cbeditor.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 CBEDITOR_H
#define CBEDITOR_H

#include <wx/hashmap.h>
#include <wx/datetime.h>
#include <wx/fontmap.h>
#include <wx/timer.h>

#include "settings.h"
#include "editorbase.h"
#include "printing_types.h"

extern const wxString g_EditorModified;

// forward decls
struct cbEditorInternalData; // this is the private data struct used by the editor.
class cbEditor;
class ProjectFile;
class EditorColourSet;
class wxSplitterWindow;
class LoaderBase;
class cbStyledTextCtrl;
class wxScintillaEvent;
class wxBoxSizer;


class DLLIMPORT cbEditor : public EditorBase
{
        DECLARE_EVENT_TABLE()
        friend class EditorManager;

    protected:
        cbEditor(wxWindow* parent, const wxString& filename, EditorColourSet* theme);
        cbEditor(wxWindow* parent, LoaderBase* fileLdr, const wxString& filename, EditorColourSet* theme);
        ~cbEditor() override;
    public:
        enum SplitType
        {
            stNoSplit = 0,
            stHorizontal,
            stVertical
        };

        void operator=(cb_unused const cbEditor& rhs){ cbThrow(_T("Can't assign an cbEditor* !!!")); }

        // properties

        cbStyledTextCtrl* GetControl() const;

        cbStyledTextCtrl* GetLeftSplitViewControl() const { return m_pControl; }

        cbStyledTextCtrl* GetRightSplitViewControl() const { return m_pControl2; }

        SplitType GetSplitType() const { return m_SplitType; }

        bool IsOK() const { return m_IsOK; }

        void SetEditorTitle(const wxString& title);

        bool GetModified() const override;

        void SetModified(bool modified = true) override;

        void SetProjectFile(ProjectFile* project_file,bool preserve_modified = false);

        ProjectFile* GetProjectFile() const { return m_pProjectFile; }

        void UpdateProjectFile();

        bool Save() override;

        bool SaveAs() override;

        bool SaveFoldState();

        bool FixFoldState();

        void FoldAll();

        void UnfoldAll();

        void ToggleAllFolds();

        void SetFoldingIndicator(int id);

        void FoldBlockFromLine(int line = -1);

        void UnfoldBlockFromLine(int line = -1);

        void ToggleFoldBlockFromLine(int line = -1);

        void SetColourSet(EditorColourSet* theme);

        EditorColourSet* GetColourSet() const { return m_pTheme; }

        void GotoMatchingBrace();

        void HighlightBraces();

        int GetLineIndentInSpaces(int line = -1) const;

        wxString GetLineIndentString(int line = -1) const;

        wxDateTime GetLastModificationTime() const { return m_LastModified; }

        void Touch();

        bool Reload(bool detectEncoding = true);

        void Print(bool selectionOnly, PrintColourMode pcm, bool line_numbers);

        void AutoComplete();

        void GotoLine(int line, bool centerOnScreen = true) override;

        bool GotoTokenPosition(int line, const wxString& tokenName);

        bool AddBreakpoint(int line = -1, bool notifyDebugger = true);

        bool RemoveBreakpoint(int line = -1, bool notifyDebugger = true);

        virtual void ToggleBreakpoint(int line = -1, bool notifyDebugger = true);

        virtual bool HasBreakpoint(int line) const;

        virtual void GotoNextBreakpoint();

        virtual void GotoPreviousBreakpoint();

        virtual void RefreshBreakpointMarkers();

        virtual void ClearAllBookmarks();

        virtual void ToggleBookmark(int line = -1);

        virtual bool HasBookmark(int line) const;

        virtual void GotoNextBookmark();

        virtual void GotoPreviousBookmark();

        virtual void SetDebugLine(int line);

        virtual void SetErrorLine(int line);

        void Split(SplitType split);

        void Unsplit();

        // the following functions, although self-explanatory, are documented
        // in EditorBase.
        void Undo() override;
        void Redo() override;
        void ClearHistory() override;
        void GotoNextChanged() override;
        void GotoPreviousChanged() override;
        void SetChangeCollection(bool collectChange) override;
        void Cut() override;
        void Copy() override;
        void Paste() override;
        bool CanUndo() const override;
        bool CanRedo() const override;
        bool HasSelection() const override;
        bool CanPaste() const override;
        bool IsReadOnly() const override;
        void SetReadOnly(bool readonly = true) override;

        bool CanSelectAll() const override;
        void SelectAll() override;

        // Workaround for shift-tab bug in wx2.4.2
        void DoIndent();   
        void DoUnIndent(); 

        // misc. functions
        wxMenu* CreateContextSubMenu(long id) override;
        void AddToContextMenu(wxMenu* popup,ModuleType type,bool pluginsdone) override;  //pecan 2006/03/22

        HighlightLanguage GetLanguage( ) const { return m_lang; }
        void SetLanguage(HighlightLanguage lang, bool colourise);

        wxFontEncoding GetEncoding( ) const;
        wxString GetEncodingName( ) const;
        void SetEncoding( wxFontEncoding encoding );

        bool GetUseBom() const;
        void SetUseBom( bool bom );

        void SetZoom(int zoom, bool both = true);

        static void ApplyStyles(cbStyledTextCtrl* control);

        void AutoIndentDone();

        void SetEditorStyle();
    private:
        cbEditor(cb_unused const cbEditor& rhs); // prevent copy construction

        // functions
        bool LineHasMarker(int marker, int line = -1) const;
        void MarkerToggle(int marker, int line = -1);
        void MarkerNext(int marker);
        void MarkerPrevious(int marker);
        void MarkLine(int marker, int line);

        enum class FoldMode : int
        {
            contract = 0, // wxSCI_FOLDACTION_CONTRACT
            expand = 1, // wxSCI_FOLDACTION_EXPAND,
            toggle = 2, //wxSCI_FOLDACTION_TOGGLE
        };
        enum FoldFlags : unsigned
        {
            none = 0x0,
            ensureVisible = 0x2,
        };

        void DoFoldAll(FoldMode fold);
        void DoFoldBlockFromLine(int line, FoldMode fold, unsigned foldFlags);
        void SetMarkerStyle(int marker, int markerType, wxColor fore, wxColor back);
        void UnderlineFoldedLines(bool underline);
        cbStyledTextCtrl* CreateEditor();
        void ConnectEvents(cbStyledTextCtrl* stc);
        void SetEditorStyleBeforeFileOpen();
        void SetEditorStyleAfterFileOpen();
        static void InternalSetEditorStyleBeforeFileOpen(cbStyledTextCtrl* control);
        static void InternalSetEditorStyleAfterFileOpen(cbStyledTextCtrl* control);
        bool Open(bool detectEncoding = true);
        void DoAskForCodeCompletion(); // relevant to code-completion plugins
        void SetLanguageDependentColours(cbStyledTextCtrl &control);
        void NotifyPlugins(wxEventType type, int intArg = 0, const wxString& strArg = wxEmptyString, int xArg = 0, int yArg = 0);

        // events
        void OnMarginClick(wxScintillaEvent& event);
        void OnEditorUpdateUI(wxScintillaEvent& event);
        void OnEditorChange(wxScintillaEvent& event);
        void OnEditorCharAdded(wxScintillaEvent& event);
        void OnEditorDwellStart(wxScintillaEvent& event);
        void OnEditorDwellEnd(wxScintillaEvent& event);
        void OnEditorModified(wxScintillaEvent& event);
        void OnUserListSelection(wxScintillaEvent& event);
        void OnZoom(wxScintillaEvent& event);
        void OnScintillaEvent(wxScintillaEvent& event);
        void OnClose(wxCloseEvent& event);

        // one event handler for all popup menu entries
        void OnContextMenuEntry(wxCommandEvent& event);
        bool OnBeforeBuildContextMenu(const wxPoint& position, ModuleType type) override;    //pecan 2006/03/22
        void OnAfterBuildContextMenu(ModuleType type) override;                              //pecan 2006/03/22

        void DestroySplitView();

        void DoInitializations(const wxString& filename, LoaderBase* fileLdr = nullptr);

        void BreakpointMarkerToggle(int line);

        // variables
        bool m_IsOK;
        wxSplitterWindow* m_pSplitter;
        wxBoxSizer* m_pSizer;
        cbStyledTextCtrl* m_pControl;
        cbStyledTextCtrl* m_pControl2;
        cbStyledTextCtrl* m_foldBackup;
        SplitType m_SplitType;
        bool m_Modified;
        int m_Index;
        wxTimer m_timerWait;
        ProjectFile* m_pProjectFile;
        EditorColourSet* m_pTheme;
        HighlightLanguage m_lang;
        wxDateTime m_LastModified; // to check if the file was modified outside the editor
        bool m_autoIndentDone;

        // DO NOT ADD ANY MORE VARIABLES HERE!
        // ADD THEM IN cbEditorInternalData INSTEAD!

        friend struct cbEditorInternalData; // allow cbEditorInternalData to access cbEditor
        cbEditorInternalData* m_pData;
};

#endif // CBEDITOR_H