projectfile.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 PROJECTFILE_H
#define PROJECTFILE_H

#include <vector>

#include "settings.h"
#include "globals.h"
#include "prep.h"
#include <wx/dynarray.h>
#include <wx/filename.h>
#include <wx/treectrl.h>
#include <wx/hashset.h>

class cbProject;
class ProjectBuildTarget;
class pfDetails;

WX_DECLARE_HASH_MAP(ProjectBuildTarget*, pfDetails*, wxPointerHash, wxPointerEqual, PFDMap);

struct pfCustomBuild
{
    pfCustomBuild() : useCustomBuildCommand(false) { }
    wxString buildCommand;
    bool     useCustomBuildCommand;
};
WX_DECLARE_HASH_MAP(wxString, pfCustomBuild, wxStringHash, wxStringEqual, pfCustomBuildMap);

class ProjectFile;
typedef std::vector<ProjectFile*> ProjectFilesVector;

WX_DEFINE_ARRAY_INT(int, editorFoldLinesArray);

class DLLIMPORT ProjectFile
{
    public:
        ProjectFile(cbProject* prj);
        ~ProjectFile();

        void Rename(const wxString& new_name);

        void AddBuildTarget(const wxString& targetName);

        void RenameBuildTarget(const wxString& oldTargetName, const wxString& newTargetName);

        void RemoveBuildTarget(const wxString& targetName);

        const wxArrayString& GetBuildTargets() const;

        bool ShowOptions(wxWindow* parent);

        // take as example the relative file sdk/cbProject.cpp
        wxString GetBaseName() const; // returns sdk/cbProject

        const wxString& GetObjName(); // returns sdk/cbProject.o

        void SetObjName(const wxString& name);

        cbProject* GetParentProject(){ return project; }

        void UpdateFileDetails(ProjectBuildTarget* target = nullptr);

        const pfDetails& GetFileDetails(ProjectBuildTarget* target);

        void SetFileState(FileVisualState state);

        FileVisualState GetFileState() const;

        void SetUseCustomBuildCommand(const wxString& compilerId, bool useCustomBuildCommand);

        void SetCustomBuildCommand(const wxString& compilerId, const wxString& newBuildCommand);

        bool GetUseCustomBuildCommand(const wxString& compilerId);

        wxString GetCustomBuildCommand(const wxString& compilerId);

        wxFileName file;

        wxString relativeFilename;

        wxString relativeToCommonTopLevelPath;

        bool compile;

        bool link;

        unsigned short int weight;

        bool editorOpen; // layout info

        int editorSplit; // layout info

        int editorSplitActive; // layout info

        int editorSplitPos; // layout info

        int editorPos; // layout info

        int editorTopLine; // layout info

        int editorZoom; // layout info

        int editorPos_2; // layout info

        int editorTopLine_2; // layout info

        int editorZoom_2; // layout info

        int editorTabPos; // layout info

        wxArrayInt editorFoldLinesArray; // layout info

        pfCustomBuildMap customBuild;

        wxString compilerVar;

        wxArrayString buildTargets;

        wxString virtual_path;

        ProjectFile* autoGeneratedBy; // deprecated --> use the method ; die public member var's

        ProjectFile* AutoGeneratedBy() const { return autoGeneratedBy;}

        void SetAutoGeneratedBy(ProjectFile* TheFile) { autoGeneratedBy = TheFile; }

        ProjectFilesVector generatedFiles;

        const wxTreeItemId& GetTreeItemId() const { return m_TreeItemId; }

        void SetTreeItemId(wxTreeItemId id) { m_TreeItemId = id; }

        static int CompareProjectFiles(ProjectFile* item1, ProjectFile* item2);
    protected:
        friend class cbProject;

        void DoUpdateFileDetails(ProjectBuildTarget* target);
        cbProject* project;
        FileVisualState m_VisualState;
        wxTreeItemId m_TreeItemId; // set by the project when building the tree
        wxString m_ObjName;
        PFDMap m_PFDMap;
};
WX_DECLARE_HASH_SET   ( ProjectFile*, wxPointerHash, wxPointerEqual, FilesList );
WX_DEFINE_SORTED_ARRAY( ProjectFile*, ProjectFileArray                         );

class pfDetails
{
    public:
        pfDetails(ProjectBuildTarget* target, ProjectFile* pf);
        void Update(ProjectBuildTarget* target, ProjectFile* pf);
        // all the members below, are set in the constructor
        wxString source_file;
        wxString object_file;
        wxString dep_file;
        wxString object_dir;
        wxString object_dir_flat;
        wxString dep_dir;
        wxString object_file_flat;
        // those below, have no UnixFilename() applied, nor QuoteStringIfNeeded()
        wxString source_file_native;
        wxString object_file_native;
        wxString dep_file_native;
        wxString object_dir_native;
        wxString object_dir_flat_native;
        wxString dep_dir_native;
        wxString source_file_absolute_native;
        wxString object_file_absolute_native;
        wxString object_file_flat_absolute_native;
        wxString dep_file_absolute_native;
        wxString object_file_flat_native;
};

#endif // PROJECTFILE_H