Improved relative paths

include/PathUtil.h

@@ -0,0 +1,30 @@
+#ifndef PATHUTIL_H
+#define PATHUTIL_H
+
+#include "lmms_export.h"
+
+#include <QDir>
+
+namespace PathUtil
+{
+	enum Base { AbsoluteBase, ProjectDirBase, FactorySampleBase, UserSampleBase, UserVSTBase, PresetBase,
+		DefaultLADSPABase, UserLADSPABase, DefaultSoundfontBase, UserSoundfontBase, DefaultGIGBase, UserGIGBase };
+
+	QString LMMS_EXPORT baseLocation(Base base);
+	QDir LMMS_EXPORT baseQDir (Base base);
+	QString LMMS_EXPORT basePrefix(Base base);
+	Base LMMS_EXPORT baseLookup(QString path);
+
+	QString LMMS_EXPORT stripPrefix(QString path);
+	QString LMMS_EXPORT cleanName(QString path);
+
+	QString LMMS_EXPORT oldRelativeUpgrade(QString input);
+
+	QString LMMS_EXPORT toAbsolute(QString input);
+	QString LMMS_EXPORT relativeOrAbsolute(QString input, Base base);
+	QString LMMS_EXPORT toShortestRelative(QString input);
+
+	// QString LMMS_EXPORT toPreferredRelative(QString, std::vector<Base>);
+}
+
+#endif

include/SampleBuffer.h

@@ -37,6 +37,7 @@
 #include "lmms_math.h"
 #include "shared_object.h"
 #include "MemoryManager.h"
+#include "PathUtil.h"
 
 
 class QPainter;
@@ -84,7 +85,7 @@ class LMMS_EXPORT SampleBuffer : public QObject, public sharedObject
 		{
 			m_isBackwards = _backwards;
 		}
-		
+
 		int interpolationMode() const
 		{
 			return m_interpolationMode;
@@ -251,9 +252,6 @@ class LMMS_EXPORT SampleBuffer : public QObject, public sharedObject
 		m_varLock.unlock();
 	}
 
-	static QString tryToMakeRelative( const QString & _file );
-	static QString tryToMakeAbsolute(const QString & file);
-
 
 public slots:
 	void setAudioFile( const QString & _audio_file );

plugins/GigPlayer/GigPlayer.cpp

@@ -28,25 +28,26 @@
  *
  */
 
+#include "GigPlayer.h"
 
 #include <cstring>
 #include <QDebug>
 #include <QLayout>
 #include <QLabel>
 #include <QDomDocument>
 
-#include "FileDialog.h"
-#include "GigPlayer.h"
+#include "ConfigManager.h"
+#include "endian_handling.h"
 #include "Engine.h"
+#include "FileDialog.h"
 #include "InstrumentTrack.h"
 #include "InstrumentPlayHandle.h"
+#include "Knob.h"
 #include "Mixer.h"
 #include "NotePlayHandle.h"
-#include "Knob.h"
+#include "PathUtil.h"
 #include "SampleBuffer.h"
 #include "Song.h"
-#include "ConfigManager.h"
-#include "endian_handling.h"
 
 #include "PatchesDialog.h"
 #include "ToolTip.h"
@@ -211,8 +212,8 @@ void GigInstrument::openFile( const QString & _gigFile, bool updateTrackName )
 
 		try
 		{
-			m_instance = new GigInstance( SampleBuffer::tryToMakeAbsolute( _gigFile ) );
-			m_filename = SampleBuffer::tryToMakeRelative( _gigFile );
+			m_instance = new GigInstance( PathUtil::toAbsolute( _gigFile ) );
+			m_filename = PathUtil::toShortestRelative( _gigFile );
 		}
 		catch( ... )
 		{
@@ -225,7 +226,7 @@ void GigInstrument::openFile( const QString & _gigFile, bool updateTrackName )
 
 	if( updateTrackName == true )
 	{
-		instrumentTrack()->setName( QFileInfo( _gigFile ).baseName() );
+		instrumentTrack()->setName(PathUtil::cleanName( _gigFile ) );
 		updatePatch();
 	}
 }
@@ -1057,7 +1058,7 @@ void GigInstrumentView::showFileDialog()
 
 	if( k->m_filename != "" )
 	{
-		QString f = SampleBuffer::tryToMakeAbsolute( k->m_filename );
+		QString f = PathUtil::toAbsolute( k->m_filename );
 		ofd.setDirectory( QFileInfo( f ).absolutePath() );
 		ofd.selectFile( QFileInfo( f ).fileName() );
 	}

plugins/audio_file_processor/audio_file_processor.cpp

@@ -22,6 +22,7 @@
  *
  */
 
+#include "audio_file_processor.h"
 
 #include <QPainter>
 #include <QBitmap>
@@ -31,18 +32,17 @@
 
 #include <samplerate.h>
 
-#include "audio_file_processor.h"
 #include "ConfigManager.h"
+#include "DataFile.h"
 #include "Engine.h"
-#include "Song.h"
+#include "gui_templates.h"
 #include "InstrumentTrack.h"
+#include "interpolation.h"
 #include "Mixer.h"
 #include "NotePlayHandle.h"
-#include "interpolation.h"
-#include "gui_templates.h"
-#include "ToolTip.h"
+#include "Song.h"
 #include "StringPairDrag.h"
-#include "DataFile.h"
+#include "ToolTip.h"
 
 #include "embed.h"
 #include "plugin_export.h"
@@ -97,13 +97,13 @@ audioFileProcessor::audioFileProcessor( InstrumentTrack * _instrument_track ) :
 				this, SLOT( loopPointChanged() ) );
 	connect( &m_stutterModel, SIGNAL( dataChanged() ),
 	    		this, SLOT( stutterModelChanged() ) );
-	    		
+
 //interpolation modes
 	m_interpolationModel.addItem( tr( "None" ) );
 	m_interpolationModel.addItem( tr( "Linear" ) );
 	m_interpolationModel.addItem( tr( "Sinc" ) );
 	m_interpolationModel.setValue( 1 );
-	
+
 	pointChanged();
 }
 
@@ -237,7 +237,7 @@ void audioFileProcessor::loadSettings( const QDomElement & _this )
 	{
 		setAudioFile( _this.attribute( "src" ), false );
 
-		QString absolutePath = m_sampleBuffer.tryToMakeAbsolute( m_sampleBuffer.audioFile() );
+		QString absolutePath = PathUtil::toAbsolute( m_sampleBuffer.audioFile() );
 		if ( !QFileInfo( absolutePath ).exists() )
 		{
 			QString message = tr( "Sample not found: %1" ).arg( m_sampleBuffer.audioFile() );
@@ -330,7 +330,7 @@ void audioFileProcessor::setAudioFile( const QString & _audio_file,
 				m_sampleBuffer.audioFile().isEmpty() ) )
 	{
 		// then set it to new one
-		instrumentTrack()->setName( QFileInfo( _audio_file).fileName() );
+		instrumentTrack()->setName( PathUtil::cleanName( _audio_file ) );
 	}
 	// else we don't touch the track-name, because the user named it self
 
@@ -364,7 +364,7 @@ void audioFileProcessor::stutterModelChanged()
 }
 
 
-void audioFileProcessor::startPointChanged( void ) 
+void audioFileProcessor::startPointChanged( void )
 {
 	// check if start is over end and swap values if so
 	if( m_startPointModel.value() > m_endPointModel.value() )
@@ -391,7 +391,7 @@ void audioFileProcessor::startPointChanged( void )
 	{
 		m_endPointModel.setValue( qMin( m_endPointModel.value() + 0.001f, 1.0f ) );
 	}
-	
+
 	pointChanged();
 
 }
@@ -1285,7 +1285,3 @@ PLUGIN_EXPORT Plugin * lmms_plugin_main(Model * model, void *)
 
 
 }
-
-
-
-

plugins/patman/patman.cpp

@@ -3,7 +3,7 @@
  *
  * Copyright (c) 2007-2008 Javier Serrano Polo <jasp00/at/users.sourceforge.net>
  * Copyright (c) 2009-2014 Tobias Doerffel <tobydox/at/users.sourceforge.net>
- * 
+ *
  * This file is part of LMMS - https://lmms.io
  *
  * This program is free software; you can redistribute it and/or
@@ -32,15 +32,15 @@
 #include "ConfigManager.h"
 #include "endian_handling.h"
 #include "Engine.h"
+#include "FileDialog.h"
 #include "gui_templates.h"
 #include "InstrumentTrack.h"
 #include "NotePlayHandle.h"
+#include "PathUtil.h"
 #include "PixmapButton.h"
 #include "Song.h"
 #include "StringPairDrag.h"
 #include "ToolTip.h"
-#include "FileDialog.h"
-#include "ConfigManager.h"
 
 #include "embed.h"
 
@@ -192,14 +192,13 @@ void patmanInstrument::setFile( const QString & _patch_file, bool _rename )
 				   	m_patchFile == "" ) )
 	{
 		// then set it to new one
-		instrumentTrack()->setName( QFileInfo( _patch_file
-								).fileName() );
+		instrumentTrack()->setName( PathUtil::cleanName( _patch_file ) );
 	}
 	// else we don't touch the instrument-track-name, because the user
 	// named it self
 
-	m_patchFile = SampleBuffer::tryToMakeRelative( _patch_file );
-	LoadErrors error = loadPatch( SampleBuffer::tryToMakeAbsolute( _patch_file ) );
+	m_patchFile = PathUtil::toShortestRelative( _patch_file );
+	LoadErrors error = loadPatch( PathUtil::toAbsolute( _patch_file ) );
 	if( error )
 	{
 		printf("Load error\n");
@@ -625,8 +624,8 @@ void PatmanView::paintEvent( QPaintEvent * )
 	QPainter p( this );
 
 	p.setFont( pointSize<8>( font() ) );
-	p.drawText( 8, 116, 235, 16, 
-			Qt::AlignLeft | Qt::TextSingleLine | Qt::AlignVCenter, 
+	p.drawText( 8, 116, 235, 16,
+			Qt::AlignLeft | Qt::TextSingleLine | Qt::AlignVCenter,
 			m_displayFilename );
 }
 
@@ -641,8 +640,3 @@ void PatmanView::modelChanged( void )
 	connect( m_pi, SIGNAL( fileChanged() ),
 			this, SLOT( updateFilename() ) );
 }
-
-
-
-
-

plugins/sf2_player/sf2_player.cpp

@@ -23,21 +23,23 @@
  *
  */
 
+#include "sf2_player.h"
+
 #include <QDebug>
 #include <QLayout>
 #include <QLabel>
 #include <QDomDocument>
 
 #include "ConfigManager.h"
 #include "FileDialog.h"
-#include "sf2_player.h"
 #include "ConfigManager.h"
 #include "Engine.h"
 #include "InstrumentTrack.h"
 #include "InstrumentPlayHandle.h"
+#include "Knob.h"
 #include "Mixer.h"
 #include "NotePlayHandle.h"
-#include "Knob.h"
+#include "PathUtil.h"
 #include "SampleBuffer.h"
 #include "Song.h"
 
@@ -335,8 +337,8 @@ void sf2Instrument::openFile( const QString & _sf2File, bool updateTrackName )
 	emit fileLoading();
 
 	// Used for loading file
-	char * sf2Ascii = qstrdup( qPrintable( SampleBuffer::tryToMakeAbsolute( _sf2File ) ) );
-	QString relativePath = SampleBuffer::tryToMakeRelative( _sf2File );
+	char * sf2Ascii = qstrdup( qPrintable( PathUtil::toAbsolute( _sf2File ) ) );
+	QString relativePath = PathUtil::toShortestRelative( _sf2File );
 
 	// free reference to soundfont if one is selected
 	freeFont();
@@ -392,7 +394,7 @@ void sf2Instrument::openFile( const QString & _sf2File, bool updateTrackName )
 
 	if( updateTrackName || instrumentTrack()->displayName() == displayName() )
 	{
-		instrumentTrack()->setName( QFileInfo( _sf2File ).baseName() );
+		instrumentTrack()->setName( PathUtil::cleanName( _sf2File ) );
 	}
 }
 
@@ -1106,7 +1108,7 @@ void sf2InstrumentView::showFileDialog()
 
 	if( k->m_filename != "" )
 	{
-		QString f = SampleBuffer::tryToMakeAbsolute( k->m_filename );
+		QString f = PathUtil::toAbsolute( k->m_filename );
 		ofd.setDirectory( QFileInfo( f ).absolutePath() );
 		ofd.selectFile( QFileInfo( f ).fileName() );
 	}
@@ -1157,6 +1159,3 @@ PLUGIN_EXPORT Plugin * lmms_plugin_main( Model *m, void * )
 
 
 }
-
-
-