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
11 * Full author contact details are available in file CREDITS.
20 #include "dimension.h"
22 #include "support/docstream.h"
32 class TextMetricsInfo;
36 class MathArray : private std::vector<MathAtom> {
38 /// re-use inhertited stuff
39 typedef std::vector<MathAtom> base_type;
40 using base_type::const_iterator;
41 using base_type::iterator;
42 using base_type::size_type;
43 using base_type::difference_type;
44 using base_type::size;
45 using base_type::empty;
46 using base_type::clear;
47 using base_type::begin;
49 using base_type::push_back;
50 using base_type::pop_back;
51 using base_type::back;
52 using base_type::front;
54 typedef size_type idx_type;
55 typedef size_type pos_type;
61 MathArray(const_iterator from, const_iterator to);
63 void append(MathArray const & ar);
65 /// inserts single atom at position pos
66 void insert(size_type pos, MathAtom const & at);
67 /// inserts multiple atoms at position pos
68 void insert(size_type pos, MathArray const & ar);
70 /// erase range from pos1 to pos2
71 void erase(iterator pos1, iterator pos2);
73 void erase(iterator pos);
74 /// erase range from pos1 to pos2
75 void erase(size_type pos1, size_type pos2);
77 void erase(size_type pos);
84 void replace(ReplaceData &);
86 void substitute(MathArray const & m);
88 /// looks for exact match
89 bool match(MathArray const & ar) const;
90 /// looks for inclusion match starting at pos
91 bool matchpart(MathArray const & ar, pos_type pos) const;
92 /// looks for containment, return == size mean not found
93 size_type find(MathArray const & ar) const;
94 /// looks for containment, return == size mean not found
95 size_type find_last(MathArray const & ar) const;
97 bool contains(MathArray const & ar) const;
99 void validate(LaTeXFeatures &) const;
101 /// checked write access
102 MathAtom & operator[](pos_type);
103 /// checked read access
104 MathAtom const & operator[](pos_type) const;
105 /// rebuild cached metrics information
106 void metrics(MetricsInfo & mi) const;
107 /// rebuild cached metrics information
108 bool metrics(MetricsInfo & mi, Dimension & dim) const;
109 /// redraw cell using cache metrics information
110 void draw(PainterInfo & pi, int x, int y) const;
111 /// rebuild cached metrics information
112 void metricsT(TextMetricsInfo const & mi, Dimension & dim) const;
113 /// redraw cell using cache metrics information
114 void drawT(TextPainter & pi, int x, int y) const;
115 /// mark cell for re-drawing
118 /// access to cached x coordinate of last drawing
119 int xo(BufferView const & bv) const;
120 /// access to cached y coordinate of last drawing
121 int yo(BufferView const & bv) const;
122 /// access to cached x coordinate of mid point of last drawing
123 int xm(BufferView const & bv) const { return xo(bv) + dim_.wid / 2; }
124 /// access to cached y coordinate of mid point of last drawing
125 int ym(BufferView const & bv) const { return yo(bv) + (dim_.des - dim_.asc) / 2; }
126 /// write access to coordinate;
127 void setXY(BufferView & bv, int x, int y) const;
128 /// returns x coordinate of given position in the array
129 int pos2x(size_type pos) const;
130 /// returns position of given x coordinate
131 int pos2x(size_type pos, int glue) const;
132 /// returns position of given x coordinate
133 size_type x2pos(int pos) const;
134 /// returns position of given x coordinate fstarting from a certain pos
135 size_type x2pos(int targetx, int glue) const;
136 /// returns distance of this cell to the point given by x and y
137 // assumes valid position and size cache
138 int dist(BufferView const & bv, int x, int y) const;
140 /// ascent of this cell above the baseline
141 int ascent() const { return dim_.asc; }
142 /// descent of this cell below the baseline
143 int descent() const { return dim_.des; }
144 /// height of the cell
145 int height() const { return dim_.asc + dim_.des; }
146 /// width of this cell
147 int width() const { return dim_.wid; }
148 /// dimensions of cell
149 Dimension const & dim() const { return dim_; }
150 /// dimensions of cell
151 void setDim(Dimension const & d) const { dim_ = d; }
152 /// minimum ascent offset for superscript
153 int minasc() const { return minasc_; }
154 /// minimum descent offset for subscript
155 int mindes() const { return mindes_; }
156 /// level above/below which super/subscript should extend
157 int slevel() const { return slevel_; }
158 /// additional super/subscript shift
159 int sshift() const { return sshift_; }
160 /// superscript kerning
161 int kerning() const { return kerning_; }
163 void swap(MathArray & ar) { base_type::swap(ar); }
166 /// cached dimensions of cell
167 mutable Dimension dim_;
168 /// cached values for super/subscript placement
173 mutable int kerning_;
176 /// is this an exact match at this position?
177 bool find1(MathArray const & ar, size_type pos) const;
181 std::ostream & operator<<(std::ostream & os, MathArray const & ar);
183 odocstream & operator<<(odocstream & os, MathArray const & ar);