DocumentThread.hh

Go to the documentation of this file.

#pragma once

#include <queue>
#include <mutex>
#include <stack>

#include "DataCell.hh"
#include "tree.hh"

namespace cadabra {

   class ActionBase;
   class ActionAddCell;
    class ActionPositionCursor;
    class ActionRemoveCell;
    class ActionSetRunStatus;
    class ActionSplitCell;
    class ActionInsertText;
    class ActionEraseText;
   class ComputeThread;
   class GUIBase;



   class DocumentThread {
        public:
         DocumentThread(GUIBase *);


         DocumentThread(const DocumentThread&)=delete;


         void set_compute_thread(ComputeThread *);


            void build_visual_representation();
            
            
            void queue_action(std::shared_ptr<ActionBase>);


         void new_document();


            void load_from_string(const std::string&);

            void undo();

            friend ActionBase;
         friend ActionAddCell;
            friend ActionPositionCursor;
            friend ActionRemoveCell;
            friend ActionSplitCell;
            friend ActionSetRunStatus;
            friend ActionInsertText;
            friend ActionEraseText;
    

            bool is_registered() const;


            void set_user_details(const std::string& name, const std::string& email, const std::string& affiliation);

        protected:
         GUIBase       *gui;
         ComputeThread *compute;


            DTree          doc;
            

         std::mutex                                       stack_mutex;
            typedef std::stack<std::shared_ptr<ActionBase> > ActionStack;
            ActionStack                                      undo_stack, redo_stack;
            std::queue<std::shared_ptr<ActionBase> >         pending_actions;           
            bool                                             disable_stacks;


         void                                             process_action_queue();


            bool  registered;

            enum class help_t { algorithm, property, latex, none };
            bool help_type_and_topic(const std::string& before, const std::string& after,
                                             help_t& help_type, std::string& help_topic) const;

    };
    
}