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"
15 #include "BiblioInfo.h"
17 #include "BufferParams.h"
20 #include "InsetList.h"
22 #include "LaTeXFeatures.h"
25 #include "OutputParams.h"
26 #include "Paragraph.h"
27 #include "ParagraphParameters.h"
28 #include "texstream.h"
29 #include "TextClass.h"
31 #include "insets/InsetBibitem.h"
32 #include "insets/InsetArgument.h"
34 #include "frontends/alert.h"
36 #include "support/lassert.h"
37 #include "support/convert.h"
38 #include "support/debug.h"
39 #include "support/lstrings.h"
40 #include "support/lyxalgo.h"
41 #include "support/textutils.h"
42 #include "support/gettext.h"
44 #include <QThreadStorage>
50 using namespace lyx::support;
66 OutputState() : open_encoding_(none), cjk_inherited_(0),
67 prev_env_language_(nullptr), nest_level_(0)
70 OpenEncoding open_encoding_;
72 Language const * prev_env_language_;
74 stack<int> lang_switch_depth_; // Both are always empty when
75 stack<string> open_polyglossia_lang_; // not using polyglossia
79 OutputState * getOutputState()
81 // FIXME An instance of OutputState should be kept around for each export
82 // instead of using local thread storage
83 static QThreadStorage<OutputState *> outputstate;
84 if (!outputstate.hasLocalData())
85 outputstate.setLocalData(new OutputState);
86 return outputstate.localData();
90 string const & openLanguageName(OutputState const * state)
92 // Return a reference to the last active language opened with
93 // polyglossia or when using begin/end commands. If none or when
94 // using babel with only a begin command, return a reference to
97 static string const empty;
99 return state->open_polyglossia_lang_.empty()
101 : state->open_polyglossia_lang_.top();
105 bool atSameLastLangSwitchDepth(OutputState const * state)
107 // Return true if the actual nest level is the same at which the
108 // language was switched when using polyglossia or begin/end
109 // commands. Instead, return always true when using babel with
110 // only a begin command.
112 return state->lang_switch_depth_.size() == 0
114 : abs(state->lang_switch_depth_.top()) == state->nest_level_;
118 bool isLocalSwitch(OutputState const * state)
120 // Return true if the language was opened by a local command switch.
122 return state->lang_switch_depth_.size()
123 && state->lang_switch_depth_.top() < 0;
127 bool langOpenedAtThisLevel(OutputState const * state)
129 // Return true if the language was opened at the current nesting level.
131 return state->lang_switch_depth_.size()
132 && abs(state->lang_switch_depth_.top()) == state->nest_level_;
136 string const getPolyglossiaEnvName(Language const * lang)
138 string result = lang->polyglossia();
139 if (result == "arabic")
140 // exceptional spelling; see polyglossia docs.
146 string const getPolyglossiaBegin(string const & lang_begin_command,
147 string const & lang, string const & opts,
148 bool const localswitch = false)
152 // we need to revert the upcasing done in getPolyglossiaEnvName()
153 // in case we have a local polyglossia command (\textarabic).
154 string language = localswitch ? ascii_lowercase(lang) : lang;
155 result = subst(lang_begin_command, "$$lang", language);
157 string options = opts.empty() ?
158 string() : "[" + opts + "]";
159 result = subst(result, "$$opts", options);
165 struct TeXEnvironmentData
168 Layout const * style;
169 Language const * par_language;
170 Encoding const * prev_encoding;
171 bool leftindent_open;
175 static TeXEnvironmentData prepareEnvironment(Buffer const & buf,
177 ParagraphList::const_iterator pit,
179 OutputParams const & runparams)
181 TeXEnvironmentData data;
183 BufferParams const & bparams = buf.params();
185 // FIXME This test should not be necessary.
186 // We should perhaps issue an error if it is.
187 Layout const & style = text.inset().forcePlainLayout() ?
188 bparams.documentClass().plainLayout() : pit->layout();
190 ParagraphList const & paragraphs = text.paragraphs();
191 ParagraphList::const_iterator const priorpit =
192 pit == paragraphs.begin() ? pit : prev(pit, 1);
194 OutputState * state = getOutputState();
195 bool const use_prev_env_language = state->prev_env_language_ != nullptr
196 && priorpit->layout().isEnvironment()
197 && (priorpit->getDepth() > pit->getDepth()
198 || (priorpit->getDepth() == pit->getDepth()
199 && priorpit->layout() != pit->layout()));
201 data.prev_encoding = runparams.encoding;
202 data.par_language = pit->getParLanguage(bparams);
203 Language const * const doc_language = bparams.language;
204 Language const * const prev_par_language =
205 (pit != paragraphs.begin())
206 ? (use_prev_env_language ? state->prev_env_language_
207 : priorpit->getParLanguage(bparams))
210 bool const use_polyglossia = runparams.use_polyglossia;
211 string const par_lang = use_polyglossia ?
212 getPolyglossiaEnvName(data.par_language) : data.par_language->babel();
213 string const prev_par_lang = use_polyglossia ?
214 getPolyglossiaEnvName(prev_par_language) : prev_par_language->babel();
215 string const doc_lang = use_polyglossia ?
216 getPolyglossiaEnvName(doc_language) : doc_language->babel();
217 string const lang_begin_command = use_polyglossia ?
218 "\\begin{$$lang}" : lyxrc.language_command_begin;
219 string const lang_end_command = use_polyglossia ?
220 "\\end{$$lang}" : lyxrc.language_command_end;
221 bool const using_begin_end = use_polyglossia ||
222 !lang_end_command.empty();
224 // For polyglossia, switch language outside of environment, if possible.
225 if (par_lang != prev_par_lang) {
226 if ((!using_begin_end || langOpenedAtThisLevel(state)) &&
227 !lang_end_command.empty() &&
228 prev_par_lang != doc_lang &&
229 !prev_par_lang.empty()) {
230 os << from_ascii(subst(
234 // the '%' is necessary to prevent unwanted whitespace
240 // If no language was explicitly opened and we are using
241 // polyglossia or begin/end commands, then the current
242 // language is the document language.
243 string const & cur_lang = using_begin_end
244 && state->lang_switch_depth_.size()
245 ? openLanguageName(state)
248 if ((lang_end_command.empty() ||
249 par_lang != doc_lang ||
250 par_lang != cur_lang) &&
252 string bc = use_polyglossia ?
253 getPolyglossiaBegin(lang_begin_command, par_lang,
254 data.par_language->polyglossiaOpts())
255 : subst(lang_begin_command, "$$lang", par_lang);
257 // the '%' is necessary to prevent unwanted whitespace
260 pushLanguageName(par_lang);
264 data.leftindent_open = false;
265 if (!pit->params().leftIndent().zero()) {
266 os << "\\begin{LyXParagraphLeftIndent}{"
267 << from_ascii(pit->params().leftIndent().asLatexString())
269 data.leftindent_open = true;
272 if (style.isEnvironment())
273 state->nest_level_ += 1;
275 if (style.isEnvironment() && !style.latexname().empty()) {
276 os << "\\begin{" << from_ascii(style.latexname()) << '}';
277 if (!style.latexargs().empty()) {
278 OutputParams rp = runparams;
279 rp.local_font = &pit->getFirstFontSettings(bparams);
280 latexArgInsets(paragraphs, pit, os, rp, style.latexargs());
282 if (style.latextype == LATEX_LIST_ENVIRONMENT) {
284 << pit->params().labelWidthString()
286 } else if (style.labeltype == LABEL_BIBLIO) {
287 if (pit->params().labelWidthString().empty())
288 os << '{' << bibitemWidest(buf, runparams) << "}\n";
291 << pit->params().labelWidthString()
294 os << from_ascii(style.latexparam()) << '\n';
295 if (style.latextype == LATEX_BIB_ENVIRONMENT
296 || style.latextype == LATEX_ITEM_ENVIRONMENT
297 || style.latextype == LATEX_LIST_ENVIRONMENT) {
298 OutputParams rp = runparams;
299 rp.local_font = &pit->getFirstFontSettings(bparams);
300 latexArgInsets(paragraphs, pit, os, rp, style.listpreamble(),
306 // in multilingual environments, the CJK tags have to be nested properly
307 data.cjk_nested = false;
308 if (!bparams.useNonTeXFonts
309 && (bparams.inputenc == "auto-legacy"
310 || bparams.inputenc == "auto-legacy-plain")
311 && data.par_language->encoding()->package() == Encoding::CJK
312 && state->open_encoding_ != CJK && pit->isMultiLingual(bparams)) {
313 if (prev_par_language->encoding()->package() == Encoding::CJK) {
314 os << "\\begin{CJK}{"
315 << from_ascii(data.par_language->encoding()->latexName())
316 << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
318 state->open_encoding_ = CJK;
319 data.cjk_nested = true;
325 static void finishEnvironment(otexstream & os, OutputParams const & runparams,
326 TeXEnvironmentData const & data)
328 OutputState * state = getOutputState();
329 // BufferParams const & bparams = buf.params(); // FIXME: for speedup shortcut below, would require passing of "buf" as argument
330 if (state->open_encoding_ == CJK && data.cjk_nested) {
331 // We need to close the encoding even if it does not change
332 // to do correct environment nesting
333 os << "\\end{CJK}\n";
334 state->open_encoding_ = none;
337 if (data.style->isEnvironment()) {
339 bool const using_begin_end =
340 runparams.use_polyglossia ||
341 !lyxrc.language_command_end.empty();
342 // Close any language opened at this nest level
343 if (using_begin_end) {
344 while (langOpenedAtThisLevel(state)) {
345 if (isLocalSwitch(state)) {
349 << openLanguageName(state)
355 state->nest_level_ -= 1;
356 string const & name = data.style->latexname();
358 os << "\\end{" << from_ascii(name) << "}\n";
359 state->prev_env_language_ = data.par_language;
360 if (runparams.encoding != data.prev_encoding) {
361 runparams.encoding = data.prev_encoding;
362 os << setEncoding(data.prev_encoding->iconvName());
366 if (data.leftindent_open) {
367 os << breakln << "\\end{LyXParagraphLeftIndent}\n";
368 state->prev_env_language_ = data.par_language;
369 if (runparams.encoding != data.prev_encoding) {
370 runparams.encoding = data.prev_encoding;
371 os << setEncoding(data.prev_encoding->iconvName());
375 // Check whether we should output a blank line after the environment
376 if (!data.style->nextnoindent)
381 void TeXEnvironment(Buffer const & buf, Text const & text,
382 OutputParams const & runparams,
383 pit_type & pit, otexstream & os)
385 ParagraphList const & paragraphs = text.paragraphs();
386 ParagraphList::const_iterator ipar = paragraphs.constIterator(pit);
387 LYXERR(Debug::LATEX, "TeXEnvironment for paragraph " << pit);
389 Layout const & current_layout = ipar->layout();
390 depth_type const current_depth = ipar->params().depth();
391 Length const & current_left_indent = ipar->params().leftIndent();
393 // This is for debugging purpose at the end.
394 pit_type const par_begin = pit;
395 for (; pit < runparams.par_end; ++pit) {
396 ParagraphList::const_iterator par = paragraphs.constIterator(pit);
398 // check first if this is an higher depth paragraph.
399 bool go_out = (par->params().depth() < current_depth);
400 if (par->params().depth() == current_depth) {
401 // This environment is finished.
402 go_out |= (par->layout() != current_layout);
403 go_out |= (par->params().leftIndent() != current_left_indent);
406 // nothing to do here, restore pit and go out.
411 if (par->layout() == current_layout
412 && par->params().depth() == current_depth
413 && par->params().leftIndent() == current_left_indent) {
414 // We are still in the same environment so TeXOnePar and continue;
415 TeXOnePar(buf, text, pit, os, runparams);
419 // We are now in a deeper environment.
420 // Either par->layout() != current_layout
421 // Or par->params().depth() > current_depth
422 // Or par->params().leftIndent() != current_left_indent)
424 // FIXME This test should not be necessary.
425 // We should perhaps issue an error if it is.
426 bool const force_plain_layout = text.inset().forcePlainLayout();
427 Layout const & style = force_plain_layout
428 ? buf.params().documentClass().plainLayout()
431 if (!style.isEnvironment()) {
432 // This is a standard paragraph, no need to call TeXEnvironment.
433 TeXOnePar(buf, text, pit, os, runparams);
437 // This is a new environment.
438 TeXEnvironmentData const data =
439 prepareEnvironment(buf, text, par, os, runparams);
440 // Recursive call to TeXEnvironment!
441 TeXEnvironment(buf, text, runparams, pit, os);
442 finishEnvironment(os, runparams, data);
445 if (pit != runparams.par_end)
446 LYXERR(Debug::LATEX, "TeXEnvironment for paragraph " << par_begin << " done.");
450 void getArgInsets(otexstream & os, OutputParams const & runparams, Layout::LaTeXArgMap const & latexargs,
451 map<int, lyx::InsetArgument const *> ilist, vector<string> required, string const & prefix)
453 unsigned int const argnr = latexargs.size();
457 // Default and preset args are always output, so if they require
458 // other arguments, consider this.
459 for (auto const & larg : latexargs) {
460 Layout::latexarg const & arg = larg.second;
461 if ((!arg.presetarg.empty() || !arg.defaultarg.empty()) && !arg.requires.empty()) {
462 vector<string> req = getVectorFromString(arg.requires);
463 required.insert(required.end(), req.begin(), req.end());
467 for (unsigned int i = 1; i <= argnr; ++i) {
468 map<int, InsetArgument const *>::const_iterator lit = ilist.find(i);
469 bool inserted = false;
470 if (lit != ilist.end()) {
471 InsetArgument const * ins = (*lit).second;
473 Layout::LaTeXArgMap::const_iterator const lait =
474 latexargs.find(ins->name());
475 if (lait != latexargs.end()) {
476 Layout::latexarg arg = (*lait).second;
480 ldelim = arg.mandatory ?
481 from_ascii("{") : from_ascii("[");
482 rdelim = arg.mandatory ?
483 from_ascii("}") : from_ascii("]");
485 if (!arg.ldelim.empty())
487 if (!arg.rdelim.empty())
489 ins->latexArgument(os, runparams, ldelim, rdelim, arg.presetarg);
490 if (prefix == "listpreamble:")
497 Layout::LaTeXArgMap::const_iterator lait = latexargs.begin();
498 Layout::LaTeXArgMap::const_iterator const laend = latexargs.end();
499 for (; lait != laend; ++lait) {
500 string const name = prefix + convert<string>(i);
501 if ((*lait).first == name) {
502 Layout::latexarg arg = (*lait).second;
503 docstring preset = arg.presetarg;
504 if (!arg.defaultarg.empty()) {
507 preset += arg.defaultarg;
510 docstring ldelim = arg.ldelim.empty() ?
511 from_ascii("{") : arg.ldelim;
512 docstring rdelim = arg.rdelim.empty() ?
513 from_ascii("}") : arg.rdelim;
514 os << ldelim << preset << rdelim;
515 } else if (!preset.empty()) {
516 docstring ldelim = arg.ldelim.empty() ?
517 from_ascii("[") : arg.ldelim;
518 docstring rdelim = arg.rdelim.empty() ?
519 from_ascii("]") : arg.rdelim;
520 os << ldelim << preset << rdelim;
521 } else if (find(required.begin(), required.end(),
522 (*lait).first) != required.end()) {
523 docstring ldelim = arg.ldelim.empty() ?
524 from_ascii("[") : arg.ldelim;
525 docstring rdelim = arg.rdelim.empty() ?
526 from_ascii("]") : arg.rdelim;
527 os << ldelim << rdelim;
534 if (runparams.for_search) {
535 // Mark end of arguments for findadv() only
536 os << "\\endarguments{}";
544 void pushLanguageName(string const & lang_name, bool localswitch)
546 OutputState * state = getOutputState();
548 int nest_level = localswitch ? -state->nest_level_ : state->nest_level_;
549 state->lang_switch_depth_.push(nest_level);
550 state->open_polyglossia_lang_.push(lang_name);
554 void popLanguageName()
556 OutputState * state = getOutputState();
558 state->lang_switch_depth_.pop();
559 state->open_polyglossia_lang_.pop();
563 string const & openLanguageName()
565 OutputState * state = getOutputState();
567 return openLanguageName(state);
573 void addArgInsets(Paragraph const & par, string const & prefix,
574 Layout::LaTeXArgMap const & latexargs,
575 map<int, InsetArgument const *> & ilist,
576 vector<string> & required)
578 for (auto const & table : par.insetList()) {
579 InsetArgument const * arg = table.inset->asInsetArgument();
582 if (arg->name().empty()) {
583 LYXERR0("Error: Unnamed argument inset!");
586 string const name = prefix.empty() ?
587 arg->name() : split(arg->name(), ':');
588 // why converting into an integer?
589 unsigned int const nr = convert<unsigned int>(name);
590 if (ilist.find(nr) == ilist.end())
592 Layout::LaTeXArgMap::const_iterator const lit =
593 latexargs.find(arg->name());
594 if (lit != latexargs.end()) {
595 Layout::latexarg const & larg = lit->second;
596 vector<string> req = getVectorFromString(larg.requires);
597 move(req.begin(), req.end(), back_inserter(required));
605 void latexArgInsets(Paragraph const & par, otexstream & os,
606 OutputParams const & runparams,
607 Layout::LaTeXArgMap const & latexargs,
608 string const & prefix)
610 map<int, InsetArgument const *> ilist;
611 vector<string> required;
612 addArgInsets(par, prefix, latexargs, ilist, required);
613 getArgInsets(os, runparams, latexargs, ilist, required, prefix);
617 void latexArgInsets(ParagraphList const & pars,
618 ParagraphList::const_iterator pit,
619 otexstream & os, OutputParams const & runparams,
620 Layout::LaTeXArgMap const & latexargs,
621 string const & prefix)
623 map<int, InsetArgument const *> ilist;
624 vector<string> required;
626 depth_type const current_depth = pit->params().depth();
627 Layout const current_layout = pit->layout();
629 // get the first paragraph in sequence with this layout and depth
632 if (lyx::prev(pit, offset) == pars.begin())
634 ParagraphList::const_iterator priorpit = lyx::prev(pit, offset + 1);
635 if (priorpit->layout() == current_layout
636 && priorpit->params().depth() == current_depth)
642 ParagraphList::const_iterator spit = lyx::prev(pit, offset);
644 for (; spit != pars.end(); ++spit) {
645 if (spit->layout() != current_layout ||
646 spit->params().depth() < current_depth)
648 if (spit->params().depth() > current_depth)
650 addArgInsets(*spit, prefix, latexargs, ilist, required);
652 getArgInsets(os, runparams, latexargs, ilist, required, prefix);
656 void latexArgInsetsForParent(ParagraphList const & pars, otexstream & os,
657 OutputParams const & runparams,
658 Layout::LaTeXArgMap const & latexargs,
659 string const & prefix)
661 map<int, InsetArgument const *> ilist;
662 vector<string> required;
664 for (Paragraph const & par : pars) {
665 if (par.layout().hasArgs())
666 // The InsetArguments inside this paragraph refer to this paragraph
668 addArgInsets(par, prefix, latexargs, ilist, required);
670 getArgInsets(os, runparams, latexargs, ilist, required, prefix);
676 // output the proper paragraph start according to latextype.
677 void parStartCommand(Paragraph const & par, otexstream & os,
678 OutputParams const & runparams, Layout const & style)
680 switch (style.latextype) {
682 if (par.needsCProtection(runparams.moving_arg)) {
683 if (contains(runparams.active_chars, '^'))
684 // cprotect relies on ^ being on catcode 7
685 os << "\\begingroup\\catcode`\\^=7";
688 os << '\\' << from_ascii(style.latexname());
691 if (!style.latexargs().empty())
692 latexArgInsets(par, os, runparams, style.latexargs());
693 os << from_ascii(style.latexparam());
695 case LATEX_ITEM_ENVIRONMENT:
696 case LATEX_LIST_ENVIRONMENT:
697 if (runparams.for_search) {
698 os << "\\" + style.itemcommand() << "{" << style.latexname() << "}";
701 os << "\\" + style.itemcommand();
703 if (!style.itemargs().empty())
704 latexArgInsets(par, os, runparams, style.itemargs(), "item:");
708 case LATEX_ENVIRONMENT:
709 if (runparams.for_search) {
710 os << "\\latexenvironment{" << style.latexname() << "}{";
713 case LATEX_BIB_ENVIRONMENT:
714 // ignore this, the inset will write itself
723 // FIXME: this should be anonymous
724 void TeXOnePar(Buffer const & buf,
728 OutputParams const & runparams_in,
729 string const & everypar,
730 int start_pos, int end_pos,
733 BufferParams const & bparams = runparams_in.is_child
734 ? buf.masterParams() : buf.params();
735 ParagraphList const & paragraphs = text.paragraphs();
736 Paragraph const & par = paragraphs.at(pit);
737 // FIXME This check should not really be needed.
738 // Perhaps we should issue an error if it is.
739 Layout const & style = text.inset().forcePlainLayout() ?
740 bparams.documentClass().plainLayout() : par.layout();
742 if (style.inpreamble && !force)
745 LYXERR(Debug::LATEX, "TeXOnePar for paragraph " << pit << " ptr " << &par << " '"
748 OutputParams runparams = runparams_in;
749 runparams.isLastPar = (pit == pit_type(paragraphs.size() - 1));
750 // We reinitialize par begin and end to be on the safe side
751 // with embedded inset as we don't know if they set those
753 runparams.par_begin = 0;
754 runparams.par_end = 0;
756 bool const maintext = text.isMainText();
757 // we are at the beginning of an inset and CJK is already open;
758 // we count inheritation levels to get the inset nesting right.
759 OutputState * state = getOutputState();
760 if (pit == 0 && !maintext
761 && (state->cjk_inherited_ > 0 || state->open_encoding_ == CJK)) {
762 state->cjk_inherited_ += 1;
763 state->open_encoding_ = none;
766 if (text.inset().isPassThru()) {
767 Font const outerfont = text.outerFont(pit);
769 // No newline before first paragraph in this lyxtext
770 if (pit > 0 && !text.inset().getLayout().parbreakIgnored()) {
772 if (!text.inset().getLayout().parbreakIsNewline())
776 par.latex(bparams, outerfont, os, runparams, start_pos, end_pos, force);
780 Paragraph const * nextpar = runparams.isLastPar
781 ? nullptr : ¶graphs.at(pit + 1);
783 bool const intitle_command = style.intitle && style.isCommand();
785 if (style.pass_thru) {
786 Font const outerfont = text.outerFont(pit);
787 parStartCommand(par, os, runparams, style);
788 if (style.isCommand() && style.needprotect)
789 // Due to the moving argument, some fragile
790 // commands (labels, index entries)
791 // are output after this command (#2154)
792 runparams.postpone_fragile_stuff = true;
796 par.latex(bparams, outerfont, os, runparams, start_pos, end_pos, force);
798 // I did not create a parEndCommand for this minuscule
799 // task because in the other user of parStartCommand
800 // the code is different (JMarc)
801 if (style.isCommand()) {
803 if (par.needsCProtection(runparams.moving_arg)
804 && contains(runparams.active_chars, '^'))
810 if (!style.parbreak_is_newline) {
812 } else if (nextpar && !style.isEnvironment()) {
813 Layout const nextstyle = text.inset().forcePlainLayout()
814 ? bparams.documentClass().plainLayout()
816 if (nextstyle.name() != style.name())
823 // This paragraph's language
824 Language const * const par_language = par.getParLanguage(bparams);
825 Language const * const nextpar_language = nextpar ?
826 nextpar->getParLanguage(bparams) : nullptr;
827 // The document's language
828 Language const * const doc_language = bparams.language;
829 // The language that was in effect when the environment this paragraph is
830 // inside of was opened
831 Language const * const outer_language =
832 (runparams.local_font != nullptr) ?
833 runparams.local_font->language() : doc_language;
835 Paragraph const * priorpar = (pit == 0) ? nullptr : ¶graphs.at(pit - 1);
837 // The previous language that was in effect is the language of the
838 // previous paragraph, unless the previous paragraph is inside an
839 // environment with nesting depth greater than (or equal to, but with
840 // a different layout) the current one. If there is no previous
841 // paragraph, the previous language is the outer language.
842 // Note further that we take the outer language also if the prior par
843 // is PassThru, since in that case it has latex_language, and all secondary
844 // languages have been closed (#10793).
845 bool const use_prev_env_language = state->prev_env_language_ != nullptr
847 && priorpar->layout().isEnvironment()
848 && (priorpar->getDepth() > par.getDepth()
849 || (priorpar->getDepth() == par.getDepth()
850 && priorpar->layout() != par.layout()));
852 // We need to ignore previous intitle commands since languages
853 // are switched locally there (# 11514)
854 // There might be paragraphs before the title, so we check this.
855 Paragraph * prior_nontitle_par = nullptr;
856 if (!intitle_command) {
860 Paragraph const * tmppar = ¶graphs.at(ppit);
861 if (tmppar->layout().intitle && tmppar->layout().isCommand())
863 prior_nontitle_par = const_cast<Paragraph*>(tmppar);
867 Language const * const prev_language =
868 runparams_in.for_search
869 ? languages.getLanguage("ignore")
870 : (prior_nontitle_par && !prior_nontitle_par->isPassThru())
871 ? (use_prev_env_language
872 ? state->prev_env_language_
873 : prior_nontitle_par->getParLanguage(bparams))
876 bool const use_polyglossia = runparams.use_polyglossia;
877 string const par_lang = use_polyglossia ?
878 getPolyglossiaEnvName(par_language): par_language->babel();
879 string const prev_lang = use_polyglossia ?
880 getPolyglossiaEnvName(prev_language) : prev_language->babel();
881 string const outer_lang = use_polyglossia ?
882 getPolyglossiaEnvName(outer_language) : outer_language->babel();
883 string const nextpar_lang = nextpar_language ? (use_polyglossia ?
884 getPolyglossiaEnvName(nextpar_language) :
885 nextpar_language->babel()) : string();
886 string lang_begin_command = use_polyglossia ?
887 "\\begin{$$lang}$$opts" : lyxrc.language_command_begin;
888 string lang_end_command = use_polyglossia ?
889 "\\end{$$lang}" : lyxrc.language_command_end;
890 // the '%' is necessary to prevent unwanted whitespace
891 string lang_command_termination = "%\n";
892 bool const using_begin_end = use_polyglossia ||
893 !lang_end_command.empty();
895 // For InTitle commands, we need to switch the language inside the command
896 // (see #10849); thus open the command here.
897 if (intitle_command) {
898 parStartCommand(par, os, runparams, style);
899 if (style.isCommand() && style.needprotect)
900 // Due to the moving argument, some fragile
901 // commands (labels, index entries)
902 // are output after this command (#2154)
903 runparams.postpone_fragile_stuff = true;
907 // In some insets (such as Arguments), we cannot use \selectlanguage.
908 // Also, if an RTL language is set via environment in polyglossia,
909 // only a nested \\text<lang> command will reset the direction for LTR
910 // languages (see # 10111).
911 bool const in_polyglossia_rtl_env =
913 && runparams.local_font != nullptr
914 && outer_language->rightToLeft()
915 && !par_language->rightToLeft();
916 bool const localswitch =
917 (runparams_in.for_search
918 || text.inset().forceLocalFontSwitch()
919 || (using_begin_end && text.inset().forcePlainLayout())
920 || in_polyglossia_rtl_env)
921 && !text.inset().forceParDirectionSwitch();
923 lang_begin_command = use_polyglossia ?
924 "\\text$$lang$$opts{" : lyxrc.language_command_local;
925 lang_end_command = "}";
926 lang_command_termination.clear();
929 bool const localswitch_needed = localswitch && par_lang != outer_lang;
931 // localswitches need to be closed and reopened at each par
932 if (runparams_in.for_search || ((par_lang != prev_lang || localswitch_needed)
933 // check if we already put language command in TeXEnvironment()
934 && !(style.isEnvironment()
935 && (pit == 0 || (priorpar->layout() != par.layout()
936 && priorpar->getDepth() <= par.getDepth())
937 || priorpar->getDepth() < par.getDepth())))) {
939 && (!using_begin_end || langOpenedAtThisLevel(state))
940 && !lang_end_command.empty()
941 && prev_lang != outer_lang
942 && !prev_lang.empty()
943 && (!using_begin_end || !style.isEnvironment())) {
944 os << from_ascii(subst(lang_end_command,
947 << lang_command_termination;
952 // We need to open a new language if we couldn't close the previous
953 // one (because there's no language_command_end); and even if we closed
954 // the previous one, if the current language is different than the
955 // outer_language (which is currently in effect once the previous one
957 if ((lang_end_command.empty() || par_lang != outer_lang
959 || (style.isEnvironment() && par_lang != prev_lang)))
960 && !par_lang.empty()) {
961 // If we're inside an inset, and that inset is within an \L or \R
962 // (or equivalents), then within the inset, too, any opposite
963 // language paragraph should appear within an \L or \R (in addition
964 // to, outside of, the normal language switch commands).
965 // This behavior is not correct for ArabTeX, though.
968 && par_language->lang() != "arabic_arabtex"
969 && outer_language->lang() != "arabic_arabtex"
970 // are we in an inset?
971 && runparams.local_font != nullptr
972 // is the inset within an \L or \R?
974 // FIXME: currently, we don't check this; this means that
975 // we'll have unnnecessary \L and \R commands, but that
976 // doesn't seem to hurt (though latex will complain)
978 // is this paragraph in the opposite direction?
979 && runparams.local_font->isRightToLeft() != par_language->rightToLeft()) {
980 // FIXME: I don't have a working copy of the Arabi package, so
981 // I'm not sure if the farsi and arabic_arabi stuff is correct
983 if (par_language->lang() == "farsi")
985 else if (outer_language->lang() == "farsi")
987 else if (par_language->lang() == "arabic_arabi")
989 else if (outer_language->lang() == "arabic_arabi")
991 // remaining RTL languages currently is hebrew
992 else if (par_language->rightToLeft())
997 // With CJK, the CJK tag has to be closed first (see below)
998 if ((runparams.encoding->package() != Encoding::CJK
999 || bparams.useNonTeXFonts
1000 || runparams.for_search)
1001 && (par_lang != openLanguageName(state) || localswitch || intitle_command)
1002 && !par_lang.empty()) {
1003 string bc = use_polyglossia ?
1004 getPolyglossiaBegin(lang_begin_command, par_lang,
1005 par_language->polyglossiaOpts(),
1007 : subst(lang_begin_command, "$$lang", par_lang);
1009 os << lang_command_termination;
1010 if (using_begin_end)
1011 pushLanguageName(par_lang, localswitch);
1016 // Switch file encoding if necessary; no need to do this for "auto-legacy-plain"
1017 // encoding, since this only affects the position of the outputted
1018 // \inputencoding command; the encoding switch will occur when necessary
1019 if (bparams.inputenc == "auto-legacy"
1020 && !runparams.isFullUnicode() // Xe/LuaTeX use one document-wide encoding (see also switchEncoding())
1021 && runparams.encoding->package() != Encoding::japanese
1022 && runparams.encoding->package() != Encoding::none) {
1023 // Look ahead for future encoding changes.
1024 // We try to output them at the beginning of the paragraph,
1025 // since the \inputencoding command is not allowed e.g. in
1026 // sections. For this reason we only set runparams.moving_arg
1027 // after checking for the encoding change, otherwise the
1028 // change would be always avoided by switchEncoding().
1029 for (pos_type i = 0; i < par.size(); ++i) {
1030 char_type const c = par.getChar(i);
1031 Encoding const * const encoding =
1032 par.getFontSettings(bparams, i).language()->encoding();
1033 if (encoding->package() != Encoding::CJK
1034 && runparams.encoding->package() == Encoding::inputenc
1039 // All characters before c are in the ASCII range, and
1040 // c is non-ASCII (but no inset), so change the
1041 // encoding to that required by the language of c.
1042 // With CJK, only add switch if we have CJK content at the beginning
1044 if (i != 0 && encoding->package() == Encoding::CJK)
1047 pair<bool, int> enc_switch = switchEncoding(os.os(),
1048 bparams, runparams, *encoding);
1049 // the following is necessary after a CJK environment in a multilingual
1050 // context (nesting issue).
1051 if (par_language->encoding()->package() == Encoding::CJK
1052 && state->open_encoding_ != CJK && state->cjk_inherited_ == 0) {
1053 os << "\\begin{CJK}{"
1054 << from_ascii(par_language->encoding()->latexName())
1055 << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
1056 state->open_encoding_ = CJK;
1058 if (encoding->package() != Encoding::none && enc_switch.first) {
1059 if (enc_switch.second > 0) {
1060 // the '%' is necessary to prevent unwanted whitespace
1063 // With CJK, the CJK tag had to be closed first (see above)
1064 if (runparams.encoding->package() == Encoding::CJK
1065 && par_lang != openLanguageName(state)
1066 && !par_lang.empty()) {
1067 os << subst(lang_begin_command, "$$lang", par_lang)
1068 << lang_command_termination;
1069 if (using_begin_end)
1070 pushLanguageName(par_lang, localswitch);
1072 runparams.encoding = encoding;
1078 runparams.moving_arg |= style.needprotect;
1079 if (style.needmboxprotect)
1080 ++runparams.inulemcmd;
1081 Encoding const * const prev_encoding = runparams.encoding;
1083 bool const useSetSpace = bparams.documentClass().provides("SetSpace");
1084 if (par.allowParagraphCustomization()) {
1085 if (par.params().startOfAppendix()) {
1086 os << "\n\\appendix\n";
1089 // InTitle commands must use switches (not environments)
1090 // inside the commands (see #9332)
1091 if (style.intitle) {
1092 if (!par.params().spacing().isDefault())
1094 if (runparams.moving_arg)
1096 os << from_ascii(par.params().spacing().writeCmd(useSetSpace));
1099 if (!par.params().spacing().isDefault()
1100 && (pit == 0 || !priorpar->hasSameLayout(par)))
1102 os << from_ascii(par.params().spacing().writeEnvirBegin(useSetSpace))
1106 if (style.isCommand()) {
1112 // For InTitle commands, we already started the command before
1113 // the language switch
1114 if (!intitle_command) {
1115 parStartCommand(par, os, runparams, style);
1116 if (style.isCommand() && style.needprotect)
1117 // Due to the moving argument, some fragile
1118 // commands (labels, index entries)
1119 // are output after this command (#2154)
1120 runparams.postpone_fragile_stuff = true;
1123 Font const outerfont = text.outerFont(pit);
1126 os << from_utf8(everypar);
1127 par.latex(bparams, outerfont, os, runparams, start_pos, end_pos, force);
1129 Font const font = par.empty()
1130 ? par.getLayoutFont(bparams, outerfont)
1131 : par.getFont(bparams, par.size() - 1, outerfont);
1133 bool const is_command = style.isCommand();
1135 // InTitle commands need to be closed after the language has been closed.
1136 if (!intitle_command) {
1139 if (!style.postcommandargs().empty())
1140 latexArgInsets(par, os, runparams, style.postcommandargs(), "post:");
1141 if (!runparams.post_macro.empty()) {
1142 // Output the stored fragile commands (labels, indices etc.)
1143 // that need to be output after the command with moving argument.
1144 os << runparams.post_macro;
1145 runparams.post_macro.clear();
1147 if (par.needsCProtection(runparams.moving_arg)
1148 && contains(runparams.active_chars, '^'))
1150 if (runparams.encoding != prev_encoding) {
1151 runparams.encoding = prev_encoding;
1152 os << setEncoding(prev_encoding->iconvName());
1157 bool pending_newline = false;
1158 bool unskip_newline = false;
1159 bool close_lang_switch = false;
1160 switch (style.latextype) {
1161 case LATEX_ITEM_ENVIRONMENT:
1162 case LATEX_LIST_ENVIRONMENT:
1163 if ((nextpar && par_lang != nextpar_lang
1164 && nextpar->getDepth() == par.getDepth())
1165 || (atSameLastLangSwitchDepth(state) && nextpar
1166 && nextpar->getDepth() < par.getDepth()))
1167 close_lang_switch = using_begin_end;
1168 if (nextpar && par.params().depth() < nextpar->params().depth())
1169 pending_newline = !text.inset().getLayout().parbreakIgnored();
1171 case LATEX_ENVIRONMENT: {
1172 // if it's the last paragraph of the current environment
1173 // skip it otherwise fall through
1175 && ((nextpar->layout() != par.layout()
1176 || nextpar->params().depth() != par.params().depth())
1177 || (!using_begin_end || par_lang != nextpar_lang)))
1179 close_lang_switch = using_begin_end;
1186 // we don't need it for the last paragraph and in InTitle commands!!!
1187 if (nextpar && !intitle_command)
1188 pending_newline = !text.inset().getLayout().parbreakIgnored();
1191 // InTitle commands use switches (not environments) for space settings
1192 if (par.allowParagraphCustomization() && !style.intitle) {
1193 if (!par.params().spacing().isDefault()
1194 && (runparams.isLastPar || !nextpar->hasSameLayout(par))) {
1195 if (pending_newline)
1198 string const endtag =
1199 par.params().spacing().writeEnvirEnd(useSetSpace);
1200 if (prefixIs(endtag, "\\end{"))
1203 os << from_ascii(endtag);
1204 pending_newline = true;
1208 // Closing the language is needed for the last paragraph in a given language
1209 // as well as for any InTitleCommand (since these set the language locally);
1210 // it is also needed if we're within an \L or \R that we may have opened above
1211 // (not necessarily in this paragraph) and are about to close.
1212 bool closing_rtl_ltr_environment = !using_begin_end
1214 && (par_language->lang() != "arabic_arabtex"
1215 && outer_language->lang() != "arabic_arabtex")
1216 // have we opened an \L or \R environment?
1217 && runparams.local_font != nullptr
1218 && runparams.local_font->isRightToLeft() != par_language->rightToLeft()
1219 // are we about to close the language?
1220 &&((nextpar && par_lang != nextpar_lang)
1221 || (runparams.isLastPar && par_lang != outer_lang));
1223 if (localswitch_needed
1224 || (intitle_command && using_begin_end)
1225 || closing_rtl_ltr_environment
1226 || (((runparams.isLastPar && !runparams.inbranch) || close_lang_switch)
1227 && (par_lang != outer_lang || (using_begin_end
1228 && style.isEnvironment()
1229 && par_lang != nextpar_lang)))) {
1230 // Since \selectlanguage write the language to the aux file,
1231 // we need to reset the language at the end of footnote or
1234 if (!localswitch && (pending_newline || close_lang_switch))
1237 // when the paragraph uses CJK, the language has to be closed earlier
1238 if ((font.language()->encoding()->package() != Encoding::CJK)
1239 || bparams.useNonTeXFonts
1240 || runparams_in.for_search) {
1241 if (lang_end_command.empty()) {
1242 // If this is a child, we should restore the
1243 // master language after the last paragraph.
1244 Language const * const current_language =
1245 (runparams.isLastPar && runparams.master_language)
1246 ? runparams.master_language
1248 string const current_lang = use_polyglossia
1249 ? getPolyglossiaEnvName(current_language)
1250 : current_language->babel();
1251 if (!current_lang.empty()
1252 && current_lang != openLanguageName(state)) {
1253 string bc = use_polyglossia ?
1254 getPolyglossiaBegin(lang_begin_command, current_lang,
1255 current_language->polyglossiaOpts(),
1257 : subst(lang_begin_command, "$$lang", current_lang);
1259 pending_newline = !localswitch
1260 && !text.inset().getLayout().parbreakIgnored();
1261 unskip_newline = !localswitch;
1262 if (using_begin_end)
1263 pushLanguageName(current_lang, localswitch);
1265 } else if ((!using_begin_end ||
1266 langOpenedAtThisLevel(state)) &&
1267 !par_lang.empty()) {
1268 // If we are in an environment, we have to
1269 // close the "outer" language afterwards
1270 string const & cur_lang = openLanguageName(state);
1271 if (!style.isEnvironment()
1272 || (close_lang_switch
1273 && atSameLastLangSwitchDepth(state)
1274 && par_lang != outer_lang
1275 && (par_lang != cur_lang
1276 || (cur_lang != outer_lang
1278 && style != nextpar->layout())))
1279 || (atSameLastLangSwitchDepth(state)
1280 && state->lang_switch_depth_.size()
1281 && cur_lang != par_lang)
1282 || in_polyglossia_rtl_env)
1284 if (using_begin_end && !localswitch)
1286 os << from_ascii(subst(
1290 pending_newline = !localswitch
1291 && !text.inset().getLayout().parbreakIgnored();
1292 unskip_newline = !localswitch;
1293 if (using_begin_end)
1299 if (closing_rtl_ltr_environment)
1302 // InTitle commands need to be closed after the language has been closed.
1303 if (intitle_command) {
1305 if (!style.postcommandargs().empty())
1306 latexArgInsets(par, os, runparams, style.postcommandargs(), "post:");
1307 if (!runparams.post_macro.empty()) {
1308 // Output the stored fragile commands (labels, indices etc.)
1309 // that need to be output after the command with moving argument.
1310 os << runparams.post_macro;
1311 runparams.post_macro.clear();
1313 if (par.needsCProtection(runparams.moving_arg)
1314 && contains(runparams.active_chars, '^'))
1316 if (runparams.encoding != prev_encoding) {
1317 runparams.encoding = prev_encoding;
1318 os << setEncoding(prev_encoding->iconvName());
1322 bool const last_was_separator =
1323 par.size() > 0 && par.isEnvSeparator(par.size() - 1);
1325 if (pending_newline) {
1327 // prevent unwanted whitespace
1329 if (!os.afterParbreak() && !last_was_separator)
1333 // if this is a CJK-paragraph and the next isn't, close CJK
1334 // also if the next paragraph is a multilingual environment (because of nesting)
1335 if (nextpar && state->open_encoding_ == CJK
1336 && bparams.encoding().iconvName() != "UTF-8"
1337 && bparams.encoding().package() != Encoding::CJK
1338 && (nextpar_language->encoding()->package() != Encoding::CJK
1339 || (nextpar->layout().isEnvironment() && nextpar->isMultiLingual(bparams)))
1340 // inbetween environments, CJK has to be closed later (nesting!)
1341 && (!style.isEnvironment() || !nextpar->layout().isEnvironment())) {
1342 os << "\\end{CJK}\n";
1343 state->open_encoding_ = none;
1346 // If this is the last paragraph, close the CJK environment
1347 // if necessary. If it's an environment or nested in an environment,
1348 // we'll have to \end that first.
1349 if (runparams.isLastPar && !style.isEnvironment()
1350 && par.params().depth() < 1) {
1351 switch (state->open_encoding_) {
1353 // do nothing at the end of child documents
1354 if (maintext && buf.masterBuffer() != &buf)
1356 // end of main text: also insert a \clearpage (see #5386)
1358 os << "\n\\clearpage\n\\end{CJK}\n";
1362 state->open_encoding_ = none;
1366 // FIXME: If we are in an inset and the switch happened outside this inset,
1367 // do not switch back at the end of the inset (bug #8479)
1368 // The following attempt does not help with listings-caption in a CJK document:
1369 // if (runparams_in.local_font != 0
1370 // && runparams_in.encoding == runparams_in.local_font->language()->encoding())
1373 state->open_encoding_ = none;
1383 // Information about local language is stored as a font feature.
1384 // If this is the last paragraph of the inset and a local_font was set upon entering
1385 // and we are mixing encodings ("auto-legacy" or "auto-legacy-plain" and no XeTeX or LuaTeX),
1386 // ensure the encoding is set back to the default encoding of the local language.
1387 if (runparams.isLastPar && runparams_in.local_font != nullptr
1388 && runparams_in.encoding != runparams_in.local_font->language()->encoding()
1389 && (bparams.inputenc == "auto-legacy" || bparams.inputenc == "auto-legacy-plain")
1390 && !runparams.isFullUnicode()
1392 runparams_in.encoding = runparams_in.local_font->language()->encoding();
1393 os << setEncoding(runparams_in.encoding->iconvName());
1395 // Otherwise, the current encoding should be set for the next paragraph.
1397 runparams_in.encoding = runparams.encoding;
1399 // Also pass the post_macros upstream
1400 runparams_in.post_macro = runparams.post_macro;
1403 // we don't need a newline for the last paragraph!!!
1404 // Note from JMarc: we will re-add a \n explicitly in
1405 // TeXEnvironment, because it is needed in this case
1406 if (nextpar && !os.afterParbreak() && !last_was_separator) {
1407 Layout const & next_layout = nextpar->layout();
1408 if (!text.inset().getLayout().parbreakIgnored())
1409 // Make sure to start a new line
1411 // A newline '\n' is always output before a command,
1412 // so avoid doubling it.
1413 if (!next_layout.isCommand()) {
1414 // Here we now try to avoid spurious empty lines by
1415 // outputting a paragraph break only if: (case 1) the
1416 // paragraph style allows parbreaks and no \begin, \end
1417 // or \item tags are going to follow (i.e., if the next
1418 // isn't the first or the current isn't the last
1419 // paragraph of an environment or itemize) and the
1420 // depth and alignment of the following paragraph is
1421 // unchanged, or (case 2) the following is a
1422 // non-environment paragraph whose depth is increased
1423 // but whose alignment is unchanged, or (case 3) the
1424 // paragraph is not an environment and the next one is a
1425 // non-itemize-like env at lower depth, or (case 4) the
1426 // paragraph is a command not followed by an environment
1427 // and the alignment of the current and next paragraph
1428 // is unchanged, or (case 5) the current alignment is
1429 // changed and a standard paragraph follows.
1430 DocumentClass const & tclass = bparams.documentClass();
1431 if ((style == next_layout
1432 && !style.parbreak_is_newline
1433 && !text.inset().getLayout().parbreakIsNewline()
1434 && !text.inset().getLayout().parbreakIgnored()
1435 && style.latextype != LATEX_ITEM_ENVIRONMENT
1436 && style.latextype != LATEX_LIST_ENVIRONMENT
1437 && style.align == par.getAlign(bparams)
1438 && nextpar->getDepth() == par.getDepth()
1439 && nextpar->getAlign(bparams) == par.getAlign(bparams))
1440 || (!next_layout.isEnvironment()
1441 && nextpar->getDepth() > par.getDepth()
1442 && nextpar->getAlign(bparams) == next_layout.align)
1443 || (!style.isEnvironment()
1444 && next_layout.latextype == LATEX_ENVIRONMENT
1445 && nextpar->getDepth() < par.getDepth())
1446 || (style.isCommand()
1447 && !next_layout.isEnvironment()
1448 && style.align == par.getAlign(bparams)
1449 && next_layout.align == nextpar->getAlign(bparams))
1450 || (style.align != par.getAlign(bparams)
1451 && tclass.isDefaultLayout(next_layout))) {
1457 LYXERR(Debug::LATEX, "TeXOnePar for paragraph " << pit << " done; ptr "
1458 << &par << " next " << nextpar);
1464 // LaTeX all paragraphs
1465 void latexParagraphs(Buffer const & buf,
1468 OutputParams const & runparams,
1469 string const & everypar)
1471 LASSERT(runparams.par_begin <= runparams.par_end,
1472 { os << "% LaTeX Output Error\n"; return; } );
1474 BufferParams const & bparams = buf.params();
1475 BufferParams const & mparams = buf.masterParams();
1477 bool const maintext = text.isMainText();
1478 bool const is_child = buf.masterBuffer() != &buf;
1479 bool const multibib_child = maintext && is_child
1480 && mparams.multibib == "child";
1482 if (multibib_child && mparams.useBiblatex())
1483 os << "\\newrefsection";
1484 else if (multibib_child && mparams.useBibtopic()
1485 && !buf.masterBibInfo().empty()) {
1486 os << "\\begin{btUnit}\n";
1487 runparams.openbtUnit = true;
1490 // Open a CJK environment at the beginning of the main buffer
1491 // if the document's main encoding requires the CJK package
1492 // or the document encoding is utf8 and the CJK package is required
1493 // (but not in child documents or documents using system fonts):
1494 OutputState * state = getOutputState();
1495 if (maintext && !is_child && !bparams.useNonTeXFonts
1496 && (bparams.encoding().package() == Encoding::CJK
1497 || (bparams.encoding().name() == "utf8"
1498 && runparams.use_CJK))
1500 docstring const cjkenc = bparams.encoding().iconvName() == "UTF-8"
1501 ? from_ascii("UTF8")
1502 : from_ascii(bparams.encoding().latexName());
1503 os << "\\begin{CJK}{" << cjkenc
1504 << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
1505 state->open_encoding_ = CJK;
1507 // if "auto begin" is switched off, explicitly switch the
1508 // language on at start
1509 string const mainlang = runparams.use_polyglossia
1510 ? getPolyglossiaEnvName(bparams.language)
1511 : bparams.language->babel();
1512 string const lang_begin_command = runparams.use_polyglossia ?
1513 "\\begin{$$lang}$$opts" : lyxrc.language_command_begin;
1514 string const lang_end_command = runparams.use_polyglossia ?
1515 "\\end{$$lang}" : lyxrc.language_command_end;
1516 bool const using_begin_end = runparams.use_polyglossia ||
1517 !lang_end_command.empty();
1519 if (maintext && !lyxrc.language_auto_begin &&
1520 !mainlang.empty()) {
1522 string bc = runparams.use_polyglossia ?
1523 getPolyglossiaBegin(lang_begin_command, mainlang,
1524 bparams.language->polyglossiaOpts())
1525 : subst(lang_begin_command, "$$lang", mainlang);
1528 if (using_begin_end)
1529 pushLanguageName(mainlang);
1532 ParagraphList const & paragraphs = text.paragraphs();
1534 if (runparams.par_begin == runparams.par_end) {
1535 // The full doc will be exported but it is easier to just rely on
1536 // runparams range parameters that will be passed TeXEnvironment.
1537 runparams.par_begin = 0;
1538 runparams.par_end = paragraphs.size();
1541 pit_type pit = runparams.par_begin;
1542 // lastpit is for the language check after the loop.
1543 pit_type lastpit = pit;
1544 // variables used in the loop:
1545 bool was_title = false;
1546 bool already_title = false;
1547 DocumentClass const & tclass = bparams.documentClass();
1549 // Did we already warn about inTitle layout mixing? (we only warn once)
1550 bool gave_layout_warning = false;
1551 for (; pit < runparams.par_end; ++pit) {
1553 ParagraphList::const_iterator par = paragraphs.constIterator(pit);
1555 // FIXME This check should not be needed. We should
1556 // perhaps issue an error if it is.
1557 Layout const & layout = text.inset().forcePlainLayout() ?
1558 tclass.plainLayout() : par->layout();
1560 if (layout.intitle) {
1561 if (already_title) {
1562 if (!gave_layout_warning && !runparams.dryrun) {
1563 gave_layout_warning = true;
1564 frontend::Alert::warning(_("Error in latexParagraphs"),
1565 bformat(_("You are using at least one "
1566 "layout (%1$s) intended for the title, "
1567 "after using non-title layouts. This "
1568 "could lead to missing or incorrect output."
1571 } else if (!was_title) {
1573 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1575 << from_ascii(tclass.titlename())
1579 } else if (was_title && !already_title && !layout.inpreamble) {
1580 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1581 os << "\\end{" << from_ascii(tclass.titlename())
1585 os << "\\" << from_ascii(tclass.titlename())
1588 already_title = true;
1592 if (layout.isCommand() && !layout.latexname().empty()
1593 && layout.latexname() == bparams.multibib) {
1594 if (runparams.openbtUnit)
1595 os << "\\end{btUnit}\n";
1596 if (!bparams.useBiblatex()
1597 && !buf.masterBibInfo().empty()) {
1598 os << '\n' << "\\begin{btUnit}\n";
1599 runparams.openbtUnit = true;
1603 if (!layout.isEnvironment() && par->params().leftIndent().zero()) {
1604 // This is a standard top level paragraph, TeX it and continue.
1605 TeXOnePar(buf, text, pit, os, runparams, everypar);
1609 TeXEnvironmentData const data =
1610 prepareEnvironment(buf, text, par, os, runparams);
1611 // pit can be changed in TeXEnvironment.
1612 TeXEnvironment(buf, text, runparams, pit, os);
1613 finishEnvironment(os, runparams, data);
1616 // FIXME: uncomment the content or remove this block
1617 if (pit == runparams.par_end) {
1618 // Make sure that the last paragraph is
1619 // correctly terminated (because TeXOnePar does
1620 // not add a \n in this case)
1624 // It might be that we only have a title in this document
1625 if (was_title && !already_title) {
1626 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1627 os << "\\end{" << from_ascii(tclass.titlename())
1630 os << "\\" << from_ascii(tclass.titlename())
1635 if (maintext && !is_child && runparams.openbtUnit)
1636 os << "\\end{btUnit}\n";
1638 // if "auto end" is switched off, explicitly close the language at the end
1639 // but only if the last par is in a babel or polyglossia language
1640 Language const * const lastpar_language =
1641 paragraphs.at(lastpit).getParLanguage(bparams);
1642 if (maintext && !lyxrc.language_auto_end && !mainlang.empty() &&
1643 lastpar_language->encoding()->package() != Encoding::CJK) {
1644 os << from_utf8(subst(lang_end_command,
1648 if (using_begin_end)
1652 // If the last paragraph is an environment, we'll have to close
1653 // CJK at the very end to do proper nesting.
1654 if (maintext && !is_child && state->open_encoding_ == CJK) {
1655 os << "\\clearpage\n\\end{CJK}\n";
1656 state->open_encoding_ = none;
1658 // Likewise for polyglossia or when using begin/end commands
1659 // or at the very end of an active branch inset with a language switch
1660 Language const * const outer_language = (runparams.local_font != nullptr)
1661 ? runparams.local_font->language() : bparams.language;
1662 string const & prev_lang = runparams.use_polyglossia
1663 ? getPolyglossiaEnvName(outer_language)
1664 : outer_language->babel();
1665 string const lastpar_lang = runparams.use_polyglossia ?
1666 getPolyglossiaEnvName(lastpar_language): lastpar_language->babel();
1667 string const & cur_lang = openLanguageName(state);
1668 if (((runparams.inbranch && langOpenedAtThisLevel(state) && prev_lang != cur_lang)
1669 || (maintext && !is_child)) && !cur_lang.empty()) {
1670 os << from_utf8(subst(lang_end_command,
1674 if (using_begin_end)
1676 } else if (runparams.inbranch && !using_begin_end
1677 && prev_lang != lastpar_lang && !lastpar_lang.empty()) {
1678 // with !using_begin_end, cur_lang is empty, so we need to
1679 // compare against the paragraph language (and we are in the
1680 // last paragraph at this point)
1681 os << subst(lang_begin_command, "$$lang", prev_lang) << '\n';
1684 // reset inherited encoding
1685 if (state->cjk_inherited_ > 0) {
1686 state->cjk_inherited_ -= 1;
1687 if (state->cjk_inherited_ == 0)
1688 state->open_encoding_ = CJK;
1691 if (multibib_child && mparams.useBibtopic()) {
1692 os << "\\end{btUnit}\n";
1693 runparams.openbtUnit = false;
1697 // Switch the input encoding for some part(s) of the document.
1698 pair<bool, int> switchEncoding(odocstream & os, BufferParams const & bparams,
1699 OutputParams const & runparams, Encoding const & newEnc,
1700 bool force, bool noswitchmacro)
1702 // Never switch encoding with XeTeX/LuaTeX
1703 // or if we're in a moving argument or inherit the outer encoding.
1704 if (runparams.isFullUnicode() || newEnc.name() == "inherit")
1705 return make_pair(false, 0);
1707 // Only switch for auto-selected legacy encodings (inputenc setting
1708 // "auto-legacy" or "auto-legacy-plain").
1709 // The "listings" environment can force a switch also with other
1710 // encoding settings (it does not support variable width encodings
1711 // (utf8, jis, ...) under 8-bit latex engines).
1712 if (!force && ((bparams.inputenc != "auto-legacy" && bparams.inputenc != "auto-legacy-plain")
1713 || runparams.moving_arg))
1714 return make_pair(false, 0);
1716 Encoding const & oldEnc = *runparams.encoding;
1717 // Do not switch, if the encoding is unchanged or switching is not supported.
1718 if (oldEnc.name() == newEnc.name()
1719 || oldEnc.package() == Encoding::japanese
1720 || oldEnc.package() == Encoding::none
1721 || newEnc.package() == Encoding::none
1722 || runparams.for_search)
1723 return make_pair(false, 0);
1724 // FIXME We ignore encoding switches from/to encodings that do
1725 // neither support the inputenc package nor the CJK package here.
1726 // This may fail for characters not supported by "unicodesymbols"
1727 // or for non-ASCII characters in "listings"
1728 // but it is the best we can do.
1731 LYXERR(Debug::LATEX, "Changing LaTeX encoding from "
1732 << oldEnc.name() << " to " << newEnc.name());
1733 os << setEncoding(newEnc.iconvName());
1734 if (bparams.inputenc == "auto-legacy-plain")
1735 return make_pair(true, 0);
1737 docstring const inputenc_arg(from_ascii(newEnc.latexName()));
1738 OutputState * state = getOutputState();
1739 switch (newEnc.package()) {
1740 case Encoding::none:
1741 case Encoding::japanese:
1742 // shouldn't ever reach here (see above) but avoids warning.
1743 return make_pair(true, 0);
1744 case Encoding::inputenc: {
1745 int count = inputenc_arg.length();
1746 if (oldEnc.package() == Encoding::CJK &&
1747 state->open_encoding_ == CJK) {
1749 state->open_encoding_ = none;
1752 else if (oldEnc.package() == Encoding::inputenc &&
1753 state->open_encoding_ == inputenc) {
1755 state->open_encoding_ = none;
1758 if (runparams.local_font != nullptr
1759 && oldEnc.package() == Encoding::CJK) {
1760 // within insets, \inputenc switches need
1761 // to be embraced within \bgroup...\egroup;
1765 state->open_encoding_ = inputenc;
1768 return make_pair(true, count);
1769 os << "\\inputencoding{" << inputenc_arg << '}';
1770 return make_pair(true, count + 16);
1772 case Encoding::CJK: {
1773 int count = inputenc_arg.length();
1774 if (oldEnc.package() == Encoding::CJK &&
1775 state->open_encoding_ == CJK) {
1779 if (oldEnc.package() == Encoding::inputenc &&
1780 state->open_encoding_ == inputenc) {
1784 os << "\\begin{CJK}{"
1785 << from_ascii(newEnc.latexName()) << "}{"
1786 << from_ascii(bparams.fonts_cjk) << "}";
1787 state->open_encoding_ = CJK;
1788 return make_pair(true, count + 15);
1791 // Dead code to avoid a warning:
1792 return make_pair(true, 0);