]> git.lyx.org Git - features.git/blobdiff - src/insets/InsetInclude.cpp
reduce line noise
[features.git] / src / insets / InsetInclude.cpp
index f5c4afd0a8268541b059ce94626669f515e5088e..ecab91e252318c35e5ce651e299a2255d47b6821 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.
  */
@@ -31,6 +32,7 @@
 #include "MetricsInfo.h"
 #include "OutputParams.h"
 #include "TocBackend.h"
+#include "TextClass.h"
 
 #include "frontends/alert.h"
 #include "frontends/Painter.h"
@@ -41,6 +43,7 @@
 #include "insets/RenderPreview.h"
 #include "insets/InsetListingsParams.h"
 
+#include "support/docstream.h"
 #include "support/filetools.h"
 #include "support/lstrings.h" // contains
 #include "support/lyxalgo.h"
@@ -48,7 +51,6 @@
 #include "support/convert.h"
 
 #include <boost/bind.hpp>
-#include <boost/filesystem/operations.hpp>
 
 
 namespace lyx {
@@ -61,13 +63,11 @@ using support::contains;
 using support::copy;
 using support::DocFileName;
 using support::FileName;
-using support::getFileContents;
 using support::getVectorFromString;
-using support::isFileReadable;
 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;
@@ -75,16 +75,14 @@ using support::prefixIs;
 using support::subst;
 using support::sum;
 
-using std::endl;
+using std::find;
 using std::string;
-using std::auto_ptr;
 using std::istringstream;
 using std::ostream;
 using std::ostringstream;
 using std::vector;
 
 namespace Alert = frontend::Alert;
-namespace fs = boost::filesystem;
 
 
 namespace {
@@ -96,37 +94,86 @@ docstring const uniqueID()
 }
 
 
+/// the type of inclusion
+enum Types {
+       INCLUDE, VERB, INPUT, VERBAST, LISTINGS, NONE
+};
+
+
+Types type(std::string const & s)
+{
+       if (s == "input")
+               return INPUT;
+       if (s == "verbatiminput")
+               return VERB;
+       if (s == "verbatiminput*")
+               return VERBAST;
+       if (s == "lstinputlisting")
+               return LISTINGS;
+       if (s == "include")
+               return INCLUDE;
+       return NONE;
+}
+
+
+Types type(InsetCommandParams const & params)
+{
+       return type(params.getCmdName());
+}
+
+
 bool isListings(InsetCommandParams const & params)
 {
-       return params.getCmdName() == "lstinputlisting";
+       return type(params) == LISTINGS;
+}
+
+
+bool isVerbatim(InsetCommandParams const & params)
+{
+       Types const t = type(params);
+       return t == VERB || t == VERBAST;
+}
+
+
+bool isInputOrInclude(InsetCommandParams const & params)
+{
+       Types const t = type(params);
+       return t == INPUT || t == INCLUDE;
 }
 
 } // namespace anon
 
 
 InsetInclude::InsetInclude(InsetCommandParams const & p)
-       : params_(p), include_label(uniqueID()),
-         preview_(new RenderMonitoredPreview(this)),
-         set_label_(false), counter_(0)
+       : InsetCommand(p, "include"), include_label(uniqueID()),
+         preview_(new RenderMonitoredPreview(this)), set_label_(false)
 {
        preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
 }
 
 
 InsetInclude::InsetInclude(InsetInclude const & other)
-       : Inset(other),
-         params_(other.params_),
-         include_label(other.include_label),
-         preview_(new RenderMonitoredPreview(this)),
-         set_label_(false), counter_(0)
+       : InsetCommand(other), include_label(other.include_label),
+         preview_(new RenderMonitoredPreview(this)), set_label_(false)
 {
        preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
 }
 
 
-InsetInclude::~InsetInclude()
+CommandInfo const * InsetInclude::findInfo(std::string const & /* cmdName */)
 {
-       InsetIncludeMailer(*this).hideDialog();
+       // 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(std::string const & s)
+{
+       return type(s) != NONE;
 }
 
 
@@ -135,19 +182,19 @@ void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
        switch (cmd.action) {
 
        case LFUN_INSET_MODIFY: {
-               InsetCommandParams p("include");
-               InsetIncludeMailer::string2params(to_utf8(cmd.argument()), p);
+               InsetCommandParams p(INCLUDE_CODE);
+               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())
-                                       cur.bv().buffer()->changeRefsIfUnique(
+                                       cur.bv().buffer().changeRefsIfUnique(
                                                from_utf8(par_old.getParamValue("label")),
                                                from_utf8(par_new.getParamValue("label")),
-                                               Inset::REF_CODE);
+                                               REF_CODE);
                        }
                        set(p, cur.buffer());
                        cur.buffer().updateBibfilesCache();
@@ -156,96 +203,25 @@ void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
                break;
        }
 
-       case LFUN_INSET_DIALOG_UPDATE:
-               InsetIncludeMailer(*this).updateDialog(&cur.bv());
-               break;
-
-       case LFUN_MOUSE_RELEASE:
-               if (!cur.selection()) 
-                       InsetIncludeMailer(*this).showDialog(&cur.bv());
-               break;
-
+       //pass everything else up the chain
        default:
-               Inset::doDispatch(cur, cmd);
+               InsetCommand::doDispatch(cur, cmd);
                break;
        }
 }
 
 
-bool InsetInclude::getStatus(Cursor & cur, FuncRequest const & cmd,
-               FuncStatus & flag) const
-{
-       switch (cmd.action) {
-
-       case LFUN_INSET_MODIFY:
-       case LFUN_INSET_DIALOG_UPDATE:
-               flag.enabled(true);
-               return true;
-
-       default:
-               return Inset::getStatus(cur, cmd, flag);
-       }
-}
-
-
-InsetCommandParams const & InsetInclude::params() const
-{
-       return params_;
-}
-
-
 namespace {
 
-/// the type of inclusion
-enum Types {
-       INCLUDE = 0,
-       VERB = 1,
-       INPUT = 2,
-       VERBAST = 3,
-       LISTINGS = 4,
-};
-
-
-Types type(InsetCommandParams const & params)
-{
-       string const command_name = params.getCmdName();
-
-       if (command_name == "input")
-               return INPUT;
-       if  (command_name == "verbatiminput")
-               return VERB;
-       if  (command_name == "verbatiminput*")
-               return VERBAST;
-       if  (command_name == "lstinputlisting")
-               return LISTINGS;
-       return INCLUDE;
-}
-
-
-bool isVerbatim(InsetCommandParams const & params)
-{
-       string const command_name = params.getCmdName();
-       return command_name == "verbatiminput" ||
-               command_name == "verbatiminput*";
-}
-
-
-bool isInputOrInclude(InsetCommandParams const & params) 
-{
-       Types const t = type(params);
-       return (t == INPUT) || (t == INCLUDE);
-}
-
-
-string const masterFilename(Buffer const & buffer)
+FileName const masterFileName(Buffer const & buffer)
 {
-       return buffer.getMasterBuffer()->fileName();
+       return buffer.masterBuffer()->fileName();
 }
 
 
 string const parentFilename(Buffer const & buffer)
 {
-       return buffer.fileName();
+       return buffer.absFileName();
 }
 
 
@@ -253,7 +229,7 @@ FileName const includedFilename(Buffer const & buffer,
                              InsetCommandParams const & params)
 {
        return makeAbsPath(to_utf8(params["filename"]),
-                          onlyPath(parentFilename(buffer)));
+              onlyPath(parentFilename(buffer)));
 }
 
 
@@ -264,65 +240,20 @@ void add_preview(RenderMonitoredPreview &, InsetInclude const &, Buffer const &)
 
 void InsetInclude::set(InsetCommandParams const & p, Buffer const & buffer)
 {
-       params_ = p;
+       setParams(p);
        set_label_ = false;
 
        if (preview_->monitoring())
                preview_->stopMonitoring();
 
-       if (type(params_) == INPUT)
+       if (type(params()) == INPUT)
                add_preview(*preview_, *this, buffer);
 }
 
 
-auto_ptr<Inset> InsetInclude::doClone() const
+Inset * InsetInclude::clone() const
 {
-       return auto_ptr<Inset>(new InsetInclude(*this));
-}
-
-
-void InsetInclude::write(Buffer const &, ostream & os) const
-{
-       write(os);
-}
-
-
-void InsetInclude::write(ostream & os) const
-{
-       os << "Include " << to_utf8(params_.getCommand()) << '\n'
-          << "preview " << convert<string>(params_.preview()) << '\n';
-}
-
-
-void InsetInclude::read(Buffer const &, Lexer & lex)
-{
-       read(lex);
-}
-
-
-void InsetInclude::read(Lexer & lex)
-{
-       if (lex.isOK()) {
-               lex.eatLine();
-               string const command = lex.getString();
-               params_.scanCommand(command);
-       }
-       string token;
-       while (lex.isOK()) {
-               lex.next();
-               token = lex.getString();
-               if (token == "\\end_inset")
-                       break;
-               if (token == "preview") {
-                       lex.next();
-                       params_.preview(lex.getBool());
-               } else
-                       lex.printError("Unknown parameter name `$$Token' for command " + params_.getCmdName());
-       }
-       if (token != "\\end_inset") {
-               lex.printError("Missing \\end_inset at this point. "
-                              "Read: `$$Token'");
-       }
+       return new InsetInclude(*this);
 }
 
 
@@ -330,34 +261,32 @@ docstring const InsetInclude::getScreenLabel(Buffer const & buf) const
 {
        docstring temp;
 
-       switch (type(params_)) {
+       switch (type(params())) {
                case INPUT:
-                       temp += buf.B_("Input");
+                       temp = buf.B_("Input");
                        break;
                case VERB:
-                       temp += buf.B_("Verbatim Input");
+                       temp = buf.B_("Verbatim Input");
                        break;
                case VERBAST:
-                       temp += buf.B_("Verbatim Input*");
+                       temp = buf.B_("Verbatim Input*");
                        break;
                case INCLUDE:
-                       temp += buf.B_("Include");
+                       temp = buf.B_("Include");
                        break;
-               case LISTINGS: {
-                       if (counter_ > 0)
-                               temp += buf.B_("Program Listing ") + convert<docstring>(counter_);
-                       else
-                               temp += buf.B_("Program Listing");
+               case LISTINGS:
+                       temp = listings_label_;
                        break;
-               }
+               case NONE:
+                       BOOST_ASSERT(false);
        }
 
        temp += ": ";
 
-       if (params_["filename"].empty())
+       if (params()["filename"].empty())
                temp += "???";
        else
-               temp += from_utf8(onlyFilename(to_utf8(params_["filename"])));
+               temp += from_utf8(onlyFilename(to_utf8(params()["filename"])));
 
        return temp;
 }
@@ -376,146 +305,174 @@ Buffer * getChildBuffer(Buffer const & buffer, InsetCommandParams const & params
                return 0;
 
        Buffer * childBuffer = theBufferList().getBuffer(included_file);
-       
+
        //FIXME RECURSIVE INCLUDES
        if (childBuffer == & buffer)
                return 0;
-       else return childBuffer;
+       else
+               return childBuffer;
 }
 
+} // namespace anon
+
 
 /// return true if the file is or got loaded.
-bool loadIfNeeded(Buffer const & buffer, InsetCommandParams const & params)
+Buffer * loadIfNeeded(Buffer const & parent, InsetCommandParams const & params)
 {
        if (isVerbatim(params) || isListings(params))
-               return false;
+               return 0;
+
+       string const parent_filename = parent.absFileName();
+       FileName const included_file = makeAbsPath(to_utf8(params["filename"]),
+                          onlyPath(parent_filename));
 
-       FileName const included_file = includedFilename(buffer, params);
        if (!isLyXFilename(included_file.absFilename()))
-               return false;
+               return 0;
 
-       Buffer * buf = theBufferList().getBuffer(included_file.absFilename());
-       if (!buf) {
+       Buffer * child = theBufferList().getBuffer(included_file.absFilename());
+       if (!child) {
                // the readonly flag can/will be wrong, not anymore I think.
-               if (!fs::exists(included_file.toFilesystemEncoding()))
-                       return false;
-               buf = theBufferList().newBuffer(included_file.absFilename());
-               if (!loadLyXFile(buf, included_file)) {
+               if (!included_file.exists())
+                       return 0;
+
+               child = theBufferList().newBuffer(included_file.absFilename());
+               if (!child->loadLyXFile(included_file)) {
                        //close the buffer we just opened
-                       theBufferList().close(buf, false);
-                       return false;
+                       theBufferList().close(child, false);
+                       return 0;
                }
        }
-       buf->setParentName(parentFilename(buffer));
-       return true;
+       child->setParentName(parent_filename);
+       return child;
 }
 
 
-} // namespace anon
-
-
 int InsetInclude::latex(Buffer const & buffer, odocstream & os,
-                        OutputParams const & runparams) const
+                       OutputParams const & runparams) const
 {
-       string incfile(to_utf8(params_["filename"]));
+       string incfile(to_utf8(params()["filename"]));
 
        // Do nothing if no file name has been specified
        if (incfile.empty())
                return 0;
 
-       FileName const included_file(includedFilename(buffer, params_));
-       
+       FileName const included_file = includedFilename(buffer, params());
+
        //Check we're not trying to include ourselves.
        //FIXME RECURSIVE INCLUDE
        //This isn't sufficient, as the inclusion could be downstream.
        //But it'll have to do for now.
-       if (isInputOrInclude(params_) &&
-               buffer.fileName() == included_file.toFilesystemEncoding()) 
+       if (isInputOrInclude(params()) &&
+               buffer.absFileName() == included_file.absFilename())
        {
-               Alert::error(_("Recursive input"), 
-                              bformat(_("Attempted to include file %1$s in itself! "
-                              "Ignoring inclusion."), from_utf8(incfile)));
+               Alert::error(_("Recursive input"),
+                              bformat(_("Attempted to include file %1$s in itself! "
+                              "Ignoring inclusion."), from_utf8(incfile)));
                return 0;
        }
 
-       Buffer const * const m_buffer = buffer.getMasterBuffer();
+       Buffer const * const masterBuffer = buffer.masterBuffer();
 
        // if incfile is relative, make it relative to the master
        // buffer directory.
        if (!absolutePath(incfile)) {
                // FIXME UNICODE
                incfile = to_utf8(makeRelPath(from_utf8(included_file.absFilename()),
-                                             from_utf8(m_buffer->filePath())));
+                                             from_utf8(masterBuffer->filePath())));
        }
 
        // write it to a file (so far the complete file)
        string const exportfile = changeExtension(incfile, ".tex");
-       string const mangled = 
+       string const mangled =
                DocFileName(changeExtension(included_file.absFilename(),".tex")).
                        mangledFilename();
-       FileName const writefile(makeAbsPath(mangled, m_buffer->temppath()));
+       FileName const writefile(makeAbsPath(mangled, masterBuffer->temppath()));
 
        if (!runparams.nice)
                incfile = mangled;
-       LYXERR(Debug::LATEX) << "incfile:" << incfile << endl;
-       LYXERR(Debug::LATEX) << "exportfile:" << exportfile << endl;
-       LYXERR(Debug::LATEX) << "writefile:" << writefile << endl;
-
-       if (runparams.inComment || runparams.dryrun)
-               // Don't try to load or copy the file
-               return true;
-       //if it's a LyX file and we're including or inputting it...
-       else if (isInputOrInclude(params_) && 
-                isLyXFilename(included_file.absFilename())) {
+       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));
+       }
+       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
+               //in a comment or doing a dryrun
+       } else 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
-               if (!loadIfNeeded(buffer, params_))
+               if (!loadIfNeeded(buffer, params()))
                        return false;
-                       
+
                Buffer * tmp = theBufferList().getBuffer(included_file.absFilename());
 
-               if (tmp->params().textclass != m_buffer->params().textclass) {
+               if (tmp->params().getBaseClass() != masterBuffer->params().getBaseClass()) {
                        // FIXME UNICODE
                        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(m_buffer->params().getTextClass().name()));
+                                             from_utf8(masterBuffer->params().getTextClass().name()));
                        Alert::warning(_("Different textclasses"), text);
                        //return 0;
                }
 
-               tmp->markDepClean(m_buffer->temppath());
+               // 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.
+               vector<string> const masterModules = masterBuffer->params().getModules();
+               vector<string> const childModules = tmp->params().getModules();
+               vector<string>::const_iterator it = childModules.begin();
+               vector<string>::const_iterator end = childModules.end();
+               for (; it != end; ++it) {
+                       string const module = *it;
+                       vector<string>::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);
+                       }
+               }
+
+               tmp->markDepClean(masterBuffer->temppath());
 
-#ifdef WITH_WARNINGS
-#warning handle non existing files
-#warning Second argument is irrelevant!
+// 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)
-#endif
                // The included file might be written in a different encoding
                Encoding const * const oldEnc = runparams.encoding;
                runparams.encoding = &tmp->params().encoding();
                tmp->makeLaTeXFile(writefile,
-                                  onlyPath(masterFilename(buffer)),
+                                  masterFileName(buffer).onlyPath(),
                                   runparams, false);
                runparams.encoding = oldEnc;
        } else {
-               // 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.
+               // 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.
                unsigned long const checksum_in  = sum(included_file);
                unsigned long const checksum_out = sum(writefile);
 
                if (checksum_in != checksum_out) {
                        if (!copy(included_file, 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;
                        }
                }
@@ -523,12 +480,12 @@ int InsetInclude::latex(Buffer const & buffer, odocstream & os,
 
        string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
                        "latex" : "pdflatex";
-       if (isVerbatim(params_)) {
+       if (isVerbatim(params())) {
                incfile = latex_path(incfile);
                // FIXME UNICODE
-               os << '\\' << from_ascii(params_.getCmdName()) << '{'
+               os << '\\' << from_ascii(params().getCmdName()) << '{'
                   << from_utf8(incfile) << '}';
-       } else if (type(params_) == INPUT) {
+       } else if (type(params()) == INPUT) {
                runparams.exportdata->addExternalFile(tex_format, writefile,
                                                      exportfile);
 
@@ -536,22 +493,22 @@ int InsetInclude::latex(Buffer const & buffer, odocstream & os,
                if (!isLyXFilename(included_file.absFilename())) {
                        incfile = latex_path(incfile);
                        // FIXME UNICODE
-                       os << '\\' << from_ascii(params_.getCmdName())
+                       os << '\\' << from_ascii(params().getCmdName())
                           << '{' << from_utf8(incfile) << '}';
                } else {
                incfile = changeExtension(incfile, ".tex");
                incfile = latex_path(incfile);
                        // FIXME UNICODE
-                       os << '\\' << from_ascii(params_.getCmdName())
+                       os << '\\' << from_ascii(params().getCmdName())
                           << '{' << from_utf8(incfile) <<  '}';
                }
-       } else if (type(params_) == LISTINGS) {
-               os << '\\' << from_ascii(params_.getCmdName());
-               string opt = params_.getOptions();
+       } else if (type(params()) == 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.encodedString()) << "]";
+                       os << "[" << from_utf8(params.params()) << "]";
                os << '{'  << from_utf8(incfile) << '}';
        } else {
                runparams.exportdata->addExternalFile(tex_format, writefile,
@@ -562,7 +519,7 @@ int InsetInclude::latex(Buffer const & buffer, odocstream & os,
                incfile = changeExtension(incfile, string());
                incfile = latex_path(incfile);
                // FIXME UNICODE
-               os << '\\' << from_ascii(params_.getCmdName()) << '{'
+               os << '\\' << from_ascii(params().getCmdName()) << '{'
                   << from_utf8(incfile) << '}';
        }
 
@@ -571,13 +528,13 @@ int InsetInclude::latex(Buffer const & buffer, odocstream & os,
 
 
 int InsetInclude::plaintext(Buffer const & buffer, odocstream & os,
-                            OutputParams const &) const
+                           OutputParams const &) const
 {
-       if (isVerbatim(params_) || isListings(params_)) {
+       if (isVerbatim(params()) || isListings(params())) {
                os << '[' << getScreenLabel(buffer) << '\n';
                // FIXME: We don't know the encoding of the file
                docstring const str =
-                    from_utf8(getFileContents(includedFilename(buffer, params_)));
+                    from_utf8(includedFilename(buffer, params()).fileContents());
                os << str;
                os << "\n]";
                return PLAINTEXT_NEWLINE + 1; // one char on a separate line
@@ -590,24 +547,24 @@ int InsetInclude::plaintext(Buffer const & buffer, odocstream & os,
 
 
 int InsetInclude::docbook(Buffer const & buffer, odocstream & os,
-                          OutputParams const & runparams) const
+                         OutputParams const & runparams) const
 {
-       string incfile = to_utf8(params_["filename"]);
+       string incfile = to_utf8(params()["filename"]);
 
        // Do nothing if no file name has been specified
        if (incfile.empty())
                return 0;
 
-       string const included_file = includedFilename(buffer, params_).absFilename();
+       string const included_file = includedFilename(buffer, params()).absFilename();
 
        //Check we're not trying to include ourselves.
        //FIXME RECURSIVE INCLUDE
        //This isn't sufficient, as the inclusion could be downstream.
        //But it'll have to do for now.
-       if (buffer.fileName() == included_file) {
-               Alert::error(_("Recursive input"), 
-                              bformat(_("Attempted to include file %1$s in itself! "
-                              "Ignoring inclusion."), from_utf8(incfile)));
+       if (buffer.absFileName() == included_file) {
+               Alert::error(_("Recursive input"),
+                              bformat(_("Attempted to include file %1$s in itself! "
+                              "Ignoring inclusion."), from_utf8(incfile)));
                return 0;
        }
 
@@ -615,18 +572,18 @@ int InsetInclude::docbook(Buffer const & buffer, odocstream & os,
        string const exportfile = changeExtension(incfile, ".sgml");
        DocFileName writefile(changeExtension(included_file, ".sgml"));
 
-       if (loadIfNeeded(buffer, params_)) {
+       if (loadIfNeeded(buffer, params())) {
                Buffer * tmp = theBufferList().getBuffer(included_file);
 
                string const mangled = writefile.mangledFilename();
                writefile = makeAbsPath(mangled,
-                                       buffer.getMasterBuffer()->temppath());
+                                       buffer.masterBuffer()->temppath());
                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);
        }
@@ -636,12 +593,12 @@ int InsetInclude::docbook(Buffer const & buffer, odocstream & os,
        runparams.exportdata->addExternalFile("docbook-xml", writefile,
                                              exportfile);
 
-       if (isVerbatim(params_) || isListings(params_)) {
+       if (isVerbatim(params()) || isListings(params())) {
                os << "<inlinegraphic fileref=\""
                   << '&' << include_label << ';'
                   << "\" format=\"linespecific\">";
        } else
-                os << '&' << include_label << ';';
+               os << '&' << include_label << ';';
 
        return 0;
 }
@@ -649,35 +606,35 @@ 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();
 
-       string const included_file = includedFilename(buffer, params_).absFilename();
+       string const included_file = includedFilename(buffer, params()).absFilename();
 
        if (isLyXFilename(included_file))
                writefile = changeExtension(included_file, ".sgml");
        else
                writefile = included_file;
 
-       if (!features.runparams().nice && !isVerbatim(params_) && !isListings(params_)) {
+       if (!features.runparams().nice && !isVerbatim(params()) && !isListings(params())) {
                incfile = DocFileName(writefile).mangledFilename();
                writefile = makeAbsPath(incfile,
-                                       buffer.getMasterBuffer()->temppath()).absFilename();
+                                       buffer.masterBuffer()->temppath()).absFilename();
        }
 
        features.includeFile(include_label, writefile);
 
-       if (isVerbatim(params_))
+       if (isVerbatim(params()))
                features.require("verbatim");
-       else if (isListings(params_))
+       else if (isListings(params()))
                features.require("listings");
 
        // Here we must do the fun stuff...
        // Load the file in the include if it needs
        // to be loaded:
-       if (loadIfNeeded(buffer, params_)) {
+       if (loadIfNeeded(buffer, params())) {
                // a file got loaded
                Buffer * const tmp = theBufferList().getBuffer(included_file);
                // make sure the buffer isn't us
@@ -699,14 +656,14 @@ void InsetInclude::validate(LaTeXFeatures & features) const
 void InsetInclude::getLabelList(Buffer const & buffer,
                                std::vector<docstring> & list) const
 {
-       if (isListings(params_)) {
-               InsetListingsParams params(params_.getOptions());
-               string label = params.getParamValue("label");
+       if (isListings(params())) {
+               InsetListingsParams p(to_utf8(params()["lstparams"]));
+               string label = p.getParamValue("label");
                if (!label.empty())
                        list.push_back(from_utf8(label));
        }
-       else if (loadIfNeeded(buffer, params_)) {
-               string const included_file = includedFilename(buffer, params_).absFilename();
+       else if (loadIfNeeded(buffer, params())) {
+               string const included_file = includedFilename(buffer, params()).absFilename();
                Buffer * tmp = theBufferList().getBuffer(included_file);
                tmp->setParentName("");
                tmp->getLabelList(list);
@@ -716,13 +673,14 @@ void InsetInclude::getLabelList(Buffer const & buffer,
 
 
 void InsetInclude::fillWithBibKeys(Buffer const & buffer,
-               std::vector<std::pair<string, docstring> > & keys) const
+               BiblioInfo & keys, InsetIterator const & /*di*/) const
 {
-       if (loadIfNeeded(buffer, params_)) {
-               string const included_file = includedFilename(buffer, params_).absFilename();
+       if (loadIfNeeded(buffer, params())) {
+               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->fillWithBibKeys(keys);
+               keys.fillWithBibKeys(tmp);
                tmp->setParentName(parentFilename(buffer));
        }
 }
@@ -730,7 +688,7 @@ void InsetInclude::fillWithBibKeys(Buffer const & buffer,
 
 void InsetInclude::updateBibfilesCache(Buffer const & buffer)
 {
-       Buffer * const tmp = getChildBuffer(buffer, params_);
+       Buffer * const tmp = getChildBuffer(buffer, params());
        if (tmp) {
                tmp->setParentName("");
                tmp->updateBibfilesCache();
@@ -742,7 +700,7 @@ void InsetInclude::updateBibfilesCache(Buffer const & buffer)
 std::vector<FileName> const &
 InsetInclude::getBibfilesCache(Buffer const & buffer) const
 {
-       Buffer * const tmp = getChildBuffer(buffer, params_);
+       Buffer * const tmp = getChildBuffer(buffer, params());
        if (tmp) {
                tmp->setParentName("");
                std::vector<FileName> const & cache = tmp->getBibfilesCache();
@@ -754,14 +712,14 @@ InsetInclude::getBibfilesCache(Buffer const & buffer) const
 }
 
 
-bool InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
+void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
 {
-       BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
+       BOOST_ASSERT(mi.base.bv);
 
        bool use_preview = false;
        if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
                graphics::PreviewImage const * pimage =
-                       preview_->getPreviewImage(*mi.base.bv->buffer());
+                       preview_->getPreviewImage(mi.base.bv->buffer());
                use_preview = pimage && pimage->image();
        }
 
@@ -770,7 +728,7 @@ bool InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
        } else {
                if (!set_label_) {
                        set_label_ = true;
-                       button_.update(getScreenLabel(*mi.base.bv->buffer()),
+                       button_.update(getScreenLabel(mi.base.bv->buffer()),
                                       true);
                }
                button_.metrics(mi, dim);
@@ -778,23 +736,17 @@ bool InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
 
        Box b(0, dim.wid, -dim.asc, dim.des);
        button_.setBox(b);
-
-       bool const changed = dim_ != dim;
-       dim_ = dim;
-       return changed;
 }
 
 
 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
 {
-       setPosCache(pi, x, y);
-
-       BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
+       BOOST_ASSERT(pi.base.bv);
 
        bool use_preview = false;
        if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
                graphics::PreviewImage const * pimage =
-                       preview_->getPreviewImage(*pi.base.bv->buffer());
+                       preview_->getPreviewImage(pi.base.bv->buffer());
                use_preview = pimage && pimage->image();
        }
 
@@ -807,7 +759,7 @@ void InsetInclude::draw(PainterInfo & pi, int x, int y) const
 
 Inset::DisplayType InsetInclude::display() const
 {
-       return type(params_) == INPUT ? Inline : AlignCenter;
+       return type(params()) == INPUT ? Inline : AlignCenter;
 }
 
 
@@ -836,7 +788,7 @@ bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
        FileName const included_file = includedFilename(buffer, params);
 
        return type(params) == INPUT && params.preview() &&
-               isFileReadable(included_file);
+               included_file.isFileReadable();
 }
 
 
@@ -879,9 +831,23 @@ void InsetInclude::addPreview(graphics::PreviewLoader & ploader) const
 }
 
 
-void InsetInclude::addToToc(TocList & toclist, Buffer const & buffer) const
+void InsetInclude::addToToc(TocList & toclist, Buffer const & buffer,
+       ParConstIterator const & pit) const
 {
-       Buffer const * const childbuffer = getChildBuffer(buffer, params_);
+       if (isListings(params())) {
+               InsetListingsParams p(to_utf8(params()["lstparams"]));
+               string caption = p.getParamValue("caption");
+               if (caption.empty())
+                       return;
+               Toc & toc = toclist["listing"];
+               docstring const str = convert<docstring>(toc.size() + 1)
+                       + ". " +  from_utf8(caption);
+               // This inset does not have a valid ParConstIterator
+               // so it has to use the iterator of its parent paragraph
+               toc.push_back(TocItem(pit, 0, str));
+               return;
+       }
+       Buffer const * const childbuffer = getChildBuffer(buffer, params());
        if (!childbuffer)
                return;
 
@@ -894,83 +860,36 @@ void InsetInclude::addToToc(TocList & toclist, Buffer const & buffer) const
 }
 
 
-void InsetInclude::updateLabels(Buffer const & buffer) const
-{
-       Buffer const * const childbuffer = getChildBuffer(buffer, params_);
-       if (!childbuffer)
-               return;
-
-       lyx::updateLabels(*childbuffer, true);
-}
-
-
-void InsetInclude::updateCounter(Counters & counters)
-{
-       if (!isListings(params_))
-               return;
-
-       InsetListingsParams const par = params_.getOptions();
-       if (par.getParamValue("caption").empty())
-               counter_ = 0;
-       else {
-               counters.step(from_ascii("listing"));
-               counter_ = counters.value(from_ascii("listing"));
+void InsetInclude::updateLabels(Buffer const & buffer, ParIterator const &)
+{
+       Buffer const * const childbuffer = getChildBuffer(buffer, params());
+       if (childbuffer)
+               lyx::updateLabels(*childbuffer, true);
+       else if (isListings(params())) {
+               InsetListingsParams const par(to_utf8(params()["lstparams"]));
+               if (par.getParamValue("caption").empty())
+                       listings_label_.clear();
+               else {
+                       Counters & counters = buffer.params().getTextClass().counters();
+                       docstring const cnt = from_ascii("listing");
+                       if (counters.hasCounter(cnt)) {
+                               counters.step(cnt);
+                               listings_label_ = buffer.B_("Program Listing ")
+                                       + convert<docstring>(counters.value(cnt));
+                       } else
+                               listings_label_ = buffer.B_("Program Listing");
+               }
        }
 }
 
 
-string const InsetIncludeMailer::name_("include");
-
-InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset)
-       : inset_(inset)
-{}
-
-
-string const InsetIncludeMailer::inset2string(Buffer const &) const
-{
-       return params2string(inset_.params());
-}
-
-
-void InsetIncludeMailer::string2params(string const & in,
-                                      InsetCommandParams & params)
-{
-       params.clear();
-       if (in.empty())
-               return;
-
-       istringstream data(in);
-       Lexer lex(0,0);
-       lex.setStream(data);
-
-       string name;
-       lex >> name;
-       if (!lex || name != name_)
-               return print_mailer_error("InsetIncludeMailer", in, 1, name_);
-
-       // This is part of the inset proper that is usually swallowed
-       // by Text::readInset
-       string id;
-       lex >> id;
-       if (!lex || id != "Include")
-               return print_mailer_error("InsetIncludeMailer", in, 2, "Include");
-
-       InsetInclude inset(params);
-       inset.read(lex);
-       params = inset.params();
-}
-
-
-string const
-InsetIncludeMailer::params2string(InsetCommandParams const & params)
+void InsetInclude::registerEmbeddedFiles(Buffer const & buffer,
+       EmbeddedFiles & files) const
 {
-       InsetInclude inset(params);
-       ostringstream data;
-       data << name_ << ' ';
-       inset.write(data);
-       data << "\\end_inset\n";
-       return data.str();
+       // include and input are temprarily not considered.
+       if (isVerbatim(params()) || isListings(params()))
+               files.registerFile(includedFilename(buffer, params()).absFilename(),
+                       false, this);
 }
 
-
 } // namespace lyx