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::push_back;
63 using base_type::pop_back;
64 using base_type::back;
65 using base_type::front;
67 typedef size_type idx_type;
68 typedef size_type pos_type;
74 explicit MathData(Buffer * buf) : buffer_(buf) {}
76 MathData(Buffer * buf, const_iterator from, const_iterator to);
78 Buffer * buffer() { return buffer_; }
80 Buffer const * buffer() const { return buffer_; }
82 void append(MathData const & ar);
84 /// inserts single atom at position pos
85 void insert(size_type pos, MathAtom const & at);
86 /// inserts multiple atoms at position pos
87 void insert(size_type pos, MathData const & ar);
89 /// erase range from pos1 to pos2
90 void erase(iterator pos1, iterator pos2);
92 void erase(iterator pos);
93 /// erase range from pos1 to pos2
94 void erase(size_type pos1, size_type pos2);
96 void erase(size_type pos);
103 void replace(ReplaceData &);
105 void substitute(MathData const & m);
107 /// looks for exact match
108 bool match(MathData const & ar) const;
109 /// looks for inclusion match starting at pos
110 bool matchpart(MathData const & ar, pos_type pos) const;
111 /// looks for containment, return == size mean not found
112 size_type find(MathData const & ar) const;
113 /// looks for containment, return == size mean not found
114 size_type find_last(MathData const & ar) const;
116 bool contains(MathData const & ar) const;
118 void validate(LaTeXFeatures &) const;
120 /// checked write access
121 MathAtom & operator[](pos_type);
122 /// checked read access
123 MathAtom const & operator[](pos_type) const;
125 /// Add this array to a math row. Return true if contents got added
126 bool addToMathRow(MathRow &, MetricsInfo & mi) const;
128 /// rebuild cached metrics information
129 /** When \c tight is true, the height of the cell will be at least
130 * the x height of the font. Otherwise, it will be the max height
133 void metrics(MetricsInfo & mi, Dimension & dim, bool tight = true) const;
135 Dimension const & dimension(BufferView const &) const;
137 /// draw the selection over the cell
138 void drawSelection(PainterInfo & pi, int x, int y) const;
139 /// redraw cell using cache metrics information
140 void draw(PainterInfo & pi, int x, int y) const;
141 /// rebuild cached metrics information
142 void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
143 /// redraw cell using cache metrics information
144 void drawT(TextPainter & pi, int x, int y) const;
145 /// approximate mathclass of the data
146 MathClass mathClass() const;
147 /// math class of last interesting element
148 MathClass lastMathClass() const;
150 /// access to cached x coordinate of last drawing
151 int xo(BufferView const & bv) const;
152 /// access to cached y coordinate of last drawing
153 int yo(BufferView const & bv) const;
154 /// access to cached x coordinate of mid point of last drawing
155 int xm(BufferView const & bv) const;
156 /// access to cached y coordinate of mid point of last drawing
157 int ym(BufferView const & bv) const;
158 /// write access to coordinate;
159 void setXY(BufferView & bv, int x, int y) const;
160 /// returns x coordinate of given position in the array
161 int pos2x(BufferView const * bv, size_type pos) const;
162 /// returns position of given x coordinate
163 size_type x2pos(BufferView const * bv, int targetx) const;
164 /// returns distance of this cell to the point given by x and y
165 // assumes valid position and size cache
166 int dist(BufferView const & bv, int x, int y) const;
168 /// minimum ascent offset for superscript
169 int minasc() const { return minasc_; }
170 /// minimum descent offset for subscript
171 int mindes() const { return mindes_; }
172 /// level above/below which super/subscript should extend
173 int slevel() const { return slevel_; }
174 /// additional super/subscript shift
175 int sshift() const { return sshift_; }
176 /// Italic correction as described in InsetMathScript.h
177 int kerning(BufferView const *) const;
179 void swap(MathData & ar) { base_type::swap(ar); }
181 /// attach/detach arguments to macros, updating the cur to
182 /// stay visually at the same position (cur==0 is allowed)
183 void updateMacros(Cursor * cur, MacroContext const & mc, UpdateType, int nesting);
185 void updateBuffer(ParIterator const &, UpdateType, bool const deleted = false);
187 void setBuffer(Buffer & b);
190 /// cached values for super/subscript placement
191 mutable int minasc_ = 0;
192 mutable int mindes_ = 0;
193 mutable int slevel_ = 0;
194 mutable int sshift_ = 0;
195 Buffer * buffer_ = nullptr;
198 /// is this an exact match at this position?
199 bool find1(MathData const & ar, size_type pos) const;
202 void detachMacroParameters(DocIterator * dit, const size_type macroPos);
204 void attachMacroParameters(Cursor * cur, const size_type macroPos,
205 const size_type macroNumArgs, const int macroOptionals,
206 const bool fromInitToNormalMode, const bool interactiveInit,
207 const size_t appetite);
209 void collectOptionalParameters(Cursor * cur,
210 const size_type numOptionalParams, std::vector<MathData> & params,
211 size_t & pos, MathAtom & scriptToPutAround,
212 const pos_type macroPos, const int thisPos, const int thisSlice);
214 void collectParameters(Cursor * cur,
215 const size_type numParams, std::vector<MathData> & params,
216 size_t & pos, MathAtom & scriptToPutAround,
217 const pos_type macroPos, const int thisPos, const int thisSlice,
218 const size_t appetite);
222 std::ostream & operator<<(std::ostream & os, MathData const & ar);
224 odocstream & operator<<(odocstream & os, MathData const & ar);