#include "InsetInclude.h"
+#include "LayoutFile.h"
#include "Buffer.h"
#include "buffer_funcs.h"
#include "BufferList.h"
#include "BufferView.h"
#include "Cursor.h"
#include "DispatchResult.h"
+#include "ErrorList.h"
#include "Exporter.h"
#include "FuncRequest.h"
#include "FuncStatus.h"
#include "graphics/PreviewImage.h"
#include "graphics/PreviewLoader.h"
-#include "insets/RenderPreview.h"
+#include "insets/InsetLabel.h"
#include "insets/InsetListingsParams.h"
+#include "insets/RenderPreview.h"
#include "support/debug.h"
#include "support/docstream.h"
EmbeddedFile file(to_utf8(params["filename"]),
onlyPath(parentFilename(buffer)));
file.setEmbed(!params["embed"].empty());
- file.enable(buffer.embedded(), &buffer);
+ file.setInzipName(to_utf8(params["embed"]));
+ file.enable(buffer.embedded(), &buffer, false);
return file;
}
+InsetLabel * createLabel(docstring const & label_str)
+{
+ if (label_str.empty())
+ return 0;
+ InsetCommandParams icp(LABEL_CODE);
+ icp["name"] = label_str;
+ return new InsetLabel(icp);
+}
+
} // namespace anon
InsetInclude::InsetInclude(InsetCommandParams const & p)
: InsetCommand(p, "include"), include_label(uniqueID()),
- preview_(new RenderMonitoredPreview(this)), set_label_(false)
+ preview_(new RenderMonitoredPreview(this)), set_label_(false), label_(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")));
+ }
}
InsetInclude::InsetInclude(InsetInclude const & other)
: InsetCommand(other), include_label(other.include_label),
- preview_(new RenderMonitoredPreview(this)), set_label_(false)
+ preview_(new RenderMonitoredPreview(this)), set_label_(false), label_(0)
{
preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
+
+ if (other.label_)
+ label_ = new InsetLabel(*other.label_);
+}
+
+
+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::setBuffer(Buffer & buffer)
+{
+ if (buffer_) {
+ try {
+ EmbeddedFile file_from = includedFilename(*buffer_, params());
+ EmbeddedFile file_to = file_from.copyTo(&buffer);
+ if (file_to.embedded())
+ setParam("embed", from_utf8(file_to.inzipName()));
+ } catch (ExceptionMessage const & message) {
+ Alert::error(message.title_, message.details_);
+ // failed to embed
+ setParam("embed", docstring());
+ }
+
+ }
+ buffer_ = &buffer;
+ if (label_)
+ label_->setBuffer(buffer);
+
}
// In the other cases, this second parameter should just be empty.
static ParamInfo param_info_;
if (param_info_.empty()) {
- param_info_.add("filename", false);
- param_info_.add("embed", false);
- param_info_.add("lstparams", true);
+ param_info_.add("filename", ParamInfo::LATEX_REQUIRED);
+ param_info_.add("lstparams", ParamInfo::LATEX_OPTIONAL);
+ param_info_.add("embed", ParamInfo::LYX_INTERNAL);
}
return param_info_;
}
void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
{
+ BOOST_ASSERT(&cur.buffer() == &buffer());
switch (cmd.action) {
case LFUN_INSET_MODIFY: {
InsetCommandMailer::string2params("include", to_utf8(cmd.argument()), p);
if (!p.getCmdName().empty()) {
if (isListings(p)){
- InsetListingsParams par_old(to_utf8(params()["lstparams"]));
- InsetListingsParams par_new(to_utf8(p["lstparams"]));
- if (par_old.getParamValue("label") !=
- par_new.getParamValue("label")
- && !par_new.getParamValue("label").empty())
- cur.bv().buffer().changeRefsIfUnique(
- from_utf8(par_old.getParamValue("label")),
- from_utf8(par_new.getParamValue("label")),
- REF_CODE);
+ InsetListingsParams new_params(to_utf8(p["lstparams"]));
+ docstring const label_str = from_utf8(new_params.getParamValue("label"));
+ if (label_str.empty())
+ delete label_;
+ else if (label_)
+ label_->updateCommand(label_str);
+ else {
+ label_ = createLabel(label_str);
+ label_->setBuffer(buffer());
+ label_->initView();
+ }
}
- try {
- // the embed parameter passed back from the dialog
- // is "true" or "false", we need to change it.
- if (p["embed"] == _("false"))
- p["embed"].clear();
- else
- p["embed"] = from_utf8(EmbeddedFile(to_utf8(p["filename"]),
- onlyPath(parentFilename(cur.buffer()))).inzipName());
- // test parameter
- includedFilename(cur.buffer(), p);
- } catch (ExceptionMessage const & message) {
- Alert::error(message.title_, message.details_);
- // do not set parameter if an error happens
- break;
- }
- set(p, cur.buffer());
- cur.buffer().updateBibfilesCache();
+ setParams(p);
+ buffer().updateBibfilesCache();
} else
cur.noUpdate();
break;
}
-void InsetInclude::set(InsetCommandParams const & p, Buffer const & buffer)
+void InsetInclude::setParams(InsetCommandParams const & p)
{
- setParams(p);
+ InsetCommand::setParams(p);
set_label_ = false;
if (preview_->monitoring())
preview_->stopMonitoring();
if (type(params()) == INPUT)
- add_preview(*preview_, *this, buffer);
+ add_preview(*preview_, *this, buffer());
}
-Inset * InsetInclude::clone() const
-{
- return new InsetInclude(*this);
-}
-
-
-docstring const InsetInclude::getScreenLabel(Buffer const & buf) const
+docstring InsetInclude::screenLabel() const
{
docstring temp;
switch (type(params())) {
case INPUT:
- temp = buf.B_("Input");
+ temp = buffer().B_("Input");
break;
case VERB:
- temp = buf.B_("Verbatim Input");
+ temp = buffer().B_("Verbatim Input");
break;
case VERBAST:
- temp = buf.B_("Verbatim Input*");
+ temp = buffer().B_("Verbatim Input*");
break;
case INCLUDE:
- temp = buf.B_("Include");
+ temp = buffer().B_("Include");
break;
case LISTINGS:
temp = listings_label_;
}
- /// return the child buffer if the file is a LyX doc and is loaded
+/// return the child buffer if the file is a LyX doc and is loaded
Buffer * getChildBuffer(Buffer const & buffer, InsetCommandParams const & params)
{
if (isVerbatim(params) || isListings(params))
if (!isLyXFilename(included_file))
return 0;
- Buffer * childBuffer = theBufferList().getBuffer(included_file);
+ Buffer * childBuffer = loadIfNeeded(buffer, params);
- //FIXME RECURSIVE INCLUDES
- if (childBuffer == & buffer)
- return 0;
- else
- return childBuffer;
+ // FIXME: recursive includes
+ return (childBuffer == &buffer) ? 0 : childBuffer;
}
+
/// return true if the file is or got loaded.
Buffer * loadIfNeeded(Buffer const & parent, InsetCommandParams const & params)
{
theBufferList().release(child);
return 0;
}
+
+ if (!child->errorList("Parse").empty()) {
+ // FIXME: Do something.
+ }
}
child->setParent(&parent);
return child;
}
-void resetParentBuffer(Buffer const * parent, InsetCommandParams const & params,
- bool close_it)
+int InsetInclude::latex(odocstream & os, OutputParams const & runparams) const
{
- if (isVerbatim(params) || isListings(params))
- return;
-
- string const parent_filename = parent->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() != parent)
- return;
-
- //close the buffer.
- child->setParent(0);
- if (close_it)
- theBufferList().release(child);
- else
- updateLabels(*child);
-}
-
-
-int InsetInclude::latex(Buffer const & buffer, odocstream & os,
- OutputParams const & runparams) const
-{
- string incfile(to_utf8(params()["filename"]));
+ string incfile = to_utf8(params()["filename"]);
// Do nothing if no file name has been specified
if (incfile.empty())
return 0;
- FileName const included_file = includedFilename(buffer, params()).availableFile();
+ FileName const included_file =
+ includedFilename(buffer(), params()).availableFile();
- //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.
+ // 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())
+ buffer().absFileName() == included_file.absFilename())
{
Alert::error(_("Recursive input"),
bformat(_("Attempted to include file %1$s in itself! "
return 0;
}
- Buffer const * const masterBuffer = buffer.masterBuffer();
+ Buffer const * const masterBuffer = buffer().masterBuffer();
// if incfile is relative, make it relative to the master
// buffer directory.
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(buffer(), params()))
return false;
Buffer * tmp = theBufferList().getBuffer(included_file.absFilename());
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().textClass().name()),
- from_utf8(masterBuffer->params().textClass().name()));
+ "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);
- //return 0;
}
// Make sure modules used in child are all included in master
string const module = *it;
vector<string>::const_iterator found =
find(masterModules.begin(), masterModules.end(), module);
- if (found != masterModules.end()) {
+ 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));
+ "uses module `%2$s'\n"
+ "which is not used in parent file."),
+ included_file.displayName(), from_utf8(module));
Alert::warning(_("Module not found"), text);
}
}
Encoding const * const oldEnc = runparams.encoding;
runparams.encoding = &tmp->params().encoding();
tmp->makeLaTeXFile(writefile,
- masterFileName(buffer).onlyPath().absFilename(),
+ masterFileName(buffer()).onlyPath().absFilename(),
runparams, false);
runparams.encoding = oldEnc;
} else {
}
-int InsetInclude::plaintext(Buffer const & buffer, odocstream & os,
- OutputParams const &) const
+int InsetInclude::plaintext(odocstream & os, OutputParams const &) const
{
if (isVerbatim(params()) || isListings(params())) {
- os << '[' << getScreenLabel(buffer) << '\n';
+ 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 << includedFilename(buffer(), params()).fileContents("UTF-8");
os << "\n]";
return PLAINTEXT_NEWLINE + 1; // one char on a separate line
} else {
- docstring const str = '[' + getScreenLabel(buffer) + ']';
+ docstring const str = '[' + screenLabel() + ']';
os << str;
return str.size();
}
}
-int InsetInclude::docbook(Buffer const & buffer, odocstream & os,
- OutputParams const & runparams) const
+int InsetInclude::docbook(odocstream & os, OutputParams const & runparams) const
{
string incfile = to_utf8(params()["filename"]);
if (incfile.empty())
return 0;
- string const included_file = includedFilename(buffer, params()).absFilename();
+ 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) {
+ // 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)));
string const exportfile = changeExtension(incfile, ".sgml");
DocFileName writefile(changeExtension(included_file, ".sgml"));
- if (loadIfNeeded(buffer, params())) {
+ if (loadIfNeeded(buffer(), params())) {
Buffer * tmp = theBufferList().getBuffer(included_file);
string const mangled = writefile.mangledFilename();
writefile = makeAbsPath(mangled,
- buffer.masterBuffer()->temppath());
+ buffer().masterBuffer()->temppath());
if (!runparams.nice)
incfile = mangled;
string incfile = to_utf8(params()["filename"]);
string writefile;
- Buffer const & buffer = features.buffer();
+ BOOST_ASSERT(&buffer() == &features.buffer());
- string const included_file = includedFilename(buffer, params()).availableFile().absFilename();
+ string const included_file =
+ includedFilename(buffer(), params()).availableFile().absFilename();
if (isLyXFilename(included_file))
writefile = changeExtension(included_file, ".sgml");
if (!features.runparams().nice && !isVerbatim(params()) && !isListings(params())) {
incfile = DocFileName(writefile).mangledFilename();
writefile = makeAbsPath(incfile,
- buffer.masterBuffer()->temppath()).absFilename();
+ buffer().masterBuffer()->temppath()).absFilename();
}
features.includeFile(include_label, writefile);
// 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(buffer(), params())) {
// a file got loaded
Buffer * const tmp = theBufferList().getBuffer(included_file);
// 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) {
+ 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);
tmp->validate(features);
- features.setBuffer(buffer);
+ features.setBuffer(buffer());
}
}
}
-void InsetInclude::getLabelList(Buffer const & buffer,
- vector<docstring> & list) const
-{
- if (isListings(params())) {
- InsetListingsParams p(to_utf8(params()["lstparams"]));
- string label = p.getParamValue("label");
- if (!label.empty())
- list.push_back(from_utf8(label));
- }
- else if (loadIfNeeded(buffer, params())) {
- string const included_file = includedFilename(buffer, params()).absFilename();
- Buffer * tmp = theBufferList().getBuffer(included_file);
- tmp->setParent(0);
- tmp->getLabelList(list);
- tmp->setParent(const_cast<Buffer *>(&buffer));
- }
-}
-
-
-void InsetInclude::fillWithBibKeys(Buffer const & buffer,
- BiblioInfo & keys, InsetIterator const & /*di*/) const
+void InsetInclude::fillWithBibKeys(BiblioInfo & keys,
+ InsetIterator const & /*di*/) const
{
- if (loadIfNeeded(buffer, params())) {
- string const included_file = includedFilename(buffer, params()).absFilename();
+ if (loadIfNeeded(buffer(), params())) {
+ string const included_file = includedFilename(buffer(), params()).absFilename();
Buffer * tmp = theBufferList().getBuffer(included_file);
//FIXME This is kind of a dirty hack and should be made reasonable.
tmp->setParent(0);
keys.fillWithBibKeys(tmp);
- tmp->setParent(&buffer);
+ tmp->setParent(&buffer());
}
}
-void InsetInclude::updateBibfilesCache(Buffer const & buffer)
+void InsetInclude::updateBibfilesCache()
{
- Buffer * const tmp = getChildBuffer(buffer, params());
+ Buffer * const tmp = getChildBuffer(buffer(), params());
if (tmp) {
tmp->setParent(0);
tmp->updateBibfilesCache();
- tmp->setParent(&buffer);
+ tmp->setParent(&buffer());
}
}
} else {
if (!set_label_) {
set_label_ = true;
- button_.update(getScreenLabel(mi.base.bv->buffer()),
- true);
+ button_.update(screenLabel(), true);
}
button_.metrics(mi, dim);
}
}
-docstring const latex_string(InsetInclude const & inset, Buffer const & buffer)
+docstring latexString(InsetInclude const & inset)
{
odocstringstream os;
// We don't need to set runparams.encoding since this will be done
// by latex() anyway.
OutputParams runparams(0);
runparams.flavor = OutputParams::LATEX;
- inset.latex(buffer, os, runparams);
+ inset.latex(os, runparams);
return os.str();
}
if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
preview_wanted(params, buffer)) {
renderer.setAbsFile(includedFilename(buffer, params));
- docstring const snippet = latex_string(inset, buffer);
+ docstring const snippet = latexString(inset);
renderer.addPreview(snippet, buffer);
}
}
if (!preview_wanted(params(), buffer))
return;
preview_->setAbsFile(includedFilename(buffer, params()));
- docstring const snippet = latex_string(*this, buffer);
+ docstring const snippet = latexString(*this);
preview_->addPreview(snippet, ploader);
}
-void InsetInclude::addToToc(Buffer const & buffer,
- ParConstIterator const & cpit) const
+void InsetInclude::addToToc(ParConstIterator const & cpit) const
{
+ bool const embedded_status = !params()["embed"].empty();
+ TocBackend & backend = buffer().tocBackend();
+
if (isListings(params())) {
+ if (label_)
+ label_->addToToc(cpit);
+
InsetListingsParams p(to_utf8(params()["lstparams"]));
string caption = p.getParamValue("caption");
if (caption.empty())
return;
- Toc & toc = buffer.tocBackend().toc("listing");
- docstring const str = convert<docstring>(toc.size() + 1)
+ Toc & toc = backend.toc("listing");
+ docstring str = convert<docstring>(toc.size() + 1)
+ ". " + from_utf8(caption);
+ if (embedded_status) {
+ backend.toc("embedded").push_back(TocItem(cpit, 0, str));
+ str += _(" (embedded)");
+ }
ParConstIterator pit = cpit;
pit.push_back(*this);
toc.push_back(TocItem(pit, 0, str));
return;
}
- Buffer const * const childbuffer = getChildBuffer(buffer, params());
- if (!childbuffer)
+ Buffer const * const childbuffer = getChildBuffer(buffer(), params());
+ if (!childbuffer) {
+ if (embedded_status)
+ // Add it to the embedded list nonetheless.
+ backend.toc("embedded").push_back(TocItem(cpit, 0,
+ params()["filename"]));
return;
+ }
+
+ Toc & toc = backend.toc("child");
+ docstring str = childbuffer->fileName().displayName();
+ if (embedded_status) {
+ backend.toc("embedded").push_back(TocItem(cpit, 0, str));
+ str += _(" (embedded)");
+ }
+ toc.push_back(TocItem(cpit, 0, str));
- TocList & toclist = buffer.tocBackend().tocs();
+ TocList & toclist = backend.tocs();
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());
+ it->second.begin(), it->second.end());
}
-void InsetInclude::updateLabels(Buffer const & buffer, ParIterator const &)
+void InsetInclude::updateLabels(ParIterator const & it)
{
- Buffer const * const childbuffer = getChildBuffer(buffer, params());
+ Buffer const * const childbuffer = getChildBuffer(buffer(), params());
if (childbuffer) {
lyx::updateLabels(*childbuffer, true);
return;
if (!isListings(params()))
return;
+ if (label_)
+ label_->updateLabels(it);
+
InsetListingsParams const par(to_utf8(params()["lstparams"]));
if (par.getParamValue("caption").empty()) {
listings_label_.clear();
return;
}
- Counters & counters = buffer.params().textClass().counters();
+ Counters & counters = buffer().params().documentClass().counters();
docstring const cnt = from_ascii("listing");
- listings_label_ = buffer.B_("Program Listing");
+ listings_label_ = buffer().B_("Program Listing");
if (counters.hasCounter(cnt)) {
counters.step(cnt);
listings_label_ += " " + convert<docstring>(counters.value(cnt));
}
-void InsetInclude::registerEmbeddedFiles(Buffer const & buffer,
- EmbeddedFileList & files) const
+void InsetInclude::registerEmbeddedFiles(EmbeddedFileList & files) const
{
- files.registerFile(includedFilename(buffer, params()), this, buffer);
+ files.registerFile(includedFilename(buffer(), params()), this, buffer());
}
-void InsetInclude::updateEmbeddedFile(Buffer const & buf,
- EmbeddedFile const & file)
+void InsetInclude::updateEmbeddedFile(EmbeddedFile const & file)
{
InsetCommandParams p = params();
p["filename"] = from_utf8(file.outputFilename());
p["embed"] = file.embedded() ? from_utf8(file.inzipName()) : docstring();
- set(p, buf);
+ setParams(p);
}
projects / lyx.git / blobdiff