X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FChanges.cpp;h=5db28010fa1755deae327cafda4ef0a8e9a5e5cc;hb=28be7d552f62cc02fa86d7f79201d089bfb2d7b5;hp=a7cd525dde3bf608f31b1d82861415aac26faae1;hpb=f630be890494c849981e4fb52ea4740506e92bed;p=lyx.git

diff --git a/src/Changes.cpp b/src/Changes.cpp
index a7cd525dde..5db28010fa 100644
--- a/src/Changes.cpp
+++ b/src/Changes.cpp
@@ -14,17 +14,35 @@
 #include <config.h>
 
 #include "Changes.h"
-#include "debug.h"
-
-#include <boost/assert.hpp>
-
+#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>
+
+using namespace std;
 
 namespace lyx {
 
-using std::abs;
-using std::endl;
-using std::string;
-using std::max;
+using frontend::Painter;
+using frontend::FontMetrics;
 
 /*
  * Class Change has a changetime field that specifies the exact time at which
@@ -34,36 +52,59 @@ using std::max;
  * When merging two adjacent changes, the changetime is not considered,
  * only the equality of the change type and author is checked (in method
  * isSimilarTo(...)). If two changes are in fact merged (in method merge()),
- * the later change time is preserved. 
+ * the later change time is preserved.
  */
 
-bool Change::isSimilarTo(Change const & change)
+bool Change::isSimilarTo(Change const & change) const
 {
-	if (type != change.type) {
+	if (type != change.type)
 		return false;
-	}
 
-	if (type == Change::UNCHANGED) {
+	if (type == Change::UNCHANGED)
 		return true;
-	}
 
 	return author == change.author;
 }
 
 
+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 (deleted())
+		color.mergeColor = Color_deletedtextmodifier;
+
+	return color;
+}
+
+
 bool operator==(Change const & l, Change const & r)
 {
-	if (l.type != r.type) {
+	if (l.type != r.type)
 		return false;
-	}
 
 	// two changes of type UNCHANGED are always equal
-	if (l.type == Change::UNCHANGED) {
+	if (l.type == Change::UNCHANGED)
 		return true;
-	}
-	
-	return l.author == r.author &&
-	       l.changetime == r.changetime;
+
+	return l.author == r.author && l.changetime == r.changetime;
 }
 
 
@@ -100,9 +141,10 @@ void Changes::set(Change const & change, pos_type const pos)
 void Changes::set(Change const & change, pos_type const start, pos_type const end)
 {
 	if (change.type != Change::UNCHANGED) {
-		LYXERR(Debug::CHANGES) << "setting change (type: " << change.type
-			<< ", author: " << change.author << ", time: " << change.changetime
-			<< ") in range (" << start << ", " << end << ")" << endl;
+		LYXERR(Debug::CHANGES, "setting change (type: " << change.type
+			<< ", author: " << change.author 
+			<< ", time: " << long(change.changetime)
+			<< ") in range (" << start << ", " << end << ")");
 	}
 
 	Range const newRange(start, end);
@@ -120,14 +162,14 @@ void Changes::set(Change const & change, pos_type const start, pos_type const en
 			pos_type oldEnd = it->range.end;
 			it->range.end = start;
 
-			LYXERR(Debug::CHANGES) << "  cutting tail of type " << it->change.type
+			LYXERR(Debug::CHANGES, "  cutting tail of type " << it->change.type
 				<< " resulting in range (" << it->range.start << ", "
-				<< it->range.end << ")" << endl;
+				<< it->range.end << ")");
 
 			++it;
 			if (oldEnd >= end) {
-				LYXERR(Debug::CHANGES) << "  inserting tail in range ("
-					<< end << ", " << oldEnd << ")" << endl;
+				LYXERR(Debug::CHANGES, "  inserting tail in range ("
+					<< end << ", " << oldEnd << ")");
 				it = table_.insert(it, ChangeRange((it-1)->change, Range(end, oldEnd)));
 			}
 			continue;
@@ -137,7 +179,7 @@ void Changes::set(Change const & change, pos_type const start, pos_type const en
 	}
 
 	if (change.type != Change::UNCHANGED) {
-		LYXERR(Debug::CHANGES) << "  inserting change" << endl;
+		LYXERR(Debug::CHANGES, "  inserting change");
 		it = table_.insert(it, ChangeRange(change, Range(start, end)));
 		++it;
 	}
@@ -145,22 +187,21 @@ void Changes::set(Change const & change, pos_type const start, pos_type const en
 	for (; it != table_.end(); ) {
 		// new change 'contains' existing change
 		if (newRange.contains(it->range)) {
-			LYXERR(Debug::CHANGES) << "  removing subrange ("
-				<< it->range.start << ", " << it->range.end << ")" << endl;
+			LYXERR(Debug::CHANGES, "  removing subrange ("
+				<< it->range.start << ", " << it->range.end << ")");
 			it = table_.erase(it);
 			continue;
 		}
 
 		// new change precedes existing change
-		if (it->range.start >= end) {
+		if (it->range.start >= end)
 			break;
-		}
 
 		// new change intersects with existing change
 		it->range.start = end;
-		LYXERR(Debug::CHANGES) << "  cutting head of type "
+		LYXERR(Debug::CHANGES, "  cutting head of type "
 			<< it->change.type << " resulting in range ("
-			<< end << ", " << it->range.end << ")" << endl;
+			<< end << ", " << it->range.end << ")");
 		break; // no need for another iteration
 	}
 
@@ -170,20 +211,15 @@ void Changes::set(Change const & change, pos_type const start, pos_type const en
 
 void Changes::erase(pos_type const pos)
 {
-	LYXERR(Debug::CHANGES) << "Erasing change at position " << pos << endl;
+	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();
@@ -193,23 +229,18 @@ void Changes::erase(pos_type const pos)
 void Changes::insert(Change const & change, lyx::pos_type pos)
 {
 	if (change.type != Change::UNCHANGED) {
-		LYXERR(Debug::CHANGES) << "Inserting change of type " << change.type
-			<< " at position " << pos << endl;
+		LYXERR(Debug::CHANGES, "Inserting change of type " << change.type
+			<< " 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
@@ -219,33 +250,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 (ChangeRange const & cr : table_)
+		if (cr.range.contains(pos))
+			return cr.change;
+	return noChange;
+}
 
-	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))) {
-			LYXERR(Debug::CHANGES) << "found intersection of range ("
+	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 << endl;
+				<< 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;
 }
 
@@ -255,13 +299,13 @@ void Changes::merge()
 	ChangeTable::iterator it = table_.begin();
 
 	while (it != table_.end()) {
-		LYXERR(Debug::CHANGES) << "found change of type " << it->change.type
+		LYXERR(Debug::CHANGES, "found change of type " << it->change.type
 			<< " and range (" << it->range.start << ", " << it->range.end
-			<< ")" << endl;
+			<< ")");
 
 		if (it->range.start == it->range.end) {
-			LYXERR(Debug::CHANGES) << "removing empty range for pos "
-				<< it->range.start << endl;
+			LYXERR(Debug::CHANGES, "removing empty range for pos "
+				<< it->range.start);
 
 			table_.erase(it);
 			// start again
@@ -272,14 +316,15 @@ void Changes::merge()
 		if (it + 1 == table_.end())
 			break;
 
-		if (it->change.isSimilarTo((it + 1)->change) && it->range.end == (it + 1)->range.start) {
-			LYXERR(Debug::CHANGES) << "merging ranges (" << it->range.start << ", "
+		if (it->change.isSimilarTo((it + 1)->change)
+		    && it->range.end == (it + 1)->range.start) {
+			LYXERR(Debug::CHANGES, "merging ranges (" << it->range.start << ", "
 				<< it->range.end << ") and (" << (it + 1)->range.start << ", "
-				<< (it + 1)->range.end << ")" << endl;
+				<< (it + 1)->range.end << ")");
 
 			(it + 1)->range.start = it->range.start;
 			(it + 1)->change.changetime = max(it->change.changetime,
-			                                  (it + 1)->change.changetime);
+							  (it + 1)->change.changetime);
 			table_.erase(it);
 			// start again
 			it = table_.begin();
@@ -291,53 +336,109 @@ void Changes::merge()
 }
 
 
-int Changes::latexMarkChange(odocstream & os,
-			     Change::Type const oldChangeType, Change::Type const changeType,
-			     bool const & output)
+namespace {
+
+docstring getLaTeXMarkup(docstring const & macro, docstring const & author,
+			 docstring const & chgTime,
+			 OutputParams const & runparams)
 {
-	if (!output || oldChangeType == changeType)
-		return 0;
+	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);
+		}
+	}
 
-	static docstring const start(from_ascii("\\changestart{}"));
-	static docstring const end(from_ascii("\\changeend{}"));
-	static docstring const son(from_ascii("\\overstrikeon{}"));
-	static docstring const soff(from_ascii("\\overstrikeoff{}"));
+	return ods.str();
+}
+
+} //namespace anon
+
+
+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 (oldChangeType == Change::DELETED) {
-		os << soff;
-		column += soff.length();
+	if (oldChange.type != Change::UNCHANGED) {
+		// close \lyxadded or \lyxdeleted
+		os << '}';
+		column++;
+		if (oldChange.type == Change::DELETED && !runparams.wasDisplayMath)
+			--runparams.inulemcmd;
 	}
 
-	switch (changeType) {
-		case Change::UNCHANGED:
-			os << end;
-			column += end.length();
-			break;
+	docstring chgTime;
+	chgTime += asctime(gmtime(&change.changetime));
+	// remove trailing '\n'
+	chgTime.erase(chgTime.end() - 1);
 
-		case Change::DELETED:
-			if (oldChangeType == Change::UNCHANGED) {
-				os << start;
-				column += start.length();
-			}
-			os << son;
-			column += son.length();
-			break;
-
-		case Change::INSERTED:
-			if (oldChangeType == Change::UNCHANGED) {
-				os << start;
-				column += start.length();
-			}
-			break;
+	docstring macro_beg;
+	if (change.type == Change::DELETED) {
+		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).name(),
+				       chgTime, runparams);
+	
+	// signature needed by \lyxsout to correctly strike out display math
+	if (change.type == Change::DELETED && runparams.inDisplayMath
+	    && (!LaTeXFeatures::isAvailable("dvipost")
+		|| (runparams.flavor != OutputParams::LATEX
+		    && runparams.flavor != OutputParams::DVILUATEX))) {
+		if (os.afterParbreak())
+			str += from_ascii("\\\\\\noindent\n");
+		else
+			str += from_ascii("\\\\\\\\\n");
+	}
+
+	os << str;
+	column += str.size();
 
 	return column;
 }
 
 
-void Changes::lyxMarkChange(std::ostream & os, int & column,
+void Changes::lyxMarkChange(ostream & os, BufferParams const & bparams, int & column,
 			    Change const & old, Change const & change)
 {
 	if (old == change)
@@ -345,22 +446,129 @@ void Changes::lyxMarkChange(std::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;
+	}
+}
+
+
+void Changes::checkAuthors(AuthorList const & authorList)
+{
+	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, TocBackend & backend) const
+{
+	if (table_.empty())
+		return;
+
+	shared_ptr<Toc> change_list = backend.toc("change");
+	AuthorList const & author_list = buffer.params().authors();
+	DocIterator dit = cdit;
+
+	for (ChangeRange const & cr : table_) {
+		docstring str;
+		switch (cr.change.type) {
+		case Change::UNCHANGED:
+			continue;
+		case Change::DELETED:
+			// ✂ U+2702 BLACK SCISSORS
+			str.push_back(0x2702);
+			break;
+		case Change::INSERTED:
+			// ✍ U+270D WRITING HAND
+			str.push_back(0x270d);
+			break;
 		}
+		dit.pos() = cr.range.start;
+		Paragraph const & par = dit.paragraph();
+		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) {
+			if (it->depth() == 0 && it->str() != author)
+				break;
+		}
+		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;
 	}
 }