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                 if (!runparams.find_effective()) {
 340                         os << '{';
 341                         ++count;
 342                         os << '\\'
 343                            << LaTeXSizeSwitchNames[f.size()] << termcmd;
 344                         count += strlen(LaTeXSizeSwitchNames[f.size()]) + 1;
 345                 }
 346                 else {
 347                         os << '\\'
 348                            << LaTeXSizeSwitchNames[f.size()] << '{';
 349                         count += strlen(LaTeXSizeSwitchNames[f.size()]) + 2;
 350                 }
 351         }
 352         if (f.family() != INHERIT_FAMILY) {
 353                 if (non_inherit_inset) {
 354                         os << '{';
 355                         ++count;
 356                         os << '\\' << LaTeXFamilySwitchNames[f.family()] << termcmd;
 357                         count += strlen(LaTeXFamilySwitchNames[f.family()]) + 1;
 358                 } else {
 359                         if (needs_cprotection) {
 360                                 os << "\\cprotect";
 361                                 count += 9;
 362                         }
 363                         os << '\\'
 364                            << LaTeXFamilyCommandNames[f.family()]
 365                            << '{';
 366                         count += strlen(LaTeXFamilyCommandNames[f.family()]) + 2;
 367                 }
 368         }
 369         if (f.series() != INHERIT_SERIES) {
 370                 if (non_inherit_inset) {
 371                         os << '{';
 372                         ++count;
 373                         os << '\\' << LaTeXSeriesSwitchNames[f.series()] << termcmd;
 374                         count += strlen(LaTeXSeriesSwitchNames[f.series()]) + 1;
 375                 } else {
 376                         if (needs_cprotection) {
 377                                 os << "\\cprotect";
 378                                 count += 9;
 379                         }
 380                         os << '\\'
 381                            << LaTeXSeriesCommandNames[f.series()]
 382                            << '{';
 383                         count += strlen(LaTeXSeriesCommandNames[f.series()]) + 2;
 384                 }
 385         }
 386         if (f.shape() != INHERIT_SHAPE) {
 387                 if (non_inherit_inset) {
 388                         os << '{';
 389                         ++count;
 390                         os << '\\' << LaTeXShapeSwitchNames[f.shape()] << termcmd;
 391                         count += strlen(LaTeXShapeSwitchNames[f.shape()]) + 1;
 392                 } else {
 393                         if (needs_cprotection) {
 394                                 os << "\\cprotect";
 395                                 count += 9;
 396                         }
 397                         os << '\\'
 398                            << LaTeXShapeCommandNames[f.shape()]
 399                            << '{';
 400                         count += strlen(LaTeXShapeCommandNames[f.shape()]) + 2;
 401                 }
 402         }
 403         if (f.color() != Color_inherit && f.color() != Color_ignore) {
 404                 if (f.color() == Color_none && p.color() != Color_none) {
 405                         // Color none: Close previous color, if any
 406                         os << '}';
 407                         ++count;
 408                 } else if (f.color() != Color_none) {
 409                         os << "\\textcolor{"
 410                            << from_ascii(lcolor.getLaTeXName(f.color()))
 411                            << "}{";
 412                         count += lcolor.getLaTeXName(f.color()).length() + 13;
 413                 }
 414         }
 415         // FIXME: uncomment this when we support background.
 416         /*
 417         if (f.background() != Color_inherit && f.background() != Color_ignore) {
 418                 os << "\\textcolor{"
 419                    << from_ascii(lcolor.getLaTeXName(f.background()))
 420                    << "}{";
 421                 count += lcolor.getLaTeXName(f.background()).length() + 13;
 422                 env = true; //We have opened a new environment
 423         }
 424         */
 425         // If the current language is Hebrew, Arabic, or Farsi
 426         // the numbers are written Left-to-Right. ArabTeX package
 427         // and bidi (polyglossia with XeTeX) reorder the number automatically
 428         // but the packages used for Hebrew and Farsi (Arabi) do not.
 429         if (!runparams.useBidiPackage()
 430             && !runparams.pass_thru
 431             && bits_.number() == FONT_ON
 432             && prev.fontInfo().number() != FONT_ON
 433             && (language()->lang() == "hebrew"
 434                 || language()->lang() == "farsi"
 435                 || language()->lang() == "arabic_arabi")) {
 436                 if (runparams.use_polyglossia) {
 437                         // LuaTeX/luabidi
 438                         os << "\\LR{";
 439                         count += 5;
 440                 } else {
 441                         os << "{\\beginL ";
 442                         count += 9;
 443                 }
 444         }
 445         if (f.emph() == FONT_ON) {
 446                 if (needs_cprotection) {
 447                         os << "\\cprotect";
 448                         count += 9;
 449                 }
 450                 os << "\\emph{";
 451                 count += 6;
 452         }
 453         // \noun{} is a LyX special macro
 454         if (f.noun() == FONT_ON) {
 455                 if (needs_cprotection) {
 456                         os << "\\cprotect";
 457                         count += 9;
 458                 }
 459                 os << "\\noun{";
 460                 count += 6;
 461         }
 462         // The ulem commands need to be on the deepest nesting level
 463         // because ulem puts every nested group or macro in a box,
 464         // which prevents linebreaks (#8424, #8733)
 465         if (f.underbar() == FONT_ON) {
 466                 if (needs_cprotection) {
 467                         os << "\\cprotect";
 468                         count += 9;
 469                 }
 470                 os << "\\uline{";
 471                 count += 7;
 472                 ++runparams.inulemcmd;
 473         }
 474         if (f.uuline() == FONT_ON) {
 475                 if (needs_cprotection) {
 476                         os << "\\cprotect";
 477                         count += 9;
 478                 }
 479                 os << "\\uuline{";
 480                 count += 8;
 481                 ++runparams.inulemcmd;
 482         }
 483         if (f.strikeout() == FONT_ON) {
 484                 if (needs_cprotection) {
 485                         os << "\\cprotect";
 486                         count += 9;
 487                 }
 488                 os << "\\sout{";
 489                 count += 6;
 490                 ++runparams.inulemcmd;
 491         }
 492         if (f.xout() == FONT_ON) {
 493                 if (needs_cprotection) {
 494                         os << "\\cprotect";
 495                         count += 9;
 496                 }
 497                 os << "\\xout{";
 498                 count += 6;
 499                 ++runparams.inulemcmd;
 500         }
 501         if (f.uwave() == FONT_ON) {
 502                 if (runparams.inulemcmd) {
 503                         // needed with nested uwave in xout
 504                         // see https://tex.stackexchange.com/a/263042
 505                         os << "\\ULdepth=1000pt";
 506                         count += 15;
 507                 }
 508                 if (needs_cprotection) {
 509                         os << "\\cprotect";
 510                         count += 9;
 511                 }
 512                 os << "\\uwave{";
 513                 count += 7;
 514                 ++runparams.inulemcmd;
 515         }
 516         return count;
 517 }
 518
 519
 520 /// Writes ending block of LaTeX needed to close use of this font
 521 // Returns number of chars written
 522 // This one corresponds to latexWriteStartChanges(). (Asger)
 523 int Font::latexWriteEndChanges(otexstream & os, BufferParams const & bparams,
 524                                   OutputParams const & runparams,
 525                                   Font const & base,
 526                                   Font const & next,
 527                                   bool & needPar,
 528                                   bool closeLanguage) const
 529 {
 530         int count = 0;
 531
 532         // reduce the current font to changes against the base
 533         // font (of the layout). We use a temporary for this to
 534         // avoid changing this font instance, as that would break
 535         FontInfo f = bits_;
 536         f.reduce(base.bits_);
 537
 538         if (f.family() != INHERIT_FAMILY) {
 539                 os << '}';
 540                 ++count;
 541         }
 542         if (f.series() != INHERIT_SERIES) {
 543                 os << '}';
 544                 ++count;
 545         }
 546         if (f.shape() != INHERIT_SHAPE) {
 547                 os << '}';
 548                 ++count;
 549         }
 550         if (f.color() != Color_inherit && f.color() != Color_ignore && f.color() != Color_none) {
 551                 os << '}';
 552                 ++count;
 553         }
 554         if (f.emph() == FONT_ON) {
 555                 os << '}';
 556                 ++count;
 557         }
 558         if (f.noun() == FONT_ON) {
 559                 os << '}';
 560                 ++count;
 561         }
 562         if (f.size() != INHERIT_SIZE) {
 563                 // We do not close size group in front of
 564                 // insets with InheritFont() false (as opposed
 565                 // to all other font properties) (#8384)
 566                 if (needPar && !closeLanguage) {
 567                         os << "\\par";
 568                         count += 4;
 569                         needPar = false;
 570                 }
 571                 os << '}';
 572                 ++count;
 573         }
 574         if (f.underbar() == FONT_ON) {
 575                 os << '}';
 576                 ++count;
 577                 --runparams.inulemcmd;
 578         }
 579         if (f.strikeout() == FONT_ON) {
 580                 os << '}';
 581                 ++count;
 582                 --runparams.inulemcmd;
 583         }
 584         if (f.xout() == FONT_ON) {
 585                 os << '}';
 586                 ++count;
 587                 --runparams.inulemcmd;
 588         }
 589         if (f.uuline() == FONT_ON) {
 590                 os << '}';
 591                 ++count;
 592                 --runparams.inulemcmd;
 593         }
 594         if (f.uwave() == FONT_ON) {
 595                 os << '}';
 596                 ++count;
 597                 --runparams.inulemcmd;
 598         }
 599
 600         // If the current language is Hebrew, Arabic, or Farsi
 601         // the numbers are written Left-to-Right. ArabTeX package
 602         // and bidi (polyglossia with XeTeX) reorder the number automatically
 603         // but the packages used for Hebrew and Farsi (Arabi) do not.
 604         if (!runparams.useBidiPackage()
 605             && !runparams.pass_thru
 606             && bits_.number() == FONT_ON
 607             && next.fontInfo().number() != FONT_ON
 608             && (language()->lang() == "hebrew"
 609                 || language()->lang() == "farsi"
 610                 || language()->lang() == "arabic_arabi")) {
 611                 if (runparams.use_polyglossia) {
 612                         // LuaTeX/luabidi
 613                         os << "}";
 614                         count += 1;
 615                 } else {
 616                         os << "\\endL}";
 617                         count += 6;
 618                 }
 619         }
 620
 621         if (open_encoding_) {
 622                 // We need to close the encoding even if it does not change
 623                 // to do correct environment nesting
 624                 Encoding const * const ascii = encodings.fromLyXName("ascii");
 625                 pair<bool, int> const c = switchEncoding(os.os(), bparams,
 626                                 runparams, *ascii);
 627                 LATTEST(c.first);
 628                 count += c.second;
 629                 runparams.encoding = ascii;
 630                 open_encoding_ = false;
 631         }
 632
 633         if (closeLanguage
 634             && language() != base.language() && language() != next.language()
 635             && (language()->encoding()->package() != Encoding::CJK)) {
 636                 os << '}';
 637                 ++count;
 638                 bool const using_begin_end =
 639                         runparams.use_polyglossia ||
 640                                 !lyxrc.language_command_end.empty();
 641                 if (using_begin_end && !languageStackEmpty())
 642                         popLanguageName();
 643         }
 644
 645         return count;
 646 }
 647
 648
 649 string Font::toString(bool const toggle) const
 650 {
 651         string const lang = (language() == reset_language)
 652                 ? "reset" : language()->lang();
 653
 654         ostringstream os;
 655         os << "family " << bits_.family() << '\n'
 656            << "series " << bits_.series() << '\n'
 657            << "shape " << bits_.shape() << '\n'
 658            << "size " << bits_.size() << '\n'
 659            << "emph " << bits_.emph() << '\n'
 660            << "underbar " << bits_.underbar() << '\n'
 661            << "strikeout " << bits_.strikeout() << '\n'
 662            << "xout " << bits_.xout() << '\n'
 663            << "uuline " << bits_.uuline() << '\n'
 664            << "uwave " << bits_.uwave() << '\n'
 665            << "noun " << bits_.noun() << '\n'
 666            << "number " << bits_.number() << '\n'
 667            << "nospellcheck " << bits_.nospellcheck() << '\n'
 668            << "color " << bits_.color() << '\n'
 669            << "language " << lang << '\n'
 670            << "toggleall " << convert<string>(toggle);
 671         return os.str();
 672 }
 673
 674
 675 bool Font::fromString(string const & data, bool & toggle)
 676 {
 677         istringstream is(data);
 678         Lexer lex;
 679         lex.setStream(is);
 680
 681         int nset = 0;
 682         while (lex.isOK()) {
 683                 string token;
 684                 if (lex.next())
 685                         token = lex.getString();
 686
 687                 if (token.empty() || !lex.next())
 688                         break;
 689
 690                 if (token == "family") {
 691                         int const next = lex.getInteger();
 692                         bits_.setFamily(FontFamily(next));
 693
 694                 } else if (token == "series") {
 695                         int const next = lex.getInteger();
 696                         bits_.setSeries(FontSeries(next));
 697
 698                 } else if (token == "shape") {
 699                         int const next = lex.getInteger();
 700                         bits_.setShape(FontShape(next));
 701
 702                 } else if (token == "size") {
 703                         int const next = lex.getInteger();
 704                         bits_.setSize(FontSize(next));
 705                 // FIXME: shall style be handled there? Probably not.
 706                 } else if (token == "emph" || token == "underbar"
 707                         || token == "noun" || token == "number"
 708                         || token == "uuline" || token == "uwave"
 709                         || token == "strikeout" || token == "xout"
 710                         || token == "nospellcheck") {
 711
 712                         int const next = lex.getInteger();
 713                         FontState const misc = FontState(next);
 714
 715                         if (token == "emph")
 716                                 bits_.setEmph(misc);
 717                         else if (token == "underbar")
 718                                 bits_.setUnderbar(misc);
 719                         else if (token == "strikeout")
 720                                 bits_.setStrikeout(misc);
 721                         else if (token == "xout")
 722                                 bits_.setXout(misc);
 723                         else if (token == "uuline")
 724                                 bits_.setUuline(misc);
 725                         else if (token == "uwave")
 726                                 bits_.setUwave(misc);
 727                         else if (token == "noun")
 728                                 bits_.setNoun(misc);
 729                         else if (token == "number")
 730                                 bits_.setNumber(misc);
 731                         else if (token == "nospellcheck")
 732                                 bits_.setNoSpellcheck(misc);
 733
 734                 } else if (token == "color") {
 735                         int const next = lex.getInteger();
 736                         bits_.setColor(ColorCode(next));
 737
 738                 /**
 739                 } else if (token == "background") {
 740                         int const next = lex.getInteger();
 741                         bits_.setBackground(ColorCode(next));
 742                 */
 743
 744                 } else if (token == "language") {
 745                         string const next = lex.getString();
 746                         setLanguage(languages.getLanguage(next));
 747
 748                 } else if (token == "toggleall") {
 749                         toggle = lex.getBool();
 750
 751                 } else {
 752                         // Unrecognised token
 753                         break;
 754                 }
 755
 756                 ++nset;
 757         }
 758         return (nset > 0);
 759 }
 760
 761
 762 void Font::validate(LaTeXFeatures & features) const
 763 {
 764         BufferParams const & bparams = features.bufferParams();
 765         Language const * doc_language = bparams.language;
 766
 767         if (bits_.noun() == FONT_ON) {
 768                 LYXERR(Debug::OUTFILE, "font.noun: " << bits_.noun());
 769                 features.require("noun");
 770                 LYXERR(Debug::OUTFILE, "Noun enabled. Font: " << to_utf8(stateText()));
 771         }
 772         if (bits_.underbar() == FONT_ON) {
 773                 LYXERR(Debug::OUTFILE, "font.underline: " << bits_.underbar());
 774                 features.require("ulem");
 775                 LYXERR(Debug::OUTFILE, "Underline enabled. Font: " << to_utf8(stateText()));
 776         }
 777         if (bits_.strikeout() == FONT_ON) {
 778                 LYXERR(Debug::OUTFILE, "font.strikeout: " << bits_.strikeout());
 779                 features.require("ulem");
 780                 LYXERR(Debug::OUTFILE, "Strike out enabled. Font: " << to_utf8(stateText()));
 781         }
 782         if (bits_.xout() == FONT_ON) {
 783                 LYXERR(Debug::OUTFILE, "font.xout: " << bits_.xout());
 784                 features.require("ulem");
 785                 LYXERR(Debug::OUTFILE, "Cross out enabled. Font: " << to_utf8(stateText()));
 786         }
 787         if (bits_.uuline() == FONT_ON) {
 788                 LYXERR(Debug::OUTFILE, "font.uuline: " << bits_.uuline());
 789                 features.require("ulem");
 790                 LYXERR(Debug::OUTFILE, "Double underline enabled. Font: " << to_utf8(stateText()));
 791         }
 792         if (bits_.uwave() == FONT_ON) {
 793                 LYXERR(Debug::OUTFILE, "font.uwave: " << bits_.uwave());
 794                 features.require("ulem");
 795                 LYXERR(Debug::OUTFILE, "Wavy underline enabled. Font: " << to_utf8(stateText()));
 796         }
 797         switch (bits_.color()) {
 798                 case Color_none:
 799                 case Color_inherit:
 800                 case Color_ignore:
 801                         // probably we should put here all interface colors used for
 802                         // font displaying! For now I just add this ones I know of (Jug)
 803                 case Color_latex:
 804                 case Color_notelabel:
 805                         break;
 806                 case Color_brown:
 807                 case Color_darkgray:
 808                 case Color_gray:
 809                 case Color_lightgray:
 810                 case Color_lime:
 811                 case Color_olive:
 812                 case Color_orange:
 813                 case Color_pink:
 814                 case Color_purple:
 815                 case Color_teal:
 816                 case Color_violet:
 817                         features.require("xcolor");
 818                         break;
 819                 default:
 820                         features.require("color");
 821                         LYXERR(Debug::OUTFILE, "Color enabled. Font: " << to_utf8(stateText()));
 822         }
 823
 824         // FIXME: Do something for background and soul package?
 825
 826         if (((features.usePolyglossia() && lang_->polyglossia() != doc_language->polyglossia())
 827              || (features.useBabel() && lang_->babel() != doc_language->babel())
 828              || (doc_language->encoding()->package() == Encoding::CJK && lang_ != doc_language))
 829             && lang_ != ignore_language
 830             && lang_ != latex_language)
 831         {
 832                 features.useLanguage(lang_);
 833                 LYXERR(Debug::OUTFILE, "Found language " << lang_->lang());
 834         }
 835 }
 836
 837
 838 ostream & operator<<(ostream & os, FontState fms)
 839 {
 840         return os << int(fms);
 841 }
 842
 843
 844 ostream & operator<<(ostream & os, FontInfo const & f)
 845 {
 846         return os << "font:"
 847                 << " family " << f.family()
 848                 << " series " << f.series()
 849                 << " shape " << f.shape()
 850                 << " size " << f.size()
 851                 << " style " << f.style()
 852                 << " color " << f.color()
 853                 // FIXME: uncomment this when we support background.
 854                 //<< " background " << f.background()
 855                 << " emph " << f.emph()
 856                 << " underbar " << f.underbar()
 857                 << " strikeout " << f.strikeout()
 858                 << " xout " << f.xout()
 859                 << " uuline " << f.uuline()
 860                 << " uwave " << f.uwave()
 861                 << " noun " << f.noun()
 862                 << " number " << f.number()
 863                 << " nospellcheck " << f.nospellcheck();
 864 }
 865
 866
 867 ostream & operator<<(ostream & os, Font const & font)
 868 {
 869         return os << font.bits_
 870                 << " lang: " << (font.lang_ ? font.lang_->lang() : "");
 871 }
 872
 873
 874 } // namespace lyx