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