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"
34 #include "frontends/alert.h"
35 #include "frontends/Application.h"
37 #include "graphics/PreviewLoader.h"
39 #include "support/convert.h"
40 #include "support/debug.h"
41 #include "support/ExceptionMessage.h"
42 #include "support/filetools.h"
43 #include "support/gettext.h"
44 #include "support/lstrings.h"
45 #include "support/lyxlib.h"
46 #include "support/Translator.h"
48 #include "support/bind.h"
53 using namespace lyx::support;
57 unsigned int const defaultLyxScale = 100;
59 string defaultTemplateName;
66 namespace Alert = frontend::Alert;
72 FileName const tempname = FileName::tempName("lyxext");
73 // must have an extension for the converter code to work correctly.
74 tempname_ = FileName(tempname.absFileName() + ".tmp");
78 TempName::TempName(TempName const &)
80 tempname_ = TempName()();
86 tempname_.removeFile();
90 TempName & TempName::operator=(TempName const & other)
93 tempname_ = TempName()();
97 } // namespace external
100 InsetExternalParams::InsetExternalParams()
102 lyxscale(defaultLyxScale),
105 if (defaultTemplateName.empty()) {
106 external::TemplateManager const & etm =
107 external::TemplateManager::get();
108 if (!etm.getTemplates().empty())
109 templatename_ = etm.getTemplates().begin()->first;
111 templatename_ = defaultTemplateName;
117 template <typename T>
118 void clearIfNotFound(T & data, external::TransformID value,
119 vector<external::TransformID> const & ids)
121 typedef vector<external::TransformID>::const_iterator
124 const_iterator it = ids.begin();
125 const_iterator end = ids.end();
126 it = find(it, end, value);
134 void InsetExternalParams::settemplate(string const & name)
136 templatename_ = name;
138 external::TemplateManager const & etm =
139 external::TemplateManager::get();
140 external::Template const * const et = etm.getTemplateByName(name);
142 // Be safe. Don't lose data.
145 // Ascertain which transforms the template supports.
146 // Empty all those that it doesn't.
147 vector<external::TransformID> const & ids = et->transformIds;
148 clearIfNotFound(clipdata, external::Clip, ids);
149 clearIfNotFound(extradata, external::Extra, ids);
150 clearIfNotFound(resizedata, external::Resize, ids);
151 clearIfNotFound(rotationdata, external::Rotate, ids);
154 preview_mode = et->preview_mode;
158 void InsetExternalParams::write(Buffer const & buf, ostream & os) const
161 << "\ttemplate " << templatename() << '\n';
163 if (!filename.empty())
164 os << "\tfilename " << filename.outputFileName(buf.filePath()) << '\n';
167 os << "\tdisplay false\n";
169 if (lyxscale != defaultLyxScale)
170 os << "\tlyxscale " << convert<string>(lyxscale) << '\n';
175 if (!clipdata.bbox.empty())
176 os << "\tboundingBox " << clipdata.bbox << '\n';
180 external::ExtraData::const_iterator it = extradata.begin();
181 external::ExtraData::const_iterator end = extradata.end();
182 for (; it != end; ++it) {
183 if (!it->second.empty())
184 os << "\textra " << it->first << " \""
185 << it->second << "\"\n";
188 if (!rotationdata.no_rotation()) {
189 os << "\trotateAngle " << rotationdata.adjAngle() << '\n';
190 if (rotationdata.origin() != external::RotationData::DEFAULT)
191 os << "\trotateOrigin "
192 << rotationdata.originString() << '\n';
195 if (!resizedata.no_resize()) {
196 double const scl = convert<double>(resizedata.scale);
197 if (!float_equal(scl, 0.0, 0.05)) {
198 if (!float_equal(scl, 100.0, 0.05))
200 << resizedata.scale << '\n';
202 if (!resizedata.width.zero())
204 << resizedata.width.asString() << '\n';
205 if (!resizedata.height.zero())
207 << resizedata.height.asString() << '\n';
209 if (resizedata.keepAspectRatio)
210 os << "\tkeepAspectRatio\n";
215 bool InsetExternalParams::read(Buffer const & buffer, Lexer & lex)
235 LexerKeyword external_tags[] = {
236 { "\\end_inset", EX_END },
237 { "boundingBox", EX_BOUNDINGBOX },
239 { "display", EX_DISPLAY},
240 { "draft", EX_DRAFT},
241 { "extra", EX_EXTRA },
242 { "filename", EX_FILENAME},
243 { "height", EX_HEIGHT },
244 { "keepAspectRatio", EX_KEEPASPECTRATIO },
245 { "lyxscale", EX_LYXSCALE},
246 { "rotateAngle", EX_ROTATEANGLE },
247 { "rotateOrigin", EX_ROTATEORIGIN },
248 { "scale", EX_SCALE },
249 { "template", EX_TEMPLATE },
250 { "width", EX_WIDTH }
253 PushPopHelper pph(lex, external_tags);
255 bool found_end = false;
256 bool read_error = false;
262 templatename_ = lex.getString();
267 string const name = lex.getString();
268 filename.set(name, buffer.filePath());
274 display = lex.getString() != "false";
280 lyxscale = lex.getInteger();
289 clipdata.bbox.xl = lex.getInteger();
291 clipdata.bbox.yb = lex.getInteger();
293 clipdata.bbox.xr = lex.getInteger();
295 clipdata.bbox.yt = lex.getInteger();
299 clipdata.clip = true;
304 string const name = lex.getString();
306 extradata.set(name, lex.getString());
312 resizedata.height = Length(lex.getString());
315 case EX_KEEPASPECTRATIO:
316 resizedata.keepAspectRatio = true;
321 rotationdata.angle = lex.getString();
324 case EX_ROTATEORIGIN:
326 rotationdata.origin(lex.getString());
331 resizedata.scale = lex.getString();
336 resizedata.width = Length(lex.getString());
344 lex.printError("ExternalInset::read: Wrong tag: $$Token");
349 if (found_end || read_error)
354 lex.printError("ExternalInsetParams::read: Missing \\end_inset.");
356 // This is a trick to make sure that the data are self-consistent.
357 settemplate(templatename_);
359 if (lyxerr.debugging(Debug::EXTERNAL)) {
360 lyxerr << "InsetExternalParams::read:\n";
361 write(buffer, lyxerr);
368 InsetExternal::InsetExternal(Buffer * buf)
369 : Inset(buf), renderer_(new RenderButton)
374 // Mouse hover is not copied and remains empty
375 InsetExternal::InsetExternal(InsetExternal const & other)
377 boost::signals::trackable(),
378 params_(other.params_),
379 renderer_(other.renderer_->clone(this))
383 InsetExternal::~InsetExternal()
385 hideDialogs("external", this);
387 map<BufferView const *, bool>::iterator it = mouse_hover_.begin();
388 map<BufferView const *, bool>::iterator end = mouse_hover_.end();
389 for (; it != end; ++it)
391 it->first->clearLastInset(this);
395 bool InsetExternal::setMouseHover(BufferView const * bv, bool mouse_hover)
397 mouse_hover_[bv] = mouse_hover;
402 void InsetExternal::statusChanged() const
408 void InsetExternal::doDispatch(Cursor & cur, FuncRequest & cmd)
410 switch (cmd.action()) {
412 case LFUN_INSET_EDIT: {
413 InsetExternalParams p = params();
414 if (!cmd.argument().empty())
415 string2params(to_utf8(cmd.argument()), buffer(), p);
416 external::editExternal(p, buffer());
420 case LFUN_INSET_MODIFY: {
421 InsetExternalParams p;
422 string2params(to_utf8(cmd.argument()), buffer(), p);
427 case LFUN_INSET_DIALOG_UPDATE:
428 cur.bv().updateDialog("external",
429 params2string(params(), cur.bv().buffer()));
433 Inset::doDispatch(cur, cmd);
438 bool InsetExternal::getStatus(Cursor & cur, FuncRequest const & cmd,
439 FuncStatus & flag) const
441 switch (cmd.action()) {
443 case LFUN_INSET_EDIT:
444 case LFUN_INSET_MODIFY:
445 case LFUN_INSET_DIALOG_UPDATE:
446 flag.setEnabled(true);
450 return Inset::getStatus(cur, cmd, flag);
455 bool InsetExternal::showInsetDialog(BufferView * bv) const
457 bv->showDialog("external", params2string(params(), bv->buffer()),
458 const_cast<InsetExternal *>(this));
463 void InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const
465 renderer_->metrics(mi, dim);
469 void InsetExternal::draw(PainterInfo & pi, int x, int y) const
471 if (renderer_->asButton())
472 renderer_->setRenderState(mouse_hover_[pi.base.bv]);
473 renderer_->draw(pi, x, y);
479 graphics::Params get_grfx_params(InsetExternalParams const & eparams)
481 graphics::Params gparams;
483 gparams.filename = eparams.filename;
484 gparams.scale = eparams.lyxscale;
485 if (eparams.clipdata.clip)
486 gparams.bb = eparams.clipdata.bbox;
487 gparams.angle = convert<double>(eparams.rotationdata.adjAngle());
488 gparams.display = eparams.display;
494 docstring screenLabel(InsetExternalParams const & params,
495 Buffer const & buffer)
497 external::Template const * const ptr =
498 external::getTemplatePtr(params);
501 return bformat((_("External template %1$s is not installed")),
502 from_utf8(params.templatename()));
504 docstring gui = _(ptr->guiName);
505 return from_utf8(external::doSubstitution(params, buffer,
506 to_utf8(gui), false));
512 static bool isPreviewWanted(InsetExternalParams const & params)
514 return params.display && params.filename.isReadableFile();
518 static docstring latexString(InsetExternal const & inset)
521 // We don't need to set runparams.encoding since it is not used by
523 OutputParams runparams(0);
524 runparams.flavor = OutputParams::LATEX;
525 inset.latex(os, runparams);
530 static void add_preview_and_start_loading(RenderMonitoredPreview & renderer,
531 InsetExternal const & inset,
532 Buffer const & buffer)
534 InsetExternalParams const & params = inset.params();
536 if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
537 isPreviewWanted(params)) {
538 renderer.setAbsFile(params.filename);
539 docstring const snippet = latexString(inset);
540 renderer.addPreview(snippet, buffer);
541 renderer.startLoading(buffer);
546 InsetExternalParams const & InsetExternal::params() const
552 void InsetExternal::updatePreview()
558 void InsetExternal::setParams(InsetExternalParams const & p)
562 // Subsequent calls to the InsetExternal::Params default constructor
564 defaultTemplateName = params_.templatename();
566 if (!external::getTemplatePtr(params_) || params_.filename.empty()
568 || !lyxrc.display_graphics
569 || params_.preview_mode == PREVIEW_OFF
570 || (params_.preview_mode == PREVIEW_INSTANT
571 && RenderPreview::status() == LyXRC::PREVIEW_OFF)) {
572 RenderButton * button_ptr = renderer_->asButton();
574 renderer_.reset(new RenderButton);
575 button_ptr = renderer_->asButton();
577 button_ptr->update(screenLabel(params_, buffer()), true);
581 switch (params_.preview_mode) {
583 // Already taken care of above.
584 LASSERT(false, return);
586 case PREVIEW_INSTANT: {
587 RenderMonitoredPreview * preview_ptr = renderer_->asMonitoredPreview();
588 renderer_.reset(new RenderMonitoredPreview(this));
589 preview_ptr = renderer_->asMonitoredPreview();
590 preview_ptr->fileChanged(bind(&InsetExternal::fileChanged, this));
591 if (preview_ptr->monitoring())
592 preview_ptr->stopMonitoring();
593 add_preview_and_start_loading(*preview_ptr, *this, buffer());
596 case PREVIEW_GRAPHICS: {
597 RenderGraphic * graphic_ptr = renderer_->asGraphic();
599 renderer_.reset(new RenderGraphic(this));
600 graphic_ptr = renderer_->asGraphic();
602 graphic_ptr->update(get_grfx_params(params_));
609 void InsetExternal::fileChanged() const
611 Buffer const * const buffer = updateFrontend();
615 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
618 ptr->removePreview(*buffer);
619 add_preview_and_start_loading(*ptr, *this, *buffer);
623 void InsetExternal::write(ostream & os) const
625 params_.write(buffer(), os);
629 void InsetExternal::read(Lexer & lex)
631 InsetExternalParams params;
632 if (params.read(buffer(), lex))
637 int InsetExternal::latex(odocstream & os, OutputParams const & runparams) const
641 os << "\\fbox{\\ttfamily{}"
642 << from_utf8(params_.filename.outputFileName(buffer().filePath()))
647 // "nice" means that the buffer is exported to LaTeX format but not
648 // run through the LaTeX compiler.
649 // If we're running through the LaTeX compiler, we should write the
650 // generated files in the buffer's temporary directory.
651 bool const external_in_tmpdir = !runparams.nice;
652 bool const dryrun = runparams.dryrun || runparams.inComment;
654 // If the template has specified a PDFLaTeX output, then we try and
656 if (runparams.flavor == OutputParams::PDFLATEX) {
657 external::Template const * const et_ptr =
658 external::getTemplatePtr(params_);
661 external::Template const & et = *et_ptr;
663 external::Template::Formats::const_iterator cit =
664 et.formats.find("PDFLaTeX");
666 if (cit != et.formats.end()) {
667 return external::writeExternal(params_, "PDFLaTeX",
669 *(runparams.exportdata),
675 return external::writeExternal(params_, "LaTeX", buffer(), os,
676 *(runparams.exportdata),
682 int InsetExternal::plaintext(odocstream & os,
683 OutputParams const & runparams) const
685 os << '\n'; // output external material on a new line
686 external::writeExternal(params_, "Ascii", buffer(), os,
687 *(runparams.exportdata), false,
688 runparams.dryrun || runparams.inComment);
689 return PLAINTEXT_NEWLINE;
693 int InsetExternal::docbook(odocstream & os,
694 OutputParams const & runparams) const
696 return external::writeExternal(params_, "DocBook", buffer(), os,
697 *(runparams.exportdata), false,
698 runparams.dryrun || runparams.inComment);
702 docstring InsetExternal::xhtml(XHTMLStream & /*xs*/,
703 OutputParams const & /*rp*/) const
705 // external::writeExternal(params_, "XHTML", buffer(), os,
706 // *(runparams.exportdata), false,
707 // runparams.dryrun || runparams.inComment);
712 void InsetExternal::validate(LaTeXFeatures & features) const
717 external::Template const * const et_ptr =
718 external::getTemplatePtr(params_);
721 external::Template const & et = *et_ptr;
724 switch (features.runparams().flavor) {
725 case OutputParams::LATEX:
728 case OutputParams::PDFLATEX:
729 case OutputParams::XETEX:
732 case OutputParams::XML:
735 case OutputParams::HTML:
738 case OutputParams::TEXT:
742 external::Template::Formats::const_iterator cit =
743 et.formats.find(format);
745 if (cit == et.formats.end()) {
746 // If the template has not specified a PDFLaTeX output,
747 // we try the LaTeX format.
748 if (format == "PDFLaTeX") {
749 cit = et.formats.find("LaTeX");
750 if (cit == et.formats.end())
756 // FIXME: We don't need that always
757 features.require("lyxdot");
759 vector<string>::const_iterator it = cit->second.requirements.begin();
760 vector<string>::const_iterator end = cit->second.requirements.end();
761 for (; it != end; ++it)
762 features.require(*it);
764 external::TemplateManager & etm = external::TemplateManager::get();
766 it = cit->second.preambleNames.begin();
767 end = cit->second.preambleNames.end();
768 for (; it != end; ++it) {
769 string const preamble = etm.getPreambleDefByName(*it);
770 if (!preamble.empty())
771 features.addPreambleSnippet(preamble);
776 void InsetExternal::addPreview(DocIterator const & /*inset_pos*/,
777 graphics::PreviewLoader & ploader) const
779 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
783 if (isPreviewWanted(params())) {
784 ptr->setAbsFile(params_.filename);
785 docstring const snippet = latexString(*this);
786 ptr->addPreview(snippet, ploader);
791 docstring InsetExternal::contextMenu(BufferView const &, int, int) const
793 return from_ascii("context-external");
797 void InsetExternal::string2params(string const & in, Buffer const & buffer,
798 InsetExternalParams & params)
800 params = InsetExternalParams();
804 istringstream data(in);
810 if (!lex || name != "external") {
811 LYXERR0("InsetExternal::string2params(" << in << ")\n"
812 "Expected arg 1 to be \"external\"\n");
816 // This is part of the inset proper that is usually swallowed
817 // by Text::readInset
820 if (!lex || id != "External") {
821 LYXERR0("InsetExternal::string2params(" << in << ")\n"
822 "Expected arg 2 to be \"External\"\n");
826 params.read(buffer, lex);
830 string InsetExternal::params2string(InsetExternalParams const & params,
831 Buffer const & buffer)
834 data << "external" << ' ';
835 params.write(buffer, data);
836 data << "\\end_inset\n";