]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetInclude.cpp
Merge branch 'master' into biblatex2
[lyx.git] / src / insets / InsetInclude.cpp
index c3bd9197ea233b953d1eabfe93d8a947073ec775..4e44ec8c87800f1825b2d65da6991fb9b6a1d837 100644 (file)
 #include "LayoutFile.h"
 #include "LayoutModuleList.h"
 #include "LyX.h"
-#include "LyXRC.h"
 #include "Lexer.h"
 #include "MetricsInfo.h"
 #include "output_plaintext.h"
 #include "output_xhtml.h"
 #include "OutputParams.h"
+#include "texstream.h"
 #include "TextClass.h"
 #include "TocBackend.h"
 
@@ -61,6 +61,8 @@
 #include "support/lassert.h"
 #include "support/lstrings.h" // contains
 #include "support/lyxalgo.h"
+#include "support/mutex.h"
+#include "support/ExceptionMessage.h"
 
 #include "support/bind.h"
 
@@ -77,6 +79,8 @@ namespace {
 docstring const uniqueID()
 {
        static unsigned int seed = 1000;
+       static Mutex mutex;
+       Mutex::Locker lock(&mutex);
        return "file" + convert<docstring>(++seed);
 }
 
@@ -125,7 +129,7 @@ bool isVerbatim(InsetCommandParams const & params)
 bool isInputOrInclude(InsetCommandParams const & params)
 {
        Types const t = type(params);
-       return t == INPUT || t == INCLUDE;
+       return t == INPUT || t == INCLUDE;
 }
 
 
@@ -388,7 +392,8 @@ docstring InsetInclude::screenLabel() const
                        temp = listings_label_;
                        break;
                case NONE:
-                       LASSERT(false, /**/);
+                       LASSERT(false, temp = buffer().B_("Unknown"));
+                       break;
        }
 
        temp += ": ";
@@ -406,7 +411,9 @@ Buffer * InsetInclude::getChildBuffer() const
 {
        Buffer * childBuffer = loadIfNeeded(); 
 
-       // FIXME: recursive includes
+       // FIXME RECURSIVE INCLUDE
+       // This isn't sufficient, as the inclusion could be downstream.
+       // But it'll have to do for now.
        return (childBuffer == &buffer()) ? 0 : childBuffer;
 }
 
@@ -535,6 +542,8 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
 
        if (!runparams.nice)
                incfile = mangled;
+       else if (!runparams.silent)
+               ; // no warning wanted
        else if (!isValidLaTeXFileName(incfile)) {
                frontend::Alert::warning(_("Invalid filename"),
                        _("The following filename will cause troubles "
@@ -548,7 +557,8 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                        from_utf8(incfile), true);
        }
 
-       FileName const writefile(makeAbsPath(mangled, masterBuffer->temppath()));
+       FileName const writefile(makeAbsPath(mangled, runparams.for_preview ?
+                                                buffer().temppath() : masterBuffer->temppath()));
 
        LYXERR(Debug::LATEX, "incfile:" << incfile);
        LYXERR(Debug::LATEX, "exportfile:" << exportfile);
@@ -625,42 +635,58 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
 
                Buffer * tmp = loadIfNeeded();
                if (!tmp) {
-                       docstring text = bformat(_("Could not load included "
-                               "file\n`%1$s'\n"
-                               "Please, check whether it actually exists."),
-                               included_file.displayName());
-                       Alert::warning(_("Missing included file"), text);
+                       if (!runparams.silent) {
+                               docstring text = bformat(_("Could not load included "
+                                       "file\n`%1$s'\n"
+                                       "Please, check whether it actually exists."),
+                                       included_file.displayName());
+                               Alert::warning(_("Missing included file"), text);
+                       }
                        return;
                }
 
-               if (tmp->params().baseClass() != masterBuffer->params().baseClass()) {
-                       // FIXME UNICODE
-                       docstring text = bformat(_("Included file `%1$s'\n"
-                               "has textclass `%2$s'\n"
-                               "while parent file has textclass `%3$s'."),
-                               included_file.displayName(),
-                               from_utf8(tmp->params().documentClass().name()),
-                               from_utf8(masterBuffer->params().documentClass().name()));
-                       Alert::warning(_("Different textclasses"), text, true);
-               }
+               if (!runparams.silent) {
+                       if (tmp->params().baseClass() != masterBuffer->params().baseClass()) {
+                               // FIXME UNICODE
+                               docstring text = bformat(_("Included file `%1$s'\n"
+                                       "has textclass `%2$s'\n"
+                                       "while parent file has textclass `%3$s'."),
+                                       included_file.displayName(),
+                                       from_utf8(tmp->params().documentClass().name()),
+                                       from_utf8(masterBuffer->params().documentClass().name()));
+                               Alert::warning(_("Different textclasses"), text, true);
+                       }
 
-               // Make sure modules used in child are all included in master
-               // FIXME It might be worth loading the children's modules into the master
-               // over in BufferParams rather than doing this check.
-               LayoutModuleList const masterModules = masterBuffer->params().getModules();
-               LayoutModuleList const childModules = tmp->params().getModules();
-               LayoutModuleList::const_iterator it = childModules.begin();
-               LayoutModuleList::const_iterator end = childModules.end();
-               for (; it != end; ++it) {
-                       string const module = *it;
-                       LayoutModuleList::const_iterator found =
-                               find(masterModules.begin(), masterModules.end(), module);
-                       if (found == masterModules.end()) {
+                       string const child_tf = tmp->params().useNonTeXFonts ? "true" : "false";
+                       string const master_tf = masterBuffer->params().useNonTeXFonts ? "true" : "false";
+                       if (tmp->params().useNonTeXFonts != masterBuffer->params().useNonTeXFonts) {
                                docstring text = bformat(_("Included file `%1$s'\n"
-                                       "uses module `%2$s'\n"
-                                       "which is not used in parent file."),
-                                       included_file.displayName(), from_utf8(module));
-                               Alert::warning(_("Module not found"), text);
+                                       "has use-non-TeX-fonts set to `%2$s'\n"
+                                       "while parent file has use-non-TeX-fonts set to `%3$s'."),
+                                       included_file.displayName(),
+                                       from_utf8(child_tf),
+                                       from_utf8(master_tf));
+                               Alert::warning(_("Different use-non-TeX-fonts settings"), text, true);
+                       }
+
+                       // Make sure modules used in child are all included in master
+                       // FIXME It might be worth loading the children's modules into the master
+                       // over in BufferParams rather than doing this check.
+                       LayoutModuleList const masterModules = masterBuffer->params().getModules();
+                       LayoutModuleList const childModules = tmp->params().getModules();
+                       LayoutModuleList::const_iterator it = childModules.begin();
+                       LayoutModuleList::const_iterator end = childModules.end();
+                       for (; it != end; ++it) {
+                               string const module = *it;
+                               LayoutModuleList::const_iterator found =
+                                       find(masterModules.begin(), masterModules.end(), module);
+                               if (found == masterModules.end()) {
+                                       docstring text = bformat(_("Included file `%1$s'\n"
+                                               "uses module `%2$s'\n"
+                                               "which is not used in parent file."),
+                                               included_file.displayName(), from_utf8(module));
+                                       Alert::warning(_("Module not found"), text);
+                               }
                        }
                }
 
@@ -676,9 +702,9 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                // and language.
                Encoding const * const oldEnc = runparams.encoding;
                Language const * const oldLang = runparams.master_language;
-               // If the master has full unicode flavor (XeTeX, LuaTeX),
+               // If the master uses non-TeX fonts (XeTeX, LuaTeX),
                // the children must be encoded in plain utf8!
-               runparams.encoding = runparams.isFullUnicode() ?
+               runparams.encoding = masterBuffer->params().useNonTeXFonts ?
                        encodings.fromLyXName("utf8-plain")
                        : &tmp->params().encoding();
                runparams.master_language = buffer().params().language;
@@ -687,16 +713,19 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                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: "
+                       if (!runparams.silent) {
+                               docstring msg = bformat(_("Included file `%1$s' "
+                                       "was not exported correctly.\n "
                                        "LaTeX export is probably incomplete."),
                                        included_file.displayName());
-                       ErrorList const & el = tmp->errorList("Export");
-                       if (!el.empty())
-                               msg = bformat(from_ascii("%1$s\n\n%2$s\n\n%3$s"),
+                               ErrorList const & el = tmp->errorList("Export");
+                               if (!el.empty())
+                                       msg = bformat(from_ascii("%1$s\n\n%2$s\n\n%3$s"),
                                                msg, el.begin()->error,
                                                el.begin()->description);
-                       Alert::warning(_("Export failure"), msg);
+                               throw ExceptionMessage(ErrorException, _("Error: "),
+                                                      msg);
+                       }
                }
                runparams.encoding = oldEnc;
                runparams.master_language = oldLang;
@@ -710,16 +739,17 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                                                        included_file,
                                                        inc_format, tex_format, el);
 
-                       if (!success) {
+                       if (!success && !runparams.silent) {
                                docstring msg = bformat(_("Included file `%1$s' "
-                                               "was not exported correctly.\nWarning: "
+                                               "was not exported correctly.\n "
                                                "LaTeX export is probably incomplete."),
                                                included_file.displayName());
                                if (!el.empty())
                                        msg = bformat(from_ascii("%1$s\n\n%2$s\n\n%3$s"),
                                                        msg, el.begin()->error,
                                                        el.begin()->description);
-                               Alert::warning(_("Export failure"), msg);
+                               throw ExceptionMessage(ErrorException, _("Error: "),
+                                                      msg);
                        }
                }
        } else {
@@ -768,7 +798,8 @@ docstring InsetInclude::xhtml(XHTMLStream & xs, OutputParams const & rp) const
        // converter on the included file. But that's just masochistic.)
        FileName const included_file = includedFileName(buffer(), params());
        if (!isLyXFileName(included_file.absFileName())) {
-               frontend::Alert::warning(_("Unsupported Inclusion"),
+               if (!rp.silent)
+                       frontend::Alert::warning(_("Unsupported Inclusion"),
                                         bformat(_("LyX does not know how to include non-LyX files when "
                                                   "generating HTML output. Offending file:\n%1$s"),
                                                    params()["filename"]));
@@ -813,8 +844,9 @@ docstring InsetInclude::xhtml(XHTMLStream & xs, OutputParams const & rp) 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
-       if (op.for_tooltip || op.for_toc) {
+       // 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
@@ -903,14 +935,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
@@ -945,9 +976,12 @@ void InsetInclude::validate(LaTeXFeatures & features) const
                        // otherwise it would always be the master buffer,
                        // and nested includes would not work.
                        features.setBuffer(*tmp);
+                       // Maybe this is already a child
+                       bool const is_child =
+                               features.runparams().is_child;
                        features.runparams().is_child = true;
                        tmp->validate(features);
-                       features.runparams().is_child = false;
+                       features.runparams().is_child = is_child;
                        features.setBuffer(buffer());
                }
        }
@@ -959,16 +993,21 @@ void InsetInclude::collectBibKeys(InsetIterator const & /*di*/) const
        Buffer * child = loadIfNeeded();
        if (!child)
                return;
+       // FIXME RECURSIVE INCLUDE
+       // This isn't sufficient, as the inclusion could be downstream.
+       // But it'll have to do for now.
+       if (child == &buffer())
+               return;
        child->collectBibKeys();
 }
 
 
 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) {
+       if (RenderPreview::previewText()) {
                graphics::PreviewImage const * pimage =
                        preview_->getPreviewImage(mi.base.bv->buffer());
                use_preview = pimage && pimage->image();
@@ -991,10 +1030,10 @@ 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) {
+       if (RenderPreview::previewText()) {
                graphics::PreviewImage const * pimage =
                        preview_->getPreviewImage(pi.base.bv->buffer());
                use_preview = pimage && pimage->image();
@@ -1007,6 +1046,12 @@ void InsetInclude::draw(PainterInfo & pi, int x, int y) const
 }
 
 
+void InsetInclude::write(ostream & os) const
+{
+       params().Write(os, &buffer());
+}
+
+
 string InsetInclude::contextMenuName() const
 {
        return "context-include";
@@ -1038,7 +1083,7 @@ void InsetInclude::fileChanged() const
                return;
 
        preview_->removePreview(*buffer);
-       add_preview(*preview_.get(), *this, *buffer);
+       add_preview(*preview_, *this, *buffer);
        preview_->startLoading(*buffer);
 }
 
@@ -1056,13 +1101,13 @@ bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
 
 docstring latexString(InsetInclude const & inset)
 {
-       TexRow texrow;
        odocstringstream ods;
-       otexstream os(ods, texrow);
+       otexstream os(ods);
        // We don't need to set runparams.encoding since this will be done
        // by latex() anyway.
        OutputParams runparams(0);
        runparams.flavor = OutputParams::LATEX;
+       runparams.for_preview = true;
        inset.latex(os, runparams);
 
        return ods.str();
@@ -1073,8 +1118,7 @@ void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
                 Buffer const & buffer)
 {
        InsetCommandParams const & params = inset.params();
-       if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
-           preview_wanted(params, buffer)) {
+       if (RenderPreview::previewText() && preview_wanted(params, buffer)) {
                renderer.setAbsFile(includedFileName(buffer, params));
                docstring const snippet = latexString(inset);
                renderer.addPreview(snippet, buffer);
@@ -1096,41 +1140,38 @@ void InsetInclude::addPreview(DocIterator const & /*inset_pos*/,
 }
 
 
-void InsetInclude::addToToc(DocIterator const & cpit, bool output_active) const
+void InsetInclude::addToToc(DocIterator const & cpit, bool output_active,
+                                                       UpdateType utype) const
 {
-       TocBackend & backend = buffer().tocBackend();
-
        if (isListings(params())) {
                if (label_)
-                       label_->addToToc(cpit, output_active);
-
+                       label_->addToToc(cpit, output_active, utype);
+               TocBuilder & b = buffer().tocBackend().builder("listing");
+               b.pushItem(cpit, screenLabel(), output_active);
                InsetListingsParams p(to_utf8(params()["lstparams"]));
-               string caption = p.getParamValue("caption");
-               if (caption.empty())
+               b.argumentItem(from_utf8(p.getParamValue("caption")));
+               b.pop();
+       } else {
+               Buffer const * const childbuffer = getChildBuffer();
+
+               TocBuilder & b = buffer().tocBackend().builder("child");
+               docstring str = childbuffer ? childbuffer->fileName().displayName()
+                       : from_ascii("?");
+               b.pushItem(cpit, str, output_active);
+               b.pop();
+
+               if (!childbuffer)
                        return;
-               Toc & toc = backend.toc("listing");
-               docstring str = convert<docstring>(toc.size() + 1)
-                       + ". " +  from_utf8(caption);
-               DocIterator pit = cpit;
-               toc.push_back(TocItem(pit, 0, str, output_active));
-               return;
-       }
-       Buffer const * const childbuffer = getChildBuffer();
-       if (!childbuffer)
-               return;
 
-       Toc & toc = backend.toc("child");
-       docstring str = childbuffer->fileName().displayName();
-       toc.push_back(TocItem(cpit, 0, str, output_active));
-
-       TocList & toclist = backend.tocs();
-       childbuffer->tocBackend().update(output_active);
-       TocList const & childtoclist = childbuffer->tocBackend().tocs();
-       TocList::const_iterator it = childtoclist.begin();
-       TocList::const_iterator const end = childtoclist.end();
-       for(; it != end; ++it)
-               toclist[it->first].insert(toclist[it->first].end(),
-                       it->second.begin(), it->second.end());
+               // Include Tocs from children
+               childbuffer->tocBackend().update(output_active, utype);
+               for(auto const & pair : childbuffer->tocBackend().tocs()) {
+                       string const & type = pair.first;
+                       shared_ptr<Toc> child_toc = pair.second;
+                       shared_ptr<Toc> toc = buffer().tocBackend().toc(type);
+                       toc->insert(toc->end(), child_toc->begin(), child_toc->end());
+               }
+       }
 }