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"
22 #include "dispatchresult.h"
24 #include "funcrequest.h"
25 #include "FuncStatus.h"
27 #include "LaTeXFeatures.h"
31 #include "metricsinfo.h"
32 #include "outputparams.h"
34 #include "frontends/Alert.h"
35 #include "frontends/Application.h"
36 #include "frontends/Painter.h"
38 #include "graphics/PreviewImage.h"
39 #include "graphics/PreviewLoader.h"
41 #include "insets/render_preview.h"
43 #include "support/lyxalgo.h"
44 #include "support/filename.h"
45 #include "support/filetools.h"
46 #include "support/lstrings.h" // contains
47 #include "support/lyxlib.h"
48 #include "support/convert.h"
50 #include <boost/bind.hpp>
51 #include <boost/filesystem/operations.hpp>
53 #include "support/std_ostream.h"
58 using lyx::support::addName;
59 using lyx::support::absolutePath;
60 using lyx::support::bformat;
61 using lyx::support::changeExtension;
62 using lyx::support::contains;
63 using lyx::support::copy;
64 using lyx::support::FileName;
65 using lyx::support::getFileContents;
66 using lyx::support::isFileReadable;
67 using lyx::support::isLyXFilename;
68 using lyx::support::latex_path;
69 using lyx::support::makeAbsPath;
70 using lyx::support::makeDisplayPath;
71 using lyx::support::makeRelPath;
72 using lyx::support::onlyFilename;
73 using lyx::support::onlyPath;
74 using lyx::support::subst;
75 using lyx::support::sum;
80 using std::istringstream;
82 using std::ostringstream;
84 namespace Alert = lyx::frontend::Alert;
85 namespace fs = boost::filesystem;
90 string const uniqueID()
92 static unsigned int seed = 1000;
93 return "file" + convert<string>(++seed);
99 InsetInclude::InsetInclude(InsetCommandParams const & p)
100 : params_(p), include_label(uniqueID()),
101 preview_(new RenderMonitoredPreview(this)),
104 preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
108 InsetInclude::InsetInclude(InsetInclude const & other)
110 params_(other.params_),
111 include_label(other.include_label),
112 preview_(new RenderMonitoredPreview(this)),
115 preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
119 InsetInclude::~InsetInclude()
121 InsetIncludeMailer(*this).hideDialog();
125 void InsetInclude::doDispatch(LCursor & cur, FuncRequest & cmd)
127 switch (cmd.action) {
129 case LFUN_INSET_MODIFY: {
130 InsetCommandParams p;
131 InsetIncludeMailer::string2params(lyx::to_utf8(cmd.argument()), p);
132 if (!p.getCmdName().empty()) {
133 set(p, cur.buffer());
134 cur.buffer().updateBibfilesCache();
140 case LFUN_INSET_DIALOG_UPDATE:
141 InsetIncludeMailer(*this).updateDialog(&cur.bv());
144 case LFUN_MOUSE_RELEASE:
145 InsetIncludeMailer(*this).showDialog(&cur.bv());
149 InsetBase::doDispatch(cur, cmd);
155 bool InsetInclude::getStatus(LCursor & cur, FuncRequest const & cmd,
156 FuncStatus & flag) const
158 switch (cmd.action) {
160 case LFUN_INSET_MODIFY:
161 case LFUN_INSET_DIALOG_UPDATE:
166 return InsetBase::getStatus(cur, cmd, flag);
171 InsetCommandParams const & InsetInclude::params() const
179 /// the type of inclusion
188 Types type(InsetCommandParams const & params)
190 string const command_name = params.getCmdName();
192 if (command_name == "input")
194 if (command_name == "verbatiminput")
196 if (command_name == "verbatiminput*")
202 bool isVerbatim(InsetCommandParams const & params)
204 string const command_name = params.getCmdName();
205 return command_name == "verbatiminput" ||
206 command_name == "verbatiminput*";
210 string const masterFilename(Buffer const & buffer)
212 return buffer.getMasterBuffer()->fileName();
216 string const parentFilename(Buffer const & buffer)
218 return buffer.fileName();
222 string const includedFilename(Buffer const & buffer,
223 InsetCommandParams const & params)
225 return makeAbsPath(params.getContents(),
226 onlyPath(parentFilename(buffer)));
230 void add_preview(RenderMonitoredPreview &, InsetInclude const &, Buffer const &);
235 void InsetInclude::set(InsetCommandParams const & p, Buffer const & buffer)
240 if (preview_->monitoring())
241 preview_->stopMonitoring();
243 if (type(params_) == INPUT)
244 add_preview(*preview_, *this, buffer);
248 auto_ptr<InsetBase> InsetInclude::doClone() const
250 return auto_ptr<InsetBase>(new InsetInclude(*this));
254 void InsetInclude::write(Buffer const &, ostream & os) const
260 void InsetInclude::write(ostream & os) const
262 os << "Include " << params_.getCommand() << '\n'
263 << "preview " << convert<string>(params_.preview()) << '\n';
267 void InsetInclude::read(Buffer const &, LyXLex & lex)
273 void InsetInclude::read(LyXLex & lex)
279 string const InsetInclude::getScreenLabel(Buffer const &) const
283 switch (type(params_)) {
288 temp += _("Verbatim Input");
291 temp += _("Verbatim Input*");
294 temp += _("Include");
298 temp += lyx::from_ascii(": ");
300 if (params_.getContents().empty())
301 temp += lyx::from_ascii("???");
303 temp += lyx::from_ascii(onlyFilename(params_.getContents()));
306 return lyx::to_utf8(temp);
312 /// return the child buffer if the file is a LyX doc and is loaded
313 Buffer * getChildBuffer(Buffer const & buffer, InsetCommandParams const & params)
315 if (isVerbatim(params))
318 string const included_file = includedFilename(buffer, params);
319 if (!isLyXFilename(included_file))
322 return theApp->bufferList().getBuffer(included_file);
326 /// return true if the file is or got loaded.
327 bool loadIfNeeded(Buffer const & buffer, InsetCommandParams const & params)
329 if (isVerbatim(params))
332 string const included_file = includedFilename(buffer, params);
333 if (!isLyXFilename(included_file))
336 Buffer * buf = theApp->bufferList().getBuffer(included_file);
338 // the readonly flag can/will be wrong, not anymore I think.
339 if (!fs::exists(included_file))
341 buf = theApp->bufferList().newBuffer(included_file);
342 if (!loadLyXFile(buf, included_file))
346 buf->setParentName(parentFilename(buffer));
354 int InsetInclude::latex(Buffer const & buffer, ostream & os,
355 OutputParams const & runparams) const
357 string incfile(params_.getContents());
359 // Do nothing if no file name has been specified
363 string const included_file = includedFilename(buffer, params_);
364 Buffer const * const m_buffer = buffer.getMasterBuffer();
366 // if incfile is relative, make it relative to the master
368 if (!absolutePath(incfile)) {
369 incfile = makeRelPath(included_file,
370 m_buffer->filePath());
373 // write it to a file (so far the complete file)
374 string const exportfile = changeExtension(incfile, ".tex");
375 string const mangled = FileName(changeExtension(included_file,
376 ".tex")).mangledFilename();
377 string const writefile = makeAbsPath(mangled, m_buffer->temppath());
381 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
382 lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl;
383 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
385 if (runparams.inComment || runparams.dryrun)
386 // Don't try to load or copy the file
388 else if (loadIfNeeded(buffer, params_)) {
389 Buffer * tmp = theApp->bufferList().getBuffer(included_file);
391 if (tmp->params().textclass != m_buffer->params().textclass) {
393 docstring text = bformat(_("Included file `%1$s'\n"
394 "has textclass `%2$s'\n"
395 "while parent file has textclass `%3$s'."),
396 makeDisplayPath(included_file),
397 lyx::from_utf8(tmp->params().getLyXTextClass().name()),
398 lyx::from_utf8(m_buffer->params().getLyXTextClass().name()));
399 Alert::warning(_("Different textclasses"), text);
403 tmp->markDepClean(m_buffer->temppath());
406 #warning handle non existing files
407 #warning Second argument is irrelevant!
408 // since only_body is true, makeLaTeXFile will not look at second
409 // argument. Should we set it to string(), or should makeLaTeXFile
410 // make use of it somehow? (JMarc 20031002)
412 tmp->makeLaTeXFile(writefile,
413 onlyPath(masterFilename(buffer)),
416 // Copy the file to the temp dir, so that .aux files etc.
417 // are not created in the original dir. Files included by
418 // this file will be found via input@path, see ../buffer.C.
419 unsigned long const checksum_in = sum(included_file);
420 unsigned long const checksum_out = sum(writefile);
422 if (checksum_in != checksum_out) {
423 if (!copy(included_file, writefile)) {
426 << lyx::to_utf8(bformat(_("Could not copy the file\n%1$s\n"
427 "into the temporary directory."),
428 lyx::from_utf8(included_file)))
435 string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
436 "latex" : "pdflatex";
437 if (isVerbatim(params_)) {
438 incfile = latex_path(incfile);
439 os << '\\' << params_.getCmdName() << '{' << incfile << '}';
440 } else if (type(params_) == INPUT) {
441 runparams.exportdata->addExternalFile(tex_format, writefile,
444 // \input wants file with extension (default is .tex)
445 if (!isLyXFilename(included_file)) {
446 incfile = latex_path(incfile);
447 os << '\\' << params_.getCmdName() << '{' << incfile << '}';
449 incfile = changeExtension(incfile, ".tex");
450 incfile = latex_path(incfile);
451 os << '\\' << params_.getCmdName() << '{'
456 runparams.exportdata->addExternalFile(tex_format, writefile,
459 // \include don't want extension and demands that the
460 // file really have .tex
461 incfile = changeExtension(incfile, string());
462 incfile = latex_path(incfile);
463 os << '\\' << params_.getCmdName() << '{'
472 int InsetInclude::plaintext(Buffer const & buffer, ostream & os,
473 OutputParams const &) const
475 if (isVerbatim(params_)) {
477 getFileContents(includedFilename(buffer, params_));
479 // Return how many newlines we issued.
480 return int(lyx::count(str.begin(), str.end(), '\n'));
486 int InsetInclude::docbook(Buffer const & buffer, ostream & os,
487 OutputParams const & runparams) const
489 string incfile(params_.getContents());
491 // Do nothing if no file name has been specified
495 string const included_file = includedFilename(buffer, params_);
497 // write it to a file (so far the complete file)
498 string const exportfile = changeExtension(incfile, ".sgml");
499 string writefile = changeExtension(included_file, ".sgml");
501 if (loadIfNeeded(buffer, params_)) {
502 Buffer * tmp = theApp->bufferList().getBuffer(included_file);
504 string const mangled = FileName(writefile).mangledFilename();
505 writefile = makeAbsPath(mangled,
506 buffer.getMasterBuffer()->temppath());
510 lyxerr[Debug::LATEX] << "incfile:" << incfile << endl;
511 lyxerr[Debug::LATEX] << "exportfile:" << exportfile << endl;
512 lyxerr[Debug::LATEX] << "writefile:" << writefile << endl;
514 tmp->makeDocBookFile(writefile, runparams, true);
517 runparams.exportdata->addExternalFile("docbook", writefile,
519 runparams.exportdata->addExternalFile("docbook-xml", writefile,
522 if (isVerbatim(params_)) {
523 os << "<inlinegraphic fileref=\""
524 << '&' << include_label << ';'
525 << "\" format=\"linespecific\">";
527 os << '&' << include_label << ';';
533 void InsetInclude::validate(LaTeXFeatures & features) const
535 string incfile(params_.getContents());
538 Buffer const & buffer = features.buffer();
540 string const included_file = includedFilename(buffer, params_);
542 if (isLyXFilename(included_file))
543 writefile = changeExtension(included_file, ".sgml");
545 writefile = included_file;
547 if (!features.runparams().nice && !isVerbatim(params_)) {
548 incfile = FileName(writefile).mangledFilename();
549 writefile = makeAbsPath(incfile,
550 buffer.getMasterBuffer()->temppath());
553 features.includeFile(include_label, writefile);
555 if (isVerbatim(params_))
556 features.require("verbatim");
558 // Here we must do the fun stuff...
559 // Load the file in the include if it needs
561 if (loadIfNeeded(buffer, params_)) {
563 Buffer * const tmp = theApp->bufferList().getBuffer(included_file);
565 // We must temporarily change features.buffer,
566 // otherwise it would always be the master buffer,
567 // and nested includes would not work.
568 features.setBuffer(*tmp);
569 tmp->validate(features);
570 features.setBuffer(buffer);
576 void InsetInclude::getLabelList(Buffer const & buffer,
577 std::vector<string> & list) const
579 if (loadIfNeeded(buffer, params_)) {
580 string const included_file = includedFilename(buffer, params_);
581 Buffer * tmp = theApp->bufferList().getBuffer(included_file);
582 tmp->setParentName("");
583 tmp->getLabelList(list);
584 tmp->setParentName(parentFilename(buffer));
589 void InsetInclude::fillWithBibKeys(Buffer const & buffer,
590 std::vector<std::pair<string,string> > & keys) const
592 if (loadIfNeeded(buffer, params_)) {
593 string const included_file = includedFilename(buffer, params_);
594 Buffer * tmp = theApp->bufferList().getBuffer(included_file);
595 tmp->setParentName("");
596 tmp->fillWithBibKeys(keys);
597 tmp->setParentName(parentFilename(buffer));
602 void InsetInclude::updateBibfilesCache(Buffer const & buffer)
604 Buffer * const tmp = getChildBuffer(buffer, params_);
606 tmp->setParentName("");
607 tmp->updateBibfilesCache();
608 tmp->setParentName(parentFilename(buffer));
613 std::vector<string> const &
614 InsetInclude::getBibfilesCache(Buffer const & buffer) const
616 Buffer * const tmp = getChildBuffer(buffer, params_);
618 tmp->setParentName("");
619 std::vector<string> const & cache = tmp->getBibfilesCache();
620 tmp->setParentName(parentFilename(buffer));
623 static std::vector<string> const empty;
628 void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
630 BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
632 bool use_preview = false;
633 if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
634 lyx::graphics::PreviewImage const * pimage =
635 preview_->getPreviewImage(*mi.base.bv->buffer());
636 use_preview = pimage && pimage->image();
640 preview_->metrics(mi, dim);
644 button_.update(getScreenLabel(*mi.base.bv->buffer()),
647 button_.metrics(mi, dim);
650 Box b(0, dim.wid, -dim.asc, dim.des);
657 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
659 setPosCache(pi, x, y);
661 BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
663 bool use_preview = false;
664 if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
665 lyx::graphics::PreviewImage const * pimage =
666 preview_->getPreviewImage(*pi.base.bv->buffer());
667 use_preview = pimage && pimage->image();
671 preview_->draw(pi, x, y);
673 button_.draw(pi, x, y);
676 bool InsetInclude::display() const
678 return type(params_) != INPUT;
687 void InsetInclude::fileChanged() const
689 Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
693 Buffer const & buffer = *buffer_ptr;
694 preview_->removePreview(buffer);
695 add_preview(*preview_.get(), *this, buffer);
696 preview_->startLoading(buffer);
702 bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
704 string const included_file = includedFilename(buffer, params);
706 return type(params) == INPUT && params.preview() &&
707 isFileReadable(included_file);
711 string const latex_string(InsetInclude const & inset, Buffer const & buffer)
714 OutputParams runparams;
715 runparams.flavor = OutputParams::LATEX;
716 inset.latex(buffer, os, runparams);
722 void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
723 Buffer const & buffer)
725 InsetCommandParams const & params = inset.params();
726 if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
727 preview_wanted(params, buffer)) {
728 renderer.setAbsFile(includedFilename(buffer, params));
729 string const snippet = latex_string(inset, buffer);
730 renderer.addPreview(snippet, buffer);
737 void InsetInclude::addPreview(lyx::graphics::PreviewLoader & ploader) const
739 Buffer const & buffer = ploader.buffer();
740 if (preview_wanted(params(), buffer)) {
741 preview_->setAbsFile(includedFilename(buffer, params()));
742 string const snippet = latex_string(*this, buffer);
743 preview_->addPreview(snippet, ploader);
748 string const InsetIncludeMailer::name_("include");
750 InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset)
755 string const InsetIncludeMailer::inset2string(Buffer const &) const
757 return params2string(inset_.params());
761 void InsetIncludeMailer::string2params(string const & in,
762 InsetCommandParams & params)
764 params = InsetCommandParams();
768 istringstream data(in);
774 if (!lex || name != name_)
775 return print_mailer_error("InsetIncludeMailer", in, 1, name_);
777 // This is part of the inset proper that is usually swallowed
778 // by LyXText::readInset
781 if (!lex || id != "Include")
782 return print_mailer_error("InsetIncludeMailer", in, 2, "Include");
784 InsetInclude inset(params);
786 params = inset.params();
791 InsetIncludeMailer::params2string(InsetCommandParams const & params)
793 InsetInclude inset(params);
795 data << name_ << ' ';
797 data << "\\end_inset\n";