]> git.lyx.org Git - lyx.git/blob - src/bufferparams.C
make it compile again (hopefully)
[lyx.git] / src / bufferparams.C
1 /**
2  * \file bufferparams.C
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Alfredo Braunstein
7  * \author Lars Gullik Bjønnes
8  * \author Jean-Marc Lasgouttes
9  * \author John Levon
10  * \author André Pönitz
11  * \author Martin Vermeer
12  *
13  * Full author contact details are available in file CREDITS.
14  */
15
16 #include <config.h>
17
18 #include "bufferparams.h"
19
20 #include "author.h"
21 #include "BranchList.h"
22 #include "Bullet.h"
23 #include "debug.h"
24 #include "encoding.h"
25 #include "gettext.h"
26 #include "language.h"
27 #include "LaTeXFeatures.h"
28 #include "LColor.h"
29 #include "lyxfont.h"
30 #include "lyxlex.h"
31 #include "lyxrc.h"
32 #include "lyxtextclasslist.h"
33 #include "outputparams.h"
34 #include "tex-strings.h"
35 #include "Spacing.h"
36 #include "texrow.h"
37 #include "vspace.h"
38
39 #include "frontends/Alert.h"
40
41 #include "support/lyxalgo.h" // for lyx::count
42 #include "support/convert.h"
43 #include "support/translator.h"
44
45 #include <boost/array.hpp>
46
47 #include <sstream>
48
49 namespace support = lyx::support;
50
51 using lyx::docstring;
52 using lyx::odocstream;
53 using lyx::support::bformat;
54 using lyx::support::rtrim;
55 using lyx::support::tokenPos;
56
57 using std::endl;
58 using std::string;
59 using std::istringstream;
60 using std::ostream;
61 using std::ostringstream;
62 using std::pair;
63
64 namespace Alert = lyx::frontend::Alert;
65 namespace biblio = lyx::biblio;
66
67
68 // Local translators
69 namespace {
70
71 // Paragraph separation
72 typedef Translator<string, BufferParams::PARSEP> ParSepTranslator;
73
74
75 ParSepTranslator const init_parseptranslator()
76 {
77         ParSepTranslator translator(string_paragraph_separation[0], BufferParams::PARSEP_INDENT);
78         translator.addPair(string_paragraph_separation[1], BufferParams::PARSEP_SKIP);
79         return translator;
80 }
81
82
83 ParSepTranslator const & parseptranslator()
84 {
85         static ParSepTranslator translator = init_parseptranslator();
86         return translator;
87 }
88
89
90 // Quotes language
91 typedef Translator<string, InsetQuotes::quote_language> QuotesLangTranslator;
92
93
94 QuotesLangTranslator const init_quoteslangtranslator()
95 {
96         QuotesLangTranslator translator(string_quotes_language[0], InsetQuotes::EnglishQ);
97         translator.addPair(string_quotes_language[1], InsetQuotes::SwedishQ);
98         translator.addPair(string_quotes_language[2], InsetQuotes::GermanQ);
99         translator.addPair(string_quotes_language[3], InsetQuotes::PolishQ);
100         translator.addPair(string_quotes_language[4], InsetQuotes::FrenchQ);
101         translator.addPair(string_quotes_language[5], InsetQuotes::DanishQ);
102         return translator;
103 }
104
105
106 QuotesLangTranslator const & quoteslangtranslator()
107 {
108         static QuotesLangTranslator translator = init_quoteslangtranslator();
109         return translator;
110 }
111
112
113 // Paper size
114 typedef Translator<std::string, PAPER_SIZE> PaperSizeTranslator;
115
116
117 PaperSizeTranslator const init_papersizetranslator()
118 {
119         PaperSizeTranslator translator(string_papersize[0], PAPER_DEFAULT);
120         translator.addPair(string_papersize[1], PAPER_CUSTOM);
121         translator.addPair(string_papersize[2], PAPER_USLETTER);
122         translator.addPair(string_papersize[3], PAPER_USLEGAL);
123         translator.addPair(string_papersize[4], PAPER_USEXECUTIVE);
124         translator.addPair(string_papersize[5], PAPER_A3);
125         translator.addPair(string_papersize[6], PAPER_A4);
126         translator.addPair(string_papersize[7], PAPER_A5);
127         translator.addPair(string_papersize[8], PAPER_B3);
128         translator.addPair(string_papersize[9], PAPER_B4);
129         translator.addPair(string_papersize[10], PAPER_B5);
130         return translator;
131 }
132
133
134 PaperSizeTranslator const & papersizetranslator()
135 {
136         static PaperSizeTranslator translator = init_papersizetranslator();
137         return translator;
138 }
139
140
141 // Paper orientation
142 typedef Translator<string, PAPER_ORIENTATION> PaperOrientationTranslator;
143
144
145 PaperOrientationTranslator const init_paperorientationtranslator()
146 {
147         PaperOrientationTranslator translator(string_orientation[0], ORIENTATION_PORTRAIT);
148         translator.addPair(string_orientation[1], ORIENTATION_LANDSCAPE);
149         return translator;
150 }
151
152
153 PaperOrientationTranslator const & paperorientationtranslator()
154 {
155         static PaperOrientationTranslator translator = init_paperorientationtranslator();
156         return translator;
157 }
158
159
160 // Page sides
161 typedef Translator<int, LyXTextClass::PageSides> SidesTranslator;
162
163
164 SidesTranslator const init_sidestranslator()
165 {
166         SidesTranslator translator(1, LyXTextClass::OneSide);
167         translator.addPair(2, LyXTextClass::TwoSides);
168         return translator;
169 }
170
171
172 SidesTranslator const & sidestranslator()
173 {
174         static SidesTranslator translator = init_sidestranslator();
175         return translator;
176 }
177
178
179
180 // AMS
181 typedef Translator<int, BufferParams::AMS> AMSTranslator;
182
183
184 AMSTranslator const init_amstranslator()
185 {
186         AMSTranslator translator(0, BufferParams::AMS_OFF);
187         translator.addPair(1, BufferParams::AMS_AUTO);
188         translator.addPair(2, BufferParams::AMS_ON);
189         return translator;
190 }
191
192
193 AMSTranslator const & amstranslator()
194 {
195         static AMSTranslator translator = init_amstranslator();
196         return translator;
197 }
198
199
200 // Cite engine
201 typedef Translator<string, biblio::CiteEngine> CiteEngineTranslator;
202
203
204 CiteEngineTranslator const init_citeenginetranslator()
205 {
206         CiteEngineTranslator translator("basic", biblio::ENGINE_BASIC);
207         translator.addPair("natbib_numerical", biblio::ENGINE_NATBIB_NUMERICAL);
208         translator.addPair("natbib_authoryear", biblio::ENGINE_NATBIB_AUTHORYEAR);
209         translator.addPair("jurabib", biblio::ENGINE_JURABIB);
210         return translator;
211 }
212
213
214 CiteEngineTranslator const & citeenginetranslator()
215 {
216         static CiteEngineTranslator translator = init_citeenginetranslator();
217         return translator;
218 }
219
220
221 // Spacing
222 typedef Translator<string, Spacing::Space> SpaceTranslator;
223
224
225 SpaceTranslator const init_spacetranslator()
226 {
227         SpaceTranslator translator("default", Spacing::Default);
228         translator.addPair("single", Spacing::Single);
229         translator.addPair("onehalf", Spacing::Onehalf);
230         translator.addPair("double", Spacing::Double);
231         translator.addPair("other", Spacing::Other);
232         return translator;
233 }
234
235
236 SpaceTranslator const & spacetranslator()
237 {
238         static SpaceTranslator translator = init_spacetranslator();
239         return translator;
240 }
241
242 // ends annonym namespace
243 }
244
245
246 class BufferParams::Impl
247 {
248 public:
249         Impl();
250
251         AuthorList authorlist;
252         BranchList branchlist;
253         boost::array<Bullet, 4> temp_bullets;
254         boost::array<Bullet, 4> user_defined_bullets;
255         Spacing spacing;
256         /** This is the amount of space used for paragraph_separation "skip",
257          * and for detached paragraphs in "indented" documents.
258          */
259         VSpace defskip;
260 };
261
262
263 BufferParams::Impl::Impl()
264         : defskip(VSpace::MEDSKIP)
265 {
266         // set initial author
267         authorlist.record(Author(lyxrc.user_name, lyxrc.user_email));
268 }
269
270
271 BufferParams::Impl *
272 BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
273 {
274         BOOST_ASSERT(ptr);
275
276         return new BufferParams::Impl(*ptr);
277 }
278
279
280 void BufferParams::MemoryTraits::destroy(BufferParams::Impl * ptr)
281 {
282         delete ptr;
283 }
284
285
286 BufferParams::BufferParams()
287         : // Initialize textclass to point to article. if `first' is
288           // true in the returned pair, then `second' is the textclass
289           // number; if it is false, second is 0. In both cases, second
290           // is what we want.
291         textclass(textclasslist.numberOfClass("article").second),
292         pimpl_(new Impl)
293 {
294         paragraph_separation = PARSEP_INDENT;
295         quotes_language = InsetQuotes::EnglishQ;
296         fontsize = "default";
297
298         /*  PaperLayout */
299         papersize = PAPER_DEFAULT;
300         orientation = ORIENTATION_PORTRAIT;
301         use_geometry = false;
302         use_amsmath = AMS_AUTO;
303         cite_engine = biblio::ENGINE_BASIC;
304         use_bibtopic = false;
305         trackChanges = false;
306         outputChanges = false;
307         secnumdepth = 3;
308         tocdepth = 3;
309         language = default_language;
310         fontsRoman = "default";
311         fontsSans = "default";
312         fontsTypewriter = "default";
313         fontsDefaultFamily = "default";
314         fontsSC = false;
315         fontsOSF = false;
316         fontsSansScale = 100;
317         fontsTypewriterScale = 100;
318         inputenc = "auto";
319         graphicsDriver = "default";
320         sides = LyXTextClass::OneSide;
321         columns = 1;
322         pagestyle = "default";
323         compressed = false;
324         for (int iter = 0; iter < 4; ++iter) {
325                 user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
326                 temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
327         }
328 }
329
330
331 BufferParams::~BufferParams()
332 {}
333
334
335 AuthorList & BufferParams::authors()
336 {
337         return pimpl_->authorlist;
338 }
339
340
341 AuthorList const & BufferParams::authors() const
342 {
343         return pimpl_->authorlist;
344 }
345
346
347 BranchList & BufferParams::branchlist()
348 {
349         return pimpl_->branchlist;
350 }
351
352
353 BranchList const & BufferParams::branchlist() const
354 {
355         return pimpl_->branchlist;
356 }
357
358
359 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
360 {
361         BOOST_ASSERT(index < 4);
362         return pimpl_->temp_bullets[index];
363 }
364
365
366 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
367 {
368         BOOST_ASSERT(index < 4);
369         return pimpl_->temp_bullets[index];
370 }
371
372
373 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
374 {
375         BOOST_ASSERT(index < 4);
376         return pimpl_->user_defined_bullets[index];
377 }
378
379
380 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
381 {
382         BOOST_ASSERT(index < 4);
383         return pimpl_->user_defined_bullets[index];
384 }
385
386
387 Spacing & BufferParams::spacing()
388 {
389         return pimpl_->spacing;
390 }
391
392
393 Spacing const & BufferParams::spacing() const
394 {
395         return pimpl_->spacing;
396 }
397
398
399 VSpace const & BufferParams::getDefSkip() const
400 {
401         return pimpl_->defskip;
402 }
403
404
405 void BufferParams::setDefSkip(VSpace const & vs)
406 {
407         pimpl_->defskip = vs;
408 }
409
410
411 string const BufferParams::readToken(LyXLex & lex, string const & token)
412 {
413         if (token == "\\textclass") {
414                 lex.next();
415                 string const classname = lex.getString();
416                 pair<bool, lyx::textclass_type> pp =
417                         textclasslist.numberOfClass(classname);
418                 if (pp.first) {
419                         textclass = pp.second;
420                 } else {
421                         // if text class does not exist, try to load it from filepath
422                         pp = textclasslist.addTextClass(classname, filepath);
423                         if (pp.first) {
424                                 textclass = pp.second;
425                         } else {
426                                 textclass = 0;
427                                 return classname;
428                         }
429                 }
430                 // FIXME: isTeXClassAvailable will try to load the layout file, but will
431                 // fail because of the lack of path info. Warnings will be given although
432                 // the layout file will be correctly loaded later.
433                 if (!getLyXTextClass().isTeXClassAvailable()) {
434                         docstring const msg =
435                                 bformat(_("The document uses a missing "
436                                                        "TeX class \"%1$s\".\n"), lyx::from_utf8(classname));
437                         Alert::warning(_("Document class not available"),
438                                        msg + _("LyX will not be able to produce output."));
439                 }
440         } else if (token == "\\begin_preamble") {
441                 readPreamble(lex);
442         } else if (token == "\\options") {
443                 lex.eatLine();
444                 options = lex.getString();
445         } else if (token == "\\language") {
446                 readLanguage(lex);
447         } else if (token == "\\inputencoding") {
448                 lex >> inputenc;
449         } else if (token == "\\graphics") {
450                 readGraphicsDriver(lex);
451         } else if (token == "\\font_roman") {
452                 lex >> fontsRoman;
453         } else if (token == "\\font_sans") {
454                 lex >> fontsSans;
455         } else if (token == "\\font_typewriter") {
456                 lex >> fontsTypewriter;
457         } else if (token == "\\font_default_family") {
458                 lex >> fontsDefaultFamily;
459         } else if (token == "\\font_sc") {
460                 lex >> fontsSC;
461         } else if (token == "\\font_osf") {
462                 lex >> fontsOSF;
463         } else if (token == "\\font_sf_scale") {
464                 lex >> fontsSansScale;
465         } else if (token == "\\font_tt_scale") {
466                 lex >> fontsTypewriterScale;
467         } else if (token == "\\paragraph_separation") {
468                 string parsep;
469                 lex >> parsep;
470                 paragraph_separation = parseptranslator().find(parsep);
471         } else if (token == "\\defskip") {
472                 lex.next();
473                 pimpl_->defskip = VSpace(lex.getString());
474         } else if (token == "\\quotes_language") {
475                 string quotes_lang;
476                 lex >> quotes_lang;
477                 quotes_language = quoteslangtranslator().find(quotes_lang);
478         } else if (token == "\\papersize") {
479                 string ppsize;
480                 lex >> ppsize;
481                 papersize = papersizetranslator().find(ppsize);
482         } else if (token == "\\use_geometry") {
483                 lex >> use_geometry;
484         } else if (token == "\\use_amsmath") {
485                 int use_ams;
486                 lex >> use_ams;
487                 use_amsmath = amstranslator().find(use_ams);
488         } else if (token == "\\cite_engine") {
489                 string engine;
490                 lex >> engine;
491                 cite_engine = citeenginetranslator().find(engine);
492         } else if (token == "\\use_bibtopic") {
493                 lex >> use_bibtopic;
494         } else if (token == "\\tracking_changes") {
495                 lex >> trackChanges;
496         } else if (token == "\\output_changes") {
497                 lex >> outputChanges;
498         } else if (token == "\\branch") {
499                 lex.next();
500                 string branch = lex.getString();
501                 branchlist().add(branch);
502                 while (true) {
503                         lex.next();
504                         string const tok = lex.getString();
505                         if (tok == "\\end_branch")
506                                 break;
507                         Branch * branch_ptr = branchlist().find(branch);
508                         if (tok == "\\selected") {
509                                 lex.next();
510                                 if (branch_ptr)
511                                         branch_ptr->setSelected(lex.getInteger());
512                         }
513                         // not yet operational
514                         if (tok == "\\color") {
515                                 lex.eatLine();
516                                 string color = lex.getString();
517                                 if (branch_ptr)
518                                         branch_ptr->setColor(color);
519                                 // Update also the LColor table:
520                                 if (color == "none")
521                                         color = lcolor.getX11Name(LColor::background);
522                                 lcolor.setColor(branch, color);
523
524                         }
525                 }
526         } else if (token == "\\author") {
527                 lex.eatLine();
528                 istringstream ss(lex.getString());
529                 Author a;
530                 ss >> a;
531                 author_map.push_back(pimpl_->authorlist.record(a));
532         } else if (token == "\\paperorientation") {
533                 string orient;
534                 lex >> orient;
535                 orientation = paperorientationtranslator().find(orient);
536         } else if (token == "\\paperwidth") {
537                 lex >> paperwidth;
538         } else if (token == "\\paperheight") {
539                 lex >> paperheight;
540         } else if (token == "\\leftmargin") {
541                 lex >> leftmargin;
542         } else if (token == "\\topmargin") {
543                 lex >> topmargin;
544         } else if (token == "\\rightmargin") {
545                 lex >> rightmargin;
546         } else if (token == "\\bottommargin") {
547                 lex >> bottommargin;
548         } else if (token == "\\headheight") {
549                 lex >> headheight;
550         } else if (token == "\\headsep") {
551                 lex >> headsep;
552         } else if (token == "\\footskip") {
553                 lex >> footskip;
554         } else if (token == "\\paperfontsize") {
555                 lex >> fontsize;
556         } else if (token == "\\papercolumns") {
557                 lex >> columns;
558         } else if (token == "\\papersides") {
559                 int psides;
560                 lex >> psides;
561                 sides = sidestranslator().find(psides);
562         } else if (token == "\\paperpagestyle") {
563                 lex >> pagestyle;
564         } else if (token == "\\bullet") {
565                 readBullets(lex);
566         } else if (token == "\\bulletLaTeX") {
567                 readBulletsLaTeX(lex);
568         } else if (token == "\\secnumdepth") {
569                 lex >> secnumdepth;
570         } else if (token == "\\tocdepth") {
571                 lex >> tocdepth;
572         } else if (token == "\\spacing") {
573                 string nspacing;
574                 lex >> nspacing;
575                 string tmp_val;
576                 if (nspacing == "other") {
577                         lex >> tmp_val;
578                 }
579                 spacing().set(spacetranslator().find(nspacing), tmp_val);
580         } else if (token == "\\float_placement") {
581                 lex >> float_placement;
582         } else {
583                 return token;
584         }
585
586         return string();
587 }
588
589
590 void BufferParams::writeFile(ostream & os) const
591 {
592         // The top of the file is written by the buffer.
593         // Prints out the buffer info into the .lyx file given by file
594
595         // the textclass
596         os << "\\textclass " << textclasslist[textclass].name() << '\n';
597
598         // then the the preamble
599         if (!preamble.empty()) {
600                 // remove '\n' from the end of preamble
601                 string const tmppreamble = rtrim(preamble, "\n");
602                 os << "\\begin_preamble\n"
603                    << tmppreamble
604                    << "\n\\end_preamble\n";
605         }
606
607         // the options
608         if (!options.empty()) {
609                 os << "\\options " << options << '\n';
610         }
611
612         // then the text parameters
613         if (language != ignore_language)
614                 os << "\\language " << language->lang() << '\n';
615         os << "\\inputencoding " << inputenc
616            << "\n\\font_roman " << fontsRoman
617            << "\n\\font_sans " << fontsSans
618            << "\n\\font_typewriter " << fontsTypewriter
619            << "\n\\font_default_family " << fontsDefaultFamily
620            << "\n\\font_sc " << convert<string>(fontsSC)
621            << "\n\\font_osf " << convert<string>(fontsOSF)
622            << "\n\\font_sf_scale " << fontsSansScale
623            << "\n\\font_tt_scale " << fontsTypewriterScale
624            << "\n\\graphics " << graphicsDriver << '\n';
625
626         if (!float_placement.empty()) {
627                 os << "\\float_placement " << float_placement << '\n';
628         }
629         os << "\\paperfontsize " << fontsize << '\n';
630
631         spacing().writeFile(os);
632
633         os << "\\papersize " << string_papersize[papersize]
634            << "\n\\use_geometry " << convert<string>(use_geometry)
635            << "\n\\use_amsmath " << use_amsmath
636            << "\n\\cite_engine " << citeenginetranslator().find(cite_engine)
637            << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
638            << "\n\\paperorientation " << string_orientation[orientation]
639            << '\n';
640
641         BranchList::const_iterator it = branchlist().begin();
642         BranchList::const_iterator end = branchlist().end();
643         for (; it != end; ++it) {
644                 os << "\\branch " << it->getBranch()
645                    << "\n\\selected " << it->getSelected()
646                    << "\n\\color " << lyx::X11hexname(it->getColor())
647                    << "\n\\end_branch"
648                    << "\n";
649         }
650
651         if (!paperwidth.empty())
652                 os << "\\paperwidth "
653                    << VSpace(paperwidth).asLyXCommand() << '\n';
654         if (!paperheight.empty())
655                 os << "\\paperheight "
656                    << VSpace(paperheight).asLyXCommand() << '\n';
657         if (!leftmargin.empty())
658                 os << "\\leftmargin "
659                    << VSpace(leftmargin).asLyXCommand() << '\n';
660         if (!topmargin.empty())
661                 os << "\\topmargin "
662                    << VSpace(topmargin).asLyXCommand() << '\n';
663         if (!rightmargin.empty())
664                 os << "\\rightmargin "
665                    << VSpace(rightmargin).asLyXCommand() << '\n';
666         if (!bottommargin.empty())
667                 os << "\\bottommargin "
668                    << VSpace(bottommargin).asLyXCommand() << '\n';
669         if (!headheight.empty())
670                 os << "\\headheight "
671                    << VSpace(headheight).asLyXCommand() << '\n';
672         if (!headsep.empty())
673                 os << "\\headsep "
674                    << VSpace(headsep).asLyXCommand() << '\n';
675         if (!footskip.empty())
676                 os << "\\footskip "
677                    << VSpace(footskip).asLyXCommand() << '\n';
678         os << "\\secnumdepth " << secnumdepth
679            << "\n\\tocdepth " << tocdepth
680            << "\n\\paragraph_separation "
681            << string_paragraph_separation[paragraph_separation]
682            << "\n\\defskip " << getDefSkip().asLyXCommand()
683            << "\n\\quotes_language "
684            << string_quotes_language[quotes_language]
685            << "\n\\papercolumns " << columns
686            << "\n\\papersides " << sides
687            << "\n\\paperpagestyle " << pagestyle << '\n';
688         for (int i = 0; i < 4; ++i) {
689                 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
690                         if (user_defined_bullet(i).getFont() != -1) {
691                                 os << "\\bullet " << i << " "
692                                    << user_defined_bullet(i).getFont() << " "
693                                    << user_defined_bullet(i).getCharacter() << " "
694                                    << user_defined_bullet(i).getSize() << "\n";
695                         }
696                         else {
697                                 os << "\\bulletLaTeX " << i << " \""
698                                    << user_defined_bullet(i).getText()
699                                    << "\"\n";
700                         }
701                 }
702         }
703
704         os << "\\tracking_changes " << convert<string>(trackChanges) << "\n";
705         os << "\\output_changes " << convert<string>(outputChanges) << "\n";
706
707         if (trackChanges) {
708                 // FIXME: Change tracking (MG)
709                 AuthorList::Authors::const_iterator it = pimpl_->authorlist.begin();
710                 AuthorList::Authors::const_iterator end = pimpl_->authorlist.end();
711                 for (; it != end; ++it) {
712                         os << "\\author " << it->second << "\n";
713                 }
714         }
715 }
716
717
718 bool BufferParams::writeLaTeX(odocstream & os, LaTeXFeatures & features,
719                               TexRow & texrow) const
720 {
721         os << "\\documentclass";
722
723         LyXTextClass const & tclass = getLyXTextClass();
724
725         ostringstream clsoptions; // the document class options.
726
727         if (tokenPos(tclass.opt_fontsize(),
728                      '|', fontsize) >= 0) {
729                 // only write if existing in list (and not default)
730                 clsoptions << fontsize << "pt,";
731         }
732
733         // custom, A3, B3 and B4 paper sizes need geometry
734         bool nonstandard_papersize = (papersize == PAPER_B3) ||
735                                      (papersize == PAPER_B4) ||
736                                      (papersize == PAPER_A3) ||
737                                      (papersize == PAPER_CUSTOM);
738
739         if (!use_geometry) {
740                 switch (papersize) {
741                 case PAPER_A4:
742                         clsoptions << "a4paper,";
743                         break;
744                 case PAPER_USLETTER:
745                         clsoptions << "letterpaper,";
746                         break;
747                 case PAPER_A5:
748                         clsoptions << "a5paper,";
749                         break;
750                 case PAPER_B5:
751                         clsoptions << "b5paper,";
752                         break;
753                 case PAPER_USEXECUTIVE:
754                         clsoptions << "executivepaper,";
755                         break;
756                 case PAPER_USLEGAL:
757                         clsoptions << "legalpaper,";
758                         break;
759                 case PAPER_DEFAULT:
760                 case PAPER_A3:
761                 case PAPER_B3:
762                 case PAPER_B4:
763                 case PAPER_CUSTOM:
764                         break;
765                 }
766         }
767
768         // if needed
769         if (sides != tclass.sides()) {
770                 switch (sides) {
771                 case LyXTextClass::OneSide:
772                         clsoptions << "oneside,";
773                         break;
774                 case LyXTextClass::TwoSides:
775                         clsoptions << "twoside,";
776                         break;
777                 }
778         }
779
780         // if needed
781         if (columns != tclass.columns()) {
782                 if (columns == 2)
783                         clsoptions << "twocolumn,";
784                 else
785                         clsoptions << "onecolumn,";
786         }
787
788         if (!use_geometry
789             && orientation == ORIENTATION_LANDSCAPE)
790                 clsoptions << "landscape,";
791
792         // language should be a parameter to \documentclass
793         if (language->babel() == "hebrew"
794             && default_language->babel() != "hebrew")
795                 // This seems necessary
796                 features.useLanguage(default_language);
797
798         ostringstream language_options;
799         bool const use_babel = features.useBabel();
800         if (use_babel) {
801                 language_options << features.getLanguages();
802                 language_options << language->babel();
803                 if (lyxrc.language_global_options)
804                         clsoptions << language_options.str() << ',';
805         }
806
807         // the user-defined options
808         if (!options.empty()) {
809                 clsoptions << options << ',';
810         }
811
812         string strOptions(clsoptions.str());
813         if (!strOptions.empty()) {
814                 strOptions = rtrim(strOptions, ",");
815                 // FIXME UNICODE
816                 os << '[' << lyx::from_utf8(strOptions) << ']';
817         }
818
819         os << '{' << lyx::from_ascii(tclass.latexname()) << "}\n";
820         texrow.newline();
821         // end of \documentclass defs
822
823         // font selection must be done before loading fontenc.sty
824         string const fonts =
825                 loadFonts(features, fontsRoman, fontsSans,
826                           fontsTypewriter, fontsSC, fontsOSF,
827                           fontsSansScale, fontsTypewriterScale);
828         if (!fonts.empty()) {
829                 os << lyx::from_ascii(fonts);
830                 texrow.newline();
831         }
832         if (fontsDefaultFamily != "default")
833                 os << "\\renewcommand{\\familydefault}{\\"
834                    << lyx::from_ascii(fontsDefaultFamily) << "}\n";
835         // this one is not per buffer
836         if (lyxrc.fontenc != "default") {
837                 os << "\\usepackage[" << lyx::from_ascii(lyxrc.fontenc)
838                    << "]{fontenc}\n";
839                 texrow.newline();
840         }
841
842         if (inputenc == "auto") {
843                 string const doc_encoding =
844                         language->encoding()->latexName();
845
846                 // Create a list with all the input encodings used
847                 // in the document
848                 std::set<string> encodings =
849                         features.getEncodingSet(doc_encoding);
850
851                 os << "\\usepackage[";
852                 std::set<string>::const_iterator it = encodings.begin();
853                 std::set<string>::const_iterator const end = encodings.end();
854                 for (; it != end; ++it)
855                         os << lyx::from_ascii(*it) << ',';
856                 os << lyx::from_ascii(doc_encoding) << "]{inputenc}\n";
857                 texrow.newline();
858         } else if (inputenc != "default") {
859                 os << "\\usepackage[" << lyx::from_ascii(inputenc)
860                    << "]{inputenc}\n";
861                 texrow.newline();
862         }
863
864         if (use_geometry || nonstandard_papersize) {
865                 os << "\\usepackage{geometry}\n";
866                 texrow.newline();
867                 os << "\\geometry{verbose";
868                 if (orientation == ORIENTATION_LANDSCAPE)
869                         os << ",landscape";
870                 switch (papersize) {
871                 case PAPER_CUSTOM:
872                         if (!paperwidth.empty())
873                                 os << ",paperwidth="
874                                    << lyx::from_ascii(paperwidth);
875                         if (!paperheight.empty())
876                                 os << ",paperheight="
877                                    << lyx::from_ascii(paperheight);
878                         break;
879                 case PAPER_USLETTER:
880                         os << ",letterpaper";
881                         break;
882                 case PAPER_USLEGAL:
883                         os << ",legalpaper";
884                         break;
885                 case PAPER_USEXECUTIVE:
886                         os << ",executivepaper";
887                         break;
888                 case PAPER_A3:
889                         os << ",a3paper";
890                         break;
891                 case PAPER_A4:
892                         os << ",a4paper";
893                         break;
894                 case PAPER_A5:
895                         os << ",a5paper";
896                         break;
897                 case PAPER_B3:
898                         os << ",b3paper";
899                         break;
900                 case PAPER_B4:
901                         os << ",b4paper";
902                         break;
903                 case PAPER_B5:
904                         os << ",b5paper";
905                         break;
906                 default:
907                         // default papersize ie PAPER_DEFAULT
908                         switch (lyxrc.default_papersize) {
909                         case PAPER_DEFAULT: // keep compiler happy
910                         case PAPER_USLETTER:
911                                 os << ",letterpaper";
912                                 break;
913                         case PAPER_USLEGAL:
914                                 os << ",legalpaper";
915                                 break;
916                         case PAPER_USEXECUTIVE:
917                                 os << ",executivepaper";
918                                 break;
919                         case PAPER_A3:
920                                 os << ",a3paper";
921                                 break;
922                         case PAPER_A4:
923                                 os << ",a4paper";
924                                 break;
925                         case PAPER_A5:
926                                 os << ",a5paper";
927                                 break;
928                         case PAPER_B5:
929                                 os << ",b5paper";
930                                 break;
931                         case PAPER_B3:
932                         case PAPER_B4:
933                         case PAPER_CUSTOM:
934                                 break;
935                         }
936                 }
937                 if (!topmargin.empty())
938                         os << ",tmargin=" << lyx::from_ascii(topmargin);
939                 if (!bottommargin.empty())
940                         os << ",bmargin=" << lyx::from_ascii(bottommargin);
941                 if (!leftmargin.empty())
942                         os << ",lmargin=" << lyx::from_ascii(leftmargin);
943                 if (!rightmargin.empty())
944                         os << ",rmargin=" << lyx::from_ascii(rightmargin);
945                 if (!headheight.empty())
946                         os << ",headheight=" << lyx::from_ascii(headheight);
947                 if (!headsep.empty())
948                         os << ",headsep=" << lyx::from_ascii(headsep);
949                 if (!footskip.empty())
950                         os << ",footskip=" << lyx::from_ascii(footskip);
951                 os << "}\n";
952                 texrow.newline();
953         }
954
955         if (tokenPos(tclass.opt_pagestyle(),
956                      '|', pagestyle) >= 0) {
957                 if (pagestyle == "fancy") {
958                         os << "\\usepackage{fancyhdr}\n";
959                         texrow.newline();
960                 }
961                 os << "\\pagestyle{" << lyx::from_ascii(pagestyle) << "}\n";
962                 texrow.newline();
963         }
964
965         // Only if class has a ToC hierarchy
966         if (tclass.hasTocLevels()) {
967                 if (secnumdepth != tclass.secnumdepth()) {
968                         os << "\\setcounter{secnumdepth}{"
969                            << secnumdepth
970                            << "}\n";
971                         texrow.newline();
972                 }
973                 if (tocdepth != tclass.tocdepth()) {
974                         os << "\\setcounter{tocdepth}{"
975                            << tocdepth
976                            << "}\n";
977                         texrow.newline();
978                 }
979         }
980
981         if (paragraph_separation) {
982                 switch (getDefSkip().kind()) {
983                 case VSpace::SMALLSKIP:
984                         os << "\\setlength\\parskip{\\smallskipamount}\n";
985                         break;
986                 case VSpace::MEDSKIP:
987                         os << "\\setlength\\parskip{\\medskipamount}\n";
988                         break;
989                 case VSpace::BIGSKIP:
990                         os << "\\setlength\\parskip{\\bigskipamount}\n";
991                         break;
992                 case VSpace::LENGTH:
993                         os << "\\setlength\\parskip{"
994                            << lyx::from_ascii(getDefSkip().length().asLatexString())
995                            << "}\n";
996                         break;
997                 default: // should never happen // Then delete it.
998                         os << "\\setlength\\parskip{\\medskipamount}\n";
999                         break;
1000                 }
1001                 texrow.newline();
1002
1003                 os << "\\setlength\\parindent{0pt}\n";
1004                 texrow.newline();
1005         }
1006
1007         // If we use jurabib, we have to call babel here.
1008         if (use_babel && features.isRequired("jurabib")) {
1009                 os << lyx::from_ascii(babelCall(language_options.str()))
1010                    << '\n'
1011                    << lyx::from_ascii(features.getBabelOptions());
1012                 texrow.newline();
1013         }
1014
1015         // Now insert the LyX specific LaTeX commands...
1016
1017         // The optional packages;
1018         string lyxpreamble(features.getPackages());
1019
1020         // this might be useful...
1021         lyxpreamble += "\n\\makeatletter\n";
1022
1023         // Some macros LyX will need
1024         string tmppreamble(features.getMacros());
1025
1026         if (!tmppreamble.empty()) {
1027                 lyxpreamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1028                         "LyX specific LaTeX commands.\n"
1029                         + tmppreamble + '\n';
1030         }
1031
1032         // the text class specific preamble
1033         tmppreamble = features.getTClassPreamble();
1034         if (!tmppreamble.empty()) {
1035                 lyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1036                         "Textclass specific LaTeX commands.\n"
1037                         + tmppreamble + '\n';
1038         }
1039
1040         /* the user-defined preamble */
1041         if (!preamble.empty()) {
1042                 lyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
1043                         "User specified LaTeX commands.\n"
1044                         + preamble + '\n';
1045         }
1046
1047         // Itemize bullet settings need to be last in case the user
1048         // defines their own bullets that use a package included
1049         // in the user-defined preamble -- ARRae
1050         // Actually it has to be done much later than that
1051         // since some packages like frenchb make modifications
1052         // at \begin{document} time -- JMarc
1053         string bullets_def;
1054         for (int i = 0; i < 4; ++i) {
1055                 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1056                         if (bullets_def.empty())
1057                                 bullets_def="\\AtBeginDocument{\n";
1058                         bullets_def += "  \\def\\labelitemi";
1059                         switch (i) {
1060                                 // `i' is one less than the item to modify
1061                         case 0:
1062                                 break;
1063                         case 1:
1064                                 bullets_def += 'i';
1065                                 break;
1066                         case 2:
1067                                 bullets_def += "ii";
1068                                 break;
1069                         case 3:
1070                                 bullets_def += 'v';
1071                                 break;
1072                         }
1073                         bullets_def += '{' +
1074                                 user_defined_bullet(i).getText()
1075                                 + "}\n";
1076                 }
1077         }
1078
1079         if (!bullets_def.empty())
1080                 lyxpreamble += bullets_def + "}\n\n";
1081
1082         // We try to load babel late, in case it interferes
1083         // with other packages.
1084         // Jurabib has to be called after babel, though.
1085         if (use_babel && !features.isRequired("jurabib")) {
1086                 lyxpreamble += babelCall(language_options.str()) + '\n';
1087                 lyxpreamble += features.getBabelOptions();
1088         }
1089
1090         lyxpreamble += "\\makeatother\n";
1091
1092         // dvipost settings come after everything else
1093         if (features.isAvailable("dvipost") && outputChanges) {
1094                 lyxpreamble +=
1095                         "\\dvipostlayout\n"
1096                         "\\dvipost{osstart color push Red}\n"
1097                         "\\dvipost{osend color pop}\n"
1098                         "\\dvipost{cbstart color push Blue}\n"
1099                         "\\dvipost{cbend color pop}\n";
1100         }
1101
1102         int const nlines =
1103                 int(lyx::count(lyxpreamble.begin(), lyxpreamble.end(), '\n'));
1104         for (int j = 0; j != nlines; ++j) {
1105                 texrow.newline();
1106         }
1107
1108         // FIXME UNICODE
1109         os << lyx::from_utf8(lyxpreamble);
1110         return use_babel;
1111 }
1112
1113
1114 void BufferParams::useClassDefaults()
1115 {
1116         LyXTextClass const & tclass = textclasslist[textclass];
1117
1118         sides = tclass.sides();
1119         columns = tclass.columns();
1120         pagestyle = tclass.pagestyle();
1121         options = tclass.options();
1122         // Only if class has a ToC hierarchy
1123         if (tclass.hasTocLevels()) {
1124                 secnumdepth = tclass.secnumdepth();
1125                 tocdepth = tclass.tocdepth();
1126         }
1127 }
1128
1129
1130 bool BufferParams::hasClassDefaults() const
1131 {
1132         LyXTextClass const & tclass = textclasslist[textclass];
1133
1134         return (sides == tclass.sides()
1135                 && columns == tclass.columns()
1136                 && pagestyle == tclass.pagestyle()
1137                 && options == tclass.options()
1138                 && secnumdepth == tclass.secnumdepth()
1139                 && tocdepth == tclass.tocdepth());
1140 }
1141
1142
1143 LyXTextClass const & BufferParams::getLyXTextClass() const
1144 {
1145         return textclasslist[textclass];
1146 }
1147
1148
1149 LyXFont const BufferParams::getFont() const
1150 {
1151         LyXFont f = getLyXTextClass().defaultfont();
1152         f.setLanguage(language);
1153         if (fontsDefaultFamily == "rmdefault")
1154                 f.setFamily(LyXFont::ROMAN_FAMILY);
1155         else if (fontsDefaultFamily == "sfdefault")
1156                 f.setFamily(LyXFont::SANS_FAMILY);
1157         else if (fontsDefaultFamily == "ttdefault")
1158                 f.setFamily(LyXFont::TYPEWRITER_FAMILY);
1159         return f;
1160 }
1161
1162
1163 void BufferParams::readPreamble(LyXLex & lex)
1164 {
1165         if (lex.getString() != "\\begin_preamble")
1166                 lyxerr << "Error (BufferParams::readPreamble):"
1167                         "consistency check failed." << endl;
1168
1169         preamble = lex.getLongString("\\end_preamble");
1170 }
1171
1172
1173 void BufferParams::readLanguage(LyXLex & lex)
1174 {
1175         if (!lex.next()) return;
1176
1177         string const tmptok = lex.getString();
1178
1179         // check if tmptok is part of tex_babel in tex-defs.h
1180         language = languages.getLanguage(tmptok);
1181         if (!language) {
1182                 // Language tmptok was not found
1183                 language = default_language;
1184                 lyxerr << "Warning: Setting language `"
1185                        << tmptok << "' to `" << language->lang()
1186                        << "'." << endl;
1187         }
1188 }
1189
1190
1191 void BufferParams::readGraphicsDriver(LyXLex & lex)
1192 {
1193         if (!lex.next()) return;
1194
1195         string const tmptok = lex.getString();
1196         // check if tmptok is part of tex_graphics in tex_defs.h
1197         int n = 0;
1198         while (true) {
1199                 string const test = tex_graphics[n++];
1200
1201                 if (test == tmptok) {
1202                         graphicsDriver = tmptok;
1203                         break;
1204                 } else if (test == "") {
1205                         lex.printError(
1206                                 "Warning: graphics driver `$$Token' not recognized!\n"
1207                                 "         Setting graphics driver to `default'.\n");
1208                         graphicsDriver = "default";
1209                         break;
1210                 }
1211         }
1212 }
1213
1214
1215 void BufferParams::readBullets(LyXLex & lex)
1216 {
1217         if (!lex.next()) return;
1218
1219         int const index = lex.getInteger();
1220         lex.next();
1221         int temp_int = lex.getInteger();
1222         user_defined_bullet(index).setFont(temp_int);
1223         temp_bullet(index).setFont(temp_int);
1224         lex >> temp_int;
1225         user_defined_bullet(index).setCharacter(temp_int);
1226         temp_bullet(index).setCharacter(temp_int);
1227         lex >> temp_int;
1228         user_defined_bullet(index).setSize(temp_int);
1229         temp_bullet(index).setSize(temp_int);
1230 }
1231
1232
1233 void BufferParams::readBulletsLaTeX(LyXLex & lex)
1234 {
1235         // The bullet class should be able to read this.
1236         if (!lex.next()) return;
1237         int const index = lex.getInteger();
1238         lex.next(true);
1239         string const temp_str = lex.getString();
1240
1241         user_defined_bullet(index).setText(temp_str);
1242         temp_bullet(index).setText(temp_str);
1243 }
1244
1245
1246 string const BufferParams::paperSizeName() const
1247 {
1248         char real_papersize = papersize;
1249         if (real_papersize == PAPER_DEFAULT)
1250                 real_papersize = lyxrc.default_papersize;
1251
1252         switch (real_papersize) {
1253         case PAPER_A3:
1254                 return "a3";
1255         case PAPER_A4:
1256                 return "a4";
1257         case PAPER_A5:
1258                 return "a5";
1259         case PAPER_B5:
1260                 return "b5";
1261         case PAPER_USEXECUTIVE:
1262                 return "foolscap";
1263         case PAPER_USLEGAL:
1264                 return "legal";
1265         case PAPER_USLETTER:
1266         default:
1267                 return "letter";
1268         }
1269 }
1270
1271
1272 string const BufferParams::dvips_options() const
1273 {
1274         string result;
1275
1276         if (use_geometry
1277             && papersize == PAPER_CUSTOM
1278             && !lyxrc.print_paper_dimension_flag.empty()
1279             && !paperwidth.empty()
1280             && !paperheight.empty()) {
1281                 // using a custom papersize
1282                 result = lyxrc.print_paper_dimension_flag;
1283                 result += ' ' + paperwidth;
1284                 result += ',' + paperheight;
1285         } else {
1286                 string const paper_option = paperSizeName();
1287                 if (paper_option != "letter" ||
1288                     orientation != ORIENTATION_LANDSCAPE) {
1289                         // dvips won't accept -t letter -t landscape.
1290                         // In all other cases, include the paper size
1291                         // explicitly.
1292                         result = lyxrc.print_paper_flag;
1293                         result += ' ' + paper_option;
1294                 }
1295         }
1296         if (orientation == ORIENTATION_LANDSCAPE &&
1297             papersize != PAPER_CUSTOM)
1298                 result += ' ' + lyxrc.print_landscape_flag;
1299         return result;
1300 }
1301
1302
1303 string const BufferParams::babelCall(string const & lang_opts) const
1304 {
1305         string tmp = lyxrc.language_package;
1306         if (!lyxrc.language_global_options && tmp == "\\usepackage{babel}")
1307                 tmp = string("\\usepackage[") + lang_opts + "]{babel}";
1308         return tmp;
1309 }
1310
1311
1312 string const BufferParams::loadFonts(LaTeXFeatures & features, string const & rm,
1313                                      string const & sf, string const & tt,
1314                                      bool const & sc, bool const & osf,
1315                                      int const & sfscale, int const & ttscale) const
1316 {
1317         /* The LaTeX font world is in a flux. In the PSNFSS font interface,
1318            several packages have been replaced by others, that might not
1319            be installed on every system. We have to take care for that
1320            (see psnfss.pdf). We try to support all psnfss fonts as well
1321            as the fonts that have become de facto standard in the LaTeX
1322            world (e.g. Latin Modern). We do not support obsolete fonts
1323            (like PSLatex). In general, it should be possible to mix any
1324            rm font with any sf or tt font, respectively. (JSpitzm)
1325            TODO:
1326                 -- separate math fonts.
1327         */
1328
1329         if (rm == "default" && sf == "default" && tt == "default")
1330                 //nothing to do
1331                 return string();
1332
1333         ostringstream os;
1334
1335         // ROMAN FONTS
1336         // Computer Modern (must be explicitely selectable -- there might be classes
1337         // that define a different default font!
1338         if (rm == "cmr") {
1339                 os << "\\renewcommand{\\rmdefault}{cmr}\n";
1340                 // osf for Computer Modern needs eco.sty
1341                 if (osf)
1342                         os << "\\usepackage{eco}\n";
1343         }
1344         // Latin Modern Roman
1345         else if (rm == "lmodern")
1346                 os << "\\usepackage{lmodern}\n";
1347         // AE
1348         else if (rm == "ae") {
1349                 // not needed when using OT1 font encoding.
1350                 if (lyxrc.fontenc != "default")
1351                         os << "\\usepackage{ae,aecompl}\n";
1352         }
1353         // Times
1354         else if (rm == "times") {
1355                 // try to load the best available package
1356                 if (features.isAvailable("mathptmx"))
1357                         os << "\\usepackage{mathptmx}\n";
1358                 else if (features.isAvailable("mathptm"))
1359                         os << "\\usepackage{mathptm}\n";
1360                 else
1361                         os << "\\usepackage{times}\n";
1362         }
1363         // Palatino
1364         else if (rm == "palatino") {
1365                 // try to load the best available package
1366                 if (features.isAvailable("mathpazo")) {
1367                         os << "\\usepackage";
1368                         if (osf || sc) {
1369                                 os << '[';
1370                                 if (!osf)
1371                                         os << "sc";
1372                                 else
1373                                         // "osf" includes "sc"!
1374                                         os << "osf";
1375                                 os << ']';
1376                         }
1377                         os << "{mathpazo}\n";
1378                 }
1379                 else if (features.isAvailable("mathpple"))
1380                         os << "\\usepackage{mathpple}\n";
1381                 else
1382                         os << "\\usepackage{palatino}\n";
1383         }
1384         // Utopia
1385         else if (rm == "utopia") {
1386                 // fourier supersedes utopia.sty, but does
1387                 // not work with OT1 encoding.
1388                 if (features.isAvailable("fourier")
1389                     && lyxrc.fontenc != "default") {
1390                         os << "\\usepackage";
1391                         if (osf || sc) {
1392                                 os << '[';
1393                                 if (sc)
1394                                         os << "expert";
1395                                 if (osf && sc)
1396                                         os << ',';
1397                                 if (osf)
1398                                         os << "oldstyle";
1399                                 os << ']';
1400                         }
1401                         os << "{fourier}\n";
1402                 }
1403                 else
1404                         os << "\\usepackage{utopia}\n";
1405         }
1406         // Bera (complete fontset)
1407         else if (rm == "bera" && sf == "default" && tt == "default")
1408                 os << "\\usepackage{bera}\n";
1409         // everything else
1410         else if (rm != "default")
1411                 os << "\\usepackage" << "{" << rm << "}\n";
1412
1413         // SANS SERIF
1414         // Helvetica, Bera Sans
1415         if (sf == "helvet" || sf == "berasans") {
1416                 if (sfscale != 100)
1417                         os << "\\usepackage[scaled=" << float(sfscale) / 100
1418                            << "]{" << sf << "}\n";
1419                 else
1420                         os << "\\usepackage{" << sf << "}\n";
1421         }
1422         // Avant Garde
1423         else if (sf == "avant")
1424                 os << "\\usepackage{" << sf << "}\n";
1425         // Computer Modern, Latin Modern, CM Bright
1426         else if (sf != "default")
1427                 os << "\\renewcommand{\\sfdefault}{" << sf << "}\n";
1428
1429         // monospaced/typewriter
1430         // Courier, LuxiMono
1431         if (tt == "luximono" || tt == "beramono") {
1432                 if (ttscale != 100)
1433                         os << "\\usepackage[scaled=" << float(ttscale) / 100
1434                            << "]{" << tt << "}\n";
1435                 else
1436                         os << "\\usepackage{" << tt << "}\n";
1437         }
1438         // Courier
1439         else if (tt == "courier" )
1440                 os << "\\usepackage{" << tt << "}\n";
1441         // Computer Modern, Latin Modern, CM Bright
1442         else if  (tt != "default")
1443                 os << "\\renewcommand{\\ttdefault}{" << tt << "}\n";
1444
1445         return os.str();
1446 }