Cadabra
Computer algebra system for field theory problems
Classes | Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
cadabra::DocumentThread Class Reference

Description

A base class with all the logic to manipulate a Cadabra notebook document. Relies on the various objects derived from ActionBase in order to get actual work done. All methods here will always run on the GUI thread.

In order to implement a GUI, derive from both DocumentThread and GUIBase and then implement the virtual functions of the latter (those implement basic insertion/removal of notebook cells; the logic to figure out which ones and to implement the undo/redo stack is all in the GUI-agnostic DocumentThread).

#include <DocumentThread.hh>

Inheritance diagram for cadabra::DocumentThread:
cadabra::NotebookWindow

Classes

class  Prefs
 

Public Member Functions

 DocumentThread (GUIBase *)
 
 DocumentThread (const DocumentThread &)=delete
 It is not possible to copy-construct a DocumentThread as it holds on to resources which are not easily copied (such as GUI elements). More...
 
virtual void set_compute_thread (ComputeThread *)
 Let the notebook know about the ComputeThread so that it can send cells for evaluation. More...
 
void build_visual_representation ()
 Ensure that the gui has an up-to-date representation of the dtree. More...
 
void queue_action (std::shared_ptr< ActionBase >)
 All changes to the document should be made by submitting ActionBase derived objects to the 'queue_action' function, so that an undo stack can be kept. More...
 
void new_document ()
 Setup an empty new document with a single Python input cell. More...
 
void load_from_string (const std::string &)
 Load a new notebook from a JSON string. More...
 
virtual void on_interactive_output (const Json::Value &msg)
 
void undo ()
 One undo step. More...
 
void set_user_details (const std::string &name, const std::string &email, const std::string &affiliation)
 Set user details which will be sent to the Cadabra log server. More...
 

Public Attributes

friend ActionBase
 
friend ActionAddCell
 
friend ActionPositionCursor
 
friend ActionRemoveCell
 
friend ActionSplitCell
 
friend ActionSetRunStatus
 
friend ActionInsertText
 
friend ActionEraseText
 
Prefs prefs
 

Protected Types

enum  help_t { help_t::algorithm, help_t::property, help_t::latex, help_t::none }
 Help system. More...
 
typedef std::stack< std::shared_ptr< ActionBase > > ActionStack
 

Protected Member Functions

void process_action_queue ()
 Process the action queue. More...
 
bool help_type_and_topic (const std::string &before, const std::string &after, help_t &help_type, std::string &help_topic) const
 

Protected Attributes

GUIBasegui
 
ComputeThreadcompute
 
DTree doc
 The actual document tree. More...
 
std::mutex stack_mutex
 The action undo/redo/todo stacks and logic to execute them. More...
 
ActionStack undo_stack
 
ActionStack redo_stack
 
std::queue< std::shared_ptr< ActionBase > > pending_actions
 
bool disable_stacks
 

Member Typedef Documentation

◆ ActionStack

typedef std::stack<std::shared_ptr<ActionBase> > cadabra::DocumentThread::ActionStack
protected

Member Enumeration Documentation

◆ help_t

enum cadabra::DocumentThread::help_t
strongprotected

Help system.

Enumerator
algorithm 
property 
latex 
none 

Constructor & Destructor Documentation

◆ DocumentThread() [1/2]

DocumentThread::DocumentThread ( GUIBase g)

◆ DocumentThread() [2/2]

cadabra::DocumentThread::DocumentThread ( const DocumentThread )
delete

It is not possible to copy-construct a DocumentThread as it holds on to resources which are not easily copied (such as GUI elements).

Member Function Documentation

◆ build_visual_representation()

void DocumentThread::build_visual_representation ( )

Ensure that the gui has an up-to-date representation of the dtree.

Traverses the entire tree so is expensive to run and should only be used when loading new documents or creating a new canvas view.

◆ help_type_and_topic()

bool DocumentThread::help_type_and_topic ( const std::string &  before,
const std::string &  after,
help_t help_type,
std::string &  help_topic 
) const
protected

◆ load_from_string()

void DocumentThread::load_from_string ( const std::string &  json)

Load a new notebook from a JSON string.

Should only be called from the GUI thread. Will cancel any pending operations on the existing notebook (if present) first.

◆ new_document()

void DocumentThread::new_document ( )

Setup an empty new document with a single Python input cell.

◆ on_interactive_output()

void DocumentThread::on_interactive_output ( const Json::Value &  msg)
virtual

Reimplemented in cadabra::NotebookWindow.

◆ process_action_queue()

void DocumentThread::process_action_queue ( )
protected

Process the action queue.

It is allowed to call queue_action() above while this is running. So a running action can add more actions.

◆ queue_action()

void DocumentThread::queue_action ( std::shared_ptr< ActionBase ab)

All changes to the document should be made by submitting ActionBase derived objects to the 'queue_action' function, so that an undo stack can be kept.

They are then processed by calling the 'process_action_queue' method (only available from this thread).

◆ set_compute_thread()

void DocumentThread::set_compute_thread ( ComputeThread cl)
virtual

Let the notebook know about the ComputeThread so that it can send cells for evaluation.

Notebook does NOT own this pointer.

Reimplemented in cadabra::NotebookWindow.

◆ set_user_details()

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

Set user details which will be sent to the Cadabra log server.

◆ undo()

void DocumentThread::undo ( )

One undo step.

Member Data Documentation

◆ ActionAddCell

friend cadabra::DocumentThread::ActionAddCell

◆ ActionBase

friend cadabra::DocumentThread::ActionBase

◆ ActionEraseText

friend cadabra::DocumentThread::ActionEraseText

◆ ActionInsertText

friend cadabra::DocumentThread::ActionInsertText

◆ ActionPositionCursor

friend cadabra::DocumentThread::ActionPositionCursor

◆ ActionRemoveCell

friend cadabra::DocumentThread::ActionRemoveCell

◆ ActionSetRunStatus

friend cadabra::DocumentThread::ActionSetRunStatus

◆ ActionSplitCell

friend cadabra::DocumentThread::ActionSplitCell

◆ compute

ComputeThread* cadabra::DocumentThread::compute
protected

◆ disable_stacks

bool cadabra::DocumentThread::disable_stacks
protected

◆ doc

DTree cadabra::DocumentThread::doc
protected

The actual document tree.

This object is only modified on the GUI thread, either directly by code in DocumentThread, or by code in the various objects derived from ActionBase. In particular, ComputeThread cannot access this tree directly.

◆ gui

GUIBase* cadabra::DocumentThread::gui
protected

◆ pending_actions

std::queue<std::shared_ptr<ActionBase> > cadabra::DocumentThread::pending_actions
protected

◆ prefs

Prefs cadabra::DocumentThread::prefs

◆ redo_stack

ActionStack cadabra::DocumentThread::redo_stack
protected

◆ stack_mutex

std::mutex cadabra::DocumentThread::stack_mutex
protected

The action undo/redo/todo stacks and logic to execute them.

These stacks can be accessed from both the DocumentThread as well as the ComputeThread (the latter does it through the DocumentThread::queue_action method), so they need a mutex to access them.

◆ undo_stack

ActionStack cadabra::DocumentThread::undo_stack
protected

The documentation for this class was generated from the following files: