]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetInclude.cpp
Natbib authoryear uses (Ref1; Ref2) by default.
[lyx.git] / src / insets / InsetInclude.cpp
index 324b4a07628f9ae9f6fff7c503fdebe9ce06daa2..88153c6d2d35941ad375977036d292062b5f6756 100644 (file)
@@ -34,6 +34,7 @@
 #include "LyXRC.h"
 #include "Lexer.h"
 #include "MetricsInfo.h"
+#include "output_plaintext.h"
 #include "output_xhtml.h"
 #include "OutputParams.h"
 #include "TextClass.h"
@@ -387,7 +388,8 @@ docstring InsetInclude::screenLabel() const
                        temp = listings_label_;
                        break;
                case NONE:
-                       LASSERT(false, /**/);
+                       LASSERT(false, temp = buffer().B_("Unknown"));
+                       break;
        }
 
        temp += ": ";
@@ -513,45 +515,111 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                                              from_utf8(masterBuffer->filePath())));
        }
 
+       string exppath = incfile;
+       if (!runparams.export_folder.empty()) {
+               exppath = makeAbsPath(exppath, runparams.export_folder).realPath();
+               FileName(exppath).onlyPath().createPath();
+       }
+
        // write it to a file (so far the complete file)
        string exportfile;
        string mangled;
        // bug 5681
        if (type(params()) == LISTINGS) {
-               exportfile = incfile;
+               exportfile = exppath;
                mangled = DocFileName(included_file).mangledFileName();
        } else {
-               exportfile = changeExtension(incfile, ".tex");
+               exportfile = changeExtension(exppath, ".tex");
                mangled = DocFileName(changeExtension(included_file.absFileName(), ".tex")).
                        mangledFileName();
        }
 
-       FileName const writefile(makeAbsPath(mangled, masterBuffer->temppath()));
-
        if (!runparams.nice)
                incfile = mangled;
        else if (!isValidLaTeXFileName(incfile)) {
                frontend::Alert::warning(_("Invalid filename"),
                        _("The following filename will cause troubles "
-                         "when running the exported file through LaTeX: ") +
+                               "when running the exported file through LaTeX: ") +
                        from_utf8(incfile));
-       }
-       else if (!isValidDVIFileName(incfile)) {
+       } else if (!isValidDVIFileName(incfile)) {
                frontend::Alert::warning(_("Problematic filename for DVI"),
                        _("The following filename can cause troubles "
-                         "when running the exported file through LaTeX "
-                         "and opening the resulting DVI: ") +
+                               "when running the exported file through LaTeX "
+                               "and opening the resulting DVI: ") +
                        from_utf8(incfile), true);
        }
+
+       FileName const writefile(makeAbsPath(mangled, masterBuffer->temppath()));
+
        LYXERR(Debug::LATEX, "incfile:" << incfile);
        LYXERR(Debug::LATEX, "exportfile:" << exportfile);
        LYXERR(Debug::LATEX, "writefile:" << writefile);
 
        string const tex_format = flavor2format(runparams.flavor);
-       if (runparams.inComment || runparams.dryrun) {
-               //Don't try to load or copy the file if we're
-               //in a comment or doing a dryrun
-       } else if (isInputOrInclude(params()) &&
+
+       switch (type(params())) {
+       case VERB:
+       case VERBAST: {
+               incfile = latex_path(incfile);
+               // FIXME UNICODE
+               os << '\\' << from_ascii(params().getCmdName()) << '{'
+                  << from_utf8(incfile) << '}';
+               break;
+       }
+       case INPUT: {
+               runparams.exportdata->addExternalFile(tex_format, writefile,
+                                                     exportfile);
+
+               // \input wants file with extension (default is .tex)
+               if (!isLyXFileName(included_file.absFileName())) {
+                       incfile = latex_path(incfile);
+                       // FIXME UNICODE
+                       os << '\\' << from_ascii(params().getCmdName())
+                          << '{' << from_utf8(incfile) << '}';
+               } else {
+                       incfile = changeExtension(incfile, ".tex");
+                       incfile = latex_path(incfile);
+                       // FIXME UNICODE
+                       os << '\\' << from_ascii(params().getCmdName())
+                          << '{' << from_utf8(incfile) <<  '}';
+               }
+               break;
+       }
+       case LISTINGS: {
+               runparams.exportdata->addExternalFile(tex_format, writefile,
+                                                     exportfile);
+               os << '\\' << from_ascii(params().getCmdName());
+               string const opt = to_utf8(params()["lstparams"]);
+               // opt is set in QInclude dialog and should have passed validation.
+               InsetListingsParams params(opt);
+               if (!params.params().empty())
+                       os << "[" << from_utf8(params.params()) << "]";
+               os << '{'  << from_utf8(incfile) << '}';
+               break;
+       }
+       case INCLUDE: {
+               runparams.exportdata->addExternalFile(tex_format, writefile,
+                                                     exportfile);
+
+               // \include don't want extension and demands that the
+               // file really have .tex
+               incfile = changeExtension(incfile, string());
+               incfile = latex_path(incfile);
+               // FIXME UNICODE
+               os << '\\' << from_ascii(params().getCmdName()) << '{'
+                  << from_utf8(incfile) << '}';
+               break;
+       }
+       case NONE:
+               break;
+       }
+
+       if (runparams.inComment || runparams.dryrun)
+               // Don't try to load or copy the file if we're
+               // in a comment or doing a dryrun
+               return;
+
+       if (isInputOrInclude(params()) &&
                 isLyXFileName(included_file.absFileName())) {
                // if it's a LyX file and we're inputting or including,
                // try to load it so we can write the associated latex
@@ -617,7 +685,9 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                runparams.master_language = buffer().params().language;
                runparams.par_begin = 0;
                runparams.par_end = tmp->paragraphs().size();
-               if (!tmp->makeLaTeXFile(tmpwritefile, runparams, false)) {
+               runparams.is_child = true;
+               if (!tmp->makeLaTeXFile(tmpwritefile, masterFileName(buffer()).
+                               onlyPath().absFileName(), runparams, Buffer::OnlyBody)) {
                        docstring msg = bformat(_("Included file `%1$s' "
                                        "was not exported correctly.\nWarning: "
                                        "LaTeX export is probably incomplete."),
@@ -631,6 +701,7 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                }
                runparams.encoding = oldEnc;
                runparams.master_language = oldLang;
+               runparams.is_child = false;
 
                // If needed, use converters to produce a latex file from the child
                if (tmpwritefile != writefile) {
@@ -656,8 +727,8 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                // In this case, it's not a LyX file, so we copy the file
                // to the temp dir, so that .aux files etc. are not created
                // in the original dir. Files included by this file will be
-               // found via the environment variable TEXINPUTS, which may be
-               // set in preferences and by default includes the original dir.
+               // found via either the environment variable TEXINPUTS, or
+               // input@path, see ../Buffer.cpp.
                unsigned long const checksum_in  = included_file.checksum();
                unsigned long const checksum_out = writefile.checksum();
 
@@ -666,67 +737,12 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                                // FIXME UNICODE
                                LYXERR(Debug::LATEX,
                                        to_utf8(bformat(_("Could not copy the file\n%1$s\n"
-                                                                 "into the temporary directory."),
-                                                  from_utf8(included_file.absFileName()))));
+                                                                       "into the temporary directory."),
+                                                        from_utf8(included_file.absFileName()))));
                                return;
                        }
                }
        }
-
-       switch (type(params())) {
-       case VERB:
-       case VERBAST: {
-               incfile = latex_path(incfile);
-               // FIXME UNICODE
-               os << '\\' << from_ascii(params().getCmdName()) << '{'
-                  << from_utf8(incfile) << '}';
-               break;
-       } 
-       case INPUT: {
-               runparams.exportdata->addExternalFile(tex_format, writefile,
-                                                     exportfile);
-
-               // \input wants file with extension (default is .tex)
-               if (!isLyXFileName(included_file.absFileName())) {
-                       incfile = latex_path(incfile);
-                       // FIXME UNICODE
-                       os << '\\' << from_ascii(params().getCmdName())
-                          << '{' << from_utf8(incfile) << '}';
-               } else {
-               incfile = changeExtension(incfile, ".tex");
-               incfile = latex_path(incfile);
-                       // FIXME UNICODE
-                       os << '\\' << from_ascii(params().getCmdName())
-                          << '{' << from_utf8(incfile) <<  '}';
-               }
-               break;
-       } 
-       case LISTINGS: {
-               os << '\\' << from_ascii(params().getCmdName());
-               string const opt = to_utf8(params()["lstparams"]);
-               // opt is set in QInclude dialog and should have passed validation.
-               InsetListingsParams params(opt);
-               if (!params.params().empty())
-                       os << "[" << from_utf8(params.params()) << "]";
-               os << '{'  << from_utf8(incfile) << '}';
-               break;
-       } 
-       case INCLUDE: {
-               runparams.exportdata->addExternalFile(tex_format, writefile,
-                                                     exportfile);
-
-               // \include don't want extension and demands that the
-               // file really have .tex
-               incfile = changeExtension(incfile, string());
-               incfile = latex_path(incfile);
-               // FIXME UNICODE
-               os << '\\' << from_ascii(params().getCmdName()) << '{'
-                  << from_utf8(incfile) << '}';
-               break;
-       }
-       case NONE:
-               break;
-       }
 }
 
 
@@ -784,7 +800,7 @@ docstring InsetInclude::xhtml(XHTMLStream & xs, OutputParams const & rp) const
        if (all_pars) {
                op.par_begin = 0;
                op.par_end = 0;
-               ibuf->writeLyXHTMLSource(xs.os(), op, true);
+               ibuf->writeLyXHTMLSource(xs.os(), op, Buffer::IncludedFile);
        } else
                xs << XHTMLStream::ESCAPE_NONE 
                   << "<!-- Included file: " 
@@ -795,19 +811,33 @@ docstring InsetInclude::xhtml(XHTMLStream & xs, OutputParams const & rp) const
 }
 
 
-int InsetInclude::plaintext(odocstream & os, OutputParams const &) const
+int InsetInclude::plaintext(odocstringstream & os,
+        OutputParams const & op, size_t) const
 {
+       // just write the filename if we're making a tooltip or toc entry,
+       // or are generating this for advanced search
+       if (op.for_tooltip || op.for_toc || op.for_search) {
+               os << '[' << screenLabel() << '\n'
+                  << getParam("filename") << "\n]";
+               return PLAINTEXT_NEWLINE + 1; // one char on a separate line
+       }
+
        if (isVerbatim(params()) || isListings(params())) {
-               os << '[' << screenLabel() << '\n';
-               // FIXME: We don't know the encoding of the file, default to UTF-8.
-               os << includedFileName(buffer(), params()).fileContents("UTF-8");
-               os << "\n]";
+               os << '[' << screenLabel() << '\n'
+                  // FIXME: We don't know the encoding of the file, default to UTF-8.
+                  << includedFileName(buffer(), params()).fileContents("UTF-8")
+                  << "\n]";
                return PLAINTEXT_NEWLINE + 1; // one char on a separate line
-       } else {
+       }
+
+       Buffer const * const ibuf = loadIfNeeded();
+       if (!ibuf) {
                docstring const str = '[' + screenLabel() + ']';
                os << str;
                return str.size();
        }
+       writePlaintextFile(*ibuf, os, op);
+       return 0;
 }
 
 
@@ -832,8 +862,14 @@ int InsetInclude::docbook(odocstream & os, OutputParams const & runparams) const
                return 0;
        }
 
+       string exppath = incfile;
+       if (!runparams.export_folder.empty()) {
+               exppath = makeAbsPath(exppath, runparams.export_folder).realPath();
+               FileName(exppath).onlyPath().createPath();
+       }
+
        // write it to a file (so far the complete file)
-       string const exportfile = changeExtension(incfile, ".sgml");
+       string const exportfile = changeExtension(exppath, ".sgml");
        DocFileName writefile(changeExtension(included_file, ".sgml"));
 
        Buffer * tmp = loadIfNeeded();
@@ -848,7 +884,7 @@ int InsetInclude::docbook(odocstream & os, OutputParams const & runparams) const
                LYXERR(Debug::LATEX, "exportfile:" << exportfile);
                LYXERR(Debug::LATEX, "writefile:" << writefile);
 
-               tmp->makeDocBookFile(writefile, runparams, true);
+               tmp->makeDocBookFile(writefile, runparams, Buffer::OnlyBody);
        }
 
        runparams.exportdata->addExternalFile("docbook", writefile,
@@ -869,14 +905,13 @@ int InsetInclude::docbook(odocstream & os, OutputParams const & runparams) const
 
 void InsetInclude::validate(LaTeXFeatures & features) const
 {
-       string incfile = to_utf8(params()["filename"]);
-       string writefile;
-
-       LASSERT(&buffer() == &features.buffer(), /**/);
+       LATTEST(&buffer() == &features.buffer());
 
+       string incfile = to_utf8(params()["filename"]);
        string const included_file =
                includedFileName(buffer(), params()).absFileName();
 
+       string writefile;
        if (isLyXFileName(included_file))
                writefile = changeExtension(included_file, ".sgml");
        else
@@ -890,6 +925,7 @@ void InsetInclude::validate(LaTeXFeatures & features) const
 
        features.includeFile(include_label, writefile);
 
+       features.useInsetLayout(getLayout());
        if (isVerbatim(params()))
                features.require("verbatim");
        else if (isListings(params()))
@@ -910,7 +946,9 @@ void InsetInclude::validate(LaTeXFeatures & features) const
                        // otherwise it would always be the master buffer,
                        // and nested includes would not work.
                        features.setBuffer(*tmp);
+                       features.runparams().is_child = true;
                        tmp->validate(features);
+                       features.runparams().is_child = false;
                        features.setBuffer(buffer());
                }
        }
@@ -928,7 +966,7 @@ void InsetInclude::collectBibKeys(InsetIterator const & /*di*/) const
 
 void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
 {
-       LASSERT(mi.base.bv, /**/);
+       LBUFERR(mi.base.bv);
 
        bool use_preview = false;
        if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
@@ -954,7 +992,7 @@ void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
 
 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
 {
-       LASSERT(pi.base.bv, /**/);
+       LBUFERR(pi.base.bv);
 
        bool use_preview = false;
        if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
@@ -970,9 +1008,9 @@ void InsetInclude::draw(PainterInfo & pi, int x, int y) const
 }
 
 
-docstring InsetInclude::contextMenuName() const
+string InsetInclude::contextMenuName() const
 {
-       return from_ascii("context-include");
+       return "context-include";
 }
 
 
@@ -982,6 +1020,13 @@ Inset::DisplayType InsetInclude::display() const
 }
 
 
+docstring InsetInclude::layoutName() const
+{
+       if (isListings(params()))
+               return from_ascii("IncludeListings");
+       return InsetCommand::layoutName();
+}
+
 
 //
 // preview stuff
@@ -1052,13 +1097,13 @@ void InsetInclude::addPreview(DocIterator const & /*inset_pos*/,
 }
 
 
-void InsetInclude::addToToc(DocIterator const & cpit) const
+void InsetInclude::addToToc(DocIterator const & cpit, bool output_active) const
 {
        TocBackend & backend = buffer().tocBackend();
 
        if (isListings(params())) {
                if (label_)
-                       label_->addToToc(cpit);
+                       label_->addToToc(cpit, output_active);
 
                InsetListingsParams p(to_utf8(params()["lstparams"]));
                string caption = p.getParamValue("caption");
@@ -1068,7 +1113,7 @@ void InsetInclude::addToToc(DocIterator const & cpit) const
                docstring str = convert<docstring>(toc.size() + 1)
                        + ". " +  from_utf8(caption);
                DocIterator pit = cpit;
-               toc.push_back(TocItem(pit, 0, str));
+               toc.push_back(TocItem(pit, 0, str, output_active));
                return;
        }
        Buffer const * const childbuffer = getChildBuffer();
@@ -1077,10 +1122,10 @@ void InsetInclude::addToToc(DocIterator const & cpit) const
 
        Toc & toc = backend.toc("child");
        docstring str = childbuffer->fileName().displayName();
-       toc.push_back(TocItem(cpit, 0, str));
+       toc.push_back(TocItem(cpit, 0, str, output_active));
 
        TocList & toclist = backend.tocs();
-       childbuffer->tocBackend().update();
+       childbuffer->tocBackend().update(output_active);
        TocList const & childtoclist = childbuffer->tocBackend().tocs();
        TocList::const_iterator it = childtoclist.begin();
        TocList::const_iterator const end = childtoclist.end();
@@ -1114,6 +1159,8 @@ void InsetInclude::updateCommand()
 
 void InsetInclude::updateBuffer(ParIterator const & it, UpdateType utype)
 {
+       button_.update(screenLabel(), true);
+
        Buffer const * const childbuffer = getChildBuffer();
        if (childbuffer) {
                childbuffer->updateBuffer(Buffer::UpdateChildOnly, utype);