2 * \file InsetInclude.cpp
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
7 * \author Richard Heck (conversion to InsetCommand)
8 * \author Bo Peng (embedding stuff)
10 * Full author contact details are available in file CREDITS.
15 #include "InsetInclude.h"
17 #include "BaseClassList.h"
19 #include "buffer_funcs.h"
20 #include "BufferList.h"
21 #include "BufferParams.h"
22 #include "BufferView.h"
24 #include "DispatchResult.h"
26 #include "FuncRequest.h"
27 #include "FuncStatus.h"
28 #include "LaTeXFeatures.h"
32 #include "MetricsInfo.h"
33 #include "OutputParams.h"
34 #include "TextClass.h"
35 #include "TocBackend.h"
37 #include "frontends/alert.h"
38 #include "frontends/Painter.h"
40 #include "graphics/PreviewImage.h"
41 #include "graphics/PreviewLoader.h"
43 #include "insets/RenderPreview.h"
44 #include "insets/InsetListingsParams.h"
46 #include "support/debug.h"
47 #include "support/docstream.h"
48 #include "support/ExceptionMessage.h"
49 #include "support/FileNameList.h"
50 #include "support/filetools.h"
51 #include "support/gettext.h"
52 #include "support/lstrings.h" // contains
53 #include "support/lyxalgo.h"
54 #include "support/convert.h"
56 #include <boost/bind.hpp>
59 using namespace lyx::support;
63 namespace Alert = frontend::Alert;
68 docstring const uniqueID()
70 static unsigned int seed = 1000;
71 return "file" + convert<docstring>(++seed);
75 /// the type of inclusion
77 INCLUDE, VERB, INPUT, VERBAST, LISTINGS, NONE
81 Types type(string const & s)
85 if (s == "verbatiminput")
87 if (s == "verbatiminput*")
89 if (s == "lstinputlisting")
97 Types type(InsetCommandParams const & params)
99 return type(params.getCmdName());
103 bool isListings(InsetCommandParams const & params)
105 return type(params) == LISTINGS;
109 bool isVerbatim(InsetCommandParams const & params)
111 Types const t = type(params);
112 return t == VERB || t == VERBAST;
116 bool isInputOrInclude(InsetCommandParams const & params)
118 Types const t = type(params);
119 return t == INPUT || t == INCLUDE;
123 FileName const masterFileName(Buffer const & buffer)
125 return buffer.masterBuffer()->fileName();
129 void add_preview(RenderMonitoredPreview &, InsetInclude const &, Buffer const &);
132 string const parentFilename(Buffer const & buffer)
134 return buffer.absFileName();
138 EmbeddedFile const includedFilename(Buffer const & buffer,
139 InsetCommandParams const & params)
141 // it is not a good idea to create this EmbeddedFile object
142 // each time, but there seems to be no easy way around.
143 EmbeddedFile file(to_utf8(params["filename"]),
144 onlyPath(parentFilename(buffer)));
145 file.setEmbed(!params["embed"].empty());
146 file.enable(buffer.embedded(), &buffer);
153 InsetInclude::InsetInclude(InsetCommandParams const & p)
154 : InsetCommand(p, "include"), include_label(uniqueID()),
155 preview_(new RenderMonitoredPreview(this)), set_label_(false)
157 preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
161 InsetInclude::InsetInclude(InsetInclude const & other)
162 : InsetCommand(other), include_label(other.include_label),
163 preview_(new RenderMonitoredPreview(this)), set_label_(false)
165 preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
169 ParamInfo const & InsetInclude::findInfo(string const & /* cmdName */)
172 // This is only correct for the case of listings, but it'll do for now.
173 // In the other cases, this second parameter should just be empty.
174 static ParamInfo param_info_;
175 if (param_info_.empty()) {
176 param_info_.add("filename", false);
177 param_info_.add("embed", false);
178 param_info_.add("lstparams", true);
184 bool InsetInclude::isCompatibleCommand(string const & s)
186 return type(s) != NONE;
190 void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
192 switch (cmd.action) {
194 case LFUN_INSET_MODIFY: {
195 InsetCommandParams p(INCLUDE_CODE);
196 InsetCommandMailer::string2params("include", to_utf8(cmd.argument()), p);
197 if (!p.getCmdName().empty()) {
199 InsetListingsParams par_old(to_utf8(params()["lstparams"]));
200 InsetListingsParams par_new(to_utf8(p["lstparams"]));
201 if (par_old.getParamValue("label") !=
202 par_new.getParamValue("label")
203 && !par_new.getParamValue("label").empty())
204 cur.bv().buffer().changeRefsIfUnique(
205 from_utf8(par_old.getParamValue("label")),
206 from_utf8(par_new.getParamValue("label")),
210 // the embed parameter passed back from the dialog
211 // is "true" or "false", we need to change it.
212 if (p["embed"] == _("false"))
215 p["embed"] = from_utf8(EmbeddedFile(to_utf8(p["filename"]),
216 onlyPath(parentFilename(cur.buffer()))).inzipName());
218 includedFilename(cur.buffer(), p);
219 } catch (ExceptionMessage const & message) {
220 Alert::error(message.title_, message.details_);
221 // do not set parameter if an error happens
224 set(p, cur.buffer());
225 cur.buffer().updateBibfilesCache();
231 //pass everything else up the chain
233 InsetCommand::doDispatch(cur, cmd);
239 void InsetInclude::set(InsetCommandParams const & p, Buffer const & buffer)
244 if (preview_->monitoring())
245 preview_->stopMonitoring();
247 if (type(params()) == INPUT)
248 add_preview(*preview_, *this, buffer);
252 Inset * InsetInclude::clone() const
254 return new InsetInclude(*this);
258 docstring const InsetInclude::getScreenLabel(Buffer const & buf) const
262 switch (type(params())) {
264 temp = buf.B_("Input");
267 temp = buf.B_("Verbatim Input");
270 temp = buf.B_("Verbatim Input*");
273 temp = buf.B_("Include");
276 temp = listings_label_;
284 if (params()["filename"].empty())
287 temp += from_utf8(onlyFilename(to_utf8(params()["filename"])));
289 if (!params()["embed"].empty())
290 temp += _(" (embedded)");
295 /// return the child buffer if the file is a LyX doc and is loaded
296 Buffer * getChildBuffer(Buffer const & buffer, InsetCommandParams const & params)
298 if (isVerbatim(params) || isListings(params))
301 string const included_file = includedFilename(buffer, params).absFilename();
302 if (!isLyXFilename(included_file))
305 Buffer * childBuffer = theBufferList().getBuffer(included_file);
307 //FIXME RECURSIVE INCLUDES
308 if (childBuffer == & buffer)
314 /// return true if the file is or got loaded.
315 Buffer * loadIfNeeded(Buffer const & parent, InsetCommandParams const & params)
317 if (isVerbatim(params) || isListings(params))
320 string const parent_filename = parent.absFileName();
321 FileName const included_file = makeAbsPath(to_utf8(params["filename"]),
322 onlyPath(parent_filename));
324 if (!isLyXFilename(included_file.absFilename()))
327 Buffer * child = theBufferList().getBuffer(included_file.absFilename());
329 // the readonly flag can/will be wrong, not anymore I think.
330 if (!included_file.exists())
333 child = theBufferList().newBuffer(included_file.absFilename());
335 // Buffer creation is not possible.
338 if (!child->loadLyXFile(included_file)) {
339 //close the buffer we just opened
340 theBufferList().release(child);
344 child->setParent(&parent);
349 void resetParentBuffer(Buffer const * parent, InsetCommandParams const & params,
352 if (isVerbatim(params) || isListings(params))
355 string const parent_filename = parent->absFileName();
356 FileName const included_file = makeAbsPath(to_utf8(params["filename"]),
357 onlyPath(parent_filename));
359 if (!isLyXFilename(included_file.absFilename()))
362 Buffer * child = theBufferList().getBuffer(included_file.absFilename());
363 // File not opened, nothing to close.
367 // Child document has a different parent, don't close it.
368 if (child->parent() != parent)
374 theBufferList().release(child);
376 updateLabels(*child);
380 int InsetInclude::latex(Buffer const & buffer, odocstream & os,
381 OutputParams const & runparams) const
383 string incfile(to_utf8(params()["filename"]));
385 // Do nothing if no file name has been specified
389 FileName const included_file = includedFilename(buffer, params()).availableFile();
391 //Check we're not trying to include ourselves.
392 //FIXME RECURSIVE INCLUDE
393 //This isn't sufficient, as the inclusion could be downstream.
394 //But it'll have to do for now.
395 if (isInputOrInclude(params()) &&
396 buffer.absFileName() == included_file.absFilename())
398 Alert::error(_("Recursive input"),
399 bformat(_("Attempted to include file %1$s in itself! "
400 "Ignoring inclusion."), from_utf8(incfile)));
404 Buffer const * const masterBuffer = buffer.masterBuffer();
406 // if incfile is relative, make it relative to the master
408 if (!FileName(incfile).isAbsolute()) {
410 incfile = to_utf8(makeRelPath(from_utf8(included_file.absFilename()),
411 from_utf8(masterBuffer->filePath())));
414 // write it to a file (so far the complete file)
415 string const exportfile = changeExtension(incfile, ".tex");
416 string const mangled =
417 DocFileName(changeExtension(included_file.absFilename(),".tex")).
419 FileName const writefile(makeAbsPath(mangled, masterBuffer->temppath()));
423 else if (!isValidLaTeXFilename(incfile)) {
424 frontend::Alert::warning(_("Invalid filename"),
425 _("The following filename is likely to cause trouble "
426 "when running the exported file through LaTeX: ") +
429 LYXERR(Debug::LATEX, "incfile:" << incfile);
430 LYXERR(Debug::LATEX, "exportfile:" << exportfile);
431 LYXERR(Debug::LATEX, "writefile:" << writefile);
433 if (runparams.inComment || runparams.dryrun) {
434 //Don't try to load or copy the file if we're
435 //in a comment or doing a dryrun
436 } else if (isInputOrInclude(params()) &&
437 isLyXFilename(included_file.absFilename())) {
438 //if it's a LyX file and we're inputting or including,
439 //try to load it so we can write the associated latex
440 if (!loadIfNeeded(buffer, params()))
443 Buffer * tmp = theBufferList().getBuffer(included_file.absFilename());
445 if (tmp->params().baseClass() != masterBuffer->params().baseClass()) {
447 docstring text = bformat(_("Included file `%1$s'\n"
448 "has textclass `%2$s'\n"
449 "while parent file has textclass `%3$s'."),
450 included_file.displayName(),
451 from_utf8(tmp->params().textClass().name()),
452 from_utf8(masterBuffer->params().textClass().name()));
453 Alert::warning(_("Different textclasses"), text);
457 // Make sure modules used in child are all included in master
458 //FIXME It might be worth loading the children's modules into the master
459 //over in BufferParams rather than doing this check.
460 vector<string> const masterModules = masterBuffer->params().getModules();
461 vector<string> const childModules = tmp->params().getModules();
462 vector<string>::const_iterator it = childModules.begin();
463 vector<string>::const_iterator end = childModules.end();
464 for (; it != end; ++it) {
465 string const module = *it;
466 vector<string>::const_iterator found =
467 find(masterModules.begin(), masterModules.end(), module);
468 if (found != masterModules.end()) {
469 docstring text = bformat(_("Included file `%1$s'\n"
470 "uses module `%2$s'\n"
471 "which is not used in parent file."),
472 included_file.displayName(), from_utf8(module));
473 Alert::warning(_("Module not found"), text);
477 tmp->markDepClean(masterBuffer->temppath());
479 // FIXME: handle non existing files
480 // FIXME: Second argument is irrelevant!
481 // since only_body is true, makeLaTeXFile will not look at second
482 // argument. Should we set it to string(), or should makeLaTeXFile
483 // make use of it somehow? (JMarc 20031002)
484 // The included file might be written in a different encoding
485 Encoding const * const oldEnc = runparams.encoding;
486 runparams.encoding = &tmp->params().encoding();
487 tmp->makeLaTeXFile(writefile,
488 masterFileName(buffer).onlyPath().absFilename(),
490 runparams.encoding = oldEnc;
492 // In this case, it's not a LyX file, so we copy the file
493 // to the temp dir, so that .aux files etc. are not created
494 // in the original dir. Files included by this file will be
495 // found via input@path, see ../Buffer.cpp.
496 unsigned long const checksum_in = included_file.checksum();
497 unsigned long const checksum_out = writefile.checksum();
499 if (checksum_in != checksum_out) {
500 if (!included_file.copyTo(writefile)) {
503 to_utf8(bformat(_("Could not copy the file\n%1$s\n"
504 "into the temporary directory."),
505 from_utf8(included_file.absFilename()))));
511 string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
512 "latex" : "pdflatex";
513 if (isVerbatim(params())) {
514 incfile = latex_path(incfile);
516 os << '\\' << from_ascii(params().getCmdName()) << '{'
517 << from_utf8(incfile) << '}';
518 } else if (type(params()) == INPUT) {
519 runparams.exportdata->addExternalFile(tex_format, writefile,
522 // \input wants file with extension (default is .tex)
523 if (!isLyXFilename(included_file.absFilename())) {
524 incfile = latex_path(incfile);
526 os << '\\' << from_ascii(params().getCmdName())
527 << '{' << from_utf8(incfile) << '}';
529 incfile = changeExtension(incfile, ".tex");
530 incfile = latex_path(incfile);
532 os << '\\' << from_ascii(params().getCmdName())
533 << '{' << from_utf8(incfile) << '}';
535 } else if (type(params()) == LISTINGS) {
536 os << '\\' << from_ascii(params().getCmdName());
537 string const opt = to_utf8(params()["lstparams"]);
538 // opt is set in QInclude dialog and should have passed validation.
539 InsetListingsParams params(opt);
540 if (!params.params().empty())
541 os << "[" << from_utf8(params.params()) << "]";
542 os << '{' << from_utf8(incfile) << '}';
544 runparams.exportdata->addExternalFile(tex_format, writefile,
547 // \include don't want extension and demands that the
548 // file really have .tex
549 incfile = changeExtension(incfile, string());
550 incfile = latex_path(incfile);
552 os << '\\' << from_ascii(params().getCmdName()) << '{'
553 << from_utf8(incfile) << '}';
560 int InsetInclude::plaintext(Buffer const & buffer, odocstream & os,
561 OutputParams const &) const
563 if (isVerbatim(params()) || isListings(params())) {
564 os << '[' << getScreenLabel(buffer) << '\n';
565 // FIXME: We don't know the encoding of the file, default to UTF-8.
566 os << includedFilename(buffer, params()).fileContents("UTF-8");
568 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
570 docstring const str = '[' + getScreenLabel(buffer) + ']';
577 int InsetInclude::docbook(Buffer const & buffer, odocstream & os,
578 OutputParams const & runparams) const
580 string incfile = to_utf8(params()["filename"]);
582 // Do nothing if no file name has been specified
586 string const included_file = includedFilename(buffer, params()).absFilename();
588 //Check we're not trying to include ourselves.
589 //FIXME RECURSIVE INCLUDE
590 //This isn't sufficient, as the inclusion could be downstream.
591 //But it'll have to do for now.
592 if (buffer.absFileName() == included_file) {
593 Alert::error(_("Recursive input"),
594 bformat(_("Attempted to include file %1$s in itself! "
595 "Ignoring inclusion."), from_utf8(incfile)));
599 // write it to a file (so far the complete file)
600 string const exportfile = changeExtension(incfile, ".sgml");
601 DocFileName writefile(changeExtension(included_file, ".sgml"));
603 if (loadIfNeeded(buffer, params())) {
604 Buffer * tmp = theBufferList().getBuffer(included_file);
606 string const mangled = writefile.mangledFilename();
607 writefile = makeAbsPath(mangled,
608 buffer.masterBuffer()->temppath());
612 LYXERR(Debug::LATEX, "incfile:" << incfile);
613 LYXERR(Debug::LATEX, "exportfile:" << exportfile);
614 LYXERR(Debug::LATEX, "writefile:" << writefile);
616 tmp->makeDocBookFile(writefile, runparams, true);
619 runparams.exportdata->addExternalFile("docbook", writefile,
621 runparams.exportdata->addExternalFile("docbook-xml", writefile,
624 if (isVerbatim(params()) || isListings(params())) {
625 os << "<inlinegraphic fileref=\""
626 << '&' << include_label << ';'
627 << "\" format=\"linespecific\">";
629 os << '&' << include_label << ';';
635 void InsetInclude::validate(LaTeXFeatures & features) const
637 string incfile = to_utf8(params()["filename"]);
640 Buffer const & buffer = features.buffer();
642 string const included_file = includedFilename(buffer, params()).availableFile().absFilename();
644 if (isLyXFilename(included_file))
645 writefile = changeExtension(included_file, ".sgml");
647 writefile = included_file;
649 if (!features.runparams().nice && !isVerbatim(params()) && !isListings(params())) {
650 incfile = DocFileName(writefile).mangledFilename();
651 writefile = makeAbsPath(incfile,
652 buffer.masterBuffer()->temppath()).absFilename();
655 features.includeFile(include_label, writefile);
657 if (isVerbatim(params()))
658 features.require("verbatim");
659 else if (isListings(params()))
660 features.require("listings");
662 // Here we must do the fun stuff...
663 // Load the file in the include if it needs
665 if (loadIfNeeded(buffer, params())) {
667 Buffer * const tmp = theBufferList().getBuffer(included_file);
668 // make sure the buffer isn't us
669 // FIXME RECURSIVE INCLUDES
670 // This is not sufficient, as recursive includes could be
671 // more than a file away. But it will do for now.
672 if (tmp && tmp != & buffer) {
673 // We must temporarily change features.buffer,
674 // otherwise it would always be the master buffer,
675 // and nested includes would not work.
676 features.setBuffer(*tmp);
677 tmp->validate(features);
678 features.setBuffer(buffer);
684 void InsetInclude::getLabelList(Buffer const & buffer,
685 vector<docstring> & list) const
687 if (isListings(params())) {
688 InsetListingsParams p(to_utf8(params()["lstparams"]));
689 string label = p.getParamValue("label");
691 list.push_back(from_utf8(label));
693 else if (loadIfNeeded(buffer, params())) {
694 string const included_file = includedFilename(buffer, params()).absFilename();
695 Buffer * tmp = theBufferList().getBuffer(included_file);
697 tmp->getLabelList(list);
698 tmp->setParent(const_cast<Buffer *>(&buffer));
703 void InsetInclude::fillWithBibKeys(Buffer const & buffer,
704 BiblioInfo & keys, InsetIterator const & /*di*/) const
706 if (loadIfNeeded(buffer, params())) {
707 string const included_file = includedFilename(buffer, params()).absFilename();
708 Buffer * tmp = theBufferList().getBuffer(included_file);
709 //FIXME This is kind of a dirty hack and should be made reasonable.
711 keys.fillWithBibKeys(tmp);
712 tmp->setParent(&buffer);
717 void InsetInclude::updateBibfilesCache(Buffer const & buffer)
719 Buffer * const tmp = getChildBuffer(buffer, params());
722 tmp->updateBibfilesCache();
723 tmp->setParent(&buffer);
728 EmbeddedFileList const &
729 InsetInclude::getBibfilesCache(Buffer const & buffer) const
731 Buffer * const tmp = getChildBuffer(buffer, params());
734 EmbeddedFileList const & cache = tmp->getBibfilesCache();
735 tmp->setParent(&buffer);
738 static EmbeddedFileList const empty;
743 void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
745 BOOST_ASSERT(mi.base.bv);
747 bool use_preview = false;
748 if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
749 graphics::PreviewImage const * pimage =
750 preview_->getPreviewImage(mi.base.bv->buffer());
751 use_preview = pimage && pimage->image();
755 preview_->metrics(mi, dim);
759 button_.update(getScreenLabel(mi.base.bv->buffer()),
762 button_.metrics(mi, dim);
765 Box b(0, dim.wid, -dim.asc, dim.des);
770 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
772 BOOST_ASSERT(pi.base.bv);
774 bool use_preview = false;
775 if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
776 graphics::PreviewImage const * pimage =
777 preview_->getPreviewImage(pi.base.bv->buffer());
778 use_preview = pimage && pimage->image();
782 preview_->draw(pi, x, y);
784 button_.draw(pi, x, y);
788 Inset::DisplayType InsetInclude::display() const
790 return type(params()) == INPUT ? Inline : AlignCenter;
799 void InsetInclude::fileChanged() const
801 Buffer const * const buffer = updateFrontend();
805 preview_->removePreview(*buffer);
806 add_preview(*preview_.get(), *this, *buffer);
807 preview_->startLoading(*buffer);
813 bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
815 FileName const included_file = includedFilename(buffer, params);
817 return type(params) == INPUT && params.preview() &&
818 included_file.isReadableFile();
822 docstring const latex_string(InsetInclude const & inset, Buffer const & buffer)
825 // We don't need to set runparams.encoding since this will be done
826 // by latex() anyway.
827 OutputParams runparams(0);
828 runparams.flavor = OutputParams::LATEX;
829 inset.latex(buffer, os, runparams);
835 void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
836 Buffer const & buffer)
838 InsetCommandParams const & params = inset.params();
839 if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
840 preview_wanted(params, buffer)) {
841 renderer.setAbsFile(includedFilename(buffer, params));
842 docstring const snippet = latex_string(inset, buffer);
843 renderer.addPreview(snippet, buffer);
850 void InsetInclude::addPreview(graphics::PreviewLoader & ploader) const
852 Buffer const & buffer = ploader.buffer();
853 if (!preview_wanted(params(), buffer))
855 preview_->setAbsFile(includedFilename(buffer, params()));
856 docstring const snippet = latex_string(*this, buffer);
857 preview_->addPreview(snippet, ploader);
861 void InsetInclude::addToToc(Buffer const & buffer,
862 ParConstIterator const & cpit) const
864 if (isListings(params())) {
865 InsetListingsParams p(to_utf8(params()["lstparams"]));
866 string caption = p.getParamValue("caption");
869 Toc & toc = buffer.tocBackend().toc("listing");
870 docstring const str = convert<docstring>(toc.size() + 1)
871 + ". " + from_utf8(caption);
872 ParConstIterator pit = cpit;
873 pit.push_back(*this);
874 toc.push_back(TocItem(pit, 0, str));
877 Buffer const * const childbuffer = getChildBuffer(buffer, params());
881 TocList & toclist = buffer.tocBackend().tocs();
882 TocList const & childtoclist = childbuffer->tocBackend().tocs();
883 TocList::const_iterator it = childtoclist.begin();
884 TocList::const_iterator const end = childtoclist.end();
885 for(; it != end; ++it)
886 toclist[it->first].insert(toclist[it->first].end(),
887 it->second.begin(), it->second.end());
891 void InsetInclude::updateLabels(Buffer const & buffer, ParIterator const &)
893 Buffer const * const childbuffer = getChildBuffer(buffer, params());
895 lyx::updateLabels(*childbuffer, true);
898 if (!isListings(params()))
901 InsetListingsParams const par(to_utf8(params()["lstparams"]));
902 if (par.getParamValue("caption").empty()) {
903 listings_label_.clear();
906 Counters & counters = buffer.params().textClass().counters();
907 docstring const cnt = from_ascii("listing");
908 listings_label_ = buffer.B_("Program Listing");
909 if (counters.hasCounter(cnt)) {
911 listings_label_ += " " + convert<docstring>(counters.value(cnt));
916 void InsetInclude::registerEmbeddedFiles(Buffer const & buffer,
917 EmbeddedFileList & files) const
919 files.registerFile(includedFilename(buffer, params()), this, buffer);
923 void InsetInclude::updateEmbeddedFile(Buffer const & buf,
924 EmbeddedFile const & file)
926 InsetCommandParams p = params();
927 p["filename"] = from_utf8(file.outputFilename());
928 p["embed"] = file.embedded() ? from_utf8(file.inzipName()) : docstring();