projectmanager.h

Go to the documentation of this file.

/*
 * This file is part of the Code::Blocks IDE and licensed under the GNU Lesser General Public License, version 3
 * http://www.gnu.org/licenses/lgpl-3.0.html
 */

#ifndef PROJECTMANAGER_H
#define PROJECTMANAGER_H

#ifndef CB_PRECOMP
    #include "globals.h" // DEFAULT_WORKSPACE
#endif

#include <wx/event.h>
#include <wx/dynarray.h>
#include <wx/hashmap.h>
#include <wx/treectrl.h>

#include "cbexception.h"
#include "cbtreectrl.h"
#include "settings.h"
#include "manager.h"

// forward decls
class cbProject;
class EditorBase;
class ProjectFile;
class FilesGroupsAndMasks;
class cbWorkspace;
class cbAuiNotebook;

WX_DEFINE_ARRAY(cbProject*, ProjectsArray);
WX_DECLARE_HASH_MAP(cbProject*, ProjectsArray*, wxPointerHash, wxPointerEqual, DepsMap); // for project dependencies


class DLLIMPORT cbProjectManagerUI
{
    public:
        virtual ~cbProjectManagerUI() {}

        virtual cbAuiNotebook* GetNotebook() = 0;
        virtual cbTreeCtrl* GetTree() = 0;
        virtual void RebuildTree() = 0;
        virtual void FreezeTree() = 0;
        virtual void UnfreezeTree(bool force = false) = 0;
        virtual wxTreeItemId GetTreeSelection() = 0;

        virtual void ShowFileInTree(ProjectFile &projectFile) = 0;

        virtual void UpdateActiveProject(cbProject *oldProject, cbProject *newProject, bool refresh) = 0;
        virtual void RemoveProject(cbProject *project) = 0;
        virtual void BeginLoadingWorkspace() = 0;
        virtual void CloseWorkspace() = 0;
        virtual void FinishLoadingProject(cbProject *project, bool newAddition, FilesGroupsAndMasks* fileGroups) = 0;
        virtual void FinishLoadingWorkspace(cbProject *activeProject, const wxString &workspaceTitle) = 0;

        virtual bool QueryCloseAllProjects() = 0;

        virtual bool QueryCloseProject(cbProject *proj, bool dontsavefiles = false) = 0;

        virtual bool QueryCloseWorkspace() = 0;

        virtual int AskForBuildTargetIndex(cbProject* project = nullptr) = 0;
        virtual wxArrayInt AskForMultiBuildTargetIndex(cbProject* project = nullptr) = 0;

        virtual void ConfigureProjectDependencies(cbProject* base = nullptr) = 0;

        virtual void SwitchToProjectsPage() = 0;
};


class DLLIMPORT ProjectManager : public Mgr<ProjectManager>, public wxEvtHandler
{
        static bool s_CanShutdown;
    public:
        friend class Mgr<ProjectManager>;
        friend class Manager; // give Manager access to our private members

        // FIXME(obfuscated#): Extract these two in their own class
        cbProjectManagerUI& GetUI() { return *m_ui; }
        void SetUI(cbProjectManagerUI *ui);

        const FilesGroupsAndMasks* GetFilesGroupsAndMasks() const { return m_pFileGroups; }
        FilesGroupsAndMasks* GetFilesGroupsAndMasks() { return m_pFileGroups; }

        static bool CanShutdown() { return s_CanShutdown; }

        wxString GetDefaultPath();
        void SetDefaultPath(const wxString& path);
        bool IsProjectStillOpen(cbProject* project);
        cbProject* GetActiveProject(){ return m_pActiveProject; }
        ProjectsArray* GetProjects(){ return m_pProjects; }
        cbProject* IsOpen(const wxString& filename);
        void SetProject(cbProject* project, bool refresh = true);
        cbProject* LoadProject(const wxString& filename, bool activateIt = true);

        void ReloadProject(cbProject *project);

        bool SaveProject(cbProject* project);
        bool SaveProjectAs(cbProject* project);
        bool SaveActiveProject();
        bool SaveActiveProjectAs();
        bool SaveAllProjects();
        bool CloseProject(cbProject* project, bool dontsave = false, bool refresh = true);
        bool CloseActiveProject(bool dontsave = false);
        bool CloseAllProjects(bool dontsave = false);

        cbProject* NewProject(const wxString& filename = wxEmptyString);
        int AddFileToProject(const wxString& filename, cbProject* project = nullptr, int target = -1);
        int AddFileToProject(const wxString& filename, cbProject* project, wxArrayInt& targets);
        int AddMultipleFilesToProject(const wxArrayString& filelist, cbProject* project, int target = -1);
        int AddMultipleFilesToProject(const wxArrayString& filelist, cbProject* project, wxArrayInt& targets);
        void RemoveFileFromProject(ProjectFile* pfile, cbProject* project);
        bool LoadWorkspace(const wxString& filename = DEFAULT_WORKSPACE);
        bool SaveWorkspace();
        bool SaveWorkspaceAs(const wxString& filename);
        bool CloseWorkspace();

        bool IsLoadingProject();
        bool IsLoadingWorkspace();
        bool IsLoading();
        bool IsClosingProject();
        bool IsClosingWorkspace();
        bool IsLoadingOrClosing();
        static bool IsBusy();
        cbWorkspace* GetWorkspace();

        bool AddProjectDependency(cbProject* base, cbProject* dependsOn);
        void RemoveProjectDependency(cbProject* base, cbProject* doesNotDependOn);
        void ClearProjectDependencies(cbProject* base);
        void RemoveProjectFromAllDependencies(cbProject* base);
        const ProjectsArray* GetDependenciesForProject(cbProject* base);
        bool CausesCircularDependency(cbProject* base, cbProject* dependsOn);

        void WorkspaceChanged();

        bool BeginLoadingProject();

        void EndLoadingProject(cbProject* project);

        bool BeginLoadingWorkspace();

        void EndLoadingWorkspace();

        ProjectManager& operator=(cb_unused const ProjectManager& rhs) // prevent assignment operator
        {
            cbThrow(_T("Can't assign a ProjectManager* !!!"));
            return *this;
        }

        void SetIsRunning(cbPlugin *plugin);

        cbPlugin* GetIsRunning() const;

        cbProject* FindProjectForFile(const wxString& file, ProjectFile **resultFile,
                                      bool isRelative, bool isUnixFilename);

    private:
        ProjectManager(cb_unused const ProjectManager& rhs); // prevent copy construction

        ProjectManager();
        ~ProjectManager() override;
        void OnAppDoneStartup(CodeBlocksEvent& event);
        int  DoAddFileToProject(const wxString& filename, cbProject* project, wxArrayInt& targets);

        cbProjectManagerUI *m_ui;
        cbProject*           m_pActiveProject;
        cbProject*           m_pProjectToActivate;
        ProjectsArray*       m_pProjects;
        DepsMap              m_ProjectDeps;
        cbWorkspace*         m_pWorkspace;
        FilesGroupsAndMasks* m_pFileGroups;
        bool                 m_IsLoadingProject;
        bool                 m_IsLoadingWorkspace;
        bool                 m_IsClosingProject;
        bool                 m_IsClosingWorkspace;
        wxString             m_InitialDir;
        bool                 m_CanSendWorkspaceChanged;
        cbPlugin*            m_RunningPlugin;

        DECLARE_EVENT_TABLE()
};

#endif // PROJECTMANAGER_H