X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetSpecialChar.cpp;h=1267a75b376c499dfb5c80bc50c9e084011e578b;hb=4cfa5a9d2a9dd340c0b0228eba4b877ff905d458;hp=1294d1791efa92899534776e0bb053bc1266cc5e;hpb=1f36fa6d567834bd67e5612b6c67f81d10c11ef1;p=lyx.git

diff --git a/src/insets/InsetSpecialChar.cpp b/src/insets/InsetSpecialChar.cpp
index 1294d1791e..1267a75b37 100644
--- a/src/insets/InsetSpecialChar.cpp
+++ b/src/insets/InsetSpecialChar.cpp
@@ -20,6 +20,7 @@
 #include "Lexer.h"
 #include "MetricsInfo.h"
 #include "output_xhtml.h"
+#include "texstream.h"
 
 #include "frontends/FontMetrics.h"
 #include "frontends/Painter.h"
@@ -47,32 +48,32 @@ namespace {
 
 int logoWidth(FontInfo const & font, InsetSpecialChar::Kind kind) {
 	frontend::FontMetrics const & fm = theFontMetrics(font);
-	double const em = fm.width('M');
+	int const em = fm.em();
 	int width = 0;
 	// See drawlogo() below to understand what this does.
 	switch (kind) {
 	case InsetSpecialChar::PHRASE_LYX:
-		width = fm.width(from_ascii("L")) - 0.16667 * em
-			+ fm.width(from_ascii("Y")) - 0.125 * em
+		width = fm.width(from_ascii("L")) - em / 6
+			+ fm.width(from_ascii("Y")) - em / 8
 			+ fm.width(from_ascii("X"));
 		break;
 
 	case InsetSpecialChar::PHRASE_TEX:
-		width = fm.width(from_ascii("T")) - 0.16667 * em
-			+ fm.width(from_ascii("E")) - 0.125 * em
+		width = fm.width(from_ascii("T")) - em / 6
+			+ fm.width(from_ascii("E")) - em / 8
 			+ fm.width(from_ascii("X"));
 		break;
 
 	case InsetSpecialChar::PHRASE_LATEX2E:
 		width = logoWidth(font, InsetSpecialChar::PHRASE_LATEX)
-			+ 0.15 * em
+			+ 3 * em / 20
 			+ fm.width(from_ascii("2") + char_type(0x03b5));
 		break;
 	case InsetSpecialChar::PHRASE_LATEX: {
 		FontInfo smaller = font;
 		smaller.decSize().decSize();
-		width = fm.width(from_ascii("L")) - 0.36 * em
-			+ theFontMetrics(smaller).width(from_ascii("A")) - 0.15 * em
+		width = fm.width(from_ascii("L")) - 9 * em / 25
+			+ theFontMetrics(smaller).width(from_ascii("A")) - 3 * em / 20
 			+ logoWidth(font, InsetSpecialChar::PHRASE_TEX);
 		break;
 	}
@@ -83,6 +84,40 @@ int logoWidth(FontInfo const & font, InsetSpecialChar::Kind kind) {
 	return width;
 }
 
+} // namespace
+
+docstring InsetSpecialChar::toolTip(BufferView const &, int, int) const
+{
+	docstring message;
+	switch (kind_) {
+		case ALLOWBREAK:
+			message = from_ascii("Optional Line Break (ZWSP)");
+			break;
+		case LIGATURE_BREAK:
+			message = from_ascii("Ligature Break (ZWNJ)");
+			break;
+		case END_OF_SENTENCE:
+			message = from_ascii("End of Sentence");
+			break;
+		case HYPHENATION:
+			message = from_ascii("Hyphenation Point");
+			break;
+		case SLASH:
+			message = from_ascii("Breakable Slash");
+			break;
+		case NOBREAKDASH:
+			message = from_ascii("Protected Hyphen (SHY)");
+			break;
+		case LDOTS:
+		case MENU_SEPARATOR:
+		case PHRASE_LYX:
+		case PHRASE_TEX:
+		case PHRASE_LATEX2E:
+		case PHRASE_LATEX:
+			// no tooltip for these ones.
+			break;
+	}
+	return message;
 }
 
 
@@ -96,6 +131,9 @@ void InsetSpecialChar::metrics(MetricsInfo & mi, Dimension & dim) const
 
 	docstring s;
 	switch (kind_) {
+		case ALLOWBREAK:
+			dim.wid = fm.em() / 8;
+			break;
 		case LIGATURE_BREAK:
 			s = from_ascii("|");
 			break;
@@ -128,40 +166,47 @@ void InsetSpecialChar::metrics(MetricsInfo & mi, Dimension & dim) const
 	}
 	if (dim.wid == 0)
 		dim.wid = fm.width(s);
-
-	setDimCache(mi, dim);
 }
 
 
 namespace {
 
-void drawLogo(PainterInfo & pi, InsetSpecialChar::Kind kind, int & x, int & y) {
+// helper function: draw text and update x.
+void drawChar(PainterInfo & pi, int & x, int const y, char_type ch)
+{
+	FontInfo font = pi.base.font;
+	font.setPaintColor(pi.textColor(font.realColor()));
+	pi.pain.text(x, y, ch, font);
+	x += theFontMetrics(font).width(ch);
+}
+
+
+void drawLogo(PainterInfo & pi, int & x, int const y, InsetSpecialChar::Kind kind)
+{
 	FontInfo const & font = pi.base.font;
-	// FIXME: this definition of em is bogus, but there is a need
-	// for a big refactoring of the code around this issue anyway.
-	double const em = theFontMetrics(font).width('M');
+	int const em = theFontMetrics(font).em();
 	switch (kind) {
 	case InsetSpecialChar::PHRASE_LYX:
 		/** Reference macro:
 		 *  \providecommand{\LyX}{L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\\@};
 		 */
-		x += pi.pain.text(x, y, from_ascii("L"), font);
-		x -= 0.16667 * em;
-		x += pi.pain.text(x, y + 0.25 * em, from_ascii("Y"), font);
-		x -= 0.125 * em;
-		x += pi.pain.text(x, y, from_ascii("X"), font);
+		drawChar(pi, x, y, 'L');
+		x -= em / 6;
+		drawChar(pi, x, y + em / 4, 'Y');
+		x -= em / 8;
+		drawChar(pi, x, y, 'X');
 		break;
 
 	case InsetSpecialChar::PHRASE_TEX: {
 		/** Reference macro:
 		 *  \def\TeX{T\kern-.1667em\lower.5ex\hbox{E}\kern-.125emX\@}
 		 */
-		double const ex = theFontMetrics(font).ascent('x');
-		x += pi.pain.text(x, y, from_ascii("T"), font);
-		x -= 0.16667 * em;
-		x += pi.pain.text(x, y + 0.5 * ex, from_ascii("E"), font);
-		x -= 0.125 * em;
-		x += pi.pain.text(x, y, from_ascii("X"), font);
+		int const ex = theFontMetrics(font).ascent('x');
+		drawChar(pi, x, y, 'T');
+		x -= em / 6;
+		drawChar(pi, x, y + ex / 2, 'E');
+		x -= em / 8;
+		drawChar(pi, x, y, 'X');
 		break;
 	}
 	case InsetSpecialChar::PHRASE_LATEX2E:
@@ -170,10 +215,10 @@ void drawLogo(PainterInfo & pi, InsetSpecialChar::Kind kind, int & x, int & y) {
 		 *    \if b\expandafter\@car\f@series\@nil\boldmath\fi
 		 *    \LaTeX\kern.15em2$_{\textstyle\varepsilon}$}}
 		 */
-		drawLogo(pi, InsetSpecialChar::PHRASE_LATEX, x, y);
-		x += 0.15 * em;
-		x += pi.pain.text(x, y, from_ascii("2"), font);
-		x += pi.pain.text(x, y + 0.25 * em, char_type(0x03b5), font);
+		drawLogo(pi, x, y, InsetSpecialChar::PHRASE_LATEX);
+		x += 3 * em / 20;
+		drawChar(pi, x, y, '2');
+		drawChar(pi, x, y + em / 4, char_type(0x03b5));
 		break;
 
 	case InsetSpecialChar::PHRASE_LATEX: {
@@ -189,13 +234,13 @@ void drawLogo(PainterInfo & pi, InsetSpecialChar::Kind kind, int & x, int & y) {
 		 *        \kern-.15em%
 		 *        \TeX}
 		 */
-		x += pi.pain.text(x, y, from_ascii("L"), font);
-		x -= 0.36 * em;
-		FontInfo smaller = font;
-		smaller.decSize().decSize();
-		x += pi.pain.text(x, y - 0.2 * em, from_ascii("A"), smaller);
-		x -= 0.15 * em;
-		drawLogo(pi, InsetSpecialChar::PHRASE_TEX, x, y);
+		drawChar(pi, x, y, 'L');
+		x -= 9 * em / 25;
+		PainterInfo pi2 = pi;
+		pi2.base.font.decSize().decSize();
+		drawChar(pi2, x, y - em / 5, 'A');
+		x -= 3 * em / 20;
+		drawLogo(pi, x, y, InsetSpecialChar::PHRASE_TEX);
 		break;
 	}
 	default:
@@ -203,7 +248,7 @@ void drawLogo(PainterInfo & pi, InsetSpecialChar::Kind kind, int & x, int & y) {
 	}
 }
 
-}
+} // namespace
 
 void InsetSpecialChar::draw(PainterInfo & pi, int x, int y) const
 {
@@ -216,6 +261,18 @@ void InsetSpecialChar::draw(PainterInfo & pi, int x, int y) const
 		pi.pain.text(x, y, char_type('-'), font);
 		break;
 	}
+	case ALLOWBREAK:
+	{
+		// A small vertical line
+		int const asc = theFontMetrics(pi.base.font).ascent('x');
+		int const desc = theFontMetrics(pi.base.font).descent('g');
+		int const x0 = x; // x + 1; // FIXME: incline,
+		int const x1 = x; // x - 1; // similar to LibreOffice?
+		int const y0 = y + desc;
+		int const y1 = y - asc / 3;
+		pi.pain.line(x0, y1, x1, y0, Color_special);
+		break;
+	}
 	case LIGATURE_BREAK:
 	{
 		font.setColor(Color_special);
@@ -271,82 +328,85 @@ void InsetSpecialChar::draw(PainterInfo & pi, int x, int y) const
 	case PHRASE_TEX:
 	case PHRASE_LATEX2E:
 	case PHRASE_LATEX:
-		drawLogo(pi, kind_, x, y);
+		drawLogo(pi, x, y, kind_);
 		break;
 	}
 }
 
 
-// In lyxf3 this will be just LaTeX
 void InsetSpecialChar::write(ostream & os) const
 {
 	string command;
 	switch (kind_) {
 	case HYPHENATION:
-		command = "\\-";
+		command = "softhyphen";
+		break;
+	case ALLOWBREAK:
+		command = "allowbreak";
 		break;
 	case LIGATURE_BREAK:
-		command = "\\textcompwordmark{}";
+		command = "ligaturebreak";
 		break;
 	case END_OF_SENTENCE:
-		command = "\\@.";
+		command = "endofsentence";
 		break;
 	case LDOTS:
-		command = "\\ldots{}";
+		command = "ldots";
 		break;
 	case MENU_SEPARATOR:
-		command = "\\menuseparator";
+		command = "menuseparator";
 		break;
 	case SLASH:
-		command = "\\slash{}";
+		command = "breakableslash";
 		break;
 	case NOBREAKDASH:
-		command = "\\nobreakdash-";
+		command = "nobreakdash";
 		break;
 	case PHRASE_LYX:
-		command = "\\LyX";
+		command = "LyX";
 		break;
 	case PHRASE_TEX:
-		command = "\\TeX";
+		command = "TeX";
 		break;
 	case PHRASE_LATEX2E:
-		command = "\\LaTeX2e";
+		command = "LaTeX2e";
 		break;
 	case PHRASE_LATEX:
-		command = "\\LaTeX";
+		command = "LaTeX";
 		break;
 	}
 	os << "\\SpecialChar " << command << "\n";
 }
 
 
-// This function will not be necessary when lyx3
 void InsetSpecialChar::read(Lexer & lex)
 {
 	lex.next();
 	string const command = lex.getString();
 
-	if (command == "\\-")
+	if (command == "softhyphen")
 		kind_ = HYPHENATION;
-	else if (command == "\\textcompwordmark{}")
+	else if (command == "allowbreak")
+		kind_ = ALLOWBREAK;
+	else if (command == "ligaturebreak")
 		kind_ = LIGATURE_BREAK;
-	else if (command == "\\@.")
+	else if (command == "endofsentence")
 		kind_ = END_OF_SENTENCE;
-	else if (command == "\\ldots{}")
+	else if (command == "ldots")
 		kind_ = LDOTS;
-	else if (command == "\\menuseparator")
+	else if (command == "menuseparator")
 		kind_ = MENU_SEPARATOR;
-	else if (command == "\\slash{}")
+	else if (command == "breakableslash")
 		kind_ = SLASH;
-	else if (command == "\\nobreakdash-")
+	else if (command == "nobreakdash")
 		kind_ = NOBREAKDASH;
-	else if (command == "\\LyX")
+	else if (command == "LyX")
 		kind_ = PHRASE_LYX;
-	else if (command == "\\TeX")
+	else if (command == "TeX")
 		kind_ = PHRASE_TEX;
-	else if (command == "\\LaTeX2e")
+	else if (command == "LaTeX2e")
 		kind_ = PHRASE_LATEX2E;
-	else if (command == "\\LaTeX")
+	else if (command == "LaTeX")
 		kind_ = PHRASE_LATEX;
 	else
 		lex.printError("InsetSpecialChar: Unknown kind: `$$Token'");
@@ -360,23 +420,27 @@ void InsetSpecialChar::latex(otexstream & os,
 	case HYPHENATION:
 		os << "\\-";
 		break;
+	case ALLOWBREAK:
+		os << "\\LyXZeroWidthSpace" << termcmd;
+		break;
 	case LIGATURE_BREAK:
-		os << "\\textcompwordmark{}";
+		os << "\\textcompwordmark" << termcmd;
 		break;
 	case END_OF_SENTENCE:
 		os << "\\@.";
 		break;
 	case LDOTS:
-		os << "\\ldots{}";
+		os << "\\ldots" << termcmd;
 		break;
 	case MENU_SEPARATOR:
 		if (rp.local_font->isRightToLeft())
-			os << "\\lyxarrow*{}";
+			os << "\\lyxarrow*";
 		else
-			os << "\\lyxarrow{}";
+			os << "\\lyxarrow";
+		os << termcmd;
 		break;
 	case SLASH:
-		os << "\\slash{}";
+		os << "\\slash" << termcmd;
 		break;
 	case NOBREAKDASH:
 		if (rp.moving_arg)
@@ -386,22 +450,22 @@ void InsetSpecialChar::latex(otexstream & os,
 	case PHRASE_LYX:
 		if (rp.moving_arg)
 			os << "\\protect";
-		os << "\\LyX{}";
+		os << "\\LyX" << termcmd;
 		break;
 	case PHRASE_TEX:
 		if (rp.moving_arg)
 			os << "\\protect";
-		os << "\\TeX{}";
+		os << "\\TeX" << termcmd;
 		break;
 	case PHRASE_LATEX2E:
 		if (rp.moving_arg)
 			os << "\\protect";
-		os << "\\LaTeX2e{}";
+		os << "\\LaTeXe" << termcmd;
 		break;
 	case PHRASE_LATEX:
 		if (rp.moving_arg)
 			os << "\\protect";
-		os << "\\LaTeX{}";
+		os << "\\LaTeX" << termcmd;
 		break;
 	}
 }
@@ -413,6 +477,9 @@ int InsetSpecialChar::plaintext(odocstringstream & os,
 	switch (kind_) {
 	case HYPHENATION:
 		return 0;
+	case ALLOWBREAK:
+		os.put(0x200b);
+		return 1;
 	case LIGATURE_BREAK:
 		os.put(0x200c);
 		return 1;
@@ -453,6 +520,10 @@ int InsetSpecialChar::docbook(odocstream & os, OutputParams const &) const
 {
 	switch (kind_) {
 	case HYPHENATION:
+		break;
+	case ALLOWBREAK:
+		os.put(0x200b);
+		break;
 	case LIGATURE_BREAK:
 		break;
 	case END_OF_SENTENCE:
@@ -493,6 +564,9 @@ docstring InsetSpecialChar::xhtml(XHTMLStream & xs, OutputParams const &) const
 	switch (kind_) {
 	case HYPHENATION:
 		break;
+	case ALLOWBREAK:
+		xs << XHTMLStream::ESCAPE_NONE << "&#8203;";
+		break;
 	case LIGATURE_BREAK:
 		xs << XHTMLStream::ESCAPE_NONE << "&#8204;";
 		break;
@@ -531,8 +605,9 @@ docstring InsetSpecialChar::xhtml(XHTMLStream & xs, OutputParams const &) const
 void InsetSpecialChar::toString(odocstream & os) const
 {
 	switch (kind_) {
+	case ALLOWBREAK:
 	case LIGATURE_BREAK:
-		// Do not output ZERO WIDTH NON JOINER here
+		// Do not output ZERO WIDTH SPACE and ZERO WIDTH NON JOINER here
 		// Spell checker would choke on it.
 		return;
 	default:
@@ -544,7 +619,8 @@ void InsetSpecialChar::toString(odocstream & os) const
 }
 
 
-void InsetSpecialChar::forOutliner(docstring & os, size_t) const
+void InsetSpecialChar::forOutliner(docstring & os, size_t const,
+								   bool const) const
 {
 	odocstringstream ods;
 	plaintext(ods, OutputParams(0));
@@ -554,6 +630,8 @@ void InsetSpecialChar::forOutliner(docstring & os, size_t) const
 
 void InsetSpecialChar::validate(LaTeXFeatures & features) const
 {
+	if (kind_ == ALLOWBREAK)
+		features.require("lyxzerowidthspace");
 	if (kind_ == MENU_SEPARATOR)
 		features.require("lyxarrow");
 	if (kind_ == NOBREAKDASH)
@@ -563,6 +641,12 @@ void InsetSpecialChar::validate(LaTeXFeatures & features) const
 }
 
 
+bool InsetSpecialChar::isChar() const
+{
+	return kind_ != HYPHENATION && kind_ != LIGATURE_BREAK;
+}
+
+
 bool InsetSpecialChar::isLetter() const
 {
 	return kind_ == HYPHENATION || kind_ == LIGATURE_BREAK
@@ -577,8 +661,8 @@ bool InsetSpecialChar::isLineSeparator() const
 	// Paragraph::stripLeadingSpaces nukes the characters which
 	// have this property. I leave the code here, since it should
 	// eventually be made to work. (JMarc 20020327)
-	return kind_ == HYPHENATION || kind_ == MENU_SEPARATOR
-		|| kind_ == SLASH;
+	return kind_ == HYPHENATION || kind_ == ALLOWBREAK
+	    || kind_ == MENU_SEPARATOR || kind_ == SLASH;
 #else
 	return false;
 #endif