src/lyxfont.C

   1 /**
   2  * \file src/lyxfont.C
   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 "lyxfont.h"
  18
  19 #include "bufferparams.h" // stateText
  20 #include "debug.h"
  21 #include "gettext.h"
  22 #include "language.h"
  23 #include "LColor.h"
  24 #include "lyxlex.h"
  25 #include "lyxrc.h"
  26
  27 #include "support/lstrings.h"
  28
  29 #include <sstream>
  30
  31 using lyx::support::ascii_lowercase;
  32 using lyx::support::bformat;
  33 using lyx::support::rtrim;
  34 using lyx::support::subst;
  35
  36 using std::endl;
  37 using std::string;
  38 using std::ostream;
  39 using std::ostringstream;
  40
  41 #ifndef CXX_GLOBAL_CSTD
  42 using std::strlen;
  43 #endif
  44
  45 //
  46 // Names for the GUI
  47 //
  48
  49 namespace {
  50
  51 char const * GUIFamilyNames[LyXFont::NUM_FAMILIES + 2 /* default & error */] =
  52 { N_("Roman"), N_("Sans Serif"), N_("Typewriter"), N_("Symbol"),
  53   "cmr", "cmsy", "cmm", "cmex", "msa", "msb", "eufrak", "wasy",
  54   N_("Inherit"), N_("Ignore") };
  55
  56 char const * GUISeriesNames[4] =
  57 { N_("Medium"), N_("Bold"), N_("Inherit"), N_("Ignore") };
  58
  59 char const * GUIShapeNames[6] =
  60 { N_("Upright"), N_("Italic"), N_("Slanted"), N_("Smallcaps"), N_("Inherit"),
  61   N_("Ignore") };
  62
  63 char const * GUISizeNames[14] =
  64 { N_("Tiny"), N_("Smallest"), N_("Smaller"), N_("Small"), N_("Normal"), N_("Large"),
  65   N_("Larger"), N_("Largest"), N_("Huge"), N_("Huger"), N_("Increase"), N_("Decrease"),
  66   N_("Inherit"), N_("Ignore") };
  67
  68 char const * GUIMiscNames[5] =
  69 { N_("Off"), N_("On"), N_("Toggle"), N_("Inherit"), N_("Ignore") };
  70
  71
  72 //
  73 // Strings used to read and write .lyx format files
  74 //
  75 char const * LyXFamilyNames[LyXFont::NUM_FAMILIES + 2 /* default & error */] =
  76 { "roman", "sans", "typewriter", "symbol",
  77   "cmr", "cmsy", "cmm", "cmex", "msa", "msb", "eufrak", "wasy",
  78   "default", "error" };
  79
  80 char const * LyXSeriesNames[4] =
  81 { "medium", "bold", "default", "error" };
  82
  83 char const * LyXShapeNames[6] =
  84 { "up", "italic", "slanted", "smallcaps", "default", "error" };
  85
  86 char const * LyXSizeNames[14] =
  87 { "tiny", "scriptsize", "footnotesize", "small", "normal", "large",
  88   "larger", "largest", "huge", "giant",
  89   "increase", "decrease", "default", "error" };
  90
  91 char const * LyXMiscNames[5] =
  92 { "off", "on", "toggle", "default", "error" };
  93
  94 //
  95 // Strings used to write LaTeX files
  96 //
  97 char const * LaTeXFamilyNames[6] =
  98 { "textrm", "textsf", "texttt", "error1", "error2", "error3" };
  99
 100 char const * LaTeXSeriesNames[4] =
 101 { "textmd", "textbf", "error4", "error5" };
 102
 103 char const * LaTeXShapeNames[6] =
 104 { "textup", "textit", "textsl", "textsc", "error6", "error7" };
 105
 106 char const * LaTeXSizeNames[14] =
 107 { "tiny", "scriptsize", "footnotesize", "small", "normalsize", "large",
 108   "Large", "LARGE", "huge", "Huge", "error8", "error9", "error10", "error11" };
 109
 110 } // namespace anon
 111
 112
 113 // Initialize static member
 114 LyXFont::FontBits LyXFont::sane = {
 115         ROMAN_FAMILY,
 116         MEDIUM_SERIES,
 117         UP_SHAPE,
 118         SIZE_NORMAL,
 119         LColor::none,
 120         OFF,
 121         OFF,
 122         OFF,
 123         OFF };
 124
 125 // Initialize static member
 126 LyXFont::FontBits LyXFont::inherit = {
 127         INHERIT_FAMILY,
 128         INHERIT_SERIES,
 129         INHERIT_SHAPE,
 130         INHERIT_SIZE,
 131         LColor::inherit,
 132         INHERIT,
 133         INHERIT,
 134         INHERIT,
 135         OFF };
 136
 137 // Initialize static member
 138 LyXFont::FontBits LyXFont::ignore = {
 139         IGNORE_FAMILY,
 140         IGNORE_SERIES,
 141         IGNORE_SHAPE,
 142         IGNORE_SIZE,
 143         LColor::ignore,
 144         IGNORE,
 145         IGNORE,
 146         IGNORE,
 147         IGNORE };
 148
 149
 150 bool operator==(LyXFont::FontBits const & lhs,
 151                 LyXFont::FontBits const & rhs)
 152 {
 153         return lhs.family == rhs.family &&
 154                 lhs.series == rhs.series &&
 155                 lhs.shape == rhs.shape &&
 156                 lhs.size == rhs.size &&
 157                 lhs.color == rhs.color &&
 158                 lhs.emph == rhs.emph &&
 159                 lhs.underbar == rhs.underbar &&
 160                 lhs.noun == rhs.noun &&
 161                 lhs.number == rhs.number;
 162 }
 163
 164
 165 LyXFont::LyXFont()
 166         : bits(sane), lang(default_language)
 167 {}
 168
 169
 170 LyXFont::LyXFont(LyXFont::FONT_INIT1)
 171         : bits(inherit), lang(default_language)
 172 {}
 173
 174
 175 LyXFont::LyXFont(LyXFont::FONT_INIT2)
 176         : bits(ignore), lang(ignore_language)
 177 {}
 178
 179
 180 LyXFont::LyXFont(LyXFont::FONT_INIT3)
 181         : bits(sane), lang(default_language)
 182 {}
 183
 184
 185 LyXFont::LyXFont(LyXFont::FONT_INIT1, Language const * l)
 186         : bits(inherit), lang(l)
 187 {}
 188
 189
 190 LyXFont::LyXFont(LyXFont::FONT_INIT2, Language const * l)
 191         : bits(ignore), lang(l)
 192 {}
 193
 194
 195 LyXFont::LyXFont(LyXFont::FONT_INIT3, Language const * l)
 196         : bits(sane), lang(l)
 197 {}
 198
 199
 200
 201 LColor_color LyXFont::color() const
 202 {
 203         return LColor::color(bits.color);
 204 }
 205
 206
 207 bool LyXFont::isRightToLeft() const
 208 {
 209         return lang->rightToLeft();
 210 }
 211
 212
 213 bool LyXFont::isVisibleRightToLeft() const
 214 {
 215         return (lang->rightToLeft() &&
 216                 number() != ON);
 217 }
 218
 219
 220 void LyXFont::setFamily(LyXFont::FONT_FAMILY f)
 221 {
 222         bits.family = f;
 223 }
 224
 225
 226 void LyXFont::setSeries(LyXFont::FONT_SERIES s)
 227 {
 228         bits.series = s;
 229 }
 230
 231
 232 void LyXFont::setShape(LyXFont::FONT_SHAPE s)
 233 {
 234         bits.shape = s;
 235 }
 236
 237
 238 void LyXFont::setSize(LyXFont::FONT_SIZE s)
 239 {
 240         bits.size = s;
 241 }
 242
 243
 244 void LyXFont::setEmph(LyXFont::FONT_MISC_STATE e)
 245 {
 246         bits.emph = e;
 247 }
 248
 249
 250 void LyXFont::setUnderbar(LyXFont::FONT_MISC_STATE u)
 251 {
 252         bits.underbar = u;
 253 }
 254
 255
 256 void LyXFont::setNoun(LyXFont::FONT_MISC_STATE n)
 257 {
 258         bits.noun = n;
 259 }
 260
 261
 262 void LyXFont::setColor(LColor_color c)
 263 {
 264         bits.color = int(c);
 265 }
 266
 267
 268 void LyXFont::setLanguage(Language const * l)
 269 {
 270         lang = l;
 271 }
 272
 273
 274 void LyXFont::setNumber(LyXFont::FONT_MISC_STATE n)
 275 {
 276         bits.number = n;
 277 }
 278
 279
 280 /// Decreases font size by one
 281 LyXFont & LyXFont::decSize()
 282 {
 283         switch (size()) {
 284         case SIZE_HUGER:        setSize(SIZE_HUGE);     break;
 285         case SIZE_HUGE:         setSize(SIZE_LARGEST);  break;
 286         case SIZE_LARGEST:      setSize(SIZE_LARGER);   break;
 287         case SIZE_LARGER:       setSize(SIZE_LARGE);    break;
 288         case SIZE_LARGE:        setSize(SIZE_NORMAL);   break;
 289         case SIZE_NORMAL:       setSize(SIZE_SMALL);    break;
 290         case SIZE_SMALL:        setSize(SIZE_FOOTNOTE); break;
 291         case SIZE_FOOTNOTE:     setSize(SIZE_SCRIPT);   break;
 292         case SIZE_SCRIPT:       setSize(SIZE_TINY);     break;
 293         case SIZE_TINY:         break;
 294         case INCREASE_SIZE:
 295                 lyxerr << "Can't LyXFont::decSize on INCREASE_SIZE" << endl;
 296                 break;
 297         case DECREASE_SIZE:
 298                 lyxerr <<"Can't LyXFont::decSize on DECREASE_SIZE" << endl;
 299                 break;
 300         case INHERIT_SIZE:
 301                 lyxerr <<"Can't LyXFont::decSize on INHERIT_SIZE" << endl;
 302                 break;
 303         case IGNORE_SIZE:
 304                 lyxerr <<"Can't LyXFont::decSize on IGNORE_SIZE" << endl;
 305                 break;
 306         }
 307         return *this;
 308 }
 309
 310
 311 /// Increases font size by one
 312 LyXFont & LyXFont::incSize()
 313 {
 314         switch (size()) {
 315         case SIZE_HUGER:        break;
 316         case SIZE_HUGE:         setSize(SIZE_HUGER);    break;
 317         case SIZE_LARGEST:      setSize(SIZE_HUGE);     break;
 318         case SIZE_LARGER:       setSize(SIZE_LARGEST);  break;
 319         case SIZE_LARGE:        setSize(SIZE_LARGER);   break;
 320         case SIZE_NORMAL:       setSize(SIZE_LARGE);    break;
 321         case SIZE_SMALL:        setSize(SIZE_NORMAL);   break;
 322         case SIZE_FOOTNOTE:     setSize(SIZE_SMALL);    break;
 323         case SIZE_SCRIPT:       setSize(SIZE_FOOTNOTE); break;
 324         case SIZE_TINY:         setSize(SIZE_SCRIPT);   break;
 325         case INCREASE_SIZE:
 326                 lyxerr <<"Can't LyXFont::incSize on INCREASE_SIZE" << endl;
 327                 break;
 328         case DECREASE_SIZE:
 329                 lyxerr <<"Can't LyXFont::incSize on DECREASE_SIZE" << endl;
 330                 break;
 331         case INHERIT_SIZE:
 332                 lyxerr <<"Can't LyXFont::incSize on INHERIT_SIZE" << endl;
 333                 break;
 334         case IGNORE_SIZE:
 335                 lyxerr <<"Can't LyXFont::incSize on IGNORE_SIZE" << endl;
 336                 break;
 337         }
 338         return *this;
 339 }
 340
 341
 342 /// Updates a misc setting according to request
 343 LyXFont::FONT_MISC_STATE LyXFont::setMisc(FONT_MISC_STATE newfont,
 344                                           FONT_MISC_STATE org)
 345 {
 346         if (newfont == TOGGLE) {
 347                 if (org == ON)
 348                         return OFF;
 349                 else if (org == OFF)
 350                         return ON;
 351                 else {
 352                         lyxerr <<"LyXFont::setMisc: Need state"
 353                                 " ON or OFF to toggle. Setting to ON" << endl;
 354                         return ON;
 355                 }
 356         } else if (newfont == IGNORE)
 357                 return org;
 358         else
 359                 return newfont;
 360 }
 361
 362
 363 /// Updates font settings according to request
 364 void LyXFont::update(LyXFont const & newfont,
 365                      Language const * document_language,
 366                      bool toggleall)
 367 {
 368         if (newfont.family() == family() && toggleall)
 369                 setFamily(INHERIT_FAMILY); // toggle 'back'
 370         else if (newfont.family() != IGNORE_FAMILY)
 371                 setFamily(newfont.family());
 372         // else it's IGNORE_SHAPE
 373
 374         // "Old" behaviour: "Setting" bold will toggle bold on/off.
 375         switch (newfont.series()) {
 376         case BOLD_SERIES:
 377                 // We toggle...
 378                 if (series() == BOLD_SERIES && toggleall)
 379                         setSeries(MEDIUM_SERIES);
 380                 else
 381                         setSeries(BOLD_SERIES);
 382                 break;
 383         case MEDIUM_SERIES:
 384         case INHERIT_SERIES:
 385                 setSeries(newfont.series());
 386                 break;
 387         case IGNORE_SERIES:
 388                 break;
 389         }
 390
 391         if (newfont.shape() == shape() && toggleall)
 392                 setShape(INHERIT_SHAPE); // toggle 'back'
 393         else if (newfont.shape() != IGNORE_SHAPE)
 394                 setShape(newfont.shape());
 395         // else it's IGNORE_SHAPE
 396
 397         if (newfont.size() != IGNORE_SIZE) {
 398                 if (newfont.size() == INCREASE_SIZE)
 399                         incSize();
 400                 else if (newfont.size() == DECREASE_SIZE)
 401                         decSize();
 402                 else
 403                         setSize(newfont.size());
 404         }
 405
 406         setEmph(setMisc(newfont.emph(), emph()));
 407         setUnderbar(setMisc(newfont.underbar(), underbar()));
 408         setNoun(setMisc(newfont.noun(), noun()));
 409
 410         setNumber(setMisc(newfont.number(), number()));
 411         if (newfont.language() == language() && toggleall)
 412                 if (language() == document_language)
 413                         setLanguage(default_language);
 414                 else
 415                         setLanguage(document_language);
 416         else if (newfont.language() != ignore_language)
 417                 setLanguage(newfont.language());
 418
 419         if (newfont.color() == color() && toggleall)
 420                 setColor(LColor::inherit); // toggle 'back'
 421         else if (newfont.color() != LColor::ignore)
 422                 setColor(newfont.color());
 423 }
 424
 425
 426 /// Reduce font to fall back to template where possible
 427 void LyXFont::reduce(LyXFont const & tmplt)
 428 {
 429         if (family() == tmplt.family())
 430                 setFamily(INHERIT_FAMILY);
 431         if (series() == tmplt.series())
 432                 setSeries(INHERIT_SERIES);
 433         if (shape() == tmplt.shape())
 434                 setShape(INHERIT_SHAPE);
 435         if (size() == tmplt.size())
 436                 setSize(INHERIT_SIZE);
 437         if (emph() == tmplt.emph())
 438                 setEmph(INHERIT);
 439         if (underbar() == tmplt.underbar())
 440                 setUnderbar(INHERIT);
 441         if (noun() == tmplt.noun())
 442                 setNoun(INHERIT);
 443         if (color() == tmplt.color())
 444                 setColor(LColor::inherit);
 445 }
 446
 447
 448 /// Realize font from a template
 449 LyXFont & LyXFont::realize(LyXFont const & tmplt)
 450 {
 451         if (bits == inherit) {
 452                 bits = tmplt.bits;
 453                 return *this;
 454         }
 455
 456         if (bits.family == INHERIT_FAMILY)
 457                 bits.family = tmplt.bits.family;
 458
 459         if (bits.series == INHERIT_SERIES)
 460                 bits.series = tmplt.bits.series;
 461
 462         if (bits.shape == INHERIT_SHAPE)
 463                 bits.shape = tmplt.bits.shape;
 464
 465         if (bits.size == INHERIT_SIZE)
 466                 bits.size = tmplt.bits.size;
 467
 468         if (bits.emph == INHERIT)
 469                 bits.emph = tmplt.bits.emph;
 470
 471         if (bits.underbar == INHERIT)
 472                 bits.underbar = tmplt.bits.underbar;
 473
 474         if (bits.noun == INHERIT)
 475                 bits.noun = tmplt.bits.noun;
 476
 477         if (bits.color == LColor::inherit)
 478                 bits.color = tmplt.bits.color;
 479
 480         return *this;
 481 }
 482
 483
 484 /// Is font resolved?
 485 bool LyXFont::resolved() const
 486 {
 487         return (family() != INHERIT_FAMILY && series() != INHERIT_SERIES &&
 488                 shape() != INHERIT_SHAPE && size() != INHERIT_SIZE &&
 489                 emph() != INHERIT && underbar() != INHERIT &&
 490                 noun() != INHERIT &&
 491                 color() != LColor::inherit);
 492 }
 493
 494
 495 /// Build GUI description of font state
 496 string const LyXFont::stateText(BufferParams * params) const
 497 {
 498         ostringstream os;
 499         if (family() != INHERIT_FAMILY)
 500                 os << lyx::to_utf8(_(GUIFamilyNames[family()])) << ", ";
 501         if (series() != INHERIT_SERIES)
 502                 os << lyx::to_utf8(_(GUISeriesNames[series()])) << ", ";
 503         if (shape() != INHERIT_SHAPE)
 504                 os << lyx::to_utf8(_(GUIShapeNames[shape()])) << ", ";
 505         if (size() != INHERIT_SIZE)
 506                 os << lyx::to_utf8(_(GUISizeNames[size()])) << ", ";
 507         if (color() != LColor::inherit)
 508                 os << lcolor.getGUIName(color()) << ", ";
 509         if (emph() != INHERIT)
 510                 os << lyx::to_utf8(bformat(_("Emphasis %1$s, "),
 511                               _(GUIMiscNames[emph()])));
 512         if (underbar() != INHERIT)
 513                 os << lyx::to_utf8(bformat(_("Underline %1$s, "),
 514                               _(GUIMiscNames[underbar()])));
 515         if (noun() != INHERIT)
 516                 os << lyx::to_utf8(bformat(_("Noun %1$s, "),
 517                               _(GUIMiscNames[noun()])));
 518         if (bits == inherit)
 519                 os << lyx::to_utf8(_("Default")) << ", ";
 520         if (!params || (language() != params->language))
 521                 os << lyx::to_utf8(bformat(_("Language: %1$s, "),
 522                               _(language()->display())));
 523         if (number() != OFF)
 524                 os << lyx::to_utf8(bformat(_("  Number %1$s"),
 525                                 _(GUIMiscNames[number()])));
 526         return rtrim(os.str(), ", ");
 527 }
 528
 529
 530 // Set family according to lyx format string
 531 LyXFont & LyXFont::setLyXFamily(string const & fam)
 532 {
 533         string const s = ascii_lowercase(fam);
 534
 535         int i = 0;
 536         while (LyXFamilyNames[i] != s &&
 537                LyXFamilyNames[i] != string("error"))
 538                 ++i;
 539         if (s == LyXFamilyNames[i])
 540                 setFamily(LyXFont::FONT_FAMILY(i));
 541         else
 542                 lyxerr << "LyXFont::setLyXFamily: Unknown family `"
 543                        << s << '\'' << endl;
 544         return *this;
 545 }
 546
 547
 548 // Set series according to lyx format string
 549 LyXFont & LyXFont::setLyXSeries(string const & ser)
 550 {
 551         string const s = ascii_lowercase(ser);
 552
 553         int i = 0;
 554         while (LyXSeriesNames[i] != s &&
 555                LyXSeriesNames[i] != string("error")) ++i;
 556         if (s == LyXSeriesNames[i]) {
 557                 setSeries(LyXFont::FONT_SERIES(i));
 558         } else
 559                 lyxerr << "LyXFont::setLyXSeries: Unknown series `"
 560                        << s << '\'' << endl;
 561         return *this;
 562 }
 563
 564
 565 // Set shape according to lyx format string
 566 LyXFont & LyXFont::setLyXShape(string const & sha)
 567 {
 568         string const s = ascii_lowercase(sha);
 569
 570         int i = 0;
 571         while (LyXShapeNames[i] != s && LyXShapeNames[i] != string("error"))
 572                         ++i;
 573         if (s == LyXShapeNames[i])
 574                 setShape(LyXFont::FONT_SHAPE(i));
 575         else
 576                 lyxerr << "LyXFont::setLyXShape: Unknown shape `"
 577                        << s << '\'' << endl;
 578         return *this;
 579 }
 580
 581
 582 // Set size according to lyx format string
 583 LyXFont & LyXFont::setLyXSize(string const & siz)
 584 {
 585         string const s = ascii_lowercase(siz);
 586         int i = 0;
 587         while (LyXSizeNames[i] != s && LyXSizeNames[i] != string("error"))
 588                 ++i;
 589         if (s == LyXSizeNames[i]) {
 590                 setSize(LyXFont::FONT_SIZE(i));
 591         } else
 592                 lyxerr << "LyXFont::setLyXSize: Unknown size `"
 593                        << s << '\'' << endl;
 594         return *this;
 595 }
 596
 597
 598 // Set size according to lyx format string
 599 LyXFont::FONT_MISC_STATE LyXFont::setLyXMisc(string const & siz)
 600 {
 601         string const s = ascii_lowercase(siz);
 602         int i = 0;
 603         while (LyXMiscNames[i] != s &&
 604                LyXMiscNames[i] != string("error")) ++i;
 605         if (s == LyXMiscNames[i])
 606                 return FONT_MISC_STATE(i);
 607         lyxerr << "LyXFont::setLyXMisc: Unknown misc flag `"
 608                << s << '\'' << endl;
 609         return OFF;
 610 }
 611
 612
 613 /// Sets color after LyX text format
 614 LyXFont & LyXFont::setLyXColor(string const & col)
 615 {
 616         setColor(lcolor.getFromLyXName(col));
 617         return *this;
 618 }
 619
 620
 621 // Returns size in latex format
 622 string const LyXFont::latexSize() const
 623 {
 624         return LaTeXSizeNames[size()];
 625 }
 626
 627
 628 // Read a font definition from given file in lyx format
 629 // Used for layouts
 630 LyXFont & LyXFont::lyxRead(LyXLex & lex)
 631 {
 632         bool error = false;
 633         bool finished = false;
 634         while (!finished && lex.isOK() && !error) {
 635                 lex.next();
 636                 string const tok = ascii_lowercase(lex.getString());
 637
 638                 if (tok.empty()) {
 639                         continue;
 640                 } else if (tok == "endfont") {
 641                         finished = true;
 642                 } else if (tok == "family") {
 643                         lex.next();
 644                         string const ttok = lex.getString();
 645                         setLyXFamily(ttok);
 646                 } else if (tok == "series") {
 647                         lex.next();
 648                         string const ttok = lex.getString();
 649                         setLyXSeries(ttok);
 650                 } else if (tok == "shape") {
 651                         lex.next();
 652                         string const ttok = lex.getString();
 653                         setLyXShape(ttok);
 654                 } else if (tok == "size") {
 655                         lex.next();
 656                         string const ttok = lex.getString();
 657                         setLyXSize(ttok);
 658                 } else if (tok == "misc") {
 659                         lex.next();
 660                         string const ttok = ascii_lowercase(lex.getString());
 661
 662                         if (ttok == "no_bar") {
 663                                 setUnderbar(OFF);
 664                         } else if (ttok == "no_emph") {
 665                                 setEmph(OFF);
 666                         } else if (ttok == "no_noun") {
 667                                 setNoun(OFF);
 668                         } else if (ttok == "emph") {
 669                                 setEmph(ON);
 670                         } else if (ttok == "underbar") {
 671                                 setUnderbar(ON);
 672                         } else if (ttok == "noun") {
 673                                 setNoun(ON);
 674                         } else {
 675                                 lex.printError("Illegal misc type `$$Token´");
 676                         }
 677                 } else if (tok == "color") {
 678                         lex.next();
 679                         string const ttok = lex.getString();
 680                         setLyXColor(ttok);
 681                 } else {
 682                         lex.printError("Unknown tag `$$Token'");
 683                         error = true;
 684                 }
 685         }
 686         return *this;
 687 }
 688
 689
 690 /// Writes the changes from this font to orgfont in .lyx format in file
 691 void LyXFont::lyxWriteChanges(LyXFont const & orgfont,
 692                               ostream & os) const
 693 {
 694         os << "\n";
 695         if (orgfont.family() != family())
 696                 os << "\\family " << LyXFamilyNames[family()] << "\n";
 697         if (orgfont.series() != series())
 698                 os << "\\series " << LyXSeriesNames[series()] << "\n";
 699         if (orgfont.shape() != shape())
 700                 os << "\\shape " << LyXShapeNames[shape()] << "\n";
 701         if (orgfont.size() != size())
 702                 os << "\\size " << LyXSizeNames[size()] << "\n";
 703         if (orgfont.emph() != emph())
 704                 os << "\\emph " << LyXMiscNames[emph()] << "\n";
 705         if (orgfont.number() != number())
 706                 os << "\\numeric " << LyXMiscNames[number()] << "\n";
 707         if (orgfont.underbar() != underbar()) {
 708                 // This is only for backwards compatibility
 709                 switch (underbar()) {
 710                 case OFF:       os << "\\bar no\n"; break;
 711                 case ON:        os << "\\bar under\n"; break;
 712                 case TOGGLE:    lyxerr << "LyXFont::lyxWriteFontChanges: "
 713                                         "TOGGLE should not appear here!"
 714                                        << endl;
 715                 break;
 716                 case INHERIT:   os << "\\bar default\n"; break;
 717                 case IGNORE:    lyxerr << "LyXFont::lyxWriteFontChanges: "
 718                                         "IGNORE should not appear here!"
 719                                        << endl;
 720                 break;
 721                 }
 722         }
 723         if (orgfont.noun() != noun()) {
 724                 os << "\\noun " << LyXMiscNames[noun()] << "\n";
 725         }
 726         if (orgfont.color() != color()) {
 727                 // To make us file compatible with older
 728                 // lyx versions we emit "default" instead
 729                 // of "inherit"
 730                 string col_str(lcolor.getLyXName(color()));
 731                 if (col_str == "inherit") col_str = "default";
 732                 os << "\\color " << col_str << "\n";
 733         }
 734         if (orgfont.language() != language() &&
 735             language() != latex_language) {
 736                 if (language())
 737                         os << "\\lang " << language()->lang() << "\n";
 738                 else
 739                         os << "\\lang unknown\n";
 740         }
 741 }
 742
 743
 744 /// Writes the head of the LaTeX needed to impose this font
 745 // Returns number of chars written.
 746 int LyXFont::latexWriteStartChanges(ostream & os, LyXFont const & base,
 747                                     LyXFont const & prev) const
 748 {
 749         int count = 0;
 750         bool env = false;
 751
 752         if (language()->babel() != base.language()->babel() &&
 753             language() != prev.language()) {
 754                 if (isRightToLeft() != prev.isRightToLeft()) {
 755                         if (isRightToLeft()) {
 756                                 os << "\\R{";
 757                                 count += 3;
 758                         } else {
 759                                 os << "\\L{";
 760                                 count += 3;
 761                         }
 762                 } else {
 763                         string const tmp =
 764                                 subst(lyxrc.language_command_local,
 765                                       "$$lang", language()->babel());
 766                         os << tmp;
 767                         count += tmp.length();
 768                 }
 769         }
 770
 771         if (number() == ON && prev.number() != ON &&
 772             language()->lang() == "hebrew") {
 773                 os << "{\\beginL ";
 774                 count += 9;
 775         }
 776
 777         LyXFont f = *this;
 778         f.reduce(base);
 779
 780         if (f.family() != INHERIT_FAMILY) {
 781                 os << '\\'
 782                    << LaTeXFamilyNames[f.family()]
 783                    << '{';
 784                 count += strlen(LaTeXFamilyNames[f.family()]) + 2;
 785                 env = true; //We have opened a new environment
 786         }
 787         if (f.series() != INHERIT_SERIES) {
 788                 os << '\\'
 789                    << LaTeXSeriesNames[f.series()]
 790                    << '{';
 791                 count += strlen(LaTeXSeriesNames[f.series()]) + 2;
 792                 env = true; //We have opened a new environment
 793         }
 794         if (f.shape() != INHERIT_SHAPE) {
 795                 os << '\\'
 796                    << LaTeXShapeNames[f.shape()]
 797                    << '{';
 798                 count += strlen(LaTeXShapeNames[f.shape()]) + 2;
 799                 env = true; //We have opened a new environment
 800         }
 801         if (f.color() != LColor::inherit && f.color() != LColor::ignore) {
 802                 os << "\\textcolor{"
 803                    << lcolor.getLaTeXName(f.color())
 804                    << "}{";
 805                 count += lcolor.getLaTeXName(f.color()).length() + 13;
 806                 env = true; //We have opened a new environment
 807         }
 808         if (f.emph() == ON) {
 809                 os << "\\emph{";
 810                 count += 6;
 811                 env = true; //We have opened a new environment
 812         }
 813         if (f.underbar() == ON) {
 814                 os << "\\underbar{";
 815                 count += 10;
 816                 env = true; //We have opened a new environment
 817         }
 818         // \noun{} is a LyX special macro
 819         if (f.noun() == ON) {
 820                 os << "\\noun{";
 821                 count += 6;
 822                 env = true; //We have opened a new environment
 823         }
 824         if (f.size() != INHERIT_SIZE) {
 825                 // If we didn't open an environment above, we open one here
 826                 if (!env) {
 827                         os << '{';
 828                         ++count;
 829                 }
 830                 os << '\\'
 831                    << LaTeXSizeNames[f.size()]
 832                    << ' ';
 833                 count += strlen(LaTeXSizeNames[f.size()]) + 2;
 834         }
 835         return count;
 836 }
 837
 838
 839 /// Writes ending block of LaTeX needed to close use of this font
 840 // Returns number of chars written
 841 // This one corresponds to latexWriteStartChanges(). (Asger)
 842 int LyXFont::latexWriteEndChanges(ostream & os, LyXFont const & base,
 843                                   LyXFont const & next) const
 844 {
 845         int count = 0;
 846         bool env = false;
 847
 848         // reduce the current font to changes against the base
 849         // font (of the layout). We use a temporary for this to
 850         // avoid changing this font instance, as that would break
 851         LyXFont f = *this;
 852         f.reduce(base);
 853
 854         if (f.family() != INHERIT_FAMILY) {
 855                 os << '}';
 856                 ++count;
 857                 env = true; // Size change need not bother about closing env.
 858         }
 859         if (f.series() != INHERIT_SERIES) {
 860                 os << '}';
 861                 ++count;
 862                 env = true; // Size change need not bother about closing env.
 863         }
 864         if (f.shape() != INHERIT_SHAPE) {
 865                 os << '}';
 866                 ++count;
 867                 env = true; // Size change need not bother about closing env.
 868         }
 869         if (f.color() != LColor::inherit && f.color() != LColor::ignore) {
 870                 os << '}';
 871                 ++count;
 872                 env = true; // Size change need not bother about closing env.
 873         }
 874         if (f.emph() == ON) {
 875                 os << '}';
 876                 ++count;
 877                 env = true; // Size change need not bother about closing env.
 878         }
 879         if (f.underbar() == ON) {
 880                 os << '}';
 881                 ++count;
 882                 env = true; // Size change need not bother about closing env.
 883         }
 884         if (f.noun() == ON) {
 885                 os << '}';
 886                 ++count;
 887                 env = true; // Size change need not bother about closing env.
 888         }
 889         if (f.size() != INHERIT_SIZE) {
 890                 // We only have to close if only size changed
 891                 if (!env) {
 892                         os << '}';
 893                         ++count;
 894                 }
 895         }
 896
 897         if (number() == ON && next.number() != ON &&
 898             language()->lang() == "hebrew") {
 899                 os << "\\endL}";
 900                 count += 6;
 901         }
 902
 903         if (language() != base.language() && language() != next.language()) {
 904                 os << '}';
 905                 ++count;
 906         }
 907
 908         return count;
 909 }
 910
 911
 912 LColor_color LyXFont::realColor() const
 913 {
 914         if (color() == LColor::none)
 915                 return LColor::foreground;
 916         return color();
 917 }
 918
 919
 920 ostream & operator<<(ostream & os, LyXFont::FONT_MISC_STATE fms)
 921 {
 922         return os << int(fms);
 923 }
 924
 925
 926 std::ostream & operator<<(std::ostream & os, LyXFont const & font)
 927 {
 928         return os << "font:"
 929                 << " family " << font.bits.family
 930                 << " series " << font.bits.series
 931                 << " shape " << font.bits.shape
 932                 << " size " << font.bits.size
 933                 << " color " << font.bits.color
 934                 << " emph " << font.bits.emph
 935                 << " underbar " << font.bits.underbar
 936                 << " noun " << font.bits.noun
 937                 << " number " << font.bits.number
 938                 << " lang: " << (font.lang ? font.lang->lang() : 0);
 939 }