#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"
#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"
#include "support/lassert.h"
#include "support/lstrings.h" // contains
#include "support/lyxalgo.h"
-
-#include "support/bind.h"
+#include "support/mutex.h"
+#include "support/ExceptionMessage.h"
using namespace std;
using namespace lyx::support;
docstring const uniqueID()
{
static unsigned int seed = 1000;
+ static Mutex mutex;
+ Mutex::Locker lock(&mutex);
return "file" + convert<docstring>(++seed);
}
return VERB;
if (s == "verbatiminput*")
return VERBAST;
- if (s == "lstinputlisting")
+ if (s == "lstinputlisting" || s == "inputminted")
return LISTINGS;
if (s == "include")
return INCLUDE;
bool isInputOrInclude(InsetCommandParams const & params)
{
Types const t = type(params);
- return t == INPUT || t == INCLUDE;
+ return t == INPUT || t == 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)));
}
InsetLabel * createLabel(Buffer * buf, docstring const & label_str)
{
if (label_str.empty())
- return 0;
+ return nullptr;
InsetCommandParams icp(LABEL_CODE);
icp["name"] = 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),
- set_label_(false), label_(0), child_buffer_(0)
+ preview_(make_unique<RenderMonitoredPreview>(this)), failedtoload_(false),
+ set_label_(false), label_(nullptr), child_buffer_(nullptr), file_exist_(false),
+ recursion_error_(false)
{
- preview_->fileChanged(bind(&InsetInclude::fileChanged, this));
+ preview_->connect([=](){ fileChanged(); });
if (isListings(params())) {
InsetListingsParams listing_params(to_utf8(p["lstparams"]));
InsetInclude::InsetInclude(InsetInclude const & other)
: InsetCommand(other), include_label(other.include_label),
- preview_(new RenderMonitoredPreview(this)), failedtoload_(false),
- set_label_(false), label_(0), child_buffer_(0)
+ preview_(make_unique<RenderMonitoredPreview>(this)), failedtoload_(false),
+ set_label_(false), label_(nullptr), child_buffer_(nullptr),
+ file_exist_(other.file_exist_),recursion_error_(other.recursion_error_)
{
- preview_->fileChanged(bind(&InsetInclude::fileChanged, this));
+ preview_->connect([=](){ fileChanged(); });
if (other.label_)
label_ = new InsetLabel(*other.label_);
InsetInclude::~InsetInclude()
{
- if (isBufferLoaded())
- 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;
+ label_ = nullptr;
} 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
- formats.edit(buffer(),
- support::makeAbsPath(file, support::onlyPath(buffer().absFileName())),
+ theFormats().edit(buffer(),
+ support::makeAbsPath(f, support::onlyPath(buffer().absFileName())),
"text");
}
void InsetInclude::setParams(InsetCommandParams const & p)
{
// invalidate the cache
- child_buffer_ = 0;
+ child_buffer_ = nullptr;
+
+ // reset in order to allow loading new file
+ failedtoload_ = false;
+ recursion_error_ = false;
InsetCommand::setParams(p);
set_label_ = false;
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 = listings_label_;
break;
case NONE:
- LASSERT(false, /**/);
+ LASSERT(false, temp = buffer().B_("Unknown"));
+ break;
}
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;
-}
-
-
-Buffer * InsetInclude::getChildBuffer() const
-{
- Buffer * childBuffer = loadIfNeeded();
-
- // FIXME: recursive includes
- return (childBuffer == &buffer()) ? 0 : childBuffer;
+ return pre.empty() ? temp : pre + from_ascii(" ") + temp;
}
// 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;
+ return nullptr;
FileName const included_file = includedFileName(buffer(), params());
// Use cached Buffer if possible.
- if (child_buffer_ != 0) {
+ if (child_buffer_ != nullptr) {
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 vanished, so invalidate cache and try to reload.
- child_buffer_ = 0;
+ child_buffer_ = nullptr;
}
if (!isLyXFileName(included_file.absFileName()))
- return 0;
+ return nullptr;
Buffer * child = theBufferList().getBuffer(included_file);
+ if (checkForRecursiveInclude(child))
+ return child;
+
if (!child) {
// the readonly flag can/will be wrong, not anymore I think.
- if (!included_file.exists())
- return 0;
+ if (!included_file.exists()) {
+ failedtoload_ = true;
+ return nullptr;
+ }
child = theBufferList().newBuffer(included_file.absFileName());
if (!child)
// Buffer creation is not possible.
- return 0;
+ return nullptr;
+ buffer().pushIncludedBuffer(child);
// Set parent before loading, such that macros can be tracked
child->setParent(&buffer());
if (child->loadLyXFile() != Buffer::ReadSuccess) {
failedtoload_ = true;
- child->setParent(0);
+ child->setParent(nullptr);
//close the buffer we just opened
theBufferList().release(child);
- return 0;
+ buffer().popIncludedBuffer();
+ return nullptr;
}
+ buffer().popIncludedBuffer();
if (!child->errorList("Parse").empty()) {
// FIXME: Do something.
}
}
-void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
+bool InsetInclude::checkForRecursiveInclude(
+ Buffer const * cbuf, bool silent) const
{
- string incfile = to_utf8(params()["filename"]);
+ if (recursion_error_)
+ return true;
- // Do nothing if no file name has been specified
- if (incfile.empty())
- return;
+ if (!buffer().isBufferIncluded(cbuf))
+ return false;
+
+ if (!silent) {
+ docstring const msg = _("The file\n%1$s\n has attempted to include itself.\n"
+ "The document set will not work properly until this is fixed!");
+ frontend::Alert::warning(_("Recursive Include"),
+ bformat(msg, from_utf8(cbuf->fileName().absFileName())));
+ }
+ recursion_error_ = true;
+ return true;
+}
- FileName const included_file = includedFileName(buffer(), params());
- // Check we're not trying to include ourselves.
- // FIXME RECURSIVE INCLUDE
- // This isn't sufficient, as the inclusion could be downstream.
- // But it'll have to do for now.
- if (isInputOrInclude(params()) &&
- buffer().absFileName() == included_file.absFileName())
- {
- Alert::error(_("Recursive input"),
- bformat(_("Attempted to include file %1$s in itself! "
- "Ignoring inclusion."), from_utf8(incfile)));
+void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
+{
+ 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());
Buffer const * const masterBuffer = buffer().masterBuffer();
// if incfile is relative, make it relative to the master
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)
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 "
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);
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: {
// 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
+ if (!isInputOrInclude(params()) ||
+ !isLyXFileName(included_file.absFileName())) {
+ // 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 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();
+ if (checksum_in != checksum_out) {
+ if (!included_file.copyTo(writefile)) {
+ // 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()))));
+ }
+ }
+ return;
+ }
- Buffer * tmp = loadIfNeeded();
- if (!tmp) {
+
+ // it's a LyX file and we're inputting or including, so
+ // try to load it so we can write the associated latex
+ Buffer * tmp = loadIfNeeded();
+ if (!tmp) {
+ if (!runparams.silent) {
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);
- return;
+ throw ExceptionMessage(ErrorException, _("Error: "),
+ text);
}
+ return;
+ }
+
+ if (recursion_error_)
+ return;
+ if (!runparams.silent) {
if (tmp->params().baseClass() != masterBuffer->params().baseClass()) {
// FIXME UNICODE
docstring text = bformat(_("Included file `%1$s'\n"
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);
+ }
+ 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
// FIXME It might be worth loading the children's modules into the master
// over in BufferParams rather than doing this check.
"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);
}
}
+ }
- tmp->markDepClean(masterBuffer->temppath());
-
- // 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)));
-
- // 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),
- // the children must be encoded in plain utf8!
- runparams.encoding = runparams.isFullUnicode() ?
- encodings.fromLyXName("utf8-plain")
- : &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)) {
+ tmp->markDepClean(masterBuffer->temppath());
+
+ // Don't assume the child's format is latex
+ string const inc_format = tmp->params().bufferFormat();
+ FileName const tmpwritefile(changeExtension(writefile.absFileName(),
+ 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 uses non-TeX fonts (XeTeX, LuaTeX),
+ // the children must be encoded in plain utf8!
+ 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;
+ 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.\nWarning: "
- "LaTeX export is probably incomplete."),
- included_file.displayName());
+ "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"),
- msg, el.begin()->error,
- el.begin()->description);
- Alert::warning(_("Export failure"), msg);
+ msg, el.begin()->error, el.begin()->description);
+ 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) {
- ErrorList el;
- bool const success =
- theConverters().convert(tmp, tmpwritefile, writefile,
- included_file,
- inc_format, tex_format, el);
-
- if (!success) {
- docstring msg = bformat(_("Included file `%1$s' "
- "was not exported correctly.\nWarning: "
- "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);
- }
- }
- } 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 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();
-
- if (checksum_in != checksum_out) {
- if (!included_file.copyTo(writefile)) {
- // 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()))));
- return;
- }
+ }
+ 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) {
+ ErrorList el;
+ Converters::RetVal const conv_retval =
+ theConverters().convert(tmp, tmpwritefile, writefile,
+ 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);
}
}
}
// 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"]));
+ ltrim(params()["filename"])));
return docstring();
}
// In the other cases, we will generate the HTML and include it.
- // Check we're not trying to include ourselves.
- // FIXME RECURSIVE INCLUDE
- if (buffer().absFileName() == included_file.absFileName()) {
- Alert::error(_("Recursive input"),
- bformat(_("Attempted to include file %1$s in itself! "
- "Ignoring inclusion."), params()["filename"]));
- return docstring();
- }
-
Buffer const * const ibuf = loadIfNeeded();
if (!ibuf)
return docstring();
+ if (recursion_error_)
+ 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();
}
int InsetInclude::plaintext(odocstringstream & os,
OutputParams const & op, size_t) const
{
- // just write the filename if we're making a tooltip or toc entry
- if (op.for_tooltip || op.for_toc) {
+ // 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]";
+ << 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
}
os << str;
return str.size();
}
+
+ if (recursion_error_)
+ return 0;
+
writePlaintextFile(*ibuf, os, op);
return 0;
}
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())
return 0;
string const included_file = includedFileName(buffer(), params()).absFileName();
-
- // Check we're not trying to include ourselves.
- // FIXME RECURSIVE INCLUDE
- // This isn't sufficient, as the inclusion could be downstream.
- // But it'll have to do for now.
- if (buffer().absFileName() == included_file) {
- Alert::error(_("Recursive input"),
- bformat(_("Attempted to include file %1$s in itself! "
- "Ignoring inclusion."), from_utf8(incfile)));
- return 0;
- }
-
string exppath = incfile;
if (!runparams.export_folder.empty()) {
exppath = makeAbsPath(exppath, runparams.export_folder).realPath();
Buffer * tmp = loadIfNeeded();
if (tmp) {
+ if (recursion_error_)
+ return 0;
+
string const mangled = writefile.mangledFileName();
writefile = makeAbsPath(mangled,
buffer().masterBuffer()->temppath());
void InsetInclude::validate(LaTeXFeatures & features) const
{
- string incfile = to_utf8(params()["filename"]);
- string writefile;
-
- LASSERT(&buffer() == &features.buffer(), /**/);
+ LATTEST(&buffer() == &features.buffer());
+ string incfile = ltrim(to_utf8(params()["filename"]));
string const included_file =
includedFileName(buffer(), params()).absFileName();
+ string writefile;
if (isLyXFileName(included_file))
writefile = changeExtension(included_file, ".sgml");
else
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
// to be loaded:
Buffer * const tmp = loadIfNeeded();
- if (tmp) {
- // the file is loaded
- // make sure the buffer isn't us
- // FIXME RECURSIVE INCLUDES
- // This is not sufficient, as recursive includes could be
- // more than a file away. But it will do for now.
- if (tmp && tmp != &buffer()) {
- // We must temporarily change features.buffer,
- // otherwise it would always be the master buffer,
- // and nested includes would not work.
- features.setBuffer(*tmp);
- features.runparams().is_child = true;
- tmp->validate(features);
- features.runparams().is_child = false;
- features.setBuffer(buffer());
- }
- }
+ if (!tmp)
+ return;
+
+ // the file is loaded
+ if (checkForRecursiveInclude(tmp))
+ return;
+ buffer().pushIncludedBuffer(tmp);
+
+ // We must temporarily change features.buffer,
+ // 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());
+
+ buffer().popIncludedBuffer();
}
-void InsetInclude::collectBibKeys(InsetIterator const & /*di*/) const
+void InsetInclude::collectBibKeys(InsetIterator const & /*di*/, FileNameList & checkedFiles) const
{
- Buffer * child = loadIfNeeded();
- if (!child)
+ Buffer * ibuf = loadIfNeeded();
+ if (!ibuf)
return;
- child->collectBibKeys();
+
+ if (checkForRecursiveInclude(ibuf))
+ return;
+ buffer().pushIncludedBuffer(ibuf);
+ ibuf->collectBibKeys(checkedFiles);
+ buffer().popIncludedBuffer();
}
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();
} else {
if (!set_label_) {
set_label_ = true;
- button_.update(screenLabel(), true);
+ button_.update(screenLabel(), true, false, !file_exist_ || recursion_error_);
}
button_.metrics(mi, dim);
}
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();
}
+void InsetInclude::write(ostream & os) const
+{
+ params().Write(os, &buffer());
+}
+
+
string InsetInclude::contextMenuName() const
{
return "context-include";
return;
preview_->removePreview(*buffer);
- add_preview(*preview_.get(), *this, *buffer);
+ add_preview(*preview_, *this, *buffer);
preview_->startLoading(*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);
+ OutputParams runparams(nullptr);
runparams.flavor = OutputParams::LATEX;
+ runparams.for_preview = true;
inset.latex(os, runparams);
return ods.str();
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*/,
}
-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 if (isVerbatim(params())) {
+ TocBuilder & b = backend.builder("child");
+ b.pushItem(cpit, screenLabel(), output_active);
+ b.pop();
+ } else {
+ Buffer const * const childbuffer = loadIfNeeded();
+
+ 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());
+ if (checkForRecursiveInclude(childbuffer))
+ return;
+ buffer().pushIncludedBuffer(childbuffer);
+ // 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);
+ buffer().popIncludedBuffer();
+ // Copy missing outliner names (though the user has been warned against
+ // having different document class and module selection between master
+ // and child).
+ for (auto const & name
+ : childbuffer->params().documentClass().outlinerNames())
+ backend.addName(name.first, translateIfPossible(name.second));
+ }
}
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)
+void InsetInclude::updateBuffer(ParIterator const & it, UpdateType utype, bool const deleted)
{
- button_.update(screenLabel(), true);
-
- Buffer const * const childbuffer = getChildBuffer();
+ file_exist_ = includedFileExist();
+ Buffer const * const childbuffer = loadIfNeeded();
if (childbuffer) {
- childbuffer->updateBuffer(Buffer::UpdateChildOnly, utype);
+ if (!checkForRecursiveInclude(childbuffer))
+ childbuffer->updateBuffer(Buffer::UpdateChildOnly, utype);
+ button_.update(screenLabel(), true, false, recursion_error_);
return;
}
+
+ button_.update(screenLabel(), true, false, !file_exist_);
+
if (!isListings(params()))
return;
if (label_)
- label_->updateBuffer(it, utype);
+ label_->updateBuffer(it, utype, deleted);
InsetListingsParams const par(to_utf8(params()["lstparams"]));
if (par.getParamValue("caption").empty()) {
}
+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