lbajardsilogic@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
lbajardsilogic@0: 
lbajardsilogic@0: /*
lbajardsilogic@0:     Sonic Visualiser
lbajardsilogic@0:     An audio file viewer and annotation editor.
lbajardsilogic@0:     Centre for Digital Music, Queen Mary, University of London.
lbajardsilogic@0:     This file copyright 2006 Chris Cannam.
lbajardsilogic@0:     
lbajardsilogic@0:     This program is free software; you can redistribute it and/or
lbajardsilogic@0:     modify it under the terms of the GNU General Public License as
lbajardsilogic@0:     published by the Free Software Foundation; either version 2 of the
lbajardsilogic@0:     License, or (at your option) any later version.  See the file
lbajardsilogic@0:     COPYING included with this distribution for more information.
lbajardsilogic@0: */
lbajardsilogic@0: 
lbajardsilogic@0: #ifndef _TEMP_DIRECTORY_H_
lbajardsilogic@0: #define _TEMP_DIRECTORY_H_
lbajardsilogic@0: 
lbajardsilogic@0: #include <QString>
lbajardsilogic@0: #include <QMutex>
lbajardsilogic@0: 
lbajardsilogic@0: #include <exception>
lbajardsilogic@0: 
lbajardsilogic@0: /**
lbajardsilogic@0:  * A class that manages the creation and removal of a temporary
lbajardsilogic@0:  * directory tree to store data during the program run.  There is one
lbajardsilogic@0:  * root temporary directory for the program, created on demand and
lbajardsilogic@0:  * deleted when the program exits.
lbajardsilogic@0:  *
lbajardsilogic@0:  * This class is thread safe.
lbajardsilogic@0:  */
lbajardsilogic@0: 
lbajardsilogic@0: class TempDirectory
lbajardsilogic@0: {
lbajardsilogic@0: public:
lbajardsilogic@0:     static TempDirectory *getInstance();
lbajardsilogic@0:     
lbajardsilogic@0:     virtual ~TempDirectory();
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Create the root temporary directory if necessary, and return
lbajardsilogic@0:      * its path.  Throw DirectoryCreationFailed if the directory
lbajardsilogic@0:      * cannot be created.
lbajardsilogic@0:      */
lbajardsilogic@0:     QString getPath();
lbajardsilogic@0: 
lbajardsilogic@0:     /** 
lbajardsilogic@0:      * Create an immediate subdirectory of the root temporary
lbajardsilogic@0:      * directory of the given name, if it doesn't already exist, and
lbajardsilogic@0:      * return its path.  Throw DirectoryCreationFailed if the
lbajardsilogic@0:      * directory cannot be created.
lbajardsilogic@0:      */
lbajardsilogic@0:     QString getSubDirectoryPath(QString subdir);
lbajardsilogic@0: 
lbajardsilogic@12: 	QString getDir();
lbajardsilogic@12: 	QString getConfigPath();
lbajardsilogic@12: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Delete the temporary directory (before exiting).
lbajardsilogic@0:      */
lbajardsilogic@0:     void cleanup();
lbajardsilogic@0: 
lbajardsilogic@0: protected:
lbajardsilogic@0:     TempDirectory();
lbajardsilogic@0: 
lbajardsilogic@0:     QString createTempDirectoryIn(QString inDir);
lbajardsilogic@0:     void cleanupDirectory(QString tmpDir);
lbajardsilogic@0:     void cleanupAbandonedDirectories(QString svDir);
lbajardsilogic@0: 
lbajardsilogic@0:     QString m_tmpdir;
lbajardsilogic@0:     QMutex m_mutex;
lbajardsilogic@0: 
lbajardsilogic@0:     static TempDirectory *m_instance;
lbajardsilogic@12: 
lbajardsilogic@0: };
lbajardsilogic@0: 
lbajardsilogic@0: 
lbajardsilogic@0: #endif