src/insets/InsetQuotes.cpp

   1 /**
   2  * \file InsetQuotes.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Jean-Marc Lasgouttes
   7  * \author Jürgen Spitzmüller
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "InsetQuotes.h"
  15
  16 #include "Buffer.h"
  17 #include "BufferParams.h"
  18 #include "BufferView.h"
  19 #include "Cursor.h"
  20 #include "Dimension.h"
  21 #include "Encoding.h"
  22 #include "Font.h"
  23 #include "FuncStatus.h"
  24 #include "FuncRequest.h"
  25 #include "Language.h"
  26 #include "LaTeXFeatures.h"
  27 #include "Lexer.h"
  28 #include "LyXRC.h"
  29 #include "MetricsInfo.h"
  30 #include "OutputParams.h"
  31 #include "Paragraph.h"
  32 #include "ParIterator.h"
  33 #include "texstream.h"
  34 #include "xml.h"
  35
  36 #include "frontends/FontMetrics.h"
  37 #include "frontends/Painter.h"
  38
  39 #include "support/debug.h"
  40 #include "support/docstring.h"
  41 #include "support/docstream.h"
  42 #include "support/gettext.h"
  43 #include "support/lstrings.h"
  44 #include "support/textutils.h"
  45
  46 #include <string.h>
  47
  48 using namespace std;
  49 using namespace lyx::support;
  50
  51 namespace lyx {
  52
  53 namespace {
  54
  55 /* codes used to read/write quotes to LyX files
  56  * available styles:
  57  * e    ``english''  (`inner quotation')
  58  * s    ''swedish''  ('inner quotation')
  59  * g    ,,german``   (,inner quotation`)
  60  * p    ,,polish''   (,inner quotation')
  61  * c    <<swiss>>    (<inner quotation>)
  62  * a    >>danish<<   (>inner quotation<)
  63  * q    "plain"      ('inner quotation')
  64  * b    `british'    (``inner quotation'')
  65  * w    >>swedishg>> ('inner quotation') ["g" = Guillemets]
  66  * f    <<french>>   (``inner quotation'')
  67  * i    <<frenchin>> (<<inner quotation>>) ["in" = Imprimerie Nationale]
  68  * r    <<russian>>  (,,inner quotation``)
  69  * j    [U+300C]cjk[U+300D]  ([U+300E]inner quotation[U+300F]) [CORNER BRACKETS]
  70  * k    [U+300A]cjkangle[U+300B]  ([U+3008]inner quotation[U+3009]) [ANGLE BRACKETS]
  71  * x    dynamic style (inherits document settings)
  72  */
  73
  74 char const * const style_char = "esgpcaqbwfirjkx";
  75 char const * const side_char = "lr" ;
  76 char const * const level_char = "sd";
  77
  78 } // namespace
  79
  80
  81 /////////////////////////////////////////////////////////////////////
  82 //
  83 // InsetQuotesParams
  84 //
  85 ///////////////////////////////////////////////////////////////////////
  86
  87 InsetQuotesParams quoteparams;
  88
  89
  90 int InsetQuotesParams::stylescount() const
  91 {
  92         return strlen(style_char);
  93 }
  94
  95
  96 char InsetQuotesParams::getStyleChar(QuoteStyle const & style) const
  97 {
  98         return style_char[style];
  99 }
 100
 101
 102 InsetQuotesParams::QuoteStyle InsetQuotesParams::getQuoteStyle(string const & s,
 103                             bool const allow_wildcards, QuoteStyle fb)
 104 {
 105         QuoteStyle res = fb;
 106
 107         string str = s;
 108         if (str.length() != 3) {
 109                 LYXERR0("ERROR (InsetQuotes::InsetQuotes):"
 110                         " bad string length.");
 111                 str = "eld";
 112         }
 113
 114         // '.' wildcard means: keep current style
 115         if (!allow_wildcards || str[0] != '.') {
 116                 int i;
 117                 for (i = 0; i < stylescount(); ++i) {
 118                         if (str[0] == style_char[i]) {
 119                                 res = QuoteStyle(i);
 120                                 break;
 121                         }
 122                 }
 123                 if (i >= stylescount()) {
 124                         LYXERR0("ERROR (InsetQuotes::InsetQuotes):"
 125                                 " bad style specification.");
 126                         res = EnglishQuotes;
 127                 }
 128         }
 129
 130         return res;
 131 }
 132
 133
 134 InsetQuotesParams::QuoteSide InsetQuotesParams::getQuoteSide(string const & s,
 135                         bool const allow_wildcards, QuoteSide fb)
 136 {
 137         QuoteSide res = fb;
 138
 139         string str = s;
 140         if (str.length() != 3) {
 141                 LYXERR0("ERROR (InsetQuotes::InsetQuotes):"
 142                         " bad string length.");
 143                 str = "eld";
 144         }
 145
 146         // '.' wildcard means: keep current side
 147         if (!allow_wildcards || str[1] != '.') {
 148                 int i;
 149                 for (i = 0; i < 2; ++i) {
 150                         if (str[1] == side_char[i]) {
 151                                 res = InsetQuotesParams::QuoteSide(i);
 152                                 break;
 153                         }
 154                 }
 155                 if (i >= 2) {
 156                         LYXERR0("ERROR (InsetQuotes::InsetQuotes):"
 157                                 " bad side specification.");
 158                         res = OpeningQuote;
 159                 }
 160         }
 161
 162         return res;
 163 }
 164
 165
 166 InsetQuotesParams::QuoteLevel InsetQuotesParams::getQuoteLevel(string const & s,
 167                         bool const allow_wildcards, QuoteLevel fb)
 168 {
 169         QuoteLevel res = fb;
 170
 171         string str = s;
 172         if (str.length() != 3) {
 173                 LYXERR0("ERROR (InsetQuotes::InsetQuotes):"
 174                         " bad string length.");
 175                 str = "eld";
 176         }
 177
 178         // '.' wildcard means: keep current level
 179         if (!allow_wildcards || str[2] != '.') {
 180                 int i;
 181                 for (i = 0; i < 2; ++i) {
 182                         if (str[2] == level_char[i]) {
 183                                 res = InsetQuotesParams::QuoteLevel(i);
 184                                 break;
 185                         }
 186                 }
 187                 if (i >= 2) {
 188                         LYXERR0("ERROR (InsetQuotes::InsetQuotes):"
 189                                 " bad level specification.");
 190                         res = InsetQuotesParams::PrimaryQuotes;
 191                 }
 192         }
 193
 194         return res;
 195 }
 196
 197
 198 char_type InsetQuotesParams::getQuoteChar(QuoteStyle const & style, QuoteLevel const & level,
 199                                     QuoteSide const & side, bool const rtl) const
 200 {
 201         // main opening quotation mark
 202         char_type left_primary;
 203         // main closing quotation mark
 204         char_type right_primary;
 205         // secondary (inner, 'single') opening quotation mark
 206         char_type left_secondary;
 207         // secondary (inner, 'single') closing quotation mark
 208         char_type right_secondary;
 209
 210         switch (style) {
 211         case EnglishQuotes: {
 212                 left_primary = 0x201c; // ``
 213                 right_primary = 0x201d; // ''
 214                 left_secondary = 0x2018; // `
 215                 right_secondary = 0x2019; // '
 216                 break;
 217         }
 218         case SwedishQuotes: {
 219                 left_primary = 0x201d; // ''
 220                 right_primary = 0x201d; // ''
 221                 left_secondary = 0x2019; // '
 222                 right_secondary = 0x2019; // '
 223                 break;
 224         }
 225         case GermanQuotes: {
 226                 left_primary = 0x201e; // ,,
 227                 right_primary = 0x201c; // ``
 228                 left_secondary = 0x201a; // ,
 229                 right_secondary = 0x2018; // `
 230                 break;
 231         }
 232         case PolishQuotes: {
 233                 left_primary =  0x201e; // ,,
 234                 right_primary = 0x201d; // ''
 235                 left_secondary = 0x201a; // ,
 236                 right_secondary = 0x2019; // '
 237                 break;
 238         }
 239         case SwissQuotes: {
 240                 left_primary = 0x00ab; // <<
 241                 right_primary = 0x00bb; // >>
 242                 left_secondary = 0x2039; // <
 243                 right_secondary = 0x203a; // >
 244                 break;
 245         }
 246         case DanishQuotes: {
 247                 left_primary = 0x00bb; // >>
 248                 right_primary = 0x00ab; // <<
 249                 left_secondary = 0x203a; // >
 250                 right_secondary = 0x2039; // <
 251                 break;
 252         }
 253         case PlainQuotes: {
 254                 left_primary = 0x0022; // "
 255                 right_primary = 0x0022; // "
 256                 left_secondary = 0x0027; // '
 257                 right_secondary = 0x0027; // '
 258                 break;
 259         }
 260         case BritishQuotes: {
 261                 left_primary = 0x2018; // `
 262                 right_primary = 0x2019; // '
 263                 left_secondary = 0x201c; // ``
 264                 right_secondary = 0x201d; // ''
 265                 break;
 266         }
 267         case SwedishGQuotes: {
 268                 left_primary = 0x00bb; // >>
 269                 right_primary = 0x00bb; // >>
 270                 left_secondary = 0x2019; // '
 271                 right_secondary = 0x2019; // '
 272                 break;
 273         }
 274         case FrenchQuotes: {
 275                 left_primary = 0x00ab; // <<
 276                 right_primary = 0x00bb; // >>
 277                 left_secondary = 0x201c; // ``
 278                 right_secondary = 0x201d; // ''
 279                 break;
 280         }
 281         case FrenchINQuotes:{
 282                 left_primary = 0x00ab; // <<
 283                 right_primary = 0x00bb; // >>
 284                 left_secondary =  0x00ab; // <<
 285                 right_secondary = 0x00bb; // >>
 286                 break;
 287         }
 288         case RussianQuotes:{
 289                 left_primary = 0x00ab; // <<
 290                 right_primary = 0x00bb; // >>
 291                 left_secondary =  0x201e; // ,,
 292                 right_secondary = 0x201c; // ``
 293                 break;
 294         }
 295         case CJKQuotes:{
 296                 left_primary = 0x300c; // LEFT CORNER BRACKET
 297                 right_primary = 0x300d; // RIGHT CORNER BRACKET
 298                 left_secondary =  0x300e; // LEFT WHITE CORNER BRACKET
 299                 right_secondary = 0x300f; // RIGHT WHITE CORNER BRACKET
 300                 break;
 301         }
 302         case CJKAngleQuotes:{
 303                 left_primary = 0x300a; // LEFT DOUBLE ANGLE BRACKET
 304                 right_primary = 0x300b; // RIGHT DOUBLE ANGLE BRACKET
 305                 left_secondary =  0x3008; // LEFT ANGLE BRACKET
 306                 right_secondary = 0x3009; // RIGHT ANGLE BRACKET
 307                 break;
 308         }
 309         case DynamicQuotes:
 310         default:
 311                 // should not happen
 312                 left_primary = 0x003f; // ?
 313                 right_primary = 0x003f; // ?
 314                 left_secondary =  0x003f; // ?
 315                 right_secondary = 0x003f; // ?
 316                 break;
 317         }
 318
 319         switch (level) {
 320         case SecondaryQuotes:
 321                 if (rtl)
 322                         return (side == ClosingQuote) ? left_secondary : right_secondary;
 323                 return (side == OpeningQuote) ? left_secondary : right_secondary;
 324         case PrimaryQuotes:
 325                 if (rtl)
 326                         return (side == ClosingQuote) ? left_primary : right_primary;
 327                 return (side == OpeningQuote) ? left_primary : right_primary;
 328         default:
 329                 break;
 330         }
 331
 332         // should not happen
 333         return 0x003f;
 334 }
 335
 336
 337 docstring InsetQuotesParams::getLaTeXQuote(char_type c, string const & op,
 338                                            bool const rtl) const
 339 {
 340         string res;
 341
 342         switch (c){
 343         case 0x201a: {// ,
 344                 if (op == "babel")
 345                         res = "\\glq";
 346                 else
 347                         res = "\\quotesinglbase";
 348                 break;
 349         }
 350         case 0x2019: {// '
 351                 if (op == "int")
 352                         // This macro is redefined in rtl mode
 353                         res = rtl ? "\\textquoteleft" : "\\textquoteright";
 354                 else
 355                         res = "'";
 356                 break;
 357         }
 358         case 0x2018: {// `
 359                 if (op == "int")
 360                         // This macro is redefined in rtl mode
 361                         res = rtl ? "\\textquoteright" : "\\textquoteleft";
 362                 else
 363                         res = "`";
 364                 break;
 365         }
 366         case 0x2039: {// <
 367                 if (op == "babel")
 368                         res = "\\flq";
 369                 else
 370                         res = "\\guilsinglleft";
 371                 break;
 372         }
 373         case 0x203a: {// >
 374                 if (op == "babel")
 375                         res = "\\frq";
 376                 else
 377                         res = "\\guilsinglright";
 378                 break;
 379         }
 380         case 0x0027: {// ' (plain)
 381                 res = "\\textquotesingle";
 382                 break;
 383         }
 384         case 0x201e: {// ,,
 385                 if (op == "t1")
 386                         res = ",,";
 387                 else if (op == "babel")
 388                         res = "\\glqq";
 389                 else
 390                         res = "\\quotedblbase";
 391                 break;
 392         }
 393         case 0x201d: {// ''
 394                 if (op == "int")
 395                         // This macro is redefined in rtl mode
 396                         res = rtl ? "\\textquotedblleft" : "\\textquotedblright";
 397                 else
 398                         res = "''";
 399                 break;
 400         }
 401         case 0x201c: {// ``
 402                 if (op == "int")
 403                         // This macro is redefined in rtl mode
 404                         res = rtl ? "\\textquotedblright" : "\\textquotedblleft";
 405                 else
 406                         res = "``";
 407                 break;
 408         }
 409         case 0x00ab: {// <<
 410                 if (op == "t1")
 411                         res = "<<";
 412                 else if (op == "babel")
 413                         res = "\\flqq";
 414                 else
 415                         res = "\\guillemotleft";
 416                 break;
 417         }
 418         case 0x00bb: {// >>
 419                 if (op == "t1")
 420                         res = ">>";
 421                 else if (op == "babel")
 422                         res = "\\frqq";
 423                 else
 424                         res = "\\guillemotright";
 425                 break;
 426         }
 427         case 0x0022: {// "
 428                 res = "\\textquotedbl";
 429                 break;
 430         }
 431         // The following are fakes
 432         // This is just to get something symbolic
 433         // in encodings where this chars would not be used anyway
 434         case 0x300c: // LEFT CORNER BRACKET
 435                 res = "\\ensuremath{\\lceil}";
 436                 break;
 437         case 0x300d: // RIGHT CORNER BRACKET
 438                 res = "\\ensuremath{\\rfloor}";
 439                 break;
 440         case 0x300e: // LEFT WHITE CORNER BRACKET
 441                 res = "\\ensuremath{\\llceil}";
 442                 break;
 443         case 0x300f: // RIGHT WHITE CORNER BRACKET
 444                 res = "\\ensuremath{\\rrfloor}";
 445                 break;
 446         case 0x300a: // LEFT DOUBLE ANGLE BRACKET
 447                 res = "\\ensuremath{\\langle\\kern-2.5pt\\langle}";
 448                 break;
 449         case 0x300b: // RIGHT DOUBLE ANGLE BRACKET
 450                 res = "\\ensuremath{\\rangle\\kern-2.5pt\\rangle}";
 451                 break;
 452         case 0x3008: // LEFT ANGLE BRACKET
 453                 res = "\\ensuremath{\\langle}";
 454                 break;
 455         case 0x3009: // RIGHT ANGLE BRACKET
 456                 res = "\\ensuremath{\\rangle}";
 457                 break;
 458         default:
 459                 break;
 460         }
 461
 462         return from_ascii(res);
 463 }
 464
 465
 466 docstring InsetQuotesParams::getHTMLQuote(char_type c) const
 467 {
 468         string res;
 469
 470         switch (c){
 471         case 0x201a: // ,
 472                 res = "&sbquo;";
 473                 break;
 474         case 0x2019: // '
 475                 res = "&rsquo;";
 476                 break;
 477         case 0x2018: // `
 478                 res = "&lsquo;";
 479                 break;
 480         case 0x2039: // <
 481                 res = "&lsaquo;";
 482                 break;
 483         case 0x203a: // >
 484                 res = "&rsaquo;";
 485                 break;
 486         case 0x0027: // ' (plain)
 487                 res = "&#x27;";
 488                 break;
 489         case 0x201e: // ,,
 490                 res = "&bdquo;";
 491                 break;
 492         case 0x201d: // ''
 493                 res = "&rdquo;";
 494                 break;
 495         case 0x201c: // ``
 496                 res = "&ldquo;";
 497                 break;
 498         case 0x00ab: // <<
 499                 res = "&laquo;";
 500                 break;
 501         case 0x00bb: // >>
 502                 res = "&raquo;";
 503                 break;
 504         case 0x0022: // "
 505                 res = "&quot;";
 506                 break;
 507         case 0x300c: // LEFT CORNER BRACKET
 508                 res = "&#x300c;";
 509                 break;
 510         case 0x300d: // RIGHT CORNER BRACKET
 511                 res = "&#x300d;";
 512                 break;
 513         case 0x300e: // LEFT WHITE CORNER BRACKET
 514                 res = "&#x300e;";
 515                 break;
 516         case 0x300f: // RIGHT WHITE CORNER BRACKET
 517                 res = "&#x300f;";
 518                 break;
 519         case 0x300a: // LEFT DOUBLE ANGLE BRACKET
 520                 res = "&#x300a;";
 521                 break;
 522         case 0x300b: // RIGHT DOUBLE ANGLE BRACKET
 523                 res = "&#x300b;";
 524                 break;
 525         case 0x3008: // LEFT ANGLE BRACKET
 526                 res = "&#x3008;";
 527                 break;
 528         case 0x3009: // RIGHT ANGLE BRACKET
 529                 res = "&#x3009;";
 530                 break;
 531         default:
 532                 break;
 533         }
 534
 535         return from_ascii(res);
 536 }
 537
 538
 539 docstring InsetQuotesParams::getXMLQuote(char_type c) const
 540 {
 541         // Directly output the character Unicode form.
 542         return from_ascii("&#" + to_string(c) + ";");
 543 }
 544
 545
 546 map<string, docstring> InsetQuotesParams::getTypes() const
 547 {
 548         map<string, docstring> res;
 549
 550         int sty, sid, lev;
 551         QuoteStyle style;
 552         QuoteSide side;
 553         QuoteLevel level;
 554         string type;
 555
 556         // get all quote types
 557         for (sty = 0; sty < stylescount(); ++sty) {
 558                 style = QuoteStyle(sty);
 559                 if (style == DynamicQuotes)
 560                         continue;
 561                 for (sid = 0; sid < 2; ++sid) {
 562                         side = QuoteSide(sid);
 563                         for (lev = 0; lev < 2; ++lev) {
 564                                 type += style_char[style];
 565                                 type += side_char[sid];
 566                                 level = QuoteLevel(lev);
 567                                 type += level_char[lev];
 568                                 res[type] = docstring(1, getQuoteChar(style, level, side));
 569                                 type.clear();
 570                         }
 571                 }
 572         }
 573         return res;
 574 }
 575
 576
 577 docstring const InsetQuotesParams::getGuiLabel(QuoteStyle const & qs, bool langdef)
 578 {
 579         docstring const styledesc =
 580                 bformat(_("%1$souter%2$s and %3$sinner%4$s[[quotation marks]]"),
 581                         docstring(1, getQuoteChar(qs, PrimaryQuotes, OpeningQuote)),
 582                         docstring(1, getQuoteChar(qs, PrimaryQuotes, ClosingQuote)),
 583                         docstring(1, getQuoteChar(qs, SecondaryQuotes, OpeningQuote)),
 584                         docstring(1, getQuoteChar(qs, SecondaryQuotes, ClosingQuote))
 585                         );
 586
 587         if (!langdef)
 588                 return styledesc;
 589
 590         return bformat(_("%1$s[[quot. mark description]] (language default)"),
 591                         styledesc);
 592 }
 593
 594
 595 docstring const InsetQuotesParams::getShortGuiLabel(docstring const & str)
 596 {
 597         string const s = to_ascii(str);
 598         QuoteStyle const style = getQuoteStyle(s);
 599         QuoteSide const side = getQuoteSide(s);
 600         QuoteLevel const level = getQuoteLevel(s);
 601
 602         return (side == OpeningQuote) ?
 603                 bformat(_("%1$stext"),
 604                        docstring(1, getQuoteChar(style, level, side))) :
 605                 bformat(_("text%1$s"),
 606                        docstring(1, getQuoteChar(style, level, side)));
 607 }
 608
 609
 610 /////////////////////////////////////////////////////////////////////
 611 //
 612 // InsetQuotes
 613 //
 614 ///////////////////////////////////////////////////////////////////////
 615
 616 InsetQuotes::InsetQuotes(Buffer * buf, string const & str)
 617         : Inset(buf),
 618           style_(InsetQuotesParams::EnglishQuotes), side_(InsetQuotesParams::OpeningQuote),
 619           pass_thru_(false), internal_fontenc_(false), rtl_(false)
 620 {
 621         if (buf) {
 622                 global_style_ = buf->masterBuffer()->params().quotes_style;
 623                 fontspec_ = buf->masterBuffer()->params().useNonTeXFonts;
 624         }
 625         else {
 626                 global_style_ = InsetQuotesParams::EnglishQuotes;
 627                 fontspec_ = false;
 628         }
 629
 630         parseString(str);
 631 }
 632
 633
 634 InsetQuotes::InsetQuotes(Buffer * buf, char_type c, InsetQuotesParams::QuoteLevel level,
 635                          string const & side, string const & style)
 636         : Inset(buf), level_(level), pass_thru_(false), fontspec_(false),
 637           internal_fontenc_(false), rtl_(false)
 638 {
 639         bool dynamic = false;
 640         if (buf) {
 641                 global_style_ = buf->masterBuffer()->params().quotes_style;
 642                 fontenc_ = buf->masterBuffer()->params().main_font_encoding();
 643                 dynamic = buf->masterBuffer()->params().dynamic_quotes;
 644                 fontspec_ = buf->masterBuffer()->params().useNonTeXFonts;
 645         } else {
 646                 global_style_ = InsetQuotesParams::EnglishQuotes;
 647                 fontenc_ = "OT1";
 648                 fontspec_ = false;
 649         }
 650         if (style.empty())
 651                 style_ = dynamic ? InsetQuotesParams::DynamicQuotes : global_style_;
 652         else
 653                 style_ = getStyle(style);
 654
 655         if (side == "left" || side == "opening")
 656                 side_ = InsetQuotesParams::OpeningQuote;
 657         else if (side == "right" || side == "closing")
 658                 side_ = InsetQuotesParams::ClosingQuote;
 659         else
 660                 setSide(c);
 661 }
 662
 663
 664 docstring InsetQuotes::layoutName() const
 665 {
 666         return from_ascii("Quotes");
 667 }
 668
 669
 670 void InsetQuotes::setSide(char_type c)
 671 {
 672         // Decide whether opening or closing quote
 673         if (lyx::isSpace(c) || isOpenPunctuation(c))
 674                 side_ = InsetQuotesParams::OpeningQuote;// opening quote
 675         else
 676                 side_ = InsetQuotesParams::ClosingQuote;// closing quote
 677 }
 678
 679
 680 void InsetQuotes::parseString(string const & s, bool const allow_wildcards)
 681 {
 682         style_ = quoteparams.getQuoteStyle(s, allow_wildcards, style_);
 683         side_ = quoteparams.getQuoteSide(s, allow_wildcards, side_);
 684         level_ = quoteparams.getQuoteLevel(s, allow_wildcards, level_);
 685 }
 686
 687
 688 InsetQuotesParams::QuoteStyle InsetQuotes::getStyle(string const & s)
 689 {
 690         InsetQuotesParams::QuoteStyle qs = InsetQuotesParams::EnglishQuotes;
 691
 692         if (s == "english")
 693                 qs = InsetQuotesParams::EnglishQuotes;
 694         else if (s == "swedish")
 695                 qs = InsetQuotesParams::SwedishQuotes;
 696         else if (s == "german")
 697                 qs = InsetQuotesParams::GermanQuotes;
 698         else if (s == "polish")
 699                 qs = InsetQuotesParams::PolishQuotes;
 700         else if (s == "swiss")
 701                 qs = InsetQuotesParams::SwissQuotes;
 702         else if (s == "danish")
 703                 qs = InsetQuotesParams::DanishQuotes;
 704         else if (s == "plain")
 705                 qs = InsetQuotesParams::PlainQuotes;
 706         else if (s == "british")
 707                 qs = InsetQuotesParams::BritishQuotes;
 708         else if (s == "swedishg")
 709                 qs = InsetQuotesParams::SwedishGQuotes;
 710         else if (s == "french")
 711                 qs = InsetQuotesParams::FrenchQuotes;
 712         else if (s == "frenchin")
 713                 qs = InsetQuotesParams::FrenchINQuotes;
 714         else if (s == "russian")
 715                 qs = InsetQuotesParams::RussianQuotes;
 716         else if (s == "cjk")
 717                 qs = InsetQuotesParams::CJKQuotes;
 718         else if (s == "cjkangle")
 719                 qs = InsetQuotesParams::CJKAngleQuotes;
 720         else if (s == "dynamic")
 721                 qs = InsetQuotesParams::DynamicQuotes;
 722
 723         return qs;
 724 }
 725
 726
 727 docstring InsetQuotes::displayString() const
 728 {
 729         // In PassThru, we use straight quotes
 730         if (pass_thru_)
 731                 return (level_ == InsetQuotesParams::PrimaryQuotes) ?
 732                                         from_ascii("\"") : from_ascii("'");
 733
 734         InsetQuotesParams::QuoteStyle style =
 735                         (style_ == InsetQuotesParams::DynamicQuotes) ? global_style_ : style_;
 736
 737         docstring retdisp = docstring(1, quoteparams.getQuoteChar(style, level_, side_, rtl_));
 738
 739         // in French, thin spaces are added inside double guillemets
 740         if (prefixIs(context_lang_, "fr")
 741             && level_ == InsetQuotesParams::PrimaryQuotes
 742             && (style == InsetQuotesParams::SwissQuotes
 743                 || style == InsetQuotesParams::FrenchQuotes
 744                 || style == InsetQuotesParams::FrenchINQuotes)) {
 745                 // THIN SPACE (U+2009)
 746                 char_type const thin_space = 0x2009;
 747                 if (side_ == InsetQuotesParams::OpeningQuote)
 748                         retdisp += thin_space;
 749                 else
 750                         retdisp = thin_space + retdisp;
 751         }
 752
 753         return retdisp;
 754 }
 755
 756
 757 void InsetQuotes::metrics(MetricsInfo & mi, Dimension & dim) const
 758 {
 759         FontInfo & font = mi.base.font;
 760         frontend::FontMetrics const & fm = theFontMetrics(font);
 761         dim.asc = fm.maxAscent();
 762         dim.des = fm.maxDescent();
 763         dim.wid = fm.width(displayString());
 764 }
 765
 766
 767 void InsetQuotes::draw(PainterInfo & pi, int x, int y) const
 768 {
 769         FontInfo font = pi.base.font;
 770         if (style_ == InsetQuotesParams::DynamicQuotes)
 771                 font.setPaintColor(Color_special);
 772         else
 773                 font.setPaintColor(pi.textColor(font.realColor()));
 774         pi.pain.text(x, y, displayString(), font);
 775 }
 776
 777
 778 string InsetQuotes::getType() const
 779 {
 780         string text;
 781         text += style_char[style_];
 782         text += side_char[side_];
 783         text += level_char[level_];
 784         return text;
 785 }
 786
 787
 788 void InsetQuotes::write(ostream & os) const
 789 {
 790         os << "Quotes " << getType();
 791 }
 792
 793
 794 void InsetQuotes::read(Lexer & lex)
 795 {
 796         lex.setContext("InsetQuotes::read");
 797         lex.next();
 798         parseString(lex.getString());
 799         lex >> "\\end_inset";
 800 }
 801
 802
 803 void InsetQuotes::doDispatch(Cursor & cur, FuncRequest & cmd)
 804 {
 805         switch (cmd.action()) {
 806         case LFUN_INSET_MODIFY: {
 807                 string const first_arg = cmd.getArg(0);
 808                 bool const change_type = first_arg == "changetype";
 809                 if (!change_type) {
 810                         // not for us
 811                         // this will not be handled higher up
 812                         cur.undispatched();
 813                         return;
 814                 }
 815                 cur.recordUndoInset(this);
 816                 parseString(cmd.getArg(1), true);
 817                 cur.forceBufferUpdate();
 818                 break;
 819         }
 820         default:
 821                 Inset::doDispatch(cur, cmd);
 822                 break;
 823         }
 824 }
 825
 826
 827 bool InsetQuotes::getStatus(Cursor & cur, FuncRequest const & cmd,
 828                 FuncStatus & flag) const
 829 {
 830         switch (cmd.action()) {
 831
 832         case LFUN_INSET_MODIFY: {
 833                 string const first_arg = cmd.getArg(0);
 834                 if (first_arg == "changetype") {
 835                         string const type = cmd.getArg(1);
 836                         flag.setOnOff(type == getType());
 837                         flag.setEnabled(!pass_thru_);
 838                         return true;
 839                 }
 840                 return Inset::getStatus(cur, cmd, flag);
 841         }
 842
 843         default:
 844                 return Inset::getStatus(cur, cmd, flag);
 845         }
 846 }
 847
 848
 849 void InsetQuotes::latex(otexstream & os, OutputParams const & runparams) const
 850 {
 851         InsetQuotesParams::QuoteStyle style =
 852                         (style_ == InsetQuotesParams::DynamicQuotes) ? global_style_ : style_;
 853         char_type quotechar = quoteparams.getQuoteChar(style, level_, side_, rtl_);
 854         docstring qstr;
 855
 856         // In pass-thru context, we output plain quotes
 857         if (runparams.pass_thru)
 858                 qstr = (level_ == InsetQuotesParams::PrimaryQuotes) ? from_ascii("\"") : from_ascii("'");
 859         else if (style == InsetQuotesParams::PlainQuotes && fontspec_) {
 860                 // For XeTeX and LuaTeX,we need to disable mapping to get straight
 861                 // quotes. We define our own commands that do this
 862                 qstr = (level_ == InsetQuotesParams::PrimaryQuotes) ?
 863                         from_ascii("\\textquotedblplain") : from_ascii("\\textquotesingleplain");
 864         }
 865         else if (runparams.use_polyglossia) {
 866                 // For polyglossia, we directly output the respective unicode chars
 867                 // (spacing and kerning is then handled respectively)
 868                 qstr = docstring(1, quotechar);
 869         }
 870         // The CJK marks are not yet covered by utf8 inputenc (we don't have the entry in
 871         // unicodesymbols, since we don't want to add fake synbols there).
 872         else if (style == InsetQuotesParams::CJKQuotes || style  == InsetQuotesParams::CJKAngleQuotes) {
 873                 if (runparams.encoding && runparams.encoding->name() != "utf8"
 874                     && runparams.encoding->encodable(quotechar))
 875                         qstr = docstring(1, quotechar);
 876                 else
 877                         qstr = quoteparams.getLaTeXQuote(quotechar, "int");
 878         }
 879         else if ((style == InsetQuotesParams::SwissQuotes
 880                  || style == InsetQuotesParams::FrenchQuotes
 881                  || style == InsetQuotesParams::FrenchINQuotes)
 882                  && level_ == InsetQuotesParams::PrimaryQuotes
 883                  && prefixIs(runparams.local_font->language()->code(), "fr")) {
 884                 // Specific guillemets of French babel
 885                 // including correct French spacing
 886                 if (side_ == InsetQuotesParams::OpeningQuote)
 887                         qstr = from_ascii("\\og");
 888                 else
 889                         qstr = from_ascii("\\fg");
 890         } else if (runparams.use_hyperref && runparams.moving_arg) {
 891                 // Use internal commands in headings with hyperref
 892                 // (ligatures not featured in PDF strings)
 893                 qstr = quoteparams.getLaTeXQuote(quotechar, "int", rtl_);
 894         } else if (fontenc_ == "T1"
 895                    && !runparams.local_font->language()->internalFontEncoding()) {
 896                 // Quotation marks for T1 font encoding
 897                 // (using ligatures)
 898                 qstr = quoteparams.getLaTeXQuote(quotechar, "t1");
 899         } else if (runparams.local_font->language()->internalFontEncoding()) {
 900                 // Quotation marks for internal font encodings
 901                 // (ligatures not featured)
 902                 qstr = quoteparams.getLaTeXQuote(quotechar, "int", rtl_);
 903 #ifdef DO_USE_DEFAULT_LANGUAGE
 904         } else if ((doclang == "default"
 905 #else
 906         } else if ((!runparams.use_babel
 907 #endif
 908                    || (fontenc_ != "T1" && fontenc_ != "OT1"))
 909                    || runparams.isFullUnicode()) {
 910                 // Standard quotation mark macros
 911                 // These are also used by babel
 912                 // without fontenc (XeTeX/LuaTeX)
 913                 qstr = quoteparams.getLaTeXQuote(quotechar, "ot1");
 914         } else {
 915                 // Babel shorthand quotation marks (for T1/OT1)
 916                 qstr = quoteparams.getLaTeXQuote(quotechar, "babel");
 917         }
 918
 919         if (!runparams.pass_thru) {
 920                 // Guard against unwanted ligatures with preceding text
 921                 char_type const lastchar = os.lastChar();
 922                 // LuaTeX does not respect {} as ligature breaker by design,
 923                 // see https://tex.stackexchange.com/q/349725/19291
 924                 docstring const nolig =
 925                                 (runparams.flavor == OutputParams::LUATEX
 926                                  || runparams.flavor == OutputParams::DVILUATEX) ?
 927                                         from_ascii("\\/") : from_ascii("{}");
 928                 // !` ?` => !{}` ?{}`
 929                 if (prefixIs(qstr, from_ascii("`"))
 930                     && (lastchar == '!' || lastchar == '?'))
 931                         os << nolig;
 932                 // ``` ''' ,,, <<< >>>
 933                 // => `{}`` '{}'' ,{},, <{}<< >{}>>
 934                 if (contains(from_ascii(",'`<>"), lastchar)
 935                     && prefixIs(qstr, lastchar))
 936                         os << nolig;
 937         }
 938
 939         os << qstr;
 940
 941         if (prefixIs(qstr, from_ascii("\\")) && !suffixIs(qstr, '}'))
 942                 // properly terminate the command depending on the context
 943                 os << termcmd;
 944 }
 945
 946
 947 int InsetQuotes::plaintext(odocstringstream & os,
 948         OutputParams const &, size_t) const
 949 {
 950         docstring const str = displayString();
 951         os << str;
 952         return str.size();
 953 }
 954
 955
 956 docstring InsetQuotes::getQuoteEntity(bool isHTML) const {
 957         InsetQuotesParams::QuoteStyle style =
 958                         (style_ == InsetQuotesParams::DynamicQuotes) ? global_style_ : style_;
 959         docstring res = isHTML ? quoteparams.getHTMLQuote(quoteparams.getQuoteChar(style, level_, side_)) :
 960                                         quoteparams.getXMLQuote(quoteparams.getQuoteChar(style, level_, side_));
 961
 962         // in French, thin spaces are added inside double guillemets
 963         if (prefixIs(context_lang_, "fr")
 964             && level_ == InsetQuotesParams::PrimaryQuotes
 965             && (style == InsetQuotesParams::FrenchQuotes
 966                 || style == InsetQuotesParams::FrenchINQuotes
 967                 || style == InsetQuotesParams::SwissQuotes)) {
 968                 // THIN SPACE (U+2009)
 969                 docstring const thin_space = from_ascii("&#x2009;");
 970                 if (side_ == InsetQuotesParams::OpeningQuote) // Open quote: space after
 971                         res += thin_space;
 972                 else // Close quote: space before
 973                         res = thin_space + res;
 974         }
 975         return res;
 976 }
 977
 978
 979 void InsetQuotes::docbook(XMLStream & xs, OutputParams const &) const
 980 {
 981         xs << XMLStream::ESCAPE_NONE << getQuoteEntity(false);
 982 }
 983
 984
 985 docstring InsetQuotes::xhtml(XMLStream & xs, OutputParams const &) const
 986 {
 987         xs << XMLStream::ESCAPE_NONE << getQuoteEntity(true);
 988         return docstring();
 989 }
 990
 991
 992 void InsetQuotes::toString(odocstream & os) const
 993 {
 994         os << displayString();
 995 }
 996
 997
 998 void InsetQuotes::forOutliner(docstring & os, size_t const, bool const) const
 999 {
1000         os += displayString();
1001 }
1002
1003
1004 void InsetQuotes::updateBuffer(ParIterator const & it, UpdateType /* utype*/, bool const /*deleted*/)
1005 {
1006         BufferParams const & bp = buffer().masterBuffer()->params();
1007         Font const & font = it.paragraph().getFontSettings(bp, it.pos());
1008         pass_thru_ = it.paragraph().isPassThru();
1009         context_lang_ = font.language()->code();
1010         internal_fontenc_ = font.language()->internalFontEncoding();
1011         fontenc_ = bp.main_font_encoding();
1012         global_style_ = bp.quotes_style;
1013         fontspec_ = bp.useNonTeXFonts;
1014         rtl_ = font.isRightToLeft();
1015 }
1016
1017
1018 void InsetQuotes::validate(LaTeXFeatures & features) const
1019 {
1020         InsetQuotesParams::QuoteStyle style =
1021                         (style_ == InsetQuotesParams::DynamicQuotes) ? global_style_ : style_;
1022         char_type type = quoteparams.getQuoteChar(style, level_, side_);
1023
1024         // Handle characters that are not natively supported by
1025         // specific font encodings (we roll our own definitions)
1026 #ifdef DO_USE_DEFAULT_LANGUAGE
1027         if (features.bufferParams().language->lang() == "default"
1028 #else
1029         if (!features.useBabel()
1030 #endif
1031             && !features.runparams().isFullUnicode() && fontenc_ != "T1") {
1032                 switch (type) {
1033                 case 0x201a:
1034                         features.require("quotesinglbase");
1035                         break;
1036                 case 0x2039:
1037                         features.require("guilsinglleft");
1038                         break;
1039                 case 0x203a:
1040                         features.require("guilsinglright");
1041                         break;
1042                 case 0x201e:
1043                         features.require("quotedblbase");
1044                         break;
1045                 case 0x00ab:
1046                         features.require("guillemotleft");
1047                         break;
1048                 case 0x00bb:
1049                         features.require("guillemotright");
1050                         break;
1051                 default:
1052                         break;
1053                 }
1054         }
1055         // Handle straight quotation marks. These need special care
1056         // in most output formats
1057         switch (type) {
1058         case 0x0027: {
1059                 if (features.runparams().isFullUnicode() && fontspec_)
1060                                 features.require("textquotesinglep");
1061                         else
1062                                 features.require("textcomp");
1063                         break;
1064         }
1065         case 0x0022: {
1066                 if (features.runparams().isFullUnicode() && fontspec_)
1067                         features.require("textquotedblp");
1068                 else if (fontenc_ != "T1" || internal_fontenc_)
1069                         features.require("textquotedbl");
1070                 break;
1071         }
1072         // we fake these from math (also for utf8 inputenc
1073         // currently; see above)
1074         case 0x300e: // LEFT WHITE CORNER BRACKET
1075         case 0x300f: // RIGHT WHITE CORNER BRACKET
1076                 if (!features.runparams().encoding
1077                     || features.runparams().encoding->name() == "utf8"
1078                     || !features.runparams().encoding->encodable(type))
1079                         features.require("stmaryrd");
1080                 break;
1081         default:
1082                 break;
1083         }
1084 }
1085
1086
1087 string InsetQuotes::contextMenuName() const
1088 {
1089         return "context-quote";
1090 }
1091
1092 } // namespace lyx