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 "graphics/PreviewLoader.h"
35 #include "support/debug.h"
36 #include "support/filetools.h"
37 #include "support/gettext.h"
38 #include "support/lstrings.h"
39 #include "support/lyxlib.h"
40 #include "support/convert.h"
41 #include "support/Translator.h"
43 #include <boost/bind.hpp>
48 using namespace lyx::support;
52 lyx::external::DisplayType const defaultDisplayType = lyx::external::NoDisplay;
54 unsigned int const defaultLyxScale = 100;
56 string defaultTemplateName;
67 FileName const tempname = FileName::tempName("lyxext");
68 // FIXME: This is unsafe
69 tempname.removeFile();
70 // must have an extension for the converter code to work correctly.
71 tempname_ = FileName(tempname.absFilename() + ".tmp");
75 TempName::TempName(TempName const &)
77 tempname_ = TempName()();
83 tempname_.removeFile();
87 TempName & TempName::operator=(TempName const & other)
90 tempname_ = TempName()();
97 /// The translator between the Display enum and corresponding lyx string.
98 Translator<DisplayType, string> const initTranslator()
100 Translator<DisplayType, string> translator(DefaultDisplay, "default");
102 // Fill the display translator
103 translator.addPair(MonochromeDisplay, "monochrome");
104 translator.addPair(GrayscaleDisplay, "grayscale");
105 translator.addPair(ColorDisplay, "color");
106 translator.addPair(PreviewDisplay, "preview");
107 translator.addPair(NoDisplay, "none");
115 Translator<DisplayType, string> const & displayTranslator()
117 static Translator<DisplayType, string> const translator =
122 } // namespace external
125 InsetExternalParams::InsetExternalParams()
126 : display(defaultDisplayType),
127 lyxscale(defaultLyxScale),
130 if (defaultTemplateName.empty()) {
131 external::TemplateManager const & etm =
132 external::TemplateManager::get();
133 templatename_ = etm.getTemplates().begin()->first;
135 templatename_ = defaultTemplateName;
141 template <typename T>
142 void clearIfNotFound(T & data, external::TransformID value,
143 vector<external::TransformID> const & ids)
145 typedef vector<external::TransformID>::const_iterator
148 const_iterator it = ids.begin();
149 const_iterator end = ids.end();
150 it = find(it, end, value);
158 void InsetExternalParams::settemplate(string const & name)
160 templatename_ = name;
162 external::TemplateManager const & etm =
163 external::TemplateManager::get();
164 external::Template const * const et = etm.getTemplateByName(name);
166 // Be safe. Don't lose data.
169 // Ascertain which transforms the template supports.
170 // Empty all those that it doesn't.
171 vector<external::TransformID> const & ids = et->transformIds;
172 clearIfNotFound(clipdata, external::Clip, ids);
173 clearIfNotFound(extradata, external::Extra, ids);
174 clearIfNotFound(resizedata, external::Resize, ids);
175 clearIfNotFound(rotationdata, external::Rotate, ids);
179 void InsetExternalParams::write(Buffer const & buf, ostream & os) const
182 << "\ttemplate " << templatename() << '\n';
184 if (!filename.empty()) {
185 os << "\tfilename " << filename.outputFilename(buf.filePath()) << '\n';
186 os << "\tembed " << (filename.embedded() ? filename.inzipName() : "\"\"") << '\n';
188 if (display != defaultDisplayType)
190 << external::displayTranslator().find(display)
193 if (lyxscale != defaultLyxScale)
194 os << "\tlyxscale " << convert<string>(lyxscale) << '\n';
199 if (!clipdata.bbox.empty())
200 os << "\tboundingBox " << clipdata.bbox << '\n';
204 external::ExtraData::const_iterator it = extradata.begin();
205 external::ExtraData::const_iterator end = extradata.end();
206 for (; it != end; ++it) {
207 if (!it->second.empty())
208 os << "\textra " << it->first << " \""
209 << it->second << "\"\n";
212 if (!rotationdata.no_rotation()) {
213 os << "\trotateAngle " << rotationdata.adjAngle() << '\n';
214 if (rotationdata.origin() != external::RotationData::DEFAULT)
215 os << "\trotateOrigin "
216 << rotationdata.originString() << '\n';
219 if (!resizedata.no_resize()) {
220 double const scl = convert<double>(resizedata.scale);
221 if (!float_equal(scl, 0.0, 0.05)) {
222 if (!float_equal(scl, 100.0, 0.05))
224 << resizedata.scale << '\n';
226 if (!resizedata.width.zero())
228 << resizedata.width.asString() << '\n';
229 if (!resizedata.height.zero())
231 << resizedata.height.asString() << '\n';
233 if (resizedata.keepAspectRatio)
234 os << "\tkeepAspectRatio\n";
239 bool InsetExternalParams::read(Buffer const & buffer, Lexer & lex)
260 keyword_item external_tags[] = {
261 { "\\end_inset", EX_END },
262 { "boundingBox", EX_BOUNDINGBOX },
264 { "display", EX_DISPLAY},
265 { "draft", EX_DRAFT},
266 { "embed", EX_EMBED},
267 { "extra", EX_EXTRA },
268 { "filename", EX_FILENAME},
269 { "height", EX_HEIGHT },
270 { "keepAspectRatio", EX_KEEPASPECTRATIO },
271 { "lyxscale", EX_LYXSCALE},
272 { "rotateAngle", EX_ROTATEANGLE },
273 { "rotateOrigin", EX_ROTATEORIGIN },
274 { "scale", EX_SCALE },
275 { "template", EX_TEMPLATE },
276 { "width", EX_WIDTH }
279 PushPopHelper pph(lex, external_tags, EX_END);
281 bool found_end = false;
282 bool read_error = false;
288 templatename_ = lex.getString();
293 string const name = lex.getString();
294 filename.set(name, buffer.filePath());
300 string const name = lex.getString();
301 filename.setInzipName(name);
302 filename.setEmbed(!name.empty());
308 string const name = lex.getString();
309 display = external::displayTranslator().find(name);
315 lyxscale = lex.getInteger();
324 clipdata.bbox.xl = lex.getInteger();
326 clipdata.bbox.yb = lex.getInteger();
328 clipdata.bbox.xr = lex.getInteger();
330 clipdata.bbox.yt = lex.getInteger();
334 clipdata.clip = true;
339 string const name = lex.getString();
341 extradata.set(name, lex.getString());
347 resizedata.height = Length(lex.getString());
350 case EX_KEEPASPECTRATIO:
351 resizedata.keepAspectRatio = true;
356 rotationdata.angle = lex.getString();
359 case EX_ROTATEORIGIN:
361 rotationdata.origin(lex.getString());
366 resizedata.scale = lex.getString();
371 resizedata.width = Length(lex.getString());
379 lex.printError("ExternalInset::read: Wrong tag: $$Token");
384 if (found_end || read_error)
389 lex.printError("ExternalInsetParams::read: Missing \\end_inset.");
391 // This is a trick to make sure that the data are self-consistent.
392 settemplate(templatename_);
394 if (lyxerr.debugging(Debug::EXTERNAL)) {
395 lyxerr << "InsetExternalParams::read:\n";
396 write(buffer, lyxerr);
403 InsetExternal::InsetExternal()
404 : renderer_(new RenderButton)
408 InsetExternal::InsetExternal(InsetExternal const & other)
410 boost::signals::trackable(),
411 params_(other.params_),
412 renderer_(other.renderer_->clone(this))
416 InsetExternal::~InsetExternal()
418 InsetExternalMailer(*this).hideDialog();
422 void InsetExternal::statusChanged() const
428 void InsetExternal::doDispatch(Cursor & cur, FuncRequest & cmd)
430 switch (cmd.action) {
432 case LFUN_EXTERNAL_EDIT: {
433 InsetExternalParams p;
434 InsetExternalMailer::string2params(to_utf8(cmd.argument()), buffer(), p);
435 external::editExternal(p, buffer());
439 case LFUN_INSET_MODIFY: {
440 InsetExternalParams p;
441 InsetExternalMailer::string2params(to_utf8(cmd.argument()), buffer(), p);
446 case LFUN_INSET_DIALOG_UPDATE:
447 InsetExternalMailer(*this).updateDialog(&cur.bv());
450 case LFUN_MOUSE_RELEASE:
451 if (!cur.selection())
452 InsetExternalMailer(*this).showDialog(&cur.bv());
456 Inset::doDispatch(cur, cmd);
461 bool InsetExternal::getStatus(Cursor & cur, FuncRequest const & cmd,
462 FuncStatus & flag) const
464 switch (cmd.action) {
466 case LFUN_EXTERNAL_EDIT:
467 case LFUN_INSET_MODIFY:
468 case LFUN_INSET_DIALOG_UPDATE:
473 return Inset::getStatus(cur, cmd, flag);
478 void InsetExternal::registerEmbeddedFiles(EmbeddedFileList & files) const
480 files.registerFile(params_.filename, this, buffer());
484 void InsetExternal::updateEmbeddedFile(EmbeddedFile const & file)
486 params_.filename = file;
490 void InsetExternal::edit(Cursor & cur, bool, EntryDirection)
492 InsetExternalMailer(*this).showDialog(&cur.bv());
496 void InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const
498 renderer_->metrics(mi, dim);
502 void InsetExternal::draw(PainterInfo & pi, int x, int y) const
504 renderer_->draw(pi, x, y);
517 RenderType getRenderType(InsetExternalParams const & p)
519 if (!external::getTemplatePtr(p) ||
520 p.filename.empty() ||
521 p.display == external::NoDisplay)
524 if (p.display == external::PreviewDisplay) {
525 if (RenderPreview::status() != LyXRC::PREVIEW_OFF)
526 return RENDERPREVIEW;
530 if (p.display == external::DefaultDisplay &&
531 lyxrc.display_graphics == graphics::NoDisplay)
533 return RENDERGRAPHIC;
537 graphics::Params get_grfx_params(InsetExternalParams const & eparams)
539 graphics::Params gparams;
541 gparams.filename = eparams.filename.availableFile();
542 gparams.icon = eparams.filename.embedded() ? "pin.png" : "";
543 gparams.scale = eparams.lyxscale;
544 if (eparams.clipdata.clip)
545 gparams.bb = eparams.clipdata.bbox;
546 gparams.angle = convert<double>(eparams.rotationdata.adjAngle());
548 switch (eparams.display) {
549 case external::DefaultDisplay:
550 gparams.display = graphics::DefaultDisplay;
552 case external::MonochromeDisplay:
553 gparams.display = graphics::MonochromeDisplay;
555 case external::GrayscaleDisplay:
556 gparams.display = graphics::GrayscaleDisplay;
558 case external::ColorDisplay:
559 gparams.display = graphics::ColorDisplay;
561 case external::NoDisplay:
562 gparams.display = graphics::NoDisplay;
567 if (gparams.display == graphics::DefaultDisplay)
568 gparams.display = graphics::DisplayType(lyxrc.display_graphics);
569 // Override the above if we're not using a gui
571 gparams.display = graphics::NoDisplay;
577 docstring screenLabel(InsetExternalParams const & params,
578 Buffer const & buffer)
580 external::Template const * const ptr =
581 external::getTemplatePtr(params);
584 return bformat((_("External template %1$s is not installed")),
585 from_utf8(params.templatename()));
587 docstring gui = _(ptr->guiName);
588 return from_utf8(external::doSubstitution(params, buffer,
589 to_utf8(gui), false));
595 static bool isPreviewWanted(InsetExternalParams const & params)
597 return params.display == external::PreviewDisplay &&
598 params.filename.isReadableFile();
602 static docstring latexString(InsetExternal const & inset)
605 // We don't need to set runparams.encoding since it is not used by
607 OutputParams runparams(0);
608 runparams.flavor = OutputParams::LATEX;
609 inset.latex(os, runparams);
614 static void add_preview_and_start_loading(RenderMonitoredPreview & renderer,
615 InsetExternal const & inset,
616 Buffer const & buffer)
618 InsetExternalParams const & params = inset.params();
620 if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
621 isPreviewWanted(params)) {
622 renderer.setAbsFile(params.filename);
623 docstring const snippet = latexString(inset);
624 renderer.addPreview(snippet, buffer);
625 renderer.startLoading(buffer);
630 InsetExternalParams const & InsetExternal::params() const
636 void InsetExternal::setParams(InsetExternalParams const & p)
640 // Subsequent calls to the InsetExternal::Params default constructor
642 defaultTemplateName = params_.templatename();
644 switch (getRenderType(params_)) {
646 RenderButton * button_ptr = renderer_->asButton();
648 renderer_.reset(new RenderButton);
649 button_ptr = renderer_->asButton();
652 button_ptr->update(screenLabel(params_, buffer()), true);
656 case RENDERGRAPHIC: {
657 RenderGraphic * graphic_ptr = renderer_->asGraphic();
659 renderer_.reset(new RenderGraphic(this));
660 graphic_ptr = renderer_->asGraphic();
663 graphic_ptr->update(get_grfx_params(params_));
668 case RENDERPREVIEW: {
669 RenderMonitoredPreview * preview_ptr =
670 renderer_->asMonitoredPreview();
672 renderer_.reset(new RenderMonitoredPreview(this));
673 preview_ptr = renderer_->asMonitoredPreview();
674 preview_ptr->fileChanged(
675 boost::bind(&InsetExternal::fileChanged, this));
678 if (preview_ptr->monitoring())
679 preview_ptr->stopMonitoring();
680 add_preview_and_start_loading(*preview_ptr, *this, buffer());
688 void InsetExternal::fileChanged() const
690 Buffer const * const buffer = updateFrontend();
694 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
697 ptr->removePreview(*buffer);
698 add_preview_and_start_loading(*ptr, *this, *buffer);
702 void InsetExternal::write(ostream & os) const
704 params_.write(buffer(), os);
708 void InsetExternal::read(Lexer & lex)
710 InsetExternalParams params;
711 if (params.read(buffer(), lex)) {
712 // exception handling is not needed as long as embedded files are in place.
713 params.filename.enable(buffer().embedded(), &buffer(), false);
719 int InsetExternal::latex(odocstream & os, OutputParams const & runparams) const
723 os << "\\fbox{\\ttfamily{}"
724 << from_utf8(params_.filename.outputFilename(buffer().filePath()))
729 // "nice" means that the buffer is exported to LaTeX format but not
730 // run through the LaTeX compiler.
731 // If we're running through the LaTeX compiler, we should write the
732 // generated files in the buffer's temporary directory.
733 bool const external_in_tmpdir = !runparams.nice;
734 bool const dryrun = runparams.dryrun || runparams.inComment;
736 // If the template has specified a PDFLaTeX output, then we try and
738 if (runparams.flavor == OutputParams::PDFLATEX) {
739 external::Template const * const et_ptr =
740 external::getTemplatePtr(params_);
743 external::Template const & et = *et_ptr;
745 external::Template::Formats::const_iterator cit =
746 et.formats.find("PDFLaTeX");
748 if (cit != et.formats.end()) {
749 return external::writeExternal(params_, "PDFLaTeX",
751 *(runparams.exportdata),
757 return external::writeExternal(params_, "LaTeX", buffer(), os,
758 *(runparams.exportdata),
764 int InsetExternal::plaintext(odocstream & os,
765 OutputParams const & runparams) const
767 os << '\n'; // output external material on a new line
768 external::writeExternal(params_, "Ascii", buffer(), os,
769 *(runparams.exportdata), false,
770 runparams.dryrun || runparams.inComment);
771 return PLAINTEXT_NEWLINE;
775 int InsetExternal::docbook(odocstream & os,
776 OutputParams const & runparams) const
778 return external::writeExternal(params_, "DocBook", buffer(), os,
779 *(runparams.exportdata), false,
780 runparams.dryrun || runparams.inComment);
784 void InsetExternal::validate(LaTeXFeatures & features) const
789 external::Template const * const et_ptr =
790 external::getTemplatePtr(params_);
793 external::Template const & et = *et_ptr;
796 switch (features.runparams().flavor) {
797 case OutputParams::LATEX:
800 case OutputParams::PDFLATEX:
803 case OutputParams::XML:
807 external::Template::Formats::const_iterator cit =
808 et.formats.find(format);
809 if (cit == et.formats.end())
812 // FIXME: We don't need that always
813 features.require("lyxdot");
815 vector<string>::const_iterator it = cit->second.requirements.begin();
816 vector<string>::const_iterator end = cit->second.requirements.end();
817 for (; it != end; ++it)
818 features.require(*it);
820 external::TemplateManager & etm = external::TemplateManager::get();
822 it = cit->second.preambleNames.begin();
823 end = cit->second.preambleNames.end();
824 for (; it != end; ++it) {
825 string const preamble = etm.getPreambleDefByName(*it);
826 if (!preamble.empty())
827 features.addPreambleSnippet(preamble);
836 void InsetExternal::addPreview(graphics::PreviewLoader & ploader) const
838 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
842 if (isPreviewWanted(params())) {
843 ptr->setAbsFile(params_.filename);
844 docstring const snippet = latexString(*this);
845 ptr->addPreview(snippet, ploader);
852 string const InsetExternalMailer::name_("external");
854 InsetExternalMailer::InsetExternalMailer(InsetExternal & inset)
859 string const InsetExternalMailer::inset2string(Buffer const & buffer) const
861 return params2string(inset_.params(), buffer);
865 void InsetExternalMailer::string2params(string const & in,
866 Buffer const & buffer,
867 InsetExternalParams & params)
869 params = InsetExternalParams();
873 istringstream data(in);
879 if (!lex || name != name_)
880 return print_mailer_error("InsetExternalMailer", in, 1, name_);
882 // This is part of the inset proper that is usually swallowed
883 // by Text::readInset
886 if (!lex || id != "External")
887 return print_mailer_error("InsetBoxMailer", in, 2, "External");
889 params.read(buffer, lex);
894 InsetExternalMailer::params2string(InsetExternalParams const & params,
895 Buffer const & buffer)
898 data << name_ << ' ';
899 params.write(buffer, data);
900 data << "\\end_inset\n";