]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetInclude.cpp
Fix left/right border UI when toggling formal
[lyx.git] / src / insets / InsetInclude.cpp
index a3a7441a39bccf4f977c7657b7fef9fee4302f7b..7c0d6ce5505a3f86d7b1cc15f2b9ed4cdf662b03 100644 (file)
@@ -36,6 +36,7 @@
 #include "output_plaintext.h"
 #include "output_xhtml.h"
 #include "OutputParams.h"
+#include "texstream.h"
 #include "TextClass.h"
 #include "TocBackend.h"
 
@@ -61,6 +62,7 @@
 #include "support/lstrings.h" // contains
 #include "support/lyxalgo.h"
 #include "support/mutex.h"
+#include "support/ExceptionMessage.h"
 
 #include "support/bind.h"
 
@@ -97,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;
@@ -127,7 +129,7 @@ bool isVerbatim(InsetCommandParams const & params)
 bool isInputOrInclude(InsetCommandParams const & params)
 {
        Types const t = type(params);
-       return t == INPUT || t == INCLUDE;
+       return t == INPUT || t == INCLUDE;
 }
 
 
@@ -163,15 +165,32 @@ 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)
        : InsetCommand(buf, p), include_label(uniqueID()),
-         preview_(new RenderMonitoredPreview(this)), failedtoload_(false),
+         preview_(make_unique<RenderMonitoredPreview>(this)), failedtoload_(false),
          set_label_(false), label_(0), child_buffer_(0)
 {
-       preview_->fileChanged(bind(&InsetInclude::fileChanged, this));
+       preview_->connect([=](){ fileChanged(); });
 
        if (isListings(params())) {
                InsetListingsParams listing_params(to_utf8(p["lstparams"]));
@@ -183,10 +202,10 @@ InsetInclude::InsetInclude(Buffer * buf, InsetCommandParams const & p)
 
 InsetInclude::InsetInclude(InsetInclude const & other)
        : InsetCommand(other), include_label(other.include_label),
-         preview_(new RenderMonitoredPreview(this)), failedtoload_(false),
+         preview_(make_unique<RenderMonitoredPreview>(this)), failedtoload_(false),
          set_label_(false), label_(0), child_buffer_(0)
 {
-       preview_->fileChanged(bind(&InsetInclude::fileChanged, this));
+       preview_->connect([=](){ fileChanged(); });
 
        if (other.label_)
                label_ = new InsetLabel(*other.label_);
@@ -195,8 +214,6 @@ InsetInclude::InsetInclude(InsetInclude const & other)
 
 InsetInclude::~InsetInclude()
 {
-       if (isBufferLoaded())
-               buffer().invalidateBibfileCache();
        delete label_;
 }
 
@@ -260,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());
                                                }
@@ -308,7 +325,7 @@ void InsetInclude::editIncluded(string const & file)
                lyx::dispatch(fr);
        } else
                // tex file or other text file in verbatim mode
-               formats.edit(buffer(),
+               theFormats().edit(buffer(),
                        support::makeAbsPath(file, support::onlyPath(buffer().absFileName())),
                        "text");
 }
@@ -349,8 +366,6 @@ void InsetInclude::setParams(InsetCommandParams const & p)
 
        if (type(params()) == INPUT)
                add_preview(*preview_, *this, buffer());
-
-       buffer().invalidateBibfileCache();
 }
 
 
@@ -407,7 +422,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.
@@ -422,7 +437,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;
@@ -431,7 +446,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_;
@@ -555,7 +570,8 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                        from_utf8(incfile), true);
        }
 
-       FileName const writefile(makeAbsPath(mangled, masterBuffer->temppath()));
+       FileName const writefile(makeAbsPath(mangled, runparams.for_preview ?
+                                                buffer().temppath() : masterBuffer->temppath()));
 
        LYXERR(Debug::LATEX, "incfile:" << incfile);
        LYXERR(Debug::LATEX, "exportfile:" << exportfile);
@@ -592,15 +608,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: {
@@ -637,7 +739,8 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                                        "file\n`%1$s'\n"
                                        "Please, check whether it actually exists."),
                                        included_file.displayName());
-                               Alert::warning(_("Missing included file"), text);
+                               throw ExceptionMessage(ErrorException, _("Error: "),
+                                                      text);
                        }
                        return;
                }
@@ -654,6 +757,18 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                                Alert::warning(_("Different textclasses"), text, true);
                        }
 
+                       string const child_tf = tmp->params().useNonTeXFonts ? "true" : "false";
+                       string const master_tf = masterBuffer->params().useNonTeXFonts ? "true" : "false";
+                       if (tmp->params().useNonTeXFonts != masterBuffer->params().useNonTeXFonts) {
+                               docstring text = bformat(_("Included file `%1$s'\n"
+                                       "has use-non-TeX-fonts set to `%2$s'\n"
+                                       "while parent file has use-non-TeX-fonts set to `%3$s'."),
+                                       included_file.displayName(),
+                                       from_utf8(child_tf),
+                                       from_utf8(master_tf));
+                               Alert::warning(_("Different use-non-TeX-fonts settings"), 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.
@@ -670,7 +785,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);
                                }
                        }
                }
@@ -680,16 +795,16 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                // Don't assume the child's format is latex
                string const inc_format = tmp->params().bufferFormat();
                FileName const tmpwritefile(changeExtension(writefile.absFileName(),
-                       formats.extension(inc_format)));
+                       theFormats().extension(inc_format)));
 
                // FIXME: handle non existing files
                // 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;
-               // If the master has full unicode flavor (XeTeX, LuaTeX),
+               // If the master uses non-TeX fonts (XeTeX, LuaTeX),
                // the children must be encoded in plain utf8!
-               runparams.encoding = runparams.isFullUnicode() ?
+               runparams.encoding = masterBuffer->params().useNonTeXFonts ?
                        encodings.fromLyXName("utf8-plain")
                        : &tmp->params().encoding();
                runparams.master_language = buffer().params().language;
@@ -700,7 +815,7 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                                onlyPath().absFileName(), runparams, Buffer::OnlyBody)) {
                        if (!runparams.silent) {
                                docstring msg = bformat(_("Included file `%1$s' "
-                                       "was not exported correctly.\nWarning: "
+                                       "was not exported correctly.\n "
                                        "LaTeX export is probably incomplete."),
                                        included_file.displayName());
                                ErrorList const & el = tmp->errorList("Export");
@@ -708,7 +823,8 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
                                        msg = bformat(from_ascii("%1$s\n\n%2$s\n\n%3$s"),
                                                msg, el.begin()->error,
                                                el.begin()->description);
-                               Alert::warning(_("Export failure"), msg);
+                               throw ExceptionMessage(ErrorException, _("Error: "),
+                                                      msg);
                        }
                }
                runparams.encoding = oldEnc;
@@ -725,14 +841,15 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
 
                        if (!success && !runparams.silent) {
                                docstring msg = bformat(_("Included file `%1$s' "
-                                               "was not exported correctly.\nWarning: "
+                                               "was not exported correctly.\n "
                                                "LaTeX export is probably incomplete."),
                                                included_file.displayName());
                                if (!el.empty())
                                        msg = bformat(from_ascii("%1$s\n\n%2$s\n\n%3$s"),
                                                        msg, el.begin()->error,
                                                        el.begin()->description);
-                               Alert::warning(_("Export failure"), msg);
+                               throw ExceptionMessage(ErrorException, _("Error: "),
+                                                      msg);
                        }
                }
        } else {
@@ -805,20 +922,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();
 }
@@ -941,8 +1058,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
@@ -971,7 +1096,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)
@@ -981,7 +1106,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);
 }
 
 
@@ -1001,7 +1126,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);
        }
@@ -1066,7 +1191,7 @@ void InsetInclude::fileChanged() const
                return;
 
        preview_->removePreview(*buffer);
-       add_preview(*preview_.get(), *this, *buffer);
+       add_preview(*preview_, *this, *buffer);
        preview_->startLoading(*buffer);
 }
 
@@ -1084,13 +1209,13 @@ bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
 
 docstring latexString(InsetInclude const & inset)
 {
-       TexRow texrow;
        odocstringstream ods;
-       otexstream os(ods, texrow);
+       otexstream os(ods);
        // We don't need to set runparams.encoding since this will be done
        // by latex() anyway.
        OutputParams runparams(0);
        runparams.flavor = OutputParams::LATEX;
+       runparams.for_preview = true;
        inset.latex(os, runparams);
 
        return ods.str();
@@ -1108,7 +1233,7 @@ void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
        }
 }
 
-} // namespace anon
+} // namespace
 
 
 void InsetInclude::addPreview(DocIterator const & /*inset_pos*/,
@@ -1123,41 +1248,42 @@ void InsetInclude::addPreview(DocIterator const & /*inset_pos*/,
 }
 
 
-void InsetInclude::addToToc(DocIterator const & cpit, bool output_active) const
+void InsetInclude::addToToc(DocIterator const & cpit, bool output_active,
+                            UpdateType utype, TocBackend & backend) const
 {
-       TocBackend & backend = buffer().tocBackend();
-
        if (isListings(params())) {
                if (label_)
-                       label_->addToToc(cpit, output_active);
-
+                       label_->addToToc(cpit, output_active, utype, backend);
+               TocBuilder & b = backend.builder("listing");
+               b.pushItem(cpit, screenLabel(), output_active);
                InsetListingsParams p(to_utf8(params()["lstparams"]));
-               string caption = p.getParamValue("caption");
-               if (caption.empty())
+               b.argumentItem(from_utf8(p.getParamValue("caption")));
+               b.pop();
+       } else {
+               Buffer const * const childbuffer = getChildBuffer();
+
+               TocBuilder & b = backend.builder("child");
+               docstring str = childbuffer ? childbuffer->fileName().displayName()
+                       : from_ascii("?");
+               b.pushItem(cpit, str, output_active);
+               b.pop();
+
+               if (!childbuffer)
                        return;
-               Toc & toc = backend.toc("listing");
-               docstring str = convert<docstring>(toc.size() + 1)
-                       + ". " +  from_utf8(caption);
-               DocIterator pit = cpit;
-               toc.push_back(TocItem(pit, 0, str, output_active));
-               return;
-       }
-       Buffer const * const childbuffer = getChildBuffer();
-       if (!childbuffer)
-               return;
 
-       Toc & toc = backend.toc("child");
-       docstring str = childbuffer->fileName().displayName();
-       toc.push_back(TocItem(cpit, 0, str, output_active));
-
-       TocList & toclist = backend.tocs();
-       childbuffer->tocBackend().update(output_active);
-       TocList const & childtoclist = childbuffer->tocBackend().tocs();
-       TocList::const_iterator it = childtoclist.begin();
-       TocList::const_iterator const end = childtoclist.end();
-       for(; it != end; ++it)
-               toclist[it->first].insert(toclist[it->first].end(),
-                       it->second.begin(), it->second.end());
+               // Update the child's tocBackend. The outliner uses the master's, but
+               // the navigation menu uses the child's.
+               childbuffer->tocBackend().update(output_active, utype);
+               // Include Tocs from children
+               childbuffer->inset().addToToc(DocIterator(), output_active, utype,
+                                             backend);
+               //Copy missing outliner names (though the user has been warned against
+               //having different document class and module selection between master
+               //and child).
+               for (pair<string, docstring> const & name
+                            : childbuffer->params().documentClass().outlinerNames())
+                       backend.addName(name.first, translateIfPossible(name.second));
+       }
 }
 
 
@@ -1179,13 +1305,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) {