#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/lassert.h"
#include "support/lstrings.h" // contains
#include "support/lyxalgo.h"
+#include "support/mutex.h"
+#include "support/ExceptionMessage.h"
#include "support/bind.h"
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;
}
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"]));
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_);
InsetInclude::~InsetInclude()
{
if (isBufferLoaded())
- buffer().invalidateBibfileCache();
+ /* 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_;
}
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");
}
temp = listings_label_;
break;
case NONE:
- LASSERT(false, /**/);
+ LASSERT(false, temp = buffer().B_("Unknown"));
+ break;
}
temp += ": ";
{
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;
}
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);
+ string parameters = lstparams.params();
+ string language;
+ string caption;
+ string label;
+ string placement;
+ bool isfloat = lstparams.isFloat();
+ if (use_minted) {
+ // Get float placement, language, caption, and
+ // label, then remove the relative options.
+ vector<string> opts =
+ getVectorFromString(parameters, ",", false);
+ for (size_t i = 0; i < opts.size(); ++i) {
+ if (prefixIs(opts[i], "float")) {
+ if (prefixIs(opts[i], "float="))
+ placement = opts[i].substr(6);
+ opts.erase(opts.begin() + i--);
+ } else if (prefixIs(opts[i], "language=")) {
+ language = opts[i].substr(9);
+ opts.erase(opts.begin() + i--);
+ } else if (prefixIs(opts[i], "caption=")) {
+ caption = opts[i].substr(8);
+ opts.erase(opts.begin() + i--);
+ } else if (prefixIs(opts[i], "label=")) {
+ label = opts[i].substr(6);
+ opts.erase(opts.begin() + i--);
+ }
+ }
+ if (!label.empty()) {
+ if (isfloat || !caption.empty())
+ label = trim(label, "{}");
+ else
+ opts.push_back("label=" + label);
+ }
+ parameters = getStringFromVector(opts, ",");
+ }
+ if (language.empty())
+ language = "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: {
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);
+ }
}
}
// 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.is_child = true;
if (!tmp->makeLaTeXFile(tmpwritefile, masterFileName(buffer()).
onlyPath().absFileName(), runparams, Buffer::OnlyBody)) {
- docstring msg = bformat(_("Included file `%1$s' "
- "was not exported correctly.\nWarning: "
+ 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;
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 {
// 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"]));
int InsetInclude::plaintext(odocstringstream & os,
OutputParams const & op, size_t) const
{
- // don't write the file just because we're making a tooltip or toc entry!!
- if (op.for_tooltip || op.for_toc || 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]";
+ // 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.
+ << includedFileName(buffer(), params()).fileContents("UTF-8")
+ << "\n]";
return PLAINTEXT_NEWLINE + 1; // one char on a separate line
}
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
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
// 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 = false;
+ features.runparams().is_child = is_child;
features.setBuffer(buffer());
}
}
Buffer * child = loadIfNeeded();
if (!child)
return;
+ // 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();
}
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);
}
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);
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);
}
-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 {
+ 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));
- 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<string, docstring> const & name
+ : childbuffer->params().documentClass().outlinerNames())
+ backend.addName(name.first, translateIfPossible(name.second));
+ }
}
void InsetInclude::updateBuffer(ParIterator const & it, UpdateType utype)
{
- button_.update(screenLabel(), true);
+ button_.update(screenLabel(), true, false);
Buffer const * const childbuffer = getChildBuffer();
if (childbuffer) {
projects / lyx.git / blobdiff