]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetSpecialChar.cpp
Fixup 572b06d6: reduce cache size for breakString
[lyx.git] / src / insets / InsetSpecialChar.cpp
index 3e47b642a2b4c1aa2ea8d9392185b27235d6bd34..88af6538f68b6b44110ac5fdefb7c3f95098ba7c 100644 (file)
 #include "InsetSpecialChar.h"
 
 #include "Dimension.h"
+#include "Encoding.h"
 #include "Font.h"
+#include "Language.h"
 #include "LaTeXFeatures.h"
 #include "Lexer.h"
 #include "MetricsInfo.h"
 #include "output_xhtml.h"
+#include "xml.h"
 #include "texstream.h"
 
 #include "frontends/FontMetrics.h"
+#include "frontends/NullPainter.h"
 #include "frontends/Painter.h"
 
 #include "support/debug.h"
@@ -34,7 +38,7 @@ namespace lyx {
 
 
 InsetSpecialChar::InsetSpecialChar(Kind k)
-       : Inset(0), kind_(k)
+       : Inset(nullptr), kind_(k)
 {}
 
 
@@ -44,48 +48,6 @@ InsetSpecialChar::Kind InsetSpecialChar::kind() const
 }
 
 
-namespace {
-
-int logoWidth(FontInfo const & font, InsetSpecialChar::Kind kind) {
-       frontend::FontMetrics const & fm = theFontMetrics(font);
-       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")) - 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")) - 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)
-                       + 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")) - 9 * em / 25
-                       + theFontMetrics(smaller).width(from_ascii("A")) - 3 * em / 20
-                       + logoWidth(font, InsetSpecialChar::PHRASE_TEX);
-               break;
-       }
-       default:
-               LYXERR0("No information for computing width of logo " << kind);
-       }
-
-       return width;
-}
-
-}
-
 docstring InsetSpecialChar::toolTip(BufferView const &, int, int) const
 {
        docstring message;
@@ -108,58 +70,39 @@ docstring InsetSpecialChar::toolTip(BufferView const &, int, int) const
                case NOBREAKDASH:
                        message = from_ascii("Protected Hyphen (SHY)");
                        break;
-               default:
+               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;
 }
 
 
-void InsetSpecialChar::metrics(MetricsInfo & mi, Dimension & dim) const
+int InsetSpecialChar::rowFlags() const
 {
-       frontend::FontMetrics const & fm =
-               theFontMetrics(mi.base.font);
-       dim.asc = fm.maxAscent();
-       dim.des = fm.maxDescent();
-       dim.wid = 0;
-
-       docstring s;
        switch (kind_) {
-               case ALLOWBREAK:
-                       dim.wid = fm.em() / 8;
-                       break;
-               case LIGATURE_BREAK:
-                       s = from_ascii("|");
-                       break;
-               case END_OF_SENTENCE:
-                       s = from_ascii(".");
-                       break;
-               case LDOTS:
-                       s = from_ascii(". . .");
-                       break;
-               case MENU_SEPARATOR:
-                       s = from_ascii(" x ");
-                       break;
-               case HYPHENATION:
-                       dim.wid = fm.width(from_ascii("-"));
-                       if (dim.wid > 5)
-                               dim.wid -= 2; // to make it look shorter
-                       break;
-               case SLASH:
-                       s = from_ascii("/");
-                       break;
-               case NOBREAKDASH:
-                       s = from_ascii("-");
-                       break;
-               case PHRASE_LYX:
-               case PHRASE_TEX:
-               case PHRASE_LATEX2E:
-               case PHRASE_LATEX:
-                       dim.wid = logoWidth(mi.base.font, kind_);
-                       break;
+       case ALLOWBREAK:
+       case HYPHENATION:
+       case SLASH:
+               // these are the elements that allow line breaking
+               return CanBreakAfter;
+       case NOBREAKDASH:
+       case END_OF_SENTENCE:
+       case LIGATURE_BREAK:
+       case LDOTS:
+       case MENU_SEPARATOR:
+       case PHRASE_LYX:
+       case PHRASE_TEX:
+       case PHRASE_LATEX2E:
+       case PHRASE_LATEX:
+               break;
        }
-       if (dim.wid == 0)
-               dim.wid = fm.width(s);
+       return Inline;
 }
 
 
@@ -195,7 +138,7 @@ void drawLogo(PainterInfo & pi, int & x, int const y, InsetSpecialChar::Kind kin
                /** Reference macro:
                 *  \def\TeX{T\kern-.1667em\lower.5ex\hbox{E}\kern-.125emX\@}
                 */
-               int const ex = theFontMetrics(font).ascent('x');
+               int const ex = theFontMetrics(font).xHeight();
                drawChar(pi, x, y, 'T');
                x -= em / 6;
                drawChar(pi, x, y + ex / 2, 'E');
@@ -212,6 +155,7 @@ void drawLogo(PainterInfo & pi, int & x, int const y, InsetSpecialChar::Kind kin
                drawLogo(pi, x, y, InsetSpecialChar::PHRASE_LATEX);
                x += 3 * em / 20;
                drawChar(pi, x, y, '2');
+               // ε U+03B5 GREEK SMALL LETTER EPSILON
                drawChar(pi, x, y + em / 4, char_type(0x03b5));
                break;
 
@@ -242,8 +186,67 @@ void drawLogo(PainterInfo & pi, int & x, int const y, InsetSpecialChar::Kind kin
        }
 }
 
+} // namespace
+
+
+void InsetSpecialChar::metrics(MetricsInfo & mi, Dimension & dim) const
+{
+       frontend::FontMetrics const & fm =
+               theFontMetrics(mi.base.font);
+       dim.asc = fm.maxAscent();
+       dim.des = 0;
+       dim.wid = 0;
+
+       docstring s;
+       switch (kind_) {
+               case ALLOWBREAK:
+                       dim.asc = fm.xHeight();
+                       dim.des = fm.descent('g');
+                       dim.wid = fm.em() / 8;
+                       break;
+               case LIGATURE_BREAK:
+                       s = from_ascii("|");
+                       break;
+               case END_OF_SENTENCE:
+                       s = from_ascii(".");
+                       break;
+               case LDOTS:
+                       s = from_ascii(". . .");
+                       break;
+               case MENU_SEPARATOR:
+                       // ▹  U+25B9 WHITE RIGHT-POINTING SMALL TRIANGLE
+                       // There is a \thinspace on each side of the triangle
+                       dim.wid = 2 * fm.em() / 6 + fm.width(char_type(0x25B9));
+                       break;
+               case HYPHENATION:
+                       dim.wid = fm.width(from_ascii("-"));
+                       if (dim.wid > 5)
+                               dim.wid -= 2; // to make it look shorter
+                       break;
+               case SLASH:
+                       s = from_ascii("/");
+                       dim.des = fm.descent(s[0]);
+                       break;
+               case NOBREAKDASH:
+                       s = from_ascii("-");
+                       break;
+               case PHRASE_LYX:
+               case PHRASE_TEX:
+               case PHRASE_LATEX2E:
+               case PHRASE_LATEX:
+                       dim.asc = fm.maxAscent();
+                       dim.des = fm.maxDescent();
+                       frontend::NullPainter np;
+                       PainterInfo pi(mi.base.bv, np);
+                       pi.base.font = mi.base.font;
+                       drawLogo(pi, dim.wid, 0, kind_);
+                       break;
+       }
+       if (dim.wid == 0)
+               dim.wid = fm.width(s);
 }
 
+
 void InsetSpecialChar::draw(PainterInfo & pi, int x, int y) const
 {
        FontInfo font = pi.base.font;
@@ -258,7 +261,7 @@ void InsetSpecialChar::draw(PainterInfo & pi, int x, int y) const
        case ALLOWBREAK:
        {
                // A small vertical line
-               int const asc = theFontMetrics(pi.base.font).ascent('x');
+               int const asc = theFontMetrics(pi.base.font).xHeight();
                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?
@@ -292,18 +295,13 @@ void InsetSpecialChar::draw(PainterInfo & pi, int x, int y) const
                frontend::FontMetrics const & fm =
                        theFontMetrics(font);
 
-               // A triangle the width and height of an 'x'
-               int w = fm.width(char_type('x'));
-               int ox = fm.width(char_type(' ')) + x;
-               int h = fm.ascent(char_type('x'));
-               int xp[4], yp[4];
-
-               xp[0] = ox;     yp[0] = y;
-               xp[1] = ox;     yp[1] = y - h;
-               xp[2] = ox + w; yp[2] = y - h/2;
-               xp[3] = ox;     yp[3] = y;
-
-               pi.pain.lines(xp, yp, 4, Color_special);
+               // There is a \thinspace on each side of the triangle
+               x += fm.em() / 6;
+               // ▹ U+25B9 WHITE RIGHT-POINTING SMALL TRIANGLE
+               // ◃ U+25C3 WHITE LEFT-POINTING SMALL TRIANGLE
+               char_type const c = pi.ltr_pos ? 0x25B9 : 0x25C3;
+               font.setColor(Color_special);
+               pi.pain.text(x, y, c, font);
                break;
        }
        case SLASH:
@@ -410,15 +408,32 @@ void InsetSpecialChar::read(Lexer & lex)
 void InsetSpecialChar::latex(otexstream & os,
                             OutputParams const & rp) const
 {
+       bool const rtl = rp.local_font->isRightToLeft();
+       bool const utf8 = rp.encoding->iconvName() == "UTF-8";
+       string lswitch = "";
+       string lswitche = "";
+       if (rtl && !rp.use_polyglossia) {
+               lswitch = "\\L{";
+               lswitche = "}";
+               if (rp.local_font->language()->lang() == "arabic_arabi"
+                   || rp.local_font->language()->lang() == "farsi")
+                       lswitch = "\\textLR{";
+       }
+
        switch (kind_) {
        case HYPHENATION:
                os << "\\-";
                break;
        case ALLOWBREAK:
+               // U+200B not yet supported by utf8 inputenc
                os << "\\LyXZeroWidthSpace" << termcmd;
                break;
        case LIGATURE_BREAK:
-               os << "\\textcompwordmark" << termcmd;
+               if (utf8)
+                       // U+200C ZERO WIDTH NON-JOINER
+                       os.put(0x200c);
+               else
+                       os << "\\textcompwordmark" << termcmd;
                break;
        case END_OF_SENTENCE:
                os << "\\@.";
@@ -427,7 +442,7 @@ void InsetSpecialChar::latex(otexstream & os,
                os << "\\ldots" << termcmd;
                break;
        case MENU_SEPARATOR:
-               if (rp.local_font->isRightToLeft())
+               if (rtl)
                        os << "\\lyxarrow*";
                else
                        os << "\\lyxarrow";
@@ -444,22 +459,22 @@ void InsetSpecialChar::latex(otexstream & os,
        case PHRASE_LYX:
                if (rp.moving_arg)
                        os << "\\protect";
-               os << "\\LyX" << termcmd;
+               os << lswitch << "\\LyX" << termcmd << lswitche;
                break;
        case PHRASE_TEX:
                if (rp.moving_arg)
                        os << "\\protect";
-               os << "\\TeX" << termcmd;
+               os << lswitch << "\\TeX" << termcmd << lswitche;
                break;
        case PHRASE_LATEX2E:
                if (rp.moving_arg)
                        os << "\\protect";
-               os << "\\LaTeXe" << termcmd;
+               os << lswitch << "\\LaTeXe" << termcmd << lswitche;
                break;
        case PHRASE_LATEX:
                if (rp.moving_arg)
                        os << "\\protect";
-               os << "\\LaTeX" << termcmd;
+               os << lswitch << "\\LaTeX" << termcmd << lswitche;
                break;
        }
 }
@@ -472,15 +487,18 @@ int InsetSpecialChar::plaintext(odocstringstream & os,
        case HYPHENATION:
                return 0;
        case ALLOWBREAK:
+               // U+200B ZERO WIDTH SPACE (ZWSP)
                os.put(0x200b);
                return 1;
        case LIGATURE_BREAK:
+               // U+200C ZERO WIDTH NON-JOINER
                os.put(0x200c);
                return 1;
        case END_OF_SENTENCE:
                os << '.';
                return 1;
        case LDOTS:
+               // … U+2026 HORIZONTAL ELLIPSIS
                os.put(0x2026);
                return 1;
        case MENU_SEPARATOR:
@@ -490,6 +508,7 @@ int InsetSpecialChar::plaintext(odocstringstream & os,
                os << '/';
                return 1;
        case NOBREAKDASH:
+               // ‑ U+2011 NON-BREAKING HYPHEN
                os.put(0x2011);
                return 1;
        case PHRASE_LYX:
@@ -500,6 +519,7 @@ int InsetSpecialChar::plaintext(odocstringstream & os,
                return 3;
        case PHRASE_LATEX2E:
                os << "LaTeX2";
+               // ε U+03B5 GREEK SMALL LETTER EPSILON
                os.put(0x03b5);
                return 7;
        case PHRASE_LATEX:
@@ -510,74 +530,82 @@ int InsetSpecialChar::plaintext(odocstringstream & os,
 }
 
 
-int InsetSpecialChar::docbook(odocstream & os, OutputParams const &) const
+void InsetSpecialChar::docbook(XMLStream & xs, OutputParams const &) const
 {
        switch (kind_) {
-       case HYPHENATION:
-               break;
-       case ALLOWBREAK:
-               os.put(0x200b);
-               break;
+    case HYPHENATION:
+       // Soft hyphen.
+        xs << XMLStream::ESCAPE_NONE << "&#xAD;";
+        break;
+    case ALLOWBREAK:
+       // Zero-width space
+        xs << XMLStream::ESCAPE_NONE << "&#x200B;";
+        break;
        case LIGATURE_BREAK:
+               // Zero width non-joiner
+               xs << XMLStream::ESCAPE_NONE << "&#x200C;";
                break;
        case END_OF_SENTENCE:
-               os << '.';
+               xs << '.';
                break;
        case LDOTS:
-               os << "&hellip;";
+               // &hellip;
+               xs << XMLStream::ESCAPE_NONE << "&#x2026;";
                break;
        case MENU_SEPARATOR:
-               os << "&lyxarrow;";
+               // &rArr;, right arrow.
+               xs << XMLStream::ESCAPE_NONE << "&#x21D2;";
                break;
        case SLASH:
-               os << '/';
+               // &frasl;, fractional slash.
+               xs << XMLStream::ESCAPE_NONE << "&#x2044;";
                break;
+               // Non-breaking hyphen.
        case NOBREAKDASH:
-               os << '-';
+               xs << XMLStream::ESCAPE_NONE << "&#x2011;";
                break;
        case PHRASE_LYX:
-               os << "LyX";
+               xs << "LyX";
                break;
        case PHRASE_TEX:
-               os << "TeX";
+               xs << "TeX";
                break;
        case PHRASE_LATEX2E:
-               os << "LaTeX2";
-               os.put(0x03b5);
+               // Lower-case epsilon.
+               xs << "LaTeX2" << XMLStream::ESCAPE_NONE << "&#x03b5;";
                break;
        case PHRASE_LATEX:
-               os << "LaTeX";
+               xs << "LaTeX";
                break;
        }
-       return 0;
 }
 
 
-docstring InsetSpecialChar::xhtml(XHTMLStream & xs, OutputParams const &) const
+docstring InsetSpecialChar::xhtml(XMLStream & xs, OutputParams const &) const
 {
        switch (kind_) {
        case HYPHENATION:
                break;
        case ALLOWBREAK:
-               xs << XHTMLStream::ESCAPE_NONE << "&#8203;";
+               xs << XMLStream::ESCAPE_NONE << "&#8203;";
                break;
        case LIGATURE_BREAK:
-               xs << XHTMLStream::ESCAPE_NONE << "&#8204;";
+               xs << XMLStream::ESCAPE_NONE << "&#8204;";
                break;
        case END_OF_SENTENCE:
                xs << '.';
                break;
        case LDOTS:
-               xs << XHTMLStream::ESCAPE_NONE << "&hellip;";
+               xs << XMLStream::ESCAPE_NONE << "&hellip;";
                break;
        case MENU_SEPARATOR:
-               xs << XHTMLStream::ESCAPE_NONE << "&rArr;";
+               xs << XMLStream::ESCAPE_NONE << "&rArr;";
                break;
        case SLASH:
-               xs << XHTMLStream::ESCAPE_NONE << "&frasl;";
+               xs << XMLStream::ESCAPE_NONE << "&frasl;";
                break;
        case NOBREAKDASH:
-               xs << XHTMLStream::ESCAPE_NONE << "&#8209;";
+               xs << XMLStream::ESCAPE_NONE << "&#8209;";
                break;
        case PHRASE_LYX:
                xs << "LyX";
@@ -586,7 +614,7 @@ docstring InsetSpecialChar::xhtml(XHTMLStream & xs, OutputParams const &) const
                xs << "TeX";
                break;
        case PHRASE_LATEX2E:
-               xs << "LaTeX2" << XHTMLStream::ESCAPE_NONE << "&#x3b5;";
+               xs << "LaTeX2" << XMLStream::ESCAPE_NONE << "&#x3b5;";
                break;
        case PHRASE_LATEX:
                xs << "LaTeX";
@@ -644,7 +672,9 @@ bool InsetSpecialChar::isChar() const
 bool InsetSpecialChar::isLetter() const
 {
        return kind_ == HYPHENATION || kind_ == LIGATURE_BREAK
-               || kind_ == NOBREAKDASH;
+               || kind_ == NOBREAKDASH
+               || kind_ == PHRASE_LYX || kind_ == PHRASE_LATEX
+               || kind_ == PHRASE_TEX || kind_ == PHRASE_LATEX2E;
 }