annotate data/fileio/FileFinder.h @ 211:e2bbb58e6df6

Several changes related to referring to remote URLs for sessions and files:
* Pull file dialog wrapper functions out from MainWindow into FileFinder
* If a file referred to in a session is not found at its expected location,
  try a few other alternatives (same location as the session file or same
  location as the last audio file) before asking the user to locate it
* Allow user to give a URL when locating an audio file, not just locate on
  the filesystem
* Make wave file models remember the "original" location (e.g. URL) of
  the audio file, not just the actual location from which the data was
  loaded (e.g. local copy of that URL) -- when saving a session, use the
  original location so as not to refer to a temporary file
* Clean up incompletely-downloaded local copies of files

/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */

/*
    Sonic Visualiser
    An audio file viewer and annotation editor.
    Centre for Digital Music, Queen Mary, University of London.
    This file copyright 2007 QMUL.
    
    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License as
    published by the Free Software Foundation; either version 2 of the
    License, or (at your option) any later version.  See the file
    COPYING included with this distribution for more information.
*/

#ifndef _FILE_FINDER_H_
#define _FILE_FINDER_H_

#include <QString>
#include <QObject>

class FileFinder : public QObject
{
    Q_OBJECT

public:
    virtual ~FileFinder();

    enum FileType {
        SessionFile,
        AudioFile,
        LayerFile,
        SessionOrAudioFile,
        AnyFile
    };

    QString getOpenFileName(FileType type, QString fallbackLocation = "");
    QString getSaveFileName(FileType type, QString fallbackLocation = "");
    void registerLastOpenedFilePath(FileType type, QString path);

    QString find(FileType type, QString location, QString lastKnownLocation = "");

    static FileFinder *getInstance();

protected:
    FileFinder();
    static FileFinder *m_instance;

    QString findRelative(QString location, QString relativeTo);
    QString locateInteractive(FileType type, QString thing);

    QString m_lastLocatedLocation;
};

#endif