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),
141 templatename_(defaultTemplateName)
147 template <typename T>
148 void clearIfNotFound(T & data, external::TransformID value,
149 vector<external::TransformID> const & ids)
151 typedef vector<external::TransformID>::const_iterator
154 const_iterator it = ids.begin();
155 const_iterator end = ids.end();
156 it = std::find(it, end, value);
164 void InsetExternalParams::settemplate(string const & name)
166 templatename_ = name;
168 external::TemplateManager const & etm =
169 external::TemplateManager::get();
170 external::Template const * const et = etm.getTemplateByName(name);
172 // Be safe. Don't lose data.
175 // Ascertain which transforms the template supports.
176 // Empty all those that it doesn't.
177 vector<external::TransformID> const & ids = et->transformIds;
178 clearIfNotFound(clipdata, external::Clip, ids);
179 clearIfNotFound(extradata, external::Extra, ids);
180 clearIfNotFound(resizedata, external::Resize, ids);
181 clearIfNotFound(rotationdata, external::Rotate, ids);
185 void InsetExternalParams::write(Buffer const & buffer, ostream & os) const
188 << "\ttemplate " << templatename() << '\n';
190 if (!filename.empty())
192 << filename.outputFilename(buffer.filePath())
195 if (display != defaultDisplayType)
197 << external::displayTranslator().find(display)
200 if (lyxscale != defaultLyxScale)
201 os << "\tlyxscale " << tostr(lyxscale) << '\n';
206 if (!clipdata.bbox.empty())
207 os << "\tboundingBox " << clipdata.bbox << '\n';
211 external::ExtraData::const_iterator it = extradata.begin();
212 external::ExtraData::const_iterator end = extradata.end();
213 for (; it != end; ++it) {
214 if (!it->second.empty())
215 os << "\textra " << it->first << " \""
216 << it->second << "\"\n";
219 if (!rotationdata.no_rotation()) {
220 os << "\trotateAngle " << rotationdata.angle() << '\n';
221 if (rotationdata.origin() != external::RotationData::DEFAULT)
222 os << "\trotateOrigin "
223 << rotationdata.originString() << '\n';
226 if (!resizedata.no_resize()) {
227 using support::float_equal;
229 if (!float_equal(resizedata.scale, 0.0, 0.05)) {
230 if (!float_equal(resizedata.scale, 100.0, 0.05))
232 << resizedata.scale << '\n';
234 if (!resizedata.width.zero())
236 << resizedata.width.asString() << '\n';
237 if (!resizedata.height.zero())
239 << resizedata.height.asString() << '\n';
241 if (resizedata.keepAspectRatio)
242 os << "\tkeepAspectRatio\n";
247 bool InsetExternalParams::read(Buffer const & buffer, LyXLex & lex)
267 keyword_item external_tags[] = {
268 { "\\end_inset", EX_END },
269 { "boundingBox", EX_BOUNDINGBOX },
271 { "display", EX_DISPLAY},
272 { "draft", EX_DRAFT},
273 { "extra", EX_EXTRA },
274 { "filename", EX_FILENAME},
275 { "height", EX_HEIGHT },
276 { "keepAspectRatio", EX_KEEPASPECTRATIO },
277 { "lyxscale", EX_LYXSCALE},
278 { "rotateAngle", EX_ROTATEANGLE },
279 { "rotateOrigin", EX_ROTATEORIGIN },
280 { "scale", EX_SCALE },
281 { "template", EX_TEMPLATE },
282 { "width", EX_WIDTH }
285 pushpophelper pph(lex, external_tags, EX_END);
287 bool found_end = false;
288 bool read_error = false;
294 templatename_ = lex.getString();
299 string const name = lex.getString();
300 filename.set(name, buffer.filePath());
306 string const name = lex.getString();
307 display = external::displayTranslator().find(name);
313 lyxscale = lex.getInteger();
322 clipdata.bbox.xl = lex.getInteger();
324 clipdata.bbox.yb = lex.getInteger();
326 clipdata.bbox.xr = lex.getInteger();
328 clipdata.bbox.yt = lex.getInteger();
332 clipdata.clip = true;
337 string const name = lex.getString();
339 extradata.set(name, lex.getString());
345 resizedata.height = LyXLength(lex.getString());
348 case EX_KEEPASPECTRATIO:
349 resizedata.keepAspectRatio = true;
354 rotationdata.angle(lex.getFloat());
357 case EX_ROTATEORIGIN:
359 rotationdata.origin(lex.getString());
364 resizedata.scale = lex.getFloat();
369 resizedata.width = LyXLength(lex.getString());
377 lex.printError("ExternalInset::read: "
378 "Wrong tag: $$Token");
383 if (found_end || read_error)
388 lex.printError("ExternalInsetParams::read: Missing \\end_inset.");
390 // This is a trick to make sure that the data are self-consistent.
391 settemplate(templatename_);
393 if (lyxerr.debugging(Debug::EXTERNAL)) {
394 lyxerr << "InsetExternalParams::read:\n";
395 write(buffer, lyxerr);
402 InsetExternal::InsetExternal()
403 : renderer_(new RenderButton)
407 InsetExternal::InsetExternal(InsetExternal const & other)
409 boost::signals::trackable(),
410 params_(other.params_),
411 renderer_(other.renderer_->clone())
413 if (renderer_->asMonitoredPreview() != 0) {
414 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
415 ptr->connect(boost::bind(&InsetExternal::statusChanged, this));
416 ptr->fileChanged(boost::bind(&InsetExternal::fileChanged, this));
418 } else if (renderer_->asGraphic() != 0 ) {
419 RenderGraphic * const ptr = renderer_->asGraphic();
420 ptr->connect(boost::bind(&InsetExternal::statusChanged, this));
425 auto_ptr<InsetBase> InsetExternal::clone() const
427 return auto_ptr<InsetBase>(new InsetExternal(*this));
431 InsetExternal::~InsetExternal()
433 InsetExternalMailer(*this).hideDialog();
437 void InsetExternal::statusChanged() const
439 LyX::cref().updateInset(this);
444 InsetExternal::priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &)
446 switch (cmd.action) {
448 case LFUN_EXTERNAL_EDIT: {
449 BOOST_ASSERT(cmd.view());
451 Buffer const & buffer = *cmd.view()->buffer();
452 InsetExternalParams p;
453 InsetExternalMailer::string2params(cmd.argument, buffer, p);
454 external::editExternal(p, buffer);
455 return DispatchResult(true);
458 case LFUN_INSET_MODIFY: {
459 BOOST_ASSERT(cmd.view());
461 Buffer const & buffer = *cmd.view()->buffer();
462 InsetExternalParams p;
463 InsetExternalMailer::string2params(cmd.argument, buffer, p);
464 setParams(p, buffer);
465 cmd.view()->update();
466 return DispatchResult(true, true);
469 case LFUN_INSET_DIALOG_UPDATE:
470 InsetExternalMailer(*this).updateDialog(cmd.view());
471 return DispatchResult(true, true);
473 case LFUN_MOUSE_RELEASE:
474 InsetExternalMailer(*this).showDialog(cmd.view());
475 return DispatchResult(true, true);
478 return DispatchResult(false);
483 void InsetExternal::edit(BufferView * bv, bool)
485 InsetExternalMailer(*this).showDialog(bv);
489 void InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const
491 renderer_->metrics(mi, dim);
496 void InsetExternal::draw(PainterInfo & pi, int x, int y) const
500 renderer_->draw(pi, x, y);
513 RenderType getRenderType(InsetExternalParams const & p)
515 if (!external::getTemplatePtr(p) ||
516 p.filename.empty() ||
517 p.display == external::NoDisplay)
520 if (p.display == external::PreviewDisplay) {
521 if (RenderPreview::activated())
522 return RENDERPREVIEW;
526 if (p.display == external::DefaultDisplay &&
527 lyxrc.display_graphics == graphics::NoDisplay)
529 return RENDERGRAPHIC;
533 graphics::Params get_grfx_params(InsetExternalParams const & eparams)
535 graphics::Params gparams;
537 gparams.filename = eparams.filename.absFilename();
538 gparams.scale = eparams.lyxscale;
539 if (eparams.clipdata.clip)
540 gparams.bb = eparams.clipdata.bbox;
541 gparams.angle = eparams.rotationdata.angle();
543 switch (eparams.display) {
544 case external::DefaultDisplay:
545 gparams.display = graphics::DefaultDisplay;
547 case external::MonochromeDisplay:
548 gparams.display = graphics::MonochromeDisplay;
550 case external::GrayscaleDisplay:
551 gparams.display = graphics::GrayscaleDisplay;
553 case external::ColorDisplay:
554 gparams.display = graphics::ColorDisplay;
556 case external::NoDisplay:
557 gparams.display = graphics::NoDisplay;
562 if (gparams.display == graphics::DefaultDisplay)
563 gparams.display = lyxrc.display_graphics;
564 // Override the above if we're not using a gui
565 if (!lyx_gui::use_gui)
566 gparams.display = graphics::NoDisplay;
572 string const getScreenLabel(InsetExternalParams const & params,
573 Buffer const & buffer)
575 external::Template const * const ptr =
576 external::getTemplatePtr(params);
578 return support::bformat(_("External template %1$s is not installed"),
579 params.templatename());
580 return external::doSubstitution(params, buffer, ptr->guiName);
583 void add_preview(RenderMonitoredPreview &, InsetExternal const &, Buffer const &);
588 InsetExternalParams const & InsetExternal::params() const
594 void InsetExternal::setParams(InsetExternalParams const & p,
595 Buffer const & buffer)
599 switch (getRenderType(params_)) {
601 RenderButton * button_ptr = renderer_->asButton();
603 renderer_.reset(new RenderButton);
604 button_ptr = renderer_->asButton();
607 button_ptr->update(getScreenLabel(params_, buffer), true);
610 } case RENDERGRAPHIC: {
611 RenderGraphic * graphic_ptr = renderer_->asGraphic();
613 renderer_.reset(new RenderGraphic);
614 graphic_ptr = renderer_->asGraphic();
615 graphic_ptr->connect(
616 boost::bind(&InsetExternal::statusChanged, this));
619 graphic_ptr->update(get_grfx_params(params_));
623 } case RENDERPREVIEW: {
624 RenderMonitoredPreview * preview_ptr =
625 renderer_->asMonitoredPreview();
627 renderer_.reset(new RenderMonitoredPreview);
628 preview_ptr = renderer_->asMonitoredPreview();
629 preview_ptr->connect(
630 boost::bind(&InsetExternal::statusChanged, this));
631 preview_ptr->fileChanged(
632 boost::bind(&InsetExternal::fileChanged, this));
635 if (preview_ptr->monitoring())
636 preview_ptr->stopMonitoring();
637 add_preview(*preview_ptr, *this, buffer);
645 void InsetExternal::fileChanged() const
647 Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
651 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
654 Buffer const & buffer = *buffer_ptr;
655 ptr->removePreview(buffer);
656 add_preview(*ptr, *this, buffer);
657 ptr->startLoading(buffer);
661 void InsetExternal::write(Buffer const & buffer, ostream & os) const
663 params_.write(buffer, os);
667 void InsetExternal::read(Buffer const & buffer, LyXLex & lex)
669 InsetExternalParams params;
670 if (params.read(buffer, lex))
671 setParams(params, buffer);
675 int InsetExternal::latex(Buffer const & buf, ostream & os,
676 OutputParams const & runparams) const
679 os << "\\fbox{\\ttfamily{}"
680 << params_.filename.outputFilename(buf.filePath())
685 // "nice" means that the buffer is exported to LaTeX format but not
686 // run through the LaTeX compiler.
687 // If we're running through the LaTeX compiler, we should write the
688 // generated files in the bufer's temporary directory.
689 bool const external_in_tmpdir =
690 lyxrc.use_tempdir && !buf.temppath().empty() && !runparams.nice;
692 // If the template has specified a PDFLaTeX output, then we try and
694 if (runparams.flavor == OutputParams::PDFLATEX) {
695 external::Template const * const et_ptr =
696 external::getTemplatePtr(params_);
699 external::Template const & et = *et_ptr;
701 external::Template::Formats::const_iterator cit =
702 et.formats.find("PDFLaTeX");
703 if (cit != et.formats.end())
704 return external::writeExternal(params_, "PDFLaTeX",
705 buf, os, external_in_tmpdir);
708 return external::writeExternal(params_, "LaTeX",
709 buf, os, external_in_tmpdir);
713 int InsetExternal::plaintext(Buffer const & buf, ostream & os,
714 OutputParams const &) const
716 return external::writeExternal(params_, "Ascii", buf, os);
720 int InsetExternal::linuxdoc(Buffer const & buf, ostream & os,
721 OutputParams const &) const
723 return external::writeExternal(params_, "LinuxDoc", buf, os);
727 int InsetExternal::docbook(Buffer const & buf, ostream & os,
728 OutputParams const &) const
730 return external::writeExternal(params_, "DocBook", buf, os);
734 void InsetExternal::validate(LaTeXFeatures & features) const
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("LaTeX");
747 if (cit == et.formats.end())
750 if (!cit->second.requirement.empty())
751 features.require(cit->second.requirement);
753 external::TemplateManager & etm = external::TemplateManager::get();
755 vector<string>::const_iterator it = cit->second.preambleNames.begin();
756 vector<string>::const_iterator end = cit->second.preambleNames.end();
757 for (; it != end; ++it) {
758 string const preamble = etm.getPreambleDefByName(*it);
759 if (!preamble.empty())
760 features.addExternalPreamble(preamble);
771 bool preview_wanted(InsetExternalParams const & params)
773 string const included_file = params.filename.absFilename();
775 return params.display == external::PreviewDisplay &&
776 support::IsFileReadable(included_file);
780 string const latex_string(InsetExternal const & inset, Buffer const & buffer)
783 OutputParams runparams;
784 runparams.flavor = OutputParams::LATEX;
785 inset.latex(buffer, os, runparams);
791 void add_preview(RenderMonitoredPreview & renderer, InsetExternal const & inset,
792 Buffer const & buffer)
794 InsetExternalParams const & params = inset.params();
795 if (RenderPreview::activated() && preview_wanted(params)) {
796 renderer.setAbsFile(params.filename.absFilename());
797 string const snippet = latex_string(inset, buffer);
798 renderer.addPreview(snippet, buffer);
805 void InsetExternal::addPreview(graphics::PreviewLoader & ploader) const
807 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
811 if (preview_wanted(params())) {
812 ptr->setAbsFile(params_.filename.absFilename());
813 string const snippet = latex_string(*this, ploader.buffer());
814 ptr->addPreview(snippet, ploader);
821 string const InsetExternalMailer::name_("external");
823 InsetExternalMailer::InsetExternalMailer(InsetExternal & inset)
828 string const InsetExternalMailer::inset2string(Buffer const & buffer) const
830 return params2string(inset_.params(), buffer);
834 void InsetExternalMailer::string2params(string const & in,
835 Buffer const & buffer,
836 InsetExternalParams & params)
838 params = InsetExternalParams();
842 istringstream data(in);
848 if (!lex || name != name_)
849 return print_mailer_error("InsetExternalMailer", in, 1, name_);
851 // This is part of the inset proper that is usually swallowed
852 // by LyXText::readInset
855 if (!lex || id != "External")
856 return print_mailer_error("InsetBoxMailer", in, 2, "External");
858 params.read(buffer, lex);
863 InsetExternalMailer::params2string(InsetExternalParams const & params,
864 Buffer const & buffer)
867 data << name_ << ' ';
868 params.write(buffer, data);
869 data << "\\end_inset\n";