textundostack.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 <QMap>
#include <QStack>
 
namespace edbee {
 
class Change;
class TextDocument;
class TextEditorController;
class ChangeGroup;
 

 
class EDBEE_EXPORT TextUndoStack : public QObject
{
    Q_OBJECT
 
public:

    enum EndUndoGroupAction {
        ActionUngrouped,        
        ActionFullDiscard,      
        ActionEnd               
 
    };
    enum EndUndoGroupAction {…};
 
public:
    explicit TextUndoStack( TextDocument* doc, QObject* parent = 0);
    virtual ~TextUndoStack();
    void clear();
 
    void registerContoller( TextEditorController* controller );
    void unregisterController( TextEditorController* controller );
    bool isControllerRegistered( TextEditorController* controller );
 
    void beginUndoGroup( ChangeGroup* group );
    ChangeGroup* currentGroup();
    void endUndoGroup(int coalesceId , bool flatten);
    void endUndoGroupAndDiscard();
    int undoGroupLevel();
 
    int lastCoalesceIdAtCurrentLevel();
    void setLastCoalesceIdAtCurrentLevel(int id);
    void resetAllLastCoalesceIds();
 
    Change* giveChange( Change* change, int coalesceId );
 
    bool canUndo( TextEditorController* controller=0 );
    bool canRedo( TextEditorController* controller=0 );
 
    void undo( TextEditorController* controller=0, bool controllerOnly=false );
    void redo( TextEditorController* controller=0, bool controllerOnly=false );
 
    bool isCollectionEnabled() { return collectionEnabled_; }
    void setCollectionEnabled( bool enabled ) { collectionEnabled_ = enabled; }
 
    bool isUndoRunning() { return undoRunning_; }
    bool isRedoRunning() { return redoRunning_; }
 
    int size();
    Change* at(int idx);
    int currentIndex( TextEditorController* controller=0 );
    int lastIndex( TextEditorController* controller=0 );
    Change* last(TextEditorController* controller=0 );
 
    int sizeInDocChanges();
    int currentIndexInDocChanges();
 
    Change* findRedoChange( TextEditorController* controller=0);
    Change* findUndoChange( TextEditorController* controller=0 );
 
    void setPersisted(bool enabled);
    bool isPersisted();
    int persistedIndex();
 
    TextDocument* document() { return documentRef_; }
 
    QString dumpStack();
    void dumpStackInternal();
 
protected:
    int findRedoIndex( int index, TextEditorController* controller=0 );
    int findUndoIndex( int index, TextEditorController* controller=0 );
    void clearRedo( TextEditorController* controller );
    bool undoControllerChange( TextEditorController* controller );
    void undoDocumentChange();
    bool redoControllerChange( TextEditorController* controller );
    void redoDocumentChange();
 
    void setPersistedIndex( int index );
    void setChangeIndex( int index );
 
signals:
 
    void undoGroupStarted( edbee::ChangeGroup* group );

    void undoGroupEnded( int coalesceId, bool merged, int action );
    void changeAdded( edbee::Change* change );
//    void changeMerged( edbee::TextChange* oldChange, edbee::TextChange* change );
    void undoExecuted( edbee::Change* change );
    void redoExecuted( edbee::Change* change );

    void persistedChanged(bool persisted);
 
 
private:
    void clearHistoryLists();
 
 
    TextDocument* documentRef_;                           
 
    QList<Change*> changeList_;                       
    int changeIndex_;                                     
    QMap<TextEditorController*,int> controllerIndexMap_;  
    int persistedIndex_;                                  
 
    QStack<ChangeGroup*> undoGroupStack_;             
    QStack<int> lastCoalesceIdStack_;                     
 
//    int undoGroupLevel_;                                 ///< The undo group level
//    TextChangeGroup* undoGroup_;                         ///< The current undo group
    bool collectionEnabled_;                               
 
    bool undoRunning_;                                    
    bool redoRunning_;                                    
};
class EDBEE_EXPORT TextUndoStack : public QObject {…};
 
} // edbee