* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author Richard Heck (conversion to InsetCommand)
*
* Full author contact details are available in file CREDITS.
#include "InsetInclude.h"
-#include "LayoutFile.h"
#include "Buffer.h"
#include "buffer_funcs.h"
#include "BufferList.h"
#include "DispatchResult.h"
#include "ErrorList.h"
#include "Exporter.h"
+#include "Format.h"
#include "FuncRequest.h"
#include "FuncStatus.h"
#include "LaTeXFeatures.h"
+#include "LayoutFile.h"
+#include "LayoutModuleList.h"
#include "LyX.h"
+#include "LyXFunc.h"
#include "LyXRC.h"
#include "Lexer.h"
#include "MetricsInfo.h"
+#include "output_xhtml.h"
#include "OutputParams.h"
#include "TextClass.h"
#include "TocBackend.h"
#include "insets/InsetListingsParams.h"
#include "insets/RenderPreview.h"
-#include "support/assert.h"
+#include "support/convert.h"
#include "support/debug.h"
#include "support/docstream.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/convert.h"
#include <boost/bind.hpp>
}
-InsetLabel * createLabel(docstring const & label_str)
+InsetLabel * createLabel(Buffer * buf, docstring const & label_str)
{
if (label_str.empty())
return 0;
InsetCommandParams icp(LABEL_CODE);
icp["name"] = label_str;
- return new InsetLabel(icp);
+ return new InsetLabel(buf, icp);
}
} // namespace anon
-InsetInclude::InsetInclude(InsetCommandParams const & p)
- : InsetCommand(p, "include"), include_label(uniqueID()),
- preview_(new RenderMonitoredPreview(this)), set_label_(false), label_(0)
+InsetInclude::InsetInclude(Buffer * buf, InsetCommandParams const & p)
+ : InsetCommand(buf, p, "include"), include_label(uniqueID()),
+ preview_(new RenderMonitoredPreview(this)), failedtoload_(false),
+ set_label_(false), label_(0), child_buffer_(0)
{
preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
if (isListings(params())) {
InsetListingsParams listing_params(to_utf8(p["lstparams"]));
- label_ = createLabel(from_utf8(listing_params.getParamValue("label")));
+ label_ = createLabel(buffer_, from_utf8(listing_params.getParamValue("label")));
}
}
InsetInclude::InsetInclude(InsetInclude const & other)
: InsetCommand(other), include_label(other.include_label),
- preview_(new RenderMonitoredPreview(this)), set_label_(false), label_(0)
+ preview_(new RenderMonitoredPreview(this)), failedtoload_(false),
+ set_label_(false), label_(0), child_buffer_(0)
{
preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
InsetInclude::~InsetInclude()
{
delete label_;
- if (isVerbatim(params()) || isListings(params()))
- return;
-
-
- string const parent_filename = buffer().absFileName();
- FileName const included_file = makeAbsPath(to_utf8(params()["filename"]),
- onlyPath(parent_filename));
-
- if (!isLyXFilename(included_file.absFilename()))
- return;
-
- Buffer * child = theBufferList().getBuffer(included_file.absFilename());
- // File not opened, nothing to close.
- if (!child)
- return;
-
- // Child document has a different parent, don't close it.
- if (child->parent() != &buffer())
- return;
-
- //close the buffer.
- theBufferList().release(child);
}
void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
{
- LASSERT(&cur.buffer() == &buffer(), /**/);
switch (cmd.action) {
+ case LFUN_INSET_EDIT: {
+ editIncluded(to_utf8(params()["filename"]));
+ break;
+ }
+
case LFUN_INSET_MODIFY: {
+ // It should be OK just to invalidate the cache is setParams()
+ // If not....
+ // child_buffer_ = 0;
InsetCommandParams p(INCLUDE_CODE);
- InsetCommand::string2params("include", to_utf8(cmd.argument()), p);
+ if (cmd.getArg(0) == "changetype") {
+ InsetCommand::doDispatch(cur, cmd);
+ p = params();
+ } else
+ InsetCommand::string2params("include", to_utf8(cmd.argument()), p);
if (!p.getCmdName().empty()) {
if (isListings(p)){
InsetListingsParams new_params(to_utf8(p["lstparams"]));
- docstring const label_str = from_utf8(new_params.getParamValue("label"));
- if (label_str.empty())
+ docstring const new_label =
+ from_utf8(new_params.getParamValue("label"));
+
+ if (new_label.empty()) {
delete label_;
- else if (label_)
- label_->updateCommand(label_str);
- else {
- label_ = createLabel(label_str);
- label_->setBuffer(buffer());
- label_->initView();
+ label_ = 0;
+ } else {
+ docstring old_label;
+ if (label_)
+ old_label = label_->getParam("name");
+ else {
+ label_ = createLabel(buffer_, new_label);
+ label_->setBuffer(buffer());
+ }
+
+ if (new_label != old_label) {
+ label_->updateCommand(new_label);
+ // the label might have been adapted (duplicate)
+ if (new_label != label_->getParam("name")) {
+ new_params.addParam("label", "{" +
+ to_utf8(label_->getParam("name")) + "}", true);
+ p["lstparams"] = from_utf8(new_params.params());
+ }
+ }
}
}
setParams(p);
}
+void InsetInclude::editIncluded(string const & file)
+{
+ string const ext = support::getExtension(file);
+ if (ext == "lyx") {
+ FuncRequest fr(LFUN_BUFFER_CHILD_OPEN, file);
+ lyx::dispatch(fr);
+ } else
+ // tex file or other text file in verbatim mode
+ formats.edit(buffer(),
+ support::makeAbsPath(file, support::onlyPath(buffer().absFileName())),
+ "text");
+}
+
+
+bool InsetInclude::getStatus(Cursor & cur, FuncRequest const & cmd,
+ FuncStatus & flag) const
+{
+ switch (cmd.action) {
+
+ case LFUN_INSET_EDIT:
+ flag.setEnabled(true);
+ return true;
+
+ case LFUN_INSET_MODIFY:
+ if (cmd.getArg(0) == "changetype")
+ return InsetCommand::getStatus(cur, cmd, flag);
+ else
+ flag.setEnabled(true);
+ return true;
+
+ default:
+ return InsetCommand::getStatus(cur, cmd, flag);
+ }
+}
+
+
void InsetInclude::setParams(InsetCommandParams const & p)
{
+ // invalidate the cache
+ child_buffer_ = 0;
+
InsetCommand::setParams(p);
set_label_ = false;
}
-/// return the child buffer if the file is a LyX doc and is loaded
-Buffer * getChildBuffer(Buffer const & buffer, InsetCommandParams const & params)
+Buffer * InsetInclude::getChildBuffer() const
{
- if (isVerbatim(params) || isListings(params))
- return 0;
-
- string const included_file = includedFilename(buffer, params).absFilename();
- if (!isLyXFilename(included_file))
- return 0;
-
- Buffer * childBuffer = loadIfNeeded(buffer, params);
+ Buffer * childBuffer = loadIfNeeded();
// FIXME: recursive includes
- return (childBuffer == &buffer) ? 0 : childBuffer;
+ return (childBuffer == &buffer()) ? 0 : childBuffer;
}
-/// return true if the file is or got loaded.
-Buffer * loadIfNeeded(Buffer const & parent, InsetCommandParams const & params)
+Buffer * InsetInclude::loadIfNeeded() const
{
- if (isVerbatim(params) || isListings(params))
+ // Don't try to load it again if we failed before.
+ if (failedtoload_ || isVerbatim(params()) || isListings(params()))
return 0;
- string const parent_filename = parent.absFileName();
- FileName const included_file = makeAbsPath(to_utf8(params["filename"]),
- onlyPath(parent_filename));
+ // Use cached Buffer if possible.
+ if (child_buffer_ != 0) {
+ if (theBufferList().isLoaded(child_buffer_))
+ return child_buffer_;
+ // Buffer vanished, so invalidate cache and try to reload.
+ child_buffer_ = 0;
+ }
+
+ string const parent_filename = buffer().absFileName();
+ FileName const included_file =
+ makeAbsPath(to_utf8(params()["filename"]), onlyPath(parent_filename));
if (!isLyXFilename(included_file.absFilename()))
return 0;
- Buffer * child = theBufferList().getBuffer(included_file.absFilename());
+ Buffer * child = theBufferList().getBuffer(included_file);
if (!child) {
// the readonly flag can/will be wrong, not anymore I think.
if (!included_file.exists())
return 0;
if (!child->loadLyXFile(included_file)) {
+ failedtoload_ = true;
//close the buffer we just opened
theBufferList().release(child);
return 0;
// FIXME: Do something.
}
}
- child->setParent(&parent);
+ child->setParent(&buffer());
+ // Cache the child buffer.
+ child_buffer_ = child;
return child;
}
// if incfile is relative, make it relative to the master
// buffer directory.
- if (!FileName(incfile).isAbsolute()) {
+ if (!FileName::isAbsolute(incfile)) {
// FIXME UNICODE
incfile = to_utf8(makeRelPath(from_utf8(included_file.absFilename()),
from_utf8(masterBuffer->filePath())));
}
// write it to a file (so far the complete file)
- string const exportfile = changeExtension(incfile, ".tex");
- string const mangled =
- DocFileName(changeExtension(included_file.absFilename(),".tex")).
+ string exportfile;
+ string mangled;
+ // bug 5681
+ if (type(params()) == LISTINGS) {
+ exportfile = incfile;
+ mangled = DocFileName(included_file).mangledFilename();
+ } else {
+ exportfile = changeExtension(incfile, ".tex");
+ mangled = DocFileName(changeExtension(included_file.absFilename(), ".tex")).
mangledFilename();
+ }
+
FileName const writefile(makeAbsPath(mangled, masterBuffer->temppath()));
if (!runparams.nice)
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 (!loadIfNeeded(buffer(), params()))
+ if (!loadIfNeeded())
return false;
- Buffer * tmp = theBufferList().getBuffer(included_file.absFilename());
+ Buffer * tmp = theBufferList().getBuffer(included_file);
if (tmp->params().baseClass() != masterBuffer->params().baseClass()) {
// FIXME UNICODE
included_file.displayName(),
from_utf8(tmp->params().documentClass().name()),
from_utf8(masterBuffer->params().documentClass().name()));
- Alert::warning(_("Different textclasses"), text);
+ 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.
- vector<string> const masterModules = masterBuffer->params().getModules();
- vector<string> const childModules = tmp->params().getModules();
- vector<string>::const_iterator it = childModules.begin();
- vector<string>::const_iterator end = childModules.end();
+ // 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;
- vector<string>::const_iterator found =
+ LayoutModuleList::const_iterator found =
find(masterModules.begin(), masterModules.end(), module);
if (found == masterModules.end()) {
docstring text = bformat(_("Included file `%1$s'\n"
tmp->markDepClean(masterBuffer->temppath());
-// 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)
+ // 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;
runparams.encoding = &tmp->params().encoding();
+ runparams.master_language = buffer().params().language;
tmp->makeLaTeXFile(writefile,
masterFileName(buffer()).onlyPath().absFilename(),
runparams, false);
runparams.encoding = oldEnc;
+ runparams.master_language = oldLang;
} 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
string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
"latex" : "pdflatex";
- if (isVerbatim(params())) {
+ switch (type(params())) {
+ case VERB:
+ case VERBAST: {
incfile = latex_path(incfile);
// FIXME UNICODE
os << '\\' << from_ascii(params().getCmdName()) << '{'
<< from_utf8(incfile) << '}';
- } else if (type(params()) == INPUT) {
+ break;
+ }
+ case INPUT: {
runparams.exportdata->addExternalFile(tex_format, writefile,
exportfile);
os << '\\' << from_ascii(params().getCmdName())
<< '{' << from_utf8(incfile) << '}';
}
- } else if (type(params()) == LISTINGS) {
+ 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.
if (!params.params().empty())
os << "[" << from_utf8(params.params()) << "]";
os << '{' << from_utf8(incfile) << '}';
- } else {
+ break;
+ }
+ case INCLUDE: {
runparams.exportdata->addExternalFile(tex_format, writefile,
exportfile);
// FIXME UNICODE
os << '\\' << from_ascii(params().getCmdName()) << '{'
<< from_utf8(incfile) << '}';
+ break;
+ }
+ case NONE:
+ break;
}
return 0;
}
+docstring InsetInclude::xhtml(XHTMLStream & xs, OutputParams const &rp) const
+{
+ if (rp.inComment)
+ return docstring();
+
+ // For verbatim and listings, we just include the contents of the file as-is.
+ // In the case of listings, we wrap it in <pre>.
+ bool const listing = isListings(params());
+ if (listing || isVerbatim(params())) {
+ if (listing)
+ xs << StartTag("pre");
+ // FIXME: We don't know the encoding of the file, default to UTF-8.
+ xs << includedFilename(buffer(), params()).fileContents("UTF-8");
+ if (listing)
+ xs << EndTag("pre");
+ return docstring();
+ }
+
+ // We don't (yet) know how to Input or Include non-LyX files.
+ // (If we wanted to get really arcane, we could run some tex2html
+ // converter on the included file. But that's just masochistic.)
+ string const parent_filename = buffer().absFileName();
+ FileName const included_file =
+ makeAbsPath(to_utf8(params()["filename"]), onlyPath(parent_filename));
+ if (!isLyXFilename(included_file.absFilename())) {
+ 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"]));
+ 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();
+ ibuf->writeLyXHTMLSource(xs.os(), rp, true);
+ return docstring();
+}
+
+
int InsetInclude::plaintext(odocstream & os, OutputParams const &) const
{
if (isVerbatim(params()) || isListings(params())) {
string const exportfile = changeExtension(incfile, ".sgml");
DocFileName writefile(changeExtension(included_file, ".sgml"));
- if (loadIfNeeded(buffer(), params())) {
- Buffer * tmp = theBufferList().getBuffer(included_file);
+ if (loadIfNeeded()) {
+ Buffer * tmp = theBufferList().getBuffer(FileName(included_file));
string const mangled = writefile.mangledFilename();
writefile = makeAbsPath(mangled,
// Here we must do the fun stuff...
// Load the file in the include if it needs
// to be loaded:
- if (loadIfNeeded(buffer(), params())) {
+ if (loadIfNeeded()) {
// a file got loaded
- Buffer * const tmp = theBufferList().getBuffer(included_file);
+ Buffer * const tmp = theBufferList().getBuffer(FileName(included_file));
// make sure the buffer isn't us
// FIXME RECURSIVE INCLUDES
// This is not sufficient, as recursive includes could be
void InsetInclude::fillWithBibKeys(BiblioInfo & keys,
InsetIterator const & /*di*/) const
{
- if (loadIfNeeded(buffer(), params())) {
+ if (loadIfNeeded()) {
string const included_file = includedFilename(buffer(), params()).absFilename();
- Buffer * tmp = theBufferList().getBuffer(included_file);
+ Buffer * tmp = theBufferList().getBuffer(FileName(included_file));
BiblioInfo const & newkeys = tmp->localBibInfo();
keys.mergeBiblioInfo(newkeys);
}
void InsetInclude::updateBibfilesCache()
{
- Buffer * const tmp = getChildBuffer(buffer(), params());
- if (tmp) {
- tmp->setParent(0);
- tmp->updateBibfilesCache();
- tmp->setParent(&buffer());
- }
+ Buffer const * const child = getChildBuffer();
+ if (child)
+ child->updateBibfilesCache(Buffer::UpdateChildOnly);
}
support::FileNameList const &
- InsetInclude::getBibfilesCache(Buffer const & buffer) const
+ InsetInclude::getBibfilesCache() const
{
- Buffer * const tmp = getChildBuffer(buffer, params());
- if (tmp) {
- tmp->setParent(0);
- support::FileNameList const & cache = tmp->getBibfilesCache();
- tmp->setParent(&buffer);
- return cache;
- }
+ Buffer const * const child = getChildBuffer();
+ if (child)
+ return child->getBibfilesCache(Buffer::UpdateChildOnly);
+
static support::FileNameList const empty;
return empty;
}
}
+docstring InsetInclude::contextMenu(BufferView const &, int, int) const
+{
+ return from_ascii("context-include");
+}
+
+
Inset::DisplayType InsetInclude::display() const
{
return type(params()) == INPUT ? Inline : AlignCenter;
} // namespace anon
-void InsetInclude::addPreview(graphics::PreviewLoader & ploader) const
+void InsetInclude::addPreview(DocIterator const & /*inset_pos*/,
+ graphics::PreviewLoader & ploader) const
{
Buffer const & buffer = ploader.buffer();
if (!preview_wanted(params(), buffer))
}
-void InsetInclude::addToToc(ParConstIterator const & cpit) const
+void InsetInclude::addToToc(DocIterator const & cpit)
{
TocBackend & backend = buffer().tocBackend();
Toc & toc = backend.toc("listing");
docstring str = convert<docstring>(toc.size() + 1)
+ ". " + from_utf8(caption);
- ParConstIterator pit = cpit;
- pit.push_back(*this);
+ DocIterator pit = cpit;
toc.push_back(TocItem(pit, 0, str));
return;
}
- Buffer const * const childbuffer = getChildBuffer(buffer(), params());
+ Buffer const * const childbuffer = getChildBuffer();
if (!childbuffer)
return;
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();
}
-void InsetInclude::updateLabels(ParIterator const & it)
+void InsetInclude::updateCommand()
+{
+ if (!label_)
+ return;
+
+ docstring old_label = label_->getParam("name");
+ label_->updateCommand(old_label, false);
+ // the label might have been adapted (duplicate)
+ docstring new_label = label_->getParam("name");
+ if (old_label == new_label)
+ return;
+
+ // update listings parameters...
+ InsetCommandParams p(INCLUDE_CODE);
+ p = params();
+ InsetListingsParams par(to_utf8(params()["lstparams"]));
+ par.addParam("label", "{" + to_utf8(new_label) + "}", true);
+ p["lstparams"] = from_utf8(par.params());
+ setParams(p);
+}
+
+void InsetInclude::updateLabels(ParIterator const & it, bool out)
{
- Buffer const * const childbuffer = getChildBuffer(buffer(), params());
+ Buffer const * const childbuffer = getChildBuffer();
if (childbuffer) {
- lyx::updateLabels(*childbuffer, true);
+ childbuffer->updateLabels(Buffer::UpdateChildOnly, out);
return;
}
if (!isListings(params()))
return;
if (label_)
- label_->updateLabels(it);
+ label_->updateLabels(it, out);
InsetListingsParams const par(to_utf8(params()["lstparams"]));
if (par.getParamValue("caption").empty()) {
- listings_label_.clear();
+ listings_label_ = buffer().B_("Program Listing");
return;
}
- Counters & counters = buffer().params().documentClass().counters();
+ Buffer const & master = *buffer().masterBuffer();
+ Counters & counters = master.params().documentClass().counters();
docstring const cnt = from_ascii("listing");
- listings_label_ = buffer().B_("Program Listing");
+ listings_label_ = master.B_("Program Listing");
if (counters.hasCounter(cnt)) {
counters.step(cnt);
listings_label_ += " " + convert<docstring>(counters.value(cnt));
projects / lyx.git / blobdiff