#include "support/convert.h"
#include "support/debug.h"
#include "support/docstream.h"
+#include "support/FileName.h"
#include "support/FileNameList.h"
#include "support/filetools.h"
#include "support/gettext.h"
return VERB;
if (s == "verbatiminput*")
return VERBAST;
- if (s == "lstinputlisting")
+ if (s == "lstinputlisting" || s == "inputminted")
return LISTINGS;
if (s == "include")
return INCLUDE;
FileName const includedFileName(Buffer const & buffer,
InsetCommandParams const & params)
{
- return makeAbsPath(to_utf8(params["filename"]),
+ return makeAbsPath(ltrim(to_utf8(params["filename"])),
onlyPath(parentFileName(buffer)));
}
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_(make_unique<RenderMonitoredPreview>(this)), failedtoload_(false),
- set_label_(false), label_(0), child_buffer_(0)
+ set_label_(false), label_(0), child_buffer_(0), file_exist_(false)
{
preview_->connect([=](){ fileChanged(); });
InsetInclude::InsetInclude(InsetInclude const & other)
: InsetCommand(other), include_label(other.include_label),
preview_(make_unique<RenderMonitoredPreview>(this)), failedtoload_(false),
- set_label_(false), label_(0), child_buffer_(0)
+ set_label_(false), label_(0), child_buffer_(0), file_exist_(other.file_exist_)
{
preview_->connect([=](){ fileChanged(); });
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_;
}
if (param_info_.empty()) {
param_info_.add("filename", ParamInfo::LATEX_REQUIRED);
param_info_.add("lstparams", ParamInfo::LATEX_OPTIONAL);
+ param_info_.add("literal", ParamInfo::LYX_INTERNAL);
}
return param_info_;
}
}
+bool InsetInclude::needsCProtection(bool const /*maintext*/, bool const fragile) const
+{
+ // We need to \cprotect all types in fragile context
+ return fragile;
+}
+
+
void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
{
switch (cmd.action()) {
case LFUN_INSET_EDIT: {
- editIncluded(to_utf8(params()["filename"]));
+ editIncluded(ltrim(to_utf8(params()["filename"])));
break;
}
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());
}
break;
}
+ case LFUN_MOUSE_RELEASE: {
+ if (cmd.modifier() == ControlModifier) {
+ FileName const incfile = includedFileName(buffer(), params());
+ string const & incname = incfile.absFileName();
+ editIncluded(incname);
+ break;
+ }
+ }
+ // fall through
+
//pass everything else up the chain
default:
InsetCommand::doDispatch(cur, cmd);
}
-void InsetInclude::editIncluded(string const & file)
+void InsetInclude::editIncluded(string const & f)
{
- string const ext = support::getExtension(file);
- if (ext == "lyx") {
- FuncRequest fr(LFUN_BUFFER_CHILD_OPEN, file);
+ if (isLyXFileName(f)) {
+ FuncRequest fr(LFUN_BUFFER_CHILD_OPEN, f);
lyx::dispatch(fr);
} else
// tex file or other text file in verbatim mode
theFormats().edit(buffer(),
- support::makeAbsPath(file, support::onlyPath(buffer().absFileName())),
+ support::makeAbsPath(f, support::onlyPath(buffer().absFileName())),
"text");
}
if (type(params()) == INPUT)
add_preview(*preview_, *this, buffer());
-
- buffer().invalidateBibfileCache();
}
return true;
return (std::find(includeonlys.begin(),
includeonlys.end(),
- to_utf8(params()["filename"])) != includeonlys.end());
+ ltrim(to_utf8(params()["filename"]))) != includeonlys.end());
}
docstring InsetInclude::screenLabel() const
{
+ docstring pre = file_exist_ ? docstring() : _("FILE MISSING:");
+
docstring temp;
switch (type(params())) {
temp = buffer().B_("Input");
break;
case VERB:
- temp = buffer().B_("Verbatim Input");
+ temp = buffer().B_("Verbatim");
break;
case VERBAST:
- temp = buffer().B_("Verbatim Input*");
+ temp = buffer().B_("Verbatim*");
break;
case INCLUDE:
if (isChildIncluded())
temp += ": ";
- if (params()["filename"].empty())
+ if (ltrim(params()["filename"]).empty())
temp += "???";
else
- temp += from_utf8(onlyFileName(to_utf8(params()["filename"])));
+ temp += from_utf8(onlyFileName(ltrim(to_utf8(params()["filename"]))));
- return temp;
+ return pre.empty() ? temp : pre + from_ascii(" ") + temp;
}
Buffer * InsetInclude::getChildBuffer() const
{
- Buffer * childBuffer = loadIfNeeded();
+ Buffer * childBuffer = loadIfNeeded();
// FIXME RECURSIVE INCLUDE
// This isn't sufficient, as the inclusion could be downstream.
// 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;
// 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_;
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)
void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
{
- string incfile = to_utf8(params()["filename"]);
-
- // Do nothing if no file name has been specified
- if (incfile.empty())
+ string incfile = ltrim(to_utf8(params()["filename"]));
+
+ // Warn if no file name has been specified
+ if (incfile.empty()) {
+ frontend::Alert::warning(_("No file name specified"),
+ _("An included file name is empty.\n"
+ "Ignoring Inclusion"),
+ true);
return;
+ }
+ // Warn if file doesn't exist
+ if (!includedFileExist()) {
+ frontend::Alert::warning(_("Included file not found"),
+ bformat(_("The included file\n"
+ "'%1$s'\n"
+ "has not been found. LyX will ignore the inclusion."),
+ from_utf8(incfile)),
+ true);
+ return;
+ }
FileName const included_file = includedFileName(buffer(), params());
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)
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="))) {
+ caption = params().prepareCommand(runparams, trim(opts[i].substr(8), "{}"),
+ ParamInfo::HANDLING_LATEXIFY);
+ 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: {
from_utf8(child_tf),
from_utf8(master_tf));
Alert::warning(_("Different use-non-TeX-fonts settings"), text, true);
+ }
+ else if (tmp->params().inputenc != masterBuffer->params().inputenc) {
+ docstring text = bformat(_("Included file `%1$s'\n"
+ "uses input encoding \"%2$s\" [%3$s]\n"
+ "while parent file uses input encoding \"%4$s\" [%5$s]."),
+ included_file.displayName(),
+ _(tmp->params().inputenc),
+ from_utf8(tmp->params().encoding().guiName()),
+ _(masterBuffer->params().inputenc),
+ from_utf8(masterBuffer->params().encoding().guiName()));
+ Alert::warning(_("Different LaTeX input encodings"), text, true);
}
// Make sure modules used in child are all included in master
"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);
}
}
}
Language const * const oldLang = runparams.master_language;
// If the master uses non-TeX fonts (XeTeX, LuaTeX),
// the children must be encoded in plain utf8!
- runparams.encoding = masterBuffer->params().useNonTeXFonts ?
- encodings.fromLyXName("utf8-plain")
- : &tmp->params().encoding();
+ if (masterBuffer->params().useNonTeXFonts)
+ runparams.encoding = encodings.fromLyXName("utf8-plain");
+ else if (oldEnc)
+ runparams.encoding = oldEnc;
+ else runparams.encoding = &tmp->params().encoding();
runparams.master_language = buffer().params().language;
runparams.par_begin = 0;
runparams.par_end = tmp->paragraphs().size();
runparams.is_child = true;
- if (!tmp->makeLaTeXFile(tmpwritefile, masterFileName(buffer()).
- onlyPath().absFileName(), runparams, Buffer::OnlyBody)) {
+ Buffer::ExportStatus retval =
+ tmp->makeLaTeXFile(tmpwritefile, masterFileName(buffer()).
+ onlyPath().absFileName(), runparams, Buffer::OnlyBody);
+ if (retval == Buffer::ExportKilled && buffer().isClone() &&
+ buffer().isExporting()) {
+ // We really shouldn't get here, I don't think.
+ LYXERR0("No conversion exception?");
+ throw ConversionException();
+ }
+ else if (retval != Buffer::ExportSuccess) {
if (!runparams.silent) {
docstring msg = bformat(_("Included file `%1$s' "
"was not exported correctly.\n "
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);
- throw ExceptionMessage(ErrorException, _("Error: "),
- msg);
+ msg, el.begin()->error, el.begin()->description);
+ throw ExceptionMessage(ErrorException, _("Error: "), msg);
}
}
runparams.encoding = oldEnc;
// If needed, use converters to produce a latex file from the child
if (tmpwritefile != writefile) {
ErrorList el;
- bool const success =
+ Converters::RetVal const conv_retval =
theConverters().convert(tmp, tmpwritefile, writefile,
- included_file,
- inc_format, tex_format, el);
-
- if (!success && !runparams.silent) {
+ included_file, inc_format, tex_format, el);
+ if (conv_retval == Converters::KILLED && buffer().isClone() &&
+ buffer().isExporting()) {
+ // We really shouldn't get here, I don't think.
+ LYXERR0("No conversion exception?");
+ throw ConversionException();
+ } else if (conv_retval != Converters::SUCCESS && !runparams.silent) {
docstring msg = bformat(_("Included file `%1$s' "
"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);
- throw ExceptionMessage(ErrorException, _("Error: "),
- msg);
+ msg, el.begin()->error, el.begin()->description);
+ throw ExceptionMessage(ErrorException, _("Error: "), msg);
}
}
} else {
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"]));
+ ltrim(params()["filename"])));
return docstring();
}
if (buffer().absFileName() == included_file.absFileName()) {
Alert::error(_("Recursive input"),
bformat(_("Attempted to include file %1$s in itself! "
- "Ignoring inclusion."), params()["filename"]));
+ "Ignoring inclusion."), ltrim(params()["filename"])));
return docstring();
}
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();
}
// or are generating this for advanced search
if (op.for_tooltip || op.for_toc || op.for_search) {
os << '[' << screenLabel() << '\n'
- << getParam("filename") << "\n]";
+ << ltrim(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.
- << includedFileName(buffer(), params()).fileContents("UTF-8")
- << "\n]";
+ if (op.for_search) {
+ os << '[' << screenLabel() << ']';
+ }
+ else {
+ 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
}
int InsetInclude::docbook(odocstream & os, OutputParams const & runparams) const
{
- string incfile = to_utf8(params()["filename"]);
+ string incfile = ltrim(to_utf8(params()["filename"]));
// Do nothing if no file name has been specified
if (incfile.empty())
{
LATTEST(&buffer() == &features.buffer());
- string incfile = to_utf8(params()["filename"]);
+ string incfile = ltrim(to_utf8(params()["filename"]));
string const included_file =
includedFileName(buffer(), params()).absFileName();
if (isVerbatim(params()))
features.require("verbatim");
else if (isListings(params())) {
- if (buffer().params().use_minted)
+ if (buffer().params().use_minted) {
features.require("minted");
- else
+ string const opts = to_utf8(params()["lstparams"]);
+ InsetListingsParams lstpars(opts);
+ if (!lstpars.isFloat() && contains(opts, "caption="))
+ features.require("lyxmintcaption");
+ } else
features.require("listings");
}
}
-void InsetInclude::collectBibKeys(InsetIterator const & /*di*/) const
+void InsetInclude::collectBibKeys(InsetIterator const & /*di*/, FileNameList & checkedFiles) const
{
Buffer * child = loadIfNeeded();
if (!child)
// But it'll have to do for now.
if (child == &buffer())
return;
- child->collectBibKeys();
+ child->collectBibKeys(checkedFiles);
}
}
}
-} // namespace anon
+} // namespace
void InsetInclude::addPreview(DocIterator const & /*inset_pos*/,
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");
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)
{
+ file_exist_ = includedFileExist();
+
button_.update(screenLabel(), true, false);
Buffer const * const childbuffer = getChildBuffer();
}
+bool InsetInclude::includedFileExist() const
+{
+ // check whether the included file exist
+ string incFileName = ltrim(to_utf8(params()["filename"]));
+ FileName fn =
+ support::makeAbsPath(incFileName,
+ support::onlyPath(buffer().absFileName()));
+ return fn.exists();
+}
+
} // namespace lyx
projects / lyx.git / blobdiff