]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetExternal.cpp
Make script inset much tighter in texted.
[lyx.git] / src / insets / InsetExternal.cpp
index 6417013696a3f043dc12ae4ea3ed3014bb2f0583..f604a1fb9d2e0028005a57524e643037b60e35c9 100644 (file)
@@ -18,6 +18,7 @@
 
 #include "Buffer.h"
 #include "BufferView.h"
+#include "Converter.h"
 #include "Cursor.h"
 #include "DispatchResult.h"
 #include "Exporter.h"
 #include "MetricsInfo.h"
 #include "OutputParams.h"
 #include "output_latex.h"
+#include "output_xhtml.h"
+#include "texstream.h"
+#include "TocBackend.h"
 
 #include "frontends/alert.h"
 #include "frontends/Application.h"
 
 #include "graphics/PreviewLoader.h"
 
-#include "support/bind.h"
 #include "support/convert.h"
 #include "support/debug.h"
 #include "support/ExceptionMessage.h"
@@ -59,7 +62,7 @@ unsigned int const defaultLyxScale = 100;
 
 string defaultTemplateName;
 
-} // namespace anon
+} // namespace
 
 
 namespace lyx {
@@ -68,13 +71,20 @@ namespace Alert = frontend::Alert;
 
 namespace external {
 
-TempName::TempName() : tempfile_(new support::TempFile("lyxextXXXXXX.tmp"))
+TempName::TempName()
 {
        // must have an extension for the converter code to work correctly.
+       support::TempFile f("lyxextXXXXXX.tmp");
+       // Let f go out of scope here and delete the file ourselves in
+       // ~TempName(), since otherwise external processes would not be able
+       // to use the file on windows (bug 9925). This is not as safe as
+       // keeping a support::TempFile member would be, but the best we can do.
+       f.setAutoRemove(false);
+       tempname_ = f.name();
 }
 
 
-TempName::TempName(TempName const & that) : tempfile_(0)
+TempName::TempName(TempName const & that)
 {
        *this = that;
 }
@@ -82,15 +92,18 @@ TempName::TempName(TempName const & that) : tempfile_(0)
 
 TempName::~TempName()
 {
-       delete tempfile_;
+       tempname_.removeFile();
 }
 
 
 TempName & TempName::operator=(TempName const & other)
 {
        if (this != &other) {
-               delete tempfile_;
-               tempfile_ = new support::TempFile("lyxextXXXXXX.tmp");
+               if (!tempname_.empty())
+                       tempname_.removeFile();
+               support::TempFile f("lyxextXXXXXX.tmp");
+               f.setAutoRemove(false);
+               tempname_ = f.name();
        }
        return *this;
 }
@@ -98,7 +111,7 @@ TempName & TempName::operator=(TempName const & other)
 
 support::FileName TempName::operator()() const
 {
-       return tempfile_->name();
+       return tempname_;
 }
 
 } // namespace external
@@ -106,6 +119,7 @@ support::FileName TempName::operator()() const
 
 InsetExternalParams::InsetExternalParams()
        : display(true),
+         preview_mode(PREVIEW_OFF),
          lyxscale(defaultLyxScale),
          draft(false)
 {
@@ -135,7 +149,7 @@ void clearIfNotFound(T & data, external::TransformID value,
                data = T();
 }
 
-} // namespace anon
+} // namespace
 
 
 void InsetExternalParams::settemplate(string const & name)
@@ -157,7 +171,7 @@ void InsetExternalParams::settemplate(string const & name)
        clearIfNotFound(resizedata,   external::Resize, ids);
        clearIfNotFound(rotationdata, external::Rotate, ids);
 
-       // 
+       //
        preview_mode = et->preview_mode;
 }
 
@@ -272,20 +286,26 @@ bool InsetExternalParams::read(Buffer const & buffer, Lexer & lex)
                case EX_FILENAME: {
                        lex.eatLine();
                        string const name = lex.getString();
-                       filename.set(name, buffer.filePath());
+                       filename = buffer.getReferencedFileName(name);
                        break;
                }
-               
+
                case EX_DISPLAY: {
                        lex.next();
                        display = lex.getString() != "false";
                        break;
                }
 
-               case EX_LYXSCALE:
+               case EX_LYXSCALE: {
                        lex.next();
-                       lyxscale = lex.getInteger();
+                       int const ls = lex.getInteger();
+                       // negative values are not accepted.
+                       if (ls >= 0)
+                               lyxscale = ls;
+                       else
+                               lex.printError("ExternalInset::read: Wrong lyxscale: $$Token");
                        break;
+               }
 
                case EX_DRAFT:
                        draft = true;
@@ -293,13 +313,13 @@ bool InsetExternalParams::read(Buffer const & buffer, Lexer & lex)
 
                case EX_BOUNDINGBOX:
                        lex.next();
-                       clipdata.bbox.xl = lex.getInteger();
+                       clipdata.bbox.xl = Length(lex.getString());
                        lex.next();
-                       clipdata.bbox.yb = lex.getInteger();
+                       clipdata.bbox.yb = Length(lex.getString());
                        lex.next();
-                       clipdata.bbox.xr = lex.getInteger();
+                       clipdata.bbox.xr = Length(lex.getString());
                        lex.next();
-                       clipdata.bbox.yt = lex.getInteger();
+                       clipdata.bbox.yt = Length(lex.getString());
                        break;
 
                case EX_CLIP:
@@ -372,6 +392,32 @@ bool InsetExternalParams::read(Buffer const & buffer, Lexer & lex)
 }
 
 
+namespace {
+
+docstring screenLabel(InsetExternalParams const & params,
+                           Buffer const & buffer)
+{
+       external::Template const * const ptr =
+               external::getTemplatePtr(params);
+       if (!ptr)
+               // FIXME UNICODE
+               return bformat((_("External template %1$s is not installed")),
+                                       from_utf8(params.templatename()));
+       // FIXME UNICODE
+       docstring gui = _(ptr->guiName);
+       gui += ": ";
+
+       if (params.filename.empty())
+               gui += "???";
+       else
+               gui += from_utf8(params.filename.relFileName(buffer.filePath()));
+
+       return gui;
+}
+
+} // namespace
+
+
 InsetExternal::InsetExternal(Buffer * buf)
        : Inset(buf), renderer_(new RenderButton)
 {
@@ -381,7 +427,6 @@ InsetExternal::InsetExternal(Buffer * buf)
 // Mouse hover is not copied and remains empty
 InsetExternal::InsetExternal(InsetExternal const & other)
        : Inset(other),
-         boost::signals::trackable(),
          params_(other.params_),
          renderer_(other.renderer_->clone(this))
 {}
@@ -406,12 +451,6 @@ bool InsetExternal::setMouseHover(BufferView const * bv, bool mouse_hover) const
 }
 
 
-void InsetExternal::statusChanged() const
-{
-       updateFrontend();
-}
-
-
 void InsetExternal::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
        switch (cmd.action()) {
@@ -460,6 +499,16 @@ bool InsetExternal::getStatus(Cursor & cur, FuncRequest const & cmd,
 }
 
 
+void InsetExternal::addToToc(DocIterator const & cpit, bool output_active,
+                                                        UpdateType, TocBackend & backend) const
+{
+       docstring str = screenLabel(params_, buffer());
+       TocBuilder & b = backend.builder("external");
+       b.pushItem(cpit, str, output_active);
+       b.pop();
+}
+
+
 bool InsetExternal::showInsetDialog(BufferView * bv) const
 {
        bv->showDialog("external", params2string(params(), bv->buffer()),
@@ -470,12 +519,18 @@ bool InsetExternal::showInsetDialog(BufferView * bv) const
 
 void InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const
 {
+       if (!isRendererValid())
+               updatePreview();
+
        renderer_->metrics(mi, dim);
 }
 
 
 void InsetExternal::draw(PainterInfo & pi, int x, int y) const
 {
+       if (!isRendererValid())
+               updatePreview();
+
        if (renderer_->asButton())
                renderer_->setRenderState(mouse_hover_[pi.base.bv]);
        renderer_->draw(pi, x, y);
@@ -498,29 +553,7 @@ graphics::Params get_grfx_params(InsetExternalParams const & eparams)
        return gparams;
 }
 
-
-docstring screenLabel(InsetExternalParams const & params,
-                           Buffer const & buffer)
-{
-       external::Template const * const ptr =
-               external::getTemplatePtr(params);
-       if (!ptr)
-               // FIXME UNICODE
-               return bformat((_("External template %1$s is not installed")),
-                                       from_utf8(params.templatename()));
-       // FIXME UNICODE
-       docstring gui = _(ptr->guiName);
-       gui += ": ";
-
-       if (params.filename.empty())
-               gui += "???";
-       else
-               gui += from_utf8(params.filename.relFileName(buffer.filePath()));
-
-       return gui;
-}
-
-} // namespace anon
+} // namespace
 
 
 static bool isPreviewWanted(InsetExternalParams const & params)
@@ -531,9 +564,8 @@ static bool isPreviewWanted(InsetExternalParams const & params)
 
 static docstring latexString(InsetExternal const & inset)
 {
-       TexRow texrow;
        odocstringstream ods;
-       otexstream os(ods, texrow);
+       otexstream os(ods);
        // We don't need to set runparams.encoding since it is not used by
        // latex().
        OutputParams runparams(0);
@@ -564,9 +596,22 @@ InsetExternalParams const & InsetExternal::params() const
 }
 
 
-void InsetExternal::updatePreview()
+bool InsetExternal::isPreviewed() const
+{
+       return (external::getTemplatePtr(params_) && !params_.filename.empty()
+               && params_.display
+               && lyxrc.display_graphics
+               && params_.preview_mode != PREVIEW_OFF
+               && (params_.preview_mode != PREVIEW_INSTANT
+                   || RenderPreview::previewText()));
+}
+
+
+bool InsetExternal::isRendererValid() const
 {
-       setParams(params_);
+       if (!renderer_->asButton())
+               return isPreviewed();
+       return !isPreviewed();
 }
 
 
@@ -578,18 +623,19 @@ void InsetExternal::setParams(InsetExternalParams const & p)
        // will use this.
        defaultTemplateName = params_.templatename();
 
-       if (!external::getTemplatePtr(params_) || params_.filename.empty()
-               || !params_.display
-               || !lyxrc.display_graphics
-               || params_.preview_mode == PREVIEW_OFF
-               || (params_.preview_mode == PREVIEW_INSTANT
-                   && !RenderPreview::previewText())) {
+       updatePreview();
+}
+
+
+void InsetExternal::updatePreview() const
+{
+       if (!isPreviewed()) {
                RenderButton * button_ptr = renderer_->asButton();
                if (!button_ptr) {
                        renderer_.reset(new RenderButton);
                        button_ptr = renderer_->asButton();
                }
-               button_ptr->update(screenLabel(params_, buffer()), true);
+               button_ptr->update(screenLabel(params_, buffer()), true, false);
                return;
        }
 
@@ -599,16 +645,13 @@ void InsetExternal::setParams(InsetExternalParams const & p)
                LASSERT(false, return);
                break;
        case PREVIEW_INSTANT: {
-               //FIXME: why is the value below immediately forgotten?
+               renderer_ = make_unique<RenderMonitoredPreview>(this);
                RenderMonitoredPreview * preview_ptr = renderer_->asMonitoredPreview();
-               renderer_.reset(new RenderMonitoredPreview(this));
-               preview_ptr = renderer_->asMonitoredPreview();
-               preview_ptr->fileChanged(bind(&InsetExternal::fileChanged, this));
-               if (preview_ptr->monitoring())
-                       preview_ptr->stopMonitoring();
+               // This connection is closed at the same time as this is destroyed.
+               preview_ptr->connect([=]() { fileChanged(); });
                add_preview_and_start_loading(*preview_ptr, *this, buffer());
                break;
-       } 
+       }
        case PREVIEW_GRAPHICS: {
                RenderGraphic * graphic_ptr = renderer_->asGraphic();
                if (!graphic_ptr) {
@@ -680,19 +723,26 @@ void InsetExternal::latex(otexstream & os, OutputParams const & runparams) const
                        et.formats.find("PDFLaTeX");
 
                if (cit != et.formats.end()) {
-                       external::writeExternal(params_, "PDFLaTeX",
-                                               buffer(), os,
-                                               *(runparams.exportdata),
-                                               external_in_tmpdir,
-                                               dryrun);
+                       external::RetVal retval =
+                               external::writeExternal(params_, "PDFLaTeX", buffer(), os,
+                                   *(runparams.exportdata), external_in_tmpdir, dryrun);
+                       if (retval == external::KILLED) {
+                               LYXERR0("External template preparation killed.");
+                               if (buffer().isClone() && buffer().isExporting())
+                                       throw ConversionException();
+                       }
                        return;
                }
        }
 
-       external::writeExternal(params_, "LaTeX", buffer(), os,
-                               *(runparams.exportdata),
-                               external_in_tmpdir,
-                               dryrun);
+       external::RetVal retval =
+               external::writeExternal(params_, "LaTeX", buffer(), os,
+                   *(runparams.exportdata), external_in_tmpdir, dryrun);
+       if (retval == external::KILLED) {
+               LYXERR0("External template preparation killed.");
+               if (buffer().isClone() && buffer().isExporting())
+                       throw ConversionException();
+       }
 }
 
 
@@ -703,12 +753,18 @@ int InsetExternal::plaintext(odocstringstream & os,
        if (runparams.for_tooltip)
                return 0;
 
-       TexRow texrow;
-       otexstream ots(os, texrow);
+       bool const external_in_tmpdir = !runparams.nice;
+       bool const dryrun = runparams.dryrun || runparams.inComment;
+       otexstream ots(os);
        ots << '\n'; // output external material on a new line
-       external::writeExternal(params_, "Ascii", buffer(), ots,
-                               *(runparams.exportdata), false,
-                               runparams.dryrun || runparams.inComment);
+       external::RetVal retval =
+               external::writeExternal(params_, "Ascii", buffer(), ots,
+                   *(runparams.exportdata), external_in_tmpdir, dryrun);
+       if (retval == external::KILLED) {
+               LYXERR0("External template preparation killed.");
+               if (buffer().isClone() && buffer().isExporting())
+                       throw ConversionException();
+       }
        return PLAINTEXT_NEWLINE;
 }
 
@@ -716,23 +772,39 @@ int InsetExternal::plaintext(odocstringstream & os,
 int InsetExternal::docbook(odocstream & os,
                           OutputParams const & runparams) const
 {
-       TexRow texrow;
+       bool const external_in_tmpdir = !runparams.nice;
+       bool const dryrun = runparams.dryrun || runparams.inComment;
        odocstringstream ods;
-       otexstream ots(ods, texrow);
-       external::writeExternal(params_, "DocBook", buffer(), ots,
-                               *(runparams.exportdata), false,
-                               runparams.dryrun || runparams.inComment);
+       otexstream ots(ods);
+       external::RetVal retval =
+               external::writeExternal(params_, "DocBook", buffer(), ots,
+                   *(runparams.exportdata), external_in_tmpdir, dryrun);
+       if (retval == external::KILLED) {
+               LYXERR0("External template preparation killed.");
+               if (buffer().isClone() && buffer().isExporting())
+                       throw ConversionException();
+       }
        os << ods.str();
        return int(count(ods.str().begin(), ods.str().end(), '\n'));
 }
 
 
-docstring InsetExternal::xhtml(XHTMLStream  & /*xs*/,
-                       OutputParams const & /*rp*/) const
+docstring InsetExternal::xhtml(XHTMLStream & xs,
+                       OutputParams const & runparams) const
 {
-//     external::writeExternal(params_, "XHTML", buffer(), os,
-//                                    *(runparams.exportdata), false,
-//                                    runparams.dryrun || runparams.inComment);
+       bool const external_in_tmpdir = !runparams.nice;
+       bool const dryrun = runparams.dryrun || runparams.inComment;
+       odocstringstream ods;
+       otexstream ots(ods);
+       external::RetVal retval =
+               external::writeExternal(params_, "XHTML", buffer(), ots,
+                   *(runparams.exportdata), external_in_tmpdir, dryrun);
+       if (retval == external::KILLED) {
+               LYXERR0("External template preparation killed.");
+               if (buffer().isClone() && buffer().isExporting())
+                       throw ConversionException();
+       }
+       xs << XHTMLStream::ESCAPE_NONE << ods.str();
        return docstring();
 }
 
@@ -796,10 +868,8 @@ void InsetExternal::validate(LaTeXFeatures & features) const
 
        external::TemplateManager & etm = external::TemplateManager::get();
 
-       it  = cit->second.preambleNames.begin();
-       end = cit->second.preambleNames.end();
-       for (; it != end; ++it) {
-               string const preamble = etm.getPreambleDefByName(*it);
+       for (string const & name : cit->second.preambleNames) {
+               docstring const preamble = etm.getPreambleDefByName(name);
                if (!preamble.empty())
                        features.addPreambleSnippet(preamble);
        }
@@ -807,7 +877,7 @@ void InsetExternal::validate(LaTeXFeatures & features) const
 
 
 void InsetExternal::addPreview(DocIterator const & /*inset_pos*/,
-       graphics::PreviewLoader & ploader) const        
+                               graphics::PreviewLoader & ploader) const
 {
        RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
        if (!ptr)