3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
8 * Full author contact details are available in file CREDITS
13 #include "insetinclude.h"
15 #include "bufferlist.h"
16 #include "BufferView.h"
18 #include "funcrequest.h"
20 #include "LaTeXFeatures.h"
21 #include "latexrunparams.h"
27 #include "frontends/Dialogs.h"
28 #include "frontends/LyXView.h"
29 #include "frontends/Painter.h"
31 #include "support/filetools.h"
32 #include "support/FileInfo.h"
33 #include "support/FileMonitor.h"
34 #include "support/lstrings.h" // contains
35 #include "support/tostr.h"
37 #include "graphics/PreviewedInset.h"
38 #include "graphics/PreviewImage.h"
40 #include <boost/bind.hpp>
49 extern BufferList bufferlist;
52 class InsetInclude::PreviewImpl : public grfx::PreviewedInset {
55 PreviewImpl(InsetInclude & p) : PreviewedInset(p) {}
58 bool previewWanted() const;
60 string const latexString() const;
62 InsetInclude & parent() const {
63 return *static_cast<InsetInclude*>(inset());
67 bool monitoring() const { return monitor_.get(); }
69 void startMonitoring();
71 void stopMonitoring() { monitor_.reset(); }
74 /// Invoked by monitor_ should the parent file change.
75 void restartLoading();
77 boost::scoped_ptr<FileMonitor> monitor_;
83 string const uniqueID()
85 static unsigned int seed = 1000;
86 return "file" + tostr(++seed);
92 InsetInclude::InsetInclude(Params const & p)
93 : params_(p), include_label(uniqueID()),
94 preview_(new PreviewImpl(*this))
98 InsetInclude::InsetInclude(InsetCommandParams const & p, Buffer const & b)
99 : include_label(uniqueID()),
100 preview_(new PreviewImpl(*this))
103 params_.masterFilename_ = b.fileName();
107 InsetInclude::~InsetInclude()
109 InsetIncludeMailer mailer(*this);
114 dispatch_result InsetInclude::localDispatch(FuncRequest const & cmd)
116 switch (cmd.action) {
118 case LFUN_INSET_MODIFY: {
119 InsetInclude::Params p;
120 InsetIncludeMailer::string2params(cmd.argument, p);
121 if (!p.cparams.getCmdName().empty()) {
123 params_.masterFilename_ = cmd.view()->buffer()->fileName();
124 cmd.view()->updateInset(this);
129 case LFUN_INSET_DIALOG_UPDATE:
130 InsetIncludeMailer(*this).updateDialog(cmd.view());
133 case LFUN_MOUSE_RELEASE:
134 case LFUN_INSET_EDIT:
135 InsetIncludeMailer(*this).showDialog(cmd.view());
144 InsetInclude::Params const & InsetInclude::params() const
150 bool InsetInclude::Params::operator==(Params const & o) const
152 return cparams == o.cparams && flag == o.flag &&
153 masterFilename_ == o.masterFilename_;
157 bool InsetInclude::Params::operator!=(Params const & o) const
159 return !(*this == o);
163 void InsetInclude::set(Params const & p)
169 switch (params_.flag) {
174 command="verbatiminput";
180 command="verbatiminput*";
184 params_.cparams.setCmdName(command);
186 if (preview_->monitoring())
187 preview_->stopMonitoring();
189 if (grfx::PreviewedInset::activated() && params_.flag == INPUT)
190 preview_->generatePreview();
194 Inset * InsetInclude::clone(Buffer const & buffer, bool) const
197 p.masterFilename_ = buffer.fileName();
199 return new InsetInclude(p);
203 void InsetInclude::write(Buffer const *, ostream & os) const
205 os << "Include " << params_.cparams.getCommand() << '\n'
206 << "preview " << tostr(params_.cparams.preview()) << '\n';
210 void InsetInclude::read(Buffer const *, LyXLex & lex)
212 params_.cparams.read(lex);
214 if (params_.cparams.getCmdName() == "include")
215 params_.flag = INCLUDE;
216 else if (params_.cparams.getCmdName() == "input")
217 params_.flag = INPUT;
218 /* FIXME: is this logic necessary now ? */
219 else if (contains(params_.cparams.getCmdName(), "verbatim")) {
221 if (params_.cparams.getCmdName() == "verbatiminput*")
222 params_.flag = VERBAST;
227 bool InsetInclude::display() const
229 return !(params_.flag == INPUT);
233 string const InsetInclude::getScreenLabel(Buffer const *) const
237 switch (params_.flag) {
238 case INPUT: temp += _("Input"); break;
239 case VERB: temp += _("Verbatim Input"); break;
240 case VERBAST: temp += _("Verbatim Input*"); break;
241 case INCLUDE: temp += _("Include"); break;
246 if (params_.cparams.getContents().empty())
249 temp += params_.cparams.getContents();
255 string const InsetInclude::getFileName() const
257 return MakeAbsPath(params_.cparams.getContents(),
258 OnlyPath(getMasterFilename()));
262 string const InsetInclude::getMasterFilename() const
264 return params_.masterFilename_;
268 bool InsetInclude::loadIfNeeded() const
273 if (!IsLyXFilename(getFileName()))
276 if (bufferlist.exists(getFileName()))
279 // the readonly flag can/will be wrong, not anymore I think.
280 FileInfo finfo(getFileName());
284 return bufferlist.loadLyXFile(getFileName(), false) != 0;
288 int InsetInclude::latex(Buffer const * buffer, ostream & os,
289 LatexRunParams const & runparams,
290 bool /*fragile*/, bool /*fs*/) const
292 string incfile(params_.cparams.getContents());
294 // Do nothing if no file name has been specified
298 if (loadIfNeeded()) {
299 Buffer * tmp = bufferlist.getBuffer(getFileName());
301 // FIXME: this should be a GUI warning
302 if (tmp->params.textclass != buffer->params.textclass) {
303 lyxerr << "WARNING: Included file `"
304 << MakeDisplayPath(getFileName())
305 << "' has textclass `"
306 << tmp->params.getLyXTextClass().name()
307 << "' while parent file has textclass `"
308 << buffer->params.getLyXTextClass().name()
313 // write it to a file (so far the complete file)
314 string writefile = ChangeExtension(getFileName(), ".tex");
316 if (!buffer->tmppath.empty()
317 && !buffer->niceFile) {
318 incfile = subst(incfile, '/','@');
320 incfile = subst(incfile, ':', '$');
322 writefile = AddName(buffer->tmppath, incfile);
324 writefile = getFileName();
325 writefile = ChangeExtension(writefile, ".tex");
326 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
327 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
329 tmp->markDepClean(buffer->tmppath);
331 tmp->makeLaTeXFile(writefile,
332 OnlyPath(getMasterFilename()),
334 buffer->niceFile, true);
338 os << '\\' << params_.cparams.getCmdName() << '{' << incfile << '}';
339 } else if (params_.flag == INPUT) {
340 // \input wants file with extension (default is .tex)
341 if (!IsLyXFilename(getFileName())) {
342 os << '\\' << params_.cparams.getCmdName() << '{' << incfile << '}';
344 os << '\\' << params_.cparams.getCmdName() << '{'
345 << ChangeExtension(incfile, ".tex")
349 // \include don't want extension and demands that the
350 // file really have .tex
351 os << '\\' << params_.cparams.getCmdName() << '{'
352 << ChangeExtension(incfile, string())
360 int InsetInclude::ascii(Buffer const *, ostream & os, int) const
363 os << GetFileContents(getFileName());
368 int InsetInclude::linuxdoc(Buffer const * buffer, ostream & os) const
370 string incfile(params_.cparams.getContents());
372 // Do nothing if no file name has been specified
376 if (loadIfNeeded()) {
377 Buffer * tmp = bufferlist.getBuffer(getFileName());
379 // write it to a file (so far the complete file)
380 string writefile = ChangeExtension(getFileName(), ".sgml");
381 if (!buffer->tmppath.empty() && !buffer->niceFile) {
382 incfile = subst(incfile, '/','@');
383 writefile = AddName(buffer->tmppath, incfile);
385 writefile = getFileName();
387 if (IsLyXFilename(getFileName()))
388 writefile = ChangeExtension(writefile, ".sgml");
390 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
391 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
393 tmp->makeLinuxDocFile(writefile, buffer->niceFile, true);
398 << GetFileContents(getFileName())
401 os << '&' << include_label << ';';
407 int InsetInclude::docbook(Buffer const * buffer, ostream & os,
408 bool /*mixcont*/) const
410 string incfile(params_.cparams.getContents());
412 // Do nothing if no file name has been specified
416 if (loadIfNeeded()) {
417 Buffer * tmp = bufferlist.getBuffer(getFileName());
419 // write it to a file (so far the complete file)
420 string writefile = ChangeExtension(getFileName(), ".sgml");
421 if (!buffer->tmppath.empty() && !buffer->niceFile) {
422 incfile = subst(incfile, '/','@');
423 writefile = AddName(buffer->tmppath, incfile);
425 writefile = getFileName();
426 if (IsLyXFilename(getFileName()))
427 writefile = ChangeExtension(writefile, ".sgml");
429 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
430 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
432 tmp->makeDocBookFile(writefile, buffer->niceFile, true);
436 os << "<inlinegraphic fileref=\""
437 << '&' << include_label << ';'
438 << "\" format=\"linespecific\">";
440 os << '&' << include_label << ';';
446 void InsetInclude::validate(LaTeXFeatures & features) const
449 string incfile(params_.cparams.getContents());
452 Buffer const * const b = bufferlist.getBuffer(getMasterFilename());
454 if (b && !b->tmppath.empty() && !b->niceFile && !isVerbatim()) {
455 incfile = subst(incfile, '/','@');
456 writefile = AddName(b->tmppath, incfile);
458 writefile = getFileName();
460 if (IsLyXFilename(getFileName()))
461 writefile = ChangeExtension(writefile, ".sgml");
463 features.includeFile(include_label, writefile);
466 features.require("verbatim");
468 // Here we must do the fun stuff...
469 // Load the file in the include if it needs
471 if (loadIfNeeded()) {
473 Buffer * const tmp = bufferlist.getBuffer(getFileName());
476 tmp->niceFile = b->niceFile;
477 tmp->validate(features);
483 vector<string> const InsetInclude::getLabelList() const
487 if (loadIfNeeded()) {
488 Buffer * tmp = bufferlist.getBuffer(getFileName());
489 tmp->setParentName("");
490 l = tmp->getLabelList();
491 tmp->setParentName(getMasterFilename());
498 void InsetInclude::fillWithBibKeys(vector<pair<string,string> > & keys) const
500 if (loadIfNeeded()) {
501 Buffer * tmp = bufferlist.getBuffer(getFileName());
502 tmp->setParentName("");
503 tmp->fillWithBibKeys(keys);
504 tmp->setParentName(getMasterFilename());
509 int InsetInclude::ascent(BufferView * bv, LyXFont const & font) const
511 return preview_->previewReady() ?
512 preview_->pimage()->ascent() : InsetButton::ascent(bv, font);
516 int InsetInclude::descent(BufferView * bv, LyXFont const & font) const
518 return preview_->previewReady() ?
519 preview_->pimage()->descent() : InsetButton::descent(bv, font);
523 int InsetInclude::width(BufferView * bv, LyXFont const & font) const
525 return preview_->previewReady() ?
526 preview_->pimage()->width() : InsetButton::width(bv, font);
530 void InsetInclude::draw(BufferView * bv, LyXFont const & font, int y,
534 if (!preview_->previewReady()) {
535 InsetButton::draw(bv, font, y, xx);
539 if (!preview_->monitoring())
540 preview_->startMonitoring();
542 int const x = int(xx);
543 int const w = width(bv, font);
544 int const d = descent(bv, font);
545 int const a = ascent(bv, font);
548 bv->painter().image(x, y - a, w, h,
549 *(preview_->pimage()->image()));
559 void InsetInclude::addPreview(grfx::PreviewLoader & ploader) const
561 preview_->addPreview(ploader);
565 bool InsetInclude::PreviewImpl::previewWanted() const
567 return parent().params_.flag == InsetInclude::INPUT &&
568 parent().params_.cparams.preview() &&
569 IsFileReadable(parent().getFileName());
573 string const InsetInclude::PreviewImpl::latexString() const
575 if (!view() || !view()->buffer())
579 LatexRunParams runparams;
580 runparams.flavor = LatexRunParams::LATEX;
581 parent().latex(view()->buffer(), os, runparams, false, false);
583 return STRCONV(os.str());
587 void InsetInclude::PreviewImpl::startMonitoring()
589 monitor_.reset(new FileMonitor(parent().getFileName(), 2000));
590 monitor_->connect(boost::bind(&PreviewImpl::restartLoading, this));
595 void InsetInclude::PreviewImpl::restartLoading()
597 lyxerr << "restartLoading()" << std::endl;
600 view()->updateInset(&parent());
605 string const InsetIncludeMailer::name_("include");
607 InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset)
612 string const InsetIncludeMailer::inset2string() const
614 return params2string(inset_.params());
618 void InsetIncludeMailer::string2params(string const & in,
619 InsetInclude::Params & params)
621 params = InsetInclude::Params();
626 istringstream data(STRCONV(in));
632 string const token = lex.getString();
637 // This is part of the inset proper that is usually swallowed
638 // by Buffer::readInset
641 string const token = lex.getString();
642 if (token != "Include")
647 InsetInclude inset(params);
649 params = inset.params();
655 InsetIncludeMailer::params2string(InsetInclude::Params const & params)
657 InsetInclude inset(params);
660 data << name_ << ' ';
661 inset.write(0, data);
662 data << "\\end_inset\n";
663 return STRCONV(data.str());