X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2FInsetInclude.cpp;h=7bf23298148589ad97f8758e4ab04e63bf208b8b;hb=96dea61f22c04529e726cab36acf0240d41fa778;hp=58d46ab09416bdde95cd6b8309c4fbff143685d4;hpb=eff76bd3ab5643340cc0216f5db7215893f3d2ac;p=lyx.git diff --git a/src/insets/InsetInclude.cpp b/src/insets/InsetInclude.cpp index 58d46ab094..7bf2329814 100644 --- a/src/insets/InsetInclude.cpp +++ b/src/insets/InsetInclude.cpp @@ -31,11 +31,12 @@ #include "LayoutFile.h" #include "LayoutModuleList.h" #include "LyX.h" -#include "LyXRC.h" #include "Lexer.h" #include "MetricsInfo.h" +#include "output_plaintext.h" #include "output_xhtml.h" #include "OutputParams.h" +#include "texstream.h" #include "TextClass.h" #include "TocBackend.h" @@ -60,6 +61,8 @@ #include "support/lassert.h" #include "support/lstrings.h" // contains #include "support/lyxalgo.h" +#include "support/mutex.h" +#include "support/ExceptionMessage.h" #include "support/bind.h" @@ -76,6 +79,8 @@ namespace { docstring const uniqueID() { static unsigned int seed = 1000; + static Mutex mutex; + Mutex::Locker lock(&mutex); return "file" + convert(++seed); } @@ -94,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; @@ -124,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; } @@ -160,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(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"])); @@ -180,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(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_); @@ -192,8 +214,6 @@ InsetInclude::InsetInclude(InsetInclude const & other) InsetInclude::~InsetInclude() { - if (isBufferLoaded()) - buffer().invalidateBibfileCache(); delete label_; } @@ -257,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()); } @@ -305,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"); } @@ -338,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; @@ -346,8 +369,6 @@ void InsetInclude::setParams(InsetCommandParams const & p) if (type(params()) == INPUT) add_preview(*preview_, *this, buffer()); - - buffer().invalidateBibfileCache(); } @@ -387,7 +408,8 @@ docstring InsetInclude::screenLabel() const temp = listings_label_; break; case NONE: - LASSERT(false, /**/); + LASSERT(false, temp = buffer().B_("Unknown")); + break; } temp += ": "; @@ -403,9 +425,11 @@ docstring InsetInclude::screenLabel() const Buffer * InsetInclude::getChildBuffer() const { - Buffer * childBuffer = loadIfNeeded(); + Buffer * childBuffer = loadIfNeeded(); - // FIXME: recursive includes + // FIXME RECURSIVE INCLUDE + // This isn't sufficient, as the inclusion could be downstream. + // But it'll have to do for now. return (childBuffer == &buffer()) ? 0 : childBuffer; } @@ -416,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; @@ -425,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_; @@ -439,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) @@ -516,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) @@ -532,74 +557,240 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const mangledFileName(); } - FileName const writefile(makeAbsPath(mangled, masterBuffer->temppath())); - if (!runparams.nice) incfile = mangled; + else if (!runparams.silent) + ; // no warning wanted else if (!isValidLaTeXFileName(incfile)) { frontend::Alert::warning(_("Invalid filename"), _("The following filename will cause troubles " - "when running the exported file through LaTeX: ") + + "when running the exported file through LaTeX: ") + from_utf8(incfile)); - } - else if (!isValidDVIFileName(incfile)) { + } else if (!isValidDVIFileName(incfile)) { frontend::Alert::warning(_("Problematic filename for DVI"), _("The following filename can cause troubles " - "when running the exported file through LaTeX " - "and opening the resulting DVI: ") + + "when running the exported file through LaTeX " + "and opening the resulting DVI: ") + from_utf8(incfile), true); } + + FileName const writefile(makeAbsPath(mangled, runparams.for_preview ? + buffer().temppath() : masterBuffer->temppath())); + LYXERR(Debug::LATEX, "incfile:" << incfile); LYXERR(Debug::LATEX, "exportfile:" << exportfile); LYXERR(Debug::LATEX, "writefile:" << writefile); string const tex_format = flavor2format(runparams.flavor); - 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()) && + + switch (type(params())) { + case VERB: + case VERBAST: { + incfile = latex_path(incfile); + // FIXME UNICODE + os << '\\' << from_ascii(params().getCmdName()) << '{' + << from_utf8(incfile) << '}'; + break; + } + case INPUT: { + runparams.exportdata->addExternalFile(tex_format, writefile, + exportfile); + + // \input wants file with extension (default is .tex) + if (!isLyXFileName(included_file.absFileName())) { + incfile = latex_path(incfile); + // FIXME UNICODE + os << '\\' << from_ascii(params().getCmdName()) + << '{' << from_utf8(incfile) << '}'; + } else { + incfile = changeExtension(incfile, ".tex"); + incfile = latex_path(incfile); + // FIXME UNICODE + os << '\\' << from_ascii(params().getCmdName()) + << '{' << from_utf8(incfile) << '}'; + } + 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); + string const opt = to_utf8(params()["lstparams"]); + // opt is set in QInclude dialog and should have passed validation. + 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 opts = + getVectorFromString(parameters, from_ascii(","), false); + vector 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: { + runparams.exportdata->addExternalFile(tex_format, writefile, + exportfile); + + // \include don't want extension and demands that the + // file really have .tex + incfile = changeExtension(incfile, string()); + incfile = latex_path(incfile); + // FIXME UNICODE + os << '\\' << from_ascii(params().getCmdName()) << '{' + << from_utf8(incfile) << '}'; + break; + } + case NONE: + break; + } + + if (runparams.inComment || runparams.dryrun) + // Don't try to load or copy the file if we're + // in a comment or doing a dryrun + return; + + 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 Buffer * tmp = loadIfNeeded(); if (!tmp) { - docstring text = bformat(_("Could not load included " - "file\n`%1$s'\n" - "Please, check whether it actually exists."), - included_file.displayName()); - Alert::warning(_("Missing included file"), text); + if (!runparams.silent) { + docstring text = bformat(_("Could not load included " + "file\n`%1$s'\n" + "Please, check whether it actually exists."), + included_file.displayName()); + throw ExceptionMessage(ErrorException, _("Error: "), + text); + } return; } - if (tmp->params().baseClass() != masterBuffer->params().baseClass()) { - // FIXME UNICODE - docstring text = bformat(_("Included file `%1$s'\n" - "has textclass `%2$s'\n" - "while parent file has textclass `%3$s'."), - included_file.displayName(), - from_utf8(tmp->params().documentClass().name()), - from_utf8(masterBuffer->params().documentClass().name())); - Alert::warning(_("Different textclasses"), text, true); - } + if (!runparams.silent) { + if (tmp->params().baseClass() != masterBuffer->params().baseClass()) { + // FIXME UNICODE + docstring text = bformat(_("Included file `%1$s'\n" + "has textclass `%2$s'\n" + "while parent file has textclass `%3$s'."), + included_file.displayName(), + from_utf8(tmp->params().documentClass().name()), + from_utf8(masterBuffer->params().documentClass().name())); + 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. - 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; - LayoutModuleList::const_iterator found = - find(masterModules.begin(), masterModules.end(), module); - if (found == masterModules.end()) { + 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" - "uses module `%2$s'\n" - "which is not used in parent file."), - included_file.displayName(), from_utf8(module)); - Alert::warning(_("Module not found"), text); + "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. + 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; + LayoutModuleList::const_iterator found = + find(masterModules.begin(), masterModules.end(), module); + if (found == masterModules.end()) { + docstring text = bformat(_("Included file `%1$s'\n" + "uses module `%2$s'\n" + "which is not used in parent file."), + included_file.displayName(), from_utf8(module)); + Alert::warning(_("Module not found"), text, true); + } } } @@ -608,35 +799,41 @@ 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; runparams.par_begin = 0; runparams.par_end = tmp->paragraphs().size(); - if (!tmp->makeLaTeXFile(tmpwritefile, runparams, false)) { - docstring msg = bformat(_("Included file `%1$s' " - "was not exported correctly.\nWarning: " + runparams.is_child = true; + if (!tmp->makeLaTeXFile(tmpwritefile, masterFileName(buffer()). + onlyPath().absFileName(), runparams, Buffer::OnlyBody)) { + if (!runparams.silent) { + docstring msg = bformat(_("Included file `%1$s' " + "was not exported correctly.\n " "LaTeX export is probably incomplete."), included_file.displayName()); - ErrorList const & el = tmp->errorList("Export"); - if (!el.empty()) - msg = bformat(from_ascii("%1$s\n\n%2$s\n\n%3$s"), + ErrorList const & el = tmp->errorList("Export"); + 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); + } } runparams.encoding = oldEnc; runparams.master_language = oldLang; + runparams.is_child = false; // If needed, use converters to produce a latex file from the child if (tmpwritefile != writefile) { @@ -646,24 +843,25 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const included_file, inc_format, tex_format, el); - if (!success) { + 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 { // 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 the environment variable TEXINPUTS, which may be - // set in preferences and by default includes the original dir. + // found via either the environment variable TEXINPUTS, or + // input@path, see ../Buffer.cpp. unsigned long const checksum_in = included_file.checksum(); unsigned long const checksum_out = writefile.checksum(); @@ -672,69 +870,12 @@ void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const // FIXME UNICODE LYXERR(Debug::LATEX, to_utf8(bformat(_("Could not copy the file\n%1$s\n" - "into the temporary directory."), - from_utf8(included_file.absFileName())))); + "into the temporary directory."), + from_utf8(included_file.absFileName())))); return; } } } - - switch (type(params())) { - case VERB: - case VERBAST: { - incfile = latex_path(incfile); - // FIXME UNICODE - os << '\\' << from_ascii(params().getCmdName()) << '{' - << from_utf8(incfile) << '}'; - break; - } - case INPUT: { - runparams.exportdata->addExternalFile(tex_format, writefile, - exportfile); - - // \input wants file with extension (default is .tex) - if (!isLyXFileName(included_file.absFileName())) { - incfile = latex_path(incfile); - // FIXME UNICODE - os << '\\' << from_ascii(params().getCmdName()) - << '{' << from_utf8(incfile) << '}'; - } else { - incfile = changeExtension(incfile, ".tex"); - incfile = latex_path(incfile); - // FIXME UNICODE - os << '\\' << from_ascii(params().getCmdName()) - << '{' << from_utf8(incfile) << '}'; - } - break; - } - case LISTINGS: { - 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) << '}'; - break; - } - case INCLUDE: { - runparams.exportdata->addExternalFile(tex_format, writefile, - exportfile); - - // \include don't want extension and demands that the - // file really have .tex - incfile = changeExtension(incfile, string()); - incfile = latex_path(incfile); - // FIXME UNICODE - os << '\\' << from_ascii(params().getCmdName()) << '{' - << from_utf8(incfile) << '}'; - break; - } - case NONE: - break; - } } @@ -761,7 +902,8 @@ docstring InsetInclude::xhtml(XHTMLStream & xs, OutputParams const & rp) const // converter on the included file. But that's just masochistic.) FileName const included_file = includedFileName(buffer(), params()); if (!isLyXFileName(included_file.absFileName())) { - frontend::Alert::warning(_("Unsupported Inclusion"), + if (!rp.silent) + 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"])); @@ -784,38 +926,52 @@ 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, true); + ibuf->writeLyXHTMLSource(xs.os(), op, Buffer::IncludedFile); } else - xs << XHTMLStream::ESCAPE_NONE - << ""; return docstring(); } -int InsetInclude::plaintext(odocstream & os, OutputParams const &) const +int InsetInclude::plaintext(odocstringstream & os, + OutputParams const & op, size_t) const { + // just write the filename if we're making a tooltip or toc entry, + // or are generating this for advanced search + if (op.for_tooltip || op.for_toc || op.for_search) { + os << '[' << screenLabel() << '\n' + << getParam("filename") << "\n]"; + return PLAINTEXT_NEWLINE + 1; // one char on a separate line + } + if (isVerbatim(params()) || isListings(params())) { - os << '[' << screenLabel() << '\n'; - // FIXME: We don't know the encoding of the file, default to UTF-8. - os << includedFileName(buffer(), params()).fileContents("UTF-8"); - os << "\n]"; + os << '[' << screenLabel() << '\n' + // FIXME: We don't know the encoding of the file, default to UTF-8. + << includedFileName(buffer(), params()).fileContents("UTF-8") + << "\n]"; return PLAINTEXT_NEWLINE + 1; // one char on a separate line - } else { + } + + Buffer const * const ibuf = loadIfNeeded(); + if (!ibuf) { docstring const str = '[' + screenLabel() + ']'; os << str; return str.size(); } + writePlaintextFile(*ibuf, os, op); + return 0; } @@ -862,7 +1018,7 @@ int InsetInclude::docbook(odocstream & os, OutputParams const & runparams) const LYXERR(Debug::LATEX, "exportfile:" << exportfile); LYXERR(Debug::LATEX, "writefile:" << writefile); - tmp->makeDocBookFile(writefile, runparams, true); + tmp->makeDocBookFile(writefile, runparams, Buffer::OnlyBody); } runparams.exportdata->addExternalFile("docbook", writefile, @@ -883,14 +1039,13 @@ int InsetInclude::docbook(odocstream & os, OutputParams const & runparams) const void InsetInclude::validate(LaTeXFeatures & features) const { - string incfile = to_utf8(params()["filename"]); - string writefile; - - LASSERT(&buffer() == &features.buffer(), /**/); + LATTEST(&buffer() == &features.buffer()); + string incfile = to_utf8(params()["filename"]); string const included_file = includedFileName(buffer(), params()).absFileName(); + string writefile; if (isLyXFileName(included_file)) writefile = changeExtension(included_file, ".sgml"); else @@ -904,10 +1059,19 @@ void InsetInclude::validate(LaTeXFeatures & features) const features.includeFile(include_label, writefile); + 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 @@ -924,28 +1088,38 @@ void InsetInclude::validate(LaTeXFeatures & features) const // otherwise it would always be the master buffer, // and nested includes would not work. features.setBuffer(*tmp); + // Maybe this is already a child + bool const is_child = + features.runparams().is_child; + features.runparams().is_child = true; tmp->validate(features); + features.runparams().is_child = is_child; features.setBuffer(buffer()); } } } -void InsetInclude::collectBibKeys(InsetIterator const & /*di*/) const +void InsetInclude::collectBibKeys(InsetIterator const & /*di*/, FileNameList & checkedFiles) const { Buffer * child = loadIfNeeded(); if (!child) return; - child->collectBibKeys(); + // FIXME RECURSIVE INCLUDE + // This isn't sufficient, as the inclusion could be downstream. + // But it'll have to do for now. + if (child == &buffer()) + return; + child->collectBibKeys(checkedFiles); } void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const { - LASSERT(mi.base.bv, /**/); + LBUFERR(mi.base.bv); bool use_preview = false; - if (RenderPreview::status() != LyXRC::PREVIEW_OFF) { + if (RenderPreview::previewText()) { graphics::PreviewImage const * pimage = preview_->getPreviewImage(mi.base.bv->buffer()); use_preview = pimage && pimage->image(); @@ -956,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); } @@ -968,10 +1142,10 @@ void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const void InsetInclude::draw(PainterInfo & pi, int x, int y) const { - LASSERT(pi.base.bv, /**/); + LBUFERR(pi.base.bv); bool use_preview = false; - if (RenderPreview::status() != LyXRC::PREVIEW_OFF) { + if (RenderPreview::previewText()) { graphics::PreviewImage const * pimage = preview_->getPreviewImage(pi.base.bv->buffer()); use_preview = pimage && pimage->image(); @@ -984,9 +1158,15 @@ void InsetInclude::draw(PainterInfo & pi, int x, int y) const } -docstring InsetInclude::contextMenuName() const +void InsetInclude::write(ostream & os) const +{ + params().Write(os, &buffer()); +} + + +string InsetInclude::contextMenuName() const { - return from_ascii("context-include"); + return "context-include"; } @@ -996,6 +1176,13 @@ Inset::DisplayType InsetInclude::display() const } +docstring InsetInclude::layoutName() const +{ + if (isListings(params())) + return from_ascii("IncludeListings"); + return InsetCommand::layoutName(); +} + // // preview stuff @@ -1008,7 +1195,7 @@ void InsetInclude::fileChanged() const return; preview_->removePreview(*buffer); - add_preview(*preview_.get(), *this, *buffer); + add_preview(*preview_, *this, *buffer); preview_->startLoading(*buffer); } @@ -1026,13 +1213,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(); @@ -1043,15 +1230,14 @@ void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset, Buffer const & buffer) { InsetCommandParams const & params = inset.params(); - if (RenderPreview::status() != LyXRC::PREVIEW_OFF && - preview_wanted(params, buffer)) { + if (RenderPreview::previewText() && preview_wanted(params, buffer)) { renderer.setAbsFile(includedFileName(buffer, params)); docstring const snippet = latexString(inset); renderer.addPreview(snippet, buffer); } } -} // namespace anon +} // namespace void InsetInclude::addPreview(DocIterator const & /*inset_pos*/, @@ -1066,41 +1252,46 @@ void InsetInclude::addPreview(DocIterator const & /*inset_pos*/, } -void InsetInclude::addToToc(DocIterator const & cpit) 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); - + 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 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"); + 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(toc.size() + 1) - + ". " + from_utf8(caption); - DocIterator pit = cpit; - toc.push_back(TocItem(pit, 0, str)); - 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)); - - TocList & toclist = backend.tocs(); - childbuffer->tocBackend().update(); - 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 const & name + : childbuffer->params().documentClass().outlinerNames()) + backend.addName(name.first, translateIfPossible(name.second)); + } } @@ -1122,12 +1313,14 @@ 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, false); + Buffer const * const childbuffer = getChildBuffer(); if (childbuffer) { childbuffer->updateBuffer(Buffer::UpdateChildOnly, utype);