4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Alejandro Aguilar Sierra
9 * \author Lars Gullik Bjønnes
10 * \author Stefan Schimanski
12 * Full author contact details are available in file CREDITS.
19 #include "MathClass.h"
21 #include "Dimension.h"
22 #include "OutputEnums.h"
24 #include "support/strfwd.h"
45 class TextMetricsInfo;
49 class MathData : private std::vector<MathAtom> {
51 /// re-use inhertited stuff
52 typedef std::vector<MathAtom> base_type;
53 using base_type::const_iterator;
54 using base_type::iterator;
55 using base_type::size_type;
56 using base_type::difference_type;
57 using base_type::size;
58 using base_type::empty;
59 using base_type::clear;
60 using base_type::begin;
62 using base_type::pop_back;
63 using base_type::back;
64 using base_type::front;
66 typedef size_type idx_type;
67 typedef size_type pos_type;
73 explicit MathData(Buffer * buf) : buffer_(buf) {}
75 MathData(Buffer * buf, const_iterator from, const_iterator to);
77 Buffer * buffer() { return buffer_; }
79 Buffer const * buffer() const { return buffer_; }
81 void append(MathData const & ar);
83 /// inserts single atom at position pos
84 void insert(size_type pos, MathAtom const & at);
85 /// inserts multiple atoms at position pos
86 void insert(size_type pos, MathData const & ar);
87 /// inserts single atom at end
88 void push_back(MathAtom const & at);
90 /// erase range from pos1 to pos2
91 void erase(iterator pos1, iterator pos2);
93 void erase(iterator pos);
94 /// erase range from pos1 to pos2
95 void erase(size_type pos1, size_type pos2);
97 void erase(size_type pos);
104 void replace(ReplaceData &);
106 void substitute(MathData const & m);
108 /// looks for exact match
109 bool match(MathData const & ar) const;
110 /// looks for inclusion match starting at pos
111 bool matchpart(MathData const & ar, pos_type pos) const;
112 /// looks for containment, return == size mean not found
113 size_type find(MathData const & ar) const;
114 /// looks for containment, return == size mean not found
115 size_type find_last(MathData const & ar) const;
117 bool contains(MathData const & ar) const;
119 void validate(LaTeXFeatures &) const;
121 /// checked write access
122 MathAtom & operator[](pos_type);
123 /// checked read access
124 MathAtom const & operator[](pos_type) const;
126 /// Add this array to a math row. Return true if contents got added
127 bool addToMathRow(MathRow &, MetricsInfo & mi) const;
129 /// rebuild cached metrics information
130 /** When \c tight is true, the height of the cell will be at least
131 * the x height of the font. Otherwise, it will be the max height
134 void metrics(MetricsInfo & mi, Dimension & dim, bool tight = true) const;
136 Dimension const & dimension(BufferView const &) const;
138 /// draw the selection over the cell
139 void drawSelection(PainterInfo & pi, int x, int y) const;
140 /// redraw cell using cache metrics information
141 void draw(PainterInfo & pi, int x, int y) const;
142 /// rebuild cached metrics information
143 void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
144 /// redraw cell using cache metrics information
145 void drawT(TextPainter & pi, int x, int y) const;
146 /// approximate mathclass of the data
147 MathClass mathClass() const;
148 /// math class of first interesting element
149 MathClass firstMathClass() const;
150 /// math class of last interesting element
151 MathClass lastMathClass() const;
152 /// is the cell in display style
153 bool displayStyle() const { return display_style_; }
155 /// access to cached x coordinate of last drawing
156 int xo(BufferView const & bv) const;
157 /// access to cached y coordinate of last drawing
158 int yo(BufferView const & bv) const;
159 /// access to cached x coordinate of mid point of last drawing
160 int xm(BufferView const & bv) const;
161 /// access to cached y coordinate of mid point of last drawing
162 int ym(BufferView const & bv) const;
163 /// write access to coordinate;
164 void setXY(BufferView & bv, int x, int y) const;
165 /// returns x coordinate of given position in the array
166 int pos2x(BufferView const * bv, size_type pos) const;
167 /// returns position of given x coordinate
168 size_type x2pos(BufferView const * bv, int targetx) const;
169 /// returns distance of this cell to the point given by x and y
170 // assumes valid position and size cache
171 int dist(BufferView const & bv, int x, int y) const;
173 /// minimum ascent offset for superscript
174 int minasc() const { return minasc_; }
175 /// minimum descent offset for subscript
176 int mindes() const { return mindes_; }
177 /// level above/below which super/subscript should extend
178 int slevel() const { return slevel_; }
179 /// additional super/subscript shift
180 int sshift() const { return sshift_; }
181 /// Italic correction as described in InsetMathScript.h
182 int kerning(BufferView const *) const;
184 void swap(MathData & ar) { base_type::swap(ar); }
186 /// attach/detach arguments to macros, updating the cur to
187 /// stay visually at the same position (cur==0 is allowed)
188 void updateMacros(Cursor * cur, MacroContext const & mc, UpdateType, int nesting);
190 void updateBuffer(ParIterator const &, UpdateType, bool const deleted = false);
191 /// Change associated buffer for this object and its contents
192 void setBuffer(Buffer & b);
193 /// Update assiociated buffer for the contents of the object
194 void setContentsBuffer();
197 /// cached values for super/subscript placement
198 mutable int minasc_ = 0;
199 mutable int mindes_ = 0;
200 mutable int slevel_ = 0;
201 mutable int sshift_ = 0;
202 /// cached value for display style
203 mutable bool display_style_ = false;
204 Buffer * buffer_ = nullptr;
207 /// is this an exact match at this position?
208 bool find1(MathData const & ar, size_type pos) const;
211 void detachMacroParameters(DocIterator * dit, const size_type macroPos);
213 void attachMacroParameters(Cursor * cur, const size_type macroPos,
214 const size_type macroNumArgs, const int macroOptionals,
215 const bool fromInitToNormalMode, const bool interactiveInit,
216 const size_t appetite);
218 void collectOptionalParameters(Cursor * cur,
219 const size_type numOptionalParams, std::vector<MathData> & params,
220 size_t & pos, MathAtom & scriptToPutAround,
221 const pos_type macroPos, const int thisPos, const int thisSlice);
223 void collectParameters(Cursor * cur,
224 const size_type numParams, std::vector<MathData> & params,
225 size_t & pos, MathAtom & scriptToPutAround,
226 const pos_type macroPos, const int thisPos, const int thisSlice,
227 const size_t appetite);
231 std::ostream & operator<<(std::ostream & os, MathData const & ar);
233 odocstream & operator<<(odocstream & os, MathData const & ar);