src/Font.cpp

   1 /**
   2  * \file src/Font.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  * \author Jean-Marc Lasgouttes
   8  * \author Angus Leeming
   9  * \author André Pönitz
  10  * \author Dekel Tsur
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #include <config.h>
  16
  17 #include "Font.h"
  18
  19 #include "BufferParams.h" // stateText
  20 #include "ColorSet.h"
  21 #include "Encoding.h"
  22 #include "Language.h"
  23 #include "LaTeXFeatures.h"
  24 #include "Lexer.h"
  25 #include "LyXRC.h"
  26 #include "output_latex.h"
  27 #include "OutputParams.h"
  28 #include "texstream.h"
  29
  30 #include "support/lassert.h"
  31 #include "support/convert.h"
  32 #include "support/debug.h"
  33 #include "support/gettext.h"
  34 #include "support/lstrings.h"
  35
  36 #include <cstring>
  37
  38 using namespace std;
  39 using namespace lyx::support;
  40
  41 namespace lyx {
  42
  43 //
  44 // Strings used to read and write .lyx format files
  45 //
  46 // These are defined in FontInfo.cpp
  47 extern char const * LyXFamilyNames[NUM_FAMILIES + 2];
  48 extern char const * LyXSeriesNames[NUM_SERIES + 2];
  49 extern char const * LyXShapeNames[NUM_SHAPE + 2];
  50 extern char const * LyXSizeNames[NUM_SIZE + 4];
  51 extern char const * LyXMiscNames[5];
  52 extern char const * GUIMiscNames[5];
  53
  54 namespace {
  55
  56 //
  57 // Strings used to write LaTeX files
  58 //
  59 char const * LaTeXFamilyCommandNames[NUM_FAMILIES + 2] =
  60 { "textrm", "textsf", "texttt", "error1", "error2", "error3", "error4",
  61   "error5", "error6", "error7", "error8", "error9", "error10", "error11",
  62   "error12", "error13", "error14" };
  63
  64 char const * LaTeXFamilySwitchNames[NUM_FAMILIES + 2] =
  65 { "rmfamily", "sffamily", "ttfamily", "error1", "error2", "error3", "error4",
  66   "error5", "error6", "error7", "error8", "error9", "error10", "error11",
  67   "error12", "error13", "error14" };
  68
  69 char const * LaTeXSeriesCommandNames[NUM_SERIES + 2] =
  70 { "textmd", "textbf", "error4", "error5" };
  71
  72 char const * LaTeXSeriesSwitchNames[NUM_SERIES + 2] =
  73 { "mdseries", "bfseries", "error4", "error5" };
  74
  75 char const * LaTeXShapeCommandNames[NUM_SHAPE + 2] =
  76 { "textup", "textit", "textsl", "textsc", "error6", "error7" };
  77
  78 char const * LaTeXShapeSwitchNames[NUM_SHAPE + 2] =
  79 { "upshape", "itshape", "slshape", "scshape", "error6", "error7" };
  80
  81 char const * LaTeXSizeSwitchNames[NUM_SIZE + 4] =
  82 { "tiny", "scriptsize", "footnotesize", "small", "normalsize", "large",
  83   "Large", "LARGE", "huge", "Huge", "error8", "error9", "error10", "error11" };
  84
  85 } // namespace
  86
  87
  88 Font::Font(FontInfo bits, Language const * l)
  89         : bits_(bits), lang_(l), open_encoding_(false)
  90 {
  91         if (!lang_)
  92                 lang_ = default_language;
  93 }
  94
  95
  96 bool Font::isRightToLeft() const
  97 {
  98         return lang_->rightToLeft();
  99 }
 100
 101
 102 bool Font::isVisibleRightToLeft() const
 103 {
 104         return (lang_->rightToLeft() &&
 105                 bits_.number() != FONT_ON);
 106 }
 107
 108
 109 void Font::setLanguage(Language const * l)
 110 {
 111         lang_ = l;
 112 }
 113
 114
 115 /// Updates font settings according to request
 116 void Font::update(Font const & newfont,
 117                      Language const * default_lang,
 118                      bool toggleall)
 119 {
 120         bits_.update(newfont.fontInfo(), toggleall);
 121
 122         if (newfont.language() == language() && toggleall)
 123                 if (language() == default_lang)
 124                         setLanguage(default_language);
 125                 else
 126                         setLanguage(default_lang);
 127         else if (newfont.language() == reset_language)
 128                 setLanguage(default_lang);
 129         else if (newfont.language() != ignore_language)
 130                 setLanguage(newfont.language());
 131 }
 132
 133
 134 docstring const Font::stateText(BufferParams * params, bool const terse) const
 135 {
 136         odocstringstream os;
 137         os << bits_.stateText(terse);
 138         if ((!params || (language() != params->language))
 139             && (!terse || language() != ignore_language)) {
 140                 // reset_language is a null pointer!
 141                 os << bformat(_("Language: %1$s, "),
 142                               (language() == reset_language) ? _("Default")
 143                                                              : _(language()->display()));
 144         }
 145         if (bits_.number() != FONT_OFF)
 146                 os << "  " << bformat(_("Number %1$s"),
 147                               _(GUIMiscNames[bits_.number()]));
 148         return rtrim(os.str(), ", ");
 149 }
 150
 151
 152 // Returns size in latex format
 153 string const Font::latexSize() const
 154 {
 155         return LaTeXSizeSwitchNames[bits_.size()];
 156 }
 157
 158
 159 /// Writes the changes from this font to orgfont in .lyx format in file
 160 void Font::lyxWriteChanges(Font const & orgfont,
 161                               ostream & os) const
 162 {
 163         os << "\n";
 164         if (orgfont.fontInfo().family() != bits_.family())
 165                 os << "\\family " << LyXFamilyNames[bits_.family()] << "\n";
 166         if (orgfont.fontInfo().series() != bits_.series())
 167                 os << "\\series " << LyXSeriesNames[bits_.series()] << "\n";
 168         if (orgfont.fontInfo().shape() != bits_.shape())
 169                 os << "\\shape " << LyXShapeNames[bits_.shape()] << "\n";
 170         if (orgfont.fontInfo().size() != bits_.size())
 171                 os << "\\size " << LyXSizeNames[bits_.size()] << "\n";
 172         // FIXME: shall style be handled there? Probably not.
 173         if (orgfont.fontInfo().emph() != bits_.emph())
 174                 os << "\\emph " << LyXMiscNames[bits_.emph()] << "\n";
 175         if (orgfont.fontInfo().number() != bits_.number())
 176                 os << "\\numeric " << LyXMiscNames[bits_.number()] << "\n";
 177         if (orgfont.fontInfo().nospellcheck() != bits_.nospellcheck())
 178                 os << "\\nospellcheck " << LyXMiscNames[bits_.nospellcheck()] << "\n";
 179         if (orgfont.fontInfo().underbar() != bits_.underbar()) {
 180                 // This is only for backwards compatibility
 181                 switch (bits_.underbar()) {
 182                 case FONT_OFF:  os << "\\bar no\n"; break;
 183                 case FONT_ON:        os << "\\bar under\n"; break;
 184                 case FONT_TOGGLE:       lyxerr << "Font::lyxWriteFontChanges: "
 185                                         "FONT_TOGGLE should not appear here!"
 186                                        << endl;
 187                 break;
 188                 case FONT_INHERIT:   os << "\\bar default\n"; break;
 189                 case FONT_IGNORE:    lyxerr << "Font::lyxWriteFontChanges: "
 190                                         "IGNORE should not appear here!"
 191                                        << endl;
 192                 break;
 193                 }
 194         }
 195         if (orgfont.fontInfo().strikeout() != bits_.strikeout()) {
 196                 os << "\\strikeout " << LyXMiscNames[bits_.strikeout()] << "\n";
 197         }
 198         if (orgfont.fontInfo().xout() != bits_.xout()) {
 199                 os << "\\xout " << LyXMiscNames[bits_.xout()] << "\n";
 200         }
 201         if (orgfont.fontInfo().uuline() != bits_.uuline()) {
 202                 os << "\\uuline " << LyXMiscNames[bits_.uuline()] << "\n";
 203         }
 204         if (orgfont.fontInfo().uwave() != bits_.uwave()) {
 205                 os << "\\uwave " << LyXMiscNames[bits_.uwave()] << "\n";
 206         }
 207         if (orgfont.fontInfo().noun() != bits_.noun()) {
 208                 os << "\\noun " << LyXMiscNames[bits_.noun()] << "\n";
 209         }
 210         if (orgfont.fontInfo().color() != bits_.color())
 211                 os << "\\color " << lcolor.getLyXName(bits_.color()) << '\n';
 212         // FIXME: uncomment this when we support background.
 213         //if (orgfont.fontInfo().background() != bits_.background())
 214         //      os << "\\color " << lcolor.getLyXName(bits_.background()) << '\n';
 215         if (orgfont.language() != language() &&
 216             language() != latex_language) {
 217                 if (language())
 218                         os << "\\lang " << language()->lang() << "\n";
 219                 else
 220                         os << "\\lang unknown\n";
 221         }
 222 }
 223
 224
 225 /// Writes the head of the LaTeX needed to impose this font
 226 // Returns number of chars written.
 227 int Font::latexWriteStartChanges(otexstream & os, BufferParams const & bparams,
 228                                     OutputParams const & runparams,
 229                                     Font const & base,
 230                                     Font const & prev,
 231                                     bool non_inherit_inset,
 232                                     bool needs_cprotection) const
 233 {
 234         int count = 0;
 235
 236         // polyglossia or babel?
 237         if (runparams.use_polyglossia
 238             && language()->lang() != base.language()->lang()
 239             && language() != prev.language()) {
 240                 if (!language()->polyglossia().empty()) {
 241                         string tmp;
 242                         if (needs_cprotection)
 243                                 tmp += "\\cprotect";
 244                         tmp += "\\text" + language()->polyglossia();
 245                         if (!language()->polyglossiaOpts().empty()) {
 246                                 tmp += "[" + language()->polyglossiaOpts() + "]";
 247                                 if (runparams.use_hyperref && runparams.moving_arg) {
 248                                         // We need to strip the command for
 249                                         // the pdf string, see #11813
 250                                         string tmpp;
 251                                         if (needs_cprotection)
 252                                                 tmpp = "\\cprotect";
 253                                         tmp = tmpp + "\\texorpdfstring{" + tmp + "}{}";
 254                                 }
 255                         }
 256                         tmp += "{";
 257                         os << from_ascii(tmp);
 258                         count += tmp.length();
 259                         pushLanguageName(language()->polyglossia(), true);
 260                 } else if (language()->encoding()->package() != Encoding::CJK) {
 261                         os << '{';
 262                         count += 1;
 263                 }
 264         } else if (language()->babel() != base.language()->babel() &&
 265             language() != prev.language()) {
 266                 if (language()->lang() == "farsi") {
 267                         if (needs_cprotection) {
 268                                 os << "\\cprotect";
 269                                 count += 9;
 270                         }
 271                         os << "\\textFR{";
 272                         count += 8;
 273                 } else if (!isRightToLeft() &&
 274                             base.language()->lang() == "farsi") {
 275                         if (needs_cprotection) {
 276                                 os << "\\cprotect";
 277                                 count += 9;
 278                         }
 279                         os << "\\textLR{";
 280                         count += 8;
 281                 } else if (language()->lang() == "arabic_arabi") {
 282                         if (needs_cprotection) {
 283                                 os << "\\cprotect";
 284                                 count += 9;
 285                         }
 286                         os << "\\textAR{";
 287                         count += 8;
 288                 } else if (!isRightToLeft() &&
 289                                 base.language()->lang() == "arabic_arabi") {
 290                         if (needs_cprotection) {
 291                                 os << "\\cprotect";
 292                                 count += 9;
 293                         }
 294                         os << "\\textLR{";
 295                         count += 8;
 296                 // currently the remaining RTL languages are arabic_arabtex and hebrew
 297                 } else if (isRightToLeft() != prev.isRightToLeft()) {
 298                         if (needs_cprotection) {
 299                                 os << "\\cprotect";
 300                                 count += 9;
 301                         }
 302                         if (isRightToLeft()) {
 303                                 os << "\\R{";
 304                                 count += 3;
 305                         } else {
 306                                 os << "\\L{";
 307                                 count += 3;
 308                         }
 309                 } else if (!language()->babel().empty()) {
 310                         string const tmp =
 311                                 subst(lyxrc.language_command_local,
 312                                       "$$lang", language()->babel());
 313                         os << from_ascii(tmp);
 314                         count += tmp.length();
 315                         if (!lyxrc.language_command_end.empty())
 316                                 pushLanguageName(language()->babel(), true);
 317                 } else if (language()->encoding()->package() != Encoding::CJK) {
 318                         os << '{';
 319                         count += 1;
 320                 }
 321         }
 322
 323         if (language()->encoding()->package() == Encoding::CJK) {
 324                 pair<bool, int> const c = switchEncoding(os.os(), bparams,
 325                                 runparams, *(language()->encoding()));
 326                 if (c.first) {
 327                         open_encoding_ = true;
 328                         count += c.second;
 329                         runparams.encoding = language()->encoding();
 330                 }
 331         }
 332
 333         FontInfo f = bits_;
 334         f.reduce(base.bits_);
 335         FontInfo p = bits_;
 336         p.reduce(prev.bits_);
 337
 338         if (f.size() != INHERIT_SIZE) {
 339                 os << '{';
 340                 ++count;
 341                 os << '\\'
 342                    << LaTeXSizeSwitchNames[f.size()] << termcmd;
 343                 count += strlen(LaTeXSizeSwitchNames[f.size()]) + 1;
 344         }
 345         if (f.family() != INHERIT_FAMILY) {
 346                 if (non_inherit_inset) {
 347                         os << '{';
 348                         ++count;
 349                         os << '\\' << LaTeXFamilySwitchNames[f.family()] << termcmd;
 350                         count += strlen(LaTeXFamilySwitchNames[f.family()]) + 1;
 351                 } else {
 352                         if (needs_cprotection) {
 353                                 os << "\\cprotect";
 354                                 count += 9;
 355                         }
 356                         os << '\\'
 357                            << LaTeXFamilyCommandNames[f.family()]
 358                            << '{';
 359                         count += strlen(LaTeXFamilyCommandNames[f.family()]) + 2;
 360                 }
 361         }
 362         if (f.series() != INHERIT_SERIES) {
 363                 if (non_inherit_inset) {
 364                         os << '{';
 365                         ++count;
 366                         os << '\\' << LaTeXSeriesSwitchNames[f.series()] << termcmd;
 367                         count += strlen(LaTeXSeriesSwitchNames[f.series()]) + 1;
 368                 } else {
 369                         if (needs_cprotection) {
 370                                 os << "\\cprotect";
 371                                 count += 9;
 372                         }
 373                         os << '\\'
 374                            << LaTeXSeriesCommandNames[f.series()]
 375                            << '{';
 376                         count += strlen(LaTeXSeriesCommandNames[f.series()]) + 2;
 377                 }
 378         }
 379         if (f.shape() != INHERIT_SHAPE) {
 380                 if (non_inherit_inset) {
 381                         os << '{';
 382                         ++count;
 383                         os << '\\' << LaTeXShapeSwitchNames[f.shape()] << termcmd;
 384                         count += strlen(LaTeXShapeSwitchNames[f.shape()]) + 1;
 385                 } else {
 386                         if (needs_cprotection) {
 387                                 os << "\\cprotect";
 388                                 count += 9;
 389                         }
 390                         os << '\\'
 391                            << LaTeXShapeCommandNames[f.shape()]
 392                            << '{';
 393                         count += strlen(LaTeXShapeCommandNames[f.shape()]) + 2;
 394                 }
 395         }
 396         if (f.color() != Color_inherit && f.color() != Color_ignore) {
 397                 if (f.color() == Color_none && p.color() != Color_none) {
 398                         // Color none: Close previous color, if any
 399                         os << '}';
 400                         ++count;
 401                 } else if (f.color() != Color_none) {
 402                         if (needs_cprotection) {
 403                                 os << "\\cprotect";
 404                                 count += 9;
 405                         }
 406                         os << "\\textcolor{"
 407                            << from_ascii(lcolor.getLaTeXName(f.color()))
 408                            << "}{";
 409                         count += lcolor.getLaTeXName(f.color()).length() + 13;
 410                 }
 411         }
 412         // FIXME: uncomment this when we support background.
 413         /*
 414         if (f.background() != Color_inherit && f.background() != Color_ignore) {
 415                 os << "\\textcolor{"
 416                    << from_ascii(lcolor.getLaTeXName(f.background()))
 417                    << "}{";
 418                 count += lcolor.getLaTeXName(f.background()).length() + 13;
 419                 env = true; //We have opened a new environment
 420         }
 421         */
 422         // If the current language is Hebrew, Arabic, or Farsi
 423         // the numbers are written Left-to-Right. ArabTeX package
 424         // and bidi (polyglossia with XeTeX) reorder the number automatically
 425         // but the packages used for Hebrew and Farsi (Arabi) do not.
 426         if (!runparams.useBidiPackage()
 427             && !runparams.pass_thru
 428             && bits_.number() == FONT_ON
 429             && prev.fontInfo().number() != FONT_ON
 430             && (language()->lang() == "hebrew"
 431                 || language()->lang() == "farsi"
 432                 || language()->lang() == "arabic_arabi")) {
 433                 if (runparams.use_polyglossia) {
 434                         // LuaTeX/luabidi
 435                         os << "\\LR{";
 436                         count += 5;
 437                 } else {
 438                         os << "{\\beginL ";
 439                         count += 9;
 440                 }
 441         }
 442         if (f.emph() == FONT_ON) {
 443                 if (needs_cprotection) {
 444                         os << "\\cprotect";
 445                         count += 9;
 446                 }
 447                 os << "\\emph{";
 448                 count += 6;
 449         }
 450         // \noun{} is a LyX special macro
 451         if (f.noun() == FONT_ON) {
 452                 if (needs_cprotection) {
 453                         os << "\\cprotect";
 454                         count += 9;
 455                 }
 456                 os << "\\noun{";
 457                 count += 6;
 458         }
 459         // The ulem commands need to be on the deepest nesting level
 460         // because ulem puts every nested group or macro in a box,
 461         // which prevents linebreaks (#8424, #8733)
 462         if (f.underbar() == FONT_ON) {
 463                 if (needs_cprotection) {
 464                         os << "\\cprotect";
 465                         count += 9;
 466                 }
 467                 os << "\\uline{";
 468                 count += 7;
 469                 ++runparams.inulemcmd;
 470         }
 471         if (f.uuline() == FONT_ON) {
 472                 if (needs_cprotection) {
 473                         os << "\\cprotect";
 474                         count += 9;
 475                 }
 476                 os << "\\uuline{";
 477                 count += 8;
 478                 ++runparams.inulemcmd;
 479         }
 480         if (f.strikeout() == FONT_ON) {
 481                 if (needs_cprotection) {
 482                         os << "\\cprotect";
 483                         count += 9;
 484                 }
 485                 os << "\\sout{";
 486                 count += 6;
 487                 ++runparams.inulemcmd;
 488         }
 489         if (f.xout() == FONT_ON) {
 490                 if (needs_cprotection) {
 491                         os << "\\cprotect";
 492                         count += 9;
 493                 }
 494                 os << "\\xout{";
 495                 count += 6;
 496                 ++runparams.inulemcmd;
 497         }
 498         if (f.uwave() == FONT_ON) {
 499                 if (runparams.inulemcmd) {
 500                         // needed with nested uwave in xout
 501                         // see https://tex.stackexchange.com/a/263042
 502                         os << "\\ULdepth=1000pt";
 503                         count += 15;
 504                 }
 505                 if (needs_cprotection) {
 506                         os << "\\cprotect";
 507                         count += 9;
 508                 }
 509                 os << "\\uwave{";
 510                 count += 7;
 511                 ++runparams.inulemcmd;
 512         }
 513         return count;
 514 }
 515
 516
 517 /// Writes ending block of LaTeX needed to close use of this font
 518 // Returns number of chars written
 519 // This one corresponds to latexWriteStartChanges(). (Asger)
 520 int Font::latexWriteEndChanges(otexstream & os, BufferParams const & bparams,
 521                                   OutputParams const & runparams,
 522                                   Font const & base,
 523                                   Font const & next,
 524                                   bool & needPar,
 525                                   bool closeLanguage) const
 526 {
 527         int count = 0;
 528
 529         // reduce the current font to changes against the base
 530         // font (of the layout). We use a temporary for this to
 531         // avoid changing this font instance, as that would break
 532         FontInfo f = bits_;
 533         f.reduce(base.bits_);
 534
 535         if (f.family() != INHERIT_FAMILY) {
 536                 os << '}';
 537                 ++count;
 538         }
 539         if (f.series() != INHERIT_SERIES) {
 540                 os << '}';
 541                 ++count;
 542         }
 543         if (f.shape() != INHERIT_SHAPE) {
 544                 os << '}';
 545                 ++count;
 546         }
 547         if (f.color() != Color_inherit && f.color() != Color_ignore && f.color() != Color_none) {
 548                 os << '}';
 549                 ++count;
 550         }
 551         if (f.emph() == FONT_ON) {
 552                 os << '}';
 553                 ++count;
 554         }
 555         if (f.noun() == FONT_ON) {
 556                 os << '}';
 557                 ++count;
 558         }
 559         if (f.size() != INHERIT_SIZE) {
 560                 // We do not close size group in front of
 561                 // insets with InheritFont() false (as opposed
 562                 // to all other font properties) (#8384)
 563                 if (needPar && !closeLanguage) {
 564                         os << "\\par";
 565                         count += 4;
 566                         needPar = false;
 567                 }
 568                 os << '}';
 569                 ++count;
 570         }
 571         if (f.underbar() == FONT_ON) {
 572                 os << '}';
 573                 ++count;
 574                 --runparams.inulemcmd;
 575         }
 576         if (f.strikeout() == FONT_ON) {
 577                 os << '}';
 578                 ++count;
 579                 --runparams.inulemcmd;
 580         }
 581         if (f.xout() == FONT_ON) {
 582                 os << '}';
 583                 ++count;
 584                 --runparams.inulemcmd;
 585         }
 586         if (f.uuline() == FONT_ON) {
 587                 os << '}';
 588                 ++count;
 589                 --runparams.inulemcmd;
 590         }
 591         if (f.uwave() == FONT_ON) {
 592                 os << '}';
 593                 ++count;
 594                 --runparams.inulemcmd;
 595         }
 596
 597         // If the current language is Hebrew, Arabic, or Farsi
 598         // the numbers are written Left-to-Right. ArabTeX package
 599         // and bidi (polyglossia with XeTeX) reorder the number automatically
 600         // but the packages used for Hebrew and Farsi (Arabi) do not.
 601         if (!runparams.useBidiPackage()
 602             && !runparams.pass_thru
 603             && bits_.number() == FONT_ON
 604             && next.fontInfo().number() != FONT_ON
 605             && (language()->lang() == "hebrew"
 606                 || language()->lang() == "farsi"
 607                 || language()->lang() == "arabic_arabi")) {
 608                 if (runparams.use_polyglossia) {
 609                         // LuaTeX/luabidi
 610                         os << "}";
 611                         count += 1;
 612                 } else {
 613                         os << "\\endL}";
 614                         count += 6;
 615                 }
 616         }
 617
 618         if (open_encoding_) {
 619                 // We need to close the encoding even if it does not change
 620                 // to do correct environment nesting
 621                 Encoding const * const ascii = encodings.fromLyXName("ascii");
 622                 pair<bool, int> const c = switchEncoding(os.os(), bparams,
 623                                 runparams, *ascii);
 624                 LATTEST(c.first);
 625                 count += c.second;
 626                 runparams.encoding = ascii;
 627                 open_encoding_ = false;
 628         }
 629
 630         if (closeLanguage
 631             && language() != base.language() && language() != next.language()
 632             && (language()->encoding()->package() != Encoding::CJK)) {
 633                 os << '}';
 634                 ++count;
 635                 bool const using_begin_end =
 636                         runparams.use_polyglossia ||
 637                                 !lyxrc.language_command_end.empty();
 638                 if (using_begin_end)
 639                         popLanguageName();
 640         }
 641
 642         return count;
 643 }
 644
 645
 646 string Font::toString(bool const toggle) const
 647 {
 648         string const lang = (language() == reset_language)
 649                 ? "reset" : language()->lang();
 650
 651         ostringstream os;
 652         os << "family " << bits_.family() << '\n'
 653            << "series " << bits_.series() << '\n'
 654            << "shape " << bits_.shape() << '\n'
 655            << "size " << bits_.size() << '\n'
 656            << "emph " << bits_.emph() << '\n'
 657            << "underbar " << bits_.underbar() << '\n'
 658            << "strikeout " << bits_.strikeout() << '\n'
 659            << "xout " << bits_.xout() << '\n'
 660            << "uuline " << bits_.uuline() << '\n'
 661            << "uwave " << bits_.uwave() << '\n'
 662            << "noun " << bits_.noun() << '\n'
 663            << "number " << bits_.number() << '\n'
 664            << "nospellcheck " << bits_.nospellcheck() << '\n'
 665            << "color " << bits_.color() << '\n'
 666            << "language " << lang << '\n'
 667            << "toggleall " << convert<string>(toggle);
 668         return os.str();
 669 }
 670
 671
 672 bool Font::fromString(string const & data, bool & toggle)
 673 {
 674         istringstream is(data);
 675         Lexer lex;
 676         lex.setStream(is);
 677
 678         int nset = 0;
 679         while (lex.isOK()) {
 680                 string token;
 681                 if (lex.next())
 682                         token = lex.getString();
 683
 684                 if (token.empty() || !lex.next())
 685                         break;
 686
 687                 if (token == "family") {
 688                         int const next = lex.getInteger();
 689                         bits_.setFamily(FontFamily(next));
 690
 691                 } else if (token == "series") {
 692                         int const next = lex.getInteger();
 693                         bits_.setSeries(FontSeries(next));
 694
 695                 } else if (token == "shape") {
 696                         int const next = lex.getInteger();
 697                         bits_.setShape(FontShape(next));
 698
 699                 } else if (token == "size") {
 700                         int const next = lex.getInteger();
 701                         bits_.setSize(FontSize(next));
 702                 // FIXME: shall style be handled there? Probably not.
 703                 } else if (token == "emph" || token == "underbar"
 704                         || token == "noun" || token == "number"
 705                         || token == "uuline" || token == "uwave"
 706                         || token == "strikeout" || token == "xout"
 707                         || token == "nospellcheck") {
 708
 709                         int const next = lex.getInteger();
 710                         FontState const misc = FontState(next);
 711
 712                         if (token == "emph")
 713                                 bits_.setEmph(misc);
 714                         else if (token == "underbar")
 715                                 bits_.setUnderbar(misc);
 716                         else if (token == "strikeout")
 717                                 bits_.setStrikeout(misc);
 718                         else if (token == "xout")
 719                                 bits_.setXout(misc);
 720                         else if (token == "uuline")
 721                                 bits_.setUuline(misc);
 722                         else if (token == "uwave")
 723                                 bits_.setUwave(misc);
 724                         else if (token == "noun")
 725                                 bits_.setNoun(misc);
 726                         else if (token == "number")
 727                                 bits_.setNumber(misc);
 728                         else if (token == "nospellcheck")
 729                                 bits_.setNoSpellcheck(misc);
 730
 731                 } else if (token == "color") {
 732                         int const next = lex.getInteger();
 733                         bits_.setColor(ColorCode(next));
 734
 735                 /**
 736                 } else if (token == "background") {
 737                         int const next = lex.getInteger();
 738                         bits_.setBackground(ColorCode(next));
 739                 */
 740
 741                 } else if (token == "language") {
 742                         string const next = lex.getString();
 743                         setLanguage(languages.getLanguage(next));
 744
 745                 } else if (token == "toggleall") {
 746                         toggle = lex.getBool();
 747
 748                 } else {
 749                         // Unrecognised token
 750                         break;
 751                 }
 752
 753                 ++nset;
 754         }
 755         return (nset > 0);
 756 }
 757
 758
 759 void Font::validate(LaTeXFeatures & features) const
 760 {
 761         BufferParams const & bparams = features.bufferParams();
 762         Language const * doc_language = bparams.language;
 763
 764         if (bits_.noun() == FONT_ON) {
 765                 LYXERR(Debug::LATEX, "font.noun: " << bits_.noun());
 766                 features.require("noun");
 767                 LYXERR(Debug::LATEX, "Noun enabled. Font: " << to_utf8(stateText()));
 768         }
 769         if (bits_.underbar() == FONT_ON) {
 770                 LYXERR(Debug::LATEX, "font.underline: " << bits_.underbar());
 771                 features.require("ulem");
 772                 LYXERR(Debug::LATEX, "Underline enabled. Font: " << to_utf8(stateText()));
 773         }
 774         if (bits_.strikeout() == FONT_ON) {
 775                 LYXERR(Debug::LATEX, "font.strikeout: " << bits_.strikeout());
 776                 features.require("ulem");
 777                 LYXERR(Debug::LATEX, "Strike out enabled. Font: " << to_utf8(stateText()));
 778         }
 779         if (bits_.xout() == FONT_ON) {
 780                 LYXERR(Debug::LATEX, "font.xout: " << bits_.xout());
 781                 features.require("ulem");
 782                 LYXERR(Debug::LATEX, "Cross out enabled. Font: " << to_utf8(stateText()));
 783         }
 784         if (bits_.uuline() == FONT_ON) {
 785                 LYXERR(Debug::LATEX, "font.uuline: " << bits_.uuline());
 786                 features.require("ulem");
 787                 LYXERR(Debug::LATEX, "Double underline enabled. Font: " << to_utf8(stateText()));
 788         }
 789         if (bits_.uwave() == FONT_ON) {
 790                 LYXERR(Debug::LATEX, "font.uwave: " << bits_.uwave());
 791                 features.require("ulem");
 792                 LYXERR(Debug::LATEX, "Wavy underline enabled. Font: " << to_utf8(stateText()));
 793         }
 794         switch (bits_.color()) {
 795                 case Color_none:
 796                 case Color_inherit:
 797                 case Color_ignore:
 798                         // probably we should put here all interface colors used for
 799                         // font displaying! For now I just add this ones I know of (Jug)
 800                 case Color_latex:
 801                 case Color_notelabel:
 802                         break;
 803                 case Color_brown:
 804                 case Color_darkgray:
 805                 case Color_gray:
 806                 case Color_lightgray:
 807                 case Color_lime:
 808                 case Color_olive:
 809                 case Color_orange:
 810                 case Color_pink:
 811                 case Color_purple:
 812                 case Color_teal:
 813                 case Color_violet:
 814                         features.require("xcolor");
 815                         break;
 816                 default:
 817                         features.require("color");
 818                         LYXERR(Debug::LATEX, "Color enabled. Font: " << to_utf8(stateText()));
 819         }
 820
 821         // FIXME: Do something for background and soul package?
 822
 823         if (((features.usePolyglossia() && lang_->polyglossia() != doc_language->polyglossia())
 824              || (features.useBabel() && lang_->babel() != doc_language->babel())
 825              || (doc_language->encoding()->package() == Encoding::CJK && lang_ != doc_language))
 826             && lang_ != ignore_language
 827             && lang_ != latex_language)
 828         {
 829                 features.useLanguage(lang_);
 830                 LYXERR(Debug::LATEX, "Found language " << lang_->lang());
 831         }
 832 }
 833
 834
 835 ostream & operator<<(ostream & os, FontState fms)
 836 {
 837         return os << int(fms);
 838 }
 839
 840
 841 ostream & operator<<(ostream & os, FontInfo const & f)
 842 {
 843         return os << "font:"
 844                 << " family " << f.family()
 845                 << " series " << f.series()
 846                 << " shape " << f.shape()
 847                 << " size " << f.size()
 848                 << " style " << f.style()
 849                 << " color " << f.color()
 850                 // FIXME: uncomment this when we support background.
 851                 //<< " background " << f.background()
 852                 << " emph " << f.emph()
 853                 << " underbar " << f.underbar()
 854                 << " strikeout " << f.strikeout()
 855                 << " xout " << f.xout()
 856                 << " uuline " << f.uuline()
 857                 << " uwave " << f.uwave()
 858                 << " noun " << f.noun()
 859                 << " number " << f.number()
 860                 << " nospellcheck " << f.nospellcheck();
 861 }
 862
 863
 864 ostream & operator<<(ostream & os, Font const & font)
 865 {
 866         return os << font.bits_
 867                 << " lang: " << (font.lang_ ? font.lang_->lang() : "");
 868 }
 869
 870
 871 } // namespace lyx