1 /**
2 * \file BufferParams.cpp
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 "LayoutFile.h"
22 #include "BranchList.h"
23 #include "Buffer.h"
24 #include "buffer_funcs.h"
25 #include "Bullet.h"
26 #include "CiteEnginesList.h"
27 #include "Color.h"
28 #include "ColorSet.h"
29 #include "Converter.h"
30 #include "Encoding.h"
31 #include "IndicesList.h"
32 #include "Language.h"
33 #include "LaTeXFeatures.h"
34 #include "LaTeXFonts.h"
35 #include "Length.h"
36 #include "ModuleList.h"
37 #include "Font.h"
38 #include "Lexer.h"
39 #include "LyXRC.h"
40 #include "OutputParams.h"
41 #include "Spacing.h"
42 #include "texstream.h"
43 #include "TexRow.h"
44 #include "VSpace.h"
45 #include "PDFOptions.h"
46
47 #include "frontends/alert.h"
48
49 #include "insets/InsetListingsParams.h"
50
51 #include "support/convert.h"
52 #include "support/debug.h"
53 #include "support/docstream.h"
54 #include "support/FileName.h"
55 #include "support/filetools.h"
56 #include "support/gettext.h"
57 #include "support/Messages.h"
58 #include "support/mutex.h"
59 #include "support/Package.h"
60 #include "support/Translator.h"
61 #include "support/lstrings.h"
62
63 #include <algorithm>
64 #include <sstream>
65
66 using namespace std;
67 using namespace lyx::support;
68
69
70 static char const * const string_paragraph_separation[] = {
71 "indent", "skip", ""
72 };
73
74
75 static char const * const string_quotes_style[] = {
76 "english", "swedish", "german", "polish", "swiss", "danish", "plain",
77 "british", "swedishg", "french", "frenchin", "russian", "cjk", "cjkangle", ""
78 };
79
80
81 static char const * const string_papersize[] = {
82 "default", "custom", "letterpaper", "legalpaper", "executivepaper",
83 "a0paper", "a1paper", "a2paper", "a3paper", "a4paper", "a5paper",
84 "a6paper", "b0paper", "b1paper", "b2paper","b3paper", "b4paper",
85 "b5paper", "b6paper", "c0paper", "c1paper", "c2paper", "c3paper",
86 "c4paper", "c5paper", "c6paper", "b0j", "b1j", "b2j", "b3j", "b4j", "b5j",
87 "b6j", ""
88 };
89
90
91 static char const * const string_orientation[] = {
92 "portrait", "landscape", ""
93 };
94
95
96 static char const * const tex_graphics[] = {
97 "default", "dvialw", "dvilaser", "dvipdf", "dvipdfm", "dvipdfmx",
98 "dvips", "dvipsone", "dvitops", "dviwin", "dviwindo", "dvi2ps", "emtex",
99 "ln", "oztex", "pctexhp", "pctexps", "pctexwin", "pctex32", "pdftex",
100 "psprint", "pubps", "tcidvi", "textures", "truetex", "vtex", "xdvi",
101 "xetex", "none", ""
102 };
103
104
105
106 namespace lyx {
107
108 // Local translators
109 namespace {
110
111 // Paragraph separation
112 typedef Translator<string, BufferParams::ParagraphSeparation> ParSepTranslator;
113
114
init_parseptranslator()115 ParSepTranslator const init_parseptranslator()
116 {
117 ParSepTranslator translator
118 (string_paragraph_separation[0], BufferParams::ParagraphIndentSeparation);
119 translator.addPair(string_paragraph_separation[1], BufferParams::ParagraphSkipSeparation);
120 return translator;
121 }
122
123
parseptranslator()124 ParSepTranslator const & parseptranslator()
125 {
126 static ParSepTranslator const translator =
127 init_parseptranslator();
128 return translator;
129 }
130
131
132 // Quotes style
133 typedef Translator<string, InsetQuotesParams::QuoteStyle> QuotesStyleTranslator;
134
135
init_quotesstyletranslator()136 QuotesStyleTranslator const init_quotesstyletranslator()
137 {
138 QuotesStyleTranslator translator
139 (string_quotes_style[0], InsetQuotesParams::EnglishQuotes);
140 translator.addPair(string_quotes_style[1], InsetQuotesParams::SwedishQuotes);
141 translator.addPair(string_quotes_style[2], InsetQuotesParams::GermanQuotes);
142 translator.addPair(string_quotes_style[3], InsetQuotesParams::PolishQuotes);
143 translator.addPair(string_quotes_style[4], InsetQuotesParams::SwissQuotes);
144 translator.addPair(string_quotes_style[5], InsetQuotesParams::DanishQuotes);
145 translator.addPair(string_quotes_style[6], InsetQuotesParams::PlainQuotes);
146 translator.addPair(string_quotes_style[7], InsetQuotesParams::BritishQuotes);
147 translator.addPair(string_quotes_style[8], InsetQuotesParams::SwedishGQuotes);
148 translator.addPair(string_quotes_style[9], InsetQuotesParams::FrenchQuotes);
149 translator.addPair(string_quotes_style[10], InsetQuotesParams::FrenchINQuotes);
150 translator.addPair(string_quotes_style[11], InsetQuotesParams::RussianQuotes);
151 translator.addPair(string_quotes_style[12], InsetQuotesParams::CJKQuotes);
152 translator.addPair(string_quotes_style[13], InsetQuotesParams::CJKAngleQuotes);
153 return translator;
154 }
155
156
quotesstyletranslator()157 QuotesStyleTranslator const & quotesstyletranslator()
158 {
159 static QuotesStyleTranslator const translator =
160 init_quotesstyletranslator();
161 return translator;
162 }
163
164
165 // Paper size
166 typedef Translator<string, PAPER_SIZE> PaperSizeTranslator;
167
168
initPaperSizeTranslator()169 static PaperSizeTranslator initPaperSizeTranslator()
170 {
171 PaperSizeTranslator translator(string_papersize[0], PAPER_DEFAULT);
172 translator.addPair(string_papersize[1], PAPER_CUSTOM);
173 translator.addPair(string_papersize[2], PAPER_USLETTER);
174 translator.addPair(string_papersize[3], PAPER_USLEGAL);
175 translator.addPair(string_papersize[4], PAPER_USEXECUTIVE);
176 translator.addPair(string_papersize[5], PAPER_A0);
177 translator.addPair(string_papersize[6], PAPER_A1);
178 translator.addPair(string_papersize[7], PAPER_A2);
179 translator.addPair(string_papersize[8], PAPER_A3);
180 translator.addPair(string_papersize[9], PAPER_A4);
181 translator.addPair(string_papersize[10], PAPER_A5);
182 translator.addPair(string_papersize[11], PAPER_A6);
183 translator.addPair(string_papersize[12], PAPER_B0);
184 translator.addPair(string_papersize[13], PAPER_B1);
185 translator.addPair(string_papersize[14], PAPER_B2);
186 translator.addPair(string_papersize[15], PAPER_B3);
187 translator.addPair(string_papersize[16], PAPER_B4);
188 translator.addPair(string_papersize[17], PAPER_B5);
189 translator.addPair(string_papersize[18], PAPER_B6);
190 translator.addPair(string_papersize[19], PAPER_C0);
191 translator.addPair(string_papersize[20], PAPER_C1);
192 translator.addPair(string_papersize[21], PAPER_C2);
193 translator.addPair(string_papersize[22], PAPER_C3);
194 translator.addPair(string_papersize[23], PAPER_C4);
195 translator.addPair(string_papersize[24], PAPER_C5);
196 translator.addPair(string_papersize[25], PAPER_C6);
197 translator.addPair(string_papersize[26], PAPER_JISB0);
198 translator.addPair(string_papersize[27], PAPER_JISB1);
199 translator.addPair(string_papersize[28], PAPER_JISB2);
200 translator.addPair(string_papersize[29], PAPER_JISB3);
201 translator.addPair(string_papersize[30], PAPER_JISB4);
202 translator.addPair(string_papersize[31], PAPER_JISB5);
203 translator.addPair(string_papersize[32], PAPER_JISB6);
204 return translator;
205 }
206
207
papersizetranslator()208 PaperSizeTranslator const & papersizetranslator()
209 {
210 static PaperSizeTranslator const translator =
211 initPaperSizeTranslator();
212 return translator;
213 }
214
215
216 // Paper orientation
217 typedef Translator<string, PAPER_ORIENTATION> PaperOrientationTranslator;
218
219
init_paperorientationtranslator()220 PaperOrientationTranslator const init_paperorientationtranslator()
221 {
222 PaperOrientationTranslator translator(string_orientation[0], ORIENTATION_PORTRAIT);
223 translator.addPair(string_orientation[1], ORIENTATION_LANDSCAPE);
224 return translator;
225 }
226
227
paperorientationtranslator()228 PaperOrientationTranslator const & paperorientationtranslator()
229 {
230 static PaperOrientationTranslator const translator =
231 init_paperorientationtranslator();
232 return translator;
233 }
234
235
236 // Page sides
237 typedef Translator<int, PageSides> SidesTranslator;
238
239
init_sidestranslator()240 SidesTranslator const init_sidestranslator()
241 {
242 SidesTranslator translator(1, OneSide);
243 translator.addPair(2, TwoSides);
244 return translator;
245 }
246
247
sidestranslator()248 SidesTranslator const & sidestranslator()
249 {
250 static SidesTranslator const translator = init_sidestranslator();
251 return translator;
252 }
253
254
255 // LaTeX packages
256 typedef Translator<int, BufferParams::Package> PackageTranslator;
257
258
init_packagetranslator()259 PackageTranslator const init_packagetranslator()
260 {
261 PackageTranslator translator(0, BufferParams::package_off);
262 translator.addPair(1, BufferParams::package_auto);
263 translator.addPair(2, BufferParams::package_on);
264 return translator;
265 }
266
267
packagetranslator()268 PackageTranslator const & packagetranslator()
269 {
270 static PackageTranslator const translator =
271 init_packagetranslator();
272 return translator;
273 }
274
275
276 // Spacing
277 typedef Translator<string, Spacing::Space> SpaceTranslator;
278
279
init_spacetranslator()280 SpaceTranslator const init_spacetranslator()
281 {
282 SpaceTranslator translator("default", Spacing::Default);
283 translator.addPair("single", Spacing::Single);
284 translator.addPair("onehalf", Spacing::Onehalf);
285 translator.addPair("double", Spacing::Double);
286 translator.addPair("other", Spacing::Other);
287 return translator;
288 }
289
290
spacetranslator()291 SpaceTranslator const & spacetranslator()
292 {
293 static SpaceTranslator const translator = init_spacetranslator();
294 return translator;
295 }
296
297
inSystemDir(FileName const & document_dir,string & system_dir)298 bool inSystemDir(FileName const & document_dir, string & system_dir)
299 {
300 // A document is assumed to be in a system LyX directory (not
301 // necessarily the system directory of the running instance)
302 // if both "configure.py" and "chkconfig.ltx" are found in
303 // either document_dir/../ or document_dir/../../.
304 // If true, the system directory path is returned in system_dir
305 // with a trailing path separator.
306
307 string const msg = "Checking whether document is in a system dir...";
308
309 string dir = document_dir.absFileName();
310
311 for (int i = 0; i < 2; ++i) {
312 dir = addPath(dir, "..");
313 if (!fileSearch(dir, "configure.py").empty() &&
314 !fileSearch(dir, "chkconfig.ltx").empty()) {
315 LYXERR(Debug::FILES, msg << " yes");
316 system_dir = addPath(FileName(dir).realPath(), "");
317 return true;
318 }
319 }
320
321 LYXERR(Debug::FILES, msg << " no");
322 system_dir = string();
323 return false;
324 }
325
326 } // namespace
327
328
329 class BufferParams::Impl
330 {
331 public:
332 Impl();
333
334 AuthorList authorlist;
335 BranchList branchlist;
336 Bullet temp_bullets[4];
337 Bullet user_defined_bullets[4];
338 IndicesList indiceslist;
339 Spacing spacing;
340 Length parindent;
341 Length mathindent;
342 /** This is the amount of space used for paragraph_separation "skip",
343 * and for detached paragraphs in "indented" documents.
344 */
345 VSpace defskip;
346 PDFOptions pdfoptions;
347 LayoutFileIndex baseClass_;
348 FormatList exportableFormatList;
349 FormatList viewableFormatList;
350 bool isViewCacheValid;
351 bool isExportCacheValid;
352 };
353
354
Impl()355 BufferParams::Impl::Impl()
356 : defskip(VSpace::MEDSKIP), baseClass_(string("")),
357 isViewCacheValid(false), isExportCacheValid(false)
358 {
359 // set initial author
360 // FIXME UNICODE
361 authorlist.record(Author(from_utf8(lyxrc.user_name), from_utf8(lyxrc.user_email)));
362 }
363
364
365 BufferParams::Impl *
clone(BufferParams::Impl const * ptr)366 BufferParams::MemoryTraits::clone(BufferParams::Impl const * ptr)
367 {
368 LBUFERR(ptr);
369 return new BufferParams::Impl(*ptr);
370 }
371
372
destroy(BufferParams::Impl * ptr)373 void BufferParams::MemoryTraits::destroy(BufferParams::Impl * ptr)
374 {
375 delete ptr;
376 }
377
378
BufferParams()379 BufferParams::BufferParams()
380 : pimpl_(new Impl)
381 {
382 setBaseClass(defaultBaseclass());
383 cite_engine_.push_back("basic");
384 cite_engine_type_ = ENGINE_TYPE_DEFAULT;
385 makeDocumentClass();
386 paragraph_separation = ParagraphIndentSeparation;
387 is_math_indent = false;
388 math_numbering_side = DEFAULT;
389 quotes_style = InsetQuotesParams::EnglishQuotes;
390 dynamic_quotes = false;
391 fontsize = "default";
392
393 /* PaperLayout */
394 papersize = PAPER_DEFAULT;
395 orientation = ORIENTATION_PORTRAIT;
396 use_geometry = false;
397 biblio_style = string();
398 use_bibtopic = false;
399 multibib = string();
400 use_indices = false;
401 save_transient_properties = true;
402 track_changes = false;
403 output_changes = false;
404 use_default_options = true;
405 maintain_unincluded_children = false;
406 secnumdepth = 3;
407 tocdepth = 3;
408 language = default_language;
409 fontenc = "global";
410 fonts_roman[0] = "default";
411 fonts_roman[1] = "default";
412 fonts_sans[0] = "default";
413 fonts_sans[1] = "default";
414 fonts_typewriter[0] = "default";
415 fonts_typewriter[1] = "default";
416 fonts_math[0] = "auto";
417 fonts_math[1] = "auto";
418 fonts_default_family = "default";
419 useNonTeXFonts = false;
420 use_microtype = false;
421 use_dash_ligatures = true;
422 fonts_expert_sc = false;
423 fonts_old_figures = false;
424 fonts_sans_scale[0] = 100;
425 fonts_sans_scale[1] = 100;
426 fonts_typewriter_scale[0] = 100;
427 fonts_typewriter_scale[1] = 100;
428 inputenc = "auto";
429 lang_package = "default";
430 graphics_driver = "default";
431 default_output_format = "default";
432 bibtex_command = "default";
433 index_command = "default";
434 sides = OneSide;
435 columns = 1;
436 listings_params = string();
437 pagestyle = "default";
438 suppress_date = false;
439 justification = true;
440 // no color is the default (white)
441 backgroundcolor = lyx::rgbFromHexName("#ffffff");
442 isbackgroundcolor = false;
443 // no color is the default (black)
444 fontcolor = lyx::rgbFromHexName("#000000");
445 isfontcolor = false;
446 // light gray is the default font color for greyed-out notes
447 notefontcolor = lyx::rgbFromHexName("#cccccc");
448 boxbgcolor = lyx::rgbFromHexName("#ff0000");
449 compressed = lyxrc.save_compressed;
450 for (int iter = 0; iter < 4; ++iter) {
451 user_defined_bullet(iter) = ITEMIZE_DEFAULTS[iter];
452 temp_bullet(iter) = ITEMIZE_DEFAULTS[iter];
453 }
454 // default index
455 indiceslist().addDefault(B_("Index"));
456 html_be_strict = false;
457 html_math_output = MathML;
458 html_math_img_scale = 1.0;
459 html_css_as_file = false;
460 display_pixel_ratio = 1.0;
461
462 shell_escape = false;
463 output_sync = false;
464 use_refstyle = true;
465 use_minted = false;
466
467 // map current author
468 author_map_[pimpl_->authorlist.get(0).bufferId()] = 0;
469 }
470
471
B_(string const & l10n) const472 docstring BufferParams::B_(string const & l10n) const
473 {
474 LASSERT(language, return from_utf8(l10n));
475 return getMessages(language->code()).get(l10n);
476 }
477
478
use_package(std::string const & p) const479 BufferParams::Package BufferParams::use_package(std::string const & p) const
480 {
481 PackageMap::const_iterator it = use_packages.find(p);
482 if (it == use_packages.end())
483 return package_auto;
484 return it->second;
485 }
486
487
use_package(std::string const & p,BufferParams::Package u)488 void BufferParams::use_package(std::string const & p, BufferParams::Package u)
489 {
490 use_packages[p] = u;
491 }
492
493
auto_packages()494 map<string, string> const & BufferParams::auto_packages()
495 {
496 static map<string, string> packages;
497 if (packages.empty()) {
498 // We could have a race condition here that two threads
499 // discover an empty map at the same time and want to fill
500 // it, but that is no problem, since the same contents is
501 // filled in twice then. Having the locker inside the
502 // packages.empty() condition has the advantage that we
503 // don't need the mutex overhead for simple reading.
504 static Mutex mutex;
505 Mutex::Locker locker(&mutex);
506 // adding a package here implies a file format change!
507 packages["amsmath"] =
508 N_("The LaTeX package amsmath is only used if AMS formula types or symbols from the AMS math toolbars are inserted into formulas");
509 packages["amssymb"] =
510 N_("The LaTeX package amssymb is only used if symbols from the AMS math toolbars are inserted into formulas");
511 packages["cancel"] =
512 N_("The LaTeX package cancel is only used if \\cancel commands are used in formulas");
513 packages["esint"] =
514 N_("The LaTeX package esint is only used if special integral symbols are inserted into formulas");
515 packages["mathdots"] =
516 N_("The LaTeX package mathdots is only used if the command \\iddots is inserted into formulas");
517 packages["mathtools"] =
518 N_("The LaTeX package mathtools is only used if some mathematical relations are inserted into formulas");
519 packages["mhchem"] =
520 N_("The LaTeX package mhchem is only used if either the command \\ce or \\cf is inserted into formulas");
521 packages["stackrel"] =
522 N_("The LaTeX package stackrel is only used if the command \\stackrel with subscript is inserted into formulas");
523 packages["stmaryrd"] =
524 N_("The LaTeX package stmaryrd is only used if symbols from the St Mary's Road symbol font for theoretical computer science are inserted into formulas");
525 packages["undertilde"] =
526 N_("The LaTeX package undertilde is only used if you use the math frame decoration 'utilde'");
527 }
528 return packages;
529 }
530
531
useBibtopic() const532 bool BufferParams::useBibtopic() const
533 {
534 if (useBiblatex())
535 return false;
536 return (use_bibtopic || (!multibib.empty() && multibib != "child"));
537 }
538
539
authors()540 AuthorList & BufferParams::authors()
541 {
542 return pimpl_->authorlist;
543 }
544
545
authors() const546 AuthorList const & BufferParams::authors() const
547 {
548 return pimpl_->authorlist;
549 }
550
551
addAuthor(Author a)552 void BufferParams::addAuthor(Author a)
553 {
554 author_map_[a.bufferId()] = pimpl_->authorlist.record(a);
555 }
556
557
branchlist()558 BranchList & BufferParams::branchlist()
559 {
560 return pimpl_->branchlist;
561 }
562
563
branchlist() const564 BranchList const & BufferParams::branchlist() const
565 {
566 return pimpl_->branchlist;
567 }
568
569
indiceslist()570 IndicesList & BufferParams::indiceslist()
571 {
572 return pimpl_->indiceslist;
573 }
574
575
indiceslist() const576 IndicesList const & BufferParams::indiceslist() const
577 {
578 return pimpl_->indiceslist;
579 }
580
581
temp_bullet(lyx::size_type const index)582 Bullet & BufferParams::temp_bullet(lyx::size_type const index)
583 {
584 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
585 return pimpl_->temp_bullets[index];
586 }
587
588
temp_bullet(lyx::size_type const index) const589 Bullet const & BufferParams::temp_bullet(lyx::size_type const index) const
590 {
591 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
592 return pimpl_->temp_bullets[index];
593 }
594
595
user_defined_bullet(lyx::size_type const index)596 Bullet & BufferParams::user_defined_bullet(lyx::size_type const index)
597 {
598 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
599 return pimpl_->user_defined_bullets[index];
600 }
601
602
user_defined_bullet(lyx::size_type const index) const603 Bullet const & BufferParams::user_defined_bullet(lyx::size_type const index) const
604 {
605 LASSERT(index < 4, return pimpl_->temp_bullets[0]);
606 return pimpl_->user_defined_bullets[index];
607 }
608
609
spacing()610 Spacing & BufferParams::spacing()
611 {
612 return pimpl_->spacing;
613 }
614
615
spacing() const616 Spacing const & BufferParams::spacing() const
617 {
618 return pimpl_->spacing;
619 }
620
621
pdfoptions()622 PDFOptions & BufferParams::pdfoptions()
623 {
624 return pimpl_->pdfoptions;
625 }
626
627
pdfoptions() const628 PDFOptions const & BufferParams::pdfoptions() const
629 {
630 return pimpl_->pdfoptions;
631 }
632
633
getMathIndent() const634 Length const & BufferParams::getMathIndent() const
635 {
636 return pimpl_->mathindent;
637 }
638
639
setMathIndent(Length const & indent)640 void BufferParams::setMathIndent(Length const & indent)
641 {
642 pimpl_->mathindent = indent;
643 }
644
645
getParIndent() const646 Length const & BufferParams::getParIndent() const
647 {
648 return pimpl_->parindent;
649 }
650
651
setParIndent(Length const & indent)652 void BufferParams::setParIndent(Length const & indent)
653 {
654 pimpl_->parindent = indent;
655 }
656
657
getDefSkip() const658 VSpace const & BufferParams::getDefSkip() const
659 {
660 return pimpl_->defskip;
661 }
662
663
setDefSkip(VSpace const & vs)664 void BufferParams::setDefSkip(VSpace const & vs)
665 {
666 // DEFSKIP will cause an infinite loop
667 LASSERT(vs.kind() != VSpace::DEFSKIP, return);
668 pimpl_->defskip = vs;
669 }
670
671
getMathNumber() const672 BufferParams::MathNumber BufferParams::getMathNumber() const
673 {
674 if (math_numbering_side != DEFAULT)
675 return math_numbering_side;
676 // FIXME: do not hardcode language here
677 else if (language->lang() == "arabic_arabi"
678 || documentClass().provides("leqno"))
679 return LEFT;
680 else
681 return RIGHT;
682 }
683
684
readToken(Lexer & lex,string const & token,FileName const & filepath)685 string BufferParams::readToken(Lexer & lex, string const & token,
686 FileName const & filepath)
687 {
688 string result;
689
690 if (token == "\\textclass") {
691 lex.next();
692 string const classname = lex.getString();
693 // if there exists a local layout file, ignore the system one
694 // NOTE: in this case, the textclass (.cls file) is assumed to
695 // be available.
696 string tcp;
697 LayoutFileList & bcl = LayoutFileList::get();
698 if (!filepath.empty()) {
699 // If classname is an absolute path, the document is
700 // using a local layout file which could not be accessed
701 // by a relative path. In this case the path is correct
702 // even if the document was moved to a different
703 // location. However, we will have a problem if the
704 // document was generated on a different platform.
705 bool isabsolute = FileName::isAbsolute(classname);
706 string const classpath = onlyPath(classname);
707 string const path = isabsolute ? classpath
708 : FileName(addPath(filepath.absFileName(),
709 classpath)).realPath();
710 string const oldpath = isabsolute ? string()
711 : FileName(addPath(origin, classpath)).realPath();
712 tcp = bcl.addLocalLayout(onlyFileName(classname), path, oldpath);
713 }
714 // that returns non-empty if a "local" layout file is found.
715 if (!tcp.empty()) {
716 result = to_utf8(makeRelPath(from_utf8(onlyPath(tcp)),
717 from_utf8(filepath.absFileName())));
718 if (result.empty())
719 result = ".";
720 setBaseClass(onlyFileName(tcp));
721 } else
722 setBaseClass(onlyFileName(classname));
723 // We assume that a tex class exists for local or unknown
724 // layouts so this warning, will only be given for system layouts.
725 if (!baseClass()->isTeXClassAvailable()) {
726 docstring const desc =
727 translateIfPossible(from_utf8(baseClass()->description()));
728 docstring const prereqs =
729 from_utf8(baseClass()->prerequisites());
730 docstring const msg =
731 bformat(_("The selected document class\n"
732 "\t%1$s\n"
733 "requires external files that are not available.\n"
734 "The document class can still be used, but the\n"
735 "document cannot be compiled until the following\n"
736 "prerequisites are installed:\n"
737 "\t%2$s\n"
738 "See section 3.1.2.2 (Class Availability) of the\n"
739 "User's Guide for more information."), desc, prereqs);
740 frontend::Alert::warning(_("Document class not available"),
741 msg, true);
742 }
743 } else if (token == "\\save_transient_properties") {
744 lex >> save_transient_properties;
745 } else if (token == "\\origin") {
746 lex.eatLine();
747 origin = lex.getString();
748 string const sysdirprefix = "/systemlyxdir/";
749 if (prefixIs(origin, sysdirprefix)) {
750 string docsys;
751 if (inSystemDir(filepath, docsys))
752 origin.replace(0, sysdirprefix.length() - 1, docsys);
753 else
754 origin.replace(0, sysdirprefix.length() - 1,
755 package().system_support().absFileName());
756 }
757 } else if (token == "\\begin_preamble") {
758 readPreamble(lex);
759 } else if (token == "\\begin_local_layout") {
760 readLocalLayout(lex, false);
761 } else if (token == "\\begin_forced_local_layout") {
762 readLocalLayout(lex, true);
763 } else if (token == "\\begin_modules") {
764 readModules(lex);
765 } else if (token == "\\begin_removed_modules") {
766 readRemovedModules(lex);
767 } else if (token == "\\begin_includeonly") {
768 readIncludeonly(lex);
769 } else if (token == "\\maintain_unincluded_children") {
770 lex >> maintain_unincluded_children;
771 } else if (token == "\\options") {
772 lex.eatLine();
773 options = lex.getString();
774 } else if (token == "\\use_default_options") {
775 lex >> use_default_options;
776 } else if (token == "\\master") {
777 lex.eatLine();
778 master = lex.getString();
779 if (!filepath.empty() && FileName::isAbsolute(origin)) {
780 bool const isabs = FileName::isAbsolute(master);
781 FileName const abspath(isabs ? master : origin + master);
782 bool const moved = filepath != FileName(origin);
783 if (moved && abspath.exists()) {
784 docstring const path = isabs
785 ? from_utf8(master)
786 : from_utf8(abspath.realPath());
787 docstring const refpath =
788 from_utf8(filepath.absFileName());
789 master = to_utf8(makeRelPath(path, refpath));
790 }
791 }
792 } else if (token == "\\suppress_date") {
793 lex >> suppress_date;
794 } else if (token == "\\justification") {
795 lex >> justification;
796 } else if (token == "\\language") {
797 readLanguage(lex);
798 } else if (token == "\\language_package") {
799 lex.eatLine();
800 lang_package = lex.getString();
801 } else if (token == "\\inputencoding") {
802 lex >> inputenc;
803 } else if (token == "\\graphics") {
804 readGraphicsDriver(lex);
805 } else if (token == "\\default_output_format") {
806 lex >> default_output_format;
807 } else if (token == "\\bibtex_command") {
808 lex.eatLine();
809 bibtex_command = lex.getString();
810 } else if (token == "\\index_command") {
811 lex.eatLine();
812 index_command = lex.getString();
813 } else if (token == "\\fontencoding") {
814 lex.eatLine();
815 fontenc = lex.getString();
816 } else if (token == "\\font_roman") {
817 lex >> fonts_roman[0];
818 lex >> fonts_roman[1];
819 } else if (token == "\\font_sans") {
820 lex >> fonts_sans[0];
821 lex >> fonts_sans[1];
822 } else if (token == "\\font_typewriter") {
823 lex >> fonts_typewriter[0];
824 lex >> fonts_typewriter[1];
825 } else if (token == "\\font_math") {
826 lex >> fonts_math[0];
827 lex >> fonts_math[1];
828 } else if (token == "\\font_default_family") {
829 lex >> fonts_default_family;
830 } else if (token == "\\use_non_tex_fonts") {
831 lex >> useNonTeXFonts;
832 } else if (token == "\\font_sc") {
833 lex >> fonts_expert_sc;
834 } else if (token == "\\font_osf") {
835 lex >> fonts_old_figures;
836 } else if (token == "\\font_sf_scale") {
837 lex >> fonts_sans_scale[0];
838 lex >> fonts_sans_scale[1];
839 } else if (token == "\\font_tt_scale") {
840 lex >> fonts_typewriter_scale[0];
841 lex >> fonts_typewriter_scale[1];
842 } else if (token == "\\font_cjk") {
843 lex >> fonts_cjk;
844 } else if (token == "\\use_microtype") {
845 lex >> use_microtype;
846 } else if (token == "\\use_dash_ligatures") {
847 lex >> use_dash_ligatures;
848 } else if (token == "\\paragraph_separation") {
849 string parsep;
850 lex >> parsep;
851 paragraph_separation = parseptranslator().find(parsep);
852 } else if (token == "\\paragraph_indentation") {
853 lex.next();
854 string parindent = lex.getString();
855 if (parindent == "default")
856 pimpl_->parindent = Length();
857 else
858 pimpl_->parindent = Length(parindent);
859 } else if (token == "\\defskip") {
860 lex.next();
861 string const defskip = lex.getString();
862 pimpl_->defskip = VSpace(defskip);
863 if (pimpl_->defskip.kind() == VSpace::DEFSKIP)
864 // that is invalid
865 pimpl_->defskip = VSpace(VSpace::MEDSKIP);
866 } else if (token == "\\is_math_indent") {
867 lex >> is_math_indent;
868 } else if (token == "\\math_indentation") {
869 lex.next();
870 string mathindent = lex.getString();
871 if (mathindent == "default")
872 pimpl_->mathindent = Length();
873 else
874 pimpl_->mathindent = Length(mathindent);
875 } else if (token == "\\math_numbering_side") {
876 string tmp;
877 lex >> tmp;
878 if (tmp == "left")
879 math_numbering_side = LEFT;
880 else if (tmp == "right")
881 math_numbering_side = RIGHT;
882 else
883 math_numbering_side = DEFAULT;
884 } else if (token == "\\quotes_style") {
885 string qstyle;
886 lex >> qstyle;
887 quotes_style = quotesstyletranslator().find(qstyle);
888 } else if (token == "\\dynamic_quotes") {
889 lex >> dynamic_quotes;
890 } else if (token == "\\papersize") {
891 string ppsize;
892 lex >> ppsize;
893 papersize = papersizetranslator().find(ppsize);
894 } else if (token == "\\use_geometry") {
895 lex >> use_geometry;
896 } else if (token == "\\use_package") {
897 string package;
898 int use;
899 lex >> package;
900 lex >> use;
901 use_package(package, packagetranslator().find(use));
902 } else if (token == "\\cite_engine") {
903 lex.eatLine();
904 vector<string> engine = getVectorFromString(lex.getString());
905 setCiteEngine(engine);
906 } else if (token == "\\cite_engine_type") {
907 string engine_type;
908 lex >> engine_type;
909 cite_engine_type_ = theCiteEnginesList.getType(engine_type);
910 } else if (token == "\\biblio_style") {
911 lex.eatLine();
912 biblio_style = lex.getString();
913 } else if (token == "\\biblio_options") {
914 lex.eatLine();
915 biblio_opts = trim(lex.getString());
916 } else if (token == "\\biblatex_bibstyle") {
917 lex.eatLine();
918 biblatex_bibstyle = trim(lex.getString());
919 } else if (token == "\\biblatex_citestyle") {
920 lex.eatLine();
921 biblatex_citestyle = trim(lex.getString());
922 } else if (token == "\\use_bibtopic") {
923 lex >> use_bibtopic;
924 } else if (token == "\\multibib") {
925 lex >> multibib;
926 } else if (token == "\\use_indices") {
927 lex >> use_indices;
928 } else if (token == "\\tracking_changes") {
929 lex >> track_changes;
930 } else if (token == "\\output_changes") {
931 lex >> output_changes;
932 } else if (token == "\\branch") {
933 lex.eatLine();
934 docstring branch = lex.getDocString();
935 branchlist().add(branch);
936 while (true) {
937 lex.next();
938 string const tok = lex.getString();
939 if (tok == "\\end_branch")
940 break;
941 Branch * branch_ptr = branchlist().find(branch);
942 if (tok == "\\selected") {
943 lex.next();
944 if (branch_ptr)
945 branch_ptr->setSelected(lex.getInteger());
946 }
947 if (tok == "\\filename_suffix") {
948 lex.next();
949 if (branch_ptr)
950 branch_ptr->setFileNameSuffix(lex.getInteger());
951 }
952 if (tok == "\\color") {
953 lex.eatLine();
954 string color = lex.getString();
955 if (branch_ptr)
956 branch_ptr->setColor(color);
957 // Update also the Color table:
958 if (color == "none")
959 color = lcolor.getX11Name(Color_background);
960 // FIXME UNICODE
961 lcolor.setColor(to_utf8(branch), color);
962 }
963 }
964 } else if (token == "\\index") {
965 lex.eatLine();
966 docstring index = lex.getDocString();
967 docstring shortcut;
968 indiceslist().add(index);
969 while (true) {
970 lex.next();
971 string const tok = lex.getString();
972 if (tok == "\\end_index")
973 break;
974 Index * index_ptr = indiceslist().find(index);
975 if (tok == "\\shortcut") {
976 lex.next();
977 shortcut = lex.getDocString();
978 if (index_ptr)
979 index_ptr->setShortcut(shortcut);
980 }
981 if (tok == "\\color") {
982 lex.eatLine();
983 string color = lex.getString();
984 if (index_ptr)
985 index_ptr->setColor(color);
986 // Update also the Color table:
987 if (color == "none")
988 color = lcolor.getX11Name(Color_background);
989 // FIXME UNICODE
990 if (!shortcut.empty())
991 lcolor.setColor(to_utf8(shortcut), color);
992 }
993 }
994 } else if (token == "\\author") {
995 lex.eatLine();
996 istringstream ss(lex.getString());
997 Author a;
998 ss >> a;
999 addAuthor(a);
1000 } else if (token == "\\paperorientation") {
1001 string orient;
1002 lex >> orient;
1003 orientation = paperorientationtranslator().find(orient);
1004 } else if (token == "\\backgroundcolor") {
1005 lex.eatLine();
1006 backgroundcolor = lyx::rgbFromHexName(lex.getString());
1007 isbackgroundcolor = true;
1008 } else if (token == "\\fontcolor") {
1009 lex.eatLine();
1010 fontcolor = lyx::rgbFromHexName(lex.getString());
1011 isfontcolor = true;
1012 } else if (token == "\\notefontcolor") {
1013 lex.eatLine();
1014 string color = lex.getString();
1015 notefontcolor = lyx::rgbFromHexName(color);
1016 lcolor.setColor("notefontcolor", color);
1017 } else if (token == "\\boxbgcolor") {
1018 lex.eatLine();
1019 string color = lex.getString();
1020 boxbgcolor = lyx::rgbFromHexName(color);
1021 lcolor.setColor("boxbgcolor", color);
1022 } else if (token == "\\paperwidth") {
1023 lex >> paperwidth;
1024 } else if (token == "\\paperheight") {
1025 lex >> paperheight;
1026 } else if (token == "\\leftmargin") {
1027 lex >> leftmargin;
1028 } else if (token == "\\topmargin") {
1029 lex >> topmargin;
1030 } else if (token == "\\rightmargin") {
1031 lex >> rightmargin;
1032 } else if (token == "\\bottommargin") {
1033 lex >> bottommargin;
1034 } else if (token == "\\headheight") {
1035 lex >> headheight;
1036 } else if (token == "\\headsep") {
1037 lex >> headsep;
1038 } else if (token == "\\footskip") {
1039 lex >> footskip;
1040 } else if (token == "\\columnsep") {
1041 lex >> columnsep;
1042 } else if (token == "\\paperfontsize") {
1043 lex >> fontsize;
1044 } else if (token == "\\papercolumns") {
1045 lex >> columns;
1046 } else if (token == "\\listings_params") {
1047 string par;
1048 lex >> par;
1049 listings_params = InsetListingsParams(par).params();
1050 } else if (token == "\\papersides") {
1051 int psides;
1052 lex >> psides;
1053 sides = sidestranslator().find(psides);
1054 } else if (token == "\\paperpagestyle") {
1055 lex >> pagestyle;
1056 } else if (token == "\\bullet") {
1057 readBullets(lex);
1058 } else if (token == "\\bulletLaTeX") {
1059 readBulletsLaTeX(lex);
1060 } else if (token == "\\secnumdepth") {
1061 lex >> secnumdepth;
1062 } else if (token == "\\tocdepth") {
1063 lex >> tocdepth;
1064 } else if (token == "\\spacing") {
1065 string nspacing;
1066 lex >> nspacing;
1067 string tmp_val;
1068 if (nspacing == "other") {
1069 lex >> tmp_val;
1070 }
1071 spacing().set(spacetranslator().find(nspacing), tmp_val);
1072 } else if (token == "\\float_placement") {
1073 lex >> float_placement;
1074
1075 } else if (prefixIs(token, "\\pdf_") || token == "\\use_hyperref") {
1076 string toktmp = pdfoptions().readToken(lex, token);
1077 if (!toktmp.empty()) {
1078 lyxerr << "PDFOptions::readToken(): Unknown token: " <<
1079 toktmp << endl;
1080 return toktmp;
1081 }
1082 } else if (token == "\\html_math_output") {
1083 int temp;
1084 lex >> temp;
1085 html_math_output = static_cast<MathOutput>(temp);
1086 } else if (token == "\\html_be_strict") {
1087 lex >> html_be_strict;
1088 } else if (token == "\\html_css_as_file") {
1089 lex >> html_css_as_file;
1090 } else if (token == "\\html_math_img_scale") {
1091 lex >> html_math_img_scale;
1092 } else if (token == "\\html_latex_start") {
1093 lex.eatLine();
1094 html_latex_start = lex.getString();
1095 } else if (token == "\\html_latex_end") {
1096 lex.eatLine();
1097 html_latex_end = lex.getString();
1098 } else if (token == "\\output_sync") {
1099 lex >> output_sync;
1100 } else if (token == "\\output_sync_macro") {
1101 lex >> output_sync_macro;
1102 } else if (token == "\\use_refstyle") {
1103 lex >> use_refstyle;
1104 } else if (token == "\\use_minted") {
1105 lex >> use_minted;
1106 } else {
1107 lyxerr << "BufferParams::readToken(): Unknown token: " <<
1108 token << endl;
1109 return token;
1110 }
1111
1112 return result;
1113 }
1114
1115
1116 namespace {
1117 // Quote argument if it contains spaces
quoteIfNeeded(string const & str)1118 string quoteIfNeeded(string const & str) {
1119 if (contains(str, ' '))
1120 return "\"" + str + "\"";
1121 return str;
1122 }
1123 } // namespace
1124
1125
writeFile(ostream & os,Buffer const * buf) const1126 void BufferParams::writeFile(ostream & os, Buffer const * buf) const
1127 {
1128 // The top of the file is written by the buffer.
1129 // Prints out the buffer info into the .lyx file given by file
1130
1131 os << "\\save_transient_properties "
1132 << convert<string>(save_transient_properties) << '\n';
1133
1134 // the document directory (must end with a path separator)
1135 // realPath() is used to resolve symlinks, while addPath(..., "")
1136 // ensures a trailing path separator.
1137 string docsys;
1138 string filepath = addPath(buf->fileName().onlyPath().realPath(), "");
1139 string const sysdir = inSystemDir(FileName(filepath), docsys) ? docsys
1140 : addPath(package().system_support().realPath(), "");
1141 string const relpath =
1142 to_utf8(makeRelPath(from_utf8(filepath), from_utf8(sysdir)));
1143 if (!prefixIs(relpath, "../") && !FileName::isAbsolute(relpath))
1144 filepath = addPath("/systemlyxdir", relpath);
1145 else if (!save_transient_properties || !lyxrc.save_origin)
1146 filepath = "unavailable";
1147 os << "\\origin " << quoteIfNeeded(filepath) << '\n';
1148
1149 // the textclass
1150 os << "\\textclass "
1151 << quoteIfNeeded(buf->includedFilePath(addName(buf->layoutPos(),
1152 baseClass()->name()), "layout"))
1153 << '\n';
1154
1155 // then the preamble
1156 if (!preamble.empty()) {
1157 // remove '\n' from the end of preamble
1158 docstring const tmppreamble = rtrim(preamble, "\n");
1159 os << "\\begin_preamble\n"
1160 << to_utf8(tmppreamble)
1161 << "\n\\end_preamble\n";
1162 }
1163
1164 // the options
1165 if (!options.empty()) {
1166 os << "\\options " << options << '\n';
1167 }
1168
1169 // use the class options defined in the layout?
1170 os << "\\use_default_options "
1171 << convert<string>(use_default_options) << "\n";
1172
1173 // the master document
1174 if (!master.empty()) {
1175 os << "\\master " << master << '\n';
1176 }
1177
1178 // removed modules
1179 if (!removed_modules_.empty()) {
1180 os << "\\begin_removed_modules" << '\n';
1181 list<string>::const_iterator it = removed_modules_.begin();
1182 list<string>::const_iterator en = removed_modules_.end();
1183 for (; it != en; ++it)
1184 os << *it << '\n';
1185 os << "\\end_removed_modules" << '\n';
1186 }
1187
1188 // the modules
1189 if (!layout_modules_.empty()) {
1190 os << "\\begin_modules" << '\n';
1191 LayoutModuleList::const_iterator it = layout_modules_.begin();
1192 LayoutModuleList::const_iterator en = layout_modules_.end();
1193 for (; it != en; ++it)
1194 os << *it << '\n';
1195 os << "\\end_modules" << '\n';
1196 }
1197
1198 // includeonly
1199 if (!included_children_.empty()) {
1200 os << "\\begin_includeonly" << '\n';
1201 list<string>::const_iterator it = included_children_.begin();
1202 list<string>::const_iterator en = included_children_.end();
1203 for (; it != en; ++it)
1204 os << *it << '\n';
1205 os << "\\end_includeonly" << '\n';
1206 }
1207 os << "\\maintain_unincluded_children "
1208 << convert<string>(maintain_unincluded_children) << '\n';
1209
1210 // local layout information
1211 docstring const local_layout = getLocalLayout(false);
1212 if (!local_layout.empty()) {
1213 // remove '\n' from the end
1214 docstring const tmplocal = rtrim(local_layout, "\n");
1215 os << "\\begin_local_layout\n"
1216 << to_utf8(tmplocal)
1217 << "\n\\end_local_layout\n";
1218 }
1219 docstring const forced_local_layout = getLocalLayout(true);
1220 if (!forced_local_layout.empty()) {
1221 // remove '\n' from the end
1222 docstring const tmplocal = rtrim(forced_local_layout, "\n");
1223 os << "\\begin_forced_local_layout\n"
1224 << to_utf8(tmplocal)
1225 << "\n\\end_forced_local_layout\n";
1226 }
1227
1228 // then the text parameters
1229 if (language != ignore_language)
1230 os << "\\language " << language->lang() << '\n';
1231 os << "\\language_package " << lang_package
1232 << "\n\\inputencoding " << inputenc
1233 << "\n\\fontencoding " << fontenc
1234 << "\n\\font_roman \"" << fonts_roman[0]
1235 << "\" \"" << fonts_roman[1] << '"'
1236 << "\n\\font_sans \"" << fonts_sans[0]
1237 << "\" \"" << fonts_sans[1] << '"'
1238 << "\n\\font_typewriter \"" << fonts_typewriter[0]
1239 << "\" \"" << fonts_typewriter[1] << '"'
1240 << "\n\\font_math \"" << fonts_math[0]
1241 << "\" \"" << fonts_math[1] << '"'
1242 << "\n\\font_default_family " << fonts_default_family
1243 << "\n\\use_non_tex_fonts " << convert<string>(useNonTeXFonts)
1244 << "\n\\font_sc " << convert<string>(fonts_expert_sc)
1245 << "\n\\font_osf " << convert<string>(fonts_old_figures)
1246 << "\n\\font_sf_scale " << fonts_sans_scale[0]
1247 << ' ' << fonts_sans_scale[1]
1248 << "\n\\font_tt_scale " << fonts_typewriter_scale[0]
1249 << ' ' << fonts_typewriter_scale[1]
1250 << '\n';
1251 if (!fonts_cjk.empty()) {
1252 os << "\\font_cjk " << fonts_cjk << '\n';
1253 }
1254 os << "\\use_microtype " << convert<string>(use_microtype) << '\n';
1255 os << "\\use_dash_ligatures " << convert<string>(use_dash_ligatures) << '\n';
1256 os << "\\graphics " << graphics_driver << '\n';
1257 os << "\\default_output_format " << default_output_format << '\n';
1258 os << "\\output_sync " << output_sync << '\n';
1259 if (!output_sync_macro.empty())
1260 os << "\\output_sync_macro \"" << output_sync_macro << "\"\n";
1261 os << "\\bibtex_command " << bibtex_command << '\n';
1262 os << "\\index_command " << index_command << '\n';
1263
1264 if (!float_placement.empty()) {
1265 os << "\\float_placement " << float_placement << '\n';
1266 }
1267 os << "\\paperfontsize " << fontsize << '\n';
1268
1269 spacing().writeFile(os);
1270 pdfoptions().writeFile(os);
1271
1272 os << "\\papersize " << string_papersize[papersize]
1273 << "\n\\use_geometry " << convert<string>(use_geometry);
1274 map<string, string> const & packages = auto_packages();
1275 for (map<string, string>::const_iterator it = packages.begin();
1276 it != packages.end(); ++it)
1277 os << "\n\\use_package " << it->first << ' '
1278 << use_package(it->first);
1279
1280 os << "\n\\cite_engine ";
1281
1282 if (!cite_engine_.empty()) {
1283 LayoutModuleList::const_iterator be = cite_engine_.begin();
1284 LayoutModuleList::const_iterator en = cite_engine_.end();
1285 for (LayoutModuleList::const_iterator it = be; it != en; ++it) {
1286 if (it != be)
1287 os << ',';
1288 os << *it;
1289 }
1290 } else {
1291 os << "basic";
1292 }
1293
1294 os << "\n\\cite_engine_type " << theCiteEnginesList.getTypeAsString(cite_engine_type_);
1295
1296 if (!biblio_style.empty())
1297 os << "\n\\biblio_style " << biblio_style;
1298 if (!biblio_opts.empty())
1299 os << "\n\\biblio_options " << biblio_opts;
1300 if (!biblatex_bibstyle.empty())
1301 os << "\n\\biblatex_bibstyle " << biblatex_bibstyle;
1302 if (!biblatex_citestyle.empty())
1303 os << "\n\\biblatex_citestyle " << biblatex_citestyle;
1304 if (!multibib.empty())
1305 os << "\n\\multibib " << multibib;
1306
1307 os << "\n\\use_bibtopic " << convert<string>(use_bibtopic)
1308 << "\n\\use_indices " << convert<string>(use_indices)
1309 << "\n\\paperorientation " << string_orientation[orientation]
1310 << "\n\\suppress_date " << convert<string>(suppress_date)
1311 << "\n\\justification " << convert<string>(justification)
1312 << "\n\\use_refstyle " << use_refstyle
1313 << "\n\\use_minted " << use_minted
1314 << '\n';
1315 if (isbackgroundcolor == true)
1316 os << "\\backgroundcolor " << lyx::X11hexname(backgroundcolor) << '\n';
1317 if (isfontcolor == true)
1318 os << "\\fontcolor " << lyx::X11hexname(fontcolor) << '\n';
1319 if (notefontcolor != lyx::rgbFromHexName("#cccccc"))
1320 os << "\\notefontcolor " << lyx::X11hexname(notefontcolor) << '\n';
1321 if (boxbgcolor != lyx::rgbFromHexName("#ff0000"))
1322 os << "\\boxbgcolor " << lyx::X11hexname(boxbgcolor) << '\n';
1323
1324 BranchList::const_iterator it = branchlist().begin();
1325 BranchList::const_iterator end = branchlist().end();
1326 for (; it != end; ++it) {
1327 os << "\\branch " << to_utf8(it->branch())
1328 << "\n\\selected " << it->isSelected()
1329 << "\n\\filename_suffix " << it->hasFileNameSuffix()
1330 << "\n\\color " << lyx::X11hexname(it->color())
1331 << "\n\\end_branch"
1332 << "\n";
1333 }
1334
1335 IndicesList::const_iterator iit = indiceslist().begin();
1336 IndicesList::const_iterator iend = indiceslist().end();
1337 for (; iit != iend; ++iit) {
1338 os << "\\index " << to_utf8(iit->index())
1339 << "\n\\shortcut " << to_utf8(iit->shortcut())
1340 << "\n\\color " << lyx::X11hexname(iit->color())
1341 << "\n\\end_index"
1342 << "\n";
1343 }
1344
1345 if (!paperwidth.empty())
1346 os << "\\paperwidth "
1347 << VSpace(paperwidth).asLyXCommand() << '\n';
1348 if (!paperheight.empty())
1349 os << "\\paperheight "
1350 << VSpace(paperheight).asLyXCommand() << '\n';
1351 if (!leftmargin.empty())
1352 os << "\\leftmargin "
1353 << VSpace(leftmargin).asLyXCommand() << '\n';
1354 if (!topmargin.empty())
1355 os << "\\topmargin "
1356 << VSpace(topmargin).asLyXCommand() << '\n';
1357 if (!rightmargin.empty())
1358 os << "\\rightmargin "
1359 << VSpace(rightmargin).asLyXCommand() << '\n';
1360 if (!bottommargin.empty())
1361 os << "\\bottommargin "
1362 << VSpace(bottommargin).asLyXCommand() << '\n';
1363 if (!headheight.empty())
1364 os << "\\headheight "
1365 << VSpace(headheight).asLyXCommand() << '\n';
1366 if (!headsep.empty())
1367 os << "\\headsep "
1368 << VSpace(headsep).asLyXCommand() << '\n';
1369 if (!footskip.empty())
1370 os << "\\footskip "
1371 << VSpace(footskip).asLyXCommand() << '\n';
1372 if (!columnsep.empty())
1373 os << "\\columnsep "
1374 << VSpace(columnsep).asLyXCommand() << '\n';
1375 os << "\\secnumdepth " << secnumdepth
1376 << "\n\\tocdepth " << tocdepth
1377 << "\n\\paragraph_separation "
1378 << string_paragraph_separation[paragraph_separation];
1379 if (!paragraph_separation)
1380 os << "\n\\paragraph_indentation "
1381 << (getParIndent().empty() ? "default" : getParIndent().asString());
1382 else
1383 os << "\n\\defskip " << getDefSkip().asLyXCommand();
1384 os << "\n\\is_math_indent " << is_math_indent;
1385 if (is_math_indent)
1386 os << "\n\\math_indentation "
1387 << (getMathIndent().empty() ? "default" : getMathIndent().asString());
1388 os << "\n\\math_numbering_side ";
1389 switch(math_numbering_side) {
1390 case LEFT:
1391 os << "left";
1392 break;
1393 case RIGHT:
1394 os << "right";
1395 break;
1396 case DEFAULT:
1397 os << "default";
1398 }
1399 os << "\n\\quotes_style "
1400 << string_quotes_style[quotes_style]
1401 << "\n\\dynamic_quotes " << dynamic_quotes
1402 << "\n\\papercolumns " << columns
1403 << "\n\\papersides " << sides
1404 << "\n\\paperpagestyle " << pagestyle << '\n';
1405 if (!listings_params.empty())
1406 os << "\\listings_params \"" <<
1407 InsetListingsParams(listings_params).encodedString() << "\"\n";
1408 for (int i = 0; i < 4; ++i) {
1409 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
1410 if (user_defined_bullet(i).getFont() != -1) {
1411 os << "\\bullet " << i << " "
1412 << user_defined_bullet(i).getFont() << " "
1413 << user_defined_bullet(i).getCharacter() << " "
1414 << user_defined_bullet(i).getSize() << "\n";
1415 }
1416 else {
1417 // FIXME UNICODE
1418 os << "\\bulletLaTeX " << i << " \""
1419 << lyx::to_ascii(user_defined_bullet(i).getText())
1420 << "\"\n";
1421 }
1422 }
1423 }
1424
1425 os << "\\tracking_changes "
1426 << (save_transient_properties ? convert<string>(track_changes) : "false")
1427 << '\n';
1428
1429 os << "\\output_changes "
1430 << (save_transient_properties ? convert<string>(output_changes) : "false")
1431 << '\n';
1432
1433 os << "\\html_math_output " << html_math_output << '\n'
1434 << "\\html_css_as_file " << html_css_as_file << '\n'
1435 << "\\html_be_strict " << convert<string>(html_be_strict) << '\n';
1436
1437 if (html_math_img_scale != 1.0)
1438 os << "\\html_math_img_scale " << convert<string>(html_math_img_scale) << '\n';
1439 if (!html_latex_start.empty())
1440 os << "\\html_latex_start " << html_latex_start << '\n';
1441 if (!html_latex_end.empty())
1442 os << "\\html_latex_end " << html_latex_end << '\n';
1443
1444 os << pimpl_->authorlist;
1445 }
1446
1447
validate(LaTeXFeatures & features) const1448 void BufferParams::validate(LaTeXFeatures & features) const
1449 {
1450 features.require(documentClass().requires());
1451
1452 if (columns > 1 && language->rightToLeft())
1453 features.require("rtloutputdblcol");
1454
1455 if (output_changes) {
1456 bool dvipost = LaTeXFeatures::isAvailable("dvipost");
1457 bool xcolorulem = LaTeXFeatures::isAvailable("ulem") &&
1458 LaTeXFeatures::isAvailable("xcolor");
1459
1460 switch (features.runparams().flavor) {
1461 case OutputParams::LATEX:
1462 case OutputParams::DVILUATEX:
1463 if (dvipost) {
1464 features.require("ct-dvipost");
1465 features.require("dvipost");
1466 } else if (xcolorulem) {
1467 features.require("ct-xcolor-ulem");
1468 features.require("ulem");
1469 features.require("xcolor");
1470 } else {
1471 features.require("ct-none");
1472 }
1473 break;
1474 case OutputParams::LUATEX:
1475 case OutputParams::PDFLATEX:
1476 case OutputParams::XETEX:
1477 if (xcolorulem) {
1478 features.require("ct-xcolor-ulem");
1479 features.require("ulem");
1480 features.require("xcolor");
1481 // improves color handling in PDF output
1482 features.require("pdfcolmk");
1483 } else {
1484 features.require("ct-none");
1485 }
1486 break;
1487 default:
1488 break;
1489 }
1490 }
1491
1492 // Floats with 'Here definitely' as default setting.
1493 if (float_placement.find('H') != string::npos)
1494 features.require("float");
1495
1496 for (PackageMap::const_iterator it = use_packages.begin();
1497 it != use_packages.end(); ++it) {
1498 if (it->first == "amsmath") {
1499 // AMS Style is at document level
1500 if (it->second == package_on ||
1501 features.isProvided("amsmath"))
1502 features.require(it->first);
1503 } else if (it->second == package_on)
1504 features.require(it->first);
1505 }
1506
1507 // Document-level line spacing
1508 if (spacing().getSpace() != Spacing::Single && !spacing().isDefault())
1509 features.require("setspace");
1510
1511 // the bullet shapes are buffer level not paragraph level
1512 // so they are tested here
1513 for (int i = 0; i < 4; ++i) {
1514 if (user_defined_bullet(i) == ITEMIZE_DEFAULTS[i])
1515 continue;
1516 int const font = user_defined_bullet(i).getFont();
1517 if (font == 0) {
1518 int const c = user_defined_bullet(i).getCharacter();
1519 if (c == 16
1520 || c == 17
1521 || c == 25
1522 || c == 26
1523 || c == 31) {
1524 features.require("latexsym");
1525 }
1526 } else if (font == 1) {
1527 features.require("amssymb");
1528 } else if (font >= 2 && font <= 5) {
1529 features.require("pifont");
1530 }
1531 }
1532
1533 if (pdfoptions().use_hyperref) {
1534 features.require("hyperref");
1535 // due to interferences with babel and hyperref, the color package has to
1536 // be loaded after hyperref when hyperref is used with the colorlinks
1537 // option, see http://www.lyx.org/trac/ticket/5291
1538 if (pdfoptions().colorlinks)
1539 features.require("color");
1540 }
1541 if (!listings_params.empty()) {
1542 // do not test validity because listings_params is
1543 // supposed to be valid
1544 string par =
1545 InsetListingsParams(listings_params).separatedParams(true);
1546 // we can't support all packages, but we should load the color package
1547 if (par.find("\\color", 0) != string::npos)
1548 features.require("color");
1549 }
1550
1551 // some languages are only available via polyglossia
1552 if (features.hasPolyglossiaExclusiveLanguages())
1553 features.require("polyglossia");
1554
1555 if (useNonTeXFonts && fontsMath() != "auto")
1556 features.require("unicode-math");
1557
1558 if (use_microtype)
1559 features.require("microtype");
1560
1561 if (!language->requires().empty())
1562 features.require(language->requires());
1563 }
1564
1565
writeLaTeX(otexstream & os,LaTeXFeatures & features,FileName const & filepath) const1566 bool BufferParams::writeLaTeX(otexstream & os, LaTeXFeatures & features,
1567 FileName const & filepath) const
1568 {
1569 // http://www.tug.org/texmf-dist/doc/latex/base/fixltx2e.pdf
1570 // !! To use the Fix-cm package, load it before \documentclass, and use the command
1571 // \RequirePackage to do so, rather than the normal \usepackage
1572 // Do not try to load any other package before the document class, unless you
1573 // have a thorough understanding of the LATEX internals and know exactly what you
1574 // are doing!
1575 if (features.mustProvide("fix-cm"))
1576 os << "\\RequirePackage{fix-cm}\n";
1577 // Likewise for fixltx2e. If other packages conflict with this policy,
1578 // treat it as a package bug (and report it!)
1579 // See http://www.latex-project.org/cgi-bin/ltxbugs2html?pr=latex/4407
1580 if (features.mustProvide("fixltx2e"))
1581 os << "\\RequirePackage{fixltx2e}\n";
1582
1583 os << "\\documentclass";
1584
1585 DocumentClass const & tclass = documentClass();
1586
1587 ostringstream clsoptions; // the document class options.
1588
1589 if (tokenPos(tclass.opt_fontsize(),
1590 '|', fontsize) >= 0) {
1591 // only write if existing in list (and not default)
1592 clsoptions << fontsize << "pt,";
1593 }
1594
1595 // all paper sizes except of A4, A5, B5 and the US sizes need the
1596 // geometry package
1597 bool nonstandard_papersize = papersize != PAPER_DEFAULT
1598 && papersize != PAPER_USLETTER
1599 && papersize != PAPER_USLEGAL
1600 && papersize != PAPER_USEXECUTIVE
1601 && papersize != PAPER_A4
1602 && papersize != PAPER_A5
1603 && papersize != PAPER_B5;
1604
1605 if (!use_geometry || features.isProvided("geometry-light")) {
1606 switch (papersize) {
1607 case PAPER_A4:
1608 clsoptions << "a4paper,";
1609 break;
1610 case PAPER_USLETTER:
1611 clsoptions << "letterpaper,";
1612 break;
1613 case PAPER_A5:
1614 clsoptions << "a5paper,";
1615 break;
1616 case PAPER_B5:
1617 clsoptions << "b5paper,";
1618 break;
1619 case PAPER_USEXECUTIVE:
1620 clsoptions << "executivepaper,";
1621 break;
1622 case PAPER_USLEGAL:
1623 clsoptions << "legalpaper,";
1624 break;
1625 case PAPER_DEFAULT:
1626 case PAPER_A0:
1627 case PAPER_A1:
1628 case PAPER_A2:
1629 case PAPER_A3:
1630 case PAPER_A6:
1631 case PAPER_B0:
1632 case PAPER_B1:
1633 case PAPER_B2:
1634 case PAPER_B3:
1635 case PAPER_B4:
1636 case PAPER_B6:
1637 case PAPER_C0:
1638 case PAPER_C1:
1639 case PAPER_C2:
1640 case PAPER_C3:
1641 case PAPER_C4:
1642 case PAPER_C5:
1643 case PAPER_C6:
1644 case PAPER_JISB0:
1645 case PAPER_JISB1:
1646 case PAPER_JISB2:
1647 case PAPER_JISB3:
1648 case PAPER_JISB4:
1649 case PAPER_JISB5:
1650 case PAPER_JISB6:
1651 case PAPER_CUSTOM:
1652 break;
1653 }
1654 }
1655
1656 // if needed
1657 if (sides != tclass.sides()) {
1658 switch (sides) {
1659 case OneSide:
1660 clsoptions << "oneside,";
1661 break;
1662 case TwoSides:
1663 clsoptions << "twoside,";
1664 break;
1665 }
1666 }
1667
1668 // if needed
1669 if (columns != tclass.columns()) {
1670 if (columns == 2)
1671 clsoptions << "twocolumn,";
1672 else
1673 clsoptions << "onecolumn,";
1674 }
1675
1676 if (!use_geometry
1677 && orientation == ORIENTATION_LANDSCAPE)
1678 clsoptions << "landscape,";
1679
1680 if (is_math_indent)
1681 clsoptions << "fleqn,";
1682
1683 switch(math_numbering_side) {
1684 case LEFT:
1685 clsoptions << "leqno,";
1686 break;
1687 case RIGHT:
1688 clsoptions << "reqno,";
1689 features.require("amsmath");
1690 break;
1691 case DEFAULT:
1692 break;
1693 }
1694
1695 // language should be a parameter to \documentclass
1696 if (language->babel() == "hebrew"
1697 && default_language->babel() != "hebrew")
1698 // This seems necessary
1699 features.useLanguage(default_language);
1700
1701 ostringstream language_options;
1702 bool const use_babel = features.useBabel() && !features.isProvided("babel");
1703 bool const use_polyglossia = features.usePolyglossia();
1704 bool const global = lyxrc.language_global_options;
1705 if (use_babel || (use_polyglossia && global)) {
1706 language_options << features.getBabelLanguages();
1707 if (!language->babel().empty()) {
1708 if (!language_options.str().empty())
1709 language_options << ',';
1710 language_options << language->babel();
1711 }
1712 if (global && !features.needBabelLangOptions()
1713 && !language_options.str().empty())
1714 clsoptions << language_options.str() << ',';
1715 }
1716
1717 // the predefined options from the layout
1718 if (use_default_options && !tclass.options().empty())
1719 clsoptions << tclass.options() << ',';
1720
1721 // the user-defined options
1722 if (!options.empty()) {
1723 clsoptions << options << ',';
1724 }
1725
1726 string strOptions(clsoptions.str());
1727 if (!strOptions.empty()) {
1728 strOptions = rtrim(strOptions, ",");
1729 // FIXME UNICODE
1730 os << '[' << from_utf8(strOptions) << ']';
1731 }
1732
1733 os << '{' << from_ascii(tclass.latexname()) << "}\n";
1734 // end of \documentclass defs
1735
1736 // if we use fontspec or newtxmath, we have to load the AMS packages here
1737 string const ams = features.loadAMSPackages();
1738 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
1739 bool const use_newtxmath =
1740 theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getUsedPackage(
1741 ot1, false, false) == "newtxmath";
1742 if ((useNonTeXFonts || use_newtxmath) && !ams.empty())
1743 os << from_ascii(ams);
1744
1745 if (useNonTeXFonts) {
1746 if (!features.isProvided("fontspec"))
1747 os << "\\usepackage{fontspec}\n";
1748 if (features.mustProvide("unicode-math")
1749 && features.isAvailable("unicode-math"))
1750 os << "\\usepackage{unicode-math}\n";
1751 }
1752
1753 // font selection must be done before loading fontenc.sty
1754 string const fonts = loadFonts(features);
1755 if (!fonts.empty())
1756 os << from_utf8(fonts);
1757
1758 if (fonts_default_family != "default")
1759 os << "\\renewcommand{\\familydefault}{\\"
1760 << from_ascii(fonts_default_family) << "}\n";
1761
1762 // set font encoding
1763 // XeTeX and LuaTeX (with OS fonts) do not need fontenc
1764 if (!useNonTeXFonts && !features.isProvided("fontenc")
1765 && main_font_encoding() != "default") {
1766 // get main font encodings
1767 vector<string> fontencs = font_encodings();
1768 // get font encodings of secondary languages
1769 features.getFontEncodings(fontencs);
1770 if (!fontencs.empty()) {
1771 os << "\\usepackage["
1772 << from_ascii(getStringFromVector(fontencs))
1773 << "]{fontenc}\n";
1774 }
1775 }
1776
1777 // handle inputenc etc.
1778 writeEncodingPreamble(os, features);
1779
1780 // includeonly
1781 if (!features.runparams().includeall && !included_children_.empty()) {
1782 os << "\\includeonly{";
1783 list<string>::const_iterator it = included_children_.begin();
1784 list<string>::const_iterator en = included_children_.end();
1785 bool first = true;
1786 for (; it != en; ++it) {
1787 string incfile = *it;
1788 FileName inc = makeAbsPath(incfile, filepath.absFileName());
1789 string mangled = DocFileName(changeExtension(inc.absFileName(), ".tex")).
1790 mangledFileName();
1791 if (!features.runparams().nice)
1792 incfile = mangled;
1793 // \includeonly doesn't want an extension
1794 incfile = changeExtension(incfile, string());
1795 incfile = support::latex_path(incfile);
1796 if (!incfile.empty()) {
1797 if (!first)
1798 os << ",";
1799 os << from_utf8(incfile);
1800 }
1801 first = false;
1802 }
1803 os << "}\n";
1804 }
1805
1806 if (!features.isProvided("geometry")
1807 && (use_geometry || nonstandard_papersize)) {
1808 odocstringstream ods;
1809 if (!getGraphicsDriver("geometry").empty())
1810 ods << getGraphicsDriver("geometry");
1811 if (orientation == ORIENTATION_LANDSCAPE)
1812 ods << ",landscape";
1813 switch (papersize) {
1814 case PAPER_CUSTOM:
1815 if (!paperwidth.empty())
1816 ods << ",paperwidth="
1817 << from_ascii(paperwidth);
1818 if (!paperheight.empty())
1819 ods << ",paperheight="
1820 << from_ascii(paperheight);
1821 break;
1822 case PAPER_USLETTER:
1823 ods << ",letterpaper";
1824 break;
1825 case PAPER_USLEGAL:
1826 ods << ",legalpaper";
1827 break;
1828 case PAPER_USEXECUTIVE:
1829 ods << ",executivepaper";
1830 break;
1831 case PAPER_A0:
1832 ods << ",a0paper";
1833 break;
1834 case PAPER_A1:
1835 ods << ",a1paper";
1836 break;
1837 case PAPER_A2:
1838 ods << ",a2paper";
1839 break;
1840 case PAPER_A3:
1841 ods << ",a3paper";
1842 break;
1843 case PAPER_A4:
1844 ods << ",a4paper";
1845 break;
1846 case PAPER_A5:
1847 ods << ",a5paper";
1848 break;
1849 case PAPER_A6:
1850 ods << ",a6paper";
1851 break;
1852 case PAPER_B0:
1853 ods << ",b0paper";
1854 break;
1855 case PAPER_B1:
1856 ods << ",b1paper";
1857 break;
1858 case PAPER_B2:
1859 ods << ",b2paper";
1860 break;
1861 case PAPER_B3:
1862 ods << ",b3paper";
1863 break;
1864 case PAPER_B4:
1865 ods << ",b4paper";
1866 break;
1867 case PAPER_B5:
1868 ods << ",b5paper";
1869 break;
1870 case PAPER_B6:
1871 ods << ",b6paper";
1872 break;
1873 case PAPER_C0:
1874 ods << ",c0paper";
1875 break;
1876 case PAPER_C1:
1877 ods << ",c1paper";
1878 break;
1879 case PAPER_C2:
1880 ods << ",c2paper";
1881 break;
1882 case PAPER_C3:
1883 ods << ",c3paper";
1884 break;
1885 case PAPER_C4:
1886 ods << ",c4paper";
1887 break;
1888 case PAPER_C5:
1889 ods << ",c5paper";
1890 break;
1891 case PAPER_C6:
1892 ods << ",c6paper";
1893 break;
1894 case PAPER_JISB0:
1895 ods << ",b0j";
1896 break;
1897 case PAPER_JISB1:
1898 ods << ",b1j";
1899 break;
1900 case PAPER_JISB2:
1901 ods << ",b2j";
1902 break;
1903 case PAPER_JISB3:
1904 ods << ",b3j";
1905 break;
1906 case PAPER_JISB4:
1907 ods << ",b4j";
1908 break;
1909 case PAPER_JISB5:
1910 ods << ",b5j";
1911 break;
1912 case PAPER_JISB6:
1913 ods << ",b6j";
1914 break;
1915 case PAPER_DEFAULT:
1916 break;
1917 }
1918 docstring g_options = trim(ods.str(), ",");
1919 os << "\\usepackage";
1920 // geometry-light means that the class works with geometry, but overwrites
1921 // the package options and paper sizes (memoir does this).
1922 // In this case, all options need to go to \geometry
1923 // and the standard paper sizes need to go to the class options.
1924 if (!g_options.empty() && !features.isProvided("geometry-light")) {
1925 os << '[' << g_options << ']';
1926 g_options.clear();
1927 }
1928 os << "{geometry}\n";
1929 if (use_geometry || features.isProvided("geometry-light")) {
1930 os << "\\geometry{verbose";
1931 if (!g_options.empty())
1932 // Output general options here with "geometry light".
1933 os << "," << g_options;
1934 // output this only if use_geometry is true
1935 if (use_geometry) {
1936 if (!topmargin.empty())
1937 os << ",tmargin=" << from_ascii(Length(topmargin).asLatexString());
1938 if (!bottommargin.empty())
1939 os << ",bmargin=" << from_ascii(Length(bottommargin).asLatexString());
1940 if (!leftmargin.empty())
1941 os << ",lmargin=" << from_ascii(Length(leftmargin).asLatexString());
1942 if (!rightmargin.empty())
1943 os << ",rmargin=" << from_ascii(Length(rightmargin).asLatexString());
1944 if (!headheight.empty())
1945 os << ",headheight=" << from_ascii(Length(headheight).asLatexString());
1946 if (!headsep.empty())
1947 os << ",headsep=" << from_ascii(Length(headsep).asLatexString());
1948 if (!footskip.empty())
1949 os << ",footskip=" << from_ascii(Length(footskip).asLatexString());
1950 if (!columnsep.empty())
1951 os << ",columnsep=" << from_ascii(Length(columnsep).asLatexString());
1952 }
1953 os << "}\n";
1954 }
1955 } else if (orientation == ORIENTATION_LANDSCAPE
1956 || papersize != PAPER_DEFAULT) {
1957 features.require("papersize");
1958 }
1959
1960 if (tokenPos(tclass.opt_pagestyle(), '|', pagestyle) >= 0) {
1961 if (pagestyle == "fancy")
1962 os << "\\usepackage{fancyhdr}\n";
1963 os << "\\pagestyle{" << from_ascii(pagestyle) << "}\n";
1964 }
1965
1966 // only output when the background color is not default
1967 if (isbackgroundcolor == true) {
1968 // only require color here, the background color will be defined
1969 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1970 // package pdfpages
1971 features.require("color");
1972 features.require("pagecolor");
1973 }
1974
1975 // only output when the font color is not default
1976 if (isfontcolor == true) {
1977 // only require color here, the font color will be defined
1978 // in LaTeXFeatures.cpp to avoid interferences with the LaTeX
1979 // package pdfpages
1980 features.require("color");
1981 features.require("fontcolor");
1982 }
1983
1984 // Only if class has a ToC hierarchy
1985 if (tclass.hasTocLevels()) {
1986 if (secnumdepth != tclass.secnumdepth()) {
1987 os << "\\setcounter{secnumdepth}{"
1988 << secnumdepth
1989 << "}\n";
1990 }
1991 if (tocdepth != tclass.tocdepth()) {
1992 os << "\\setcounter{tocdepth}{"
1993 << tocdepth
1994 << "}\n";
1995 }
1996 }
1997
1998 if (paragraph_separation) {
1999 // when skip separation
2000 switch (getDefSkip().kind()) {
2001 case VSpace::SMALLSKIP:
2002 os << "\\setlength{\\parskip}{\\smallskipamount}\n";
2003 break;
2004 case VSpace::MEDSKIP:
2005 os << "\\setlength{\\parskip}{\\medskipamount}\n";
2006 break;
2007 case VSpace::BIGSKIP:
2008 os << "\\setlength{\\parskip}{\\bigskipamount}\n";
2009 break;
2010 case VSpace::LENGTH:
2011 os << "\\setlength{\\parskip}{"
2012 << from_utf8(getDefSkip().length().asLatexString())
2013 << "}\n";
2014 break;
2015 default: // should never happen // Then delete it.
2016 os << "\\setlength{\\parskip}{\\medskipamount}\n";
2017 break;
2018 }
2019 os << "\\setlength{\\parindent}{0pt}\n";
2020 } else {
2021 // when separation by indentation
2022 // only output something when a width is given
2023 if (!getParIndent().empty()) {
2024 os << "\\setlength{\\parindent}{"
2025 << from_utf8(getParIndent().asLatexString())
2026 << "}\n";
2027 }
2028 }
2029
2030 if (is_math_indent) {
2031 // when formula indentation
2032 // only output something when it is not the default
2033 if (!getMathIndent().empty()) {
2034 os << "\\setlength{\\mathindent}{"
2035 << from_utf8(getMathIndent().asString())
2036 << "}\n";
2037 }
2038 }
2039
2040 // Now insert the LyX specific LaTeX commands...
2041 features.resolveAlternatives();
2042 features.expandMultiples();
2043
2044 if (output_sync) {
2045 if (!output_sync_macro.empty())
2046 os << from_utf8(output_sync_macro) +"\n";
2047 else if (features.runparams().flavor == OutputParams::LATEX)
2048 os << "\\usepackage[active]{srcltx}\n";
2049 else if (features.runparams().flavor == OutputParams::PDFLATEX)
2050 os << "\\synctex=-1\n";
2051 }
2052
2053 // The package options (via \PassOptionsToPackage)
2054 os << from_ascii(features.getPackageOptions());
2055
2056 // due to interferences with babel and hyperref, the color package has to
2057 // be loaded (when it is not already loaded) before babel when hyperref
2058 // is used with the colorlinks option, see
2059 // http://www.lyx.org/trac/ticket/5291
2060 // we decided therefore to load color always before babel, see
2061 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144349.html
2062 os << from_ascii(features.getColorOptions());
2063
2064 // If we use hyperref, jurabib, japanese or varioref,
2065 // we have to call babel before
2066 if (use_babel
2067 && (features.isRequired("jurabib")
2068 || features.isRequired("hyperref")
2069 || features.isRequired("varioref")
2070 || features.isRequired("japanese"))) {
2071 os << features.getBabelPresettings();
2072 // FIXME UNICODE
2073 os << from_utf8(babelCall(language_options.str(),
2074 features.needBabelLangOptions())) + '\n';
2075 os << features.getBabelPostsettings();
2076 }
2077
2078 // The optional packages;
2079 os << from_ascii(features.getPackages());
2080
2081 // Additional Indices
2082 if (features.isRequired("splitidx")) {
2083 IndicesList::const_iterator iit = indiceslist().begin();
2084 IndicesList::const_iterator iend = indiceslist().end();
2085 for (; iit != iend; ++iit) {
2086 os << "\\newindex{";
2087 os << escape(iit->shortcut());
2088 os << "}\n";
2089 }
2090 }
2091
2092 // Line spacing
2093 os << from_utf8(spacing().writePreamble(features.isProvided("SetSpace")));
2094
2095 // PDF support.
2096 // * Hyperref manual: "Make sure it comes last of your loaded
2097 // packages, to give it a fighting chance of not being over-written,
2098 // since its job is to redefine many LaTeX commands."
2099 // * Email from Heiko Oberdiek: "It is usually better to load babel
2100 // before hyperref. Then hyperref has a chance to detect babel.
2101 // * Has to be loaded before the "LyX specific LaTeX commands" to
2102 // avoid errors with algorithm floats.
2103 // use hyperref explicitly if it is required
2104 if (features.isRequired("hyperref")) {
2105 OutputParams tmp_params = features.runparams();
2106 pdfoptions().writeLaTeX(tmp_params, os,
2107 features.isProvided("hyperref"));
2108 // correctly break URLs with hyperref and dvi/ps output
2109 if (features.runparams().hyperref_driver == "dvips"
2110 && features.isAvailable("breakurl"))
2111 os << "\\usepackage{breakurl}\n";
2112 } else if (features.isRequired("nameref"))
2113 // hyperref loads this automatically
2114 os << "\\usepackage{nameref}\n";
2115
2116 // bibtopic needs to be loaded after hyperref.
2117 // the dot provides the aux file naming which LyX can detect.
2118 if (features.mustProvide("bibtopic"))
2119 os << "\\usepackage[dot]{bibtopic}\n";
2120
2121 // Will be surrounded by \makeatletter and \makeatother when not empty
2122 otexstringstream atlyxpreamble;
2123
2124 // Some macros LyX will need
2125 {
2126 TexString tmppreamble = features.getMacros();
2127 if (!tmppreamble.str.empty())
2128 atlyxpreamble << "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2129 "LyX specific LaTeX commands.\n"
2130 << move(tmppreamble)
2131 << '\n';
2132 }
2133 // the text class specific preamble
2134 {
2135 docstring tmppreamble = features.getTClassPreamble();
2136 if (!tmppreamble.empty())
2137 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2138 "Textclass specific LaTeX commands.\n"
2139 << tmppreamble
2140 << '\n';
2141 }
2142 // suppress date if selected
2143 // use \@ifundefined because we cannot be sure that every document class
2144 // has a \date command
2145 if (suppress_date)
2146 atlyxpreamble << "\\@ifundefined{date}{}{\\date{}}\n";
2147
2148 /* the user-defined preamble */
2149 if (!containsOnly(preamble, " \n\t")) {
2150 // FIXME UNICODE
2151 atlyxpreamble << "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
2152 "User specified LaTeX commands.\n";
2153
2154 // Check if the user preamble contains uncodable glyphs
2155 odocstringstream user_preamble;
2156 docstring uncodable_glyphs;
2157 Encoding const * const enc = features.runparams().encoding;
2158 if (enc) {
2159 for (size_t n = 0; n < preamble.size(); ++n) {
2160 char_type c = preamble[n];
2161 if (!enc->encodable(c)) {
2162 docstring const glyph(1, c);
2163 LYXERR0("Uncodable character '"
2164 << glyph
2165 << "' in user preamble!");
2166 uncodable_glyphs += glyph;
2167 if (features.runparams().dryrun) {
2168 user_preamble << "<" << _("LyX Warning: ")
2169 << _("uncodable character") << " '";
2170 user_preamble.put(c);
2171 user_preamble << "'>";
2172 }
2173 } else
2174 user_preamble.put(c);
2175 }
2176 } else
2177 user_preamble << preamble;
2178
2179 // On BUFFER_VIEW|UPDATE, warn user if we found uncodable glyphs
2180 if (!features.runparams().dryrun && !uncodable_glyphs.empty()) {
2181 frontend::Alert::warning(
2182 _("Uncodable character in user preamble"),
2183 support::bformat(
2184 _("The user preamble of your document contains glyphs "
2185 "that are unknown in the current document encoding "
2186 "(namely %1$s).\nThese glyphs are omitted "
2187 " from the output, which may result in "
2188 "incomplete output."
2189 "\n\nPlease select an appropriate "
2190 "document encoding\n"
2191 "(such as utf8) or change the "
2192 "preamble code accordingly."),
2193 uncodable_glyphs));
2194 }
2195 atlyxpreamble << user_preamble.str() << '\n';
2196 }
2197
2198 // footmisc must be loaded after setspace
2199 // Load it here to avoid clashes with footmisc loaded in the user
2200 // preamble. For that reason we also pass the options via
2201 // \PassOptionsToPackage in getPreamble() and not here.
2202 if (features.mustProvide("footmisc"))
2203 atlyxpreamble << "\\usepackage{footmisc}\n";
2204
2205 // subfig loads internally the LaTeX package "caption". As
2206 // caption is a very popular package, users will load it in
2207 // the preamble. Therefore we must load subfig behind the
2208 // user-defined preamble and check if the caption package was
2209 // loaded or not. For the case that caption is loaded before
2210 // subfig, there is the subfig option "caption=false". This
2211 // option also works when a koma-script class is used and
2212 // koma's own caption commands are used instead of caption. We
2213 // use \PassOptionsToPackage here because the user could have
2214 // already loaded subfig in the preamble.
2215 if (features.mustProvide("subfig"))
2216 atlyxpreamble << "\\@ifundefined{showcaptionsetup}{}{%\n"
2217 " \\PassOptionsToPackage{caption=false}{subfig}}\n"
2218 "\\usepackage{subfig}\n";
2219
2220 // Itemize bullet settings need to be last in case the user
2221 // defines their own bullets that use a package included
2222 // in the user-defined preamble -- ARRae
2223 // Actually it has to be done much later than that
2224 // since some packages like frenchb make modifications
2225 // at \begin{document} time -- JMarc
2226 docstring bullets_def;
2227 for (int i = 0; i < 4; ++i) {
2228 if (user_defined_bullet(i) != ITEMIZE_DEFAULTS[i]) {
2229 if (bullets_def.empty())
2230 bullets_def += "\\AtBeginDocument{\n";
2231 bullets_def += " \\def\\labelitemi";
2232 switch (i) {
2233 // `i' is one less than the item to modify
2234 case 0:
2235 break;
2236 case 1:
2237 bullets_def += 'i';
2238 break;
2239 case 2:
2240 bullets_def += "ii";
2241 break;
2242 case 3:
2243 bullets_def += 'v';
2244 break;
2245 }
2246 bullets_def += '{' +
2247 user_defined_bullet(i).getText()
2248 + "}\n";
2249 }
2250 }
2251
2252 if (!bullets_def.empty())
2253 atlyxpreamble << bullets_def << "}\n\n";
2254
2255 if (!atlyxpreamble.empty())
2256 os << "\n\\makeatletter\n"
2257 << atlyxpreamble.release()
2258 << "\\makeatother\n\n";
2259
2260 // We try to load babel late, in case it interferes with other packages.
2261 // Jurabib, hyperref, varioref, bicaption, menukeys and listings (bug 8995)
2262 // have to be called after babel, though.
2263 if (use_babel && !features.isRequired("jurabib")
2264 && !features.isRequired("hyperref")
2265 && !features.isRequired("varioref")
2266 && !features.isRequired("japanese")) {
2267 os << features.getBabelPresettings();
2268 // FIXME UNICODE
2269 os << from_utf8(babelCall(language_options.str(),
2270 features.needBabelLangOptions())) + '\n';
2271 os << features.getBabelPostsettings();
2272 }
2273 if (features.isRequired("bicaption"))
2274 os << "\\usepackage{bicaption}\n";
2275 if (!listings_params.empty()
2276 || features.mustProvide("listings")
2277 || features.mustProvide("minted")) {
2278 if (use_minted)
2279 os << "\\usepackage{minted}\n";
2280 else
2281 os << "\\usepackage{listings}\n";
2282 }
2283 string lst_params = listings_params;
2284 // If minted, do not output the language option (bug 11203)
2285 if (use_minted && contains(lst_params, "language=")) {
2286 vector<string> opts =
2287 getVectorFromString(lst_params, ",", false);
2288 for (size_t i = 0; i < opts.size(); ++i) {
2289 if (prefixIs(opts[i], "language="))
2290 opts.erase(opts.begin() + i--);
2291 }
2292 lst_params = getStringFromVector(opts, ",");
2293 }
2294 if (!lst_params.empty()) {
2295 if (use_minted)
2296 os << "\\setminted{";
2297 else
2298 os << "\\lstset{";
2299 // do not test validity because listings_params is
2300 // supposed to be valid
2301 string par =
2302 InsetListingsParams(lst_params).separatedParams(true);
2303 os << from_utf8(par);
2304 os << "}\n";
2305 }
2306
2307 // xunicode only needs to be loaded if tipa is used
2308 // (the rest is obsoleted by the new TU encoding).
2309 // It needs to be loaded at least after amsmath, amssymb,
2310 // esint and the other packages that provide special glyphs
2311 if (features.mustProvide("tipa") && useNonTeXFonts
2312 && !features.isProvided("xunicode")) {
2313 // The package officially only supports XeTeX, but also works
2314 // with LuaTeX. Thus we work around its XeTeX test.
2315 if (features.runparams().flavor != OutputParams::XETEX) {
2316 os << "% Pretend to xunicode that we are XeTeX\n"
2317 << "\\def\\XeTeXpicfile{}\n";
2318 }
2319 os << "\\usepackage{xunicode}\n";
2320 }
2321
2322 // covington must be loaded after beamerarticle
2323 if (features.isRequired("covington"))
2324 os << "\\usepackage{covington}\n";
2325
2326 // Polyglossia must be loaded last ...
2327 if (use_polyglossia) {
2328 // call the package
2329 os << "\\usepackage{polyglossia}\n";
2330 // set the main language
2331 os << "\\setdefaultlanguage";
2332 if (!language->polyglossiaOpts().empty())
2333 os << "[" << from_ascii(language->polyglossiaOpts()) << "]";
2334 os << "{" << from_ascii(language->polyglossia()) << "}\n";
2335 // now setup the other languages
2336 set<string> const polylangs =
2337 features.getPolyglossiaLanguages();
2338 for (set<string>::const_iterator mit = polylangs.begin();
2339 mit != polylangs.end() ; ++mit) {
2340 // We do not output the options here; they are output in
2341 // the language switch commands. This is safer if multiple
2342 // varieties are used.
2343 if (*mit == language->polyglossia())
2344 continue;
2345 os << "\\setotherlanguage";
2346 os << "{" << from_ascii(*mit) << "}\n";
2347 }
2348 }
2349
2350 // ... but before biblatex (see #7065)
2351 if (features.mustProvide("biblatex")
2352 && !features.isProvided("biblatex-natbib")
2353 && !features.isProvided("natbib-internal")
2354 && !features.isProvided("natbib")
2355 && !features.isProvided("jurabib")) {
2356 string delim = "";
2357 string opts;
2358 os << "\\usepackage";
2359 if (!biblatex_bibstyle.empty()
2360 && (biblatex_bibstyle == biblatex_citestyle)) {
2361 opts = "style=" + biblatex_bibstyle;
2362 delim = ",";
2363 } else {
2364 if (!biblatex_bibstyle.empty()) {
2365 opts = "bibstyle=" + biblatex_bibstyle;
2366 delim = ",";
2367 }
2368 if (!biblatex_citestyle.empty()) {
2369 opts += delim + "citestyle=" + biblatex_citestyle;
2370 delim = ",";
2371 }
2372 }
2373 if (!multibib.empty() && multibib != "child") {
2374 opts += delim + "refsection=" + multibib;
2375 delim = ",";
2376 }
2377 if (bibtexCommand() == "bibtex8"
2378 || prefixIs(bibtexCommand(), "bibtex8 ")) {
2379 opts += delim + "backend=bibtex8";
2380 delim = ",";
2381 } else if (bibtexCommand() == "bibtex"
2382 || prefixIs(bibtexCommand(), "bibtex ")) {
2383 opts += delim + "backend=bibtex";
2384 delim = ",";
2385 }
2386 if (!biblio_opts.empty())
2387 opts += delim + biblio_opts;
2388 if (!opts.empty())
2389 os << "[" << opts << "]";
2390 os << "{biblatex}\n";
2391 }
2392
2393
2394 // Load custom language package here
2395 if (features.langPackage() == LaTeXFeatures::LANG_PACK_CUSTOM) {
2396 if (lang_package == "default")
2397 os << from_utf8(lyxrc.language_custom_package);
2398 else
2399 os << from_utf8(lang_package);
2400 os << '\n';
2401 }
2402
2403 // Since menukeys uses catoptions, which does some heavy changes on key-value options,
2404 // it is recommended to load menukeys as the last package (even after hyperref)
2405 if (features.isRequired("menukeys"))
2406 os << "\\usepackage{menukeys}\n";
2407
2408 docstring const i18npreamble =
2409 features.getTClassI18nPreamble(use_babel, use_polyglossia,
2410 use_minted);
2411 if (!i18npreamble.empty())
2412 os << i18npreamble + '\n';
2413
2414 return use_babel;
2415 }
2416
2417
useClassDefaults()2418 void BufferParams::useClassDefaults()
2419 {
2420 DocumentClass const & tclass = documentClass();
2421
2422 sides = tclass.sides();
2423 columns = tclass.columns();
2424 pagestyle = tclass.pagestyle();
2425 use_default_options = true;
2426 // Only if class has a ToC hierarchy
2427 if (tclass.hasTocLevels()) {
2428 secnumdepth = tclass.secnumdepth();
2429 tocdepth = tclass.tocdepth();
2430 }
2431 }
2432
2433
hasClassDefaults() const2434 bool BufferParams::hasClassDefaults() const
2435 {
2436 DocumentClass const & tclass = documentClass();
2437
2438 return sides == tclass.sides()
2439 && columns == tclass.columns()
2440 && pagestyle == tclass.pagestyle()
2441 && use_default_options
2442 && secnumdepth == tclass.secnumdepth()
2443 && tocdepth == tclass.tocdepth();
2444 }
2445
2446
documentClass() const2447 DocumentClass const & BufferParams::documentClass() const
2448 {
2449 return *doc_class_;
2450 }
2451
2452
documentClassPtr() const2453 DocumentClassConstPtr BufferParams::documentClassPtr() const
2454 {
2455 return doc_class_;
2456 }
2457
2458
setDocumentClass(DocumentClassConstPtr tc)2459 void BufferParams::setDocumentClass(DocumentClassConstPtr tc)
2460 {
2461 // evil, but this function is evil
2462 doc_class_ = const_pointer_cast<DocumentClass>(tc);
2463 invalidateConverterCache();
2464 }
2465
2466
setBaseClass(string const & classname,string const & path)2467 bool BufferParams::setBaseClass(string const & classname, string const & path)
2468 {
2469 LYXERR(Debug::TCLASS, "setBaseClass: " << classname);
2470 LayoutFileList & bcl = LayoutFileList::get();
2471 if (!bcl.haveClass(classname)) {
2472 docstring s =
2473 bformat(_("The layout file:\n"
2474 "%1$s\n"
2475 "could not be found. A default textclass with default\n"
2476 "layouts will be used. LyX will not be able to produce\n"
2477 "correct output."),
2478 from_utf8(classname));
2479 frontend::Alert::error(_("Document class not found"), s);
2480 bcl.addEmptyClass(classname);
2481 }
2482
2483 bool const success = bcl[classname].load(path);
2484 if (!success) {
2485 docstring s =
2486 bformat(_("Due to some error in it, the layout file:\n"
2487 "%1$s\n"
2488 "could not be loaded. A default textclass with default\n"
2489 "layouts will be used. LyX will not be able to produce\n"
2490 "correct output."),
2491 from_utf8(classname));
2492 frontend::Alert::error(_("Could not load class"), s);
2493 bcl.addEmptyClass(classname);
2494 }
2495
2496 pimpl_->baseClass_ = classname;
2497 layout_modules_.adaptToBaseClass(baseClass(), removed_modules_);
2498 return true;
2499 }
2500
2501
baseClass() const2502 LayoutFile const * BufferParams::baseClass() const
2503 {
2504 if (LayoutFileList::get().haveClass(pimpl_->baseClass_))
2505 return &(LayoutFileList::get()[pimpl_->baseClass_]);
2506 else
2507 return 0;
2508 }
2509
2510
baseClassID() const2511 LayoutFileIndex const & BufferParams::baseClassID() const
2512 {
2513 return pimpl_->baseClass_;
2514 }
2515
2516
makeDocumentClass(bool const clone)2517 void BufferParams::makeDocumentClass(bool const clone)
2518 {
2519 if (!baseClass())
2520 return;
2521
2522 invalidateConverterCache();
2523 LayoutModuleList mods;
2524 LayoutModuleList ces;
2525 LayoutModuleList::iterator it = layout_modules_.begin();
2526 LayoutModuleList::iterator en = layout_modules_.end();
2527 for (; it != en; ++it)
2528 mods.push_back(*it);
2529
2530 it = cite_engine_.begin();
2531 en = cite_engine_.end();
2532 for (; it != en; ++it)
2533 ces.push_back(*it);
2534
2535 doc_class_ = getDocumentClass(*baseClass(), mods, ces, clone);
2536
2537 TextClass::ReturnValues success = TextClass::OK;
2538 if (!forced_local_layout_.empty())
2539 success = doc_class_->read(to_utf8(forced_local_layout_),
2540 TextClass::MODULE);
2541 if (!local_layout_.empty() &&
2542 (success == TextClass::OK || success == TextClass::OK_OLDFORMAT))
2543 success = doc_class_->read(to_utf8(local_layout_), TextClass::MODULE);
2544 if (success != TextClass::OK && success != TextClass::OK_OLDFORMAT) {
2545 docstring const msg = _("Error reading internal layout information");
2546 frontend::Alert::warning(_("Read Error"), msg);
2547 }
2548 }
2549
2550
layoutModuleCanBeAdded(string const & modName) const2551 bool BufferParams::layoutModuleCanBeAdded(string const & modName) const
2552 {
2553 return layout_modules_.moduleCanBeAdded(modName, baseClass());
2554 }
2555
2556
citationModuleCanBeAdded(string const & modName) const2557 bool BufferParams::citationModuleCanBeAdded(string const & modName) const
2558 {
2559 return cite_engine_.moduleCanBeAdded(modName, baseClass());
2560 }
2561
2562
getLocalLayout(bool forced) const2563 docstring BufferParams::getLocalLayout(bool forced) const
2564 {
2565 if (forced)
2566 return from_utf8(doc_class_->forcedLayouts());
2567 else
2568 return local_layout_;
2569 }
2570
2571
setLocalLayout(docstring const & layout,bool forced)2572 void BufferParams::setLocalLayout(docstring const & layout, bool forced)
2573 {
2574 if (forced)
2575 forced_local_layout_ = layout;
2576 else
2577 local_layout_ = layout;
2578 }
2579
2580
addLayoutModule(string const & modName)2581 bool BufferParams::addLayoutModule(string const & modName)
2582 {
2583 LayoutModuleList::const_iterator it = layout_modules_.begin();
2584 LayoutModuleList::const_iterator end = layout_modules_.end();
2585 for (; it != end; ++it)
2586 if (*it == modName)
2587 return false;
2588 layout_modules_.push_back(modName);
2589 return true;
2590 }
2591
2592
bufferFormat() const2593 string BufferParams::bufferFormat() const
2594 {
2595 return documentClass().outputFormat();
2596 }
2597
2598
isExportable(string const & format,bool need_viewable) const2599 bool BufferParams::isExportable(string const & format, bool need_viewable) const
2600 {
2601 FormatList const & formats = exportableFormats(need_viewable);
2602 FormatList::const_iterator fit = formats.begin();
2603 FormatList::const_iterator end = formats.end();
2604 for (; fit != end ; ++fit) {
2605 if ((*fit)->name() == format)
2606 return true;
2607 }
2608 return false;
2609 }
2610
2611
exportableFormats(bool only_viewable) const2612 FormatList const & BufferParams::exportableFormats(bool only_viewable) const
2613 {
2614 FormatList & cached = only_viewable ?
2615 pimpl_->viewableFormatList : pimpl_->exportableFormatList;
2616 bool & valid = only_viewable ?
2617 pimpl_->isViewCacheValid : pimpl_->isExportCacheValid;
2618 if (valid)
2619 return cached;
2620
2621 vector<string> const backs = backends();
2622 set<string> excludes;
2623 if (useNonTeXFonts) {
2624 excludes.insert("latex");
2625 excludes.insert("pdflatex");
2626 }
2627 FormatList result =
2628 theConverters().getReachable(backs[0], only_viewable, true, excludes);
2629 for (vector<string>::const_iterator it = backs.begin() + 1;
2630 it != backs.end(); ++it) {
2631 FormatList r = theConverters().getReachable(*it, only_viewable,
2632 false, excludes);
2633 result.insert(result.end(), r.begin(), r.end());
2634 }
2635 sort(result.begin(), result.end(), Format::formatSorter);
2636 cached = result;
2637 valid = true;
2638 return cached;
2639 }
2640
2641
backends() const2642 vector<string> BufferParams::backends() const
2643 {
2644 vector<string> v;
2645 string const buffmt = bufferFormat();
2646
2647 // FIXME: Don't hardcode format names here, but use a flag
2648 if (buffmt == "latex") {
2649 if (encoding().package() == Encoding::japanese)
2650 v.push_back("platex");
2651 else {
2652 if (!useNonTeXFonts) {
2653 v.push_back("pdflatex");
2654 v.push_back("latex");
2655 }
2656 v.push_back("xetex");
2657 v.push_back("luatex");
2658 v.push_back("dviluatex");
2659 }
2660 } else {
2661 string rbuffmt = buffmt;
2662 // If we use an OutputFormat in Japanese docs,
2663 // we need special format in order to get the path
2664 // via pLaTeX (#8823)
2665 if (documentClass().hasOutputFormat()
2666 && encoding().package() == Encoding::japanese)
2667 rbuffmt += "-ja";
2668 v.push_back(rbuffmt);
2669 }
2670
2671 v.push_back("xhtml");
2672 v.push_back("text");
2673 v.push_back("lyx");
2674 return v;
2675 }
2676
2677
getOutputFlavor(string const & format) const2678 OutputParams::FLAVOR BufferParams::getOutputFlavor(string const & format) const
2679 {
2680 string const dformat = (format.empty() || format == "default") ?
2681 getDefaultOutputFormat() : format;
2682 DefaultFlavorCache::const_iterator it =
2683 default_flavors_.find(dformat);
2684
2685 if (it != default_flavors_.end())
2686 return it->second;
2687
2688 OutputParams::FLAVOR result = OutputParams::LATEX;
2689
2690 // FIXME It'd be better not to hardcode this, but to do
2691 // something with formats.
2692 if (dformat == "xhtml")
2693 result = OutputParams::HTML;
2694 else if (dformat == "text")
2695 result = OutputParams::TEXT;
2696 else if (dformat == "lyx")
2697 result = OutputParams::LYX;
2698 else if (dformat == "pdflatex")
2699 result = OutputParams::PDFLATEX;
2700 else if (dformat == "xetex")
2701 result = OutputParams::XETEX;
2702 else if (dformat == "luatex")
2703 result = OutputParams::LUATEX;
2704 else if (dformat == "dviluatex")
2705 result = OutputParams::DVILUATEX;
2706 else {
2707 // Try to determine flavor of default output format
2708 vector<string> backs = backends();
2709 if (find(backs.begin(), backs.end(), dformat) == backs.end()) {
2710 // Get shortest path to format
2711 Graph::EdgePath path;
2712 for (vector<string>::const_iterator it = backs.begin();
2713 it != backs.end(); ++it) {
2714 Graph::EdgePath p = theConverters().getPath(*it, dformat);
2715 if (!p.empty() && (path.empty() || p.size() < path.size())) {
2716 path = p;
2717 }
2718 }
2719 if (!path.empty())
2720 result = theConverters().getFlavor(path);
2721 }
2722 }
2723 // cache this flavor
2724 default_flavors_[dformat] = result;
2725 return result;
2726 }
2727
2728
getDefaultOutputFormat() const2729 string BufferParams::getDefaultOutputFormat() const
2730 {
2731 if (!default_output_format.empty()
2732 && default_output_format != "default")
2733 return default_output_format;
2734 if (isDocBook()) {
2735 FormatList const & formats = exportableFormats(true);
2736 if (formats.empty())
2737 return string();
2738 // return the first we find
2739 return formats.front()->name();
2740 }
2741 if (encoding().package() == Encoding::japanese)
2742 return lyxrc.default_platex_view_format;
2743 if (useNonTeXFonts)
2744 return lyxrc.default_otf_view_format;
2745 return lyxrc.default_view_format;
2746 }
2747
getFont() const2748 Font const BufferParams::getFont() const
2749 {
2750 FontInfo f = documentClass().defaultfont();
2751 if (fonts_default_family == "rmdefault")
2752 f.setFamily(ROMAN_FAMILY);
2753 else if (fonts_default_family == "sfdefault")
2754 f.setFamily(SANS_FAMILY);
2755 else if (fonts_default_family == "ttdefault")
2756 f.setFamily(TYPEWRITER_FAMILY);
2757 return Font(f, language);
2758 }
2759
2760
getQuoteStyle(string const & qs) const2761 InsetQuotesParams::QuoteStyle BufferParams::getQuoteStyle(string const & qs) const
2762 {
2763 return quotesstyletranslator().find(qs);
2764 }
2765
2766
isLatex() const2767 bool BufferParams::isLatex() const
2768 {
2769 return documentClass().outputType() == LATEX;
2770 }
2771
2772
isLiterate() const2773 bool BufferParams::isLiterate() const
2774 {
2775 return documentClass().outputType() == LITERATE;
2776 }
2777
2778
isDocBook() const2779 bool BufferParams::isDocBook() const
2780 {
2781 return documentClass().outputType() == DOCBOOK;
2782 }
2783
2784
readPreamble(Lexer & lex)2785 void BufferParams::readPreamble(Lexer & lex)
2786 {
2787 if (lex.getString() != "\\begin_preamble")
2788 lyxerr << "Error (BufferParams::readPreamble):"
2789 "consistency check failed." << endl;
2790
2791 preamble = lex.getLongString(from_ascii("\\end_preamble"));
2792 }
2793
2794
readLocalLayout(Lexer & lex,bool forced)2795 void BufferParams::readLocalLayout(Lexer & lex, bool forced)
2796 {
2797 string const expected = forced ? "\\begin_forced_local_layout" :
2798 "\\begin_local_layout";
2799 if (lex.getString() != expected)
2800 lyxerr << "Error (BufferParams::readLocalLayout):"
2801 "consistency check failed." << endl;
2802
2803 if (forced)
2804 forced_local_layout_ =
2805 lex.getLongString(from_ascii("\\end_forced_local_layout"));
2806 else
2807 local_layout_ = lex.getLongString(from_ascii("\\end_local_layout"));
2808 }
2809
2810
setLanguage(string const & lang)2811 bool BufferParams::setLanguage(string const & lang)
2812 {
2813 Language const *new_language = languages.getLanguage(lang);
2814 if (!new_language) {
2815 // Language lang was not found
2816 return false;
2817 }
2818 language = new_language;
2819 return true;
2820 }
2821
2822
readLanguage(Lexer & lex)2823 void BufferParams::readLanguage(Lexer & lex)
2824 {
2825 if (!lex.next()) return;
2826
2827 string const tmptok = lex.getString();
2828
2829 // check if tmptok is part of tex_babel in tex-defs.h
2830 if (!setLanguage(tmptok)) {
2831 // Language tmptok was not found
2832 language = default_language;
2833 lyxerr << "Warning: Setting language `"
2834 << tmptok << "' to `" << language->lang()
2835 << "'." << endl;
2836 }
2837 }
2838
2839
readGraphicsDriver(Lexer & lex)2840 void BufferParams::readGraphicsDriver(Lexer & lex)
2841 {
2842 if (!lex.next())
2843 return;
2844
2845 string const tmptok = lex.getString();
2846 // check if tmptok is part of tex_graphics in tex_defs.h
2847 int n = 0;
2848 while (true) {
2849 string const test = tex_graphics[n++];
2850
2851 if (test == tmptok) {
2852 graphics_driver = tmptok;
2853 break;
2854 }
2855 if (test.empty()) {
2856 lex.printError(
2857 "Warning: graphics driver `$$Token' not recognized!\n"
2858 " Setting graphics driver to `default'.\n");
2859 graphics_driver = "default";
2860 break;
2861 }
2862 }
2863 }
2864
2865
readBullets(Lexer & lex)2866 void BufferParams::readBullets(Lexer & lex)
2867 {
2868 if (!lex.next())
2869 return;
2870
2871 int const index = lex.getInteger();
2872 lex.next();
2873 int temp_int = lex.getInteger();
2874 user_defined_bullet(index).setFont(temp_int);
2875 temp_bullet(index).setFont(temp_int);
2876 lex >> temp_int;
2877 user_defined_bullet(index).setCharacter(temp_int);
2878 temp_bullet(index).setCharacter(temp_int);
2879 lex >> temp_int;
2880 user_defined_bullet(index).setSize(temp_int);
2881 temp_bullet(index).setSize(temp_int);
2882 }
2883
2884
readBulletsLaTeX(Lexer & lex)2885 void BufferParams::readBulletsLaTeX(Lexer & lex)
2886 {
2887 // The bullet class should be able to read this.
2888 if (!lex.next())
2889 return;
2890 int const index = lex.getInteger();
2891 lex.next(true);
2892 docstring const temp_str = lex.getDocString();
2893
2894 user_defined_bullet(index).setText(temp_str);
2895 temp_bullet(index).setText(temp_str);
2896 }
2897
2898
readModules(Lexer & lex)2899 void BufferParams::readModules(Lexer & lex)
2900 {
2901 if (!lex.eatLine()) {
2902 lyxerr << "Error (BufferParams::readModules):"
2903 "Unexpected end of input." << endl;
2904 return;
2905 }
2906 while (true) {
2907 string mod = lex.getString();
2908 if (mod == "\\end_modules")
2909 break;
2910 addLayoutModule(mod);
2911 lex.eatLine();
2912 }
2913 }
2914
2915
readRemovedModules(Lexer & lex)2916 void BufferParams::readRemovedModules(Lexer & lex)
2917 {
2918 if (!lex.eatLine()) {
2919 lyxerr << "Error (BufferParams::readRemovedModules):"
2920 "Unexpected end of input." << endl;
2921 return;
2922 }
2923 while (true) {
2924 string mod = lex.getString();
2925 if (mod == "\\end_removed_modules")
2926 break;
2927 removed_modules_.push_back(mod);
2928 lex.eatLine();
2929 }
2930 // now we want to remove any removed modules that were previously
2931 // added. normally, that will be because default modules were added in
2932 // setBaseClass(), which gets called when \textclass is read at the
2933 // start of the read.
2934 list<string>::const_iterator rit = removed_modules_.begin();
2935 list<string>::const_iterator const ren = removed_modules_.end();
2936 for (; rit != ren; ++rit) {
2937 LayoutModuleList::iterator const mit = layout_modules_.begin();
2938 LayoutModuleList::iterator const men = layout_modules_.end();
2939 LayoutModuleList::iterator found = find(mit, men, *rit);
2940 if (found == men)
2941 continue;
2942 layout_modules_.erase(found);
2943 }
2944 }
2945
2946
readIncludeonly(Lexer & lex)2947 void BufferParams::readIncludeonly(Lexer & lex)
2948 {
2949 if (!lex.eatLine()) {
2950 lyxerr << "Error (BufferParams::readIncludeonly):"
2951 "Unexpected end of input." << endl;
2952 return;
2953 }
2954 while (true) {
2955 string child = lex.getString();
2956 if (child == "\\end_includeonly")
2957 break;
2958 included_children_.push_back(child);
2959 lex.eatLine();
2960 }
2961 }
2962
2963
paperSizeName(PapersizePurpose purpose) const2964 string BufferParams::paperSizeName(PapersizePurpose purpose) const
2965 {
2966 switch (papersize) {
2967 case PAPER_DEFAULT:
2968 // could be anything, so don't guess
2969 return string();
2970 case PAPER_CUSTOM: {
2971 if (purpose == XDVI && !paperwidth.empty() &&
2972 !paperheight.empty()) {
2973 // heightxwidth<unit>
2974 string first = paperwidth;
2975 string second = paperheight;
2976 if (orientation == ORIENTATION_LANDSCAPE)
2977 first.swap(second);
2978 // cut off unit.
2979 return first.erase(first.length() - 2)
2980 + "x" + second;
2981 }
2982 return string();
2983 }
2984 case PAPER_A0:
2985 // dvips and dvipdfm do not know this
2986 if (purpose == DVIPS || purpose == DVIPDFM)
2987 return string();
2988 return "a0";
2989 case PAPER_A1:
2990 if (purpose == DVIPS || purpose == DVIPDFM)
2991 return string();
2992 return "a1";
2993 case PAPER_A2:
2994 if (purpose == DVIPS || purpose == DVIPDFM)
2995 return string();
2996 return "a2";
2997 case PAPER_A3:
2998 return "a3";
2999 case PAPER_A4:
3000 return "a4";
3001 case PAPER_A5:
3002 return "a5";
3003 case PAPER_A6:
3004 if (purpose == DVIPS || purpose == DVIPDFM)
3005 return string();
3006 return "a6";
3007 case PAPER_B0:
3008 if (purpose == DVIPS || purpose == DVIPDFM)
3009 return string();
3010 return "b0";
3011 case PAPER_B1:
3012 if (purpose == DVIPS || purpose == DVIPDFM)
3013 return string();
3014 return "b1";
3015 case PAPER_B2:
3016 if (purpose == DVIPS || purpose == DVIPDFM)
3017 return string();
3018 return "b2";
3019 case PAPER_B3:
3020 if (purpose == DVIPS || purpose == DVIPDFM)
3021 return string();
3022 return "b3";
3023 case PAPER_B4:
3024 // dvipdfm does not know this
3025 if (purpose == DVIPDFM)
3026 return string();
3027 return "b4";
3028 case PAPER_B5:
3029 if (purpose == DVIPDFM)
3030 return string();
3031 return "b5";
3032 case PAPER_B6:
3033 if (purpose == DVIPS || purpose == DVIPDFM)
3034 return string();
3035 return "b6";
3036 case PAPER_C0:
3037 if (purpose == DVIPS || purpose == DVIPDFM)
3038 return string();
3039 return "c0";
3040 case PAPER_C1:
3041 if (purpose == DVIPS || purpose == DVIPDFM)
3042 return string();
3043 return "c1";
3044 case PAPER_C2:
3045 if (purpose == DVIPS || purpose == DVIPDFM)
3046 return string();
3047 return "c2";
3048 case PAPER_C3:
3049 if (purpose == DVIPS || purpose == DVIPDFM)
3050 return string();
3051 return "c3";
3052 case PAPER_C4:
3053 if (purpose == DVIPS || purpose == DVIPDFM)
3054 return string();
3055 return "c4";
3056 case PAPER_C5:
3057 if (purpose == DVIPS || purpose == DVIPDFM)
3058 return string();
3059 return "c5";
3060 case PAPER_C6:
3061 if (purpose == DVIPS || purpose == DVIPDFM)
3062 return string();
3063 return "c6";
3064 case PAPER_JISB0:
3065 if (purpose == DVIPS || purpose == DVIPDFM)
3066 return string();
3067 return "jisb0";
3068 case PAPER_JISB1:
3069 if (purpose == DVIPS || purpose == DVIPDFM)
3070 return string();
3071 return "jisb1";
3072 case PAPER_JISB2:
3073 if (purpose == DVIPS || purpose == DVIPDFM)
3074 return string();
3075 return "jisb2";
3076 case PAPER_JISB3:
3077 if (purpose == DVIPS || purpose == DVIPDFM)
3078 return string();
3079 return "jisb3";
3080 case PAPER_JISB4:
3081 if (purpose == DVIPS || purpose == DVIPDFM)
3082 return string();
3083 return "jisb4";
3084 case PAPER_JISB5:
3085 if (purpose == DVIPS || purpose == DVIPDFM)
3086 return string();
3087 return "jisb5";
3088 case PAPER_JISB6:
3089 if (purpose == DVIPS || purpose == DVIPDFM)
3090 return string();
3091 return "jisb6";
3092 case PAPER_USEXECUTIVE:
3093 // dvipdfm does not know this
3094 if (purpose == DVIPDFM)
3095 return string();
3096 return "foolscap";
3097 case PAPER_USLEGAL:
3098 return "legal";
3099 case PAPER_USLETTER:
3100 default:
3101 if (purpose == XDVI)
3102 return "us";
3103 return "letter";
3104 }
3105 }
3106
3107
dvips_options() const3108 string const BufferParams::dvips_options() const
3109 {
3110 string result;
3111
3112 // If the class loads the geometry package, we do not know which
3113 // paper size is used, since we do not set it (bug 7013).
3114 // Therefore we must not specify any argument here.
3115 // dvips gets the correct paper size via DVI specials in this case
3116 // (if the class uses the geometry package correctly).
3117 if (documentClass().provides("geometry"))
3118 return result;
3119
3120 if (use_geometry
3121 && papersize == PAPER_CUSTOM
3122 && !lyxrc.print_paper_dimension_flag.empty()
3123 && !paperwidth.empty()
3124 && !paperheight.empty()) {
3125 // using a custom papersize
3126 result = lyxrc.print_paper_dimension_flag;
3127 result += ' ' + paperwidth;
3128 result += ',' + paperheight;
3129 } else {
3130 string const paper_option = paperSizeName(DVIPS);
3131 if (!paper_option.empty() && (paper_option != "letter" ||
3132 orientation != ORIENTATION_LANDSCAPE)) {
3133 // dvips won't accept -t letter -t landscape.
3134 // In all other cases, include the paper size
3135 // explicitly.
3136 result = lyxrc.print_paper_flag;
3137 result += ' ' + paper_option;
3138 }
3139 }
3140 if (orientation == ORIENTATION_LANDSCAPE &&
3141 papersize != PAPER_CUSTOM)
3142 result += ' ' + lyxrc.print_landscape_flag;
3143 return result;
3144 }
3145
3146
main_font_encoding() const3147 string const BufferParams::main_font_encoding() const
3148 {
3149 return font_encodings().empty() ? "default" : font_encodings().back();
3150 }
3151
3152
font_encodings() const3153 vector<string> const BufferParams::font_encodings() const
3154 {
3155 string doc_fontenc = (fontenc == "global") ? lyxrc.fontenc : fontenc;
3156
3157 vector<string> fontencs;
3158
3159 // "default" means "no explicit font encoding"
3160 if (doc_fontenc != "default") {
3161 fontencs = getVectorFromString(doc_fontenc);
3162 if (!language->fontenc().empty()
3163 && ascii_lowercase(language->fontenc()) != "none") {
3164 vector<string> fencs = getVectorFromString(language->fontenc());
3165 vector<string>::const_iterator fit = fencs.begin();
3166 for (; fit != fencs.end(); ++fit) {
3167 if (find(fontencs.begin(), fontencs.end(), *fit) == fontencs.end())
3168 fontencs.push_back(*fit);
3169 }
3170 }
3171 }
3172
3173 return fontencs;
3174 }
3175
3176
babelCall(string const & lang_opts,bool const langoptions) const3177 string BufferParams::babelCall(string const & lang_opts, bool const langoptions) const
3178 {
3179 // suppress the babel call if there is no BabelName defined
3180 // for the document language in the lib/languages file and if no
3181 // other languages are used (lang_opts is then empty)
3182 if (lang_opts.empty())
3183 return string();
3184 // either a specific language (AsBabelOptions setting in
3185 // lib/languages) or the prefs require the languages to
3186 // be submitted to babel itself (not the class).
3187 if (langoptions)
3188 return "\\usepackage[" + lang_opts + "]{babel}";
3189 return "\\usepackage{babel}";
3190 }
3191
3192
getGraphicsDriver(string const & package) const3193 docstring BufferParams::getGraphicsDriver(string const & package) const
3194 {
3195 docstring result;
3196
3197 if (package == "geometry") {
3198 if (graphics_driver == "dvips"
3199 || graphics_driver == "dvipdfm"
3200 || graphics_driver == "pdftex"
3201 || graphics_driver == "vtex")
3202 result = from_ascii(graphics_driver);
3203 else if (graphics_driver == "dvipdfmx")
3204 result = from_ascii("dvipdfm");
3205 }
3206
3207 return result;
3208 }
3209
3210
writeEncodingPreamble(otexstream & os,LaTeXFeatures & features) const3211 void BufferParams::writeEncodingPreamble(otexstream & os,
3212 LaTeXFeatures & features) const
3213 {
3214 // XeTeX/LuaTeX: (see also #9740)
3215 // With Unicode fonts we use utf8-plain without encoding package.
3216 // With TeX fonts, we cannot use utf8-plain, but "inputenc" fails.
3217 // XeTeX must use ASCII encoding (see Buffer.cpp),
3218 // for LuaTeX, we load "luainputenc" (see below).
3219 if (useNonTeXFonts || features.runparams().flavor == OutputParams::XETEX)
3220 return;
3221
3222 if (inputenc == "auto") {
3223 string const doc_encoding =
3224 language->encoding()->latexName();
3225 Encoding::Package const package =
3226 language->encoding()->package();
3227
3228 // Create list of inputenc options:
3229 set<string> encodings;
3230 // luainputenc fails with more than one encoding
3231 if (!features.runparams().isFullUnicode()) // if we reach this point, this means LuaTeX with TeX fonts
3232 // list all input encodings used in the document
3233 encodings = features.getEncodingSet(doc_encoding);
3234
3235 // If the "japanese" package (i.e. pLaTeX) is used,
3236 // inputenc must be omitted.
3237 // see http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg129680.html
3238 if ((!encodings.empty() || package == Encoding::inputenc)
3239 && !features.isRequired("japanese")
3240 && !features.isProvided("inputenc")) {
3241 os << "\\usepackage[";
3242 set<string>::const_iterator it = encodings.begin();
3243 set<string>::const_iterator const end = encodings.end();
3244 if (it != end) {
3245 os << from_ascii(*it);
3246 ++it;
3247 }
3248 for (; it != end; ++it)
3249 os << ',' << from_ascii(*it);
3250 if (package == Encoding::inputenc) {
3251 if (!encodings.empty())
3252 os << ',';
3253 os << from_ascii(doc_encoding);
3254 }
3255 if (features.runparams().flavor == OutputParams::LUATEX
3256 || features.runparams().flavor == OutputParams::DVILUATEX)
3257 os << "]{luainputenc}\n";
3258 else
3259 os << "]{inputenc}\n";
3260 }
3261 if (package == Encoding::CJK || features.mustProvide("CJK")) {
3262 if (language->encoding()->name() == "utf8-cjk"
3263 && LaTeXFeatures::isAvailable("CJKutf8"))
3264 os << "\\usepackage{CJKutf8}\n";
3265 else
3266 os << "\\usepackage{CJK}\n";
3267 }
3268 } else if (inputenc != "default") {
3269 switch (encoding().package()) {
3270 case Encoding::none:
3271 case Encoding::japanese:
3272 break;
3273 case Encoding::inputenc:
3274 // do not load inputenc if japanese is used
3275 // or if the class provides inputenc
3276 if (features.isRequired("japanese")
3277 || features.isProvided("inputenc"))
3278 break;
3279 os << "\\usepackage[" << from_ascii(encoding().latexName());
3280 if (features.runparams().flavor == OutputParams::LUATEX
3281 || features.runparams().flavor == OutputParams::DVILUATEX)
3282 os << "]{luainputenc}\n";
3283 else
3284 os << "]{inputenc}\n";
3285 break;
3286 case Encoding::CJK:
3287 if (encoding().name() == "utf8-cjk"
3288 && LaTeXFeatures::isAvailable("CJKutf8"))
3289 os << "\\usepackage{CJKutf8}\n";
3290 else
3291 os << "\\usepackage{CJK}\n";
3292 break;
3293 }
3294 // Load the CJK package if needed by a secondary language.
3295 // If the main encoding is some variant of UTF8, use CJKutf8.
3296 if (encoding().package() != Encoding::CJK && features.mustProvide("CJK")) {
3297 if (language->encoding()->name() == "utf8-cjk"
3298 && LaTeXFeatures::isAvailable("CJKutf8"))
3299 os << "\\usepackage{CJKutf8}\n";
3300 else
3301 os << "\\usepackage{CJK}\n";
3302 }
3303 }
3304 }
3305
3306
parseFontName(string const & name) const3307 string const BufferParams::parseFontName(string const & name) const
3308 {
3309 string mangled = name;
3310 size_t const idx = mangled.find('[');
3311 if (idx == string::npos || idx == 0)
3312 return mangled;
3313 else
3314 return mangled.substr(0, idx - 1);
3315 }
3316
3317
loadFonts(LaTeXFeatures & features) const3318 string const BufferParams::loadFonts(LaTeXFeatures & features) const
3319 {
3320 if (fontsRoman() == "default" && fontsSans() == "default"
3321 && fontsTypewriter() == "default"
3322 && (fontsMath() == "default" || fontsMath() == "auto"))
3323 //nothing to do
3324 return string();
3325
3326 ostringstream os;
3327
3328 /* Fontspec (XeTeX, LuaTeX): we provide GUI support for oldstyle
3329 * numbers (Numbers=OldStyle) and sf/tt scaling. The Ligatures=TeX/
3330 * Mapping=tex-text option assures TeX ligatures (such as "--")
3331 * are resolved. Note that tt does not use these ligatures.
3332 * TODO:
3333 * -- add more GUI options?
3334 * -- add more fonts (fonts for other scripts)
3335 * -- if there's a way to find out if a font really supports
3336 * OldStyle, enable/disable the widget accordingly.
3337 */
3338 if (useNonTeXFonts && features.isAvailable("fontspec")) {
3339 // "Mapping=tex-text" and "Ligatures=TeX" are equivalent.
3340 // However, until v.2 (2010/07/11) fontspec only knew
3341 // Mapping=tex-text (for XeTeX only); then "Ligatures=TeX"
3342 // was introduced for both XeTeX and LuaTeX (LuaTeX
3343 // didn't understand "Mapping=tex-text", while XeTeX
3344 // understood both. With most recent versions, both
3345 // variants are understood by both engines. However,
3346 // we want to provide support for at least TeXLive 2009
3347 // (for XeTeX; LuaTeX is only supported as of v.2)
3348 string const texmapping =
3349 (features.runparams().flavor == OutputParams::XETEX) ?
3350 "Mapping=tex-text" : "Ligatures=TeX";
3351 if (fontsRoman() != "default") {
3352 os << "\\setmainfont[" << texmapping;
3353 if (fonts_old_figures)
3354 os << ",Numbers=OldStyle";
3355 os << "]{" << parseFontName(fontsRoman()) << "}\n";
3356 }
3357 if (fontsSans() != "default") {
3358 string const sans = parseFontName(fontsSans());
3359 if (fontsSansScale() != 100)
3360 os << "\\setsansfont[Scale="
3361 << float(fontsSansScale()) / 100
3362 << "," << texmapping << "]{"
3363 << sans << "}\n";
3364 else
3365 os << "\\setsansfont[" << texmapping << "]{"
3366 << sans << "}\n";
3367 }
3368 if (fontsTypewriter() != "default") {
3369 string const mono = parseFontName(fontsTypewriter());
3370 if (fontsTypewriterScale() != 100)
3371 os << "\\setmonofont[Scale="
3372 << float(fontsTypewriterScale()) / 100
3373 << "]{"
3374 << mono << "}\n";
3375 else
3376 os << "\\setmonofont{"
3377 << mono << "}\n";
3378 }
3379 return os.str();
3380 }
3381
3382 // Tex Fonts
3383 bool const ot1 = (main_font_encoding() == "default" || main_font_encoding() == "OT1");
3384 bool const dryrun = features.runparams().dryrun;
3385 bool const complete = (fontsSans() == "default" && fontsTypewriter() == "default");
3386 bool const nomath = (fontsMath() == "default");
3387
3388 // ROMAN FONTS
3389 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsRoman())).getLaTeXCode(
3390 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3391 nomath);
3392
3393 // SANS SERIF
3394 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsSans())).getLaTeXCode(
3395 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3396 nomath, fontsSansScale());
3397
3398 // MONOSPACED/TYPEWRITER
3399 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsTypewriter())).getLaTeXCode(
3400 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3401 nomath, fontsTypewriterScale());
3402
3403 // MATH
3404 os << theLaTeXFonts().getLaTeXFont(from_ascii(fontsMath())).getLaTeXCode(
3405 dryrun, ot1, complete, fonts_expert_sc, fonts_old_figures,
3406 nomath);
3407
3408 return os.str();
3409 }
3410
3411
encoding() const3412 Encoding const & BufferParams::encoding() const
3413 {
3414 // Main encoding for LaTeX output.
3415 //
3416 // Exception: XeTeX with 8-bit TeX fonts requires ASCII (see #9740).
3417 // As the "flavor" is only known once export started, this
3418 // cannot be handled here. Instead, runparams.encoding is set
3419 // to ASCII in Buffer::makeLaTeXFile (for export)
3420 // and Buffer::writeLaTeXSource (for preview).
3421 if (useNonTeXFonts)
3422 return *(encodings.fromLyXName("utf8-plain"));
3423 if (inputenc == "auto" || inputenc == "default")
3424 return *language->encoding();
3425 Encoding const * const enc = encodings.fromLyXName(inputenc);
3426 if (enc)
3427 return *enc;
3428 LYXERR0("Unknown inputenc value `" << inputenc
3429 << "'. Using `auto' instead.");
3430 return *language->encoding();
3431 }
3432
3433
addCiteEngine(string const & engine)3434 bool BufferParams::addCiteEngine(string const & engine)
3435 {
3436 LayoutModuleList::const_iterator it = cite_engine_.begin();
3437 LayoutModuleList::const_iterator en = cite_engine_.end();
3438 for (; it != en; ++it)
3439 if (*it == engine)
3440 return false;
3441 cite_engine_.push_back(engine);
3442 return true;
3443 }
3444
3445
addCiteEngine(vector<string> const & engine)3446 bool BufferParams::addCiteEngine(vector<string> const & engine)
3447 {
3448 vector<string>::const_iterator it = engine.begin();
3449 vector<string>::const_iterator en = engine.end();
3450 bool ret = true;
3451 for (; it != en; ++it)
3452 if (!addCiteEngine(*it))
3453 ret = false;
3454 return ret;
3455 }
3456
3457
defaultBiblioStyle() const3458 string const & BufferParams::defaultBiblioStyle() const
3459 {
3460 if (!biblio_style.empty())
3461 return biblio_style;
3462
3463 map<string, string> const & bs = documentClass().defaultBiblioStyle();
3464 auto cit = bs.find(theCiteEnginesList.getTypeAsString(citeEngineType()));
3465 if (cit != bs.end())
3466 return cit->second;
3467 else
3468 return empty_string();
3469 }
3470
3471
fullAuthorList() const3472 bool const & BufferParams::fullAuthorList() const
3473 {
3474 return documentClass().fullAuthorList();
3475 }
3476
3477
getCiteAlias(string const & s) const3478 string BufferParams::getCiteAlias(string const & s) const
3479 {
3480 vector<string> commands =
3481 documentClass().citeCommands(citeEngineType());
3482 // If it is a real command, don't treat it as an alias
3483 if (find(commands.begin(), commands.end(), s) != commands.end())
3484 return string();
3485 map<string,string> aliases = documentClass().citeCommandAliases();
3486 if (aliases.find(s) != aliases.end())
3487 return aliases[s];
3488 return string();
3489 }
3490
3491
setCiteEngine(string const & engine)3492 void BufferParams::setCiteEngine(string const & engine)
3493 {
3494 clearCiteEngine();
3495 addCiteEngine(engine);
3496 }
3497
3498
setCiteEngine(vector<string> const & engine)3499 void BufferParams::setCiteEngine(vector<string> const & engine)
3500 {
3501 clearCiteEngine();
3502 addCiteEngine(engine);
3503 }
3504
3505
citeCommands() const3506 vector<string> BufferParams::citeCommands() const
3507 {
3508 static CitationStyle const default_style;
3509 vector<string> commands =
3510 documentClass().citeCommands(citeEngineType());
3511 if (commands.empty())
3512 commands.push_back(default_style.name);
3513 return commands;
3514 }
3515
3516
citeStyles() const3517 vector<CitationStyle> BufferParams::citeStyles() const
3518 {
3519 static CitationStyle const default_style;
3520 vector<CitationStyle> styles =
3521 documentClass().citeStyles(citeEngineType());
3522 if (styles.empty())
3523 styles.push_back(default_style);
3524 return styles;
3525 }
3526
3527
bibtexCommand() const3528 string const BufferParams::bibtexCommand() const
3529 {
3530 // Return document-specific setting if available
3531 if (bibtex_command != "default")
3532 return bibtex_command;
3533
3534 // If we have "default" in document settings, consult the prefs
3535 // 1. Japanese (uses a specific processor)
3536 if (encoding().package() == Encoding::japanese) {
3537 if (lyxrc.jbibtex_command != "automatic")
3538 // Return the specified program, if "automatic" is not set
3539 return lyxrc.jbibtex_command;
3540 else if (!useBiblatex()) {
3541 // With classic BibTeX, return pbibtex, jbibtex, bibtex
3542 if (lyxrc.jbibtex_alternatives.find("pbibtex") != lyxrc.jbibtex_alternatives.end())
3543 return "pbibtex";
3544 if (lyxrc.jbibtex_alternatives.find("jbibtex") != lyxrc.jbibtex_alternatives.end())
3545 return "jbibtex";
3546 return "bibtex";
3547 }
3548 }
3549 // 2. All other languages
3550 else if (lyxrc.bibtex_command != "automatic")
3551 // Return the specified program, if "automatic" is not set
3552 return lyxrc.bibtex_command;
3553
3554 // 3. Automatic: find the most suitable for the current cite framework
3555 if (useBiblatex()) {
3556 // For Biblatex, we prefer biber (also for Japanese)
3557 // and fall back to bibtex8 and, as last resort, bibtex
3558 if (lyxrc.bibtex_alternatives.find("biber") != lyxrc.bibtex_alternatives.end())
3559 return "biber";
3560 else if (lyxrc.bibtex_alternatives.find("bibtex8") != lyxrc.bibtex_alternatives.end())
3561 return "bibtex8";
3562 }
3563 return "bibtex";
3564 }
3565
3566
useBiblatex() const3567 bool BufferParams::useBiblatex() const
3568 {
3569 return theCiteEnginesList[citeEngine().list().front()]
3570 ->getCiteFramework() == "biblatex";
3571 }
3572
3573
invalidateConverterCache() const3574 void BufferParams::invalidateConverterCache() const
3575 {
3576 pimpl_->isExportCacheValid = false;
3577 pimpl_->isViewCacheValid = false;
3578 }
3579
3580
3581 // We shouldn't need to reset the params here, since anything
3582 // we need will be recopied.
copyForAdvFR(const BufferParams & bp)3583 void BufferParams::copyForAdvFR(const BufferParams & bp)
3584 {
3585 string const & lang = bp.language->lang();
3586 setLanguage(lang);
3587 layout_modules_ = bp.layout_modules_;
3588 string const & doc_class = bp.documentClass().name();
3589 setBaseClass(doc_class);
3590 }
3591
3592 } // namespace lyx
3593