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';
193 os << "\tembed " << (filename.embedded() ? filename.inzipName() : "\"\"") << '\n';
195 if (display != defaultDisplayType)
197 << external::displayTranslator().find(display)
200 if (lyxscale != defaultLyxScale)
201 os << "\tlyxscale " << convert<string>(lyxscale) << '\n';
206 if (!clipdata.bbox.empty())
207 os << "\tboundingBox " << clipdata.bbox << '\n';
211 external::ExtraData::const_iterator it = extradata.begin();
212 external::ExtraData::const_iterator end = extradata.end();
213 for (; it != end; ++it) {
214 if (!it->second.empty())
215 os << "\textra " << it->first << " \""
216 << it->second << "\"\n";
219 if (!rotationdata.no_rotation()) {
220 os << "\trotateAngle " << rotationdata.adjAngle() << '\n';
221 if (rotationdata.origin() != external::RotationData::DEFAULT)
222 os << "\trotateOrigin "
223 << rotationdata.originString() << '\n';
226 if (!resizedata.no_resize()) {
227 double const scl = convert<double>(resizedata.scale);
228 if (!float_equal(scl, 0.0, 0.05)) {
229 if (!float_equal(scl, 100.0, 0.05))
231 << resizedata.scale << '\n';
233 if (!resizedata.width.zero())
235 << resizedata.width.asString() << '\n';
236 if (!resizedata.height.zero())
238 << resizedata.height.asString() << '\n';
240 if (resizedata.keepAspectRatio)
241 os << "\tkeepAspectRatio\n";
246 bool InsetExternalParams::read(Buffer const & buffer, Lexer & lex)
267 LexerKeyword external_tags[] = {
268 { "\\end_inset", EX_END },
269 { "boundingBox", EX_BOUNDINGBOX },
271 { "display", EX_DISPLAY},
272 { "draft", EX_DRAFT},
273 { "embed", EX_EMBED},
274 { "extra", EX_EXTRA },
275 { "filename", EX_FILENAME},
276 { "height", EX_HEIGHT },
277 { "keepAspectRatio", EX_KEEPASPECTRATIO },
278 { "lyxscale", EX_LYXSCALE},
279 { "rotateAngle", EX_ROTATEANGLE },
280 { "rotateOrigin", EX_ROTATEORIGIN },
281 { "scale", EX_SCALE },
282 { "template", EX_TEMPLATE },
283 { "width", EX_WIDTH }
286 PushPopHelper pph(lex, external_tags, EX_END);
288 bool found_end = false;
289 bool read_error = false;
295 templatename_ = lex.getString();
300 string const name = lex.getString();
301 filename.set(name, buffer.filePath());
307 string const name = lex.getString();
308 filename.setInzipName(name);
309 filename.setEmbed(!name.empty());
315 string const name = lex.getString();
316 display = external::displayTranslator().find(name);
322 lyxscale = lex.getInteger();
331 clipdata.bbox.xl = lex.getInteger();
333 clipdata.bbox.yb = lex.getInteger();
335 clipdata.bbox.xr = lex.getInteger();
337 clipdata.bbox.yt = lex.getInteger();
341 clipdata.clip = true;
346 string const name = lex.getString();
348 extradata.set(name, lex.getString());
354 resizedata.height = Length(lex.getString());
357 case EX_KEEPASPECTRATIO:
358 resizedata.keepAspectRatio = true;
363 rotationdata.angle = lex.getString();
366 case EX_ROTATEORIGIN:
368 rotationdata.origin(lex.getString());
373 resizedata.scale = lex.getString();
378 resizedata.width = Length(lex.getString());
386 lex.printError("ExternalInset::read: Wrong tag: $$Token");
391 if (found_end || read_error)
396 lex.printError("ExternalInsetParams::read: Missing \\end_inset.");
398 // This is a trick to make sure that the data are self-consistent.
399 settemplate(templatename_);
401 if (lyxerr.debugging(Debug::EXTERNAL)) {
402 lyxerr << "InsetExternalParams::read:\n";
403 write(buffer, lyxerr);
410 InsetExternal::InsetExternal(Buffer & buf)
411 : renderer_(new RenderButton)
413 Inset::setBuffer(buf);
417 InsetExternal::InsetExternal(InsetExternal const & other)
419 boost::signals::trackable(),
420 params_(other.params_),
421 renderer_(other.renderer_->clone(this))
425 InsetExternal::~InsetExternal()
427 hideDialogs("external", this);
431 void InsetExternal::setBuffer(Buffer & buffer)
435 // a file may not be copied successfully when, e.g. buffer_
436 // has already been closed.
437 params_.filename = params_.filename.copyTo(buffer);
438 } catch (ExceptionMessage const & message) {
439 Alert::error(message.title_, message.details_);
441 params_.filename.setEmbed(false);
444 Inset::setBuffer(buffer);
448 void InsetExternal::statusChanged() const
454 void InsetExternal::doDispatch(Cursor & cur, FuncRequest & cmd)
456 switch (cmd.action) {
458 case LFUN_EXTERNAL_EDIT: {
459 InsetExternalParams p = params();
460 if (!cmd.argument().empty())
461 string2params(to_utf8(cmd.argument()), buffer(), p);
462 external::editExternal(p, buffer());
466 case LFUN_INSET_MODIFY: {
467 InsetExternalParams p;
468 string2params(to_utf8(cmd.argument()), buffer(), p);
473 case LFUN_INSET_DIALOG_UPDATE:
474 cur.bv().updateDialog("external",
475 params2string(params(), cur.bv().buffer()));
478 case LFUN_MOUSE_RELEASE:
479 if (!cur.selection() && cmd.button() == mouse_button::button1)
480 cur.bv().showDialog("external",
481 params2string(params(), cur.bv().buffer()),
486 Inset::doDispatch(cur, cmd);
491 bool InsetExternal::getStatus(Cursor & cur, FuncRequest const & cmd,
492 FuncStatus & flag) const
494 switch (cmd.action) {
496 case LFUN_EXTERNAL_EDIT:
497 case LFUN_INSET_MODIFY:
498 case LFUN_INSET_DIALOG_UPDATE:
503 return Inset::getStatus(cur, cmd, flag);
508 void InsetExternal::registerEmbeddedFiles(EmbeddedFileList & files) const
510 files.registerFile(params_.filename, this, buffer());
514 void InsetExternal::updateEmbeddedFile(EmbeddedFile const & file)
516 params_.filename = file;
520 void InsetExternal::edit(Cursor & cur, bool, EntryDirection)
522 cur.bv().showDialog("external",
523 params2string(params(), cur.bv().buffer()),
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 renderer_->draw(pi, x, y);
549 RenderType getRenderType(InsetExternalParams const & p)
551 if (!external::getTemplatePtr(p) ||
552 p.filename.empty() ||
553 p.display == external::NoDisplay)
556 if (p.display == external::PreviewDisplay) {
557 if (RenderPreview::status() != LyXRC::PREVIEW_OFF)
558 return RENDERPREVIEW;
562 if (p.display == external::DefaultDisplay &&
563 lyxrc.display_graphics == graphics::NoDisplay)
565 return RENDERGRAPHIC;
569 graphics::Params get_grfx_params(InsetExternalParams const & eparams)
571 graphics::Params gparams;
573 gparams.filename = eparams.filename.availableFile();
574 gparams.icon = eparams.filename.embedded() ? "pin.png" : "";
575 gparams.scale = eparams.lyxscale;
576 if (eparams.clipdata.clip)
577 gparams.bb = eparams.clipdata.bbox;
578 gparams.angle = convert<double>(eparams.rotationdata.adjAngle());
580 switch (eparams.display) {
581 case external::DefaultDisplay:
582 gparams.display = graphics::DefaultDisplay;
584 case external::MonochromeDisplay:
585 gparams.display = graphics::MonochromeDisplay;
587 case external::GrayscaleDisplay:
588 gparams.display = graphics::GrayscaleDisplay;
590 case external::ColorDisplay:
591 gparams.display = graphics::ColorDisplay;
593 case external::NoDisplay:
594 gparams.display = graphics::NoDisplay;
599 if (gparams.display == graphics::DefaultDisplay)
600 gparams.display = graphics::DisplayType(lyxrc.display_graphics);
601 // Override the above if we're not using a gui
603 gparams.display = graphics::NoDisplay;
609 docstring screenLabel(InsetExternalParams const & params,
610 Buffer const & buffer)
612 external::Template const * const ptr =
613 external::getTemplatePtr(params);
616 return bformat((_("External template %1$s is not installed")),
617 from_utf8(params.templatename()));
619 docstring gui = _(ptr->guiName);
620 return from_utf8(external::doSubstitution(params, buffer,
621 to_utf8(gui), false));
627 static bool isPreviewWanted(InsetExternalParams const & params)
629 return params.display == external::PreviewDisplay &&
630 params.filename.isReadableFile();
634 static docstring latexString(InsetExternal const & inset)
637 // We don't need to set runparams.encoding since it is not used by
639 OutputParams runparams(0);
640 runparams.flavor = OutputParams::LATEX;
641 inset.latex(os, runparams);
646 static void add_preview_and_start_loading(RenderMonitoredPreview & renderer,
647 InsetExternal const & inset,
648 Buffer const & buffer)
650 InsetExternalParams const & params = inset.params();
652 if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
653 isPreviewWanted(params)) {
654 renderer.setAbsFile(params.filename);
655 docstring const snippet = latexString(inset);
656 renderer.addPreview(snippet, buffer);
657 renderer.startLoading(buffer);
662 InsetExternalParams const & InsetExternal::params() const
668 void InsetExternal::setParams(InsetExternalParams const & p)
672 // Subsequent calls to the InsetExternal::Params default constructor
674 defaultTemplateName = params_.templatename();
676 switch (getRenderType(params_)) {
678 RenderButton * button_ptr = renderer_->asButton();
680 renderer_.reset(new RenderButton);
681 button_ptr = renderer_->asButton();
684 button_ptr->update(screenLabel(params_, buffer()), true);
688 case RENDERGRAPHIC: {
689 RenderGraphic * graphic_ptr = renderer_->asGraphic();
691 renderer_.reset(new RenderGraphic(this));
692 graphic_ptr = renderer_->asGraphic();
695 graphic_ptr->update(get_grfx_params(params_));
700 case RENDERPREVIEW: {
701 RenderMonitoredPreview * preview_ptr =
702 renderer_->asMonitoredPreview();
704 renderer_.reset(new RenderMonitoredPreview(this));
705 preview_ptr = renderer_->asMonitoredPreview();
706 preview_ptr->fileChanged(
707 boost::bind(&InsetExternal::fileChanged, this));
710 if (preview_ptr->monitoring())
711 preview_ptr->stopMonitoring();
712 add_preview_and_start_loading(*preview_ptr, *this, buffer());
720 void InsetExternal::fileChanged() const
722 Buffer const * const buffer = updateFrontend();
726 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
729 ptr->removePreview(*buffer);
730 add_preview_and_start_loading(*ptr, *this, *buffer);
734 void InsetExternal::write(ostream & os) const
736 params_.write(buffer(), os);
740 void InsetExternal::read(Lexer & lex)
742 InsetExternalParams params;
743 if (params.read(buffer(), lex)) {
744 // exception handling is not needed as long as embedded files are in place.
745 params.filename.enable(buffer().embedded(), buffer(), false);
751 int InsetExternal::latex(odocstream & os, OutputParams const & runparams) const
755 os << "\\fbox{\\ttfamily{}"
756 << from_utf8(params_.filename.outputFilename(buffer().filePath()))
761 // "nice" means that the buffer is exported to LaTeX format but not
762 // run through the LaTeX compiler.
763 // If we're running through the LaTeX compiler, we should write the
764 // generated files in the buffer's temporary directory.
765 bool const external_in_tmpdir = !runparams.nice;
766 bool const dryrun = runparams.dryrun || runparams.inComment;
768 // If the template has specified a PDFLaTeX output, then we try and
770 if (runparams.flavor == OutputParams::PDFLATEX) {
771 external::Template const * const et_ptr =
772 external::getTemplatePtr(params_);
775 external::Template const & et = *et_ptr;
777 external::Template::Formats::const_iterator cit =
778 et.formats.find("PDFLaTeX");
780 if (cit != et.formats.end()) {
781 return external::writeExternal(params_, "PDFLaTeX",
783 *(runparams.exportdata),
789 return external::writeExternal(params_, "LaTeX", buffer(), os,
790 *(runparams.exportdata),
796 int InsetExternal::plaintext(odocstream & os,
797 OutputParams const & runparams) const
799 os << '\n'; // output external material on a new line
800 external::writeExternal(params_, "Ascii", buffer(), os,
801 *(runparams.exportdata), false,
802 runparams.dryrun || runparams.inComment);
803 return PLAINTEXT_NEWLINE;
807 int InsetExternal::docbook(odocstream & os,
808 OutputParams const & runparams) const
810 return external::writeExternal(params_, "DocBook", buffer(), os,
811 *(runparams.exportdata), false,
812 runparams.dryrun || runparams.inComment);
816 void InsetExternal::validate(LaTeXFeatures & features) const
821 external::Template const * const et_ptr =
822 external::getTemplatePtr(params_);
825 external::Template const & et = *et_ptr;
828 switch (features.runparams().flavor) {
829 case OutputParams::LATEX:
832 case OutputParams::PDFLATEX:
835 case OutputParams::XML:
839 external::Template::Formats::const_iterator cit =
840 et.formats.find(format);
841 if (cit == et.formats.end())
844 // FIXME: We don't need that always
845 features.require("lyxdot");
847 vector<string>::const_iterator it = cit->second.requirements.begin();
848 vector<string>::const_iterator end = cit->second.requirements.end();
849 for (; it != end; ++it)
850 features.require(*it);
852 external::TemplateManager & etm = external::TemplateManager::get();
854 it = cit->second.preambleNames.begin();
855 end = cit->second.preambleNames.end();
856 for (; it != end; ++it) {
857 string const preamble = etm.getPreambleDefByName(*it);
858 if (!preamble.empty())
859 features.addPreambleSnippet(preamble);
864 void InsetExternal::addPreview(graphics::PreviewLoader & ploader) const
866 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
870 if (isPreviewWanted(params())) {
871 ptr->setAbsFile(params_.filename);
872 docstring const snippet = latexString(*this);
873 ptr->addPreview(snippet, ploader);
878 void InsetExternal::string2params(string const & in, Buffer const & buffer,
879 InsetExternalParams & params)
881 params = InsetExternalParams();
885 istringstream data(in);
891 if (!lex || name != "external") {
892 LYXERR0("InsetExternal::string2params(" << in << ")\n"
893 "Expected arg 1 to be \"external\"\n");
897 // This is part of the inset proper that is usually swallowed
898 // by Text::readInset
901 if (!lex || id != "External") {
902 LYXERR0("InsetExternal::string2params(" << in << ")\n"
903 "Expected arg 2 to be \"External\"\n");
907 params.read(buffer, lex);
911 string InsetExternal::params2string(InsetExternalParams const & params,
912 Buffer const & buffer)
915 data << "external" << ' ';
916 params.write(buffer, data);
917 data << "\\end_inset\n";