src/Changes.cpp

   1 /**
   2  * \file Changes.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author John Levon
   7  * \author Michael Gerz
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  *
  11  * Record changes in a paragraph.
  12  */
  13
  14 #include <config.h>
  15
  16 #include "Changes.h"
  17 #include "Author.h"
  18 #include "Buffer.h"
  19 #include "BufferParams.h"
  20 #include "LaTeXFeatures.h"
  21 #include "Paragraph.h"
  22 #include "TocBackend.h"
  23
  24 #include "support/debug.h"
  25 #include "support/gettext.h"
  26 #include "support/lassert.h"
  27
  28 #include <ostream>
  29
  30 using namespace std;
  31
  32 namespace lyx {
  33
  34 /*
  35  * Class Change has a changetime field that specifies the exact time at which
  36  * a specific change was made. The change time is used as a guidance for the
  37  * user while editing his document. Presently, it is not considered for LaTeX
  38  * export.
  39  * When merging two adjacent changes, the changetime is not considered,
  40  * only the equality of the change type and author is checked (in method
  41  * isSimilarTo(...)). If two changes are in fact merged (in method merge()),
  42  * the later change time is preserved.
  43  */
  44
  45 bool Change::isSimilarTo(Change const & change) const
  46 {
  47         if (type != change.type)
  48                 return false;
  49
  50         if (type == Change::UNCHANGED)
  51                 return true;
  52
  53         return author == change.author;
  54 }
  55
  56
  57 ColorCode Change::color() const
  58 {
  59         ColorCode color = Color_none;
  60         switch (author % 5) {
  61                 case 0:
  62                         color = Color_changedtextauthor1;
  63                         break;
  64                 case 1:
  65                         color = Color_changedtextauthor2;
  66                         break;
  67                 case 2:
  68                         color = Color_changedtextauthor3;
  69                         break;
  70                 case 3:
  71                         color = Color_changedtextauthor4;
  72                         break;
  73                 case 4:
  74                         color = Color_changedtextauthor5;
  75                         break;
  76         }
  77         return color;
  78 }
  79
  80
  81 bool operator==(Change const & l, Change const & r)
  82 {
  83         if (l.type != r.type)
  84                 return false;
  85
  86         // two changes of type UNCHANGED are always equal
  87         if (l.type == Change::UNCHANGED)
  88                 return true;
  89
  90         return l.author == r.author && l.changetime == r.changetime;
  91 }
  92
  93
  94 bool operator!=(Change const & l, Change const & r)
  95 {
  96         return !(l == r);
  97 }
  98
  99
 100 bool operator==(Changes::Range const & r1, Changes::Range const & r2)
 101 {
 102         return r1.start == r2.start && r1.end == r2.end;
 103 }
 104
 105
 106 bool operator!=(Changes::Range const & r1, Changes::Range const & r2)
 107 {
 108         return !(r1 == r2);
 109 }
 110
 111
 112 bool Changes::Range::intersects(Range const & r) const
 113 {
 114         return r.start < end && r.end > start; // end itself is not in the range!
 115 }
 116
 117
 118 void Changes::set(Change const & change, pos_type const pos)
 119 {
 120         set(change, pos, pos + 1);
 121 }
 122
 123
 124 void Changes::set(Change const & change, pos_type const start, pos_type const end)
 125 {
 126         if (change.type != Change::UNCHANGED) {
 127                 LYXERR(Debug::CHANGES, "setting change (type: " << change.type
 128                         << ", author: " << change.author
 129                         << ", time: " << long(change.changetime)
 130                         << ") in range (" << start << ", " << end << ")");
 131         }
 132
 133         Range const newRange(start, end);
 134
 135         ChangeTable::iterator it = table_.begin();
 136
 137         for (; it != table_.end(); ) {
 138                 // current change starts like or follows new change
 139                 if (it->range.start >= start) {
 140                         break;
 141                 }
 142
 143                 // new change intersects with existing change
 144                 if (it->range.end > start) {
 145                         pos_type oldEnd = it->range.end;
 146                         it->range.end = start;
 147
 148                         LYXERR(Debug::CHANGES, "  cutting tail of type " << it->change.type
 149                                 << " resulting in range (" << it->range.start << ", "
 150                                 << it->range.end << ")");
 151
 152                         ++it;
 153                         if (oldEnd >= end) {
 154                                 LYXERR(Debug::CHANGES, "  inserting tail in range ("
 155                                         << end << ", " << oldEnd << ")");
 156                                 it = table_.insert(it, ChangeRange((it-1)->change, Range(end, oldEnd)));
 157                         }
 158                         continue;
 159                 }
 160
 161                 ++it;
 162         }
 163
 164         if (change.type != Change::UNCHANGED) {
 165                 LYXERR(Debug::CHANGES, "  inserting change");
 166                 it = table_.insert(it, ChangeRange(change, Range(start, end)));
 167                 ++it;
 168         }
 169
 170         for (; it != table_.end(); ) {
 171                 // new change 'contains' existing change
 172                 if (newRange.contains(it->range)) {
 173                         LYXERR(Debug::CHANGES, "  removing subrange ("
 174                                 << it->range.start << ", " << it->range.end << ")");
 175                         it = table_.erase(it);
 176                         continue;
 177                 }
 178
 179                 // new change precedes existing change
 180                 if (it->range.start >= end)
 181                         break;
 182
 183                 // new change intersects with existing change
 184                 it->range.start = end;
 185                 LYXERR(Debug::CHANGES, "  cutting head of type "
 186                         << it->change.type << " resulting in range ("
 187                         << end << ", " << it->range.end << ")");
 188                 break; // no need for another iteration
 189         }
 190
 191         merge();
 192 }
 193
 194
 195 void Changes::erase(pos_type const pos)
 196 {
 197         LYXERR(Debug::CHANGES, "Erasing change at position " << pos);
 198
 199         ChangeTable::iterator it = table_.begin();
 200         ChangeTable::iterator end = table_.end();
 201
 202         for (; it != end; ++it) {
 203                 // range (pos,pos+x) becomes (pos,pos+x-1)
 204                 if (it->range.start > pos)
 205                         --(it->range.start);
 206                 // range (pos-x,pos) stays (pos-x,pos)
 207                 if (it->range.end > pos)
 208                         --(it->range.end);
 209         }
 210
 211         merge();
 212 }
 213
 214
 215 void Changes::insert(Change const & change, lyx::pos_type pos)
 216 {
 217         if (change.type != Change::UNCHANGED) {
 218                 LYXERR(Debug::CHANGES, "Inserting change of type " << change.type
 219                         << " at position " << pos);
 220         }
 221
 222         ChangeTable::iterator it = table_.begin();
 223         ChangeTable::iterator end = table_.end();
 224
 225         for (; it != end; ++it) {
 226                 // range (pos,pos+x) becomes (pos+1,pos+x+1)
 227                 if (it->range.start >= pos)
 228                         ++(it->range.start);
 229
 230                 // range (pos-x,pos) stays as it is
 231                 if (it->range.end > pos)
 232                         ++(it->range.end);
 233         }
 234
 235         set(change, pos, pos + 1); // set will call merge
 236 }
 237
 238
 239 Change const & Changes::lookup(pos_type const pos) const
 240 {
 241         static Change const noChange = Change(Change::UNCHANGED);
 242
 243         ChangeTable::const_iterator it = table_.begin();
 244         ChangeTable::const_iterator const end = table_.end();
 245
 246         for (; it != end; ++it) {
 247                 if (it->range.contains(pos))
 248                         return it->change;
 249         }
 250
 251         return noChange;
 252 }
 253
 254
 255 bool Changes::isChanged(pos_type const start, pos_type const end) const
 256 {
 257         ChangeTable::const_iterator it = table_.begin();
 258         ChangeTable::const_iterator const itend = table_.end();
 259
 260         for (; it != itend; ++it) {
 261                 if (it->range.intersects(Range(start, end))) {
 262                         LYXERR(Debug::CHANGES, "found intersection of range ("
 263                                 << start << ", " << end << ") with ("
 264                                 << it->range.start << ", " << it->range.end
 265                                 << ") of type " << it->change.type);
 266                         return true;
 267                 }
 268         }
 269         return false;
 270 }
 271
 272
 273 void Changes::merge()
 274 {
 275         ChangeTable::iterator it = table_.begin();
 276
 277         while (it != table_.end()) {
 278                 LYXERR(Debug::CHANGES, "found change of type " << it->change.type
 279                         << " and range (" << it->range.start << ", " << it->range.end
 280                         << ")");
 281
 282                 if (it->range.start == it->range.end) {
 283                         LYXERR(Debug::CHANGES, "removing empty range for pos "
 284                                 << it->range.start);
 285
 286                         table_.erase(it);
 287                         // start again
 288                         it = table_.begin();
 289                         continue;
 290                 }
 291
 292                 if (it + 1 == table_.end())
 293                         break;
 294
 295                 if (it->change.isSimilarTo((it + 1)->change)
 296                     && it->range.end == (it + 1)->range.start) {
 297                         LYXERR(Debug::CHANGES, "merging ranges (" << it->range.start << ", "
 298                                 << it->range.end << ") and (" << (it + 1)->range.start << ", "
 299                                 << (it + 1)->range.end << ")");
 300
 301                         (it + 1)->range.start = it->range.start;
 302                         (it + 1)->change.changetime = max(it->change.changetime,
 303                                                           (it + 1)->change.changetime);
 304                         table_.erase(it);
 305                         // start again
 306                         it = table_.begin();
 307                         continue;
 308                 }
 309
 310                 ++it;
 311         }
 312 }
 313
 314
 315 int Changes::latexMarkChange(odocstream & os, BufferParams const & bparams,
 316                              Change const & oldChange, Change const & change)
 317 {
 318         if (!bparams.outputChanges || oldChange == change)
 319                 return 0;
 320
 321         int column = 0;
 322
 323         if (oldChange.type != Change::UNCHANGED) {
 324                 os << '}'; // close \lyxadded or \lyxdeleted
 325                 column++;
 326         }
 327
 328         docstring chgTime;
 329         chgTime += ctime(&change.changetime);
 330         chgTime.erase(chgTime.end() - 1); // remove trailing '\n'
 331
 332         if (change.type == Change::DELETED) {
 333                 docstring str = "\\lyxdeleted{" +
 334                         bparams.authors().get(change.author).name() + "}{" +
 335                         chgTime + "}{";
 336                 os << str;
 337                 column += str.size();
 338         } else if (change.type == Change::INSERTED) {
 339                 docstring str = "\\lyxadded{" +
 340                         bparams.authors().get(change.author).name() + "}{" +
 341                         chgTime + "}{";
 342                 os << str;
 343                 column += str.size();
 344         }
 345
 346         return column;
 347 }
 348
 349
 350 void Changes::lyxMarkChange(ostream & os, int & column,
 351                             Change const & old, Change const & change)
 352 {
 353         if (old == change)
 354                 return;
 355
 356         column = 0;
 357
 358         switch (change.type) {
 359                 case Change::UNCHANGED:
 360                         os << "\n\\change_unchanged\n";
 361                         break;
 362
 363                 case Change::DELETED: {
 364                         os << "\n\\change_deleted " << change.author
 365                                 << " " << change.changetime << "\n";
 366                         break;
 367                 }
 368
 369                 case Change::INSERTED: {
 370                         os << "\n\\change_inserted " << change.author
 371                                 << " " << change.changetime << "\n";
 372                         break;
 373                 }
 374         }
 375 }
 376
 377
 378 void Changes::checkAuthors(AuthorList const & authorList)
 379 {
 380         ChangeTable::const_iterator it = table_.begin();
 381         ChangeTable::const_iterator endit = table_.end();
 382         for ( ; it != endit ; ++it)
 383                 if (it->change.type != Change::UNCHANGED)
 384                         authorList.get(it->change.author).setUsed(true);
 385 }
 386
 387
 388 void Changes::addToToc(DocIterator const & cdit, Buffer const & buffer) const
 389 {
 390         if (table_.empty())
 391                 return;
 392
 393         Toc & change_list = buffer.tocBackend().toc("change");
 394         AuthorList const & author_list = buffer.params().authors();
 395         DocIterator dit = cdit;
 396
 397         ChangeTable::const_iterator it = table_.begin();
 398         ChangeTable::const_iterator const itend = table_.end();
 399         for (; it != itend; ++it) {
 400                 docstring str;
 401                 switch (it->change.type) {
 402                 case Change::UNCHANGED:
 403                         continue;
 404                 case Change::DELETED:
 405                         // 0x2702 is a scissors symbol in the Dingbats unicode group.
 406                         str.push_back(0x2702);
 407                         break;
 408                 case Change::INSERTED:
 409                         // 0x2702 is the hand writting symbol in the Dingbats unicode group.
 410                         str.push_back(0x270d);
 411                         break;
 412                 }
 413                 dit.pos() = it->range.start;
 414                 Paragraph const & par = dit.paragraph();
 415                 str += " " + par.asString(it->range.start, max(par.size(), it->range.end));
 416                 // FIXME: find an unicode character for carriage return presentation if
 417                 // present; i.e. when it->range.end > par.size()
 418                 docstring const & author = author_list.get(it->change.author).name();
 419                 Toc::iterator it = change_list.item(0, author);
 420                 if (it == change_list.end()) {
 421                         change_list.push_back(TocItem(dit, 0, author));
 422                         change_list.push_back(TocItem(dit, 1, str));
 423                         continue;
 424                 }
 425                 for (++it; it != change_list.end(); ++it) {
 426                         if (it->depth() == 0 && it->str() != author)
 427                                 break;
 428                 }
 429                 change_list.insert(it, TocItem(dit, 1, str));
 430         }
 431 }
 432
 433 } // namespace lyx