]> git.lyx.org Git - lyx.git/blobdiff - src/output_latex.C
Extend the navigate menu to child docs
[lyx.git] / src / output_latex.C
index cc4a7fb921323c3d69fe26a25c56f52fa4949930..c6986cce240e8ec00ae174c12fafb2da27cd7d9a 100644 (file)
 #include "encoding.h"
 #include "language.h"
 #include "lyxrc.h"
+#include "outputparams.h"
 #include "paragraph.h"
 #include "paragraph_funcs.h"
 #include "ParagraphParameters.h"
 #include "texrow.h"
 #include "vspace.h"
 
+#include "insets/insetbibitem.h"
 #include "insets/insetoptarg.h"
 
 #include "support/lstrings.h"
+#include "support/unicode.h"
 
-#ifdef HAVE_LOCALE
-#endif
 
-using lyx::support::subst;
+namespace lyx {
+
+using support::subst;
 
 using std::endl;
-using std::ostream;
 using std::string;
 
-extern string bibitemWidest(Buffer const &);
-
 
 namespace {
 
@@ -46,14 +46,14 @@ ParagraphList::const_iterator
 TeXEnvironment(Buffer const & buf,
               ParagraphList const & paragraphs,
               ParagraphList::const_iterator pit,
-              ostream & os, TexRow & texrow,
+              odocstream & os, TexRow & texrow,
               OutputParams const & runparams);
 
 ParagraphList::const_iterator
 TeXOnePar(Buffer const & buf,
          ParagraphList const & paragraphs,
          ParagraphList::const_iterator pit,
-         ostream & os, TexRow & texrow,
+         odocstream & os, TexRow & texrow,
          OutputParams const & runparams,
          string const & everypar = string());
 
@@ -62,7 +62,7 @@ ParagraphList::const_iterator
 TeXDeeper(Buffer const & buf,
          ParagraphList const & paragraphs,
          ParagraphList::const_iterator pit,
-         ostream & os, TexRow & texrow,
+         odocstream & os, TexRow & texrow,
          OutputParams const & runparams)
 {
        lyxerr[Debug::LATEX] << "TeXDeeper...     " << &*pit << endl;
@@ -78,17 +78,21 @@ TeXDeeper(Buffer const & buf,
                                             os, texrow, runparams);
                }
        }
-       lyxerr[Debug::LATEX] << "TeXDeeper...done " << &*par << endl;
+       lyxerr[Debug::LATEX] << "TeXDeeper...done " << endl;
 
        return par;
 }
 
 
+int latexOptArgInsets(Buffer const & buf, Paragraph const & par,
+                     odocstream & os, OutputParams const & runparams, int number);
+
+
 ParagraphList::const_iterator
 TeXEnvironment(Buffer const & buf,
               ParagraphList const & paragraphs,
               ParagraphList::const_iterator pit,
-              ostream & os, TexRow & texrow,
+              odocstream & os, TexRow & texrow,
               OutputParams const & runparams)
 {
        lyxerr[Debug::LATEX] << "TeXEnvironment...     " << &*pit << endl;
@@ -107,16 +111,20 @@ TeXEnvironment(Buffer const & buf,
 
                if (!lyxrc.language_command_end.empty() &&
                    previous_language->babel() != doc_language->babel()) {
-                       os << subst(lyxrc.language_command_end, "$$lang",
-                                   previous_language->babel())
+                       os << from_ascii(subst(
+                               lyxrc.language_command_end,
+                               "$$lang",
+                               previous_language->babel()))
                           << endl;
                        texrow.newline();
                }
 
                if (lyxrc.language_command_end.empty() ||
                    language->babel() != doc_language->babel()) {
-                       os << subst(lyxrc.language_command_begin, "$$lang",
-                                   language->babel())
+                       os << from_ascii(subst(
+                               lyxrc.language_command_begin,
+                               "$$lang",
+                               language->babel()))
                           << endl;
                        texrow.newline();
                }
@@ -124,21 +132,32 @@ TeXEnvironment(Buffer const & buf,
 
        bool leftindent_open = false;
        if (!pit->params().leftIndent().zero()) {
-               os << "\\begin{LyXParagraphLeftIndent}{" <<
-                       pit->params().leftIndent().asLatexString() << "}\n";
+               os << "\\begin{LyXParagraphLeftIndent}{"
+                  << from_ascii(pit->params().leftIndent().asLatexString())
+                  << "}\n";
                texrow.newline();
                leftindent_open = true;
        }
 
        if (style->isEnvironment()) {
-               os << "\\begin{" << style->latexname() << '}';
+               os << "\\begin{" << from_ascii(style->latexname()) << '}';
+               if (style->optionalargs > 0) {
+                       int ret = latexOptArgInsets(buf, *pit, os, runparams,
+                                                   style->optionalargs);
+                       while (ret > 0) {
+                               texrow.newline();
+                               --ret;
+                       }
+               }
                if (style->latextype == LATEX_LIST_ENVIRONMENT) {
-                       os << "{" << pit->params().labelWidthString() << "}\n";
+                       os << '{'
+                          << pit->params().labelWidthString()
+                          << "}\n";
                } else if (style->labeltype == LABEL_BIBLIO) {
                        // ale970405
-                       os << "{" <<  bibitemWidest(buf) << "}\n";
+                       os << '{' << bibitemWidest(buf) << "}\n";
                } else
-                       os << style->latexparam() << '\n';
+                       os << from_ascii(style->latexparam()) << '\n';
                texrow.newline();
        }
        ParagraphList::const_iterator par = pit;
@@ -180,7 +199,7 @@ TeXEnvironment(Buffer const & buf,
                 && par->params().leftIndent() == pit->params().leftIndent());
 
        if (style->isEnvironment()) {
-               os << "\\end{" << style->latexname() << "}\n";
+               os << "\\end{" << from_ascii(style->latexname()) << "}\n";
                texrow.newline();
        }
 
@@ -189,23 +208,28 @@ TeXEnvironment(Buffer const & buf,
                texrow.newline();
        }
 
-       lyxerr[Debug::LATEX] << "TeXEnvironment...done " << &*par << endl;
-       return par;  // ale970302
+       if (par != paragraphs.end() && lyxerr.debugging(Debug::LATEX))
+               lyxerr << "TeXEnvironment...done " << &*par << endl;
+       return par;
 }
 
 
-InsetOptArg * optArgInset(Paragraph const & par)
+int latexOptArgInsets(Buffer const & buf, Paragraph const & par,
+                     odocstream & os, OutputParams const & runparams, int number)
 {
-       // Find the entry.
+       int lines = 0;
+
        InsetList::const_iterator it = par.insetlist.begin();
        InsetList::const_iterator end = par.insetlist.end();
-       for (; it != end; ++it) {
-               InsetBase * ins = it->inset;
-               if (ins->lyxCode() == InsetBase::OPTARG_CODE) {
-                       return static_cast<InsetOptArg *>(ins);
+       for (; it != end && number > 0 ; ++it) {
+               if (it->inset->lyxCode() == InsetBase::OPTARG_CODE) {
+                       InsetOptArg * ins =
+                               static_cast<InsetOptArg *>(it->inset);
+                       lines += ins->latexOptional(buf, os, runparams);
+                       --number;
                }
        }
-       return 0;
+       return lines;
 }
 
 
@@ -213,8 +237,8 @@ ParagraphList::const_iterator
 TeXOnePar(Buffer const & buf,
          ParagraphList const & paragraphs,
          ParagraphList::const_iterator pit,
-         ostream & os, TexRow & texrow,
-         OutputParams const & runparams,
+         odocstream & ucs4, TexRow & texrow,
+         OutputParams const & runparams_in,
          string const & everypar)
 {
        lyxerr[Debug::LATEX] << "TeXOnePar...     " << &*pit << " '"
@@ -223,38 +247,15 @@ TeXOnePar(Buffer const & buf,
        bool further_blank_line = false;
        LyXLayout_ptr style;
 
-       // well we have to check if we are in an inset with unlimited
-       // length (all in one row) if that is true then we don't allow
-       // any special options in the paragraph and also we don't allow
-       // any environment other then "Standard" to be valid!
-       if (!pit->forceDefaultParagraphs()) {
+       // In an an inset with unlimited length (all in one row),
+       // force layout to default
+       if (!pit->forceDefaultParagraphs())
                style = pit->layout();
-
-               if (pit->params().startOfAppendix()) {
-                       os << "\\appendix\n";
-                       texrow.newline();
-               }
-
-               if (!pit->params().spacing().isDefault()
-                       && (pit == paragraphs.begin()
-                           || !boost::prior(pit)->hasSameLayout(*pit)))
-               {
-                       os << pit->params().spacing().writeEnvirBegin() << '\n';
-                       texrow.newline();
-               }
-
-               if (style->isCommand()) {
-                       os << '\n';
-                       texrow.newline();
-               }
-
-               if (further_blank_line) {
-                       os << '\n';
-                       texrow.newline();
-               }
-       } else {
+       else
                style = bparams.getLyXTextClass().defaultLayout();
-       }
+
+       OutputParams runparams = runparams_in;
+       runparams.moving_arg |= style->needprotect;
 
        Language const * language = pit->getParLanguage(bparams);
        Language const * doc_language = bparams.language;
@@ -274,42 +275,85 @@ TeXOnePar(Buffer const & buf,
                if (!lyxrc.language_command_end.empty() &&
                    previous_language->babel() != doc_language->babel())
                {
-                       os << subst(lyxrc.language_command_end, "$$lang",
-                                   previous_language->babel())
-                          << endl;
+                       ucs4 << from_ascii(subst(lyxrc.language_command_end,
+                               "$$lang",
+                               previous_language->babel()))
+                            << endl;
                        texrow.newline();
                }
 
                if (lyxrc.language_command_end.empty() ||
                    language->babel() != doc_language->babel())
                {
-                       os << subst(lyxrc.language_command_begin, "$$lang",
-                                   language->babel())
-                          << endl;
+                       ucs4 << from_ascii(subst(
+                               lyxrc.language_command_begin,
+                               "$$lang",
+                               language->babel()))
+                            << endl;
                        texrow.newline();
                }
        }
 
        if (bparams.inputenc == "auto" &&
            language->encoding() != previous_language->encoding()) {
-               os << "\\inputencoding{"
-                  << language->encoding()->LatexName()
-                  << "}\n";
+               ucs4 << "\\inputencoding{"
+                    << from_ascii(language->encoding()->latexName())
+                    << "}\n";
                texrow.newline();
        }
+       // We need to output the paragraph to a temporary stream if we
+       // need to change the encoding. Don't do this if the result does
+       // not go to a file but to the builtin source viewer.
+       odocstringstream par_stream;
+       bool const change_encoding = !runparams_in.dryrun &&
+                       bparams.inputenc == "auto" &&
+                       language->encoding() != doc_language->encoding();
+       // don't trigger the copy ctor because it's private on msvc 
+       odocstream & os = *(change_encoding ? &par_stream : &ucs4);
+
+       // In an an inset with unlimited length (all in one row),
+       // don't allow any special options in the paragraph
+       if (!pit->forceDefaultParagraphs()) {
+               if (pit->params().startOfAppendix()) {
+                       os << "\\appendix\n";
+                       texrow.newline();
+               }
+
+               if (!pit->params().spacing().isDefault()
+                       && (pit == paragraphs.begin()
+                           || !boost::prior(pit)->hasSameLayout(*pit)))
+               {
+                       os << from_ascii(pit->params().spacing().writeEnvirBegin())
+                           << '\n';
+                       texrow.newline();
+               }
+
+               if (style->isCommand()) {
+                       os << '\n';
+                       texrow.newline();
+               }
+
+               if (further_blank_line) {
+                       os << '\n';
+                       texrow.newline();
+               }
+       }
 
        switch (style->latextype) {
        case LATEX_COMMAND:
-               os << '\\' << style->latexname();
+               os << '\\' << from_ascii(style->latexname());
 
                // Separate handling of optional argument inset.
-               if (style->optionalargs == 1) {
-                       InsetOptArg * it = optArgInset(*pit);
-                       if (it)
-                               it->latexOptional(buf, os, runparams);
+               if (style->optionalargs > 0) {
+                       int ret = latexOptArgInsets(buf, *pit, os, runparams,
+                                                   style->optionalargs);
+                       while (ret > 0) {
+                               texrow.newline();
+                               --ret;
+                       }
                }
                else
-                       os << style->latexparam();
+                       os << from_ascii(style->latexparam());
                break;
        case LATEX_ITEM_ENVIRONMENT:
        case LATEX_LIST_ENVIRONMENT:
@@ -322,9 +366,10 @@ TeXOnePar(Buffer const & buf,
                break;
        }
 
-       os << everypar;
+       // FIXME UNICODE
+       os << from_utf8(everypar);
        bool need_par = pit->simpleTeXOnePar(buf, bparams,
-                       outerFont(pit - paragraphs.begin(), paragraphs),
+                                            outerFont(std::distance(paragraphs.begin(), pit), paragraphs),
                                             os, texrow, runparams);
 
        // Make sure that \\par is done with the font of the last
@@ -337,8 +382,8 @@ TeXOnePar(Buffer const & buf,
        // We do not need to use to change the font for the last paragraph
        // or for a command.
        LyXFont const outerfont =
-                       outerFont(pit - paragraphs.begin(),
-paragraphs);
+               outerFont(std::distance(paragraphs.begin(), pit),
+                         paragraphs);
 
        LyXFont const font =
                (pit->empty()
@@ -352,7 +397,7 @@ paragraphs);
            && !is_command) {
                if (!need_par)
                        os << '{';
-               os << "\\" << font.latexSize() << " \\par}";
+               os << "\\" << from_ascii(font.latexSize()) << " \\par}";
        } else if (need_par) {
                os << "\\par}";
        } else if (is_command)
@@ -387,25 +432,6 @@ paragraphs);
                }
        }
 
-       if (boost::next(pit) == const_cast<ParagraphList&>(paragraphs).end()
-           && language->babel() != doc_language->babel()) {
-               // Since \selectlanguage write the language to the aux file,
-               // we need to reset the language at the end of footnote or
-               // float.
-
-               if (lyxrc.language_command_end.empty())
-                       os << subst(lyxrc.language_command_begin,
-                                   "$$lang",
-                                   doc_language->babel())
-                          << endl;
-               else
-                       os << subst(lyxrc.language_command_end,
-                                   "$$lang",
-                                   language->babel())
-                          << endl;
-               texrow.newline();
-       }
-
        if (!pit->forceDefaultParagraphs()) {
                further_blank_line = false;
 
@@ -418,11 +444,33 @@ paragraphs);
                        && (boost::next(pit) == paragraphs.end()
                            || !boost::next(pit)->hasSameLayout(*pit)))
                {
-                       os << pit->params().spacing().writeEnvirEnd() << '\n';
+                       os << from_ascii(pit->params().spacing().writeEnvirEnd())
+                          << '\n';
                        texrow.newline();
                }
        }
 
+       if (boost::next(pit) == paragraphs.end()
+           && language->babel() != doc_language->babel()) {
+               // Since \selectlanguage write the language to the aux file,
+               // we need to reset the language at the end of footnote or
+               // float.
+
+               if (lyxrc.language_command_end.empty())
+                       os << from_ascii(subst(
+                               lyxrc.language_command_begin,
+                               "$$lang",
+                               doc_language->babel()))
+                          << endl;
+               else
+                       os << from_ascii(subst(
+                               lyxrc.language_command_end,
+                               "$$lang",
+                               language->babel()))
+                          << endl;
+               texrow.newline();
+       }
+
        // we don't need it for the last paragraph!!!
        // Note from JMarc: we will re-add a \n explicitely in
        // TeXEnvironment, because it is needed in this case
@@ -431,7 +479,63 @@ paragraphs);
                texrow.newline();
        }
 
-       lyxerr[Debug::LATEX] << "TeXOnePar...done " << &*boost::next(pit) << endl;
+       if (boost::next(pit) != paragraphs.end() &&
+           lyxerr.debugging(Debug::LATEX))
+               lyxerr << "TeXOnePar...done " << &*boost::next(pit) << endl;
+
+       if (change_encoding) {
+               lyxerr[Debug::LATEX] << "Converting paragraph to encoding "
+                       << language->encoding()->iconvName() << endl;
+               docstring const par = par_stream.str();
+               // Convert the paragraph to the 8bit encoding that we need to
+               // output.
+               std::vector<char> const encoded = lyx::ucs4_to_eightbit(par.c_str(),
+                       par.size(), language->encoding()->iconvName());
+               // Interpret this as if it was in the 8 bit encoding of the
+               // document language and convert it back to UCS4. That means
+               // that faked does not contain pure UCS4 anymore, but what
+               // will be written to the output file will be correct, because
+               // the real output stream will do a UCS4 -> document language
+               // encoding conversion.
+               // This is of course a hack, but not a bigger one than mixing
+               // two encodings in one file.
+               // FIXME: Catch iconv conversion errors and display an error
+               // dialog.
+
+               // Here follows an explanation how I (gb) came to the current
+               // solution:
+
+               // codecvt facets are only used by file streams -> OK, maybe
+               // we could use file streams and not generic streams in the
+               // latex() methods? No, that does not  work, we use them at
+               // several places to write to string streams.
+               // Next try: Maybe we could do something else than codecvt
+               // in our streams, and  add a setEncoding() method? That
+               // does not work unless we rebuild the functionality of file
+               // and string streams, since both odocfstream and
+               // odocstringstream inherit from std::basic_ostream<docstring>
+               // and we can  neither add a method to that class nor change
+               // the inheritance of the file and string streams.
+
+               // What might be possible is to encapsulate the real file and
+               // string streams in our own version, and use a homemade
+               // streambuf that would do the encoding conversion and then
+               // forward to the real stream. That would probably work, but
+               // would require far more code and a good understanding of
+               // stream buffers to get it right.
+
+               // Another idea by JMarc is to use a modifier like
+               // os << setencoding("iso-8859-1");
+               // That currently looks like the best idea.
+
+               std::vector<char_type> const faked = lyx::eightbit_to_ucs4(&(encoded[0]),
+                       encoded.size(), doc_language->encoding()->iconvName());
+               std::vector<char_type>::const_iterator const end = faked.end();
+               std::vector<char_type>::const_iterator it = faked.begin();
+               for (; it != end; ++it)
+                       ucs4.put(*it);
+       }
+
        return ++pit;
 }
 
@@ -441,7 +545,7 @@ paragraphs);
 // LaTeX all paragraphs
 void latexParagraphs(Buffer const & buf,
                     ParagraphList const & paragraphs,
-                    ostream & os,
+                    odocstream & os,
                     TexRow & texrow,
                     OutputParams const & runparams,
                     string const & everypar)
@@ -452,8 +556,20 @@ void latexParagraphs(Buffer const & buf,
        ParagraphList::const_iterator par = paragraphs.begin();
        ParagraphList::const_iterator endpar = paragraphs.end();
 
+       BOOST_ASSERT(runparams.par_begin <= runparams.par_end);
+       // if only part of the paragraphs will be outputed
+       if (runparams.par_begin !=  runparams.par_end) {
+               par = boost::next(paragraphs.begin(), runparams.par_begin);
+               endpar = boost::next(paragraphs.begin(), runparams.par_end);
+               // runparams will be passed to nested paragraphs, so
+               // we have to reset the range parameters.
+               const_cast<OutputParams&>(runparams).par_begin = 0;
+               const_cast<OutputParams&>(runparams).par_end = 0;
+       }
+
        // if only_body
        while (par != endpar) {
+               ParagraphList::const_iterator lastpar = par;
                // well we have to check if we are in an inset with unlimited
                // length (all in one row) if that is true then we don't allow
                // any special options in the paragraph and also we don't allow
@@ -470,18 +586,18 @@ void latexParagraphs(Buffer const & buf,
                                        was_title = true;
                                        if (tclass.titletype() == TITLE_ENVIRONMENT) {
                                                os << "\\begin{"
-                                                   << tclass.titlename()
+                                                   << from_ascii(tclass.titlename())
                                                    << "}\n";
                                                texrow.newline();
                                        }
                                }
                        } else if (was_title && !already_title) {
                                if (tclass.titletype() == TITLE_ENVIRONMENT) {
-                                       os << "\\end{" << tclass.titlename()
+                                       os << "\\end{" << from_ascii(tclass.titlename())
                                            << "}\n";
                                }
                                else {
-                                       os << "\\" << tclass.titlename()
+                                       os << "\\" << from_ascii(tclass.titlename())
                                            << "\n";
                                }
                                texrow.newline();
@@ -491,7 +607,7 @@ void latexParagraphs(Buffer const & buf,
 
                        if (layout->is_environment) {
                                par = TeXOnePar(buf, paragraphs, par, os, texrow,
-                                               runparams, everypar);
+                                               runparams, everypar);
                        } else if (layout->isEnvironment() ||
                                !par->params().leftIndent().zero())
                        {
@@ -499,23 +615,28 @@ void latexParagraphs(Buffer const & buf,
                                                     texrow, runparams);
                        } else {
                                par = TeXOnePar(buf, paragraphs, par, os, texrow,
-                                               runparams, everypar);
+                                               runparams, everypar);
                        }
                } else {
                        par = TeXOnePar(buf, paragraphs, par, os, texrow,
-                                       runparams, everypar);
+                                       runparams, everypar);
                }
+               if (std::distance(lastpar, par) >= std::distance(lastpar, endpar))
+                       break;
        }
        // It might be that we only have a title in this document
        if (was_title && !already_title) {
                if (tclass.titletype() == TITLE_ENVIRONMENT) {
-                       os << "\\end{" << tclass.titlename()
+                       os << "\\end{" << from_ascii(tclass.titlename())
                            << "}\n";
                }
                else {
-                       os << "\\" << tclass.titlename()
+                       os << "\\" << from_ascii(tclass.titlename())
                            << "\n";
                                }
                texrow.newline();
        }
 }
+
+
+} // namespace lyx