Cadabra
Computer algebra system for field theory problems
TeXEngine.hh
Go to the documentation of this file.
1 
2 #pragma once
3 
4 #include <stdexcept>
5 #include <vector>
6 #include <set>
7 #include <string>
8 #include <memory>
9 
10 namespace cadabra {
11 
22 
23  class TeXEngine {
24  public:
25  class TeXException : public std::logic_error {
26  public:
27  TeXException(const std::string&);
28  };
29 
30  class TeXRequest {
31  public:
32  TeXRequest();
33  friend class TeXEngine;
34 
35  unsigned width() const;
36  unsigned height() const;
37  const std::vector<unsigned char>& image() const;
38 
39  private:
40  std::string latex_string;
41  std::string start_wrap, end_wrap;
43  bool has_error; // currently set, but never re-set, and unused.
44  std::vector<unsigned char> image_;
45  unsigned width_, height_;
46  };
47 
48  TeXEngine();
49  ~TeXEngine();
50 
51  // Set the width and font size for all images to be generated.
52  void set_geometry(int horizontal_pixels);
53 
54  // Get the width.
55  int get_geometry() const;
56 
57  // Set the scale factor for generating bitmaps. The total scale is
58  // the product of HiDPI scale and any text-scaling factor on top of
59  // that, so that it represents the total scale at which text renders.
60  // The device_scale is just the HiDPI factor; we need to generate
61  // bitmaps at the width times this size.
62  void set_scale(double total_scale, double device_scale);
63  double get_scale() const;
64  void set_font_size(int font_size);
65  std::vector<std::string> latex_packages;
66 
67  // All checkin/checkout conversion routines. TeXEngine keeps
68  // track of all TeXRequests in order to be able to convert
69  // all of them in one shot (with one LaTeX run), which you can
70  // do with 'convert_all'.
71 
72  // You can share the result in a TeXRequest in multiple
73  // widgets, but you need to call checkout if a widget no
74  // longer needs it. TeXEngine will then run a cleanup on all
75  // TeXRequests that are no longer referenced except by
76  // itself.
77 
78  std::shared_ptr<TeXRequest> checkin(const std::string&,
79  const std::string& startwrap, const std::string& endwrap);
80  std::shared_ptr<TeXRequest> modify(std::shared_ptr<TeXRequest>, const std::string&);
81 
83  void convert_all();
84 
87  void invalidate_all();
88 
90  void checkout(std::shared_ptr<TeXRequest>);
91  void checkout_all();
92 
93  private:
94  std::string convert_unicode_to_tex(const std::string&) const;
95 
96  static double millimeter_per_inch;
97 
98  std::set<std::shared_ptr<TeXRequest> > requests;
99 
100  std::string preamble_string;
104 
105  void erase_file(const std::string&) const;
106  void convert_one(std::shared_ptr<TeXRequest>);
107  void convert_set(std::set<std::shared_ptr<TeXRequest> >&);
108 
109  std::string handle_latex_errors(const std::string&, int exit_code) const;
110  };
111 
112  }
cadabra::TeXEngine::convert_set
void convert_set(std::set< std::shared_ptr< TeXRequest > > &)
Definition: TeXEngine.cc:337
cadabra::TeXEngine::TeXException
Definition: TeXEngine.hh:25
cadabra::TeXEngine::convert_unicode_to_tex
std::string convert_unicode_to_tex(const std::string &) const
Definition: TeXEngine.cc:43
cadabra::TeXEngine::convert_all
void convert_all()
Generate images for all TeXRequests which are labelled as needing conversion.
Definition: TeXEngine.cc:294
cadabra::TeXEngine::TeXRequest::end_wrap
std::string end_wrap
Definition: TeXEngine.hh:41
cadabra::TeXEngine::TeXRequest::width
unsigned width() const
Definition: TeXEngine.cc:108
cadabra::TeXEngine::convert_one
void convert_one(std::shared_ptr< TeXRequest >)
Definition: TeXEngine.cc:329
cadabra::TeXEngine::get_scale
double get_scale() const
Definition: TeXEngine.cc:244
cadabra::TeXEngine::set_scale
void set_scale(double total_scale, double device_scale)
Definition: TeXEngine.cc:230
cadabra::TeXEngine::TeXRequest::has_error
bool has_error
Definition: TeXEngine.hh:43
cadabra::TeXEngine::invalidate_all
void invalidate_all()
Mark all TeXRequests as needing re-generating.
Definition: TeXEngine.cc:278
cadabra::TeXEngine::TeXEngine
TeXEngine()
Definition: TeXEngine.cc:183
set
VERSION_LESS set(CMAKE_CXX_STANDARD 14) message(STATUS "Using C++14 as you are using CMkake < 3.8
cadabra::TeXEngine::~TeXEngine
~TeXEngine()
Definition: TeXEngine.cc:179
cadabra::TeXEngine::checkout_all
void checkout_all()
Definition: TeXEngine.cc:273
cadabra::TeXEngine::handle_latex_errors
std::string handle_latex_errors(const std::string &, int exit_code) const
Definition: TeXEngine.cc:128
cadabra::TeXEngine::erase_file
void erase_file(const std::string &) const
Definition: TeXEngine.cc:123
cadabra::TeXEngine::TeXRequest
Definition: TeXEngine.hh:30
cadabra::TeXEngine::TeXRequest::image
const std::vector< unsigned char > & image() const
Definition: TeXEngine.cc:118
cadabra::TeXEngine::latex_packages
std::vector< std::string > latex_packages
Definition: TeXEngine.hh:65
cadabra::TeXEngine::requests
std::set< std::shared_ptr< TeXRequest > > requests
Definition: TeXEngine.hh:98
cadabra::TeXEngine::modify
std::shared_ptr< TeXRequest > modify(std::shared_ptr< TeXRequest >, const std::string &)
Definition: TeXEngine.cc:287
cadabra::TeXEngine::preamble_string
std::string preamble_string
Definition: TeXEngine.hh:100
cadabra::TeXEngine::TeXRequest::TeXRequest
TeXRequest()
Definition: TeXEngine.cc:249
cadabra::TeXEngine::TeXRequest::width_
unsigned width_
Definition: TeXEngine.hh:45
cadabra::TeXEngine::set_geometry
void set_geometry(int horizontal_pixels)
Definition: TeXEngine.cc:199
cadabra::TeXEngine::TeXRequest::start_wrap
std::string start_wrap
Definition: TeXEngine.hh:41
cadabra::TeXEngine::checkout
void checkout(std::shared_ptr< TeXRequest >)
Mark a TeXRequest as no longer being needed.
Definition: TeXEngine.cc:266
cadabra::TeXEngine::TeXException::TeXException
TeXException(const std::string &)
Definition: TeXEngine.cc:38
cadabra::TeXEngine
Definition: TeXEngine.hh:23
cadabra::TeXEngine::checkin
std::shared_ptr< TeXRequest > checkin(const std::string &, const std::string &startwrap, const std::string &endwrap)
Definition: TeXEngine.cc:254
cadabra::TeXEngine::TeXRequest::image_
std::vector< unsigned char > image_
Definition: TeXEngine.hh:44
cadabra::TeXEngine::TeXRequest::needs_generating
bool needs_generating
Definition: TeXEngine.hh:42
cadabra::TeXEngine::TeXRequest::latex_string
std::string latex_string
Definition: TeXEngine.hh:40
cadabra
Functions to handle the exchange properties of two or more symbols in a product.
Definition: Adjform.cc:83
cadabra::TeXEngine::font_size_
int font_size_
Definition: TeXEngine.hh:102
cadabra::TeXEngine::total_scale_
double total_scale_
Definition: TeXEngine.hh:103
cadabra::TeXEngine::get_geometry
int get_geometry() const
Definition: TeXEngine.cc:212
cadabra::TeXEngine::TeXRequest::height
unsigned height() const
Definition: TeXEngine.cc:113
cadabra::TeXEngine::set_font_size
void set_font_size(int font_size)
Definition: TeXEngine.cc:217
cadabra::TeXEngine::TeXRequest::height_
unsigned height_
Definition: TeXEngine.hh:45
cadabra::TeXEngine::horizontal_pixels_
int horizontal_pixels_
Definition: TeXEngine.hh:101
cadabra::TeXEngine::device_scale_
double device_scale_
Definition: TeXEngine.hh:103
cadabra::TeXEngine::millimeter_per_inch
static double millimeter_per_inch
Definition: TeXEngine.hh:96