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 // Do not output empty environments if the whole paragraph has
438 // been deleted with ct and changes are not output.
439 if (size_t(pit + 1) < paragraphs.size()) {
440 ParagraphList::const_iterator nextpar = paragraphs.constIterator(pit + 1);
441 Paragraph const & cpar = paragraphs.at(pit);
442 if ((par->layout() != nextpar->layout()
443 || par->params().depth() == nextpar->params().depth()
444 || par->params().leftIndent() == nextpar->params().leftIndent())
445 && !runparams.for_search && cpar.size() > 0
446 && cpar.isDeleted(0, cpar.size()) && !buf.params().output_changes) {
447 if (!buf.params().output_changes && !cpar.parEndChange().deleted())
453 // This is a new environment.
454 TeXEnvironmentData const data =
455 prepareEnvironment(buf, text, par, os, runparams);
456 // Recursive call to TeXEnvironment!
457 TeXEnvironment(buf, text, runparams, pit, os);
458 finishEnvironment(os, runparams, data);
461 if (pit != runparams.par_end)
462 LYXERR(Debug::LATEX, "TeXEnvironment for paragraph " << par_begin << " done.");
466 void getArgInsets(otexstream & os, OutputParams const & runparams, Layout::LaTeXArgMap const & latexargs,
467 map<int, lyx::InsetArgument const *> ilist, vector<string> required, string const & prefix)
469 unsigned int const argnr = latexargs.size();
473 // Default and preset args are always output, so if they require
474 // other arguments, consider this.
475 for (auto const & larg : latexargs) {
476 Layout::latexarg const & arg = larg.second;
477 if ((!arg.presetarg.empty() || !arg.defaultarg.empty()) && !arg.requires.empty()) {
478 vector<string> req = getVectorFromString(arg.requires);
479 required.insert(required.end(), req.begin(), req.end());
483 for (unsigned int i = 1; i <= argnr; ++i) {
484 map<int, InsetArgument const *>::const_iterator lit = ilist.find(i);
485 bool inserted = false;
486 if (lit != ilist.end()) {
487 InsetArgument const * ins = (*lit).second;
489 Layout::LaTeXArgMap::const_iterator const lait =
490 latexargs.find(ins->name());
491 if (lait != latexargs.end()) {
492 Layout::latexarg arg = (*lait).second;
496 ldelim = arg.mandatory ?
497 from_ascii("{") : from_ascii("[");
498 rdelim = arg.mandatory ?
499 from_ascii("}") : from_ascii("]");
501 if (!arg.ldelim.empty())
503 if (!arg.rdelim.empty())
505 ins->latexArgument(os, runparams, ldelim, rdelim, arg.presetarg);
506 if (prefix == "listpreamble:")
513 Layout::LaTeXArgMap::const_iterator lait = latexargs.begin();
514 Layout::LaTeXArgMap::const_iterator const laend = latexargs.end();
515 for (; lait != laend; ++lait) {
516 string const name = prefix + convert<string>(i);
517 if ((*lait).first == name) {
518 Layout::latexarg arg = (*lait).second;
519 docstring preset = arg.presetarg;
520 if (!arg.defaultarg.empty()) {
523 preset += arg.defaultarg;
526 docstring ldelim = arg.ldelim.empty() ?
527 from_ascii("{") : arg.ldelim;
528 docstring rdelim = arg.rdelim.empty() ?
529 from_ascii("}") : arg.rdelim;
530 os << ldelim << preset << rdelim;
531 } else if (!preset.empty()) {
532 docstring ldelim = arg.ldelim.empty() ?
533 from_ascii("[") : arg.ldelim;
534 docstring rdelim = arg.rdelim.empty() ?
535 from_ascii("]") : arg.rdelim;
536 os << ldelim << preset << rdelim;
537 } else if (find(required.begin(), required.end(),
538 (*lait).first) != required.end()) {
539 docstring ldelim = arg.ldelim.empty() ?
540 from_ascii("[") : arg.ldelim;
541 docstring rdelim = arg.rdelim.empty() ?
542 from_ascii("]") : arg.rdelim;
543 os << ldelim << rdelim;
550 if (runparams.for_search) {
551 // Mark end of arguments for findadv() only
552 os << "\\endarguments{}";
560 void pushLanguageName(string const & lang_name, bool localswitch)
562 OutputState * state = getOutputState();
564 int nest_level = localswitch ? -state->nest_level_ : state->nest_level_;
565 state->lang_switch_depth_.push(nest_level);
566 state->open_polyglossia_lang_.push(lang_name);
570 void popLanguageName()
572 OutputState * state = getOutputState();
574 state->lang_switch_depth_.pop();
575 state->open_polyglossia_lang_.pop();
579 string const & openLanguageName()
581 OutputState * state = getOutputState();
583 return openLanguageName(state);
589 void addArgInsets(Paragraph const & par, string const & prefix,
590 Layout::LaTeXArgMap const & latexargs,
591 map<int, InsetArgument const *> & ilist,
592 vector<string> & required)
594 for (auto const & table : par.insetList()) {
595 InsetArgument const * arg = table.inset->asInsetArgument();
598 if (arg->name().empty()) {
599 LYXERR0("Error: Unnamed argument inset!");
602 string const name = prefix.empty() ?
603 arg->name() : split(arg->name(), ':');
604 // why converting into an integer?
605 unsigned int const nr = convert<unsigned int>(name);
606 if (ilist.find(nr) == ilist.end())
608 Layout::LaTeXArgMap::const_iterator const lit =
609 latexargs.find(arg->name());
610 if (lit != latexargs.end()) {
611 Layout::latexarg const & larg = lit->second;
612 vector<string> req = getVectorFromString(larg.requires);
613 move(req.begin(), req.end(), back_inserter(required));
621 void latexArgInsets(Paragraph const & par, otexstream & os,
622 OutputParams const & runparams,
623 Layout::LaTeXArgMap const & latexargs,
624 string const & prefix)
626 map<int, InsetArgument const *> ilist;
627 vector<string> required;
628 addArgInsets(par, prefix, latexargs, ilist, required);
629 getArgInsets(os, runparams, latexargs, ilist, required, prefix);
633 void latexArgInsets(ParagraphList const & pars,
634 ParagraphList::const_iterator pit,
635 otexstream & os, OutputParams const & runparams,
636 Layout::LaTeXArgMap const & latexargs,
637 string const & prefix)
639 map<int, InsetArgument const *> ilist;
640 vector<string> required;
642 depth_type const current_depth = pit->params().depth();
643 Layout const current_layout = pit->layout();
645 // get the first paragraph in sequence with this layout and depth
648 if (lyx::prev(pit, offset) == pars.begin())
650 ParagraphList::const_iterator priorpit = lyx::prev(pit, offset + 1);
651 if (priorpit->layout() == current_layout
652 && priorpit->params().depth() == current_depth)
658 ParagraphList::const_iterator spit = lyx::prev(pit, offset);
660 for (; spit != pars.end(); ++spit) {
661 if (spit->layout() != current_layout ||
662 spit->params().depth() < current_depth)
664 if (spit->params().depth() > current_depth)
666 addArgInsets(*spit, prefix, latexargs, ilist, required);
668 getArgInsets(os, runparams, latexargs, ilist, required, prefix);
672 void latexArgInsetsForParent(ParagraphList const & pars, otexstream & os,
673 OutputParams const & runparams,
674 Layout::LaTeXArgMap const & latexargs,
675 string const & prefix)
677 map<int, InsetArgument const *> ilist;
678 vector<string> required;
680 for (Paragraph const & par : pars) {
681 if (par.layout().hasArgs())
682 // The InsetArguments inside this paragraph refer to this paragraph
684 addArgInsets(par, prefix, latexargs, ilist, required);
686 getArgInsets(os, runparams, latexargs, ilist, required, prefix);
692 // output the proper paragraph start according to latextype.
693 void parStartCommand(Paragraph const & par, otexstream & os,
694 OutputParams const & runparams, Layout const & style)
696 switch (style.latextype) {
698 if (par.needsCProtection(runparams.moving_arg)) {
699 if (contains(runparams.active_chars, '^'))
700 // cprotect relies on ^ being on catcode 7
701 os << "\\begingroup\\catcode`\\^=7";
704 os << '\\' << from_ascii(style.latexname());
707 if (!style.latexargs().empty())
708 latexArgInsets(par, os, runparams, style.latexargs());
709 os << from_ascii(style.latexparam());
711 case LATEX_ITEM_ENVIRONMENT:
712 case LATEX_LIST_ENVIRONMENT:
713 if (runparams.for_search) {
714 os << "\\" + style.itemcommand() << "{" << style.latexname() << "}";
717 os << "\\" + style.itemcommand();
719 if (!style.itemargs().empty())
720 latexArgInsets(par, os, runparams, style.itemargs(), "item:");
724 case LATEX_ENVIRONMENT:
725 if (runparams.for_search) {
726 os << "\\latexenvironment{" << style.latexname() << "}{";
729 case LATEX_BIB_ENVIRONMENT:
730 // ignore this, the inset will write itself
739 // FIXME: this should be anonymous
740 void TeXOnePar(Buffer const & buf,
744 OutputParams const & runparams_in,
745 string const & everypar,
746 int start_pos, int end_pos,
749 BufferParams const & bparams = runparams_in.is_child
750 ? buf.masterParams() : buf.params();
751 ParagraphList const & paragraphs = text.paragraphs();
752 Paragraph const & par = paragraphs.at(pit);
753 // FIXME This check should not really be needed.
754 // Perhaps we should issue an error if it is.
755 Layout const & style = text.inset().forcePlainLayout() ?
756 bparams.documentClass().plainLayout() : par.layout();
758 if (style.inpreamble && !force)
761 // Do not output empty commands if the whole paragraph has
762 // been deleted with ct and changes are not output.
763 if (!runparams_in.for_search && style.latextype != LATEX_ENVIRONMENT
764 && par.size() > 0 && par.isDeleted(0, par.size()) && !bparams.output_changes)
767 LYXERR(Debug::LATEX, "TeXOnePar for paragraph " << pit << " ptr " << &par << " '"
770 OutputParams runparams = runparams_in;
771 runparams.isLastPar = (pit == pit_type(paragraphs.size() - 1));
772 // We reinitialize par begin and end to be on the safe side
773 // with embedded inset as we don't know if they set those
775 runparams.par_begin = 0;
776 runparams.par_end = 0;
778 bool const maintext = text.isMainText();
779 // we are at the beginning of an inset and CJK is already open;
780 // we count inheritation levels to get the inset nesting right.
781 OutputState * state = getOutputState();
782 if (pit == 0 && !maintext
783 && (state->cjk_inherited_ > 0 || state->open_encoding_ == CJK)) {
784 state->cjk_inherited_ += 1;
785 state->open_encoding_ = none;
788 // This paragraph is merged and we do not show changes in the output
789 bool const merged_par = !bparams.output_changes && par.parEndChange().deleted();
791 if (text.inset().isPassThru()) {
792 Font const outerfont = text.outerFont(pit);
794 // No newline before first paragraph in this lyxtext
795 if (pit > 0 && !text.inset().getLayout().parbreakIgnored() && !merged_par) {
797 if (!text.inset().getLayout().parbreakIsNewline())
801 par.latex(bparams, outerfont, os, runparams, start_pos, end_pos, force);
805 Paragraph const * nextpar = runparams.isLastPar
806 ? nullptr : ¶graphs.at(pit + 1);
808 bool const intitle_command = style.intitle && style.isCommand();
809 // Intitle commands switch languages locally, thus increase
810 // language nesting level
812 state->nest_level_ += 1;
814 if (style.pass_thru) {
815 Font const outerfont = text.outerFont(pit);
816 parStartCommand(par, os, runparams, style);
817 if (style.isCommand() && style.needprotect)
818 // Due to the moving argument, some fragile
819 // commands (labels, index entries)
820 // are output after this command (#2154)
821 runparams.postpone_fragile_stuff =
822 bparams.postpone_fragile_content;
826 par.latex(bparams, outerfont, os, runparams, start_pos, end_pos, force);
828 // I did not create a parEndCommand for this minuscule
829 // task because in the other user of parStartCommand
830 // the code is different (JMarc)
831 if (style.isCommand()) {
833 if (par.needsCProtection(runparams.moving_arg)
834 && contains(runparams.active_chars, '^'))
841 else if (!merged_par)
843 if (!style.parbreak_is_newline && !merged_par) {
845 } else if (nextpar && !style.isEnvironment()) {
846 Layout const nextstyle = text.inset().forcePlainLayout()
847 ? bparams.documentClass().plainLayout()
849 if (nextstyle.name() != style.name() && !merged_par)
856 // This paragraph's language
857 Language const * const par_language = par.getParLanguage(bparams);
858 Language const * const nextpar_language = nextpar ?
859 nextpar->getParLanguage(bparams) : nullptr;
860 // The document's language
861 Language const * const doc_language = bparams.language;
862 // The language that was in effect when the environment this paragraph is
863 // inside of was opened
864 Language const * const outer_language =
865 (runparams.local_font != nullptr) ?
866 runparams.local_font->language() : doc_language;
868 Paragraph const * priorpar = (pit == 0) ? nullptr : ¶graphs.at(pit - 1);
870 // The previous language that was in effect is the language of the
871 // previous paragraph, unless the previous paragraph is inside an
872 // environment with nesting depth greater than (or equal to, but with
873 // a different layout) the current one. If there is no previous
874 // paragraph, the previous language is the outer language.
875 // Note further that we take the outer language also if the prior par
876 // is PassThru, since in that case it has latex_language, and all secondary
877 // languages have been closed (#10793).
878 bool const use_prev_env_language = state->prev_env_language_ != nullptr
880 && priorpar->layout().isEnvironment()
881 && (priorpar->getDepth() > par.getDepth()
882 || (priorpar->getDepth() == par.getDepth()
883 && priorpar->layout() != par.layout()));
885 // We need to ignore previous intitle commands since languages
886 // are switched locally there (# 11514)
887 // There might be paragraphs before the title, so we check this.
888 Paragraph * prior_nontitle_par = nullptr;
889 if (!intitle_command) {
893 Paragraph const * tmppar = ¶graphs.at(ppit);
894 if (tmppar->layout().intitle && tmppar->layout().isCommand())
896 prior_nontitle_par = const_cast<Paragraph*>(tmppar);
900 Language const * const prev_language =
901 runparams_in.for_search
902 ? languages.getLanguage("ignore")
903 : (prior_nontitle_par && !prior_nontitle_par->isPassThru())
904 ? (use_prev_env_language
905 ? state->prev_env_language_
906 : prior_nontitle_par->getParLanguage(bparams))
909 bool const use_polyglossia = runparams.use_polyglossia;
910 string const par_lang = use_polyglossia ?
911 getPolyglossiaEnvName(par_language): par_language->babel();
912 string const prev_lang = use_polyglossia ?
913 getPolyglossiaEnvName(prev_language) : prev_language->babel();
914 string const outer_lang = use_polyglossia ?
915 getPolyglossiaEnvName(outer_language) : outer_language->babel();
916 string const nextpar_lang = nextpar_language ? (use_polyglossia ?
917 getPolyglossiaEnvName(nextpar_language) :
918 nextpar_language->babel()) : string();
919 string lang_begin_command = use_polyglossia ?
920 "\\begin{$$lang}$$opts" : lyxrc.language_command_begin;
921 string lang_end_command = use_polyglossia ?
922 "\\end{$$lang}" : lyxrc.language_command_end;
923 // the '%' is necessary to prevent unwanted whitespace
924 string lang_command_termination = "%\n";
925 bool const using_begin_end = use_polyglossia ||
926 !lang_end_command.empty();
928 // For InTitle commands, we need to switch the language inside the command
929 // (see #10849); thus open the command here.
930 if (intitle_command) {
931 parStartCommand(par, os, runparams, style);
932 if (style.isCommand() && style.needprotect)
933 // Due to the moving argument, some fragile
934 // commands (labels, index entries)
935 // are output after this command (#2154)
936 runparams.postpone_fragile_stuff =
937 bparams.postpone_fragile_content;
941 // In some insets (such as Arguments), we cannot use \selectlanguage.
942 // Also, if an RTL language is set via environment in polyglossia,
943 // only a nested \\text<lang> command will reset the direction for LTR
944 // languages (see # 10111).
945 bool const in_polyglossia_rtl_env =
947 && runparams.local_font != nullptr
948 && outer_language->rightToLeft()
949 && !par_language->rightToLeft();
950 bool const localswitch =
951 (runparams_in.for_search
952 || text.inset().forceLocalFontSwitch()
953 || (using_begin_end && text.inset().forcePlainLayout())
954 || in_polyglossia_rtl_env)
955 && !text.inset().forceParDirectionSwitch();
957 lang_begin_command = use_polyglossia ?
958 "\\text$$lang$$opts{" : lyxrc.language_command_local;
959 lang_end_command = "}";
960 lang_command_termination.clear();
963 bool const localswitch_needed = localswitch && par_lang != outer_lang;
965 // localswitches need to be closed and reopened at each par
966 if (runparams_in.for_search || ((par_lang != prev_lang || localswitch_needed)
967 // check if we already put language command in TeXEnvironment()
968 && !(style.isEnvironment()
969 && (pit == 0 || (priorpar->layout() != par.layout()
970 && priorpar->getDepth() <= par.getDepth())
971 || priorpar->getDepth() < par.getDepth())))) {
973 && (!using_begin_end || langOpenedAtThisLevel(state))
974 && !lang_end_command.empty()
975 && prev_lang != outer_lang
976 && !prev_lang.empty()
977 && (!using_begin_end || !style.isEnvironment())) {
978 os << from_ascii(subst(lang_end_command,
981 << lang_command_termination;
986 // We need to open a new language if we couldn't close the previous
987 // one (because there's no language_command_end); and even if we closed
988 // the previous one, if the current language is different than the
989 // outer_language (which is currently in effect once the previous one
991 if ((lang_end_command.empty() || par_lang != outer_lang
993 || (style.isEnvironment() && par_lang != prev_lang)))
994 && !par_lang.empty()) {
995 // If we're inside an inset, and that inset is within an \L or \R
996 // (or equivalents), then within the inset, too, any opposite
997 // language paragraph should appear within an \L or \R (in addition
998 // to, outside of, the normal language switch commands).
999 // This behavior is not correct for ArabTeX, though.
1000 if (!using_begin_end
1002 && par_language->lang() != "arabic_arabtex"
1003 && outer_language->lang() != "arabic_arabtex"
1004 // are we in an inset?
1005 && runparams.local_font != nullptr
1006 // is the inset within an \L or \R?
1008 // FIXME: currently, we don't check this; this means that
1009 // we'll have unnnecessary \L and \R commands, but that
1010 // doesn't seem to hurt (though latex will complain)
1012 // is this paragraph in the opposite direction?
1013 && runparams.local_font->isRightToLeft() != par_language->rightToLeft()) {
1014 // FIXME: I don't have a working copy of the Arabi package, so
1015 // I'm not sure if the farsi and arabic_arabi stuff is correct
1017 if (par_language->lang() == "farsi")
1019 else if (outer_language->lang() == "farsi")
1021 else if (par_language->lang() == "arabic_arabi")
1023 else if (outer_language->lang() == "arabic_arabi")
1025 // remaining RTL languages currently is hebrew
1026 else if (par_language->rightToLeft())
1031 // With CJK, the CJK tag has to be closed first (see below)
1032 if ((runparams.encoding->package() != Encoding::CJK
1033 || bparams.useNonTeXFonts
1034 || runparams.for_search)
1035 && (par_lang != openLanguageName(state) || localswitch || intitle_command)
1036 && !par_lang.empty()) {
1037 string bc = use_polyglossia ?
1038 getPolyglossiaBegin(lang_begin_command, par_lang,
1039 par_language->polyglossiaOpts(),
1041 : subst(lang_begin_command, "$$lang", par_lang);
1043 os << lang_command_termination;
1044 if (using_begin_end)
1045 pushLanguageName(par_lang, localswitch);
1050 // Switch file encoding if necessary; no need to do this for "auto-legacy-plain"
1051 // encoding, since this only affects the position of the outputted
1052 // \inputencoding command; the encoding switch will occur when necessary
1053 if (bparams.inputenc == "auto-legacy"
1054 && !runparams.isFullUnicode() // Xe/LuaTeX use one document-wide encoding (see also switchEncoding())
1055 && runparams.encoding->package() != Encoding::japanese
1056 && runparams.encoding->package() != Encoding::none) {
1057 // Look ahead for future encoding changes.
1058 // We try to output them at the beginning of the paragraph,
1059 // since the \inputencoding command is not allowed e.g. in
1060 // sections. For this reason we only set runparams.moving_arg
1061 // after checking for the encoding change, otherwise the
1062 // change would be always avoided by switchEncoding().
1063 for (pos_type i = 0; i < par.size(); ++i) {
1064 char_type const c = par.getChar(i);
1065 Encoding const * const encoding =
1066 par.getFontSettings(bparams, i).language()->encoding();
1067 if (encoding->package() != Encoding::CJK
1068 && runparams.encoding->package() == Encoding::inputenc
1073 // All characters before c are in the ASCII range, and
1074 // c is non-ASCII (but no inset), so change the
1075 // encoding to that required by the language of c.
1076 // With CJK, only add switch if we have CJK content at the beginning
1078 if (i != 0 && encoding->package() == Encoding::CJK)
1081 pair<bool, int> enc_switch = switchEncoding(os.os(),
1082 bparams, runparams, *encoding);
1083 // the following is necessary after a CJK environment in a multilingual
1084 // context (nesting issue).
1085 if (par_language->encoding()->package() == Encoding::CJK
1086 && state->open_encoding_ != CJK && state->cjk_inherited_ == 0) {
1087 os << "\\begin{CJK}{"
1088 << from_ascii(par_language->encoding()->latexName())
1089 << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
1090 state->open_encoding_ = CJK;
1092 if (encoding->package() != Encoding::none && enc_switch.first) {
1093 if (enc_switch.second > 0) {
1094 // the '%' is necessary to prevent unwanted whitespace
1097 // With CJK, the CJK tag had to be closed first (see above)
1098 if (runparams.encoding->package() == Encoding::CJK
1099 && par_lang != openLanguageName(state)
1100 && !par_lang.empty()) {
1101 os << subst(lang_begin_command, "$$lang", par_lang)
1102 << lang_command_termination;
1103 if (using_begin_end)
1104 pushLanguageName(par_lang, localswitch);
1106 runparams.encoding = encoding;
1112 runparams.moving_arg |= style.needprotect;
1113 if (style.needmboxprotect)
1114 ++runparams.inulemcmd;
1115 Encoding const * const prev_encoding = runparams.encoding;
1117 bool const useSetSpace = bparams.documentClass().provides("SetSpace");
1118 if (par.allowParagraphCustomization()) {
1119 if (par.params().startOfAppendix()) {
1120 os << "\n\\appendix\n";
1123 // InTitle commands must use switches (not environments)
1124 // inside the commands (see #9332)
1125 if (style.intitle) {
1126 if (!par.params().spacing().isDefault())
1128 if (runparams.moving_arg)
1130 os << from_ascii(par.params().spacing().writeCmd(useSetSpace));
1133 if (!par.params().spacing().isDefault()
1134 && (pit == 0 || !priorpar->hasSameLayout(par)))
1136 os << from_ascii(par.params().spacing().writeEnvirBegin(useSetSpace))
1140 if (style.isCommand()) {
1146 // For InTitle commands, we already started the command before
1147 // the language switch
1148 if (!intitle_command) {
1149 parStartCommand(par, os, runparams, style);
1150 if (style.isCommand() && style.needprotect)
1151 // Due to the moving argument, some fragile
1152 // commands (labels, index entries)
1153 // are output after this command (#2154)
1154 runparams.postpone_fragile_stuff =
1155 bparams.postpone_fragile_content;
1158 Font const outerfont = text.outerFont(pit);
1161 os << from_utf8(everypar);
1162 par.latex(bparams, outerfont, os, runparams, start_pos, end_pos, force);
1164 Font const font = par.empty()
1165 ? par.getLayoutFont(bparams, outerfont)
1166 : par.getFont(bparams, par.size() - 1, outerfont);
1168 bool const is_command = style.isCommand();
1170 // InTitle commands need to be closed after the language has been closed.
1171 if (!intitle_command) {
1174 if (!style.postcommandargs().empty())
1175 latexArgInsets(par, os, runparams, style.postcommandargs(), "post:");
1176 if (!runparams.post_macro.empty()) {
1177 // Output the stored fragile commands (labels, indices etc.)
1178 // that need to be output after the command with moving argument.
1179 os << runparams.post_macro;
1180 runparams.post_macro.clear();
1182 if (par.needsCProtection(runparams.moving_arg)
1183 && contains(runparams.active_chars, '^'))
1185 if (runparams.encoding != prev_encoding) {
1186 runparams.encoding = prev_encoding;
1187 os << setEncoding(prev_encoding->iconvName());
1192 bool pending_newline = false;
1193 bool unskip_newline = false;
1194 bool close_lang_switch = false;
1195 switch (style.latextype) {
1196 case LATEX_ITEM_ENVIRONMENT:
1197 case LATEX_LIST_ENVIRONMENT:
1198 if ((nextpar && par_lang != nextpar_lang
1199 && nextpar->getDepth() == par.getDepth())
1200 || (atSameLastLangSwitchDepth(state) && nextpar
1201 && nextpar->getDepth() < par.getDepth()))
1202 close_lang_switch = using_begin_end;
1203 if (nextpar && par.params().depth() < nextpar->params().depth())
1204 pending_newline = !text.inset().getLayout().parbreakIgnored() && !merged_par;
1206 case LATEX_ENVIRONMENT: {
1207 // if it's the last paragraph of the current environment
1208 // skip it otherwise fall through
1210 && ((nextpar->layout() != par.layout()
1211 || nextpar->params().depth() != par.params().depth())
1212 || (!using_begin_end || par_lang != nextpar_lang)))
1214 close_lang_switch = using_begin_end;
1221 // we don't need it for the last paragraph and in InTitle commands!!!
1222 if (nextpar && !intitle_command)
1223 pending_newline = !text.inset().getLayout().parbreakIgnored() && !merged_par;
1226 // InTitle commands use switches (not environments) for space settings
1227 if (par.allowParagraphCustomization() && !style.intitle) {
1228 if (!par.params().spacing().isDefault()
1229 && (runparams.isLastPar || !nextpar->hasSameLayout(par))) {
1230 if (pending_newline)
1233 string const endtag =
1234 par.params().spacing().writeEnvirEnd(useSetSpace);
1235 if (prefixIs(endtag, "\\end{"))
1238 os << from_ascii(endtag);
1239 pending_newline = true;
1243 // Closing the language is needed for the last paragraph in a given language
1244 // as well as for any InTitleCommand (since these set the language locally);
1245 // it is also needed if we're within an \L or \R that we may have opened above
1246 // (not necessarily in this paragraph) and are about to close.
1247 bool closing_rtl_ltr_environment = !using_begin_end
1249 && (par_language->lang() != "arabic_arabtex"
1250 && outer_language->lang() != "arabic_arabtex")
1251 // have we opened an \L or \R environment?
1252 && runparams.local_font != nullptr
1253 && runparams.local_font->isRightToLeft() != par_language->rightToLeft()
1254 // are we about to close the language?
1255 &&((nextpar && par_lang != nextpar_lang)
1256 || (runparams.isLastPar && par_lang != outer_lang));
1258 if (localswitch_needed
1259 || (intitle_command && using_begin_end)
1260 || closing_rtl_ltr_environment
1261 || (((runparams.isLastPar && !runparams.inbranch) || close_lang_switch)
1262 && (par_lang != outer_lang || (using_begin_end
1263 && style.isEnvironment()
1264 && par_lang != nextpar_lang)))) {
1265 // Since \selectlanguage write the language to the aux file,
1266 // we need to reset the language at the end of footnote or
1269 if (!localswitch && (pending_newline || close_lang_switch))
1272 // when the paragraph uses CJK, the language has to be closed earlier
1273 if ((font.language()->encoding()->package() != Encoding::CJK)
1274 || bparams.useNonTeXFonts
1275 || runparams_in.for_search) {
1276 if (lang_end_command.empty()) {
1277 // If this is a child, we should restore the
1278 // master language after the last paragraph.
1279 Language const * const current_language =
1280 (runparams.isLastPar && runparams.master_language)
1281 ? runparams.master_language
1283 string const current_lang = use_polyglossia
1284 ? getPolyglossiaEnvName(current_language)
1285 : current_language->babel();
1286 if (!current_lang.empty()
1287 && current_lang != openLanguageName(state)) {
1288 string bc = use_polyglossia ?
1289 getPolyglossiaBegin(lang_begin_command, current_lang,
1290 current_language->polyglossiaOpts(),
1292 : subst(lang_begin_command, "$$lang", current_lang);
1294 pending_newline = !localswitch
1295 && !text.inset().getLayout().parbreakIgnored();
1296 unskip_newline = !localswitch;
1297 if (using_begin_end)
1298 pushLanguageName(current_lang, localswitch);
1300 } else if ((!using_begin_end ||
1301 langOpenedAtThisLevel(state)) &&
1302 !par_lang.empty()) {
1303 // If we are in an environment, we have to
1304 // close the "outer" language afterwards
1305 string const & cur_lang = openLanguageName(state);
1306 if (!style.isEnvironment()
1307 || (close_lang_switch
1308 && atSameLastLangSwitchDepth(state)
1309 && par_lang != outer_lang
1310 && (par_lang != cur_lang
1311 || (cur_lang != outer_lang
1313 && style != nextpar->layout())))
1314 || (atSameLastLangSwitchDepth(state)
1315 && state->lang_switch_depth_.size()
1316 && cur_lang != par_lang)
1317 || in_polyglossia_rtl_env)
1319 if (using_begin_end && !localswitch)
1321 os << from_ascii(subst(
1325 pending_newline = !localswitch
1326 && !text.inset().getLayout().parbreakIgnored();
1327 unskip_newline = !localswitch;
1328 if (using_begin_end)
1334 if (closing_rtl_ltr_environment)
1337 // InTitle commands need to be closed after the language has been closed.
1338 if (intitle_command) {
1340 if (!style.postcommandargs().empty())
1341 latexArgInsets(par, os, runparams, style.postcommandargs(), "post:");
1342 if (!runparams.post_macro.empty()) {
1343 // Output the stored fragile commands (labels, indices etc.)
1344 // that need to be output after the command with moving argument.
1345 os << runparams.post_macro;
1346 runparams.post_macro.clear();
1348 if (par.needsCProtection(runparams.moving_arg)
1349 && contains(runparams.active_chars, '^'))
1351 if (runparams.encoding != prev_encoding) {
1352 runparams.encoding = prev_encoding;
1353 os << setEncoding(prev_encoding->iconvName());
1357 bool const last_was_separator =
1358 par.size() > 0 && par.isEnvSeparator(par.size() - 1);
1360 // Signify added/deleted par break in output if show changes in output
1361 if (nextpar && !os.afterParbreak() && !last_was_separator
1362 && bparams.output_changes && par.parEndChange().changed()) {
1363 Changes::latexMarkChange(os, bparams, Change(Change::UNCHANGED),
1364 par.parEndChange(), runparams);
1365 os << bparams.encoding().latexString(docstring(1, 0x00b6)).first << "}";
1368 if (pending_newline) {
1370 // prevent unwanted whitespace
1372 if (!os.afterParbreak() && !last_was_separator)
1376 // if this is a CJK-paragraph and the next isn't, close CJK
1377 // also if the next paragraph is a multilingual environment (because of nesting)
1378 if (nextpar && state->open_encoding_ == CJK
1379 && bparams.encoding().iconvName() != "UTF-8"
1380 && bparams.encoding().package() != Encoding::CJK
1381 && (nextpar_language->encoding()->package() != Encoding::CJK
1382 || (nextpar->layout().isEnvironment() && nextpar->isMultiLingual(bparams)))
1383 // inbetween environments, CJK has to be closed later (nesting!)
1384 && (!style.isEnvironment() || !nextpar->layout().isEnvironment())) {
1385 os << "\\end{CJK}\n";
1386 state->open_encoding_ = none;
1389 // If this is the last paragraph, close the CJK environment
1390 // if necessary. If it's an environment or nested in an environment,
1391 // we'll have to \end that first.
1392 if (runparams.isLastPar && !style.isEnvironment()
1393 && par.params().depth() < 1) {
1394 switch (state->open_encoding_) {
1396 // do nothing at the end of child documents
1397 if (maintext && buf.masterBuffer() != &buf)
1399 // end of main text: also insert a \clearpage (see #5386)
1401 os << "\n\\clearpage\n\\end{CJK}\n";
1405 state->open_encoding_ = none;
1409 // FIXME: If we are in an inset and the switch happened outside this inset,
1410 // do not switch back at the end of the inset (bug #8479)
1411 // The following attempt does not help with listings-caption in a CJK document:
1412 // if (runparams_in.local_font != 0
1413 // && runparams_in.encoding == runparams_in.local_font->language()->encoding())
1416 state->open_encoding_ = none;
1426 // Information about local language is stored as a font feature.
1427 // If this is the last paragraph of the inset and a local_font was set upon entering
1428 // and we are mixing encodings ("auto-legacy" or "auto-legacy-plain" and no XeTeX or LuaTeX),
1429 // ensure the encoding is set back to the default encoding of the local language.
1430 if (runparams.isLastPar && runparams_in.local_font != nullptr
1431 && runparams_in.encoding != runparams_in.local_font->language()->encoding()
1432 && (bparams.inputenc == "auto-legacy" || bparams.inputenc == "auto-legacy-plain")
1433 && !runparams.isFullUnicode()
1435 runparams_in.encoding = runparams_in.local_font->language()->encoding();
1436 os << setEncoding(runparams_in.encoding->iconvName());
1438 // Otherwise, the current encoding should be set for the next paragraph.
1440 runparams_in.encoding = runparams.encoding;
1442 // Also pass the post_macros upstream
1443 runparams_in.post_macro = runparams.post_macro;
1446 // we don't need a newline for the last paragraph!!!
1447 // Note from JMarc: we will re-add a \n explicitly in
1448 // TeXEnvironment, because it is needed in this case
1449 if (nextpar && !os.afterParbreak() && !last_was_separator) {
1450 Layout const & next_layout = nextpar->layout();
1451 if (!text.inset().getLayout().parbreakIgnored() && !merged_par)
1452 // Make sure to start a new line
1454 // A newline '\n' is always output before a command,
1455 // so avoid doubling it.
1456 if (!next_layout.isCommand()) {
1457 // Here we now try to avoid spurious empty lines by
1458 // outputting a paragraph break only if: (case 1) the
1459 // paragraph style allows parbreaks and no \begin, \end
1460 // or \item tags are going to follow (i.e., if the next
1461 // isn't the first or the current isn't the last
1462 // paragraph of an environment or itemize) and the
1463 // depth and alignment of the following paragraph is
1464 // unchanged, or (case 2) the following is a
1465 // non-environment paragraph whose depth is increased
1466 // but whose alignment is unchanged, or (case 3) the
1467 // paragraph is not an environment and the next one is a
1468 // non-itemize-like env at lower depth, or (case 4) the
1469 // paragraph is a command not followed by an environment
1470 // and the alignment of the current and next paragraph
1471 // is unchanged, or (case 5) the current alignment is
1472 // changed and a standard paragraph follows.
1473 DocumentClass const & tclass = bparams.documentClass();
1474 if ((style == next_layout
1475 && !style.parbreak_is_newline
1476 && !text.inset().getLayout().parbreakIsNewline()
1477 && !text.inset().getLayout().parbreakIgnored()
1478 && style.latextype != LATEX_ITEM_ENVIRONMENT
1479 && style.latextype != LATEX_LIST_ENVIRONMENT
1480 && style.align == par.getAlign(bparams)
1481 && nextpar->getDepth() == par.getDepth()
1482 && nextpar->getAlign(bparams) == par.getAlign(bparams))
1483 || (!next_layout.isEnvironment()
1484 && nextpar->getDepth() > par.getDepth()
1485 && nextpar->getAlign(bparams) == next_layout.align)
1486 || (!style.isEnvironment()
1487 && next_layout.latextype == LATEX_ENVIRONMENT
1488 && nextpar->getDepth() < par.getDepth())
1489 || (style.isCommand()
1490 && !next_layout.isEnvironment()
1491 && style.align == par.getAlign(bparams)
1492 && next_layout.align == nextpar->getAlign(bparams))
1493 || (style.align != par.getAlign(bparams)
1494 && tclass.isDefaultLayout(next_layout))) {
1495 // and omit paragraph break if it has been deleted with ct
1496 // and changes are not shown in output
1503 // Reset language nesting level after intitle command
1504 if (intitle_command)
1505 state->nest_level_ -= 1;
1507 LYXERR(Debug::LATEX, "TeXOnePar for paragraph " << pit << " done; ptr "
1508 << &par << " next " << nextpar);
1514 // LaTeX all paragraphs
1515 void latexParagraphs(Buffer const & buf,
1518 OutputParams const & runparams,
1519 string const & everypar)
1521 LASSERT(runparams.par_begin <= runparams.par_end,
1522 { os << "% LaTeX Output Error\n"; return; } );
1524 BufferParams const & bparams = buf.params();
1525 BufferParams const & mparams = buf.masterParams();
1527 bool const maintext = text.isMainText();
1528 bool const is_child = buf.masterBuffer() != &buf;
1529 bool const multibib_child = maintext && is_child
1530 && mparams.multibib == "child";
1532 if (multibib_child && mparams.useBiblatex())
1533 os << "\\newrefsection";
1534 else if (multibib_child && mparams.useBibtopic()
1535 && !buf.masterBibInfo().empty()) {
1536 os << "\\begin{btUnit}\n";
1537 runparams.openbtUnit = true;
1540 // Open a CJK environment at the beginning of the main buffer
1541 // if the document's main encoding requires the CJK package
1542 // or the document encoding is utf8 and the CJK package is required
1543 // (but not in child documents or documents using system fonts):
1544 OutputState * state = getOutputState();
1545 if (maintext && !is_child && !bparams.useNonTeXFonts
1546 && (bparams.encoding().package() == Encoding::CJK
1547 || (bparams.encoding().name() == "utf8"
1548 && runparams.use_CJK))
1550 docstring const cjkenc = bparams.encoding().iconvName() == "UTF-8"
1551 ? from_ascii("UTF8")
1552 : from_ascii(bparams.encoding().latexName());
1553 os << "\\begin{CJK}{" << cjkenc
1554 << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
1555 state->open_encoding_ = CJK;
1557 // if "auto begin" is switched off, explicitly switch the
1558 // language on at start
1559 string const mainlang = runparams.use_polyglossia
1560 ? getPolyglossiaEnvName(bparams.language)
1561 : bparams.language->babel();
1562 string const lang_begin_command = runparams.use_polyglossia ?
1563 "\\begin{$$lang}$$opts" : lyxrc.language_command_begin;
1564 string const lang_end_command = runparams.use_polyglossia ?
1565 "\\end{$$lang}" : lyxrc.language_command_end;
1566 bool const using_begin_end = runparams.use_polyglossia ||
1567 !lang_end_command.empty();
1569 if (maintext && !lyxrc.language_auto_begin &&
1570 !mainlang.empty()) {
1572 string bc = runparams.use_polyglossia ?
1573 getPolyglossiaBegin(lang_begin_command, mainlang,
1574 bparams.language->polyglossiaOpts())
1575 : subst(lang_begin_command, "$$lang", mainlang);
1578 if (using_begin_end)
1579 pushLanguageName(mainlang);
1582 ParagraphList const & paragraphs = text.paragraphs();
1584 if (runparams.par_begin == runparams.par_end) {
1585 // The full doc will be exported but it is easier to just rely on
1586 // runparams range parameters that will be passed TeXEnvironment.
1587 runparams.par_begin = 0;
1588 runparams.par_end = paragraphs.size();
1591 pit_type pit = runparams.par_begin;
1592 // lastpit is for the language check after the loop.
1593 pit_type lastpit = pit;
1594 // variables used in the loop:
1595 bool was_title = false;
1596 bool already_title = false;
1597 DocumentClass const & tclass = bparams.documentClass();
1599 // Did we already warn about inTitle layout mixing? (we only warn once)
1600 bool gave_layout_warning = false;
1601 for (; pit < runparams.par_end; ++pit) {
1603 ParagraphList::const_iterator par = paragraphs.constIterator(pit);
1605 // FIXME This check should not be needed. We should
1606 // perhaps issue an error if it is.
1607 Layout const & layout = text.inset().forcePlainLayout() ?
1608 tclass.plainLayout() : par->layout();
1610 if (layout.intitle) {
1611 if (already_title) {
1612 if (!gave_layout_warning && !runparams.dryrun) {
1613 gave_layout_warning = true;
1614 frontend::Alert::warning(_("Error in latexParagraphs"),
1615 bformat(_("You are using at least one "
1616 "layout (%1$s) intended for the title, "
1617 "after using non-title layouts. This "
1618 "could lead to missing or incorrect output."
1621 } else if (!was_title) {
1623 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1625 << from_ascii(tclass.titlename())
1629 } else if (was_title && !already_title && !layout.inpreamble) {
1630 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1631 os << "\\end{" << from_ascii(tclass.titlename())
1635 os << "\\" << from_ascii(tclass.titlename())
1638 already_title = true;
1642 if (layout.isCommand() && !layout.latexname().empty()
1643 && layout.latexname() == bparams.multibib) {
1644 if (runparams.openbtUnit)
1645 os << "\\end{btUnit}\n";
1646 if (!bparams.useBiblatex()
1647 && !buf.masterBibInfo().empty()) {
1648 os << '\n' << "\\begin{btUnit}\n";
1649 runparams.openbtUnit = true;
1653 if (!layout.isEnvironment() && par->params().leftIndent().zero()) {
1654 // This is a standard top level paragraph, TeX it and continue.
1655 TeXOnePar(buf, text, pit, os, runparams, everypar);
1659 // Do not output empty environments if the whole paragraph has
1660 // been deleted with ct and changes are not output.
1661 if (size_t(pit + 1) < paragraphs.size()) {
1662 ParagraphList::const_iterator nextpar = paragraphs.constIterator(pit + 1);
1663 Paragraph const & cpar = paragraphs.at(pit);
1664 if ((par->layout() != nextpar->layout()
1665 || par->params().depth() == nextpar->params().depth()
1666 || par->params().leftIndent() == nextpar->params().leftIndent())
1667 && !runparams.for_search && cpar.size() > 0
1668 && cpar.isDeleted(0, cpar.size()) && !bparams.output_changes) {
1669 if (!bparams.output_changes && !cpar.parEndChange().deleted())
1675 TeXEnvironmentData const data =
1676 prepareEnvironment(buf, text, par, os, runparams);
1677 // pit can be changed in TeXEnvironment.
1678 TeXEnvironment(buf, text, runparams, pit, os);
1679 finishEnvironment(os, runparams, data);
1682 // FIXME: uncomment the content or remove this block
1683 if (pit == runparams.par_end) {
1684 // Make sure that the last paragraph is
1685 // correctly terminated (because TeXOnePar does
1686 // not add a \n in this case)
1690 // It might be that we only have a title in this document
1691 if (was_title && !already_title) {
1692 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1693 os << "\\end{" << from_ascii(tclass.titlename())
1696 os << "\\" << from_ascii(tclass.titlename())
1701 if (maintext && !is_child && runparams.openbtUnit)
1702 os << "\\end{btUnit}\n";
1704 // if "auto end" is switched off, explicitly close the language at the end
1705 // but only if the last par is in a babel or polyglossia language
1706 Language const * const lastpar_language =
1707 paragraphs.at(lastpit).getParLanguage(bparams);
1708 if (maintext && !lyxrc.language_auto_end && !mainlang.empty() &&
1709 lastpar_language->encoding()->package() != Encoding::CJK) {
1710 os << from_utf8(subst(lang_end_command,
1714 // If we have language_auto_begin, the stack will
1715 // already be empty, nothing to pop()
1716 if (using_begin_end && !lyxrc.language_auto_begin)
1720 // If the last paragraph is an environment, we'll have to close
1721 // CJK at the very end to do proper nesting.
1722 if (maintext && !is_child && state->open_encoding_ == CJK) {
1723 os << "\\clearpage\n\\end{CJK}\n";
1724 state->open_encoding_ = none;
1726 // Likewise for polyglossia or when using begin/end commands
1727 // or at the very end of an active branch inset with a language switch
1728 Language const * const outer_language = (runparams.local_font != nullptr)
1729 ? runparams.local_font->language() : bparams.language;
1730 string const & prev_lang = runparams.use_polyglossia
1731 ? getPolyglossiaEnvName(outer_language)
1732 : outer_language->babel();
1733 string const lastpar_lang = runparams.use_polyglossia ?
1734 getPolyglossiaEnvName(lastpar_language): lastpar_language->babel();
1735 string const & cur_lang = openLanguageName(state);
1736 if (((runparams.inbranch && langOpenedAtThisLevel(state) && prev_lang != cur_lang)
1737 || (maintext && !is_child)) && !cur_lang.empty()) {
1738 os << from_utf8(subst(lang_end_command,
1742 if (using_begin_end)
1744 } else if (runparams.inbranch && !using_begin_end
1745 && prev_lang != lastpar_lang && !lastpar_lang.empty()) {
1746 // with !using_begin_end, cur_lang is empty, so we need to
1747 // compare against the paragraph language (and we are in the
1748 // last paragraph at this point)
1749 os << subst(lang_begin_command, "$$lang", prev_lang) << '\n';
1752 // reset inherited encoding
1753 if (state->cjk_inherited_ > 0) {
1754 state->cjk_inherited_ -= 1;
1755 if (state->cjk_inherited_ == 0)
1756 state->open_encoding_ = CJK;
1759 if (multibib_child && mparams.useBibtopic()) {
1760 os << "\\end{btUnit}\n";
1761 runparams.openbtUnit = false;
1765 // Switch the input encoding for some part(s) of the document.
1766 pair<bool, int> switchEncoding(odocstream & os, BufferParams const & bparams,
1767 OutputParams const & runparams, Encoding const & newEnc,
1768 bool force, bool noswitchmacro)
1770 // Never switch encoding with XeTeX/LuaTeX
1771 // or if we're in a moving argument or inherit the outer encoding.
1772 if (runparams.isFullUnicode() || newEnc.name() == "inherit")
1773 return make_pair(false, 0);
1775 // Only switch for auto-selected legacy encodings (inputenc setting
1776 // "auto-legacy" or "auto-legacy-plain").
1777 // The "listings" environment can force a switch also with other
1778 // encoding settings (it does not support variable width encodings
1779 // (utf8, jis, ...) under 8-bit latex engines).
1780 if (!force && ((bparams.inputenc != "auto-legacy" && bparams.inputenc != "auto-legacy-plain")
1781 || runparams.moving_arg))
1782 return make_pair(false, 0);
1784 Encoding const & oldEnc = *runparams.encoding;
1785 // Do not switch, if the encoding is unchanged or switching is not supported.
1786 if (oldEnc.name() == newEnc.name()
1787 || oldEnc.package() == Encoding::japanese
1788 || oldEnc.package() == Encoding::none
1789 || newEnc.package() == Encoding::none
1790 || runparams.for_search)
1791 return make_pair(false, 0);
1792 // FIXME We ignore encoding switches from/to encodings that do
1793 // neither support the inputenc package nor the CJK package here.
1794 // This may fail for characters not supported by "unicodesymbols"
1795 // or for non-ASCII characters in "listings"
1796 // but it is the best we can do.
1799 LYXERR(Debug::LATEX, "Changing LaTeX encoding from "
1800 << oldEnc.name() << " to " << newEnc.name());
1801 os << setEncoding(newEnc.iconvName());
1802 if (bparams.inputenc == "auto-legacy-plain")
1803 return make_pair(true, 0);
1805 docstring const inputenc_arg(from_ascii(newEnc.latexName()));
1806 OutputState * state = getOutputState();
1807 switch (newEnc.package()) {
1808 case Encoding::none:
1809 case Encoding::japanese:
1810 // shouldn't ever reach here (see above) but avoids warning.
1811 return make_pair(true, 0);
1812 case Encoding::inputenc: {
1813 int count = inputenc_arg.length();
1814 if (oldEnc.package() == Encoding::CJK &&
1815 state->open_encoding_ == CJK) {
1817 state->open_encoding_ = none;
1820 else if (oldEnc.package() == Encoding::inputenc &&
1821 state->open_encoding_ == inputenc) {
1823 state->open_encoding_ = none;
1826 if (runparams.local_font != nullptr
1827 && oldEnc.package() == Encoding::CJK) {
1828 // within insets, \inputenc switches need
1829 // to be embraced within \bgroup...\egroup;
1833 state->open_encoding_ = inputenc;
1836 return make_pair(true, count);
1837 os << "\\inputencoding{" << inputenc_arg << '}';
1838 return make_pair(true, count + 16);
1840 case Encoding::CJK: {
1841 int count = inputenc_arg.length();
1842 if (oldEnc.package() == Encoding::CJK &&
1843 state->open_encoding_ == CJK) {
1847 if (oldEnc.package() == Encoding::inputenc &&
1848 state->open_encoding_ == inputenc) {
1852 os << "\\begin{CJK}{"
1853 << from_ascii(newEnc.latexName()) << "}{"
1854 << from_ascii(bparams.fonts_cjk) << "}";
1855 state->open_encoding_ = CJK;
1856 return make_pair(true, count + 15);
1859 // Dead code to avoid a warning:
1860 return make_pair(true, 0);