]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetInclude.cpp
Fix the guiName of external insets.
[lyx.git] / src / insets / InsetInclude.cpp
index a2164475c3308e4745543bc9e2b04917374edd11..fbabcc8b50b5f0770ef05df3f41a719757f82530 100644 (file)
 #include "BufferList.h"
 #include "BufferParams.h"
 #include "BufferView.h"
+#include "Converter.h"
 #include "Cursor.h"
 #include "DispatchResult.h"
+#include "Encoding.h"
 #include "ErrorList.h"
 #include "Exporter.h"
 #include "Format.h"
@@ -47,6 +49,8 @@
 #include "insets/InsetListingsParams.h"
 #include "insets/RenderPreview.h"
 
+#include "mathed/MacroTable.h"
+
 #include "support/convert.h"
 #include "support/debug.h"
 #include "support/docstream.h"
@@ -160,7 +164,7 @@ InsetLabel * createLabel(Buffer * buf, docstring const & label_str)
 
 
 InsetInclude::InsetInclude(Buffer * buf, InsetCommandParams const & p)
-       : InsetCommand(buf, p, "include"), include_label(uniqueID()),
+       : InsetCommand(buf, p), include_label(uniqueID()),
          preview_(new RenderMonitoredPreview(this)), failedtoload_(false),
          set_label_(false), label_(0), child_buffer_(0)
 {
@@ -169,7 +173,8 @@ InsetInclude::InsetInclude(Buffer * buf, InsetCommandParams const & p)
        if (isListings(params())) {
                InsetListingsParams listing_params(to_utf8(p["lstparams"]));
                label_ = createLabel(buffer_, from_utf8(listing_params.getParamValue("label")));
-       }
+       } else if (isInputOrInclude(params()) && buf)
+               loadIfNeeded();
 }
 
 
@@ -242,10 +247,11 @@ void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
                // child_buffer_ = 0;
                InsetCommandParams p(INCLUDE_CODE);
                if (cmd.getArg(0) == "changetype") {
+                       cur.recordUndo();
                        InsetCommand::doDispatch(cur, cmd);
                        p = params();
                } else
-                       InsetCommand::string2params("include", to_utf8(cmd.argument()), p);
+                       InsetCommand::string2params(to_utf8(cmd.argument()), p);
                if (!p.getCmdName().empty()) {
                        if (isListings(p)){
                                InsetListingsParams new_params(to_utf8(p["lstparams"]));
@@ -265,7 +271,7 @@ void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
                                        }                                       
 
                                        if (new_label != old_label) {
-                                               label_->updateCommand(new_label);
+                                               label_->updateLabelAndRefs(new_label, &cur);
                                                // the label might have been adapted (duplicate)
                                                if (new_label != label_->getParam("name")) {
                                                        new_params.addParam("label", "{" + 
@@ -275,6 +281,7 @@ void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
                                        }
                                }
                        }
+                       cur.recordUndo();
                        setParams(p);
                        cur.forceBufferUpdate();
                } else
@@ -440,31 +447,46 @@ Buffer * InsetInclude::loadIfNeeded() const
                        // Buffer creation is not possible.
                        return 0;
 
-               if (!child->loadLyXFile(included_file)) {
+               // Set parent before loading, such that macros can be tracked
+               child->setParent(&buffer());
+
+               if (child->loadLyXFile() != Buffer::ReadSuccess) {
                        failedtoload_ = true;
+                       child->setParent(0);
                        //close the buffer we just opened
                        theBufferList().release(child);
                        return 0;
                }
-       
+
                if (!child->errorList("Parse").empty()) {
                        // FIXME: Do something.
                }
+       } else {
+               // The file was already loaded, so, simply
+               // inform parent buffer about local macros.
+               Buffer const * parent = &buffer();
+               child->setParent(parent);
+               MacroNameSet macros;
+               child->listMacroNames(macros);
+               MacroNameSet::const_iterator cit = macros.begin();
+               MacroNameSet::const_iterator end = macros.end();
+               for (; cit != end; ++cit)
+                       parent->usermacros.insert(*cit);
        }
-       child->setParent(&buffer());
+
        // Cache the child buffer.
        child_buffer_ = child;
        return child;
 }
 
 
-int InsetInclude::latex(odocstream & os, OutputParams const & runparams) const
+void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
 {
        string incfile = to_utf8(params()["filename"]);
 
        // Do nothing if no file name has been specified
        if (incfile.empty())
-               return 0;
+               return;
 
        FileName const included_file = includedFileName(buffer(), params());
 
@@ -478,7 +500,7 @@ int InsetInclude::latex(odocstream & os, OutputParams const & runparams) const
                Alert::error(_("Recursive input"),
                               bformat(_("Attempted to include file %1$s in itself! "
                               "Ignoring inclusion."), from_utf8(incfile)));
-               return 0;
+               return;
        }
 
        Buffer const * const masterBuffer = buffer().masterBuffer();
@@ -510,14 +532,22 @@ int InsetInclude::latex(odocstream & os, OutputParams const & runparams) const
                incfile = mangled;
        else if (!isValidLaTeXFileName(incfile)) {
                frontend::Alert::warning(_("Invalid filename"),
-                                        _("The following filename is likely to cause trouble "
-                                          "when running the exported file through LaTeX: ") +
-                                           from_utf8(incfile));
+                       _("The following filename will cause troubles "
+                         "when running the exported file through LaTeX: ") +
+                       from_utf8(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: ") +
+                       from_utf8(incfile), true);
        }
        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
@@ -525,10 +555,16 @@ int InsetInclude::latex(odocstream & os, OutputParams const & runparams) const
                 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
-               
+
                Buffer * tmp = loadIfNeeded();
-               if (!tmp)
-                       return false;
+               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);
+                       return;
+               }
 
                if (tmp->params().baseClass() != masterBuffer->params().baseClass()) {
                        // FIXME UNICODE
@@ -563,27 +599,65 @@ int InsetInclude::latex(odocstream & os, OutputParams const & runparams) const
 
                tmp->markDepClean(masterBuffer->temppath());
 
+               // Don't assume the child's format is latex
+               string const inc_format = tmp->params().bufferFormat();
+               FileName const tmpwritefile(changeExtension(writefile.absFileName(),
+                       formats.extension(inc_format)));
+
                // FIXME: handle non existing files
-               // FIXME: Second argument is irrelevant!
-               // since only_body is true, makeLaTeXFile will not look at second
-               // argument. Should we set it to string(), or should makeLaTeXFile
-               // make use of it somehow? (JMarc 20031002)
                // The included file might be written in a different encoding
                // and language.
                Encoding const * const oldEnc = runparams.encoding;
                Language const * const oldLang = runparams.master_language;
-               runparams.encoding = &tmp->params().encoding();
+               // If the master has full unicode flavor (XeTeX, LuaTeX),
+               // the children must be encoded in plain utf8!
+               runparams.encoding = runparams.isFullUnicode() ?
+                       encodings.fromLyXName("utf8-plain")
+                       : &tmp->params().encoding();
                runparams.master_language = buffer().params().language;
-               tmp->makeLaTeXFile(writefile,
-                                  masterFileName(buffer()).onlyPath().absFileName(),
-                                  runparams, false);
+               runparams.par_begin = 0;
+               runparams.par_end = tmp->paragraphs().size();
+               if (!tmp->makeLaTeXFile(tmpwritefile, runparams, false)) {
+                       docstring msg = bformat(_("Included file `%1$s' "
+                                       "was not exported correctly.\nWarning: "
+                                       "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"),
+                                               msg, el.begin()->error,
+                                               el.begin()->description);
+                       Alert::warning(_("Export failure"), msg);
+               }
                runparams.encoding = oldEnc;
                runparams.master_language = oldLang;
+
+               // If needed, use converters to produce a latex file from the child
+               if (tmpwritefile != writefile) {
+                       ErrorList el;
+                       bool const success =
+                               theConverters().convert(tmp, tmpwritefile, writefile,
+                                                       included_file,
+                                                       inc_format, tex_format, el);
+
+                       if (!success) {
+                               docstring msg = bformat(_("Included file `%1$s' "
+                                               "was not exported correctly.\nWarning: "
+                                               "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);
+                       }
+               }
        } else {
                // 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 input@path, see ../Buffer.cpp.
+               // found via the environment variable TEXINPUTS, which may be
+               // set in preferences and by default includes the original dir.
                unsigned long const checksum_in  = included_file.checksum();
                unsigned long const checksum_out = writefile.checksum();
 
@@ -594,13 +668,11 @@ int InsetInclude::latex(odocstream & os, OutputParams const & runparams) const
                                        to_utf8(bformat(_("Could not copy the file\n%1$s\n"
                                                                  "into the temporary directory."),
                                                   from_utf8(included_file.absFileName()))));
-                               return 0;
+                               return;
                        }
                }
        }
 
-       string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
-                       "latex" : "pdflatex";
        switch (type(params())) {
        case VERB:
        case VERBAST: {
@@ -621,8 +693,8 @@ int InsetInclude::latex(odocstream & os, OutputParams const & runparams) const
                        os << '\\' << from_ascii(params().getCmdName())
                           << '{' << from_utf8(incfile) << '}';
                } else {
-               incfile = changeExtension(incfile, ".tex");
-               incfile = latex_path(incfile);
+                       incfile = changeExtension(incfile, ".tex");
+                       incfile = latex_path(incfile);
                        // FIXME UNICODE
                        os << '\\' << from_ascii(params().getCmdName())
                           << '{' << from_utf8(incfile) <<  '}';
@@ -655,12 +727,10 @@ int InsetInclude::latex(odocstream & os, OutputParams const & runparams) const
        case NONE:
                break;
        }
-
-       return 0;
 }
 
 
-docstring InsetInclude::xhtml(XHTMLStream & xs, OutputParams const &rp) const
+docstring InsetInclude::xhtml(XHTMLStream & xs, OutputParams const & rp) const
 {
        if (rp.inComment)
                 return docstring();
@@ -704,7 +774,23 @@ docstring InsetInclude::xhtml(XHTMLStream & xs, OutputParams const &rp) const
        Buffer const * const ibuf = loadIfNeeded();
        if (!ibuf)
                return docstring();
-       ibuf->writeLyXHTMLSource(xs.os(), rp, true);
+
+       // are we generating only some paragraphs, or all of them?
+       bool const all_pars = !rp.dryrun || 
+                       (rp.par_begin == 0 && 
+                        rp.par_end == (int)buffer().text().paragraphs().size());
+       
+       OutputParams op = rp;
+       if (all_pars) {
+               op.par_begin = 0;
+               op.par_end = 0;
+               ibuf->writeLyXHTMLSource(xs.os(), op, true);
+       } else
+               xs << XHTMLStream::ESCAPE_NONE 
+                  << "<!-- Included file: " 
+                  << from_utf8(included_file.absFileName()) 
+                  << XHTMLStream::ESCAPE_NONE 
+                        << " -->";
        return docstring();
 }
 
@@ -831,13 +917,12 @@ void InsetInclude::validate(LaTeXFeatures & features) const
 }
 
 
-void InsetInclude::fillWithBibKeys(BiblioInfo & keys,
-       InsetIterator const & /*di*/) const
+void InsetInclude::collectBibKeys(InsetIterator const & /*di*/) const
 {
        Buffer * child = loadIfNeeded();
        if (!child)
                return;
-       child->fillWithBibKeys(keys);
+       child->collectBibKeys();
 }
 
 
@@ -885,7 +970,7 @@ void InsetInclude::draw(PainterInfo & pi, int x, int y) const
 }
 
 
-docstring InsetInclude::contextMenu(BufferView const &, int, int) const
+docstring InsetInclude::contextMenuName() const
 {
        return from_ascii("context-include");
 }
@@ -927,14 +1012,16 @@ bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
 
 docstring latexString(InsetInclude const & inset)
 {
-       odocstringstream os;
+       TexRow texrow;
+       odocstringstream ods;
+       otexstream os(ods, texrow);
        // We don't need to set runparams.encoding since this will be done
        // by latex() anyway.
        OutputParams runparams(0);
        runparams.flavor = OutputParams::LATEX;
        inset.latex(os, runparams);
 
-       return os.str();
+       return ods.str();
 }
 
 
@@ -965,7 +1052,7 @@ void InsetInclude::addPreview(DocIterator const & /*inset_pos*/,
 }
 
 
-void InsetInclude::addToToc(DocIterator const & cpit)
+void InsetInclude::addToToc(DocIterator const & cpit) const
 {
        TocBackend & backend = buffer().tocBackend();
 
@@ -1009,7 +1096,7 @@ void InsetInclude::updateCommand()
                return;
 
        docstring old_label = label_->getParam("name");
-       label_->updateCommand(old_label, false);
+       label_->updateLabel(old_label);
        // the label might have been adapted (duplicate)
        docstring new_label = label_->getParam("name");
        if (old_label == new_label)
@@ -1024,6 +1111,7 @@ void InsetInclude::updateCommand()
        setParams(p);   
 }
 
+
 void InsetInclude::updateBuffer(ParIterator const & it, UpdateType utype)
 {
        Buffer const * const childbuffer = getChildBuffer();