]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetInclude.cpp
Fix text frame drawing.
[lyx.git] / src / insets / InsetInclude.cpp
index df6043fee71ffc4b70b19ae5645e9bcef2a13900..82a48be4f9b6987e170e9d2499f77eb2f3bef733 100644 (file)
@@ -52,6 +52,9 @@
 
 
 namespace lyx {
+  
+// Implementation is in LyX.cpp
+extern void dispatch(FuncRequest const & action);
 
 using support::addName;
 using support::absolutePath;
@@ -65,6 +68,7 @@ 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;
@@ -77,7 +81,6 @@ using support::sum;
 
 using std::endl;
 using std::string;
-using std::auto_ptr;
 using std::istringstream;
 using std::ostream;
 using std::ostringstream;
@@ -107,7 +110,7 @@ bool isListings(InsetCommandParams const & params)
 InsetInclude::InsetInclude(InsetCommandParams const & p)
        : params_(p), include_label(uniqueID()),
          preview_(new RenderMonitoredPreview(this)),
-         set_label_(false), counter_(0)
+         set_label_(false)
 {
        preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
 }
@@ -118,7 +121,7 @@ InsetInclude::InsetInclude(InsetInclude const & other)
          params_(other.params_),
          include_label(other.include_label),
          preview_(new RenderMonitoredPreview(this)),
-         set_label_(false), counter_(0)
+         set_label_(false)
 {
        preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
 }
@@ -144,7 +147,7 @@ void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
                                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);
@@ -161,7 +164,7 @@ void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
                break;
 
        case LFUN_MOUSE_RELEASE:
-               if (!cur.selection()) 
+               if (!cur.selection())
                        InsetIncludeMailer(*this).showDialog(&cur.bv());
                break;
 
@@ -230,6 +233,13 @@ bool isVerbatim(InsetCommandParams const & params)
 }
 
 
+bool isInputOrInclude(InsetCommandParams const & params)
+{
+       Types const t = type(params);
+       return (t == INPUT) || (t == INCLUDE);
+}
+
+
 string const masterFilename(Buffer const & buffer)
 {
        return buffer.getMasterBuffer()->fileName();
@@ -268,9 +278,9 @@ void InsetInclude::set(InsetCommandParams const & p, Buffer const & buffer)
 }
 
 
-auto_ptr<Inset> InsetInclude::doClone() const
+Inset * InsetInclude::clone() const
 {
-       return auto_ptr<Inset>(new InsetInclude(*this));
+       return new InsetInclude(*this);
 }
 
 
@@ -314,7 +324,7 @@ void InsetInclude::read(Lexer & lex)
        }
        if (token != "\\end_inset") {
                lex.printError("Missing \\end_inset at this point. "
-                              "Read: `$$Token'");
+                              "Read: `$$Token'");
        }
 }
 
@@ -325,23 +335,19 @@ docstring const InsetInclude::getScreenLabel(Buffer const & buf) const
 
        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");
-                       break;
+                       temp = listings_label_;
                }
        }
 
@@ -369,44 +375,49 @@ 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.fileName();
+       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))
-                       return false;
+                       return 0;
+
+               child = theBufferList().newBuffer(included_file.absFilename());
+               if (!loadLyXFile(child, included_file)) {
+                       //close the buffer we just opened
+                       theBufferList().close(child, false);
+                       return 0;
+               }
        }
-       if (buf)
-               buf->setParentName(parentFilename(buffer));
-       return buf != 0;
+       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"]));
 
@@ -415,15 +426,17 @@ int InsetInclude::latex(Buffer const & buffer, odocstream & os,
                return 0;
 
        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 (!isListings(params_) && buffer.fileName() == included_file.toFilesystemEncoding()) {
-               Alert::error(_("Recursive input"), 
-                              bformat(_("Attempted to include file %1$s in itself! "
-                              "Ignoring inclusion."), from_utf8(incfile)));
+       if (isInputOrInclude(params_) &&
+               buffer.fileName() == included_file.absFilename())
+       {
+               Alert::error(_("Recursive input"),
+                              bformat(_("Attempted to include file %1$s in itself! "
+                              "Ignoring inclusion."), from_utf8(incfile)));
                return 0;
        }
 
@@ -434,28 +447,41 @@ int InsetInclude::latex(Buffer const & buffer, odocstream & os,
        if (!absolutePath(incfile)) {
                // FIXME UNICODE
                incfile = to_utf8(makeRelPath(from_utf8(included_file.absFilename()),
-                                             from_utf8(m_buffer->filePath())));
+                                             from_utf8(m_buffer->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")).mangledFilename();
+       string const mangled =
+               DocFileName(changeExtension(included_file.absFilename(),".tex")).
+                       mangledFilename();
        FileName const writefile(makeAbsPath(mangled, m_buffer->temppath()));
 
        if (!runparams.nice)
                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));
+       }
        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
-               ;
-       else if (loadIfNeeded(buffer, params_)) {
+       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_))
+                       return false;
+
                Buffer * tmp = theBufferList().getBuffer(included_file.absFilename());
 
-               if (tmp->params().textclass != m_buffer->params().textclass) {
+               if (tmp->params().getBaseClass() != m_buffer->params().getBaseClass()) {
                        // FIXME UNICODE
                        docstring text = bformat(_("Included file `%1$s'\n"
                                                "has textclass `%2$s'\n"
@@ -466,16 +492,34 @@ int InsetInclude::latex(Buffer const & buffer, odocstream & os,
                        Alert::warning(_("Different textclasses"), text);
                        //return 0;
                }
+               
+               // 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 = m_buffer->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."),
+                                      makeDisplayPath(included_file.absFilename()), from_utf8(module));
+                               Alert::warning(_("Module not found"), text);
+                       }
+               }
 
                tmp->markDepClean(m_buffer->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();
@@ -484,9 +528,10 @@ int InsetInclude::latex(Buffer const & buffer, odocstream & os,
                                   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);
 
@@ -533,7 +578,7 @@ int InsetInclude::latex(Buffer const & buffer, odocstream & os,
                // 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,
@@ -553,7 +598,7 @@ 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_)) {
                os << '[' << getScreenLabel(buffer) << '\n';
@@ -572,7 +617,7 @@ 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"]);
 
@@ -587,9 +632,9 @@ int InsetInclude::docbook(Buffer const & buffer, odocstream & os,
        //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)));
+               Alert::error(_("Recursive input"),
+                              bformat(_("Attempted to include file %1$s in itself! "
+                              "Ignoring inclusion."), from_utf8(incfile)));
                return 0;
        }
 
@@ -623,7 +668,7 @@ int InsetInclude::docbook(Buffer const & buffer, odocstream & os,
                   << '&' << include_label << ';'
                   << "\" format=\"linespecific\">";
        } else
-                os << '&' << include_label << ';';
+               os << '&' << include_label << ';';
 
        return 0;
 }
@@ -698,13 +743,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();
                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));
        }
 }
@@ -738,12 +784,12 @@ InsetInclude::getBibfilesCache(Buffer const & buffer) const
 
 bool 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();
        }
 
@@ -752,7 +798,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);
@@ -771,12 +817,12 @@ 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();
        }
 
@@ -861,8 +907,21 @@ 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
 {
+       if (isListings(params_)) {
+               InsetListingsParams params(params_.getOptions());
+               string caption = params.getParamValue("caption");
+               if (!caption.empty()) {
+                       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;
@@ -876,28 +935,36 @@ void InsetInclude::addToToc(TocList & toclist, Buffer const & buffer) const
 }
 
 
-void InsetInclude::updateLabels(Buffer const & buffer) const
+void InsetInclude::updateLabels(Buffer const & buffer, 
+                               ParIterator const &)
 {
        Buffer const * const childbuffer = getChildBuffer(buffer, params_);
-       if (!childbuffer)
-               return;
-
-       lyx::updateLabels(*childbuffer, true);
+       if (childbuffer)
+               lyx::updateLabels(*childbuffer, true);
+       else if (isListings(params_)) {
+               InsetListingsParams const par = params_.getOptions();
+               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");
+               }
+       }
 }
 
 
-void InsetInclude::updateCounter(Counters & counters)
+void InsetInclude::registerEmbeddedFiles(Buffer const & buffer,
+       EmbeddedFiles & files, ParConstIterator const & pit) const
 {
-       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"));
-       }
+       // include and input are temprarily not considered.
+       if (isVerbatim(params_) || isListings(params_))
+               files.registerFile(includedFilename(buffer, params_).absFilename(),
+                       EmbeddedFile::AUTO, pit);
 }