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)
388 /// return true if the file is or got loaded.
389 bool loadIfNeeded(Buffer const & buffer, InsetCommandParams const & params)
391 if (isVerbatim(params) || isListings(params))
394 FileName const included_file = includedFilename(buffer, params);
395 if (!isLyXFilename(included_file.absFilename()))
398 Buffer * buf = theBufferList().getBuffer(included_file.absFilename());
400 // the readonly flag can/will be wrong, not anymore I think.
401 if (!fs::exists(included_file.toFilesystemEncoding()))
403 buf = theBufferList().newBuffer(included_file.absFilename());
404 if (!loadLyXFile(buf, included_file)) {
405 //close the buffer we just opened
406 theBufferList().close(buf, false);
410 buf->setParentName(parentFilename(buffer));
418 int InsetInclude::latex(Buffer const & buffer, odocstream & os,
419 OutputParams const & runparams) const
421 string incfile(to_utf8(params_["filename"]));
423 // Do nothing if no file name has been specified
427 FileName const included_file(includedFilename(buffer, params_));
429 //Check we're not trying to include ourselves.
430 //FIXME RECURSIVE INCLUDE
431 //This isn't sufficient, as the inclusion could be downstream.
432 //But it'll have to do for now.
433 if (isInputOrInclude(params_) &&
434 buffer.fileName() == included_file.toFilesystemEncoding())
436 Alert::error(_("Recursive input"),
437 bformat(_("Attempted to include file %1$s in itself! "
438 "Ignoring inclusion."), from_utf8(incfile)));
442 Buffer const * const m_buffer = buffer.getMasterBuffer();
444 // if incfile is relative, make it relative to the master
446 if (!absolutePath(incfile)) {
448 incfile = to_utf8(makeRelPath(from_utf8(included_file.absFilename()),
449 from_utf8(m_buffer->filePath())));
452 // write it to a file (so far the complete file)
453 string const exportfile = changeExtension(incfile, ".tex");
454 string const mangled =
455 DocFileName(changeExtension(included_file.absFilename(),".tex")).
457 FileName const writefile(makeAbsPath(mangled, m_buffer->temppath()));
461 LYXERR(Debug::LATEX) << "incfile:" << incfile << endl;
462 LYXERR(Debug::LATEX) << "exportfile:" << exportfile << endl;
463 LYXERR(Debug::LATEX) << "writefile:" << writefile << endl;
465 if (runparams.inComment || runparams.dryrun) {
466 //Don't try to load or copy the file if we're
467 //in a comment or doing a dryrun
468 } else if (isInputOrInclude(params_) &&
469 isLyXFilename(included_file.absFilename())) {
470 //if it's a LyX file and we're inputting or including,
471 //try to load it so we can write the associated latex
472 if (!loadIfNeeded(buffer, params_))
475 Buffer * tmp = theBufferList().getBuffer(included_file.absFilename());
477 if (tmp->params().textclass != m_buffer->params().textclass) {
479 docstring text = bformat(_("Included file `%1$s'\n"
480 "has textclass `%2$s'\n"
481 "while parent file has textclass `%3$s'."),
482 makeDisplayPath(included_file.absFilename()),
483 from_utf8(tmp->params().getTextClass().name()),
484 from_utf8(m_buffer->params().getTextClass().name()));
485 Alert::warning(_("Different textclasses"), text);
489 tmp->markDepClean(m_buffer->temppath());
492 #warning handle non existing files
493 #warning Second argument is irrelevant!
494 // since only_body is true, makeLaTeXFile will not look at second
495 // argument. Should we set it to string(), or should makeLaTeXFile
496 // make use of it somehow? (JMarc 20031002)
498 // The included file might be written in a different encoding
499 Encoding const * const oldEnc = runparams.encoding;
500 runparams.encoding = &tmp->params().encoding();
501 tmp->makeLaTeXFile(writefile,
502 onlyPath(masterFilename(buffer)),
504 runparams.encoding = oldEnc;
506 // In this case, it's not a LyX file, so we copy the file
507 // to the temp dir, so that .aux files etc. are not created
508 // in the original dir. Files included by this file will be
509 // found via input@path, see ../Buffer.cpp.
510 unsigned long const checksum_in = sum(included_file);
511 unsigned long const checksum_out = sum(writefile);
513 if (checksum_in != checksum_out) {
514 if (!copy(included_file, writefile)) {
517 << to_utf8(bformat(_("Could not copy the file\n%1$s\n"
518 "into the temporary directory."),
519 from_utf8(included_file.absFilename())))
526 string const tex_format = (runparams.flavor == OutputParams::LATEX) ?
527 "latex" : "pdflatex";
528 if (isVerbatim(params_)) {
529 incfile = latex_path(incfile);
531 os << '\\' << from_ascii(params_.getCmdName()) << '{'
532 << from_utf8(incfile) << '}';
533 } else if (type(params_) == INPUT) {
534 runparams.exportdata->addExternalFile(tex_format, writefile,
537 // \input wants file with extension (default is .tex)
538 if (!isLyXFilename(included_file.absFilename())) {
539 incfile = latex_path(incfile);
541 os << '\\' << from_ascii(params_.getCmdName())
542 << '{' << from_utf8(incfile) << '}';
544 incfile = changeExtension(incfile, ".tex");
545 incfile = latex_path(incfile);
547 os << '\\' << from_ascii(params_.getCmdName())
548 << '{' << from_utf8(incfile) << '}';
550 } else if (type(params_) == LISTINGS) {
551 os << '\\' << from_ascii(params_.getCmdName());
552 string opt = params_.getOptions();
553 // opt is set in QInclude dialog and should have passed validation.
554 InsetListingsParams params(opt);
555 if (!params.params().empty())
556 os << "[" << from_utf8(params.params()) << "]";
557 os << '{' << from_utf8(incfile) << '}';
559 runparams.exportdata->addExternalFile(tex_format, writefile,
562 // \include don't want extension and demands that the
563 // file really have .tex
564 incfile = changeExtension(incfile, string());
565 incfile = latex_path(incfile);
567 os << '\\' << from_ascii(params_.getCmdName()) << '{'
568 << from_utf8(incfile) << '}';
575 int InsetInclude::plaintext(Buffer const & buffer, odocstream & os,
576 OutputParams const &) const
578 if (isVerbatim(params_) || isListings(params_)) {
579 os << '[' << getScreenLabel(buffer) << '\n';
580 // FIXME: We don't know the encoding of the file
581 docstring const str =
582 from_utf8(getFileContents(includedFilename(buffer, params_)));
585 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
587 docstring const str = '[' + getScreenLabel(buffer) + ']';
594 int InsetInclude::docbook(Buffer const & buffer, odocstream & os,
595 OutputParams const & runparams) const
597 string incfile = to_utf8(params_["filename"]);
599 // Do nothing if no file name has been specified
603 string const included_file = includedFilename(buffer, params_).absFilename();
605 //Check we're not trying to include ourselves.
606 //FIXME RECURSIVE INCLUDE
607 //This isn't sufficient, as the inclusion could be downstream.
608 //But it'll have to do for now.
609 if (buffer.fileName() == included_file) {
610 Alert::error(_("Recursive input"),
611 bformat(_("Attempted to include file %1$s in itself! "
612 "Ignoring inclusion."), from_utf8(incfile)));
616 // write it to a file (so far the complete file)
617 string const exportfile = changeExtension(incfile, ".sgml");
618 DocFileName writefile(changeExtension(included_file, ".sgml"));
620 if (loadIfNeeded(buffer, params_)) {
621 Buffer * tmp = theBufferList().getBuffer(included_file);
623 string const mangled = writefile.mangledFilename();
624 writefile = makeAbsPath(mangled,
625 buffer.getMasterBuffer()->temppath());
629 LYXERR(Debug::LATEX) << "incfile:" << incfile << endl;
630 LYXERR(Debug::LATEX) << "exportfile:" << exportfile << endl;
631 LYXERR(Debug::LATEX) << "writefile:" << writefile << endl;
633 tmp->makeDocBookFile(writefile, runparams, true);
636 runparams.exportdata->addExternalFile("docbook", writefile,
638 runparams.exportdata->addExternalFile("docbook-xml", writefile,
641 if (isVerbatim(params_) || isListings(params_)) {
642 os << "<inlinegraphic fileref=\""
643 << '&' << include_label << ';'
644 << "\" format=\"linespecific\">";
646 os << '&' << include_label << ';';
652 void InsetInclude::validate(LaTeXFeatures & features) const
654 string incfile(to_utf8(params_["filename"]));
657 Buffer const & buffer = features.buffer();
659 string const included_file = includedFilename(buffer, params_).absFilename();
661 if (isLyXFilename(included_file))
662 writefile = changeExtension(included_file, ".sgml");
664 writefile = included_file;
666 if (!features.runparams().nice && !isVerbatim(params_) && !isListings(params_)) {
667 incfile = DocFileName(writefile).mangledFilename();
668 writefile = makeAbsPath(incfile,
669 buffer.getMasterBuffer()->temppath()).absFilename();
672 features.includeFile(include_label, writefile);
674 if (isVerbatim(params_))
675 features.require("verbatim");
676 else if (isListings(params_))
677 features.require("listings");
679 // Here we must do the fun stuff...
680 // Load the file in the include if it needs
682 if (loadIfNeeded(buffer, params_)) {
684 Buffer * const tmp = theBufferList().getBuffer(included_file);
685 // make sure the buffer isn't us
686 // FIXME RECURSIVE INCLUDES
687 // This is not sufficient, as recursive includes could be
688 // more than a file away. But it will do for now.
689 if (tmp && tmp != & buffer) {
690 // We must temporarily change features.buffer,
691 // otherwise it would always be the master buffer,
692 // and nested includes would not work.
693 features.setBuffer(*tmp);
694 tmp->validate(features);
695 features.setBuffer(buffer);
701 void InsetInclude::getLabelList(Buffer const & buffer,
702 std::vector<docstring> & list) const
704 if (isListings(params_)) {
705 InsetListingsParams params(params_.getOptions());
706 string label = params.getParamValue("label");
708 list.push_back(from_utf8(label));
710 else if (loadIfNeeded(buffer, params_)) {
711 string const included_file = includedFilename(buffer, params_).absFilename();
712 Buffer * tmp = theBufferList().getBuffer(included_file);
713 tmp->setParentName("");
714 tmp->getLabelList(list);
715 tmp->setParentName(parentFilename(buffer));
720 void InsetInclude::fillWithBibKeys(Buffer const & buffer,
721 std::vector<std::pair<string, docstring> > & keys) const
723 if (loadIfNeeded(buffer, params_)) {
724 string const included_file = includedFilename(buffer, params_).absFilename();
725 Buffer * tmp = theBufferList().getBuffer(included_file);
726 tmp->setParentName("");
727 tmp->fillWithBibKeys(keys);
728 tmp->setParentName(parentFilename(buffer));
733 void InsetInclude::updateBibfilesCache(Buffer const & buffer)
735 Buffer * const tmp = getChildBuffer(buffer, params_);
737 tmp->setParentName("");
738 tmp->updateBibfilesCache();
739 tmp->setParentName(parentFilename(buffer));
744 std::vector<FileName> const &
745 InsetInclude::getBibfilesCache(Buffer const & buffer) const
747 Buffer * const tmp = getChildBuffer(buffer, params_);
749 tmp->setParentName("");
750 std::vector<FileName> const & cache = tmp->getBibfilesCache();
751 tmp->setParentName(parentFilename(buffer));
754 static std::vector<FileName> const empty;
759 bool InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
761 BOOST_ASSERT(mi.base.bv && mi.base.bv->buffer());
763 bool use_preview = false;
764 if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
765 graphics::PreviewImage const * pimage =
766 preview_->getPreviewImage(*mi.base.bv->buffer());
767 use_preview = pimage && pimage->image();
771 preview_->metrics(mi, dim);
775 button_.update(getScreenLabel(*mi.base.bv->buffer()),
778 button_.metrics(mi, dim);
781 Box b(0, dim.wid, -dim.asc, dim.des);
784 bool const changed = dim_ != dim;
790 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
792 setPosCache(pi, x, y);
794 BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
796 bool use_preview = false;
797 if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
798 graphics::PreviewImage const * pimage =
799 preview_->getPreviewImage(*pi.base.bv->buffer());
800 use_preview = pimage && pimage->image();
804 preview_->draw(pi, x, y);
806 button_.draw(pi, x, y);
810 Inset::DisplayType InsetInclude::display() const
812 return type(params_) == INPUT ? Inline : AlignCenter;
821 void InsetInclude::fileChanged() const
823 Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
827 Buffer const & buffer = *buffer_ptr;
828 preview_->removePreview(buffer);
829 add_preview(*preview_.get(), *this, buffer);
830 preview_->startLoading(buffer);
836 bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
838 FileName const included_file = includedFilename(buffer, params);
840 return type(params) == INPUT && params.preview() &&
841 isFileReadable(included_file);
845 docstring const latex_string(InsetInclude const & inset, Buffer const & buffer)
848 // We don't need to set runparams.encoding since this will be done
849 // by latex() anyway.
850 OutputParams runparams(0);
851 runparams.flavor = OutputParams::LATEX;
852 inset.latex(buffer, os, runparams);
858 void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
859 Buffer const & buffer)
861 InsetCommandParams const & params = inset.params();
862 if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
863 preview_wanted(params, buffer)) {
864 renderer.setAbsFile(includedFilename(buffer, params));
865 docstring const snippet = latex_string(inset, buffer);
866 renderer.addPreview(snippet, buffer);
873 void InsetInclude::addPreview(graphics::PreviewLoader & ploader) const
875 Buffer const & buffer = ploader.buffer();
876 if (preview_wanted(params(), buffer)) {
877 preview_->setAbsFile(includedFilename(buffer, params()));
878 docstring const snippet = latex_string(*this, buffer);
879 preview_->addPreview(snippet, ploader);
884 void InsetInclude::addToToc(TocList & toclist, Buffer const & buffer) const
886 Buffer const * const childbuffer = getChildBuffer(buffer, params_);
890 TocList const & childtoclist = childbuffer->tocBackend().tocs();
891 TocList::const_iterator it = childtoclist.begin();
892 TocList::const_iterator const end = childtoclist.end();
893 for(; it != end; ++it)
894 toclist[it->first].insert(toclist[it->first].end(),
895 it->second.begin(), it->second.end());
899 void InsetInclude::updateLabels(Buffer const & buffer) const
901 Buffer const * const childbuffer = getChildBuffer(buffer, params_);
905 lyx::updateLabels(*childbuffer, true);
909 void InsetInclude::updateCounter(Counters & counters)
911 if (!isListings(params_))
914 InsetListingsParams const par = params_.getOptions();
915 if (par.getParamValue("caption").empty())
918 counters.step(from_ascii("listing"));
919 counter_ = counters.value(from_ascii("listing"));
924 string const InsetIncludeMailer::name_("include");
926 InsetIncludeMailer::InsetIncludeMailer(InsetInclude & inset)
931 string const InsetIncludeMailer::inset2string(Buffer const &) const
933 return params2string(inset_.params());
937 void InsetIncludeMailer::string2params(string const & in,
938 InsetCommandParams & params)
944 istringstream data(in);
950 if (!lex || name != name_)
951 return print_mailer_error("InsetIncludeMailer", in, 1, name_);
953 // This is part of the inset proper that is usually swallowed
954 // by Text::readInset
957 if (!lex || id != "Include")
958 return print_mailer_error("InsetIncludeMailer", in, 2, "Include");
960 InsetInclude inset(params);
962 params = inset.params();
967 InsetIncludeMailer::params2string(InsetCommandParams const & params)
969 InsetInclude inset(params);
971 data << name_ << ' ';
973 data << "\\end_inset\n";