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"
36 #include "MetricsInfo.h"
37 #include "output_xhtml.h"
38 #include "OutputParams.h"
39 #include "TextClass.h"
40 #include "TocBackend.h"
42 #include "frontends/alert.h"
43 #include "frontends/Painter.h"
45 #include "graphics/PreviewImage.h"
46 #include "graphics/PreviewLoader.h"
48 #include "insets/InsetLabel.h"
49 #include "insets/InsetListingsParams.h"
50 #include "insets/RenderPreview.h"
52 #include "mathed/MacroTable.h"
54 #include "support/convert.h"
55 #include "support/debug.h"
56 #include "support/docstream.h"
57 #include "support/FileNameList.h"
58 #include "support/filetools.h"
59 #include "support/gettext.h"
60 #include "support/lassert.h"
61 #include "support/lstrings.h" // contains
62 #include "support/lyxalgo.h"
64 #include "support/bind.h"
67 using namespace lyx::support;
71 namespace Alert = frontend::Alert;
76 docstring const uniqueID()
78 static unsigned int seed = 1000;
79 return "file" + convert<docstring>(++seed);
83 /// the type of inclusion
85 INCLUDE, VERB, INPUT, VERBAST, LISTINGS, NONE
89 Types type(string const & s)
93 if (s == "verbatiminput")
95 if (s == "verbatiminput*")
97 if (s == "lstinputlisting")
105 Types type(InsetCommandParams const & params)
107 return type(params.getCmdName());
111 bool isListings(InsetCommandParams const & params)
113 return type(params) == LISTINGS;
117 bool isVerbatim(InsetCommandParams const & params)
119 Types const t = type(params);
120 return t == VERB || t == VERBAST;
124 bool isInputOrInclude(InsetCommandParams const & params)
126 Types const t = type(params);
127 return t == INPUT || t == INCLUDE;
131 FileName const masterFileName(Buffer const & buffer)
133 return buffer.masterBuffer()->fileName();
137 void add_preview(RenderMonitoredPreview &, InsetInclude const &, Buffer const &);
140 string const parentFileName(Buffer const & buffer)
142 return buffer.absFileName();
146 FileName const includedFileName(Buffer const & buffer,
147 InsetCommandParams const & params)
149 return makeAbsPath(to_utf8(params["filename"]),
150 onlyPath(parentFileName(buffer)));
154 InsetLabel * createLabel(Buffer * buf, docstring const & label_str)
156 if (label_str.empty())
158 InsetCommandParams icp(LABEL_CODE);
159 icp["name"] = label_str;
160 return new InsetLabel(buf, icp);
166 InsetInclude::InsetInclude(Buffer * buf, InsetCommandParams const & p)
167 : InsetCommand(buf, p), include_label(uniqueID()),
168 preview_(new RenderMonitoredPreview(this)), failedtoload_(false),
169 set_label_(false), label_(0), child_buffer_(0)
171 preview_->fileChanged(bind(&InsetInclude::fileChanged, this));
173 if (isListings(params())) {
174 InsetListingsParams listing_params(to_utf8(p["lstparams"]));
175 label_ = createLabel(buffer_, from_utf8(listing_params.getParamValue("label")));
176 } else if (isInputOrInclude(params()) && buf)
181 InsetInclude::InsetInclude(InsetInclude const & other)
182 : InsetCommand(other), include_label(other.include_label),
183 preview_(new RenderMonitoredPreview(this)), failedtoload_(false),
184 set_label_(false), label_(0), child_buffer_(0)
186 preview_->fileChanged(bind(&InsetInclude::fileChanged, this));
189 label_ = new InsetLabel(*other.label_);
193 InsetInclude::~InsetInclude()
195 if (isBufferLoaded())
196 buffer().invalidateBibfileCache();
201 void InsetInclude::setBuffer(Buffer & buffer)
203 InsetCommand::setBuffer(buffer);
205 label_->setBuffer(buffer);
209 void InsetInclude::setChildBuffer(Buffer * buffer)
211 child_buffer_ = buffer;
215 ParamInfo const & InsetInclude::findInfo(string const & /* cmdName */)
218 // This is only correct for the case of listings, but it'll do for now.
219 // In the other cases, this second parameter should just be empty.
220 static ParamInfo param_info_;
221 if (param_info_.empty()) {
222 param_info_.add("filename", ParamInfo::LATEX_REQUIRED);
223 param_info_.add("lstparams", ParamInfo::LATEX_OPTIONAL);
229 bool InsetInclude::isCompatibleCommand(string const & s)
231 return type(s) != NONE;
235 void InsetInclude::doDispatch(Cursor & cur, FuncRequest & cmd)
237 switch (cmd.action()) {
239 case LFUN_INSET_EDIT: {
240 editIncluded(to_utf8(params()["filename"]));
244 case LFUN_INSET_MODIFY: {
245 // It should be OK just to invalidate the cache in setParams()
247 // child_buffer_ = 0;
248 InsetCommandParams p(INCLUDE_CODE);
249 if (cmd.getArg(0) == "changetype") {
251 InsetCommand::doDispatch(cur, cmd);
254 InsetCommand::string2params(to_utf8(cmd.argument()), p);
255 if (!p.getCmdName().empty()) {
257 InsetListingsParams new_params(to_utf8(p["lstparams"]));
258 docstring const new_label =
259 from_utf8(new_params.getParamValue("label"));
261 if (new_label.empty()) {
267 old_label = label_->getParam("name");
269 label_ = createLabel(buffer_, new_label);
270 label_->setBuffer(buffer());
273 if (new_label != old_label) {
274 label_->updateLabelAndRefs(new_label, &cur);
275 // the label might have been adapted (duplicate)
276 if (new_label != label_->getParam("name")) {
277 new_params.addParam("label", "{" +
278 to_utf8(label_->getParam("name")) + "}", true);
279 p["lstparams"] = from_utf8(new_params.params());
286 cur.forceBufferUpdate();
288 cur.noScreenUpdate();
292 //pass everything else up the chain
294 InsetCommand::doDispatch(cur, cmd);
300 void InsetInclude::editIncluded(string const & file)
302 string const ext = support::getExtension(file);
304 FuncRequest fr(LFUN_BUFFER_CHILD_OPEN, file);
307 // tex file or other text file in verbatim mode
308 formats.edit(buffer(),
309 support::makeAbsPath(file, support::onlyPath(buffer().absFileName())),
314 bool InsetInclude::getStatus(Cursor & cur, FuncRequest const & cmd,
315 FuncStatus & flag) const
317 switch (cmd.action()) {
319 case LFUN_INSET_EDIT:
320 flag.setEnabled(true);
323 case LFUN_INSET_MODIFY:
324 if (cmd.getArg(0) == "changetype")
325 return InsetCommand::getStatus(cur, cmd, flag);
327 flag.setEnabled(true);
331 return InsetCommand::getStatus(cur, cmd, flag);
336 void InsetInclude::setParams(InsetCommandParams const & p)
338 // invalidate the cache
341 InsetCommand::setParams(p);
344 if (preview_->monitoring())
345 preview_->stopMonitoring();
347 if (type(params()) == INPUT)
348 add_preview(*preview_, *this, buffer());
350 buffer().invalidateBibfileCache();
354 bool InsetInclude::isChildIncluded() const
356 std::list<std::string> includeonlys =
357 buffer().params().getIncludedChildren();
358 if (includeonlys.empty())
360 return (std::find(includeonlys.begin(),
362 to_utf8(params()["filename"])) != includeonlys.end());
366 docstring InsetInclude::screenLabel() const
370 switch (type(params())) {
372 temp = buffer().B_("Input");
375 temp = buffer().B_("Verbatim Input");
378 temp = buffer().B_("Verbatim Input*");
381 if (isChildIncluded())
382 temp = buffer().B_("Include");
384 temp += buffer().B_("Include (excluded)");
387 temp = listings_label_;
390 LASSERT(false, /**/);
395 if (params()["filename"].empty())
398 temp += from_utf8(onlyFileName(to_utf8(params()["filename"])));
404 Buffer * InsetInclude::getChildBuffer() const
406 Buffer * childBuffer = loadIfNeeded();
408 // FIXME: recursive includes
409 return (childBuffer == &buffer()) ? 0 : childBuffer;
413 Buffer * InsetInclude::loadIfNeeded() const
415 // This is for background export and preview. We don't even want to
416 // try to load the cloned child document again.
417 if (buffer().isClone())
418 return child_buffer_;
420 // Don't try to load it again if we failed before.
421 if (failedtoload_ || isVerbatim(params()) || isListings(params()))
424 FileName const included_file = includedFileName(buffer(), params());
425 // Use cached Buffer if possible.
426 if (child_buffer_ != 0) {
427 if (theBufferList().isLoaded(child_buffer_)
428 // additional sanity check: make sure the Buffer really is
429 // associated with the file we want.
430 && child_buffer_ == theBufferList().getBuffer(included_file))
431 return child_buffer_;
432 // Buffer vanished, so invalidate cache and try to reload.
436 if (!isLyXFileName(included_file.absFileName()))
439 Buffer * child = theBufferList().getBuffer(included_file);
441 // the readonly flag can/will be wrong, not anymore I think.
442 if (!included_file.exists())
445 child = theBufferList().newBuffer(included_file.absFileName());
447 // Buffer creation is not possible.
450 // Set parent before loading, such that macros can be tracked
451 child->setParent(&buffer());
453 if (child->loadLyXFile() != Buffer::ReadSuccess) {
454 failedtoload_ = true;
456 //close the buffer we just opened
457 theBufferList().release(child);
461 if (!child->errorList("Parse").empty()) {
462 // FIXME: Do something.
465 // The file was already loaded, so, simply
466 // inform parent buffer about local macros.
467 Buffer const * parent = &buffer();
468 child->setParent(parent);
470 child->listMacroNames(macros);
471 MacroNameSet::const_iterator cit = macros.begin();
472 MacroNameSet::const_iterator end = macros.end();
473 for (; cit != end; ++cit)
474 parent->usermacros.insert(*cit);
477 // Cache the child buffer.
478 child_buffer_ = child;
483 void InsetInclude::latex(otexstream & os, OutputParams const & runparams) const
485 string incfile = to_utf8(params()["filename"]);
487 // Do nothing if no file name has been specified
491 FileName const included_file = includedFileName(buffer(), params());
493 // Check we're not trying to include ourselves.
494 // FIXME RECURSIVE INCLUDE
495 // This isn't sufficient, as the inclusion could be downstream.
496 // But it'll have to do for now.
497 if (isInputOrInclude(params()) &&
498 buffer().absFileName() == included_file.absFileName())
500 Alert::error(_("Recursive input"),
501 bformat(_("Attempted to include file %1$s in itself! "
502 "Ignoring inclusion."), from_utf8(incfile)));
506 Buffer const * const masterBuffer = buffer().masterBuffer();
508 // if incfile is relative, make it relative to the master
510 if (!FileName::isAbsolute(incfile)) {
512 incfile = to_utf8(makeRelPath(from_utf8(included_file.absFileName()),
513 from_utf8(masterBuffer->filePath())));
516 string exppath = incfile;
517 if (!runparams.export_folder.empty()) {
518 exppath = makeAbsPath(exppath, runparams.export_folder).realPath();
519 FileName(exppath).onlyPath().createPath();
522 // write it to a file (so far the complete file)
526 if (type(params()) == LISTINGS) {
527 exportfile = exppath;
528 mangled = DocFileName(included_file).mangledFileName();
530 exportfile = changeExtension(exppath, ".tex");
531 mangled = DocFileName(changeExtension(included_file.absFileName(), ".tex")).
535 FileName const writefile(makeAbsPath(mangled, masterBuffer->temppath()));
539 else if (!isValidLaTeXFileName(incfile)) {
540 frontend::Alert::warning(_("Invalid filename"),
541 _("The following filename will cause troubles "
542 "when running the exported file through LaTeX: ") +
545 else if (!isValidDVIFileName(incfile)) {
546 frontend::Alert::warning(_("Problematic filename for DVI"),
547 _("The following filename can cause troubles "
548 "when running the exported file through LaTeX "
549 "and opening the resulting DVI: ") +
550 from_utf8(incfile), true);
552 LYXERR(Debug::LATEX, "incfile:" << incfile);
553 LYXERR(Debug::LATEX, "exportfile:" << exportfile);
554 LYXERR(Debug::LATEX, "writefile:" << writefile);
556 string const tex_format = flavor2format(runparams.flavor);
557 if (runparams.inComment || runparams.dryrun) {
558 //Don't try to load or copy the file if we're
559 //in a comment or doing a dryrun
560 } else if (isInputOrInclude(params()) &&
561 isLyXFileName(included_file.absFileName())) {
562 // if it's a LyX file and we're inputting or including,
563 // try to load it so we can write the associated latex
565 Buffer * tmp = loadIfNeeded();
567 docstring text = bformat(_("Could not load included "
569 "Please, check whether it actually exists."),
570 included_file.displayName());
571 Alert::warning(_("Missing included file"), text);
575 if (tmp->params().baseClass() != masterBuffer->params().baseClass()) {
577 docstring text = bformat(_("Included file `%1$s'\n"
578 "has textclass `%2$s'\n"
579 "while parent file has textclass `%3$s'."),
580 included_file.displayName(),
581 from_utf8(tmp->params().documentClass().name()),
582 from_utf8(masterBuffer->params().documentClass().name()));
583 Alert::warning(_("Different textclasses"), text, true);
586 // Make sure modules used in child are all included in master
587 // FIXME It might be worth loading the children's modules into the master
588 // over in BufferParams rather than doing this check.
589 LayoutModuleList const masterModules = masterBuffer->params().getModules();
590 LayoutModuleList const childModules = tmp->params().getModules();
591 LayoutModuleList::const_iterator it = childModules.begin();
592 LayoutModuleList::const_iterator end = childModules.end();
593 for (; it != end; ++it) {
594 string const module = *it;
595 LayoutModuleList::const_iterator found =
596 find(masterModules.begin(), masterModules.end(), module);
597 if (found == masterModules.end()) {
598 docstring text = bformat(_("Included file `%1$s'\n"
599 "uses module `%2$s'\n"
600 "which is not used in parent file."),
601 included_file.displayName(), from_utf8(module));
602 Alert::warning(_("Module not found"), text);
606 tmp->markDepClean(masterBuffer->temppath());
608 // Don't assume the child's format is latex
609 string const inc_format = tmp->params().bufferFormat();
610 FileName const tmpwritefile(changeExtension(writefile.absFileName(),
611 formats.extension(inc_format)));
613 // FIXME: handle non existing files
614 // The included file might be written in a different encoding
616 Encoding const * const oldEnc = runparams.encoding;
617 Language const * const oldLang = runparams.master_language;
618 // If the master has full unicode flavor (XeTeX, LuaTeX),
619 // the children must be encoded in plain utf8!
620 runparams.encoding = runparams.isFullUnicode() ?
621 encodings.fromLyXName("utf8-plain")
622 : &tmp->params().encoding();
623 runparams.master_language = buffer().params().language;
624 runparams.par_begin = 0;
625 runparams.par_end = tmp->paragraphs().size();
626 if (!tmp->makeLaTeXFile(tmpwritefile, masterFileName(buffer()).
627 onlyPath().absFileName(), runparams, Buffer::OnlyBody)) {
628 docstring msg = bformat(_("Included file `%1$s' "
629 "was not exported correctly.\nWarning: "
630 "LaTeX export is probably incomplete."),
631 included_file.displayName());
632 ErrorList const & el = tmp->errorList("Export");
634 msg = bformat(from_ascii("%1$s\n\n%2$s\n\n%3$s"),
635 msg, el.begin()->error,
636 el.begin()->description);
637 Alert::warning(_("Export failure"), msg);
639 runparams.encoding = oldEnc;
640 runparams.master_language = oldLang;
642 // If needed, use converters to produce a latex file from the child
643 if (tmpwritefile != writefile) {
646 theConverters().convert(tmp, tmpwritefile, writefile,
648 inc_format, tex_format, el);
651 docstring msg = bformat(_("Included file `%1$s' "
652 "was not exported correctly.\nWarning: "
653 "LaTeX export is probably incomplete."),
654 included_file.displayName());
656 msg = bformat(from_ascii("%1$s\n\n%2$s\n\n%3$s"),
657 msg, el.begin()->error,
658 el.begin()->description);
659 Alert::warning(_("Export failure"), msg);
663 // In this case, it's not a LyX file, so we copy the file
664 // to the temp dir, so that .aux files etc. are not created
665 // in the original dir. Files included by this file will be
666 // found via either the environment variable TEXINPUTS, or
667 // input@path, see ../Buffer.cpp.
668 unsigned long const checksum_in = included_file.checksum();
669 unsigned long const checksum_out = writefile.checksum();
671 if (checksum_in != checksum_out) {
672 if (!included_file.copyTo(writefile)) {
675 to_utf8(bformat(_("Could not copy the file\n%1$s\n"
676 "into the temporary directory."),
677 from_utf8(included_file.absFileName()))));
683 switch (type(params())) {
686 incfile = latex_path(incfile);
688 os << '\\' << from_ascii(params().getCmdName()) << '{'
689 << from_utf8(incfile) << '}';
693 runparams.exportdata->addExternalFile(tex_format, writefile,
696 // \input wants file with extension (default is .tex)
697 if (!isLyXFileName(included_file.absFileName())) {
698 incfile = latex_path(incfile);
700 os << '\\' << from_ascii(params().getCmdName())
701 << '{' << from_utf8(incfile) << '}';
703 incfile = changeExtension(incfile, ".tex");
704 incfile = latex_path(incfile);
706 os << '\\' << from_ascii(params().getCmdName())
707 << '{' << from_utf8(incfile) << '}';
712 runparams.exportdata->addExternalFile(tex_format, writefile,
714 os << '\\' << from_ascii(params().getCmdName());
715 string const opt = to_utf8(params()["lstparams"]);
716 // opt is set in QInclude dialog and should have passed validation.
717 InsetListingsParams params(opt);
718 if (!params.params().empty())
719 os << "[" << from_utf8(params.params()) << "]";
720 os << '{' << from_utf8(incfile) << '}';
724 runparams.exportdata->addExternalFile(tex_format, writefile,
727 // \include don't want extension and demands that the
728 // file really have .tex
729 incfile = changeExtension(incfile, string());
730 incfile = latex_path(incfile);
732 os << '\\' << from_ascii(params().getCmdName()) << '{'
733 << from_utf8(incfile) << '}';
742 docstring InsetInclude::xhtml(XHTMLStream & xs, OutputParams const & rp) const
747 // For verbatim and listings, we just include the contents of the file as-is.
748 // In the case of listings, we wrap it in <pre>.
749 bool const listing = isListings(params());
750 if (listing || isVerbatim(params())) {
752 xs << html::StartTag("pre");
753 // FIXME: We don't know the encoding of the file, default to UTF-8.
754 xs << includedFileName(buffer(), params()).fileContents("UTF-8");
756 xs << html::EndTag("pre");
760 // We don't (yet) know how to Input or Include non-LyX files.
761 // (If we wanted to get really arcane, we could run some tex2html
762 // converter on the included file. But that's just masochistic.)
763 FileName const included_file = includedFileName(buffer(), params());
764 if (!isLyXFileName(included_file.absFileName())) {
765 frontend::Alert::warning(_("Unsupported Inclusion"),
766 bformat(_("LyX does not know how to include non-LyX files when "
767 "generating HTML output. Offending file:\n%1$s"),
768 params()["filename"]));
772 // In the other cases, we will generate the HTML and include it.
774 // Check we're not trying to include ourselves.
775 // FIXME RECURSIVE INCLUDE
776 if (buffer().absFileName() == included_file.absFileName()) {
777 Alert::error(_("Recursive input"),
778 bformat(_("Attempted to include file %1$s in itself! "
779 "Ignoring inclusion."), params()["filename"]));
783 Buffer const * const ibuf = loadIfNeeded();
787 // are we generating only some paragraphs, or all of them?
788 bool const all_pars = !rp.dryrun ||
789 (rp.par_begin == 0 &&
790 rp.par_end == (int)buffer().text().paragraphs().size());
792 OutputParams op = rp;
796 ibuf->writeLyXHTMLSource(xs.os(), op, Buffer::OnlyBody);
798 xs << XHTMLStream::ESCAPE_NONE
799 << "<!-- Included file: "
800 << from_utf8(included_file.absFileName())
801 << XHTMLStream::ESCAPE_NONE
807 int InsetInclude::plaintext(odocstream & os, OutputParams const &) const
809 if (isVerbatim(params()) || isListings(params())) {
810 os << '[' << screenLabel() << '\n';
811 // FIXME: We don't know the encoding of the file, default to UTF-8.
812 os << includedFileName(buffer(), params()).fileContents("UTF-8");
814 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
816 docstring const str = '[' + screenLabel() + ']';
823 int InsetInclude::docbook(odocstream & os, OutputParams const & runparams) const
825 string incfile = to_utf8(params()["filename"]);
827 // Do nothing if no file name has been specified
831 string const included_file = includedFileName(buffer(), params()).absFileName();
833 // Check we're not trying to include ourselves.
834 // FIXME RECURSIVE INCLUDE
835 // This isn't sufficient, as the inclusion could be downstream.
836 // But it'll have to do for now.
837 if (buffer().absFileName() == included_file) {
838 Alert::error(_("Recursive input"),
839 bformat(_("Attempted to include file %1$s in itself! "
840 "Ignoring inclusion."), from_utf8(incfile)));
844 string exppath = incfile;
845 if (!runparams.export_folder.empty()) {
846 exppath = makeAbsPath(exppath, runparams.export_folder).realPath();
847 FileName(exppath).onlyPath().createPath();
850 // write it to a file (so far the complete file)
851 string const exportfile = changeExtension(exppath, ".sgml");
852 DocFileName writefile(changeExtension(included_file, ".sgml"));
854 Buffer * tmp = loadIfNeeded();
856 string const mangled = writefile.mangledFileName();
857 writefile = makeAbsPath(mangled,
858 buffer().masterBuffer()->temppath());
862 LYXERR(Debug::LATEX, "incfile:" << incfile);
863 LYXERR(Debug::LATEX, "exportfile:" << exportfile);
864 LYXERR(Debug::LATEX, "writefile:" << writefile);
866 tmp->makeDocBookFile(writefile, runparams, Buffer::OnlyBody);
869 runparams.exportdata->addExternalFile("docbook", writefile,
871 runparams.exportdata->addExternalFile("docbook-xml", writefile,
874 if (isVerbatim(params()) || isListings(params())) {
875 os << "<inlinegraphic fileref=\""
876 << '&' << include_label << ';'
877 << "\" format=\"linespecific\">";
879 os << '&' << include_label << ';';
885 void InsetInclude::validate(LaTeXFeatures & features) const
887 string incfile = to_utf8(params()["filename"]);
890 LASSERT(&buffer() == &features.buffer(), /**/);
892 string const included_file =
893 includedFileName(buffer(), params()).absFileName();
895 if (isLyXFileName(included_file))
896 writefile = changeExtension(included_file, ".sgml");
898 writefile = included_file;
900 if (!features.runparams().nice && !isVerbatim(params()) && !isListings(params())) {
901 incfile = DocFileName(writefile).mangledFileName();
902 writefile = makeAbsPath(incfile,
903 buffer().masterBuffer()->temppath()).absFileName();
906 features.includeFile(include_label, writefile);
908 if (isVerbatim(params()))
909 features.require("verbatim");
910 else if (isListings(params()))
911 features.require("listings");
913 // Here we must do the fun stuff...
914 // Load the file in the include if it needs
916 Buffer * const tmp = loadIfNeeded();
918 // the file is loaded
919 // make sure the buffer isn't us
920 // FIXME RECURSIVE INCLUDES
921 // This is not sufficient, as recursive includes could be
922 // more than a file away. But it will do for now.
923 if (tmp && tmp != &buffer()) {
924 // We must temporarily change features.buffer,
925 // otherwise it would always be the master buffer,
926 // and nested includes would not work.
927 features.setBuffer(*tmp);
928 tmp->validate(features);
929 features.setBuffer(buffer());
935 void InsetInclude::collectBibKeys(InsetIterator const & /*di*/) const
937 Buffer * child = loadIfNeeded();
940 child->collectBibKeys();
944 void InsetInclude::metrics(MetricsInfo & mi, Dimension & dim) const
946 LASSERT(mi.base.bv, /**/);
948 bool use_preview = false;
949 if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
950 graphics::PreviewImage const * pimage =
951 preview_->getPreviewImage(mi.base.bv->buffer());
952 use_preview = pimage && pimage->image();
956 preview_->metrics(mi, dim);
960 button_.update(screenLabel(), true);
962 button_.metrics(mi, dim);
965 Box b(0, dim.wid, -dim.asc, dim.des);
970 void InsetInclude::draw(PainterInfo & pi, int x, int y) const
972 LASSERT(pi.base.bv, /**/);
974 bool use_preview = false;
975 if (RenderPreview::status() != LyXRC::PREVIEW_OFF) {
976 graphics::PreviewImage const * pimage =
977 preview_->getPreviewImage(pi.base.bv->buffer());
978 use_preview = pimage && pimage->image();
982 preview_->draw(pi, x, y);
984 button_.draw(pi, x, y);
988 string InsetInclude::contextMenuName() const
990 return "context-include";
994 Inset::DisplayType InsetInclude::display() const
996 return type(params()) == INPUT ? Inline : AlignCenter;
1005 void InsetInclude::fileChanged() const
1007 Buffer const * const buffer = updateFrontend();
1011 preview_->removePreview(*buffer);
1012 add_preview(*preview_.get(), *this, *buffer);
1013 preview_->startLoading(*buffer);
1019 bool preview_wanted(InsetCommandParams const & params, Buffer const & buffer)
1021 FileName const included_file = includedFileName(buffer, params);
1023 return type(params) == INPUT && params.preview() &&
1024 included_file.isReadableFile();
1028 docstring latexString(InsetInclude const & inset)
1031 odocstringstream ods;
1032 otexstream os(ods, texrow);
1033 // We don't need to set runparams.encoding since this will be done
1034 // by latex() anyway.
1035 OutputParams runparams(0);
1036 runparams.flavor = OutputParams::LATEX;
1037 inset.latex(os, runparams);
1043 void add_preview(RenderMonitoredPreview & renderer, InsetInclude const & inset,
1044 Buffer const & buffer)
1046 InsetCommandParams const & params = inset.params();
1047 if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
1048 preview_wanted(params, buffer)) {
1049 renderer.setAbsFile(includedFileName(buffer, params));
1050 docstring const snippet = latexString(inset);
1051 renderer.addPreview(snippet, buffer);
1058 void InsetInclude::addPreview(DocIterator const & /*inset_pos*/,
1059 graphics::PreviewLoader & ploader) const
1061 Buffer const & buffer = ploader.buffer();
1062 if (!preview_wanted(params(), buffer))
1064 preview_->setAbsFile(includedFileName(buffer, params()));
1065 docstring const snippet = latexString(*this);
1066 preview_->addPreview(snippet, ploader);
1070 void InsetInclude::addToToc(DocIterator const & cpit) const
1072 TocBackend & backend = buffer().tocBackend();
1074 if (isListings(params())) {
1076 label_->addToToc(cpit);
1078 InsetListingsParams p(to_utf8(params()["lstparams"]));
1079 string caption = p.getParamValue("caption");
1080 if (caption.empty())
1082 Toc & toc = backend.toc("listing");
1083 docstring str = convert<docstring>(toc.size() + 1)
1084 + ". " + from_utf8(caption);
1085 DocIterator pit = cpit;
1086 toc.push_back(TocItem(pit, 0, str));
1089 Buffer const * const childbuffer = getChildBuffer();
1093 Toc & toc = backend.toc("child");
1094 docstring str = childbuffer->fileName().displayName();
1095 toc.push_back(TocItem(cpit, 0, str));
1097 TocList & toclist = backend.tocs();
1098 childbuffer->tocBackend().update();
1099 TocList const & childtoclist = childbuffer->tocBackend().tocs();
1100 TocList::const_iterator it = childtoclist.begin();
1101 TocList::const_iterator const end = childtoclist.end();
1102 for(; it != end; ++it)
1103 toclist[it->first].insert(toclist[it->first].end(),
1104 it->second.begin(), it->second.end());
1108 void InsetInclude::updateCommand()
1113 docstring old_label = label_->getParam("name");
1114 label_->updateLabel(old_label);
1115 // the label might have been adapted (duplicate)
1116 docstring new_label = label_->getParam("name");
1117 if (old_label == new_label)
1120 // update listings parameters...
1121 InsetCommandParams p(INCLUDE_CODE);
1123 InsetListingsParams par(to_utf8(params()["lstparams"]));
1124 par.addParam("label", "{" + to_utf8(new_label) + "}", true);
1125 p["lstparams"] = from_utf8(par.params());
1130 void InsetInclude::updateBuffer(ParIterator const & it, UpdateType utype)
1132 Buffer const * const childbuffer = getChildBuffer();
1134 childbuffer->updateBuffer(Buffer::UpdateChildOnly, utype);
1137 if (!isListings(params()))
1141 label_->updateBuffer(it, utype);
1143 InsetListingsParams const par(to_utf8(params()["lstparams"]));
1144 if (par.getParamValue("caption").empty()) {
1145 listings_label_ = buffer().B_("Program Listing");
1148 Buffer const & master = *buffer().masterBuffer();
1149 Counters & counters = master.params().documentClass().counters();
1150 docstring const cnt = from_ascii("listing");
1151 listings_label_ = master.B_("Program Listing");
1152 if (counters.hasCounter(cnt)) {
1153 counters.step(cnt, utype);
1154 listings_label_ += " " + convert<docstring>(counters.value(cnt));