]> git.lyx.org Git - lyx.git/blobdiff - src/Changes.cpp
Merge branch 'master' of git.lyx.org:lyx
[lyx.git] / src / Changes.cpp
index 685e69b0ee9007f52bc57253dedb08319e256a6a..97596b4b9268a90501b6617e22522dd3fdc6b4b1 100644 (file)
 #include "Author.h"
 #include "Buffer.h"
 #include "BufferParams.h"
+#include "Encoding.h"
 #include "LaTeXFeatures.h"
+#include "MetricsInfo.h"
+#include "OutputParams.h"
 #include "Paragraph.h"
 #include "TocBackend.h"
 
 #include "support/debug.h"
 #include "support/gettext.h"
 #include "support/lassert.h"
+#include "support/lstrings.h"
+#include "support/mutex.h"
+
+#include "frontends/alert.h"
+#include "frontends/FontMetrics.h"
+#include "frontends/Painter.h"
 
 #include <ostream>
 
@@ -31,6 +40,9 @@ using namespace std;
 
 namespace lyx {
 
+using frontend::Painter;
+using frontend::FontMetrics;
+
 /*
  * 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
@@ -54,9 +66,9 @@ bool Change::isSimilarTo(Change const & change) const
 }
 
 
-ColorCode Change::color() const
+Color Change::color() const
 {
-       ColorCode color = Color_none;
+       Color color = Color_none;
        switch (author % 5) {
                case 0:
                        color = Color_changedtextauthor1;
@@ -74,6 +86,10 @@ ColorCode Change::color() const
                        color = Color_changedtextauthor5;
                        break;
        }
+
+       if (deleted())
+               color.mergeColor = Color_deletedtextmodifier;
+
        return color;
 }
 
@@ -128,6 +144,8 @@ void Changes::set(Change const & change, pos_type const start, pos_type const en
                        << ", author: " << change.author 
                        << ", time: " << long(change.changetime)
                        << ") in range (" << start << ", " << end << ")");
+               if (!isChanged())
+                       is_update_required_ = true;
        }
 
        Range const newRange(start, end);
@@ -252,6 +270,24 @@ Change const & Changes::lookup(pos_type const pos) const
 }
 
 
+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))) {
+                       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;
+               }
+       }
+       return false;
+}
+
+
 bool Changes::isChanged(pos_type const start, pos_type const end) const
 {
        ChangeTable::const_iterator it = table_.begin();
@@ -270,8 +306,21 @@ bool Changes::isChanged(pos_type const start, pos_type const end) const
 }
 
 
+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())
+                       return true;
+       }
+       return false;
+}
+
+
 void Changes::merge()
 {
+       bool merged = false;
        ChangeTable::iterator it = table_.begin();
 
        while (it != table_.end()) {
@@ -284,6 +333,7 @@ void Changes::merge()
                                << it->range.start);
 
                        table_.erase(it);
+                       merged = true;
                        // start again
                        it = table_.begin();
                        continue;
@@ -302,6 +352,7 @@ 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;
@@ -309,45 +360,102 @@ void Changes::merge()
 
                ++it;
        }
+       if (merged && !isChanged())
+               is_update_required_ = true;
+}
+
+
+namespace {
+
+docstring getLaTeXMarkup(docstring const & macro, docstring const & author,
+                        docstring const & chgTime,
+                        OutputParams const & runparams)
+{
+       if (macro.empty())
+               return docstring();
+
+       docstring uncodable_author;
+       odocstringstream ods;
+
+       ods << macro;
+       // convert utf8 author name to something representable
+       // in the current encoding
+       pair<docstring, docstring> author_latexed =
+               runparams.encoding->latexString(author, runparams.dryrun);
+       if (!author_latexed.second.empty()) {
+               LYXERR0("Omitting uncodable characters '"
+                       << author_latexed.second
+                       << "' in change author name!");
+               uncodable_author = author;
+       }
+       ods << author_latexed.first << "}{" << chgTime << "}{";
+
+       // warn user (once) if we found uncodable glyphs.
+       if (!uncodable_author.empty()) {
+               static std::set<docstring> warned_authors;
+               static Mutex warned_mutex;
+               Mutex::Locker locker(&warned_mutex);
+               if (warned_authors.find(uncodable_author) == warned_authors.end()) {
+                       frontend::Alert::warning(_("Uncodable character in author name"),
+                               support::bformat(_("The author name '%1$s',\n"
+                                 "used for change tracking, contains 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 spelling of the author name."),
+                               uncodable_author, author_latexed.second));
+                       warned_authors.insert(uncodable_author);
+               }
+       }
+
+       return ods.str();
 }
 
+} //namespace anon
+
 
-int Changes::latexMarkChange(odocstream & os, BufferParams const & bparams,
-                            Change const & oldChange, Change const & change)
+int Changes::latexMarkChange(otexstream & os, BufferParams const & bparams,
+                            Change const & oldChange, Change const & change,
+                            OutputParams const & runparams)
 {
-       if (!bparams.outputChanges || oldChange == change)
+       if (!bparams.output_changes || oldChange == change)
                return 0;
 
        int column = 0;
 
        if (oldChange.type != Change::UNCHANGED) {
-               os << '}'; // close \lyxadded or \lyxdeleted
+               // close \lyxadded or \lyxdeleted
+               os << '}';
                column++;
+               if (oldChange.type == Change::DELETED)
+                       --runparams.inulemcmd;
        }
 
        docstring chgTime;
-       chgTime += ctime(&change.changetime);
-       chgTime.erase(chgTime.end() - 1); // remove trailing '\n'
+       chgTime += asctime(gmtime(&change.changetime));
+       // remove trailing '\n'
+       chgTime.erase(chgTime.end() - 1);
 
+       docstring macro_beg;
        if (change.type == Change::DELETED) {
-               docstring str = "\\lyxdeleted{" +
-                       bparams.authors().get(change.author).name() + "}{" +
-                       chgTime + "}{";
-               os << str;
-               column += str.size();
-       } else if (change.type == Change::INSERTED) {
-               docstring str = "\\lyxadded{" +
-                       bparams.authors().get(change.author).name() + "}{" +
-                       chgTime + "}{";
-               os << str;
-               column += str.size();
+               macro_beg = from_ascii("\\lyxdeleted{");
+               ++runparams.inulemcmd;
        }
+       else if (change.type == Change::INSERTED)
+               macro_beg = from_ascii("\\lyxadded{");
+       
+       docstring str = getLaTeXMarkup(macro_beg,
+                                      bparams.authors().get(change.author).name(),
+                                      chgTime, runparams);
+       
+       os << str;
+       column += str.size();
 
        return column;
 }
 
 
-void Changes::lyxMarkChange(ostream & os, int & column,
+void Changes::lyxMarkChange(ostream & os, BufferParams const & bparams, int & column,
                            Change const & old, Change const & change)
 {
        if (old == change)
@@ -355,22 +463,22 @@ void Changes::lyxMarkChange(ostream & os, int & column,
 
        column = 0;
 
+       int const buffer_id = bparams.authors().get(change.author).bufferId();
+
        switch (change.type) {
                case Change::UNCHANGED:
                        os << "\n\\change_unchanged\n";
                        break;
 
-               case Change::DELETED: {
-                       os << "\n\\change_deleted " << change.author
+               case Change::DELETED:
+                       os << "\n\\change_deleted " << buffer_id
                                << " " << change.changetime << "\n";
                        break;
-               }
 
-               case Change::INSERTED: {
-                       os << "\n\\change_inserted " << change.author
+               case Change::INSERTED:
+                       os << "\n\\change_inserted " << buffer_id
                                << " " << change.changetime << "\n";
                        break;
-               }
        }
 }
 
@@ -385,12 +493,13 @@ void Changes::checkAuthors(AuthorList const & authorList)
 }
 
 
-void Changes::addToToc(DocIterator const & cdit, Buffer const & buffer) const
+void Changes::addToToc(DocIterator const & cdit, Buffer const & buffer,
+        bool output_active) const
 {
        if (table_.empty())
                return;
 
-       Toc & change_list = buffer.tocBackend().toc("change");
+       shared_ptr<Toc> change_list = buffer.tocBackend().toc("change");
        AuthorList const & author_list = buffer.params().authors();
        DocIterator dit = cdit;
 
@@ -402,32 +511,86 @@ void Changes::addToToc(DocIterator const & cdit, Buffer const & buffer) const
                case Change::UNCHANGED:
                        continue;
                case Change::DELETED:
-                       // 0x2702 is a scissors symbol in the Dingbats unicode group.
+                       // ✂ U+2702 BLACK SCISSORS
                        str.push_back(0x2702);
                        break;
                case Change::INSERTED:
-                       // 0x2702 is the hand writting symbol in the Dingbats unicode group.
+                       // ✍ U+270D WRITING HAND
                        str.push_back(0x270d);
                        break;
                }
                dit.pos() = it->range.start;
                Paragraph const & par = dit.paragraph();
-               str += " " + par.asString(it->range.start, max(par.size(), it->range.end));
-               // FIXME: find an unicode character for carriage return presentation if
-               // present; i.e. when it->range.end > par.size()
+               str += " " + par.asString(it->range.start, min(par.size(), it->range.end));
+               if (it->range.end > par.size())
+                       // ¶ U+00B6 PILCROW SIGN
+                       str.push_back(0xb6);
                docstring const & author = author_list.get(it->change.author).name();
-               Toc::iterator it = change_list.item(0, author);
-               if (it == change_list.end()) {
-                       change_list.push_back(TocItem(dit, 0, author));
-                       change_list.push_back(TocItem(dit, 1, str));
+               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)));
                        continue;
                }
-               for (++it; it != change_list.end(); ++it) {
+               for (++it; it != change_list->end(); ++it) {
                        if (it->depth() == 0 && it->str() != author)
                                break;
                }
-               change_list.insert(it, TocItem(dit, 1, str));
+               change_list->insert(it, TocItem(dit, 1, str, output_active,
+                       support::wrapParas(str, 4)));
        }
 }
 
+
+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())
+               return;
+       // Calculate 1/3 height of font
+       FontMetrics const & fm = theFontMetrics(font);
+       int const y_bar = 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(),
+                    Painter::line_solid, pi.base.solidLineThickness());
+}
+
+
+void Change::paintCue(PainterInfo & pi, double const x1, double const y1,
+                      double const x2, double const y2) const
+{
+       /*
+        * y1      /
+        *        /
+        *       /
+        *      /
+        *     /
+        * y2 /_____
+        *    x1  x2
+        */
+       double y = 0;
+       switch(type) {
+       case UNCHANGED:
+               return;
+       case INSERTED:
+               y = y2;
+               break;
+       case DELETED:
+               y = y1;
+               break;
+       }
+       pi.pain.line(x1, y2, x2, y, color(), Painter::line_solid,
+                    pi.base.solidLineThickness());
+}
+
+
 } // namespace lyx