TexRow: enable new RowEntry types

diff --git a/src/TexRow.cpp b/src/TexRow.cpp
index 2884cda664973f4b5ca1e773efa528c3d16c377d..24e0f36937d45ff86e4032d6c92ba5f46972a2cb 100644 (file)
--- a/src/TexRow.cpp
+++ b/src/TexRow.cpp
@@ -66,11 +66,15 @@ void TexString::validate()
 
 bool TexRow::RowEntryList::addEntry(RowEntry entry)
 {
-       if (!entry.is_math) {
+       switch (entry.type) {
+       case text_entry:
                if (isNone(text_entry_))
                        text_entry_ = entry.text;
                else if (!v_.empty() && TexRow::sameParOrInsetMath(v_.back(), entry))
                        return false;
+               break;
+       default:
+               break;
        }
        forceAddEntry(entry);
        return true;
@@ -107,7 +111,7 @@ TexRow::TexRow()
 
 
 TexRow::TextEntry const TexRow::text_none = { -1, 0 };
-TexRow::RowEntry const TexRow::row_none = { false, { TexRow::text_none } };
+TexRow::RowEntry const TexRow::row_none = TexRow::textEntry(-1, 0);
 
 
 //static
@@ -120,7 +124,7 @@ bool TexRow::isNone(TextEntry t)
 //static
 bool TexRow::isNone(RowEntry r)
 {
-       return !r.is_math && isNone(r.text);
+       return r.type == text_entry && isNone(r.text);
 }
 
 
@@ -141,7 +145,7 @@ TexRow::RowEntryList & TexRow::currentRow()
 TexRow::RowEntry TexRow::textEntry(int id, pos_type pos)
 {
        RowEntry entry;
-       entry.is_math = false;
+       entry.type = text_entry;
        entry.text.pos = pos;
        entry.text.id = id;
        return entry;
@@ -152,21 +156,39 @@ TexRow::RowEntry TexRow::textEntry(int id, pos_type pos)
 TexRow::RowEntry TexRow::mathEntry(uid_type id, idx_type cell)
 {
        RowEntry entry;
-       entry.is_math = true;
+       entry.type = math_entry;
        entry.math.cell = cell;
        entry.math.id = id;
        return entry;
 }
 
 
+//static
+TexRow::RowEntry TexRow::beginDocument()
+{
+       RowEntry entry;
+       entry.type = begin_document;
+       entry.begindocument = {};
+       return entry;
+}
+
+
 bool operator==(TexRow::RowEntry entry1, TexRow::RowEntry entry2)
 {
-       return entry1.is_math == entry2.is_math
-               && (entry1.is_math
-                   ? (entry1.math.id == entry2.math.id
-                      && entry1.math.cell == entry2.math.cell)
-                   : (entry1.text.id == entry2.text.id
-                      && entry1.text.pos == entry2.text.pos));
+       if (entry1.type != entry2.type)
+               return false;
+       switch (entry1.type) {
+       case TexRow::text_entry:
+               return entry1.text.id == entry2.text.id
+                       && entry1.text.pos == entry2.text.pos;
+       case TexRow::math_entry:
+               return entry1.math.id == entry2.math.id
+                       && entry1.math.cell == entry2.math.cell;
+       case TexRow::begin_document:
+               return true;
+       default:
+               return false;
+       }
 }
 
 
@@ -318,11 +340,11 @@ TexRow::RowEntry TexRow::rowEntryFromCursorSlice(CursorSlice const & slice)
        RowEntry entry;
        InsetMath * insetMath = slice.asInsetMath();
        if (insetMath) {
-               entry.is_math = 1;
+               entry.type = math_entry;
                entry.math.id = insetMath->id();
                entry.math.cell = slice.idx();
        } else if (slice.text()) {
-               entry.is_math = 0;
+               entry.type = text_entry;
                entry.text.id = slice.paragraph().id();
                entry.text.pos = slice.pos();
        } else
@@ -334,10 +356,18 @@ TexRow::RowEntry TexRow::rowEntryFromCursorSlice(CursorSlice const & slice)
 //static
 bool TexRow::sameParOrInsetMath(RowEntry entry1, RowEntry entry2)
 {
-       return entry1.is_math == entry2.is_math
-               && (entry1.is_math
-                   ? (entry1.math.id == entry2.math.id)
-                   : (entry1.text.id == entry2.text.id));
+       if (entry1.type != entry2.type)
+               return false;
+       switch (entry1.type) {
+       case TexRow::text_entry:
+               return entry1.text.id == entry2.text.id;
+       case TexRow::math_entry:
+               return entry1.math.id == entry2.math.id;
+       case TexRow::begin_document:
+               return true;
+       default:
+               return false;
+       }
 }
 
 
@@ -345,10 +375,16 @@ bool TexRow::sameParOrInsetMath(RowEntry entry1, RowEntry entry2)
 int TexRow::comparePos(RowEntry entry1, RowEntry entry2)
 {
        // assume it is sameParOrInsetMath
-       if (entry1.is_math)
-               return entry2.math.cell - entry1.math.cell;
-       else
+       switch (entry1.type /* equal to entry2.type */) {
+       case TexRow::text_entry:
                return entry2.text.pos - entry1.text.pos;
+       case TexRow::math_entry:
+               return entry2.math.cell - entry1.math.cell;
+       case TexRow::begin_document:
+               return 0;
+       default:
+               return 0;
+       }
 }
 
 
@@ -569,10 +605,19 @@ void TexRow::setRows(size_t r)
 docstring TexRow::asString(RowEntry entry)
 {
        odocstringstream os;
-       if (entry.is_math)
-               os << "(1," << entry.math.id << "," << entry.math.cell << ")";
-       else
-               os << "(0," << entry.text.id << "," << entry.text.pos << ")";
+       switch (entry.type) {
+       case TexRow::text_entry:
+               os << "(par " << entry.text.id << "," << entry.text.pos << ")";
+               break;
+       case TexRow::math_entry:
+               os << "(" << entry.math.id << "," << entry.math.cell << ")";
+               break;
+       case TexRow::begin_document:
+               os << "(begin_document)";
+               break;
+       default:
+               break;
+       }
        return os.str();
 }
 

diff --git a/src/TexRow.h b/src/TexRow.h
index 57c01ddb9ef6d2f6bb95b7e914885b88d11ec4c3..9797ffd493cedf6919c1211ae599c6e52011834f 100644 (file)
--- a/src/TexRow.h
+++ b/src/TexRow.h
@@ -52,6 +52,16 @@ typedef size_t idx_type;
 
 class TexRow {
 public:
+       /// We begin with defining the types of row information we are tracking
+       ///
+
+       /// 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; };
 
@@ -60,13 +70,31 @@ public:
 
        /// a container for passing entries around
        struct RowEntry {
-               bool is_math;// true iff the union is a math
+               RowType type;
                union {
-                       struct TextEntry text;
-                       struct MathEntry math;
+                       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;
@@ -106,20 +134,6 @@ public:
        /// 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);
 
@@ -146,6 +160,7 @@ public:
 
        /**
         * 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
@@ -184,6 +199,7 @@ public:
 
        /// Finds the best pair of rows for dit
        /// returns (-1,-1) if not found.
+       /// This is the main algorithm behind forward-search.
        std::pair<int,int> rowFromDocIterator(DocIterator const & dit) const;
 
        /// Finds the best pair of rows for cursor, taking the selection into
@@ -204,7 +220,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