]> git.lyx.org Git - lyx.git/blobdiff - src/Changes.cpp
Less expensive OP first as this might be called often.
[lyx.git] / src / Changes.cpp
index d83d7829ba9d28435fa24ada06cf39c7f83530e5..16bbb2fdd64452f0bbe789cda3097fff50a86bb0 100644 (file)
 #include "Author.h"
 #include "Buffer.h"
 #include "BufferParams.h"
+#include "Color.h"
 #include "Encoding.h"
-#include "LaTeXFeatures.h"
+#include "LyXRC.h"
 #include "MetricsInfo.h"
 #include "OutputParams.h"
 #include "Paragraph.h"
+#include "texstream.h"
 #include "TocBackend.h"
 
 #include "support/debug.h"
@@ -69,26 +71,29 @@ bool Change::isSimilarTo(Change const & change) const
 Color Change::color() const
 {
        Color color = Color_none;
-       switch (author % 5) {
-               case 0:
-                       color = Color_changedtextauthor1;
-                       break;
-               case 1:
-                       color = Color_changedtextauthor2;
-                       break;
-               case 2:
-                       color = Color_changedtextauthor3;
-                       break;
-               case 3:
-                       color = Color_changedtextauthor4;
-                       break;
-               case 4:
-                       color = Color_changedtextauthor5;
-                       break;
+       if (author == 0)
+               color = Color_changedtext_workarea_author1;
+       else if (author == 1)
+               color = Color_changedtext_workarea_comparison;
+       else {
+               switch ((author - 2) % 4) {
+                       case 0:
+                               color = Color_changedtext_workarea_author2;
+                               break;
+                       case 1:
+                               color = Color_changedtext_workarea_author3;
+                               break;
+                       case 2:
+                               color = Color_changedtext_workarea_author4;
+                               break;
+                       case 3:
+                               color = Color_changedtext_workarea_author5;
+                               break;
+               }
        }
 
        if (deleted())
-               color.mergeColor = Color_deletedtextmodifier;
+               color.mergeColor = Color_deletedtext_workarea_modifier;
 
        return color;
 }
@@ -141,11 +146,9 @@ void Changes::set(Change const & change, pos_type const start, pos_type const en
 {
        if (change.type != Change::UNCHANGED) {
                LYXERR(Debug::CHANGES, "setting change (type: " << change.type
-                       << ", author: " << change.author 
+                       << ", author: " << change.author
                        << ", time: " << long(change.changetime)
                        << ") in range (" << start << ", " << end << ")");
-               if (!isChanged())
-                       is_update_required_ = true;
        }
 
        Range const newRange(start, end);
@@ -214,16 +217,13 @@ void Changes::erase(pos_type const pos)
 {
        LYXERR(Debug::CHANGES, "Erasing change at position " << pos);
 
-       ChangeTable::iterator it = table_.begin();
-       ChangeTable::iterator end = table_.end();
-
-       for (; it != end; ++it) {
+       for (ChangeRange & cr : table_) {
                // range (pos,pos+x) becomes (pos,pos+x-1)
-               if (it->range.start > pos)
-                       --(it->range.start);
+               if (cr.range.start > pos)
+                       --(cr.range.start);
                // range (pos-x,pos) stays (pos-x,pos)
-               if (it->range.end > pos)
-                       --(it->range.end);
+               if (cr.range.end > pos)
+                       --(cr.range.end);
        }
 
        merge();
@@ -237,17 +237,14 @@ void Changes::insert(Change const & change, lyx::pos_type pos)
                        << " at position " << pos);
        }
 
-       ChangeTable::iterator it = table_.begin();
-       ChangeTable::iterator end = table_.end();
-
-       for (; it != end; ++it) {
+       for (ChangeRange & cr : table_) {
                // range (pos,pos+x) becomes (pos+1,pos+x+1)
-               if (it->range.start >= pos)
-                       ++(it->range.start);
+               if (cr.range.start >= pos)
+                       ++(cr.range.start);
 
                // range (pos-x,pos) stays as it is
-               if (it->range.end > pos)
-                       ++(it->range.end);
+               if (cr.range.end > pos)
+                       ++(cr.range.end);
        }
 
        set(change, pos, pos + 1); // set will call merge
@@ -257,70 +254,52 @@ void Changes::insert(Change const & change, lyx::pos_type pos)
 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();
-
-       for (; it != end; ++it) {
-               if (it->range.contains(pos))
-                       return it->change;
-       }
-
+       for (ChangeRange const & cr : table_)
+               if (cr.range.contains(pos))
+                       return cr.change;
        return noChange;
 }
 
 
 bool Changes::isDeleted(pos_type start, pos_type end) const
 {
-       ChangeTable::const_iterator it = table_.begin();
-       ChangeTable::const_iterator const itend = table_.end();
-
-       for (; it != itend; ++it) {
-               if (it->range.contains(Range(start, end))) {
+       for (ChangeRange const & cr : table_)
+               if (cr.range.contains(Range(start, end))) {
                        LYXERR(Debug::CHANGES, "range ("
                                << start << ", " << end << ") fully contains ("
-                               << it->range.start << ", " << it->range.end
-                               << ") of type " << it->change.type);
-                       return it->change.type == Change::DELETED;
+                               << cr.range.start << ", " << cr.range.end
+                               << ") of type " << cr.change.type);
+                       return cr.change.type == Change::DELETED;
                }
-       }
        return false;
 }
 
 
 bool Changes::isChanged(pos_type const start, pos_type const end) const
 {
-       ChangeTable::const_iterator it = table_.begin();
-       ChangeTable::const_iterator const itend = table_.end();
-
-       for (; it != itend; ++it) {
-               if (it->range.intersects(Range(start, end))) {
+       for (ChangeRange const & cr : table_)
+               if (cr.range.intersects(Range(start, end))) {
                        LYXERR(Debug::CHANGES, "found intersection of range ("
                                << start << ", " << end << ") with ("
-                               << it->range.start << ", " << it->range.end
-                               << ") of type " << it->change.type);
+                               << cr.range.start << ", " << cr.range.end
+                               << ") of type " << cr.change.type);
                        return true;
                }
-       }
        return false;
 }
 
 
 bool Changes::isChanged() const
 {
-       ChangeTable::const_iterator it = table_.begin();
-       ChangeTable::const_iterator const itend = table_.end();
-       for (; it != itend; ++it) {
-               if (it->change.changed())
+       for (ChangeRange const & cr : table_)
+               if (cr.change.changed())
                        return true;
-       }
        return false;
 }
 
 
 void Changes::merge()
 {
-       bool merged = false;
        ChangeTable::iterator it = table_.begin();
 
        while (it != table_.end()) {
@@ -333,7 +312,6 @@ void Changes::merge()
                                << it->range.start);
 
                        table_.erase(it);
-                       merged = true;
                        // start again
                        it = table_.begin();
                        continue;
@@ -352,7 +330,6 @@ void Changes::merge()
                        (it + 1)->change.changetime = max(it->change.changetime,
                                                          (it + 1)->change.changetime);
                        table_.erase(it);
-                       merged = true;
                        // start again
                        it = table_.begin();
                        continue;
@@ -360,14 +337,12 @@ void Changes::merge()
 
                ++it;
        }
-       if (merged && !isChanged())
-               is_update_required_ = true;
 }
 
 
 namespace {
 
-docstring getLaTeXMarkup(docstring const & macro, docstring const & author,
+docstring getLaTeXMarkup(docstring const & macro, Author const & author,
                         docstring const & chgTime,
                         OutputParams const & runparams)
 {
@@ -377,18 +352,52 @@ docstring getLaTeXMarkup(docstring const & macro, docstring const & author,
        docstring uncodable_author;
        odocstringstream ods;
 
+       docstring const author_name = author.name();
+       docstring const author_initials = author.initials();
+       
        ods << macro;
+       if (!author_initials.empty()) {
+               docstring uncodable_initials;
+               // convert utf8 author initials to something representable
+               // in the current encoding
+               pair<docstring, docstring> author_initials_latexed =
+                       runparams.encoding->latexString(author_initials, runparams.dryrun);
+               if (!author_initials_latexed.second.empty()) {
+                       LYXERR0("Omitting uncodable characters '"
+                               << author_initials_latexed.second
+                               << "' in change author initials!");
+                       uncodable_initials = author_initials;
+               }
+               ods << "[" << author_initials_latexed.first << "]";
+               // warn user (once) if we found uncodable glyphs.
+               if (!uncodable_initials.empty()) {
+                       static std::set<docstring> warned_author_initials;
+                       static Mutex warned_mutex;
+                       Mutex::Locker locker(&warned_mutex);
+                       if (warned_author_initials.find(uncodable_initials) == warned_author_initials.end()) {
+                               frontend::Alert::warning(_("Uncodable character in author initials"),
+                                       support::bformat(_("The author initials '%1$s',\n"
+                                         "used for change tracking, contain the following glyphs that\n"
+                                         "cannot be represented in the current encoding: %2$s.\n"
+                                         "These glyphs will be omitted in the exported LaTeX file.\n\n"
+                                         "Choose an appropriate document encoding (such as utf8)\n"
+                                         "or change the author initials."),
+                                       uncodable_initials, author_initials_latexed.second));
+                               warned_author_initials.insert(uncodable_initials);
+                       }
+               }
+       }
        // convert utf8 author name to something representable
        // in the current encoding
        pair<docstring, docstring> author_latexed =
-               runparams.encoding->latexString(author, runparams.dryrun);
+               runparams.encoding->latexString(author_name, runparams.dryrun);
        if (!author_latexed.second.empty()) {
                LYXERR0("Omitting uncodable characters '"
                        << author_latexed.second
                        << "' in change author name!");
-               uncodable_author = author;
+               uncodable_author = author_name;
        }
-       ods << author_latexed.first << "}{" << chgTime << "}{";
+       ods << "{" << author_latexed.first << "}{" << chgTime << "}{";
 
        // warn user (once) if we found uncodable glyphs.
        if (!uncodable_author.empty()) {
@@ -411,7 +420,7 @@ docstring getLaTeXMarkup(docstring const & macro, docstring const & author,
        return ods.str();
 }
 
-} //namespace anon
+} // namespace
 
 
 int Changes::latexMarkChange(otexstream & os, BufferParams const & bparams,
@@ -424,10 +433,13 @@ int Changes::latexMarkChange(otexstream & os, BufferParams const & bparams,
        int column = 0;
 
        if (oldChange.type != Change::UNCHANGED) {
-               // close \lyxadded or \lyxdeleted
-               os << '}';
-               column++;
-               if (oldChange.type == Change::DELETED)
+               if (oldChange.type != Change::DELETED || runparams.ctObject != CtObject::OmitObject) {
+                       // close \lyxadded or \lyxdeleted
+                       os << '}';
+                       column++;
+               }
+               if (oldChange.type == Change::DELETED
+                   && !runparams.wasDisplayMath)
                        --runparams.inulemcmd;
        }
 
@@ -438,16 +450,27 @@ int Changes::latexMarkChange(otexstream & os, BufferParams const & bparams,
 
        docstring macro_beg;
        if (change.type == Change::DELETED) {
-               macro_beg = from_ascii("\\lyxdeleted{");
-               ++runparams.inulemcmd;
+               if (runparams.ctObject == CtObject::OmitObject)
+                       return 0;
+               else if (runparams.ctObject == CtObject::Object)
+                       macro_beg = from_ascii("\\lyxobjdeleted");
+               else if (runparams.ctObject == CtObject::DisplayObject)
+                       macro_beg = from_ascii("\\lyxdisplayobjdeleted");
+               else if (runparams.ctObject == CtObject::UDisplayObject)
+                       macro_beg = from_ascii("\\lyxudisplayobjdeleted");
+               else {
+                       macro_beg = from_ascii("\\lyxdeleted");
+                       if (!runparams.inDisplayMath)
+                               ++runparams.inulemcmd;
+               }
        }
        else if (change.type == Change::INSERTED)
-               macro_beg = from_ascii("\\lyxadded{");
-       
+               macro_beg = from_ascii("\\lyxadded");
+
        docstring str = getLaTeXMarkup(macro_beg,
-                                      bparams.authors().get(change.author).name(),
+                                      bparams.authors().get(change.author),
                                       chgTime, runparams);
-       
+
        os << str;
        column += str.size();
 
@@ -483,31 +506,27 @@ void Changes::lyxMarkChange(ostream & os, BufferParams const & bparams, int & co
 }
 
 
-void Changes::checkAuthors(AuthorList const & authorList)
+void Changes::checkAuthors(AuthorList const & authorList) const
 {
-       ChangeTable::const_iterator it = table_.begin();
-       ChangeTable::const_iterator endit = table_.end();
-       for ( ; it != endit ; ++it) 
-               if (it->change.type != Change::UNCHANGED)
-                       authorList.get(it->change.author).setUsed(true);
+       for (ChangeRange const & cr : table_)
+               if (cr.change.type != Change::UNCHANGED)
+                       authorList.get(cr.change.author).setUsed(true);
 }
 
 
 void Changes::addToToc(DocIterator const & cdit, Buffer const & buffer,
-        bool output_active) const
+                       bool output_active, TocBackend & backend) const
 {
        if (table_.empty())
                return;
 
-       shared_ptr<Toc> change_list = buffer.tocBackend().toc("change");
+       shared_ptr<Toc> change_list = backend.toc("change");
        AuthorList const & author_list = buffer.params().authors();
        DocIterator dit = cdit;
 
-       ChangeTable::const_iterator it = table_.begin();
-       ChangeTable::const_iterator const itend = table_.end();
-       for (; it != itend; ++it) {
+       for (ChangeRange const & cr : table_) {
                docstring str;
-               switch (it->change.type) {
+               switch (cr.change.type) {
                case Change::UNCHANGED:
                        continue;
                case Change::DELETED:
@@ -519,48 +538,38 @@ void Changes::addToToc(DocIterator const & cdit, Buffer const & buffer,
                        str.push_back(0x270d);
                        break;
                }
-               dit.pos() = it->range.start;
+               dit.pos() = cr.range.start;
                Paragraph const & par = dit.paragraph();
-               str += " " + par.asString(it->range.start, min(par.size(), it->range.end));
-               if (it->range.end > par.size())
+               str += " " + par.asString(cr.range.start, min(par.size(), cr.range.end));
+               if (cr.range.end > par.size())
                        // ΒΆ U+00B6 PILCROW SIGN
                        str.push_back(0xb6);
-               docstring const & author = author_list.get(it->change.author).name();
+               docstring const & author = author_list.get(cr.change.author).name();
                Toc::iterator it = TocBackend::findItem(*change_list, 0, author);
                if (it == change_list->end()) {
                        change_list->push_back(TocItem(dit, 0, author, true));
-                       change_list->push_back(TocItem(dit, 1, str, output_active,
-                               support::wrapParas(str, 4)));
+                       change_list->push_back(TocItem(dit, 1, str, output_active));
                        continue;
                }
                for (++it; it != change_list->end(); ++it) {
                        if (it->depth() == 0 && it->str() != author)
                                break;
                }
-               change_list->insert(it, TocItem(dit, 1, str, output_active,
-                       support::wrapParas(str, 4)));
+               change_list->insert(it, TocItem(dit, 1, str, output_active));
        }
 }
 
 
-void Changes::updateBuffer(Buffer const & buf)
-{
-       is_update_required_ = false;
-       if (!buf.areChangesPresent() && isChanged())
-               buf.setChangesPresent(true);
-}
-
-
 void Change::paintCue(PainterInfo & pi, double const x1, double const y,
                       double const x2, FontInfo const & font) const
 {
-       if (!changed())
+       if (!changed() || (!lyxrc.ct_additions_underlined && inserted()))
                return;
        // Calculate 1/3 height of font
        FontMetrics const & fm = theFontMetrics(font);
-       int const y_bar = int(deleted() ? y - fm.maxAscent() / 3
-               : y + 2 * pi.base.solidLineOffset() + pi.base.solidLineThickness());
-       pi.pain.line(int(x1), y_bar, int(x2), y_bar, color(),
+       double const y_bar = deleted() ? y - fm.maxAscent() / 3
+               : y + 2 * pi.base.solidLineOffset() + pi.base.solidLineThickness();
+       pi.pain.line(int(x1), int(y_bar), int(x2), int(y_bar), color(),
                     Painter::line_solid, pi.base.solidLineThickness());
 }
 
@@ -577,20 +586,25 @@ void Change::paintCue(PainterInfo & pi, double const x1, double const y1,
         * y2 /_____
         *    x1  x2
         */
-       double y = 0;
        switch(type) {
        case UNCHANGED:
                return;
-       case INSERTED:
-               y = y2;
-               break;
+       case INSERTED: {
+               if (!lyxrc.ct_additions_underlined)
+                       return;
+               pi.pain.line(int(x1), int(y2) + 1, int(x2), int(y2) + 1,
+                            color(), Painter::line_solid,
+                            pi.base.solidLineThickness());
+               return;
+       }
        case DELETED:
-               y = y1;
-               break;
+               // FIXME: we cannot use antialias since we keep drawing on the same
+               // background with the current painting mechanism.
+               pi.pain.line(int(x1), int(y2), int(x2), int(y1),
+                            color(), Painter::line_solid_aliased,
+                            pi.base.solidLineThickness());
+               return;
        }
-       pi.pain.line(int(x1), int(y2), int(x2), int(y), 
-                    color(), Painter::line_solid,
-                    pi.base.solidLineThickness());
 }