#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 "texstream.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>
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
}
-ColorCode Change::color() const
+Color Change::color() const
{
- ColorCode color = Color_none;
+ Color color = Color_none;
switch (author % 5) {
case 0:
color = Color_changedtextauthor1;
color = Color_changedtextauthor5;
break;
}
+
+ if (deleted())
+ color.mergeColor = Color_deletedtextmodifier;
+
return color;
}
{
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 << ")");
}
{
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();
<< " 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
Change const & Changes::lookup(pos_type const pos) const
{
static Change const noChange = Change(Change::UNCHANGED);
+ for (ChangeRange const & cr : table_)
+ if (cr.range.contains(pos))
+ return cr.change;
+ return noChange;
+}
- 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;
- }
- return noChange;
+bool Changes::isDeleted(pos_type start, pos_type end) const
+{
+ for (ChangeRange const & cr : table_)
+ if (cr.range.contains(Range(start, end))) {
+ LYXERR(Debug::CHANGES, "range ("
+ << start << ", " << end << ") fully contains ("
+ << 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
+{
+ for (ChangeRange const & cr : table_)
+ if (cr.change.changed())
+ return true;
return false;
}
}
-int Changes::latexMarkChange(odocstream & os, BufferParams const & bparams,
- Change const & oldChange, Change const & change)
+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
+
+
+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;
+ bool const dvipost = LaTeXFeatures::isAvailable("dvipost") &&
+ (runparams.flavor == OutputParams::LATEX
+ || runparams.flavor == OutputParams::DVILUATEX);
+
if (oldChange.type != Change::UNCHANGED) {
- os << '}'; // close \lyxadded or \lyxdeleted
+ // close \lyxadded or \lyxdeleted
+ os << '}';
column++;
+ if (oldChange.type == Change::DELETED
+ && !runparams.wasDisplayMath && !dvipost)
+ --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{");
+ if (!runparams.inDisplayMath && !dvipost)
+ ++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);
+
+ // signature needed by \lyxsout to correctly strike out display math
+ if (change.type == Change::DELETED && runparams.inDisplayMath
+ && !dvipost) {
+ if (os.lastChar() == '\n')
+ str += from_ascii("\\\\\\noindent\n");
+ else
+ str += from_ascii("\\\\\\\\\n");
}
+ 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)
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;
- }
}
}
void Changes::checkAuthors(AuthorList const & authorList)
{
- 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) const
+void Changes::addToToc(DocIterator const & cdit, Buffer const & buffer,
+ bool output_active, TocBackend & backend) const
{
if (table_.empty())
return;
- 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:
- // 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;
+ dit.pos() = cr.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()
- 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));
+ 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(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));
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));
+ }
+}
+
+
+void Changes::updateBuffer(Buffer const & buf)
+{
+ bool const changed = isChanged();
+ buf.setChangesPresent(buf.areChangesPresent() || changed);
+ previously_changed_ = changed;
+}
+
+
+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);
+ 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());
+}
+
+
+void Change::paintCue(PainterInfo & pi, double const x1, double const y1,
+ double const x2, double const y2) const
+{
+ /*
+ * y1 /
+ * /
+ * /
+ * /
+ * /
+ * y2 /_____
+ * x1 x2
+ */
+ switch(type) {
+ case UNCHANGED:
+ return;
+ case INSERTED:
+ pi.pain.line(int(x1), int(y2) + 1, int(x2), int(y2) + 1,
+ color(), Painter::line_solid,
+ pi.base.solidLineThickness());
+ return;
+ case DELETED:
+ // 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;
}
}
+
} // namespace lyx
projects / lyx.git / blobdiff