]> git.lyx.org Git - lyx.git/blob - src/output_latex.cpp
db56ff608bb4391863fe33e04e262201120951ce
[lyx.git] / src / output_latex.cpp
1 /**
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.
5  *
6  * \author Lars Gullik Bjønnes
7  *
8  * Full author contact details are available in file CREDITS.
9  */
10
11 #include <config.h>
12
13 #include "output_latex.h"
14
15 #include "BiblioInfo.h"
16 #include "Buffer.h"
17 #include "BufferParams.h"
18 #include "Encoding.h"
19 #include "Font.h"
20 #include "InsetList.h"
21 #include "Language.h"
22 #include "LaTeXFeatures.h"
23 #include "Layout.h"
24 #include "LyXRC.h"
25 #include "OutputParams.h"
26 #include "Paragraph.h"
27 #include "ParagraphParameters.h"
28 #include "texstream.h"
29 #include "TextClass.h"
30
31 #include "insets/InsetBibitem.h"
32 #include "insets/InsetArgument.h"
33
34 #include "frontends/alert.h"
35
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"
43
44 #include <QThreadStorage>
45
46 #include <list>
47 #include <stack>
48
49 using namespace std;
50 using namespace lyx::support;
51
52
53 namespace lyx {
54
55 namespace {
56
57 enum OpenEncoding {
58         none,
59         inputenc,
60         CJK
61 };
62
63
64 struct OutputState
65 {
66         OutputState() : open_encoding_(none), cjk_inherited_(0),
67                 prev_env_language_(nullptr), nest_level_(0)
68         {
69         }
70         OpenEncoding open_encoding_;
71         int cjk_inherited_;
72         Language const * prev_env_language_;
73         int nest_level_;
74         stack<int> lang_switch_depth_;          // Both are always empty when
75         stack<string> open_polyglossia_lang_;   // not using polyglossia
76 };
77
78
79 OutputState * getOutputState()
80 {
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();
87 }
88
89
90 string const & openLanguageName(OutputState const * state)
91 {
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
95         // an empty string.
96
97         static string const empty;
98
99         return state->open_polyglossia_lang_.empty()
100                 ? empty
101                 : state->open_polyglossia_lang_.top();
102 }
103
104
105 bool atSameLastLangSwitchDepth(OutputState const * state)
106 {
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.
111
112         return state->lang_switch_depth_.size() == 0
113                         ? true
114                         : abs(state->lang_switch_depth_.top()) == state->nest_level_;
115 }
116
117
118 bool isLocalSwitch(OutputState const * state)
119 {
120         // Return true if the language was opened by a local command switch.
121
122         return state->lang_switch_depth_.size()
123                 && state->lang_switch_depth_.top() < 0;
124 }
125
126
127 bool langOpenedAtThisLevel(OutputState const * state)
128 {
129         // Return true if the language was opened at the current nesting level.
130
131         return state->lang_switch_depth_.size()
132                 && abs(state->lang_switch_depth_.top()) == state->nest_level_;
133 }
134
135
136 string const getPolyglossiaEnvName(Language const * lang)
137 {
138         string result = lang->polyglossia();
139         if (result == "arabic")
140                 // exceptional spelling; see polyglossia docs.
141                 result = "Arabic";
142         return result;
143 }
144
145
146 string const getPolyglossiaBegin(string const & lang_begin_command,
147                                  string const & lang, string const & opts,
148                                  bool const localswitch = false)
149 {
150         string result;
151         if (!lang.empty()) {
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);
156         }
157         string options = opts.empty() ?
158                     string() : "[" + opts + "]";
159         result = subst(result, "$$opts", options);
160
161         return result;
162 }
163
164
165 struct TeXEnvironmentData
166 {
167         bool cjk_nested;
168         Layout const * style;
169         Language const * par_language;
170         Encoding const * prev_encoding;
171         bool leftindent_open;
172 };
173
174
175 static TeXEnvironmentData prepareEnvironment(Buffer const & buf,
176                                         Text const & text,
177                                         ParagraphList::const_iterator pit,
178                                         otexstream & os,
179                                         OutputParams const & runparams)
180 {
181         TeXEnvironmentData data;
182
183         BufferParams const & bparams = buf.params();
184
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();
189
190         ParagraphList const & paragraphs = text.paragraphs();
191         ParagraphList::const_iterator const priorpit =
192                 pit == paragraphs.begin() ? pit : prev(pit, 1);
193
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()));
200
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))
208                 : doc_language;
209
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();
223
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(
231                                 lang_end_command,
232                                 "$$lang",
233                                 prev_par_lang))
234                           // the '%' is necessary to prevent unwanted whitespace
235                           << "%\n";
236                         if (using_begin_end)
237                                 popLanguageName();
238                 }
239
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)
246                                                   : doc_lang;
247
248                 if ((lang_end_command.empty() ||
249                     par_lang != doc_lang ||
250                     par_lang != cur_lang) &&
251                     !par_lang.empty()) {
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);
256                             os << bc;
257                             // the '%' is necessary to prevent unwanted whitespace
258                             os << "%\n";
259                             if (using_begin_end)
260                                     pushLanguageName(par_lang);
261                 }
262         }
263
264         data.leftindent_open = false;
265         if (!pit->params().leftIndent().zero()) {
266                 os << "\\begin{LyXParagraphLeftIndent}{"
267                    << from_ascii(pit->params().leftIndent().asLatexString())
268                    << "}\n";
269                 data.leftindent_open = true;
270         }
271
272         if (style.isEnvironment())
273                 state->nest_level_ += 1;
274
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());
281                 }
282                 if (style.latextype == LATEX_LIST_ENVIRONMENT) {
283                         os << '{'
284                            << pit->params().labelWidthString()
285                            << "}\n";
286                 } else if (style.labeltype == LABEL_BIBLIO) {
287                         if (pit->params().labelWidthString().empty())
288                                 os << '{' << bibitemWidest(buf, runparams) << "}\n";
289                         else
290                                 os << '{'
291                                   << pit->params().labelWidthString()
292                                   << "}\n";
293                 } else
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(),
301                                        "listpreamble:");
302                 }
303         }
304         data.style = &style;
305
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";
317                 }
318                 state->open_encoding_ = CJK;
319                 data.cjk_nested = true;
320         }
321         return data;
322 }
323
324
325 static void finishEnvironment(otexstream & os, OutputParams const & runparams,
326                               TeXEnvironmentData const & data)
327 {
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;
335         }
336
337         if (data.style->isEnvironment()) {
338                 os << breakln;
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)) {
346                                         os << "}";
347                                 } else {
348                                         os << "\\end{"
349                                            << openLanguageName(state)
350                                            << "}%\n";
351                                 }
352                                 popLanguageName();
353                         }
354                 }
355                 state->nest_level_ -= 1;
356                 string const & name = data.style->latexname();
357                 if (!name.empty())
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());
363                 }
364         }
365
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());
372                 }
373         }
374
375         // Check whether we should output a blank line after the environment
376         if (!data.style->nextnoindent)
377                 os << '\n';
378 }
379
380
381 void TeXEnvironment(Buffer const & buf, Text const & text,
382                     OutputParams const & runparams,
383                     pit_type & pit, otexstream & os)
384 {
385         ParagraphList const & paragraphs = text.paragraphs();
386         ParagraphList::const_iterator ipar = paragraphs.constIterator(pit);
387         LYXERR(Debug::LATEX, "TeXEnvironment for paragraph " << pit);
388
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();
392
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);
397
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);
404                 }
405                 if (go_out) {
406                         // nothing to do here, restore pit and go out.
407                         pit--;
408                         break;
409                 }
410
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);
416                         continue;
417                 }
418
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)
423
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()
429                         : par->layout();
430
431                 if (!style.isEnvironment()) {
432                         // This is a standard paragraph, no need to call TeXEnvironment.
433                         TeXOnePar(buf, text, pit, os, runparams);
434                         continue;
435                 }
436
437                 // This is a new environment.
438                 TeXEnvironmentData const data =
439                         prepareEnvironment(buf, text, par, os, runparams);
440                 // Recursive call to TeXEnvironment!
441                 TeXEnvironment(buf, text, runparams, pit, os);
442                 finishEnvironment(os, runparams, data);
443         }
444
445         if (pit != runparams.par_end)
446                 LYXERR(Debug::LATEX, "TeXEnvironment for paragraph " << par_begin << " done.");
447 }
448
449
450 void getArgInsets(otexstream & os, OutputParams const & runparams, Layout::LaTeXArgMap const & latexargs,
451                   map<int, lyx::InsetArgument const *> ilist, vector<string> required, string const & prefix)
452 {
453         unsigned int const argnr = latexargs.size();
454         if (argnr == 0)
455                 return;
456
457         // Default and preset args are always output, so if they require
458         // other arguments, consider this.
459         for (auto const & larg : latexargs) {
460                 Layout::latexarg const & arg = larg.second;
461                 if ((!arg.presetarg.empty() || !arg.defaultarg.empty()) && !arg.requires.empty()) {
462                                 vector<string> req = getVectorFromString(arg.requires);
463                                 required.insert(required.end(), req.begin(), req.end());
464                         }
465         }
466
467         for (unsigned int i = 1; i <= argnr; ++i) {
468                 map<int, InsetArgument const *>::const_iterator lit = ilist.find(i);
469                 bool inserted = false;
470                 if (lit != ilist.end()) {
471                         InsetArgument const * ins = (*lit).second;
472                         if (ins) {
473                                 Layout::LaTeXArgMap::const_iterator const lait =
474                                                 latexargs.find(ins->name());
475                                 if (lait != latexargs.end()) {
476                                         Layout::latexarg arg = (*lait).second;
477                                         docstring ldelim;
478                                         docstring rdelim;
479                                         if (!arg.nodelims) {
480                                                 ldelim = arg.mandatory ?
481                                                         from_ascii("{") : from_ascii("[");
482                                                 rdelim = arg.mandatory ?
483                                                         from_ascii("}") : from_ascii("]");
484                                         }
485                                         if (!arg.ldelim.empty())
486                                                 ldelim = arg.ldelim;
487                                         if (!arg.rdelim.empty())
488                                                 rdelim = arg.rdelim;
489                                         ins->latexArgument(os, runparams, ldelim, rdelim, arg.presetarg);
490                                         if (prefix == "listpreamble:")
491                                                 os << breakln;
492                                         inserted = true;
493                                 }
494                         }
495                 }
496                 if (!inserted) {
497                         Layout::LaTeXArgMap::const_iterator lait = latexargs.begin();
498                         Layout::LaTeXArgMap::const_iterator const laend = latexargs.end();
499                         for (; lait != laend; ++lait) {
500                                 string const name = prefix + convert<string>(i);
501                                 if ((*lait).first == name) {
502                                         Layout::latexarg arg = (*lait).second;
503                                         docstring preset = arg.presetarg;
504                                         if (!arg.defaultarg.empty()) {
505                                                 if (!preset.empty())
506                                                         preset += ",";
507                                                 preset += arg.defaultarg;
508                                         }
509                                         if (arg.mandatory) {
510                                                 docstring ldelim = arg.ldelim.empty() ?
511                                                                 from_ascii("{") : arg.ldelim;
512                                                 docstring rdelim = arg.rdelim.empty() ?
513                                                                 from_ascii("}") : arg.rdelim;
514                                                 os << ldelim << preset << rdelim;
515                                         } else if (!preset.empty()) {
516                                                 docstring ldelim = arg.ldelim.empty() ?
517                                                                 from_ascii("[") : arg.ldelim;
518                                                 docstring rdelim = arg.rdelim.empty() ?
519                                                                 from_ascii("]") : arg.rdelim;
520                                                 os << ldelim << preset << rdelim;
521                                         } else if (find(required.begin(), required.end(),
522                                                    (*lait).first) != required.end()) {
523                                                 docstring ldelim = arg.ldelim.empty() ?
524                                                                 from_ascii("[") : arg.ldelim;
525                                                 docstring rdelim = arg.rdelim.empty() ?
526                                                                 from_ascii("]") : arg.rdelim;
527                                                 os << ldelim << rdelim;
528                                         } else
529                                                 break;
530                                 }
531                         }
532                 }
533         }
534         if (runparams.for_search) {
535                 // Mark end of arguments for findadv() only
536                 os << "\\endarguments{}";
537         }
538 }
539
540
541 } // namespace
542
543
544 void pushLanguageName(string const & lang_name, bool localswitch)
545 {
546         OutputState * state = getOutputState();
547
548         int nest_level = localswitch ? -state->nest_level_ : state->nest_level_;
549         state->lang_switch_depth_.push(nest_level);
550         state->open_polyglossia_lang_.push(lang_name);
551 }
552
553
554 void popLanguageName()
555 {
556         OutputState * state = getOutputState();
557
558         state->lang_switch_depth_.pop();
559         state->open_polyglossia_lang_.pop();
560 }
561
562
563 string const & openLanguageName()
564 {
565         OutputState * state = getOutputState();
566
567         return openLanguageName(state);
568 }
569
570
571 namespace {
572
573 void addArgInsets(Paragraph const & par, string const & prefix,
574                  Layout::LaTeXArgMap const & latexargs,
575                  map<int, InsetArgument const *> & ilist,
576                  vector<string> & required)
577 {
578         for (auto const & table : par.insetList()) {
579                 InsetArgument const * arg = table.inset->asInsetArgument();
580                 if (!arg)
581                         continue;
582                 if (arg->name().empty()) {
583                         LYXERR0("Error: Unnamed argument inset!");
584                         continue;
585                 }
586                 string const name = prefix.empty() ?
587                         arg->name() : split(arg->name(), ':');
588                 // why converting into an integer?
589                 unsigned int const nr = convert<unsigned int>(name);
590                 if (ilist.find(nr) == ilist.end())
591                         ilist[nr] = arg;
592                 Layout::LaTeXArgMap::const_iterator const lit =
593                         latexargs.find(arg->name());
594                 if (lit != latexargs.end()) {
595                         Layout::latexarg const & larg = lit->second;
596                         vector<string> req = getVectorFromString(larg.requires);
597                         move(req.begin(), req.end(), back_inserter(required));
598                 }
599         }
600 }
601
602 } // namespace
603
604
605 void latexArgInsets(Paragraph const & par, otexstream & os,
606                     OutputParams const & runparams,
607                     Layout::LaTeXArgMap const & latexargs,
608                     string const & prefix)
609 {
610         map<int, InsetArgument const *> ilist;
611         vector<string> required;
612         addArgInsets(par, prefix, latexargs, ilist, required);
613         getArgInsets(os, runparams, latexargs, ilist, required, prefix);
614 }
615
616
617 void latexArgInsets(ParagraphList const & pars,
618                     ParagraphList::const_iterator pit,
619                     otexstream & os, OutputParams const & runparams,
620                     Layout::LaTeXArgMap const & latexargs,
621                     string const & prefix)
622 {
623         map<int, InsetArgument const *> ilist;
624         vector<string> required;
625
626         depth_type const current_depth = pit->params().depth();
627         Layout const current_layout = pit->layout();
628
629         // get the first paragraph in sequence with this layout and depth
630         pit_type offset = 0;
631         while (true) {
632                 if (lyx::prev(pit, offset) == pars.begin())
633                         break;
634                 ParagraphList::const_iterator priorpit = lyx::prev(pit, offset + 1);
635                 if (priorpit->layout() == current_layout
636                     && priorpit->params().depth() == current_depth)
637                         ++offset;
638                 else
639                         break;
640         }
641
642         ParagraphList::const_iterator spit = lyx::prev(pit, offset);
643
644         for (; spit != pars.end(); ++spit) {
645                 if (spit->layout() != current_layout ||
646                     spit->params().depth() < current_depth)
647                         break;
648                 if (spit->params().depth() > current_depth)
649                         continue;
650                 addArgInsets(*spit, prefix, latexargs, ilist, required);
651         }
652         getArgInsets(os, runparams, latexargs, ilist, required, prefix);
653 }
654
655
656 void latexArgInsetsForParent(ParagraphList const & pars, otexstream & os,
657                              OutputParams const & runparams,
658                              Layout::LaTeXArgMap const & latexargs,
659                              string const & prefix)
660 {
661         map<int, InsetArgument const *> ilist;
662         vector<string> required;
663
664         for (Paragraph const & par : pars) {
665                 if (par.layout().hasArgs())
666                         // The InsetArguments inside this paragraph refer to this paragraph
667                         continue;
668                 addArgInsets(par, prefix, latexargs, ilist, required);
669         }
670         getArgInsets(os, runparams, latexargs, ilist, required, prefix);
671 }
672
673
674 namespace {
675
676 // output the proper paragraph start according to latextype.
677 void parStartCommand(Paragraph const & par, otexstream & os,
678                      OutputParams const & runparams, Layout const & style)
679 {
680         switch (style.latextype) {
681         case LATEX_COMMAND:
682                 if (par.needsCProtection(runparams.moving_arg)) {
683                         if (contains(runparams.active_chars, '^'))
684                                 // cprotect relies on ^ being on catcode 7
685                                 os << "\\begingroup\\catcode`\\^=7";
686                         os << "\\cprotect";
687                 }
688                 os << '\\' << from_ascii(style.latexname());
689
690                 // Command arguments
691                 if (!style.latexargs().empty())
692                         latexArgInsets(par, os, runparams, style.latexargs());
693                 os << from_ascii(style.latexparam());
694                 break;
695         case LATEX_ITEM_ENVIRONMENT:
696         case LATEX_LIST_ENVIRONMENT:
697                 if (runparams.for_search) {
698                         os << "\\" + style.itemcommand() << "{" << style.latexname() << "}";
699                 }
700                 else {
701                         os << "\\" + style.itemcommand();
702                         // Item arguments
703                         if (!style.itemargs().empty())
704                                 latexArgInsets(par, os, runparams, style.itemargs(), "item:");
705                         os << " ";
706                 }
707                 break;
708         case LATEX_ENVIRONMENT:
709                 if (runparams.for_search) {
710                         os << "\\latexenvironment{" << style.latexname() << "}{";
711                 }
712                 break;
713         case LATEX_BIB_ENVIRONMENT:
714                 // ignore this, the inset will write itself
715                 break;
716         default:
717                 break;
718         }
719 }
720
721 } // namespace
722
723 // FIXME: this should be anonymous
724 void TeXOnePar(Buffer const & buf,
725                Text const & text,
726                pit_type pit,
727                otexstream & os,
728                OutputParams const & runparams_in,
729                string const & everypar,
730                int start_pos, int end_pos,
731                bool const force)
732 {
733         BufferParams const & bparams = runparams_in.is_child
734                 ? buf.masterParams() : buf.params();
735         ParagraphList const & paragraphs = text.paragraphs();
736         Paragraph const & par = paragraphs.at(pit);
737         // FIXME This check should not really be needed.
738         // Perhaps we should issue an error if it is.
739         Layout const & style = text.inset().forcePlainLayout() ?
740                 bparams.documentClass().plainLayout() : par.layout();
741
742         if (style.inpreamble && !force)
743                 return;
744
745         LYXERR(Debug::LATEX, "TeXOnePar for paragraph " << pit << " ptr " << &par << " '"
746                 << everypar << "'");
747
748         OutputParams runparams = runparams_in;
749         runparams.isLastPar = (pit == pit_type(paragraphs.size() - 1));
750         // We reinitialize par begin and end to be on the safe side
751         // with embedded inset as we don't know if they set those
752         // value correctly.
753         runparams.par_begin = 0;
754         runparams.par_end = 0;
755
756         bool const maintext = text.isMainText();
757         // we are at the beginning of an inset and CJK is already open;
758         // we count inheritation levels to get the inset nesting right.
759         OutputState * state = getOutputState();
760         if (pit == 0 && !maintext
761             && (state->cjk_inherited_ > 0 || state->open_encoding_ == CJK)) {
762                 state->cjk_inherited_ += 1;
763                 state->open_encoding_ = none;
764         }
765
766         if (text.inset().isPassThru()) {
767                 Font const outerfont = text.outerFont(pit);
768
769                 // No newline before first paragraph in this lyxtext
770                 if (pit > 0 && !text.inset().getLayout().parbreakIgnored()) {
771                         os << '\n';
772                         if (!text.inset().getLayout().parbreakIsNewline())
773                                 os << '\n';
774                 }
775
776                 par.latex(bparams, outerfont, os, runparams, start_pos, end_pos, force);
777                 return;
778         }
779
780         Paragraph const * nextpar = runparams.isLastPar
781                 ? nullptr : &paragraphs.at(pit + 1);
782
783         bool const intitle_command = style.intitle && style.isCommand();
784         // Intitle commands switch languages locally, thus increase
785         // language nesting level
786         if (intitle_command)
787                 state->nest_level_ += 1;
788
789         if (style.pass_thru) {
790                 Font const outerfont = text.outerFont(pit);
791                 parStartCommand(par, os, runparams, style);
792                 if (style.isCommand() && style.needprotect)
793                         // Due to the moving argument, some fragile
794                         // commands (labels, index entries)
795                         // are output after this command (#2154)
796                         runparams.postpone_fragile_stuff = true;
797                 if (intitle_command)
798                         os << '{';
799
800                 par.latex(bparams, outerfont, os, runparams, start_pos, end_pos, force);
801
802                 // I did not create a parEndCommand for this minuscule
803                 // task because in the other user of parStartCommand
804                 // the code is different (JMarc)
805                 if (style.isCommand()) {
806                         os << "}";
807                         if (par.needsCProtection(runparams.moving_arg)
808                             && contains(runparams.active_chars, '^'))
809                                 os << "\\endgroup";
810                         os << "\n";
811                 }
812                 else
813                         os << '\n';
814                 if (!style.parbreak_is_newline) {
815                         os << '\n';
816                 } else if (nextpar && !style.isEnvironment()) {
817                         Layout const nextstyle = text.inset().forcePlainLayout()
818                                 ? bparams.documentClass().plainLayout()
819                                 : nextpar->layout();
820                         if (nextstyle.name() != style.name())
821                                 os << '\n';
822                 }
823
824                 return;
825         }
826
827         // This paragraph's language
828         Language const * const par_language = par.getParLanguage(bparams);
829         Language const * const nextpar_language = nextpar ?
830                 nextpar->getParLanguage(bparams) : nullptr;
831         // The document's language
832         Language const * const doc_language = bparams.language;
833         // The language that was in effect when the environment this paragraph is
834         // inside of was opened
835         Language const * const outer_language =
836                 (runparams.local_font != nullptr) ?
837                         runparams.local_font->language() : doc_language;
838
839         Paragraph const * priorpar = (pit == 0) ? nullptr : &paragraphs.at(pit - 1);
840
841         // The previous language that was in effect is the language of the
842         // previous paragraph, unless the previous paragraph is inside an
843         // environment with nesting depth greater than (or equal to, but with
844         // a different layout) the current one. If there is no previous
845         // paragraph, the previous language is the outer language.
846         // Note further that we take the outer language also if the prior par
847         // is PassThru, since in that case it has latex_language, and all secondary
848         // languages have been closed (#10793).
849         bool const use_prev_env_language = state->prev_env_language_ != nullptr
850                         && priorpar
851                         && priorpar->layout().isEnvironment()
852                         && (priorpar->getDepth() > par.getDepth()
853                             || (priorpar->getDepth() == par.getDepth()
854                                 && priorpar->layout() != par.layout()));
855
856         // We need to ignore previous intitle commands since languages
857         // are switched locally there (# 11514)
858         // There might be paragraphs before the title, so we check this.
859         Paragraph * prior_nontitle_par = nullptr;
860         if (!intitle_command) {
861                 pit_type ppit = pit;
862                 while (ppit > 0) {
863                         --ppit;
864                         Paragraph const * tmppar = &paragraphs.at(ppit);
865                         if (tmppar->layout().intitle && tmppar->layout().isCommand())
866                                 continue;
867                         prior_nontitle_par = const_cast<Paragraph*>(tmppar);
868                         break;
869                 }
870         }
871         Language const * const prev_language =
872                 runparams_in.for_search 
873                         ? languages.getLanguage("ignore")
874                         : (prior_nontitle_par && !prior_nontitle_par->isPassThru())
875                                 ? (use_prev_env_language 
876                                         ? state->prev_env_language_
877                                         : prior_nontitle_par->getParLanguage(bparams))
878                                 : outer_language;
879
880         bool const use_polyglossia = runparams.use_polyglossia;
881         string const par_lang = use_polyglossia ?
882                 getPolyglossiaEnvName(par_language): par_language->babel();
883         string const prev_lang = use_polyglossia ?
884                 getPolyglossiaEnvName(prev_language) : prev_language->babel();
885         string const outer_lang = use_polyglossia ?
886                 getPolyglossiaEnvName(outer_language) : outer_language->babel();
887         string const nextpar_lang = nextpar_language ? (use_polyglossia ?
888                 getPolyglossiaEnvName(nextpar_language) :
889                 nextpar_language->babel()) : string();
890         string lang_begin_command = use_polyglossia ?
891                 "\\begin{$$lang}$$opts" : lyxrc.language_command_begin;
892         string lang_end_command = use_polyglossia ?
893                 "\\end{$$lang}" : lyxrc.language_command_end;
894         // the '%' is necessary to prevent unwanted whitespace
895         string lang_command_termination = "%\n";
896         bool const using_begin_end = use_polyglossia ||
897                                         !lang_end_command.empty();
898
899         // For InTitle commands, we need to switch the language inside the command
900         // (see #10849); thus open the command here.
901         if (intitle_command) {
902                 parStartCommand(par, os, runparams, style);
903                 if (style.isCommand() && style.needprotect)
904                         // Due to the moving argument, some fragile
905                         // commands (labels, index entries)
906                         // are output after this command (#2154)
907                         runparams.postpone_fragile_stuff = true;
908                 os << '{';
909         }
910
911         // In some insets (such as Arguments), we cannot use \selectlanguage.
912         // Also, if an RTL language is set via environment in polyglossia,
913         // only a nested \\text<lang> command will reset the direction for LTR
914         // languages (see # 10111).
915         bool const in_polyglossia_rtl_env =
916                 use_polyglossia
917                 && runparams.local_font != nullptr
918                 && outer_language->rightToLeft()
919                 && !par_language->rightToLeft();
920         bool const localswitch =
921                         (runparams_in.for_search
922                         || text.inset().forceLocalFontSwitch()
923                         || (using_begin_end && text.inset().forcePlainLayout())
924                         || in_polyglossia_rtl_env)
925                         && !text.inset().forceParDirectionSwitch();
926         if (localswitch) {
927                 lang_begin_command = use_polyglossia ?
928                             "\\text$$lang$$opts{" : lyxrc.language_command_local;
929                 lang_end_command = "}";
930                 lang_command_termination.clear();
931         }
932
933         bool const localswitch_needed = localswitch && par_lang != outer_lang;
934
935         // localswitches need to be closed and reopened at each par
936         if (runparams_in.for_search || ((par_lang != prev_lang || localswitch_needed)
937              // check if we already put language command in TeXEnvironment()
938              && !(style.isEnvironment()
939                   && (pit == 0 || (priorpar->layout() != par.layout()
940                                    && priorpar->getDepth() <= par.getDepth())
941                       || priorpar->getDepth() < par.getDepth())))) {
942                 if (!localswitch
943                     && (!using_begin_end || langOpenedAtThisLevel(state))
944                     && !lang_end_command.empty()
945                     && prev_lang != outer_lang
946                     && !prev_lang.empty()
947                     && (!using_begin_end || !style.isEnvironment())) {
948                         os << from_ascii(subst(lang_end_command,
949                                                "$$lang",
950                                                prev_lang))
951                            << lang_command_termination;
952                         if (using_begin_end)
953                                 popLanguageName();
954                 }
955
956                 // We need to open a new language if we couldn't close the previous
957                 // one (because there's no language_command_end); and even if we closed
958                 // the previous one, if the current language is different than the
959                 // outer_language (which is currently in effect once the previous one
960                 // is closed).
961                 if ((lang_end_command.empty() || par_lang != outer_lang
962                      || (!using_begin_end
963                          || (style.isEnvironment() && par_lang != prev_lang)))
964                         && !par_lang.empty()) {
965                         // If we're inside an inset, and that inset is within an \L or \R
966                         // (or equivalents), then within the inset, too, any opposite
967                         // language paragraph should appear within an \L or \R (in addition
968                         // to, outside of, the normal language switch commands).
969                         // This behavior is not correct for ArabTeX, though.
970                         if (!using_begin_end
971                             // not for ArabTeX
972                             && par_language->lang() != "arabic_arabtex"
973                             && outer_language->lang() != "arabic_arabtex"
974                             // are we in an inset?
975                             && runparams.local_font != nullptr
976                             // is the inset within an \L or \R?
977                             //
978                             // FIXME: currently, we don't check this; this means that
979                             // we'll have unnnecessary \L and \R commands, but that
980                             // doesn't seem to hurt (though latex will complain)
981                             //
982                             // is this paragraph in the opposite direction?
983                             && runparams.local_font->isRightToLeft() != par_language->rightToLeft()) {
984                                 // FIXME: I don't have a working copy of the Arabi package, so
985                                 // I'm not sure if the farsi and arabic_arabi stuff is correct
986                                 // or not...
987                                 if (par_language->lang() == "farsi")
988                                         os << "\\textFR{";
989                                 else if (outer_language->lang() == "farsi")
990                                         os << "\\textLR{";
991                                 else if (par_language->lang() == "arabic_arabi")
992                                         os << "\\textAR{";
993                                 else if (outer_language->lang() == "arabic_arabi")
994                                         os << "\\textLR{";
995                                 // remaining RTL languages currently is hebrew
996                                 else if (par_language->rightToLeft())
997                                         os << "\\R{";
998                                 else
999                                         os << "\\L{";
1000                         }
1001                         // With CJK, the CJK tag has to be closed first (see below)
1002                         if ((runparams.encoding->package() != Encoding::CJK
1003                                  || bparams.useNonTeXFonts
1004                                  || runparams.for_search)
1005                             && (par_lang != openLanguageName(state) || localswitch || intitle_command)
1006                             && !par_lang.empty()) {
1007                                 string bc = use_polyglossia ?
1008                                           getPolyglossiaBegin(lang_begin_command, par_lang,
1009                                                               par_language->polyglossiaOpts(),
1010                                                               localswitch)
1011                                           : subst(lang_begin_command, "$$lang", par_lang);
1012                                 os << bc;
1013                                 os << lang_command_termination;
1014                                 if (using_begin_end)
1015                                         pushLanguageName(par_lang, localswitch);
1016                         }
1017                 }
1018         }
1019
1020         // Switch file encoding if necessary; no need to do this for "auto-legacy-plain"
1021         // encoding, since this only affects the position of the outputted
1022         // \inputencoding command; the encoding switch will occur when necessary
1023         if (bparams.inputenc == "auto-legacy"
1024                 && !runparams.isFullUnicode() // Xe/LuaTeX use one document-wide encoding  (see also switchEncoding())
1025                 && runparams.encoding->package() != Encoding::japanese
1026                 && runparams.encoding->package() != Encoding::none) {
1027                 // Look ahead for future encoding changes.
1028                 // We try to output them at the beginning of the paragraph,
1029                 // since the \inputencoding command is not allowed e.g. in
1030                 // sections. For this reason we only set runparams.moving_arg
1031                 // after checking for the encoding change, otherwise the
1032                 // change would be always avoided by switchEncoding().
1033                 for (pos_type i = 0; i < par.size(); ++i) {
1034                         char_type const c = par.getChar(i);
1035                         Encoding const * const encoding =
1036                                 par.getFontSettings(bparams, i).language()->encoding();
1037                         if (encoding->package() != Encoding::CJK
1038                                 && runparams.encoding->package() == Encoding::inputenc
1039                                 && isASCII(c))
1040                                 continue;
1041                         if (par.isInset(i))
1042                                 break;
1043                         // All characters before c are in the ASCII range, and
1044                         // c is non-ASCII (but no inset), so change the
1045                         // encoding to that required by the language of c.
1046                         // With CJK, only add switch if we have CJK content at the beginning
1047                         // of the paragraph
1048                         if (i != 0 && encoding->package() == Encoding::CJK)
1049                                 continue;
1050
1051                         pair<bool, int> enc_switch = switchEncoding(os.os(),
1052                                                 bparams, runparams, *encoding);
1053                         // the following is necessary after a CJK environment in a multilingual
1054                         // context (nesting issue).
1055                         if (par_language->encoding()->package() == Encoding::CJK
1056                                 && state->open_encoding_ != CJK && state->cjk_inherited_ == 0) {
1057                                 os << "\\begin{CJK}{"
1058                                    << from_ascii(par_language->encoding()->latexName())
1059                                    << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
1060                                 state->open_encoding_ = CJK;
1061                         }
1062                         if (encoding->package() != Encoding::none && enc_switch.first) {
1063                                 if (enc_switch.second > 0) {
1064                                         // the '%' is necessary to prevent unwanted whitespace
1065                                         os << "%\n";
1066                                 }
1067                                 // With CJK, the CJK tag had to be closed first (see above)
1068                                 if (runparams.encoding->package() == Encoding::CJK
1069                                     && par_lang != openLanguageName(state)
1070                                     && !par_lang.empty()) {
1071                                         os << subst(lang_begin_command, "$$lang", par_lang)
1072                                            << lang_command_termination;
1073                                         if (using_begin_end)
1074                                                 pushLanguageName(par_lang, localswitch);
1075                                 }
1076                                 runparams.encoding = encoding;
1077                         }
1078                         break;
1079                 }
1080         }
1081
1082         runparams.moving_arg |= style.needprotect;
1083         if (style.needmboxprotect)
1084                 ++runparams.inulemcmd;
1085         Encoding const * const prev_encoding = runparams.encoding;
1086
1087         bool const useSetSpace = bparams.documentClass().provides("SetSpace");
1088         if (par.allowParagraphCustomization()) {
1089                 if (par.params().startOfAppendix()) {
1090                         os << "\n\\appendix\n";
1091                 }
1092
1093                 // InTitle commands must use switches (not environments)
1094                 // inside the commands (see #9332)
1095                 if (style.intitle) {
1096                         if (!par.params().spacing().isDefault())
1097                         {
1098                                 if (runparams.moving_arg)
1099                                         os << "\\protect";
1100                                 os << from_ascii(par.params().spacing().writeCmd(useSetSpace));
1101                         }
1102                 } else {
1103                         if (!par.params().spacing().isDefault()
1104                                 && (pit == 0 || !priorpar->hasSameLayout(par)))
1105                         {
1106                                 os << from_ascii(par.params().spacing().writeEnvirBegin(useSetSpace))
1107                                     << '\n';
1108                         }
1109
1110                         if (style.isCommand()) {
1111                                 os << '\n';
1112                         }
1113                 }
1114         }
1115
1116         // For InTitle commands, we already started the command before
1117         // the language switch
1118         if (!intitle_command) {
1119                 parStartCommand(par, os, runparams, style);
1120                 if (style.isCommand() && style.needprotect)
1121                         // Due to the moving argument, some fragile
1122                         // commands (labels, index entries)
1123                         // are output after this command (#2154)
1124                         runparams.postpone_fragile_stuff = true;
1125         }
1126
1127         Font const outerfont = text.outerFont(pit);
1128
1129         // FIXME UNICODE
1130         os << from_utf8(everypar);
1131         par.latex(bparams, outerfont, os, runparams, start_pos, end_pos, force);
1132
1133         Font const font = par.empty()
1134                  ? par.getLayoutFont(bparams, outerfont)
1135                  : par.getFont(bparams, par.size() - 1, outerfont);
1136
1137         bool const is_command = style.isCommand();
1138
1139         // InTitle commands need to be closed after the language has been closed.
1140         if (!intitle_command) {
1141                 if (is_command) {
1142                         os << '}';
1143                         if (!style.postcommandargs().empty())
1144                                 latexArgInsets(par, os, runparams, style.postcommandargs(), "post:");
1145                         if (!runparams.post_macro.empty()) {
1146                                 // Output the stored fragile commands (labels, indices etc.)
1147                                 // that need to be output after the command with moving argument.
1148                                 os << runparams.post_macro;
1149                                 runparams.post_macro.clear();
1150                         }
1151                         if (par.needsCProtection(runparams.moving_arg)
1152                             && contains(runparams.active_chars, '^'))
1153                                 os << "\\endgroup";
1154                         if (runparams.encoding != prev_encoding) {
1155                                 runparams.encoding = prev_encoding;
1156                                 os << setEncoding(prev_encoding->iconvName());
1157                         }
1158                 }
1159         }
1160
1161         bool pending_newline = false;
1162         bool unskip_newline = false;
1163         bool close_lang_switch = false;
1164         switch (style.latextype) {
1165         case LATEX_ITEM_ENVIRONMENT:
1166         case LATEX_LIST_ENVIRONMENT:
1167                 if ((nextpar && par_lang != nextpar_lang
1168                              && nextpar->getDepth() == par.getDepth())
1169                     || (atSameLastLangSwitchDepth(state) && nextpar
1170                             && nextpar->getDepth() < par.getDepth()))
1171                         close_lang_switch = using_begin_end;
1172                 if (nextpar && par.params().depth() < nextpar->params().depth())
1173                         pending_newline = !text.inset().getLayout().parbreakIgnored();
1174                 break;
1175         case LATEX_ENVIRONMENT: {
1176                 // if it's the last paragraph of the current environment
1177                 // skip it otherwise fall through
1178                 if (nextpar
1179                     && ((nextpar->layout() != par.layout()
1180                            || nextpar->params().depth() != par.params().depth())
1181                         || (!using_begin_end || par_lang != nextpar_lang)))
1182                 {
1183                         close_lang_switch = using_begin_end;
1184                         break;
1185                 }
1186         }
1187         // possible
1188         // fall through
1189         default:
1190                 // we don't need it for the last paragraph and in InTitle commands!!!
1191                 if (nextpar && !intitle_command)
1192                         pending_newline = !text.inset().getLayout().parbreakIgnored();
1193         }
1194
1195         // InTitle commands use switches (not environments) for space settings
1196         if (par.allowParagraphCustomization() && !style.intitle) {
1197                 if (!par.params().spacing().isDefault()
1198                         && (runparams.isLastPar || !nextpar->hasSameLayout(par))) {
1199                         if (pending_newline)
1200                                 os << '\n';
1201
1202                         string const endtag =
1203                                 par.params().spacing().writeEnvirEnd(useSetSpace);
1204                         if (prefixIs(endtag, "\\end{"))
1205                                 os << breakln;
1206
1207                         os << from_ascii(endtag);
1208                         pending_newline = true;
1209                 }
1210         }
1211
1212         // Closing the language is needed for the last paragraph in a given language
1213         // as well as for any InTitleCommand (since these set the language locally);
1214         // it is also needed if we're within an \L or \R that we may have opened above
1215         // (not necessarily in this paragraph) and are about to close.
1216         bool closing_rtl_ltr_environment = !using_begin_end
1217                 // not for ArabTeX
1218                 && (par_language->lang() != "arabic_arabtex"
1219                     && outer_language->lang() != "arabic_arabtex")
1220                 // have we opened an \L or \R environment?
1221                 && runparams.local_font != nullptr
1222                 && runparams.local_font->isRightToLeft() != par_language->rightToLeft()
1223                 // are we about to close the language?
1224                 &&((nextpar && par_lang != nextpar_lang)
1225                    || (runparams.isLastPar && par_lang != outer_lang));
1226
1227         if (localswitch_needed
1228             || (intitle_command && using_begin_end)
1229             || closing_rtl_ltr_environment
1230             || (((runparams.isLastPar && !runparams.inbranch) || close_lang_switch)
1231                 && (par_lang != outer_lang || (using_begin_end
1232                                                 && style.isEnvironment()
1233                                                 && par_lang != nextpar_lang)))) {
1234                 // Since \selectlanguage write the language to the aux file,
1235                 // we need to reset the language at the end of footnote or
1236                 // float.
1237
1238                 if (!localswitch && (pending_newline || close_lang_switch))
1239                         os << '\n';
1240
1241                 // when the paragraph uses CJK, the language has to be closed earlier
1242                 if ((font.language()->encoding()->package() != Encoding::CJK)
1243                         || bparams.useNonTeXFonts
1244                         || runparams_in.for_search) {
1245                         if (lang_end_command.empty()) {
1246                                 // If this is a child, we should restore the
1247                                 // master language after the last paragraph.
1248                                 Language const * const current_language =
1249                                         (runparams.isLastPar && runparams.master_language)
1250                                                 ? runparams.master_language
1251                                                 : outer_language;
1252                                 string const current_lang = use_polyglossia
1253                                         ? getPolyglossiaEnvName(current_language)
1254                                         : current_language->babel();
1255                                 if (!current_lang.empty()
1256                                     && current_lang != openLanguageName(state)) {
1257                                         string bc = use_polyglossia ?
1258                                                     getPolyglossiaBegin(lang_begin_command, current_lang,
1259                                                                         current_language->polyglossiaOpts(),
1260                                                                         localswitch)
1261                                                   : subst(lang_begin_command, "$$lang", current_lang);
1262                                         os << bc;
1263                                         pending_newline = !localswitch
1264                                                         && !text.inset().getLayout().parbreakIgnored();
1265                                         unskip_newline = !localswitch;
1266                                         if (using_begin_end)
1267                                                 pushLanguageName(current_lang, localswitch);
1268                                 }
1269                         } else if ((!using_begin_end ||
1270                                     langOpenedAtThisLevel(state)) &&
1271                                    !par_lang.empty()) {
1272                                 // If we are in an environment, we have to
1273                                 // close the "outer" language afterwards
1274                                 string const & cur_lang = openLanguageName(state);
1275                                 if (!style.isEnvironment()
1276                                     || (close_lang_switch
1277                                         && atSameLastLangSwitchDepth(state)
1278                                         && par_lang != outer_lang
1279                                         && (par_lang != cur_lang
1280                                             || (cur_lang != outer_lang
1281                                                 && nextpar
1282                                                 && style != nextpar->layout())))
1283                                     || (atSameLastLangSwitchDepth(state)
1284                                         && state->lang_switch_depth_.size()
1285                                         && cur_lang != par_lang)
1286                                     || in_polyglossia_rtl_env)
1287                                 {
1288                                         if (using_begin_end && !localswitch)
1289                                                 os << breakln;
1290                                         os << from_ascii(subst(
1291                                                 lang_end_command,
1292                                                 "$$lang",
1293                                                 par_lang));
1294                                         pending_newline = !localswitch
1295                                                         && !text.inset().getLayout().parbreakIgnored();
1296                                         unskip_newline = !localswitch;
1297                                         if (using_begin_end)
1298                                                 popLanguageName();
1299                                 }
1300                         }
1301                 }
1302         }
1303         if (closing_rtl_ltr_environment)
1304                 os << "}";
1305
1306         // InTitle commands need to be closed after the language has been closed.
1307         if (intitle_command) {
1308                 os << '}';
1309                 if (!style.postcommandargs().empty())
1310                         latexArgInsets(par, os, runparams, style.postcommandargs(), "post:");
1311                 if (!runparams.post_macro.empty()) {
1312                         // Output the stored fragile commands (labels, indices etc.)
1313                         // that need to be output after the command with moving argument.
1314                         os << runparams.post_macro;
1315                         runparams.post_macro.clear();
1316                 }
1317                 if (par.needsCProtection(runparams.moving_arg)
1318                     && contains(runparams.active_chars, '^'))
1319                         os << "\\endgroup";
1320                 if (runparams.encoding != prev_encoding) {
1321                         runparams.encoding = prev_encoding;
1322                         os << setEncoding(prev_encoding->iconvName());
1323                 }
1324         }
1325
1326         bool const last_was_separator =
1327                 par.size() > 0 && par.isEnvSeparator(par.size() - 1);
1328
1329         if (pending_newline) {
1330                 if (unskip_newline)
1331                         // prevent unwanted whitespace
1332                         os << '%';
1333                 if (!os.afterParbreak() && !last_was_separator)
1334                         os << '\n';
1335         }
1336
1337         // if this is a CJK-paragraph and the next isn't, close CJK
1338         // also if the next paragraph is a multilingual environment (because of nesting)
1339         if (nextpar && state->open_encoding_ == CJK
1340                 && bparams.encoding().iconvName() != "UTF-8"
1341                 && bparams.encoding().package() != Encoding::CJK
1342                 && (nextpar_language->encoding()->package() != Encoding::CJK
1343                         || (nextpar->layout().isEnvironment() && nextpar->isMultiLingual(bparams)))
1344                 // inbetween environments, CJK has to be closed later (nesting!)
1345                 && (!style.isEnvironment() || !nextpar->layout().isEnvironment())) {
1346                 os << "\\end{CJK}\n";
1347                 state->open_encoding_ = none;
1348         }
1349
1350         // If this is the last paragraph, close the CJK environment
1351         // if necessary. If it's an environment or nested in an environment,
1352         // we'll have to \end that first.
1353         if (runparams.isLastPar && !style.isEnvironment()
1354                 && par.params().depth() < 1) {
1355                 switch (state->open_encoding_) {
1356                         case CJK: {
1357                                 // do nothing at the end of child documents
1358                                 if (maintext && buf.masterBuffer() != &buf)
1359                                         break;
1360                                 // end of main text: also insert a \clearpage (see #5386)
1361                                 if (maintext) {
1362                                         os << "\n\\clearpage\n\\end{CJK}\n";
1363                                 // end of an inset
1364                                 } else
1365                                         os << "\\end{CJK}";
1366                                 state->open_encoding_ = none;
1367                                 break;
1368                         }
1369                         case inputenc: {
1370                                 // FIXME: If we are in an inset and the switch happened outside this inset,
1371                                 // do not switch back at the end of the inset (bug #8479)
1372                                 // The following attempt does not help with listings-caption in a CJK document:
1373                                 // if (runparams_in.local_font != 0
1374                                 //    && runparams_in.encoding == runparams_in.local_font->language()->encoding())
1375                                 //      break;
1376                                 os << "\\egroup";
1377                                 state->open_encoding_ = none;
1378                                 break;
1379                         }
1380                         case none:
1381                         default:
1382                                 // do nothing
1383                                 break;
1384                 }
1385         }
1386
1387         // Information about local language is stored as a font feature.
1388         // If this is the last paragraph of the inset and a local_font was set upon entering
1389         // and we are mixing encodings ("auto-legacy" or "auto-legacy-plain" and no XeTeX or LuaTeX),
1390         // ensure the encoding is set back to the default encoding of the local language.
1391         if (runparams.isLastPar && runparams_in.local_font != nullptr
1392             && runparams_in.encoding != runparams_in.local_font->language()->encoding()
1393             && (bparams.inputenc == "auto-legacy" || bparams.inputenc == "auto-legacy-plain")
1394                 && !runparams.isFullUnicode()
1395            ) {
1396                 runparams_in.encoding = runparams_in.local_font->language()->encoding();
1397                 os << setEncoding(runparams_in.encoding->iconvName());
1398         }
1399         // Otherwise, the current encoding should be set for the next paragraph.
1400         else
1401                 runparams_in.encoding = runparams.encoding;
1402
1403         // Also pass the post_macros upstream
1404         runparams_in.post_macro = runparams.post_macro;
1405
1406
1407         // we don't need a newline for the last paragraph!!!
1408         // Note from JMarc: we will re-add a \n explicitly in
1409         // TeXEnvironment, because it is needed in this case
1410         if (nextpar && !os.afterParbreak() && !last_was_separator) {
1411                 Layout const & next_layout = nextpar->layout();
1412                 if (!text.inset().getLayout().parbreakIgnored())
1413                         // Make sure to start a new line
1414                         os << breakln;
1415                 // A newline '\n' is always output before a command,
1416                 // so avoid doubling it.
1417                 if (!next_layout.isCommand()) {
1418                         // Here we now try to avoid spurious empty lines by
1419                         // outputting a paragraph break only if: (case 1) the
1420                         // paragraph style allows parbreaks and no \begin, \end
1421                         // or \item tags are going to follow (i.e., if the next
1422                         // isn't the first or the current isn't the last
1423                         // paragraph of an environment or itemize) and the
1424                         // depth and alignment of the following paragraph is
1425                         // unchanged, or (case 2) the following is a
1426                         // non-environment paragraph whose depth is increased
1427                         // but whose alignment is unchanged, or (case 3) the
1428                         // paragraph is not an environment and the next one is a
1429                         // non-itemize-like env at lower depth, or (case 4) the
1430                         // paragraph is a command not followed by an environment
1431                         // and the alignment of the current and next paragraph
1432                         // is unchanged, or (case 5) the current alignment is
1433                         // changed and a standard paragraph follows.
1434                         DocumentClass const & tclass = bparams.documentClass();
1435                         if ((style == next_layout
1436                              && !style.parbreak_is_newline
1437                              && !text.inset().getLayout().parbreakIsNewline()
1438                              && !text.inset().getLayout().parbreakIgnored()
1439                              && style.latextype != LATEX_ITEM_ENVIRONMENT
1440                              && style.latextype != LATEX_LIST_ENVIRONMENT
1441                              && style.align == par.getAlign(bparams)
1442                              && nextpar->getDepth() == par.getDepth()
1443                              && nextpar->getAlign(bparams) == par.getAlign(bparams))
1444                             || (!next_layout.isEnvironment()
1445                                 && nextpar->getDepth() > par.getDepth()
1446                                 && nextpar->getAlign(bparams) == next_layout.align)
1447                             || (!style.isEnvironment()
1448                                 && next_layout.latextype == LATEX_ENVIRONMENT
1449                                 && nextpar->getDepth() < par.getDepth())
1450                             || (style.isCommand()
1451                                 && !next_layout.isEnvironment()
1452                                 && style.align == par.getAlign(bparams)
1453                                 && next_layout.align == nextpar->getAlign(bparams))
1454                             || (style.align != par.getAlign(bparams)
1455                                 && tclass.isDefaultLayout(next_layout))) {
1456                                 os << '\n';
1457                         }
1458                 }
1459         }
1460
1461         // Reset language nesting level after intitle command
1462         if (intitle_command)
1463                 state->nest_level_ -= 1;
1464
1465         LYXERR(Debug::LATEX, "TeXOnePar for paragraph " << pit << " done; ptr "
1466                 << &par << " next " << nextpar);
1467
1468         return;
1469 }
1470
1471
1472 // LaTeX all paragraphs
1473 void latexParagraphs(Buffer const & buf,
1474                      Text const & text,
1475                      otexstream & os,
1476                      OutputParams const & runparams,
1477                      string const & everypar)
1478 {
1479         LASSERT(runparams.par_begin <= runparams.par_end,
1480                 { os << "% LaTeX Output Error\n"; return; } );
1481
1482         BufferParams const & bparams = buf.params();
1483         BufferParams const & mparams = buf.masterParams();
1484
1485         bool const maintext = text.isMainText();
1486         bool const is_child = buf.masterBuffer() != &buf;
1487         bool const multibib_child = maintext && is_child
1488                         && mparams.multibib == "child";
1489
1490         if (multibib_child && mparams.useBiblatex())
1491                 os << "\\newrefsection";
1492         else if (multibib_child && mparams.useBibtopic()
1493                  && !buf.masterBibInfo().empty()) {
1494                 os << "\\begin{btUnit}\n";
1495                 runparams.openbtUnit = true;
1496         }
1497
1498         // Open a CJK environment at the beginning of the main buffer
1499         // if the document's main encoding requires the CJK package
1500         // or the document encoding is utf8 and the CJK package is required
1501         // (but not in child documents or documents using system fonts):
1502         OutputState * state = getOutputState();
1503         if (maintext && !is_child && !bparams.useNonTeXFonts
1504             && (bparams.encoding().package() == Encoding::CJK
1505                         || (bparams.encoding().name() == "utf8"
1506                                 && runparams.use_CJK))
1507            ) {
1508                 docstring const cjkenc = bparams.encoding().iconvName() == "UTF-8"
1509                                                                  ? from_ascii("UTF8")
1510                                                                  : from_ascii(bparams.encoding().latexName());
1511                 os << "\\begin{CJK}{" << cjkenc
1512                    << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
1513                 state->open_encoding_ = CJK;
1514         }
1515         // if "auto begin" is switched off, explicitly switch the
1516         // language on at start
1517         string const mainlang = runparams.use_polyglossia
1518                 ? getPolyglossiaEnvName(bparams.language)
1519                 : bparams.language->babel();
1520         string const lang_begin_command = runparams.use_polyglossia ?
1521                 "\\begin{$$lang}$$opts" : lyxrc.language_command_begin;
1522         string const lang_end_command = runparams.use_polyglossia ?
1523                 "\\end{$$lang}" : lyxrc.language_command_end;
1524         bool const using_begin_end = runparams.use_polyglossia ||
1525                                         !lang_end_command.empty();
1526
1527         if (maintext && !lyxrc.language_auto_begin &&
1528             !mainlang.empty()) {
1529                 // FIXME UNICODE
1530                 string bc = runparams.use_polyglossia ?
1531                             getPolyglossiaBegin(lang_begin_command, mainlang,
1532                                                 bparams.language->polyglossiaOpts())
1533                           : subst(lang_begin_command, "$$lang", mainlang);
1534                 os << bc;
1535                 os << '\n';
1536                 if (using_begin_end)
1537                         pushLanguageName(mainlang);
1538         }
1539
1540         ParagraphList const & paragraphs = text.paragraphs();
1541
1542         if (runparams.par_begin == runparams.par_end) {
1543                 // The full doc will be exported but it is easier to just rely on
1544                 // runparams range parameters that will be passed TeXEnvironment.
1545                 runparams.par_begin = 0;
1546                 runparams.par_end = paragraphs.size();
1547         }
1548
1549         pit_type pit = runparams.par_begin;
1550         // lastpit is for the language check after the loop.
1551         pit_type lastpit = pit;
1552         // variables used in the loop:
1553         bool was_title = false;
1554         bool already_title = false;
1555         DocumentClass const & tclass = bparams.documentClass();
1556
1557         // Did we already warn about inTitle layout mixing? (we only warn once)
1558         bool gave_layout_warning = false;
1559         for (; pit < runparams.par_end; ++pit) {
1560                 lastpit = pit;
1561                 ParagraphList::const_iterator par = paragraphs.constIterator(pit);
1562
1563                 // FIXME This check should not be needed. We should
1564                 // perhaps issue an error if it is.
1565                 Layout const & layout = text.inset().forcePlainLayout() ?
1566                                 tclass.plainLayout() : par->layout();
1567
1568                 if (layout.intitle) {
1569                         if (already_title) {
1570                                 if (!gave_layout_warning && !runparams.dryrun) {
1571                                         gave_layout_warning = true;
1572                                         frontend::Alert::warning(_("Error in latexParagraphs"),
1573                                                         bformat(_("You are using at least one "
1574                                                           "layout (%1$s) intended for the title, "
1575                                                           "after using non-title layouts. This "
1576                                                           "could lead to missing or incorrect output."
1577                                                           ), layout.name()));
1578                                 }
1579                         } else if (!was_title) {
1580                                 was_title = true;
1581                                 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1582                                         os << "\\begin{"
1583                                                         << from_ascii(tclass.titlename())
1584                                                         << "}\n";
1585                                 }
1586                         }
1587                 } else if (was_title && !already_title && !layout.inpreamble) {
1588                         if (tclass.titletype() == TITLE_ENVIRONMENT) {
1589                                 os << "\\end{" << from_ascii(tclass.titlename())
1590                                                 << "}\n";
1591                         }
1592                         else {
1593                                 os << "\\" << from_ascii(tclass.titlename())
1594                                                 << "\n";
1595                         }
1596                         already_title = true;
1597                         was_title = false;
1598                 }
1599
1600                 if (layout.isCommand() && !layout.latexname().empty()
1601                     && layout.latexname() == bparams.multibib) {
1602                         if (runparams.openbtUnit)
1603                                 os << "\\end{btUnit}\n";
1604                         if (!bparams.useBiblatex()
1605                             && !buf.masterBibInfo().empty()) {
1606                                 os << '\n' << "\\begin{btUnit}\n";
1607                                 runparams.openbtUnit = true;
1608                         }
1609                 }
1610
1611                 if (!layout.isEnvironment() && par->params().leftIndent().zero()) {
1612                         // This is a standard top level paragraph, TeX it and continue.
1613                         TeXOnePar(buf, text, pit, os, runparams, everypar);
1614                         continue;
1615                 }
1616
1617                 TeXEnvironmentData const data =
1618                         prepareEnvironment(buf, text, par, os, runparams);
1619                 // pit can be changed in TeXEnvironment.
1620                 TeXEnvironment(buf, text, runparams, pit, os);
1621                 finishEnvironment(os, runparams, data);
1622         }
1623
1624         // FIXME: uncomment the content or remove this block
1625         if (pit == runparams.par_end) {
1626                         // Make sure that the last paragraph is
1627                         // correctly terminated (because TeXOnePar does
1628                         // not add a \n in this case)
1629                         //os << '\n';
1630         }
1631
1632         // It might be that we only have a title in this document
1633         if (was_title && !already_title) {
1634                 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1635                         os << "\\end{" << from_ascii(tclass.titlename())
1636                            << "}\n";
1637                 } else {
1638                         os << "\\" << from_ascii(tclass.titlename())
1639                            << "\n";
1640                 }
1641         }
1642
1643         if (maintext && !is_child && runparams.openbtUnit)
1644                 os << "\\end{btUnit}\n";
1645
1646         // if "auto end" is switched off, explicitly close the language at the end
1647         // but only if the last par is in a babel or polyglossia language
1648         Language const * const lastpar_language =
1649                         paragraphs.at(lastpit).getParLanguage(bparams);
1650         if (maintext && !lyxrc.language_auto_end && !mainlang.empty() &&
1651                 lastpar_language->encoding()->package() != Encoding::CJK) {
1652                 os << from_utf8(subst(lang_end_command,
1653                                         "$$lang",
1654                                         mainlang))
1655                         << '\n';
1656                 // If we have language_auto_begin, the stack will
1657                 // already be empty, nothing to pop()
1658                 if (using_begin_end && !lyxrc.language_auto_begin)
1659                         popLanguageName();
1660         }
1661
1662         // If the last paragraph is an environment, we'll have to close
1663         // CJK at the very end to do proper nesting.
1664         if (maintext && !is_child && state->open_encoding_ == CJK) {
1665                 os << "\\clearpage\n\\end{CJK}\n";
1666                 state->open_encoding_ = none;
1667         }
1668         // Likewise for polyglossia or when using begin/end commands
1669         // or at the very end of an active branch inset with a language switch
1670         Language const * const outer_language = (runparams.local_font != nullptr)
1671                         ? runparams.local_font->language() : bparams.language;
1672         string const & prev_lang = runparams.use_polyglossia
1673                         ? getPolyglossiaEnvName(outer_language)
1674                         : outer_language->babel();
1675         string const lastpar_lang = runparams.use_polyglossia ?
1676                 getPolyglossiaEnvName(lastpar_language): lastpar_language->babel();
1677         string const & cur_lang = openLanguageName(state);
1678         if (((runparams.inbranch && langOpenedAtThisLevel(state) && prev_lang != cur_lang)
1679              || (maintext && !is_child)) && !cur_lang.empty()) {
1680                 os << from_utf8(subst(lang_end_command,
1681                                         "$$lang",
1682                                         cur_lang))
1683                    << '\n';
1684                 if (using_begin_end)
1685                         popLanguageName();
1686         } else if (runparams.inbranch && !using_begin_end
1687                    && prev_lang != lastpar_lang && !lastpar_lang.empty()) {
1688                 // with !using_begin_end, cur_lang is empty, so we need to
1689                 // compare against the paragraph language (and we are in the
1690                 // last paragraph at this point)
1691                 os << subst(lang_begin_command, "$$lang", prev_lang) << '\n';
1692         }
1693
1694         // reset inherited encoding
1695         if (state->cjk_inherited_ > 0) {
1696                 state->cjk_inherited_ -= 1;
1697                 if (state->cjk_inherited_ == 0)
1698                         state->open_encoding_ = CJK;
1699         }
1700
1701         if (multibib_child && mparams.useBibtopic()) {
1702                 os << "\\end{btUnit}\n";
1703                 runparams.openbtUnit = false;
1704         }
1705 }
1706
1707 // Switch the input encoding for some part(s) of the document.
1708 pair<bool, int> switchEncoding(odocstream & os, BufferParams const & bparams,
1709                    OutputParams const & runparams, Encoding const & newEnc,
1710                    bool force, bool noswitchmacro)
1711 {
1712         // Never switch encoding with XeTeX/LuaTeX
1713         // or if we're in a moving argument or inherit the outer encoding.
1714         if (runparams.isFullUnicode() || newEnc.name() == "inherit")
1715                 return make_pair(false, 0);     
1716
1717         // Only switch for auto-selected legacy encodings (inputenc setting
1718         // "auto-legacy" or "auto-legacy-plain").
1719         // The "listings" environment can force a switch also with other
1720         // encoding settings (it does not support variable width encodings
1721         // (utf8, jis, ...) under 8-bit latex engines).
1722         if (!force && ((bparams.inputenc != "auto-legacy" && bparams.inputenc != "auto-legacy-plain")
1723                                    || runparams.moving_arg))
1724                 return make_pair(false, 0);
1725
1726         Encoding const & oldEnc = *runparams.encoding;
1727         // Do not switch, if the encoding is unchanged or switching is not supported.
1728         if (oldEnc.name() == newEnc.name()
1729                 || oldEnc.package() == Encoding::japanese
1730                 || oldEnc.package() == Encoding::none
1731                 || newEnc.package() == Encoding::none
1732                 || runparams.for_search)
1733                 return make_pair(false, 0);
1734         // FIXME We ignore encoding switches from/to encodings that do
1735         // neither support the inputenc package nor the CJK package here.
1736         // This may fail for characters not supported by "unicodesymbols"
1737         // or for non-ASCII characters in "listings"
1738         // but it is the best we can do.
1739
1740         // change encoding
1741         LYXERR(Debug::LATEX, "Changing LaTeX encoding from "
1742                    << oldEnc.name() << " to " << newEnc.name());
1743         os << setEncoding(newEnc.iconvName());
1744         if (bparams.inputenc == "auto-legacy-plain")
1745           return make_pair(true, 0);
1746
1747         docstring const inputenc_arg(from_ascii(newEnc.latexName()));
1748         OutputState * state = getOutputState();
1749         switch (newEnc.package()) {
1750                 case Encoding::none:
1751                 case Encoding::japanese:
1752                         // shouldn't ever reach here (see above) but avoids warning.
1753                         return make_pair(true, 0);
1754                 case Encoding::inputenc: {
1755                         int count = inputenc_arg.length();
1756                         if (oldEnc.package() == Encoding::CJK &&
1757                             state->open_encoding_ == CJK) {
1758                                 os << "\\end{CJK}";
1759                                 state->open_encoding_ = none;
1760                                 count += 9;
1761                         }
1762                         else if (oldEnc.package() == Encoding::inputenc &&
1763                                  state->open_encoding_ == inputenc) {
1764                                 os << "\\egroup";
1765                                 state->open_encoding_ = none;
1766                                 count += 7;
1767                         }
1768                         if (runparams.local_font != nullptr
1769                             &&  oldEnc.package() == Encoding::CJK) {
1770                                 // within insets, \inputenc switches need
1771                                 // to be embraced within \bgroup...\egroup;
1772                                 // else CJK fails.
1773                                 os << "\\bgroup";
1774                                 count += 7;
1775                                 state->open_encoding_ = inputenc;
1776                         }
1777                         if (noswitchmacro)
1778                                 return make_pair(true, count);
1779                         os << "\\inputencoding{" << inputenc_arg << '}';
1780                         return make_pair(true, count + 16);
1781                 }
1782                 case Encoding::CJK: {
1783                         int count = inputenc_arg.length();
1784                         if (oldEnc.package() == Encoding::CJK &&
1785                             state->open_encoding_ == CJK) {
1786                                 os << "\\end{CJK}";
1787                                 count += 9;
1788                         }
1789                         if (oldEnc.package() == Encoding::inputenc &&
1790                             state->open_encoding_ == inputenc) {
1791                                 os << "\\egroup";
1792                                 count += 7;
1793                         }
1794                         os << "\\begin{CJK}{"
1795                            << from_ascii(newEnc.latexName()) << "}{"
1796                            << from_ascii(bparams.fonts_cjk) << "}";
1797                         state->open_encoding_ = CJK;
1798                         return make_pair(true, count + 15);
1799                 }
1800         }
1801         // Dead code to avoid a warning:
1802         return make_pair(true, 0);
1803 }
1804
1805 } // namespace lyx