]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetInclude.cpp
Internal buffers are valid
[lyx.git] / src / insets / InsetInclude.cpp
index 3fc35fe308a295e2c2eea6a38cbe8450a69880e2..7bf23298148589ad97f8758e4ab04e63bf208b8b 100644 (file)
@@ -99,7 +99,7 @@ Types type(string const & s)
                return VERB;
        if (s == "verbatiminput*")
                return VERBAST;
-       if (s == "lstinputlisting")
+       if (s == "lstinputlisting" || s == "inputminted")
                return LISTINGS;
        if (s == "include")
                return INCLUDE;
@@ -165,7 +165,24 @@ InsetLabel * createLabel(Buffer * buf, docstring const & label_str)
        return new InsetLabel(buf, icp);
 }
 
-} // namespace anon
+
+char_type replaceCommaInBraces(docstring & params)
+{
+       // Code point from private use area
+       char_type private_char = 0xE000;
+       int count = 0;
+       for (char_type & c : params) {
+               if (c == '{')
+                       ++count;
+               else if (c == '}')
+                       --count;
+               else if (c == ',' && count)
+                       c = private_char;
+       }
+       return private_char;
+}
+
+} // namespace
 
 
 InsetInclude::InsetInclude(Buffer * buf, InsetCommandParams const & p)
@@ -197,11 +214,6 @@ InsetInclude::InsetInclude(InsetInclude const & other)
 
 InsetInclude::~InsetInclude()
 {
-       if (isBufferLoaded())
-               /* We do not use buffer() because Coverity believes that this
-                * may throw an exception. Actually this code path is not
-                * taken when buffer_ == 0 */
-               buffer_->invalidateBibfileCache();
        delete label_;
 }
 
@@ -265,24 +277,24 @@ void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
                                InsetListingsParams new_params(to_utf8(p["lstparams"]));
                                docstring const new_label =
                                        from_utf8(new_params.getParamValue("label"));
-                               
+
                                if (new_label.empty()) {
                                        delete label_;
                                        label_ = 0;
                                } else {
                                        docstring old_label;
-                                       if (label_) 
+                                       if (label_)
                                                old_label = label_->getParam("name");
                                        else {
                                                label_ = createLabel(buffer_, new_label);
                                                label_->setBuffer(buffer());
-                                       }                                       
+                                       }
 
                                        if (new_label != old_label) {
                                                label_->updateLabelAndRefs(new_label, &cur);
                                                // the label might have been adapted (duplicate)
                                                if (new_label != label_->getParam("name")) {
-                                                       new_params.addParam("label", "{" + 
+                                                       new_params.addParam("label", "{" +
                                                                to_utf8(label_->getParam("name")) + "}", true);
                                                        p["lstparams"] = from_utf8(new_params.params());
                                                }
@@ -346,6 +358,9 @@ void InsetInclude::setParams(InsetCommandParams const & p)
        // invalidate the cache
        child_buffer_ = 0;
 
+       // reset in order to allow loading new file
+       failedtoload_ = false;
+
        InsetCommand::setParams(p);
        set_label_ = false;
 
@@ -354,8 +369,6 @@ void InsetInclude::setParams(InsetCommandParams const & p)
 
        if (type(params()) == INPUT)
                add_preview(*preview_, *this, buffer());
-
-       buffer().invalidateBibfileCache();
 }
 
 
@@ -412,7 +425,7 @@ docstring InsetInclude::screenLabel() const
 
 Buffer * InsetInclude::getChildBuffer() const
 {
-       Buffer * childBuffer = loadIfNeeded(); 
+       Buffer * childBuffer = loadIfNeeded();
 
        // FIXME RECURSIVE INCLUDE
        // This isn't sufficient, as the inclusion could be downstream.
@@ -427,7 +440,7 @@ Buffer * InsetInclude::loadIfNeeded() const
        // try to load the cloned child document again.
        if (buffer().isClone())
                return child_buffer_;
-       
+
        // Don't try to load it again if we failed before.
        if (failedtoload_ || isVerbatim(params()) || isListings(params()))
                return 0;
@@ -436,7 +449,7 @@ Buffer * InsetInclude::loadIfNeeded() const
        // Use cached Buffer if possible.
        if (child_buffer_ != 0) {
                if (theBufferList().isLoaded(child_buffer_)
-               // additional sanity check: make sure the Buffer really is
+                   // additional sanity check: make sure the Buffer really is
                    // associated with the file we want.
                    && child_buffer_ == theBufferList().getBuffer(included_file))
                        return child_buffer_;
@@ -450,8 +463,10 @@ Buffer * InsetInclude::loadIfNeeded() const
        Buffer * child = theBufferList().getBuffer(included_file);
        if (!child) {
                // the readonly flag can/will be wrong, not anymore I think.
-               if (!included_file.exists())
+               if (!included_file.exists()) {
+                       failedtoload_ = true;
                        return 0;
+               }
 
                child = theBufferList().newBuffer(included_file.absFileName());
                if (!child)
@@ -527,7 +542,6 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
        string exppath = incfile;
        if (!runparams.export_folder.empty()) {
                exppath = makeAbsPath(exppath, runparams.export_folder).realPath();
-               FileName(exppath).onlyPath().createPath();
        }
 
        // write it to a file (so far the complete file)
@@ -598,15 +612,101 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                break;
        }
        case LISTINGS: {
+               // Here, listings and minted have sligthly different behaviors.
+               // Using listings, it is always possible to have a caption,
+               // even for non-floats. Using minted, only floats can have a
+               // caption. So, with minted we use the following strategy.
+               // If a caption was specified but the float parameter was not,
+               // we ourselves add a caption above the listing (because the
+               // listing comes from a file and might span several pages).
+               // Otherwise, if float was specified, the floating listing
+               // environment provided by minted is used. In either case, the
+               // label parameter is taken as the label by which the float
+               // can be referenced, otherwise it will have the meaning
+               // intended by minted. In this last case, the label will
+               // serve as a sort of caption that, however, will be shown
+               // by minted only if the frame parameter is also specified.
+               bool const use_minted = buffer().params().use_minted;
                runparams.exportdata->addExternalFile(tex_format, writefile,
                                                      exportfile);
-               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.params()) << "]";
-               os << '{'  << from_utf8(incfile) << '}';
+               InsetListingsParams lstparams(opt);
+               docstring parameters = from_utf8(lstparams.params());
+               docstring language;
+               docstring caption;
+               docstring label;
+               docstring placement;
+               bool isfloat = lstparams.isFloat();
+               // We are going to split parameters at commas, so
+               // replace commas that are not parameter separators
+               // with a code point from the private use area
+               char_type comma = replaceCommaInBraces(parameters);
+               // Get float placement, language, caption, and
+               // label, then remove the relative options if minted.
+               vector<docstring> opts =
+                       getVectorFromString(parameters, from_ascii(","), false);
+               vector<docstring> latexed_opts;
+               for (size_t i = 0; i < opts.size(); ++i) {
+                       // Restore replaced commas
+                       opts[i] = subst(opts[i], comma, ',');
+                       if (use_minted && prefixIs(opts[i], from_ascii("float"))) {
+                               if (prefixIs(opts[i], from_ascii("float=")))
+                                       placement = opts[i].substr(6);
+                               opts.erase(opts.begin() + i--);
+                       } else if (use_minted && prefixIs(opts[i], from_ascii("language="))) {
+                               language = opts[i].substr(9);
+                               opts.erase(opts.begin() + i--);
+                       } else if (prefixIs(opts[i], from_ascii("caption="))) {
+                               // FIXME We should use HANDLING_LATEXIFY here,
+                               // but that's a file format change (see #10455).
+                               caption = opts[i].substr(8);
+                               opts.erase(opts.begin() + i--);
+                               if (!use_minted)
+                                       latexed_opts.push_back(from_ascii("caption=") + caption);
+                       } else if (prefixIs(opts[i], from_ascii("label="))) {
+                               label = params().prepareCommand(runparams, trim(opts[i].substr(6), "{}"),
+                                                               ParamInfo::HANDLING_ESCAPE);
+                               opts.erase(opts.begin() + i--);
+                               if (!use_minted)
+                                       latexed_opts.push_back(from_ascii("label={") + label + "}");
+                       }
+                       if (use_minted && !label.empty()) {
+                               if (isfloat || !caption.empty())
+                                       label = trim(label, "{}");
+                               else
+                                       opts.push_back(from_ascii("label=") + label);
+                       }
+               }
+               if (!latexed_opts.empty())
+                       opts.insert(opts.end(), latexed_opts.begin(), latexed_opts.end());
+               parameters = getStringFromVector(opts, from_ascii(","));
+               if (language.empty())
+                       language = from_ascii("TeX");
+               if (use_minted && isfloat) {
+                       os << breakln << "\\begin{listing}";
+                       if (!placement.empty())
+                               os << '[' << placement << "]";
+                       os << breakln;
+               } else if (use_minted && !caption.empty()) {
+                       os << breakln << "\\lyxmintcaption[t]{" << caption;
+                       if (!label.empty())
+                               os << "\\label{" << label << "}";
+                       os << "}\n";
+               }
+               os << (use_minted ? "\\inputminted" : "\\lstinputlisting");
+               if (!parameters.empty())
+                       os << "[" << parameters << "]";
+               if (use_minted)
+                       os << '{'  << ascii_lowercase(language) << '}';
+               os << '{'  << incfile << '}';
+               if (use_minted && isfloat) {
+                       if (!caption.empty())
+                               os << breakln << "\\caption{" << caption << "}";
+                       if (!label.empty())
+                               os << breakln << "\\label{" << label << "}";
+                       os << breakln << "\\end{listing}\n";
+               }
                break;
        }
        case INCLUDE: {
@@ -689,7 +789,7 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                                                "uses module `%2$s'\n"
                                                "which is not used in parent file."),
                                                included_file.displayName(), from_utf8(module));
-                                       Alert::warning(_("Module not found"), text);
+                                       Alert::warning(_("Module not found"), text, true);
                                }
                        }
                }
@@ -826,20 +926,20 @@ docstring InsetInclude::xhtml(XHTMLStream & xs, OutputParams const & rp) const
                return docstring();
 
        // are we generating only some paragraphs, or all of them?
-       bool const all_pars = !rp.dryrun || 
-                       (rp.par_begin == 0 && 
+       bool const all_pars = !rp.dryrun ||
+                       (rp.par_begin == 0 &&
                         rp.par_end == (int)buffer().text().paragraphs().size());
-       
+
        OutputParams op = rp;
        if (all_pars) {
                op.par_begin = 0;
                op.par_end = 0;
                ibuf->writeLyXHTMLSource(xs.os(), op, Buffer::IncludedFile);
        } else
-               xs << XHTMLStream::ESCAPE_NONE 
-                  << "<!-- Included file: " 
-                  << from_utf8(included_file.absFileName()) 
-                  << XHTMLStream::ESCAPE_NONE 
+               xs << XHTMLStream::ESCAPE_NONE
+                  << "<!-- Included file: "
+                  << from_utf8(included_file.absFileName())
+                  << XHTMLStream::ESCAPE_NONE
                         << " -->";
        return docstring();
 }
@@ -962,8 +1062,16 @@ void InsetInclude::validate(LaTeXFeatures & features) const
        features.useInsetLayout(getLayout());
        if (isVerbatim(params()))
                features.require("verbatim");
-       else if (isListings(params()))
-               features.require("listings");
+       else if (isListings(params())) {
+               if (buffer().params().use_minted) {
+                       features.require("minted");
+                       string const opts = to_utf8(params()["lstparams"]);
+                       InsetListingsParams lstpars(opts);
+                       if (!lstpars.isFloat() && contains(opts, "caption="))
+                               features.require("lyxmintcaption");
+               } else
+                       features.require("listings");
+       }
 
        // Here we must do the fun stuff...
        // Load the file in the include if it needs
@@ -992,7 +1100,7 @@ void InsetInclude::validate(LaTeXFeatures & features) const
 }
 
 
-void InsetInclude::collectBibKeys(InsetIterator const & /*di*/) const
+void InsetInclude::collectBibKeys(InsetIterator const & /*di*/, FileNameList & checkedFiles) const
 {
        Buffer * child = loadIfNeeded();
        if (!child)
@@ -1002,7 +1110,7 @@ void InsetInclude::collectBibKeys(InsetIterator const & /*di*/) const
        // But it'll have to do for now.
        if (child == &buffer())
                return;
-       child->collectBibKeys();
+       child->collectBibKeys(checkedFiles);
 }
 
 
@@ -1022,7 +1130,7 @@ void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
        } else {
                if (!set_label_) {
                        set_label_ = true;
-                       button_.update(screenLabel(), true);
+                       button_.update(screenLabel(), true, false);
                }
                button_.metrics(mi, dim);
        }
@@ -1129,7 +1237,7 @@ void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
        }
 }
 
-} // namespace anon
+} // namespace
 
 
 void InsetInclude::addPreview(DocIterator const & /*inset_pos*/,
@@ -1154,8 +1262,12 @@ void InsetInclude::addToToc(DocIterator const & cpit, bool output_active,
                b.pushItem(cpit, screenLabel(), output_active);
                InsetListingsParams p(to_utf8(params()["lstparams"]));
                b.argumentItem(from_utf8(p.getParamValue("caption")));
-               b.pop();
-       } else {
+        b.pop();
+    } else if (isVerbatim(params())) {
+        TocBuilder & b = backend.builder("child");
+        b.pushItem(cpit, screenLabel(), output_active);
+        b.pop();
+    } else {
                Buffer const * const childbuffer = getChildBuffer();
 
                TocBuilder & b = backend.builder("child");
@@ -1201,13 +1313,13 @@ void InsetInclude::updateCommand()
        InsetListingsParams par(to_utf8(params()["lstparams"]));
        par.addParam("label", "{" + to_utf8(new_label) + "}", true);
        p["lstparams"] = from_utf8(par.params());
-       setParams(p);   
+       setParams(p);
 }
 
 
 void InsetInclude::updateBuffer(ParIterator const & it, UpdateType utype)
 {
-       button_.update(screenLabel(), true);
+       button_.update(screenLabel(), true, false);
 
        Buffer const * const childbuffer = getChildBuffer();
        if (childbuffer) {