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