2 * \file insetexternal.C
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/render_button.h"
17 #include "insets/render_graphic.h"
18 #include "insets/render_preview.h"
23 #include "dispatchresult.h"
25 #include "FuncStatus.h"
26 #include "funcrequest.h"
28 #include "LaTeXFeatures.h"
32 #include "metricsinfo.h"
33 #include "outputparams.h"
35 #include "graphics/PreviewLoader.h"
37 #include "support/filetools.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>
47 namespace support = lyx::support;
48 namespace external = lyx::external;
49 namespace graphics = lyx::graphics;
55 using std::istringstream;
57 using std::ostringstream;
66 external::DisplayType const defaultDisplayType = external::NoDisplay;
68 unsigned int const defaultLyxScale = 100;
70 string defaultTemplateName = "RasterImage";
80 tempname_ = support::tempName(string(), "lyxext");
81 // FIXME: This is unsafe
82 support::unlink(tempname_);
83 // must have an extension for the converter code to work correctly.
88 TempName::TempName(TempName const &)
90 tempname_ = TempName()();
96 support::unlink(tempname_);
101 TempName::operator=(TempName const & other)
104 tempname_ = TempName()();
111 /// The translator between the Display enum and corresponding lyx string.
112 Translator<DisplayType, string> const initTranslator()
114 Translator<DisplayType, string> translator(DefaultDisplay, "default");
116 // Fill the display translator
117 translator.addPair(MonochromeDisplay, "monochrome");
118 translator.addPair(GrayscaleDisplay, "grayscale");
119 translator.addPair(ColorDisplay, "color");
120 translator.addPair(PreviewDisplay, "preview");
121 translator.addPair(NoDisplay, "none");
129 Translator<DisplayType, string> const & displayTranslator()
131 static Translator<DisplayType, string> const translator =
136 } // namespace external
140 InsetExternalParams::InsetExternalParams()
141 : display(defaultDisplayType),
142 lyxscale(defaultLyxScale),
144 templatename_(defaultTemplateName)
150 template <typename T>
151 void clearIfNotFound(T & data, external::TransformID value,
152 vector<external::TransformID> const & ids)
154 typedef vector<external::TransformID>::const_iterator
157 const_iterator it = ids.begin();
158 const_iterator end = ids.end();
159 it = std::find(it, end, value);
167 void InsetExternalParams::settemplate(string const & name)
169 templatename_ = name;
171 external::TemplateManager const & etm =
172 external::TemplateManager::get();
173 external::Template const * const et = etm.getTemplateByName(name);
175 // Be safe. Don't lose data.
178 // Ascertain which transforms the template supports.
179 // Empty all those that it doesn't.
180 vector<external::TransformID> const & ids = et->transformIds;
181 clearIfNotFound(clipdata, external::Clip, ids);
182 clearIfNotFound(extradata, external::Extra, ids);
183 clearIfNotFound(resizedata, external::Resize, ids);
184 clearIfNotFound(rotationdata, external::Rotate, ids);
188 void InsetExternalParams::write(Buffer const & buffer, ostream & os) const
191 << "\ttemplate " << templatename() << '\n';
193 if (!filename.empty())
195 << filename.outputFilename(buffer.filePath())
198 if (display != defaultDisplayType)
200 << external::displayTranslator().find(display)
203 if (lyxscale != defaultLyxScale)
204 os << "\tlyxscale " << convert<string>(lyxscale) << '\n';
209 if (!clipdata.bbox.empty())
210 os << "\tboundingBox " << clipdata.bbox << '\n';
214 external::ExtraData::const_iterator it = extradata.begin();
215 external::ExtraData::const_iterator end = extradata.end();
216 for (; it != end; ++it) {
217 if (!it->second.empty())
218 os << "\textra " << it->first << " \""
219 << it->second << "\"\n";
222 if (!rotationdata.no_rotation()) {
223 os << "\trotateAngle " << rotationdata.adjAngle() << '\n';
224 if (rotationdata.origin() != external::RotationData::DEFAULT)
225 os << "\trotateOrigin "
226 << rotationdata.originString() << '\n';
229 if (!resizedata.no_resize()) {
230 using support::float_equal;
231 double const scl = convert<double>(resizedata.scale);
232 if (!float_equal(scl, 0.0, 0.05)) {
233 if (!float_equal(scl, 100.0, 0.05))
235 << resizedata.scale << '\n';
237 if (!resizedata.width.zero())
239 << resizedata.width.asString() << '\n';
240 if (!resizedata.height.zero())
242 << resizedata.height.asString() << '\n';
244 if (resizedata.keepAspectRatio)
245 os << "\tkeepAspectRatio\n";
250 bool InsetExternalParams::read(Buffer const & buffer, LyXLex & lex)
270 keyword_item external_tags[] = {
271 { "\\end_inset", EX_END },
272 { "boundingBox", EX_BOUNDINGBOX },
274 { "display", EX_DISPLAY},
275 { "draft", EX_DRAFT},
276 { "extra", EX_EXTRA },
277 { "filename", EX_FILENAME},
278 { "height", EX_HEIGHT },
279 { "keepAspectRatio", EX_KEEPASPECTRATIO },
280 { "lyxscale", EX_LYXSCALE},
281 { "rotateAngle", EX_ROTATEANGLE },
282 { "rotateOrigin", EX_ROTATEORIGIN },
283 { "scale", EX_SCALE },
284 { "template", EX_TEMPLATE },
285 { "width", EX_WIDTH }
288 pushpophelper pph(lex, external_tags, EX_END);
290 bool found_end = false;
291 bool read_error = false;
297 templatename_ = lex.getString();
302 string const name = lex.getString();
303 filename.set(name, buffer.filePath());
309 string const name = lex.getString();
310 display = external::displayTranslator().find(name);
316 lyxscale = lex.getInteger();
325 clipdata.bbox.xl = lex.getInteger();
327 clipdata.bbox.yb = lex.getInteger();
329 clipdata.bbox.xr = lex.getInteger();
331 clipdata.bbox.yt = lex.getInteger();
335 clipdata.clip = true;
340 string const name = lex.getString();
342 extradata.set(name, lex.getString());
348 resizedata.height = LyXLength(lex.getString());
351 case EX_KEEPASPECTRATIO:
352 resizedata.keepAspectRatio = true;
357 rotationdata.angle = lex.getString();
360 case EX_ROTATEORIGIN:
362 rotationdata.origin(lex.getString());
367 resizedata.scale = lex.getString();
372 resizedata.width = LyXLength(lex.getString());
380 lex.printError("ExternalInset::read: "
381 "Wrong tag: $$Token");
386 if (found_end || read_error)
391 lex.printError("ExternalInsetParams::read: Missing \\end_inset.");
393 // This is a trick to make sure that the data are self-consistent.
394 settemplate(templatename_);
396 if (lyxerr.debugging(Debug::EXTERNAL)) {
397 lyxerr << "InsetExternalParams::read:\n";
398 write(buffer, lyxerr);
405 InsetExternal::InsetExternal()
406 : renderer_(new RenderButton)
410 InsetExternal::InsetExternal(InsetExternal const & other)
412 boost::signals::trackable(),
413 params_(other.params_),
414 renderer_(other.renderer_->clone(this))
418 auto_ptr<InsetBase> InsetExternal::doClone() const
420 return auto_ptr<InsetBase>(new InsetExternal(*this));
424 InsetExternal::~InsetExternal()
426 InsetExternalMailer(*this).hideDialog();
430 void InsetExternal::statusChanged() const
432 LyX::cref().updateInset(this);
436 void InsetExternal::doDispatch(LCursor & cur, FuncRequest & cmd)
438 switch (cmd.action) {
440 case LFUN_EXTERNAL_EDIT: {
441 Buffer const & buffer = cur.buffer();
442 InsetExternalParams p;
443 InsetExternalMailer::string2params(lyx::to_utf8(cmd.argument()), buffer, p);
444 external::editExternal(p, buffer);
448 case LFUN_INSET_MODIFY: {
449 Buffer const & buffer = cur.buffer();
450 InsetExternalParams p;
451 InsetExternalMailer::string2params(lyx::to_utf8(cmd.argument()), buffer, p);
452 setParams(p, buffer);
456 case LFUN_INSET_DIALOG_UPDATE:
457 InsetExternalMailer(*this).updateDialog(&cur.bv());
460 case LFUN_MOUSE_RELEASE:
461 InsetExternalMailer(*this).showDialog(&cur.bv());
465 InsetBase::doDispatch(cur, cmd);
470 bool InsetExternal::getStatus(LCursor & cur, FuncRequest const & cmd,
471 FuncStatus & flag) const
473 switch (cmd.action) {
475 case LFUN_EXTERNAL_EDIT:
476 case LFUN_INSET_MODIFY:
477 case LFUN_INSET_DIALOG_UPDATE:
482 return InsetBase::getStatus(cur, cmd, flag);
487 void InsetExternal::edit(LCursor & cur, bool)
489 InsetExternalMailer(*this).showDialog(&cur.bv());
493 void InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const
495 renderer_->metrics(mi, dim);
500 void InsetExternal::draw(PainterInfo & pi, int x, int y) const
502 setPosCache(pi, x, y);
503 renderer_->draw(pi, x, y);
516 RenderType getRenderType(InsetExternalParams const & p)
518 if (!external::getTemplatePtr(p) ||
519 p.filename.empty() ||
520 p.display == external::NoDisplay)
523 if (p.display == external::PreviewDisplay) {
524 if (RenderPreview::status() != LyXRC::PREVIEW_OFF)
525 return RENDERPREVIEW;
529 if (p.display == external::DefaultDisplay &&
530 lyxrc.display_graphics == graphics::NoDisplay)
532 return RENDERGRAPHIC;
536 graphics::Params get_grfx_params(InsetExternalParams const & eparams)
538 graphics::Params gparams;
540 gparams.filename = eparams.filename.absFilename();
541 gparams.scale = eparams.lyxscale;
542 if (eparams.clipdata.clip)
543 gparams.bb = eparams.clipdata.bbox;
544 gparams.angle = convert<double>(eparams.rotationdata.adjAngle());
546 switch (eparams.display) {
547 case external::DefaultDisplay:
548 gparams.display = graphics::DefaultDisplay;
550 case external::MonochromeDisplay:
551 gparams.display = graphics::MonochromeDisplay;
553 case external::GrayscaleDisplay:
554 gparams.display = graphics::GrayscaleDisplay;
556 case external::ColorDisplay:
557 gparams.display = graphics::ColorDisplay;
559 case external::NoDisplay:
560 gparams.display = graphics::NoDisplay;
565 if (gparams.display == graphics::DefaultDisplay)
566 gparams.display = lyxrc.display_graphics;
567 // Override the above if we're not using a gui
569 gparams.display = graphics::NoDisplay;
575 docstring const getScreenLabel(InsetExternalParams const & params,
576 Buffer const & buffer)
578 external::Template const * const ptr =
579 external::getTemplatePtr(params);
582 return support::bformat((_("External template %1$s is not installed")),
583 lyx::from_utf8(params.templatename()));
585 return lyx::from_utf8(external::doSubstitution(params, buffer,
586 ptr->guiName, false));
589 void add_preview_and_start_loading(RenderMonitoredPreview &,
590 InsetExternal const &,
596 InsetExternalParams const & InsetExternal::params() const
602 void InsetExternal::setParams(InsetExternalParams const & p,
603 Buffer const & buffer)
607 // Subsequent calls to the InsetExternal::Params default constructor
609 defaultTemplateName = params_.templatename();
611 switch (getRenderType(params_)) {
613 RenderButton * button_ptr = renderer_->asButton();
615 renderer_.reset(new RenderButton);
616 button_ptr = renderer_->asButton();
619 button_ptr->update(getScreenLabel(params_, buffer), true);
622 } case RENDERGRAPHIC: {
623 RenderGraphic * graphic_ptr = renderer_->asGraphic();
625 renderer_.reset(new RenderGraphic(this));
626 graphic_ptr = renderer_->asGraphic();
629 graphic_ptr->update(get_grfx_params(params_));
633 } case RENDERPREVIEW: {
634 RenderMonitoredPreview * preview_ptr =
635 renderer_->asMonitoredPreview();
637 renderer_.reset(new RenderMonitoredPreview(this));
638 preview_ptr = renderer_->asMonitoredPreview();
639 preview_ptr->fileChanged(
640 boost::bind(&InsetExternal::fileChanged, this));
643 if (preview_ptr->monitoring())
644 preview_ptr->stopMonitoring();
645 add_preview_and_start_loading(*preview_ptr, *this, buffer);
653 void InsetExternal::fileChanged() const
655 Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
659 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
662 Buffer const & buffer = *buffer_ptr;
663 ptr->removePreview(buffer);
664 add_preview_and_start_loading(*ptr, *this, buffer);
668 void InsetExternal::write(Buffer const & buffer, ostream & os) const
670 params_.write(buffer, os);
674 void InsetExternal::read(Buffer const & buffer, LyXLex & lex)
676 InsetExternalParams params;
677 if (params.read(buffer, lex))
678 setParams(params, buffer);
682 int InsetExternal::latex(Buffer const & buf, ostream & os,
683 OutputParams const & runparams) const
686 os << "\\fbox{\\ttfamily{}"
687 << params_.filename.outputFilename(buf.filePath())
692 // "nice" means that the buffer is exported to LaTeX format but not
693 // run through the LaTeX compiler.
694 // If we're running through the LaTeX compiler, we should write the
695 // generated files in the bufer's temporary directory.
696 bool const external_in_tmpdir = !runparams.nice && !runparams.dryrun;
698 // If the template has specified a PDFLaTeX output, then we try and
700 if (runparams.flavor == OutputParams::PDFLATEX) {
701 external::Template const * const et_ptr =
702 external::getTemplatePtr(params_);
705 external::Template const & et = *et_ptr;
707 external::Template::Formats::const_iterator cit =
708 et.formats.find("PDFLaTeX");
709 if (cit != et.formats.end())
710 return external::writeExternal(params_, "PDFLaTeX",
712 *(runparams.exportdata),
714 runparams.inComment);
716 return external::writeExternal(params_, "LaTeX", buf, os,
717 *(runparams.exportdata),
719 runparams.inComment);
723 int InsetExternal::plaintext(Buffer const & buf, lyx::odocstream & os,
724 OutputParams const & runparams) const
726 std::ostringstream oss;
727 int const retval = external::writeExternal(params_, "Ascii", buf, oss,
728 *(runparams.exportdata), false,
729 runparams.inComment);
731 os << lyx::from_utf8(oss.str());
736 int InsetExternal::docbook(Buffer const & buf, ostream & os,
737 OutputParams const & runparams) const
739 return external::writeExternal(params_, "DocBook", buf, os,
740 *(runparams.exportdata), false,
741 runparams.inComment);
745 void InsetExternal::validate(LaTeXFeatures & features) const
750 external::Template const * const et_ptr =
751 external::getTemplatePtr(params_);
754 external::Template const & et = *et_ptr;
757 switch (features.runparams().flavor) {
758 case OutputParams::LATEX:
761 case OutputParams::PDFLATEX:
764 case OutputParams::XML:
768 external::Template::Formats::const_iterator cit =
769 et.formats.find(format);
770 if (cit == et.formats.end())
773 // FIXME: We don't need that always
774 features.require("lyxdot");
776 vector<string>::const_iterator it = cit->second.requirements.begin();
777 vector<string>::const_iterator end = cit->second.requirements.end();
778 for (; it != end; ++it)
779 features.require(*it);
781 external::TemplateManager & etm = external::TemplateManager::get();
783 it = cit->second.preambleNames.begin();
784 end = cit->second.preambleNames.end();
785 for (; it != end; ++it) {
786 string const preamble = etm.getPreambleDefByName(*it);
787 if (!preamble.empty())
788 features.addExternalPreamble(preamble);
799 bool preview_wanted(InsetExternalParams const & params)
801 string const included_file = params.filename.absFilename();
803 return params.display == external::PreviewDisplay &&
804 support::isFileReadable(included_file);
808 string const latex_string(InsetExternal const & inset, Buffer const & buffer)
811 OutputParams runparams;
812 runparams.flavor = OutputParams::LATEX;
813 inset.latex(buffer, os, runparams);
819 void add_preview_and_start_loading(RenderMonitoredPreview & renderer,
820 InsetExternal const & inset,
821 Buffer const & buffer)
823 InsetExternalParams const & params = inset.params();
825 if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
826 preview_wanted(params)) {
827 renderer.setAbsFile(params.filename.absFilename());
828 string const snippet = latex_string(inset, buffer);
829 renderer.addPreview(snippet, buffer);
830 renderer.startLoading(buffer);
837 void InsetExternal::addPreview(graphics::PreviewLoader & ploader) const
839 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
843 if (preview_wanted(params())) {
844 ptr->setAbsFile(params_.filename.absFilename());
845 string const snippet = latex_string(*this, ploader.buffer());
846 ptr->addPreview(snippet, ploader);
853 string const InsetExternalMailer::name_("external");
855 InsetExternalMailer::InsetExternalMailer(InsetExternal & inset)
860 string const InsetExternalMailer::inset2string(Buffer const & buffer) const
862 return params2string(inset_.params(), buffer);
866 void InsetExternalMailer::string2params(string const & in,
867 Buffer const & buffer,
868 InsetExternalParams & params)
870 params = InsetExternalParams();
874 istringstream data(in);
880 if (!lex || name != name_)
881 return print_mailer_error("InsetExternalMailer", in, 1, name_);
883 // This is part of the inset proper that is usually swallowed
884 // by LyXText::readInset
887 if (!lex || id != "External")
888 return print_mailer_error("InsetBoxMailer", in, 2, "External");
890 params.read(buffer, lex);
895 InsetExternalMailer::params2string(InsetExternalParams const & params,
896 Buffer const & buffer)
899 data << name_ << ' ';
900 params.write(buffer, data);
901 data << "\\end_inset\n";