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 if (display != defaultDisplayType)
195 << external::displayTranslator().find(display)
198 if (lyxscale != defaultLyxScale)
199 os << "\tlyxscale " << convert<string>(lyxscale) << '\n';
204 if (!clipdata.bbox.empty())
205 os << "\tboundingBox " << clipdata.bbox << '\n';
209 external::ExtraData::const_iterator it = extradata.begin();
210 external::ExtraData::const_iterator end = extradata.end();
211 for (; it != end; ++it) {
212 if (!it->second.empty())
213 os << "\textra " << it->first << " \""
214 << it->second << "\"\n";
217 if (!rotationdata.no_rotation()) {
218 os << "\trotateAngle " << rotationdata.adjAngle() << '\n';
219 if (rotationdata.origin() != external::RotationData::DEFAULT)
220 os << "\trotateOrigin "
221 << rotationdata.originString() << '\n';
224 if (!resizedata.no_resize()) {
225 double const scl = convert<double>(resizedata.scale);
226 if (!float_equal(scl, 0.0, 0.05)) {
227 if (!float_equal(scl, 100.0, 0.05))
229 << resizedata.scale << '\n';
231 if (!resizedata.width.zero())
233 << resizedata.width.asString() << '\n';
234 if (!resizedata.height.zero())
236 << resizedata.height.asString() << '\n';
238 if (resizedata.keepAspectRatio)
239 os << "\tkeepAspectRatio\n";
244 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 { "embed", EX_EMBED},
272 { "extra", EX_EXTRA },
273 { "filename", EX_FILENAME},
274 { "height", EX_HEIGHT },
275 { "keepAspectRatio", EX_KEEPASPECTRATIO },
276 { "lyxscale", EX_LYXSCALE},
277 { "rotateAngle", EX_ROTATEANGLE },
278 { "rotateOrigin", EX_ROTATEORIGIN },
279 { "scale", EX_SCALE },
280 { "template", EX_TEMPLATE },
281 { "width", EX_WIDTH }
284 PushPopHelper pph(lex, external_tags);
286 bool found_end = false;
287 bool read_error = false;
293 templatename_ = lex.getString();
298 string const name = lex.getString();
299 filename.set(name, buffer.filePath());
305 string const name = lex.getString();
306 filename.setInzipName(name);
307 filename.setEmbed(!name.empty());
313 string const name = lex.getString();
314 display = external::displayTranslator().find(name);
320 lyxscale = lex.getInteger();
329 clipdata.bbox.xl = lex.getInteger();
331 clipdata.bbox.yb = lex.getInteger();
333 clipdata.bbox.xr = lex.getInteger();
335 clipdata.bbox.yt = lex.getInteger();
339 clipdata.clip = true;
344 string const name = lex.getString();
346 extradata.set(name, lex.getString());
352 resizedata.height = Length(lex.getString());
355 case EX_KEEPASPECTRATIO:
356 resizedata.keepAspectRatio = true;
361 rotationdata.angle = lex.getString();
364 case EX_ROTATEORIGIN:
366 rotationdata.origin(lex.getString());
371 resizedata.scale = lex.getString();
376 resizedata.width = Length(lex.getString());
384 lex.printError("ExternalInset::read: Wrong tag: $$Token");
389 if (found_end || read_error)
394 lex.printError("ExternalInsetParams::read: Missing \\end_inset.");
396 // This is a trick to make sure that the data are self-consistent.
397 settemplate(templatename_);
399 if (lyxerr.debugging(Debug::EXTERNAL)) {
400 lyxerr << "InsetExternalParams::read:\n";
401 write(buffer, lyxerr);
408 InsetExternal::InsetExternal(Buffer & buf)
409 : renderer_(new RenderButton)
411 Inset::setBuffer(buf);
415 InsetExternal::InsetExternal(InsetExternal const & other)
417 boost::signals::trackable(),
418 params_(other.params_),
419 renderer_(other.renderer_->clone(this))
423 InsetExternal::~InsetExternal()
425 hideDialogs("external", this);
429 void InsetExternal::setBuffer(Buffer & buffer)
433 // a file may not be copied successfully when, e.g. buffer_
434 // has already been closed.
435 params_.filename = params_.filename.copyTo(buffer);
436 } catch (ExceptionMessage const & message) {
437 Alert::error(message.title_, message.details_);
439 params_.filename.setEmbed(false);
442 Inset::setBuffer(buffer);
446 void InsetExternal::statusChanged() const
452 void InsetExternal::doDispatch(Cursor & cur, FuncRequest & cmd)
454 switch (cmd.action) {
456 case LFUN_EXTERNAL_EDIT: {
457 InsetExternalParams p = params();
458 if (!cmd.argument().empty())
459 string2params(to_utf8(cmd.argument()), buffer(), p);
460 external::editExternal(p, buffer());
464 case LFUN_INSET_MODIFY: {
465 InsetExternalParams p;
466 string2params(to_utf8(cmd.argument()), buffer(), p);
471 case LFUN_INSET_DIALOG_UPDATE:
472 cur.bv().updateDialog("external",
473 params2string(params(), cur.bv().buffer()));
476 case LFUN_MOUSE_RELEASE:
477 if (!cur.selection() && cmd.button() == mouse_button::button1)
478 cur.bv().showDialog("external",
479 params2string(params(), cur.bv().buffer()),
484 Inset::doDispatch(cur, cmd);
489 bool InsetExternal::getStatus(Cursor & cur, FuncRequest const & cmd,
490 FuncStatus & flag) const
492 switch (cmd.action) {
494 case LFUN_EXTERNAL_EDIT:
495 case LFUN_INSET_MODIFY:
496 case LFUN_INSET_DIALOG_UPDATE:
501 return Inset::getStatus(cur, cmd, flag);
506 void InsetExternal::registerEmbeddedFiles(EmbeddedFileList & files) const
508 files.registerFile(params_.filename, this, buffer());
512 void InsetExternal::updateEmbeddedFile(EmbeddedFile const & file)
514 params_.filename = file;
518 void InsetExternal::edit(Cursor & cur, bool, EntryDirection)
520 cur.bv().showDialog("external",
521 params2string(params(), cur.bv().buffer()),
526 void InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const
528 renderer_->metrics(mi, dim);
532 void InsetExternal::draw(PainterInfo & pi, int x, int y) const
534 renderer_->draw(pi, x, y);
547 RenderType getRenderType(InsetExternalParams const & p)
549 if (!external::getTemplatePtr(p) ||
550 p.filename.empty() ||
551 p.display == external::NoDisplay)
554 if (p.display == external::PreviewDisplay) {
555 if (RenderPreview::status() != LyXRC::PREVIEW_OFF)
556 return RENDERPREVIEW;
560 if (p.display == external::DefaultDisplay &&
561 lyxrc.display_graphics == graphics::NoDisplay)
563 return RENDERGRAPHIC;
567 graphics::Params get_grfx_params(InsetExternalParams const & eparams)
569 graphics::Params gparams;
571 gparams.filename = eparams.filename.availableFile();
572 gparams.icon = eparams.filename.embedded() ? "pin.png" : "";
573 gparams.scale = eparams.lyxscale;
574 if (eparams.clipdata.clip)
575 gparams.bb = eparams.clipdata.bbox;
576 gparams.angle = convert<double>(eparams.rotationdata.adjAngle());
578 switch (eparams.display) {
579 case external::DefaultDisplay:
580 gparams.display = graphics::DefaultDisplay;
582 case external::MonochromeDisplay:
583 gparams.display = graphics::MonochromeDisplay;
585 case external::GrayscaleDisplay:
586 gparams.display = graphics::GrayscaleDisplay;
588 case external::ColorDisplay:
589 gparams.display = graphics::ColorDisplay;
591 case external::NoDisplay:
592 gparams.display = graphics::NoDisplay;
595 LASSERT(false, /**/);
597 if (gparams.display == graphics::DefaultDisplay)
598 gparams.display = graphics::DisplayType(lyxrc.display_graphics);
599 // Override the above if we're not using a gui
601 gparams.display = graphics::NoDisplay;
607 docstring screenLabel(InsetExternalParams const & params,
608 Buffer const & buffer)
610 external::Template const * const ptr =
611 external::getTemplatePtr(params);
614 return bformat((_("External template %1$s is not installed")),
615 from_utf8(params.templatename()));
617 docstring gui = _(ptr->guiName);
618 return from_utf8(external::doSubstitution(params, buffer,
619 to_utf8(gui), false));
625 static bool isPreviewWanted(InsetExternalParams const & params)
627 return params.display == external::PreviewDisplay &&
628 params.filename.isReadableFile();
632 static docstring latexString(InsetExternal const & inset)
635 // We don't need to set runparams.encoding since it is not used by
637 OutputParams runparams(0);
638 runparams.flavor = OutputParams::LATEX;
639 inset.latex(os, runparams);
644 static void add_preview_and_start_loading(RenderMonitoredPreview & renderer,
645 InsetExternal const & inset,
646 Buffer const & buffer)
648 InsetExternalParams const & params = inset.params();
650 if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
651 isPreviewWanted(params)) {
652 renderer.setAbsFile(params.filename);
653 docstring const snippet = latexString(inset);
654 renderer.addPreview(snippet, buffer);
655 renderer.startLoading(buffer);
660 InsetExternalParams const & InsetExternal::params() const
666 void InsetExternal::setParams(InsetExternalParams const & p)
670 // Subsequent calls to the InsetExternal::Params default constructor
672 defaultTemplateName = params_.templatename();
674 switch (getRenderType(params_)) {
676 RenderButton * button_ptr = renderer_->asButton();
678 renderer_.reset(new RenderButton);
679 button_ptr = renderer_->asButton();
682 button_ptr->update(screenLabel(params_, buffer()), true);
686 case RENDERGRAPHIC: {
687 RenderGraphic * graphic_ptr = renderer_->asGraphic();
689 renderer_.reset(new RenderGraphic(this));
690 graphic_ptr = renderer_->asGraphic();
693 graphic_ptr->update(get_grfx_params(params_));
698 case RENDERPREVIEW: {
699 RenderMonitoredPreview * preview_ptr =
700 renderer_->asMonitoredPreview();
702 renderer_.reset(new RenderMonitoredPreview(this));
703 preview_ptr = renderer_->asMonitoredPreview();
704 preview_ptr->fileChanged(
705 boost::bind(&InsetExternal::fileChanged, this));
708 if (preview_ptr->monitoring())
709 preview_ptr->stopMonitoring();
710 add_preview_and_start_loading(*preview_ptr, *this, buffer());
718 void InsetExternal::fileChanged() const
720 Buffer const * const buffer = updateFrontend();
724 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
727 ptr->removePreview(*buffer);
728 add_preview_and_start_loading(*ptr, *this, *buffer);
732 void InsetExternal::write(ostream & os) const
734 params_.write(buffer(), os);
738 void InsetExternal::read(Lexer & lex)
740 InsetExternalParams params;
741 if (params.read(buffer(), lex)) {
742 // exception handling is not needed as long as embedded files are in place.
743 params.filename.enable(buffer().embedded(), buffer(), false);
749 int InsetExternal::latex(odocstream & os, OutputParams const & runparams) const
753 os << "\\fbox{\\ttfamily{}"
754 << from_utf8(params_.filename.outputFilename(buffer().filePath()))
759 // "nice" means that the buffer is exported to LaTeX format but not
760 // run through the LaTeX compiler.
761 // If we're running through the LaTeX compiler, we should write the
762 // generated files in the buffer's temporary directory.
763 bool const external_in_tmpdir = !runparams.nice;
764 bool const dryrun = runparams.dryrun || runparams.inComment;
766 // If the template has specified a PDFLaTeX output, then we try and
768 if (runparams.flavor == OutputParams::PDFLATEX) {
769 external::Template const * const et_ptr =
770 external::getTemplatePtr(params_);
773 external::Template const & et = *et_ptr;
775 external::Template::Formats::const_iterator cit =
776 et.formats.find("PDFLaTeX");
778 if (cit != et.formats.end()) {
779 return external::writeExternal(params_, "PDFLaTeX",
781 *(runparams.exportdata),
787 return external::writeExternal(params_, "LaTeX", buffer(), os,
788 *(runparams.exportdata),
794 int InsetExternal::plaintext(odocstream & os,
795 OutputParams const & runparams) const
797 os << '\n'; // output external material on a new line
798 external::writeExternal(params_, "Ascii", buffer(), os,
799 *(runparams.exportdata), false,
800 runparams.dryrun || runparams.inComment);
801 return PLAINTEXT_NEWLINE;
805 int InsetExternal::docbook(odocstream & os,
806 OutputParams const & runparams) const
808 return external::writeExternal(params_, "DocBook", buffer(), os,
809 *(runparams.exportdata), false,
810 runparams.dryrun || runparams.inComment);
814 void InsetExternal::validate(LaTeXFeatures & features) const
819 external::Template const * const et_ptr =
820 external::getTemplatePtr(params_);
823 external::Template const & et = *et_ptr;
826 switch (features.runparams().flavor) {
827 case OutputParams::LATEX:
830 case OutputParams::PDFLATEX:
833 case OutputParams::XML:
837 external::Template::Formats::const_iterator cit =
838 et.formats.find(format);
840 if (cit == et.formats.end()) {
841 // If the template has not specified a PDFLaTeX output,
842 // we try the LaTeX format.
843 if (format == "PDFLaTeX") {
844 cit = et.formats.find("LaTeX");
845 if (cit == et.formats.end())
851 // FIXME: We don't need that always
852 features.require("lyxdot");
854 vector<string>::const_iterator it = cit->second.requirements.begin();
855 vector<string>::const_iterator end = cit->second.requirements.end();
856 for (; it != end; ++it)
857 features.require(*it);
859 external::TemplateManager & etm = external::TemplateManager::get();
861 it = cit->second.preambleNames.begin();
862 end = cit->second.preambleNames.end();
863 for (; it != end; ++it) {
864 string const preamble = etm.getPreambleDefByName(*it);
865 if (!preamble.empty())
866 features.addPreambleSnippet(preamble);
871 void InsetExternal::addPreview(graphics::PreviewLoader & ploader) const
873 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
877 if (isPreviewWanted(params())) {
878 ptr->setAbsFile(params_.filename);
879 docstring const snippet = latexString(*this);
880 ptr->addPreview(snippet, ploader);
885 void InsetExternal::string2params(string const & in, Buffer const & buffer,
886 InsetExternalParams & params)
888 params = InsetExternalParams();
892 istringstream data(in);
898 if (!lex || name != "external") {
899 LYXERR0("InsetExternal::string2params(" << in << ")\n"
900 "Expected arg 1 to be \"external\"\n");
904 // This is part of the inset proper that is usually swallowed
905 // by Text::readInset
908 if (!lex || id != "External") {
909 LYXERR0("InsetExternal::string2params(" << in << ")\n"
910 "Expected arg 2 to be \"External\"\n");
914 params.read(buffer, lex);
918 string InsetExternal::params2string(InsetExternalParams const & params,
919 Buffer const & buffer)
922 data << "external" << ' ';
923 params.write(buffer, data);
924 data << "\\end_inset\n";