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.
18 #include "Dimension.h"
23 #include "OutputEnums.h"
25 #include "support/strfwd.h"
44 class TextMetricsInfo;
48 class MathData : private std::vector<MathAtom> {
50 /// re-use inhertited stuff
51 typedef std::vector<MathAtom> base_type;
52 using base_type::const_iterator;
53 using base_type::iterator;
54 using base_type::size_type;
55 using base_type::difference_type;
56 using base_type::size;
57 using base_type::empty;
58 using base_type::clear;
59 using base_type::begin;
61 using base_type::push_back;
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);
88 /// erase range from pos1 to pos2
89 void erase(iterator pos1, iterator pos2);
91 void erase(iterator pos);
92 /// erase range from pos1 to pos2
93 void erase(size_type pos1, size_type pos2);
95 void erase(size_type pos);
102 void replace(ReplaceData &);
104 void substitute(MathData const & m);
106 /// looks for exact match
107 bool match(MathData const & ar) const;
108 /// looks for inclusion match starting at pos
109 bool matchpart(MathData const & ar, pos_type pos) const;
110 /// looks for containment, return == size mean not found
111 size_type find(MathData const & ar) const;
112 /// looks for containment, return == size mean not found
113 size_type find_last(MathData const & ar) const;
115 bool contains(MathData const & ar) const;
117 void validate(LaTeXFeatures &) const;
119 /// checked write access
120 MathAtom & operator[](pos_type);
121 /// checked read access
122 MathAtom const & operator[](pos_type) const;
124 /// Add this array to a math row. Return true if contents got added
125 bool addToMathRow(MathRow &, MetricsInfo & mi) const;
127 /// rebuild cached metrics information
128 /** When \c tight is true, the height of the cell will be at least
129 * the x height of the font. Otherwise, it will be the max height
132 void metrics(MetricsInfo & mi, Dimension & dim, bool tight = true) const;
134 Dimension const & dimension(BufferView const &) const;
136 /// draw the selection over the cell
137 void drawSelection(PainterInfo & pi, int x, int y) const;
138 /// redraw cell using cache metrics information
139 void draw(PainterInfo & pi, int x, int y) const;
140 /// rebuild cached metrics information
141 void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
142 /// redraw cell using cache metrics information
143 void drawT(TextPainter & pi, int x, int y) const;
144 /// approximate mathclass of the data
145 MathClass mathClass() const;
146 /// math class of last interesting element
147 MathClass lastMathClass() const;
149 /// access to cached x coordinate of last drawing
150 int xo(BufferView const & bv) const;
151 /// access to cached y coordinate of last drawing
152 int yo(BufferView const & bv) const;
153 /// access to cached x coordinate of mid point of last drawing
154 int xm(BufferView const & bv) const;
155 /// access to cached y coordinate of mid point of last drawing
156 int ym(BufferView const & bv) const;
157 /// write access to coordinate;
158 void setXY(BufferView & bv, int x, int y) const;
159 /// returns x coordinate of given position in the array
160 int pos2x(BufferView const * bv, size_type pos) const;
161 /// returns position of given x coordinate
162 size_type x2pos(BufferView const * bv, int targetx) const;
163 /// returns distance of this cell to the point given by x and y
164 // assumes valid position and size cache
165 int dist(BufferView const & bv, int x, int y) const;
167 /// minimum ascent offset for superscript
168 int minasc() const { return minasc_; }
169 /// minimum descent offset for subscript
170 int mindes() const { return mindes_; }
171 /// level above/below which super/subscript should extend
172 int slevel() const { return slevel_; }
173 /// additional super/subscript shift
174 int sshift() const { return sshift_; }
175 /// Italic correction as described in InsetMathScript.h
176 int kerning(BufferView const *) const;
178 void swap(MathData & ar) { base_type::swap(ar); }
180 /// attach/detach arguments to macros, updating the cur to
181 /// stay visually at the same position (cur==0 is allowed)
182 void updateMacros(Cursor * cur, MacroContext const & mc, UpdateType, int nesting);
184 void updateBuffer(ParIterator const &, UpdateType, bool const deleted = false);
186 void setBuffer(Buffer & b);
189 /// cached values for super/subscript placement
190 mutable int minasc_ = 0;
191 mutable int mindes_ = 0;
192 mutable int slevel_ = 0;
193 mutable int sshift_ = 0;
194 Buffer * buffer_ = nullptr;
197 /// is this an exact match at this position?
198 bool find1(MathData const & ar, size_type pos) const;
201 void detachMacroParameters(DocIterator * dit, const size_type macroPos);
203 void attachMacroParameters(Cursor * cur, const size_type macroPos,
204 const size_type macroNumArgs, const int macroOptionals,
205 const bool fromInitToNormalMode, const bool interactiveInit,
206 const size_t appetite);
208 void collectOptionalParameters(Cursor * cur,
209 const size_type numOptionalParams, std::vector<MathData> & params,
210 size_t & pos, MathAtom & scriptToPutAround,
211 const pos_type macroPos, const int thisPos, const int thisSlice);
213 void collectParameters(Cursor * cur,
214 const size_type numParams, std::vector<MathData> & params,
215 size_t & pos, MathAtom & scriptToPutAround,
216 const pos_type macroPos, const int thisPos, const int thisSlice,
217 const size_t appetite);
221 std::ostream & operator<<(std::ostream & os, MathData const & ar);
223 odocstream & operator<<(odocstream & os, MathData const & ar);