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