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