X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTexRow.h;h=8edcd8eb16515146fb8230cc34dd548bcdf3f7d8;hb=da67bde61af6dfecef7a237b72b878fe30638a81;hp=dc0efdc4747c56f54091ec98c437bf1870763c36;hpb=3fd2398a28c8d2c85d1bb2c33c6ca15bfc398b54;p=lyx.git diff --git a/src/TexRow.h b/src/TexRow.h index dc0efdc474..8edcd8eb16 100644 --- a/src/TexRow.h +++ b/src/TexRow.h @@ -29,43 +29,74 @@ #define TEXROW_H #include "support/debug.h" +#include "support/docstring.h" #include "support/types.h" #include namespace lyx { -class LyXErr; +class Buffer; class Cursor; class CursorSlice; class DocIterator; class docstring_list; +class FuncRequest; /// types for cells and math insets typedef void const * uid_type; typedef size_t idx_type; -/// an individual par id/pos <=> row mapping -struct TextEntry { int id; pos_type pos; }; +/// Represents the correspondence between paragraphs and the generated +/// LaTeX file -/// an individual math id/cell <=> row mapping -struct MathEntry { uid_type id; idx_type cell; }; +class TexRow { +public: + /// We begin with defining the types of row information we are tracking + /// -/// a container for passing entries around -struct RowEntry { - bool is_math;// true iff the union is a math - union { - struct TextEntry text; - struct MathEntry math; + /// type of row entries + enum RowType { + text_entry, + math_entry, + begin_document }; -}; + /// an individual par id/pos <=> row mapping + struct TextEntry { int id; pos_type pos; }; -/// Represents the correspondence between paragraphs and the generated -/// LaTeX file + /// an individual math id/cell <=> row mapping + struct MathEntry { uid_type id; idx_type cell; }; -class TexRow { + /// a container for passing entries around + struct RowEntry { + RowType type; + union { + struct TextEntry text;// iff the type is text_entry + struct MathEntry math;// iff the type is row_entry + struct {} begindocument;// iff the type is begin_document + }; + }; + + /// Encapsulates the paragraph and position for later use + static RowEntry textEntry(int id, pos_type pos); + /// Encapsulates a cell and position for later use + static RowEntry mathEntry(uid_type id, idx_type cell); + /// Denotes the beginning of the document + static RowEntry beginDocument(); + + /// Converts a CursorSlice into a RowEntry + static RowEntry rowEntryFromCursorSlice(CursorSlice const & slice); + + static const TextEntry text_none; + static const RowEntry row_none; + /// Returns true if RowEntry is devoid of information + static bool isNone(RowEntry entry); + /// Returns true if TextEntry is devoid of information + static bool isNone(TextEntry entry); + +private: /// id/pos correspondence for a single row class RowEntryList; @@ -88,23 +119,17 @@ public: /// TexRow(); + /// Copy can be expensive and is not usually useful for TexRow. + /// Force explicit copy, prefer move instead. This also prevents + /// move()s from being converted into copy silently. + explicit TexRow(TexRow const & other) = default; + TexRow(TexRow && other) = default; + TexRow & operator=(TexRow const & other) = default; + TexRow & operator=(TexRow && other) = default; + /// Clears structure. void reset(); - static const TextEntry text_none; - static const RowEntry row_none; - /// Returns true if RowEntry is devoid of information - static bool isNone(RowEntry entry); - /// Returns true if TextEntry is devoid of information - static bool isNone(TextEntry entry); - - /// Converts a CursorSlice into a RowEntry - static RowEntry rowEntryFromCursorSlice(CursorSlice const & slice); - /// Encapsulates the paragraph and position for later use - static RowEntry textEntry(int id, pos_type pos); - /// Encapsulates a cell and position for later use - static RowEntry mathEntry(uid_type id, idx_type cell); - /// for debugging purposes static docstring asString(RowEntry entry); @@ -130,19 +155,47 @@ public: void newlines(size_t num_lines); /** - * getIdFromRow - find pid and position for a given row - * @param row row number to find - * @param id set to id if found - * @param pos set to paragraph position if found - * @return true if found, false otherwise - * - * If the row could not be found, pos is set to zero and - * id is set to -1 + * getEntriesFromRow - find pids and position for a given row + * This is the main algorithm behind reverse-search. + * @param row number to find + * @return a pair of TextEntry denoting the start and end of the position. + * The TextEntry values can be isNone(). If no row is found then the first + * value isNone(). */ - bool getIdFromRow(int row, int & id, int & pos) const; + std::pair getEntriesFromRow(int row) const; + + /** + * getDocIteratorFromEntries - find pids and positions for a given row + * @param buffer where to look + * @return a pair of DocIterators denoting the start and end of the + * position. The DocIterators can be invalid. The starting DocIterator + * being invalid means that no location was found. Note: there is no + * guarantee that the DocIterators are in the same inset or even at the + * same depth. + */ + static std::pair getDocIteratorsFromEntries( + TextEntry start, + TextEntry end, + Buffer const & buf); + + // A FuncRequest to select from start to end + static FuncRequest goToFunc(TextEntry start, TextEntry end); + // A FuncRequest to select a row + FuncRequest goToFuncFromRow(int const row) const; + + /** + * getDocIteratorFromRow - find pids and positions for a given row + * @param row number to find + * @param buffer where to look + * @return a pair of DocIterators as above. + */ + std::pair getDocIteratorsFromRow( + int row, + Buffer const & buf) const; /// Finds the best pair of rows for dit /// returns (-1,-1) if not found. + /// This is the main algorithm behind forward-search. std::pair rowFromDocIterator(DocIterator const & dit) const; /// Finds the best pair of rows for cursor, taking the selection into @@ -151,7 +204,9 @@ public: std::pair rowFromCursor(Cursor const & dit) const; /// Returns the number of rows contained - int rows() const; + size_t rows() const; + /// Fill or trim to reach the row count \param r + void setRows(size_t r); /// appends texrow. the final line of this is merged with the first line of /// texrow. @@ -161,7 +216,7 @@ public: void prepend(docstring_list &) const; private: - /// true iff same paragraph or math inset + /// true iff same paragraph or math inset or begin_document static bool sameParOrInsetMath(RowEntry entry1, RowEntry entry2); /// computes the distance in pos or cell index /// assumes it is the sameParOrInsetMath @@ -170,6 +225,35 @@ private: }; +/// TexString : dumb struct to pass around docstrings with TexRow information. +/// They are best created using otexstringstream. +/// They can be output to otexrowstreams and otexstreams. +/// A valid TexString has as many newlines in str as in texrow. Be careful not +/// to introduce a mismatch between the line and the row counts, as this will +/// assert in devel mode when outputting to a otexstream. +struct TexString { + /// + docstring str; + /// + TexRow texrow; + /// Copy can be expensive and is not usually useful for TexString. + /// Force explicit copy, prefer move instead. This also prevents + /// move()s from being converted into copy silently. + explicit TexString(TexString const &) = default; + TexString(TexString && other) = default; + TexString & operator=(TexString const & other) = default; + TexString & operator=(TexString && other) = default; + /// Empty TexString + TexString() = default; + /// Texstring containing str and TexRow with enough lines which are empty + explicit TexString(docstring str); + /// Texstring containing str and texrow. Must be valid. + TexString(docstring str, TexRow texrow); + /// Ensure that the string and the TexRow have as many newlines. + void validate(); +}; + + // Standard container needs a complete type class TexRow::RowEntryList { // For each row we store a list of one special TextEntry and several @@ -210,10 +294,7 @@ public: }; -bool operator==(RowEntry entry1, RowEntry entry2); - - -LyXErr & operator<<(LyXErr &, TexRow const &); +bool operator==(TexRow::RowEntry entry1, TexRow::RowEntry entry2); } // namespace lyx