X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fchanges.C;h=1ad18c6bf29048537b13eca6de4c4b2d8cd202c5;hb=c4320d24cd2d29c2e77958b4a8fd44f2bd587ca7;hp=8b73679cb8b77a48f2811c9fbcf15448f51b5315;hpb=04a381977918db73961a14fe0799a0051a3c1689;p=lyx.git diff --git a/src/changes.C b/src/changes.C index 8b73679cb8..1ad18c6bf2 100644 --- a/src/changes.C +++ b/src/changes.C @@ -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. * @@ -17,16 +18,44 @@ #include -using lyx::pos_type; +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; + return l.type == r.type && + l.author == r.author && + l.changetime == r.changetime; } @@ -54,272 +83,155 @@ bool Changes::Range::contains(Range const & r) const } -bool Changes::Range::contained(Range const & r) const -{ - return r.contains(*this); -} - - bool Changes::Range::contains(pos_type const pos) const { return pos >= start && pos < end; } -bool Changes::Range::loose_contains(pos_type const pos) const -{ - return pos >= start && pos <= end; -} - - bool Changes::Range::intersects(Range const & r) const { - return contained(r) || contains(r) - || contains(r.start) || contains(r.end); -} - - -Changes::Changes(Change::Type const type) - : empty_type_(type) -{ -} - - -Changes::~Changes() -{ + return r.start < end && r.end > start; // end itself is not in the range! } -Changes::Changes(Changes const & c) +void Changes::set(Change const & change, pos_type const pos) { - table_ = c.table_; + set(change, pos, pos + 1); } -void Changes::record(Change const change, pos_type const pos) +void Changes::set(Change const & change, pos_type const start, pos_type const end) { if (lyxerr.debugging(Debug::CHANGES)) { - lyxerr[Debug::CHANGES] << "record " << change.type - << " at pos " << pos << " with total " - << table_.size() << " changes." << endl; - } - - switch (change.type) { - case Change::INSERTED: - add(change, pos); - break; - case Change::DELETED: - del(change, pos); - break; - case Change::UNCHANGED: - set(Change::UNCHANGED, pos); - break; + lyxerr[Debug::CHANGES] << "setting change (type: " << change.type + << ", author: " << change.author << ", time: " << change.changetime + << ") in range (" << start << ", " << end << ")" << endl; } -} + Range const newRange(start, end); -void Changes::set(Change const change, pos_type const pos) -{ - set(change, pos, pos + 1); -} - - -void Changes::set(Change::Type const type, pos_type const pos) -{ - set(type, pos, pos + 1); -} - - -void Changes::set(Change::Type const type, - pos_type const start, pos_type const end) -{ - set(Change(type), start, 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; - } - - Range const new_range(start, end); + 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)) { + // 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 } - check(); 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; - } - - if (range.contains(pos)) { - found = true; - --range.end; - continue; + // range (pos,pos+x) becomes (pos,pos+x-1) + if (it->range.start > pos) { + --(it->range.start); } - - if (found) { - --range.start; - --range.end; + // range (pos-x,pos) stays (pos-x,pos) + if (it->range.end > pos) { + --(it->range.end); } } - check(); + merge(); } -void Changes::del(Change const change, ChangeTable::size_type const pos) +void Changes::insert(Change const & change, lyx::pos_type pos) { - // this case happens when building from .lyx - if (table_.empty()) { - set(change, pos); - return; - } - - ChangeTable::iterator it = table_.begin(); - - for (; it != table_.end(); ++it) { - Range & range(it->range); - - if (range.contains(pos)) { - if (it->change.type != Change::INSERTED) { - set(change, pos); - } else { - erase(pos); - } - break; - } else if (range.loose_contains(pos) && it + 1 == table_.end()) { - // this case happens when building from .lyx - set(change, pos); - break; - } + if (lyxerr.debugging(Debug::CHANGES)) { + lyxerr[Debug::CHANGES] << "Inserting change of type " << change.type + << " at position " << pos << endl; } -} - -void Changes::add(Change const change, ChangeTable::size_type const pos) -{ ChangeTable::iterator it = table_.begin(); ChangeTable::iterator end = table_.end(); - bool found = false; - for (; it != end; ++it) { - Range & range(it->range); - - if (!found && range.loose_contains(pos)) { - found = true; - if (lyxerr.debugging(Debug::CHANGES)) { - lyxerr[Debug::CHANGES] << "Found range of " - << range.start << "," << range.end << endl; - } - ++range.end; - continue; + // 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); } } - set(change, pos); + + set(change, pos, pos + 1); // set will call merge } -Change const Changes::lookupFull(pos_type const pos) const +Change const Changes::lookup(pos_type const pos) const { - if (!table_.size()) { - if (lyxerr.debugging(Debug::CHANGES)) - lyxerr[Debug::CHANGES] << "Empty, type is " << empty_type_ << endl; - return Change(empty_type_); - } - ChangeTable::const_iterator it = table_.begin(); ChangeTable::const_iterator const end = table_.end(); @@ -328,106 +240,48 @@ Change const Changes::lookupFull(pos_type const pos) const return it->change; } - check(); - BOOST_ASSERT(false && "missing changes for pos"); return Change(Change::UNCHANGED); } -Change::Type Changes::lookup(pos_type const pos) const +bool Changes::isChanged(pos_type const start, pos_type const end) const { - if (!table_.size()) { - if (lyxerr.debugging(Debug::CHANGES)) - lyxerr[Debug::CHANGES] << "Empty, type is " << empty_type_ << endl; - return empty_type_; - } - - ChangeTable::const_iterator it = table_.begin(); - ChangeTable::const_iterator end = table_.end(); - - for (; it != end; ++it) { - if (it->range.contains(pos)) - return it->change.type; - } - - check(); - BOOST_ASSERT(false && "missing changes for pos"); - return Change::UNCHANGED; -} - - -bool Changes::isChange(pos_type const start, pos_type const end) const -{ - if (!table_.size()) { - if (lyxerr.debugging(Debug::CHANGES)) - lyxerr[Debug::CHANGES] << "Empty, type is " << empty_type_ << endl; - return empty_type_ != Change::UNCHANGED; - } - ChangeTable::const_iterator it = table_.begin(); 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; -} - - -bool Changes::isChangeEdited(lyx::pos_type const start, - lyx::pos_type const end) const -{ - if (!table_.size()) { - if (lyxerr.debugging(Debug::CHANGES)) - lyxerr[Debug::CHANGES] << "Empty, type is " << empty_type_ << endl; - return empty_type_ != Change::INSERTED; - } - - ChangeTable::const_iterator it = table_.begin(); - ChangeTable::const_iterator const itend = table_.end(); - - for (; it != itend; ++it) { - if (it->range.intersects(Range(start, end ? end - 1 : 0)) - && it->change.type != Change::INSERTED) { - 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; } @@ -440,15 +294,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(); @@ -457,70 +311,36 @@ void Changes::merge() ++it; } - - lyxerr[Debug::CHANGES] << "Merge ended" << endl; - check(); } -void Changes::check() const -{ - ChangeTable::const_iterator it = table_.begin(); - ChangeTable::const_iterator end = table_.end(); - - bool dont_assert = true; - - lyxerr[Debug::CHANGES] << "Changelist:" << endl; - for (; it != end; ++it) { - if (lyxerr.debugging(Debug::CHANGES)) { - lyxerr[Debug::CHANGES] << "Range of type " << it->change.type << " is " - << it->range.start << "," << it->range.end << " author " - << it->change.author << " time " << it->change.changetime << endl; - } - - if (it + 1 == end) - break; - - Range const & range(it->range); - Range const & next((it + 1)->range); - if (range.end != next.start) - dont_assert = false; - } - - if (lyxerr.debugging(Debug::CHANGES)) - lyxerr[Debug::CHANGES] << "End" << endl; - - BOOST_ASSERT(dont_assert); -} - - -int Changes::latexMarkChange(std::ostream & os, - Change::Type const old, Change::Type const change, +int Changes::latexMarkChange(odocstream & os, + Change::Type const oldChangeType, Change::Type const changeType, bool const & output) { - if (!output || old == change) + if (!output || oldChangeType == changeType) return 0; - - string const start("\\changestart{}"); - string const end("\\changeend{}"); - string const son("\\overstrikeon{}"); - string const soff("\\overstrikeoff{}"); + + static docstring const start(from_ascii("\\changestart{}")); + static docstring const end(from_ascii("\\changeend{}")); + static docstring const son(from_ascii("\\overstrikeon{}")); + static docstring const soff(from_ascii("\\overstrikeoff{}")); 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(); } @@ -529,7 +349,7 @@ int Changes::latexMarkChange(std::ostream & os, break; case Change::INSERTED: - if (old == Change::UNCHANGED) { + if (oldChangeType == Change::UNCHANGED) { os << start; column += start.length(); } @@ -541,7 +361,6 @@ int Changes::latexMarkChange(std::ostream & os, void Changes::lyxMarkChange(std::ostream & os, int & column, - lyx::time_type const curtime, Change const & old, Change const & change) { if (old == change) @@ -555,22 +374,18 @@ void Changes::lyxMarkChange(std::ostream & os, int & column, break; case Change::DELETED: { - lyx::time_type t = change.changetime; - if (!t) - t = curtime; os << "\n\\change_deleted " << change.author - << " " << t << "\n"; - + << " " << change.changetime << "\n"; break; } - case Change::INSERTED: { - lyx::time_type t = change.changetime; - if (!t) - t = curtime; + case Change::INSERTED: { os << "\n\\change_inserted " << change.author - << " " << t << "\n"; + << " " << change.changetime << "\n"; break; - } + } } } + + +} // namespace lyx