]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetQuotes.cpp
Loop refactoring
[lyx.git] / src / insets / InsetQuotes.cpp
index 6ed66b2e3ede5d3d09bc9af457e7b5a57c0a23fc..c93de5a06395c4ad301d04838659cfc1f9e73346 100644 (file)
 #include "LyXRC.h"
 #include "MetricsInfo.h"
 #include "OutputParams.h"
-#include "output_xhtml.h"
 #include "Paragraph.h"
 #include "ParIterator.h"
 #include "texstream.h"
+#include "xml.h"
 
 #include "frontends/FontMetrics.h"
 #include "frontends/Painter.h"
@@ -75,7 +75,7 @@ char const * const style_char = "esgpcaqbwfirjkx";
 char const * const side_char = "lr" ;
 char const * const level_char = "sd";
 
-} // namespace anon
+} // namespace
 
 
 /////////////////////////////////////////////////////////////////////
@@ -93,8 +93,110 @@ int InsetQuotesParams::stylescount() const
 }
 
 
+char InsetQuotesParams::getStyleChar(QuoteStyle const & style) const
+{
+       return style_char[style];
+}
+
+
+InsetQuotesParams::QuoteStyle InsetQuotesParams::getQuoteStyle(string const & s,
+                           bool const allow_wildcards, QuoteStyle fb)
+{
+       QuoteStyle res = fb;
+
+       string str = s;
+       if (str.length() != 3) {
+               LYXERR0("ERROR (InsetQuotes::InsetQuotes):"
+                       " bad string length.");
+               str = "eld";
+       }
+
+       // '.' wildcard means: keep current style
+       if (!allow_wildcards || str[0] != '.') {
+               int i;
+               for (i = 0; i < stylescount(); ++i) {
+                       if (str[0] == style_char[i]) {
+                               res = QuoteStyle(i);
+                               break;
+                       }
+               }
+               if (i >= stylescount()) {
+                       LYXERR0("ERROR (InsetQuotes::InsetQuotes):"
+                               " bad style specification.");
+                       res = EnglishQuotes;
+               }
+       }
+
+       return res;
+}
+
+
+InsetQuotesParams::QuoteSide InsetQuotesParams::getQuoteSide(string const & s,
+                       bool const allow_wildcards, QuoteSide fb)
+{
+       QuoteSide res = fb;
+
+       string str = s;
+       if (str.length() != 3) {
+               LYXERR0("ERROR (InsetQuotes::InsetQuotes):"
+                       " bad string length.");
+               str = "eld";
+       }
+
+       // '.' wildcard means: keep current side
+       if (!allow_wildcards || str[1] != '.') {
+               int i;
+               for (i = 0; i < 2; ++i) {
+                       if (str[1] == side_char[i]) {
+                               res = InsetQuotesParams::QuoteSide(i);
+                               break;
+                       }
+               }
+               if (i >= 2) {
+                       LYXERR0("ERROR (InsetQuotes::InsetQuotes):"
+                               " bad side specification.");
+                       res = OpeningQuote;
+               }
+       }
+
+       return res;
+}
+
+
+InsetQuotesParams::QuoteLevel InsetQuotesParams::getQuoteLevel(string const & s,
+                       bool const allow_wildcards, QuoteLevel fb)
+{
+       QuoteLevel res = fb;
+
+       string str = s;
+       if (str.length() != 3) {
+               LYXERR0("ERROR (InsetQuotes::InsetQuotes):"
+                       " bad string length.");
+               str = "eld";
+       }
+
+       // '.' wildcard means: keep current level
+       if (!allow_wildcards || str[2] != '.') {
+               int i;
+               for (i = 0; i < 2; ++i) {
+                       if (str[2] == level_char[i]) {
+                               res = InsetQuotesParams::QuoteLevel(i);
+                               break;
+                       }
+               }
+               if (i >= 2) {
+                       LYXERR0("ERROR (InsetQuotes::InsetQuotes):"
+                               " bad level specification.");
+                       res = InsetQuotesParams::PrimaryQuotes;
+               }
+       }
+
+       return res;
+}
+
+
 char_type InsetQuotesParams::getQuoteChar(QuoteStyle const & style, QuoteLevel const & level,
-                                   QuoteSide const & side) const
+                                   QuoteSide const & side, bool const rtl) const
 {
        // main opening quotation mark
        char_type left_primary;
@@ -216,8 +318,12 @@ char_type InsetQuotesParams::getQuoteChar(QuoteStyle const & style, QuoteLevel c
 
        switch (level) {
        case SecondaryQuotes:
+               if (rtl)
+                       return (side == ClosingQuote) ? left_secondary : right_secondary;
                return (side == OpeningQuote) ? left_secondary : right_secondary;
        case PrimaryQuotes:
+               if (rtl)
+                       return (side == ClosingQuote) ? left_primary : right_primary;
                return (side == OpeningQuote) ? left_primary : right_primary;
        default:
                break;
@@ -228,7 +334,8 @@ char_type InsetQuotesParams::getQuoteChar(QuoteStyle const & style, QuoteLevel c
 }
 
 
-docstring InsetQuotesParams::getLaTeXQuote(char_type c, string const & op) const
+docstring InsetQuotesParams::getLaTeXQuote(char_type c, string const & op,
+                                          bool const rtl) const
 {
        string res;
 
@@ -242,14 +349,16 @@ docstring InsetQuotesParams::getLaTeXQuote(char_type c, string const & op) const
        }
        case 0x2019: {// '
                if (op == "int")
-                       res = "\\textquoteleft";
+                       // This macro is redefined in rtl mode
+                       res = rtl ? "\\textquoteleft" : "\\textquoteright";
                else
                        res = "'";
                break;
        }
        case 0x2018: {// `
                if (op == "int")
-                       res = "\\textquoteright";
+                       // This macro is redefined in rtl mode
+                       res = rtl ? "\\textquoteright" : "\\textquoteleft";
                else
                        res = "`";
                break;
@@ -283,14 +392,16 @@ docstring InsetQuotesParams::getLaTeXQuote(char_type c, string const & op) const
        }
        case 0x201d: {// ''
                if (op == "int")
-                       res = "\\textquotedblleft";
+                       // This macro is redefined in rtl mode
+                       res = rtl ? "\\textquotedblleft" : "\\textquotedblright";
                else
                        res = "''";
                break;
        }
        case 0x201c: {// ``
                if (op == "int")
-                       res = "\\textquotedblright";
+                       // This macro is redefined in rtl mode
+                       res = rtl ? "\\textquotedblright" : "\\textquotedblleft";
                else
                        res = "``";
                break;
@@ -319,7 +430,7 @@ docstring InsetQuotesParams::getLaTeXQuote(char_type c, string const & op) const
        }
        // The following are fakes
        // This is just to get something symbolic
-       // in encodings where this chars would not be used ayway
+       // in encodings where this chars would not be used anyway
        case 0x300c: // LEFT CORNER BRACKET
                res = "\\ensuremath{\\lceil}";
                break;
@@ -347,7 +458,7 @@ docstring InsetQuotesParams::getLaTeXQuote(char_type c, string const & op) const
        default:
                break;
        }
-       
+
        return from_ascii(res);
 }
 
@@ -420,11 +531,18 @@ docstring InsetQuotesParams::getHTMLQuote(char_type c) const
        default:
                break;
        }
-       
+
        return from_ascii(res);
 }
 
 
+docstring InsetQuotesParams::getXMLQuote(char_type c) const
+{
+       // Directly output the character Unicode form.
+       return from_ascii("&#" + to_string(c) + ";");
+}
+
+
 map<string, docstring> InsetQuotesParams::getTypes() const
 {
        map<string, docstring> res;
@@ -456,14 +574,36 @@ map<string, docstring> InsetQuotesParams::getTypes() const
 }
 
 
-docstring const InsetQuotesParams::getGuiLabel(QuoteStyle const & qs)
+docstring const InsetQuotesParams::getGuiLabel(QuoteStyle const & qs, bool langdef)
+{
+       docstring const styledesc =
+               bformat(_("%1$souter%2$s and %3$sinner%4$s[[quotation marks]]"),
+                       docstring(1, getQuoteChar(qs, PrimaryQuotes, OpeningQuote)),
+                       docstring(1, getQuoteChar(qs, PrimaryQuotes, ClosingQuote)),
+                       docstring(1, getQuoteChar(qs, SecondaryQuotes, OpeningQuote)),
+                       docstring(1, getQuoteChar(qs, SecondaryQuotes, ClosingQuote))
+                       );
+
+       if (!langdef)
+               return styledesc;
+
+       return bformat(_("%1$s[[quot. mark description]] (language default)"),
+                       styledesc);
+}
+
+
+docstring const InsetQuotesParams::getShortGuiLabel(docstring const & str)
 {
-       return bformat(_("%1$souter%2$s and %3$sinner%4$s[[quotation marks]]"),
-               docstring(1, quoteparams.getQuoteChar(qs, PrimaryQuotes, OpeningQuote)),
-               docstring(1, quoteparams.getQuoteChar(qs, PrimaryQuotes, ClosingQuote)),
-               docstring(1, quoteparams.getQuoteChar(qs, SecondaryQuotes, OpeningQuote)),
-               docstring(1, quoteparams.getQuoteChar(qs, SecondaryQuotes, ClosingQuote))
-               );
+       string const s = to_ascii(str);
+       QuoteStyle const style = getQuoteStyle(s);
+       QuoteSide const side = getQuoteSide(s);
+       QuoteLevel const level = getQuoteLevel(s);
+
+       return (side == OpeningQuote) ?
+               bformat(_("%1$stext"),
+                      docstring(1, getQuoteChar(style, level, side))) :
+               bformat(_("text%1$s"),
+                      docstring(1, getQuoteChar(style, level, side)));
 }
 
 
@@ -473,7 +613,10 @@ docstring const InsetQuotesParams::getGuiLabel(QuoteStyle const & qs)
 //
 ///////////////////////////////////////////////////////////////////////
 
-InsetQuotes::InsetQuotes(Buffer * buf, string const & str) : Inset(buf)
+InsetQuotes::InsetQuotes(Buffer * buf, string const & str)
+       : Inset(buf),
+         style_(InsetQuotesParams::EnglishQuotes), side_(InsetQuotesParams::OpeningQuote),
+         pass_thru_(false), internal_fontenc_(false), rtl_(false)
 {
        if (buf) {
                global_style_ = buf->masterBuffer()->params().quotes_style;
@@ -490,18 +633,18 @@ InsetQuotes::InsetQuotes(Buffer * buf, string const & str) : Inset(buf)
 
 InsetQuotes::InsetQuotes(Buffer * buf, char_type c, InsetQuotesParams::QuoteLevel level,
                         string const & side, string const & style)
-       : Inset(buf), level_(level), pass_thru_(false), fontspec_(false)
+       : Inset(buf), level_(level), pass_thru_(false), fontspec_(false),
+         internal_fontenc_(false), rtl_(false)
 {
        bool dynamic = false;
        if (buf) {
                global_style_ = buf->masterBuffer()->params().quotes_style;
-               fontenc_ = (buf->masterBuffer()->params().fontenc == "global")
-                       ? lyxrc.fontenc : buf->params().fontenc;
+               fontenc_ = buf->masterBuffer()->params().main_font_encoding();
                dynamic = buf->masterBuffer()->params().dynamic_quotes;
                fontspec_ = buf->masterBuffer()->params().useNonTeXFonts;
        } else {
                global_style_ = InsetQuotesParams::EnglishQuotes;
-               fontenc_ = lyxrc.fontenc;
+               fontenc_ = "OT1";
                fontspec_ = false;
        }
        if (style.empty())
@@ -536,66 +679,16 @@ void InsetQuotes::setSide(char_type c)
 
 void InsetQuotes::parseString(string const & s, bool const allow_wildcards)
 {
-       string str = s;
-       if (str.length() != 3) {
-               lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
-                       " bad string length." << endl;
-               str = "eld";
-       }
-
-       int i;
-
-       // '.' wildcard means: keep current stylee
-       if (!allow_wildcards || str[0] != '.') {
-               for (i = 0; i < quoteparams.stylescount(); ++i) {
-                       if (str[0] == style_char[i]) {
-                               style_ = InsetQuotesParams::QuoteStyle(i);
-                               break;
-                       }
-               }
-               if (i >= quoteparams.stylescount()) {
-                       LYXERR0("ERROR (InsetQuotes::InsetQuotes):"
-                               " bad style specification.");
-                       style_ = InsetQuotesParams::EnglishQuotes;
-               }
-       }
-
-       // '.' wildcard means: keep current side
-       if (!allow_wildcards || str[1] != '.') {
-               for (i = 0; i < 2; ++i) {
-                       if (str[1] == side_char[i]) {
-                               side_ = InsetQuotesParams::QuoteSide(i);
-                               break;
-                       }
-               }
-               if (i >= 2) {
-                       LYXERR0("ERROR (InsetQuotes::InsetQuotes):"
-                               " bad side specification.");
-                       side_ = InsetQuotesParams::OpeningQuote;
-               }
-       }
-
-       // '.' wildcard means: keep current level
-       if (!allow_wildcards || str[2] != '.') {
-               for (i = 0; i < 2; ++i) {
-                       if (str[2] == level_char[i]) {
-                               level_ = InsetQuotesParams::QuoteLevel(i);
-                               break;
-                       }
-               }
-               if (i >= 2) {
-                       LYXERR0("ERROR (InsetQuotes::InsetQuotes):"
-                               " bad level specification.");
-                       level_ = InsetQuotesParams::PrimaryQuotes;
-               }
-       }
+       style_ = quoteparams.getQuoteStyle(s, allow_wildcards, style_);
+       side_ = quoteparams.getQuoteSide(s, allow_wildcards, side_);
+       level_ = quoteparams.getQuoteLevel(s, allow_wildcards, level_);
 }
 
 
 InsetQuotesParams::QuoteStyle InsetQuotes::getStyle(string const & s)
 {
        InsetQuotesParams::QuoteStyle qs = InsetQuotesParams::EnglishQuotes;
-       
+
        if (s == "english")
                qs = InsetQuotesParams::EnglishQuotes;
        else if (s == "swedish")
@@ -641,7 +734,7 @@ docstring InsetQuotes::displayString() const
        InsetQuotesParams::QuoteStyle style =
                        (style_ == InsetQuotesParams::DynamicQuotes) ? global_style_ : style_;
 
-       docstring retdisp = docstring(1, quoteparams.getQuoteChar(style, level_, side_));
+       docstring retdisp = docstring(1, quoteparams.getQuoteChar(style, level_, side_, rtl_));
 
        // in French, thin spaces are added inside double guillemets
        if (prefixIs(context_lang_, "fr")
@@ -721,7 +814,7 @@ void InsetQuotes::doDispatch(Cursor & cur, FuncRequest & cmd)
                }
                cur.recordUndoInset(this);
                parseString(cmd.getArg(1), true);
-               cur.buffer()->updateBuffer();
+               cur.forceBufferUpdate();
                break;
        }
        default:
@@ -757,7 +850,7 @@ void InsetQuotes::latex(otexstream & os, OutputParams const & runparams) const
 {
        InsetQuotesParams::QuoteStyle style =
                        (style_ == InsetQuotesParams::DynamicQuotes) ? global_style_ : style_;
-       char_type quotechar = quoteparams.getQuoteChar(style, level_, side_);
+       char_type quotechar = quoteparams.getQuoteChar(style, level_, side_, rtl_);
        docstring qstr;
 
        // In pass-thru context, we output plain quotes
@@ -770,12 +863,15 @@ void InsetQuotes::latex(otexstream & os, OutputParams const & runparams) const
                        from_ascii("\\textquotedblplain") : from_ascii("\\textquotesingleplain");
        }
        else if (runparams.use_polyglossia) {
-               // For polyglossia, we directly output the respective unicode chars 
+               // For polyglossia, we directly output the respective unicode chars
                // (spacing and kerning is then handled respectively)
                qstr = docstring(1, quotechar);
        }
+       // The CJK marks are not yet covered by utf8 inputenc (we don't have the entry in
+       // unicodesymbols, since we don't want to add fake synbols there).
        else if (style == InsetQuotesParams::CJKQuotes || style  == InsetQuotesParams::CJKAngleQuotes) {
-               if (runparams.encoding && runparams.encoding->encodable(quotechar))
+               if (runparams.encoding && runparams.encoding->name() != "utf8"
+                   && runparams.encoding->encodable(quotechar))
                        qstr = docstring(1, quotechar);
                else
                        qstr = quoteparams.getLaTeXQuote(quotechar, "int");
@@ -791,6 +887,10 @@ void InsetQuotes::latex(otexstream & os, OutputParams const & runparams) const
                        qstr = from_ascii("\\og");
                else
                        qstr = from_ascii("\\fg");
+       } else if (runparams.use_hyperref && runparams.moving_arg) {
+               // Use internal commands in headings with hyperref
+               // (ligatures not featured in PDF strings)
+               qstr = quoteparams.getLaTeXQuote(quotechar, "int", rtl_);
        } else if (fontenc_ == "T1"
                   && !runparams.local_font->language()->internalFontEncoding()) {
                // Quotation marks for T1 font encoding
@@ -799,12 +899,14 @@ void InsetQuotes::latex(otexstream & os, OutputParams const & runparams) const
        } else if (runparams.local_font->language()->internalFontEncoding()) {
                // Quotation marks for internal font encodings
                // (ligatures not featured)
-               qstr = quoteparams.getLaTeXQuote(quotechar, "int");
+               qstr = quoteparams.getLaTeXQuote(quotechar, "int", rtl_);
 #ifdef DO_USE_DEFAULT_LANGUAGE
-       } else if (doclang == "default") {
+       } else if ((doclang == "default"
 #else
-       } else if (!runparams.use_babel || runparams.isFullUnicode()) {
+       } else if ((!runparams.use_babel
 #endif
+                  || (fontenc_ != "T1" && fontenc_ != "OT1"))
+                  || runparams.isFullUnicode()) {
                // Standard quotation mark macros
                // These are also used by babel
                // without fontenc (XeTeX/LuaTeX)
@@ -817,15 +919,21 @@ void InsetQuotes::latex(otexstream & os, OutputParams const & runparams) const
        if (!runparams.pass_thru) {
                // Guard against unwanted ligatures with preceding text
                char_type const lastchar = os.lastChar();
+               // LuaTeX does not respect {} as ligature breaker by design,
+               // see https://tex.stackexchange.com/q/349725/19291
+               docstring const nolig =
+                               (runparams.flavor == OutputParams::LUATEX
+                                || runparams.flavor == OutputParams::DVILUATEX) ?
+                                       from_ascii("\\/") : from_ascii("{}");
                // !` ?` => !{}` ?{}`
                if (prefixIs(qstr, from_ascii("`"))
                    && (lastchar == '!' || lastchar == '?'))
-                       os << "{}";
+                       os << nolig;
                // ``` ''' ,,, <<< >>>
                // => `{}`` '{}'' ,{},, <{}<< >{}>>
                if (contains(from_ascii(",'`<>"), lastchar)
                    && prefixIs(qstr, lastchar))
-                       os << "{}";
+                       os << nolig;
        }
 
        os << qstr;
@@ -836,7 +944,7 @@ void InsetQuotes::latex(otexstream & os, OutputParams const & runparams) const
 }
 
 
-int InsetQuotes::plaintext(odocstringstream & os, 
+int InsetQuotes::plaintext(odocstringstream & os,
         OutputParams const &, size_t) const
 {
        docstring const str = displayString();
@@ -845,10 +953,12 @@ int InsetQuotes::plaintext(odocstringstream & os,
 }
 
 
-docstring InsetQuotes::getQuoteEntity() const {
+docstring InsetQuotes::getQuoteEntity(bool isHTML) const {
        InsetQuotesParams::QuoteStyle style =
                        (style_ == InsetQuotesParams::DynamicQuotes) ? global_style_ : style_;
-       docstring res = quoteparams.getHTMLQuote(quoteparams.getQuoteChar(style, level_, side_));
+       docstring res = isHTML ? quoteparams.getHTMLQuote(quoteparams.getQuoteChar(style, level_, side_)) :
+                                       quoteparams.getXMLQuote(quoteparams.getQuoteChar(style, level_, side_));
+
        // in French, thin spaces are added inside double guillemets
        if (prefixIs(context_lang_, "fr")
            && level_ == InsetQuotesParams::PrimaryQuotes
@@ -857,25 +967,24 @@ docstring InsetQuotes::getQuoteEntity() const {
                || style == InsetQuotesParams::SwissQuotes)) {
                // THIN SPACE (U+2009)
                docstring const thin_space = from_ascii("&#x2009;");
-               if (side_ == InsetQuotesParams::OpeningQuote)
+               if (side_ == InsetQuotesParams::OpeningQuote) // Open quote: space after
                        res += thin_space;
-               else
+               else // Close quote: space before
                        res = thin_space + res;
        }
        return res;
 }
 
 
-int InsetQuotes::docbook(odocstream & os, OutputParams const &) const
+void InsetQuotes::docbook(XMLStream & xs, OutputParams const &) const
 {
-       os << getQuoteEntity();
-       return 0;
+       xs << XMLStream::ESCAPE_NONE << getQuoteEntity(false);
 }
 
 
-docstring InsetQuotes::xhtml(XHTMLStream & xs, OutputParams const &) const
+docstring InsetQuotes::xhtml(XMLStream & xs, OutputParams const &) const
 {
-       xs << XHTMLStream::ESCAPE_NONE << getQuoteEntity();
+       xs << XMLStream::ESCAPE_NONE << getQuoteEntity(true);
        return docstring();
 }
 
@@ -892,14 +1001,17 @@ void InsetQuotes::forOutliner(docstring & os, size_t const, bool const) const
 }
 
 
-void InsetQuotes::updateBuffer(ParIterator const & it, UpdateType /* utype*/)
+void InsetQuotes::updateBuffer(ParIterator const & it, UpdateType /* utype*/, bool const /*deleted*/)
 {
        BufferParams const & bp = buffer().masterBuffer()->params();
+       Font const & font = it.paragraph().getFontSettings(bp, it.pos());
        pass_thru_ = it.paragraph().isPassThru();
-       context_lang_ = it.paragraph().getFontSettings(bp, it.pos()).language()->code();
-       fontenc_ = (bp.fontenc == "global") ? lyxrc.fontenc : bp.fontenc;
+       context_lang_ = font.language()->code();
+       internal_fontenc_ = font.language()->internalFontEncoding();
+       fontenc_ = bp.main_font_encoding();
        global_style_ = bp.quotes_style;
        fontspec_ = bp.useNonTeXFonts;
+       rtl_ = font.isRightToLeft();
 }
 
 
@@ -945,22 +1057,24 @@ void InsetQuotes::validate(LaTeXFeatures & features) const
        switch (type) {
        case 0x0027: {
                if (features.runparams().isFullUnicode() && fontspec_)
-                               features.require("textquotesinglep");
-                       else
-                               features.require("textcomp");
-                       break;
+                       features.require("textquotesinglep");
+               else
+                       features.require("textcomp");
+               break;
        }
        case 0x0022: {
                if (features.runparams().isFullUnicode() && fontspec_)
                        features.require("textquotedblp");
-               else if (fontenc_ != "T1")
+               else if (fontenc_ != "T1" || internal_fontenc_)
                        features.require("textquotedbl");
                break;
        }
-       // we fake these from math
+       // we fake these from math (also for utf8 inputenc
+       // currently; see above)
        case 0x300e: // LEFT WHITE CORNER BRACKET
        case 0x300f: // RIGHT WHITE CORNER BRACKET
                if (!features.runparams().encoding
+                   || features.runparams().encoding->name() == "utf8"
                    || !features.runparams().encoding->encodable(type))
                        features.require("stmaryrd");
                break;