]> git.lyx.org Git - lyx.git/blobdiff - src/changes.C
* src/LyXAction.C: mark goto-clear-bookmark as working without buffer
[lyx.git] / src / changes.C
index 4265e22c52c5c8d4c9271590271f76bb0a080b66..511e429ede717258b03927e40e0335fc533a34c5 100644 (file)
@@ -4,6 +4,7 @@
  * Licence details can be found in the file COPYING.
  *
  * \author John Levon
+ * \author Michael Gerz
  *
  * Full author contact details are available in file CREDITS.
  *
 
 namespace lyx {
 
+using std::abs;
 using std::endl;
 using std::string;
+using std::max;
+
+/*
+ * Class Change has a changetime field that specifies the exact time at which
+ * a specific change was made. The change time is used as a guidance for the
+ * user while editing his document. Presently, it is not considered for LaTeX
+ * export.
+ * When merging two adjacent changes, the changetime is not considered,
+ * only the equality of the change type and author is checked (in method
+ * isSimilarTo(...)). If two changes are in fact merged (in method merge()),
+ * the later change time is preserved. 
+ */
+
+bool Change::isSimilarTo(Change const & change)
+{
+       if (type != change.type) {
+               return false;
+       }
+
+       if (type == Change::UNCHANGED) {
+               return true;
+       }
+
+       return author == change.author;
+}
 
 
 bool operator==(Change const & l, Change const & r)
 {
-       return l.type == r.type && l.author == r.author
-               && l.changetime == r.changetime;
+       if (l.type != r.type) {
+               return false;
+       }
+
+       // two changes of type UNCHANGED are always equal
+       if (l.type == Change::UNCHANGED) {
+               return true;
+       }
+       
+       return l.author == r.author &&
+              l.changetime == r.changetime;
 }
 
 
@@ -49,18 +85,6 @@ bool operator!=(Changes::Range const & r1, Changes::Range const & r2)
 }
 
 
-bool Changes::Range::contains(Range const & r) const
-{
-       return r.start >= start && r.end <= end;
-}
-
-
-bool Changes::Range::contains(pos_type const pos) const
-{
-       return pos >= start && pos < end;
-}
-
-
 bool Changes::Range::intersects(Range const & r) const
 {
        return r.start < end && r.end > start; // end itself is not in the range!
@@ -73,85 +97,79 @@ void Changes::set(Change const & change, pos_type const pos)
 }
 
 
-void Changes::set(Change const & change,
-                 pos_type const start, pos_type const end)
+void Changes::set(Change const & change, pos_type const start, pos_type const end)
 {
-       ChangeTable::iterator it = table_.begin();
-
        if (lyxerr.debugging(Debug::CHANGES)) {
-               lyxerr[Debug::CHANGES] << "changeset of " << change.type
-                       << " author " << change.author << " time " << change.changetime
-                       << " in range " << start << "," << end << endl;
+               lyxerr[Debug::CHANGES] << "setting change (type: " << change.type
+                       << ", author: " << change.author << ", time: " << change.changetime
+                       << ") in range (" << start << ", " << end << ")" << endl;
        }
 
-       Range const new_range(start, end);
+       Range const newRange(start, end);
+
+       ChangeTable::iterator it = table_.begin();
+
+       for (; it != table_.end(); ) {
+               // current change starts like or follows new change
+               if (it->range.start >= start) {
+                       break;
+               }
 
-       // remove all sub-ranges
-       for (; it != table_.end();) {
-               if (new_range != it->range /*&& it->range.contained(new_range)*/) { // FIXME: change tracking (MG)
+               // new change intersects with existing change
+               if (it->range.end > start) {
+                       pos_type oldEnd = it->range.end;
+                       it->range.end = start;
                        if (lyxerr.debugging(Debug::CHANGES)) {
-                               lyxerr[Debug::CHANGES] << "Removing subrange "
-                                       << it->range.start << "," << it->range.end << endl;
+                               lyxerr[Debug::CHANGES] << "  cutting tail of type " << it->change.type
+                                       << " resulting in range (" << it->range.start << ", "
+                                       << it->range.end << ")" << endl;
                        }
-                       it = table_.erase(it);
-               } else {
                        ++it;
+                       if (oldEnd >= end) {
+                               if (lyxerr.debugging(Debug::CHANGES)) {
+                                       lyxerr[Debug::CHANGES] << "  inserting tail in range ("
+                                               << end << ", " << oldEnd << ")" << endl;
+                               }
+                               it = table_.insert(it, ChangeRange((it-1)->change, Range(end, oldEnd)));
+                       }
+                       continue;
                }
-       }
-
-       it = table_.begin();
-       ChangeTable::iterator const itend = table_.end();
-
-       // find a super-range
-       for (; it != itend; ++it) {
-               if (it->range.contains(new_range))
-                       break;
-       }
-
-       if (it == itend) {
-               lyxerr[Debug::CHANGES] << "Inserting change at end" << endl;
-               table_.push_back(ChangeRange(change, Range(start, end)));
-               merge();
-               return;
-       }
 
-       if (change.type == it->change.type) {
-               lyxerr[Debug::CHANGES] << "Change set already." << endl;
-               it->change = change;
-               return;
-       }
-
-       ChangeRange c(*it);
-
-       if (lyxerr.debugging(Debug::CHANGES)) {
-               lyxerr[Debug::CHANGES] << "Using change of type " << c.change.type
-                       << " over " << c.range.start << "," << c.range.end << endl;
+               ++it;
        }
 
-       // split head
-       if (c.range.start < start) {
-               it = table_.insert(it, ChangeRange(c.change, Range(c.range.start, start)));
+       if (change.type != Change::UNCHANGED) {
                if (lyxerr.debugging(Debug::CHANGES)) {
-                       lyxerr[Debug::CHANGES] << "Splitting head of type " << c.change.type
-                               << " over " << c.range.start << "," << start << endl;
+                       lyxerr[Debug::CHANGES] << "  inserting change" << endl;
                }
+               it = table_.insert(it, ChangeRange(change, Range(start, end)));
                ++it;
        }
 
-       // reset this as new type
-       it->range.start = start;
-       it->range.end = end;
-       it->change = change;
-       lyxerr[Debug::CHANGES] << "Resetting to new change" << endl;
+       for (; it != table_.end(); ) {
+               // new change 'contains' existing change
+               if (newRange.contains(it->range)) {
+                       if (lyxerr.debugging(Debug::CHANGES)) {
+                               lyxerr[Debug::CHANGES] << "  removing subrange ("
+                                       << it->range.start << ", " << it->range.end << ")" << endl;
+                       }
+                       it = table_.erase(it);
+                       continue;
+               }
 
-       // split tail
-       if (c.range.end > end) {
-               ++it;
-               table_.insert(it, ChangeRange(c.change, Range(end, c.range.end)));
+               // new change precedes existing change
+               if (it->range.start >= end) {
+                       break;
+               }
+
+               // new change intersects with existing change
+               it->range.start = end;
                if (lyxerr.debugging(Debug::CHANGES)) {
-                       lyxerr[Debug::CHANGES] << "Splitting tail of type " << c.change.type
-                               << " over " << end << "," << c.range.end << endl;
+                       lyxerr[Debug::CHANGES] << "  cutting head of type "
+                               << it->change.type << " resulting in range ("
+                               << end << ", " << it->range.end << ")" << endl;
                }
+               break; // no need for another iteration
        }
 
        merge();
@@ -160,36 +178,58 @@ void Changes::set(Change const & change,
 
 void Changes::erase(pos_type const pos)
 {
+       if (lyxerr.debugging(Debug::CHANGES)) {
+               lyxerr[Debug::CHANGES] << "Erasing change at position " << pos << endl;
+       }
+
        ChangeTable::iterator it = table_.begin();
        ChangeTable::iterator end = table_.end();
 
-       bool found = false;
-
        for (; it != end; ++it) {
-               Range & range(it->range);
-
-               if (lyxerr.debugging(Debug::CHANGES)) {
-                       lyxerr[Debug::CHANGES] << "era:Range of type " << it->change.type << " is "
-                               << it->range.start << "," << it->range.end << endl;
+               // range (pos,pos+x) becomes (pos,pos+x-1)
+               if (it->range.start > pos) {
+                       --(it->range.start);
+               }
+               // range (pos-x,pos) stays (pos-x,pos)
+               if (it->range.end > pos) {
+                       --(it->range.end);
                }
+       }
 
-               if (range.contains(pos)) {
-                       found = true;
-                       --range.end;
-                       continue;
+       merge();
+}
+
+
+void Changes::insert(Change const & change, lyx::pos_type pos)
+{
+       if (lyxerr.debugging(Debug::CHANGES)) {
+               lyxerr[Debug::CHANGES] << "Inserting change of type " << change.type
+                       << " at position " << pos << endl;
+       }
+
+       ChangeTable::iterator it = table_.begin();
+       ChangeTable::iterator end = table_.end();
+
+       for (; it != end; ++it) {
+               // range (pos,pos+x) becomes (pos+1,pos+x+1)
+               if (it->range.start >= pos) {
+                       ++(it->range.start);
                }
 
-               if (found) {
-                       --range.start;
-                       --range.end;
+               // range (pos-x,pos) stays as it is
+               if (it->range.end > pos) {
+                       ++(it->range.end);
                }
        }
-       merge();
+
+       set(change, pos, pos + 1); // set will call merge
 }
 
 
-Change const Changes::lookup(pos_type const pos) const
+Change const Changes::lookup(pos_type const pos) const
 {
+       static Change const noChange = Change(Change::UNCHANGED);
+               
        ChangeTable::const_iterator it = table_.begin();
        ChangeTable::const_iterator const end = table_.end();
 
@@ -198,8 +238,7 @@ Change const Changes::lookup(pos_type const pos) const
                        return it->change;
        }
 
-       BOOST_ASSERT(false && "missing changes for pos");
-       return Change(Change::UNCHANGED);
+       return noChange;
 }
 
 
@@ -209,44 +248,38 @@ bool Changes::isChanged(pos_type const start, pos_type const end) const
        ChangeTable::const_iterator const itend = table_.end();
 
        for (; it != itend; ++it) {
-               if (lyxerr.debugging(Debug::CHANGES)) {
-                       lyxerr[Debug::CHANGES] << "Looking for " << start << ","
-                               << end << " in " << it->range.start << ","
-                               << it->range.end << "of type " << it->change.type << endl;
-               }
-
-               if (it->range.intersects(Range(start, end))
-                       && it->change.type != Change::UNCHANGED) {
+               if (it->range.intersects(Range(start, end))) {
                        if (lyxerr.debugging(Debug::CHANGES)) {
-                               lyxerr[Debug::CHANGES] << "Found intersection of "
-                                       << start << "," << end << " with "
-                                       << it->range.start << "," << it->range.end
-                                       << " of type " << it->change.type << endl;
+                               lyxerr[Debug::CHANGES] << "found intersection of range ("
+                                       << start << ", " << end << ") with ("
+                                       << it->range.start << ", " << it->range.end
+                                       << ") of type " << it->change.type << endl;
                        }
                        return true;
                }
        }
-
        return false;
 }
 
 
 void Changes::merge()
 {
-       if (lyxerr.debugging(Debug::CHANGES))
-               lyxerr[Debug::CHANGES] << "Starting merge" << endl;
+       if (lyxerr.debugging(Debug::CHANGES)) {
+               lyxerr[Debug::CHANGES] << "merging changes..." << endl;
+       }
 
        ChangeTable::iterator it = table_.begin();
 
        while (it != table_.end()) {
                if (lyxerr.debugging(Debug::CHANGES)) {
-                       lyxerr[Debug::CHANGES] << "Range of type " << it->change.type << " is "
-                               << it->range.start << "," << it->range.end << endl;
+                       lyxerr[Debug::CHANGES] << "  found change of type " << it->change.type
+                               << " and range (" << it->range.start << ", " << it->range.end
+                               << ")" << endl;
                }
 
                if (it->range.start == it->range.end) {
                        if (lyxerr.debugging(Debug::CHANGES)) {
-                               lyxerr[Debug::CHANGES] << "Removing empty range for pos "
+                               lyxerr[Debug::CHANGES] << "  removing empty range for pos "
                                        << it->range.start << endl;
                        }
 
@@ -259,15 +292,15 @@ void Changes::merge()
                if (it + 1 == table_.end())
                        break;
 
-               if (it->change == (it + 1)->change) {
+               if (it->change.isSimilarTo((it + 1)->change) && it->range.end == (it + 1)->range.start) {
                        if (lyxerr.debugging(Debug::CHANGES)) {
-                               lyxerr[Debug::CHANGES] << "Merging equal ranges "
-                                       << it->range.start << "," << it->range.end
-                                       << " and " << (it + 1)->range.start << ","
-                                       << (it + 1)->range.end << endl;
+                               lyxerr[Debug::CHANGES] << "  merging ranges (" << it->range.start << ", "
+                                       << it->range.end << ") and (" << (it + 1)->range.start << ", "
+                                       << (it + 1)->range.end << ")" << endl;
                        }
-
                        (it + 1)->range.start = it->range.start;
+                       (it + 1)->change.changetime = max(it->change.changetime,
+                                                         (it + 1)->change.changetime);
                        table_.erase(it);
                        // start again
                        it = table_.begin();
@@ -276,16 +309,14 @@ void Changes::merge()
 
                ++it;
        }
-
-       lyxerr[Debug::CHANGES] << "Merge ended" << endl;
 }
 
 
 int Changes::latexMarkChange(odocstream & os,
-                            Change::Type const old, Change::Type const change,
+                            Change::Type const oldChangeType, Change::Type const changeType,
                             bool const & output)
 {
-       if (!output || old == change)
+       if (!output || oldChangeType == changeType)
                return 0;
 
        static docstring const start(from_ascii("\\changestart{}"));
@@ -295,19 +326,19 @@ int Changes::latexMarkChange(odocstream & os,
 
        int column = 0;
 
-       if (old == Change::DELETED) {
+       if (oldChangeType == Change::DELETED) {
                os << soff;
                column += soff.length();
        }
 
-       switch (change) {
+       switch (changeType) {
                case Change::UNCHANGED:
                        os << end;
                        column += end.length();
                        break;
 
                case Change::DELETED:
-                       if (old == Change::UNCHANGED) {
+                       if (oldChangeType == Change::UNCHANGED) {
                                os << start;
                                column += start.length();
                        }
@@ -316,7 +347,7 @@ int Changes::latexMarkChange(odocstream & os,
                        break;
 
                case Change::INSERTED:
-                       if (old == Change::UNCHANGED) {
+                       if (oldChangeType == Change::UNCHANGED) {
                                os << start;
                                column += start.length();
                        }
@@ -328,7 +359,6 @@ int Changes::latexMarkChange(odocstream & os,
 
 
 void Changes::lyxMarkChange(std::ostream & os, int & column,
-                           time_type const curtime,
                            Change const & old, Change const & change)
 {
        if (old == change)
@@ -342,23 +372,16 @@ void Changes::lyxMarkChange(std::ostream & os, int & column,
                        break;
 
                case Change::DELETED: {
-                       time_type t = change.changetime;
-                       if (!t)
-                               t = curtime;
                        os << "\n\\change_deleted " << change.author
-                               << " " << t << "\n";
-
+                               << " " << change.changetime << "\n";
                        break;
                }
 
-       case Change::INSERTED: {
-                       time_type t = change.changetime;
-                       if (!t)
-                               t = curtime;
+               case Change::INSERTED: {
                        os << "\n\\change_inserted " << change.author
-                               << " " << t << "\n";
+                               << " " << change.changetime << "\n";
                        break;
-       }
+               }
        }
 }