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.
6 * \author Lars Gullik Bjønnes
8 * Full author contact details are available in file CREDITS.
13 #include "output_latex.h"
16 #include "BufferParams.h"
19 #include "InsetList.h"
23 #include "OutputParams.h"
24 #include "Paragraph.h"
25 #include "ParagraphParameters.h"
26 #include "TextClass.h"
30 #include "insets/InsetBibitem.h"
31 #include "insets/InsetArgument.h"
33 #include "support/lassert.h"
34 #include "support/debug.h"
35 #include "support/lstrings.h"
37 #include <boost/next_prior.hpp>
41 using namespace lyx::support;
54 static int open_encoding_ = none;
55 static int cjk_inherited_ = 0;
56 Language const * prev_env_language_ = 0;
59 string const getPolyglossiaEnvName(Language const * lang)
61 string result = lang->polyglossia();
62 if (result == "arabic")
63 // exceptional spelling; see polyglossia docs.
69 struct TeXEnvironementData
73 Language const * par_language;
74 Encoding const * prev_encoding;
79 static TeXEnvironementData prepareEnvironement(Buffer const & buf, Text const & text,
80 ParagraphList::const_iterator pit, odocstream & os, TexRow & texrow,
81 OutputParams const & runparams)
83 TeXEnvironementData data;
85 BufferParams const & bparams = buf.params();
87 // FIXME This test should not be necessary.
88 // We should perhaps issue an error if it is.
89 Layout const & style = text.inset().forcePlainLayout() ?
90 bparams.documentClass().plainLayout() : pit->layout();
92 ParagraphList const & paragraphs = text.paragraphs();
93 ParagraphList::const_iterator const priorpit =
94 pit == paragraphs.begin() ? pit : boost::prior(pit);
96 bool const use_prev_env_language = prev_env_language_ != 0
97 && priorpit->layout().isEnvironment()
98 && (priorpit->getDepth() > pit->getDepth()
99 || (priorpit->getDepth() == pit->getDepth()
100 && priorpit->layout() != pit->layout()));
102 data.prev_encoding = runparams.encoding;
103 data.par_language = pit->getParLanguage(bparams);
104 Language const * const doc_language = bparams.language;
105 Language const * const prev_par_language =
106 (pit != paragraphs.begin())
107 ? (use_prev_env_language ? prev_env_language_
108 : priorpit->getParLanguage(bparams))
110 string par_lang = data.par_language->babel();
111 string prev_par_lang = prev_par_language->babel();
112 string doc_lang = doc_language->babel();
113 string lang_begin_command = lyxrc.language_command_begin;
114 string lang_end_command = lyxrc.language_command_end;
116 if (runparams.use_polyglossia) {
117 par_lang = getPolyglossiaEnvName(data.par_language);
118 prev_par_lang = getPolyglossiaEnvName(prev_par_language);
119 doc_lang = getPolyglossiaEnvName(doc_language);
120 lang_begin_command = "\\begin{$$lang}";
121 lang_end_command = "\\end{$$lang}";
124 if (par_lang != prev_par_lang) {
125 if (!lang_end_command.empty() &&
126 prev_par_lang != doc_lang &&
127 !prev_par_lang.empty()) {
128 os << from_ascii(subst(
132 // the '%' is necessary to prevent unwanted whitespace
137 if ((lang_end_command.empty() ||
138 par_lang != doc_lang) &&
140 os << from_ascii(subst(
144 if (runparams.use_polyglossia
145 && !data.par_language->polyglossiaOpts().empty())
147 << from_ascii(data.par_language->polyglossiaOpts())
149 // the '%' is necessary to prevent unwanted whitespace
155 data.leftindent_open = false;
156 if (!pit->params().leftIndent().zero()) {
157 os << "\\begin{LyXParagraphLeftIndent}{"
158 << from_ascii(pit->params().leftIndent().asLatexString())
161 data.leftindent_open = true;
164 if (style.isEnvironment()) {
165 os << "\\begin{" << from_ascii(style.latexname()) << '}';
166 if (style.optargs != 0 || style.reqargs != 0) {
167 int ret = latexArgInsets(*pit, os, runparams, style.reqargs, style.optargs);
173 if (style.latextype == LATEX_LIST_ENVIRONMENT) {
175 << pit->params().labelWidthString()
177 } else if (style.labeltype == LABEL_BIBLIO) {
178 if (pit->params().labelWidthString().empty())
179 os << '{' << bibitemWidest(buf, runparams) << "}\n";
182 << pit->params().labelWidthString()
185 os << from_ascii(style.latexparam()) << '\n';
190 // in multilingual environments, the CJK tags have to be nested properly
191 data.cjk_nested = false;
192 if (data.par_language->encoding()->package() == Encoding::CJK &&
193 open_encoding_ != CJK && pit->isMultiLingual(bparams)) {
194 if (prev_par_language->encoding()->package() == Encoding::CJK)
195 os << "\\begin{CJK}{" << from_ascii(data.par_language->encoding()->latexName())
196 << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
197 open_encoding_ = CJK;
198 data.cjk_nested = true;
205 static void finishEnvironement(odocstream & os, TexRow & texrow,
206 OutputParams const & runparams, TeXEnvironementData const & data)
208 if (open_encoding_ == CJK && data.cjk_nested) {
209 // We need to close the encoding even if it does not change
210 // to do correct environment nesting
211 os << "\\end{CJK}\n";
213 open_encoding_ = none;
216 if (data.style->isEnvironment()) {
217 os << "\\end{" << from_ascii(data.style->latexname()) << "}\n";
219 prev_env_language_ = data.par_language;
220 if (runparams.encoding != data.prev_encoding) {
221 runparams.encoding = data.prev_encoding;
222 if (!runparams.isFullUnicode())
223 os << setEncoding(data.prev_encoding->iconvName());
227 if (data.leftindent_open) {
228 os << "\\end{LyXParagraphLeftIndent}\n";
230 prev_env_language_ = data.par_language;
231 if (runparams.encoding != data.prev_encoding) {
232 runparams.encoding = data.prev_encoding;
233 if (!runparams.isFullUnicode())
234 os << setEncoding(data.prev_encoding->iconvName());
240 void TeXEnvironment(Buffer const & buf,
241 Text const & text, OutputParams const & runparams,
242 pit_type & pit, odocstream & os, TexRow & texrow)
244 ParagraphList const & paragraphs = text.paragraphs();
245 ParagraphList::const_iterator par = paragraphs.constIterator(pit);
246 LYXERR(Debug::LATEX, "TeXEnvironment for paragraph " << pit);
248 Layout const & current_layout = par->layout();
249 depth_type const current_depth = par->params().depth();
250 Length const & current_left_indent = par->params().leftIndent();
252 // This is for debugging purpose at the end.
253 pit_type const par_begin = pit;
254 for (; pit < runparams.par_end; ++pit) {
256 ParagraphList::const_iterator par = paragraphs.constIterator(pit);
258 // check first if this is an higher depth paragraph.
259 bool go_out = (par->params().depth() < current_depth);
260 if (par->params().depth() == current_depth) {
261 // This environment is finished.
262 go_out |= (par->layout() != current_layout);
263 go_out |= (par->params().leftIndent() != current_left_indent);
266 // nothing to do here, restore pit and go out.
271 if (par->layout() == current_layout
272 && par->params().depth() == current_depth
273 && par->params().leftIndent() == current_left_indent) {
274 // We are still in the same environment so TeXOnePar and continue;
275 TeXOnePar(buf, text, par, os, texrow, runparams);
279 // We are now in a deeper environment.
280 // Either par->layout() != current_layout
281 // Or par->params().depth() > current_depth
282 // Or par->params().leftIndent() != current_left_indent)
284 if (par->layout().isParagraph()) {
285 // FIXME (Lgb): How to handle this?
286 //&& !suffixIs(os, "\n\n")
288 // (ARRae) There should be at least one '\n' already but we need there to
289 // be two for Standard paragraphs that are depth-increment'ed to be
290 // output correctly. However, tables can also be paragraphs so
291 // don't adjust them.
294 // FIXME (Lgb): Will it ever harm to have one '\n' too
295 // many? i.e. that we sometimes will have
301 // FIXME This test should not be necessary.
302 // We should perhaps issue an error if it is.
303 bool const force_plain_layout = text.inset().forcePlainLayout();
304 Layout const & style = force_plain_layout
305 ? buf.params().documentClass().plainLayout()
308 if (!style.isEnvironment()) {
309 // This is a standard paragraph, no need to call TeXEnvironment.
310 TeXOnePar(buf, text, par, os, texrow, runparams);
314 // This is a new environment.
315 TeXEnvironementData const data = prepareEnvironement(buf, text, par,
316 os, texrow, runparams);
317 // Recursive call to TeXEnvironment!
318 TeXEnvironment(buf, text, runparams, pit, os, texrow);
319 finishEnvironement(os, texrow, runparams, data);
322 if (pit != runparams.par_end)
323 LYXERR(Debug::LATEX, "TeXEnvironment for paragraph " << par_begin << " done.");
329 int latexArgInsets(Paragraph const & par, odocstream & os,
330 OutputParams const & runparams, unsigned int reqargs,
331 unsigned int optargs)
333 unsigned int totalargs = reqargs + optargs;
334 list<InsetArgument const *> ilist;
336 InsetList::const_iterator it = par.insetList().begin();
337 InsetList::const_iterator end = par.insetList().end();
338 for (; it != end; ++it) {
339 if (it->inset->lyxCode() == ARG_CODE) {
340 if (ilist.size() >= totalargs) {
341 LYXERR0("WARNING: Found extra argument inset.");
344 InsetArgument const * ins =
345 static_cast<InsetArgument const *>(it->inset);
346 ilist.push_back(ins);
350 if (!reqargs && ilist.size() == 0)
354 bool const have_optional_args = ilist.size() > reqargs;
355 if (have_optional_args) {
356 unsigned int todo = ilist.size() - reqargs;
357 for (unsigned int i = 0; i < todo; ++i) {
358 InsetArgument const * ins = ilist.front();
360 lines += ins->latexArgument(os, runparams, true);
364 // we should now have no more insets than there are required
366 LASSERT(ilist.size() <= reqargs, /* */);
370 for (unsigned int i = 0; i < reqargs; ++i) {
372 // a required argument wasn't given, so we output {}
375 InsetArgument const * ins = ilist.front();
377 lines += ins->latexArgument(os, runparams, false);
384 // FIXME: this should be anonymous
385 void TeXOnePar(Buffer const & buf,
387 ParagraphList::const_iterator const pit,
388 odocstream & os, TexRow & texrow,
389 OutputParams const & runparams_in,
390 string const & everypar,
391 int start_pos, int end_pos)
394 BufferParams const & bparams = buf.params();
395 // FIXME This check should not really be needed.
396 // Perhaps we should issue an error if it is.
397 Layout const style = text.inset().forcePlainLayout() ?
398 bparams.documentClass().plainLayout() : pit->layout();
400 ParagraphList const & paragraphs = text.paragraphs();
401 ParagraphList::const_iterator const priorpit =
402 pit == paragraphs.begin() ? pit : boost::prior(pit);
403 ParagraphList::const_iterator const nextpit =
404 pit == paragraphs.end() ? pit : boost::next(pit);
406 if (style.inpreamble)
409 size_t pos = paragraphs.position(pit);
410 LYXERR(Debug::LATEX, "TeXOnePar for paragraph " << pos << " ptr " << &*pit << " '"
413 OutputParams runparams = runparams_in;
414 runparams.isLastPar = nextpit == paragraphs.end();
415 // We reinitialze par begin and end to be on the safe side
416 // with embedded inset as we don't know if they set those
418 runparams.par_begin = 0;
419 runparams.par_end = 0;
421 bool const maintext = text.isMainText();
422 // we are at the beginning of an inset and CJK is already open;
423 // we count inheritation levels to get the inset nesting right.
424 if (pit == paragraphs.begin() && !maintext
425 && (cjk_inherited_ > 0 || open_encoding_ == CJK)) {
427 open_encoding_ = none;
430 if (text.inset().getLayout().isPassThru()) {
431 int const dist = paragraphs.position(pit);
432 Font const outerfont = text.outerFont(dist);
434 // No newline before first paragraph in this lyxtext
438 if (!text.inset().getLayout().parbreakIsNewline()) {
444 pit->latex(bparams, outerfont, os, texrow,
445 runparams, start_pos, end_pos);
449 if (style.pass_thru) {
450 int const dist = paragraphs.position(pit);
451 Font const outerfont = text.outerFont(dist);
452 pit->latex(bparams, outerfont, os, texrow,
453 runparams, start_pos, end_pos);
456 if (!style.parbreak_is_newline) {
459 } else if (nextpit != paragraphs.end()) {
460 Layout const nextstyle = text.inset().forcePlainLayout() ?
461 bparams.documentClass().plainLayout() : nextpit->layout();
462 if (nextstyle.name() != style.name()) {
471 // This paragraph's language
472 Language const * const par_language = pit->getParLanguage(bparams);
473 // The document's language
474 Language const * const doc_language = bparams.language;
475 // The language that was in effect when the environment this paragraph is
476 // inside of was opened
477 Language const * const outer_language =
478 (runparams.local_font != 0) ?
479 runparams.local_font->language() : doc_language;
481 // The previous language that was in effect is the language of the
482 // previous paragraph, unless the previous paragraph is inside an
483 // environment with nesting depth greater than (or equal to, but with
484 // a different layout) the current one. If there is no previous
485 // paragraph, the previous language is the outer language.
486 bool const use_prev_env_language = prev_env_language_ != 0
487 && priorpit->layout().isEnvironment()
488 && (priorpit->getDepth() > pit->getDepth()
489 || (priorpit->getDepth() == pit->getDepth()
490 && priorpit->layout() != pit->layout()));
491 Language const * const prev_language =
492 (pit != paragraphs.begin())
493 ? (use_prev_env_language ? prev_env_language_
494 : priorpit->getParLanguage(bparams))
497 string par_lang = par_language->babel();
498 string prev_lang = prev_language->babel();
499 string doc_lang = doc_language->babel();
500 string outer_lang = outer_language->babel();
501 string lang_begin_command = lyxrc.language_command_begin;
502 string lang_end_command = lyxrc.language_command_end;
504 if (runparams.use_polyglossia) {
505 par_lang = getPolyglossiaEnvName(par_language);
506 prev_lang = getPolyglossiaEnvName(prev_language);
507 doc_lang = getPolyglossiaEnvName(doc_language);
508 outer_lang = getPolyglossiaEnvName(outer_language);
509 lang_begin_command = "\\begin{$$lang}";
510 lang_end_command = "\\end{$$lang}";
512 if (par_lang != prev_lang
513 // check if we already put language command in TeXEnvironment()
514 && !(style.isEnvironment()
515 && (pit == paragraphs.begin() ||
516 (priorpit->layout() != pit->layout() &&
517 priorpit->getDepth() <= pit->getDepth())
518 || priorpit->getDepth() < pit->getDepth())))
520 if (!lang_end_command.empty() &&
521 prev_lang != outer_lang &&
524 os << from_ascii(subst(lang_end_command,
527 // the '%' is necessary to prevent unwanted whitespace
532 // We need to open a new language if we couldn't close the previous
533 // one (because there's no language_command_end); and even if we closed
534 // the previous one, if the current language is different than the
535 // outer_language (which is currently in effect once the previous one
537 if ((lang_end_command.empty() ||
538 par_lang != outer_lang) &&
540 // If we're inside an inset, and that inset is within an \L or \R
541 // (or equivalents), then within the inset, too, any opposite
542 // language paragraph should appear within an \L or \R (in addition
543 // to, outside of, the normal language switch commands).
544 // This behavior is not correct for ArabTeX, though.
545 if (!runparams.use_polyglossia &&
547 (par_language->lang() != "arabic_arabtex" &&
548 outer_language->lang() != "arabic_arabtex") &&
549 // are we in an inset?
550 runparams.local_font != 0 &&
551 // is the inset within an \L or \R?
553 // FIXME: currently, we don't check this; this means that
554 // we'll have unnnecessary \L and \R commands, but that
555 // doesn't seem to hurt (though latex will complain)
557 // is this paragraph in the opposite direction?
558 runparams.local_font->isRightToLeft() !=
559 par_language->rightToLeft()
561 // FIXME: I don't have a working copy of the Arabi package, so
562 // I'm not sure if the farsi and arabic_arabi stuff is correct
564 if (par_language->lang() == "farsi")
566 else if (outer_language->lang() == "farsi")
568 else if (par_language->lang() == "arabic_arabi")
570 else if (outer_language->lang() == "arabic_arabi")
572 // remaining RTL languages currently is hebrew
573 else if (par_language->rightToLeft())
578 // With CJK, the CJK tag has to be closed first (see below)
579 if (runparams.encoding->package() != Encoding::CJK) {
580 os << from_ascii(subst(
584 if (runparams.use_polyglossia
585 && !par_language->polyglossiaOpts().empty())
587 << from_ascii(par_language->polyglossiaOpts())
589 // the '%' is necessary to prevent unwanted whitespace
596 // Switch file encoding if necessary; no need to do this for "default"
597 // encoding, since this only affects the position of the outputted
598 // \inputencoding command; the encoding switch will occur when necessary
599 if (bparams.inputenc == "auto" &&
600 runparams.encoding->package() != Encoding::none) {
601 // Look ahead for future encoding changes.
602 // We try to output them at the beginning of the paragraph,
603 // since the \inputencoding command is not allowed e.g. in
604 // sections. For this reason we only set runparams.moving_arg
605 // after checking for the encoding change, otherwise the
606 // change would be always avoided by switchEncoding().
607 for (pos_type i = 0; i < pit->size(); ++i) {
608 char_type const c = pit->getChar(i);
609 Encoding const * const encoding =
610 pit->getFontSettings(bparams, i).language()->encoding();
611 if (encoding->package() != Encoding::CJK &&
612 runparams.encoding->package() == Encoding::inputenc &&
617 // All characters before c are in the ASCII range, and
618 // c is non-ASCII (but no inset), so change the
619 // encoding to that required by the language of c.
620 // With CJK, only add switch if we have CJK content at the beginning
622 if (encoding->package() != Encoding::CJK || i == 0) {
623 pair<bool, int> enc_switch = switchEncoding(os, bparams, runparams,
625 // the following is necessary after a CJK environment in a multilingual
626 // context (nesting issue).
627 if (par_language->encoding()->package() == Encoding::CJK &&
628 open_encoding_ != CJK && cjk_inherited_ == 0) {
629 os << "\\begin{CJK}{" << from_ascii(par_language->encoding()->latexName())
630 << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
631 open_encoding_ = CJK;
634 if (encoding->package() != Encoding::none && enc_switch.first) {
635 if (enc_switch.second > 0) {
636 // the '%' is necessary to prevent unwanted whitespace
640 // With CJK, the CJK tag had to be closed first (see above)
641 if (runparams.encoding->package() == Encoding::CJK) {
642 os << from_ascii(subst(
646 // the '%' is necessary to prevent unwanted whitespace
650 runparams.encoding = encoding;
657 runparams.moving_arg |= style.needprotect;
658 Encoding const * const prev_encoding = runparams.encoding;
660 bool const useSetSpace = bparams.documentClass().provides("SetSpace");
661 if (pit->allowParagraphCustomization()) {
662 if (pit->params().startOfAppendix()) {
663 os << "\\appendix\n";
667 if (!pit->params().spacing().isDefault()
668 && (pit == paragraphs.begin()
669 || !priorpit->hasSameLayout(*pit)))
671 os << from_ascii(pit->params().spacing().writeEnvirBegin(useSetSpace))
676 if (style.isCommand()) {
682 switch (style.latextype) {
684 os << '\\' << from_ascii(style.latexname());
686 // Separate handling of optional argument inset.
687 if (style.optargs != 0 || style.reqargs != 0) {
688 int ret = latexArgInsets(*pit, os, runparams, style.reqargs, style.optargs);
695 os << from_ascii(style.latexparam());
697 case LATEX_ITEM_ENVIRONMENT:
698 case LATEX_LIST_ENVIRONMENT:
701 case LATEX_BIB_ENVIRONMENT:
702 // ignore this, the inset will write itself
708 Font const outerfont = text.outerFont(paragraphs.position(pit));
711 os << from_utf8(everypar);
712 pit->latex(bparams, outerfont, os, texrow,
713 runparams, start_pos, end_pos);
715 // Make sure that \\par is done with the font of the last
716 // character if this has another size as the default.
717 // This is necessary because LaTeX (and LyX on the screen)
718 // calculates the space between the baselines according
719 // to this font. (Matthias)
721 // Is this really needed ? (Dekel)
722 // We do not need to use to change the font for the last paragraph
725 Font const font = pit->empty()
726 ? pit->getLayoutFont(bparams, outerfont)
727 : pit->getFont(bparams, pit->size() - 1, outerfont);
729 bool const is_command = style.isCommand();
731 if (style.resfont.size() != font.fontInfo().size()
732 && nextpit != paragraphs.end()
735 os << "\\" << from_ascii(font.latexSize()) << " \\par}";
736 } else if (is_command) {
738 if (runparams.encoding != prev_encoding) {
739 runparams.encoding = prev_encoding;
740 if (!runparams.isFullUnicode())
741 os << setEncoding(prev_encoding->iconvName());
745 bool pending_newline = false;
746 switch (style.latextype) {
747 case LATEX_ITEM_ENVIRONMENT:
748 case LATEX_LIST_ENVIRONMENT:
749 if (nextpit != paragraphs.end()
750 && (pit->params().depth() < nextpit->params().depth()))
751 pending_newline = true;
753 case LATEX_ENVIRONMENT: {
754 // if its the last paragraph of the current environment
755 // skip it otherwise fall through
756 if (nextpit != paragraphs.end() &&
757 (nextpit->layout() != pit->layout()
758 || nextpit->params().depth() != pit->params().depth()))
762 // fall through possible
764 // we don't need it for the last paragraph!!!
765 if (nextpit != paragraphs.end())
766 pending_newline = true;
769 if (pit->allowParagraphCustomization()) {
770 if (!pit->params().spacing().isDefault()
771 && (nextpit == paragraphs.end() || !nextpit->hasSameLayout(*pit)))
773 if (pending_newline) {
777 os << from_ascii(pit->params().spacing().writeEnvirEnd(useSetSpace));
778 pending_newline = true;
782 // Closing the language is needed for the last paragraph; it is also
783 // needed if we're within an \L or \R that we may have opened above (not
784 // necessarily in this paragraph) and are about to close.
785 bool closing_rtl_ltr_environment =
786 !runparams.use_polyglossia &&
788 (par_language->lang() != "arabic_arabtex" &&
789 outer_language->lang() != "arabic_arabtex") &&
790 // have we opened and \L or \R environment?
791 runparams.local_font != 0 &&
792 runparams.local_font->isRightToLeft() != par_language->rightToLeft() &&
793 // are we about to close the language?
794 ((nextpit != paragraphs.end() &&
795 par_language->babel() !=
796 (nextpit->getParLanguage(bparams))->babel()) ||
797 (nextpit == paragraphs.end() &&
798 par_language->babel() != outer_language->babel()));
800 if (closing_rtl_ltr_environment || (nextpit == paragraphs.end()
801 && par_language->babel() != outer_language->babel())) {
802 // Since \selectlanguage write the language to the aux file,
803 // we need to reset the language at the end of footnote or
806 if (pending_newline) {
810 // when the paragraph uses CJK, the language has to be closed earlier
811 if (font.language()->encoding()->package() != Encoding::CJK) {
812 if (lang_end_command.empty()) {
813 // If this is a child, we should restore the
814 // master language after the last paragraph.
815 Language const * const current_language =
816 (nextpit == paragraphs.end()
817 && runparams.master_language)
818 ? runparams.master_language
820 string const current_lang = runparams.use_polyglossia ?
821 getPolyglossiaEnvName(current_language)
822 : current_language->babel();
823 if (!current_lang.empty()) {
824 os << from_ascii(subst(
828 pending_newline = true;
830 } else if (!par_lang.empty()) {
831 os << from_ascii(subst(
835 pending_newline = true;
839 if (closing_rtl_ltr_environment)
842 if (pending_newline) {
847 // if this is a CJK-paragraph and the next isn't, close CJK
848 // also if the next paragraph is a multilingual environment (because of nesting)
849 if (nextpit != paragraphs.end() && open_encoding_ == CJK &&
850 (nextpit->getParLanguage(bparams)->encoding()->package() != Encoding::CJK ||
851 (nextpit->layout().isEnvironment() && nextpit->isMultiLingual(bparams)))
852 // inbetween environments, CJK has to be closed later (nesting!)
853 && (!style.isEnvironment() || !nextpit->layout().isEnvironment())) {
854 os << "\\end{CJK}\n";
855 open_encoding_ = none;
858 // If this is the last paragraph, close the CJK environment
859 // if necessary. If it's an environment, we'll have to \end that first.
860 if (nextpit == paragraphs.end() && !style.isEnvironment()) {
861 switch (open_encoding_) {
863 // do nothing at the end of child documents
864 if (maintext && buf.masterBuffer() != &buf)
870 os << "\\end{CJK}\n";
875 open_encoding_ = none;
880 open_encoding_ = none;
890 // If this is the last paragraph, and a local_font was set upon entering
891 // the inset, and we're using "auto" or "default" encoding, the encoding
892 // should be set back to that local_font's encoding.
893 // However, do not change the encoding when a fully unicode aware backend
894 // such as XeTeX is used.
895 if (nextpit == paragraphs.end() && runparams_in.local_font != 0
896 && runparams_in.encoding != runparams_in.local_font->language()->encoding()
897 && (bparams.inputenc == "auto" || bparams.inputenc == "default")
898 && (!runparams.isFullUnicode())) {
899 runparams_in.encoding = runparams_in.local_font->language()->encoding();
900 os << setEncoding(runparams_in.encoding->iconvName());
902 // Otherwise, the current encoding should be set for the next paragraph.
904 runparams_in.encoding = runparams.encoding;
907 // we don't need a newline for the last paragraph!!!
908 // Note from JMarc: we will re-add a \n explicitly in
909 // TeXEnvironment, because it is needed in this case
910 if (nextpit != paragraphs.end()) {
911 Layout const & next_layout = nextpit->layout();
912 if (style == next_layout
913 // no blank lines before environments!
914 || !next_layout.isEnvironment()
915 // unless there's a depth change
916 // FIXME What we really want to do here is put every \begin and \end
917 // tag on a new line (which was not the case with nested environments).
918 // But in the present state of play, we don't have access to the
919 // information whether the current TeX row is empty or not.
920 // For some ideas about how to fix this, see this thread:
921 // http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg145787.html
922 || nextpit->params().depth() != pit->params().depth()) {
928 if (nextpit != paragraphs.end())
929 LYXERR(Debug::LATEX, "TeXOnePar for paragraph " << pos << " done; ptr " << &*pit << " next " << &*nextpit);
935 // LaTeX all paragraphs
936 void latexParagraphs(Buffer const & buf,
940 OutputParams const & runparams,
941 string const & everypar)
943 BufferParams const & bparams = buf.params();
945 bool const maintext = text.isMainText();
946 bool const is_child = buf.masterBuffer() != &buf;
948 // Open a CJK environment at the beginning of the main buffer
949 // if the document's language is a CJK language
950 // (but not in child documents)
951 if (maintext && !is_child
952 && bparams.encoding().package() == Encoding::CJK) {
953 os << "\\begin{CJK}{" << from_ascii(bparams.encoding().latexName())
954 << "}{" << from_ascii(bparams.fonts_cjk) << "}%\n";
956 open_encoding_ = CJK;
958 // if "auto begin" is switched off, explicitly switch the
959 // language on at start
960 string const mainlang = runparams.use_polyglossia ?
961 getPolyglossiaEnvName(bparams.language)
962 : bparams.language->babel();
963 string const lang_begin_command = runparams.use_polyglossia ?
964 "\\begin{$$lang}" : lyxrc.language_command_begin;
966 if (maintext && !lyxrc.language_auto_begin &&
969 os << from_utf8(subst(lang_begin_command,
972 if (runparams.use_polyglossia
973 && !bparams.language->polyglossiaOpts().empty())
975 << from_ascii(bparams.language->polyglossiaOpts())
981 ParagraphList const & paragraphs = text.paragraphs();
982 LASSERT(runparams.par_begin <= runparams.par_end, /**/);
984 if (runparams.par_begin == runparams.par_end) {
985 // The full doc will be exported but it is easier to just rely on
986 // runparams range parameters that will be passed TeXEnvironment.
987 runparams.par_begin = 0;
988 runparams.par_end = paragraphs.size();
991 pit_type pit = runparams.par_begin;
992 // lastpit is for the language check after the loop.
994 // variables used in the loop:
995 bool was_title = false;
996 bool already_title = false;
997 DocumentClass const & tclass = bparams.documentClass();
999 for (; pit < runparams.par_end; ++pit) {
1001 ParagraphList::const_iterator par = paragraphs.constIterator(pit);
1003 // FIXME This check should not be needed. We should
1004 // perhaps issue an error if it is.
1005 Layout const & layout = text.inset().forcePlainLayout() ?
1006 tclass.plainLayout() : par->layout();
1008 if (layout.intitle) {
1009 if (already_title) {
1010 LYXERR0("Error in latexParagraphs: You"
1011 " should not mix title layouts"
1012 " with normal ones.");
1013 } else if (!was_title) {
1015 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1017 << from_ascii(tclass.titlename())
1022 } else if (was_title && !already_title) {
1023 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1024 os << "\\end{" << from_ascii(tclass.titlename())
1028 os << "\\" << from_ascii(tclass.titlename())
1032 already_title = true;
1037 if (!layout.isEnvironment() && par->params().leftIndent().zero()) {
1038 // This is a standard top level paragraph, TeX it and continue.
1039 TeXOnePar(buf, text, par, os, texrow, runparams, everypar);
1043 TeXEnvironementData const data = prepareEnvironement(buf, text, par,
1044 os, texrow, runparams);
1045 // pit can be changed in TeXEnvironment.
1046 TeXEnvironment(buf, text, runparams, pit, os, texrow);
1047 finishEnvironement(os, texrow, runparams, data);
1050 if (pit == runparams.par_end) {
1051 // Make sure that the last paragraph is
1052 // correctly terminated (because TeXOnePar does
1053 // not add a \n in this case)
1058 // It might be that we only have a title in this document
1059 if (was_title && !already_title) {
1060 if (tclass.titletype() == TITLE_ENVIRONMENT) {
1061 os << "\\end{" << from_ascii(tclass.titlename())
1065 os << "\\" << from_ascii(tclass.titlename())
1071 // if "auto end" is switched off, explicitly close the language at the end
1072 // but only if the last par is in a babel language
1073 string const lang_end_command = runparams.use_polyglossia ?
1074 "\\end{$$lang}" : lyxrc.language_command_end;
1075 if (maintext && !lyxrc.language_auto_end && !mainlang.empty() &&
1076 paragraphs.at(lastpit).getParLanguage(bparams)->encoding()->package() != Encoding::CJK) {
1077 os << from_utf8(subst(lang_end_command,
1084 // If the last paragraph is an environment, we'll have to close
1085 // CJK at the very end to do proper nesting.
1086 if (maintext && !is_child && open_encoding_ == CJK) {
1087 os << "\\end{CJK}\n";
1089 open_encoding_ = none;
1092 // reset inherited encoding
1093 if (cjk_inherited_ > 0) {
1094 cjk_inherited_ -= 1;
1095 if (cjk_inherited_ == 0)
1096 open_encoding_ = CJK;
1101 pair<bool, int> switchEncoding(odocstream & os, BufferParams const & bparams,
1102 OutputParams const & runparams, Encoding const & newEnc,
1105 Encoding const & oldEnc = *runparams.encoding;
1106 bool moving_arg = runparams.moving_arg;
1107 if (!force && ((bparams.inputenc != "auto" && bparams.inputenc != "default")
1109 return make_pair(false, 0);
1111 // Do nothing if the encoding is unchanged.
1112 if (oldEnc.name() == newEnc.name())
1113 return make_pair(false, 0);
1115 // FIXME We ignore encoding switches from/to encodings that do
1116 // neither support the inputenc package nor the CJK package here.
1117 // This does of course only work in special cases (e.g. switch from
1118 // tis620-0 to latin1, but the text in latin1 contains ASCII only),
1119 // but it is the best we can do
1120 if (oldEnc.package() == Encoding::none
1121 || newEnc.package() == Encoding::none)
1122 return make_pair(false, 0);
1124 LYXERR(Debug::LATEX, "Changing LaTeX encoding from "
1125 << oldEnc.name() << " to " << newEnc.name());
1126 os << setEncoding(newEnc.iconvName());
1127 if (bparams.inputenc == "default")
1128 return make_pair(true, 0);
1130 docstring const inputenc_arg(from_ascii(newEnc.latexName()));
1131 switch (newEnc.package()) {
1132 case Encoding::none:
1133 case Encoding::japanese:
1134 // shouldn't ever reach here, see above
1135 return make_pair(true, 0);
1136 case Encoding::inputenc: {
1137 int count = inputenc_arg.length();
1138 if (oldEnc.package() == Encoding::CJK &&
1139 open_encoding_ == CJK) {
1141 open_encoding_ = none;
1144 else if (oldEnc.package() == Encoding::inputenc &&
1145 open_encoding_ == inputenc) {
1147 open_encoding_ = none;
1150 if (runparams.local_font != 0
1151 && oldEnc.package() == Encoding::CJK) {
1152 // within insets, \inputenc switches need
1153 // to be embraced within \bgroup...\egroup;
1157 open_encoding_ = inputenc;
1159 // with the japanese option, inputenc is omitted.
1160 if (runparams.use_japanese)
1161 return make_pair(true, count);
1162 os << "\\inputencoding{" << inputenc_arg << '}';
1163 return make_pair(true, count + 16);
1165 case Encoding::CJK: {
1166 int count = inputenc_arg.length();
1167 if (oldEnc.package() == Encoding::CJK &&
1168 open_encoding_ == CJK) {
1172 if (oldEnc.package() == Encoding::inputenc &&
1173 open_encoding_ == inputenc) {
1177 os << "\\begin{CJK}{" << inputenc_arg << "}{"
1178 << from_ascii(bparams.fonts_cjk) << "}";
1179 open_encoding_ = CJK;
1180 return make_pair(true, count + 15);
1183 // Dead code to avoid a warning:
1184 return make_pair(true, 0);