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