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"
21 #include "BufferView.h"
23 #include "dispatchresult.h"
24 #include "funcrequest.h"
26 #include "LaTeXFeatures.h"
30 #include "metricsinfo.h"
31 #include "outputparams.h"
33 #include "frontends/lyx_gui.h"
34 #include "frontends/LyXView.h"
36 #include "graphics/PreviewLoader.h"
38 #include "support/FileInfo.h"
39 #include "support/filetools.h"
40 #include "support/lstrings.h"
41 #include "support/lyxlib.h"
42 #include "support/tostr.h"
43 #include "support/translator.h"
45 #include <boost/bind.hpp>
47 #include "support/std_sstream.h"
49 namespace support = lyx::support;
50 namespace external = lyx::external;
51 namespace graphics = lyx::graphics;
56 using std::istringstream;
58 using std::ostringstream;
64 external::DisplayType const defaultDisplayType = external::NoDisplay;
66 unsigned int const defaultLyxScale = 100;
68 string const defaultTemplateName = "RasterImage";
78 tempname_ = support::tempName(string(), "lyxext");
79 support::unlink(tempname_);
80 // must have an extension for the converter code to work correctly.
85 TempName::TempName(TempName const &)
87 tempname_ = TempName()();
93 support::unlink(tempname_);
98 TempName::operator=(TempName const & other)
101 tempname_ = TempName()();
108 /// The translator between the Display enum and corresponding lyx string.
109 Translator<DisplayType, string> const initTranslator()
111 Translator<DisplayType, string> translator(DefaultDisplay, "default");
113 // Fill the display translator
114 translator.addPair(MonochromeDisplay, "monochrome");
115 translator.addPair(GrayscaleDisplay, "grayscale");
116 translator.addPair(ColorDisplay, "color");
117 translator.addPair(PreviewDisplay, "preview");
118 translator.addPair(NoDisplay, "none");
126 Translator<DisplayType, string> const & displayTranslator()
128 static Translator<DisplayType, string> const translator =
133 } // namespace external
137 InsetExternalParams::InsetExternalParams()
138 : display(defaultDisplayType),
139 lyxscale(defaultLyxScale),
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 = std::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())
191 << filename.outputFilename(buffer.filePath())
194 if (display != defaultDisplayType)
196 << external::displayTranslator().find(display)
199 if (lyxscale != defaultLyxScale)
200 os << "\tlyxscale " << tostr(lyxscale) << '\n';
202 if (!clipdata.bbox.empty())
203 os << "\tboundingBox " << clipdata.bbox << '\n';
207 external::ExtraData::const_iterator it = extradata.begin();
208 external::ExtraData::const_iterator end = extradata.end();
209 for (; it != end; ++it) {
210 if (!it->second.empty())
211 os << "\textra " << it->first << " \""
212 << it->second << "\"\n";
215 if (!rotationdata.no_rotation()) {
216 os << "\trotateAngle " << rotationdata.angle() << '\n';
217 if (rotationdata.origin() != external::RotationData::DEFAULT)
218 os << "\trotateOrigin "
219 << rotationdata.originString() << '\n';
222 if (!resizedata.no_resize()) {
223 using support::float_equal;
225 if (!float_equal(resizedata.scale, 0.0, 0.05)) {
226 if (!float_equal(resizedata.scale, 100.0, 0.05))
228 << resizedata.scale << '\n';
230 if (!resizedata.width.zero())
232 << resizedata.width.asString() << '\n';
233 if (!resizedata.height.zero())
235 << resizedata.height.asString() << '\n';
237 if (resizedata.keepAspectRatio)
238 os << "\tkeepAspectRatio\n";
243 bool InsetExternalParams::read(Buffer const & buffer, LyXLex & lex)
262 keyword_item external_tags[] = {
263 { "\\end_inset", EX_END },
264 { "boundingBox", EX_BOUNDINGBOX },
266 { "display", EX_DISPLAY},
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 display = external::displayTranslator().find(name);
307 lyxscale = lex.getInteger();
312 clipdata.bbox.xl = lex.getInteger();
314 clipdata.bbox.yb = lex.getInteger();
316 clipdata.bbox.xr = lex.getInteger();
318 clipdata.bbox.yt = lex.getInteger();
322 clipdata.clip = true;
327 string const name = lex.getString();
329 extradata.set(name, lex.getString());
335 resizedata.height = LyXLength(lex.getString());
338 case EX_KEEPASPECTRATIO:
339 resizedata.keepAspectRatio = true;
344 rotationdata.angle(lex.getFloat());
347 case EX_ROTATEORIGIN:
349 rotationdata.origin(lex.getString());
354 resizedata.scale = lex.getFloat();
359 resizedata.width = LyXLength(lex.getString());
367 lex.printError("ExternalInset::read: "
368 "Wrong tag: $$Token");
373 if (found_end || read_error)
378 lex.printError("ExternalInsetParams::read: Missing \\end_inset.");
380 // This is a trick to make sure that the data are self-consistent.
381 settemplate(templatename_);
383 if (lyxerr.debugging(Debug::EXTERNAL)) {
384 lyxerr << "InsetExternalParams::read:\n";
385 write(buffer, lyxerr);
392 InsetExternal::InsetExternal()
393 : renderer_(new RenderButton)
397 InsetExternal::InsetExternal(InsetExternal const & other)
399 boost::signals::trackable(),
400 params_(other.params_),
401 renderer_(other.renderer_->clone())
403 if (renderer_->asMonitoredPreview() != 0) {
404 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
405 ptr->connect(boost::bind(&InsetExternal::statusChanged, this));
406 ptr->fileChanged(boost::bind(&InsetExternal::fileChanged, this));
408 } else if (renderer_->asGraphic() != 0 ) {
409 RenderGraphic * const ptr = renderer_->asGraphic();
410 ptr->connect(boost::bind(&InsetExternal::statusChanged, this));
415 auto_ptr<InsetBase> InsetExternal::clone() const
417 return auto_ptr<InsetBase>(new InsetExternal(*this));
421 InsetExternal::~InsetExternal()
423 InsetExternalMailer(*this).hideDialog();
427 void InsetExternal::statusChanged() const
429 LyX::cref().updateInset(this);
434 InsetExternal::priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &)
436 switch (cmd.action) {
438 case LFUN_EXTERNAL_EDIT: {
439 BOOST_ASSERT(cmd.view());
441 Buffer const & buffer = *cmd.view()->buffer();
442 InsetExternalParams p;
443 InsetExternalMailer::string2params(cmd.argument, buffer, p);
444 external::editExternal(p, buffer);
445 return DispatchResult(true);
448 case LFUN_INSET_MODIFY: {
449 BOOST_ASSERT(cmd.view());
451 Buffer const & buffer = *cmd.view()->buffer();
452 InsetExternalParams p;
453 InsetExternalMailer::string2params(cmd.argument, buffer, p);
454 setParams(p, buffer);
455 cmd.view()->update();
456 return DispatchResult(true, true);
459 case LFUN_INSET_DIALOG_UPDATE:
460 InsetExternalMailer(*this).updateDialog(cmd.view());
461 return DispatchResult(true, true);
463 case LFUN_MOUSE_RELEASE:
464 InsetExternalMailer(*this).showDialog(cmd.view());
465 return DispatchResult(true, true);
468 return DispatchResult(false);
473 void InsetExternal::edit(BufferView * bv, bool)
475 InsetExternalMailer(*this).showDialog(bv);
479 void InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const
481 renderer_->metrics(mi, dim);
486 void InsetExternal::draw(PainterInfo & pi, int x, int y) const
490 renderer_->draw(pi, x, y);
503 RenderType getRenderType(InsetExternalParams const & p)
505 if (!external::getTemplatePtr(p) ||
506 p.filename.empty() ||
507 p.display == external::NoDisplay)
510 if (p.display == external::PreviewDisplay) {
511 if (RenderPreview::activated())
512 return RENDERPREVIEW;
516 if (p.display == external::DefaultDisplay &&
517 lyxrc.display_graphics == graphics::NoDisplay)
519 return RENDERGRAPHIC;
523 graphics::Params get_grfx_params(InsetExternalParams const & eparams)
525 graphics::Params gparams;
527 gparams.filename = eparams.filename.absFilename();
528 gparams.scale = eparams.lyxscale;
529 if (eparams.clipdata.clip)
530 gparams.bb = eparams.clipdata.bbox;
531 gparams.angle = eparams.rotationdata.angle();
533 switch (eparams.display) {
534 case external::DefaultDisplay:
535 gparams.display = graphics::DefaultDisplay;
537 case external::MonochromeDisplay:
538 gparams.display = graphics::MonochromeDisplay;
540 case external::GrayscaleDisplay:
541 gparams.display = graphics::GrayscaleDisplay;
543 case external::ColorDisplay:
544 gparams.display = graphics::ColorDisplay;
546 case external::NoDisplay:
547 gparams.display = graphics::NoDisplay;
552 if (gparams.display == graphics::DefaultDisplay)
553 gparams.display = lyxrc.display_graphics;
554 // Override the above if we're not using a gui
555 if (!lyx_gui::use_gui)
556 gparams.display = graphics::NoDisplay;
562 string const getScreenLabel(InsetExternalParams const & params,
563 Buffer const & buffer)
565 external::Template const * const ptr =
566 external::getTemplatePtr(params);
568 return support::bformat(_("External template %1$s is not installed"),
569 params.templatename());
570 return external::doSubstitution(params, buffer, ptr->guiName);
573 void add_preview(RenderMonitoredPreview &, InsetExternal const &, Buffer const &);
578 InsetExternalParams const & InsetExternal::params() const
584 void InsetExternal::setParams(InsetExternalParams const & p,
585 Buffer const & buffer)
589 switch (getRenderType(params_)) {
591 RenderButton * button_ptr = renderer_->asButton();
593 renderer_.reset(new RenderButton);
594 button_ptr = renderer_->asButton();
597 button_ptr->update(getScreenLabel(params_, buffer), true);
600 } case RENDERGRAPHIC: {
601 RenderGraphic * graphic_ptr = renderer_->asGraphic();
603 renderer_.reset(new RenderGraphic);
604 graphic_ptr = renderer_->asGraphic();
605 graphic_ptr->connect(
606 boost::bind(&InsetExternal::statusChanged, this));
609 graphic_ptr->update(get_grfx_params(params_));
613 } case RENDERPREVIEW: {
614 RenderMonitoredPreview * preview_ptr =
615 renderer_->asMonitoredPreview();
617 renderer_.reset(new RenderMonitoredPreview);
618 preview_ptr = renderer_->asMonitoredPreview();
619 preview_ptr->connect(
620 boost::bind(&InsetExternal::statusChanged, this));
621 preview_ptr->fileChanged(
622 boost::bind(&InsetExternal::fileChanged, this));
625 if (preview_ptr->monitoring())
626 preview_ptr->stopMonitoring();
627 add_preview(*preview_ptr, *this, buffer);
635 void InsetExternal::fileChanged() const
637 Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
641 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
644 Buffer const & buffer = *buffer_ptr;
645 ptr->removePreview(buffer);
646 add_preview(*ptr, *this, buffer);
647 ptr->startLoading(buffer);
651 void InsetExternal::write(Buffer const & buffer, ostream & os) const
653 params_.write(buffer, os);
657 void InsetExternal::read(Buffer const & buffer, LyXLex & lex)
659 InsetExternalParams params;
660 if (params.read(buffer, lex))
661 setParams(params, buffer);
665 int InsetExternal::latex(Buffer const & buf, ostream & os,
666 OutputParams const & runparams) const
668 // "nice" means that the buffer is exported to LaTeX format but not
669 // run through the LaTeX compiler.
670 // If we're running through the LaTeX compiler, we should write the
671 // generated files in the bufer's temporary directory.
672 bool const external_in_tmpdir =
673 lyxrc.use_tempdir && !buf.temppath().empty() && !runparams.nice;
675 // If the template has specified a PDFLaTeX output, then we try and
677 if (runparams.flavor == OutputParams::PDFLATEX) {
678 external::Template const * const et_ptr =
679 external::getTemplatePtr(params_);
682 external::Template const & et = *et_ptr;
684 external::Template::Formats::const_iterator cit =
685 et.formats.find("PDFLaTeX");
686 if (cit != et.formats.end())
687 return external::writeExternal(params_, "PDFLaTeX",
688 buf, os, external_in_tmpdir);
691 return external::writeExternal(params_, "LaTeX",
692 buf, os, external_in_tmpdir);
696 int InsetExternal::plaintext(Buffer const & buf, ostream & os,
697 OutputParams const &) const
699 return external::writeExternal(params_, "Ascii", buf, os);
703 int InsetExternal::linuxdoc(Buffer const & buf, ostream & os,
704 OutputParams const &) const
706 return external::writeExternal(params_, "LinuxDoc", buf, os);
710 int InsetExternal::docbook(Buffer const & buf, ostream & os,
711 OutputParams const &) const
713 return external::writeExternal(params_, "DocBook", buf, os);
717 void InsetExternal::validate(LaTeXFeatures & features) const
719 external::Template const * const et_ptr =
720 external::getTemplatePtr(params_);
723 external::Template const & et = *et_ptr;
725 external::Template::Formats::const_iterator cit =
726 et.formats.find("LaTeX");
727 if (cit == et.formats.end())
730 if (!cit->second.requirement.empty())
731 features.require(cit->second.requirement);
733 external::TemplateManager & etm = external::TemplateManager::get();
735 vector<string>::const_iterator it = cit->second.preambleNames.begin();
736 vector<string>::const_iterator end = cit->second.preambleNames.end();
737 for (; it != end; ++it) {
738 string const preamble = etm.getPreambleDefByName(*it);
739 if (!preamble.empty())
740 features.addExternalPreamble(preamble);
751 bool preview_wanted(InsetExternalParams const & params)
753 string const included_file = params.filename.absFilename();
755 return params.display == external::PreviewDisplay &&
756 support::IsFileReadable(included_file);
760 string const latex_string(InsetExternal const & inset, Buffer const & buffer)
763 OutputParams runparams;
764 runparams.flavor = OutputParams::LATEX;
765 inset.latex(buffer, os, runparams);
771 void add_preview(RenderMonitoredPreview & renderer, InsetExternal const & inset,
772 Buffer const & buffer)
774 InsetExternalParams const & params = inset.params();
775 if (RenderPreview::activated() && preview_wanted(params)) {
776 renderer.setAbsFile(params.filename.absFilename());
777 string const snippet = latex_string(inset, buffer);
778 renderer.addPreview(snippet, buffer);
785 void InsetExternal::addPreview(graphics::PreviewLoader & ploader) const
787 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
791 if (preview_wanted(params())) {
792 ptr->setAbsFile(params_.filename.absFilename());
793 string const snippet = latex_string(*this, ploader.buffer());
794 ptr->addPreview(snippet, ploader);
801 string const InsetExternalMailer::name_("external");
803 InsetExternalMailer::InsetExternalMailer(InsetExternal & inset)
808 string const InsetExternalMailer::inset2string(Buffer const & buffer) const
810 return params2string(inset_.params(), buffer);
814 void InsetExternalMailer::string2params(string const & in,
815 Buffer const & buffer,
816 InsetExternalParams & params)
818 params = InsetExternalParams();
823 istringstream data(in);
829 string const token = lex.getString();
834 // This is part of the inset proper that is usually swallowed
835 // by Buffer::readInset
838 string const token = lex.getString();
839 if (token != "External")
844 params.read(buffer, lex);
850 InsetExternalMailer::params2string(InsetExternalParams const & params,
851 Buffer const & buffer)
854 data << name_ << ' ';
855 params.write(buffer, data);
856 data << "\\end_inset\n";