+/**
+ * \file insetinclude.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Lars Gullik Bjønnes
+ *
+ * Full author contact details are available in file CREDITS
+ */
#include <config.h>
-#include <cstdlib>
-
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
-#include "frontends/Dialogs.h"
-
#include "insetinclude.h"
#include "buffer.h"
#include "bufferlist.h"
+#include "BufferView.h"
#include "debug.h"
-#include "support/filetools.h"
-#include "lyxrc.h"
-#include "LyXView.h"
-#include "LaTeXFeatures.h"
+#include "funcrequest.h"
#include "gettext.h"
+#include "LaTeXFeatures.h"
+#include "latexrunparams.h"
+#include "Lsstream.h"
+#include "lyxlex.h"
+#include "lyxrc.h"
+#include "Lsstream.h"
+
+#include "frontends/Dialogs.h"
+#include "frontends/LyXView.h"
+#include "frontends/Painter.h"
+
+#include "support/filetools.h"
#include "support/FileInfo.h"
-#include "layout.h"
-#include "lyxfunc.h"
+#include "support/FileMonitor.h"
+#include "support/lstrings.h" // contains
+#include "support/tostr.h"
+
+#include "graphics/PreviewedInset.h"
+#include "graphics/PreviewImage.h"
+
+#include <boost/bind.hpp>
+
+#include <cstdlib>
using std::ostream;
using std::endl;
extern BufferList bufferlist;
-static inline
-string unique_id() {
- static unsigned int seed = 1000;
+class InsetInclude::PreviewImpl : public grfx::PreviewedInset {
+public:
+ ///
+ PreviewImpl(InsetInclude & p) : PreviewedInset(p) {}
+
+ ///
+ bool previewWanted() const;
+ ///
+ string const latexString() const;
+ ///
+ InsetInclude & parent() const {
+ return *static_cast<InsetInclude*>(inset());
+ }
- std::ostringstream ost;
- ost << "file" << ++seed;
+ ///
+ bool monitoring() const { return monitor_.get(); }
+ ///
+ void startMonitoring();
+ ///
+ void stopMonitoring() { monitor_.reset(); }
- // Needed if we use lyxstring.
- return ost.str().c_str();
+private:
+ /// Invoked by monitor_ should the parent file change.
+ void restartLoading();
+ ///
+ boost::scoped_ptr<FileMonitor> monitor_;
+};
+
+
+namespace {
+
+string const uniqueID()
+{
+ static unsigned int seed = 1000;
+ return "file" + tostr(++seed);
}
+} // namespace anon
-InsetInclude::InsetInclude(InsetCommandParams const & p, Buffer const & bf)
- : InsetCommand(p), master(&bf)
+
+InsetInclude::InsetInclude(Params const & p)
+ : params_(p), include_label(uniqueID()),
+ preview_(new PreviewImpl(*this))
+{}
+
+
+InsetInclude::InsetInclude(InsetCommandParams const & p, Buffer const & b)
+ : include_label(uniqueID()),
+ preview_(new PreviewImpl(*this))
{
- flag = InsetInclude::INCLUDE;
- noload = false;
- include_label = unique_id();
+ params_.cparams = p;
+ params_.masterFilename_ = b.fileName();
}
InsetInclude::~InsetInclude()
{
+ InsetIncludeMailer mailer(*this);
+ mailer.hideDialog();
}
-Inset * InsetInclude::Clone(Buffer const & buffer) const
-{
- InsetInclude * ii = new InsetInclude (params(), buffer);
- ii->setNoLoad(isNoLoad());
- // By default, the newly created inset is of `include' type,
- // so we do not test this case.
- if (isInput())
- ii->setInput();
- else if (isVerb()) {
- ii->setVerb();
- ii->setVisibleSpace(isVerbVisibleSpace());
+dispatch_result InsetInclude::localDispatch(FuncRequest const & cmd)
+{
+ switch (cmd.action) {
+
+ case LFUN_INSET_MODIFY: {
+ InsetInclude::Params p;
+ InsetIncludeMailer::string2params(cmd.argument, p);
+ if (!p.cparams.getCmdName().empty()) {
+ set(p);
+ params_.masterFilename_ = cmd.view()->buffer()->fileName();
+ cmd.view()->updateInset(this);
+ }
+ return DISPATCHED;
+ }
+
+ case LFUN_INSET_DIALOG_UPDATE:
+ InsetIncludeMailer(*this).updateDialog(cmd.view());
+ return DISPATCHED;
+
+ case LFUN_MOUSE_RELEASE:
+ case LFUN_INSET_EDIT:
+ InsetIncludeMailer(*this).showDialog(cmd.view());
+ return DISPATCHED;
+
+ default:
+ return UNDISPATCHED;
}
- return ii;
}
-void InsetInclude::Edit(BufferView * bv, int, int, unsigned int)
+InsetInclude::Params const & InsetInclude::params() const
+{
+ return params_;
+}
+
+
+bool InsetInclude::Params::operator==(Params const & o) const
{
- bv->owner()->getDialogs()->showInclude(this);
+ return cparams == o.cparams && flag == o.flag &&
+ masterFilename_ == o.masterFilename_;
}
-void InsetInclude::Write(Buffer const *, ostream & os) const
+bool InsetInclude::Params::operator!=(Params const & o) const
{
- os << "Include " << getCommand() << "\n";
+ return !(*this == o);
}
-void InsetInclude::Read(Buffer const * buf, LyXLex & lex)
+void InsetInclude::set(Params const & p)
{
- InsetCommand::Read(buf, lex);
-
- if (getCmdName() == "include")
- setInclude();
- else if (getCmdName() == "input")
- setInput();
- else if (contains(getCmdName(), "verbatim")) {
- setVerb();
- if (getCmdName() == "verbatiminput*")
- setVisibleSpace(true);
+ params_ = p;
+
+ string command;
+
+ switch (params_.flag) {
+ case INCLUDE:
+ command="include";
+ break;
+ case VERB:
+ command="verbatiminput";
+ break;
+ case INPUT:
+ command="input";
+ break;
+ case VERBAST:
+ command="verbatiminput*";
+ break;
}
+
+ params_.cparams.setCmdName(command);
+
+ if (preview_->monitoring())
+ preview_->stopMonitoring();
+
+ if (grfx::PreviewedInset::activated() && params_.flag == INPUT)
+ preview_->generatePreview();
+}
+
+
+Inset * InsetInclude::clone(Buffer const & buffer, bool) const
+{
+ Params p(params_);
+ p.masterFilename_ = buffer.fileName();
+
+ return new InsetInclude(p);
+}
+
+
+void InsetInclude::write(Buffer const *, ostream & os) const
+{
+ os << "Include " << params_.cparams.getCommand() << '\n'
+ << "preview " << tostr(params_.cparams.preview()) << '\n';
}
-bool InsetInclude::display() const
+void InsetInclude::read(Buffer const *, LyXLex & lex)
{
- return !isInput();
+ params_.cparams.read(lex);
+
+ if (params_.cparams.getCmdName() == "include")
+ params_.flag = INCLUDE;
+ else if (params_.cparams.getCmdName() == "input")
+ params_.flag = INPUT;
+ /* FIXME: is this logic necessary now ? */
+ else if (contains(params_.cparams.getCmdName(), "verbatim")) {
+ params_.flag = VERB;
+ if (params_.cparams.getCmdName() == "verbatiminput*")
+ params_.flag = VERBAST;
+ }
+}
+
+
+bool InsetInclude::display() const
+{
+ return !(params_.flag == INPUT);
}
-string const InsetInclude::getScreenLabel() const
+string const InsetInclude::getScreenLabel(Buffer const *) const
{
string temp;
- if (isInput())
- temp += _("Input");
- else if (isVerb()) {
- temp += _("Verbatim Input");
- if (isVerbVisibleSpace()) temp += '*';
- } else temp += _("Include");
- temp += ": ";
-
- if (getContents().empty()) {
- temp+= "???";
- } else {
- temp+= getContents();
+
+ switch (params_.flag) {
+ case INPUT: temp += _("Input"); break;
+ case VERB: temp += _("Verbatim Input"); break;
+ case VERBAST: temp += _("Verbatim Input*"); break;
+ case INCLUDE: temp += _("Include"); break;
}
+
+ temp += ": ";
+
+ if (params_.cparams.getContents().empty())
+ temp += "???";
+ else
+ temp += params_.cparams.getContents();
+
return temp;
}
string const InsetInclude::getFileName() const
{
- return MakeAbsPath(getContents(),
+ return MakeAbsPath(params_.cparams.getContents(),
OnlyPath(getMasterFilename()));
}
string const InsetInclude::getMasterFilename() const
{
- return master->fileName();
+ return params_.masterFilename_;
}
bool InsetInclude::loadIfNeeded() const
{
- if (isNoLoad() || isVerb()) return false;
- if (!IsLyXFilename(getFileName())) return false;
-
- if (bufferlist.exists(getFileName())) return true;
-
+ if (isVerbatim())
+ return false;
+
+ if (!IsLyXFilename(getFileName()))
+ return false;
+
+ if (bufferlist.exists(getFileName()))
+ return true;
+
// the readonly flag can/will be wrong, not anymore I think.
FileInfo finfo(getFileName());
- bool const ro = !finfo.writable();
- return bufferlist.readFile(getFileName(), ro) != 0;
+ if (!finfo.isOK())
+ return false;
+
+ return bufferlist.loadLyXFile(getFileName(), false) != 0;
}
-int InsetInclude::Latex(Buffer const * buffer, ostream & os,
- bool /*fragile*/, bool /*fs*/) const
+int InsetInclude::latex(Buffer const * buffer, ostream & os,
+ LatexRunParams const & runparams) const
{
- string incfile(getContents());
-
+ string incfile(params_.cparams.getContents());
+
// Do nothing if no file name has been specified
if (incfile.empty())
return 0;
-
+
if (loadIfNeeded()) {
Buffer * tmp = bufferlist.getBuffer(getFileName());
+ // FIXME: this should be a GUI warning
if (tmp->params.textclass != buffer->params.textclass) {
lyxerr << "WARNING: Included file `"
<< MakeDisplayPath(getFileName())
<< "' has textclass `"
- << textclasslist.NameOfClass(tmp->params.textclass)
+ << tmp->params.getLyXTextClass().name()
<< "' while parent file has textclass `"
- << textclasslist.NameOfClass(buffer->params.textclass)
+ << buffer->params.getLyXTextClass().name()
<< "'." << endl;
//return 0;
}
-
+
// write it to a file (so far the complete file)
string writefile = ChangeExtension(getFileName(), ".tex");
- if (!buffer->tmppath.empty()
- && !buffer->niceFile) {
+
+ if (!buffer->tmppath.empty() && !runparams.nice) {
incfile = subst(incfile, '/','@');
#ifdef __EMX__
incfile = subst(incfile, ':', '$');
writefile = ChangeExtension(writefile, ".tex");
lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
-
+
tmp->markDepClean(buffer->tmppath);
-
- tmp->makeLaTeXFile(writefile,
- OnlyPath(getMasterFilename()),
- buffer->niceFile, true);
- }
-
- if (isVerb()) {
- os << '\\' << getCmdName() << '{' << incfile << '}';
- } else if (isInput()) {
+
+ tmp->makeLaTeXFile(writefile, OnlyPath(getMasterFilename()),
+ runparams, true);
+ }
+
+ if (isVerbatim()) {
+ os << '\\' << params_.cparams.getCmdName() << '{' << incfile << '}';
+ } else if (params_.flag == INPUT) {
// \input wants file with extension (default is .tex)
if (!IsLyXFilename(getFileName())) {
- os << '\\' << getCmdName() << '{' << incfile << '}';
+ os << '\\' << params_.cparams.getCmdName() << '{' << incfile << '}';
} else {
- os << '\\' << getCmdName() << '{'
+ os << '\\' << params_.cparams.getCmdName() << '{'
<< ChangeExtension(incfile, ".tex")
<< '}';
}
} else {
// \include don't want extension and demands that the
// file really have .tex
- os << '\\' << getCmdName() << '{'
+ os << '\\' << params_.cparams.getCmdName() << '{'
<< ChangeExtension(incfile, string())
<< '}';
}
}
-int InsetInclude::Ascii(Buffer const *, std::ostream & os, int) const
+int InsetInclude::ascii(Buffer const *, ostream & os, int) const
{
- if (isVerb())
+ if (isVerbatim())
os << GetFileContents(getFileName());
return 0;
}
-int InsetInclude::Linuxdoc(Buffer const * buffer, ostream & os) const
+int InsetInclude::linuxdoc(Buffer const * buffer, ostream & os) const
{
- string incfile(getContents());
-
+ string incfile(params_.cparams.getContents());
+
// Do nothing if no file name has been specified
if (incfile.empty())
return 0;
-
+
if (loadIfNeeded()) {
Buffer * tmp = bufferlist.getBuffer(getFileName());
lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
-
+
tmp->makeLinuxDocFile(writefile, buffer->niceFile, true);
- }
+ }
- if (isVerb()) {
- os << "<inlinegraphic fileref=\"" << '&' << include_label << ';'
- << "\" format=\"linespecific\">"
- << "</inlinegraphic>";
- } else
+ if (isVerbatim()) {
+ os << "<![CDATA["
+ << GetFileContents(getFileName())
+ << "]]>";
+ } else
os << '&' << include_label << ';';
-
+
return 0;
}
-int InsetInclude::DocBook(Buffer const * buffer, ostream & os) const
+int InsetInclude::docbook(Buffer const * buffer, ostream & os,
+ bool /*mixcont*/) const
{
- string incfile(getContents());
+ string incfile(params_.cparams.getContents());
// Do nothing if no file name has been specified
if (incfile.empty())
return 0;
-
+
if (loadIfNeeded()) {
Buffer * tmp = bufferlist.getBuffer(getFileName());
lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
-
+
tmp->makeDocBookFile(writefile, buffer->niceFile, true);
- }
+ }
- if (isVerb()) {
- os << "<inlinegraphic fileref=\"" << '&' << include_label << ';'
- << "\" format=\"linespecific\">"
- << "</inlinegraphic>";
- } else
+ if (isVerbatim()) {
+ os << "<inlinegraphic fileref=\""
+ << '&' << include_label << ';'
+ << "\" format=\"linespecific\">";
+ } else
os << '&' << include_label << ';';
-
+
return 0;
}
-void InsetInclude::Validate(LaTeXFeatures & features) const
+void InsetInclude::validate(LaTeXFeatures & features) const
{
- string incfile(getContents());
- string writefile; // = ChangeExtension(getFileName(), ".sgml");
+ string incfile(params_.cparams.getContents());
+ string writefile;
+
+ Buffer const * const b = bufferlist.getBuffer(getMasterFilename());
- if (!master->tmppath.empty() && !master->niceFile) {
+ if (b && !b->tmppath.empty() && !b->niceFile && !isVerbatim()) {
incfile = subst(incfile, '/','@');
- writefile = AddName(master->tmppath, incfile);
+ writefile = AddName(b->tmppath, incfile);
} else
writefile = getFileName();
- // Use the relative path.
- //writefile = incfile;
if (IsLyXFilename(getFileName()))
writefile = ChangeExtension(writefile, ".sgml");
- features.IncludedFiles[include_label] = writefile;
+ features.includeFile(include_label, writefile);
- if (isVerb())
- features.verbatim = true;
+ if (isVerbatim())
+ features.require("verbatim");
// Here we must do the fun stuff...
// Load the file in the include if it needs
// to be loaded:
if (loadIfNeeded()) {
// a file got loaded
- Buffer * tmp = bufferlist.getBuffer(getFileName());
- tmp->validate(features);
+ Buffer * const tmp = bufferlist.getBuffer(getFileName());
+ if (tmp) {
+ if (b)
+ tmp->niceFile = b->niceFile;
+ tmp->validate(features);
+ }
}
}
if (loadIfNeeded()) {
Buffer * tmp = bufferlist.getBuffer(getFileName());
- tmp->setParentName("");
+ tmp->setParentName("");
l = tmp->getLabelList();
tmp->setParentName(getMasterFilename());
}
}
-vector<pair<string,string> > const InsetInclude::getKeys() const
+void InsetInclude::fillWithBibKeys(vector<pair<string,string> > & keys) const
{
- vector<pair<string,string> > keys;
-
if (loadIfNeeded()) {
Buffer * tmp = bufferlist.getBuffer(getFileName());
- tmp->setParentName("");
- keys = tmp->getBibkeyList();
+ tmp->setParentName("");
+ tmp->fillWithBibKeys(keys);
tmp->setParentName(getMasterFilename());
}
+}
+
+
+int InsetInclude::ascent(BufferView * bv, LyXFont const & font) const
+{
+ return preview_->previewReady() ?
+ preview_->pimage()->ascent() : InsetButton::ascent(bv, font);
+}
+
+
+int InsetInclude::descent(BufferView * bv, LyXFont const & font) const
+{
+ return preview_->previewReady() ?
+ preview_->pimage()->descent() : InsetButton::descent(bv, font);
+}
+
+
+int InsetInclude::width(BufferView * bv, LyXFont const & font) const
+{
+ return preview_->previewReady() ?
+ preview_->pimage()->width() : InsetButton::width(bv, font);
+}
+
+
+void InsetInclude::draw(BufferView * bv, LyXFont const & font, int y,
+ float & xx) const
+{
+ cache(bv);
+ if (!preview_->previewReady()) {
+ InsetButton::draw(bv, font, y, xx);
+ return;
+ }
+
+ if (!preview_->monitoring())
+ preview_->startMonitoring();
+
+ int const x = int(xx);
+ int const w = width(bv, font);
+ int const d = descent(bv, font);
+ int const a = ascent(bv, font);
+ int const h = a + d;
+
+ bv->painter().image(x, y - a, w, h,
+ *(preview_->pimage()->image()));
+
+ xx += w;
+}
+
+
+//
+// preview stuff
+//
+
+void InsetInclude::addPreview(grfx::PreviewLoader & ploader) const
+{
+ preview_->addPreview(ploader);
+}
+
+
+bool InsetInclude::PreviewImpl::previewWanted() const
+{
+ return parent().params_.flag == InsetInclude::INPUT &&
+ parent().params_.cparams.preview() &&
+ IsFileReadable(parent().getFileName());
+}
+
+
+string const InsetInclude::PreviewImpl::latexString() const
+{
+ if (!view() || !view()->buffer())
+ return string();
+
+ ostringstream os;
+ LatexRunParams runparams;
+ runparams.flavor = LatexRunParams::LATEX;
+ parent().latex(view()->buffer(), os, runparams);
+
+ return STRCONV(os.str());
+}
+
+
+void InsetInclude::PreviewImpl::startMonitoring()
+{
+ monitor_.reset(new FileMonitor(parent().getFileName(), 2000));
+ monitor_->connect(boost::bind(&PreviewImpl::restartLoading, this));
+ monitor_->start();
+}
+
+
+void InsetInclude::PreviewImpl::restartLoading()
+{
+ lyxerr << "restartLoading()" << std::endl;
+ removePreview();
+ if (view())
+ view()->updateInset(&parent());
+ generatePreview();
+}
+
+
+string const InsetIncludeMailer::name_("include");
+
+InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset)
+ : inset_(inset)
+{}
+
+
+string const InsetIncludeMailer::inset2string() const
+{
+ return params2string(inset_.params());
+}
+
+
+void InsetIncludeMailer::string2params(string const & in,
+ InsetInclude::Params & params)
+{
+ params = InsetInclude::Params();
+
+ if (in.empty())
+ return;
- return keys;
+ istringstream data(STRCONV(in));
+ LyXLex lex(0,0);
+ lex.setStream(data);
+
+ if (lex.isOK()) {
+ lex.next();
+ string const token = lex.getString();
+ if (token != name_)
+ return;
+ }
+
+ // This is part of the inset proper that is usually swallowed
+ // by Buffer::readInset
+ if (lex.isOK()) {
+ lex.next();
+ string const token = lex.getString();
+ if (token != "Include")
+ return;
+ }
+
+ if (lex.isOK()) {
+ InsetInclude inset(params);
+ inset.read(0, lex);
+ params = inset.params();
+ }
+}
+
+
+string const
+InsetIncludeMailer::params2string(InsetInclude::Params const & params)
+{
+ InsetInclude inset(params);
+ inset.set(params);
+ ostringstream data;
+ data << name_ << ' ';
+ inset.write(0, data);
+ data << "\\end_inset\n";
+ return STRCONV(data.str());
}
projects / lyx.git / blobdiff