ProjectFileManager.h

Go to the documentation of this file.

#pragma once
#include <NDEVR/QTModelManager.h>
#include <QObject>
namespace NDEVR
{
    class Log;
    class BasicThread;
    /**--------------------------------------------------------------------------------------------------
    \brief Options for saving an NDEVR project 
    **/
    struct SaveOptions
    {
        SaveOptions()
        {};
        SaveOptions(const File& destination)
            : destination(destination)
        {};
        Log* log = nullptr;
        PopupInfo origin;
        File destination;
        bool is_blocking = false;
        bool path_includes_new_project_name = false;
        bool is_temp = false;
        bool write_image = true;
        std::function<void(bool, File)> finished_callback;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief Manages writing to the NDV file and any folder operations for projects. Also responsible for
        creating auto-save backup files at given intervals.
    **/
    class NDEVR_API ProjectFileManager : public QObject
    {
        Q_OBJECT
    public:
        enum PathChangeMode
        {
              e_move
            , e_copy
            , e_new
        };
        ProjectFileManager(QTModelManager* manager);
        ~ProjectFileManager();
        
        virtual bool moveProject(const SaveOptions& options);
        virtual bool copyProject(const SaveOptions& options);
        virtual void userDiscardProject(QTModelManager* manager, bool is_blocking);
        virtual bool userSaveProject(const SaveOptions& options = SaveOptions());
        virtual bool saveProject(const SaveOptions& options = SaveOptions());
        void updateLastBackupTime();
        File previousBackupFile() const;
        void clearBackupInformation();
        void update(Time current_time);
        void readINIOptions();
        void saveINIOptions();
        virtual INIFactory getINI();
        Time lastSaveTime() const { return m_last_save_time; }
        virtual void updateActiveProjectFolder(PathChangeMode mode, Log* log = nullptr);
        void clearAll();
#if NDEVR_SUPPORTS_THREADING
        Thread* autoSaveThread();
#endif
        virtual String projectName() const;
        virtual File projectFile() const;
        virtual File projectDirectory() const;
        virtual File projectParentDirectory() const;
        virtual File activeBackupFile() const;
        virtual File activeLogFolder() const;
        virtual File activeScreenshotFolder() const;
        virtual File activeVideoFolder() const;
        virtual File defaultBrowseDirectory(bool is_project) const;
    signals:
        void projectSavedSignal();
        void logPathAboutToChangeSignal(const File& new_path, PathChangeMode mode);
        void logPathChangedSignal(const File& path);
 
        void videoPathAboutToChangeSignal(const File& new_path, PathChangeMode mode);
        void videoPathChangedSignal(const File& path);
 
        void imagePathAboutToChangeSignal(const File& new_path, PathChangeMode mode);
        void imagePathChangedSignal(const File& path);
 
        void exportPathAboutToChangeSignal(const File& new_path, PathChangeMode mode);
        void exportPathChangedSignal(const File& path);
    protected:
        QTModelManager* m_manager;
        BasicThread* m_auto_save_thread;
        File m_project_parent_directory;
        String m_project_name;
        String m_runtime_log_folder;
        Time m_last_backup_time;
        Time m_last_save_time;
        Time m_last_project_file_check_time;
        File m_last_save_file;
        bool m_is_last_save_backup;
    };
}