]> git.lyx.org Git - features.git/blobdiff - src/insets/InsetInclude.cpp
* Lazy MathData to avoid unneeded interpretation of macro definitions
[features.git] / src / insets / InsetInclude.cpp
index b7708c14fa048e9df0bcd5001f26fac252571ed6..42a61077fc3ceedc305efcce125c3b979c5f2659 100644 (file)
@@ -4,6 +4,7 @@
  * Licence details can be found in the file COPYING.
  *
  * \author Lars Gullik Bjønnes
+ * \author Richard Heck (conversion to InsetCommand)
  *
  * Full author contact details are available in file CREDITS.
  */
 #include "BufferParams.h"
 #include "BufferView.h"
 #include "Cursor.h"
-#include "debug.h"
+#include "support/debug.h"
 #include "DispatchResult.h"
 #include "Exporter.h"
 #include "FuncRequest.h"
 #include "FuncStatus.h"
-#include "gettext.h"
+#include "support/gettext.h"
 #include "LaTeXFeatures.h"
 #include "LyX.h"
 #include "LyXRC.h"
@@ -31,6 +32,7 @@
 #include "MetricsInfo.h"
 #include "OutputParams.h"
 #include "TocBackend.h"
+#include "TextClass.h"
 
 #include "frontends/alert.h"
 #include "frontends/Painter.h"
 #include "insets/RenderPreview.h"
 #include "insets/InsetListingsParams.h"
 
+#include "support/docstream.h"
+#include "support/FileNameList.h"
 #include "support/filetools.h"
 #include "support/lstrings.h" // contains
 #include "support/lyxalgo.h"
-#include "support/lyxlib.h"
 #include "support/convert.h"
 
 #include <boost/bind.hpp>
 
+using namespace std;
+using namespace lyx::support;
 
 namespace lyx {
 
-using support::addName;
-using support::absolutePath;
-using support::bformat;
-using support::changeExtension;
-using support::contains;
-using support::copy;
-using support::DocFileName;
-using support::FileName;
-using support::getVectorFromString;
-using support::isLyXFilename;
-using support::isValidLaTeXFilename;
-using support::latex_path;
-using support::makeAbsPath;
-using support::makeDisplayPath;
-using support::makeRelPath;
-using support::onlyFilename;
-using support::onlyPath;
-using support::prefixIs;
-using support::subst;
-using support::sum;
-
-using std::endl;
-using std::find;
-using std::string;
-using std::istringstream;
-using std::ostream;
-using std::ostringstream;
-using std::vector;
-
 namespace Alert = frontend::Alert;
 
 
@@ -95,27 +71,29 @@ docstring const uniqueID()
 
 /// the type of inclusion
 enum Types {
-       INCLUDE = 0,
- VERB = 1,
- INPUT = 2,
- VERBAST = 3,
- LISTINGS = 4,
+       INCLUDE, VERB, INPUT, VERBAST, LISTINGS, NONE
 };
 
 
-Types type(InsetCommandParams const & params)
+Types type(string const & s)
 {
-       string const command_name = params.getCmdName();
-
-       if (command_name == "input")
+       if (s == "input")
                return INPUT;
-       if  (command_name == "verbatiminput")
+       if (s == "verbatiminput")
                return VERB;
-       if  (command_name == "verbatiminput*")
+       if (s == "verbatiminput*")
                return VERBAST;
-       if  (command_name == "lstinputlisting")
+       if (s == "lstinputlisting")
                return LISTINGS;
-       return INCLUDE;
+       if (s == "include")
+               return INCLUDE;
+       return NONE;
+}
+
+
+Types type(InsetCommandParams const & params)
+{
+       return type(params.getCmdName());
 }
 
 
@@ -128,14 +106,14 @@ bool isListings(InsetCommandParams const & params)
 bool isVerbatim(InsetCommandParams const & params)
 {
        Types const t = type(params);
-       return (t == VERB) || (t == VERBAST);
+       return t == VERB || t == VERBAST;
 }
 
 
 bool isInputOrInclude(InsetCommandParams const & params)
 {
        Types const t = type(params);
-       return (t == INPUT) || (t == INCLUDE);
+       return t == INPUT || t == INCLUDE;
 }
 
 } // namespace anon
@@ -157,6 +135,24 @@ InsetInclude::InsetInclude(InsetInclude const & other)
 }
 
 
+CommandInfo const * InsetInclude::findInfo(string const & /* cmdName */)
+{
+       // FIXME
+       // This is only correct for the case of listings, but it'll do for now.
+       // In the other cases, this second parameter should just be empty.
+       static const char * const paramnames[] = {"filename", "lstparams", ""};
+       static const bool isoptional[] = {false, true};
+       static const CommandInfo info = {2, paramnames, isoptional};
+       return &info;
+}
+
+
+bool InsetInclude::isCompatibleCommand(string const & s)
+{
+       return type(s) != NONE;
+}
+
+
 void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
        switch (cmd.action) {
@@ -166,8 +162,8 @@ void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
                InsetCommandMailer::string2params("include", to_utf8(cmd.argument()), p);
                if (!p.getCmdName().empty()) {
                        if (isListings(p)){
-                               InsetListingsParams par_old(params().getOptions());
-                               InsetListingsParams par_new(p.getOptions());
+                               InsetListingsParams par_old(to_utf8(params()["lstparams"]));
+                               InsetListingsParams par_new(to_utf8(p["lstparams"]));
                                if (par_old.getParamValue("label") !=
                                    par_new.getParamValue("label")
                                    && !par_new.getParamValue("label").empty())
@@ -193,9 +189,9 @@ void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
 
 namespace {
 
-string const masterFilename(Buffer const & buffer)
+FileName const masterFileName(Buffer const & buffer)
 {
-       return buffer.masterBuffer()->absFileName();
+       return buffer.masterBuffer()->fileName();
 }
 
 
@@ -254,9 +250,11 @@ docstring const InsetInclude::getScreenLabel(Buffer const & buf) const
                case INCLUDE:
                        temp = buf.B_("Include");
                        break;
-               case LISTINGS: {
+               case LISTINGS:
                        temp = listings_label_;
-               }
+                       break;
+               case NONE:
+                       BOOST_ASSERT(false);
        }
 
        temp += ": ";
@@ -270,9 +268,7 @@ docstring const InsetInclude::getScreenLabel(Buffer const & buf) const
 }
 
 
-namespace {
-
-/// return the child buffer if the file is a LyX doc and is loaded
+       /// return the child buffer if the file is a LyX doc and is loaded
 Buffer * getChildBuffer(Buffer const & buffer, InsetCommandParams const & params)
 {
        if (isVerbatim(params) || isListings(params))
@@ -291,9 +287,6 @@ Buffer * getChildBuffer(Buffer const & buffer, InsetCommandParams const & params
                return childBuffer;
 }
 
-} // namespace anon
-
-
 /// return true if the file is or got loaded.
 Buffer * loadIfNeeded(Buffer const & parent, InsetCommandParams const & params)
 {
@@ -314,17 +307,52 @@ Buffer * loadIfNeeded(Buffer const & parent, InsetCommandParams const & params)
                        return 0;
 
                child = theBufferList().newBuffer(included_file.absFilename());
+               if (!child)
+                       // Buffer creation is not possible.
+                       return 0;
+
                if (!child->loadLyXFile(included_file)) {
                        //close the buffer we just opened
-                       theBufferList().close(child, false);
+                       theBufferList().release(child);
                        return 0;
                }
        }
-       child->setParentName(parent_filename);
+       child->setParent(&parent);
        return child;
 }
 
 
+void resetParentBuffer(Buffer const * parent, InsetCommandParams const & params,
+       bool close_it)
+{
+       if (isVerbatim(params) || isListings(params))
+               return;
+
+       string const parent_filename = parent->absFileName();
+       FileName const included_file = makeAbsPath(to_utf8(params["filename"]),
+                          onlyPath(parent_filename));
+
+       if (!isLyXFilename(included_file.absFilename()))
+               return;
+
+       Buffer * child = theBufferList().getBuffer(included_file.absFilename());
+       // File not opened, nothing to close.
+       if (!child)
+               return;
+
+       // Child document has a different parent, don't close it.
+       if (child->parent() != parent)
+               return;
+
+       //close the buffer.
+       child->setParent(0);
+       if (close_it)
+               theBufferList().release(child);
+       else
+               updateLabels(*child);
+}
+
+
 int InsetInclude::latex(Buffer const & buffer, odocstream & os,
                        OutputParams const & runparams) const
 {
@@ -353,7 +381,7 @@ int InsetInclude::latex(Buffer const & buffer, odocstream & os,
 
        // if incfile is relative, make it relative to the master
        // buffer directory.
-       if (!absolutePath(incfile)) {
+       if (!FileName(incfile).isAbsolute()) {
                // FIXME UNICODE
                incfile = to_utf8(makeRelPath(from_utf8(included_file.absFilename()),
                                              from_utf8(masterBuffer->filePath())));
@@ -374,9 +402,9 @@ int InsetInclude::latex(Buffer const & buffer, odocstream & os,
                                           "when running the exported file through LaTeX: ") +
                                            from_utf8(incfile));
        }
-       LYXERR(Debug::LATEX) << "incfile:" << incfile << endl;
-       LYXERR(Debug::LATEX) << "exportfile:" << exportfile << endl;
-       LYXERR(Debug::LATEX) << "writefile:" << writefile << endl;
+       LYXERR(Debug::LATEX, "incfile:" << incfile);
+       LYXERR(Debug::LATEX, "exportfile:" << exportfile);
+       LYXERR(Debug::LATEX, "writefile:" << writefile);
 
        if (runparams.inComment || runparams.dryrun) {
                //Don't try to load or copy the file if we're
@@ -395,7 +423,7 @@ int InsetInclude::latex(Buffer const & buffer, odocstream & os,
                        docstring text = bformat(_("Included file `%1$s'\n"
                                                "has textclass `%2$s'\n"
                                                             "while parent file has textclass `%3$s'."),
-                                             makeDisplayPath(included_file.absFilename()),
+                                             included_file.displayName(),
                                              from_utf8(tmp->params().getTextClass().name()),
                                              from_utf8(masterBuffer->params().getTextClass().name()));
                        Alert::warning(_("Different textclasses"), text);
@@ -417,7 +445,7 @@ int InsetInclude::latex(Buffer const & buffer, odocstream & os,
                                docstring text = bformat(_("Included file `%1$s'\n"
                                                        "uses module `%2$s'\n"
                                                        "which is not used in parent file."),
-                                      makeDisplayPath(included_file.absFilename()), from_utf8(module));
+                                      included_file.displayName(), from_utf8(module));
                                Alert::warning(_("Module not found"), text);
                        }
                }
@@ -433,7 +461,7 @@ int InsetInclude::latex(Buffer const & buffer, odocstream & os,
                Encoding const * const oldEnc = runparams.encoding;
                runparams.encoding = &tmp->params().encoding();
                tmp->makeLaTeXFile(writefile,
-                                  onlyPath(masterFilename(buffer)),
+                                  masterFileName(buffer).onlyPath().absFilename(),
                                   runparams, false);
                runparams.encoding = oldEnc;
        } else {
@@ -441,17 +469,16 @@ int InsetInclude::latex(Buffer const & buffer, odocstream & os,
                // 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.
-               unsigned long const checksum_in  = sum(included_file);
-               unsigned long const checksum_out = sum(writefile);
+               unsigned long const checksum_in  = included_file.checksum();
+               unsigned long const checksum_out = writefile.checksum();
 
                if (checksum_in != checksum_out) {
-                       if (!copy(included_file, writefile)) {
+                       if (!included_file.copyTo(writefile)) {
                                // FIXME UNICODE
-                               LYXERR(Debug::LATEX)
-                                       << to_utf8(bformat(_("Could not copy the file\n%1$s\n"
+                               LYXERR(Debug::LATEX,
+                                       to_utf8(bformat(_("Could not copy the file\n%1$s\n"
                                                                  "into the temporary directory."),
-                                                  from_utf8(included_file.absFilename())))
-                                       << endl;
+                                                  from_utf8(included_file.absFilename()))));
                                return 0;
                        }
                }
@@ -483,7 +510,7 @@ int InsetInclude::latex(Buffer const & buffer, odocstream & os,
                }
        } else if (type(params()) == LISTINGS) {
                os << '\\' << from_ascii(params().getCmdName());
-               string opt = params().getOptions();
+               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())
@@ -511,10 +538,8 @@ int InsetInclude::plaintext(Buffer const & buffer, odocstream & os,
 {
        if (isVerbatim(params()) || isListings(params())) {
                os << '[' << getScreenLabel(buffer) << '\n';
-               // FIXME: We don't know the encoding of the file
-               docstring const str =
-                    from_utf8(includedFilename(buffer, params()).fileContents());
-               os << str;
+               // FIXME: We don't know the encoding of the file, default to UTF-8.
+               os << includedFilename(buffer, params()).fileContents("UTF-8");
                os << "\n]";
                return PLAINTEXT_NEWLINE + 1; // one char on a separate line
        } else {
@@ -560,9 +585,9 @@ int InsetInclude::docbook(Buffer const & buffer, odocstream & os,
                if (!runparams.nice)
                        incfile = mangled;
 
-               LYXERR(Debug::LATEX) << "incfile:" << incfile << endl;
-               LYXERR(Debug::LATEX) << "exportfile:" << exportfile << endl;
-               LYXERR(Debug::LATEX) << "writefile:" << writefile << endl;
+               LYXERR(Debug::LATEX, "incfile:" << incfile);
+               LYXERR(Debug::LATEX, "exportfile:" << exportfile);
+               LYXERR(Debug::LATEX, "writefile:" << writefile);
 
                tmp->makeDocBookFile(writefile, runparams, true);
        }
@@ -585,7 +610,7 @@ int InsetInclude::docbook(Buffer const & buffer, odocstream & os,
 
 void InsetInclude::validate(LaTeXFeatures & features) const
 {
-       string incfile(to_utf8(params()["filename"]));
+       string incfile = to_utf8(params()["filename"]);
        string writefile;
 
        Buffer const & buffer = features.buffer();
@@ -633,10 +658,10 @@ void InsetInclude::validate(LaTeXFeatures & features) const
 
 
 void InsetInclude::getLabelList(Buffer const & buffer,
-                               std::vector<docstring> & list) const
+                               vector<docstring> & list) const
 {
        if (isListings(params())) {
-               InsetListingsParams p(params().getOptions());
+               InsetListingsParams p(to_utf8(params()["lstparams"]));
                string label = p.getParamValue("label");
                if (!label.empty())
                        list.push_back(from_utf8(label));
@@ -644,9 +669,9 @@ void InsetInclude::getLabelList(Buffer const & buffer,
        else if (loadIfNeeded(buffer, params())) {
                string const included_file = includedFilename(buffer, params()).absFilename();
                Buffer * tmp = theBufferList().getBuffer(included_file);
-               tmp->setParentName("");
+               tmp->setParent(0);
                tmp->getLabelList(list);
-               tmp->setParentName(parentFilename(buffer));
+               tmp->setParent(const_cast<Buffer *>(&buffer));
        }
 }
 
@@ -658,9 +683,9 @@ void InsetInclude::fillWithBibKeys(Buffer const & buffer,
                string const included_file = includedFilename(buffer, params()).absFilename();
                Buffer * tmp = theBufferList().getBuffer(included_file);
                //FIXME This is kind of a dirty hack and should be made reasonable.
-               tmp->setParentName("");
+               tmp->setParent(0);
                keys.fillWithBibKeys(tmp);
-               tmp->setParentName(parentFilename(buffer));
+               tmp->setParent(&buffer);
        }
 }
 
@@ -669,24 +694,24 @@ void InsetInclude::updateBibfilesCache(Buffer const & buffer)
 {
        Buffer * const tmp = getChildBuffer(buffer, params());
        if (tmp) {
-               tmp->setParentName("");
+               tmp->setParent(0);
                tmp->updateBibfilesCache();
-               tmp->setParentName(parentFilename(buffer));
+               tmp->setParent(&buffer);
        }
 }
 
 
-std::vector<FileName> const &
+FileNameList const &
 InsetInclude::getBibfilesCache(Buffer const & buffer) const
 {
        Buffer * const tmp = getChildBuffer(buffer, params());
        if (tmp) {
-               tmp->setParentName("");
-               std::vector<FileName> const & cache = tmp->getBibfilesCache();
-               tmp->setParentName(parentFilename(buffer));
+               tmp->setParent(0);
+               FileNameList const & cache = tmp->getBibfilesCache();
+               tmp->setParent(&buffer);
                return cache;
        }
-       static std::vector<FileName> const empty;
+       static FileNameList const empty;
        return empty;
 }
 
@@ -749,14 +774,13 @@ Inset::DisplayType InsetInclude::display() const
 
 void InsetInclude::fileChanged() const
 {
-       Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
-       if (!buffer_ptr)
+       Buffer const * const buffer = updateFrontend();
+       if (!buffer)
                return;
 
-       Buffer const & buffer = *buffer_ptr;
-       preview_->removePreview(buffer);
-       add_preview(*preview_.get(), *this, buffer);
-       preview_->startLoading(buffer);
+       preview_->removePreview(*buffer);
+       add_preview(*preview_.get(), *this, *buffer);
+       preview_->startLoading(*buffer);
 }
 
 
@@ -767,7 +791,7 @@ bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
        FileName const included_file = includedFilename(buffer, params);
 
        return type(params) == INPUT && params.preview() &&
-               included_file.isFileReadable();
+               included_file.isReadableFile();
 }
 
 
@@ -814,7 +838,7 @@ void InsetInclude::addToToc(TocList & toclist, Buffer const & buffer,
        ParConstIterator const & pit) const
 {
        if (isListings(params())) {
-               InsetListingsParams p(params().getOptions());
+               InsetListingsParams p(to_utf8(params()["lstparams"]));
                string caption = p.getParamValue("caption");
                if (caption.empty())
                        return;
@@ -845,7 +869,7 @@ void InsetInclude::updateLabels(Buffer const & buffer, ParIterator const &)
        if (childbuffer)
                lyx::updateLabels(*childbuffer, true);
        else if (isListings(params())) {
-               InsetListingsParams const par = params().getOptions();
+               InsetListingsParams const par(to_utf8(params()["lstparams"]));
                if (par.getParamValue("caption").empty())
                        listings_label_.clear();
                else {