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() && !runparams.nice) {
317 incfile = subst(incfile, '/','@');
319 incfile = subst(incfile, ':', '$');
321 writefile = AddName(buffer->tmppath, incfile);
323 writefile = getFileName();
324 writefile = ChangeExtension(writefile, ".tex");
325 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
326 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
328 tmp->markDepClean(buffer->tmppath);
330 tmp->makeLaTeXFile(writefile, OnlyPath(getMasterFilename()),
335 os << '\\' << params_.cparams.getCmdName() << '{' << incfile << '}';
336 } else if (params_.flag == INPUT) {
337 // \input wants file with extension (default is .tex)
338 if (!IsLyXFilename(getFileName())) {
339 os << '\\' << params_.cparams.getCmdName() << '{' << incfile << '}';
341 os << '\\' << params_.cparams.getCmdName() << '{'
342 << ChangeExtension(incfile, ".tex")
346 // \include don't want extension and demands that the
347 // file really have .tex
348 os << '\\' << params_.cparams.getCmdName() << '{'
349 << ChangeExtension(incfile, string())
357 int InsetInclude::ascii(Buffer const *, ostream & os, int) const
360 os << GetFileContents(getFileName());
365 int InsetInclude::linuxdoc(Buffer const * buffer, ostream & os) const
367 string incfile(params_.cparams.getContents());
369 // Do nothing if no file name has been specified
373 if (loadIfNeeded()) {
374 Buffer * tmp = bufferlist.getBuffer(getFileName());
376 // write it to a file (so far the complete file)
377 string writefile = ChangeExtension(getFileName(), ".sgml");
378 if (!buffer->tmppath.empty() && !buffer->niceFile) {
379 incfile = subst(incfile, '/','@');
380 writefile = AddName(buffer->tmppath, incfile);
382 writefile = getFileName();
384 if (IsLyXFilename(getFileName()))
385 writefile = ChangeExtension(writefile, ".sgml");
387 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
388 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
390 tmp->makeLinuxDocFile(writefile, buffer->niceFile, true);
395 << GetFileContents(getFileName())
398 os << '&' << include_label << ';';
404 int InsetInclude::docbook(Buffer const * buffer, ostream & os,
405 bool /*mixcont*/) const
407 string incfile(params_.cparams.getContents());
409 // Do nothing if no file name has been specified
413 if (loadIfNeeded()) {
414 Buffer * tmp = bufferlist.getBuffer(getFileName());
416 // write it to a file (so far the complete file)
417 string writefile = ChangeExtension(getFileName(), ".sgml");
418 if (!buffer->tmppath.empty() && !buffer->niceFile) {
419 incfile = subst(incfile, '/','@');
420 writefile = AddName(buffer->tmppath, incfile);
422 writefile = getFileName();
423 if (IsLyXFilename(getFileName()))
424 writefile = ChangeExtension(writefile, ".sgml");
426 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
427 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
429 tmp->makeDocBookFile(writefile, buffer->niceFile, true);
433 os << "<inlinegraphic fileref=\""
434 << '&' << include_label << ';'
435 << "\" format=\"linespecific\">";
437 os << '&' << include_label << ';';
443 void InsetInclude::validate(LaTeXFeatures & features) const
446 string incfile(params_.cparams.getContents());
449 Buffer const * const b = bufferlist.getBuffer(getMasterFilename());
451 if (b && !b->tmppath.empty() && !b->niceFile && !isVerbatim()) {
452 incfile = subst(incfile, '/','@');
453 writefile = AddName(b->tmppath, incfile);
455 writefile = getFileName();
457 if (IsLyXFilename(getFileName()))
458 writefile = ChangeExtension(writefile, ".sgml");
460 features.includeFile(include_label, writefile);
463 features.require("verbatim");
465 // Here we must do the fun stuff...
466 // Load the file in the include if it needs
468 if (loadIfNeeded()) {
470 Buffer * const tmp = bufferlist.getBuffer(getFileName());
473 tmp->niceFile = b->niceFile;
474 tmp->validate(features);
480 vector<string> const InsetInclude::getLabelList() const
484 if (loadIfNeeded()) {
485 Buffer * tmp = bufferlist.getBuffer(getFileName());
486 tmp->setParentName("");
487 l = tmp->getLabelList();
488 tmp->setParentName(getMasterFilename());
495 void InsetInclude::fillWithBibKeys(vector<pair<string,string> > & keys) const
497 if (loadIfNeeded()) {
498 Buffer * tmp = bufferlist.getBuffer(getFileName());
499 tmp->setParentName("");
500 tmp->fillWithBibKeys(keys);
501 tmp->setParentName(getMasterFilename());
506 int InsetInclude::ascent(BufferView * bv, LyXFont const & font) const
508 return preview_->previewReady() ?
509 preview_->pimage()->ascent() : InsetButton::ascent(bv, font);
513 int InsetInclude::descent(BufferView * bv, LyXFont const & font) const
515 return preview_->previewReady() ?
516 preview_->pimage()->descent() : InsetButton::descent(bv, font);
520 int InsetInclude::width(BufferView * bv, LyXFont const & font) const
522 return preview_->previewReady() ?
523 preview_->pimage()->width() : InsetButton::width(bv, font);
527 void InsetInclude::draw(BufferView * bv, LyXFont const & font, int y,
531 if (!preview_->previewReady()) {
532 InsetButton::draw(bv, font, y, xx);
536 if (!preview_->monitoring())
537 preview_->startMonitoring();
539 int const x = int(xx);
540 int const w = width(bv, font);
541 int const d = descent(bv, font);
542 int const a = ascent(bv, font);
545 bv->painter().image(x, y - a, w, h,
546 *(preview_->pimage()->image()));
556 void InsetInclude::addPreview(grfx::PreviewLoader & ploader) const
558 preview_->addPreview(ploader);
562 bool InsetInclude::PreviewImpl::previewWanted() const
564 return parent().params_.flag == InsetInclude::INPUT &&
565 parent().params_.cparams.preview() &&
566 IsFileReadable(parent().getFileName());
570 string const InsetInclude::PreviewImpl::latexString() const
572 if (!view() || !view()->buffer())
576 LatexRunParams runparams;
577 runparams.flavor = LatexRunParams::LATEX;
578 parent().latex(view()->buffer(), os, runparams, false, false);
580 return STRCONV(os.str());
584 void InsetInclude::PreviewImpl::startMonitoring()
586 monitor_.reset(new FileMonitor(parent().getFileName(), 2000));
587 monitor_->connect(boost::bind(&PreviewImpl::restartLoading, this));
592 void InsetInclude::PreviewImpl::restartLoading()
594 lyxerr << "restartLoading()" << std::endl;
597 view()->updateInset(&parent());
602 string const InsetIncludeMailer::name_("include");
604 InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset)
609 string const InsetIncludeMailer::inset2string() const
611 return params2string(inset_.params());
615 void InsetIncludeMailer::string2params(string const & in,
616 InsetInclude::Params & params)
618 params = InsetInclude::Params();
623 istringstream data(STRCONV(in));
629 string const token = lex.getString();
634 // This is part of the inset proper that is usually swallowed
635 // by Buffer::readInset
638 string const token = lex.getString();
639 if (token != "Include")
644 InsetInclude inset(params);
646 params = inset.params();
652 InsetIncludeMailer::params2string(InsetInclude::Params const & params)
654 InsetInclude inset(params);
657 data << name_ << ' ';
658 inset.write(0, data);
659 data << "\\end_inset\n";
660 return STRCONV(data.str());