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