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 "InsetList.h"
  19 #include "Language.h"
  20 #include "Layout.h"
  21 #include "LyXRC.h"
  22 #include "OutputParams.h"
  23 #include "Paragraph.h"
  24 #include "paragraph_funcs.h"
  25 #include "ParagraphParameters.h"
  26 #include "TextClass.h"
  27 #include "TexRow.h"
  28 #include "VSpace.h"
  29
  30 #include "insets/InsetBibitem.h"
  31 #include "insets/InsetOptArg.h"
  32
  33 #include "support/debug.h"
  34 #include "support/lstrings.h"
  35
  36 #include <boost/next_prior.hpp>
  37
  38 using namespace std;
  39 using namespace lyx::support;
  40
  41 namespace lyx {
  42
  43 namespace {
  44
  45
  46 enum OpenEncoding {
  47                 none,
  48                 inputenc,
  49                 CJK
  50         };
  51
  52 static int open_encoding_ = none;
  53 static bool cjk_inherited_ = false;
  54
  55
  56 ParagraphList::const_iterator
  57 TeXEnvironment(Buffer const & buf,
  58                Text const & text,
  59                ParagraphList::const_iterator pit,
  60                odocstream & os, TexRow & texrow,
  61                OutputParams const & runparams);
  62
  63 ParagraphList::const_iterator
  64 TeXOnePar(Buffer const & buf,
  65           Text const & text,
  66           ParagraphList::const_iterator pit,
  67           odocstream & os, TexRow & texrow,
  68           OutputParams const & runparams,
  69           string const & everypar = string());
  70
  71
  72 ParagraphList::const_iterator
  73 TeXDeeper(Buffer const & buf,
  74           Text const & text,
  75           ParagraphList::const_iterator pit,
  76           odocstream & os, TexRow & texrow,
  77           OutputParams const & runparams)
  78 {
  79         LYXERR(Debug::LATEX, "TeXDeeper...     " << &*pit);
  80         ParagraphList::const_iterator par = pit;
  81
  82         ParagraphList const & paragraphs = text.paragraphs();
  83
  84         while (par != paragraphs.end() &&
  85                      par->params().depth() == pit->params().depth()) {
  86                 if (par->layout()->isEnvironment()) {
  87                         par = TeXEnvironment(buf, text, par,
  88                                              os, texrow, runparams);
  89                 } else {
  90                         par = TeXOnePar(buf, text, par,
  91                                              os, texrow, runparams);
  92                 }
  93         }
  94         LYXERR(Debug::LATEX, "TeXDeeper...done ");
  95
  96         return par;
  97 }
  98
  99
 100 ParagraphList::const_iterator
 101 TeXEnvironment(Buffer const & buf,
 102                Text const & text,
 103                ParagraphList::const_iterator pit,
 104                odocstream & os, TexRow & texrow,
 105                OutputParams const & runparams)
 106 {
 107         LYXERR(Debug::LATEX, "TeXEnvironment...     " << &*pit);
 108
 109         BufferParams const & bparams = buf.params();
 110
 111         LayoutPtr const & style = pit->forceEmptyLayout() ?
 112                 &bparams.documentClass().emptyLayout() : pit->layout();
 113
 114         ParagraphList const & paragraphs = text.paragraphs();
 115
 116         Language const * const par_language = pit->getParLanguage(bparams);
 117         Language const * const doc_language = bparams.language;
 118         Language const * const prev_par_language =
 119                 (pit != paragraphs.begin())
 120                 ? boost::prior(pit)->getParLanguage(bparams)
 121                 : doc_language;
 122         if (par_language->babel() != prev_par_language->babel()) {
 123
 124                 if (!lyxrc.language_command_end.empty() &&
 125                     prev_par_language->babel() != doc_language->babel() &&
 126                     !prev_par_language->babel().empty()) {
 127                         os << from_ascii(subst(
 128                                 lyxrc.language_command_end,
 129                                 "$$lang",
 130                                 prev_par_language->babel()))
 131                            // the '%' is necessary to prevent unwanted whitespace
 132                            << "%\n";
 133                         texrow.newline();
 134                 }
 135
 136                 if ((lyxrc.language_command_end.empty() ||
 137                      par_language->babel() != doc_language->babel()) &&
 138                     !par_language->babel().empty()) {
 139                         os << from_ascii(subst(
 140                                 lyxrc.language_command_begin,
 141                                 "$$lang",
 142                                 par_language->babel()))
 143                            // the '%' is necessary to prevent unwanted whitespace
 144                            << "%\n";
 145                         texrow.newline();
 146                 }
 147         }
 148
 149         bool leftindent_open = false;
 150         if (!pit->params().leftIndent().zero()) {
 151                 os << "\\begin{LyXParagraphLeftIndent}{"
 152                    << from_ascii(pit->params().leftIndent().asLatexString())
 153                    << "}\n";
 154                 texrow.newline();
 155                 leftindent_open = true;
 156         }
 157
 158         if (style->isEnvironment()) {
 159                 os << "\\begin{" << from_ascii(style->latexname()) << '}';
 160                 if (style->optionalargs > 0) {
 161                         int ret = latexOptArgInsets(*pit, os, runparams,
 162                                                     style->optionalargs);
 163                         while (ret > 0) {
 164                                 texrow.newline();
 165                                 --ret;
 166                         }
 167                 }
 168                 if (style->latextype == LATEX_LIST_ENVIRONMENT) {
 169                         os << '{'
 170                            << pit->params().labelWidthString()
 171                            << "}\n";
 172                 } else if (style->labeltype == LABEL_BIBLIO) {
 173                         // ale970405
 174                         os << '{' << bibitemWidest(buf) << "}\n";
 175                 } else
 176                         os << from_ascii(style->latexparam()) << '\n';
 177                 texrow.newline();
 178         }
 179
 180         // in multilingual environments, the CJK tags have to be nested properly
 181         bool cjk_nested = false;
 182         if (par_language->encoding()->package() == Encoding::CJK &&
 183             open_encoding_ != CJK && pit->isMultiLingual(bparams)) {
 184                 os << "\\begin{CJK}{" << from_ascii(par_language->encoding()->latexName())
 185                    << "}{}%\n";
 186                 open_encoding_ = CJK;
 187                 cjk_nested = true;
 188                 texrow.newline();
 189         }
 190
 191         ParagraphList::const_iterator par = pit;
 192         do {
 193                 par = TeXOnePar(buf, text, par, os, texrow, runparams);
 194
 195                 if (par == paragraphs.end()) {
 196                         // Make sure that the last paragraph is
 197                         // correctly terminated (because TeXOnePar does
 198                         // not add a \n in this case)
 199                         os << '\n';
 200                         texrow.newline();
 201                 } else if (par->params().depth() > pit->params().depth()) {
 202                         if (par->layout()->isParagraph()) {
 203                           // Thinko!
 204                           // How to handle this? (Lgb)
 205                           //&& !suffixIs(os, "\n\n")
 206                                   //) {
 207
 208                                 // There should be at least one '\n' already
 209                                 // but we need there to be two for Standard
 210                                 // paragraphs that are depth-increment'ed to be
 211                                 // output correctly.  However, tables can
 212                                 // also be paragraphs so don't adjust them.
 213                                 // ARRae
 214                                 // Thinkee:
 215                                 // Will it ever harm to have one '\n' too
 216                                 // many? i.e. that we sometimes will have
 217                                 // three in a row. (Lgb)
 218                                 os << '\n';
 219                                 texrow.newline();
 220                         }
 221                         par = TeXDeeper(buf, text, par, os, texrow,
 222                                         runparams);
 223                 }
 224         } while (par != paragraphs.end()
 225                  && par->layout() == pit->layout()
 226                  && par->params().depth() == pit->params().depth()
 227                  && par->params().leftIndent() == pit->params().leftIndent());
 228
 229         if (open_encoding_ == CJK && cjk_nested) {
 230                 // We need to close the encoding even if it does not change
 231                 // to do correct environment nesting
 232                 os << "\\end{CJK}\n";
 233                 texrow.newline();
 234                 open_encoding_ = none;
 235         }
 236
 237         if (style->isEnvironment()) {
 238                 os << "\\end{" << from_ascii(style->latexname()) << "}\n";
 239                 texrow.newline();
 240         }
 241
 242         if (leftindent_open) {
 243                 os << "\\end{LyXParagraphLeftIndent}\n";
 244                 texrow.newline();
 245         }
 246
 247         if (par != paragraphs.end())
 248                 LYXERR(Debug::LATEX, "TeXEnvironment...done " << &*par);
 249
 250         return par;
 251 }
 252
 253 }
 254
 255
 256 int latexOptArgInsets(Paragraph const & par, odocstream & os,
 257         OutputParams const & runparams, int number)
 258 {
 259         int lines = 0;
 260
 261         InsetList::const_iterator it = par.insetList().begin();
 262         InsetList::const_iterator end = par.insetList().end();
 263         for (; it != end && number > 0 ; ++it) {
 264                 if (it->inset->lyxCode() == OPTARG_CODE) {
 265                         InsetOptArg * ins =
 266                                 static_cast<InsetOptArg *>(it->inset);
 267                         lines += ins->latexOptional(os, runparams);
 268                         --number;
 269                 }
 270         }
 271         return lines;
 272 }
 273
 274
 275 namespace {
 276
 277 ParagraphList::const_iterator
 278 TeXOnePar(Buffer const & buf,
 279           Text const & text,
 280           ParagraphList::const_iterator pit,
 281           odocstream & os, TexRow & texrow,
 282           OutputParams const & runparams_in,
 283           string const & everypar)
 284 {
 285         LYXERR(Debug::LATEX, "TeXOnePar...     " << &*pit << " '"
 286                 << everypar << "'");
 287         BufferParams const & bparams = buf.params();
 288         ParagraphList const & paragraphs = text.paragraphs();
 289
 290         if (runparams_in.verbatim) {
 291                 int const dist = distance(paragraphs.begin(), pit);
 292                 Font const outerfont = outerFont(dist, paragraphs);
 293
 294                 // No newline if only one paragraph in this lyxtext
 295                 if (dist > 0) {
 296                         os << '\n';
 297                         texrow.newline();
 298                 }
 299
 300                 /*bool need_par = */ pit->latex(bparams, outerfont,
 301                         os, texrow, runparams_in);
 302
 303                 return ++pit;
 304         }
 305
 306         // FIXME This comment doesn't make sense. What's the
 307         // length got to do with forceEmptyLayout()? I.e., what
 308         // was forceDefaultParagraphs()?
 309         // In an inset with unlimited length (all in one row),
 310         // force layout to default
 311         LayoutPtr const style = pit->forceEmptyLayout() ?
 312                 &bparams.documentClass().emptyLayout() : pit->layout();
 313
 314         OutputParams runparams = runparams_in;
 315         runparams.moving_arg |= style->needprotect;
 316
 317         bool const maintext = text.isMainText(buf);
 318         // we are at the beginning of an inset and CJK is already open.
 319         if (pit == paragraphs.begin() && !maintext && open_encoding_ == CJK) {
 320                 cjk_inherited_ = true;
 321                 open_encoding_ = none;
 322         }
 323
 324         // This paragraph's language
 325         Language const * const par_language = pit->getParLanguage(bparams);
 326         // The document's language
 327         Language const * const doc_language = bparams.language;
 328         // The language that was in effect when the environment this paragraph is
 329         // inside of was opened
 330         Language const * const outer_language =
 331                 (runparams.local_font != 0) ?
 332                         runparams.local_font->language() : doc_language;
 333         // The previous language that was in effect is either the language of
 334         // the previous paragraph, if there is one, or else the outer language
 335         // if there is no previous paragraph
 336         Language const * const prev_language =
 337                 (pit != paragraphs.begin()) ?
 338                         boost::prior(pit)->getParLanguage(bparams) : outer_language;
 339
 340         if (par_language->babel() != prev_language->babel()
 341             // check if we already put language command in TeXEnvironment()
 342             && !(style->isEnvironment()
 343                  && (pit == paragraphs.begin() ||
 344                      (boost::prior(pit)->layout() != pit->layout() &&
 345                       boost::prior(pit)->getDepth() <= pit->getDepth())
 346                      || boost::prior(pit)->getDepth() < pit->getDepth())))
 347         {
 348                 if (!lyxrc.language_command_end.empty() &&
 349                     prev_language->babel() != outer_language->babel() &&
 350                     !prev_language->babel().empty())
 351                 {
 352                         os << from_ascii(subst(lyxrc.language_command_end,
 353                                 "$$lang",
 354                                 prev_language->babel()))
 355                            // the '%' is necessary to prevent unwanted whitespace
 356                            << "%\n";
 357                         texrow.newline();
 358                 }
 359
 360                 // We need to open a new language if we couldn't close the previous
 361                 // one (because there's no language_command_end); and even if we closed
 362                 // the previous one, if the current language is different than the
 363                 // outer_language (which is currently in effect once the previous one
 364                 // is closed).
 365                 if ((lyxrc.language_command_end.empty() ||
 366                      par_language->babel() != outer_language->babel()) &&
 367                     !par_language->babel().empty()) {
 368                         // If we're inside an inset, and that inset is within an \L or \R
 369                         // (or equivalents), then within the inset, too, any opposite
 370                         // language paragraph should appear within an \L or \R (in addition
 371                         // to, outside of, the normal language switch commands).
 372                         // This behavior is not correct for ArabTeX, though.
 373                         if (    // not for ArabTeX
 374                                         (par_language->lang() != "arabic_arabtex" &&
 375                                          outer_language->lang() != "arabic_arabtex") &&
 376                                         // are we in an inset?
 377                                         runparams.local_font != 0 &&
 378                                         // is the inset within an \L or \R?
 379                                         //
 380                                         // FIXME: currently, we don't check this; this means that
 381                                         // we'll have unnnecessary \L and \R commands, but that
 382                                         // doesn't seem to hurt (though latex will complain)
 383                                         //
 384                                         // is this paragraph in the opposite direction?
 385                                         runparams.local_font->isRightToLeft() !=
 386                                                 par_language->rightToLeft()
 387                                 ) {
 388                                 // FIXME: I don't have a working copy of the Arabi package, so
 389                                 // I'm not sure if the farsi and arabic_arabi stuff is correct
 390                                 // or not...
 391                                 if (par_language->lang() == "farsi")
 392                                         os << "\\textFR{";
 393                                 else if (outer_language->lang() == "farsi")
 394                                         os << "\\textLR{";
 395                                 else if (par_language->lang() == "arabic_arabi")
 396                                         os << "\\textAR{";
 397                                 else if (outer_language->lang() == "arabic_arabi")
 398                                         os << "\\textLR{";
 399                                 // remaining RTL languages currently is hebrew
 400                                 else if (par_language->rightToLeft())
 401                                         os << "\\R{";
 402                                 else
 403                                         os << "\\L{";
 404                         }
 405                         // With CJK, the CJK tag has to be closed first (see below)
 406                         if (runparams.encoding->package() != Encoding::CJK) {
 407                                 os << from_ascii(subst(
 408                                         lyxrc.language_command_begin,
 409                                         "$$lang",
 410                                         par_language->babel()))
 411                                    // the '%' is necessary to prevent unwanted whitespace
 412                                    << "%\n";
 413                                 texrow.newline();
 414                         }
 415                 }
 416         }
 417
 418         // Switch file encoding if necessary; no need to do this for "default"
 419         // encoding, since this only affects the position of the outputted
 420         // \inputencoding command; the encoding switch will occur when necessary
 421         if (bparams.inputenc == "auto" &&
 422             runparams.encoding->package() != Encoding::none) {
 423                 // Look ahead for future encoding changes.
 424                 // We try to output them at the beginning of the paragraph,
 425                 // since the \inputencoding command is not allowed e.g. in
 426                 // sections.
 427                 for (pos_type i = 0; i < pit->size(); ++i) {
 428                         char_type const c = pit->getChar(i);
 429                         Encoding const * const encoding =
 430                                 pit->getFontSettings(bparams, i).language()->encoding();
 431                         if (encoding->package() != Encoding::CJK &&
 432                             runparams.encoding->package() == Encoding::inputenc &&
 433                             c < 0x80)
 434                                 continue;
 435                         if (pit->isInset(i))
 436                                 break;
 437                         // All characters before c are in the ASCII range, and
 438                         // c is non-ASCII (but no inset), so change the
 439                         // encoding to that required by the language of c.
 440                         // With CJK, only add switch if we have CJK content at the beginning
 441                         // of the paragraph
 442                         if (encoding->package() != Encoding::CJK || i == 0) {
 443                                 OutputParams tmp_rp = runparams;
 444                                 runparams.moving_arg = false;
 445                                 pair<bool, int> enc_switch = switchEncoding(os, bparams, runparams,
 446                                         *encoding);
 447                                 runparams = tmp_rp;
 448                                 // the following is necessary after a CJK environment in a multilingual
 449                                 // context (nesting issue).
 450                                 if (par_language->encoding()->package() == Encoding::CJK &&
 451                                     open_encoding_ != CJK && !cjk_inherited_) {
 452                                         os << "\\begin{CJK}{" << from_ascii(par_language->encoding()->latexName())
 453                                            << "}{}%\n";
 454                                         open_encoding_ = CJK;
 455                                         texrow.newline();
 456                                 }
 457                                 if (encoding->package() != Encoding::none && enc_switch.first) {
 458                                         if (enc_switch.second > 0) {
 459                                                 // the '%' is necessary to prevent unwanted whitespace
 460                                                 os << "%\n";
 461                                                 texrow.newline();
 462                                         }
 463                                         // With CJK, the CJK tag had to be closed first (see above)
 464                                         if (runparams.encoding->package() == Encoding::CJK) {
 465                                                 os << from_ascii(subst(
 466                                                         lyxrc.language_command_begin,
 467                                                         "$$lang",
 468                                                         par_language->babel()))
 469                                                 // the '%' is necessary to prevent unwanted whitespace
 470                                                 << "%\n";
 471                                                 texrow.newline();
 472                                         }
 473                                         runparams.encoding = encoding;
 474                                 }
 475                                 break;
 476                         }
 477                 }
 478         }
 479
 480         bool const useSetSpace = bparams.documentClass().provides("SetSpace");
 481         if (pit->allowParagraphCustomization()) {
 482                 if (pit->params().startOfAppendix()) {
 483                         os << "\\appendix\n";
 484                         texrow.newline();
 485                 }
 486
 487                 if (!pit->params().spacing().isDefault()
 488                         && (pit == paragraphs.begin()
 489                             || !boost::prior(pit)->hasSameLayout(*pit)))
 490                 {
 491                         os << from_ascii(pit->params().spacing().writeEnvirBegin(useSetSpace))
 492                             << '\n';
 493                         texrow.newline();
 494                 }
 495
 496                 if (style->isCommand()) {
 497                         os << '\n';
 498                         texrow.newline();
 499                 }
 500         }
 501
 502         switch (style->latextype) {
 503         case LATEX_COMMAND:
 504                 os << '\\' << from_ascii(style->latexname());
 505
 506                 // Separate handling of optional argument inset.
 507                 if (style->optionalargs > 0) {
 508                         int ret = latexOptArgInsets(*pit, os, runparams,
 509                                                     style->optionalargs);
 510                         while (ret > 0) {
 511                                 texrow.newline();
 512                                 --ret;
 513                         }
 514                 }
 515                 else
 516                         os << from_ascii(style->latexparam());
 517                 break;
 518         case LATEX_ITEM_ENVIRONMENT:
 519         case LATEX_LIST_ENVIRONMENT:
 520                 os << "\\item ";
 521                 break;
 522         case LATEX_BIB_ENVIRONMENT:
 523                 // ignore this, the inset will write itself
 524                 break;
 525         default:
 526                 break;
 527         }
 528
 529         Font const outerfont = outerFont(distance(paragraphs.begin(), pit),
 530                           paragraphs);
 531
 532         // FIXME UNICODE
 533         os << from_utf8(everypar);
 534         bool need_par = pit->latex(bparams, outerfont,
 535                                              os, texrow, runparams);
 536
 537         // Make sure that \\par is done with the font of the last
 538         // character if this has another size as the default.
 539         // This is necessary because LaTeX (and LyX on the screen)
 540         // calculates the space between the baselines according
 541         // to this font. (Matthias)
 542         //
 543         // Is this really needed ? (Dekel)
 544         // We do not need to use to change the font for the last paragraph
 545         // or for a command.
 546
 547         Font const font = pit->empty()
 548                  ? pit->getLayoutFont(bparams, outerfont)
 549                  : pit->getFont(bparams, pit->size() - 1, outerfont);
 550
 551         bool is_command = style->isCommand();
 552
 553         if (style->resfont.size() != font.fontInfo().size()
 554             && boost::next(pit) != paragraphs.end()
 555             && !is_command) {
 556                 if (!need_par)
 557                         os << '{';
 558                 os << "\\" << from_ascii(font.latexSize()) << " \\par}";
 559         } else if (need_par) {
 560                 os << "\\par}";
 561         } else if (is_command)
 562                 os << '}';
 563
 564         bool pending_newline = false;
 565         switch (style->latextype) {
 566         case LATEX_ITEM_ENVIRONMENT:
 567         case LATEX_LIST_ENVIRONMENT:
 568                 if (boost::next(pit) != paragraphs.end()
 569                     && (pit->params().depth() < boost::next(pit)->params().depth()))
 570                         pending_newline = true;
 571                 break;
 572         case LATEX_ENVIRONMENT: {
 573                 // if its the last paragraph of the current environment
 574                 // skip it otherwise fall through
 575                 ParagraphList::const_iterator next = boost::next(pit);
 576
 577                 if (next != paragraphs.end()
 578                     && (next->layout() != pit->layout()
 579                         || next->params().depth() != pit->params().depth()))
 580                         break;
 581         }
 582
 583                 // fall through possible
 584         default:
 585                 // we don't need it for the last paragraph!!!
 586                 if (boost::next(pit) != paragraphs.end())
 587                         pending_newline = true;
 588         }
 589
 590         if (pit->allowParagraphCustomization()) {
 591                 if (!pit->params().spacing().isDefault()
 592                         && (boost::next(pit) == paragraphs.end()
 593                             || !boost::next(pit)->hasSameLayout(*pit)))
 594                 {
 595                         if (pending_newline) {
 596                                 os << '\n';
 597                                 texrow.newline();
 598                         }
 599                         os << from_ascii(pit->params().spacing().writeEnvirEnd(useSetSpace));
 600                         pending_newline = true;
 601                 }
 602         }
 603
 604         // Closing the language is needed for the last paragraph; it is also
 605         // needed if we're within an \L or \R that we may have opened above (not
 606         // necessarily in this paragraph) and are about to close.
 607         bool closing_rtl_ltr_environment =
 608                 // not for ArabTeX
 609                 (par_language->lang() != "arabic_arabtex" &&
 610                  outer_language->lang() != "arabic_arabtex") &&
 611                 // have we opened and \L or \R environment?
 612                 runparams.local_font != 0 &&
 613                 runparams.local_font->isRightToLeft() != par_language->rightToLeft() &&
 614                 // are we about to close the language?
 615                 ((boost::next(pit) != paragraphs.end() &&
 616                   par_language->babel() !=
 617                         (boost::next(pit)->getParLanguage(bparams))->babel()) ||
 618                  (boost::next(pit) == paragraphs.end() &&
 619                   par_language->babel() != outer_language->babel()));
 620
 621         if (closing_rtl_ltr_environment || (boost::next(pit) == paragraphs.end()
 622             && par_language->babel() != outer_language->babel())) {
 623                 // Since \selectlanguage write the language to the aux file,
 624                 // we need to reset the language at the end of footnote or
 625                 // float.
 626
 627                 if (pending_newline) {
 628                         os << '\n';
 629                         texrow.newline();
 630                 }
 631                 // when the paragraph uses CJK, the language has to be closed earlier
 632                 if (font.language()->encoding()->package() != Encoding::CJK) {
 633                         if (lyxrc.language_command_end.empty()) {
 634                                 if (!prev_language->babel().empty()) {
 635                                         os << from_ascii(subst(
 636                                                 lyxrc.language_command_begin,
 637                                                 "$$lang",
 638                                                 prev_language->babel()));
 639                                         pending_newline = true;
 640                                 }
 641                         } else if (!par_language->babel().empty()) {
 642                                 os << from_ascii(subst(
 643                                         lyxrc.language_command_end,
 644                                         "$$lang",
 645                                         par_language->babel()));
 646                                 pending_newline = true;
 647                         }
 648                 }
 649         }
 650         if (closing_rtl_ltr_environment)
 651                 os << "}";
 652
 653         if (pending_newline) {
 654                 os << '\n';
 655                 texrow.newline();
 656         }
 657
 658         // if this is a CJK-paragraph and the next isn't, close CJK
 659         // also if the next paragraph is a multilingual environment (because of nesting)
 660         if (boost::next(pit) != paragraphs.end() && open_encoding_ == CJK &&
 661             (boost::next(pit)->getParLanguage(bparams)->encoding()->package() != Encoding::CJK ||
 662              boost::next(pit)->layout()->isEnvironment() && boost::next(pit)->isMultiLingual(bparams))
 663              // in environments, CJK has to be closed later (nesting!)
 664              && !style->isEnvironment()) {
 665                 os << "\\end{CJK}\n";
 666                 open_encoding_ = none;
 667         }
 668
 669         // If this is the last paragraph, close the CJK environment
 670         // if necessary. If it's an environment, we'll have to \end that first.
 671         if (boost::next(pit) == paragraphs.end() && !style->isEnvironment()) {
 672                 switch (open_encoding_) {
 673                         case CJK: {
 674                                 // end of main text
 675                                 if (maintext) {
 676                                         os << '\n';
 677                                         texrow.newline();
 678                                         os << "\\end{CJK}\n";
 679                                         texrow.newline();
 680                                 // end of an inset
 681                                 } else
 682                                         os << "\\end{CJK}";
 683                                 open_encoding_ = none;
 684                                 break;
 685                         }
 686                         case inputenc: {
 687                                 os << "\\egroup";
 688                                 open_encoding_ = none;
 689                                 break;
 690                         }
 691                         case none:
 692                         default:
 693                                 // do nothing
 694                                 break;
 695                 }
 696         }
 697
 698         // If this is the last paragraph, and a local_font was set upon entering
 699         // the inset, the encoding should be set back to that local_font's
 700         // encoding. We don't use switchEncoding(), because no explicit encoding
 701         // switch command is needed, since latex will automatically revert to it
 702         // when this inset closes.
 703         // This switch is only necessary if we're using "auto" or "default"
 704         // encoding.
 705         if (boost::next(pit) == paragraphs.end() && runparams_in.local_font != 0) {
 706                 runparams_in.encoding = runparams_in.local_font->language()->encoding();
 707                 if (bparams.inputenc == "auto" || bparams.inputenc == "default")
 708                         os << setEncoding(runparams_in.encoding->iconvName());
 709
 710         }
 711         // Otherwise, the current encoding should be set for the next paragraph.
 712         else
 713                 runparams_in.encoding = runparams.encoding;
 714
 715
 716         // we don't need it for the last paragraph!!!
 717         // Note from JMarc: we will re-add a \n explicitely in
 718         // TeXEnvironment, because it is needed in this case
 719         if (boost::next(pit) != paragraphs.end()) {
 720                 os << '\n';
 721                 texrow.newline();
 722         }
 723
 724         if (boost::next(pit) != paragraphs.end())
 725                 LYXERR(Debug::LATEX, "TeXOnePar...done " << &*boost::next(pit));
 726
 727         return ++pit;
 728 }
 729
 730 } // anon namespace
 731
 732
 733 // LaTeX all paragraphs
 734 void latexParagraphs(Buffer const & buf,
 735                      Text const & text,
 736                      odocstream & os,
 737                      TexRow & texrow,
 738                      OutputParams const & runparams,
 739                      string const & everypar)
 740 {
 741         bool was_title = false;
 742         bool already_title = false;
 743         BufferParams const & bparams = buf.params();
 744         DocumentClass const & tclass = bparams.documentClass();
 745         ParagraphList const & paragraphs = text.paragraphs();
 746         ParagraphList::const_iterator par = paragraphs.begin();
 747         ParagraphList::const_iterator endpar = paragraphs.end();
 748
 749         BOOST_ASSERT(runparams.par_begin <= runparams.par_end);
 750         // if only part of the paragraphs will be outputed
 751         if (runparams.par_begin !=  runparams.par_end) {
 752                 par = boost::next(paragraphs.begin(), runparams.par_begin);
 753                 endpar = boost::next(paragraphs.begin(), runparams.par_end);
 754                 // runparams will be passed to nested paragraphs, so
 755                 // we have to reset the range parameters.
 756                 const_cast<OutputParams&>(runparams).par_begin = 0;
 757                 const_cast<OutputParams&>(runparams).par_end = 0;
 758         }
 759
 760         bool const maintext = text.isMainText(buf);
 761
 762         // Open a CJK environment at the beginning of the main buffer
 763         // if the document's language is a CJK language
 764         if (maintext && bparams.encoding().package() == Encoding::CJK) {
 765                 os << "\\begin{CJK}{" << from_ascii(bparams.encoding().latexName())
 766                 << "}{}%\n";
 767                 texrow.newline();
 768                 open_encoding_ = CJK;
 769         }
 770         // if "auto begin" is switched off, explicitely switch the
 771         // language on at start
 772         if (maintext && !lyxrc.language_auto_begin &&
 773             !bparams.language->babel().empty()) {
 774                 // FIXME UNICODE
 775                 os << from_utf8(subst(lyxrc.language_command_begin,
 776                                         "$$lang",
 777                                         bparams.language->babel()))
 778                         << '\n';
 779         texrow.newline();
 780         }
 781
 782         ParagraphList::const_iterator lastpar;
 783         // if only_body
 784         while (par != endpar) {
 785                 lastpar = par;
 786                 // well we have to check if we are in an inset with unlimited
 787                 // length (all in one row) if that is true then we don't allow
 788                 // any special options in the paragraph and also we don't allow
 789                 // any environment other than the default layout of the
 790                 // text class to be valid!
 791                 if (par->allowParagraphCustomization()) {
 792                         LayoutPtr const & layout = par->forceEmptyLayout() ?
 793                                         &tclass.emptyLayout() :
 794                                         par->layout();
 795
 796                         if (layout->intitle) {
 797                                 if (already_title) {
 798                                         lyxerr << "Error in latexParagraphs: You"
 799                                                 " should not mix title layouts"
 800                                                 " with normal ones." << endl;
 801                                 } else if (!was_title) {
 802                                         was_title = true;
 803                                         if (tclass.titletype() == TITLE_ENVIRONMENT) {
 804                                                 os << "\\begin{"
 805                                                     << from_ascii(tclass.titlename())
 806                                                     << "}\n";
 807                                                 texrow.newline();
 808                                         }
 809                                 }
 810                         } else if (was_title && !already_title) {
 811                                 if (tclass.titletype() == TITLE_ENVIRONMENT) {
 812                                         os << "\\end{" << from_ascii(tclass.titlename())
 813                                             << "}\n";
 814                                 }
 815                                 else {
 816                                         os << "\\" << from_ascii(tclass.titlename())
 817                                             << "\n";
 818                                 }
 819                                 texrow.newline();
 820                                 already_title = true;
 821                                 was_title = false;
 822                         }
 823
 824                         if (layout->is_environment) {
 825                                 par = TeXOnePar(buf, text, par, os, texrow,
 826                                                 runparams, everypar);
 827                         } else if (layout->isEnvironment() ||
 828                                    !par->params().leftIndent().zero()) {
 829                                 par = TeXEnvironment(buf, text, par, os,
 830                                                      texrow, runparams);
 831                         } else {
 832                                 par = TeXOnePar(buf, text, par, os, texrow,
 833                                                 runparams, everypar);
 834                         }
 835                 } else {
 836                         par = TeXOnePar(buf, text, par, os, texrow,
 837                                         runparams, everypar);
 838                 }
 839                 if (distance(lastpar, par) >= distance(lastpar, endpar))
 840                         break;
 841         }
 842         // It might be that we only have a title in this document
 843         if (was_title && !already_title) {
 844                 if (tclass.titletype() == TITLE_ENVIRONMENT) {
 845                         os << "\\end{" << from_ascii(tclass.titlename())
 846                             << "}\n";
 847                 }
 848                 else {
 849                         os << "\\" << from_ascii(tclass.titlename())
 850                             << "\n";
 851                                 }
 852                 texrow.newline();
 853         }
 854         // if "auto end" is switched off, explicitely close the language at the end
 855         // but only if the last par is in a babel language
 856         if (maintext && !lyxrc.language_auto_end && !bparams.language->babel().empty() &&
 857                 lastpar->getParLanguage(bparams)->encoding()->package() != Encoding::CJK) {
 858                 os << from_utf8(subst(lyxrc.language_command_end,
 859                                         "$$lang",
 860                                         bparams.language->babel()))
 861                         << '\n';
 862                 texrow.newline();
 863         }
 864         // If the last paragraph is an environment, we'll have to close
 865         // CJK at the very end to do proper nesting.
 866         if (maintext && open_encoding_ == CJK) {
 867                 os << "\\end{CJK}\n";
 868                 texrow.newline();
 869                 open_encoding_ = none;
 870         }
 871         // reset inherited encoding
 872         if (cjk_inherited_) {
 873                 open_encoding_ = CJK;
 874                 cjk_inherited_ = false;
 875         }
 876 }
 877
 878
 879 pair<bool, int> switchEncoding(odocstream & os, BufferParams const & bparams,
 880                    OutputParams const & runparams, Encoding const & newEnc)
 881 {
 882         Encoding const oldEnc = *runparams.encoding;
 883         bool moving_arg = runparams.moving_arg;
 884         if ((bparams.inputenc != "auto" && bparams.inputenc != "default")
 885                 || moving_arg)
 886                 return make_pair(false, 0);
 887
 888         // Do nothing if the encoding is unchanged.
 889         if (oldEnc.name() == newEnc.name())
 890                 return make_pair(false, 0);
 891
 892         // FIXME We ignore encoding switches from/to encodings that do
 893         // neither support the inputenc package nor the CJK package here.
 894         // This does of course only work in special cases (e.g. switch from
 895         // tis620-0 to latin1, but the text in latin1 contains ASCII only),
 896         // but it is the best we can do
 897         if (oldEnc.package() == Encoding::none
 898                 || newEnc.package() == Encoding::none)
 899                 return make_pair(false, 0);
 900
 901         LYXERR(Debug::LATEX, "Changing LaTeX encoding from "
 902                 << oldEnc.name() << " to " << newEnc.name());
 903         os << setEncoding(newEnc.iconvName());
 904         if (bparams.inputenc == "default")
 905                 return make_pair(true, 0);
 906
 907         docstring const inputenc_arg(from_ascii(newEnc.latexName()));
 908         switch (newEnc.package()) {
 909                 case Encoding::none:
 910                         // shouldn't ever reach here, see above
 911                         return make_pair(true, 0);
 912                 case Encoding::inputenc: {
 913                         int count = inputenc_arg.length();
 914                         if (oldEnc.package() == Encoding::CJK &&
 915                             open_encoding_ == CJK) {
 916                                 os << "\\end{CJK}";
 917                                 open_encoding_ = none;
 918                                 count += 9;
 919                         }
 920                         else if (oldEnc.package() == Encoding::inputenc &&
 921                                  open_encoding_ == inputenc) {
 922                                 os << "\\egroup";
 923                                 open_encoding_ = none;
 924                                 count += 7;
 925                         }
 926                         if (runparams.local_font != 0 && oldEnc.package() == Encoding::CJK) {
 927                                 // within insets, \inputenc switches need to be
 928                                 // embraced within \bgroup ... \egroup; else CJK fails.
 929                                 os << "\\bgroup";
 930                                 count += 7;
 931                                 open_encoding_ = inputenc;
 932                         }
 933                         os << "\\inputencoding{" << inputenc_arg << '}';
 934                         return make_pair(true, count + 16);
 935                 }
 936                 case Encoding::CJK: {
 937                         int count = inputenc_arg.length();
 938                         if (oldEnc.package() == Encoding::CJK &&
 939                             open_encoding_ == CJK) {
 940                                 os << "\\end{CJK}";
 941                                 count += 9;
 942                         }
 943                         if (oldEnc.package() == Encoding::inputenc &&
 944                             open_encoding_ == inputenc) {
 945                                 os << "\\egroup";
 946                                 count += 7;
 947                         }
 948                         os << "\\begin{CJK}{" << inputenc_arg << "}{}";
 949                         open_encoding_ = CJK;
 950                         return make_pair(true, count + 15);
 951                 }
 952         }
 953         // Dead code to avoid a warning:
 954         return make_pair(true, 0);
 955
 956 }
 957
 958 } // namespace lyx