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"
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"
33 #include "frontends/alert.h"
35 #include "graphics/PreviewLoader.h"
37 #include "support/debug.h"
38 #include "support/ExceptionMessage.h"
39 #include "support/filetools.h"
40 #include "support/gettext.h"
41 #include "support/lstrings.h"
42 #include "support/lyxlib.h"
43 #include "support/convert.h"
44 #include "support/Translator.h"
46 #include <boost/bind.hpp>
51 using namespace lyx::support;
55 lyx::external::DisplayType const defaultDisplayType = lyx::external::NoDisplay;
57 unsigned int const defaultLyxScale = 100;
59 string defaultTemplateName;
66 namespace Alert = frontend::Alert;
72 FileName const tempname = FileName::tempName("lyxext");
73 // FIXME: This is unsafe
74 tempname.removeFile();
75 // must have an extension for the converter code to work correctly.
76 tempname_ = FileName(tempname.absFilename() + ".tmp");
80 TempName::TempName(TempName const &)
82 tempname_ = TempName()();
88 tempname_.removeFile();
92 TempName & TempName::operator=(TempName const & other)
95 tempname_ = TempName()();
102 /// The translator between the Display enum and corresponding lyx string.
103 Translator<DisplayType, string> const initTranslator()
105 Translator<DisplayType, string> translator(DefaultDisplay, "default");
107 // Fill the display translator
108 translator.addPair(MonochromeDisplay, "monochrome");
109 translator.addPair(GrayscaleDisplay, "grayscale");
110 translator.addPair(ColorDisplay, "color");
111 translator.addPair(PreviewDisplay, "preview");
112 translator.addPair(NoDisplay, "none");
120 Translator<DisplayType, string> const & displayTranslator()
122 static Translator<DisplayType, string> const translator =
127 } // namespace external
130 InsetExternalParams::InsetExternalParams()
131 : display(defaultDisplayType),
132 lyxscale(defaultLyxScale),
135 if (defaultTemplateName.empty()) {
136 external::TemplateManager const & etm =
137 external::TemplateManager::get();
138 templatename_ = etm.getTemplates().begin()->first;
140 templatename_ = defaultTemplateName;
146 template <typename T>
147 void clearIfNotFound(T & data, external::TransformID value,
148 vector<external::TransformID> const & ids)
150 typedef vector<external::TransformID>::const_iterator
153 const_iterator it = ids.begin();
154 const_iterator end = ids.end();
155 it = find(it, end, value);
163 void InsetExternalParams::settemplate(string const & name)
165 templatename_ = name;
167 external::TemplateManager const & etm =
168 external::TemplateManager::get();
169 external::Template const * const et = etm.getTemplateByName(name);
171 // Be safe. Don't lose data.
174 // Ascertain which transforms the template supports.
175 // Empty all those that it doesn't.
176 vector<external::TransformID> const & ids = et->transformIds;
177 clearIfNotFound(clipdata, external::Clip, ids);
178 clearIfNotFound(extradata, external::Extra, ids);
179 clearIfNotFound(resizedata, external::Resize, ids);
180 clearIfNotFound(rotationdata, external::Rotate, ids);
184 void InsetExternalParams::write(Buffer const & buffer, ostream & os) const
187 << "\ttemplate " << templatename() << '\n';
189 if (!filename.empty()) {
190 os << "\tfilename " << filename.outputFilename(buffer.filePath()) << '\n';
191 os << "\tembed " << (filename.embedded() ? filename.inzipName() : "\"\"") << '\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 keyword_item 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, EX_END);
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()
409 : renderer_(new RenderButton)
413 InsetExternal::InsetExternal(InsetExternal const & other)
415 boost::signals::trackable(),
416 params_(other.params_),
417 renderer_(other.renderer_->clone(this))
421 Inset * InsetExternal::clone() const
423 return new InsetExternal(*this);
427 InsetExternal::~InsetExternal()
429 InsetExternalMailer(*this).hideDialog();
433 void InsetExternal::statusChanged() const
439 void InsetExternal::doDispatch(Cursor & cur, FuncRequest & cmd)
441 switch (cmd.action) {
443 case LFUN_EXTERNAL_EDIT: {
444 Buffer const & buffer = cur.buffer();
445 InsetExternalParams p;
446 InsetExternalMailer::string2params(to_utf8(cmd.argument()), buffer, p);
447 external::editExternal(p, buffer);
451 case LFUN_INSET_MODIFY: {
452 Buffer const & buffer = cur.buffer();
453 InsetExternalParams p;
454 InsetExternalMailer::string2params(to_utf8(cmd.argument()), buffer, p);
455 if (!p.filename.empty()) {
457 p.filename.enable(buffer.embedded(), &buffer);
458 } catch (ExceptionMessage const & message) {
459 Alert::error(message.title_, message.details_);
460 // do not set parameter if an error happens
464 setParams(p, buffer);
468 case LFUN_INSET_DIALOG_UPDATE:
469 InsetExternalMailer(*this).updateDialog(&cur.bv());
472 case LFUN_MOUSE_RELEASE:
473 if (!cur.selection())
474 InsetExternalMailer(*this).showDialog(&cur.bv());
478 Inset::doDispatch(cur, cmd);
483 bool InsetExternal::getStatus(Cursor & cur, FuncRequest const & cmd,
484 FuncStatus & flag) const
486 switch (cmd.action) {
488 case LFUN_EXTERNAL_EDIT:
489 case LFUN_INSET_MODIFY:
490 case LFUN_INSET_DIALOG_UPDATE:
495 return Inset::getStatus(cur, cmd, flag);
500 void InsetExternal::registerEmbeddedFiles(Buffer const & buffer,
501 EmbeddedFileList & files) const
503 files.registerFile(params_.filename, this, buffer);
507 void InsetExternal::updateEmbeddedFile(Buffer const & buf,
508 EmbeddedFile const & file)
510 // when embedding is enabled, change of embedding status leads to actions
511 EmbeddedFile temp = file;
512 temp.enable(buf.embedded(), &buf);
513 // this will not be set if an exception is thorwn in enable()
514 params_.filename = temp;
518 void InsetExternal::edit(Cursor & cur, bool, EntryDirection)
520 InsetExternalMailer(*this).showDialog(&cur.bv());
524 void InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const
526 renderer_->metrics(mi, dim);
530 void InsetExternal::draw(PainterInfo & pi, int x, int y) const
532 renderer_->draw(pi, x, y);
545 RenderType getRenderType(InsetExternalParams const & p)
547 if (!external::getTemplatePtr(p) ||
548 p.filename.empty() ||
549 p.display == external::NoDisplay)
552 if (p.display == external::PreviewDisplay) {
553 if (RenderPreview::status() != LyXRC::PREVIEW_OFF)
554 return RENDERPREVIEW;
558 if (p.display == external::DefaultDisplay &&
559 lyxrc.display_graphics == graphics::NoDisplay)
561 return RENDERGRAPHIC;
565 graphics::Params get_grfx_params(InsetExternalParams const & eparams)
567 graphics::Params gparams;
569 gparams.filename = eparams.filename.availableFile();
570 gparams.icon = eparams.filename.embedded() ? "pin.png" : "";
571 gparams.scale = eparams.lyxscale;
572 if (eparams.clipdata.clip)
573 gparams.bb = eparams.clipdata.bbox;
574 gparams.angle = convert<double>(eparams.rotationdata.adjAngle());
576 switch (eparams.display) {
577 case external::DefaultDisplay:
578 gparams.display = graphics::DefaultDisplay;
580 case external::MonochromeDisplay:
581 gparams.display = graphics::MonochromeDisplay;
583 case external::GrayscaleDisplay:
584 gparams.display = graphics::GrayscaleDisplay;
586 case external::ColorDisplay:
587 gparams.display = graphics::ColorDisplay;
589 case external::NoDisplay:
590 gparams.display = graphics::NoDisplay;
595 if (gparams.display == graphics::DefaultDisplay)
596 gparams.display = graphics::DisplayType(lyxrc.display_graphics);
597 // Override the above if we're not using a gui
599 gparams.display = graphics::NoDisplay;
605 docstring const getScreenLabel(InsetExternalParams const & params,
606 Buffer const & buffer)
608 external::Template const * const ptr =
609 external::getTemplatePtr(params);
612 return bformat((_("External template %1$s is not installed")),
613 from_utf8(params.templatename()));
615 docstring gui = _(ptr->guiName);
616 return from_utf8(external::doSubstitution(params, buffer,
617 to_utf8(gui), false));
620 void add_preview_and_start_loading(RenderMonitoredPreview &,
621 InsetExternal const &,
627 InsetExternalParams const & InsetExternal::params() const
633 void InsetExternal::setParams(InsetExternalParams const & p,
634 Buffer const & buffer)
638 // Subsequent calls to the InsetExternal::Params default constructor
640 defaultTemplateName = params_.templatename();
642 switch (getRenderType(params_)) {
644 RenderButton * button_ptr = renderer_->asButton();
646 renderer_.reset(new RenderButton);
647 button_ptr = renderer_->asButton();
650 button_ptr->update(getScreenLabel(params_, buffer), true);
654 case RENDERGRAPHIC: {
655 RenderGraphic * graphic_ptr = renderer_->asGraphic();
657 renderer_.reset(new RenderGraphic(this));
658 graphic_ptr = renderer_->asGraphic();
661 graphic_ptr->update(get_grfx_params(params_));
666 case RENDERPREVIEW: {
667 RenderMonitoredPreview * preview_ptr =
668 renderer_->asMonitoredPreview();
670 renderer_.reset(new RenderMonitoredPreview(this));
671 preview_ptr = renderer_->asMonitoredPreview();
672 preview_ptr->fileChanged(
673 boost::bind(&InsetExternal::fileChanged, this));
676 if (preview_ptr->monitoring())
677 preview_ptr->stopMonitoring();
678 add_preview_and_start_loading(*preview_ptr, *this, buffer);
686 void InsetExternal::fileChanged() const
688 Buffer const * const buffer = updateFrontend();
692 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
695 ptr->removePreview(*buffer);
696 add_preview_and_start_loading(*ptr, *this, *buffer);
700 void InsetExternal::write(Buffer const & buffer, ostream & os) const
702 params_.write(buffer, os);
706 void InsetExternal::read(Buffer const & buffer, Lexer & lex)
708 InsetExternalParams params;
709 if (params.read(buffer, lex)) {
710 // exception handling is not needed as long as embedded files are in place.
711 params.filename.enable(buffer.embedded(), & buffer);
712 setParams(params, buffer);
717 int InsetExternal::latex(Buffer const & buf, odocstream & os,
718 OutputParams const & runparams) const
722 os << "\\fbox{\\ttfamily{}"
723 << from_utf8(params_.filename.outputFilename(buf.filePath()))
728 // "nice" means that the buffer is exported to LaTeX format but not
729 // run through the LaTeX compiler.
730 // If we're running through the LaTeX compiler, we should write the
731 // generated files in the buffer's temporary directory.
732 bool const external_in_tmpdir = !runparams.nice;
733 bool const dryrun = runparams.dryrun || runparams.inComment;
735 // If the template has specified a PDFLaTeX output, then we try and
737 if (runparams.flavor == OutputParams::PDFLATEX) {
738 external::Template const * const et_ptr =
739 external::getTemplatePtr(params_);
742 external::Template const & et = *et_ptr;
744 external::Template::Formats::const_iterator cit =
745 et.formats.find("PDFLaTeX");
747 if (cit != et.formats.end()) {
748 return external::writeExternal(params_, "PDFLaTeX",
750 *(runparams.exportdata),
756 return external::writeExternal(params_, "LaTeX", buf, os,
757 *(runparams.exportdata),
763 int InsetExternal::plaintext(Buffer const & buf, odocstream & os,
764 OutputParams const & runparams) const
766 os << '\n'; // output external material on a new line
767 external::writeExternal(params_, "Ascii", buf, os,
768 *(runparams.exportdata), false,
769 runparams.dryrun || runparams.inComment);
770 return PLAINTEXT_NEWLINE;
774 int InsetExternal::docbook(Buffer const & buf, odocstream & os,
775 OutputParams const & runparams) const
777 return external::writeExternal(params_, "DocBook", buf, os,
778 *(runparams.exportdata), false,
779 runparams.dryrun || runparams.inComment);
783 void InsetExternal::validate(LaTeXFeatures & features) const
788 external::Template const * const et_ptr =
789 external::getTemplatePtr(params_);
792 external::Template const & et = *et_ptr;
795 switch (features.runparams().flavor) {
796 case OutputParams::LATEX:
799 case OutputParams::PDFLATEX:
802 case OutputParams::XML:
806 external::Template::Formats::const_iterator cit =
807 et.formats.find(format);
808 if (cit == et.formats.end())
811 // FIXME: We don't need that always
812 features.require("lyxdot");
814 vector<string>::const_iterator it = cit->second.requirements.begin();
815 vector<string>::const_iterator end = cit->second.requirements.end();
816 for (; it != end; ++it)
817 features.require(*it);
819 external::TemplateManager & etm = external::TemplateManager::get();
821 it = cit->second.preambleNames.begin();
822 end = cit->second.preambleNames.end();
823 for (; it != end; ++it) {
824 string const preamble = etm.getPreambleDefByName(*it);
825 if (!preamble.empty())
826 features.addPreambleSnippet(preamble);
837 bool preview_wanted(InsetExternalParams const & params)
839 return params.display == external::PreviewDisplay &&
840 params.filename.isReadableFile();
844 docstring const latex_string(InsetExternal const & inset, Buffer const & buffer)
847 // We don't need to set runparams.encoding since it is not used by
849 OutputParams runparams(0);
850 runparams.flavor = OutputParams::LATEX;
851 inset.latex(buffer, os, runparams);
856 void add_preview_and_start_loading(RenderMonitoredPreview & renderer,
857 InsetExternal const & inset,
858 Buffer const & buffer)
860 InsetExternalParams const & params = inset.params();
862 if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
863 preview_wanted(params)) {
864 renderer.setAbsFile(params.filename);
865 docstring const snippet = latex_string(inset, buffer);
866 renderer.addPreview(snippet, buffer);
867 renderer.startLoading(buffer);
874 void InsetExternal::addPreview(graphics::PreviewLoader & ploader) const
876 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
880 if (preview_wanted(params())) {
881 ptr->setAbsFile(params_.filename);
882 docstring const snippet = latex_string(*this, ploader.buffer());
883 ptr->addPreview(snippet, ploader);
890 string const InsetExternalMailer::name_("external");
892 InsetExternalMailer::InsetExternalMailer(InsetExternal & inset)
897 string const InsetExternalMailer::inset2string(Buffer const & buffer) const
899 return params2string(inset_.params(), buffer);
903 void InsetExternalMailer::string2params(string const & in,
904 Buffer const & buffer,
905 InsetExternalParams & params)
907 params = InsetExternalParams();
911 istringstream data(in);
917 if (!lex || name != name_)
918 return print_mailer_error("InsetExternalMailer", in, 1, name_);
920 // This is part of the inset proper that is usually swallowed
921 // by Text::readInset
924 if (!lex || id != "External")
925 return print_mailer_error("InsetBoxMailer", in, 2, "External");
927 params.read(buffer, lex);
932 InsetExternalMailer::params2string(InsetExternalParams const & params,
933 Buffer const & buffer)
936 data << name_ << ' ';
937 params.write(buffer, data);
938 data << "\\end_inset\n";