juce_CodeEditorComponent.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
class CodeTokeniser;
 
 
//==============================================================================
class JUCE_API  CodeEditorComponent   : public Component,
                                        public ApplicationCommandTarget,
                                        public TextInputTarget
{
public:
    //==============================================================================
    CodeEditorComponent (CodeDocument& document,
                         CodeTokeniser* codeTokeniser);

    ~CodeEditorComponent() override;
 
    //==============================================================================
    CodeDocument& getDocument() const noexcept          { return document; }

    void loadContent (const String& newContent);
 
    //==============================================================================
    float getCharWidth() const noexcept                         { return charWidth; }

    int getLineHeight() const noexcept                          { return lineHeight; }

    int getNumLinesOnScreen() const noexcept                    { return linesOnScreen; }

    int getFirstLineOnScreen() const noexcept                   { return firstLineOnScreen; }

    int getNumColumnsOnScreen() const noexcept                  { return columnsOnScreen; }

    CodeDocument::Position getCaretPos() const                  { return caretPos; }

    Rectangle<int> getCaretRectangle() override;

    void moveCaretTo (const CodeDocument::Position& newPos, bool selecting);

    Rectangle<int> getCharacterBounds (const CodeDocument::Position& pos) const;

    CodeDocument::Position getPositionAt (int x, int y) const;

    CodeDocument::Position getSelectionStart() const            { return selectionStart; }

    CodeDocument::Position getSelectionEnd() const              { return selectionEnd; }

    void setLineNumbersShown (bool shouldBeShown);
 
    //==============================================================================
    bool moveCaretLeft (bool moveInWholeWordSteps, bool selecting);
    bool moveCaretRight (bool moveInWholeWordSteps, bool selecting);
    bool moveCaretUp (bool selecting);
    bool moveCaretDown (bool selecting);
    bool scrollDown();
    bool scrollUp();
    bool pageUp (bool selecting);
    bool pageDown (bool selecting);
    bool moveCaretToTop (bool selecting);
    bool moveCaretToStartOfLine (bool selecting);
    bool moveCaretToEnd (bool selecting);
    bool moveCaretToEndOfLine (bool selecting);
    bool deleteBackwards (bool moveInWholeWordSteps);
    bool deleteForwards (bool moveInWholeWordSteps);
    bool deleteWhitespaceBackwardsToTabStop();
    virtual bool copyToClipboard();
    virtual bool cutToClipboard();
    virtual bool pasteFromClipboard();
    bool undo();
    bool redo();
 
    void selectRegion (const CodeDocument::Position& start, const CodeDocument::Position& end);
    bool selectAll();
    void deselectAll();
 
    void scrollToLine (int newFirstLineOnScreen);
    void scrollBy (int deltaLines);
    void scrollToColumn (int newFirstColumnOnScreen);
    void scrollToKeepCaretOnScreen();
    void scrollToKeepLinesOnScreen (Range<int> linesToShow);
 
    void insertTextAtCaret (const String& textToInsert) override;
    void insertTabAtCaret();
 
    void indentSelection();
    void unindentSelection();
 
    //==============================================================================
    Range<int> getHighlightedRegion() const override;
    bool isHighlightActive() const noexcept;
    void setHighlightedRegion (const Range<int>& newRange) override;
    String getTextInRange (const Range<int>& range) const override;
 
    //==============================================================================
    struct State
    {
        State (const CodeEditorComponent&);
        State (const String& stringifiedVersion);
        State (const State&) noexcept;

        void restoreState (CodeEditorComponent&) const;

        String toString() const;
 
    private:
        int lastTopLine, lastCaretPos, lastSelectionEnd;
    };
 
    //==============================================================================
    void setTabSize (int numSpacesPerTab, bool insertSpacesInsteadOfTabCharacters);

    int getTabSize() const noexcept                     { return spacesPerTab; }

    bool areSpacesInsertedForTabs() const               { return useSpacesForTabs; }

    String getTabString (int numSpaces) const;

    void setFont (const Font& newFont);

    const Font& getFont() const noexcept                { return font; }

    void setReadOnly (bool shouldBeReadOnly) noexcept;

    bool isReadOnly() const noexcept                    { return readOnly; }
 
    //==============================================================================
    struct JUCE_API  ColourScheme
    {
        struct TokenType
        {
            String name;
            Colour colour;
        };
 
        Array<TokenType> types;
 
        void set (const String& name, Colour colour);
    };

    void setColourScheme (const ColourScheme& scheme);

    const ColourScheme& getColourScheme() const noexcept    { return colourScheme; }

    Colour getColourForTokenType (int tokenType) const;

    void retokenise (int startIndex, int endIndex);
 
    //==============================================================================
    enum ColourIds
    {
        backgroundColourId          = 0x1004500,  
        highlightColourId           = 0x1004502,  
        defaultTextColourId         = 0x1004503,  
        lineNumberBackgroundId      = 0x1004504,  
        lineNumberTextId            = 0x1004505,  
    };
 
    //==============================================================================
    void setScrollbarThickness (int thickness);

    int getScrollbarThickness() const noexcept          { return scrollbarThickness; }
 
    //==============================================================================
    virtual void handleReturnKey();
    virtual void handleTabKey();
    virtual void handleEscapeKey();

    virtual void editorViewportPositionChanged();

    virtual void caretPositionMoved();
 
    //==============================================================================
    virtual void addPopupMenuItems (PopupMenu& menuToAddTo,
                                    const MouseEvent* mouseClickEvent);

    virtual void performPopupMenuAction (int menuItemID);

    void setCommandManager (ApplicationCommandManager* newManager) noexcept;
 
    //==============================================================================
    void paint (Graphics&) override;
    void resized() override;
    bool keyPressed (const KeyPress&) override;
    void mouseDown (const MouseEvent&) override;
    void mouseDrag (const MouseEvent&) override;
    void mouseUp (const MouseEvent&) override;
    void mouseDoubleClick (const MouseEvent&) override;
    void mouseWheelMove (const MouseEvent&, const MouseWheelDetails&) override;
    void focusGained (FocusChangeType) override;
    void focusLost (FocusChangeType) override;
    bool isTextInputActive() const override;
    void setTemporaryUnderlining (const Array<Range<int>>&) override;
    ApplicationCommandTarget* getNextCommandTarget() override;
    void getAllCommands (Array<CommandID>&) override;
    void getCommandInfo (CommandID, ApplicationCommandInfo&) override;
    bool perform (const InvocationInfo&) override;
    void lookAndFeelChanged() override;
 
private:
    //==============================================================================
    CodeDocument& document;
 
    Font font;
    int firstLineOnScreen = 0, spacesPerTab = 4;
    float charWidth = 0;
    int lineHeight = 0, linesOnScreen = 0, columnsOnScreen = 0;
    int scrollbarThickness = 16, columnToTryToMaintain = -1;
    bool readOnly = false, useSpacesForTabs = true, showLineNumbers = false, shouldFollowDocumentChanges = false;
    double xOffset = 0;
    CodeDocument::Position caretPos, selectionStart, selectionEnd;
 
    std::unique_ptr<CaretComponent> caret;
    ScrollBar verticalScrollBar { true }, horizontalScrollBar { false };
    ApplicationCommandManager* appCommandManager = nullptr;
 
    class Pimpl;
    std::unique_ptr<Pimpl> pimpl;
 
    class GutterComponent;
    std::unique_ptr<GutterComponent> gutter;
 
    class CodeEditorAccessibilityHandler;
 
    enum DragType
    {
        notDragging,
        draggingSelectionStart,
        draggingSelectionEnd
    };
 
    DragType dragType = notDragging;
 
    //==============================================================================
    CodeTokeniser* codeTokeniser;
    ColourScheme colourScheme;
 
    class CodeEditorLine;
    OwnedArray<CodeEditorLine> lines;
    void rebuildLineTokens();
    void rebuildLineTokensAsync();
    void codeDocumentChanged (int start, int end);
 
    Array<CodeDocument::Iterator> cachedIterators;
    void clearCachedIterators (int firstLineToBeInvalid);
    void updateCachedIterators (int maxLineNum);
    void getIteratorForPosition (int position, CodeDocument::Iterator&);
 
    void moveLineDelta (int delta, bool selecting);
    int getGutterSize() const noexcept;
 
    //==============================================================================
    std::unique_ptr<AccessibilityHandler> createAccessibilityHandler() override;
    void insertText (const String&);
    virtual void updateCaretPosition();
    void updateScrollBars();
    void scrollToLineInternal (int line);
    void scrollToColumnInternal (double column);
    void newTransaction();
    void cut();
    void indentSelectedLines (int spacesToAdd);
    bool skipBackwardsToPreviousTab();
    bool performCommand (CommandID);
    void setSelection (CodeDocument::Position, CodeDocument::Position);
 
    int indexToColumn (int line, int index) const noexcept;
    int columnToIndex (int line, int column) const noexcept;
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (CodeEditorComponent)
};
 
} // namespace juce