2 * \file InsetExternal.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup Nielsen
8 * Full author contact details are available in file CREDITS.
13 #include "InsetExternal.h"
14 #include "insets/ExternalSupport.h"
15 #include "insets/RenderButton.h"
16 #include "insets/RenderGraphic.h"
17 #include "insets/RenderPreview.h"
20 #include "BufferView.h"
21 #include "Converter.h"
23 #include "DispatchResult.h"
25 #include "FuncStatus.h"
26 #include "FuncRequest.h"
27 #include "LaTeXFeatures.h"
29 #include "MetricsInfo.h"
30 #include "output_latex.h"
31 #include "output_xhtml.h"
32 #include "texstream.h"
34 #include "TocBackend.h"
36 #include "frontends/alert.h"
37 #include "frontends/Application.h"
39 #include "graphics/PreviewLoader.h"
41 #include "support/convert.h"
42 #include "support/debug.h"
43 #include "support/ExceptionMessage.h"
44 #include "support/filetools.h"
45 #include "support/gettext.h"
46 #include "support/lassert.h"
47 #include "support/Lexer.h"
48 #include "support/lstrings.h"
49 #include "support/lyxlib.h"
50 #include "support/TempFile.h"
56 using namespace lyx::support;
60 unsigned int const defaultLyxScale = 100;
62 string defaultTemplateName;
69 namespace Alert = frontend::Alert;
75 // must have an extension for the converter code to work correctly.
76 support::TempFile f("lyxextXXXXXX.tmp");
77 // Let f go out of scope here and delete the file ourselves in
78 // ~TempName(), since otherwise external processes would not be able
79 // to use the file on windows (bug 9925). This is not as safe as
80 // keeping a support::TempFile member would be, but the best we can do.
81 f.setAutoRemove(false);
86 TempName::TempName(TempName const & that)
94 tempname_.removeFile();
98 TempName & TempName::operator=(TempName const & other)
100 if (this != &other) {
101 if (!tempname_.empty())
102 tempname_.removeFile();
103 support::TempFile f("lyxextXXXXXX.tmp");
104 f.setAutoRemove(false);
105 tempname_ = f.name();
111 support::FileName TempName::operator()() const
116 } // namespace external
119 InsetExternalParams::InsetExternalParams()
121 preview_mode(PREVIEW_OFF),
122 lyxscale(defaultLyxScale),
125 if (defaultTemplateName.empty()) {
126 external::TemplateManager const & etm =
127 external::TemplateManager::get();
128 if (!etm.getTemplates().empty())
129 templatename_ = etm.getTemplates().begin()->first;
131 templatename_ = defaultTemplateName;
137 template <typename T>
138 void clearIfNotFound(T & data, external::TransformID value,
139 vector<external::TransformID> const & ids)
141 typedef vector<external::TransformID>::const_iterator
144 const_iterator it = ids.begin();
145 const_iterator end = ids.end();
146 it = find(it, end, value);
154 void InsetExternalParams::settemplate(string const & name)
156 templatename_ = name;
158 external::TemplateManager const & etm =
159 external::TemplateManager::get();
160 external::Template const * const et = etm.getTemplateByName(name);
162 // Be safe. Don't lose data.
165 // Ascertain which transforms the template supports.
166 // Empty all those that it doesn't.
167 vector<external::TransformID> const & ids = et->transformIds;
168 clearIfNotFound(clipdata, external::Clip, ids);
169 clearIfNotFound(extradata, external::Extra, ids);
170 clearIfNotFound(resizedata, external::Resize, ids);
171 clearIfNotFound(rotationdata, external::Rotate, ids);
174 preview_mode = et->preview_mode;
178 void InsetExternalParams::write(Buffer const & buf, ostream & os) const
181 << "\ttemplate " << templatename() << '\n';
183 if (!filename.empty())
184 os << "\tfilename " << filename.outputFileName(buf.filePath()) << '\n';
187 os << "\tdisplay false\n";
189 if (lyxscale != defaultLyxScale)
190 os << "\tlyxscale " << convert<string>(lyxscale) << '\n';
195 if (!clipdata.bbox.empty())
196 os << "\tboundingBox " << clipdata.bbox << '\n';
200 external::ExtraData::const_iterator it = extradata.begin();
201 external::ExtraData::const_iterator end = extradata.end();
202 for (; it != end; ++it) {
203 if (!it->second.empty())
204 os << "\textra " << it->first << " \""
205 << it->second << "\"\n";
208 if (!rotationdata.no_rotation()) {
209 os << "\trotateAngle " << rotationdata.adjAngle() << '\n';
210 if (rotationdata.origin() != external::RotationData::DEFAULT)
211 os << "\trotateOrigin "
212 << rotationdata.originString() << '\n';
215 if (!resizedata.no_resize()) {
216 double const scl = convert<double>(resizedata.scale);
217 if (!float_equal(scl, 0.0, 0.05)) {
218 if (!float_equal(scl, 100.0, 0.05))
220 << resizedata.scale << '\n';
222 if (!resizedata.width.zero())
224 << resizedata.width.asString() << '\n';
225 if (!resizedata.height.zero())
227 << resizedata.height.asString() << '\n';
229 if (resizedata.keepAspectRatio)
230 os << "\tkeepAspectRatio\n";
235 bool InsetExternalParams::read(Buffer const & buffer, Lexer & lex)
255 LexerKeyword external_tags[] = {
256 { "\\end_inset", EX_END },
257 { "boundingBox", EX_BOUNDINGBOX },
259 { "display", EX_DISPLAY},
260 { "draft", EX_DRAFT},
261 { "extra", EX_EXTRA },
262 { "filename", EX_FILENAME},
263 { "height", EX_HEIGHT },
264 { "keepAspectRatio", EX_KEEPASPECTRATIO },
265 { "lyxscale", EX_LYXSCALE},
266 { "rotateAngle", EX_ROTATEANGLE },
267 { "rotateOrigin", EX_ROTATEORIGIN },
268 { "scale", EX_SCALE },
269 { "template", EX_TEMPLATE },
270 { "width", EX_WIDTH }
273 PushPopHelper pph(lex, external_tags);
275 bool found_end = false;
276 bool read_error = false;
282 templatename_ = lex.getString();
287 string const name = lex.getString();
288 filename = buffer.getReferencedFileName(name);
294 display = lex.getString() != "false";
300 int const ls = lex.getInteger();
301 // negative values are not accepted.
305 lex.printError("ExternalInset::read: Wrong lyxscale: $$Token");
315 clipdata.bbox.xl = Length(lex.getString());
317 clipdata.bbox.yb = Length(lex.getString());
319 clipdata.bbox.xr = Length(lex.getString());
321 clipdata.bbox.yt = Length(lex.getString());
325 clipdata.clip = true;
330 string const name = lex.getString();
332 extradata.set(name, lex.getString());
338 resizedata.height = Length(lex.getString());
341 case EX_KEEPASPECTRATIO:
342 resizedata.keepAspectRatio = true;
347 rotationdata.angle = lex.getString();
350 case EX_ROTATEORIGIN:
352 rotationdata.origin(lex.getString());
357 resizedata.scale = lex.getString();
362 resizedata.width = Length(lex.getString());
370 lex.printError("ExternalInset::read: Wrong tag: $$Token");
375 if (found_end || read_error)
380 lex.printError("ExternalInsetParams::read: Missing \\end_inset.");
382 // This is a trick to make sure that the data are self-consistent.
383 settemplate(templatename_);
385 if (lyxerr.debugging(Debug::EXTERNAL)) {
386 lyxerr << "InsetExternalParams::read:\n";
387 write(buffer, lyxerr);
396 docstring screenLabel(InsetExternalParams const & params,
397 Buffer const & buffer)
399 external::Template const * const ptr =
400 external::getTemplatePtr(params);
403 return bformat((_("External template %1$s is not installed")),
404 from_utf8(params.templatename()));
406 docstring gui = _(ptr->guiName);
409 if (params.filename.empty())
412 gui += from_utf8(params.filename.relFileName(buffer.filePath()));
420 InsetExternal::InsetExternal(Buffer * buf)
421 : Inset(buf), renderer_(new RenderButton)
426 // Mouse hover is not copied and remains empty
427 InsetExternal::InsetExternal(InsetExternal const & other)
429 params_(other.params_),
430 renderer_(other.renderer_->clone(this))
434 InsetExternal::~InsetExternal()
436 hideDialogs("external", this);
438 map<BufferView const *, bool>::iterator it = mouse_hover_.begin();
439 map<BufferView const *, bool>::iterator end = mouse_hover_.end();
440 for (; it != end; ++it)
442 it->first->clearLastInset(this);
446 bool InsetExternal::setMouseHover(BufferView const * bv, bool mouse_hover) const
448 mouse_hover_[bv] = mouse_hover;
453 void InsetExternal::doDispatch(Cursor & cur, FuncRequest & cmd)
455 switch (cmd.action()) {
457 case LFUN_INSET_EDIT: {
458 InsetExternalParams p = params();
459 if (!cmd.argument().empty())
460 string2params(to_utf8(cmd.argument()), buffer(), p);
461 external::editExternal(p, buffer());
465 case LFUN_INSET_MODIFY: {
466 InsetExternalParams p;
467 string2params(to_utf8(cmd.argument()), buffer(), p);
473 case LFUN_INSET_DIALOG_UPDATE:
474 cur.bv().updateDialog("external",
475 params2string(params(), cur.bv().buffer()));
479 Inset::doDispatch(cur, cmd);
484 bool InsetExternal::getStatus(Cursor & cur, FuncRequest const & cmd,
485 FuncStatus & flag) const
487 switch (cmd.action()) {
489 case LFUN_INSET_EDIT:
490 case LFUN_INSET_MODIFY:
491 case LFUN_INSET_DIALOG_UPDATE:
492 flag.setEnabled(true);
496 return Inset::getStatus(cur, cmd, flag);
501 void InsetExternal::addToToc(DocIterator const & cpit, bool output_active,
502 UpdateType, TocBackend & backend) const
504 docstring str = screenLabel(params_, buffer());
505 TocBuilder & b = backend.builder("external");
506 b.pushItem(cpit, str, output_active);
511 bool InsetExternal::showInsetDialog(BufferView * bv) const
513 bv->showDialog("external", params2string(params(), bv->buffer()),
514 const_cast<InsetExternal *>(this));
519 void InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const
521 if (!isRendererValid())
524 renderer_->metrics(mi, dim);
528 void InsetExternal::draw(PainterInfo & pi, int x, int y) const
530 if (!isRendererValid())
533 if (renderer_->asButton())
534 renderer_->setRenderState(mouse_hover_[pi.base.bv]);
535 renderer_->draw(pi, x, y);
541 graphics::Params get_grfx_params(InsetExternalParams const & eparams)
543 graphics::Params gparams;
545 gparams.filename = eparams.filename;
546 gparams.scale = eparams.lyxscale;
547 if (eparams.clipdata.clip)
548 gparams.bb = eparams.clipdata.bbox;
549 gparams.angle = convert<double>(eparams.rotationdata.adjAngle());
550 gparams.display = eparams.display;
558 static bool isPreviewWanted(InsetExternalParams const & params)
560 return params.display && params.filename.isReadableFile();
564 static docstring latexString(InsetExternal const & inset)
566 odocstringstream ods;
568 // We don't need to set runparams.encoding since it is not used by
570 OutputParams runparams(0);
571 runparams.flavor = Flavor::LaTeX;
572 inset.latex(os, runparams);
577 static void add_preview_and_start_loading(RenderMonitoredPreview & renderer,
578 InsetExternal const & inset,
579 Buffer const & buffer)
581 InsetExternalParams const & params = inset.params();
583 if (RenderPreview::previewText() && isPreviewWanted(params)) {
584 renderer.setAbsFile(params.filename);
585 docstring const snippet = latexString(inset);
586 renderer.addPreview(snippet, buffer);
587 renderer.startLoading(buffer);
592 InsetExternalParams const & InsetExternal::params() const
598 bool InsetExternal::isPreviewed() const
600 return (external::getTemplatePtr(params_) && !params_.filename.empty()
602 && lyxrc.display_graphics
603 && params_.preview_mode != PREVIEW_OFF
604 && (params_.preview_mode != PREVIEW_INSTANT
605 || RenderPreview::previewText()));
609 bool InsetExternal::isRendererValid() const
611 if (!renderer_->asButton())
612 return isPreviewed();
613 return !isPreviewed();
617 void InsetExternal::setParams(InsetExternalParams const & p)
621 // Subsequent calls to the InsetExternal::Params default constructor
623 defaultTemplateName = params_.templatename();
629 void InsetExternal::updatePreview() const
631 if (!isPreviewed()) {
632 RenderButton * button_ptr = renderer_->asButton();
634 renderer_.reset(new RenderButton);
635 button_ptr = renderer_->asButton();
637 button_ptr->update(screenLabel(params_, buffer()), true, false);
641 switch (params_.preview_mode) {
643 // Already taken care of above.
644 LASSERT(false, return);
646 case PREVIEW_INSTANT: {
647 renderer_ = make_unique<RenderMonitoredPreview>(this);
648 RenderMonitoredPreview * preview_ptr = renderer_->asMonitoredPreview();
649 // This connection is closed at the same time as this is destroyed.
650 preview_ptr->connect([this]() { fileChanged(); });
651 add_preview_and_start_loading(*preview_ptr, *this, buffer());
654 case PREVIEW_GRAPHICS: {
655 RenderGraphic * graphic_ptr = renderer_->asGraphic();
657 renderer_.reset(new RenderGraphic(this));
658 graphic_ptr = renderer_->asGraphic();
660 graphic_ptr->update(get_grfx_params(params_));
667 void InsetExternal::fileChanged() const
669 Buffer const * const buffer = updateFrontend();
673 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
674 LASSERT(ptr, return);
676 ptr->removePreview(*buffer);
677 add_preview_and_start_loading(*ptr, *this, *buffer);
681 void InsetExternal::write(ostream & os) const
683 params_.write(buffer(), os);
687 void InsetExternal::read(Lexer & lex)
689 InsetExternalParams params;
690 if (params.read(buffer(), lex))
695 void InsetExternal::latex(otexstream & os, OutputParams const & runparams) const
699 os << "\\fbox{\\ttfamily{}"
700 << from_utf8(params_.filename.outputFileName(buffer().filePath()))
705 // "nice" means that the buffer is exported to LaTeX format but not
706 // run through the LaTeX compiler.
707 // If we're running through the LaTeX compiler, we should write the
708 // generated files in the buffer's temporary directory.
709 bool const external_in_tmpdir = !runparams.nice;
710 bool const dryrun = runparams.dryrun || runparams.inComment;
712 // If the template has specified a PDFLaTeX output, then we try and
714 if (runparams.flavor == Flavor::PdfLaTeX) {
715 external::Template const * const et_ptr =
716 external::getTemplatePtr(params_);
719 external::Template const & et = *et_ptr;
721 external::Template::Formats::const_iterator cit =
722 et.formats.find("PDFLaTeX");
724 if (cit != et.formats.end()) {
725 external::RetVal retval =
726 external::writeExternal(params_, "PDFLaTeX", buffer(), os,
727 *(runparams.exportdata), external_in_tmpdir, dryrun);
728 if (retval == external::KILLED) {
729 LYXERR0("External template preparation killed.");
730 if (buffer().isClone() && buffer().isExporting())
731 throw ConversionException();
737 external::RetVal retval =
738 external::writeExternal(params_, "LaTeX", buffer(), os,
739 *(runparams.exportdata), external_in_tmpdir, dryrun);
740 if (retval == external::KILLED) {
741 LYXERR0("External template preparation killed.");
742 if (buffer().isClone() && buffer().isExporting())
743 throw ConversionException();
748 int InsetExternal::plaintext(odocstringstream & os,
749 OutputParams const & runparams, size_t) const
751 // this is too slow for constant use
752 if (runparams.for_tooltip)
755 bool const external_in_tmpdir = !runparams.nice;
756 bool const dryrun = runparams.dryrun || runparams.inComment;
758 ots << '\n'; // output external material on a new line
759 external::RetVal retval =
760 external::writeExternal(params_, "Ascii", buffer(), ots,
761 *(runparams.exportdata), external_in_tmpdir, dryrun);
762 if (retval == external::KILLED) {
763 LYXERR0("External template preparation killed.");
764 if (buffer().isClone() && buffer().isExporting())
765 throw ConversionException();
767 return PLAINTEXT_NEWLINE;
771 void InsetExternal::generateXML(XMLStream & xs, OutputParams const & runparams, std::string const & format) const
773 bool const external_in_tmpdir = !runparams.nice;
774 bool const dryrun = runparams.dryrun || runparams.inComment;
775 odocstringstream ods;
777 external::RetVal retval =
778 external::writeExternal(params_, format, buffer(), ots,
779 *(runparams.exportdata), external_in_tmpdir, dryrun);
780 if (retval == external::KILLED) {
781 LYXERR0("External template preparation killed.");
782 if (buffer().isClone() && buffer().isExporting())
783 throw ConversionException();
785 xs << XMLStream::ESCAPE_NONE << ods.str();
789 void InsetExternal::docbook(XMLStream & xs,
790 OutputParams const & runparams) const
792 generateXML(xs, runparams, "DocBook");
796 docstring InsetExternal::xhtml(XMLStream & xs,
797 OutputParams const & runparams) const
799 generateXML(xs, runparams, "XHTML");
804 void InsetExternal::validate(LaTeXFeatures & features) const
809 external::Template const * const et_ptr =
810 external::getTemplatePtr(params_);
813 external::Template const & et = *et_ptr;
816 switch (features.runparams().flavor) {
818 case Flavor::DviLuaTeX:
822 case Flavor::PdfLaTeX:
826 case Flavor::DocBook5:
839 external::Template::Formats::const_iterator cit =
840 et.formats.find(format);
842 if (cit == et.formats.end()) {
843 // If the template has not specified a PDFLaTeX output,
844 // we try the LaTeX format.
845 if (format == "PDFLaTeX") {
846 cit = et.formats.find("LaTeX");
847 if (cit == et.formats.end())
853 // FIXME: We don't need that always, see InsetGraphics
854 features.require("lyxdot");
856 vector<string>::const_iterator it = cit->second.requirements.begin();
857 vector<string>::const_iterator end = cit->second.requirements.end();
858 for (; it != end; ++it)
859 features.require(*it);
861 external::TemplateManager & etm = external::TemplateManager::get();
863 for (string const & name : cit->second.preambleNames) {
864 docstring const preamble = etm.getPreambleDefByName(name);
865 if (!preamble.empty())
866 features.addPreambleSnippet(preamble);
871 void InsetExternal::addPreview(DocIterator const & /*inset_pos*/,
872 graphics::PreviewLoader & ploader) const
874 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
878 if (isPreviewWanted(params())) {
879 ptr->setAbsFile(params_.filename);
880 docstring const snippet = latexString(*this);
881 ptr->addPreview(snippet, ploader);
886 string InsetExternal::contextMenuName() const
888 return "context-external";
892 void InsetExternal::string2params(string const & in, Buffer const & buffer,
893 InsetExternalParams & params)
895 params = InsetExternalParams();
899 istringstream data(in);
905 if (!lex || name != "external") {
906 LYXERR0("InsetExternal::string2params(" << in << ")\n"
907 "Expected arg 1 to be \"external\"\n");
911 // This is part of the inset proper that is usually swallowed
912 // by Text::readInset
915 if (!lex || id != "External") {
916 LYXERR0("InsetExternal::string2params(" << in << ")\n"
917 "Expected arg 2 to be \"External\"\n");
921 params.read(buffer, lex);
925 string InsetExternal::params2string(InsetExternalParams const & params,
926 Buffer const & buffer)
929 data << "external" << ' ';
930 params.write(buffer, data);
931 data << "\\end_inset\n";
936 docstring InsetExternal::toolTip(BufferView const &, int, int) const
938 return from_utf8(params().filename.onlyFileName());