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
 785         if (style.pass_thru) {
 786                 Font const outerfont = text.outerFont(pit);
 787                 parStartCommand(par, os, runparams, style);
 788                 if (style.isCommand() && style.needprotect)
 789                         // Due to the moving argument, some fragile
 790                         // commands (labels, index entries)
 791                         // are output after this command (#2154)
 792                         runparams.postpone_fragile_stuff = true;
 793                 if (intitle_command)
 794                         os << '{';
 795
 796                 par.latex(bparams, outerfont, os, runparams, start_pos, end_pos, force);
 797
 798                 // I did not create a parEndCommand for this minuscule
 799                 // task because in the other user of parStartCommand
 800                 // the code is different (JMarc)
 801                 if (style.isCommand()) {
 802                         os << "}";
 803                         if (par.needsCProtection(runparams.moving_arg)
 804                             && contains(runparams.active_chars, '^'))
 805                                 os << "\\endgroup";
 806                         os << "\n";
 807                 }
 808                 else
 809                         os << '\n';
 810                 if (!style.parbreak_is_newline) {
 811                         os << '\n';
 812                 } else if (nextpar && !style.isEnvironment()) {
 813                         Layout const nextstyle = text.inset().forcePlainLayout()
 814                                 ? bparams.documentClass().plainLayout()
 815                                 : nextpar->layout();
 816                         if (nextstyle.name() != style.name())
 817                                 os << '\n';
 818                 }
 819
 820                 return;
 821         }
 822
 823         // This paragraph's language
 824         Language const * const par_language = par.getParLanguage(bparams);
 825         Language const * const nextpar_language = nextpar ?
 826                 nextpar->getParLanguage(bparams) : nullptr;
 827         // The document's language
 828         Language const * const doc_language = bparams.language;
 829         // The language that was in effect when the environment this paragraph is
 830         // inside of was opened
 831         Language const * const outer_language =
 832                 (runparams.local_font != nullptr) ?
 833                         runparams.local_font->language() : doc_language;
 834
 835         Paragraph const * priorpar = (pit == 0) ? nullptr : &paragraphs.at(pit - 1);
 836
 837         // The previous language that was in effect is the language of the
 838         // previous paragraph, unless the previous paragraph is inside an
 839         // environment with nesting depth greater than (or equal to, but with
 840         // a different layout) the current one. If there is no previous
 841         // paragraph, the previous language is the outer language.
 842         // Note further that we take the outer language also if the prior par
 843         // is PassThru, since in that case it has latex_language, and all secondary
 844         // languages have been closed (#10793).
 845         bool const use_prev_env_language = state->prev_env_language_ != nullptr
 846                         && priorpar
 847                         && priorpar->layout().isEnvironment()
 848                         && (priorpar->getDepth() > par.getDepth()
 849                             || (priorpar->getDepth() == par.getDepth()
 850                                 && priorpar->layout() != par.layout()));
 851
 852         // We need to ignore previous intitle commands since languages
 853         // are switched locally there (# 11514)
 854         // There might be paragraphs before the title, so we check this.
 855         Paragraph * prior_nontitle_par = nullptr;
 856         if (!intitle_command) {
 857                 pit_type ppit = pit;
 858                 while (ppit > 0) {
 859                         --ppit;
 860                         Paragraph const * tmppar = &paragraphs.at(ppit);
 861                         if (tmppar->layout().intitle && tmppar->layout().isCommand())
 862                                 continue;
 863                         prior_nontitle_par = const_cast<Paragraph*>(tmppar);
 864                         break;
 865                 }
 866         }
 867         Language const * const prev_language =
 868                 runparams_in.for_search
 869                         ? languages.getLanguage("ignore")
 870                         : (prior_nontitle_par && !prior_nontitle_par->isPassThru())
 871                                 ? (use_prev_env_language
 872                                         ? state->prev_env_language_
 873                                         : prior_nontitle_par->getParLanguage(bparams))
 874                                 : outer_language;
 875
 876         bool const use_polyglossia = runparams.use_polyglossia;
 877         string const par_lang = use_polyglossia ?
 878                 getPolyglossiaEnvName(par_language): par_language->babel();
 879         string const prev_lang = use_polyglossia ?
 880                 getPolyglossiaEnvName(prev_language) : prev_language->babel();
 881         string const outer_lang = use_polyglossia ?
 882                 getPolyglossiaEnvName(outer_language) : outer_language->babel();
 883         string const nextpar_lang = nextpar_language ? (use_polyglossia ?
 884                 getPolyglossiaEnvName(nextpar_language) :
 885                 nextpar_language->babel()) : string();
 886         string lang_begin_command = use_polyglossia ?
 887                 "\\begin{$$lang}$$opts" : lyxrc.language_command_begin;
 888         string lang_end_command = use_polyglossia ?
 889                 "\\end{$$lang}" : lyxrc.language_command_end;
 890         // the '%' is necessary to prevent unwanted whitespace
 891         string lang_command_termination = "%\n";
 892         bool const using_begin_end = use_polyglossia ||
 893                                         !lang_end_command.empty();
 894
 895         // For InTitle commands, we need to switch the language inside the command
 896         // (see #10849); thus open the command here.
 897         if (intitle_command) {
 898                 parStartCommand(par, os, runparams, style);
 899                 if (style.isCommand() && style.needprotect)
 900                         // Due to the moving argument, some fragile
 901                         // commands (labels, index entries)
 902                         // are output after this command (#2154)
 903                         runparams.postpone_fragile_stuff = true;
 904                 os << '{';
 905         }
 906
 907         // In some insets (such as Arguments), we cannot use \selectlanguage.
 908         // Also, if an RTL language is set via environment in polyglossia,
 909         // only a nested \\text<lang> command will reset the direction for LTR
 910         // languages (see # 10111).
 911         bool const in_polyglossia_rtl_env =
 912                 use_polyglossia
 913                 && runparams.local_font != nullptr
 914                 && outer_language->rightToLeft()
 915                 && !par_language->rightToLeft();
 916         bool const localswitch = runparams_in.for_search
 917                         || text.inset().forceLocalFontSwitch()
 918                         || (using_begin_end && text.inset().forcePlainLayout())
 919                         || in_polyglossia_rtl_env;
 920         if (localswitch) {
 921                 lang_begin_command = use_polyglossia ?
 922                             "\\text$$lang$$opts{" : lyxrc.language_command_local;
 923                 lang_end_command = "}";
 924                 lang_command_termination.clear();
 925         }
 926
 927         bool const localswitch_needed = localswitch && par_lang != outer_lang;
 928
 929         // localswitches need to be closed and reopened at each par
 930         if (runparams_in.for_search || ((par_lang != prev_lang || localswitch_needed)
 931              // check if we already put language command in TeXEnvironment()
 932              && !(style.isEnvironment()
 933                   && (pit == 0 || (priorpar->layout() != par.layout()
 934                                    && priorpar->getDepth() <= par.getDepth())
 935                       || priorpar->getDepth() < par.getDepth())))) {
 936                 if (!localswitch
 937                     && (!using_begin_end || langOpenedAtThisLevel(state))
 938                     && !lang_end_command.empty()
 939                     && prev_lang != outer_lang
 940                     && !prev_lang.empty()
 941                     && (!using_begin_end || !style.isEnvironment())) {
 942                         os << from_ascii(subst(lang_end_command,
 943                                                "$$lang",
 944                                                prev_lang))
 945                            << lang_command_termination;
 946                         if (using_begin_end)
 947                                 popLanguageName();
 948                 }
 949
 950                 // We need to open a new language if we couldn't close the previous
 951                 // one (because there's no language_command_end); and even if we closed
 952                 // the previous one, if the current language is different than the
 953                 // outer_language (which is currently in effect once the previous one
 954                 // is closed).
 955                 if ((lang_end_command.empty() || par_lang != outer_lang
 956                      || (!using_begin_end
 957                          || (style.isEnvironment() && par_lang != prev_lang)))
 958                         && !par_lang.empty()) {
 959                         // If we're inside an inset, and that inset is within an \L or \R
 960                         // (or equivalents), then within the inset, too, any opposite
 961                         // language paragraph should appear within an \L or \R (in addition
 962                         // to, outside of, the normal language switch commands).
 963                         // This behavior is not correct for ArabTeX, though.
 964                         if (!using_begin_end
 965                             // not for ArabTeX
 966                             && par_language->lang() != "arabic_arabtex"
 967                             && outer_language->lang() != "arabic_arabtex"
 968                             // are we in an inset?
 969                             && runparams.local_font != nullptr
 970                             // is the inset within an \L or \R?
 971                             //
 972                             // FIXME: currently, we don't check this; this means that
 973                             // we'll have unnnecessary \L and \R commands, but that
 974                             // doesn't seem to hurt (though latex will complain)
 975                             //
 976                             // is this paragraph in the opposite direction?
 977                             && runparams.local_font->isRightToLeft() != par_language->rightToLeft()) {
 978                                 // FIXME: I don't have a working copy of the Arabi package, so
 979                                 // I'm not sure if the farsi and arabic_arabi stuff is correct
 980                                 // or not...
 981                                 if (par_language->lang() == "farsi")
 982                                         os << "\\textFR{";
 983                                 else if (outer_language->lang() == "farsi")
 984                                         os << "\\textLR{";
 985                                 else if (par_language->lang() == "arabic_arabi")
 986                                         os << "\\textAR{";
 987                                 else if (outer_language->lang() == "arabic_arabi")
 988                                         os << "\\textLR{";
 989                                 // remaining RTL languages currently is hebrew
 990                                 else if (par_language->rightToLeft())
 991                                         os << "\\R{";
 992                                 else
 993                                         os << "\\L{";
 994                         }
 995                         // With CJK, the CJK tag has to be closed first (see below)
 996                         if ((runparams.encoding->package() != Encoding::CJK
 997                                  || bparams.useNonTeXFonts
 998                                  || runparams.for_search)
 999                             && (par_lang != openLanguageName(state) || localswitch || intitle_command)
1000                             && !par_lang.empty()) {
1001                                 string bc = use_polyglossia ?
1002                                           getPolyglossiaBegin(lang_begin_command, par_lang,
1003                                                               par_language->polyglossiaOpts(),
1004                                                               localswitch)
1005                                           : subst(lang_begin_command, "$$lang", par_lang);
1006                                 os << bc;
1007                                 os << lang_command_termination;
1008                                 if (using_begin_end)
1009                                         pushLanguageName(par_lang, localswitch);
1010                         }
1011                 }
1012         }
1013
1014         // Switch file encoding if necessary; no need to do this for "auto-legacy-plain"
1015         // encoding, since this only affects the position of the outputted
1016         // \inputencoding command; the encoding switch will occur when necessary
1017         if (bparams.inputenc == "auto-legacy"
1018                 && !runparams.isFullUnicode() // Xe/LuaTeX use one document-wide encoding  (see also switchEncoding())
1019                 && runparams.encoding->package() != Encoding::japanese
1020                 && runparams.encoding->package() != Encoding::none) {
1021                 // Look ahead for future encoding changes.
1022                 // We try to output them at the beginning of the paragraph,
1023                 // since the \inputencoding command is not allowed e.g. in
1024                 // sections. For this reason we only set runparams.moving_arg
1025                 // after checking for the encoding change, otherwise the
1026                 // change would be always avoided by switchEncoding().
1027                 for (pos_type i = 0; i < par.size(); ++i) {
1028                         char_type const c = par.getChar(i);
1029                         Encoding const * const encoding =
1030                                 par.getFontSettings(bparams, i).language()->encoding();
1031                         if (encoding->package() != Encoding::CJK
1032                                 && runparams.encoding->package() == Encoding::inputenc
1033                                 && isASCII(c))
1034                                 continue;
1035                         if (par.isInset(i))
1036                                 break;
1037                         // All characters before c are in the ASCII range, and
1038                         // c is non-ASCII (but no inset), so change the
1039                         // encoding to that required by the language of c.
1040                         // With CJK, only add switch if we have CJK content at the beginning
1041                         // of the paragraph
1042                         if (i != 0 && encoding->package() == Encoding::CJK)
1043                                 continue;
1044
1045                         pair<bool, int> enc_switch = switchEncoding(os.os(),
1046                                                 bparams, runparams, *encoding);
1047                         // the following is necessary after a CJK environment in a multilingual
1048                         // context (nesting issue).
1049                         if (par_language->encoding()->package() == Encoding::CJK
1050                                 && state->open_encoding_ != CJK && state->cjk_inherited_ == 0) {
1051                                 os << "\\begin{CJK}{"
1052                                    << from_ascii(par_language->encoding()->latexName())
1053                                    << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
1054                                 state->open_encoding_ = CJK;
1055                         }
1056                         if (encoding->package() != Encoding::none && enc_switch.first) {
1057                                 if (enc_switch.second > 0) {
1058                                         // the '%' is necessary to prevent unwanted whitespace
1059                                         os << "%\n";
1060                                 }
1061                                 // With CJK, the CJK tag had to be closed first (see above)
1062                                 if (runparams.encoding->package() == Encoding::CJK
1063                                     && par_lang != openLanguageName(state)
1064                                     && !par_lang.empty()) {
1065                                         os << subst(lang_begin_command, "$$lang", par_lang)
1066                                            << lang_command_termination;
1067                                         if (using_begin_end)
1068                                                 pushLanguageName(par_lang, localswitch);
1069                                 }
1070                                 runparams.encoding = encoding;
1071                         }
1072                         break;
1073                 }
1074         }
1075
1076         runparams.moving_arg |= style.needprotect;
1077         if (style.needmboxprotect)
1078                 ++runparams.inulemcmd;
1079         Encoding const * const prev_encoding = runparams.encoding;
1080
1081         bool const useSetSpace = bparams.documentClass().provides("SetSpace");
1082         if (par.allowParagraphCustomization()) {
1083                 if (par.params().startOfAppendix()) {
1084                         os << "\n\\appendix\n";
1085                 }
1086
1087                 // InTitle commands must use switches (not environments)
1088                 // inside the commands (see #9332)
1089                 if (style.intitle) {
1090                         if (!par.params().spacing().isDefault())
1091                         {
1092                                 if (runparams.moving_arg)
1093                                         os << "\\protect";
1094                                 os << from_ascii(par.params().spacing().writeCmd(useSetSpace));
1095                         }
1096                 } else {
1097                         if (!par.params().spacing().isDefault()
1098                                 && (pit == 0 || !priorpar->hasSameLayout(par)))
1099                         {
1100                                 os << from_ascii(par.params().spacing().writeEnvirBegin(useSetSpace))
1101                                     << '\n';
1102                         }
1103
1104                         if (style.isCommand()) {
1105                                 os << '\n';
1106                         }
1107                 }
1108         }
1109
1110         // For InTitle commands, we already started the command before
1111         // the language switch
1112         if (!intitle_command) {
1113                 parStartCommand(par, os, runparams, style);
1114                 if (style.isCommand() && style.needprotect)
1115                         // Due to the moving argument, some fragile
1116                         // commands (labels, index entries)
1117                         // are output after this command (#2154)
1118                         runparams.postpone_fragile_stuff = true;
1119         }
1120
1121         Font const outerfont = text.outerFont(pit);
1122
1123         // FIXME UNICODE
1124         os << from_utf8(everypar);
1125         par.latex(bparams, outerfont, os, runparams, start_pos, end_pos, force);
1126
1127         Font const font = par.empty()
1128                  ? par.getLayoutFont(bparams, outerfont)
1129                  : par.getFont(bparams, par.size() - 1, outerfont);
1130
1131         bool const is_command = style.isCommand();
1132
1133         // InTitle commands need to be closed after the language has been closed.
1134         if (!intitle_command) {
1135                 if (is_command) {
1136                         os << '}';
1137                         if (!style.postcommandargs().empty())
1138                                 latexArgInsets(par, os, runparams, style.postcommandargs(), "post:");
1139                         if (!runparams.post_macro.empty()) {
1140                                 // Output the stored fragile commands (labels, indices etc.)
1141                                 // that need to be output after the command with moving argument.
1142                                 os << runparams.post_macro;
1143                                 runparams.post_macro.clear();
1144                         }
1145                         if (par.needsCProtection(runparams.moving_arg)
1146                             && contains(runparams.active_chars, '^'))
1147                                 os << "\\endgroup";
1148                         if (runparams.encoding != prev_encoding) {
1149                                 runparams.encoding = prev_encoding;
1150                                 os << setEncoding(prev_encoding->iconvName());
1151                         }
1152                 }
1153         }
1154
1155         bool pending_newline = false;
1156         bool unskip_newline = false;
1157         bool close_lang_switch = false;
1158         switch (style.latextype) {
1159         case LATEX_ITEM_ENVIRONMENT:
1160         case LATEX_LIST_ENVIRONMENT:
1161                 if ((nextpar && par_lang != nextpar_lang
1162                              && nextpar->getDepth() == par.getDepth())
1163                     || (atSameLastLangSwitchDepth(state) && nextpar
1164                             && nextpar->getDepth() < par.getDepth()))
1165                         close_lang_switch = using_begin_end;
1166                 if (nextpar && par.params().depth() < nextpar->params().depth())
1167                         pending_newline = !text.inset().getLayout().parbreakIgnored();
1168                 break;
1169         case LATEX_ENVIRONMENT: {
1170                 // if it's the last paragraph of the current environment
1171                 // skip it otherwise fall through
1172                 if (nextpar
1173                     && ((nextpar->layout() != par.layout()
1174                            || nextpar->params().depth() != par.params().depth())
1175                         || (!using_begin_end || par_lang != nextpar_lang)))
1176                 {
1177                         close_lang_switch = using_begin_end;
1178                         break;
1179                 }
1180         }
1181         // possible
1182         // fall through
1183         default:
1184                 // we don't need it for the last paragraph and in InTitle commands!!!
1185                 if (nextpar && !intitle_command)
1186                         pending_newline = !text.inset().getLayout().parbreakIgnored();
1187         }
1188
1189         // InTitle commands use switches (not environments) for space settings
1190         if (par.allowParagraphCustomization() && !style.intitle) {
1191                 if (!par.params().spacing().isDefault()
1192                         && (runparams.isLastPar || !nextpar->hasSameLayout(par))) {
1193                         if (pending_newline)
1194                                 os << '\n';
1195
1196                         string const endtag =
1197                                 par.params().spacing().writeEnvirEnd(useSetSpace);
1198                         if (prefixIs(endtag, "\\end{"))
1199                                 os << breakln;
1200
1201                         os << from_ascii(endtag);
1202                         pending_newline = true;
1203                 }
1204         }
1205
1206         // Closing the language is needed for the last paragraph in a given language
1207         // as well as for any InTitleCommand (since these set the language locally);
1208         // it is also needed if we're within an \L or \R that we may have opened above
1209         // (not necessarily in this paragraph) and are about to close.
1210         bool closing_rtl_ltr_environment = !using_begin_end
1211                 // not for ArabTeX
1212                 && (par_language->lang() != "arabic_arabtex"
1213                     && outer_language->lang() != "arabic_arabtex")
1214                 // have we opened an \L or \R environment?
1215                 && runparams.local_font != nullptr
1216                 && runparams.local_font->isRightToLeft() != par_language->rightToLeft()
1217                 // are we about to close the language?
1218                 &&((nextpar && par_lang != nextpar_lang)
1219                    || (runparams.isLastPar && par_lang != outer_lang));
1220
1221         if (localswitch_needed
1222             || (intitle_command && using_begin_end)
1223             || closing_rtl_ltr_environment
1224             || (((runparams.isLastPar && !runparams.inbranch) || close_lang_switch)
1225                 && (par_lang != outer_lang || (using_begin_end
1226                                                 && style.isEnvironment()
1227                                                 && par_lang != nextpar_lang)))) {
1228                 // Since \selectlanguage write the language to the aux file,
1229                 // we need to reset the language at the end of footnote or
1230                 // float.
1231
1232                 if (!localswitch && (pending_newline || close_lang_switch))
1233                         os << '\n';
1234
1235                 // when the paragraph uses CJK, the language has to be closed earlier
1236                 if ((font.language()->encoding()->package() != Encoding::CJK)
1237                         || bparams.useNonTeXFonts
1238                         || runparams_in.for_search) {
1239                         if (lang_end_command.empty()) {
1240                                 // If this is a child, we should restore the
1241                                 // master language after the last paragraph.
1242                                 Language const * const current_language =
1243                                         (runparams.isLastPar && runparams.master_language)
1244                                                 ? runparams.master_language
1245                                                 : outer_language;
1246                                 string const current_lang = use_polyglossia
1247                                         ? getPolyglossiaEnvName(current_language)
1248                                         : current_language->babel();
1249                                 if (!current_lang.empty()
1250                                     && current_lang != openLanguageName(state)) {
1251                                         string bc = use_polyglossia ?
1252                                                     getPolyglossiaBegin(lang_begin_command, current_lang,
1253                                                                         current_language->polyglossiaOpts(),
1254                                                                         localswitch)
1255                                                   : subst(lang_begin_command, "$$lang", current_lang);
1256                                         os << bc;
1257                                         pending_newline = !localswitch
1258                                                         && !text.inset().getLayout().parbreakIgnored();
1259                                         unskip_newline = !localswitch;
1260                                         if (using_begin_end)
1261                                                 pushLanguageName(current_lang, localswitch);
1262                                 }
1263                         } else if ((!using_begin_end ||
1264                                     langOpenedAtThisLevel(state)) &&
1265                                    !par_lang.empty()) {
1266                                 // If we are in an environment, we have to
1267                                 // close the "outer" language afterwards
1268                                 string const & cur_lang = openLanguageName(state);
1269                                 if (!style.isEnvironment()
1270                                     || (close_lang_switch
1271                                         && atSameLastLangSwitchDepth(state)
1272                                         && par_lang != outer_lang
1273                                         && (par_lang != cur_lang
1274                                             || (cur_lang != outer_lang
1275                                                 && nextpar
1276                                                 && style != nextpar->layout())))
1277                                     || (atSameLastLangSwitchDepth(state)
1278                                         && state->lang_switch_depth_.size()
1279                                         && cur_lang != par_lang)
1280                                     || in_polyglossia_rtl_env)
1281                                 {
1282                                         if (using_begin_end && !localswitch)
1283                                                 os << breakln;
1284                                         os << from_ascii(subst(
1285                                                 lang_end_command,
1286                                                 "$$lang",
1287                                                 par_lang));
1288                                         pending_newline = !localswitch
1289                                                         && !text.inset().getLayout().parbreakIgnored();
1290                                         unskip_newline = !localswitch;
1291                                         if (using_begin_end)
1292                                                 popLanguageName();
1293                                 }
1294                         }
1295                 }
1296         }
1297         if (closing_rtl_ltr_environment)
1298                 os << "}";
1299
1300         // InTitle commands need to be closed after the language has been closed.
1301         if (intitle_command) {
1302                 os << '}';
1303                 if (!style.postcommandargs().empty())
1304                         latexArgInsets(par, os, runparams, style.postcommandargs(), "post:");
1305                 if (!runparams.post_macro.empty()) {
1306                         // Output the stored fragile commands (labels, indices etc.)
1307                         // that need to be output after the command with moving argument.
1308                         os << runparams.post_macro;
1309                         runparams.post_macro.clear();
1310                 }
1311                 if (par.needsCProtection(runparams.moving_arg)
1312                     && contains(runparams.active_chars, '^'))
1313                         os << "\\endgroup";
1314                 if (runparams.encoding != prev_encoding) {
1315                         runparams.encoding = prev_encoding;
1316                         os << setEncoding(prev_encoding->iconvName());
1317                 }
1318         }
1319
1320         bool const last_was_separator =
1321                 par.size() > 0 && par.isEnvSeparator(par.size() - 1);
1322
1323         if (pending_newline) {
1324                 if (unskip_newline)
1325                         // prevent unwanted whitespace
1326                         os << '%';
1327                 if (!os.afterParbreak() && !last_was_separator)
1328                         os << '\n';
1329         }
1330
1331         // if this is a CJK-paragraph and the next isn't, close CJK
1332         // also if the next paragraph is a multilingual environment (because of nesting)
1333         if (nextpar && state->open_encoding_ == CJK
1334                 && bparams.encoding().iconvName() != "UTF-8"
1335                 && bparams.encoding().package() != Encoding::CJK
1336                 && (nextpar_language->encoding()->package() != Encoding::CJK
1337                         || (nextpar->layout().isEnvironment() && nextpar->isMultiLingual(bparams)))
1338                 // inbetween environments, CJK has to be closed later (nesting!)
1339                 && (!style.isEnvironment() || !nextpar->layout().isEnvironment())) {
1340                 os << "\\end{CJK}\n";
1341                 state->open_encoding_ = none;
1342         }
1343
1344         // If this is the last paragraph, close the CJK environment
1345         // if necessary. If it's an environment or nested in an environment,
1346         // we'll have to \end that first.
1347         if (runparams.isLastPar && !style.isEnvironment()
1348                 && par.params().depth() < 1) {
1349                 switch (state->open_encoding_) {
1350                         case CJK: {
1351                                 // do nothing at the end of child documents
1352                                 if (maintext && buf.masterBuffer() != &buf)
1353                                         break;
1354                                 // end of main text: also insert a \clearpage (see #5386)
1355                                 if (maintext) {
1356                                         os << "\n\\clearpage\n\\end{CJK}\n";
1357                                 // end of an inset
1358                                 } else
1359                                         os << "\\end{CJK}";
1360                                 state->open_encoding_ = none;
1361                                 break;
1362                         }
1363                         case inputenc: {
1364                                 // FIXME: If we are in an inset and the switch happened outside this inset,
1365                                 // do not switch back at the end of the inset (bug #8479)
1366                                 // The following attempt does not help with listings-caption in a CJK document:
1367                                 // if (runparams_in.local_font != 0
1368                                 //    && runparams_in.encoding == runparams_in.local_font->language()->encoding())
1369                                 //      break;
1370                                 os << "\\egroup";
1371                                 state->open_encoding_ = none;
1372                                 break;
1373                         }
1374                         case none:
1375                         default:
1376                                 // do nothing
1377                                 break;
1378                 }
1379         }
1380
1381         // Information about local language is stored as a font feature.
1382         // If this is the last paragraph of the inset and a local_font was set upon entering
1383         // and we are mixing encodings ("auto-legacy" or "auto-legacy-plain" and no XeTeX or LuaTeX),
1384         // ensure the encoding is set back to the default encoding of the local language.
1385         if (runparams.isLastPar && runparams_in.local_font != nullptr
1386             && runparams_in.encoding != runparams_in.local_font->language()->encoding()
1387             && (bparams.inputenc == "auto-legacy" || bparams.inputenc == "auto-legacy-plain")
1388                 && !runparams.isFullUnicode()
1389            ) {
1390                 runparams_in.encoding = runparams_in.local_font->language()->encoding();
1391                 os << setEncoding(runparams_in.encoding->iconvName());
1392         }
1393         // Otherwise, the current encoding should be set for the next paragraph.
1394         else
1395                 runparams_in.encoding = runparams.encoding;
1396
1397         // Also pass the post_macros upstream
1398         runparams_in.post_macro = runparams.post_macro;
1399
1400
1401         // we don't need a newline for the last paragraph!!!
1402         // Note from JMarc: we will re-add a \n explicitly in
1403         // TeXEnvironment, because it is needed in this case
1404         if (nextpar && !os.afterParbreak() && !last_was_separator) {
1405                 Layout const & next_layout = nextpar->layout();
1406                 if (!text.inset().getLayout().parbreakIgnored())
1407                         // Make sure to start a new line
1408                         os << breakln;
1409                 // A newline '\n' is always output before a command,
1410                 // so avoid doubling it.
1411                 if (!next_layout.isCommand()) {
1412                         // Here we now try to avoid spurious empty lines by
1413                         // outputting a paragraph break only if: (case 1) the
1414                         // paragraph style allows parbreaks and no \begin, \end
1415                         // or \item tags are going to follow (i.e., if the next
1416                         // isn't the first or the current isn't the last
1417                         // paragraph of an environment or itemize) and the
1418                         // depth and alignment of the following paragraph is
1419                         // unchanged, or (case 2) the following is a
1420                         // non-environment paragraph whose depth is increased
1421                         // but whose alignment is unchanged, or (case 3) the
1422                         // paragraph is not an environment and the next one is a
1423                         // non-itemize-like env at lower depth, or (case 4) the
1424                         // paragraph is a command not followed by an environment
1425                         // and the alignment of the current and next paragraph
1426                         // is unchanged, or (case 5) the current alignment is
1427                         // changed and a standard paragraph follows.
1428                         DocumentClass const & tclass = bparams.documentClass();
1429                         if ((style == next_layout
1430                              && !style.parbreak_is_newline
1431                              && !text.inset().getLayout().parbreakIsNewline()
1432                              && !text.inset().getLayout().parbreakIgnored()
1433                              && style.latextype != LATEX_ITEM_ENVIRONMENT
1434                              && style.latextype != LATEX_LIST_ENVIRONMENT
1435                              && style.align == par.getAlign(bparams)
1436                              && nextpar->getDepth() == par.getDepth()
1437                              && nextpar->getAlign(bparams) == par.getAlign(bparams))
1438                             || (!next_layout.isEnvironment()
1439                                 && nextpar->getDepth() > par.getDepth()
1440                                 && nextpar->getAlign(bparams) == next_layout.align)
1441                             || (!style.isEnvironment()
1442                                 && next_layout.latextype == LATEX_ENVIRONMENT
1443                                 && nextpar->getDepth() < par.getDepth())
1444                             || (style.isCommand()
1445                                 && !next_layout.isEnvironment()
1446                                 && style.align == par.getAlign(bparams)
1447                                 && next_layout.align == nextpar->getAlign(bparams))
1448                             || (style.align != par.getAlign(bparams)
1449                                 && tclass.isDefaultLayout(next_layout))) {
1450                                 os << '\n';
1451                         }
1452                 }
1453         }
1454
1455         LYXERR(Debug::LATEX, "TeXOnePar for paragraph " << pit << " done; ptr "
1456                 << &par << " next " << nextpar);
1457
1458         return;
1459 }
1460
1461
1462 // LaTeX all paragraphs
1463 void latexParagraphs(Buffer const & buf,
1464                      Text const & text,
1465                      otexstream & os,
1466                      OutputParams const & runparams,
1467                      string const & everypar)
1468 {
1469         LASSERT(runparams.par_begin <= runparams.par_end,
1470                 { os << "% LaTeX Output Error\n"; return; } );
1471
1472         BufferParams const & bparams = buf.params();
1473         BufferParams const & mparams = buf.masterParams();
1474
1475         bool const maintext = text.isMainText();
1476         bool const is_child = buf.masterBuffer() != &buf;
1477         bool const multibib_child = maintext && is_child
1478                         && mparams.multibib == "child";
1479
1480         if (multibib_child && mparams.useBiblatex())
1481                 os << "\\newrefsection";
1482         else if (multibib_child && mparams.useBibtopic()
1483                  && !buf.masterBibInfo().empty()) {
1484                 os << "\\begin{btUnit}\n";
1485                 runparams.openbtUnit = true;
1486         }
1487
1488         // Open a CJK environment at the beginning of the main buffer
1489         // if the document's main encoding requires the CJK package
1490         // or the document encoding is utf8 and the CJK package is required
1491         // (but not in child documents or documents using system fonts):
1492         OutputState * state = getOutputState();
1493         if (maintext && !is_child && !bparams.useNonTeXFonts
1494             && (bparams.encoding().package() == Encoding::CJK
1495                         || (bparams.encoding().name() == "utf8"
1496                                 && runparams.use_CJK))
1497            ) {
1498                 docstring const cjkenc = bparams.encoding().iconvName() == "UTF-8"
1499                                                                  ? from_ascii("UTF8")
1500                                                                  : from_ascii(bparams.encoding().latexName());
1501                 os << "\\begin{CJK}{" << cjkenc
1502                    << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
1503                 state->open_encoding_ = CJK;
1504         }
1505         // if "auto begin" is switched off, explicitly switch the
1506         // language on at start
1507         string const mainlang = runparams.use_polyglossia
1508                 ? getPolyglossiaEnvName(bparams.language)
1509                 : bparams.language->babel();
1510         string const lang_begin_command = runparams.use_polyglossia ?
1511                 "\\begin{$$lang}$$opts" : lyxrc.language_command_begin;
1512         string const lang_end_command = runparams.use_polyglossia ?
1513                 "\\end{$$lang}" : lyxrc.language_command_end;
1514         bool const using_begin_end = runparams.use_polyglossia ||
1515                                         !lang_end_command.empty();
1516
1517         if (maintext && !lyxrc.language_auto_begin &&
1518             !mainlang.empty()) {
1519                 // FIXME UNICODE
1520                 string bc = runparams.use_polyglossia ?
1521                             getPolyglossiaBegin(lang_begin_command, mainlang,
1522                                                 bparams.language->polyglossiaOpts())
1523                           : subst(lang_begin_command, "$$lang", mainlang);
1524                 os << bc;
1525                 os << '\n';
1526                 if (using_begin_end)
1527                         pushLanguageName(mainlang);
1528         }
1529
1530         ParagraphList const & paragraphs = text.paragraphs();
1531
1532         if (runparams.par_begin == runparams.par_end) {
1533                 // The full doc will be exported but it is easier to just rely on
1534                 // runparams range parameters that will be passed TeXEnvironment.
1535                 runparams.par_begin = 0;
1536                 runparams.par_end = paragraphs.size();
1537         }
1538
1539         pit_type pit = runparams.par_begin;
1540         // lastpit is for the language check after the loop.
1541         pit_type lastpit = pit;
1542         // variables used in the loop:
1543         bool was_title = false;
1544         bool already_title = false;
1545         DocumentClass const & tclass = bparams.documentClass();
1546
1547         // Did we already warn about inTitle layout mixing? (we only warn once)
1548         bool gave_layout_warning = false;
1549         for (; pit < runparams.par_end; ++pit) {
1550                 lastpit = pit;
1551                 ParagraphList::const_iterator par = paragraphs.constIterator(pit);
1552
1553                 // FIXME This check should not be needed. We should
1554                 // perhaps issue an error if it is.
1555                 Layout const & layout = text.inset().forcePlainLayout() ?
1556                                 tclass.plainLayout() : par->layout();
1557
1558                 if (layout.intitle) {
1559                         if (already_title) {
1560                                 if (!gave_layout_warning && !runparams.dryrun) {
1561                                         gave_layout_warning = true;
1562                                         frontend::Alert::warning(_("Error in latexParagraphs"),
1563                                                         bformat(_("You are using at least one "
1564                                                           "layout (%1$s) intended for the title, "
1565                                                           "after using non-title layouts. This "
1566                                                           "could lead to missing or incorrect output."
1567                                                           ), layout.name()));
1568                                 }
1569                         } else if (!was_title) {
1570                                 was_title = true;
1571                                 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1572                                         os << "\\begin{"
1573                                                         << from_ascii(tclass.titlename())
1574                                                         << "}\n";
1575                                 }
1576                         }
1577                 } else if (was_title && !already_title && !layout.inpreamble) {
1578                         if (tclass.titletype() == TITLE_ENVIRONMENT) {
1579                                 os << "\\end{" << from_ascii(tclass.titlename())
1580                                                 << "}\n";
1581                         }
1582                         else {
1583                                 os << "\\" << from_ascii(tclass.titlename())
1584                                                 << "\n";
1585                         }
1586                         already_title = true;
1587                         was_title = false;
1588                 }
1589
1590                 if (layout.isCommand() && !layout.latexname().empty()
1591                     && layout.latexname() == bparams.multibib) {
1592                         if (runparams.openbtUnit)
1593                                 os << "\\end{btUnit}\n";
1594                         if (!bparams.useBiblatex()
1595                             && !buf.masterBibInfo().empty()) {
1596                                 os << '\n' << "\\begin{btUnit}\n";
1597                                 runparams.openbtUnit = true;
1598                         }
1599                 }
1600
1601                 if (!layout.isEnvironment() && par->params().leftIndent().zero()) {
1602                         // This is a standard top level paragraph, TeX it and continue.
1603                         TeXOnePar(buf, text, pit, os, runparams, everypar);
1604                         continue;
1605                 }
1606
1607                 TeXEnvironmentData const data =
1608                         prepareEnvironment(buf, text, par, os, runparams);
1609                 // pit can be changed in TeXEnvironment.
1610                 TeXEnvironment(buf, text, runparams, pit, os);
1611                 finishEnvironment(os, runparams, data);
1612         }
1613
1614         // FIXME: uncomment the content or remove this block
1615         if (pit == runparams.par_end) {
1616                         // Make sure that the last paragraph is
1617                         // correctly terminated (because TeXOnePar does
1618                         // not add a \n in this case)
1619                         //os << '\n';
1620         }
1621
1622         // It might be that we only have a title in this document
1623         if (was_title && !already_title) {
1624                 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1625                         os << "\\end{" << from_ascii(tclass.titlename())
1626                            << "}\n";
1627                 } else {
1628                         os << "\\" << from_ascii(tclass.titlename())
1629                            << "\n";
1630                 }
1631         }
1632
1633         if (maintext && !is_child && runparams.openbtUnit)
1634                 os << "\\end{btUnit}\n";
1635
1636         // if "auto end" is switched off, explicitly close the language at the end
1637         // but only if the last par is in a babel or polyglossia language
1638         Language const * const lastpar_language =
1639                         paragraphs.at(lastpit).getParLanguage(bparams);
1640         if (maintext && !lyxrc.language_auto_end && !mainlang.empty() &&
1641                 lastpar_language->encoding()->package() != Encoding::CJK) {
1642                 os << from_utf8(subst(lang_end_command,
1643                                         "$$lang",
1644                                         mainlang))
1645                         << '\n';
1646                 if (using_begin_end)
1647                         popLanguageName();
1648         }
1649
1650         // If the last paragraph is an environment, we'll have to close
1651         // CJK at the very end to do proper nesting.
1652         if (maintext && !is_child && state->open_encoding_ == CJK) {
1653                 os << "\\clearpage\n\\end{CJK}\n";
1654                 state->open_encoding_ = none;
1655         }
1656         // Likewise for polyglossia or when using begin/end commands
1657         // or at the very end of an active branch inset with a language switch
1658         Language const * const outer_language = (runparams.local_font != nullptr)
1659                         ? runparams.local_font->language() : bparams.language;
1660         string const & prev_lang = runparams.use_polyglossia
1661                         ? getPolyglossiaEnvName(outer_language)
1662                         : outer_language->babel();
1663         string const lastpar_lang = runparams.use_polyglossia ?
1664                 getPolyglossiaEnvName(lastpar_language): lastpar_language->babel();
1665         string const & cur_lang = openLanguageName(state);
1666         if (((runparams.inbranch && langOpenedAtThisLevel(state) && prev_lang != cur_lang)
1667              || (maintext && !is_child)) && !cur_lang.empty()) {
1668                 os << from_utf8(subst(lang_end_command,
1669                                         "$$lang",
1670                                         cur_lang))
1671                    << '\n';
1672                 if (using_begin_end)
1673                         popLanguageName();
1674         } else if (runparams.inbranch && !using_begin_end
1675                    && prev_lang != lastpar_lang && !lastpar_lang.empty()) {
1676                 // with !using_begin_end, cur_lang is empty, so we need to
1677                 // compare against the paragraph language (and we are in the
1678                 // last paragraph at this point)
1679                 os << subst(lang_begin_command, "$$lang", prev_lang) << '\n';
1680         }
1681
1682         // reset inherited encoding
1683         if (state->cjk_inherited_ > 0) {
1684                 state->cjk_inherited_ -= 1;
1685                 if (state->cjk_inherited_ == 0)
1686                         state->open_encoding_ = CJK;
1687         }
1688
1689         if (multibib_child && mparams.useBibtopic()) {
1690                 os << "\\end{btUnit}\n";
1691                 runparams.openbtUnit = false;
1692         }
1693 }
1694
1695 // Switch the input encoding for some part(s) of the document.
1696 pair<bool, int> switchEncoding(odocstream & os, BufferParams const & bparams,
1697                    OutputParams const & runparams, Encoding const & newEnc,
1698                    bool force, bool noswitchmacro)
1699 {
1700         // Never switch encoding with XeTeX/LuaTeX
1701         // or if we're in a moving argument or inherit the outer encoding.
1702         if (runparams.isFullUnicode() || newEnc.name() == "inherit")
1703                 return make_pair(false, 0);
1704
1705         // Only switch for auto-selected legacy encodings (inputenc setting
1706         // "auto-legacy" or "auto-legacy-plain").
1707         // The "listings" environment can force a switch also with other
1708         // encoding settings (it does not support variable width encodings
1709         // (utf8, jis, ...) under 8-bit latex engines).
1710         if (!force && ((bparams.inputenc != "auto-legacy" && bparams.inputenc != "auto-legacy-plain")
1711                                    || runparams.moving_arg))
1712                 return make_pair(false, 0);
1713
1714         Encoding const & oldEnc = *runparams.encoding;
1715         // Do not switch, if the encoding is unchanged or switching is not supported.
1716         if (oldEnc.name() == newEnc.name()
1717                 || oldEnc.package() == Encoding::japanese
1718                 || oldEnc.package() == Encoding::none
1719                 || newEnc.package() == Encoding::none
1720                 || runparams.for_search)
1721                 return make_pair(false, 0);
1722         // FIXME We ignore encoding switches from/to encodings that do
1723         // neither support the inputenc package nor the CJK package here.
1724         // This may fail for characters not supported by "unicodesymbols"
1725         // or for non-ASCII characters in "listings"
1726         // but it is the best we can do.
1727
1728         // change encoding
1729         LYXERR(Debug::LATEX, "Changing LaTeX encoding from "
1730                    << oldEnc.name() << " to " << newEnc.name());
1731         os << setEncoding(newEnc.iconvName());
1732         if (bparams.inputenc == "auto-legacy-plain")
1733           return make_pair(true, 0);
1734
1735         docstring const inputenc_arg(from_ascii(newEnc.latexName()));
1736         OutputState * state = getOutputState();
1737         switch (newEnc.package()) {
1738                 case Encoding::none:
1739                 case Encoding::japanese:
1740                         // shouldn't ever reach here (see above) but avoids warning.
1741                         return make_pair(true, 0);
1742                 case Encoding::inputenc: {
1743                         int count = inputenc_arg.length();
1744                         if (oldEnc.package() == Encoding::CJK &&
1745                             state->open_encoding_ == CJK) {
1746                                 os << "\\end{CJK}";
1747                                 state->open_encoding_ = none;
1748                                 count += 9;
1749                         }
1750                         else if (oldEnc.package() == Encoding::inputenc &&
1751                                  state->open_encoding_ == inputenc) {
1752                                 os << "\\egroup";
1753                                 state->open_encoding_ = none;
1754                                 count += 7;
1755                         }
1756                         if (runparams.local_font != nullptr
1757                             &&  oldEnc.package() == Encoding::CJK) {
1758                                 // within insets, \inputenc switches need
1759                                 // to be embraced within \bgroup...\egroup;
1760                                 // else CJK fails.
1761                                 os << "\\bgroup";
1762                                 count += 7;
1763                                 state->open_encoding_ = inputenc;
1764                         }
1765                         if (noswitchmacro)
1766                                 return make_pair(true, count);
1767                         os << "\\inputencoding{" << inputenc_arg << '}';
1768                         return make_pair(true, count + 16);
1769                 }
1770                 case Encoding::CJK: {
1771                         int count = inputenc_arg.length();
1772                         if (oldEnc.package() == Encoding::CJK &&
1773                             state->open_encoding_ == CJK) {
1774                                 os << "\\end{CJK}";
1775                                 count += 9;
1776                         }
1777                         if (oldEnc.package() == Encoding::inputenc &&
1778                             state->open_encoding_ == inputenc) {
1779                                 os << "\\egroup";
1780                                 count += 7;
1781                         }
1782                         os << "\\begin{CJK}{"
1783                            << from_ascii(newEnc.latexName()) << "}{"
1784                            << from_ascii(bparams.fonts_cjk) << "}";
1785                         state->open_encoding_ = CJK;
1786                         return make_pair(true, count + 15);
1787                 }
1788         }
1789         // Dead code to avoid a warning:
1790         return make_pair(true, 0);
1791 }
1792
1793 } // namespace lyx