X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Finsets%2Finsetexternal.C;h=910d3d071a55a3d2230672a217d987144652de64;hb=e28331ed63062dea10d0a21b9ec12034b4b17b9a;hp=f18fbc0a8a730c5ef6bb59630253cb1302944e9a;hpb=87ca6fbbeb83fa95310789e6d692e43cbfcdb6f5;p=lyx.git diff --git a/src/insets/insetexternal.C b/src/insets/insetexternal.C index f18fbc0a8a..910d3d071a 100644 --- a/src/insets/insetexternal.C +++ b/src/insets/insetexternal.C @@ -15,33 +15,34 @@ #include "insets/ExternalTemplate.h" #include "insets/render_button.h" #include "insets/render_graphic.h" +#include "insets/render_preview.h" #include "buffer.h" -#include "BufferView.h" +#include "cursor.h" #include "debug.h" +#include "dispatchresult.h" +#include "exporter.h" +#include "FuncStatus.h" #include "funcrequest.h" #include "gettext.h" #include "LaTeXFeatures.h" -#include "latexrunparams.h" #include "lyx_main.h" #include "lyxlex.h" #include "lyxrc.h" #include "metricsinfo.h" +#include "outputparams.h" -#include "frontends/lyx_gui.h" -#include "frontends/LyXView.h" +#include "graphics/PreviewLoader.h" +#include "support/filetools.h" #include "support/lstrings.h" #include "support/lyxlib.h" -#include "support/tostr.h" +#include "support/convert.h" #include "support/translator.h" #include -#include "support/std_sstream.h" - -namespace support = lyx::support; -namespace external = lyx::external; +#include using std::endl; using std::string; @@ -54,22 +55,26 @@ using std::vector; namespace { -lyx::graphics::DisplayType const defaultDisplayType = lyx::graphics::NoDisplay; +lyx::external::DisplayType const defaultDisplayType = lyx::external::NoDisplay; + +unsigned int const defaultLyxScale = 100; -unsigned int defaultLyxScale = 100; +string defaultTemplateName = "RasterImage"; } // namespace anon namespace lyx { + namespace external { TempName::TempName() { - tempname_ = support::tempName(string(), "lyxext"); - support::unlink(tempname_); + support::FileName const tempname(support::tempName(support::FileName(), "lyxext")); + // FIXME: This is unsafe + support::unlink(tempname); // must have an extension for the converter code to work correctly. - tempname_ += ".tmp"; + tempname_ = support::FileName(tempname.absFilename() + ".tmp"); } @@ -93,13 +98,42 @@ TempName::operator=(TempName const & other) return *this; } + +namespace { + +/// The translator between the Display enum and corresponding lyx string. +Translator const initTranslator() +{ + Translator translator(DefaultDisplay, "default"); + + // Fill the display translator + translator.addPair(MonochromeDisplay, "monochrome"); + translator.addPair(GrayscaleDisplay, "grayscale"); + translator.addPair(ColorDisplay, "color"); + translator.addPair(PreviewDisplay, "preview"); + translator.addPair(NoDisplay, "none"); + + return translator; +} + +} // namespace anon + + +Translator const & displayTranslator() +{ + static Translator const translator = + initTranslator(); + return translator; +} + } // namespace external -} // namespace lyx InsetExternalParams::InsetExternalParams() : display(defaultDisplayType), - lyxscale(defaultLyxScale) + lyxscale(defaultLyxScale), + draft(false), + templatename_(defaultTemplateName) {} @@ -155,11 +189,14 @@ void InsetExternalParams::write(Buffer const & buffer, ostream & os) const if (display != defaultDisplayType) os << "\tdisplay " - << lyx::graphics::displayTranslator().find(display) + << external::displayTranslator().find(display) << '\n'; if (lyxscale != defaultLyxScale) - os << "\tlyxscale " << tostr(lyxscale) << '\n'; + os << "\tlyxscale " << convert(lyxscale) << '\n'; + + if (draft) + os << "\tdraft\n"; if (!clipdata.bbox.empty()) os << "\tboundingBox " << clipdata.bbox << '\n'; @@ -175,7 +212,7 @@ void InsetExternalParams::write(Buffer const & buffer, ostream & os) const } if (!rotationdata.no_rotation()) { - os << "\trotateAngle " << rotationdata.angle() << '\n'; + os << "\trotateAngle " << rotationdata.adjAngle() << '\n'; if (rotationdata.origin() != external::RotationData::DEFAULT) os << "\trotateOrigin " << rotationdata.originString() << '\n'; @@ -183,9 +220,9 @@ void InsetExternalParams::write(Buffer const & buffer, ostream & os) const if (!resizedata.no_resize()) { using support::float_equal; - - if (!float_equal(resizedata.scale, 0.0, 0.05)) { - if (!float_equal(resizedata.scale, 100.0, 0.05)) + double const scl = convert(resizedata.scale); + if (!float_equal(scl, 0.0, 0.05)) { + if (!float_equal(scl, 100.0, 0.05)) os << "\tscale " << resizedata.scale << '\n'; } else { @@ -209,6 +246,7 @@ bool InsetExternalParams::read(Buffer const & buffer, LyXLex & lex) EX_FILENAME, EX_DISPLAY, EX_LYXSCALE, + EX_DRAFT, EX_BOUNDINGBOX, EX_CLIP, EX_EXTRA, @@ -226,6 +264,7 @@ bool InsetExternalParams::read(Buffer const & buffer, LyXLex & lex) { "boundingBox", EX_BOUNDINGBOX }, { "clip", EX_CLIP }, { "display", EX_DISPLAY}, + { "draft", EX_DRAFT}, { "extra", EX_EXTRA }, { "filename", EX_FILENAME}, { "height", EX_HEIGHT }, @@ -251,7 +290,7 @@ bool InsetExternalParams::read(Buffer const & buffer, LyXLex & lex) break; case EX_FILENAME: { - lex.next(); + lex.eatLine(); string const name = lex.getString(); filename.set(name, buffer.filePath()); break; @@ -260,7 +299,7 @@ bool InsetExternalParams::read(Buffer const & buffer, LyXLex & lex) case EX_DISPLAY: { lex.next(); string const name = lex.getString(); - display = lyx::graphics::displayTranslator().find(name); + display = external::displayTranslator().find(name); break; } @@ -269,6 +308,10 @@ bool InsetExternalParams::read(Buffer const & buffer, LyXLex & lex) lyxscale = lex.getInteger(); break; + case EX_DRAFT: + draft = true; + break; + case EX_BOUNDINGBOX: lex.next(); clipdata.bbox.xl = lex.getInteger(); @@ -303,7 +346,7 @@ bool InsetExternalParams::read(Buffer const & buffer, LyXLex & lex) case EX_ROTATEANGLE: lex.next(); - rotationdata.angle(lex.getFloat()); + rotationdata.angle = lex.getString(); break; case EX_ROTATEORIGIN: @@ -313,7 +356,7 @@ bool InsetExternalParams::read(Buffer const & buffer, LyXLex & lex) case EX_SCALE: lex.next(); - resizedata.scale = lex.getFloat(); + resizedata.scale = lex.getString(); break; case EX_WIDTH: @@ -337,7 +380,7 @@ bool InsetExternalParams::read(Buffer const & buffer, LyXLex & lex) } if (!found_end) - lex.printError("ExternalInset::read: Missing \\end_inset."); + lex.printError("ExternalInsetParams::read: Missing \\end_inset."); // This is a trick to make sure that the data are self-consistent. settemplate(templatename_); @@ -360,16 +403,11 @@ InsetExternal::InsetExternal(InsetExternal const & other) : InsetOld(other), boost::signals::trackable(), params_(other.params_), - renderer_(other.renderer_->clone()) -{ - RenderGraphic * ptr = - dynamic_cast(renderer_.get()); - if (ptr) - ptr->connect(boost::bind(&InsetExternal::statusChanged, this)); -} + renderer_(other.renderer_->clone(this)) +{} -auto_ptr InsetExternal::clone() const +auto_ptr InsetExternal::doClone() const { return auto_ptr(new InsetExternal(*this)); } @@ -387,94 +425,165 @@ void InsetExternal::statusChanged() const } -dispatch_result -InsetExternal::priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &) +void InsetExternal::doDispatch(LCursor & cur, FuncRequest & cmd) { switch (cmd.action) { case LFUN_EXTERNAL_EDIT: { - BOOST_ASSERT(cmd.view()); - - Buffer const & buffer = *cmd.view()->buffer(); + Buffer const & buffer = cur.buffer(); InsetExternalParams p; - InsetExternalMailer::string2params(cmd.argument, buffer, p); + InsetExternalMailer::string2params(to_utf8(cmd.argument()), buffer, p); external::editExternal(p, buffer); - return DISPATCHED_NOUPDATE; + break; } case LFUN_INSET_MODIFY: { - BOOST_ASSERT(cmd.view()); - - Buffer const & buffer = *cmd.view()->buffer(); + Buffer const & buffer = cur.buffer(); InsetExternalParams p; - InsetExternalMailer::string2params(cmd.argument, buffer, p); + InsetExternalMailer::string2params(to_utf8(cmd.argument()), buffer, p); setParams(p, buffer); - cmd.view()->updateInset(this); - return DISPATCHED; + break; } case LFUN_INSET_DIALOG_UPDATE: - InsetExternalMailer(*this).updateDialog(cmd.view()); - return DISPATCHED; + InsetExternalMailer(*this).updateDialog(&cur.bv()); + break; case LFUN_MOUSE_RELEASE: - case LFUN_INSET_EDIT: - InsetExternalMailer(*this).showDialog(cmd.view()); - return DISPATCHED; + InsetExternalMailer(*this).showDialog(&cur.bv()); + break; default: - return UNDISPATCHED; + InsetBase::doDispatch(cur, cmd); } } -void InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const +bool InsetExternal::getStatus(LCursor & cur, FuncRequest const & cmd, + FuncStatus & flag) const +{ + switch (cmd.action) { + + case LFUN_EXTERNAL_EDIT: + case LFUN_INSET_MODIFY: + case LFUN_INSET_DIALOG_UPDATE: + flag.enabled(true); + return true; + + default: + return InsetBase::getStatus(cur, cmd, flag); + } +} + + +void InsetExternal::edit(LCursor & cur, bool) +{ + InsetExternalMailer(*this).showDialog(&cur.bv()); +} + + +bool InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const { renderer_->metrics(mi, dim); + bool const changed = dim_ != dim; dim_ = dim; + return changed; } void InsetExternal::draw(PainterInfo & pi, int x, int y) const { + setPosCache(pi, x, y); renderer_->draw(pi, x, y); } namespace { -lyx::graphics::Params get_grfx_params(InsetExternalParams const & eparams) +enum RenderType { + RENDERBUTTON, + RENDERGRAPHIC, + RENDERPREVIEW +}; + + +RenderType getRenderType(InsetExternalParams const & p) +{ + if (!external::getTemplatePtr(p) || + p.filename.empty() || + p.display == external::NoDisplay) + return RENDERBUTTON; + + if (p.display == external::PreviewDisplay) { + if (RenderPreview::status() != LyXRC::PREVIEW_OFF) + return RENDERPREVIEW; + return RENDERBUTTON; + } + + if (p.display == external::DefaultDisplay && + lyxrc.display_graphics == graphics::NoDisplay) + return RENDERBUTTON; + return RENDERGRAPHIC; +} + + +graphics::Params get_grfx_params(InsetExternalParams const & eparams) { - lyx::graphics::Params gparams; + graphics::Params gparams; - gparams.filename = eparams.filename.absFilename(); + gparams.filename = eparams.filename; gparams.scale = eparams.lyxscale; if (eparams.clipdata.clip) gparams.bb = eparams.clipdata.bbox; - gparams.angle = eparams.rotationdata.angle(); - - gparams.display = eparams.display; - if (gparams.display == lyx::graphics::DefaultDisplay) + gparams.angle = convert(eparams.rotationdata.adjAngle()); + + switch (eparams.display) { + case external::DefaultDisplay: + gparams.display = graphics::DefaultDisplay; + break; + case external::MonochromeDisplay: + gparams.display = graphics::MonochromeDisplay; + break; + case external::GrayscaleDisplay: + gparams.display = graphics::GrayscaleDisplay; + break; + case external::ColorDisplay: + gparams.display = graphics::ColorDisplay; + break; + case external::NoDisplay: + gparams.display = graphics::NoDisplay; + break; + default: + BOOST_ASSERT(false); + } + if (gparams.display == graphics::DefaultDisplay) gparams.display = lyxrc.display_graphics; // Override the above if we're not using a gui - if (!lyx_gui::use_gui) - gparams.display = lyx::graphics::NoDisplay; + if (!use_gui) + gparams.display = graphics::NoDisplay; return gparams; } -string const getScreenLabel(InsetExternalParams const & params, +docstring const getScreenLabel(InsetExternalParams const & params, Buffer const & buffer) { external::Template const * const ptr = external::getTemplatePtr(params); if (!ptr) - return support::bformat(_("External template %1$s is not installed"), - params.templatename()); - return external::doSubstitution(params, buffer, ptr->guiName); + // FIXME UNICODE + return support::bformat((_("External template %1$s is not installed")), + from_utf8(params.templatename())); + // FIXME UNICODE + return from_utf8(external::doSubstitution(params, buffer, + ptr->guiName, false)); } +void add_preview_and_start_loading(RenderMonitoredPreview &, + InsetExternal const &, + Buffer const &); + } // namespace anon @@ -487,39 +596,69 @@ InsetExternalParams const & InsetExternal::params() const void InsetExternal::setParams(InsetExternalParams const & p, Buffer const & buffer) { - // The stored params; what we would like to happen in an ideal world. params_ = p; - // We display the inset as a button by default. - bool display_button = (!external::getTemplatePtr(params_) || - params_.filename.empty() || - params_.display == lyx::graphics::NoDisplay); + // Subsequent calls to the InsetExternal::Params default constructor + // will use this. + defaultTemplateName = params_.templatename(); - if (display_button) { - RenderButton * button_ptr = - dynamic_cast(renderer_.get()); + switch (getRenderType(params_)) { + case RENDERBUTTON: { + RenderButton * button_ptr = renderer_->asButton(); if (!button_ptr) { - button_ptr = new RenderButton; - renderer_.reset(button_ptr); + renderer_.reset(new RenderButton); + button_ptr = renderer_->asButton(); } button_ptr->update(getScreenLabel(params_, buffer), true); + break; - } else { - RenderGraphic * graphic_ptr = - dynamic_cast(renderer_.get()); + } case RENDERGRAPHIC: { + RenderGraphic * graphic_ptr = renderer_->asGraphic(); if (!graphic_ptr) { - graphic_ptr = new RenderGraphic; - graphic_ptr->connect( - boost::bind(&InsetExternal::statusChanged, this)); - renderer_.reset(graphic_ptr); + renderer_.reset(new RenderGraphic(this)); + graphic_ptr = renderer_->asGraphic(); } graphic_ptr->update(get_grfx_params(params_)); + + break; + + } case RENDERPREVIEW: { + RenderMonitoredPreview * preview_ptr = + renderer_->asMonitoredPreview(); + if (!preview_ptr) { + renderer_.reset(new RenderMonitoredPreview(this)); + preview_ptr = renderer_->asMonitoredPreview(); + preview_ptr->fileChanged( + boost::bind(&InsetExternal::fileChanged, this)); + } + + if (preview_ptr->monitoring()) + preview_ptr->stopMonitoring(); + add_preview_and_start_loading(*preview_ptr, *this, buffer); + + break; + } } } +void InsetExternal::fileChanged() const +{ + Buffer const * const buffer_ptr = LyX::cref().updateInset(this); + if (!buffer_ptr) + return; + + RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview(); + BOOST_ASSERT(ptr); + + Buffer const & buffer = *buffer_ptr; + ptr->removePreview(buffer); + add_preview_and_start_loading(*ptr, *this, buffer); +} + + void InsetExternal::write(Buffer const & buffer, ostream & os) const { params_.write(buffer, os); @@ -534,19 +673,26 @@ void InsetExternal::read(Buffer const & buffer, LyXLex & lex) } -int InsetExternal::latex(Buffer const & buf, ostream & os, - LatexRunParams const & runparams) const +int InsetExternal::latex(Buffer const & buf, odocstream & os, + OutputParams const & runparams) const { + if (params_.draft) { + // FIXME UNICODE + os << "\\fbox{\\ttfamily{}" + << from_utf8(params_.filename.outputFilename(buf.filePath())) + << "}\n"; + return 1; + } + // "nice" means that the buffer is exported to LaTeX format but not // run through the LaTeX compiler. // If we're running through the LaTeX compiler, we should write the // generated files in the bufer's temporary directory. - bool const external_in_tmpdir = - lyxrc.use_tempdir && !buf.temppath().empty() && !runparams.nice; + bool const external_in_tmpdir = !runparams.nice && !runparams.dryrun; // If the template has specified a PDFLaTeX output, then we try and // use that. - if (runparams.flavor == LatexRunParams::PDFLATEX) { + if (runparams.flavor == OutputParams::PDFLATEX) { external::Template const * const et_ptr = external::getTemplatePtr(params_); if (!et_ptr) @@ -555,62 +701,147 @@ int InsetExternal::latex(Buffer const & buf, ostream & os, external::Template::Formats::const_iterator cit = et.formats.find("PDFLaTeX"); - if (cit != et.formats.end()) + + if (cit != et.formats.end()) { return external::writeExternal(params_, "PDFLaTeX", - buf, os, external_in_tmpdir); + buf, os, + *(runparams.exportdata), + external_in_tmpdir, + runparams.inComment); + } + } - - return external::writeExternal(params_, "LaTeX", - buf, os, external_in_tmpdir); + + return external::writeExternal(params_, "LaTeX", buf, os, + *(runparams.exportdata), + external_in_tmpdir, + runparams.inComment); } -int InsetExternal::ascii(Buffer const & buf, ostream & os, int) const +int InsetExternal::plaintext(Buffer const & buf, odocstream & os, + OutputParams const & runparams) const { - return external::writeExternal(params_, "Ascii", buf, os); + return external::writeExternal(params_, "Ascii", buf, os, + *(runparams.exportdata), false, + runparams.inComment); } -int InsetExternal::linuxdoc(Buffer const & buf, ostream & os) const +int InsetExternal::docbook(Buffer const & buf, odocstream & os, + OutputParams const & runparams) const { - return external::writeExternal(params_, "LinuxDoc", buf, os); -} - - -int InsetExternal::docbook(Buffer const & buf, ostream & os, bool) const -{ - return external::writeExternal(params_, "DocBook", buf, os); + return external::writeExternal(params_, "DocBook", buf, os, + *(runparams.exportdata), false, + runparams.inComment); } void InsetExternal::validate(LaTeXFeatures & features) const { + if (params_.draft) + return; + external::Template const * const et_ptr = external::getTemplatePtr(params_); if (!et_ptr) return; external::Template const & et = *et_ptr; + string format; + switch (features.runparams().flavor) { + case OutputParams::LATEX: + format = "LaTeX"; + break; + case OutputParams::PDFLATEX: + format = "PDFLaTeX"; + break; + case OutputParams::XML: + format = "DocBook"; + break; + } external::Template::Formats::const_iterator cit = - et.formats.find("LaTeX"); + et.formats.find(format); if (cit == et.formats.end()) return; - if (!cit->second.requirement.empty()) - features.require(cit->second.requirement); + // FIXME: We don't need that always + features.require("lyxdot"); + + vector::const_iterator it = cit->second.requirements.begin(); + vector::const_iterator end = cit->second.requirements.end(); + for (; it != end; ++it) + features.require(*it); external::TemplateManager & etm = external::TemplateManager::get(); - vector::const_iterator it = cit->second.preambleNames.begin(); - vector::const_iterator end = cit->second.preambleNames.end(); + it = cit->second.preambleNames.begin(); + end = cit->second.preambleNames.end(); for (; it != end; ++it) { string const preamble = etm.getPreambleDefByName(*it); if (!preamble.empty()) - features.addExternalPreamble(preamble); + features.addPreambleSnippet(preamble); } } +// +// preview stuff +// + +namespace { + +bool preview_wanted(InsetExternalParams const & params) +{ + return params.display == external::PreviewDisplay && + support::isFileReadable(params.filename); +} + + +docstring const latex_string(InsetExternal const & inset, Buffer const & buffer) +{ + odocstringstream os; + OutputParams runparams; + runparams.flavor = OutputParams::LATEX; + inset.latex(buffer, os, runparams); + return os.str(); +} + + +void add_preview_and_start_loading(RenderMonitoredPreview & renderer, + InsetExternal const & inset, + Buffer const & buffer) +{ + InsetExternalParams const & params = inset.params(); + + if (RenderPreview::status() != LyXRC::PREVIEW_OFF && + preview_wanted(params)) { + renderer.setAbsFile(params.filename); + docstring const snippet = latex_string(inset, buffer); + renderer.addPreview(snippet, buffer); + renderer.startLoading(buffer); + } +} + +} // namespace anon + + +void InsetExternal::addPreview(graphics::PreviewLoader & ploader) const +{ + RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview(); + if (!ptr) + return; + + if (preview_wanted(params())) { + ptr->setAbsFile(params_.filename); + docstring const snippet = latex_string(*this, ploader.buffer()); + ptr->addPreview(snippet, ploader); + } +} + + +/// Mailer stuff + string const InsetExternalMailer::name_("external"); InsetExternalMailer::InsetExternalMailer(InsetExternal & inset) @@ -629,7 +860,6 @@ void InsetExternalMailer::string2params(string const & in, InsetExternalParams & params) { params = InsetExternalParams(); - if (in.empty()) return; @@ -637,25 +867,19 @@ void InsetExternalMailer::string2params(string const & in, LyXLex lex(0,0); lex.setStream(data); - if (lex.isOK()) { - lex.next(); - string const token = lex.getString(); - if (token != name_) - return; - } + string name; + lex >> name; + if (!lex || name != name_) + return print_mailer_error("InsetExternalMailer", in, 1, name_); // This is part of the inset proper that is usually swallowed - // by Buffer::readInset - if (lex.isOK()) { - lex.next(); - string const token = lex.getString(); - if (token != "External") - return; - } + // by LyXText::readInset + string id; + lex >> id; + if (!lex || id != "External") + return print_mailer_error("InsetBoxMailer", in, 2, "External"); - if (lex.isOK()) { - params.read(buffer, lex); - } + params.read(buffer, lex); } @@ -669,3 +893,5 @@ InsetExternalMailer::params2string(InsetExternalParams const & params, data << "\\end_inset\n"; return data.str(); } + +} // namespace lyx