#include "bufferlist.h"
#include "bufferparams.h"
#include "BufferView.h"
+#include "cursor.h"
#include "debug.h"
+#include "dispatchresult.h"
+#include "exporter.h"
#include "funcrequest.h"
#include "gettext.h"
#include "LaTeXFeatures.h"
-#include "latexrunparams.h"
+#include "lyx_main.h"
+#include "lyxrc.h"
#include "lyxlex.h"
#include "metricsinfo.h"
+#include "outputparams.h"
+#include "frontends/Alert.h"
+#include "frontends/LyXView.h"
#include "frontends/Painter.h"
-#include "graphics/PreviewedInset.h"
#include "graphics/PreviewImage.h"
+#include "graphics/PreviewLoader.h"
+
+#include "insets/render_preview.h"
#include "support/FileInfo.h"
-#include "support/FileMonitor.h"
+#include "support/filename.h"
#include "support/filetools.h"
#include "support/lstrings.h" // contains
+#include "support/lyxlib.h"
#include "support/tostr.h"
#include <boost/bind.hpp>
-#include "support/std_sstream.h"
+#include "support/std_ostream.h"
+
+#include <sstream>
using lyx::support::AddName;
+using lyx::support::AbsolutePath;
+using lyx::support::bformat;
using lyx::support::ChangeExtension;
using lyx::support::contains;
+using lyx::support::copy;
using lyx::support::FileInfo;
-using lyx::support::FileMonitor;
+using lyx::support::FileName;
using lyx::support::GetFileContents;
using lyx::support::IsFileReadable;
using lyx::support::IsLyXFilename;
using lyx::support::MakeAbsPath;
using lyx::support::MakeDisplayPath;
+using lyx::support::MakeRelPath;
using lyx::support::OnlyFilename;
using lyx::support::OnlyPath;
using lyx::support::subst;
+using lyx::support::sum;
using std::endl;
-
+using std::string;
using std::auto_ptr;
using std::istringstream;
using std::ostream;
extern BufferList bufferlist;
-class InsetInclude::PreviewImpl : public lyx::graphics::PreviewedInset {
-public:
- ///
- PreviewImpl(InsetInclude & p) : PreviewedInset(p) {}
-
- ///
- bool previewWanted(Buffer const &) const;
- ///
- string const latexString(Buffer const &) const;
- ///
- InsetInclude const & parent() const {
- return dynamic_cast<InsetInclude const &>(inset());
- }
-
- ///
- bool monitoring() const { return monitor_.get(); }
- ///
- void startMonitoring(string const & file);
- ///
- void stopMonitoring() { monitor_.reset(); }
-
-private:
- /// Invoked by monitor_ should the parent file change.
- void restartLoading();
- ///
- boost::scoped_ptr<FileMonitor> monitor_;
-};
-
-
namespace {
string const uniqueID()
InsetInclude::InsetInclude(InsetCommandParams const & p)
: params_(p), include_label(uniqueID()),
- preview_(new PreviewImpl(*this)),
+ preview_(new RenderMonitoredPreview(this)),
set_label_(false)
-{}
+{
+ preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
+}
InsetInclude::InsetInclude(InsetInclude const & other)
: InsetOld(other),
params_(other.params_),
include_label(other.include_label),
- preview_(new PreviewImpl(*this)),
+ preview_(new RenderMonitoredPreview(this)),
set_label_(other.set_label_)
-{}
+{
+ preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
+}
InsetInclude::~InsetInclude()
{
- InsetIncludeMailer mailer(*this);
- mailer.hideDialog();
+ InsetIncludeMailer(*this).hideDialog();
}
-dispatch_result InsetInclude::localDispatch(FuncRequest const & cmd)
+void InsetInclude::priv_dispatch(LCursor & cur, FuncRequest & cmd)
{
switch (cmd.action) {
InsetCommandParams p;
InsetIncludeMailer::string2params(cmd.argument, p);
if (!p.getCmdName().empty()) {
- set(p, *cmd.view()->buffer());
- cmd.view()->updateInset(this);
+ set(p, cur.buffer());
+ cur.bv().update();
}
- return DISPATCHED;
+ break;
}
case LFUN_INSET_DIALOG_UPDATE:
- InsetIncludeMailer(*this).updateDialog(cmd.view());
- return DISPATCHED;
+ InsetIncludeMailer(*this).updateDialog(&cur.bv());
+ break;
case LFUN_MOUSE_RELEASE:
- if (button_.box().contains(cmd.x, cmd.y))
- InsetIncludeMailer(*this).showDialog(cmd.view());
- return DISPATCHED;
-
case LFUN_INSET_DIALOG_SHOW:
- InsetIncludeMailer(*this).showDialog(cmd.view());
- return DISPATCHED;
+ InsetIncludeMailer(*this).showDialog(&cur.bv());
+ break;
default:
- return InsetOld::localDispatch(cmd);
+ InsetOld::priv_dispatch(cur, cmd);
+ break;
}
}
return VERBAST;
return INCLUDE;
}
-
+
bool isVerbatim(InsetCommandParams const & params)
{
command_name == "verbatiminput*";
}
+
+string const masterFilename(Buffer const & buffer)
+{
+ return buffer.getMasterBuffer()->fileName();
+}
+
+
+string const parentFilename(Buffer const & buffer)
+{
+ return buffer.fileName();
+}
+
+
+string const includedFilename(Buffer const & buffer,
+ InsetCommandParams const & params)
+{
+ return MakeAbsPath(params.getContents(),
+ OnlyPath(parentFilename(buffer)));
+}
+
+
+void add_preview(RenderMonitoredPreview &, InsetInclude const &, Buffer const &);
+
} // namespace anon
if (preview_->monitoring())
preview_->stopMonitoring();
- if (lyx::graphics::PreviewedInset::activated() &&
- type(params_) == INPUT)
- preview_->generatePreview(buffer);
+ if (type(params_) == INPUT)
+ add_preview(*preview_, *this, buffer);
}
namespace {
-string const masterFilename(Buffer const & buffer)
-{
- return buffer.fileName();
-}
-
-
-string const includedFilename(Buffer const & buffer,
- InsetCommandParams const & params)
-{
- return MakeAbsPath(params.getContents(),
- OnlyPath(masterFilename(buffer)));
-}
-
-
/// return true if the file is or got loaded.
bool loadIfNeeded(Buffer const & buffer, InsetCommandParams const & params)
{
if (!IsLyXFilename(included_file))
return false;
- if (bufferlist.exists(included_file))
- return true;
-
- // the readonly flag can/will be wrong, not anymore I think.
- FileInfo finfo(included_file);
- if (!finfo.isOK())
- return false;
- return loadLyXFile(bufferlist.newBuffer(included_file),
- included_file);
+ Buffer * buf = bufferlist.getBuffer(included_file);
+ if (!buf) {
+ // the readonly flag can/will be wrong, not anymore I think.
+ FileInfo finfo(included_file);
+ if (!finfo.isOK())
+ return false;
+ buf = bufferlist.newBuffer(included_file);
+ if (!loadLyXFile(buf, included_file))
+ return false;
+ }
+ if (buf)
+ buf->setParentName(parentFilename(buffer));
+ return buf != 0;
}
int InsetInclude::latex(Buffer const & buffer, ostream & os,
- LatexRunParams const & runparams) const
+ OutputParams const & runparams) const
{
string incfile(params_.getContents());
return 0;
string const included_file = includedFilename(buffer, params_);
+ Buffer const * const m_buffer = buffer.getMasterBuffer();
+
+ // if incfile is relative, make it relative to the master
+ // buffer directory.
+ if (!AbsolutePath(incfile)) {
+ incfile = MakeRelPath(included_file,
+ m_buffer->filePath());
+ }
+
+ // write it to a file (so far the complete file)
+ string const exportfile = ChangeExtension(incfile, ".tex");
+ string const mangled = FileName(ChangeExtension(included_file,
+ ".tex")).mangledFilename();
+ string const writefile = MakeAbsPath(mangled, m_buffer->temppath());
+
+ if (!runparams.nice)
+ incfile = mangled;
+ lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
+ lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl;
+ lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
if (loadIfNeeded(buffer, params_)) {
Buffer * tmp = bufferlist.getBuffer(included_file);
- // FIXME: this should be a GUI warning
- if (tmp->params().textclass != buffer.params().textclass) {
- lyxerr << "WARNING: Included file `"
- << MakeDisplayPath(included_file)
- << "' has textclass `"
- << tmp->params().getLyXTextClass().name()
- << "' while parent file has textclass `"
- << buffer.params().getLyXTextClass().name()
- << "'." << endl;
+ if (tmp->params().textclass != m_buffer->params().textclass) {
+ string text = bformat(_("Included file `%1$s'\n"
+ "has textclass `%2$s'\n"
+ "while parent file has textclass `%3$s'."),
+ MakeDisplayPath(included_file),
+ tmp->params().getLyXTextClass().name(),
+ m_buffer->params().getLyXTextClass().name());
+ Alert::warning(_("Different textclasses"), text);
//return 0;
}
- // write it to a file (so far the complete file)
- string writefile = ChangeExtension(included_file, ".tex");
+ tmp->markDepClean(m_buffer->temppath());
- if (!buffer.temppath().empty() && !runparams.nice) {
- incfile = subst(incfile, '/','@');
-#ifdef __EMX__
- incfile = subst(incfile, ':', '$');
+#ifdef WITH_WARNINGS
+#warning 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)
#endif
- writefile = AddName(buffer.temppath(), incfile);
- } else
- writefile = included_file;
- writefile = ChangeExtension(writefile, ".tex");
- lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
- lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
-
- tmp->markDepClean(buffer.temppath());
-
tmp->makeLaTeXFile(writefile,
OnlyPath(masterFilename(buffer)),
runparams, false);
+ } else {
+ // 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.C.
+ unsigned long const checksum_in = sum(included_file);
+ unsigned long const checksum_out = sum(writefile);
+
+ if (checksum_in != checksum_out) {
+ if (!copy(included_file, writefile)) {
+ lyxerr[Debug::LATEX]
+ << bformat(_("Could not copy the file\n%1$s\n"
+ "into the temporary directory."),
+ included_file)
+ << endl;
+ return 0;
+ }
+ }
}
if (isVerbatim(params_)) {
os << '\\' << params_.getCmdName() << '{' << incfile << '}';
} else if (type(params_) == INPUT) {
+ runparams.exportdata->addExternalFile("latex", writefile,
+ exportfile);
+
// \input wants file with extension (default is .tex)
if (!IsLyXFilename(included_file)) {
os << '\\' << params_.getCmdName() << '{' << incfile << '}';
<< '}';
}
} else {
+ runparams.exportdata->addExternalFile("latex", writefile,
+ exportfile);
+
// \include don't want extension and demands that the
// file really have .tex
os << '\\' << params_.getCmdName() << '{'
}
-int InsetInclude::ascii(Buffer const & buffer, ostream & os, int) const
+int InsetInclude::plaintext(Buffer const & buffer, ostream & os,
+ OutputParams const &) const
{
if (isVerbatim(params_))
os << GetFileContents(includedFilename(buffer, params_));
}
-int InsetInclude::linuxdoc(Buffer const & buffer, ostream & os) const
+int InsetInclude::linuxdoc(Buffer const & buffer, ostream & os,
+ OutputParams const & runparams) const
{
string incfile(params_.getContents());
string const included_file = includedFilename(buffer, params_);
+ // write it to a file (so far the complete file)
+ string const exportfile = ChangeExtension(incfile, ".sgml");
+ string writefile = ChangeExtension(included_file, ".sgml");
+
if (loadIfNeeded(buffer, params_)) {
Buffer * tmp = bufferlist.getBuffer(included_file);
- // write it to a file (so far the complete file)
- string writefile = ChangeExtension(included_file, ".sgml");
- if (!buffer.temppath().empty() && !buffer.niceFile()) {
- incfile = subst(incfile, '/','@');
- writefile = AddName(buffer.temppath(), incfile);
- } else
- writefile = included_file;
-
- if (IsLyXFilename(included_file))
- writefile = ChangeExtension(writefile, ".sgml");
+ writefile = MakeAbsPath(FileName(writefile).mangledFilename(),
+ buffer.getMasterBuffer()->temppath());
+ if (!runparams.nice)
+ incfile = writefile;
lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
+ lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl;
lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
- tmp->makeLinuxDocFile(writefile, buffer.niceFile(), true);
+ tmp->makeLinuxDocFile(writefile, runparams, true);
}
if (isVerbatim(params_)) {
os << "<![CDATA["
<< GetFileContents(included_file)
<< "]]>";
- } else
+ } else {
+ runparams.exportdata->addExternalFile("linuxdoc", writefile,
+ exportfile);
os << '&' << include_label << ';';
+ }
return 0;
}
int InsetInclude::docbook(Buffer const & buffer, ostream & os,
- bool /*mixcont*/) const
+ OutputParams const & runparams) const
{
string incfile(params_.getContents());
string const included_file = includedFilename(buffer, params_);
+ // write it to a file (so far the complete file)
+ string const exportfile = ChangeExtension(incfile, ".sgml");
+ string writefile = ChangeExtension(included_file, ".sgml");
+
if (loadIfNeeded(buffer, params_)) {
Buffer * tmp = bufferlist.getBuffer(included_file);
- // write it to a file (so far the complete file)
- string writefile = ChangeExtension(included_file, ".sgml");
- if (!buffer.temppath().empty() && !buffer.niceFile()) {
- incfile = subst(incfile, '/','@');
- writefile = AddName(buffer.temppath(), incfile);
- } else
- writefile = included_file;
- if (IsLyXFilename(included_file))
- writefile = ChangeExtension(writefile, ".sgml");
+ string const mangled = FileName(writefile).mangledFilename();
+ writefile = MakeAbsPath(mangled,
+ buffer.getMasterBuffer()->temppath());
+ if (!runparams.nice)
+ incfile = mangled;
lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
+ lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl;
lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
- tmp->makeDocBookFile(writefile, buffer.niceFile(), true);
+ tmp->makeDocBookFile(writefile, runparams, true);
}
+ runparams.exportdata->addExternalFile("docbook", writefile,
+ exportfile);
+ runparams.exportdata->addExternalFile("docbook-xml", writefile,
+ exportfile);
+
if (isVerbatim(params_)) {
os << "<inlinegraphic fileref=\""
<< '&' << include_label << ';'
string const included_file = includedFilename(buffer, params_);
- if (!buffer.temppath().empty() &&
- !buffer.niceFile() &&
- !isVerbatim(params_)) {
- incfile = subst(incfile, '/','@');
- writefile = AddName(buffer.temppath(), incfile);
- } else
+ if (IsLyXFilename(included_file))
+ writefile = ChangeExtension(included_file, ".sgml");
+ else
writefile = included_file;
- if (IsLyXFilename(included_file))
- writefile = ChangeExtension(writefile, ".sgml");
+ if (!features.nice() && !isVerbatim(params_)) {
+ incfile = FileName(writefile).mangledFilename();
+ writefile = MakeAbsPath(incfile,
+ buffer.getMasterBuffer()->temppath());
+ }
features.includeFile(include_label, writefile);
// a file got loaded
Buffer * const tmp = bufferlist.getBuffer(included_file);
if (tmp) {
- tmp->niceFile() = buffer.niceFile();
+ // 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);
}
}
}
Buffer * tmp = bufferlist.getBuffer(included_file);
tmp->setParentName("");
tmp->getLabelList(list);
- tmp->setParentName(masterFilename(buffer));
+ tmp->setParentName(parentFilename(buffer));
}
}
Buffer * tmp = bufferlist.getBuffer(included_file);
tmp->setParentName("");
tmp->fillWithBibKeys(keys);
- tmp->setParentName(masterFilename(buffer));
+ tmp->setParentName(parentFilename(buffer));
}
}
void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
{
- if (preview_->previewReady()) {
- dim.asc = preview_->pimage()->ascent();
- dim.des = preview_->pimage()->descent();
- dim.wid = preview_->pimage()->width();
+ BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
+
+ bool use_preview = false;
+ if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
+ lyx::graphics::PreviewImage const * pimage =
+ preview_->getPreviewImage(*mi.base.bv->buffer());
+ use_preview = pimage && pimage->image();
+ }
+
+ if (use_preview) {
+ preview_->metrics(mi, dim);
} else {
if (!set_label_) {
set_label_ = true;
button_.update(getScreenLabel(*mi.base.bv->buffer()),
- editable() != NOT_EDITABLE);
+ true);
}
button_.metrics(mi, dim);
}
- int center_indent = type(params_) == INPUT ?
- 0 : (mi.base.textwidth - dim.wid) / 2;
- Box b(center_indent, center_indent + dim.wid, -dim.asc, dim.des);
+
+ Box b(0, dim.wid, -dim.asc, dim.des);
button_.setBox(b);
- dim.wid = mi.base.textwidth;
dim_ = dim;
}
void InsetInclude::draw(PainterInfo & pi, int x, int y) const
{
- cache(pi.base.bv);
- if (!preview_->previewReady()) {
- button_.draw(pi, x + button_.box().x1, y);
- return;
- }
+ setPosCache(pi, x, y);
- if (!preview_->monitoring()) {
- string const included_file =
- includedFilename(*view()->buffer(), params_);
- preview_->startMonitoring(included_file);
+ BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
+
+ bool use_preview = false;
+ if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
+ lyx::graphics::PreviewImage const * pimage =
+ preview_->getPreviewImage(*pi.base.bv->buffer());
+ use_preview = pimage && pimage->image();
}
- pi.pain.image(x + button_.box().x1, y - dim_.asc, dim_.wid, dim_.height(),
- *(preview_->pimage()->image()));
+ if (use_preview)
+ preview_->draw(pi, x, y);
+ else
+ button_.draw(pi, x, y);
}
-
-BufferView * InsetInclude::view() const
+bool InsetInclude::display() const
{
- return button_.view();
+ return type(params_) != INPUT;
}
+
//
// preview stuff
//
-void InsetInclude::addPreview(lyx::graphics::PreviewLoader & ploader) const
+void InsetInclude::fileChanged() const
{
- preview_->addPreview(ploader);
+ Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
+ if (!buffer_ptr)
+ return;
+
+ Buffer const & buffer = *buffer_ptr;
+ preview_->removePreview(buffer);
+ add_preview(*preview_.get(), *this, buffer);
+ preview_->startLoading(buffer);
}
-bool InsetInclude::PreviewImpl::previewWanted(Buffer const & buffer) const
+namespace {
+
+bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
{
- string const included_file = includedFilename(buffer, parent().params());
+ string const included_file = includedFilename(buffer, params);
- return type(parent().params_) == INPUT &&
- parent().params_.preview() &&
+ return type(params) == INPUT && params.preview() &&
IsFileReadable(included_file);
}
-string const InsetInclude::PreviewImpl::latexString(Buffer const & buffer) const
+string const latex_string(InsetInclude const & inset, Buffer const & buffer)
{
ostringstream os;
- LatexRunParams runparams;
- runparams.flavor = LatexRunParams::LATEX;
- parent().latex(buffer, os, runparams);
+ OutputParams runparams;
+ runparams.flavor = OutputParams::LATEX;
+ inset.latex(buffer, os, runparams);
return os.str();
}
-void InsetInclude::PreviewImpl::startMonitoring(string const & file)
+void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
+ Buffer const & buffer)
{
- monitor_.reset(new FileMonitor(file, 2000));
- monitor_->connect(boost::bind(&PreviewImpl::restartLoading, this));
- monitor_->start();
+ InsetCommandParams const & params = inset.params();
+ if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
+ preview_wanted(params, buffer)) {
+ renderer.setAbsFile(includedFilename(buffer, params));
+ string const snippet = latex_string(inset, buffer);
+ renderer.addPreview(snippet, buffer);
+ }
}
+} // namespace anon
+
-void InsetInclude::PreviewImpl::restartLoading()
+void InsetInclude::addPreview(lyx::graphics::PreviewLoader & ploader) const
{
- removePreview();
- if (!view())
- return;
- view()->updateInset(&parent());
- if (view()->buffer())
- generatePreview(*view()->buffer());
+ Buffer const & buffer = ploader.buffer();
+ if (preview_wanted(params(), buffer)) {
+ preview_->setAbsFile(includedFilename(buffer, params()));
+ string const snippet = latex_string(*this, buffer);
+ preview_->addPreview(snippet, ploader);
+ }
}
InsetCommandParams & params)
{
params = InsetCommandParams();
-
if (in.empty())
return;
LyXLex lex(0,0);
lex.setStream(data);
- if (lex.isOK()) {
- lex.next();
- string const token = lex.getString();
- if (token != name_)
- return;
- }
+ string name;
+ lex >> name;
+ if (!lex || name != name_)
+ return print_mailer_error("InsetIncludeMailer", in, 1, name_);
// 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;
- }
+ // by LyXText::readInset
+ string id;
+ lex >> id;
+ if (!lex || id != "Include")
+ return print_mailer_error("InsetBoxMailer", in, 2, "Include");
- if (lex.isOK()) {
- InsetInclude inset(params);
- inset.read(lex);
- params = inset.params();
- }
+ InsetInclude inset(params);
+ inset.read(lex);
+ params = inset.params();
}