* 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;
}
}
-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!
}
-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;
+ if (change.type != Change::UNCHANGED && lyxerr.debugging(Debug::CHANGES)) {
+ 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);
- // remove all sub-ranges
- for (; it != table_.end();) {
- if (new_range != it->range /*&& it->range.contained(new_range)*/) { // FIXME: change tracking (MG)
+ ChangeTable::iterator it = table_.begin();
+
+ for (; it != table_.end(); ) {
+ // current change starts like or follows new change
+ if (it->range.start >= start) {
+ break;
+ }
+
+ // 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(start, end, change));
- 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.range.start, start, c.change));
+ 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(end, c.range.end, c.change));
+ // 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();
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 (change.type != Change::UNCHANGED && 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();
return it->change;
}
- BOOST_ASSERT(false && "missing changes for pos");
- return Change(Change::UNCHANGED);
+ return noChange;
}
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;
-
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;
}
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();
++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{}"));
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();
}
break;
case Change::INSERTED:
- if (old == Change::UNCHANGED) {
+ if (oldChangeType == Change::UNCHANGED) {
os << start;
column += start.length();
}
void Changes::lyxMarkChange(std::ostream & os, int & column,
- time_type const curtime,
Change const & old, Change const & change)
{
if (old == change)
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;
- }
+ }
}
}