Actions.hh

Go to the documentation of this file.

#pragma once

// All modifications to the document are done by calling 'perform' with an 
// action object. This enables us to implement an undo stack. This method
// will take care of making the actual change to the DTree document, and
// call back on the 'change' methods above to inform the derived class
// that a change has been made. 

#include "DataCell.hh"
#include "DocumentThread.hh"

#include <memory>

namespace cadabra {

    class DocumentThread;
    class GUIBase;



    class ActionBase {
        public:
            ActionBase(DataCell::id_t ref_id);
            

            virtual void execute(DocumentThread&, GUIBase&);


            virtual void revert(DocumentThread&, GUIBase&)=0;

            virtual bool undoable() const;

        protected:
            DataCell::id_t  ref_id;
            DTree::iterator ref;
    };
    
    
    class ActionAddCell : public ActionBase {
        public:
            enum class Position { before, after, child };
            
            ActionAddCell(DataCell, DataCell::id_t  ref_, Position pos_);           
            
            virtual void execute(DocumentThread&, GUIBase&) override;
            virtual void revert(DocumentThread&,  GUIBase&) override;
            
        private:
            // Keep track of the location where this cell is inserted into
            // the notebook. 

            DataCell          newcell;
            DTree::iterator   newref;
            Position          pos;
            int               child_num;
    };



    class ActionPositionCursor : public ActionBase {
        public:
            enum class Position { in, next, previous };

            ActionPositionCursor(DataCell::id_t ref_id_, Position pos_);

            virtual void execute(DocumentThread&, GUIBase&) override;
            virtual void revert(DocumentThread&,  GUIBase&) override;

        private:
            bool              needed_new_cell;
            DTree::iterator   newref;
            Position          pos;
    };


    class ActionSetRunStatus : public ActionBase {
        public:
            ActionSetRunStatus(DataCell::id_t ref_id_, bool running);

            virtual void execute(DocumentThread&, GUIBase&) override;
            virtual void revert(DocumentThread&,  GUIBase&) override;

            virtual bool undoable() const override;
        private:
            DTree::iterator this_cell;
            bool            was_running_, new_running_;
    };
    


    class ActionRemoveCell : public ActionBase {
        public:
            ActionRemoveCell(DataCell::id_t ref_id_);
            ~ActionRemoveCell();
            
            virtual void execute(DocumentThread&, GUIBase&) override;
            virtual void revert(DocumentThread&,  GUIBase&) override;

        private:
            // Keep track of the location where this cell (and its child
            // cells) was in the notebook.  We keep a reference to the
            // parent cell and the index of the current cell as child of
            // that parent.

            DTree             removed_tree;
            DTree::iterator   reference_parent_cell;
            size_t            reference_child_index;
    };


    class ActionSplitCell : public ActionBase {
        public:
            ActionSplitCell(DataCell::id_t ref_id);
            ~ActionSplitCell();

            virtual void execute(DocumentThread&, GUIBase&) override;
            virtual void revert(DocumentThread&,  GUIBase&) override;
            
        private:
            DTree::iterator newref; // the newly created cell
    };

    

    class ActionInsertText : public ActionBase {
        public:
            ActionInsertText(DataCell::id_t ref_id, int pos, const std::string&);
            
            virtual void execute(DocumentThread&, GUIBase&) override;
            virtual void revert(DocumentThread&,  GUIBase&) override;
            
        private:
            DTree::iterator   this_cell;
            int         insert_pos;
            std::string text;
    };
    

    class ActionEraseText : public ActionBase {
        public:
            ActionEraseText(DataCell::id_t ref_id, int, int);
            
            virtual void execute(DocumentThread&, GUIBase&) override;
            virtual void revert(DocumentThread&,  GUIBase&) override;
            
        private:
            DTree::iterator   this_cell;
            int from_pos, to_pos;
            std::string removed_text;
    };
    
}


//
//       class ActionMergeCells