2 * \file output_latex.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
8 * Full author contact details are available in file CREDITS.
13 #include "output_latex.h"
16 #include "BufferParams.h"
19 #include "InsetList.h"
23 #include "OutputParams.h"
24 #include "Paragraph.h"
25 #include "ParagraphParameters.h"
26 #include "TextClass.h"
29 #include "insets/InsetBibitem.h"
30 #include "insets/InsetArgument.h"
32 #include "support/lassert.h"
33 #include "support/convert.h"
34 #include "support/debug.h"
35 #include "support/lstrings.h"
36 #include "support/textutils.h"
39 #include <boost/next_prior.hpp>
43 using namespace lyx::support;
57 // There could easily be a conflict here, with the export process
58 // setting this one way, and a View>Source process (possbily for
59 // another Buffer) resetting it.
60 static int open_encoding_ = none;
61 static int cjk_inherited_ = 0;
62 Language const * prev_env_language_ = 0;
65 string const getPolyglossiaEnvName(Language const * lang)
67 string result = lang->polyglossia();
68 if (result == "arabic")
69 // exceptional spelling; see polyglossia docs.
75 struct TeXEnvironmentData
79 Language const * par_language;
80 Encoding const * prev_encoding;
85 static TeXEnvironmentData prepareEnvironment(Buffer const & buf,
87 ParagraphList::const_iterator pit,
89 OutputParams const & runparams)
91 TeXEnvironmentData data;
93 BufferParams const & bparams = buf.params();
95 // FIXME This test should not be necessary.
96 // We should perhaps issue an error if it is.
97 Layout const & style = text.inset().forcePlainLayout() ?
98 bparams.documentClass().plainLayout() : pit->layout();
100 ParagraphList const & paragraphs = text.paragraphs();
101 ParagraphList::const_iterator const priorpit =
102 pit == paragraphs.begin() ? pit : boost::prior(pit);
104 bool const use_prev_env_language = prev_env_language_ != 0
105 && priorpit->layout().isEnvironment()
106 && (priorpit->getDepth() > pit->getDepth()
107 || (priorpit->getDepth() == pit->getDepth()
108 && priorpit->layout() != pit->layout()));
110 data.prev_encoding = runparams.encoding;
111 data.par_language = pit->getParLanguage(bparams);
112 Language const * const doc_language = bparams.language;
113 Language const * const prev_par_language =
114 (pit != paragraphs.begin())
115 ? (use_prev_env_language ? prev_env_language_
116 : priorpit->getParLanguage(bparams))
119 bool const use_polyglossia = runparams.use_polyglossia;
120 string const par_lang = use_polyglossia ?
121 getPolyglossiaEnvName(data.par_language) : data.par_language->babel();
122 string const prev_par_lang = use_polyglossia ?
123 getPolyglossiaEnvName(prev_par_language) : prev_par_language->babel();
124 string const doc_lang = use_polyglossia ?
125 getPolyglossiaEnvName(doc_language) : doc_language->babel();
126 string const lang_begin_command = use_polyglossia ?
127 "\\begin{$$lang}" : lyxrc.language_command_begin;
128 string const lang_end_command = use_polyglossia ?
129 "\\end{$$lang}" : lyxrc.language_command_end;
131 if (par_lang != prev_par_lang) {
132 if (!lang_end_command.empty() &&
133 prev_par_lang != doc_lang &&
134 !prev_par_lang.empty()) {
135 os << from_ascii(subst(
139 // the '%' is necessary to prevent unwanted whitespace
143 if ((lang_end_command.empty() ||
144 par_lang != doc_lang) &&
146 os << from_ascii(subst(
151 && !data.par_language->polyglossiaOpts().empty())
153 << from_ascii(data.par_language->polyglossiaOpts())
155 // the '%' is necessary to prevent unwanted whitespace
160 data.leftindent_open = false;
161 if (!pit->params().leftIndent().zero()) {
162 os << "\\begin{LyXParagraphLeftIndent}{"
163 << from_ascii(pit->params().leftIndent().asLatexString())
165 data.leftindent_open = true;
168 if (style.isEnvironment()) {
169 os << "\\begin{" << from_ascii(style.latexname()) << '}';
170 if (!style.latexargs().empty()) {
171 OutputParams rp = runparams;
172 rp.local_font = &pit->getFirstFontSettings(bparams);
173 latexArgInsets(paragraphs, pit, os, rp, style.latexargs());
175 if (style.latextype == LATEX_LIST_ENVIRONMENT) {
177 << pit->params().labelWidthString()
179 } else if (style.labeltype == LABEL_BIBLIO) {
180 if (pit->params().labelWidthString().empty())
181 os << '{' << bibitemWidest(buf, runparams) << "}\n";
184 << pit->params().labelWidthString()
187 os << from_ascii(style.latexparam()) << '\n';
191 // in multilingual environments, the CJK tags have to be nested properly
192 data.cjk_nested = false;
193 if (data.par_language->encoding()->package() == Encoding::CJK &&
194 open_encoding_ != CJK && pit->isMultiLingual(bparams)) {
195 if (prev_par_language->encoding()->package() == Encoding::CJK)
196 os << "\\begin{CJK}{" << from_ascii(data.par_language->encoding()->latexName())
197 << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
198 open_encoding_ = CJK;
199 data.cjk_nested = true;
205 static void finishEnvironment(Buffer const & buf, Text const & text,
206 pit_type nextpit, otexstream & os,
207 OutputParams const & runparams,
208 TeXEnvironmentData const & data)
210 if (open_encoding_ == CJK && data.cjk_nested) {
211 // We need to close the encoding even if it does not change
212 // to do correct environment nesting
213 os << "\\end{CJK}\n";
214 open_encoding_ = none;
217 if (data.style->isEnvironment()) {
219 << "\\end{" << from_ascii(data.style->latexname()) << "}\n";
220 prev_env_language_ = data.par_language;
221 if (runparams.encoding != data.prev_encoding) {
222 runparams.encoding = data.prev_encoding;
223 if (!runparams.isFullUnicode())
224 os << setEncoding(data.prev_encoding->iconvName());
228 if (data.leftindent_open) {
229 os << breakln << "\\end{LyXParagraphLeftIndent}\n";
230 prev_env_language_ = data.par_language;
231 if (runparams.encoding != data.prev_encoding) {
232 runparams.encoding = data.prev_encoding;
233 if (!runparams.isFullUnicode())
234 os << setEncoding(data.prev_encoding->iconvName());
238 // Check whether we should output a blank line after the environment
239 DocumentClass const & tclass = buf.params().documentClass();
240 ParagraphList const & pars = text.paragraphs();
241 bool next_style_is_default = (nextpit >= runparams.par_end) ? false
242 : tclass.isDefaultLayout(pars.constIterator(nextpit)->layout());
243 if (!data.style->nextnoindent && next_style_is_default)
248 void TeXEnvironment(Buffer const & buf, Text const & text,
249 OutputParams const & runparams,
250 pit_type & pit, otexstream & os)
252 ParagraphList const & paragraphs = text.paragraphs();
253 ParagraphList::const_iterator par = paragraphs.constIterator(pit);
254 LYXERR(Debug::LATEX, "TeXEnvironment for paragraph " << pit);
256 Layout const & current_layout = par->layout();
257 depth_type const current_depth = par->params().depth();
258 Length const & current_left_indent = par->params().leftIndent();
260 // This is for debugging purpose at the end.
261 pit_type const par_begin = pit;
262 for (; pit < runparams.par_end; ++pit) {
263 ParagraphList::const_iterator par = paragraphs.constIterator(pit);
265 // check first if this is an higher depth paragraph.
266 bool go_out = (par->params().depth() < current_depth);
267 if (par->params().depth() == current_depth) {
268 // This environment is finished.
269 go_out |= (par->layout() != current_layout);
270 go_out |= (par->params().leftIndent() != current_left_indent);
273 // nothing to do here, restore pit and go out.
278 if (par->layout() == current_layout
279 && par->params().depth() == current_depth
280 && par->params().leftIndent() == current_left_indent) {
281 // We are still in the same environment so TeXOnePar and continue;
282 TeXOnePar(buf, text, pit, os, runparams);
286 // We are now in a deeper environment.
287 // Either par->layout() != current_layout
288 // Or par->params().depth() > current_depth
289 // Or par->params().leftIndent() != current_left_indent)
291 // FIXME This test should not be necessary.
292 // We should perhaps issue an error if it is.
293 bool const force_plain_layout = text.inset().forcePlainLayout();
294 Layout const & style = force_plain_layout
295 ? buf.params().documentClass().plainLayout()
298 if (!style.isEnvironment()) {
299 // This is a standard paragraph, no need to call TeXEnvironment.
300 TeXOnePar(buf, text, pit, os, runparams);
304 // This is a new environment.
305 TeXEnvironmentData const data =
306 prepareEnvironment(buf, text, par, os, runparams);
307 // Recursive call to TeXEnvironment!
308 TeXEnvironment(buf, text, runparams, pit, os);
309 finishEnvironment(buf, text, pit + 1, os, runparams, data);
312 if (pit != runparams.par_end)
313 LYXERR(Debug::LATEX, "TeXEnvironment for paragraph " << par_begin << " done.");
317 void getArgInsets(otexstream & os, OutputParams const & runparams, Layout::LaTeXArgMap const & latexargs,
318 map<int, lyx::InsetArgument const *> ilist, vector<string> required, string const & prefix)
320 unsigned int const argnr = latexargs.size();
324 for (unsigned int i = 1; i <= argnr; ++i) {
325 map<int, InsetArgument const *>::const_iterator lit = ilist.find(i);
326 bool inserted = false;
327 if (lit != ilist.end()) {
328 InsetArgument const * ins = (*lit).second;
330 Layout::LaTeXArgMap::const_iterator const lait =
331 latexargs.find(ins->name());
332 if (lait != latexargs.end()) {
333 Layout::latexarg arg = (*lait).second;
334 docstring ldelim = arg.mandatory ?
335 from_ascii("{") : from_ascii("[");
336 docstring rdelim = arg.mandatory ?
337 from_ascii("}") : from_ascii("]");
338 if (!arg.ldelim.empty())
340 if (!arg.rdelim.empty())
342 ins->latexArgument(os, runparams, ldelim, rdelim, arg.presetarg);
348 Layout::LaTeXArgMap::const_iterator lait = latexargs.begin();
349 Layout::LaTeXArgMap::const_iterator const laend = latexargs.end();
350 for (; lait != laend; ++lait) {
351 string const name = prefix + convert<string>(i);
352 if ((*lait).first == name) {
353 Layout::latexarg arg = (*lait).second;
354 docstring preset = arg.presetarg;
355 if (!arg.defaultarg.empty()) {
358 preset += arg.defaultarg;
361 docstring ldelim = arg.ldelim.empty() ?
362 from_ascii("{") : arg.ldelim;
363 docstring rdelim = arg.rdelim.empty() ?
364 from_ascii("}") : arg.rdelim;
365 os << ldelim << preset << rdelim;
366 } else if (!preset.empty()) {
367 docstring ldelim = arg.ldelim.empty() ?
368 from_ascii("[") : arg.ldelim;
369 docstring rdelim = arg.rdelim.empty() ?
370 from_ascii("]") : arg.rdelim;
371 os << ldelim << preset << rdelim;
372 } else if (find(required.begin(), required.end(),
373 (*lait).first) != required.end()) {
374 docstring ldelim = arg.ldelim.empty() ?
375 from_ascii("[") : arg.ldelim;
376 docstring rdelim = arg.rdelim.empty() ?
377 from_ascii("]") : arg.rdelim;
378 os << ldelim << rdelim;
391 void latexArgInsets(Paragraph const & par, otexstream & os,
392 OutputParams const & runparams, Layout::LaTeXArgMap const & latexargs, string const & prefix)
394 map<int, InsetArgument const *> ilist;
395 vector<string> required;
397 InsetList::const_iterator it = par.insetList().begin();
398 InsetList::const_iterator end = par.insetList().end();
399 for (; it != end; ++it) {
400 if (it->inset->lyxCode() == ARG_CODE) {
401 InsetArgument const * ins =
402 static_cast<InsetArgument const *>(it->inset);
403 if (ins->name().empty())
404 LYXERR0("Error: Unnamed argument inset!");
406 string const name = prefix.empty() ? ins->name() : split(ins->name(), ':');
407 unsigned int const nr = convert<unsigned int>(name);
409 Layout::LaTeXArgMap::const_iterator const lit =
410 latexargs.find(ins->name());
411 if (lit != latexargs.end()) {
412 Layout::latexarg const & arg = (*lit).second;
413 if (!arg.requires.empty()) {
414 vector<string> req = getVectorFromString(arg.requires);
415 required.insert(required.end(), req.begin(), req.end());
421 getArgInsets(os, runparams, latexargs, ilist, required, prefix);
425 void latexArgInsets(ParagraphList const & pars, ParagraphList::const_iterator pit,
426 otexstream & os, OutputParams const & runparams, Layout::LaTeXArgMap const & latexargs,
427 string const & prefix)
429 map<int, InsetArgument const *> ilist;
430 vector<string> required;
432 depth_type const current_depth = pit->params().depth();
433 Layout const current_layout = pit->layout();
435 // get the first paragraph in sequence with this layout and depth
438 if (boost::prior(pit, offset) == pars.begin())
440 ParagraphList::const_iterator priorpit = boost::prior(pit, offset + 1);
441 if (priorpit->layout() == current_layout
442 && priorpit->params().depth() == current_depth)
448 ParagraphList::const_iterator spit = boost::prior(pit, offset);
450 for (; spit != pars.end(); ++spit) {
451 if (spit->layout() != current_layout || spit->params().depth() < current_depth)
453 if (spit->params().depth() > current_depth)
455 InsetList::const_iterator it = spit->insetList().begin();
456 InsetList::const_iterator end = spit->insetList().end();
457 for (; it != end; ++it) {
458 if (it->inset->lyxCode() == ARG_CODE) {
459 InsetArgument const * ins =
460 static_cast<InsetArgument const *>(it->inset);
461 if (ins->name().empty())
462 LYXERR0("Error: Unnamed argument inset!");
464 string const name = prefix.empty() ? ins->name() : split(ins->name(), ':');
465 unsigned int const nr = convert<unsigned int>(name);
466 if (ilist.find(nr) == ilist.end())
468 Layout::LaTeXArgMap::const_iterator const lit =
469 latexargs.find(ins->name());
470 if (lit != latexargs.end()) {
471 Layout::latexarg const & arg = (*lit).second;
472 if (!arg.requires.empty()) {
473 vector<string> req = getVectorFromString(arg.requires);
474 required.insert(required.end(), req.begin(), req.end());
481 getArgInsets(os, runparams, latexargs, ilist, required, prefix);
486 // output the proper paragraph start according to latextype.
487 void parStartCommand(Paragraph const & par, otexstream & os,
488 OutputParams const & runparams, Layout const & style)
490 switch (style.latextype) {
492 os << '\\' << from_ascii(style.latexname());
495 if (!style.latexargs().empty())
496 latexArgInsets(par, os, runparams, style.latexargs());
497 os << from_ascii(style.latexparam());
499 case LATEX_ITEM_ENVIRONMENT:
500 case LATEX_LIST_ENVIRONMENT:
501 os << "\\" + style.itemcommand();
503 if (!style.itemargs().empty())
504 latexArgInsets(par, os, runparams, style.itemargs(), "item:");
507 case LATEX_BIB_ENVIRONMENT:
508 // ignore this, the inset will write itself
517 // FIXME: this should be anonymous
518 void TeXOnePar(Buffer const & buf,
522 OutputParams const & runparams_in,
523 string const & everypar,
524 int start_pos, int end_pos)
526 BufferParams const & bparams = runparams_in.is_child
527 ? buf.masterParams() : buf.params();
528 ParagraphList const & paragraphs = text.paragraphs();
529 Paragraph const & par = paragraphs.at(pit);
530 // FIXME This check should not really be needed.
531 // Perhaps we should issue an error if it is.
532 Layout const style = text.inset().forcePlainLayout() ?
533 bparams.documentClass().plainLayout() : par.layout();
535 if (style.inpreamble)
538 LYXERR(Debug::LATEX, "TeXOnePar for paragraph " << pit << " ptr " << &par << " '"
541 OutputParams runparams = runparams_in;
542 runparams.isLastPar = (pit == pit_type(paragraphs.size() - 1));
543 // We reinitialze par begin and end to be on the safe side
544 // with embedded inset as we don't know if they set those
546 runparams.par_begin = 0;
547 runparams.par_end = 0;
549 bool const maintext = text.isMainText();
550 // we are at the beginning of an inset and CJK is already open;
551 // we count inheritation levels to get the inset nesting right.
552 if (pit == 0 && !maintext
553 && (cjk_inherited_ > 0 || open_encoding_ == CJK)) {
555 open_encoding_ = none;
558 if (text.inset().isPassThru()) {
559 Font const outerfont = text.outerFont(pit);
561 // No newline before first paragraph in this lyxtext
564 if (!text.inset().getLayout().parbreakIsNewline())
568 par.latex(bparams, outerfont, os, runparams, start_pos, end_pos);
572 Paragraph const * nextpar = runparams.isLastPar
573 ? 0 : ¶graphs.at(pit + 1);
575 if (style.pass_thru) {
576 Font const outerfont = text.outerFont(pit);
577 parStartCommand(par, os, runparams, style);
579 par.latex(bparams, outerfont, os, runparams, start_pos, end_pos);
581 // I did not create a parEndCommand for this minuscule
582 // task because in the other user of parStartCommand
583 // the code is different (JMarc)
584 if (style.isCommand())
588 if (!style.parbreak_is_newline) {
590 } else if (nextpar && !style.isEnvironment()) {
591 Layout const nextstyle = text.inset().forcePlainLayout()
592 ? bparams.documentClass().plainLayout()
594 if (nextstyle.name() != style.name())
601 // This paragraph's language
602 Language const * const par_language = par.getParLanguage(bparams);
603 // The document's language
604 Language const * const doc_language = bparams.language;
605 // The language that was in effect when the environment this paragraph is
606 // inside of was opened
607 Language const * const outer_language =
608 (runparams.local_font != 0) ?
609 runparams.local_font->language() : doc_language;
611 Paragraph const * priorpar = (pit == 0) ? 0 : ¶graphs.at(pit - 1);
613 // The previous language that was in effect is the language of the
614 // previous paragraph, unless the previous paragraph is inside an
615 // environment with nesting depth greater than (or equal to, but with
616 // a different layout) the current one. If there is no previous
617 // paragraph, the previous language is the outer language.
618 bool const use_prev_env_language = prev_env_language_ != 0
620 && priorpar->layout().isEnvironment()
621 && (priorpar->getDepth() > par.getDepth()
622 || (priorpar->getDepth() == par.getDepth()
623 && priorpar->layout() != par.layout()));
624 Language const * const prev_language =
626 ? (use_prev_env_language ? prev_env_language_
627 : priorpar->getParLanguage(bparams))
631 bool const use_polyglossia = runparams.use_polyglossia;
632 string const par_lang = use_polyglossia ?
633 getPolyglossiaEnvName(par_language): par_language->babel();
634 string const prev_lang = use_polyglossia ?
635 getPolyglossiaEnvName(prev_language) : prev_language->babel();
636 string const doc_lang = use_polyglossia ?
637 getPolyglossiaEnvName(doc_language) : doc_language->babel();
638 string const outer_lang = use_polyglossia ?
639 getPolyglossiaEnvName(outer_language) : outer_language->babel();
640 string lang_begin_command = use_polyglossia ?
641 "\\begin{$$lang}" : lyxrc.language_command_begin;
642 string lang_end_command = use_polyglossia ?
643 "\\end{$$lang}" : lyxrc.language_command_end;
644 // the '%' is necessary to prevent unwanted whitespace
645 string lang_command_termination = "%\n";
647 // In some insets (such as Arguments), we cannot use \selectlanguage
648 bool const localswitch = !use_polyglossia
649 && text.inset().getLayout().forcelocalfontswitch();
651 lang_begin_command = lyxrc.language_command_local;
652 lang_end_command = "}";
653 lang_command_termination.clear();
656 if (par_lang != prev_lang
657 // check if we already put language command in TeXEnvironment()
658 && !(style.isEnvironment()
659 && (pit == 0 || (priorpar->layout() != par.layout()
660 && priorpar->getDepth() <= par.getDepth())
661 || priorpar->getDepth() < par.getDepth())))
663 if (!lang_end_command.empty() &&
664 prev_lang != outer_lang &&
667 os << from_ascii(subst(lang_end_command,
670 << lang_command_termination;
673 // We need to open a new language if we couldn't close the previous
674 // one (because there's no language_command_end); and even if we closed
675 // the previous one, if the current language is different than the
676 // outer_language (which is currently in effect once the previous one
678 if ((lang_end_command.empty() || par_lang != outer_lang)
679 && !par_lang.empty()) {
680 // If we're inside an inset, and that inset is within an \L or \R
681 // (or equivalents), then within the inset, too, any opposite
682 // language paragraph should appear within an \L or \R (in addition
683 // to, outside of, the normal language switch commands).
684 // This behavior is not correct for ArabTeX, though.
687 && par_language->lang() != "arabic_arabtex"
688 && outer_language->lang() != "arabic_arabtex"
689 // are we in an inset?
690 && runparams.local_font != 0
691 // is the inset within an \L or \R?
693 // FIXME: currently, we don't check this; this means that
694 // we'll have unnnecessary \L and \R commands, but that
695 // doesn't seem to hurt (though latex will complain)
697 // is this paragraph in the opposite direction?
698 && runparams.local_font->isRightToLeft() != par_language->rightToLeft()) {
699 // FIXME: I don't have a working copy of the Arabi package, so
700 // I'm not sure if the farsi and arabic_arabi stuff is correct
702 if (par_language->lang() == "farsi")
704 else if (outer_language->lang() == "farsi")
706 else if (par_language->lang() == "arabic_arabi")
708 else if (outer_language->lang() == "arabic_arabi")
710 // remaining RTL languages currently is hebrew
711 else if (par_language->rightToLeft())
716 // With CJK, the CJK tag has to be closed first (see below)
717 if (runparams.encoding->package() != Encoding::CJK
718 && !par_lang.empty()) {
719 os << from_ascii(subst(
724 && !par_language->polyglossiaOpts().empty())
726 << from_ascii(par_language->polyglossiaOpts())
728 os << lang_command_termination;
733 // Switch file encoding if necessary; no need to do this for "default"
734 // encoding, since this only affects the position of the outputted
735 // \inputencoding command; the encoding switch will occur when necessary
736 if (bparams.inputenc == "auto"
737 && runparams.encoding->package() != Encoding::none) {
738 // Look ahead for future encoding changes.
739 // We try to output them at the beginning of the paragraph,
740 // since the \inputencoding command is not allowed e.g. in
741 // sections. For this reason we only set runparams.moving_arg
742 // after checking for the encoding change, otherwise the
743 // change would be always avoided by switchEncoding().
744 for (pos_type i = 0; i < par.size(); ++i) {
745 char_type const c = par.getChar(i);
746 Encoding const * const encoding =
747 par.getFontSettings(bparams, i).language()->encoding();
748 if (encoding->package() != Encoding::CJK
749 && runparams.encoding->package() == Encoding::inputenc
754 // All characters before c are in the ASCII range, and
755 // c is non-ASCII (but no inset), so change the
756 // encoding to that required by the language of c.
757 // With CJK, only add switch if we have CJK content at the beginning
759 if (i != 0 && encoding->package() == Encoding::CJK)
762 pair<bool, int> enc_switch = switchEncoding(os.os(),
763 bparams, runparams, *encoding);
764 // the following is necessary after a CJK environment in a multilingual
765 // context (nesting issue).
766 if (par_language->encoding()->package() == Encoding::CJK
767 && open_encoding_ != CJK && cjk_inherited_ == 0) {
768 os << "\\begin{CJK}{" << from_ascii(par_language->encoding()->latexName())
769 << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
770 open_encoding_ = CJK;
772 if (encoding->package() != Encoding::none && enc_switch.first) {
773 if (enc_switch.second > 0) {
774 // the '%' is necessary to prevent unwanted whitespace
777 // With CJK, the CJK tag had to be closed first (see above)
778 if (runparams.encoding->package() == Encoding::CJK
779 && !par_lang.empty()) {
780 os << from_ascii(subst(
784 << lang_command_termination;
786 runparams.encoding = encoding;
792 runparams.moving_arg |= style.needprotect;
793 Encoding const * const prev_encoding = runparams.encoding;
795 bool const useSetSpace = bparams.documentClass().provides("SetSpace");
796 if (par.allowParagraphCustomization()) {
797 if (par.params().startOfAppendix()) {
798 os << "\n\\appendix\n";
801 if (!par.params().spacing().isDefault()
802 && (pit == 0 || !priorpar->hasSameLayout(par)))
804 os << from_ascii(par.params().spacing().writeEnvirBegin(useSetSpace))
808 if (style.isCommand()) {
813 parStartCommand(par, os, runparams, style);
814 Font const outerfont = text.outerFont(pit);
817 os << from_utf8(everypar);
818 par.latex(bparams, outerfont, os, runparams, start_pos, end_pos);
820 // Make sure that \\par is done with the font of the last
821 // character if this has another size as the default.
822 // This is necessary because LaTeX (and LyX on the screen)
823 // calculates the space between the baselines according
824 // to this font. (Matthias)
826 // Is this really needed ? (Dekel)
827 // We do not need to use to change the font for the last paragraph
830 Font const font = par.empty()
831 ? par.getLayoutFont(bparams, outerfont)
832 : par.getFont(bparams, par.size() - 1, outerfont);
834 bool const is_command = style.isCommand();
836 if (style.resfont.size() != font.fontInfo().size()
840 os << "\\" << from_ascii(font.latexSize()) << " \\par}";
841 } else if (is_command) {
843 if (!style.postcommandargs().empty())
844 latexArgInsets(par, os, runparams, style.postcommandargs(), "post:");
845 if (runparams.encoding != prev_encoding) {
846 runparams.encoding = prev_encoding;
847 if (!runparams.isFullUnicode())
848 os << setEncoding(prev_encoding->iconvName());
852 bool pending_newline = false;
853 bool unskip_newline = false;
854 switch (style.latextype) {
855 case LATEX_ITEM_ENVIRONMENT:
856 case LATEX_LIST_ENVIRONMENT:
858 && (par.params().depth() < nextpar->params().depth())
859 && !par.isEnvSeparator(par.size() - 1))
860 pending_newline = true;
862 case LATEX_ENVIRONMENT: {
863 // if its the last paragraph of the current environment
864 // skip it otherwise fall through
866 && (nextpar->layout() != par.layout()
867 || nextpar->params().depth() != par.params().depth()))
871 // fall through possible
873 // we don't need it for the last paragraph!!!
874 // or if the last thing is an environment separator
875 if (nextpar && par.size() > 0 && !par.isEnvSeparator(par.size() - 1))
876 pending_newline = true;
879 if (par.allowParagraphCustomization()) {
880 if (!par.params().spacing().isDefault()
881 && (runparams.isLastPar || !nextpar->hasSameLayout(par))) {
885 string const endtag =
886 par.params().spacing().writeEnvirEnd(useSetSpace);
887 if (prefixIs(endtag, "\\end{"))
890 os << from_ascii(endtag);
891 pending_newline = true;
895 // Closing the language is needed for the last paragraph; it is also
896 // needed if we're within an \L or \R that we may have opened above (not
897 // necessarily in this paragraph) and are about to close.
898 bool closing_rtl_ltr_environment = !use_polyglossia
900 && (par_language->lang() != "arabic_arabtex"
901 && outer_language->lang() != "arabic_arabtex")
902 // have we opened an \L or \R environment?
903 && runparams.local_font != 0
904 && runparams.local_font->isRightToLeft() != par_language->rightToLeft()
905 // are we about to close the language?
906 &&((nextpar && par_language->babel() != (nextpar->getParLanguage(bparams))->babel())
907 || (runparams.isLastPar && par_language->babel() != outer_language->babel()));
909 if (closing_rtl_ltr_environment
910 || (runparams.isLastPar
911 && ((!use_polyglossia && par_language->babel() != outer_language->babel())
912 || (use_polyglossia && par_language->polyglossia() != outer_language->polyglossia())))) {
913 // Since \selectlanguage write the language to the aux file,
914 // we need to reset the language at the end of footnote or
920 // when the paragraph uses CJK, the language has to be closed earlier
921 if (font.language()->encoding()->package() != Encoding::CJK) {
922 if (lang_end_command.empty()) {
923 // If this is a child, we should restore the
924 // master language after the last paragraph.
925 Language const * const current_language =
926 (runparams.isLastPar && runparams.master_language)
927 ? runparams.master_language
929 string const current_lang = use_polyglossia
930 ? getPolyglossiaEnvName(current_language)
931 : current_language->babel();
932 if (!current_lang.empty()) {
933 os << from_ascii(subst(
937 pending_newline = !localswitch;
938 unskip_newline = !localswitch;
940 } else if (!par_lang.empty()) {
941 os << from_ascii(subst(
945 pending_newline = !localswitch;
946 unskip_newline = !localswitch;
950 if (closing_rtl_ltr_environment)
953 if (pending_newline) {
955 // prevent unwanted whitespace
960 // if this is a CJK-paragraph and the next isn't, close CJK
961 // also if the next paragraph is a multilingual environment (because of nesting)
963 && open_encoding_ == CJK
964 && (nextpar->getParLanguage(bparams)->encoding()->package() != Encoding::CJK
965 || (nextpar->layout().isEnvironment() && nextpar->isMultiLingual(bparams)))
966 // inbetween environments, CJK has to be closed later (nesting!)
967 && (!style.isEnvironment() || !nextpar->layout().isEnvironment())) {
968 os << "\\end{CJK}\n";
969 open_encoding_ = none;
972 // If this is the last paragraph, close the CJK environment
973 // if necessary. If it's an environment, we'll have to \end that first.
974 if (runparams.isLastPar && !style.isEnvironment()) {
975 switch (open_encoding_) {
977 // do nothing at the end of child documents
978 if (maintext && buf.masterBuffer() != &buf)
982 os << "\n\\end{CJK}\n";
986 open_encoding_ = none;
991 open_encoding_ = none;
1001 // If this is the last paragraph, and a local_font was set upon entering
1002 // the inset, and we're using "auto" or "default" encoding, the encoding
1003 // should be set back to that local_font's encoding.
1004 // However, do not change the encoding when a fully unicode aware backend
1005 // such as XeTeX is used.
1006 if (runparams.isLastPar && runparams_in.local_font != 0
1007 && runparams_in.encoding != runparams_in.local_font->language()->encoding()
1008 && (bparams.inputenc == "auto" || bparams.inputenc == "default")
1009 && (!runparams.isFullUnicode())) {
1010 runparams_in.encoding = runparams_in.local_font->language()->encoding();
1011 os << setEncoding(runparams_in.encoding->iconvName());
1013 // Otherwise, the current encoding should be set for the next paragraph.
1015 runparams_in.encoding = runparams.encoding;
1018 // we don't need a newline for the last paragraph!!!
1019 // Note from JMarc: we will re-add a \n explicitly in
1020 // TeXEnvironment, because it is needed in this case
1021 if (nextpar && par.size() > 0 && !par.isEnvSeparator(par.size() - 1)) {
1022 // Make sure to start a new line
1024 Layout const & next_layout = nextpar->layout();
1025 // A newline '\n' is always output before a command,
1026 // so avoid doubling it.
1027 if (!next_layout.isCommand()) {
1028 // Here we now try to avoid spurious empty lines by
1029 // outputting a paragraph break only if: (case 1) the
1030 // paragraph style allows parbreaks and no \begin, \end
1031 // or \item tags are going to follow (i.e., if the next
1032 // isn't the first or the current isn't the last
1033 // paragraph of an environment or itemize) and the
1034 // depth and alignment of the following paragraph is
1035 // unchanged, or (case 2) the following is a
1036 // non-environment paragraph whose depth is increased
1037 // but whose alignment is unchanged, or (case 3) the
1038 // paragraph is a command not followed by an environment
1039 // and the alignment of the current and next paragraph
1040 // is unchanged, or (case 4) the current alignment is
1041 // changed and a standard paragraph follows.
1042 DocumentClass const & tclass = bparams.documentClass();
1043 if ((style == next_layout
1044 && !style.parbreak_is_newline
1045 && style.latextype != LATEX_ITEM_ENVIRONMENT
1046 && style.latextype != LATEX_LIST_ENVIRONMENT
1047 && style.align == par.getAlign()
1048 && nextpar->getDepth() == par.getDepth()
1049 && nextpar->getAlign() == par.getAlign())
1050 || (!next_layout.isEnvironment()
1051 && nextpar->getDepth() > par.getDepth()
1052 && nextpar->getAlign() == par.getAlign())
1053 || (style.isCommand()
1054 && !next_layout.isEnvironment()
1055 && style.align == par.getAlign()
1056 && next_layout.align == nextpar->getAlign())
1057 || (style.align != par.getAlign()
1058 && tclass.isDefaultLayout(next_layout))) {
1064 LYXERR(Debug::LATEX, "TeXOnePar for paragraph " << pit << " done; ptr "
1065 << &par << " next " << nextpar);
1071 // LaTeX all paragraphs
1072 void latexParagraphs(Buffer const & buf,
1075 OutputParams const & runparams,
1076 string const & everypar)
1078 LASSERT(runparams.par_begin <= runparams.par_end,
1079 { os << "% LaTeX Output Error\n"; return; } );
1081 BufferParams const & bparams = buf.params();
1083 bool const maintext = text.isMainText();
1084 bool const is_child = buf.masterBuffer() != &buf;
1086 // Open a CJK environment at the beginning of the main buffer
1087 // if the document's language is a CJK language
1088 // (but not in child documents)
1089 if (maintext && !is_child
1090 && bparams.encoding().package() == Encoding::CJK) {
1091 os << "\\begin{CJK}{" << from_ascii(bparams.encoding().latexName())
1092 << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
1093 open_encoding_ = CJK;
1095 // if "auto begin" is switched off, explicitly switch the
1096 // language on at start
1097 string const mainlang = runparams.use_polyglossia
1098 ? getPolyglossiaEnvName(bparams.language)
1099 : bparams.language->babel();
1100 string const lang_begin_command = runparams.use_polyglossia ?
1101 "\\begin{$$lang}" : lyxrc.language_command_begin;
1103 if (maintext && !lyxrc.language_auto_begin &&
1104 !mainlang.empty()) {
1106 os << from_utf8(subst(lang_begin_command,
1109 if (runparams.use_polyglossia
1110 && !bparams.language->polyglossiaOpts().empty())
1112 << from_ascii(bparams.language->polyglossiaOpts())
1117 ParagraphList const & paragraphs = text.paragraphs();
1119 if (runparams.par_begin == runparams.par_end) {
1120 // The full doc will be exported but it is easier to just rely on
1121 // runparams range parameters that will be passed TeXEnvironment.
1122 runparams.par_begin = 0;
1123 runparams.par_end = paragraphs.size();
1126 pit_type pit = runparams.par_begin;
1127 // lastpit is for the language check after the loop.
1128 pit_type lastpit = pit;
1129 // variables used in the loop:
1130 bool was_title = false;
1131 bool already_title = false;
1132 DocumentClass const & tclass = bparams.documentClass();
1134 for (; pit < runparams.par_end; ++pit) {
1136 ParagraphList::const_iterator par = paragraphs.constIterator(pit);
1138 // FIXME This check should not be needed. We should
1139 // perhaps issue an error if it is.
1140 Layout const & layout = text.inset().forcePlainLayout() ?
1141 tclass.plainLayout() : par->layout();
1143 if (layout.intitle) {
1144 if (already_title) {
1145 LYXERR0("Error in latexParagraphs: You"
1146 " should not mix title layouts"
1147 " with normal ones.");
1148 } else if (!was_title) {
1150 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1152 << from_ascii(tclass.titlename())
1156 } else if (was_title && !already_title) {
1157 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1158 os << "\\end{" << from_ascii(tclass.titlename())
1162 os << "\\" << from_ascii(tclass.titlename())
1165 already_title = true;
1170 if (!layout.isEnvironment() && par->params().leftIndent().zero()) {
1171 // This is a standard top level paragraph, TeX it and continue.
1172 TeXOnePar(buf, text, pit, os, runparams, everypar);
1176 TeXEnvironmentData const data =
1177 prepareEnvironment(buf, text, par, os, runparams);
1178 // pit can be changed in TeXEnvironment.
1179 TeXEnvironment(buf, text, runparams, pit, os);
1180 finishEnvironment(buf, text, pit + 1, os, runparams, data);
1183 if (pit == runparams.par_end) {
1184 // Make sure that the last paragraph is
1185 // correctly terminated (because TeXOnePar does
1186 // not add a \n in this case)
1190 // It might be that we only have a title in this document
1191 if (was_title && !already_title) {
1192 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1193 os << "\\end{" << from_ascii(tclass.titlename())
1196 os << "\\" << from_ascii(tclass.titlename())
1201 // if "auto end" is switched off, explicitly close the language at the end
1202 // but only if the last par is in a babel language
1203 string const lang_end_command = runparams.use_polyglossia ?
1204 "\\end{$$lang}" : lyxrc.language_command_end;
1205 if (maintext && !lyxrc.language_auto_end && !mainlang.empty() &&
1206 paragraphs.at(lastpit).getParLanguage(bparams)->encoding()->package() != Encoding::CJK) {
1207 os << from_utf8(subst(lang_end_command,
1213 // If the last paragraph is an environment, we'll have to close
1214 // CJK at the very end to do proper nesting.
1215 if (maintext && !is_child && open_encoding_ == CJK) {
1216 os << "\\end{CJK}\n";
1217 open_encoding_ = none;
1220 // reset inherited encoding
1221 if (cjk_inherited_ > 0) {
1222 cjk_inherited_ -= 1;
1223 if (cjk_inherited_ == 0)
1224 open_encoding_ = CJK;
1229 pair<bool, int> switchEncoding(odocstream & os, BufferParams const & bparams,
1230 OutputParams const & runparams, Encoding const & newEnc,
1233 Encoding const & oldEnc = *runparams.encoding;
1234 bool moving_arg = runparams.moving_arg;
1235 // If we switch from/to CJK, we need to switch anyway, despite custom inputenc
1236 bool const from_to_cjk =
1237 (oldEnc.package() == Encoding::CJK && newEnc.package() != Encoding::CJK)
1238 || (oldEnc.package() != Encoding::CJK && newEnc.package() == Encoding::CJK);
1239 if (!force && !from_to_cjk
1240 && ((bparams.inputenc != "auto" && bparams.inputenc != "default") || moving_arg))
1241 return make_pair(false, 0);
1243 // Do nothing if the encoding is unchanged.
1244 if (oldEnc.name() == newEnc.name())
1245 return make_pair(false, 0);
1247 // FIXME We ignore encoding switches from/to encodings that do
1248 // neither support the inputenc package nor the CJK package here.
1249 // This does of course only work in special cases (e.g. switch from
1250 // tis620-0 to latin1, but the text in latin1 contains ASCII only),
1251 // but it is the best we can do
1252 if (oldEnc.package() == Encoding::none
1253 || newEnc.package() == Encoding::none)
1254 return make_pair(false, 0);
1256 LYXERR(Debug::LATEX, "Changing LaTeX encoding from "
1257 << oldEnc.name() << " to " << newEnc.name());
1258 os << setEncoding(newEnc.iconvName());
1259 if (bparams.inputenc == "default")
1260 return make_pair(true, 0);
1262 docstring const inputenc_arg(from_ascii(newEnc.latexName()));
1263 switch (newEnc.package()) {
1264 case Encoding::none:
1265 case Encoding::japanese:
1266 // shouldn't ever reach here, see above
1267 return make_pair(true, 0);
1268 case Encoding::inputenc: {
1269 int count = inputenc_arg.length();
1270 if (oldEnc.package() == Encoding::CJK &&
1271 open_encoding_ == CJK) {
1273 open_encoding_ = none;
1276 else if (oldEnc.package() == Encoding::inputenc &&
1277 open_encoding_ == inputenc) {
1279 open_encoding_ = none;
1282 if (runparams.local_font != 0
1283 && oldEnc.package() == Encoding::CJK) {
1284 // within insets, \inputenc switches need
1285 // to be embraced within \bgroup...\egroup;
1289 open_encoding_ = inputenc;
1291 // with the japanese option, inputenc is omitted.
1292 if (runparams.use_japanese)
1293 return make_pair(true, count);
1294 os << "\\inputencoding{" << inputenc_arg << '}';
1295 return make_pair(true, count + 16);
1297 case Encoding::CJK: {
1298 int count = inputenc_arg.length();
1299 if (oldEnc.package() == Encoding::CJK &&
1300 open_encoding_ == CJK) {
1304 if (oldEnc.package() == Encoding::inputenc &&
1305 open_encoding_ == inputenc) {
1309 os << "\\begin{CJK}{" << inputenc_arg << "}{"
1310 << from_ascii(bparams.fonts_cjk) << "}";
1311 open_encoding_ = CJK;
1312 return make_pair(true, count + 15);
1315 // Dead code to avoid a warning:
1316 return make_pair(true, 0);