textdocument.h

Go to the documentation of this file.

// edbee - Copyright (c) 2012-2025 by Rick Blommers and contributors
// SPDX-License-Identifier: MIT
 
#pragma once
 
#include "edbee/exports.h"
 
#include <QObject>
#include <QList>
 
#include "edbee/models/textbuffer.h"
 
namespace edbee {
 
 
class TextGrammar;
class Change;
class ChangeGroup;
class TextAutoCompleteProviderList;
class TextCodec;
class TextDocumentFilter;
class TextDocumentScopes;
class TextEditorConfig;
class TextEditorController;
class LineEnding;
class TextLexer;
class TextLineData;
class TextLineDataManager;
class TextRangeSet;
class TextUndoStack;

class EDBEE_EXPORT TextDocument : public QObject
{
 
Q_OBJECT
 
public:
 
    TextDocument( QObject* parent=0);
    virtual ~TextDocument();

    virtual TextBuffer* buffer() const = 0 ;

    virtual void setLineDataFieldsPerLine( int count );

    virtual TextLineDataManager* lineDataManager() { return textLineDataManager_; }
    virtual void giveLineDataManager(TextLineDataManager* manager);
    virtual void giveLineData( int line, int field, TextLineData* dataItem );
    virtual TextLineData* getLineData( int line, int field );
//    virtual TextLineData* takeLineData( int line, int field ) = 0;

    virtual TextDocumentScopes* scopes() = 0;

    virtual TextCodec* encoding() = 0;
    virtual void setEncoding( TextCodec* codec ) = 0;

    virtual const LineEnding* lineEnding() = 0 ;
    virtual void setLineEnding( const LineEnding* lineENding ) = 0;

    virtual TextLexer* textLexer() = 0;

    virtual TextGrammar* languageGrammar() = 0;

    virtual void setLanguageGrammar( TextGrammar* grammar ) = 0;
 

    virtual TextAutoCompleteProviderList* autoCompleteProviderList() = 0;

    virtual TextUndoStack* textUndoStack() = 0;
    virtual void beginUndoGroup(ChangeGroup* group=0);
    virtual void endUndoGroup(int coalesceId, bool flatten=false );
    virtual void endUndoGroupAndDiscard();
    virtual bool isUndoCollectionEnabled();
    virtual void setUndoCollectionEnabled( bool enabled );
    virtual bool isUndoRunning();
    virtual bool isRedoRunning();
    virtual bool isUndoOrRedoRunning();
    virtual bool isPersisted();
    virtual void setPersisted(bool enabled=true);

    virtual TextEditorConfig* config() const = 0;
 
    virtual void setDocumentFilter( TextDocumentFilter* filter );
    virtual void giveDocumentFilter( TextDocumentFilter* filter );
    virtual TextDocumentFilter* documentFilter();
 
    void beginChanges( TextEditorController* controller );
    void replaceRangeSet(TextRangeSet& rangeSet, const QString& text, bool stickySelection = false);
    void replaceRangeSet(TextRangeSet& rangeSet, const QStringList& texts, bool stickySelection = false);
    void giveSelection( TextEditorController* controller,  TextRangeSet* rangeSet);
    void endChanges( int coalesceId );
 
 
 
    Change* executeAndGiveChange(Change* change , int coalesceId );
 
 
//    void giveChange( TextChange* change, bool merge  );
    virtual Change* giveChangeWithoutFilter( Change* change, int coalesceId) = 0;
    void append(const QString& text, int coalesceId=0 );
    void replace( int offset, int length, const QString& text, int coalesceId=0);
    void setText( const QString& text );
 
    // raw access for filling the document
    void rawAppendBegin();
    void rawAppendEnd();
    void rawAppend( QChar c );
    void rawAppend(const QChar *chars, int length );
 
public:
 
 // Methods directly forwarded to the  textbuffer
 
    int length();
    int lineCount();
    QChar charAt(int idx);
    QChar charAtOrNull(int idx);
    int offsetFromLine( int line );
    int lineFromOffset( int offset );
    int columnFromOffsetAndLine( int offset, int line=-1 );
    int offsetFromLineAndColumn( int line, int column );
    int lineLength( int line );
    int lineLengthWithoutNewline( int line );
    QString text();
    QString textPart( int offset, int length );
    QString lineWithoutNewline( int line );
    QString line( int line );
 
signals:
 
    void textAboutToBeChanged( edbee::TextBufferChange change );
    void textChanged( edbee::TextBufferChange change, QString oldText = QString() );

    void persistedChanged(bool persisted);

    void languageGrammarChanged();

    void lastScopedOffsetChanged( int previousOffset, int lastScopedOffset );
 
 
private:
    TextDocumentFilter* documentFilter_;             
    TextDocumentFilter* documentFilterRef_;          
 
    TextLineDataManager* textLineDataManager_;               
 
};
class EDBEE_EXPORT TextDocument : public QObject {…};
 
} // edbee