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"
27 #include "latexrunparams.h"
31 #include "metricsinfo.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 defaultLyxScale = 100;
76 tempname_ = support::tempName(string(), "lyxext");
77 support::unlink(tempname_);
78 // must have an extension for the converter code to work correctly.
83 TempName::TempName(TempName const &)
85 tempname_ = TempName()();
91 support::unlink(tempname_);
96 TempName::operator=(TempName const & other)
99 tempname_ = TempName()();
106 /// The translator between the Display enum and corresponding lyx string.
107 Translator<DisplayType, string> const initTranslator()
109 Translator<DisplayType, string> translator(DefaultDisplay, "default");
111 // Fill the display translator
112 translator.addPair(MonochromeDisplay, "monochrome");
113 translator.addPair(GrayscaleDisplay, "grayscale");
114 translator.addPair(ColorDisplay, "color");
115 translator.addPair(PreviewDisplay, "preview");
116 translator.addPair(NoDisplay, "none");
124 Translator<DisplayType, string> const & displayTranslator()
126 static Translator<DisplayType, string> const translator =
131 } // namespace external
135 InsetExternalParams::InsetExternalParams()
136 : display(defaultDisplayType),
137 lyxscale(defaultLyxScale)
143 template <typename T>
144 void clearIfNotFound(T & data, external::TransformID value,
145 vector<external::TransformID> const & ids)
147 typedef vector<external::TransformID>::const_iterator
150 const_iterator it = ids.begin();
151 const_iterator end = ids.end();
152 it = std::find(it, end, value);
160 void InsetExternalParams::settemplate(string const & name)
162 templatename_ = name;
164 external::TemplateManager const & etm =
165 external::TemplateManager::get();
166 external::Template const * const et = etm.getTemplateByName(name);
168 // Be safe. Don't lose data.
171 // Ascertain which transforms the template supports.
172 // Empty all those that it doesn't.
173 vector<external::TransformID> const & ids = et->transformIds;
174 clearIfNotFound(clipdata, external::Clip, ids);
175 clearIfNotFound(extradata, external::Extra, ids);
176 clearIfNotFound(resizedata, external::Resize, ids);
177 clearIfNotFound(rotationdata, external::Rotate, ids);
181 void InsetExternalParams::write(Buffer const & buffer, ostream & os) const
184 << "\ttemplate " << templatename() << '\n';
186 if (!filename.empty())
188 << filename.outputFilename(buffer.filePath())
191 if (display != defaultDisplayType)
193 << external::displayTranslator().find(display)
196 if (lyxscale != defaultLyxScale)
197 os << "\tlyxscale " << tostr(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.angle() << '\n';
214 if (rotationdata.origin() != external::RotationData::DEFAULT)
215 os << "\trotateOrigin "
216 << rotationdata.originString() << '\n';
219 if (!resizedata.no_resize()) {
220 using support::float_equal;
222 if (!float_equal(resizedata.scale, 0.0, 0.05)) {
223 if (!float_equal(resizedata.scale, 100.0, 0.05))
225 << resizedata.scale << '\n';
227 if (!resizedata.width.zero())
229 << resizedata.width.asString() << '\n';
230 if (!resizedata.height.zero())
232 << resizedata.height.asString() << '\n';
234 if (resizedata.keepAspectRatio)
235 os << "\tkeepAspectRatio\n";
240 bool InsetExternalParams::read(Buffer const & buffer, LyXLex & lex)
259 keyword_item external_tags[] = {
260 { "\\end_inset", EX_END },
261 { "boundingBox", EX_BOUNDINGBOX },
263 { "display", EX_DISPLAY},
264 { "extra", EX_EXTRA },
265 { "filename", EX_FILENAME},
266 { "height", EX_HEIGHT },
267 { "keepAspectRatio", EX_KEEPASPECTRATIO },
268 { "lyxscale", EX_LYXSCALE},
269 { "rotateAngle", EX_ROTATEANGLE },
270 { "rotateOrigin", EX_ROTATEORIGIN },
271 { "scale", EX_SCALE },
272 { "template", EX_TEMPLATE },
273 { "width", EX_WIDTH }
276 pushpophelper pph(lex, external_tags, EX_END);
278 bool found_end = false;
279 bool read_error = false;
285 templatename_ = lex.getString();
290 string const name = lex.getString();
291 filename.set(name, buffer.filePath());
297 string const name = lex.getString();
298 display = external::displayTranslator().find(name);
304 lyxscale = lex.getInteger();
309 clipdata.bbox.xl = lex.getInteger();
311 clipdata.bbox.yb = lex.getInteger();
313 clipdata.bbox.xr = lex.getInteger();
315 clipdata.bbox.yt = lex.getInteger();
319 clipdata.clip = true;
324 string const name = lex.getString();
326 extradata.set(name, lex.getString());
332 resizedata.height = LyXLength(lex.getString());
335 case EX_KEEPASPECTRATIO:
336 resizedata.keepAspectRatio = true;
341 rotationdata.angle(lex.getFloat());
344 case EX_ROTATEORIGIN:
346 rotationdata.origin(lex.getString());
351 resizedata.scale = lex.getFloat();
356 resizedata.width = LyXLength(lex.getString());
364 lex.printError("ExternalInset::read: "
365 "Wrong tag: $$Token");
370 if (found_end || read_error)
375 lex.printError("ExternalInset::read: Missing \\end_inset.");
377 // This is a trick to make sure that the data are self-consistent.
378 settemplate(templatename_);
380 if (lyxerr.debugging(Debug::EXTERNAL)) {
381 lyxerr << "InsetExternalParams::read:\n";
382 write(buffer, lyxerr);
389 InsetExternal::InsetExternal()
390 : renderer_(new RenderButton)
394 InsetExternal::InsetExternal(InsetExternal const & other)
396 boost::signals::trackable(),
397 params_(other.params_),
398 renderer_(other.renderer_->clone())
400 if (renderer_->asMonitoredPreview() != 0) {
401 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
402 ptr->connect(boost::bind(&InsetExternal::statusChanged, this));
403 ptr->fileChanged(boost::bind(&InsetExternal::fileChanged, this));
405 } else if (renderer_->asGraphic() != 0 ) {
406 RenderGraphic * const ptr = renderer_->asGraphic();
407 ptr->connect(boost::bind(&InsetExternal::statusChanged, this));
412 auto_ptr<InsetBase> InsetExternal::clone() const
414 return auto_ptr<InsetBase>(new InsetExternal(*this));
418 InsetExternal::~InsetExternal()
420 InsetExternalMailer(*this).hideDialog();
424 void InsetExternal::statusChanged() const
426 LyX::cref().updateInset(this);
431 InsetExternal::priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &)
433 switch (cmd.action) {
435 case LFUN_EXTERNAL_EDIT: {
436 BOOST_ASSERT(cmd.view());
438 Buffer const & buffer = *cmd.view()->buffer();
439 InsetExternalParams p;
440 InsetExternalMailer::string2params(cmd.argument, buffer, p);
441 external::editExternal(p, buffer);
442 return DispatchResult(true, NOUPDATE);
445 case LFUN_INSET_MODIFY: {
446 BOOST_ASSERT(cmd.view());
448 Buffer const & buffer = *cmd.view()->buffer();
449 InsetExternalParams p;
450 InsetExternalMailer::string2params(cmd.argument, buffer, p);
451 setParams(p, buffer);
452 cmd.view()->updateInset(this);
453 return DispatchResult(true);
456 case LFUN_INSET_DIALOG_UPDATE:
457 InsetExternalMailer(*this).updateDialog(cmd.view());
458 return DispatchResult(true);
460 case LFUN_MOUSE_RELEASE:
461 case LFUN_INSET_EDIT:
462 InsetExternalMailer(*this).showDialog(cmd.view());
463 return DispatchResult(true);
466 return DispatchResult(false);
471 void InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const
473 renderer_->metrics(mi, dim);
478 void InsetExternal::draw(PainterInfo & pi, int x, int y) const
480 renderer_->draw(pi, x, y);
493 RenderType getRenderType(InsetExternalParams const & p)
495 if (!external::getTemplatePtr(p) ||
496 p.filename.empty() ||
497 p.display == external::NoDisplay)
500 if (p.display == external::PreviewDisplay) {
501 if (RenderPreview::activated())
502 return RENDERPREVIEW;
506 if (p.display == external::DefaultDisplay &&
507 lyxrc.display_graphics == graphics::NoDisplay)
509 return RENDERGRAPHIC;
513 graphics::Params get_grfx_params(InsetExternalParams const & eparams)
515 graphics::Params gparams;
517 gparams.filename = eparams.filename.absFilename();
518 gparams.scale = eparams.lyxscale;
519 if (eparams.clipdata.clip)
520 gparams.bb = eparams.clipdata.bbox;
521 gparams.angle = eparams.rotationdata.angle();
523 switch (eparams.display) {
524 case external::DefaultDisplay:
525 gparams.display = graphics::DefaultDisplay;
527 case external::MonochromeDisplay:
528 gparams.display = graphics::MonochromeDisplay;
530 case external::GrayscaleDisplay:
531 gparams.display = graphics::GrayscaleDisplay;
533 case external::ColorDisplay:
534 gparams.display = graphics::ColorDisplay;
536 case external::NoDisplay:
537 gparams.display = graphics::NoDisplay;
542 if (gparams.display == graphics::DefaultDisplay)
543 gparams.display = lyxrc.display_graphics;
544 // Override the above if we're not using a gui
545 if (!lyx_gui::use_gui)
546 gparams.display = graphics::NoDisplay;
552 string const getScreenLabel(InsetExternalParams const & params,
553 Buffer const & buffer)
555 external::Template const * const ptr =
556 external::getTemplatePtr(params);
558 return support::bformat(_("External template %1$s is not installed"),
559 params.templatename());
560 return external::doSubstitution(params, buffer, ptr->guiName);
563 void add_preview(RenderMonitoredPreview &, InsetExternal const &, Buffer const &);
568 InsetExternalParams const & InsetExternal::params() const
574 void InsetExternal::setParams(InsetExternalParams const & p,
575 Buffer const & buffer)
579 switch (getRenderType(params_)) {
581 RenderButton * button_ptr = renderer_->asButton();
583 renderer_.reset(new RenderButton);
584 button_ptr = renderer_->asButton();
587 button_ptr->update(getScreenLabel(params_, buffer), true);
590 } case RENDERGRAPHIC: {
591 RenderGraphic * graphic_ptr = renderer_->asGraphic();
593 renderer_.reset(new RenderGraphic);
594 graphic_ptr = renderer_->asGraphic();
595 graphic_ptr->connect(
596 boost::bind(&InsetExternal::statusChanged, this));
599 graphic_ptr->update(get_grfx_params(params_));
603 } case RENDERPREVIEW: {
604 RenderMonitoredPreview * preview_ptr =
605 renderer_->asMonitoredPreview();
607 renderer_.reset(new RenderMonitoredPreview);
608 preview_ptr = renderer_->asMonitoredPreview();
609 preview_ptr->connect(
610 boost::bind(&InsetExternal::statusChanged, this));
611 preview_ptr->fileChanged(
612 boost::bind(&InsetExternal::fileChanged, this));
615 if (preview_ptr->monitoring())
616 preview_ptr->stopMonitoring();
617 add_preview(*preview_ptr, *this, buffer);
625 void InsetExternal::fileChanged() const
627 Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
631 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
634 Buffer const & buffer = *buffer_ptr;
635 ptr->removePreview(buffer);
636 add_preview(*ptr, *this, buffer);
637 ptr->startLoading(buffer);
641 void InsetExternal::write(Buffer const & buffer, ostream & os) const
643 params_.write(buffer, os);
647 void InsetExternal::read(Buffer const & buffer, LyXLex & lex)
649 InsetExternalParams params;
650 if (params.read(buffer, lex))
651 setParams(params, buffer);
655 int InsetExternal::latex(Buffer const & buf, ostream & os,
656 LatexRunParams const & runparams) const
658 // "nice" means that the buffer is exported to LaTeX format but not
659 // run through the LaTeX compiler.
660 // If we're running through the LaTeX compiler, we should write the
661 // generated files in the bufer's temporary directory.
662 bool const external_in_tmpdir =
663 lyxrc.use_tempdir && !buf.temppath().empty() && !runparams.nice;
665 // If the template has specified a PDFLaTeX output, then we try and
667 if (runparams.flavor == LatexRunParams::PDFLATEX) {
668 external::Template const * const et_ptr =
669 external::getTemplatePtr(params_);
672 external::Template const & et = *et_ptr;
674 external::Template::Formats::const_iterator cit =
675 et.formats.find("PDFLaTeX");
676 if (cit != et.formats.end())
677 return external::writeExternal(params_, "PDFLaTeX",
678 buf, os, external_in_tmpdir);
681 return external::writeExternal(params_, "LaTeX",
682 buf, os, external_in_tmpdir);
686 int InsetExternal::ascii(Buffer const & buf, ostream & os,
687 LatexRunParams const &) const
689 return external::writeExternal(params_, "Ascii", buf, os);
693 int InsetExternal::linuxdoc(Buffer const & buf, ostream & os,
694 LatexRunParams const &) const
696 return external::writeExternal(params_, "LinuxDoc", buf, os);
700 int InsetExternal::docbook(Buffer const & buf, ostream & os,
701 LatexRunParams const &) const
703 return external::writeExternal(params_, "DocBook", buf, os);
707 void InsetExternal::validate(LaTeXFeatures & features) const
709 external::Template const * const et_ptr =
710 external::getTemplatePtr(params_);
713 external::Template const & et = *et_ptr;
715 external::Template::Formats::const_iterator cit =
716 et.formats.find("LaTeX");
717 if (cit == et.formats.end())
720 if (!cit->second.requirement.empty())
721 features.require(cit->second.requirement);
723 external::TemplateManager & etm = external::TemplateManager::get();
725 vector<string>::const_iterator it = cit->second.preambleNames.begin();
726 vector<string>::const_iterator end = cit->second.preambleNames.end();
727 for (; it != end; ++it) {
728 string const preamble = etm.getPreambleDefByName(*it);
729 if (!preamble.empty())
730 features.addExternalPreamble(preamble);
741 bool preview_wanted(InsetExternalParams const & params)
743 string const included_file = params.filename.absFilename();
745 return params.display == external::PreviewDisplay &&
746 support::IsFileReadable(included_file);
750 string const latex_string(InsetExternal const & inset, Buffer const & buffer)
753 LatexRunParams runparams;
754 runparams.flavor = LatexRunParams::LATEX;
755 inset.latex(buffer, os, runparams);
761 void add_preview(RenderMonitoredPreview & renderer, InsetExternal const & inset,
762 Buffer const & buffer)
764 InsetExternalParams const & params = inset.params();
765 if (RenderPreview::activated() && preview_wanted(params)) {
766 renderer.setAbsFile(params.filename.absFilename());
767 string const snippet = latex_string(inset, buffer);
768 renderer.addPreview(snippet, buffer);
775 void InsetExternal::addPreview(graphics::PreviewLoader & ploader) const
777 RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
781 if (preview_wanted(params())) {
782 ptr->setAbsFile(params_.filename.absFilename());
783 string const snippet = latex_string(*this, ploader.buffer());
784 ptr->addPreview(snippet, ploader);
791 string const InsetExternalMailer::name_("external");
793 InsetExternalMailer::InsetExternalMailer(InsetExternal & inset)
798 string const InsetExternalMailer::inset2string(Buffer const & buffer) const
800 return params2string(inset_.params(), buffer);
804 void InsetExternalMailer::string2params(string const & in,
805 Buffer const & buffer,
806 InsetExternalParams & params)
808 params = InsetExternalParams();
813 istringstream data(in);
819 string const token = lex.getString();
824 // This is part of the inset proper that is usually swallowed
825 // by Buffer::readInset
828 string const token = lex.getString();
829 if (token != "External")
834 params.read(buffer, lex);
840 InsetExternalMailer::params2string(InsetExternalParams const & params,
841 Buffer const & buffer)
844 data << name_ << ' ';
845 params.write(buffer, data);
846 data << "\\end_inset\n";