Adds support for local paths and project bundles

doc/bash-completion/lmms

@@ -89,7 +89,7 @@ _lmms()
     pars_render=(--float --bitrate --format --interpolation)
     pars_render+=(--loop --mode --output --profile)
     pars_render+=(--samplerate --oversampling)
-    actions=(dump compress render rendertracks upgrade)
+    actions=(dump compress render rendertracks upgrade makebundle)
     actions_old=(-d --dump -r --render --rendertracks -u --upgrade)
     shortargs+=(-a -b -c -f -h -i -l -m -o -p -s -v -x)
 
@@ -250,6 +250,17 @@ _lmms()
                     filemode="files"
                     filetypes="$savefiletypes"
                 fi
+            elif [ "$action_found" == "makebundle" ]
+            then
+                if [ "$prev" == "makebundle" ]
+                then
+                    filemode="existing_files"
+                    filetypes="$savefiletypes"
+                elif [ "$prev2" == "makebundle" ]
+                then
+                    filemode="files"
+                    filetypes="$savefiletypes"
+                fi
             elif [[ "$action_found" =~ render(tracks)? ]]
             then
                 if [[ "$prev" =~ render(tracks)? ]]

include/DataFile.h

@@ -27,6 +27,7 @@
 #ifndef DATA_FILE_H
 #define DATA_FILE_H
 
+#include <map>
 #include <QDomDocument>
 
 #include "lmms_export.h"
@@ -71,7 +72,9 @@ class LMMS_EXPORT DataFile : public QDomDocument
 	QString nameWithExtension( const QString& fn ) const;
 
 	void write( QTextStream& strm );
-	bool writeFile( const QString& fn );
+	bool writeFile(const QString& fn, bool withResources = false);
+	bool copyResources(const QString& resourcesDir); //!< Copies resources to the resourcesDir and changes the DataFile to use local paths to them
+	bool hasLocalPlugins(QDomElement parent = QDomElement(), bool firstCall = true) const;
 
 	QDomElement& content()
 	{
@@ -122,6 +125,10 @@ class LMMS_EXPORT DataFile : public QDomDocument
 	// List of ProjectVersions for the legacyFileVersion method
 	static const std::vector<ProjectVersion> UPGRADE_VERSIONS;
 
+	// Map with DOM elements that access resources (for making bundles)
+	typedef std::map<QString, std::vector<QString>> ResourcesMap;
+	static const ResourcesMap ELEMENTS_WITH_RESOURCES;
+
 	void upgrade();
 
 	void loadData( const QByteArray & _data, const QString & _sourceFile );
@@ -134,6 +141,7 @@ class LMMS_EXPORT DataFile : public QDomDocument
 	} ;
 	static typeDescStruct s_types[TypeCount];
 
+	QString m_fileName; //!< The origin file name or "" if this DataFile didn't originate from a file
 	QDomElement m_content;
 	QDomElement m_head;
 	Type m_type;

include/PathUtil.h

@@ -8,12 +8,18 @@
 namespace PathUtil
 {
 	enum class Base { Absolute, ProjectDir, FactorySample, UserSample, UserVST, Preset,
-		UserLADSPA, DefaultLADSPA, UserSoundfont, DefaultSoundfont, UserGIG, DefaultGIG };
+		UserLADSPA, DefaultLADSPA, UserSoundfont, DefaultSoundfont, UserGIG, DefaultGIG,
+		LocalDir };
 
 	//! Return the directory associated with a given base as a QString
-	QString LMMS_EXPORT baseLocation(const Base base);
-	//! Return the directory associated with a given base as a QDir
-	QDir LMMS_EXPORT baseQDir (const Base base);
+	//! Optionally, if a pointer to boolean is given the method will
+	//! use it to indicate whether the prefix could be resolved properly
+	//! or not.
+	QString LMMS_EXPORT baseLocation(const Base base, bool* error = nullptr);
+	//! Return the directory associated with a given base as a QDir.
+	//! Optional pointer to boolean to indicate if the prefix could
+	//! be resolved properly.
+	QDir LMMS_EXPORT baseQDir (const Base base, bool* error = nullptr);
 	//! Return the prefix used to denote this base in path strings
 	QString LMMS_EXPORT basePrefix(const Base base);
 	//! Check the prefix of a path and return the base it corresponds to
@@ -28,13 +34,15 @@ namespace PathUtil
 	//! Upgrade prefix-less relative paths to the new format
 	QString LMMS_EXPORT oldRelativeUpgrade(const QString & input);
 
-	//! Make this path absolute
-	QString LMMS_EXPORT toAbsolute(const QString & input);
+	//! Make this path absolute. If a pointer to boolean is given
+	//! it will indicate whether the path was converted successfully
+	QString LMMS_EXPORT toAbsolute(const QString & input, bool* error = nullptr);
 	//! Make this path relative to a given base, return an absolute path if that fails
 	QString LMMS_EXPORT relativeOrAbsolute(const QString & input, const Base base);
 	//! Make this path relative to any base, choosing the shortest if there are
-	//! multiple options. Defaults to an absolute path if all bases fail.
-	QString LMMS_EXPORT toShortestRelative(const QString & input);
+	//! multiple options. allowLocal defines whether local paths should be considered.
+	//! Defaults to an absolute path if all bases fail.
+	QString LMMS_EXPORT toShortestRelative(const QString & input, bool allowLocal = false);
 
 }
 

include/Song.h

@@ -72,9 +72,14 @@ class LMMS_EXPORT Song : public TrackContainer
 		 * Should we discard MIDI ControllerConnections from project files?
 		 */
 		BoolModel discardMIDIConnections{false};
+		/**
+		 * Should we save the project as a project bundle? (with resources)
+		 */
+		BoolModel saveAsProjectBundle{false};
 
 		void setDefaultOptions() {
 			discardMIDIConnections.setValue(false);
+			saveAsProjectBundle.setValue(false);
 		}
 	};
 
@@ -282,8 +287,8 @@ class LMMS_EXPORT Song : public TrackContainer
 	void createNewProjectFromTemplate( const QString & templ );
 	void loadProject( const QString & filename );
 	bool guiSaveProject();
-	bool guiSaveProjectAs( const QString & filename );
-	bool saveProjectFile( const QString & filename );
+	bool guiSaveProjectAs(const QString & filename);
+	bool saveProjectFile(const QString & filename, bool withResources = false);
 
 	const QString & projectFileName() const
 	{

include/VersionedSaveDialog.h

@@ -40,6 +40,7 @@ class SaveOptionsWidget : public QWidget {
 
 private:
 	LedCheckBox *m_discardMIDIConnectionsCheckbox;
+	LedCheckBox *m_saveAsProjectBundleCheckbox;
 };
 
 class VersionedSaveDialog : public FileDialog