src/TexRow.h

   1 // -*- C++ -*-
   2 /**
   3  * \file TexRow.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Matthias Ettrich
   8  * \author Lars Gullik Bjønnes
   9  * \author John Levon
  10  * \author Guillaume Munch
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 /* Note about debugging options:
  16  *
  17  * When compiled in devel mode and run with the option -dbg latex, two ways
  18  * of debugging TexRow are available:
  19  *
  20  * 1. The source view panel prepends the full TexRow information to the LaTeX
  21  *    output.
  22  *
  23  * 2. Clicking on any line in the source view moves the buffer to the location
  24  *    recognised by TexRow.
  25  *
  26  */
  27
  28 #ifndef TEXROW_H
  29 #define TEXROW_H
  30
  31 #include "support/debug.h"
  32 #include "support/types.h"
  33
  34 #include <vector>
  35
  36 namespace lyx {
  37
  38 class LyXErr;
  39 class Buffer;
  40 class Cursor;
  41 class CursorSlice;
  42 class DocIterator;
  43 class docstring_list;
  44
  45 /// types for cells and math insets
  46 typedef void const * uid_type;
  47 typedef size_t idx_type;
  48
  49
  50 /// an individual par id/pos <=> row mapping
  51 struct TextEntry { int id; pos_type pos; };
  52
  53 /// an individual math id/cell <=> row mapping
  54 struct MathEntry { uid_type id; idx_type cell; };
  55
  56 /// a container for passing entries around
  57 struct RowEntry {
  58         bool is_math;// true iff the union is a math
  59         union {
  60                 struct TextEntry text;
  61                 struct MathEntry math;
  62         };
  63 };
  64
  65
  66 /// Represents the correspondence between paragraphs and the generated
  67 /// LaTeX file
  68
  69 class TexRow {
  70         /// id/pos correspondence for a single row
  71         class RowEntryList;
  72
  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;
  77         ///
  78         RowList rowlist_;
  79         ///
  80         RowEntryList & currentRow();
  81
  82         ///
  83         class RowListIterator;
  84         ///
  85         RowListIterator begin() const;
  86         ///
  87         RowListIterator end() const;
  88 public:
  89         ///
  90         TexRow();
  91
  92         /// Copy can be expensive and is not usually useful for TexRow.
  93         /// Force explicit copy, prefer move instead. This also prevents
  94         /// move()s from being converted into copy silently.
  95         explicit TexRow(TexRow const & other) = default;
  96         TexRow(TexRow && other) = default;
  97         TexRow & operator=(TexRow const & other) = default;
  98         TexRow & operator=(TexRow && other) = default;
  99
 100         /// Clears structure.
 101         void reset();
 102
 103         static const TextEntry text_none;
 104         static const RowEntry row_none;
 105         /// Returns true if RowEntry is devoid of information
 106         static bool isNone(RowEntry entry);
 107         /// Returns true if TextEntry is devoid of information
 108         static bool isNone(TextEntry entry);
 109
 110         /// Converts a CursorSlice into a RowEntry
 111         static RowEntry rowEntryFromCursorSlice(CursorSlice const & slice);
 112         /// Encapsulates the paragraph and position for later use
 113         static RowEntry textEntry(int id, pos_type pos);
 114         /// Encapsulates a cell and position for later use
 115         static RowEntry mathEntry(uid_type id, idx_type cell);
 116
 117         /// for debugging purposes
 118         static docstring asString(RowEntry entry);
 119
 120         /// Defines the row information for the current line
 121         /// returns true if this entry will appear on the current row
 122         bool start(RowEntry entry);
 123         /// Defines the paragraph and position for the current line
 124         /// returns true if this entry will appear on the current row
 125         bool start(int id, pos_type pos);
 126         /// Defines a cell and position for the current line.  Always appear in the
 127         /// current row.
 128         void startMath(uid_type id, idx_type cell);
 129         /// Defines the paragraph for the current cell-like inset.  Always appears
 130         /// in the current row like a math cell, but is detached from the normal
 131         /// text flow. Note: since the cell idx is not recorded it does not work as
 132         /// well as for math grids; if we were to do that properly we would need to
 133         /// access the id of the parent Tabular inset from the CursorSlice.
 134         void forceStart(int id, pos_type pos);
 135
 136         /// Insert node when line is completed
 137         void newline();
 138         /// Insert multiple nodes when zero or more lines are completed
 139         void newlines(size_t num_lines);
 140
 141         /**
 142          * getEntriesFromRow - find pids and position for a given row
 143          * @param row row number to find
 144          * @return a pair of TextEntry denoting the start and end of the position.
 145          * The TextEntry values can be isNone(). If no row is found then the first
 146          * value isNone().
 147          */
 148         std::pair<TextEntry,TextEntry> getEntriesFromRow(int row) const;
 149
 150         /**
 151          * getDocIteratorFromRow - find pids and positions for a given row
 152          * @param row number to find
 153          * @param buffer here to look
 154          * @return a pair of DocIterators the start and end of the position.
 155          * The DocIterators can be invalid. The starting DocIterator being invalid
 156          * means that no row was found. Note: there is no guarantee that the
 157          * DocIterators are in the same inset or even at the same depth.
 158          */
 159         std::pair<DocIterator, DocIterator> getDocIteratorFromRow(
 160             int row,
 161             Buffer const & buf) const;
 162         //TODO: remove the following by replacing it with the above
 163         bool getIdFromRow(int row, int & id, int & pos) const;
 164
 165         /// Finds the best pair of rows for dit
 166         /// returns (-1,-1) if not found.
 167         std::pair<int,int> rowFromDocIterator(DocIterator const & dit) const;
 168
 169         /// Finds the best pair of rows for cursor, taking the selection into
 170         /// account
 171         /// returns (-1,-1) if not found.
 172         std::pair<int,int> rowFromCursor(Cursor const & dit) const;
 173
 174         /// Returns the number of rows contained
 175         size_t rows() const;
 176         /// Fill or trim to reach the row count \param r
 177         void setRows(size_t r);
 178
 179         /// appends texrow. the final line of this is merged with the first line of
 180         /// texrow.
 181         void append(TexRow texrow);
 182
 183         /// for debugging purpose
 184         void prepend(docstring_list &) const;
 185
 186 private:
 187         /// true iff same paragraph or math inset
 188         static bool sameParOrInsetMath(RowEntry entry1, RowEntry entry2);
 189         /// computes the distance in pos or cell index
 190         /// assumes it is the sameParOrInsetMath
 191         static int comparePos(RowEntry entry1, RowEntry entry2);
 192
 193 };
 194
 195
 196 /// TexString : dumb struct to pass around docstrings with TexRow information.
 197 /// They are best created using oTexStringstream.
 198 /// They can be output to otexrowstreams and otexstreams.
 199 /// A valid TexString has as many newlines in str as in texrow. Be careful not
 200 /// to introduce a mismatch between the line and the row counts, as this will
 201 /// assert in devel mode when outputting to a otexstream.
 202 struct TexString {
 203         ///
 204         docstring str;
 205         ///
 206         TexRow texrow;
 207         /// Copy can be expensive and is not usually useful for TexString.
 208         /// Force explicit copy, prefer move instead. This also prevents
 209         /// move()s from being converted into copy silently.
 210         explicit TexString(TexString const &) = default;
 211         TexString(TexString && other) = default;
 212         TexString & operator=(TexString const & other) = default;
 213         TexString & operator=(TexString && other) = default;
 214         ///
 215         TexString() = default;
 216         /// ensure that the string and the TexRow have as many newlines.
 217         void validate();
 218 };
 219
 220
 221 // Standard container needs a complete type
 222 class TexRow::RowEntryList {
 223         // For each row we store a list of one special TextEntry and several
 224         // RowEntries. (The order is important.)  We only want one text entry
 225         // because we do not want to store every position in the lyx file. On the
 226         // other hand we want to record all math and table cells positions for
 227         // enough precision. Usually the count of cells is easier to handle.
 228         // The RowEntries are used for forward-search and the code preview pane.
 229         std::vector<RowEntry> v_;
 230         // The TextEntry is currently used for reverse-search and the error
 231         // reporting dialog. Once the latter are adapted to rely on the more precise
 232         // RowEntries above, it can be removed.
 233         TextEntry text_entry_;
 234
 235 public:
 236         typedef std::vector<RowEntry>::iterator iterator;
 237         iterator begin() { return v_.begin(); }
 238         iterator end() { return v_.end(); }
 239         ///
 240         typedef std::vector<RowEntry>::const_iterator const_iterator;
 241         const_iterator begin() const { return v_.cbegin(); }
 242         const_iterator end() const { return v_.cend(); }
 243         ///
 244         RowEntryList() : text_entry_(TexRow::text_none) {}
 245
 246         // returns true if the row entry will appear in the row entry list
 247         bool addEntry(RowEntry entry);
 248
 249         // the row entry will appear in the row entry list, but it never counts
 250         // as a proper text entry.
 251         void forceAddEntry(RowEntry entry);
 252
 253         // returns the TextEntry or TexRow::text_none if none
 254         TextEntry getTextEntry() const;
 255
 256         // appends a row
 257         void append(RowEntryList row);
 258 };
 259
 260
 261 bool operator==(RowEntry entry1, RowEntry entry2);
 262
 263
 264 LyXErr & operator<<(LyXErr &, TexRow const &);
 265
 266
 267 } // namespace lyx
 268
 269 #endif // TEXROW_H