juce_CodeDocument.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 CodeDocumentLine;
 
 
//==============================================================================
class JUCE_API  CodeDocument
{
public:
    CodeDocument();

    ~CodeDocument();
 
    //==============================================================================
    class JUCE_API  Position
    {
    public:
        Position() noexcept;

        Position (const CodeDocument& ownerDocument,
                  int line, int indexInLine) noexcept;

        Position (const CodeDocument& ownerDocument,
                  int charactersFromStartOfDocument) noexcept;

        Position (const Position&) noexcept;

        ~Position();
 
        Position& operator= (const Position&);
 
        bool operator== (const Position&) const noexcept;
        bool operator!= (const Position&) const noexcept;

        void setPosition (int charactersFromStartOfDocument);

        int getPosition() const noexcept            { return characterPos; }

        void setLineAndIndex (int newLineNumber, int newIndexInLine);

        int getLineNumber() const noexcept          { return line; }

        int getIndexInLine() const noexcept         { return indexInLine; }

        void setPositionMaintained (bool isMaintained);
 
        //==============================================================================
        void moveBy (int characterDelta);

        Position movedBy (int characterDelta) const;

        Position movedByLines (int deltaLines) const;

        juce_wchar getCharacter() const;

        String getLineText() const;
 
    private:
        CodeDocument* owner = nullptr;
        int characterPos = 0, line = 0, indexInLine = 0;
        bool positionMaintained = false;
 
        friend class CodeDocument;
    };
 
    //==============================================================================
    String getAllContent() const;

    String getTextBetween (const Position& start, const Position& end) const;

    String getLine (int lineIndex) const noexcept;

    int getNumCharacters() const noexcept;

    int getNumLines() const noexcept                    { return lines.size(); }

    int getMaximumLineLength() noexcept;

    void deleteSection (const Position& startPosition, const Position& endPosition);

    void deleteSection (int startIndex, int endIndex);

    void insertText (const Position& position, const String& text);

    void insertText (int insertIndex, const String& text);

    void replaceSection (int startIndex, int endIndex, const String& newText);

    void replaceAllContent (const String& newContent);

    void applyChanges (const String& newContent);

    bool loadFromStream (InputStream& stream);

    bool writeToStream (OutputStream& stream);
 
    //==============================================================================
    String getNewLineCharacters() const noexcept          { return newLineChars; }

    void setNewLineCharacters (const String& newLineCharacters) noexcept;
 
    //==============================================================================
    void newTransaction();

    void undo();

    void redo();

    void clearUndoHistory();

    UndoManager& getUndoManager() noexcept              { return undoManager; }
 
    //==============================================================================
    void setSavePoint() noexcept;

    bool hasChangedSinceSavePoint() const noexcept;
 
    //==============================================================================
    Position findWordBreakAfter (const Position& position) const noexcept;
    Position findWordBreakBefore (const Position& position) const noexcept;
    void findTokenContaining (const Position& pos, Position& start, Position& end) const noexcept;
    void findLineContaining  (const Position& pos, Position& start, Position& end) const noexcept;
 
    //==============================================================================
    class JUCE_API  Listener
    {
    public:
        Listener() = default;
        virtual ~Listener() = default;

        virtual void codeDocumentTextInserted (const String& newText, int insertIndex) = 0;

        virtual void codeDocumentTextDeleted (int startIndex, int endIndex) = 0;
    };

    void addListener (Listener* listener);

    void removeListener (Listener* listener);
 
    //==============================================================================
    class JUCE_API  Iterator
    {
    public:
        Iterator() noexcept;
 
        Iterator (const CodeDocument& document) noexcept;
        Iterator (CodeDocument::Position) noexcept;
        ~Iterator() noexcept;
 
        Iterator (const Iterator&) = default;
        Iterator& operator= (const Iterator&) = default;

        juce_wchar nextChar() noexcept;

        juce_wchar peekNextChar() const noexcept;

        juce_wchar previousChar() noexcept;

        juce_wchar peekPreviousChar() const noexcept;

        void skip() noexcept;

        int getPosition() const noexcept        { return position; }

        void skipWhitespace() noexcept;

        void skipToEndOfLine() noexcept;

        void skipToStartOfLine() noexcept;

        int getLine() const noexcept            { return line; }

        bool isEOF() const noexcept;

        bool isSOF() const noexcept;

        CodeDocument::Position toPosition() const;
 
    private:
        bool reinitialiseCharPtr() const;
 
        const CodeDocument* document;
        mutable String::CharPointerType charPointer { nullptr };
        int line = 0, position = 0;
    };
 
private:
    //==============================================================================
    struct InsertAction;
    struct DeleteAction;
    friend class Iterator;
    friend class Position;
 
    OwnedArray<CodeDocumentLine> lines;
    Array<Position*> positionsToMaintain;
    UndoManager undoManager;
    int currentActionIndex = 0, indexOfSavedState = -1;
    int maximumLineLength = -1;
    ListenerList<Listener> listeners;
    String newLineChars { "\r\n" };
 
    void insert (const String& text, int insertPos, bool undoable);
    void remove (int startPos, int endPos, bool undoable);
    void checkLastLineStatus();
 
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (CodeDocument)
};
 
} // namespace juce