4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Matthias Ettrich
8 * \author Lars Gullik Bjønnes
10 * \author Guillaume Munch
12 * Full author contact details are available in file CREDITS.
15 /* Note about debugging options:
17 * When compiled in devel mode and run with the option -dbg latex, two ways
18 * of debugging TexRow are available:
20 * 1. The source view panel prepends the full TexRow information to the LaTeX
23 * 2. Clicking on any line in the source view moves the buffer to the location
24 * recognised by TexRow.
31 #include "support/debug.h"
32 #include "support/types.h"
45 /// types for cells and math insets
46 typedef void const * uid_type;
47 typedef size_t idx_type;
50 /// an individual par id/pos <=> row mapping
51 struct TextEntry { int id; pos_type pos; };
53 /// an individual math id/cell <=> row mapping
54 struct MathEntry { uid_type id; idx_type cell; };
56 /// a container for passing entries around
58 bool is_math;// true iff the union is a math
60 struct TextEntry text;
61 struct MathEntry math;
66 /// Represents the correspondence between paragraphs and the generated
70 /// id/pos correspondence for a single row
73 /// container of id/pos <=> row mapping
74 /// invariant: in any enabled_ TexRow, rowlist_ will contain at least one
75 /// Row (the current row)
76 typedef std::vector<RowEntryList> RowList;
80 RowEntryList & currentRow();
83 class RowListIterator;
85 RowListIterator begin() const;
87 RowListIterator end() const;
95 static const TextEntry text_none;
96 static const RowEntry row_none;
97 /// Returns true if RowEntry is devoid of information
98 static bool isNone(RowEntry entry);
99 /// Returns true if TextEntry is devoid of information
100 static bool isNone(TextEntry entry);
102 /// Converts a CursorSlice into a RowEntry
103 static RowEntry rowEntryFromCursorSlice(CursorSlice const & slice);
104 /// Encapsulates the paragraph and position for later use
105 static RowEntry textEntry(int id, pos_type pos);
106 /// Encapsulates a cell and position for later use
107 static RowEntry mathEntry(uid_type id, idx_type cell);
109 /// for debugging purposes
110 static docstring asString(RowEntry entry);
112 /// Defines the row information for the current line
113 /// returns true if this entry will appear on the current row
114 bool start(RowEntry entry);
115 /// Defines the paragraph and position for the current line
116 /// returns true if this entry will appear on the current row
117 bool start(int id, pos_type pos);
118 /// Defines a cell and position for the current line. Always appear in the
120 void startMath(uid_type id, idx_type cell);
121 /// Defines the paragraph for the current cell-like inset. Always appears
122 /// in the current row like a math cell, but is detached from the normal
123 /// text flow. Note: since the cell idx is not recorded it does not work as
124 /// well as for math grids; if we were to do that properly we would need to
125 /// access the id of the parent Tabular inset from the CursorSlice.
126 void forceStart(int id, pos_type pos);
128 /// Insert node when line is completed
130 /// Insert multiple nodes when zero or more lines are completed
131 void newlines(size_t num_lines);
134 * getEntriesFromRow - find pids and position for a given row
135 * @param row row number to find
136 * @return a pair of TextEntry denoting the start and end of the position.
137 * The TextEntry values can be isNone(). If no row is found then the first
140 std::pair<TextEntry,TextEntry> getEntriesFromRow(int row) const;
143 * getDocIteratorFromRow - find pids and positions for a given row
144 * @param row number to find
145 * @param buffer here to look
146 * @return a pair of DocIterators the start and end of the position.
147 * The DocIterators can be invalid. The starting DocIterator being invalid
148 * means that no row was found. Note: there is no guarantee that the
149 * DocIterators are in the same inset or even at the same depth.
151 std::pair<DocIterator, DocIterator> getDocIteratorFromRow(
153 Buffer const & buf) const;
154 //TODO: remove the following by replacing it with the above
155 bool getIdFromRow(int row, int & id, int & pos) const;
157 /// Finds the best pair of rows for dit
158 /// returns (-1,-1) if not found.
159 std::pair<int,int> rowFromDocIterator(DocIterator const & dit) const;
161 /// Finds the best pair of rows for cursor, taking the selection into
163 /// returns (-1,-1) if not found.
164 std::pair<int,int> rowFromCursor(Cursor const & dit) const;
166 /// Returns the number of rows contained
169 /// appends texrow. the final line of this is merged with the first line of
171 void append(TexRow texrow);
173 /// for debugging purpose
174 void prepend(docstring_list &) const;
177 /// true iff same paragraph or math inset
178 static bool sameParOrInsetMath(RowEntry entry1, RowEntry entry2);
179 /// computes the distance in pos or cell index
180 /// assumes it is the sameParOrInsetMath
181 static int comparePos(RowEntry entry1, RowEntry entry2);
186 // Standard container needs a complete type
187 class TexRow::RowEntryList {
188 // For each row we store a list of one special TextEntry and several
189 // RowEntries. (The order is important.) We only want one text entry
190 // because we do not want to store every position in the lyx file. On the
191 // other hand we want to record all math and table cells positions for
192 // enough precision. Usually the count of cells is easier to handle.
193 // The RowEntries are used for forward-search and the code preview pane.
194 std::vector<RowEntry> v_;
195 // The TextEntry is currently used for reverse-search and the error
196 // reporting dialog. Once the latter are adapted to rely on the more precise
197 // RowEntries above, it can be removed.
198 TextEntry text_entry_;
201 typedef std::vector<RowEntry>::iterator iterator;
202 iterator begin() { return v_.begin(); }
203 iterator end() { return v_.end(); }
205 typedef std::vector<RowEntry>::const_iterator const_iterator;
206 const_iterator begin() const { return v_.cbegin(); }
207 const_iterator end() const { return v_.cend(); }
209 RowEntryList() : text_entry_(TexRow::text_none) {}
211 // returns true if the row entry will appear in the row entry list
212 bool addEntry(RowEntry entry);
214 // the row entry will appear in the row entry list, but it never counts
215 // as a proper text entry.
216 void forceAddEntry(RowEntry entry);
218 // returns the TextEntry or TexRow::text_none if none
219 TextEntry getTextEntry() const;
222 void append(RowEntryList row);
226 bool operator==(RowEntry entry1, RowEntry entry2);
229 LyXErr & operator<<(LyXErr &, TexRow const &);