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"
16 #include "buffer_funcs.h"
17 #include "bufferlist.h"
18 #include "bufferparams.h"
19 #include "BufferView.h"
21 #include "dispatchresult.h"
22 #include "funcrequest.h"
24 #include "LaTeXFeatures.h"
25 #include "latexrunparams.h"
28 #include "metricsinfo.h"
30 #include "frontends/LyXView.h"
31 #include "frontends/Painter.h"
33 #include "graphics/PreviewLoader.h"
35 #include "insets/render_preview.h"
37 #include "support/FileInfo.h"
38 #include "support/filetools.h"
39 #include "support/lstrings.h" // contains
40 #include "support/tostr.h"
42 #include <boost/bind.hpp>
44 #include "support/std_ostream.h"
45 #include "support/std_sstream.h"
47 using lyx::support::AddName;
48 using lyx::support::ChangeExtension;
49 using lyx::support::contains;
50 using lyx::support::FileInfo;
51 using lyx::support::GetFileContents;
52 using lyx::support::IsFileReadable;
53 using lyx::support::IsLyXFilename;
54 using lyx::support::MakeAbsPath;
55 using lyx::support::MakeDisplayPath;
56 using lyx::support::OnlyFilename;
57 using lyx::support::OnlyPath;
58 using lyx::support::subst;
63 using std::istringstream;
65 using std::ostringstream;
68 extern BufferList bufferlist;
73 string const uniqueID()
75 static unsigned int seed = 1000;
76 return "file" + tostr(++seed);
82 InsetInclude::InsetInclude(InsetCommandParams const & p)
83 : params_(p), include_label(uniqueID()),
84 preview_(new RenderMonitoredPreview),
87 preview_->connect(boost::bind(&InsetInclude::statusChanged, this));
88 preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
92 InsetInclude::InsetInclude(InsetInclude const & other)
94 params_(other.params_),
95 include_label(other.include_label),
96 preview_(new RenderMonitoredPreview),
97 set_label_(other.set_label_)
99 preview_->connect(boost::bind(&InsetInclude::statusChanged, this));
100 preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
104 InsetInclude::~InsetInclude()
106 InsetIncludeMailer mailer(*this);
112 InsetInclude::priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &)
114 switch (cmd.action) {
116 case LFUN_INSET_MODIFY: {
117 InsetCommandParams p;
118 InsetIncludeMailer::string2params(cmd.argument, p);
119 if (!p.getCmdName().empty()) {
120 set(p, *cmd.view()->buffer());
121 cmd.view()->updateInset(this);
123 return DispatchResult(true);
126 case LFUN_INSET_DIALOG_UPDATE:
127 InsetIncludeMailer(*this).updateDialog(cmd.view());
128 return DispatchResult(true);
130 case LFUN_MOUSE_RELEASE:
131 if (button_.box().contains(cmd.x, cmd.y))
132 InsetIncludeMailer(*this).showDialog(cmd.view());
133 return DispatchResult(true);
135 case LFUN_INSET_DIALOG_SHOW:
136 InsetIncludeMailer(*this).showDialog(cmd.view());
137 return DispatchResult(true);
140 return DispatchResult(false);
145 InsetCommandParams const & InsetInclude::params() const
153 /// the type of inclusion
162 Types type(InsetCommandParams const & params)
164 string const command_name = params.getCmdName();
166 if (command_name == "input")
168 if (command_name == "verbatiminput")
170 if (command_name == "verbatiminput*")
176 bool isVerbatim(InsetCommandParams const & params)
178 string const command_name = params.getCmdName();
179 return command_name == "verbatiminput" ||
180 command_name == "verbatiminput*";
184 string const masterFilename(Buffer const & buffer)
186 return buffer.fileName();
190 string const includedFilename(Buffer const & buffer,
191 InsetCommandParams const & params)
193 return MakeAbsPath(params.getContents(),
194 OnlyPath(masterFilename(buffer)));
198 void add_preview(RenderMonitoredPreview &, InsetInclude const &, Buffer const &);
203 void InsetInclude::set(InsetCommandParams const & p, Buffer const & buffer)
208 if (preview_->monitoring())
209 preview_->stopMonitoring();
211 if (type(params_) == INPUT)
212 add_preview(*preview_, *this, buffer);
216 auto_ptr<InsetBase> InsetInclude::clone() const
218 return auto_ptr<InsetBase>(new InsetInclude(*this));
222 void InsetInclude::write(Buffer const &, ostream & os) const
228 void InsetInclude::write(ostream & os) const
230 os << "Include " << params_.getCommand() << '\n'
231 << "preview " << tostr(params_.preview()) << '\n';
235 void InsetInclude::read(Buffer const &, LyXLex & lex)
241 void InsetInclude::read(LyXLex & lex)
247 string const InsetInclude::getScreenLabel(Buffer const &) const
251 switch (type(params_)) {
252 case INPUT: temp += _("Input"); break;
253 case VERB: temp += _("Verbatim Input"); break;
254 case VERBAST: temp += _("Verbatim Input*"); break;
255 case INCLUDE: temp += _("Include"); break;
260 if (params_.getContents().empty())
263 temp += OnlyFilename(params_.getContents());
271 /// return true if the file is or got loaded.
272 bool loadIfNeeded(Buffer const & buffer, InsetCommandParams const & params)
274 if (isVerbatim(params))
277 string const included_file = includedFilename(buffer, params);
278 if (!IsLyXFilename(included_file))
281 if (bufferlist.exists(included_file))
284 // the readonly flag can/will be wrong, not anymore I think.
285 FileInfo finfo(included_file);
288 return loadLyXFile(bufferlist.newBuffer(included_file),
296 int InsetInclude::latex(Buffer const & buffer, ostream & os,
297 LatexRunParams const & runparams) const
299 string incfile(params_.getContents());
301 // Do nothing if no file name has been specified
305 string const included_file = includedFilename(buffer, params_);
307 if (loadIfNeeded(buffer, params_)) {
308 Buffer * tmp = bufferlist.getBuffer(included_file);
310 // FIXME: this should be a GUI warning
311 if (tmp->params().textclass != buffer.params().textclass) {
312 lyxerr << "WARNING: Included file `"
313 << MakeDisplayPath(included_file)
314 << "' has textclass `"
315 << tmp->params().getLyXTextClass().name()
316 << "' while parent file has textclass `"
317 << buffer.params().getLyXTextClass().name()
322 // write it to a file (so far the complete file)
323 string writefile = ChangeExtension(included_file, ".tex");
325 if (!buffer.temppath().empty() && !runparams.nice) {
326 incfile = subst(incfile, '/','@');
328 incfile = subst(incfile, ':', '$');
330 writefile = AddName(buffer.temppath(), incfile);
332 writefile = included_file;
333 writefile = ChangeExtension(writefile, ".tex");
334 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
335 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
337 tmp->markDepClean(buffer.temppath());
339 tmp->makeLaTeXFile(writefile,
340 OnlyPath(masterFilename(buffer)),
344 if (isVerbatim(params_)) {
345 os << '\\' << params_.getCmdName() << '{' << incfile << '}';
346 } else if (type(params_) == INPUT) {
347 // \input wants file with extension (default is .tex)
348 if (!IsLyXFilename(included_file)) {
349 os << '\\' << params_.getCmdName() << '{' << incfile << '}';
351 os << '\\' << params_.getCmdName() << '{'
352 << ChangeExtension(incfile, ".tex")
356 // \include don't want extension and demands that the
357 // file really have .tex
358 os << '\\' << params_.getCmdName() << '{'
359 << ChangeExtension(incfile, string())
367 int InsetInclude::ascii(Buffer const & buffer, ostream & os,
368 LatexRunParams const &) const
370 if (isVerbatim(params_))
371 os << GetFileContents(includedFilename(buffer, params_));
376 int InsetInclude::linuxdoc(Buffer const & buffer, ostream & os,
377 LatexRunParams const & runparams) const
379 string incfile(params_.getContents());
381 // Do nothing if no file name has been specified
385 string const included_file = includedFilename(buffer, params_);
387 if (loadIfNeeded(buffer, params_)) {
388 Buffer * tmp = bufferlist.getBuffer(included_file);
390 // write it to a file (so far the complete file)
391 string writefile = ChangeExtension(included_file, ".sgml");
392 if (!buffer.temppath().empty() && !buffer.niceFile()) {
393 incfile = subst(incfile, '/','@');
394 writefile = AddName(buffer.temppath(), incfile);
396 writefile = included_file;
398 if (IsLyXFilename(included_file))
399 writefile = ChangeExtension(writefile, ".sgml");
401 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
402 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
404 LatexRunParams runp = runparams;
405 runp.nice = buffer.niceFile();
406 tmp->makeLinuxDocFile(writefile, runp, true);
409 if (isVerbatim(params_)) {
411 << GetFileContents(included_file)
414 os << '&' << include_label << ';';
420 int InsetInclude::docbook(Buffer const & buffer, ostream & os,
421 LatexRunParams const & runparams) const
423 string incfile(params_.getContents());
425 // Do nothing if no file name has been specified
429 string const included_file = includedFilename(buffer, params_);
431 if (loadIfNeeded(buffer, params_)) {
432 Buffer * tmp = bufferlist.getBuffer(included_file);
434 // write it to a file (so far the complete file)
435 string writefile = ChangeExtension(included_file, ".sgml");
436 if (!buffer.temppath().empty() && !buffer.niceFile()) {
437 incfile = subst(incfile, '/','@');
438 writefile = AddName(buffer.temppath(), incfile);
440 writefile = included_file;
441 if (IsLyXFilename(included_file))
442 writefile = ChangeExtension(writefile, ".sgml");
444 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
445 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
447 LatexRunParams runp = runparams;
448 runp.nice = buffer.niceFile();
449 tmp->makeDocBookFile(writefile, runp, true);
452 if (isVerbatim(params_)) {
453 os << "<inlinegraphic fileref=\""
454 << '&' << include_label << ';'
455 << "\" format=\"linespecific\">";
457 os << '&' << include_label << ';';
463 void InsetInclude::validate(LaTeXFeatures & features) const
465 string incfile(params_.getContents());
468 Buffer const & buffer = features.buffer();
470 string const included_file = includedFilename(buffer, params_);
472 if (!buffer.temppath().empty() &&
473 !buffer.niceFile() &&
474 !isVerbatim(params_)) {
475 incfile = subst(incfile, '/','@');
476 writefile = AddName(buffer.temppath(), incfile);
478 writefile = included_file;
480 if (IsLyXFilename(included_file))
481 writefile = ChangeExtension(writefile, ".sgml");
483 features.includeFile(include_label, writefile);
485 if (isVerbatim(params_))
486 features.require("verbatim");
488 // Here we must do the fun stuff...
489 // Load the file in the include if it needs
491 if (loadIfNeeded(buffer, params_)) {
493 Buffer * const tmp = bufferlist.getBuffer(included_file);
495 tmp->niceFile() = buffer.niceFile();
496 tmp->validate(features);
502 void InsetInclude::getLabelList(Buffer const & buffer,
503 std::vector<string> & list) const
505 if (loadIfNeeded(buffer, params_)) {
506 string const included_file = includedFilename(buffer, params_);
507 Buffer * tmp = bufferlist.getBuffer(included_file);
508 tmp->setParentName("");
509 tmp->getLabelList(list);
510 tmp->setParentName(masterFilename(buffer));
515 void InsetInclude::fillWithBibKeys(Buffer const & buffer,
516 std::vector<std::pair<string,string> > & keys) const
518 if (loadIfNeeded(buffer, params_)) {
519 string const included_file = includedFilename(buffer, params_);
520 Buffer * tmp = bufferlist.getBuffer(included_file);
521 tmp->setParentName("");
522 tmp->fillWithBibKeys(keys);
523 tmp->setParentName(masterFilename(buffer));
528 void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
530 if (RenderPreview::activated() && preview_->previewReady()) {
531 preview_->metrics(mi, dim);
535 button_.update(getScreenLabel(*mi.base.bv->buffer()),
536 editable() != NOT_EDITABLE);
538 button_.metrics(mi, dim);
540 int center_indent = type(params_) == INPUT ?
541 0 : (mi.base.textwidth - dim.wid) / 2;
542 Box b(center_indent, center_indent + dim.wid, -dim.asc, dim.des);
545 dim.wid = mi.base.textwidth;
550 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
552 if (!RenderPreview::activated() || !preview_->previewReady()) {
553 button_.draw(pi, x + button_.box().x1, y);
557 preview_->draw(pi, x + button_.box().x1, y);
565 void InsetInclude::statusChanged() const
567 LyX::cref().updateInset(this);
571 void InsetInclude::fileChanged() const
573 Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
577 Buffer const & buffer = *buffer_ptr;
578 preview_->removePreview(buffer);
579 add_preview(*preview_.get(), *this, buffer);
580 preview_->startLoading(buffer);
586 bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
588 string const included_file = includedFilename(buffer, params);
590 return type(params) == INPUT && params.preview() &&
591 IsFileReadable(included_file);
595 string const latex_string(InsetInclude const & inset, Buffer const & buffer)
598 LatexRunParams runparams;
599 runparams.flavor = LatexRunParams::LATEX;
600 inset.latex(buffer, os, runparams);
606 void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
607 Buffer const & buffer)
609 InsetCommandParams const & params = inset.params();
610 if (RenderPreview::activated() && preview_wanted(params, buffer)) {
611 renderer.setAbsFile(includedFilename(buffer, params));
612 string const snippet = latex_string(inset, buffer);
613 renderer.addPreview(snippet, buffer);
620 void InsetInclude::addPreview(lyx::graphics::PreviewLoader & ploader) const
622 Buffer const & buffer = ploader.buffer();
623 if (preview_wanted(params(), buffer)) {
624 preview_->setAbsFile(includedFilename(buffer, params()));
625 string const snippet = latex_string(*this, buffer);
626 preview_->addPreview(snippet, ploader);
631 string const InsetIncludeMailer::name_("include");
633 InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset)
638 string const InsetIncludeMailer::inset2string(Buffer const &) const
640 return params2string(inset_.params());
644 void InsetIncludeMailer::string2params(string const & in,
645 InsetCommandParams & params)
647 params = InsetCommandParams();
652 istringstream data(in);
658 string const token = lex.getString();
663 // This is part of the inset proper that is usually swallowed
664 // by Buffer::readInset
667 string const token = lex.getString();
668 if (token != "Include")
673 InsetInclude inset(params);
675 params = inset.params();
681 InsetIncludeMailer::params2string(InsetCommandParams const & params)
683 InsetInclude inset(params);
685 data << name_ << ' ';
687 data << "\\end_inset\n";