]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetInclude.cpp
Restore XHTML output for InsetListings.
[lyx.git] / src / insets / InsetInclude.cpp
index de084f6568d83a2b7ee007dad6fd855e50cdb682..021dd4c7303f93652fb0483b2a8db4dfd89b9852 100644 (file)
 #include "FuncStatus.h"
 #include "LaTeXFeatures.h"
 #include "LayoutFile.h"
+#include "LayoutModuleList.h"
 #include "LyX.h"
 #include "LyXFunc.h"
 #include "LyXRC.h"
 #include "Lexer.h"
 #include "MetricsInfo.h"
+#include "output_xhtml.h"
 #include "OutputParams.h"
 #include "TextClass.h"
 #include "TocBackend.h"
@@ -146,34 +148,36 @@ FileName const includedFilename(Buffer const & buffer,
 }
 
 
-InsetLabel * createLabel(docstring const & label_str)
+InsetLabel * createLabel(Buffer * buf, docstring const & label_str)
 {
        if (label_str.empty())
                return 0;
        InsetCommandParams icp(LABEL_CODE);
        icp["name"] = label_str;
-       return new InsetLabel(icp);
+       return new InsetLabel(buf, icp);
 }
 
 } // namespace anon
 
 
-InsetInclude::InsetInclude(InsetCommandParams const & p)
-       : InsetCommand(p, "include"), include_label(uniqueID()),
-         preview_(new RenderMonitoredPreview(this)), set_label_(false), label_(0)
+InsetInclude::InsetInclude(Buffer * buf, InsetCommandParams const & p)
+       : InsetCommand(buf, p, "include"), include_label(uniqueID()),
+         preview_(new RenderMonitoredPreview(this)), failedtoload_(false),
+         set_label_(false), label_(0), child_buffer_(0)
 {
        preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
 
        if (isListings(params())) {
                InsetListingsParams listing_params(to_utf8(p["lstparams"]));
-               label_ = createLabel(from_utf8(listing_params.getParamValue("label")));
+               label_ = createLabel(buffer_, from_utf8(listing_params.getParamValue("label")));
        }
 }
 
 
 InsetInclude::InsetInclude(InsetInclude const & other)
        : InsetCommand(other), include_label(other.include_label),
-         preview_(new RenderMonitoredPreview(this)), set_label_(false), label_(0)
+         preview_(new RenderMonitoredPreview(this)), failedtoload_(false),
+         set_label_(false), label_(0), child_buffer_(0)
 {
        preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
 
@@ -218,7 +222,6 @@ bool InsetInclude::isCompatibleCommand(string const & s)
 
 void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
-       LASSERT(cur.buffer() == &buffer(), return);
        switch (cmd.action) {
 
        case LFUN_INSET_EDIT: {
@@ -227,6 +230,9 @@ void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
        }
 
        case LFUN_INSET_MODIFY: {
+               // It should be OK just to invalidate the cache is setParams()
+               // If not....
+               // child_buffer_ = 0;
                InsetCommandParams p(INCLUDE_CODE);
                if (cmd.getArg(0) == "changetype") {
                        InsetCommand::doDispatch(cur, cmd);
@@ -238,23 +244,28 @@ void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
                                InsetListingsParams new_params(to_utf8(p["lstparams"]));
                                docstring const new_label =
                                        from_utf8(new_params.getParamValue("label"));
-                               docstring old_label;
-                               if (label_)
-                                       old_label = label_->getParam("name");
-                               if (new_label.empty())
+                               
+                               if (new_label.empty()) {
                                        delete label_;
-                               else if (label_ && old_label != new_label) {
-                                       label_->updateCommand(new_label);
-                                       // the label might have been adapted (duplicate)
-                                       if (new_label != label_->getParam("name")) {
-                                               new_params.addParam("label",
-                                                       "{" + to_utf8(label_->getParam("name")) + "}");
-                                               p["lstparams"] = from_utf8(new_params.params());
+                                       label_ = 0;
+                               } else {
+                                       docstring old_label;
+                                       if (label_) 
+                                               old_label = label_->getParam("name");
+                                       else {
+                                               label_ = createLabel(buffer_, new_label);
+                                               label_->setBuffer(buffer());
+                                       }                                       
+
+                                       if (new_label != old_label) {
+                                               label_->updateCommand(new_label);
+                                               // the label might have been adapted (duplicate)
+                                               if (new_label != label_->getParam("name")) {
+                                                       new_params.addParam("label", "{" + 
+                                                               to_utf8(label_->getParam("name")) + "}", true);
+                                                       p["lstparams"] = from_utf8(new_params.params());
+                                               }
                                        }
-                               } else if (old_label != new_label) {
-                                       label_ = createLabel(new_label);
-                                       label_->setBuffer(buffer());
-                                       label_->initView();
                                }
                        }
                        setParams(p);
@@ -291,10 +302,16 @@ bool InsetInclude::getStatus(Cursor & cur, FuncRequest const & cmd,
        switch (cmd.action) {
 
        case LFUN_INSET_EDIT:
-       case LFUN_INSET_MODIFY:
                flag.setEnabled(true);
                return true;
 
+       case LFUN_INSET_MODIFY:
+               if (cmd.getArg(0) == "changetype")
+                       return InsetCommand::getStatus(cur, cmd, flag);
+               else
+                       flag.setEnabled(true);
+               return true;
+
        default:
                return InsetCommand::getStatus(cur, cmd, flag);
        }
@@ -303,6 +320,9 @@ bool InsetInclude::getStatus(Cursor & cur, FuncRequest const & cmd,
 
 void InsetInclude::setParams(InsetCommandParams const & p)
 {
+       // invalidate the cache
+       child_buffer_ = 0;
+
        InsetCommand::setParams(p);
        set_label_ = false;
 
@@ -351,32 +371,32 @@ docstring InsetInclude::screenLabel() const
 }
 
 
-Buffer * InsetInclude::getChildBuffer(Buffer const & buffer) const
+Buffer * InsetInclude::getChildBuffer() const
 {
-       InsetCommandParams const & p = params();
-       if (isVerbatim(p) || isListings(p))
-               return 0;
-
-       string const included_file = includedFilename(buffer, p).absFilename();
-       if (!isLyXFilename(included_file))
-               return 0;
-
-       Buffer * childBuffer = loadIfNeeded(buffer); 
+       Buffer * childBuffer = loadIfNeeded(); 
 
        // FIXME: recursive includes
-       return (childBuffer == &buffer) ? 0 : childBuffer;
+       return (childBuffer == &buffer()) ? 0 : childBuffer;
 }
 
 
-Buffer * InsetInclude::loadIfNeeded(Buffer const & parent) const
+Buffer * InsetInclude::loadIfNeeded() const
 {
-       InsetCommandParams const & p = params();
-       if (isVerbatim(p) || isListings(p))
+       // Don't try to load it again if we failed before.
+       if (failedtoload_ || isVerbatim(params()) || isListings(params()))
                return 0;
 
-       string const parent_filename = parent.absFileName();
-       FileName const included_file = makeAbsPath(to_utf8(p["filename"]),
-                          onlyPath(parent_filename));
+       // Use cached Buffer if possible.
+       if (child_buffer_ != 0) {
+               if (theBufferList().isLoaded(child_buffer_))
+                       return child_buffer_;
+               // Buffer vanished, so invalidate cache and try to reload.
+               child_buffer_ = 0;
+       }
+
+       string const parent_filename = buffer().absFileName();
+       FileName const included_file = 
+               makeAbsPath(to_utf8(params()["filename"]), onlyPath(parent_filename));
 
        if (!isLyXFilename(included_file.absFilename()))
                return 0;
@@ -393,6 +413,7 @@ Buffer * InsetInclude::loadIfNeeded(Buffer const & parent) const
                        return 0;
 
                if (!child->loadLyXFile(included_file)) {
+                       failedtoload_ = true;
                        //close the buffer we just opened
                        theBufferList().release(child);
                        return 0;
@@ -402,7 +423,9 @@ Buffer * InsetInclude::loadIfNeeded(Buffer const & parent) const
                        // FIXME: Do something.
                }
        }
-       child->setParent(&parent);
+       child->setParent(&buffer());
+       // Cache the child buffer.
+       child_buffer_ = child;
        return child;
 }
 
@@ -434,17 +457,25 @@ int InsetInclude::latex(odocstream & os, OutputParams const & runparams) const
 
        // if incfile is relative, make it relative to the master
        // buffer directory.
-       if (!FileName(incfile).isAbsolute()) {
+       if (!FileName::isAbsolute(incfile)) {
                // FIXME UNICODE
                incfile = to_utf8(makeRelPath(from_utf8(included_file.absFilename()),
                                              from_utf8(masterBuffer->filePath())));
        }
 
        // write it to a file (so far the complete file)
-       string const exportfile = changeExtension(incfile, ".tex");
-       string const mangled =
-               DocFileName(changeExtension(included_file.absFilename(),".tex")).
+       string exportfile;
+       string mangled;
+       // bug 5681
+       if (type(params()) == LISTINGS) {
+               exportfile = incfile;
+               mangled = DocFileName(included_file).mangledFilename();
+       } else {
+               exportfile = changeExtension(incfile, ".tex");
+               mangled = DocFileName(changeExtension(included_file.absFilename(), ".tex")).
                        mangledFilename();
+       }
+
        FileName const writefile(makeAbsPath(mangled, masterBuffer->temppath()));
 
        if (!runparams.nice)
@@ -466,7 +497,7 @@ 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
-               if (!loadIfNeeded(buffer()))
+               if (!loadIfNeeded())
                        return false;
 
                Buffer * tmp = theBufferList().getBuffer(included_file);
@@ -479,19 +510,19 @@ int InsetInclude::latex(odocstream & os, OutputParams const & runparams) const
                                included_file.displayName(),
                                from_utf8(tmp->params().documentClass().name()),
                                from_utf8(masterBuffer->params().documentClass().name()));
-                       Alert::warning(_("Different textclasses"), text);
+                       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.
-               list<string> const masterModules = masterBuffer->params().getModules();
-               list<string> const childModules = tmp->params().getModules();
-               list<string>::const_iterator it = childModules.begin();
-               list<string>::const_iterator end = childModules.end();
+               // 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;
-                       list<string>::const_iterator found =
+                       LayoutModuleList::const_iterator found =
                                find(masterModules.begin(), masterModules.end(), module);
                        if (found == masterModules.end()) {
                                docstring text = bformat(_("Included file `%1$s'\n"
@@ -504,18 +535,22 @@ int InsetInclude::latex(odocstream & os, OutputParams const & runparams) const
 
                tmp->markDepClean(masterBuffer->temppath());
 
-// 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)
+               // 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();
+               runparams.master_language = buffer().params().language;
                tmp->makeLaTeXFile(writefile,
                                   masterFileName(buffer()).onlyPath().absFilename(),
                                   runparams, false);
                runparams.encoding = oldEnc;
+               runparams.master_language = oldLang;
        } 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
@@ -538,12 +573,16 @@ int InsetInclude::latex(odocstream & os, OutputParams const & runparams) const
 
        string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
                        "latex" : "pdflatex";
-       if (isVerbatim(params())) {
+       switch (type(params())) {
+       case VERB:
+       case VERBAST: {
                incfile = latex_path(incfile);
                // FIXME UNICODE
                os << '\\' << from_ascii(params().getCmdName()) << '{'
                   << from_utf8(incfile) << '}';
-       } else if (type(params()) == INPUT) {
+               break;
+       } 
+       case INPUT: {
                runparams.exportdata->addExternalFile(tex_format, writefile,
                                                      exportfile);
 
@@ -560,7 +599,9 @@ int InsetInclude::latex(odocstream & os, OutputParams const & runparams) const
                        os << '\\' << from_ascii(params().getCmdName())
                           << '{' << from_utf8(incfile) <<  '}';
                }
-       } else if (type(params()) == LISTINGS) {
+               break;
+       } 
+       case LISTINGS: {
                os << '\\' << from_ascii(params().getCmdName());
                string const opt = to_utf8(params()["lstparams"]);
                // opt is set in QInclude dialog and should have passed validation.
@@ -568,7 +609,9 @@ int InsetInclude::latex(odocstream & os, OutputParams const & runparams) const
                if (!params.params().empty())
                        os << "[" << from_utf8(params.params()) << "]";
                os << '{'  << from_utf8(incfile) << '}';
-       } else {
+               break;
+       } 
+       case INCLUDE: {
                runparams.exportdata->addExternalFile(tex_format, writefile,
                                                      exportfile);
 
@@ -579,12 +622,67 @@ int InsetInclude::latex(odocstream & os, OutputParams const & runparams) const
                // FIXME UNICODE
                os << '\\' << from_ascii(params().getCmdName()) << '{'
                   << from_utf8(incfile) << '}';
+               break;
+       }
+       case NONE:
+               break;
        }
 
        return 0;
 }
 
 
+docstring InsetInclude::xhtml(XHTMLStream & xs, OutputParams const &rp) const
+{
+       if (rp.inComment)
+                return docstring();
+
+       // For verbatim and listings, we just include the contents of the file as-is.
+       // In the case of listings, we wrap it in <pre>.
+       bool const listing = isListings(params());
+       if (listing || isVerbatim(params())) {
+               if (listing)
+                       xs << StartTag("pre");
+               // FIXME: We don't know the encoding of the file, default to UTF-8.
+               xs << includedFilename(buffer(), params()).fileContents("UTF-8");
+               if (listing)
+                       xs << EndTag("pre");
+               return docstring();
+       }
+
+       // We don't (yet) know how to Input or Include non-LyX files.
+       // (If we wanted to get really arcane, we could run some tex2html
+       // converter on the included file. But that's just masochistic.)
+       string const parent_filename = buffer().absFileName();
+       FileName const included_file = 
+               makeAbsPath(to_utf8(params()["filename"]), onlyPath(parent_filename));
+       if (!isLyXFilename(included_file.absFilename())) {
+               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"]));
+               return docstring();
+       }
+
+       // In the other cases, we will generate the HTML and include it.
+
+       // Check we're not trying to include ourselves.
+       // FIXME RECURSIVE INCLUDE
+       if (buffer().absFileName() == included_file.absFilename()) {
+               Alert::error(_("Recursive input"),
+                              bformat(_("Attempted to include file %1$s in itself! "
+                              "Ignoring inclusion."), params()["filename"]));
+               return docstring();
+       }
+
+       Buffer const * const ibuf = loadIfNeeded();
+       if (!ibuf)
+               return docstring();
+       ibuf->writeLyXHTMLSource(xs.os(), rp, true);
+       return docstring();
+}
+
+
 int InsetInclude::plaintext(odocstream & os, OutputParams const &) const
 {
        if (isVerbatim(params()) || isListings(params())) {
@@ -626,7 +724,7 @@ int InsetInclude::docbook(odocstream & os, OutputParams const & runparams) const
        string const exportfile = changeExtension(incfile, ".sgml");
        DocFileName writefile(changeExtension(included_file, ".sgml"));
 
-       if (loadIfNeeded(buffer())) {
+       if (loadIfNeeded()) {
                Buffer * tmp = theBufferList().getBuffer(FileName(included_file));
 
                string const mangled = writefile.mangledFilename();
@@ -689,7 +787,7 @@ void InsetInclude::validate(LaTeXFeatures & features) const
        // Here we must do the fun stuff...
        // Load the file in the include if it needs
        // to be loaded:
-       if (loadIfNeeded(buffer())) {
+       if (loadIfNeeded()) {
                // a file got loaded
                Buffer * const tmp = theBufferList().getBuffer(FileName(included_file));
                // make sure the buffer isn't us
@@ -711,7 +809,7 @@ void InsetInclude::validate(LaTeXFeatures & features) const
 void InsetInclude::fillWithBibKeys(BiblioInfo & keys,
        InsetIterator const & /*di*/) const
 {
-       if (loadIfNeeded(buffer())) {
+       if (loadIfNeeded()) {
                string const included_file = includedFilename(buffer(), params()).absFilename();
                Buffer * tmp = theBufferList().getBuffer(FileName(included_file));
                BiblioInfo const & newkeys = tmp->localBibInfo();
@@ -722,25 +820,19 @@ void InsetInclude::fillWithBibKeys(BiblioInfo & keys,
 
 void InsetInclude::updateBibfilesCache()
 {
-       Buffer * const tmp = getChildBuffer(buffer());
-       if (tmp) {
-               tmp->setParent(0);
-               tmp->updateBibfilesCache();
-               tmp->setParent(&buffer());
-       }
+       Buffer const * const child = getChildBuffer();
+       if (child)
+               child->updateBibfilesCache(Buffer::UpdateChildOnly);
 }
 
 
 support::FileNameList const &
-       InsetInclude::getBibfilesCache(Buffer const & buffer) const
+       InsetInclude::getBibfilesCache() const
 {
-       Buffer * const tmp = getChildBuffer(buffer);
-       if (tmp) {
-               tmp->setParent(0);
-               support::FileNameList const & cache = tmp->getBibfilesCache();
-               tmp->setParent(&buffer);
-               return cache;
-       }
+       Buffer const * const child = getChildBuffer();
+       if (child)
+               return child->getBibfilesCache(Buffer::UpdateChildOnly);
+
        static support::FileNameList const empty;
        return empty;
 }
@@ -858,7 +950,8 @@ void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
 } // namespace anon
 
 
-void InsetInclude::addPreview(graphics::PreviewLoader & ploader) const
+void InsetInclude::addPreview(DocIterator const & /*inset_pos*/,
+       graphics::PreviewLoader & ploader) const
 {
        Buffer const & buffer = ploader.buffer();
        if (!preview_wanted(params(), buffer))
@@ -888,7 +981,7 @@ void InsetInclude::addToToc(DocIterator const & cpit)
                toc.push_back(TocItem(pit, 0, str));
                return;
        }
-       Buffer const * const childbuffer = getChildBuffer(buffer());
+       Buffer const * const childbuffer = getChildBuffer();
        if (!childbuffer)
                return;
 
@@ -907,18 +1000,39 @@ void InsetInclude::addToToc(DocIterator const & cpit)
 }
 
 
-void InsetInclude::updateLabels(ParIterator const & it)
+void InsetInclude::updateCommand()
+{
+       if (!label_)
+               return;
+
+       docstring old_label = label_->getParam("name");
+       label_->updateCommand(old_label, false);
+       // the label might have been adapted (duplicate)
+       docstring new_label = label_->getParam("name");
+       if (old_label == new_label)
+               return;
+
+       // update listings parameters...
+       InsetCommandParams p(INCLUDE_CODE);
+       p = params();
+       InsetListingsParams par(to_utf8(params()["lstparams"]));
+       par.addParam("label", "{" + to_utf8(new_label) + "}", true);
+       p["lstparams"] = from_utf8(par.params());
+       setParams(p);   
+}
+
+void InsetInclude::updateLabels(ParIterator const & it, bool out)
 {
-       Buffer const * const childbuffer = getChildBuffer(buffer());
+       Buffer const * const childbuffer = getChildBuffer();
        if (childbuffer) {
-               childbuffer->updateLabels(true);
+               childbuffer->updateLabels(Buffer::UpdateChildOnly, out);
                return;
        }
        if (!isListings(params()))
                return;
 
        if (label_)
-               label_->updateLabels(it);
+               label_->updateLabels(it, out);
 
        InsetListingsParams const par(to_utf8(params()["lstparams"]));
        if (par.getParamValue("caption").empty()) {