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 Cursor;
  40 class CursorSlice;
  41 class DocIterator;
  42 class docstring_list;
  43
  44 /// types for cells and math insets
  45 typedef void const * uid_type;
  46 typedef size_t idx_type;
  47
  48
  49 /// an individual par id/pos <=> row mapping
  50 struct TextEntry { int id; pos_type pos; };
  51
  52 /// an individual math id/cell <=> row mapping
  53 struct MathEntry { uid_type id; idx_type cell; };
  54
  55 /// a container for passing entries around
  56 struct RowEntry {
  57         bool is_math;// true iff the union is a math
  58         union {
  59                 struct TextEntry text;
  60                 struct MathEntry math;
  61         };
  62 };
  63
  64
  65 /// Represents the correspondence between paragraphs and the generated
  66 /// LaTeX file
  67
  68 class TexRow {
  69         /// id/pos correspondence for a single row
  70         class RowEntryList;
  71
  72         /// container of id/pos <=> row mapping
  73         /// invariant: in any enabled_ TexRow, rowlist_ will contain at least one
  74         /// Row (the current row)
  75         typedef std::vector<RowEntryList> RowList;
  76         ///
  77         RowList rowlist_;
  78         ///
  79         bool enabled_;
  80         ///
  81         RowEntryList & currentRow();
  82
  83         ///
  84         class RowListIterator;
  85         ///
  86         RowListIterator begin() const;
  87         ///
  88         RowListIterator end() const;
  89 public:
  90         ///
  91         TexRow(bool enable = true);
  92
  93         /// Clears structure.  Set enable to false if texrow is not needed, to avoid
  94         /// computing TexRow when it is going to be immediately discarded.
  95         void reset(bool enable = true);
  96
  97         static const TextEntry text_none;
  98         static const RowEntry row_none;
  99         /// Returns true if RowEntry is devoid of information
 100         static bool isNone(RowEntry entry);
 101         /// Returns true if TextEntry is devoid of information
 102         static bool isNone(TextEntry entry);
 103
 104         /// Converts a CursorSlice into a RowEntry
 105         static RowEntry rowEntryFromCursorSlice(CursorSlice const & slice);
 106         /// Encapsulates the paragraph and position for later use
 107         static RowEntry textEntry(int id, pos_type pos);
 108         /// Encapsulates a cell and position for later use
 109         static RowEntry mathEntry(uid_type id, idx_type cell);
 110
 111         /// for debugging purposes
 112         static docstring asString(RowEntry entry);
 113
 114         /// Defines the row information for the current line
 115         /// returns true if this entry will appear on the current row
 116         bool start(RowEntry entry);
 117         /// Defines the paragraph and position for the current line
 118         /// returns true if this entry will appear on the current row
 119         bool start(int id, pos_type pos);
 120         /// Defines a cell and position for the current line.  Always appear in the
 121         /// current row.
 122         void startMath(uid_type id, idx_type cell);
 123         /// Defines the paragraph for the current cell-like inset.  Always appears
 124         /// in the current row like a math cell, but is detached from the normal
 125         /// text flow. Note: since the cell idx is not recorded it does not work as
 126         /// well as for math grids; if we were to do that properly we would need to
 127         /// access the id of the parent Tabular inset from the CursorSlice.
 128         void forceStart(int id, pos_type pos);
 129
 130         /// Insert node when line is completed
 131         void newline();
 132         /// Insert multiple nodes when zero or more lines are completed
 133         void newlines(size_t num_lines);
 134
 135         /**
 136          * getIdFromRow - find pid and position for a given row
 137          * @param row row number to find
 138          * @param id set to id if found
 139          * @param pos set to paragraph position if found
 140          * @return true if found, false otherwise
 141          *
 142          * If the row could not be found, pos is set to zero and
 143          * id is set to -1
 144          */
 145         bool getIdFromRow(int row, int & id, int & pos) const;
 146
 147         /// Finds the best pair of rows for dit
 148         /// returns (-1,-1) if not found.
 149         std::pair<int,int> rowFromDocIterator(DocIterator const & dit) const;
 150
 151         /// Finds the best pair of rows for cursor, taking the selection into
 152         /// account
 153         /// returns (-1,-1) if not found.
 154         std::pair<int,int> rowFromCursor(Cursor const & dit) const;
 155
 156         /// Returns the number of rows contained
 157         int rows() const;
 158
 159         /// appends texrow. the final line of this is merged with the first line of
 160         /// texrow.
 161         void append(TexRow texrow);
 162
 163         /// for debugging purpose
 164         void prepend(docstring_list &) const;
 165
 166 private:
 167         /// true iff same paragraph or math inset
 168         static bool sameParOrInsetMath(RowEntry entry1, RowEntry entry2);
 169         /// computes the distance in pos or cell index
 170         /// assumes it is the sameParOrInsetMath
 171         static int comparePos(RowEntry entry1, RowEntry entry2);
 172
 173 };
 174
 175
 176 // Standard container needs a complete type
 177 class TexRow::RowEntryList {
 178         // For each row we store a list of one special TextEntry and several
 179         // RowEntries. (The order is important.)  We only want one text entry
 180         // because we do not want to store every position in the lyx file. On the
 181         // other hand we want to record all math and table cells positions for
 182         // enough precision. Usually the count of cells is easier to handle.
 183         // The RowEntries are used for forward-search and the code preview pane.
 184         std::vector<RowEntry> v_;
 185         // The TextEntry is currently used for reverse-search and the error
 186         // reporting dialog. Once the latter are adapted to rely on the more precise
 187         // RowEntries above, it can be removed.
 188         TextEntry text_entry_;
 189
 190 public:
 191         typedef std::vector<RowEntry>::iterator iterator;
 192         iterator begin() { return v_.begin(); }
 193         iterator end() { return v_.end(); }
 194         ///
 195         typedef std::vector<RowEntry>::const_iterator const_iterator;
 196         const_iterator begin() const { return v_.cbegin(); }
 197         const_iterator end() const { return v_.cend(); }
 198         ///
 199         RowEntryList() : text_entry_(TexRow::text_none) {}
 200
 201         // returns true if the row entry will appear in the row entry list
 202         bool addEntry(RowEntry entry);
 203
 204         // the row entry will appear in the row entry list, but it never counts
 205         // as a proper text entry.
 206         void forceAddEntry(RowEntry entry);
 207
 208         // returns the TextEntry or TexRow::text_none if none
 209         TextEntry getTextEntry() const;
 210
 211         // appends a row
 212         void append(RowEntryList row);
 213 };
 214
 215
 216 bool operator==(RowEntry entry1, RowEntry entry2);
 217
 218
 219 LyXErr & operator<<(LyXErr &, TexRow const &);
 220
 221
 222 } // namespace lyx
 223
 224 #endif // TEXROW_H