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"
22 #include "DispatchResult.h"
24 #include "FuncStatus.h"
25 #include "FuncRequest.h"
26 #include "LaTeXFeatures.h"
28 #include "LyX.h" // use_gui
30 #include "MetricsInfo.h"
31 #include "OutputParams.h"
32 #include "output_latex.h"
33 #include "output_xhtml.h"
34 #include "texstream.h"
35 #include "TocBackend.h"
37 #include "frontends/alert.h"
38 #include "frontends/Application.h"
40 #include "graphics/PreviewLoader.h"
42 #include "support/bind.h"
43 #include "support/convert.h"
44 #include "support/debug.h"
45 #include "support/ExceptionMessage.h"
46 #include "support/filetools.h"
47 #include "support/gettext.h"
48 #include "support/lassert.h"
49 #include "support/lstrings.h"
50 #include "support/lyxlib.h"
51 #include "support/TempFile.h"
57 using namespace lyx::support;
61 unsigned int const defaultLyxScale = 100;
63 string defaultTemplateName;
70 namespace Alert = frontend::Alert;
76 // must have an extension for the converter code to work correctly.
77 support::TempFile f("lyxextXXXXXX.tmp");
78 // Let f go out of scope here and delete the file ourselves in
79 // ~TempName(), since otherwise external processes would not be able
80 // to use the file on windows (bug 9925). This is not as safe as
81 // keeping a support::TempFile member would be, but the best we can do.
82 f.setAutoRemove(false);
87 TempName::TempName(TempName const & that)
95 tempname_.removeFile();
99 TempName & TempName::operator=(TempName const & other)
101 if (this != &other) {
102 if (!tempname_.empty())
103 tempname_.removeFile();
104 support::TempFile f("lyxextXXXXXX.tmp");
105 f.setAutoRemove(false);
106 tempname_ = f.name();
112 support::FileName TempName::operator()() const
117 } // namespace external
120 InsetExternalParams::InsetExternalParams()
122 preview_mode(PREVIEW_OFF),
123 lyxscale(defaultLyxScale),
126 if (defaultTemplateName.empty()) {
127 external::TemplateManager const & etm =
128 external::TemplateManager::get();
129 if (!etm.getTemplates().empty())
130 templatename_ = etm.getTemplates().begin()->first;
132 templatename_ = defaultTemplateName;
138 template <typename T>
139 void clearIfNotFound(T & data, external::TransformID value,
140 vector<external::TransformID> const & ids)
142 typedef vector<external::TransformID>::const_iterator
145 const_iterator it = ids.begin();
146 const_iterator end = ids.end();
147 it = find(it, end, value);
155 void InsetExternalParams::settemplate(string const & name)
157 templatename_ = name;
159 external::TemplateManager const & etm =
160 external::TemplateManager::get();
161 external::Template const * const et = etm.getTemplateByName(name);
163 // Be safe. Don't lose data.
166 // Ascertain which transforms the template supports.
167 // Empty all those that it doesn't.
168 vector<external::TransformID> const & ids = et->transformIds;
169 clearIfNotFound(clipdata, external::Clip, ids);
170 clearIfNotFound(extradata, external::Extra, ids);
171 clearIfNotFound(resizedata, external::Resize, ids);
172 clearIfNotFound(rotationdata, external::Rotate, ids);
175 preview_mode = et->preview_mode;
179 void InsetExternalParams::write(Buffer const & buf, ostream & os) const
182 << "\ttemplate " << templatename() << '\n';
184 if (!filename.empty())
185 os << "\tfilename " << filename.outputFileName(buf.filePath()) << '\n';
188 os << "\tdisplay false\n";
190 if (lyxscale != defaultLyxScale)
191 os << "\tlyxscale " << convert<string>(lyxscale) << '\n';
196 if (!clipdata.bbox.empty())
197 os << "\tboundingBox " << clipdata.bbox << '\n';
201 external::ExtraData::const_iterator it = extradata.begin();
202 external::ExtraData::const_iterator end = extradata.end();
203 for (; it != end; ++it) {
204 if (!it->second.empty())
205 os << "\textra " << it->first << " \""
206 << it->second << "\"\n";
209 if (!rotationdata.no_rotation()) {
210 os << "\trotateAngle " << rotationdata.adjAngle() << '\n';
211 if (rotationdata.origin() != external::RotationData::DEFAULT)
212 os << "\trotateOrigin "
213 << rotationdata.originString() << '\n';
216 if (!resizedata.no_resize()) {
217 double const scl = convert<double>(resizedata.scale);
218 if (!float_equal(scl, 0.0, 0.05)) {
219 if (!float_equal(scl, 100.0, 0.05))
221 << resizedata.scale << '\n';
223 if (!resizedata.width.zero())
225 << resizedata.width.asString() << '\n';
226 if (!resizedata.height.zero())
228 << resizedata.height.asString() << '\n';
230 if (resizedata.keepAspectRatio)
231 os << "\tkeepAspectRatio\n";
236 bool InsetExternalParams::read(Buffer const & buffer, Lexer & lex)
256 LexerKeyword external_tags[] = {
257 { "\\end_inset", EX_END },
258 { "boundingBox", EX_BOUNDINGBOX },
260 { "display", EX_DISPLAY},
261 { "draft", EX_DRAFT},
262 { "extra", EX_EXTRA },
263 { "filename", EX_FILENAME},
264 { "height", EX_HEIGHT },
265 { "keepAspectRatio", EX_KEEPASPECTRATIO },
266 { "lyxscale", EX_LYXSCALE},
267 { "rotateAngle", EX_ROTATEANGLE },
268 { "rotateOrigin", EX_ROTATEORIGIN },
269 { "scale", EX_SCALE },
270 { "template", EX_TEMPLATE },
271 { "width", EX_WIDTH }
274 PushPopHelper pph(lex, external_tags);
276 bool found_end = false;
277 bool read_error = false;
283 templatename_ = lex.getString();
288 string const name = lex.getString();
289 filename = buffer.getReferencedFileName(name);
295 display = lex.getString() != "false";
301 int const ls = lex.getInteger();
302 // negative values are not accepted.
306 lex.printError("ExternalInset::read: Wrong lyxscale: $$Token");
316 clipdata.bbox.xl = Length(lex.getString());
318 clipdata.bbox.yb = Length(lex.getString());
320 clipdata.bbox.xr = Length(lex.getString());
322 clipdata.bbox.yt = Length(lex.getString());
326 clipdata.clip = true;
331 string const name = lex.getString();
333 extradata.set(name, lex.getString());
339 resizedata.height = Length(lex.getString());
342 case EX_KEEPASPECTRATIO:
343 resizedata.keepAspectRatio = true;
348 rotationdata.angle = lex.getString();
351 case EX_ROTATEORIGIN:
353 rotationdata.origin(lex.getString());
358 resizedata.scale = lex.getString();
363 resizedata.width = Length(lex.getString());
371 lex.printError("ExternalInset::read: Wrong tag: $$Token");
376 if (found_end || read_error)
381 lex.printError("ExternalInsetParams::read: Missing \\end_inset.");
383 // This is a trick to make sure that the data are self-consistent.
384 settemplate(templatename_);
386 if (lyxerr.debugging(Debug::EXTERNAL)) {
387 lyxerr << "InsetExternalParams::read:\n";
388 write(buffer, lyxerr);
397 docstring screenLabel(InsetExternalParams const & params,
398 Buffer const & buffer)
400 external::Template const * const ptr =
401 external::getTemplatePtr(params);
404 return bformat((_("External template %1$s is not installed")),
405 from_utf8(params.templatename()));
407 docstring gui = _(ptr->guiName);
410 if (params.filename.empty())
413 gui += from_utf8(params.filename.relFileName(buffer.filePath()));
422 InsetExternal::InsetExternal(Buffer * buf)
423 : Inset(buf), renderer_(new RenderButton)
428 // Mouse hover is not copied and remains empty
429 InsetExternal::InsetExternal(InsetExternal const & other)
431 boost::signals2::trackable(),
432 params_(other.params_),
433 renderer_(other.renderer_->clone(this))
437 InsetExternal::~InsetExternal()
439 hideDialogs("external", this);
441 map<BufferView const *, bool>::iterator it = mouse_hover_.begin();
442 map<BufferView const *, bool>::iterator end = mouse_hover_.end();
443 for (; it != end; ++it)
445 it->first->clearLastInset(this);
449 bool InsetExternal::setMouseHover(BufferView const * bv, bool mouse_hover) const
451 mouse_hover_[bv] = mouse_hover;
456 void InsetExternal::statusChanged() const
462 void InsetExternal::doDispatch(Cursor & cur, FuncRequest & cmd)
464 switch (cmd.action()) {
466 case LFUN_INSET_EDIT: {
467 InsetExternalParams p = params();
468 if (!cmd.argument().empty())
469 string2params(to_utf8(cmd.argument()), buffer(), p);
470 external::editExternal(p, buffer());
474 case LFUN_INSET_MODIFY: {
475 InsetExternalParams p;
476 string2params(to_utf8(cmd.argument()), buffer(), p);
482 case LFUN_INSET_DIALOG_UPDATE:
483 cur.bv().updateDialog("external",
484 params2string(params(), cur.bv().buffer()));
488 Inset::doDispatch(cur, cmd);
493 bool InsetExternal::getStatus(Cursor & cur, FuncRequest const & cmd,
494 FuncStatus & flag) const
496 switch (cmd.action()) {
498 case LFUN_INSET_EDIT:
499 case LFUN_INSET_MODIFY:
500 case LFUN_INSET_DIALOG_UPDATE:
501 flag.setEnabled(true);
505 return Inset::getStatus(cur, cmd, flag);
510 void InsetExternal::addToToc(DocIterator const & cpit, bool output_active,
511 UpdateType, TocBackend & backend) const
513 docstring str = screenLabel(params_, buffer());
514 TocBuilder & b = backend.builder("external");
515 b.pushItem(cpit, str, output_active);
520 bool InsetExternal::showInsetDialog(BufferView * bv) const
522 bv->showDialog("external", params2string(params(), bv->buffer()),
523 const_cast<InsetExternal *>(this));
528 void InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const
530 renderer_->metrics(mi, dim);
534 void InsetExternal::draw(PainterInfo & pi, int x, int y) const
536 if (renderer_->asButton())
537 renderer_->setRenderState(mouse_hover_[pi.base.bv]);
538 renderer_->draw(pi, x, y);
544 graphics::Params get_grfx_params(InsetExternalParams const & eparams)
546 graphics::Params gparams;
548 gparams.filename = eparams.filename;
549 gparams.scale = eparams.lyxscale;
550 if (eparams.clipdata.clip)
551 gparams.bb = eparams.clipdata.bbox;
552 gparams.angle = convert<double>(eparams.rotationdata.adjAngle());
553 gparams.display = eparams.display;
561 static bool isPreviewWanted(InsetExternalParams const & params)
563 return params.display && params.filename.isReadableFile();
567 static docstring latexString(InsetExternal const & inset)
569 odocstringstream ods;
571 // We don't need to set runparams.encoding since it is not used by
573 OutputParams runparams(0);
574 runparams.flavor = OutputParams::LATEX;
575 inset.latex(os, runparams);
580 static void add_preview_and_start_loading(RenderMonitoredPreview & renderer,
581 InsetExternal const & inset,
582 Buffer const & buffer)
584 InsetExternalParams const & params = inset.params();
586 if (RenderPreview::previewText() && isPreviewWanted(params)) {
587 renderer.setAbsFile(params.filename);
588 docstring const snippet = latexString(inset);
589 renderer.addPreview(snippet, buffer);
590 renderer.startLoading(buffer);
595 InsetExternalParams const & InsetExternal::params() const
601 void InsetExternal::updatePreview()
607 void InsetExternal::setParams(InsetExternalParams const & p)
611 // Subsequent calls to the InsetExternal::Params default constructor
613 defaultTemplateName = params_.templatename();
615 if (!external::getTemplatePtr(params_) || params_.filename.empty()
617 || !lyxrc.display_graphics
618 || params_.preview_mode == PREVIEW_OFF
619 || (params_.preview_mode == PREVIEW_INSTANT
620 && !RenderPreview::previewText())) {
621 RenderButton * button_ptr = renderer_->asButton();
623 renderer_.reset(new RenderButton);
624 button_ptr = renderer_->asButton();
626 button_ptr->update(screenLabel(params_, buffer()), true, false);
630 switch (params_.preview_mode) {
632 // Already taken care of above.
633 LASSERT(false, return);
635 case PREVIEW_INSTANT: {
636 renderer_ = make_unique<RenderMonitoredPreview>(this);
637 RenderMonitoredPreview * preview_ptr = renderer_->asMonitoredPreview();
638 preview_ptr->connect([=]() { fileChanged(); });
639 add_preview_and_start_loading(*preview_ptr, *this, buffer());
642 case PREVIEW_GRAPHICS: {
643 RenderGraphic * graphic_ptr = renderer_->asGraphic();
645 renderer_.reset(new RenderGraphic(this));
646 graphic_ptr = renderer_->asGraphic();
648 graphic_ptr->update(get_grfx_params(params_));
655 void InsetExternal::fileChanged() const
657 Buffer const * const buffer = updateFrontend();
661 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
662 LASSERT(ptr, return);
664 ptr->removePreview(*buffer);
665 add_preview_and_start_loading(*ptr, *this, *buffer);
669 void InsetExternal::write(ostream & os) const
671 params_.write(buffer(), os);
675 void InsetExternal::read(Lexer & lex)
677 InsetExternalParams params;
678 if (params.read(buffer(), lex))
683 void InsetExternal::latex(otexstream & os, OutputParams const & runparams) const
687 os << "\\fbox{\\ttfamily{}"
688 << from_utf8(params_.filename.outputFileName(buffer().filePath()))
693 // "nice" means that the buffer is exported to LaTeX format but not
694 // run through the LaTeX compiler.
695 // If we're running through the LaTeX compiler, we should write the
696 // generated files in the buffer's temporary directory.
697 bool const external_in_tmpdir = !runparams.nice;
698 bool const dryrun = runparams.dryrun || runparams.inComment;
700 // If the template has specified a PDFLaTeX output, then we try and
702 if (runparams.flavor == OutputParams::PDFLATEX) {
703 external::Template const * const et_ptr =
704 external::getTemplatePtr(params_);
707 external::Template const & et = *et_ptr;
709 external::Template::Formats::const_iterator cit =
710 et.formats.find("PDFLaTeX");
712 if (cit != et.formats.end()) {
713 external::writeExternal(params_, "PDFLaTeX",
715 *(runparams.exportdata),
722 external::writeExternal(params_, "LaTeX", buffer(), os,
723 *(runparams.exportdata),
729 int InsetExternal::plaintext(odocstringstream & os,
730 OutputParams const & runparams, size_t) const
732 // this is too slow for constant use
733 if (runparams.for_tooltip)
736 bool const external_in_tmpdir = !runparams.nice;
737 bool const dryrun = runparams.dryrun || runparams.inComment;
739 ots << '\n'; // output external material on a new line
740 external::writeExternal(params_, "Ascii", buffer(), ots,
741 *(runparams.exportdata), external_in_tmpdir, dryrun);
742 return PLAINTEXT_NEWLINE;
746 int InsetExternal::docbook(odocstream & os,
747 OutputParams const & runparams) const
749 bool const external_in_tmpdir = !runparams.nice;
750 bool const dryrun = runparams.dryrun || runparams.inComment;
751 odocstringstream ods;
753 external::writeExternal(params_, "DocBook", buffer(), ots,
754 *(runparams.exportdata), external_in_tmpdir, dryrun);
756 return int(count(ods.str().begin(), ods.str().end(), '\n'));
760 docstring InsetExternal::xhtml(XHTMLStream & xs,
761 OutputParams const & runparams) const
763 bool const external_in_tmpdir = !runparams.nice;
764 bool const dryrun = runparams.dryrun || runparams.inComment;
765 odocstringstream ods;
767 external::writeExternal(params_, "XHTML", buffer(), ots,
768 *(runparams.exportdata), external_in_tmpdir, dryrun);
769 xs << XHTMLStream::ESCAPE_NONE << ods.str();
774 void InsetExternal::validate(LaTeXFeatures & features) const
779 external::Template const * const et_ptr =
780 external::getTemplatePtr(params_);
783 external::Template const & et = *et_ptr;
786 switch (features.runparams().flavor) {
787 case OutputParams::LATEX:
788 case OutputParams::DVILUATEX:
791 case OutputParams::LUATEX:
792 case OutputParams::PDFLATEX:
793 case OutputParams::XETEX:
796 case OutputParams::XML:
799 case OutputParams::HTML:
802 case OutputParams::TEXT:
805 case OutputParams::LYX:
809 external::Template::Formats::const_iterator cit =
810 et.formats.find(format);
812 if (cit == et.formats.end()) {
813 // If the template has not specified a PDFLaTeX output,
814 // we try the LaTeX format.
815 if (format == "PDFLaTeX") {
816 cit = et.formats.find("LaTeX");
817 if (cit == et.formats.end())
823 // FIXME: We don't need that always, see InsetGraphics
824 features.require("lyxdot");
826 vector<string>::const_iterator it = cit->second.requirements.begin();
827 vector<string>::const_iterator end = cit->second.requirements.end();
828 for (; it != end; ++it)
829 features.require(*it);
831 external::TemplateManager & etm = external::TemplateManager::get();
833 for (string const & name : cit->second.preambleNames) {
834 docstring const preamble = etm.getPreambleDefByName(name);
835 if (!preamble.empty())
836 features.addPreambleSnippet(preamble);
841 void InsetExternal::addPreview(DocIterator const & /*inset_pos*/,
842 graphics::PreviewLoader & ploader) const
844 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
848 if (isPreviewWanted(params())) {
849 ptr->setAbsFile(params_.filename);
850 docstring const snippet = latexString(*this);
851 ptr->addPreview(snippet, ploader);
856 string InsetExternal::contextMenuName() const
858 return "context-external";
862 void InsetExternal::string2params(string const & in, Buffer const & buffer,
863 InsetExternalParams & params)
865 params = InsetExternalParams();
869 istringstream data(in);
875 if (!lex || name != "external") {
876 LYXERR0("InsetExternal::string2params(" << in << ")\n"
877 "Expected arg 1 to be \"external\"\n");
881 // This is part of the inset proper that is usually swallowed
882 // by Text::readInset
885 if (!lex || id != "External") {
886 LYXERR0("InsetExternal::string2params(" << in << ")\n"
887 "Expected arg 2 to be \"External\"\n");
891 params.read(buffer, lex);
895 string InsetExternal::params2string(InsetExternalParams const & params,
896 Buffer const & buffer)
899 data << "external" << ' ';
900 params.write(buffer, data);
901 data << "\\end_inset\n";