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/ExternalTemplate.h"
16 #include "insets/RenderButton.h"
17 #include "insets/RenderGraphic.h"
18 #include "insets/RenderPreview.h"
21 #include "BufferView.h"
23 #include "DispatchResult.h"
25 #include "FuncStatus.h"
26 #include "FuncRequest.h"
27 #include "LaTeXFeatures.h"
29 #include "LyX.h" // use_gui
31 #include "MetricsInfo.h"
32 #include "OutputParams.h"
34 #include "frontends/alert.h"
35 #include "frontends/Application.h"
37 #include "graphics/PreviewLoader.h"
39 #include "support/debug.h"
40 #include "support/ExceptionMessage.h"
41 #include "support/filetools.h"
42 #include "support/gettext.h"
43 #include "support/lstrings.h"
44 #include "support/lyxlib.h"
45 #include "support/convert.h"
46 #include "support/Translator.h"
48 #include <boost/bind.hpp>
53 using namespace lyx::support;
57 lyx::external::DisplayType const defaultDisplayType = lyx::external::NoDisplay;
59 unsigned int const defaultLyxScale = 100;
61 string defaultTemplateName;
68 namespace Alert = frontend::Alert;
74 FileName const tempname = FileName::tempName("lyxext");
75 // FIXME: This is unsafe
76 tempname.removeFile();
77 // must have an extension for the converter code to work correctly.
78 tempname_ = FileName(tempname.absFilename() + ".tmp");
82 TempName::TempName(TempName const &)
84 tempname_ = TempName()();
90 tempname_.removeFile();
94 TempName & TempName::operator=(TempName const & other)
97 tempname_ = TempName()();
104 /// The translator between the Display enum and corresponding lyx string.
105 Translator<DisplayType, string> const initTranslator()
107 Translator<DisplayType, string> translator(DefaultDisplay, "default");
109 // Fill the display translator
110 translator.addPair(MonochromeDisplay, "monochrome");
111 translator.addPair(GrayscaleDisplay, "grayscale");
112 translator.addPair(ColorDisplay, "color");
113 translator.addPair(PreviewDisplay, "preview");
114 translator.addPair(NoDisplay, "none");
122 Translator<DisplayType, string> const & displayTranslator()
124 static Translator<DisplayType, string> const translator =
129 } // namespace external
132 InsetExternalParams::InsetExternalParams()
133 : display(defaultDisplayType),
134 lyxscale(defaultLyxScale),
137 if (defaultTemplateName.empty()) {
138 external::TemplateManager const & etm =
139 external::TemplateManager::get();
140 templatename_ = etm.getTemplates().begin()->first;
142 templatename_ = defaultTemplateName;
148 template <typename T>
149 void clearIfNotFound(T & data, external::TransformID value,
150 vector<external::TransformID> const & ids)
152 typedef vector<external::TransformID>::const_iterator
155 const_iterator it = ids.begin();
156 const_iterator end = ids.end();
157 it = find(it, end, value);
165 void InsetExternalParams::settemplate(string const & name)
167 templatename_ = name;
169 external::TemplateManager const & etm =
170 external::TemplateManager::get();
171 external::Template const * const et = etm.getTemplateByName(name);
173 // Be safe. Don't lose data.
176 // Ascertain which transforms the template supports.
177 // Empty all those that it doesn't.
178 vector<external::TransformID> const & ids = et->transformIds;
179 clearIfNotFound(clipdata, external::Clip, ids);
180 clearIfNotFound(extradata, external::Extra, ids);
181 clearIfNotFound(resizedata, external::Resize, ids);
182 clearIfNotFound(rotationdata, external::Rotate, ids);
186 void InsetExternalParams::write(Buffer const & buf, ostream & os) const
189 << "\ttemplate " << templatename() << '\n';
191 if (!filename.empty())
192 os << "\tfilename " << filename.outputFilename(buf.filePath()) << '\n';
194 if (display != defaultDisplayType)
196 << external::displayTranslator().find(display)
199 if (lyxscale != defaultLyxScale)
200 os << "\tlyxscale " << convert<string>(lyxscale) << '\n';
205 if (!clipdata.bbox.empty())
206 os << "\tboundingBox " << clipdata.bbox << '\n';
210 external::ExtraData::const_iterator it = extradata.begin();
211 external::ExtraData::const_iterator end = extradata.end();
212 for (; it != end; ++it) {
213 if (!it->second.empty())
214 os << "\textra " << it->first << " \""
215 << it->second << "\"\n";
218 if (!rotationdata.no_rotation()) {
219 os << "\trotateAngle " << rotationdata.adjAngle() << '\n';
220 if (rotationdata.origin() != external::RotationData::DEFAULT)
221 os << "\trotateOrigin "
222 << rotationdata.originString() << '\n';
225 if (!resizedata.no_resize()) {
226 double const scl = convert<double>(resizedata.scale);
227 if (!float_equal(scl, 0.0, 0.05)) {
228 if (!float_equal(scl, 100.0, 0.05))
230 << resizedata.scale << '\n';
232 if (!resizedata.width.zero())
234 << resizedata.width.asString() << '\n';
235 if (!resizedata.height.zero())
237 << resizedata.height.asString() << '\n';
239 if (resizedata.keepAspectRatio)
240 os << "\tkeepAspectRatio\n";
245 bool InsetExternalParams::read(Buffer const & buffer, Lexer & lex)
265 LexerKeyword external_tags[] = {
266 { "\\end_inset", EX_END },
267 { "boundingBox", EX_BOUNDINGBOX },
269 { "display", EX_DISPLAY},
270 { "draft", EX_DRAFT},
271 { "extra", EX_EXTRA },
272 { "filename", EX_FILENAME},
273 { "height", EX_HEIGHT },
274 { "keepAspectRatio", EX_KEEPASPECTRATIO },
275 { "lyxscale", EX_LYXSCALE},
276 { "rotateAngle", EX_ROTATEANGLE },
277 { "rotateOrigin", EX_ROTATEORIGIN },
278 { "scale", EX_SCALE },
279 { "template", EX_TEMPLATE },
280 { "width", EX_WIDTH }
283 PushPopHelper pph(lex, external_tags);
285 bool found_end = false;
286 bool read_error = false;
292 templatename_ = lex.getString();
297 string const name = lex.getString();
298 filename.set(name, buffer.filePath());
304 string const name = lex.getString();
305 display = external::displayTranslator().find(name);
311 lyxscale = lex.getInteger();
320 clipdata.bbox.xl = lex.getInteger();
322 clipdata.bbox.yb = lex.getInteger();
324 clipdata.bbox.xr = lex.getInteger();
326 clipdata.bbox.yt = lex.getInteger();
330 clipdata.clip = true;
335 string const name = lex.getString();
337 extradata.set(name, lex.getString());
343 resizedata.height = Length(lex.getString());
346 case EX_KEEPASPECTRATIO:
347 resizedata.keepAspectRatio = true;
352 rotationdata.angle = lex.getString();
355 case EX_ROTATEORIGIN:
357 rotationdata.origin(lex.getString());
362 resizedata.scale = lex.getString();
367 resizedata.width = Length(lex.getString());
375 lex.printError("ExternalInset::read: Wrong tag: $$Token");
380 if (found_end || read_error)
385 lex.printError("ExternalInsetParams::read: Missing \\end_inset.");
387 // This is a trick to make sure that the data are self-consistent.
388 settemplate(templatename_);
390 if (lyxerr.debugging(Debug::EXTERNAL)) {
391 lyxerr << "InsetExternalParams::read:\n";
392 write(buffer, lyxerr);
399 InsetExternal::InsetExternal(Buffer & buf)
400 : renderer_(new RenderButton)
402 Inset::setBuffer(buf);
406 InsetExternal::InsetExternal(InsetExternal const & other)
408 boost::signals::trackable(),
409 params_(other.params_),
410 renderer_(other.renderer_->clone(this))
414 InsetExternal::~InsetExternal()
416 hideDialogs("external", this);
420 void InsetExternal::statusChanged() const
426 void InsetExternal::doDispatch(Cursor & cur, FuncRequest & cmd)
428 switch (cmd.action) {
430 case LFUN_INSET_EDIT: {
431 InsetExternalParams p = params();
432 if (!cmd.argument().empty())
433 string2params(to_utf8(cmd.argument()), buffer(), p);
434 external::editExternal(p, buffer());
438 case LFUN_INSET_MODIFY: {
439 InsetExternalParams p;
440 string2params(to_utf8(cmd.argument()), buffer(), p);
445 case LFUN_INSET_DIALOG_UPDATE:
446 cur.bv().updateDialog("external",
447 params2string(params(), cur.bv().buffer()));
450 case LFUN_MOUSE_RELEASE:
451 if (!cur.selection() && cmd.button() == mouse_button::button1)
452 cur.bv().showDialog("external",
453 params2string(params(), cur.bv().buffer()),
458 Inset::doDispatch(cur, cmd);
463 bool InsetExternal::getStatus(Cursor & cur, FuncRequest const & cmd,
464 FuncStatus & flag) const
466 switch (cmd.action) {
468 case LFUN_INSET_EDIT:
469 case LFUN_INSET_MODIFY:
470 case LFUN_INSET_DIALOG_UPDATE:
471 flag.setEnabled(true);
475 return Inset::getStatus(cur, cmd, flag);
480 void InsetExternal::edit(Cursor & cur, bool, EntryDirection)
482 cur.bv().showDialog("external",
483 params2string(params(), cur.bv().buffer()),
488 void InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const
490 renderer_->metrics(mi, dim);
494 void InsetExternal::draw(PainterInfo & pi, int x, int y) const
496 renderer_->draw(pi, x, y);
509 RenderType getRenderType(InsetExternalParams const & p)
511 if (!external::getTemplatePtr(p) ||
512 p.filename.empty() ||
513 p.display == external::NoDisplay)
516 if (p.display == external::PreviewDisplay) {
517 if (RenderPreview::status() != LyXRC::PREVIEW_OFF)
518 return RENDERPREVIEW;
522 if (p.display == external::DefaultDisplay &&
523 lyxrc.display_graphics == graphics::NoDisplay)
525 return RENDERGRAPHIC;
529 graphics::Params get_grfx_params(InsetExternalParams const & eparams)
531 graphics::Params gparams;
533 gparams.filename = eparams.filename;
534 gparams.scale = eparams.lyxscale;
535 if (eparams.clipdata.clip)
536 gparams.bb = eparams.clipdata.bbox;
537 gparams.angle = convert<double>(eparams.rotationdata.adjAngle());
539 switch (eparams.display) {
540 case external::DefaultDisplay:
541 gparams.display = graphics::DefaultDisplay;
543 case external::MonochromeDisplay:
544 gparams.display = graphics::MonochromeDisplay;
546 case external::GrayscaleDisplay:
547 gparams.display = graphics::GrayscaleDisplay;
549 case external::ColorDisplay:
550 gparams.display = graphics::ColorDisplay;
552 case external::NoDisplay:
553 gparams.display = graphics::NoDisplay;
556 LASSERT(false, /**/);
558 if (gparams.display == graphics::DefaultDisplay)
559 gparams.display = graphics::DisplayType(lyxrc.display_graphics);
560 // Override the above if we're not using a gui
562 gparams.display = graphics::NoDisplay;
568 docstring screenLabel(InsetExternalParams const & params,
569 Buffer const & buffer)
571 external::Template const * const ptr =
572 external::getTemplatePtr(params);
575 return bformat((_("External template %1$s is not installed")),
576 from_utf8(params.templatename()));
578 docstring gui = _(ptr->guiName);
579 return from_utf8(external::doSubstitution(params, buffer,
580 to_utf8(gui), false));
586 static bool isPreviewWanted(InsetExternalParams const & params)
588 return params.display == external::PreviewDisplay &&
589 params.filename.isReadableFile();
593 static docstring latexString(InsetExternal const & inset)
596 // We don't need to set runparams.encoding since it is not used by
598 OutputParams runparams(0);
599 runparams.flavor = OutputParams::LATEX;
600 inset.latex(os, runparams);
605 static void add_preview_and_start_loading(RenderMonitoredPreview & renderer,
606 InsetExternal const & inset,
607 Buffer const & buffer)
609 InsetExternalParams const & params = inset.params();
611 if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
612 isPreviewWanted(params)) {
613 renderer.setAbsFile(params.filename);
614 docstring const snippet = latexString(inset);
615 renderer.addPreview(snippet, buffer);
616 renderer.startLoading(buffer);
621 InsetExternalParams const & InsetExternal::params() const
627 void InsetExternal::setParams(InsetExternalParams const & p)
631 // Subsequent calls to the InsetExternal::Params default constructor
633 defaultTemplateName = params_.templatename();
635 switch (getRenderType(params_)) {
637 RenderButton * button_ptr = renderer_->asButton();
639 renderer_.reset(new RenderButton);
640 button_ptr = renderer_->asButton();
643 button_ptr->update(screenLabel(params_, buffer()), true);
647 case RENDERGRAPHIC: {
648 RenderGraphic * graphic_ptr = renderer_->asGraphic();
650 renderer_.reset(new RenderGraphic(this));
651 graphic_ptr = renderer_->asGraphic();
654 graphic_ptr->update(get_grfx_params(params_));
659 case RENDERPREVIEW: {
660 RenderMonitoredPreview * preview_ptr =
661 renderer_->asMonitoredPreview();
663 renderer_.reset(new RenderMonitoredPreview(this));
664 preview_ptr = renderer_->asMonitoredPreview();
665 preview_ptr->fileChanged(
666 boost::bind(&InsetExternal::fileChanged, this));
669 if (preview_ptr->monitoring())
670 preview_ptr->stopMonitoring();
671 add_preview_and_start_loading(*preview_ptr, *this, buffer());
679 void InsetExternal::fileChanged() const
681 Buffer const * const buffer = updateFrontend();
685 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
688 ptr->removePreview(*buffer);
689 add_preview_and_start_loading(*ptr, *this, *buffer);
693 void InsetExternal::write(ostream & os) const
695 params_.write(buffer(), os);
699 void InsetExternal::read(Lexer & lex)
701 InsetExternalParams params;
702 if (params.read(buffer(), lex))
707 int InsetExternal::latex(odocstream & os, OutputParams const & runparams) const
711 os << "\\fbox{\\ttfamily{}"
712 << from_utf8(params_.filename.outputFilename(buffer().filePath()))
717 // "nice" means that the buffer is exported to LaTeX format but not
718 // run through the LaTeX compiler.
719 // If we're running through the LaTeX compiler, we should write the
720 // generated files in the buffer's temporary directory.
721 bool const external_in_tmpdir = !runparams.nice;
722 bool const dryrun = runparams.dryrun || runparams.inComment;
724 // If the template has specified a PDFLaTeX output, then we try and
726 if (runparams.flavor == OutputParams::PDFLATEX) {
727 external::Template const * const et_ptr =
728 external::getTemplatePtr(params_);
731 external::Template const & et = *et_ptr;
733 external::Template::Formats::const_iterator cit =
734 et.formats.find("PDFLaTeX");
736 if (cit != et.formats.end()) {
737 return external::writeExternal(params_, "PDFLaTeX",
739 *(runparams.exportdata),
745 return external::writeExternal(params_, "LaTeX", buffer(), os,
746 *(runparams.exportdata),
752 int InsetExternal::plaintext(odocstream & os,
753 OutputParams const & runparams) const
755 os << '\n'; // output external material on a new line
756 external::writeExternal(params_, "Ascii", buffer(), os,
757 *(runparams.exportdata), false,
758 runparams.dryrun || runparams.inComment);
759 return PLAINTEXT_NEWLINE;
763 int InsetExternal::docbook(odocstream & os,
764 OutputParams const & runparams) const
766 return external::writeExternal(params_, "DocBook", buffer(), os,
767 *(runparams.exportdata), false,
768 runparams.dryrun || runparams.inComment);
772 void InsetExternal::validate(LaTeXFeatures & features) const
777 external::Template const * const et_ptr =
778 external::getTemplatePtr(params_);
781 external::Template const & et = *et_ptr;
784 switch (features.runparams().flavor) {
785 case OutputParams::LATEX:
788 case OutputParams::PDFLATEX:
791 case OutputParams::XML:
795 external::Template::Formats::const_iterator cit =
796 et.formats.find(format);
798 if (cit == et.formats.end()) {
799 // If the template has not specified a PDFLaTeX output,
800 // we try the LaTeX format.
801 if (format == "PDFLaTeX") {
802 cit = et.formats.find("LaTeX");
803 if (cit == et.formats.end())
809 // FIXME: We don't need that always
810 features.require("lyxdot");
812 vector<string>::const_iterator it = cit->second.requirements.begin();
813 vector<string>::const_iterator end = cit->second.requirements.end();
814 for (; it != end; ++it)
815 features.require(*it);
817 external::TemplateManager & etm = external::TemplateManager::get();
819 it = cit->second.preambleNames.begin();
820 end = cit->second.preambleNames.end();
821 for (; it != end; ++it) {
822 string const preamble = etm.getPreambleDefByName(*it);
823 if (!preamble.empty())
824 features.addPreambleSnippet(preamble);
829 void InsetExternal::addPreview(graphics::PreviewLoader & ploader) const
831 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
835 if (isPreviewWanted(params())) {
836 ptr->setAbsFile(params_.filename);
837 docstring const snippet = latexString(*this);
838 ptr->addPreview(snippet, ploader);
843 docstring InsetExternal::contextMenu(BufferView const &, int, int) const
845 return from_ascii("context-external");
849 void InsetExternal::string2params(string const & in, Buffer const & buffer,
850 InsetExternalParams & params)
852 params = InsetExternalParams();
856 istringstream data(in);
862 if (!lex || name != "external") {
863 LYXERR0("InsetExternal::string2params(" << in << ")\n"
864 "Expected arg 1 to be \"external\"\n");
868 // This is part of the inset proper that is usually swallowed
869 // by Text::readInset
872 if (!lex || id != "External") {
873 LYXERR0("InsetExternal::string2params(" << in << ")\n"
874 "Expected arg 2 to be \"External\"\n");
878 params.read(buffer, lex);
882 string InsetExternal::params2string(InsetExternalParams const & params,
883 Buffer const & buffer)
886 data << "external" << ' ';
887 params.write(buffer, data);
888 data << "\\end_inset\n";