Cadabra
Computer algebra system for field theory problems
DataCell.hh
Go to the documentation of this file.
1 
2 #pragma once
3 
4 #include <string>
5 #include <mutex>
6 
7 #include "tree.hh"
8 #include "nlohmann/json.hpp"
9 
10 namespace cadabra {
11 
26 
27  class DataCell {
28  public:
29 
33 
34  enum class CellType {
35  document,
36  python,
37  latex,
38  output,
39  verbatim,
40  latex_view,
41  input_form,
42  image_png,
43  error,
44  // section
45  };
46 
50 
51  class id_t {
52  public:
53  id_t();
54 
55  uint64_t id;
57 
58  bool operator<(const id_t& other) const;
59  };
60 
62 
63  DataCell(CellType t=CellType::python, const std::string& str="", bool hidden=false);
64 
67 
68  DataCell(id_t, CellType t=CellType::python, const std::string& str="", bool hidden=false);
69 
71 
72  DataCell(const DataCell&);
73 
75 
80 
81  std::string textbuf;
82 
87 
88  bool hidden;
89  bool sensitive;
90 
93 
95 
99 
100  bool running;
101 
102  id_t id() const;
103 
104  private:
106  };
107 
108  typedef tree<DataCell> DTree;
109 
112 
113  std::string JSON_serialise(const DTree&);
114  void JSON_recurse(const DTree&, DTree::iterator, nlohmann::json&);
115 
117 
118  void JSON_deserialise(const std::string&, DTree&);
119  void JSON_in_recurse(DTree& doc, DTree::iterator loc, const nlohmann::json& cells);
120 
122 
123  std::string export_as_HTML(const DTree& doc, bool for_embedding=false, bool
124  strip_code=false, std::string title="");
125  void HTML_recurse(const DTree& doc, DTree::iterator it, std::ostringstream& str,
126  const std::string& preamble_string,
127  bool for_embedding=false, bool strip_code=false, std::string title="");
128 
131 
132  std::string latex_to_html(const std::string&);
133 
136 
137  std::string export_as_LaTeX(const DTree& doc, const std::string& image_file_base, bool for_embedding=false);
138  void LaTeX_recurse(const DTree& doc, DTree::iterator it, std::ostringstream& str,
139  const std::string& preamble_string, const std::string& image_file_base,
140  int& image_num, bool for_embedding);
141 
144 
145  std::string export_as_python(const DTree& doc);
146  void python_recurse(const DTree& doc, DTree::iterator it, std::ostringstream& str);
147 
149  // std::string replace_all(std::string, const std::string& old, const std::string& nw);
150 
153 
154  nlohmann::json ipynb2cnb(const nlohmann::json&);
155 
157 
158  nlohmann::json cnb2ipynb(const nlohmann::json&);
159 }
cadabra::DataCell::CellType::image_png
@ image_png
output: cell showing a base64 encoded PNG image
cadabra::DataCell::serial_number
id_t serial_number
Definition: DataCell.hh:105
cadabra::LaTeX_recurse
void LaTeX_recurse(const DTree &doc, DTree::iterator it, std::ostringstream &str, const std::string &preamble_string, const std::string &image_file_base, int &image_num, bool for_embedding)
Definition: DataCell.cc:534
cadabra::python_recurse
void python_recurse(const DTree &doc, DTree::iterator it, std::ostringstream &str)
Definition: DataCell.cc:656
cadabra::DataCell::CellType::error
@ error
output: cell showing LaTeX text for errors
cadabra::JSON_deserialise
void JSON_deserialise(const std::string &, DTree &)
Load a document from .cnb format, i.e. the inverse of the above.
Definition: DataCell.cc:371
cadabra::DataCell::ignore_on_import
bool ignore_on_import
Flag indicating whether this cell should be ignored in case the notebook is imported.
Definition: DataCell.hh:94
cadabra::export_as_LaTeX
std::string export_as_LaTeX(const DTree &doc, const std::string &image_file_base, bool for_embedding=false)
Export a document to a single self-contained LaTeX file, with the exception of images which get saved...
Definition: DataCell.cc:511
cadabra::DataCell
Definition: DataCell.hh:27
cadabra::DataCell::CellType
CellType
Cells are labelled with the data type of its contents, which is stored in a textural representation b...
Definition: DataCell.hh:34
cadabra::DataCell::DataCell
DataCell(CellType t=CellType::python, const std::string &str="", bool hidden=false)
Standard constructor, generates a new unique id for this DataCell.
Definition: DataCell.cc:44
cadabra::DataCell::running
bool running
Indicator whether this cell is currently being evaluated by the server.
Definition: DataCell.hh:100
cadabra::DataCell::CellType::latex
@ latex
input : editor cell for code in latex
cadabra::JSON_serialise
std::string JSON_serialise(const DTree &)
Serialise a document into .cj format, which is a JSON version of the document tree.
Definition: DataCell.cc:290
cadabra::DataCell::CellType::input_form
@ input_form
output: cell containing input form of preceding output cell
cadabra::export_as_HTML
std::string export_as_HTML(const DTree &doc, bool for_embedding=false, bool strip_code=false, std::string title="")
Export a document to a single self-contained HTML file containing inline CSS.
Definition: DataCell.cc:74
cadabra::DataCell::CellType::output
@ output
output: cell showing python stdout, verbatim
cadabra::DataCell::CellType::python
@ python
input : editor cell for code in python
cadabra::JSON_in_recurse
void JSON_in_recurse(DTree &doc, DTree::iterator loc, const nlohmann::json &cells)
Definition: DataCell.cc:400
cadabra::DataCell::cell_type
CellType cell_type
Definition: DataCell.hh:74
cadabra::DataCell::id
id_t id() const
Definition: DataCell.cc:506
cadabra::DataCell::id_t::operator<
bool operator<(const id_t &other) const
Definition: DataCell.cc:31
cadabra::DataCell::id_t
Each cell is identified by a serial number 'id' which is used to keep track of it across network call...
Definition: DataCell.hh:51
cadabra::DataCell::id_t::created_by_client
bool created_by_client
Definition: DataCell.hh:56
cadabra::DTree
tree< DataCell > DTree
Definition: DataCell.hh:108
cadabra::DataCell::CellType::latex_view
@ latex_view
output: cell showing LaTeX text formatted using LaTeX
cadabra::DataCell::CellType::verbatim
@ verbatim
output: cell showing other verbatim output
cadabra::DataCell::hidden
bool hidden
Flag indicating whether this cell should be hidden from view.
Definition: DataCell.hh:88
cadabra::HTML_recurse
void HTML_recurse(const DTree &doc, DTree::iterator it, std::ostringstream &str, const std::string &preamble_string, bool for_embedding=false, bool strip_code=false, std::string title="")
Definition: DataCell.cc:174
cadabra::DataCell::id_t::id_t
id_t()
Definition: DataCell.cc:38
cadabra
Functions to handle the exchange properties of two or more symbols in a product.
Definition: Adjform.cc:83
cadabra::ipynb2cnb
nlohmann::json ipynb2cnb(const nlohmann::json &)
Replace all occurrences of a substring in the original string.
Definition: DataCell.cc:689
cadabra::cnb2ipynb
nlohmann::json cnb2ipynb(const nlohmann::json &)
Convert the JSON of a Cadabra notebook to a Jupyter notebook.
Definition: DataCell.cc:749
cadabra::latex_to_html
std::string latex_to_html(const std::string &)
Convert various LaTeX constructions to HTML-with-Mathjax, e.g.
Definition: DataCell.cc:92
cadabra::JSON_recurse
void JSON_recurse(const DTree &, DTree::iterator, nlohmann::json &)
Definition: DataCell.cc:301
cadabra::DataCell::sensitive
bool sensitive
Definition: DataCell.hh:89
cadabra::DataCell::CellType::document
@ document
head node, only one per document
cadabra::export_as_python
std::string export_as_python(const DTree &doc)
Export a document to a python-like file (converting text cells to comments and python cells to python...
Definition: DataCell.cc:648
cadabra::DataCell::textbuf
std::string textbuf
Textual representation of the cell content.
Definition: DataCell.hh:81
cadabra::DataCell::id_t::id
uint64_t id
Definition: DataCell.hh:55