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
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"
33 #include "TocBackend.h"
35 #include "frontends/alert.h"
36 #include "frontends/Painter.h"
38 #include "graphics/PreviewImage.h"
39 #include "graphics/PreviewLoader.h"
41 #include "insets/RenderPreview.h"
42 #include "insets/InsetListingsParams.h"
44 #include "support/filetools.h"
45 #include "support/lstrings.h" // contains
46 #include "support/lyxalgo.h"
47 #include "support/lyxlib.h"
48 #include "support/convert.h"
50 #include <boost/bind.hpp>
51 #include <boost/filesystem/operations.hpp>
56 using support::addName;
57 using support::absolutePath;
58 using support::bformat;
59 using support::changeExtension;
60 using support::contains;
62 using support::DocFileName;
63 using support::FileName;
64 using support::getFileContents;
65 using support::getVectorFromString;
66 using support::isFileReadable;
67 using support::isLyXFilename;
68 using support::latex_path;
69 using support::makeAbsPath;
70 using support::makeDisplayPath;
71 using support::makeRelPath;
72 using support::onlyFilename;
73 using support::onlyPath;
74 using support::prefixIs;
81 using std::istringstream;
83 using std::ostringstream;
86 namespace Alert = frontend::Alert;
87 namespace fs = boost::filesystem;
92 docstring const uniqueID()
94 static unsigned int seed = 1000;
95 return "file" + convert<docstring>(++seed);
99 bool isListings(InsetCommandParams const & params)
101 return params.getCmdName() == "lstinputlisting";
107 InsetInclude::InsetInclude(InsetCommandParams const & p)
108 : params_(p), include_label(uniqueID()),
109 preview_(new RenderMonitoredPreview(this)),
110 set_label_(false), counter_(0)
112 preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
116 InsetInclude::InsetInclude(InsetInclude const & other)
118 params_(other.params_),
119 include_label(other.include_label),
120 preview_(new RenderMonitoredPreview(this)),
121 set_label_(false), counter_(0)
123 preview_->fileChanged(boost::bind(&InsetInclude::fileChanged, this));
127 InsetInclude::~InsetInclude()
129 InsetIncludeMailer(*this).hideDialog();
133 void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
135 switch (cmd.action) {
137 case LFUN_INSET_MODIFY: {
138 InsetCommandParams p("include");
139 InsetIncludeMailer::string2params(to_utf8(cmd.argument()), p);
140 if (!p.getCmdName().empty()) {
142 InsetListingsParams par_old(params().getOptions());
143 InsetListingsParams par_new(p.getOptions());
144 if (par_old.getParamValue("label") !=
145 par_new.getParamValue("label")
146 && !par_new.getParamValue("label").empty())
147 cur.bv().buffer()->changeRefsIfUnique(
148 from_utf8(par_old.getParamValue("label")),
149 from_utf8(par_new.getParamValue("label")),
152 set(p, cur.buffer());
153 cur.buffer().updateBibfilesCache();
159 case LFUN_INSET_DIALOG_UPDATE:
160 InsetIncludeMailer(*this).updateDialog(&cur.bv());
163 case LFUN_MOUSE_RELEASE:
164 if (!cur.selection())
165 InsetIncludeMailer(*this).showDialog(&cur.bv());
169 Inset::doDispatch(cur, cmd);
175 bool InsetInclude::getStatus(Cursor & cur, FuncRequest const & cmd,
176 FuncStatus & flag) const
178 switch (cmd.action) {
180 case LFUN_INSET_MODIFY:
181 case LFUN_INSET_DIALOG_UPDATE:
186 return Inset::getStatus(cur, cmd, flag);
191 InsetCommandParams const & InsetInclude::params() const
199 /// the type of inclusion
209 Types type(InsetCommandParams const & params)
211 string const command_name = params.getCmdName();
213 if (command_name == "input")
215 if (command_name == "verbatiminput")
217 if (command_name == "verbatiminput*")
219 if (command_name == "lstinputlisting")
225 bool isVerbatim(InsetCommandParams const & params)
227 string const command_name = params.getCmdName();
228 return command_name == "verbatiminput" ||
229 command_name == "verbatiminput*";
233 bool isInputOrInclude(InsetCommandParams const & params)
235 Types const t = type(params);
236 return (t == INPUT) || (t == INCLUDE);
240 string const masterFilename(Buffer const & buffer)
242 return buffer.getMasterBuffer()->fileName();
246 string const parentFilename(Buffer const & buffer)
248 return buffer.fileName();
252 FileName const includedFilename(Buffer const & buffer,
253 InsetCommandParams const & params)
255 return makeAbsPath(to_utf8(params["filename"]),
256 onlyPath(parentFilename(buffer)));
260 void add_preview(RenderMonitoredPreview &, InsetInclude const &, Buffer const &);
265 void InsetInclude::set(InsetCommandParams const & p, Buffer const & buffer)
270 if (preview_->monitoring())
271 preview_->stopMonitoring();
273 if (type(params_) == INPUT)
274 add_preview(*preview_, *this, buffer);
278 auto_ptr<Inset> InsetInclude::doClone() const
280 return auto_ptr<Inset>(new InsetInclude(*this));
284 void InsetInclude::write(Buffer const &, ostream & os) const
290 void InsetInclude::write(ostream & os) const
292 os << "Include " << to_utf8(params_.getCommand()) << '\n'
293 << "preview " << convert<string>(params_.preview()) << '\n';
297 void InsetInclude::read(Buffer const &, Lexer & lex)
303 void InsetInclude::read(Lexer & lex)
307 string const command = lex.getString();
308 params_.scanCommand(command);
313 token = lex.getString();
314 if (token == "\\end_inset")
316 if (token == "preview") {
318 params_.preview(lex.getBool());
320 lex.printError("Unknown parameter name `$$Token' for command " + params_.getCmdName());
322 if (token != "\\end_inset") {
323 lex.printError("Missing \\end_inset at this point. "
329 docstring const InsetInclude::getScreenLabel(Buffer const & buf) const
333 switch (type(params_)) {
335 temp += buf.B_("Input");
338 temp += buf.B_("Verbatim Input");
341 temp += buf.B_("Verbatim Input*");
344 temp += buf.B_("Include");
348 temp += buf.B_("Program Listing ") + convert<docstring>(counter_);
350 temp += buf.B_("Program Listing");
357 if (params_["filename"].empty())
360 temp += from_utf8(onlyFilename(to_utf8(params_["filename"])));
368 /// return the child buffer if the file is a LyX doc and is loaded
369 Buffer * getChildBuffer(Buffer const & buffer, InsetCommandParams const & params)
371 if (isVerbatim(params) || isListings(params))
374 string const included_file = includedFilename(buffer, params).absFilename();
375 if (!isLyXFilename(included_file))
378 Buffer * childBuffer = theBufferList().getBuffer(included_file);
380 //FIXME RECURSIVE INCLUDES
381 if (childBuffer == & buffer)
383 else return childBuffer;
387 /// return true if the file is or got loaded.
388 bool loadIfNeeded(Buffer const & buffer, InsetCommandParams const & params)
390 if (isVerbatim(params) || isListings(params))
393 FileName const included_file = includedFilename(buffer, params);
394 if (!isLyXFilename(included_file.absFilename()))
397 Buffer * buf = theBufferList().getBuffer(included_file.absFilename());
399 // the readonly flag can/will be wrong, not anymore I think.
400 if (!fs::exists(included_file.toFilesystemEncoding()))
402 buf = theBufferList().newBuffer(included_file.absFilename());
403 if (!loadLyXFile(buf, included_file)) {
404 //close the buffer we just opened
405 theBufferList().close(buf, false);
409 buf->setParentName(parentFilename(buffer));
417 int InsetInclude::latex(Buffer const & buffer, odocstream & os,
418 OutputParams const & runparams) const
420 string incfile(to_utf8(params_["filename"]));
422 // Do nothing if no file name has been specified
426 FileName const included_file(includedFilename(buffer, params_));
428 //Check we're not trying to include ourselves.
429 //FIXME RECURSIVE INCLUDE
430 //This isn't sufficient, as the inclusion could be downstream.
431 //But it'll have to do for now.
432 if (isInputOrInclude(params_) &&
433 buffer.fileName() == included_file.toFilesystemEncoding())
435 Alert::error(_("Recursive input"),
436 bformat(_("Attempted to include file %1$s in itself! "
437 "Ignoring inclusion."), from_utf8(incfile)));
441 Buffer const * const m_buffer = buffer.getMasterBuffer();
443 // if incfile is relative, make it relative to the master
445 if (!absolutePath(incfile)) {
447 incfile = to_utf8(makeRelPath(from_utf8(included_file.absFilename()),
448 from_utf8(m_buffer->filePath())));
451 // write it to a file (so far the complete file)
452 string const exportfile = changeExtension(incfile, ".tex");
453 string const mangled =
454 DocFileName(changeExtension(included_file.absFilename(),".tex")).
456 FileName const writefile(makeAbsPath(mangled, m_buffer->temppath()));
460 LYXERR(Debug::LATEX) << "incfile:" << incfile << endl;
461 LYXERR(Debug::LATEX) << "exportfile:" << exportfile << endl;
462 LYXERR(Debug::LATEX) << "writefile:" << writefile << endl;
464 if (runparams.inComment || runparams.dryrun)
465 // Don't try to load or copy the file
467 //if it's a LyX file and we're including or inputting it...
468 else if (isInputOrInclude(params_) &&
469 isLyXFilename(included_file.absFilename())) {
470 //try to load it so we can write the associated latex
471 if (!loadIfNeeded(buffer, params_))
474 Buffer * tmp = theBufferList().getBuffer(included_file.absFilename());
476 if (tmp->params().textclass != m_buffer->params().textclass) {
478 docstring text = bformat(_("Included file `%1$s'\n"
479 "has textclass `%2$s'\n"
480 "while parent file has textclass `%3$s'."),
481 makeDisplayPath(included_file.absFilename()),
482 from_utf8(tmp->params().getTextClass().name()),
483 from_utf8(m_buffer->params().getTextClass().name()));
484 Alert::warning(_("Different textclasses"), text);
488 tmp->markDepClean(m_buffer->temppath());
491 #warning handle non existing files
492 #warning Second argument is irrelevant!
493 // since only_body is true, makeLaTeXFile will not look at second
494 // argument. Should we set it to string(), or should makeLaTeXFile
495 // make use of it somehow? (JMarc 20031002)
497 // The included file might be written in a different encoding
498 Encoding const * const oldEnc = runparams.encoding;
499 runparams.encoding = &tmp->params().encoding();
500 tmp->makeLaTeXFile(writefile,
501 onlyPath(masterFilename(buffer)),
503 runparams.encoding = oldEnc;
505 // Copy the file to the temp dir, so that .aux files etc.
506 // are not created in the original dir. Files included by
507 // this file will be found via input@path, see ../Buffer.cpp.
508 unsigned long const checksum_in = sum(included_file);
509 unsigned long const checksum_out = sum(writefile);
511 if (checksum_in != checksum_out) {
512 if (!copy(included_file, writefile)) {
515 << to_utf8(bformat(_("Could not copy the file\n%1$s\n"
516 "into the temporary directory."),
517 from_utf8(included_file.absFilename())))
524 string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
525 "latex" : "pdflatex";
526 if (isVerbatim(params_)) {
527 incfile = latex_path(incfile);
529 os << '\\' << from_ascii(params_.getCmdName()) << '{'
530 << from_utf8(incfile) << '}';
531 } else if (type(params_) == INPUT) {
532 runparams.exportdata->addExternalFile(tex_format, writefile,
535 // \input wants file with extension (default is .tex)
536 if (!isLyXFilename(included_file.absFilename())) {
537 incfile = latex_path(incfile);
539 os << '\\' << from_ascii(params_.getCmdName())
540 << '{' << from_utf8(incfile) << '}';
542 incfile = changeExtension(incfile, ".tex");
543 incfile = latex_path(incfile);
545 os << '\\' << from_ascii(params_.getCmdName())
546 << '{' << from_utf8(incfile) << '}';
548 } else if (type(params_) == LISTINGS) {
549 os << '\\' << from_ascii(params_.getCmdName());
550 string opt = params_.getOptions();
551 // opt is set in QInclude dialog and should have passed validation.
552 InsetListingsParams params(opt);
553 if (!params.params().empty())
554 os << "[" << from_utf8(params.params()) << "]";
555 os << '{' << from_utf8(incfile) << '}';
557 runparams.exportdata->addExternalFile(tex_format, writefile,
560 // \include don't want extension and demands that the
561 // file really have .tex
562 incfile = changeExtension(incfile, string());
563 incfile = latex_path(incfile);
565 os << '\\' << from_ascii(params_.getCmdName()) << '{'
566 << from_utf8(incfile) << '}';
573 int InsetInclude::plaintext(Buffer const & buffer, odocstream & os,
574 OutputParams const &) const
576 if (isVerbatim(params_) || isListings(params_)) {
577 os << '[' << getScreenLabel(buffer) << '\n';
578 // FIXME: We don't know the encoding of the file
579 docstring const str =
580 from_utf8(getFileContents(includedFilename(buffer, params_)));
583 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
585 docstring const str = '[' + getScreenLabel(buffer) + ']';
592 int InsetInclude::docbook(Buffer const & buffer, odocstream & os,
593 OutputParams const & runparams) const
595 string incfile = to_utf8(params_["filename"]);
597 // Do nothing if no file name has been specified
601 string const included_file = includedFilename(buffer, params_).absFilename();
603 //Check we're not trying to include ourselves.
604 //FIXME RECURSIVE INCLUDE
605 //This isn't sufficient, as the inclusion could be downstream.
606 //But it'll have to do for now.
607 if (buffer.fileName() == included_file) {
608 Alert::error(_("Recursive input"),
609 bformat(_("Attempted to include file %1$s in itself! "
610 "Ignoring inclusion."), from_utf8(incfile)));
614 // write it to a file (so far the complete file)
615 string const exportfile = changeExtension(incfile, ".sgml");
616 DocFileName writefile(changeExtension(included_file, ".sgml"));
618 if (loadIfNeeded(buffer, params_)) {
619 Buffer * tmp = theBufferList().getBuffer(included_file);
621 string const mangled = writefile.mangledFilename();
622 writefile = makeAbsPath(mangled,
623 buffer.getMasterBuffer()->temppath());
627 LYXERR(Debug::LATEX) << "incfile:" << incfile << endl;
628 LYXERR(Debug::LATEX) << "exportfile:" << exportfile << endl;
629 LYXERR(Debug::LATEX) << "writefile:" << writefile << endl;
631 tmp->makeDocBookFile(writefile, runparams, true);
634 runparams.exportdata->addExternalFile("docbook", writefile,
636 runparams.exportdata->addExternalFile("docbook-xml", writefile,
639 if (isVerbatim(params_) || isListings(params_)) {
640 os << "<inlinegraphic fileref=\""
641 << '&' << include_label << ';'
642 << "\" format=\"linespecific\">";
644 os << '&' << include_label << ';';
650 void InsetInclude::validate(LaTeXFeatures & features) const
652 string incfile(to_utf8(params_["filename"]));
655 Buffer const & buffer = features.buffer();
657 string const included_file = includedFilename(buffer, params_).absFilename();
659 if (isLyXFilename(included_file))
660 writefile = changeExtension(included_file, ".sgml");
662 writefile = included_file;
664 if (!features.runparams().nice && !isVerbatim(params_) && !isListings(params_)) {
665 incfile = DocFileName(writefile).mangledFilename();
666 writefile = makeAbsPath(incfile,
667 buffer.getMasterBuffer()->temppath()).absFilename();
670 features.includeFile(include_label, writefile);
672 if (isVerbatim(params_))
673 features.require("verbatim");
674 else if (isListings(params_))
675 features.require("listings");
677 // Here we must do the fun stuff...
678 // Load the file in the include if it needs
680 if (loadIfNeeded(buffer, params_)) {
682 Buffer * const tmp = theBufferList().getBuffer(included_file);
683 // make sure the buffer isn't us
684 // FIXME RECURSIVE INCLUDES
685 // This is not sufficient, as recursive includes could be
686 // more than a file away. But it will do for now.
687 if (tmp && tmp != & buffer) {
688 // We must temporarily change features.buffer,
689 // otherwise it would always be the master buffer,
690 // and nested includes would not work.
691 features.setBuffer(*tmp);
692 tmp->validate(features);
693 features.setBuffer(buffer);
699 void InsetInclude::getLabelList(Buffer const & buffer,
700 std::vector<docstring> & list) const
702 if (isListings(params_)) {
703 InsetListingsParams params(params_.getOptions());
704 string label = params.getParamValue("label");
706 list.push_back(from_utf8(label));
708 else if (loadIfNeeded(buffer, params_)) {
709 string const included_file = includedFilename(buffer, params_).absFilename();
710 Buffer * tmp = theBufferList().getBuffer(included_file);
711 tmp->setParentName("");
712 tmp->getLabelList(list);
713 tmp->setParentName(parentFilename(buffer));
718 void InsetInclude::fillWithBibKeys(Buffer const & buffer,
719 std::vector<std::pair<string, docstring> > & keys) const
721 if (loadIfNeeded(buffer, params_)) {
722 string const included_file = includedFilename(buffer, params_).absFilename();
723 Buffer * tmp = theBufferList().getBuffer(included_file);
724 tmp->setParentName("");
725 tmp->fillWithBibKeys(keys);
726 tmp->setParentName(parentFilename(buffer));
731 void InsetInclude::updateBibfilesCache(Buffer const & buffer)
733 Buffer * const tmp = getChildBuffer(buffer, params_);
735 tmp->setParentName("");
736 tmp->updateBibfilesCache();
737 tmp->setParentName(parentFilename(buffer));
742 std::vector<FileName> const &
743 InsetInclude::getBibfilesCache(Buffer const & buffer) const
745 Buffer * const tmp = getChildBuffer(buffer, params_);
747 tmp->setParentName("");
748 std::vector<FileName> const & cache = tmp->getBibfilesCache();
749 tmp->setParentName(parentFilename(buffer));
752 static std::vector<FileName> const empty;
757 bool InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
759 BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
761 bool use_preview = false;
762 if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
763 graphics::PreviewImage const * pimage =
764 preview_->getPreviewImage(*mi.base.bv->buffer());
765 use_preview = pimage && pimage->image();
769 preview_->metrics(mi, dim);
773 button_.update(getScreenLabel(*mi.base.bv->buffer()),
776 button_.metrics(mi, dim);
779 Box b(0, dim.wid, -dim.asc, dim.des);
782 bool const changed = dim_ != dim;
788 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
790 setPosCache(pi, x, y);
792 BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
794 bool use_preview = false;
795 if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
796 graphics::PreviewImage const * pimage =
797 preview_->getPreviewImage(*pi.base.bv->buffer());
798 use_preview = pimage && pimage->image();
802 preview_->draw(pi, x, y);
804 button_.draw(pi, x, y);
808 Inset::DisplayType InsetInclude::display() const
810 return type(params_) == INPUT ? Inline : AlignCenter;
819 void InsetInclude::fileChanged() const
821 Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
825 Buffer const & buffer = *buffer_ptr;
826 preview_->removePreview(buffer);
827 add_preview(*preview_.get(), *this, buffer);
828 preview_->startLoading(buffer);
834 bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
836 FileName const included_file = includedFilename(buffer, params);
838 return type(params) == INPUT && params.preview() &&
839 isFileReadable(included_file);
843 docstring const latex_string(InsetInclude const & inset, Buffer const & buffer)
846 // We don't need to set runparams.encoding since this will be done
847 // by latex() anyway.
848 OutputParams runparams(0);
849 runparams.flavor = OutputParams::LATEX;
850 inset.latex(buffer, os, runparams);
856 void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
857 Buffer const & buffer)
859 InsetCommandParams const & params = inset.params();
860 if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
861 preview_wanted(params, buffer)) {
862 renderer.setAbsFile(includedFilename(buffer, params));
863 docstring const snippet = latex_string(inset, buffer);
864 renderer.addPreview(snippet, buffer);
871 void InsetInclude::addPreview(graphics::PreviewLoader & ploader) const
873 Buffer const & buffer = ploader.buffer();
874 if (preview_wanted(params(), buffer)) {
875 preview_->setAbsFile(includedFilename(buffer, params()));
876 docstring const snippet = latex_string(*this, buffer);
877 preview_->addPreview(snippet, ploader);
882 void InsetInclude::addToToc(TocList & toclist, Buffer const & buffer) const
884 Buffer const * const childbuffer = getChildBuffer(buffer, params_);
888 TocList const & childtoclist = childbuffer->tocBackend().tocs();
889 TocList::const_iterator it = childtoclist.begin();
890 TocList::const_iterator const end = childtoclist.end();
891 for(; it != end; ++it)
892 toclist[it->first].insert(toclist[it->first].end(),
893 it->second.begin(), it->second.end());
897 void InsetInclude::updateLabels(Buffer const & buffer) const
899 Buffer const * const childbuffer = getChildBuffer(buffer, params_);
903 lyx::updateLabels(*childbuffer, true);
907 void InsetInclude::updateCounter(Counters & counters)
909 if (!isListings(params_))
912 InsetListingsParams const par = params_.getOptions();
913 if (par.getParamValue("caption").empty())
916 counters.step(from_ascii("listing"));
917 counter_ = counters.value(from_ascii("listing"));
922 string const InsetIncludeMailer::name_("include");
924 InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset)
929 string const InsetIncludeMailer::inset2string(Buffer const &) const
931 return params2string(inset_.params());
935 void InsetIncludeMailer::string2params(string const & in,
936 InsetCommandParams & params)
942 istringstream data(in);
948 if (!lex || name != name_)
949 return print_mailer_error("InsetIncludeMailer", in, 1, name_);
951 // This is part of the inset proper that is usually swallowed
952 // by Text::readInset
955 if (!lex || id != "Include")
956 return print_mailer_error("InsetIncludeMailer", in, 2, "Include");
958 InsetInclude inset(params);
960 params = inset.params();
965 InsetIncludeMailer::params2string(InsetCommandParams const & params)
967 InsetInclude inset(params);
969 data << name_ << ' ';
971 data << "\\end_inset\n";