X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FChanges.cpp;h=33209afbbb58b22c4e13d3fdd30c9d9eff9c4475;hb=c9146e5be087638d0dc115e862fd685c74e257e4;hp=2f7feb1256243571d9f253f6201365a95e7f8494;hpb=b86942b4f466d2ebc8d7b1285df816bc91527057;p=lyx.git

diff --git a/src/Changes.cpp b/src/Changes.cpp
index 2f7feb1256..33209afbbb 100644
--- a/src/Changes.cpp
+++ b/src/Changes.cpp
@@ -17,13 +17,24 @@
 #include "Author.h"
 #include "Buffer.h"
 #include "BufferParams.h"
-#include "LaTeXFeatures.h"
+#include "Color.h"
+#include "Encoding.h"
+#include "LyXRC.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>
 
@@ -31,6 +42,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
@@ -59,19 +73,19 @@ Color Change::color() const
 	Color color = Color_none;
 	switch (author % 5) {
 		case 0:
-			color = Color_changedtextauthor1;
+			color = Color_addedtextauthor1;
 			break;
 		case 1:
-			color = Color_changedtextauthor2;
+			color = Color_addedtextauthor2;
 			break;
 		case 2:
-			color = Color_changedtextauthor3;
+			color = Color_addedtextauthor3;
 			break;
 		case 3:
-			color = Color_changedtextauthor4;
+			color = Color_addedtextauthor4;
 			break;
 		case 4:
-			color = Color_changedtextauthor5;
+			color = Color_addedtextauthor5;
 			break;
 	}
 
@@ -129,7 +143,7 @@ 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 << ")");
 	}
@@ -200,16 +214,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();
@@ -223,17 +234,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
@@ -243,51 +251,46 @@ 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
+{
+	for (ChangeRange const & cr : table_)
+		if (cr.change.changed())
+			return true;
 	return false;
 }
 
@@ -334,36 +337,139 @@ void Changes::merge()
 }
 
 
-int Changes::latexMarkChange(odocstream & os, BufferParams const & bparams,
-			     Change const & oldChange, Change const & change)
+namespace {
+
+docstring getLaTeXMarkup(docstring const & macro, Author const & author,
+			 docstring const & chgTime,
+			 OutputParams const & runparams)
 {
-	if (!bparams.outputChanges || oldChange == change)
+	if (macro.empty())
+		return docstring();
+
+	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_name, runparams.dryrun);
+	if (!author_latexed.second.empty()) {
+		LYXERR0("Omitting uncodable characters '"
+			<< author_latexed.second
+			<< "' in change author name!");
+		uncodable_author = author_name;
+	}
+	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.output_changes || oldChange == change)
 		return 0;
 
 	int column = 0;
 
 	if (oldChange.type != Change::UNCHANGED) {
-		os << '}'; // close \lyxadded or \lyxdeleted
-		column++;
+		if (oldChange.type != Change::DELETED || runparams.ctObject != CtObject::OmitObject) {
+			// close \lyxadded or \lyxdeleted
+			os << '}';
+			column++;
+		}
+		if (oldChange.type == Change::DELETED
+		    && !runparams.wasDisplayMath)
+			--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();
+		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");
+
+	docstring str = getLaTeXMarkup(macro_beg,
+				       bparams.authors().get(change.author),
+				       chgTime, runparams);
+
+	os << str;
+	column += str.size();
 
 	return column;
 }
@@ -377,82 +483,126 @@ void Changes::lyxMarkChange(ostream & os, BufferParams const & bparams, int & co
 
 	column = 0;
 
-	int const buffer_id = bparams.authors().get(change.author).buffer_id();
+	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: {
+		case Change::DELETED:
 			os << "\n\\change_deleted " << buffer_id
 				<< " " << change.changetime << "\n";
 			break;
-		}
 
-		case Change::INSERTED: {
+		case Change::INSERTED:
 			os << "\n\\change_inserted " << buffer_id
 				<< " " << change.changetime << "\n";
 			break;
-		}
 	}
 }
 
 
-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) 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:
-			// 0x270d 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, min(par.size(), it->range.end));
-		if (it->range.end > par.size())
-			// the end of paragraph symbol from the Punctuation group
-			str.push_back(0x204B);
-		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 Change::paintCue(PainterInfo & pi, double const x1, double const y,
+                      double const x2, FontInfo const & font) const
+{
+	if (!changed() || (!lyxrc.ct_additions_underlined && inserted()))
+		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: {
+		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:
+		// 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