#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);
}
bool isInputOrInclude(InsetCommandParams const & params)
{
Types const t = type(params);
- return t == INPUT || t == INCLUDE;
+ return t == INPUT || t == INCLUDE;
}
}
if (new_label != old_label) {
- label_->updateCommand(new_label);
+ label_->updateLabelAndRefs(new_label, &cur);
// the label might have been adapted (duplicate)
if (new_label != label_->getParam("name")) {
new_params.addParam("label", "{" +
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;
}
from_utf8(masterBuffer->filePath())));
}
+ 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)
string exportfile;
string mangled;
// bug 5681
if (type(params()) == LISTINGS) {
- exportfile = incfile;
+ exportfile = exppath;
mangled = DocFileName(included_file).mangledFileName();
} else {
- exportfile = changeExtension(incfile, ".tex");
+ exportfile = changeExtension(exppath, ".tex");
mangled = DocFileName(changeExtension(included_file.absFileName(), ".tex")).
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: {
+ 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;
+ }
+
+ 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());
+ Alert::warning(_("Missing included file"), 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);
+ }
}
}
formats.extension(inc_format)));
// FIXME: handle non existing files
- // FIXME: Second argument is irrelevant!
- // since only_body is true, makeLaTeXFile will not look at second
- // argument. Should we set it to string(), or should makeLaTeXFile
- // make use of it somehow? (JMarc 20031002)
// 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();
+ runparams.is_child = true;
if (!tmp->makeLaTeXFile(tmpwritefile, masterFileName(buffer()).
- onlyPath().absFileName(), runparams, false)) {
- docstring msg = bformat(_("Included file `%1$s' "
- "was not exported correctly.\nWarning: "
+ 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) {
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 input@path, see ../Buffer.cpp.
+ // 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();
// 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: {
- 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;
- }
}
// 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"]));
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
<< "<!-- Included file: "
}
-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;
}
return 0;
}
+ 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)
- string const exportfile = changeExtension(incfile, ".sgml");
+ string const exportfile = changeExtension(exppath, ".sgml");
DocFileName writefile(changeExtension(included_file, ".sgml"));
Buffer * tmp = loadIfNeeded();
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,
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.includeFile(include_label, writefile);
+ features.useInsetLayout(getLayout());
if (isVerbatim(params()))
features.require("verbatim");
else if (isListings(params()))
// 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 * 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();
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();
}
-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";
}
}
+docstring InsetInclude::layoutName() const
+{
+ if (isListings(params()))
+ return from_ascii("IncludeListings");
+ return InsetCommand::layoutName();
+}
+
//
// preview stuff
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) const
{
- TocBackend & backend = buffer().tocBackend();
-
if (isListings(params())) {
if (label_)
- label_->addToToc(cpit);
-
+ label_->addToToc(cpit, output_active, utype);
+ TocBuilder & b = buffer().tocBackend().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 = buffer().tocBackend().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());
+ // Include Tocs from children
+ childbuffer->tocBackend().update(output_active, utype);
+ for(auto const & pair : childbuffer->tocBackend().tocs()) {
+ string const & type = pair.first;
+ shared_ptr<Toc> child_toc = pair.second;
+ shared_ptr<Toc> toc = buffer().tocBackend().toc(type);
+ toc->insert(toc->end(), child_toc->begin(), child_toc->end());
+ }
+ }
}
return;
docstring old_label = label_->getParam("name");
- label_->updateCommand(old_label, false);
+ label_->updateLabel(old_label);
// the label might have been adapted (duplicate)
docstring new_label = label_->getParam("name");
if (old_label == new_label)
setParams(p);
}
+
void InsetInclude::updateBuffer(ParIterator const & it, UpdateType utype)
{
+ button_.update(screenLabel(), true);
+
Buffer const * const childbuffer = getChildBuffer();
if (childbuffer) {
childbuffer->updateBuffer(Buffer::UpdateChildOnly, utype);