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"
28 #include "insets/InsetBibitem.h"
29 #include "insets/InsetArgument.h"
31 #include "support/lassert.h"
32 #include "support/convert.h"
33 #include "support/debug.h"
34 #include "support/lstrings.h"
35 #include "support/lyxalgo.h"
36 #include "support/textutils.h"
38 #include <QThreadStorage>
43 using namespace lyx::support;
59 OutputState() : open_encoding_(none), cjk_inherited_(0),
60 prev_env_language_(0), open_polyglossia_lang_("")
65 Language const * prev_env_language_;
66 string open_polyglossia_lang_;
70 OutputState * getOutputState()
72 // FIXME An instance of OutputState should be kept around for each export
73 // instead of using local thread storage
74 static QThreadStorage<OutputState *> outputstate;
75 if (!outputstate.hasLocalData())
76 outputstate.setLocalData(new OutputState);
77 return outputstate.localData();
81 string const getPolyglossiaEnvName(Language const * lang)
83 string result = lang->polyglossia();
84 if (result == "arabic")
85 // exceptional spelling; see polyglossia docs.
91 string const getPolyglossiaBegin(string const & lang_begin_command,
92 string const & lang, string const & opts)
96 result = subst(lang_begin_command, "$$lang", lang);
97 string options = opts.empty() ?
98 string() : "[" + opts + "]";
99 result = subst(result, "$$opts", options);
105 struct TeXEnvironmentData
108 Layout const * style;
109 Language const * par_language;
110 Encoding const * prev_encoding;
111 bool leftindent_open;
115 static TeXEnvironmentData prepareEnvironment(Buffer const & buf,
117 ParagraphList::const_iterator pit,
119 OutputParams const & runparams)
121 TeXEnvironmentData data;
123 BufferParams const & bparams = buf.params();
125 // FIXME This test should not be necessary.
126 // We should perhaps issue an error if it is.
127 Layout const & style = text.inset().forcePlainLayout() ?
128 bparams.documentClass().plainLayout() : pit->layout();
130 ParagraphList const & paragraphs = text.paragraphs();
131 ParagraphList::const_iterator const priorpit =
132 pit == paragraphs.begin() ? pit : prev(pit, 1);
134 OutputState * state = getOutputState();
135 bool const use_prev_env_language = state->prev_env_language_ != 0
136 && priorpit->layout().isEnvironment()
137 && (priorpit->getDepth() > pit->getDepth()
138 || (priorpit->getDepth() == pit->getDepth()
139 && priorpit->layout() != pit->layout()));
141 data.prev_encoding = runparams.encoding;
142 data.par_language = pit->getParLanguage(bparams);
143 Language const * const doc_language = bparams.language;
144 Language const * const prev_par_language =
145 (pit != paragraphs.begin())
146 ? (use_prev_env_language ? state->prev_env_language_
147 : priorpit->getParLanguage(bparams))
150 bool const use_polyglossia = runparams.use_polyglossia;
151 string const par_lang = use_polyglossia ?
152 getPolyglossiaEnvName(data.par_language) : data.par_language->babel();
153 string const prev_par_lang = use_polyglossia ?
154 getPolyglossiaEnvName(prev_par_language) : prev_par_language->babel();
155 string const doc_lang = use_polyglossia ?
156 getPolyglossiaEnvName(doc_language) : doc_language->babel();
157 string const lang_begin_command = use_polyglossia ?
158 "\\begin{$$lang}" : lyxrc.language_command_begin;
159 string const lang_end_command = use_polyglossia ?
160 "\\end{$$lang}" : lyxrc.language_command_end;
162 if (par_lang != prev_par_lang) {
163 if (!lang_end_command.empty() &&
164 prev_par_lang != doc_lang &&
165 !prev_par_lang.empty()) {
166 os << from_ascii(subst(
170 // the '%' is necessary to prevent unwanted whitespace
174 if ((lang_end_command.empty() ||
175 par_lang != doc_lang) &&
177 string bc = use_polyglossia ?
178 getPolyglossiaBegin(lang_begin_command, par_lang,
179 data.par_language->polyglossiaOpts())
180 : subst(lang_begin_command, "$$lang", par_lang);
182 // the '%' is necessary to prevent unwanted whitespace
187 data.leftindent_open = false;
188 if (!pit->params().leftIndent().zero()) {
189 os << "\\begin{LyXParagraphLeftIndent}{"
190 << from_ascii(pit->params().leftIndent().asLatexString())
192 data.leftindent_open = true;
195 if (style.isEnvironment()) {
196 if (par_lang != doc_lang)
197 state->open_polyglossia_lang_ = par_lang;
198 os << "\\begin{" << from_ascii(style.latexname()) << '}';
199 if (!style.latexargs().empty()) {
200 OutputParams rp = runparams;
201 rp.local_font = &pit->getFirstFontSettings(bparams);
202 latexArgInsets(paragraphs, pit, os, rp, style.latexargs());
204 if (style.latextype == LATEX_LIST_ENVIRONMENT) {
206 << pit->params().labelWidthString()
208 } else if (style.labeltype == LABEL_BIBLIO) {
209 if (pit->params().labelWidthString().empty())
210 os << '{' << bibitemWidest(buf, runparams) << "}\n";
213 << pit->params().labelWidthString()
216 os << from_ascii(style.latexparam()) << '\n';
220 // in multilingual environments, the CJK tags have to be nested properly
221 data.cjk_nested = false;
222 if (data.par_language->encoding()->package() == Encoding::CJK &&
223 state->open_encoding_ != CJK && pit->isMultiLingual(bparams)) {
224 if (prev_par_language->encoding()->package() == Encoding::CJK)
225 os << "\\begin{CJK}{" << from_ascii(data.par_language->encoding()->latexName())
226 << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
227 state->open_encoding_ = CJK;
228 data.cjk_nested = true;
234 static void finishEnvironment(otexstream & os, OutputParams const & runparams,
235 TeXEnvironmentData const & data)
237 OutputState * state = getOutputState();
238 if (state->open_encoding_ == CJK && data.cjk_nested) {
239 // We need to close the encoding even if it does not change
240 // to do correct environment nesting
241 os << "\\end{CJK}\n";
242 state->open_encoding_ = none;
245 if (data.style->isEnvironment()) {
247 << "\\end{" << from_ascii(data.style->latexname()) << "}\n";
248 state->prev_env_language_ = data.par_language;
249 if (runparams.encoding != data.prev_encoding) {
250 runparams.encoding = data.prev_encoding;
251 if (!runparams.isFullUnicode())
252 os << setEncoding(data.prev_encoding->iconvName());
256 if (data.leftindent_open) {
257 os << breakln << "\\end{LyXParagraphLeftIndent}\n";
258 state->prev_env_language_ = data.par_language;
259 if (runparams.encoding != data.prev_encoding) {
260 runparams.encoding = data.prev_encoding;
261 if (!runparams.isFullUnicode())
262 os << setEncoding(data.prev_encoding->iconvName());
266 // Check whether we should output a blank line after the environment
267 if (!data.style->nextnoindent)
272 void TeXEnvironment(Buffer const & buf, Text const & text,
273 OutputParams const & runparams,
274 pit_type & pit, otexstream & os)
276 ParagraphList const & paragraphs = text.paragraphs();
277 ParagraphList::const_iterator par = paragraphs.constIterator(pit);
278 LYXERR(Debug::LATEX, "TeXEnvironment for paragraph " << pit);
280 Layout const & current_layout = par->layout();
281 depth_type const current_depth = par->params().depth();
282 Length const & current_left_indent = par->params().leftIndent();
284 // This is for debugging purpose at the end.
285 pit_type const par_begin = pit;
286 for (; pit < runparams.par_end; ++pit) {
287 ParagraphList::const_iterator par = paragraphs.constIterator(pit);
289 // check first if this is an higher depth paragraph.
290 bool go_out = (par->params().depth() < current_depth);
291 if (par->params().depth() == current_depth) {
292 // This environment is finished.
293 go_out |= (par->layout() != current_layout);
294 go_out |= (par->params().leftIndent() != current_left_indent);
297 // nothing to do here, restore pit and go out.
302 if (par->layout() == current_layout
303 && par->params().depth() == current_depth
304 && par->params().leftIndent() == current_left_indent) {
305 // We are still in the same environment so TeXOnePar and continue;
306 TeXOnePar(buf, text, pit, os, runparams);
310 // We are now in a deeper environment.
311 // Either par->layout() != current_layout
312 // Or par->params().depth() > current_depth
313 // Or par->params().leftIndent() != current_left_indent)
315 // FIXME This test should not be necessary.
316 // We should perhaps issue an error if it is.
317 bool const force_plain_layout = text.inset().forcePlainLayout();
318 Layout const & style = force_plain_layout
319 ? buf.params().documentClass().plainLayout()
322 if (!style.isEnvironment()) {
323 // This is a standard paragraph, no need to call TeXEnvironment.
324 TeXOnePar(buf, text, pit, os, runparams);
328 // This is a new environment.
329 TeXEnvironmentData const data =
330 prepareEnvironment(buf, text, par, os, runparams);
331 // Recursive call to TeXEnvironment!
332 TeXEnvironment(buf, text, runparams, pit, os);
333 finishEnvironment(os, runparams, data);
336 if (pit != runparams.par_end)
337 LYXERR(Debug::LATEX, "TeXEnvironment for paragraph " << par_begin << " done.");
341 void getArgInsets(otexstream & os, OutputParams const & runparams, Layout::LaTeXArgMap const & latexargs,
342 map<int, lyx::InsetArgument const *> ilist, vector<string> required, string const & prefix)
344 unsigned int const argnr = latexargs.size();
348 // Default and preset args are always output, so if they require
349 // other arguments, consider this.
350 Layout::LaTeXArgMap::const_iterator lit = latexargs.begin();
351 Layout::LaTeXArgMap::const_iterator const lend = latexargs.end();
352 for (; lit != lend; ++lit) {
353 Layout::latexarg arg = (*lit).second;
354 if ((!arg.presetarg.empty() || !arg.defaultarg.empty()) && !arg.requires.empty()) {
355 vector<string> req = getVectorFromString(arg.requires);
356 required.insert(required.end(), req.begin(), req.end());
360 for (unsigned int i = 1; i <= argnr; ++i) {
361 map<int, InsetArgument const *>::const_iterator lit = ilist.find(i);
362 bool inserted = false;
363 if (lit != ilist.end()) {
364 InsetArgument const * ins = (*lit).second;
366 Layout::LaTeXArgMap::const_iterator const lait =
367 latexargs.find(ins->name());
368 if (lait != latexargs.end()) {
369 Layout::latexarg arg = (*lait).second;
370 docstring ldelim = arg.mandatory ?
371 from_ascii("{") : from_ascii("[");
372 docstring rdelim = arg.mandatory ?
373 from_ascii("}") : from_ascii("]");
374 if (!arg.ldelim.empty())
376 if (!arg.rdelim.empty())
378 ins->latexArgument(os, runparams, ldelim, rdelim, arg.presetarg);
384 Layout::LaTeXArgMap::const_iterator lait = latexargs.begin();
385 Layout::LaTeXArgMap::const_iterator const laend = latexargs.end();
386 for (; lait != laend; ++lait) {
387 string const name = prefix + convert<string>(i);
388 if ((*lait).first == name) {
389 Layout::latexarg arg = (*lait).second;
390 docstring preset = arg.presetarg;
391 if (!arg.defaultarg.empty()) {
394 preset += arg.defaultarg;
397 docstring ldelim = arg.ldelim.empty() ?
398 from_ascii("{") : arg.ldelim;
399 docstring rdelim = arg.rdelim.empty() ?
400 from_ascii("}") : arg.rdelim;
401 os << ldelim << preset << rdelim;
402 } else if (!preset.empty()) {
403 docstring ldelim = arg.ldelim.empty() ?
404 from_ascii("[") : arg.ldelim;
405 docstring rdelim = arg.rdelim.empty() ?
406 from_ascii("]") : arg.rdelim;
407 os << ldelim << preset << rdelim;
408 } else if (find(required.begin(), required.end(),
409 (*lait).first) != required.end()) {
410 docstring ldelim = arg.ldelim.empty() ?
411 from_ascii("[") : arg.ldelim;
412 docstring rdelim = arg.rdelim.empty() ?
413 from_ascii("]") : arg.rdelim;
414 os << ldelim << rdelim;
427 void latexArgInsets(Paragraph const & par, otexstream & os,
428 OutputParams const & runparams, Layout::LaTeXArgMap const & latexargs, string const & prefix)
430 map<int, InsetArgument const *> ilist;
431 vector<string> required;
433 InsetList::const_iterator it = par.insetList().begin();
434 InsetList::const_iterator end = par.insetList().end();
435 for (; it != end; ++it) {
436 if (it->inset->lyxCode() == ARG_CODE) {
437 InsetArgument const * ins =
438 static_cast<InsetArgument const *>(it->inset);
439 if (ins->name().empty())
440 LYXERR0("Error: Unnamed argument inset!");
442 string const name = prefix.empty() ? ins->name() : split(ins->name(), ':');
443 unsigned int const nr = convert<unsigned int>(name);
445 Layout::LaTeXArgMap::const_iterator const lit =
446 latexargs.find(ins->name());
447 if (lit != latexargs.end()) {
448 Layout::latexarg const & arg = (*lit).second;
449 if (!arg.requires.empty()) {
450 vector<string> req = getVectorFromString(arg.requires);
451 required.insert(required.end(), req.begin(), req.end());
457 getArgInsets(os, runparams, latexargs, ilist, required, prefix);
461 void latexArgInsets(ParagraphList const & pars, ParagraphList::const_iterator pit,
462 otexstream & os, OutputParams const & runparams, Layout::LaTeXArgMap const & latexargs,
463 string const & prefix)
465 map<int, InsetArgument const *> ilist;
466 vector<string> required;
468 depth_type const current_depth = pit->params().depth();
469 Layout const current_layout = pit->layout();
471 // get the first paragraph in sequence with this layout and depth
474 if (prev(pit, offset) == pars.begin())
476 ParagraphList::const_iterator priorpit = prev(pit, offset + 1);
477 if (priorpit->layout() == current_layout
478 && priorpit->params().depth() == current_depth)
484 ParagraphList::const_iterator spit = prev(pit, offset);
486 for (; spit != pars.end(); ++spit) {
487 if (spit->layout() != current_layout || spit->params().depth() < current_depth)
489 if (spit->params().depth() > current_depth)
491 InsetList::const_iterator it = spit->insetList().begin();
492 InsetList::const_iterator end = spit->insetList().end();
493 for (; it != end; ++it) {
494 if (it->inset->lyxCode() == ARG_CODE) {
495 InsetArgument const * ins =
496 static_cast<InsetArgument const *>(it->inset);
497 if (ins->name().empty())
498 LYXERR0("Error: Unnamed argument inset!");
500 string const name = prefix.empty() ? ins->name() : split(ins->name(), ':');
501 unsigned int const nr = convert<unsigned int>(name);
502 if (ilist.find(nr) == ilist.end())
504 Layout::LaTeXArgMap::const_iterator const lit =
505 latexargs.find(ins->name());
506 if (lit != latexargs.end()) {
507 Layout::latexarg const & arg = (*lit).second;
508 if (!arg.requires.empty()) {
509 vector<string> req = getVectorFromString(arg.requires);
510 required.insert(required.end(), req.begin(), req.end());
517 getArgInsets(os, runparams, latexargs, ilist, required, prefix);
522 // output the proper paragraph start according to latextype.
523 void parStartCommand(Paragraph const & par, otexstream & os,
524 OutputParams const & runparams, Layout const & style)
526 switch (style.latextype) {
528 os << '\\' << from_ascii(style.latexname());
531 if (!style.latexargs().empty())
532 latexArgInsets(par, os, runparams, style.latexargs());
533 os << from_ascii(style.latexparam());
535 case LATEX_ITEM_ENVIRONMENT:
536 case LATEX_LIST_ENVIRONMENT:
537 os << "\\" + style.itemcommand();
539 if (!style.itemargs().empty())
540 latexArgInsets(par, os, runparams, style.itemargs(), "item:");
543 case LATEX_BIB_ENVIRONMENT:
544 // ignore this, the inset will write itself
553 // FIXME: this should be anonymous
554 void TeXOnePar(Buffer const & buf,
558 OutputParams const & runparams_in,
559 string const & everypar,
560 int start_pos, int end_pos)
562 BufferParams const & bparams = runparams_in.is_child
563 ? buf.masterParams() : buf.params();
564 ParagraphList const & paragraphs = text.paragraphs();
565 Paragraph const & par = paragraphs.at(pit);
566 // FIXME This check should not really be needed.
567 // Perhaps we should issue an error if it is.
568 Layout const & style = text.inset().forcePlainLayout() ?
569 bparams.documentClass().plainLayout() : par.layout();
571 if (style.inpreamble)
574 LYXERR(Debug::LATEX, "TeXOnePar for paragraph " << pit << " ptr " << &par << " '"
577 OutputParams runparams = runparams_in;
578 runparams.isLastPar = (pit == pit_type(paragraphs.size() - 1));
579 // We reinitialze par begin and end to be on the safe side
580 // with embedded inset as we don't know if they set those
582 runparams.par_begin = 0;
583 runparams.par_end = 0;
585 bool const maintext = text.isMainText();
586 // we are at the beginning of an inset and CJK is already open;
587 // we count inheritation levels to get the inset nesting right.
588 OutputState * state = getOutputState();
589 if (pit == 0 && !maintext
590 && (state->cjk_inherited_ > 0 || state->open_encoding_ == CJK)) {
591 state->cjk_inherited_ += 1;
592 state->open_encoding_ = none;
595 if (text.inset().isPassThru()) {
596 Font const outerfont = text.outerFont(pit);
598 // No newline before first paragraph in this lyxtext
601 if (!text.inset().getLayout().parbreakIsNewline())
605 par.latex(bparams, outerfont, os, runparams, start_pos, end_pos);
609 Paragraph const * nextpar = runparams.isLastPar
610 ? 0 : ¶graphs.at(pit + 1);
612 if (style.pass_thru) {
613 Font const outerfont = text.outerFont(pit);
614 parStartCommand(par, os, runparams, style);
616 par.latex(bparams, outerfont, os, runparams, start_pos, end_pos);
618 // I did not create a parEndCommand for this minuscule
619 // task because in the other user of parStartCommand
620 // the code is different (JMarc)
621 if (style.isCommand())
625 if (!style.parbreak_is_newline) {
627 } else if (nextpar && !style.isEnvironment()) {
628 Layout const nextstyle = text.inset().forcePlainLayout()
629 ? bparams.documentClass().plainLayout()
631 if (nextstyle.name() != style.name())
638 // This paragraph's language
639 Language const * const par_language = par.getParLanguage(bparams);
640 // The document's language
641 Language const * const doc_language = bparams.language;
642 // The language that was in effect when the environment this paragraph is
643 // inside of was opened
644 Language const * const outer_language =
645 (runparams.local_font != 0) ?
646 runparams.local_font->language() : doc_language;
648 Paragraph const * priorpar = (pit == 0) ? 0 : ¶graphs.at(pit - 1);
650 // The previous language that was in effect is the language of the
651 // previous paragraph, unless the previous paragraph is inside an
652 // environment with nesting depth greater than (or equal to, but with
653 // a different layout) the current one. If there is no previous
654 // paragraph, the previous language is the outer language.
655 bool const use_prev_env_language = state->prev_env_language_ != 0
657 && priorpar->layout().isEnvironment()
658 && (priorpar->getDepth() > par.getDepth()
659 || (priorpar->getDepth() == par.getDepth()
660 && priorpar->layout() != par.layout()));
661 Language const * const prev_language =
663 ? (use_prev_env_language ? state->prev_env_language_
664 : priorpar->getParLanguage(bparams))
668 bool const use_polyglossia = runparams.use_polyglossia;
669 string const par_lang = use_polyglossia ?
670 getPolyglossiaEnvName(par_language): par_language->babel();
671 string const prev_lang = use_polyglossia ?
672 getPolyglossiaEnvName(prev_language) : prev_language->babel();
673 string const outer_lang = use_polyglossia ?
674 getPolyglossiaEnvName(outer_language) : outer_language->babel();
675 string lang_begin_command = use_polyglossia ?
676 "\\begin{$$lang}$$opts" : lyxrc.language_command_begin;
677 string lang_end_command = use_polyglossia ?
678 "\\end{$$lang}" : lyxrc.language_command_end;
679 // the '%' is necessary to prevent unwanted whitespace
680 string lang_command_termination = "%\n";
682 // In some insets (such as Arguments), we cannot use \selectlanguage
683 bool const localswitch = text.inset().forceLocalFontSwitch();
685 lang_begin_command = use_polyglossia ?
686 "\\text$$lang$$opts{" : lyxrc.language_command_local;
687 lang_end_command = "}";
688 lang_command_termination.clear();
691 if (par_lang != prev_lang
692 // check if we already put language command in TeXEnvironment()
693 && !(style.isEnvironment()
694 && (pit == 0 || (priorpar->layout() != par.layout()
695 && priorpar->getDepth() <= par.getDepth())
696 || priorpar->getDepth() < par.getDepth())))
698 if (!lang_end_command.empty() &&
699 prev_lang != outer_lang &&
702 os << from_ascii(subst(lang_end_command,
705 << lang_command_termination;
708 // We need to open a new language if we couldn't close the previous
709 // one (because there's no language_command_end); and even if we closed
710 // the previous one, if the current language is different than the
711 // outer_language (which is currently in effect once the previous one
713 if ((lang_end_command.empty() || par_lang != outer_lang)
714 && !par_lang.empty()) {
715 // If we're inside an inset, and that inset is within an \L or \R
716 // (or equivalents), then within the inset, too, any opposite
717 // language paragraph should appear within an \L or \R (in addition
718 // to, outside of, the normal language switch commands).
719 // This behavior is not correct for ArabTeX, though.
722 && par_language->lang() != "arabic_arabtex"
723 && outer_language->lang() != "arabic_arabtex"
724 // are we in an inset?
725 && runparams.local_font != 0
726 // is the inset within an \L or \R?
728 // FIXME: currently, we don't check this; this means that
729 // we'll have unnnecessary \L and \R commands, but that
730 // doesn't seem to hurt (though latex will complain)
732 // is this paragraph in the opposite direction?
733 && runparams.local_font->isRightToLeft() != par_language->rightToLeft()) {
734 // FIXME: I don't have a working copy of the Arabi package, so
735 // I'm not sure if the farsi and arabic_arabi stuff is correct
737 if (par_language->lang() == "farsi")
739 else if (outer_language->lang() == "farsi")
741 else if (par_language->lang() == "arabic_arabi")
743 else if (outer_language->lang() == "arabic_arabi")
745 // remaining RTL languages currently is hebrew
746 else if (par_language->rightToLeft())
751 // With CJK, the CJK tag has to be closed first (see below)
752 if (runparams.encoding->package() != Encoding::CJK
753 && !par_lang.empty()) {
754 string bc = use_polyglossia ?
755 getPolyglossiaBegin(lang_begin_command, par_lang, par_language->polyglossiaOpts())
756 : subst(lang_begin_command, "$$lang", par_lang);
758 os << lang_command_termination;
763 // Switch file encoding if necessary; no need to do this for "default"
764 // encoding, since this only affects the position of the outputted
765 // \inputencoding command; the encoding switch will occur when necessary
766 if (bparams.inputenc == "auto"
767 && runparams.encoding->package() != Encoding::none) {
768 // Look ahead for future encoding changes.
769 // We try to output them at the beginning of the paragraph,
770 // since the \inputencoding command is not allowed e.g. in
771 // sections. For this reason we only set runparams.moving_arg
772 // after checking for the encoding change, otherwise the
773 // change would be always avoided by switchEncoding().
774 for (pos_type i = 0; i < par.size(); ++i) {
775 char_type const c = par.getChar(i);
776 Encoding const * const encoding =
777 par.getFontSettings(bparams, i).language()->encoding();
778 if (encoding->package() != Encoding::CJK
779 && runparams.encoding->package() == Encoding::inputenc
784 // All characters before c are in the ASCII range, and
785 // c is non-ASCII (but no inset), so change the
786 // encoding to that required by the language of c.
787 // With CJK, only add switch if we have CJK content at the beginning
789 if (i != 0 && encoding->package() == Encoding::CJK)
792 pair<bool, int> enc_switch = switchEncoding(os.os(),
793 bparams, runparams, *encoding);
794 // the following is necessary after a CJK environment in a multilingual
795 // context (nesting issue).
796 if (par_language->encoding()->package() == Encoding::CJK
797 && state->open_encoding_ != CJK && state->cjk_inherited_ == 0) {
798 os << "\\begin{CJK}{" << from_ascii(par_language->encoding()->latexName())
799 << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
800 state->open_encoding_ = CJK;
802 if (encoding->package() != Encoding::none && enc_switch.first) {
803 if (enc_switch.second > 0) {
804 // the '%' is necessary to prevent unwanted whitespace
807 // With CJK, the CJK tag had to be closed first (see above)
808 if (runparams.encoding->package() == Encoding::CJK
809 && !par_lang.empty()) {
810 os << from_ascii(subst(
814 << lang_command_termination;
816 runparams.encoding = encoding;
822 runparams.moving_arg |= style.needprotect;
823 Encoding const * const prev_encoding = runparams.encoding;
825 bool const useSetSpace = bparams.documentClass().provides("SetSpace");
826 if (par.allowParagraphCustomization()) {
827 if (par.params().startOfAppendix()) {
828 os << "\n\\appendix\n";
831 if (!par.params().spacing().isDefault()
832 && (pit == 0 || !priorpar->hasSameLayout(par)))
834 os << from_ascii(par.params().spacing().writeEnvirBegin(useSetSpace))
838 if (style.isCommand()) {
843 parStartCommand(par, os, runparams, style);
844 Font const outerfont = text.outerFont(pit);
847 os << from_utf8(everypar);
848 par.latex(bparams, outerfont, os, runparams, start_pos, end_pos);
850 // Make sure that \\par is done with the font of the last
851 // character if this has another size as the default.
852 // This is necessary because LaTeX (and LyX on the screen)
853 // calculates the space between the baselines according
854 // to this font. (Matthias)
856 // We must not change the font for the last paragraph
857 // of non-multipar insets, tabular cells or commands,
858 // since this produces unwanted whitespace.
860 Font const font = par.empty()
861 ? par.getLayoutFont(bparams, outerfont)
862 : par.getFont(bparams, par.size() - 1, outerfont);
864 bool const is_command = style.isCommand();
866 if (style.resfont.size() != font.fontInfo().size()
867 && (nextpar || maintext
868 || (text.inset().paragraphs().size() > 1
869 && text.inset().lyxCode() != CELL_CODE))
872 os << "\\" << from_ascii(font.latexSize()) << " \\par}";
873 } else if (is_command) {
875 if (!style.postcommandargs().empty())
876 latexArgInsets(par, os, runparams, style.postcommandargs(), "post:");
877 if (runparams.encoding != prev_encoding) {
878 runparams.encoding = prev_encoding;
879 if (!runparams.isFullUnicode())
880 os << setEncoding(prev_encoding->iconvName());
884 bool pending_newline = false;
885 bool unskip_newline = false;
886 switch (style.latextype) {
887 case LATEX_ITEM_ENVIRONMENT:
888 case LATEX_LIST_ENVIRONMENT:
889 if (nextpar && par.params().depth() < nextpar->params().depth())
890 pending_newline = true;
892 case LATEX_ENVIRONMENT: {
893 // if its the last paragraph of the current environment
894 // skip it otherwise fall through
896 && (nextpar->layout() != par.layout()
897 || nextpar->params().depth() != par.params().depth()))
901 // fall through possible
903 // we don't need it for the last paragraph!!!
905 pending_newline = true;
908 if (par.allowParagraphCustomization()) {
909 if (!par.params().spacing().isDefault()
910 && (runparams.isLastPar || !nextpar->hasSameLayout(par))) {
914 string const endtag =
915 par.params().spacing().writeEnvirEnd(useSetSpace);
916 if (prefixIs(endtag, "\\end{"))
919 os << from_ascii(endtag);
920 pending_newline = true;
924 // Closing the language is needed for the last paragraph; it is also
925 // needed if we're within an \L or \R that we may have opened above (not
926 // necessarily in this paragraph) and are about to close.
927 bool closing_rtl_ltr_environment = !use_polyglossia
929 && (par_language->lang() != "arabic_arabtex"
930 && outer_language->lang() != "arabic_arabtex")
931 // have we opened an \L or \R environment?
932 && runparams.local_font != 0
933 && runparams.local_font->isRightToLeft() != par_language->rightToLeft()
934 // are we about to close the language?
935 &&((nextpar && par_language->babel() != (nextpar->getParLanguage(bparams))->babel())
936 || (runparams.isLastPar && par_language->babel() != outer_language->babel()));
938 if (closing_rtl_ltr_environment
939 || (runparams.isLastPar
940 && ((!use_polyglossia && par_language->babel() != outer_language->babel())
941 || (use_polyglossia && par_language->polyglossia() != outer_language->polyglossia())))) {
942 // Since \selectlanguage write the language to the aux file,
943 // we need to reset the language at the end of footnote or
949 // when the paragraph uses CJK, the language has to be closed earlier
950 if (font.language()->encoding()->package() != Encoding::CJK) {
951 if (lang_end_command.empty()) {
952 // If this is a child, we should restore the
953 // master language after the last paragraph.
954 Language const * const current_language =
955 (runparams.isLastPar && runparams.master_language)
956 ? runparams.master_language
958 string const current_lang = use_polyglossia
959 ? getPolyglossiaEnvName(current_language)
960 : current_language->babel();
961 if (!current_lang.empty()) {
962 string bc = use_polyglossia ?
963 getPolyglossiaBegin(lang_begin_command, current_lang,
964 current_language->polyglossiaOpts())
965 : subst(lang_begin_command, "$$lang", current_lang);
967 pending_newline = !localswitch;
968 unskip_newline = !localswitch;
970 } else if (!par_lang.empty()) {
971 // If we are in an environment, we have to close the "outer" language afterwards
972 if (!style.isEnvironment() || state->open_polyglossia_lang_ != par_lang) {
973 os << from_ascii(subst(
977 pending_newline = !localswitch;
978 unskip_newline = !localswitch;
983 if (closing_rtl_ltr_environment)
986 bool const last_was_separator =
987 par.size() > 0 && par.isEnvSeparator(par.size() - 1);
989 if (pending_newline) {
991 // prevent unwanted whitespace
993 if (!os.afterParbreak() && !last_was_separator)
997 // if this is a CJK-paragraph and the next isn't, close CJK
998 // also if the next paragraph is a multilingual environment (because of nesting)
1000 && state->open_encoding_ == CJK
1001 && (nextpar->getParLanguage(bparams)->encoding()->package() != Encoding::CJK
1002 || (nextpar->layout().isEnvironment() && nextpar->isMultiLingual(bparams)))
1003 // inbetween environments, CJK has to be closed later (nesting!)
1004 && (!style.isEnvironment() || !nextpar->layout().isEnvironment())) {
1005 os << "\\end{CJK}\n";
1006 state->open_encoding_ = none;
1009 // If this is the last paragraph, close the CJK environment
1010 // if necessary. If it's an environment, we'll have to \end that first.
1011 if (runparams.isLastPar && !style.isEnvironment()) {
1012 switch (state->open_encoding_) {
1014 // do nothing at the end of child documents
1015 if (maintext && buf.masterBuffer() != &buf)
1019 os << "\n\\end{CJK}\n";
1023 state->open_encoding_ = none;
1028 state->open_encoding_ = none;
1038 // If this is the last paragraph, and a local_font was set upon entering
1039 // the inset, and we're using "auto" or "default" encoding, the encoding
1040 // should be set back to that local_font's encoding.
1041 // However, do not change the encoding when a fully unicode aware backend
1042 // such as XeTeX is used.
1043 if (runparams.isLastPar && runparams_in.local_font != 0
1044 && runparams_in.encoding != runparams_in.local_font->language()->encoding()
1045 && (bparams.inputenc == "auto" || bparams.inputenc == "default")
1046 && (!runparams.isFullUnicode())) {
1047 runparams_in.encoding = runparams_in.local_font->language()->encoding();
1048 os << setEncoding(runparams_in.encoding->iconvName());
1050 // Otherwise, the current encoding should be set for the next paragraph.
1052 runparams_in.encoding = runparams.encoding;
1055 // we don't need a newline for the last paragraph!!!
1056 // Note from JMarc: we will re-add a \n explicitly in
1057 // TeXEnvironment, because it is needed in this case
1058 if (nextpar && !os.afterParbreak() && !last_was_separator) {
1059 // Make sure to start a new line
1061 Layout const & next_layout = nextpar->layout();
1062 // A newline '\n' is always output before a command,
1063 // so avoid doubling it.
1064 if (!next_layout.isCommand()) {
1065 // Here we now try to avoid spurious empty lines by
1066 // outputting a paragraph break only if: (case 1) the
1067 // paragraph style allows parbreaks and no \begin, \end
1068 // or \item tags are going to follow (i.e., if the next
1069 // isn't the first or the current isn't the last
1070 // paragraph of an environment or itemize) and the
1071 // depth and alignment of the following paragraph is
1072 // unchanged, or (case 2) the following is a
1073 // non-environment paragraph whose depth is increased
1074 // but whose alignment is unchanged, or (case 3) the
1075 // paragraph is not an environment and the next one is a
1076 // non-itemize-like env at lower depth, or (case 4) the
1077 // paragraph is a command not followed by an environment
1078 // and the alignment of the current and next paragraph
1079 // is unchanged, or (case 5) the current alignment is
1080 // changed and a standard paragraph follows.
1081 DocumentClass const & tclass = bparams.documentClass();
1082 if ((style == next_layout
1083 && !style.parbreak_is_newline
1084 && !text.inset().getLayout().parbreakIsNewline()
1085 && style.latextype != LATEX_ITEM_ENVIRONMENT
1086 && style.latextype != LATEX_LIST_ENVIRONMENT
1087 && style.align == par.getAlign()
1088 && nextpar->getDepth() == par.getDepth()
1089 && nextpar->getAlign() == par.getAlign())
1090 || (!next_layout.isEnvironment()
1091 && nextpar->getDepth() > par.getDepth()
1092 && nextpar->getAlign() == par.getAlign())
1093 || (!style.isEnvironment()
1094 && next_layout.latextype == LATEX_ENVIRONMENT
1095 && nextpar->getDepth() < par.getDepth())
1096 || (style.isCommand()
1097 && !next_layout.isEnvironment()
1098 && style.align == par.getAlign()
1099 && next_layout.align == nextpar->getAlign())
1100 || (style.align != par.getAlign()
1101 && tclass.isDefaultLayout(next_layout))) {
1107 LYXERR(Debug::LATEX, "TeXOnePar for paragraph " << pit << " done; ptr "
1108 << &par << " next " << nextpar);
1114 // LaTeX all paragraphs
1115 void latexParagraphs(Buffer const & buf,
1118 OutputParams const & runparams,
1119 string const & everypar)
1121 LASSERT(runparams.par_begin <= runparams.par_end,
1122 { os << "% LaTeX Output Error\n"; return; } );
1124 BufferParams const & bparams = buf.params();
1126 bool const maintext = text.isMainText();
1127 bool const is_child = buf.masterBuffer() != &buf;
1129 // Open a CJK environment at the beginning of the main buffer
1130 // if the document's language is a CJK language
1131 // (but not in child documents)
1132 OutputState * state = getOutputState();
1133 if (maintext && !is_child
1134 && bparams.encoding().package() == Encoding::CJK) {
1135 os << "\\begin{CJK}{" << from_ascii(bparams.encoding().latexName())
1136 << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
1137 state->open_encoding_ = CJK;
1139 // if "auto begin" is switched off, explicitly switch the
1140 // language on at start
1141 string const mainlang = runparams.use_polyglossia
1142 ? getPolyglossiaEnvName(bparams.language)
1143 : bparams.language->babel();
1144 string const lang_begin_command = runparams.use_polyglossia ?
1145 "\\begin{$$lang}$$opts" : lyxrc.language_command_begin;
1147 if (maintext && !lyxrc.language_auto_begin &&
1148 !mainlang.empty()) {
1150 string bc = runparams.use_polyglossia ?
1151 getPolyglossiaBegin(lang_begin_command, mainlang,
1152 bparams.language->polyglossiaOpts())
1153 : subst(lang_begin_command, "$$lang", mainlang);
1158 ParagraphList const & paragraphs = text.paragraphs();
1160 if (runparams.par_begin == runparams.par_end) {
1161 // The full doc will be exported but it is easier to just rely on
1162 // runparams range parameters that will be passed TeXEnvironment.
1163 runparams.par_begin = 0;
1164 runparams.par_end = paragraphs.size();
1167 pit_type pit = runparams.par_begin;
1168 // lastpit is for the language check after the loop.
1169 pit_type lastpit = pit;
1170 // variables used in the loop:
1171 bool was_title = false;
1172 bool already_title = false;
1173 DocumentClass const & tclass = bparams.documentClass();
1175 for (; pit < runparams.par_end; ++pit) {
1177 ParagraphList::const_iterator par = paragraphs.constIterator(pit);
1179 // FIXME This check should not be needed. We should
1180 // perhaps issue an error if it is.
1181 Layout const & layout = text.inset().forcePlainLayout() ?
1182 tclass.plainLayout() : par->layout();
1184 if (layout.intitle) {
1185 if (already_title) {
1186 LYXERR0("Error in latexParagraphs: You"
1187 " should not mix title layouts"
1188 " with normal ones.");
1189 } else if (!was_title) {
1191 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1193 << from_ascii(tclass.titlename())
1197 } else if (was_title && !already_title) {
1198 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1199 os << "\\end{" << from_ascii(tclass.titlename())
1203 os << "\\" << from_ascii(tclass.titlename())
1206 already_title = true;
1211 if (!layout.isEnvironment() && par->params().leftIndent().zero()) {
1212 // This is a standard top level paragraph, TeX it and continue.
1213 TeXOnePar(buf, text, pit, os, runparams, everypar);
1217 TeXEnvironmentData const data =
1218 prepareEnvironment(buf, text, par, os, runparams);
1219 // pit can be changed in TeXEnvironment.
1220 TeXEnvironment(buf, text, runparams, pit, os);
1221 finishEnvironment(os, runparams, data);
1224 if (pit == runparams.par_end) {
1225 // Make sure that the last paragraph is
1226 // correctly terminated (because TeXOnePar does
1227 // not add a \n in this case)
1231 // It might be that we only have a title in this document
1232 if (was_title && !already_title) {
1233 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1234 os << "\\end{" << from_ascii(tclass.titlename())
1237 os << "\\" << from_ascii(tclass.titlename())
1242 // if "auto end" is switched off, explicitly close the language at the end
1243 // but only if the last par is in a babel language
1244 string const lang_end_command = runparams.use_polyglossia ?
1245 "\\end{$$lang}" : lyxrc.language_command_end;
1246 if (maintext && !lyxrc.language_auto_end && !mainlang.empty() &&
1247 paragraphs.at(lastpit).getParLanguage(bparams)->encoding()->package() != Encoding::CJK) {
1248 os << from_utf8(subst(lang_end_command,
1254 // If the last paragraph is an environment, we'll have to close
1255 // CJK at the very end to do proper nesting.
1256 if (maintext && !is_child && state->open_encoding_ == CJK) {
1257 os << "\\end{CJK}\n";
1258 state->open_encoding_ = none;
1260 // Likewise for polyglossia
1261 if (maintext && !is_child && state->open_polyglossia_lang_ != "") {
1262 os << "\\end{" << state->open_polyglossia_lang_ << "}\n";
1263 state->open_polyglossia_lang_ = "";
1266 // reset inherited encoding
1267 if (state->cjk_inherited_ > 0) {
1268 state->cjk_inherited_ -= 1;
1269 if (state->cjk_inherited_ == 0)
1270 state->open_encoding_ = CJK;
1275 pair<bool, int> switchEncoding(odocstream & os, BufferParams const & bparams,
1276 OutputParams const & runparams, Encoding const & newEnc,
1279 Encoding const & oldEnc = *runparams.encoding;
1280 bool moving_arg = runparams.moving_arg;
1281 // If we switch from/to CJK, we need to switch anyway, despite custom inputenc
1282 bool const from_to_cjk =
1283 (oldEnc.package() == Encoding::CJK && newEnc.package() != Encoding::CJK)
1284 || (oldEnc.package() != Encoding::CJK && newEnc.package() == Encoding::CJK);
1285 if (!force && !from_to_cjk
1286 && ((bparams.inputenc != "auto" && bparams.inputenc != "default") || moving_arg))
1287 return make_pair(false, 0);
1289 // Do nothing if the encoding is unchanged.
1290 if (oldEnc.name() == newEnc.name())
1291 return make_pair(false, 0);
1293 // FIXME We ignore encoding switches from/to encodings that do
1294 // neither support the inputenc package nor the CJK package here.
1295 // This does of course only work in special cases (e.g. switch from
1296 // tis620-0 to latin1, but the text in latin1 contains ASCII only),
1297 // but it is the best we can do
1298 if (oldEnc.package() == Encoding::none
1299 || newEnc.package() == Encoding::none)
1300 return make_pair(false, 0);
1302 LYXERR(Debug::LATEX, "Changing LaTeX encoding from "
1303 << oldEnc.name() << " to " << newEnc.name());
1304 os << setEncoding(newEnc.iconvName());
1305 if (bparams.inputenc == "default")
1306 return make_pair(true, 0);
1308 docstring const inputenc_arg(from_ascii(newEnc.latexName()));
1309 OutputState * state = getOutputState();
1310 switch (newEnc.package()) {
1311 case Encoding::none:
1312 case Encoding::japanese:
1313 // shouldn't ever reach here, see above
1314 return make_pair(true, 0);
1315 case Encoding::inputenc: {
1316 int count = inputenc_arg.length();
1317 if (oldEnc.package() == Encoding::CJK &&
1318 state->open_encoding_ == CJK) {
1320 state->open_encoding_ = none;
1323 else if (oldEnc.package() == Encoding::inputenc &&
1324 state->open_encoding_ == inputenc) {
1326 state->open_encoding_ = none;
1329 if (runparams.local_font != 0
1330 && oldEnc.package() == Encoding::CJK) {
1331 // within insets, \inputenc switches need
1332 // to be embraced within \bgroup...\egroup;
1336 state->open_encoding_ = inputenc;
1338 // with the japanese option, inputenc is omitted.
1339 if (runparams.use_japanese)
1340 return make_pair(true, count);
1341 os << "\\inputencoding{" << inputenc_arg << '}';
1342 return make_pair(true, count + 16);
1344 case Encoding::CJK: {
1345 int count = inputenc_arg.length();
1346 if (oldEnc.package() == Encoding::CJK &&
1347 state->open_encoding_ == CJK) {
1351 if (oldEnc.package() == Encoding::inputenc &&
1352 state->open_encoding_ == inputenc) {
1356 os << "\\begin{CJK}{" << inputenc_arg << "}{"
1357 << from_ascii(bparams.fonts_cjk) << "}";
1358 state->open_encoding_ = CJK;
1359 return make_pair(true, count + 15);
1362 // Dead code to avoid a warning:
1363 return make_pair(true, 0);