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)
9 * Full author contact details are available in file CREDITS.
14 #include "InsetInclude.h"
17 #include "buffer_funcs.h"
18 #include "BufferList.h"
19 #include "BufferParams.h"
20 #include "BufferView.h"
21 #include "Converter.h"
23 #include "DispatchResult.h"
25 #include "ErrorList.h"
28 #include "FuncRequest.h"
29 #include "FuncStatus.h"
30 #include "LaTeXFeatures.h"
31 #include "LayoutFile.h"
32 #include "LayoutModuleList.h"
35 #include "MetricsInfo.h"
36 #include "output_plaintext.h"
37 #include "output_xhtml.h"
38 #include "OutputParams.h"
39 #include "texstream.h"
40 #include "TextClass.h"
41 #include "TocBackend.h"
43 #include "frontends/alert.h"
44 #include "frontends/Painter.h"
46 #include "graphics/PreviewImage.h"
47 #include "graphics/PreviewLoader.h"
49 #include "insets/InsetLabel.h"
50 #include "insets/InsetListingsParams.h"
51 #include "insets/RenderPreview.h"
53 #include "mathed/MacroTable.h"
55 #include "support/convert.h"
56 #include "support/debug.h"
57 #include "support/docstream.h"
58 #include "support/FileNameList.h"
59 #include "support/filetools.h"
60 #include "support/gettext.h"
61 #include "support/lassert.h"
62 #include "support/lstrings.h" // contains
63 #include "support/lyxalgo.h"
64 #include "support/mutex.h"
65 #include "support/ExceptionMessage.h"
67 #include "support/bind.h"
70 using namespace lyx::support;
74 namespace Alert = frontend::Alert;
79 docstring const uniqueID()
81 static unsigned int seed = 1000;
83 Mutex::Locker lock(&mutex);
84 return "file" + convert<docstring>(++seed);
88 /// the type of inclusion
90 INCLUDE, VERB, INPUT, VERBAST, LISTINGS, NONE
94 Types type(string const & s)
98 if (s == "verbatiminput")
100 if (s == "verbatiminput*")
102 if (s == "lstinputlisting" || s == "inputminted")
110 Types type(InsetCommandParams const & params)
112 return type(params.getCmdName());
116 bool isListings(InsetCommandParams const & params)
118 return type(params) == LISTINGS;
122 bool isVerbatim(InsetCommandParams const & params)
124 Types const t = type(params);
125 return t == VERB || t == VERBAST;
129 bool isInputOrInclude(InsetCommandParams const & params)
131 Types const t = type(params);
132 return t == INPUT || t == INCLUDE;
136 FileName const masterFileName(Buffer const & buffer)
138 return buffer.masterBuffer()->fileName();
142 void add_preview(RenderMonitoredPreview &, InsetInclude const &, Buffer const &);
145 string const parentFileName(Buffer const & buffer)
147 return buffer.absFileName();
151 FileName const includedFileName(Buffer const & buffer,
152 InsetCommandParams const & params)
154 return makeAbsPath(to_utf8(params["filename"]),
155 onlyPath(parentFileName(buffer)));
159 InsetLabel * createLabel(Buffer * buf, docstring const & label_str)
161 if (label_str.empty())
163 InsetCommandParams icp(LABEL_CODE);
164 icp["name"] = label_str;
165 return new InsetLabel(buf, icp);
171 InsetInclude::InsetInclude(Buffer * buf, InsetCommandParams const & p)
172 : InsetCommand(buf, p), include_label(uniqueID()),
173 preview_(make_unique<RenderMonitoredPreview>(this)), failedtoload_(false),
174 set_label_(false), label_(0), child_buffer_(0)
176 preview_->connect([=](){ fileChanged(); });
178 if (isListings(params())) {
179 InsetListingsParams listing_params(to_utf8(p["lstparams"]));
180 label_ = createLabel(buffer_, from_utf8(listing_params.getParamValue("label")));
181 } else if (isInputOrInclude(params()) && buf)
186 InsetInclude::InsetInclude(InsetInclude const & other)
187 : InsetCommand(other), include_label(other.include_label),
188 preview_(make_unique<RenderMonitoredPreview>(this)), failedtoload_(false),
189 set_label_(false), label_(0), child_buffer_(0)
191 preview_->connect([=](){ fileChanged(); });
194 label_ = new InsetLabel(*other.label_);
198 InsetInclude::~InsetInclude()
204 void InsetInclude::setBuffer(Buffer & buffer)
206 InsetCommand::setBuffer(buffer);
208 label_->setBuffer(buffer);
212 void InsetInclude::setChildBuffer(Buffer * buffer)
214 child_buffer_ = buffer;
218 ParamInfo const & InsetInclude::findInfo(string const & /* cmdName */)
221 // This is only correct for the case of listings, but it'll do for now.
222 // In the other cases, this second parameter should just be empty.
223 static ParamInfo param_info_;
224 if (param_info_.empty()) {
225 param_info_.add("filename", ParamInfo::LATEX_REQUIRED);
226 param_info_.add("lstparams", ParamInfo::LATEX_OPTIONAL);
227 param_info_.add("literal", ParamInfo::LYX_INTERNAL);
233 bool InsetInclude::isCompatibleCommand(string const & s)
235 return type(s) != NONE;
239 void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
241 switch (cmd.action()) {
243 case LFUN_INSET_EDIT: {
244 editIncluded(to_utf8(params()["filename"]));
248 case LFUN_INSET_MODIFY: {
249 // It should be OK just to invalidate the cache in setParams()
251 // child_buffer_ = 0;
252 InsetCommandParams p(INCLUDE_CODE);
253 if (cmd.getArg(0) == "changetype") {
255 InsetCommand::doDispatch(cur, cmd);
258 InsetCommand::string2params(to_utf8(cmd.argument()), p);
259 if (!p.getCmdName().empty()) {
261 InsetListingsParams new_params(to_utf8(p["lstparams"]));
262 docstring const new_label =
263 from_utf8(new_params.getParamValue("label"));
265 if (new_label.empty()) {
271 old_label = label_->getParam("name");
273 label_ = createLabel(buffer_, new_label);
274 label_->setBuffer(buffer());
277 if (new_label != old_label) {
278 label_->updateLabelAndRefs(new_label, &cur);
279 // the label might have been adapted (duplicate)
280 if (new_label != label_->getParam("name")) {
281 new_params.addParam("label", "{" +
282 to_utf8(label_->getParam("name")) + "}", true);
283 p["lstparams"] = from_utf8(new_params.params());
290 cur.forceBufferUpdate();
292 cur.noScreenUpdate();
296 //pass everything else up the chain
298 InsetCommand::doDispatch(cur, cmd);
304 void InsetInclude::editIncluded(string const & file)
306 string const ext = support::getExtension(file);
308 FuncRequest fr(LFUN_BUFFER_CHILD_OPEN, file);
311 // tex file or other text file in verbatim mode
312 theFormats().edit(buffer(),
313 support::makeAbsPath(file, support::onlyPath(buffer().absFileName())),
318 bool InsetInclude::getStatus(Cursor & cur, FuncRequest const & cmd,
319 FuncStatus & flag) const
321 switch (cmd.action()) {
323 case LFUN_INSET_EDIT:
324 flag.setEnabled(true);
327 case LFUN_INSET_MODIFY:
328 if (cmd.getArg(0) == "changetype")
329 return InsetCommand::getStatus(cur, cmd, flag);
331 flag.setEnabled(true);
335 return InsetCommand::getStatus(cur, cmd, flag);
340 void InsetInclude::setParams(InsetCommandParams const & p)
342 // invalidate the cache
345 InsetCommand::setParams(p);
348 if (preview_->monitoring())
349 preview_->stopMonitoring();
351 if (type(params()) == INPUT)
352 add_preview(*preview_, *this, buffer());
356 bool InsetInclude::isChildIncluded() const
358 std::list<std::string> includeonlys =
359 buffer().params().getIncludedChildren();
360 if (includeonlys.empty())
362 return (std::find(includeonlys.begin(),
364 to_utf8(params()["filename"])) != includeonlys.end());
368 docstring InsetInclude::screenLabel() const
372 switch (type(params())) {
374 temp = buffer().B_("Input");
377 temp = buffer().B_("Verbatim Input");
380 temp = buffer().B_("Verbatim Input*");
383 if (isChildIncluded())
384 temp = buffer().B_("Include");
386 temp += buffer().B_("Include (excluded)");
389 temp = listings_label_;
392 LASSERT(false, temp = buffer().B_("Unknown"));
398 if (params()["filename"].empty())
401 temp += from_utf8(onlyFileName(to_utf8(params()["filename"])));
407 Buffer * InsetInclude::getChildBuffer() const
409 Buffer * childBuffer = loadIfNeeded();
411 // FIXME RECURSIVE INCLUDE
412 // This isn't sufficient, as the inclusion could be downstream.
413 // But it'll have to do for now.
414 return (childBuffer == &buffer()) ? 0 : childBuffer;
418 Buffer * InsetInclude::loadIfNeeded() const
420 // This is for background export and preview. We don't even want to
421 // try to load the cloned child document again.
422 if (buffer().isClone())
423 return child_buffer_;
425 // Don't try to load it again if we failed before.
426 if (failedtoload_ || isVerbatim(params()) || isListings(params()))
429 FileName const included_file = includedFileName(buffer(), params());
430 // Use cached Buffer if possible.
431 if (child_buffer_ != 0) {
432 if (theBufferList().isLoaded(child_buffer_)
433 // additional sanity check: make sure the Buffer really is
434 // associated with the file we want.
435 && child_buffer_ == theBufferList().getBuffer(included_file))
436 return child_buffer_;
437 // Buffer vanished, so invalidate cache and try to reload.
441 if (!isLyXFileName(included_file.absFileName()))
444 Buffer * child = theBufferList().getBuffer(included_file);
446 // the readonly flag can/will be wrong, not anymore I think.
447 if (!included_file.exists())
450 child = theBufferList().newBuffer(included_file.absFileName());
452 // Buffer creation is not possible.
455 // Set parent before loading, such that macros can be tracked
456 child->setParent(&buffer());
458 if (child->loadLyXFile() != Buffer::ReadSuccess) {
459 failedtoload_ = true;
461 //close the buffer we just opened
462 theBufferList().release(child);
466 if (!child->errorList("Parse").empty()) {
467 // FIXME: Do something.
470 // The file was already loaded, so, simply
471 // inform parent buffer about local macros.
472 Buffer const * parent = &buffer();
473 child->setParent(parent);
475 child->listMacroNames(macros);
476 MacroNameSet::const_iterator cit = macros.begin();
477 MacroNameSet::const_iterator end = macros.end();
478 for (; cit != end; ++cit)
479 parent->usermacros.insert(*cit);
482 // Cache the child buffer.
483 child_buffer_ = child;
488 void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
490 string incfile = to_utf8(params()["filename"]);
492 // Do nothing if no file name has been specified
496 FileName const included_file = includedFileName(buffer(), params());
498 // Check we're not trying to include ourselves.
499 // FIXME RECURSIVE INCLUDE
500 // This isn't sufficient, as the inclusion could be downstream.
501 // But it'll have to do for now.
502 if (isInputOrInclude(params()) &&
503 buffer().absFileName() == included_file.absFileName())
505 Alert::error(_("Recursive input"),
506 bformat(_("Attempted to include file %1$s in itself! "
507 "Ignoring inclusion."), from_utf8(incfile)));
511 Buffer const * const masterBuffer = buffer().masterBuffer();
513 // if incfile is relative, make it relative to the master
515 if (!FileName::isAbsolute(incfile)) {
517 incfile = to_utf8(makeRelPath(from_utf8(included_file.absFileName()),
518 from_utf8(masterBuffer->filePath())));
521 string exppath = incfile;
522 if (!runparams.export_folder.empty()) {
523 exppath = makeAbsPath(exppath, runparams.export_folder).realPath();
524 FileName(exppath).onlyPath().createPath();
527 // write it to a file (so far the complete file)
531 if (type(params()) == LISTINGS) {
532 exportfile = exppath;
533 mangled = DocFileName(included_file).mangledFileName();
535 exportfile = changeExtension(exppath, ".tex");
536 mangled = DocFileName(changeExtension(included_file.absFileName(), ".tex")).
542 else if (!runparams.silent)
543 ; // no warning wanted
544 else if (!isValidLaTeXFileName(incfile)) {
545 frontend::Alert::warning(_("Invalid filename"),
546 _("The following filename will cause troubles "
547 "when running the exported file through LaTeX: ") +
549 } else if (!isValidDVIFileName(incfile)) {
550 frontend::Alert::warning(_("Problematic filename for DVI"),
551 _("The following filename can cause troubles "
552 "when running the exported file through LaTeX "
553 "and opening the resulting DVI: ") +
554 from_utf8(incfile), true);
557 FileName const writefile(makeAbsPath(mangled, runparams.for_preview ?
558 buffer().temppath() : masterBuffer->temppath()));
560 LYXERR(Debug::LATEX, "incfile:" << incfile);
561 LYXERR(Debug::LATEX, "exportfile:" << exportfile);
562 LYXERR(Debug::LATEX, "writefile:" << writefile);
564 string const tex_format = flavor2format(runparams.flavor);
566 switch (type(params())) {
569 incfile = latex_path(incfile);
571 os << '\\' << from_ascii(params().getCmdName()) << '{'
572 << from_utf8(incfile) << '}';
576 runparams.exportdata->addExternalFile(tex_format, writefile,
579 // \input wants file with extension (default is .tex)
580 if (!isLyXFileName(included_file.absFileName())) {
581 incfile = latex_path(incfile);
583 os << '\\' << from_ascii(params().getCmdName())
584 << '{' << from_utf8(incfile) << '}';
586 incfile = changeExtension(incfile, ".tex");
587 incfile = latex_path(incfile);
589 os << '\\' << from_ascii(params().getCmdName())
590 << '{' << from_utf8(incfile) << '}';
595 // Here, listings and minted have sligthly different behaviors.
596 // Using listings, it is always possible to have a caption,
597 // even for non-floats. Using minted, only floats can have a
598 // caption. So, with minted we use the following strategy.
599 // If a caption was specified but the float parameter was not,
600 // we ourselves add a caption above the listing (because the
601 // listing comes from a file and might span several pages).
602 // Otherwise, if float was specified, the floating listing
603 // environment provided by minted is used. In either case, the
604 // label parameter is taken as the label by which the float
605 // can be referenced, otherwise it will have the meaning
606 // intended by minted. In this last case, the label will
607 // serve as a sort of caption that, however, will be shown
608 // by minted only if the frame parameter is also specified.
609 bool const use_minted = buffer().params().use_minted;
610 runparams.exportdata->addExternalFile(tex_format, writefile,
612 string const opt = to_utf8(params()["lstparams"]);
613 // opt is set in QInclude dialog and should have passed validation.
614 InsetListingsParams lstparams(opt);
615 docstring parameters = from_utf8(lstparams.params());
620 bool isfloat = lstparams.isFloat();
621 // Get float placement, language, caption, and
622 // label, then remove the relative options if minted.
623 vector<docstring> opts =
624 getVectorFromString(parameters, from_ascii(","), false);
625 vector<docstring> latexed_opts;
626 for (size_t i = 0; i < opts.size(); ++i) {
627 if (use_minted && prefixIs(opts[i], from_ascii("float"))) {
628 if (prefixIs(opts[i], from_ascii("float=")))
629 placement = opts[i].substr(6);
630 opts.erase(opts.begin() + i--);
631 } else if (use_minted && prefixIs(opts[i], from_ascii("language="))) {
632 language = opts[i].substr(9);
633 opts.erase(opts.begin() + i--);
634 } else if (prefixIs(opts[i], from_ascii("caption="))) {
635 caption = params().prepareCommand(runparams, trim(opts[i].substr(8), "{}"),
636 ParamInfo::HANDLING_LATEXIFY);
637 opts.erase(opts.begin() + i--);
639 latexed_opts.push_back(from_ascii("caption=") + caption);
640 } else if (prefixIs(opts[i], from_ascii("label="))) {
641 label = params().prepareCommand(runparams, trim(opts[i].substr(6), "{}"),
642 ParamInfo::HANDLING_ESCAPE);
643 opts.erase(opts.begin() + i--);
645 latexed_opts.push_back(from_ascii("label={") + label + "}");
647 if (use_minted && !label.empty()) {
648 if (isfloat || !caption.empty())
649 label = trim(label, "{}");
651 opts.push_back(from_ascii("label=") + label);
654 if (!latexed_opts.empty())
655 opts.insert(opts.end(), latexed_opts.begin(), latexed_opts.end());
656 parameters = getStringFromVector(opts, from_ascii(","));
657 if (language.empty())
658 language = from_ascii("TeX");
659 if (use_minted && isfloat) {
660 os << breakln << "\\begin{listing}";
661 if (!placement.empty())
662 os << '[' << placement << "]";
664 } else if (use_minted && !caption.empty()) {
665 os << breakln << "\\lyxmintcaption[t]{" << caption;
667 os << "\\label{" << label << "}";
670 os << (use_minted ? "\\inputminted" : "\\lstinputlisting");
671 if (!parameters.empty())
672 os << "[" << parameters << "]";
674 os << '{' << ascii_lowercase(language) << '}';
675 os << '{' << incfile << '}';
676 if (use_minted && isfloat) {
677 if (!caption.empty())
678 os << breakln << "\\caption{" << caption << "}";
680 os << breakln << "\\label{" << label << "}";
681 os << breakln << "\\end{listing}\n";
686 runparams.exportdata->addExternalFile(tex_format, writefile,
689 // \include don't want extension and demands that the
690 // file really have .tex
691 incfile = changeExtension(incfile, string());
692 incfile = latex_path(incfile);
694 os << '\\' << from_ascii(params().getCmdName()) << '{'
695 << from_utf8(incfile) << '}';
702 if (runparams.inComment || runparams.dryrun)
703 // Don't try to load or copy the file if we're
704 // in a comment or doing a dryrun
707 if (isInputOrInclude(params()) &&
708 isLyXFileName(included_file.absFileName())) {
709 // if it's a LyX file and we're inputting or including,
710 // try to load it so we can write the associated latex
712 Buffer * tmp = loadIfNeeded();
714 if (!runparams.silent) {
715 docstring text = bformat(_("Could not load included "
717 "Please, check whether it actually exists."),
718 included_file.displayName());
719 throw ExceptionMessage(ErrorException, _("Error: "),
725 if (!runparams.silent) {
726 if (tmp->params().baseClass() != masterBuffer->params().baseClass()) {
728 docstring text = bformat(_("Included file `%1$s'\n"
729 "has textclass `%2$s'\n"
730 "while parent file has textclass `%3$s'."),
731 included_file.displayName(),
732 from_utf8(tmp->params().documentClass().name()),
733 from_utf8(masterBuffer->params().documentClass().name()));
734 Alert::warning(_("Different textclasses"), text, true);
737 string const child_tf = tmp->params().useNonTeXFonts ? "true" : "false";
738 string const master_tf = masterBuffer->params().useNonTeXFonts ? "true" : "false";
739 if (tmp->params().useNonTeXFonts != masterBuffer->params().useNonTeXFonts) {
740 docstring text = bformat(_("Included file `%1$s'\n"
741 "has use-non-TeX-fonts set to `%2$s'\n"
742 "while parent file has use-non-TeX-fonts set to `%3$s'."),
743 included_file.displayName(),
745 from_utf8(master_tf));
746 Alert::warning(_("Different use-non-TeX-fonts settings"), text, true);
749 // Make sure modules used in child are all included in master
750 // FIXME It might be worth loading the children's modules into the master
751 // over in BufferParams rather than doing this check.
752 LayoutModuleList const masterModules = masterBuffer->params().getModules();
753 LayoutModuleList const childModules = tmp->params().getModules();
754 LayoutModuleList::const_iterator it = childModules.begin();
755 LayoutModuleList::const_iterator end = childModules.end();
756 for (; it != end; ++it) {
757 string const module = *it;
758 LayoutModuleList::const_iterator found =
759 find(masterModules.begin(), masterModules.end(), module);
760 if (found == masterModules.end()) {
761 docstring text = bformat(_("Included file `%1$s'\n"
762 "uses module `%2$s'\n"
763 "which is not used in parent file."),
764 included_file.displayName(), from_utf8(module));
765 Alert::warning(_("Module not found"), text);
770 tmp->markDepClean(masterBuffer->temppath());
772 // Don't assume the child's format is latex
773 string const inc_format = tmp->params().bufferFormat();
774 FileName const tmpwritefile(changeExtension(writefile.absFileName(),
775 theFormats().extension(inc_format)));
777 // FIXME: handle non existing files
778 // The included file might be written in a different encoding
780 Encoding const * const oldEnc = runparams.encoding;
781 Language const * const oldLang = runparams.master_language;
782 // If the master uses non-TeX fonts (XeTeX, LuaTeX),
783 // the children must be encoded in plain utf8!
784 runparams.encoding = masterBuffer->params().useNonTeXFonts ?
785 encodings.fromLyXName("utf8-plain")
786 : &tmp->params().encoding();
787 runparams.master_language = buffer().params().language;
788 runparams.par_begin = 0;
789 runparams.par_end = tmp->paragraphs().size();
790 runparams.is_child = true;
791 Buffer::ExportStatus retval =
792 tmp->makeLaTeXFile(tmpwritefile, masterFileName(buffer()).
793 onlyPath().absFileName(), runparams, Buffer::OnlyBody);
794 if (retval == Buffer::ExportKilled && buffer().isClone() &&
795 buffer().isExporting()) {
796 // We really shouldn't get here, I don't think.
797 LYXERR0("No conversion exception?");
798 throw ConversionException();
800 else if (retval != Buffer::ExportSuccess) {
801 if (!runparams.silent) {
802 docstring msg = bformat(_("Included file `%1$s' "
803 "was not exported correctly.\n "
804 "LaTeX export is probably incomplete."),
805 included_file.displayName());
806 ErrorList const & el = tmp->errorList("Export");
808 msg = bformat(from_ascii("%1$s\n\n%2$s\n\n%3$s"),
809 msg, el.begin()->error, el.begin()->description);
810 throw ExceptionMessage(ErrorException, _("Error: "), msg);
813 runparams.encoding = oldEnc;
814 runparams.master_language = oldLang;
815 runparams.is_child = false;
817 // If needed, use converters to produce a latex file from the child
818 if (tmpwritefile != writefile) {
820 Converters::RetVal const retval =
821 theConverters().convert(tmp, tmpwritefile, writefile,
822 included_file, inc_format, tex_format, el);
823 if (retval == Converters::KILLED && buffer().isClone() &&
824 buffer().isExporting()) {
825 // We really shouldn't get here, I don't think.
826 LYXERR0("No conversion exception?");
827 throw ConversionException();
828 } else if (retval != Converters::SUCCESS && !runparams.silent) {
829 docstring msg = bformat(_("Included file `%1$s' "
830 "was not exported correctly.\n "
831 "LaTeX export is probably incomplete."),
832 included_file.displayName());
834 msg = bformat(from_ascii("%1$s\n\n%2$s\n\n%3$s"),
835 msg, el.begin()->error, el.begin()->description);
836 throw ExceptionMessage(ErrorException, _("Error: "), msg);
840 // In this case, it's not a LyX file, so we copy the file
841 // to the temp dir, so that .aux files etc. are not created
842 // in the original dir. Files included by this file will be
843 // found via either the environment variable TEXINPUTS, or
844 // input@path, see ../Buffer.cpp.
845 unsigned long const checksum_in = included_file.checksum();
846 unsigned long const checksum_out = writefile.checksum();
848 if (checksum_in != checksum_out) {
849 if (!included_file.copyTo(writefile)) {
852 to_utf8(bformat(_("Could not copy the file\n%1$s\n"
853 "into the temporary directory."),
854 from_utf8(included_file.absFileName()))));
862 docstring InsetInclude::xhtml(XHTMLStream & xs, OutputParams const & rp) const
867 // For verbatim and listings, we just include the contents of the file as-is.
868 // In the case of listings, we wrap it in <pre>.
869 bool const listing = isListings(params());
870 if (listing || isVerbatim(params())) {
872 xs << html::StartTag("pre");
873 // FIXME: We don't know the encoding of the file, default to UTF-8.
874 xs << includedFileName(buffer(), params()).fileContents("UTF-8");
876 xs << html::EndTag("pre");
880 // We don't (yet) know how to Input or Include non-LyX files.
881 // (If we wanted to get really arcane, we could run some tex2html
882 // converter on the included file. But that's just masochistic.)
883 FileName const included_file = includedFileName(buffer(), params());
884 if (!isLyXFileName(included_file.absFileName())) {
886 frontend::Alert::warning(_("Unsupported Inclusion"),
887 bformat(_("LyX does not know how to include non-LyX files when "
888 "generating HTML output. Offending file:\n%1$s"),
889 params()["filename"]));
893 // In the other cases, we will generate the HTML and include it.
895 // Check we're not trying to include ourselves.
896 // FIXME RECURSIVE INCLUDE
897 if (buffer().absFileName() == included_file.absFileName()) {
898 Alert::error(_("Recursive input"),
899 bformat(_("Attempted to include file %1$s in itself! "
900 "Ignoring inclusion."), params()["filename"]));
904 Buffer const * const ibuf = loadIfNeeded();
908 // are we generating only some paragraphs, or all of them?
909 bool const all_pars = !rp.dryrun ||
910 (rp.par_begin == 0 &&
911 rp.par_end == (int)buffer().text().paragraphs().size());
913 OutputParams op = rp;
917 ibuf->writeLyXHTMLSource(xs.os(), op, Buffer::IncludedFile);
919 xs << XHTMLStream::ESCAPE_NONE
920 << "<!-- Included file: "
921 << from_utf8(included_file.absFileName())
922 << XHTMLStream::ESCAPE_NONE
928 int InsetInclude::plaintext(odocstringstream & os,
929 OutputParams const & op, size_t) const
931 // just write the filename if we're making a tooltip or toc entry,
932 // or are generating this for advanced search
933 if (op.for_tooltip || op.for_toc || op.for_search) {
934 os << '[' << screenLabel() << '\n'
935 << getParam("filename") << "\n]";
936 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
939 if (isVerbatim(params()) || isListings(params())) {
940 os << '[' << screenLabel() << '\n'
941 // FIXME: We don't know the encoding of the file, default to UTF-8.
942 << includedFileName(buffer(), params()).fileContents("UTF-8")
944 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
947 Buffer const * const ibuf = loadIfNeeded();
949 docstring const str = '[' + screenLabel() + ']';
953 writePlaintextFile(*ibuf, os, op);
958 int InsetInclude::docbook(odocstream & os, OutputParams const & runparams) const
960 string incfile = to_utf8(params()["filename"]);
962 // Do nothing if no file name has been specified
966 string const included_file = includedFileName(buffer(), params()).absFileName();
968 // Check we're not trying to include ourselves.
969 // FIXME RECURSIVE INCLUDE
970 // This isn't sufficient, as the inclusion could be downstream.
971 // But it'll have to do for now.
972 if (buffer().absFileName() == included_file) {
973 Alert::error(_("Recursive input"),
974 bformat(_("Attempted to include file %1$s in itself! "
975 "Ignoring inclusion."), from_utf8(incfile)));
979 string exppath = incfile;
980 if (!runparams.export_folder.empty()) {
981 exppath = makeAbsPath(exppath, runparams.export_folder).realPath();
982 FileName(exppath).onlyPath().createPath();
985 // write it to a file (so far the complete file)
986 string const exportfile = changeExtension(exppath, ".sgml");
987 DocFileName writefile(changeExtension(included_file, ".sgml"));
989 Buffer * tmp = loadIfNeeded();
991 string const mangled = writefile.mangledFileName();
992 writefile = makeAbsPath(mangled,
993 buffer().masterBuffer()->temppath());
997 LYXERR(Debug::LATEX, "incfile:" << incfile);
998 LYXERR(Debug::LATEX, "exportfile:" << exportfile);
999 LYXERR(Debug::LATEX, "writefile:" << writefile);
1001 tmp->makeDocBookFile(writefile, runparams, Buffer::OnlyBody);
1004 runparams.exportdata->addExternalFile("docbook", writefile,
1006 runparams.exportdata->addExternalFile("docbook-xml", writefile,
1009 if (isVerbatim(params()) || isListings(params())) {
1010 os << "<inlinegraphic fileref=\""
1011 << '&' << include_label << ';'
1012 << "\" format=\"linespecific\">";
1014 os << '&' << include_label << ';';
1020 void InsetInclude::validate(LaTeXFeatures & features) const
1022 LATTEST(&buffer() == &features.buffer());
1024 string incfile = to_utf8(params()["filename"]);
1025 string const included_file =
1026 includedFileName(buffer(), params()).absFileName();
1029 if (isLyXFileName(included_file))
1030 writefile = changeExtension(included_file, ".sgml");
1032 writefile = included_file;
1034 if (!features.runparams().nice && !isVerbatim(params()) && !isListings(params())) {
1035 incfile = DocFileName(writefile).mangledFileName();
1036 writefile = makeAbsPath(incfile,
1037 buffer().masterBuffer()->temppath()).absFileName();
1040 features.includeFile(include_label, writefile);
1042 features.useInsetLayout(getLayout());
1043 if (isVerbatim(params()))
1044 features.require("verbatim");
1045 else if (isListings(params())) {
1046 if (buffer().params().use_minted) {
1047 features.require("minted");
1048 string const opts = to_utf8(params()["lstparams"]);
1049 InsetListingsParams lstpars(opts);
1050 if (!lstpars.isFloat() && contains(opts, "caption="))
1051 features.require("lyxmintcaption");
1053 features.require("listings");
1056 // Here we must do the fun stuff...
1057 // Load the file in the include if it needs
1059 Buffer * const tmp = loadIfNeeded();
1061 // the file is loaded
1062 // make sure the buffer isn't us
1063 // FIXME RECURSIVE INCLUDES
1064 // This is not sufficient, as recursive includes could be
1065 // more than a file away. But it will do for now.
1066 if (tmp && tmp != &buffer()) {
1067 // We must temporarily change features.buffer,
1068 // otherwise it would always be the master buffer,
1069 // and nested includes would not work.
1070 features.setBuffer(*tmp);
1071 // Maybe this is already a child
1072 bool const is_child =
1073 features.runparams().is_child;
1074 features.runparams().is_child = true;
1075 tmp->validate(features);
1076 features.runparams().is_child = is_child;
1077 features.setBuffer(buffer());
1083 void InsetInclude::collectBibKeys(InsetIterator const & /*di*/, FileNameList & checkedFiles) const
1085 Buffer * child = loadIfNeeded();
1088 // FIXME RECURSIVE INCLUDE
1089 // This isn't sufficient, as the inclusion could be downstream.
1090 // But it'll have to do for now.
1091 if (child == &buffer())
1093 child->collectBibKeys(checkedFiles);
1097 void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
1099 LBUFERR(mi.base.bv);
1101 bool use_preview = false;
1102 if (RenderPreview::previewText()) {
1103 graphics::PreviewImage const * pimage =
1104 preview_->getPreviewImage(mi.base.bv->buffer());
1105 use_preview = pimage && pimage->image();
1109 preview_->metrics(mi, dim);
1113 button_.update(screenLabel(), true, false);
1115 button_.metrics(mi, dim);
1118 Box b(0, dim.wid, -dim.asc, dim.des);
1123 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
1125 LBUFERR(pi.base.bv);
1127 bool use_preview = false;
1128 if (RenderPreview::previewText()) {
1129 graphics::PreviewImage const * pimage =
1130 preview_->getPreviewImage(pi.base.bv->buffer());
1131 use_preview = pimage && pimage->image();
1135 preview_->draw(pi, x, y);
1137 button_.draw(pi, x, y);
1141 void InsetInclude::write(ostream & os) const
1143 params().Write(os, &buffer());
1147 string InsetInclude::contextMenuName() const
1149 return "context-include";
1153 Inset::DisplayType InsetInclude::display() const
1155 return type(params()) == INPUT ? Inline : AlignCenter;
1159 docstring InsetInclude::layoutName() const
1161 if (isListings(params()))
1162 return from_ascii("IncludeListings");
1163 return InsetCommand::layoutName();
1171 void InsetInclude::fileChanged() const
1173 Buffer const * const buffer = updateFrontend();
1177 preview_->removePreview(*buffer);
1178 add_preview(*preview_, *this, *buffer);
1179 preview_->startLoading(*buffer);
1185 bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
1187 FileName const included_file = includedFileName(buffer, params);
1189 return type(params) == INPUT && params.preview() &&
1190 included_file.isReadableFile();
1194 docstring latexString(InsetInclude const & inset)
1196 odocstringstream ods;
1198 // We don't need to set runparams.encoding since this will be done
1199 // by latex() anyway.
1200 OutputParams runparams(0);
1201 runparams.flavor = OutputParams::LATEX;
1202 runparams.for_preview = true;
1203 inset.latex(os, runparams);
1209 void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
1210 Buffer const & buffer)
1212 InsetCommandParams const & params = inset.params();
1213 if (RenderPreview::previewText() && preview_wanted(params, buffer)) {
1214 renderer.setAbsFile(includedFileName(buffer, params));
1215 docstring const snippet = latexString(inset);
1216 renderer.addPreview(snippet, buffer);
1223 void InsetInclude::addPreview(DocIterator const & /*inset_pos*/,
1224 graphics::PreviewLoader & ploader) const
1226 Buffer const & buffer = ploader.buffer();
1227 if (!preview_wanted(params(), buffer))
1229 preview_->setAbsFile(includedFileName(buffer, params()));
1230 docstring const snippet = latexString(*this);
1231 preview_->addPreview(snippet, ploader);
1235 void InsetInclude::addToToc(DocIterator const & cpit, bool output_active,
1236 UpdateType utype, TocBackend & backend) const
1238 if (isListings(params())) {
1240 label_->addToToc(cpit, output_active, utype, backend);
1241 TocBuilder & b = backend.builder("listing");
1242 b.pushItem(cpit, screenLabel(), output_active);
1243 InsetListingsParams p(to_utf8(params()["lstparams"]));
1244 b.argumentItem(from_utf8(p.getParamValue("caption")));
1247 Buffer const * const childbuffer = getChildBuffer();
1249 TocBuilder & b = backend.builder("child");
1250 docstring str = childbuffer ? childbuffer->fileName().displayName()
1252 b.pushItem(cpit, str, output_active);
1258 // Update the child's tocBackend. The outliner uses the master's, but
1259 // the navigation menu uses the child's.
1260 childbuffer->tocBackend().update(output_active, utype);
1261 // Include Tocs from children
1262 childbuffer->inset().addToToc(DocIterator(), output_active, utype,
1264 //Copy missing outliner names (though the user has been warned against
1265 //having different document class and module selection between master
1267 for (pair<string, docstring> const & name
1268 : childbuffer->params().documentClass().outlinerNames())
1269 backend.addName(name.first, translateIfPossible(name.second));
1274 void InsetInclude::updateCommand()
1279 docstring old_label = label_->getParam("name");
1280 label_->updateLabel(old_label);
1281 // the label might have been adapted (duplicate)
1282 docstring new_label = label_->getParam("name");
1283 if (old_label == new_label)
1286 // update listings parameters...
1287 InsetCommandParams p(INCLUDE_CODE);
1289 InsetListingsParams par(to_utf8(params()["lstparams"]));
1290 par.addParam("label", "{" + to_utf8(new_label) + "}", true);
1291 p["lstparams"] = from_utf8(par.params());
1296 void InsetInclude::updateBuffer(ParIterator const & it, UpdateType utype)
1298 button_.update(screenLabel(), true, false);
1300 Buffer const * const childbuffer = getChildBuffer();
1302 childbuffer->updateBuffer(Buffer::UpdateChildOnly, utype);
1305 if (!isListings(params()))
1309 label_->updateBuffer(it, utype);
1311 InsetListingsParams const par(to_utf8(params()["lstparams"]));
1312 if (par.getParamValue("caption").empty()) {
1313 listings_label_ = buffer().B_("Program Listing");
1316 Buffer const & master = *buffer().masterBuffer();
1317 Counters & counters = master.params().documentClass().counters();
1318 docstring const cnt = from_ascii("listing");
1319 listings_label_ = master.B_("Program Listing");
1320 if (counters.hasCounter(cnt)) {
1321 counters.step(cnt, utype);
1322 listings_label_ += " " + convert<docstring>(counters.value(cnt));