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