2 * \file output_latex.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
8 * Full author contact details are available in file CREDITS.
13 #include "output_latex.h"
16 #include "BufferParams.h"
19 #include "InsetList.h"
23 #include "OutputParams.h"
24 #include "Paragraph.h"
25 #include "ParagraphParameters.h"
26 #include "texstream.h"
27 #include "TextClass.h"
29 #include "insets/InsetBibitem.h"
30 #include "insets/InsetArgument.h"
32 #include "frontends/alert.h"
34 #include "support/lassert.h"
35 #include "support/convert.h"
36 #include "support/debug.h"
37 #include "support/lstrings.h"
38 #include "support/lyxalgo.h"
39 #include "support/textutils.h"
40 #include "support/gettext.h"
42 #include <QThreadStorage>
48 using namespace lyx::support;
64 OutputState() : open_encoding_(none), cjk_inherited_(0),
65 prev_env_language_(0), nest_level_(0)
68 OpenEncoding open_encoding_;
70 Language const * prev_env_language_;
72 stack<int> lang_switch_depth_; // Both are always empty when
73 stack<string> open_polyglossia_lang_; // not using polyglossia
77 OutputState * getOutputState()
79 // FIXME An instance of OutputState should be kept around for each export
80 // instead of using local thread storage
81 static QThreadStorage<OutputState *> outputstate;
82 if (!outputstate.hasLocalData())
83 outputstate.setLocalData(new OutputState);
84 return outputstate.localData();
88 string const & openLanguageName(OutputState const * state)
90 // Return a reference to the last active language opened with
91 // polyglossia or when using begin/end commands. If none or when
92 // using babel with only a begin command, return a reference to
95 static string const empty;
97 return state->open_polyglossia_lang_.empty()
99 : state->open_polyglossia_lang_.top();
103 bool atSameLastLangSwitchDepth(OutputState const * state)
105 // Return true if the actual nest level is the same at which the
106 // language was switched when using polyglossia or begin/end
107 // commands. Instead, return always true when using babel with
108 // only a begin command.
110 return state->lang_switch_depth_.size() == 0
112 : abs(state->lang_switch_depth_.top()) == state->nest_level_;
116 bool isLocalSwitch(OutputState const * state)
118 // Return true if the language was opened by a local command switch.
120 return state->lang_switch_depth_.size()
121 && state->lang_switch_depth_.top() < 0;
125 bool langOpenedAtThisLevel(OutputState const * state)
127 // Return true if the language was opened at the current nesting level.
129 return state->lang_switch_depth_.size()
130 && abs(state->lang_switch_depth_.top()) == state->nest_level_;
134 string const getPolyglossiaEnvName(Language const * lang)
136 string result = lang->polyglossia();
137 if (result == "arabic")
138 // exceptional spelling; see polyglossia docs.
144 string const getPolyglossiaBegin(string const & lang_begin_command,
145 string const & lang, string const & opts,
146 bool const localswitch = false)
150 // we need to revert the upcasing done in getPolyglossiaEnvName()
151 // in case we have a local polyglossia command (\textarabic).
152 string language = localswitch ? ascii_lowercase(lang) : lang;
153 result = subst(lang_begin_command, "$$lang", language);
155 string options = opts.empty() ?
156 string() : "[" + opts + "]";
157 result = subst(result, "$$opts", options);
163 struct TeXEnvironmentData
166 Layout const * style;
167 Language const * par_language;
168 Encoding const * prev_encoding;
169 bool leftindent_open;
173 static TeXEnvironmentData prepareEnvironment(Buffer const & buf,
175 ParagraphList::const_iterator pit,
177 OutputParams const & runparams)
179 TeXEnvironmentData data;
181 BufferParams const & bparams = buf.params();
183 // FIXME This test should not be necessary.
184 // We should perhaps issue an error if it is.
185 Layout const & style = text.inset().forcePlainLayout() ?
186 bparams.documentClass().plainLayout() : pit->layout();
188 ParagraphList const & paragraphs = text.paragraphs();
189 ParagraphList::const_iterator const priorpit =
190 pit == paragraphs.begin() ? pit : prev(pit, 1);
192 OutputState * state = getOutputState();
193 bool const use_prev_env_language = state->prev_env_language_ != 0
194 && priorpit->layout().isEnvironment()
195 && (priorpit->getDepth() > pit->getDepth()
196 || (priorpit->getDepth() == pit->getDepth()
197 && priorpit->layout() != pit->layout()));
199 data.prev_encoding = runparams.encoding;
200 data.par_language = pit->getParLanguage(bparams);
201 Language const * const doc_language = bparams.language;
202 Language const * const prev_par_language =
203 (pit != paragraphs.begin())
204 ? (use_prev_env_language ? state->prev_env_language_
205 : priorpit->getParLanguage(bparams))
208 bool const use_polyglossia = runparams.use_polyglossia;
209 string const par_lang = use_polyglossia ?
210 getPolyglossiaEnvName(data.par_language) : data.par_language->babel();
211 string const prev_par_lang = use_polyglossia ?
212 getPolyglossiaEnvName(prev_par_language) : prev_par_language->babel();
213 string const doc_lang = use_polyglossia ?
214 getPolyglossiaEnvName(doc_language) : doc_language->babel();
215 string const lang_begin_command = use_polyglossia ?
216 "\\begin{$$lang}" : lyxrc.language_command_begin;
217 string const lang_end_command = use_polyglossia ?
218 "\\end{$$lang}" : lyxrc.language_command_end;
219 bool const using_begin_end = use_polyglossia ||
220 !lang_end_command.empty();
222 // For polyglossia, switch language outside of environment, if possible.
223 if (par_lang != prev_par_lang) {
224 if ((!using_begin_end || langOpenedAtThisLevel(state)) &&
225 !lang_end_command.empty() &&
226 prev_par_lang != doc_lang &&
227 !prev_par_lang.empty()) {
228 os << from_ascii(subst(
232 // the '%' is necessary to prevent unwanted whitespace
238 // If no language was explicitly opened and we are using
239 // polyglossia or begin/end commands, then the current
240 // language is the document language.
241 string const & cur_lang = using_begin_end
242 && state->lang_switch_depth_.size()
243 ? openLanguageName(state)
246 if ((lang_end_command.empty() ||
247 par_lang != doc_lang ||
248 par_lang != cur_lang) &&
250 string bc = use_polyglossia ?
251 getPolyglossiaBegin(lang_begin_command, par_lang,
252 data.par_language->polyglossiaOpts())
253 : subst(lang_begin_command, "$$lang", par_lang);
255 // the '%' is necessary to prevent unwanted whitespace
258 pushLanguageName(par_lang);
262 data.leftindent_open = false;
263 if (!pit->params().leftIndent().zero()) {
264 os << "\\begin{LyXParagraphLeftIndent}{"
265 << from_ascii(pit->params().leftIndent().asLatexString())
267 data.leftindent_open = true;
270 if (style.isEnvironment())
271 state->nest_level_ += 1;
273 if (style.isEnvironment() && !style.latexname().empty()) {
274 os << "\\begin{" << from_ascii(style.latexname()) << '}';
275 if (!style.latexargs().empty()) {
276 OutputParams rp = runparams;
277 rp.local_font = &pit->getFirstFontSettings(bparams);
278 latexArgInsets(paragraphs, pit, os, rp, style.latexargs());
280 if (style.latextype == LATEX_LIST_ENVIRONMENT) {
282 << pit->params().labelWidthString()
284 } else if (style.labeltype == LABEL_BIBLIO) {
285 if (pit->params().labelWidthString().empty())
286 os << '{' << bibitemWidest(buf, runparams) << "}\n";
289 << pit->params().labelWidthString()
292 os << from_ascii(style.latexparam()) << '\n';
296 // in multilingual environments, the CJK tags have to be nested properly
297 data.cjk_nested = false;
298 if (data.par_language->encoding()->package() == Encoding::CJK &&
299 state->open_encoding_ != CJK && pit->isMultiLingual(bparams)) {
300 if (prev_par_language->encoding()->package() == Encoding::CJK)
301 os << "\\begin{CJK}{" << from_ascii(data.par_language->encoding()->latexName())
302 << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
303 state->open_encoding_ = CJK;
304 data.cjk_nested = true;
310 static void finishEnvironment(otexstream & os, OutputParams const & runparams,
311 TeXEnvironmentData const & data)
313 OutputState * state = getOutputState();
314 // BufferParams const & bparams = buf.params(); // FIXME: for speedup shortcut below, would require passing of "buf" as argument
315 if (state->open_encoding_ == CJK && data.cjk_nested) {
316 // We need to close the encoding even if it does not change
317 // to do correct environment nesting
318 os << "\\end{CJK}\n";
319 state->open_encoding_ = none;
322 if (data.style->isEnvironment()) {
324 bool const using_begin_end =
325 runparams.use_polyglossia ||
326 !lyxrc.language_command_end.empty();
327 // Close any language opened at this nest level
328 if (using_begin_end) {
329 while (langOpenedAtThisLevel(state)) {
330 if (isLocalSwitch(state)) {
334 << openLanguageName(state)
340 state->nest_level_ -= 1;
341 string const & name = data.style->latexname();
343 os << "\\end{" << from_ascii(name) << "}\n";
344 state->prev_env_language_ = data.par_language;
345 if (runparams.encoding != data.prev_encoding) {
346 runparams.encoding = data.prev_encoding;
347 os << setEncoding(data.prev_encoding->iconvName());
351 if (data.leftindent_open) {
352 os << breakln << "\\end{LyXParagraphLeftIndent}\n";
353 state->prev_env_language_ = data.par_language;
354 if (runparams.encoding != data.prev_encoding) {
355 runparams.encoding = data.prev_encoding;
356 os << setEncoding(data.prev_encoding->iconvName());
360 // Check whether we should output a blank line after the environment
361 if (!data.style->nextnoindent)
366 void TeXEnvironment(Buffer const & buf, Text const & text,
367 OutputParams const & runparams,
368 pit_type & pit, otexstream & os)
370 ParagraphList const & paragraphs = text.paragraphs();
371 ParagraphList::const_iterator par = paragraphs.constIterator(pit);
372 LYXERR(Debug::LATEX, "TeXEnvironment for paragraph " << pit);
374 Layout const & current_layout = par->layout();
375 depth_type const current_depth = par->params().depth();
376 Length const & current_left_indent = par->params().leftIndent();
378 // This is for debugging purpose at the end.
379 pit_type const par_begin = pit;
380 for (; pit < runparams.par_end; ++pit) {
381 ParagraphList::const_iterator par = paragraphs.constIterator(pit);
383 // check first if this is an higher depth paragraph.
384 bool go_out = (par->params().depth() < current_depth);
385 if (par->params().depth() == current_depth) {
386 // This environment is finished.
387 go_out |= (par->layout() != current_layout);
388 go_out |= (par->params().leftIndent() != current_left_indent);
391 // nothing to do here, restore pit and go out.
396 if (par->layout() == current_layout
397 && par->params().depth() == current_depth
398 && par->params().leftIndent() == current_left_indent) {
399 // We are still in the same environment so TeXOnePar and continue;
400 TeXOnePar(buf, text, pit, os, runparams);
404 // We are now in a deeper environment.
405 // Either par->layout() != current_layout
406 // Or par->params().depth() > current_depth
407 // Or par->params().leftIndent() != current_left_indent)
409 // FIXME This test should not be necessary.
410 // We should perhaps issue an error if it is.
411 bool const force_plain_layout = text.inset().forcePlainLayout();
412 Layout const & style = force_plain_layout
413 ? buf.params().documentClass().plainLayout()
416 if (!style.isEnvironment()) {
417 // This is a standard paragraph, no need to call TeXEnvironment.
418 TeXOnePar(buf, text, pit, os, runparams);
422 // This is a new environment.
423 TeXEnvironmentData const data =
424 prepareEnvironment(buf, text, par, os, runparams);
425 // Recursive call to TeXEnvironment!
426 TeXEnvironment(buf, text, runparams, pit, os);
427 finishEnvironment(os, runparams, data);
430 if (pit != runparams.par_end)
431 LYXERR(Debug::LATEX, "TeXEnvironment for paragraph " << par_begin << " done.");
435 void getArgInsets(otexstream & os, OutputParams const & runparams, Layout::LaTeXArgMap const & latexargs,
436 map<int, lyx::InsetArgument const *> ilist, vector<string> required, string const & prefix)
438 unsigned int const argnr = latexargs.size();
442 // Default and preset args are always output, so if they require
443 // other arguments, consider this.
444 Layout::LaTeXArgMap::const_iterator lit = latexargs.begin();
445 Layout::LaTeXArgMap::const_iterator const lend = latexargs.end();
446 for (; lit != lend; ++lit) {
447 Layout::latexarg arg = (*lit).second;
448 if ((!arg.presetarg.empty() || !arg.defaultarg.empty()) && !arg.requires.empty()) {
449 vector<string> req = getVectorFromString(arg.requires);
450 required.insert(required.end(), req.begin(), req.end());
454 for (unsigned int i = 1; i <= argnr; ++i) {
455 map<int, InsetArgument const *>::const_iterator lit = ilist.find(i);
456 bool inserted = false;
457 if (lit != ilist.end()) {
458 InsetArgument const * ins = (*lit).second;
460 Layout::LaTeXArgMap::const_iterator const lait =
461 latexargs.find(ins->name());
462 if (lait != latexargs.end()) {
463 Layout::latexarg arg = (*lait).second;
464 docstring ldelim = arg.mandatory ?
465 from_ascii("{") : from_ascii("[");
466 docstring rdelim = arg.mandatory ?
467 from_ascii("}") : from_ascii("]");
468 if (!arg.ldelim.empty())
470 if (!arg.rdelim.empty())
472 ins->latexArgument(os, runparams, ldelim, rdelim, arg.presetarg);
478 Layout::LaTeXArgMap::const_iterator lait = latexargs.begin();
479 Layout::LaTeXArgMap::const_iterator const laend = latexargs.end();
480 for (; lait != laend; ++lait) {
481 string const name = prefix + convert<string>(i);
482 if ((*lait).first == name) {
483 Layout::latexarg arg = (*lait).second;
484 docstring preset = arg.presetarg;
485 if (!arg.defaultarg.empty()) {
488 preset += arg.defaultarg;
491 docstring ldelim = arg.ldelim.empty() ?
492 from_ascii("{") : arg.ldelim;
493 docstring rdelim = arg.rdelim.empty() ?
494 from_ascii("}") : arg.rdelim;
495 os << ldelim << preset << rdelim;
496 } else if (!preset.empty()) {
497 docstring ldelim = arg.ldelim.empty() ?
498 from_ascii("[") : arg.ldelim;
499 docstring rdelim = arg.rdelim.empty() ?
500 from_ascii("]") : arg.rdelim;
501 os << ldelim << preset << rdelim;
502 } else if (find(required.begin(), required.end(),
503 (*lait).first) != required.end()) {
504 docstring ldelim = arg.ldelim.empty() ?
505 from_ascii("[") : arg.ldelim;
506 docstring rdelim = arg.rdelim.empty() ?
507 from_ascii("]") : arg.rdelim;
508 os << ldelim << rdelim;
521 void pushLanguageName(string const & lang_name, bool localswitch)
523 OutputState * state = getOutputState();
525 int nest_level = localswitch ? -state->nest_level_ : state->nest_level_;
526 state->lang_switch_depth_.push(nest_level);
527 state->open_polyglossia_lang_.push(lang_name);
531 void popLanguageName()
533 OutputState * state = getOutputState();
535 state->lang_switch_depth_.pop();
536 state->open_polyglossia_lang_.pop();
540 string const & openLanguageName()
542 OutputState * state = getOutputState();
544 return openLanguageName(state);
550 void addArgInsets(Paragraph const & par, string const & prefix,
551 Layout::LaTeXArgMap const & latexargs,
552 map<int, InsetArgument const *> & ilist,
553 vector<string> & required)
555 for (auto const & table : par.insetList()) {
556 InsetArgument const * arg = table.inset->asInsetArgument();
559 if (arg->name().empty()) {
560 LYXERR0("Error: Unnamed argument inset!");
563 string const name = prefix.empty() ?
564 arg->name() : split(arg->name(), ':');
565 // why converting into an integer?
566 unsigned int const nr = convert<unsigned int>(name);
567 if (ilist.find(nr) == ilist.end())
569 Layout::LaTeXArgMap::const_iterator const lit =
570 latexargs.find(arg->name());
571 if (lit != latexargs.end()) {
572 Layout::latexarg const & larg = lit->second;
573 vector<string> req = getVectorFromString(larg.requires);
574 move(req.begin(), req.end(), back_inserter(required));
582 void latexArgInsets(Paragraph const & par, otexstream & os,
583 OutputParams const & runparams,
584 Layout::LaTeXArgMap const & latexargs,
585 string const & prefix)
587 map<int, InsetArgument const *> ilist;
588 vector<string> required;
589 addArgInsets(par, prefix, latexargs, ilist, required);
590 getArgInsets(os, runparams, latexargs, ilist, required, prefix);
594 void latexArgInsets(ParagraphList const & pars,
595 ParagraphList::const_iterator pit,
596 otexstream & os, OutputParams const & runparams,
597 Layout::LaTeXArgMap const & latexargs,
598 string const & prefix)
600 map<int, InsetArgument const *> ilist;
601 vector<string> required;
603 depth_type const current_depth = pit->params().depth();
604 Layout const current_layout = pit->layout();
606 // get the first paragraph in sequence with this layout and depth
609 if (lyx::prev(pit, offset) == pars.begin())
611 ParagraphList::const_iterator priorpit = lyx::prev(pit, offset + 1);
612 if (priorpit->layout() == current_layout
613 && priorpit->params().depth() == current_depth)
619 ParagraphList::const_iterator spit = lyx::prev(pit, offset);
621 for (; spit != pars.end(); ++spit) {
622 if (spit->layout() != current_layout ||
623 spit->params().depth() < current_depth)
625 if (spit->params().depth() > current_depth)
627 addArgInsets(*spit, prefix, latexargs, ilist, required);
629 getArgInsets(os, runparams, latexargs, ilist, required, prefix);
633 void latexArgInsetsForParent(ParagraphList const & pars, otexstream & os,
634 OutputParams const & runparams,
635 Layout::LaTeXArgMap const & latexargs,
636 string const & prefix)
638 map<int, InsetArgument const *> ilist;
639 vector<string> required;
641 for (Paragraph const & par : pars) {
642 if (par.layout().hasArgs())
643 // The InsetArguments inside this paragraph refer to this paragraph
645 addArgInsets(par, prefix, latexargs, ilist, required);
647 getArgInsets(os, runparams, latexargs, ilist, required, prefix);
653 // output the proper paragraph start according to latextype.
654 void parStartCommand(Paragraph const & par, otexstream & os,
655 OutputParams const & runparams, Layout const & style)
657 switch (style.latextype) {
659 os << '\\' << from_ascii(style.latexname());
662 if (!style.latexargs().empty())
663 latexArgInsets(par, os, runparams, style.latexargs());
664 os << from_ascii(style.latexparam());
666 case LATEX_ITEM_ENVIRONMENT:
667 case LATEX_LIST_ENVIRONMENT:
668 os << "\\" + style.itemcommand();
670 if (!style.itemargs().empty())
671 latexArgInsets(par, os, runparams, style.itemargs(), "item:");
674 case LATEX_BIB_ENVIRONMENT:
675 // ignore this, the inset will write itself
684 // FIXME: this should be anonymous
685 void TeXOnePar(Buffer const & buf,
689 OutputParams const & runparams_in,
690 string const & everypar,
691 int start_pos, int end_pos,
694 BufferParams const & bparams = runparams_in.is_child
695 ? buf.masterParams() : buf.params();
696 ParagraphList const & paragraphs = text.paragraphs();
697 Paragraph const & par = paragraphs.at(pit);
698 // FIXME This check should not really be needed.
699 // Perhaps we should issue an error if it is.
700 Layout const & style = text.inset().forcePlainLayout() ?
701 bparams.documentClass().plainLayout() : par.layout();
703 if (style.inpreamble && !force)
706 LYXERR(Debug::LATEX, "TeXOnePar for paragraph " << pit << " ptr " << &par << " '"
709 OutputParams runparams = runparams_in;
710 runparams.isLastPar = (pit == pit_type(paragraphs.size() - 1));
711 // We reinitialze par begin and end to be on the safe side
712 // with embedded inset as we don't know if they set those
714 runparams.par_begin = 0;
715 runparams.par_end = 0;
717 bool const maintext = text.isMainText();
718 // we are at the beginning of an inset and CJK is already open;
719 // we count inheritation levels to get the inset nesting right.
720 OutputState * state = getOutputState();
721 if (pit == 0 && !maintext
722 && (state->cjk_inherited_ > 0 || state->open_encoding_ == CJK)) {
723 state->cjk_inherited_ += 1;
724 state->open_encoding_ = none;
727 if (text.inset().isPassThru()) {
728 Font const outerfont = text.outerFont(pit);
730 // No newline before first paragraph in this lyxtext
733 if (!text.inset().getLayout().parbreakIsNewline())
737 par.latex(bparams, outerfont, os, runparams, start_pos, end_pos, force);
741 Paragraph const * nextpar = runparams.isLastPar
742 ? 0 : ¶graphs.at(pit + 1);
744 bool const intitle_command = style.intitle && style.latextype == LATEX_COMMAND;
746 if (style.pass_thru) {
747 Font const outerfont = text.outerFont(pit);
748 parStartCommand(par, os, runparams, style);
752 par.latex(bparams, outerfont, os, runparams, start_pos, end_pos, force);
754 // I did not create a parEndCommand for this minuscule
755 // task because in the other user of parStartCommand
756 // the code is different (JMarc)
757 if (style.isCommand())
761 if (!style.parbreak_is_newline) {
763 } else if (nextpar && !style.isEnvironment()) {
764 Layout const nextstyle = text.inset().forcePlainLayout()
765 ? bparams.documentClass().plainLayout()
767 if (nextstyle.name() != style.name())
774 // This paragraph's language
775 Language const * const par_language = par.getParLanguage(bparams);
776 Language const * const nextpar_language = nextpar ?
777 nextpar->getParLanguage(bparams) : 0;
778 // The document's language
779 Language const * const doc_language = bparams.language;
780 // The language that was in effect when the environment this paragraph is
781 // inside of was opened
782 Language const * const outer_language =
783 (runparams.local_font != 0) ?
784 runparams.local_font->language() : doc_language;
786 Paragraph const * priorpar = (pit == 0) ? 0 : ¶graphs.at(pit - 1);
788 // The previous language that was in effect is the language of the
789 // previous paragraph, unless the previous paragraph is inside an
790 // environment with nesting depth greater than (or equal to, but with
791 // a different layout) the current one. If there is no previous
792 // paragraph, the previous language is the outer language.
793 // Note further that we take the outer language also if the prior par
794 // is PassThru, since in that case it has latex_language, and all secondary
795 // languages have been closed (#10793).
796 bool const use_prev_env_language = state->prev_env_language_ != 0
798 && priorpar->layout().isEnvironment()
799 && (priorpar->getDepth() > par.getDepth()
800 || (priorpar->getDepth() == par.getDepth()
801 && priorpar->layout() != par.layout()));
802 Language const * const prev_language =
803 (priorpar && !priorpar->isPassThru())
804 ? (use_prev_env_language ? state->prev_env_language_
805 : priorpar->getParLanguage(bparams))
808 bool const use_polyglossia = runparams.use_polyglossia;
809 string const par_lang = use_polyglossia ?
810 getPolyglossiaEnvName(par_language): par_language->babel();
811 string const prev_lang = use_polyglossia ?
812 getPolyglossiaEnvName(prev_language) : prev_language->babel();
813 string const outer_lang = use_polyglossia ?
814 getPolyglossiaEnvName(outer_language) : outer_language->babel();
815 string const nextpar_lang = nextpar_language ? (use_polyglossia ?
816 getPolyglossiaEnvName(nextpar_language) :
817 nextpar_language->babel()) : string();
818 string lang_begin_command = use_polyglossia ?
819 "\\begin{$$lang}$$opts" : lyxrc.language_command_begin;
820 string lang_end_command = use_polyglossia ?
821 "\\end{$$lang}" : lyxrc.language_command_end;
822 // the '%' is necessary to prevent unwanted whitespace
823 string lang_command_termination = "%\n";
824 bool const using_begin_end = use_polyglossia ||
825 !lang_end_command.empty();
827 // For InTitle commands, we need to switch the language inside the command
828 // (see #10849); thus open the command here.
829 if (intitle_command) {
830 parStartCommand(par, os, runparams, style);
834 // In some insets (such as Arguments), we cannot use \selectlanguage.
835 // Also, if an RTL language is set via environment in polyglossia,
836 // only a nested \\text<lang> command will reset the direction for LTR
837 // languages (see # 10111).
838 bool const localswitch = text.inset().forceLocalFontSwitch()
839 || (using_begin_end && text.inset().forcePlainLayout())
840 || (use_polyglossia && outer_language->rightToLeft() && !par_language->rightToLeft());
842 lang_begin_command = use_polyglossia ?
843 "\\text$$lang$$opts{" : lyxrc.language_command_local;
844 lang_end_command = "}";
845 lang_command_termination.clear();
848 bool const localswitch_needed = localswitch && par_lang != outer_lang;
850 // localswitches need to be closed and reopened at each par
851 if ((par_lang != prev_lang || localswitch_needed)
852 // check if we already put language command in TeXEnvironment()
853 && !(style.isEnvironment()
854 && (pit == 0 || (priorpar->layout() != par.layout()
855 && priorpar->getDepth() <= par.getDepth())
856 || priorpar->getDepth() < par.getDepth()))) {
858 && (!using_begin_end || langOpenedAtThisLevel(state))
859 && !lang_end_command.empty()
860 && prev_lang != outer_lang
861 && !prev_lang.empty()
862 && (!using_begin_end || !style.isEnvironment())) {
863 os << from_ascii(subst(lang_end_command,
866 << lang_command_termination;
871 // We need to open a new language if we couldn't close the previous
872 // one (because there's no language_command_end); and even if we closed
873 // the previous one, if the current language is different than the
874 // outer_language (which is currently in effect once the previous one
876 if ((lang_end_command.empty() || par_lang != outer_lang
878 || (style.isEnvironment() && par_lang != prev_lang)))
879 && !par_lang.empty()) {
880 // If we're inside an inset, and that inset is within an \L or \R
881 // (or equivalents), then within the inset, too, any opposite
882 // language paragraph should appear within an \L or \R (in addition
883 // to, outside of, the normal language switch commands).
884 // This behavior is not correct for ArabTeX, though.
887 && par_language->lang() != "arabic_arabtex"
888 && outer_language->lang() != "arabic_arabtex"
889 // are we in an inset?
890 && runparams.local_font != 0
891 // is the inset within an \L or \R?
893 // FIXME: currently, we don't check this; this means that
894 // we'll have unnnecessary \L and \R commands, but that
895 // doesn't seem to hurt (though latex will complain)
897 // is this paragraph in the opposite direction?
898 && runparams.local_font->isRightToLeft() != par_language->rightToLeft()) {
899 // FIXME: I don't have a working copy of the Arabi package, so
900 // I'm not sure if the farsi and arabic_arabi stuff is correct
902 if (par_language->lang() == "farsi")
904 else if (outer_language->lang() == "farsi")
906 else if (par_language->lang() == "arabic_arabi")
908 else if (outer_language->lang() == "arabic_arabi")
910 // remaining RTL languages currently is hebrew
911 else if (par_language->rightToLeft())
916 // With CJK, the CJK tag has to be closed first (see below)
917 if (runparams.encoding->package() != Encoding::CJK
918 && (par_lang != openLanguageName(state) || localswitch)
919 && !par_lang.empty()) {
920 string bc = use_polyglossia ?
921 getPolyglossiaBegin(lang_begin_command, par_lang,
922 par_language->polyglossiaOpts(),
924 : subst(lang_begin_command, "$$lang", par_lang);
926 os << lang_command_termination;
928 pushLanguageName(par_lang, localswitch);
933 // Switch file encoding if necessary; no need to do this for "default"
934 // encoding, since this only affects the position of the outputted
935 // \inputencoding command; the encoding switch will occur when necessary
936 if (bparams.inputenc == "auto"
937 && !runparams.isFullUnicode() // Xe/LuaTeX use one document-wide encoding (see also switchEncoding())
938 && runparams.encoding->package() != Encoding::none) {
939 // Look ahead for future encoding changes.
940 // We try to output them at the beginning of the paragraph,
941 // since the \inputencoding command is not allowed e.g. in
942 // sections. For this reason we only set runparams.moving_arg
943 // after checking for the encoding change, otherwise the
944 // change would be always avoided by switchEncoding().
945 for (pos_type i = 0; i < par.size(); ++i) {
946 char_type const c = par.getChar(i);
947 Encoding const * const encoding =
948 par.getFontSettings(bparams, i).language()->encoding();
949 if (encoding->package() != Encoding::CJK
950 && runparams.encoding->package() == Encoding::inputenc
955 // All characters before c are in the ASCII range, and
956 // c is non-ASCII (but no inset), so change the
957 // encoding to that required by the language of c.
958 // With CJK, only add switch if we have CJK content at the beginning
960 if (i != 0 && encoding->package() == Encoding::CJK)
963 pair<bool, int> enc_switch = switchEncoding(os.os(),
964 bparams, runparams, *encoding);
965 // the following is necessary after a CJK environment in a multilingual
966 // context (nesting issue).
967 if (par_language->encoding()->package() == Encoding::CJK
968 && state->open_encoding_ != CJK && state->cjk_inherited_ == 0) {
969 os << "\\begin{CJK}{" << from_ascii(par_language->encoding()->latexName())
970 << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
971 state->open_encoding_ = CJK;
973 if (encoding->package() != Encoding::none && enc_switch.first) {
974 if (enc_switch.second > 0) {
975 // the '%' is necessary to prevent unwanted whitespace
978 // With CJK, the CJK tag had to be closed first (see above)
979 if (runparams.encoding->package() == Encoding::CJK
980 && par_lang != openLanguageName(state)
981 && !par_lang.empty()) {
982 string bc = use_polyglossia ?
983 getPolyglossiaBegin(lang_begin_command, par_lang,
984 par_language->polyglossiaOpts(),
986 : subst(lang_begin_command, "$$lang", par_lang);
988 << lang_command_termination;
990 pushLanguageName(par_lang, localswitch);
992 runparams.encoding = encoding;
998 runparams.moving_arg |= style.needprotect;
999 Encoding const * const prev_encoding = runparams.encoding;
1001 bool const useSetSpace = bparams.documentClass().provides("SetSpace");
1002 if (par.allowParagraphCustomization()) {
1003 if (par.params().startOfAppendix()) {
1004 os << "\n\\appendix\n";
1007 // InTitle commands must use switches (not environments)
1008 // inside the commands (see #9332)
1009 if (style.intitle) {
1010 if (!par.params().spacing().isDefault())
1012 if (runparams.moving_arg)
1014 os << from_ascii(par.params().spacing().writeCmd(useSetSpace));
1017 if (!par.params().spacing().isDefault()
1018 && (pit == 0 || !priorpar->hasSameLayout(par)))
1020 os << from_ascii(par.params().spacing().writeEnvirBegin(useSetSpace))
1024 if (style.isCommand()) {
1030 // For InTitle commands, we already started the command before
1031 // the language switch
1032 if (!intitle_command)
1033 parStartCommand(par, os, runparams, style);
1035 Font const outerfont = text.outerFont(pit);
1038 os << from_utf8(everypar);
1039 par.latex(bparams, outerfont, os, runparams, start_pos, end_pos, force);
1041 Font const font = par.empty()
1042 ? par.getLayoutFont(bparams, outerfont)
1043 : par.getFont(bparams, par.size() - 1, outerfont);
1045 bool const is_command = style.isCommand();
1047 // InTitle commands need to be closed after the language has been closed.
1048 if (!intitle_command) {
1051 if (!style.postcommandargs().empty())
1052 latexArgInsets(par, os, runparams, style.postcommandargs(), "post:");
1053 if (runparams.encoding != prev_encoding) {
1054 runparams.encoding = prev_encoding;
1055 os << setEncoding(prev_encoding->iconvName());
1060 bool pending_newline = false;
1061 bool unskip_newline = false;
1062 bool close_lang_switch = false;
1063 switch (style.latextype) {
1064 case LATEX_ITEM_ENVIRONMENT:
1065 case LATEX_LIST_ENVIRONMENT:
1066 if ((nextpar && par_lang != nextpar_lang
1067 && nextpar->getDepth() == par.getDepth())
1068 || (atSameLastLangSwitchDepth(state) && nextpar
1069 && nextpar->getDepth() < par.getDepth()))
1070 close_lang_switch = using_begin_end;
1071 if (nextpar && par.params().depth() < nextpar->params().depth())
1072 pending_newline = true;
1074 case LATEX_ENVIRONMENT: {
1075 // if its the last paragraph of the current environment
1076 // skip it otherwise fall through
1078 && ((nextpar->layout() != par.layout()
1079 || nextpar->params().depth() != par.params().depth())
1080 || (!using_begin_end || par_lang != nextpar_lang)))
1082 close_lang_switch = using_begin_end;
1089 // we don't need it for the last paragraph and in InTitle commands!!!
1090 if (nextpar && !intitle_command)
1091 pending_newline = true;
1094 // InTitle commands use switches (not environments) for space settings
1095 if (par.allowParagraphCustomization() && !style.intitle) {
1096 if (!par.params().spacing().isDefault()
1097 && (runparams.isLastPar || !nextpar->hasSameLayout(par))) {
1098 if (pending_newline)
1101 string const endtag =
1102 par.params().spacing().writeEnvirEnd(useSetSpace);
1103 if (prefixIs(endtag, "\\end{"))
1106 os << from_ascii(endtag);
1107 pending_newline = true;
1111 // Closing the language is needed for the last paragraph in a given language
1112 // as well as for any InTitleCommand (since these set the language locally);
1113 // it is also needed if we're within an \L or \R that we may have opened above
1114 // (not necessarily in this paragraph) and are about to close.
1115 bool closing_rtl_ltr_environment = !using_begin_end
1117 && (par_language->lang() != "arabic_arabtex"
1118 && outer_language->lang() != "arabic_arabtex")
1119 // have we opened an \L or \R environment?
1120 && runparams.local_font != 0
1121 && runparams.local_font->isRightToLeft() != par_language->rightToLeft()
1122 // are we about to close the language?
1123 &&((nextpar && par_lang != nextpar_lang)
1124 || (runparams.isLastPar && par_lang != outer_lang));
1126 if (localswitch_needed
1127 || (intitle_command && using_begin_end)
1128 || closing_rtl_ltr_environment
1129 || ((runparams.isLastPar || close_lang_switch)
1130 && (par_lang != outer_lang || (using_begin_end
1131 && style.isEnvironment()
1132 && par_lang != nextpar_lang)))) {
1133 // Since \selectlanguage write the language to the aux file,
1134 // we need to reset the language at the end of footnote or
1137 if (!localswitch && (pending_newline || close_lang_switch))
1140 // when the paragraph uses CJK, the language has to be closed earlier
1141 if (font.language()->encoding()->package() != Encoding::CJK) {
1142 if (lang_end_command.empty()) {
1143 // If this is a child, we should restore the
1144 // master language after the last paragraph.
1145 Language const * const current_language =
1146 (runparams.isLastPar && runparams.master_language)
1147 ? runparams.master_language
1149 string const current_lang = use_polyglossia
1150 ? getPolyglossiaEnvName(current_language)
1151 : current_language->babel();
1152 if (!current_lang.empty()
1153 && current_lang != openLanguageName(state)) {
1154 string bc = use_polyglossia ?
1155 getPolyglossiaBegin(lang_begin_command, current_lang,
1156 current_language->polyglossiaOpts(),
1158 : subst(lang_begin_command, "$$lang", current_lang);
1160 pending_newline = !localswitch;
1161 unskip_newline = !localswitch;
1162 if (using_begin_end)
1163 pushLanguageName(current_lang, localswitch);
1165 } else if ((!using_begin_end ||
1166 langOpenedAtThisLevel(state)) &&
1167 !par_lang.empty()) {
1168 // If we are in an environment, we have to
1169 // close the "outer" language afterwards
1170 string const & cur_lang = openLanguageName(state);
1171 if (!style.isEnvironment()
1172 || (close_lang_switch
1173 && atSameLastLangSwitchDepth(state)
1174 && par_lang != outer_lang
1175 && (par_lang != cur_lang
1176 || (cur_lang != outer_lang
1178 && style != nextpar->layout())))
1179 || (atSameLastLangSwitchDepth(state)
1180 && state->lang_switch_depth_.size()
1181 && cur_lang != par_lang))
1183 if (using_begin_end && !localswitch)
1185 os << from_ascii(subst(
1189 pending_newline = !localswitch;
1190 unskip_newline = !localswitch;
1191 if (using_begin_end)
1197 if (closing_rtl_ltr_environment)
1200 // InTitle commands need to be closed after the language has been closed.
1201 if (intitle_command) {
1204 if (!style.postcommandargs().empty())
1205 latexArgInsets(par, os, runparams, style.postcommandargs(), "post:");
1206 if (runparams.encoding != prev_encoding) {
1207 runparams.encoding = prev_encoding;
1208 os << setEncoding(prev_encoding->iconvName());
1213 bool const last_was_separator =
1214 par.size() > 0 && par.isEnvSeparator(par.size() - 1);
1216 if (pending_newline) {
1218 // prevent unwanted whitespace
1220 if (!os.afterParbreak() && !last_was_separator)
1224 // if this is a CJK-paragraph and the next isn't, close CJK
1225 // also if the next paragraph is a multilingual environment (because of nesting)
1227 && state->open_encoding_ == CJK
1228 && (nextpar_language->encoding()->package() != Encoding::CJK
1229 || (nextpar->layout().isEnvironment() && nextpar->isMultiLingual(bparams)))
1230 // inbetween environments, CJK has to be closed later (nesting!)
1231 && (!style.isEnvironment() || !nextpar->layout().isEnvironment())) {
1232 os << "\\end{CJK}\n";
1233 state->open_encoding_ = none;
1236 // If this is the last paragraph, close the CJK environment
1237 // if necessary. If it's an environment, we'll have to \end that first.
1238 if (runparams.isLastPar && !style.isEnvironment()) {
1239 switch (state->open_encoding_) {
1241 // do nothing at the end of child documents
1242 if (maintext && buf.masterBuffer() != &buf)
1246 os << "\n\\end{CJK}\n";
1250 state->open_encoding_ = none;
1255 state->open_encoding_ = none;
1265 // If this is the last paragraph, and a local_font was set upon entering
1266 // the inset, and we're using "auto" or "default" encoding, and not
1267 // compiling with XeTeX or LuaTeX, the encoding
1268 // should be set back to that local_font's encoding.
1269 if (runparams.isLastPar && runparams_in.local_font != 0
1270 && runparams_in.encoding != runparams_in.local_font->language()->encoding()
1271 && (bparams.inputenc == "auto" || bparams.inputenc == "default")
1272 && !runparams.isFullUnicode()
1274 runparams_in.encoding = runparams_in.local_font->language()->encoding();
1275 os << setEncoding(runparams_in.encoding->iconvName());
1277 // Otherwise, the current encoding should be set for the next paragraph.
1279 runparams_in.encoding = runparams.encoding;
1282 // we don't need a newline for the last paragraph!!!
1283 // Note from JMarc: we will re-add a \n explicitly in
1284 // TeXEnvironment, because it is needed in this case
1285 if (nextpar && !os.afterParbreak() && !last_was_separator) {
1286 // Make sure to start a new line
1288 Layout const & next_layout = nextpar->layout();
1289 // A newline '\n' is always output before a command,
1290 // so avoid doubling it.
1291 if (!next_layout.isCommand()) {
1292 // Here we now try to avoid spurious empty lines by
1293 // outputting a paragraph break only if: (case 1) the
1294 // paragraph style allows parbreaks and no \begin, \end
1295 // or \item tags are going to follow (i.e., if the next
1296 // isn't the first or the current isn't the last
1297 // paragraph of an environment or itemize) and the
1298 // depth and alignment of the following paragraph is
1299 // unchanged, or (case 2) the following is a
1300 // non-environment paragraph whose depth is increased
1301 // but whose alignment is unchanged, or (case 3) the
1302 // paragraph is not an environment and the next one is a
1303 // non-itemize-like env at lower depth, or (case 4) the
1304 // paragraph is a command not followed by an environment
1305 // and the alignment of the current and next paragraph
1306 // is unchanged, or (case 5) the current alignment is
1307 // changed and a standard paragraph follows.
1308 DocumentClass const & tclass = bparams.documentClass();
1309 if ((style == next_layout
1310 && !style.parbreak_is_newline
1311 && !text.inset().getLayout().parbreakIsNewline()
1312 && style.latextype != LATEX_ITEM_ENVIRONMENT
1313 && style.latextype != LATEX_LIST_ENVIRONMENT
1314 && style.align == par.getAlign()
1315 && nextpar->getDepth() == par.getDepth()
1316 && nextpar->getAlign() == par.getAlign())
1317 || (!next_layout.isEnvironment()
1318 && nextpar->getDepth() > par.getDepth()
1319 && nextpar->getAlign() == par.getAlign())
1320 || (!style.isEnvironment()
1321 && next_layout.latextype == LATEX_ENVIRONMENT
1322 && nextpar->getDepth() < par.getDepth())
1323 || (style.isCommand()
1324 && !next_layout.isEnvironment()
1325 && style.align == par.getAlign()
1326 && next_layout.align == nextpar->getAlign())
1327 || (style.align != par.getAlign()
1328 && tclass.isDefaultLayout(next_layout))) {
1334 LYXERR(Debug::LATEX, "TeXOnePar for paragraph " << pit << " done; ptr "
1335 << &par << " next " << nextpar);
1341 // LaTeX all paragraphs
1342 void latexParagraphs(Buffer const & buf,
1345 OutputParams const & runparams,
1346 string const & everypar)
1348 LASSERT(runparams.par_begin <= runparams.par_end,
1349 { os << "% LaTeX Output Error\n"; return; } );
1351 BufferParams const & bparams = buf.params();
1352 BufferParams const & mparams = buf.masterParams();
1354 bool const maintext = text.isMainText();
1355 bool const is_child = buf.masterBuffer() != &buf;
1356 bool const multibib_child = maintext && is_child
1357 && mparams.multibib == "child";
1359 if (multibib_child && mparams.useBiblatex())
1360 os << "\\newrefsection";
1361 else if (multibib_child && mparams.useBibtopic()) {
1362 os << "\\begin{btUnit}\n";
1363 runparams.openbtUnit = true;
1366 // Open a CJK environment at the beginning of the main buffer
1367 // if the document's language is a CJK language
1368 // (but not in child documents)
1369 OutputState * state = getOutputState();
1370 if (maintext && !is_child
1371 && bparams.encoding().package() == Encoding::CJK) {
1372 os << "\\begin{CJK}{" << from_ascii(bparams.encoding().latexName())
1373 << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
1374 state->open_encoding_ = CJK;
1376 // if "auto begin" is switched off, explicitly switch the
1377 // language on at start
1378 string const mainlang = runparams.use_polyglossia
1379 ? getPolyglossiaEnvName(bparams.language)
1380 : bparams.language->babel();
1381 string const lang_begin_command = runparams.use_polyglossia ?
1382 "\\begin{$$lang}$$opts" : lyxrc.language_command_begin;
1383 string const lang_end_command = runparams.use_polyglossia ?
1384 "\\end{$$lang}" : lyxrc.language_command_end;
1385 bool const using_begin_end = runparams.use_polyglossia ||
1386 !lang_end_command.empty();
1388 if (maintext && !lyxrc.language_auto_begin &&
1389 !mainlang.empty()) {
1391 string bc = runparams.use_polyglossia ?
1392 getPolyglossiaBegin(lang_begin_command, mainlang,
1393 bparams.language->polyglossiaOpts())
1394 : subst(lang_begin_command, "$$lang", mainlang);
1397 if (using_begin_end)
1398 pushLanguageName(mainlang);
1401 ParagraphList const & paragraphs = text.paragraphs();
1403 if (runparams.par_begin == runparams.par_end) {
1404 // The full doc will be exported but it is easier to just rely on
1405 // runparams range parameters that will be passed TeXEnvironment.
1406 runparams.par_begin = 0;
1407 runparams.par_end = paragraphs.size();
1410 pit_type pit = runparams.par_begin;
1411 // lastpit is for the language check after the loop.
1412 pit_type lastpit = pit;
1413 // variables used in the loop:
1414 bool was_title = false;
1415 bool already_title = false;
1416 DocumentClass const & tclass = bparams.documentClass();
1418 // Did we already warn about inTitle layout mixing? (we only warn once)
1419 bool gave_layout_warning = false;
1420 for (; pit < runparams.par_end; ++pit) {
1422 ParagraphList::const_iterator par = paragraphs.constIterator(pit);
1424 // FIXME This check should not be needed. We should
1425 // perhaps issue an error if it is.
1426 Layout const & layout = text.inset().forcePlainLayout() ?
1427 tclass.plainLayout() : par->layout();
1429 if (layout.intitle) {
1430 if (already_title) {
1431 if (!gave_layout_warning && !runparams.dryrun) {
1432 gave_layout_warning = true;
1433 frontend::Alert::warning(_("Error in latexParagraphs"),
1434 bformat(_("You are using at least one "
1435 "layout (%1$s) intended for the title, "
1436 "after using non-title layouts. This "
1437 "could lead to missing or incorrect output."
1440 } else if (!was_title) {
1442 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1444 << from_ascii(tclass.titlename())
1448 } else if (was_title && !already_title && !layout.inpreamble) {
1449 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1450 os << "\\end{" << from_ascii(tclass.titlename())
1454 os << "\\" << from_ascii(tclass.titlename())
1457 already_title = true;
1461 if (layout.isCommand() && !layout.latexname().empty()
1462 && layout.latexname() == bparams.multibib) {
1463 if (runparams.openbtUnit)
1464 os << "\\end{btUnit}\n";
1465 if (!bparams.useBiblatex()) {
1466 os << '\n' << "\\begin{btUnit}\n";
1467 runparams.openbtUnit = true;
1471 if (!layout.isEnvironment() && par->params().leftIndent().zero()) {
1472 // This is a standard top level paragraph, TeX it and continue.
1473 TeXOnePar(buf, text, pit, os, runparams, everypar);
1477 TeXEnvironmentData const data =
1478 prepareEnvironment(buf, text, par, os, runparams);
1479 // pit can be changed in TeXEnvironment.
1480 TeXEnvironment(buf, text, runparams, pit, os);
1481 finishEnvironment(os, runparams, data);
1484 if (pit == runparams.par_end) {
1485 // Make sure that the last paragraph is
1486 // correctly terminated (because TeXOnePar does
1487 // not add a \n in this case)
1491 // It might be that we only have a title in this document
1492 if (was_title && !already_title) {
1493 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1494 os << "\\end{" << from_ascii(tclass.titlename())
1497 os << "\\" << from_ascii(tclass.titlename())
1502 if (maintext && !is_child && runparams.openbtUnit)
1503 os << "\\end{btUnit}\n";
1505 // if "auto end" is switched off, explicitly close the language at the end
1506 // but only if the last par is in a babel or polyglossia language
1507 if (maintext && !lyxrc.language_auto_end && !mainlang.empty() &&
1508 paragraphs.at(lastpit).getParLanguage(bparams)->encoding()->package() != Encoding::CJK) {
1509 os << from_utf8(subst(lang_end_command,
1513 if (using_begin_end)
1517 // If the last paragraph is an environment, we'll have to close
1518 // CJK at the very end to do proper nesting.
1519 if (maintext && !is_child && state->open_encoding_ == CJK) {
1520 os << "\\end{CJK}\n";
1521 state->open_encoding_ = none;
1523 // Likewise for polyglossia or when using begin/end commands
1524 string const & cur_lang = openLanguageName(state);
1525 if (maintext && !is_child && !cur_lang.empty()) {
1526 os << from_utf8(subst(lang_end_command,
1530 if (using_begin_end)
1534 // reset inherited encoding
1535 if (state->cjk_inherited_ > 0) {
1536 state->cjk_inherited_ -= 1;
1537 if (state->cjk_inherited_ == 0)
1538 state->open_encoding_ = CJK;
1541 if (multibib_child && mparams.useBibtopic()) {
1542 os << "\\end{btUnit}\n";
1543 runparams.openbtUnit = false;
1548 pair<bool, int> switchEncoding(odocstream & os, BufferParams const & bparams,
1549 OutputParams const & runparams, Encoding const & newEnc,
1552 // XeTeX/LuaTeX use only one encoding per document:
1553 // * with useNonTeXFonts: "utf8plain",
1554 // * with XeTeX and TeX fonts: "ascii" (inputenc fails),
1555 // * with LuaTeX and TeX fonts: only one encoding accepted by luainputenc.
1556 if (runparams.isFullUnicode() || newEnc.name() == "inherit")
1557 return make_pair(false, 0);
1559 Encoding const & oldEnc = *runparams.encoding;
1560 bool moving_arg = runparams.moving_arg;
1561 // If we switch from/to CJK, we need to switch anyway, despite custom inputenc
1562 bool const from_to_cjk =
1563 (oldEnc.package() == Encoding::CJK && newEnc.package() != Encoding::CJK)
1564 || (oldEnc.package() != Encoding::CJK && newEnc.package() == Encoding::CJK);
1565 if (!force && !from_to_cjk
1566 && ((bparams.inputenc != "auto" && bparams.inputenc != "default") || moving_arg))
1567 return make_pair(false, 0);
1569 // Do nothing if the encoding is unchanged.
1570 if (oldEnc.name() == newEnc.name())
1571 return make_pair(false, 0);
1573 // FIXME We ignore encoding switches from/to encodings that do
1574 // neither support the inputenc package nor the CJK package here.
1575 // This does of course only work in special cases (e.g. switch from
1576 // tis620-0 to latin1, but the text in latin1 contains ASCII only),
1577 // but it is the best we can do
1578 if (oldEnc.package() == Encoding::none
1579 || newEnc.package() == Encoding::none)
1580 return make_pair(false, 0);
1582 LYXERR(Debug::LATEX, "Changing LaTeX encoding from "
1583 << oldEnc.name() << " to " << newEnc.name());
1584 os << setEncoding(newEnc.iconvName());
1585 if (bparams.inputenc == "default")
1586 return make_pair(true, 0);
1588 docstring const inputenc_arg(from_ascii(newEnc.latexName()));
1589 OutputState * state = getOutputState();
1590 switch (newEnc.package()) {
1591 case Encoding::none:
1592 case Encoding::japanese:
1593 // shouldn't ever reach here, see above
1594 return make_pair(true, 0);
1595 case Encoding::inputenc: {
1596 int count = inputenc_arg.length();
1597 if (oldEnc.package() == Encoding::CJK &&
1598 state->open_encoding_ == CJK) {
1600 state->open_encoding_ = none;
1603 else if (oldEnc.package() == Encoding::inputenc &&
1604 state->open_encoding_ == inputenc) {
1606 state->open_encoding_ = none;
1609 if (runparams.local_font != 0
1610 && oldEnc.package() == Encoding::CJK) {
1611 // within insets, \inputenc switches need
1612 // to be embraced within \bgroup...\egroup;
1616 state->open_encoding_ = inputenc;
1618 // with the japanese option, inputenc is omitted.
1619 if (runparams.use_japanese)
1620 return make_pair(true, count);
1621 os << "\\inputencoding{" << inputenc_arg << '}';
1622 return make_pair(true, count + 16);
1624 case Encoding::CJK: {
1625 int count = inputenc_arg.length();
1626 if (oldEnc.package() == Encoding::CJK &&
1627 state->open_encoding_ == CJK) {
1631 if (oldEnc.package() == Encoding::inputenc &&
1632 state->open_encoding_ == inputenc) {
1636 os << "\\begin{CJK}{" << inputenc_arg << "}{"
1637 << from_ascii(bparams.fonts_cjk) << "}";
1638 state->open_encoding_ = CJK;
1639 return make_pair(true, count + 15);
1642 // Dead code to avoid a warning:
1643 return make_pair(true, 0);