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/FileName.h"
59 #include "support/FileNameList.h"
60 #include "support/filetools.h"
61 #include "support/gettext.h"
62 #include "support/lassert.h"
63 #include "support/lstrings.h" // contains
64 #include "support/lyxalgo.h"
65 #include "support/mutex.h"
66 #include "support/ExceptionMessage.h"
68 #include "support/bind.h"
71 using namespace lyx::support;
75 namespace Alert = frontend::Alert;
80 docstring const uniqueID()
82 static unsigned int seed = 1000;
84 Mutex::Locker lock(&mutex);
85 return "file" + convert<docstring>(++seed);
89 /// the type of inclusion
91 INCLUDE, VERB, INPUT, VERBAST, LISTINGS, NONE
95 Types type(string const & s)
99 if (s == "verbatiminput")
101 if (s == "verbatiminput*")
103 if (s == "lstinputlisting" || s == "inputminted")
111 Types type(InsetCommandParams const & params)
113 return type(params.getCmdName());
117 bool isListings(InsetCommandParams const & params)
119 return type(params) == LISTINGS;
123 bool isVerbatim(InsetCommandParams const & params)
125 Types const t = type(params);
126 return t == VERB || t == VERBAST;
130 bool isInputOrInclude(InsetCommandParams const & params)
132 Types const t = type(params);
133 return t == INPUT || t == INCLUDE;
137 FileName const masterFileName(Buffer const & buffer)
139 return buffer.masterBuffer()->fileName();
143 void add_preview(RenderMonitoredPreview &, InsetInclude const &, Buffer const &);
146 string const parentFileName(Buffer const & buffer)
148 return buffer.absFileName();
152 FileName const includedFileName(Buffer const & buffer,
153 InsetCommandParams const & params)
155 return makeAbsPath(ltrim(to_utf8(params["filename"])),
156 onlyPath(parentFileName(buffer)));
160 InsetLabel * createLabel(Buffer * buf, docstring const & label_str)
162 if (label_str.empty())
164 InsetCommandParams icp(LABEL_CODE);
165 icp["name"] = label_str;
166 return new InsetLabel(buf, icp);
170 char_type replaceCommaInBraces(docstring & params)
172 // Code point from private use area
173 char_type private_char = 0xE000;
175 for (char_type & c : params) {
180 else if (c == ',' && count)
189 InsetInclude::InsetInclude(Buffer * buf, InsetCommandParams const & p)
190 : InsetCommand(buf, p), include_label(uniqueID()),
191 preview_(make_unique<RenderMonitoredPreview>(this)), failedtoload_(false),
192 set_label_(false), label_(0), child_buffer_(0), file_exist_(false)
194 preview_->connect([=](){ fileChanged(); });
196 if (isListings(params())) {
197 InsetListingsParams listing_params(to_utf8(p["lstparams"]));
198 label_ = createLabel(buffer_, from_utf8(listing_params.getParamValue("label")));
199 } else if (isInputOrInclude(params()) && buf)
204 InsetInclude::InsetInclude(InsetInclude const & other)
205 : InsetCommand(other), include_label(other.include_label),
206 preview_(make_unique<RenderMonitoredPreview>(this)), failedtoload_(false),
207 set_label_(false), label_(0), child_buffer_(0), file_exist_(other.file_exist_)
209 preview_->connect([=](){ fileChanged(); });
212 label_ = new InsetLabel(*other.label_);
216 InsetInclude::~InsetInclude()
222 void InsetInclude::setBuffer(Buffer & buffer)
224 InsetCommand::setBuffer(buffer);
226 label_->setBuffer(buffer);
230 void InsetInclude::setChildBuffer(Buffer * buffer)
232 child_buffer_ = buffer;
236 ParamInfo const & InsetInclude::findInfo(string const & /* cmdName */)
239 // This is only correct for the case of listings, but it'll do for now.
240 // In the other cases, this second parameter should just be empty.
241 static ParamInfo param_info_;
242 if (param_info_.empty()) {
243 param_info_.add("filename", ParamInfo::LATEX_REQUIRED);
244 param_info_.add("lstparams", ParamInfo::LATEX_OPTIONAL);
245 param_info_.add("literal", ParamInfo::LYX_INTERNAL);
251 bool InsetInclude::isCompatibleCommand(string const & s)
253 return type(s) != NONE;
257 bool InsetInclude::needsCProtection(bool const /*maintext*/, bool const fragile) const
259 // We need to \cprotect all types in fragile context
264 void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
266 switch (cmd.action()) {
268 case LFUN_INSET_EDIT: {
269 editIncluded(ltrim(to_utf8(params()["filename"])));
273 case LFUN_INSET_MODIFY: {
274 // It should be OK just to invalidate the cache in setParams()
276 // child_buffer_ = 0;
277 InsetCommandParams p(INCLUDE_CODE);
278 if (cmd.getArg(0) == "changetype") {
280 InsetCommand::doDispatch(cur, cmd);
283 InsetCommand::string2params(to_utf8(cmd.argument()), p);
284 if (!p.getCmdName().empty()) {
286 InsetListingsParams new_params(to_utf8(p["lstparams"]));
287 docstring const new_label =
288 from_utf8(new_params.getParamValue("label"));
290 if (new_label.empty()) {
296 old_label = label_->getParam("name");
298 label_ = createLabel(buffer_, new_label);
299 label_->setBuffer(buffer());
302 if (new_label != old_label) {
303 label_->updateLabelAndRefs(new_label, &cur);
304 // the label might have been adapted (duplicate)
305 if (new_label != label_->getParam("name")) {
306 new_params.addParam("label", "{" +
307 to_utf8(label_->getParam("name")) + "}", true);
308 p["lstparams"] = from_utf8(new_params.params());
315 cur.forceBufferUpdate();
317 cur.noScreenUpdate();
321 case LFUN_MOUSE_RELEASE: {
322 if (cmd.modifier() == ControlModifier) {
323 FileName const incfile = includedFileName(buffer(), params());
324 string const & incname = incfile.absFileName();
325 editIncluded(incname);
331 //pass everything else up the chain
333 InsetCommand::doDispatch(cur, cmd);
339 void InsetInclude::editIncluded(string const & f)
341 if (isLyXFileName(f)) {
342 FuncRequest fr(LFUN_BUFFER_CHILD_OPEN, f);
345 // tex file or other text file in verbatim mode
346 theFormats().edit(buffer(),
347 support::makeAbsPath(f, support::onlyPath(buffer().absFileName())),
352 bool InsetInclude::getStatus(Cursor & cur, FuncRequest const & cmd,
353 FuncStatus & flag) const
355 switch (cmd.action()) {
357 case LFUN_INSET_EDIT:
358 flag.setEnabled(true);
361 case LFUN_INSET_MODIFY:
362 if (cmd.getArg(0) == "changetype")
363 return InsetCommand::getStatus(cur, cmd, flag);
365 flag.setEnabled(true);
369 return InsetCommand::getStatus(cur, cmd, flag);
374 void InsetInclude::setParams(InsetCommandParams const & p)
376 // invalidate the cache
379 InsetCommand::setParams(p);
382 if (preview_->monitoring())
383 preview_->stopMonitoring();
385 if (type(params()) == INPUT)
386 add_preview(*preview_, *this, buffer());
390 bool InsetInclude::isChildIncluded() const
392 std::list<std::string> includeonlys =
393 buffer().params().getIncludedChildren();
394 if (includeonlys.empty())
396 return (std::find(includeonlys.begin(),
398 ltrim(to_utf8(params()["filename"]))) != includeonlys.end());
402 docstring InsetInclude::screenLabel() const
404 docstring pre = file_exist_ ? docstring() : _("FILE MISSING:");
408 switch (type(params())) {
410 temp = buffer().B_("Input");
413 temp = buffer().B_("Verbatim");
416 temp = buffer().B_("Verbatim*");
419 if (isChildIncluded())
420 temp = buffer().B_("Include");
422 temp += buffer().B_("Include (excluded)");
425 temp = listings_label_;
428 LASSERT(false, temp = buffer().B_("Unknown"));
434 if (ltrim(params()["filename"]).empty())
437 temp += from_utf8(onlyFileName(ltrim(to_utf8(params()["filename"]))));
439 return pre.empty() ? temp : pre + from_ascii(" ") + temp;
443 Buffer * InsetInclude::getChildBuffer() const
445 Buffer * childBuffer = loadIfNeeded();
447 // FIXME RECURSIVE INCLUDE
448 // This isn't sufficient, as the inclusion could be downstream.
449 // But it'll have to do for now.
450 return (childBuffer == &buffer()) ? 0 : childBuffer;
454 Buffer * InsetInclude::loadIfNeeded() const
456 // This is for background export and preview. We don't even want to
457 // try to load the cloned child document again.
458 if (buffer().isClone())
459 return child_buffer_;
461 // Don't try to load it again if we failed before.
462 if (failedtoload_ || isVerbatim(params()) || isListings(params()))
465 FileName const included_file = includedFileName(buffer(), params());
466 // Use cached Buffer if possible.
467 if (child_buffer_ != 0) {
468 if (theBufferList().isLoaded(child_buffer_)
469 // additional sanity check: make sure the Buffer really is
470 // associated with the file we want.
471 && child_buffer_ == theBufferList().getBuffer(included_file))
472 return child_buffer_;
473 // Buffer vanished, so invalidate cache and try to reload.
477 if (!isLyXFileName(included_file.absFileName()))
480 Buffer * child = theBufferList().getBuffer(included_file);
482 // the readonly flag can/will be wrong, not anymore I think.
483 if (!included_file.exists())
486 child = theBufferList().newBuffer(included_file.absFileName());
488 // Buffer creation is not possible.
491 // Set parent before loading, such that macros can be tracked
492 child->setParent(&buffer());
494 if (child->loadLyXFile() != Buffer::ReadSuccess) {
495 failedtoload_ = true;
497 //close the buffer we just opened
498 theBufferList().release(child);
502 if (!child->errorList("Parse").empty()) {
503 // FIXME: Do something.
506 // The file was already loaded, so, simply
507 // inform parent buffer about local macros.
508 Buffer const * parent = &buffer();
509 child->setParent(parent);
511 child->listMacroNames(macros);
512 MacroNameSet::const_iterator cit = macros.begin();
513 MacroNameSet::const_iterator end = macros.end();
514 for (; cit != end; ++cit)
515 parent->usermacros.insert(*cit);
518 // Cache the child buffer.
519 child_buffer_ = child;
524 void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
526 string incfile = ltrim(to_utf8(params()["filename"]));
528 // Warn if no file name has been specified
529 if (incfile.empty()) {
530 frontend::Alert::warning(_("No file name specified"),
531 _("An included file name is empty.\n"
532 "Ignoring Inclusion"),
536 // Warn if file doesn't exist
537 if (!includedFileExist()) {
538 frontend::Alert::warning(_("Included file not found"),
539 bformat(_("The included file\n"
541 "has not been found. LyX will ignore the inclusion."),
547 FileName const included_file = includedFileName(buffer(), params());
549 // Check we're not trying to include ourselves.
550 // FIXME RECURSIVE INCLUDE
551 // This isn't sufficient, as the inclusion could be downstream.
552 // But it'll have to do for now.
553 if (isInputOrInclude(params()) &&
554 buffer().absFileName() == included_file.absFileName())
556 Alert::error(_("Recursive input"),
557 bformat(_("Attempted to include file %1$s in itself! "
558 "Ignoring inclusion."), from_utf8(incfile)));
562 Buffer const * const masterBuffer = buffer().masterBuffer();
564 // if incfile is relative, make it relative to the master
566 if (!FileName::isAbsolute(incfile)) {
568 incfile = to_utf8(makeRelPath(from_utf8(included_file.absFileName()),
569 from_utf8(masterBuffer->filePath())));
572 string const exppath = runparams.export_folder.empty() ?
574 makeAbsPath(exppath, runparams.export_folder).realPath();
576 // write it to a file (so far the complete file)
580 if (type(params()) == LISTINGS) {
581 exportfile = exppath;
582 mangled = DocFileName(included_file).mangledFileName();
584 exportfile = changeExtension(exppath, ".tex");
585 mangled = DocFileName(changeExtension(included_file.absFileName(), ".tex")).
591 else if (!runparams.silent)
592 ; // no warning wanted
593 else if (!isValidLaTeXFileName(incfile)) {
594 frontend::Alert::warning(_("Invalid filename"),
595 _("The following filename will cause troubles "
596 "when running the exported file through LaTeX: ") +
598 } else if (!isValidDVIFileName(incfile)) {
599 frontend::Alert::warning(_("Problematic filename for DVI"),
600 _("The following filename can cause troubles "
601 "when running the exported file through LaTeX "
602 "and opening the resulting DVI: ") +
603 from_utf8(incfile), true);
606 FileName const writefile(makeAbsPath(mangled, runparams.for_preview ?
607 buffer().temppath() : masterBuffer->temppath()));
609 LYXERR(Debug::LATEX, "incfile:" << incfile);
610 LYXERR(Debug::LATEX, "exportfile:" << exportfile);
611 LYXERR(Debug::LATEX, "writefile:" << writefile);
613 string const tex_format = flavor2format(runparams.flavor);
615 switch (type(params())) {
618 incfile = latex_path(incfile);
620 os << '\\' << from_ascii(params().getCmdName()) << '{'
621 << from_utf8(incfile) << '}';
625 runparams.exportdata->addExternalFile(tex_format, writefile,
628 // \input wants file with extension (default is .tex)
629 if (!isLyXFileName(included_file.absFileName())) {
630 incfile = latex_path(incfile);
632 os << '\\' << from_ascii(params().getCmdName())
633 << '{' << from_utf8(incfile) << '}';
635 incfile = changeExtension(incfile, ".tex");
636 incfile = latex_path(incfile);
638 os << '\\' << from_ascii(params().getCmdName())
639 << '{' << from_utf8(incfile) << '}';
644 // Here, listings and minted have sligthly different behaviors.
645 // Using listings, it is always possible to have a caption,
646 // even for non-floats. Using minted, only floats can have a
647 // caption. So, with minted we use the following strategy.
648 // If a caption was specified but the float parameter was not,
649 // we ourselves add a caption above the listing (because the
650 // listing comes from a file and might span several pages).
651 // Otherwise, if float was specified, the floating listing
652 // environment provided by minted is used. In either case, the
653 // label parameter is taken as the label by which the float
654 // can be referenced, otherwise it will have the meaning
655 // intended by minted. In this last case, the label will
656 // serve as a sort of caption that, however, will be shown
657 // by minted only if the frame parameter is also specified.
658 bool const use_minted = buffer().params().use_minted;
659 runparams.exportdata->addExternalFile(tex_format, writefile,
661 string const opt = to_utf8(params()["lstparams"]);
662 // opt is set in QInclude dialog and should have passed validation.
663 InsetListingsParams lstparams(opt);
664 docstring parameters = from_utf8(lstparams.params());
669 bool isfloat = lstparams.isFloat();
670 // We are going to split parameters at commas, so
671 // replace commas that are not parameter separators
672 // with a code point from the private use area
673 char_type comma = replaceCommaInBraces(parameters);
674 // Get float placement, language, caption, and
675 // label, then remove the relative options if minted.
676 vector<docstring> opts =
677 getVectorFromString(parameters, from_ascii(","), false);
678 vector<docstring> latexed_opts;
679 for (size_t i = 0; i < opts.size(); ++i) {
680 // Restore replaced commas
681 opts[i] = subst(opts[i], comma, ',');
682 if (use_minted && prefixIs(opts[i], from_ascii("float"))) {
683 if (prefixIs(opts[i], from_ascii("float=")))
684 placement = opts[i].substr(6);
685 opts.erase(opts.begin() + i--);
686 } else if (use_minted && prefixIs(opts[i], from_ascii("language="))) {
687 language = opts[i].substr(9);
688 opts.erase(opts.begin() + i--);
689 } else if (prefixIs(opts[i], from_ascii("caption="))) {
690 caption = params().prepareCommand(runparams, trim(opts[i].substr(8), "{}"),
691 ParamInfo::HANDLING_LATEXIFY);
692 opts.erase(opts.begin() + i--);
694 latexed_opts.push_back(from_ascii("caption={") + caption + "}");
695 } else if (prefixIs(opts[i], from_ascii("label="))) {
696 label = params().prepareCommand(runparams, trim(opts[i].substr(6), "{}"),
697 ParamInfo::HANDLING_ESCAPE);
698 opts.erase(opts.begin() + i--);
700 latexed_opts.push_back(from_ascii("label={") + label + "}");
702 if (use_minted && !label.empty()) {
703 if (isfloat || !caption.empty())
704 label = trim(label, "{}");
706 opts.push_back(from_ascii("label=") + label);
709 if (!latexed_opts.empty())
710 opts.insert(opts.end(), latexed_opts.begin(), latexed_opts.end());
711 parameters = getStringFromVector(opts, from_ascii(","));
712 if (language.empty())
713 language = from_ascii("TeX");
714 if (use_minted && isfloat) {
715 os << breakln << "\\begin{listing}";
716 if (!placement.empty())
717 os << '[' << placement << "]";
719 } else if (use_minted && !caption.empty()) {
720 os << breakln << "\\lyxmintcaption[t]{" << caption;
722 os << "\\label{" << label << "}";
725 os << (use_minted ? "\\inputminted" : "\\lstinputlisting");
726 if (!parameters.empty())
727 os << "[" << parameters << "]";
729 os << '{' << ascii_lowercase(language) << '}';
730 os << '{' << incfile << '}';
731 if (use_minted && isfloat) {
732 if (!caption.empty())
733 os << breakln << "\\caption{" << caption << "}";
735 os << breakln << "\\label{" << label << "}";
736 os << breakln << "\\end{listing}\n";
741 runparams.exportdata->addExternalFile(tex_format, writefile,
744 // \include don't want extension and demands that the
745 // file really have .tex
746 incfile = changeExtension(incfile, string());
747 incfile = latex_path(incfile);
749 os << '\\' << from_ascii(params().getCmdName()) << '{'
750 << from_utf8(incfile) << '}';
757 if (runparams.inComment || runparams.dryrun)
758 // Don't try to load or copy the file if we're
759 // in a comment or doing a dryrun
762 if (isInputOrInclude(params()) &&
763 isLyXFileName(included_file.absFileName())) {
764 // if it's a LyX file and we're inputting or including,
765 // try to load it so we can write the associated latex
767 Buffer * tmp = loadIfNeeded();
769 if (!runparams.silent) {
770 docstring text = bformat(_("Could not load included "
772 "Please, check whether it actually exists."),
773 included_file.displayName());
774 throw ExceptionMessage(ErrorException, _("Error: "),
780 if (!runparams.silent) {
781 if (tmp->params().baseClass() != masterBuffer->params().baseClass()) {
783 docstring text = bformat(_("Included file `%1$s'\n"
784 "has textclass `%2$s'\n"
785 "while parent file has textclass `%3$s'."),
786 included_file.displayName(),
787 from_utf8(tmp->params().documentClass().name()),
788 from_utf8(masterBuffer->params().documentClass().name()));
789 Alert::warning(_("Different textclasses"), text, true);
792 string const child_tf = tmp->params().useNonTeXFonts ? "true" : "false";
793 string const master_tf = masterBuffer->params().useNonTeXFonts ? "true" : "false";
794 if (tmp->params().useNonTeXFonts != masterBuffer->params().useNonTeXFonts) {
795 docstring text = bformat(_("Included file `%1$s'\n"
796 "has use-non-TeX-fonts set to `%2$s'\n"
797 "while parent file has use-non-TeX-fonts set to `%3$s'."),
798 included_file.displayName(),
800 from_utf8(master_tf));
801 Alert::warning(_("Different use-non-TeX-fonts settings"), text, true);
803 else if (tmp->params().inputenc != masterBuffer->params().inputenc) {
804 docstring text = bformat(_("Included file `%1$s'\n"
805 "uses input encoding \"%2$s\" [%3$s]\n"
806 "while parent file uses input encoding \"%4$s\" [%5$s]."),
807 included_file.displayName(),
808 _(tmp->params().inputenc),
809 from_utf8(tmp->params().encoding().guiName()),
810 _(masterBuffer->params().inputenc),
811 from_utf8(masterBuffer->params().encoding().guiName()));
812 Alert::warning(_("Different LaTeX input encodings"), text, true);
815 // Make sure modules used in child are all included in master
816 // FIXME It might be worth loading the children's modules into the master
817 // over in BufferParams rather than doing this check.
818 LayoutModuleList const masterModules = masterBuffer->params().getModules();
819 LayoutModuleList const childModules = tmp->params().getModules();
820 LayoutModuleList::const_iterator it = childModules.begin();
821 LayoutModuleList::const_iterator end = childModules.end();
822 for (; it != end; ++it) {
823 string const module = *it;
824 LayoutModuleList::const_iterator found =
825 find(masterModules.begin(), masterModules.end(), module);
826 if (found == masterModules.end()) {
827 docstring text = bformat(_("Included file `%1$s'\n"
828 "uses module `%2$s'\n"
829 "which is not used in parent file."),
830 included_file.displayName(), from_utf8(module));
831 Alert::warning(_("Module not found"), text, true);
836 tmp->markDepClean(masterBuffer->temppath());
838 // Don't assume the child's format is latex
839 string const inc_format = tmp->params().bufferFormat();
840 FileName const tmpwritefile(changeExtension(writefile.absFileName(),
841 theFormats().extension(inc_format)));
843 // FIXME: handle non existing files
844 // The included file might be written in a different encoding
846 Encoding const * const oldEnc = runparams.encoding;
847 Language const * const oldLang = runparams.master_language;
848 // If the master uses non-TeX fonts (XeTeX, LuaTeX),
849 // the children must be encoded in plain utf8!
850 runparams.encoding = masterBuffer->params().useNonTeXFonts ?
851 encodings.fromLyXName("utf8-plain") : oldEnc;
852 runparams.master_language = buffer().params().language;
853 runparams.par_begin = 0;
854 runparams.par_end = tmp->paragraphs().size();
855 runparams.is_child = true;
856 Buffer::ExportStatus retval =
857 tmp->makeLaTeXFile(tmpwritefile, masterFileName(buffer()).
858 onlyPath().absFileName(), runparams, Buffer::OnlyBody);
859 if (retval == Buffer::ExportKilled && buffer().isClone() &&
860 buffer().isExporting()) {
861 // We really shouldn't get here, I don't think.
862 LYXERR0("No conversion exception?");
863 throw ConversionException();
865 else if (retval != Buffer::ExportSuccess) {
866 if (!runparams.silent) {
867 docstring msg = bformat(_("Included file `%1$s' "
868 "was not exported correctly.\n "
869 "LaTeX export is probably incomplete."),
870 included_file.displayName());
871 ErrorList const & el = tmp->errorList("Export");
873 msg = bformat(from_ascii("%1$s\n\n%2$s\n\n%3$s"),
874 msg, el.begin()->error, el.begin()->description);
875 throw ExceptionMessage(ErrorException, _("Error: "), msg);
878 runparams.encoding = oldEnc;
879 runparams.master_language = oldLang;
880 runparams.is_child = false;
882 // If needed, use converters to produce a latex file from the child
883 if (tmpwritefile != writefile) {
885 Converters::RetVal const retval =
886 theConverters().convert(tmp, tmpwritefile, writefile,
887 included_file, inc_format, tex_format, el);
888 if (retval == Converters::KILLED && buffer().isClone() &&
889 buffer().isExporting()) {
890 // We really shouldn't get here, I don't think.
891 LYXERR0("No conversion exception?");
892 throw ConversionException();
893 } else if (retval != Converters::SUCCESS && !runparams.silent) {
894 docstring msg = bformat(_("Included file `%1$s' "
895 "was not exported correctly.\n "
896 "LaTeX export is probably incomplete."),
897 included_file.displayName());
899 msg = bformat(from_ascii("%1$s\n\n%2$s\n\n%3$s"),
900 msg, el.begin()->error, el.begin()->description);
901 throw ExceptionMessage(ErrorException, _("Error: "), msg);
905 // In this case, it's not a LyX file, so we copy the file
906 // to the temp dir, so that .aux files etc. are not created
907 // in the original dir. Files included by this file will be
908 // found via either the environment variable TEXINPUTS, or
909 // input@path, see ../Buffer.cpp.
910 unsigned long const checksum_in = included_file.checksum();
911 unsigned long const checksum_out = writefile.checksum();
913 if (checksum_in != checksum_out) {
914 if (!included_file.copyTo(writefile)) {
917 to_utf8(bformat(_("Could not copy the file\n%1$s\n"
918 "into the temporary directory."),
919 from_utf8(included_file.absFileName()))));
927 docstring InsetInclude::xhtml(XHTMLStream & xs, OutputParams const & rp) const
932 // For verbatim and listings, we just include the contents of the file as-is.
933 // In the case of listings, we wrap it in <pre>.
934 bool const listing = isListings(params());
935 if (listing || isVerbatim(params())) {
937 xs << html::StartTag("pre");
938 // FIXME: We don't know the encoding of the file, default to UTF-8.
939 xs << includedFileName(buffer(), params()).fileContents("UTF-8");
941 xs << html::EndTag("pre");
945 // We don't (yet) know how to Input or Include non-LyX files.
946 // (If we wanted to get really arcane, we could run some tex2html
947 // converter on the included file. But that's just masochistic.)
948 FileName const included_file = includedFileName(buffer(), params());
949 if (!isLyXFileName(included_file.absFileName())) {
951 frontend::Alert::warning(_("Unsupported Inclusion"),
952 bformat(_("LyX does not know how to include non-LyX files when "
953 "generating HTML output. Offending file:\n%1$s"),
954 ltrim(params()["filename"])));
958 // In the other cases, we will generate the HTML and include it.
960 // Check we're not trying to include ourselves.
961 // FIXME RECURSIVE INCLUDE
962 if (buffer().absFileName() == included_file.absFileName()) {
963 Alert::error(_("Recursive input"),
964 bformat(_("Attempted to include file %1$s in itself! "
965 "Ignoring inclusion."), ltrim(params()["filename"])));
969 Buffer const * const ibuf = loadIfNeeded();
973 // are we generating only some paragraphs, or all of them?
974 bool const all_pars = !rp.dryrun ||
975 (rp.par_begin == 0 &&
976 rp.par_end == (int)buffer().text().paragraphs().size());
978 OutputParams op = rp;
982 ibuf->writeLyXHTMLSource(xs.os(), op, Buffer::IncludedFile);
984 xs << XHTMLStream::ESCAPE_NONE
985 << "<!-- Included file: "
986 << from_utf8(included_file.absFileName())
987 << XHTMLStream::ESCAPE_NONE
993 int InsetInclude::plaintext(odocstringstream & os,
994 OutputParams const & op, size_t) const
996 // just write the filename if we're making a tooltip or toc entry,
997 // or are generating this for advanced search
998 if (op.for_tooltip || op.for_toc || op.for_search) {
999 os << '[' << screenLabel() << '\n'
1000 << ltrim(getParam("filename")) << "\n]";
1001 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
1004 if (isVerbatim(params()) || isListings(params())) {
1005 if (op.for_search) {
1006 os << '[' << screenLabel() << ']';
1009 os << '[' << screenLabel() << '\n'
1010 // FIXME: We don't know the encoding of the file, default to UTF-8.
1011 << includedFileName(buffer(), params()).fileContents("UTF-8")
1014 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
1017 Buffer const * const ibuf = loadIfNeeded();
1019 docstring const str = '[' + screenLabel() + ']';
1023 writePlaintextFile(*ibuf, os, op);
1028 int InsetInclude::docbook(odocstream & os, OutputParams const & runparams) const
1030 string incfile = ltrim(to_utf8(params()["filename"]));
1032 // Do nothing if no file name has been specified
1033 if (incfile.empty())
1036 string const included_file = includedFileName(buffer(), params()).absFileName();
1038 // Check we're not trying to include ourselves.
1039 // FIXME RECURSIVE INCLUDE
1040 // This isn't sufficient, as the inclusion could be downstream.
1041 // But it'll have to do for now.
1042 if (buffer().absFileName() == included_file) {
1043 Alert::error(_("Recursive input"),
1044 bformat(_("Attempted to include file %1$s in itself! "
1045 "Ignoring inclusion."), from_utf8(incfile)));
1049 string exppath = incfile;
1050 if (!runparams.export_folder.empty()) {
1051 exppath = makeAbsPath(exppath, runparams.export_folder).realPath();
1052 FileName(exppath).onlyPath().createPath();
1055 // write it to a file (so far the complete file)
1056 string const exportfile = changeExtension(exppath, ".sgml");
1057 DocFileName writefile(changeExtension(included_file, ".sgml"));
1059 Buffer * tmp = loadIfNeeded();
1061 string const mangled = writefile.mangledFileName();
1062 writefile = makeAbsPath(mangled,
1063 buffer().masterBuffer()->temppath());
1064 if (!runparams.nice)
1067 LYXERR(Debug::LATEX, "incfile:" << incfile);
1068 LYXERR(Debug::LATEX, "exportfile:" << exportfile);
1069 LYXERR(Debug::LATEX, "writefile:" << writefile);
1071 tmp->makeDocBookFile(writefile, runparams, Buffer::OnlyBody);
1074 runparams.exportdata->addExternalFile("docbook", writefile,
1076 runparams.exportdata->addExternalFile("docbook-xml", writefile,
1079 if (isVerbatim(params()) || isListings(params())) {
1080 os << "<inlinegraphic fileref=\""
1081 << '&' << include_label << ';'
1082 << "\" format=\"linespecific\">";
1084 os << '&' << include_label << ';';
1090 void InsetInclude::validate(LaTeXFeatures & features) const
1092 LATTEST(&buffer() == &features.buffer());
1094 string incfile = ltrim(to_utf8(params()["filename"]));
1095 string const included_file =
1096 includedFileName(buffer(), params()).absFileName();
1099 if (isLyXFileName(included_file))
1100 writefile = changeExtension(included_file, ".sgml");
1102 writefile = included_file;
1104 if (!features.runparams().nice && !isVerbatim(params()) && !isListings(params())) {
1105 incfile = DocFileName(writefile).mangledFileName();
1106 writefile = makeAbsPath(incfile,
1107 buffer().masterBuffer()->temppath()).absFileName();
1110 features.includeFile(include_label, writefile);
1112 features.useInsetLayout(getLayout());
1113 if (isVerbatim(params()))
1114 features.require("verbatim");
1115 else if (isListings(params())) {
1116 if (buffer().params().use_minted) {
1117 features.require("minted");
1118 string const opts = to_utf8(params()["lstparams"]);
1119 InsetListingsParams lstpars(opts);
1120 if (!lstpars.isFloat() && contains(opts, "caption="))
1121 features.require("lyxmintcaption");
1123 features.require("listings");
1126 // Here we must do the fun stuff...
1127 // Load the file in the include if it needs
1129 Buffer * const tmp = loadIfNeeded();
1131 // the file is loaded
1132 // make sure the buffer isn't us
1133 // FIXME RECURSIVE INCLUDES
1134 // This is not sufficient, as recursive includes could be
1135 // more than a file away. But it will do for now.
1136 if (tmp && tmp != &buffer()) {
1137 // We must temporarily change features.buffer,
1138 // otherwise it would always be the master buffer,
1139 // and nested includes would not work.
1140 features.setBuffer(*tmp);
1141 // Maybe this is already a child
1142 bool const is_child =
1143 features.runparams().is_child;
1144 features.runparams().is_child = true;
1145 tmp->validate(features);
1146 features.runparams().is_child = is_child;
1147 features.setBuffer(buffer());
1153 void InsetInclude::collectBibKeys(InsetIterator const & /*di*/, FileNameList & checkedFiles) const
1155 Buffer * child = loadIfNeeded();
1158 // FIXME RECURSIVE INCLUDE
1159 // This isn't sufficient, as the inclusion could be downstream.
1160 // But it'll have to do for now.
1161 if (child == &buffer())
1163 child->collectBibKeys(checkedFiles);
1167 void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
1169 LBUFERR(mi.base.bv);
1171 bool use_preview = false;
1172 if (RenderPreview::previewText()) {
1173 graphics::PreviewImage const * pimage =
1174 preview_->getPreviewImage(mi.base.bv->buffer());
1175 use_preview = pimage && pimage->image();
1179 preview_->metrics(mi, dim);
1183 button_.update(screenLabel(), true, false);
1185 button_.metrics(mi, dim);
1188 Box b(0, dim.wid, -dim.asc, dim.des);
1193 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
1195 LBUFERR(pi.base.bv);
1197 bool use_preview = false;
1198 if (RenderPreview::previewText()) {
1199 graphics::PreviewImage const * pimage =
1200 preview_->getPreviewImage(pi.base.bv->buffer());
1201 use_preview = pimage && pimage->image();
1205 preview_->draw(pi, x, y);
1207 button_.draw(pi, x, y);
1211 void InsetInclude::write(ostream & os) const
1213 params().Write(os, &buffer());
1217 string InsetInclude::contextMenuName() const
1219 return "context-include";
1223 Inset::DisplayType InsetInclude::display() const
1225 return type(params()) == INPUT ? Inline : AlignCenter;
1229 docstring InsetInclude::layoutName() const
1231 if (isListings(params()))
1232 return from_ascii("IncludeListings");
1233 return InsetCommand::layoutName();
1241 void InsetInclude::fileChanged() const
1243 Buffer const * const buffer = updateFrontend();
1247 preview_->removePreview(*buffer);
1248 add_preview(*preview_, *this, *buffer);
1249 preview_->startLoading(*buffer);
1255 bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
1257 FileName const included_file = includedFileName(buffer, params);
1259 return type(params) == INPUT && params.preview() &&
1260 included_file.isReadableFile();
1264 docstring latexString(InsetInclude const & inset)
1266 odocstringstream ods;
1268 // We don't need to set runparams.encoding since this will be done
1269 // by latex() anyway.
1270 OutputParams runparams(0);
1271 runparams.flavor = OutputParams::LATEX;
1272 runparams.for_preview = true;
1273 inset.latex(os, runparams);
1279 void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
1280 Buffer const & buffer)
1282 InsetCommandParams const & params = inset.params();
1283 if (RenderPreview::previewText() && preview_wanted(params, buffer)) {
1284 renderer.setAbsFile(includedFileName(buffer, params));
1285 docstring const snippet = latexString(inset);
1286 renderer.addPreview(snippet, buffer);
1293 void InsetInclude::addPreview(DocIterator const & /*inset_pos*/,
1294 graphics::PreviewLoader & ploader) const
1296 Buffer const & buffer = ploader.buffer();
1297 if (!preview_wanted(params(), buffer))
1299 preview_->setAbsFile(includedFileName(buffer, params()));
1300 docstring const snippet = latexString(*this);
1301 preview_->addPreview(snippet, ploader);
1305 void InsetInclude::addToToc(DocIterator const & cpit, bool output_active,
1306 UpdateType utype, TocBackend & backend) const
1308 if (isListings(params())) {
1310 label_->addToToc(cpit, output_active, utype, backend);
1311 TocBuilder & b = backend.builder("listing");
1312 b.pushItem(cpit, screenLabel(), output_active);
1313 InsetListingsParams p(to_utf8(params()["lstparams"]));
1314 b.argumentItem(from_utf8(p.getParamValue("caption")));
1316 } else if (isVerbatim(params())) {
1317 TocBuilder & b = backend.builder("child");
1318 b.pushItem(cpit, screenLabel(), output_active);
1321 Buffer const * const childbuffer = getChildBuffer();
1323 TocBuilder & b = backend.builder("child");
1324 docstring str = childbuffer ? childbuffer->fileName().displayName()
1326 b.pushItem(cpit, str, output_active);
1332 // Update the child's tocBackend. The outliner uses the master's, but
1333 // the navigation menu uses the child's.
1334 childbuffer->tocBackend().update(output_active, utype);
1335 // Include Tocs from children
1336 childbuffer->inset().addToToc(DocIterator(), output_active, utype,
1338 //Copy missing outliner names (though the user has been warned against
1339 //having different document class and module selection between master
1341 for (pair<string, docstring> const & name
1342 : childbuffer->params().documentClass().outlinerNames())
1343 backend.addName(name.first, translateIfPossible(name.second));
1348 void InsetInclude::updateCommand()
1353 docstring old_label = label_->getParam("name");
1354 label_->updateLabel(old_label);
1355 // the label might have been adapted (duplicate)
1356 docstring new_label = label_->getParam("name");
1357 if (old_label == new_label)
1360 // update listings parameters...
1361 InsetCommandParams p(INCLUDE_CODE);
1363 InsetListingsParams par(to_utf8(params()["lstparams"]));
1364 par.addParam("label", "{" + to_utf8(new_label) + "}", true);
1365 p["lstparams"] = from_utf8(par.params());
1370 void InsetInclude::updateBuffer(ParIterator const & it, UpdateType utype)
1372 file_exist_ = includedFileExist();
1374 button_.update(screenLabel(), true, false);
1376 Buffer const * const childbuffer = getChildBuffer();
1378 childbuffer->updateBuffer(Buffer::UpdateChildOnly, utype);
1381 if (!isListings(params()))
1385 label_->updateBuffer(it, utype);
1387 InsetListingsParams const par(to_utf8(params()["lstparams"]));
1388 if (par.getParamValue("caption").empty()) {
1389 listings_label_ = buffer().B_("Program Listing");
1392 Buffer const & master = *buffer().masterBuffer();
1393 Counters & counters = master.params().documentClass().counters();
1394 docstring const cnt = from_ascii("listing");
1395 listings_label_ = master.B_("Program Listing");
1396 if (counters.hasCounter(cnt)) {
1397 counters.step(cnt, utype);
1398 listings_label_ += " " + convert<docstring>(counters.value(cnt));
1403 bool InsetInclude::includedFileExist() const
1405 // check whether the included file exist
1406 string incFileName = ltrim(to_utf8(params()["filename"]));
1408 support::makeAbsPath(incFileName,
1409 support::onlyPath(buffer().absFileName()));