]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetExternal.cpp
Fix trailing whitespace in cpp files.
[lyx.git] / src / insets / InsetExternal.cpp
index 7225da7472dd46783ce325a814102b3dba826040..32075d4cf52fe13ad9a7c5b0d49ba60e3f68bd3a 100644 (file)
@@ -30,6 +30,9 @@
 #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 "support/ExceptionMessage.h"
 #include "support/filetools.h"
 #include "support/gettext.h"
+#include "support/lassert.h"
 #include "support/lstrings.h"
 #include "support/lyxlib.h"
-#include "support/Translator.h"
-
-#include "support/bind.h"
+#include "support/TempFile.h"
 
 #include <sstream>
+#include <vector>
 
 using namespace std;
 using namespace lyx::support;
@@ -69,15 +72,20 @@ namespace external {
 
 TempName::TempName()
 {
-       FileName const tempname = FileName::tempName("lyxext");
        // must have an extension for the converter code to work correctly.
-       tempname_ = FileName(tempname.absFileName() + ".tmp");
+       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 &)
+TempName::TempName(TempName const & that)
 {
-       tempname_ = TempName()();
+       *this = that;
 }
 
 
@@ -89,16 +97,28 @@ TempName::~TempName()
 
 TempName & TempName::operator=(TempName const & other)
 {
-       if (this != &other)
-               tempname_ = TempName()();
+       if (this != &other) {
+               if (!tempname_.empty())
+                       tempname_.removeFile();
+               support::TempFile f("lyxextXXXXXX.tmp");
+               f.setAutoRemove(false);
+               tempname_ = f.name();
+       }
        return *this;
 }
 
+
+support::FileName TempName::operator()() const
+{
+       return tempname_;
+}
+
 } // namespace external
 
 
 InsetExternalParams::InsetExternalParams()
        : display(true),
+         preview_mode(PREVIEW_OFF),
          lyxscale(defaultLyxScale),
          draft(false)
 {
@@ -150,7 +170,7 @@ void InsetExternalParams::settemplate(string const & name)
        clearIfNotFound(resizedata,   external::Resize, ids);
        clearIfNotFound(rotationdata, external::Rotate, ids);
 
-       // 
+       //
        preview_mode = et->preview_mode;
 }
 
@@ -265,20 +285,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;
@@ -286,13 +312,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:
@@ -365,15 +391,42 @@ 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 anon
+
+
+
 InsetExternal::InsetExternal(Buffer * buf)
        : Inset(buf), renderer_(new RenderButton)
 {
 }
 
 
+// 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))
 {}
@@ -382,6 +435,19 @@ InsetExternal::InsetExternal(InsetExternal const & other)
 InsetExternal::~InsetExternal()
 {
        hideDialogs("external", this);
+
+       map<BufferView const *, bool>::iterator it = mouse_hover_.begin();
+       map<BufferView const *, bool>::iterator end = mouse_hover_.end();
+       for (; it != end; ++it)
+               if (it->second)
+                       it->first->clearLastInset(this);
+}
+
+
+bool InsetExternal::setMouseHover(BufferView const * bv, bool mouse_hover) const
+{
+       mouse_hover_[bv] = mouse_hover;
+       return true;
 }
 
 
@@ -406,6 +472,7 @@ void InsetExternal::doDispatch(Cursor & cur, FuncRequest & cmd)
        case LFUN_INSET_MODIFY: {
                InsetExternalParams p;
                string2params(to_utf8(cmd.argument()), buffer(), p);
+               cur.recordUndo();
                setParams(p);
                break;
        }
@@ -438,6 +505,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()),
@@ -454,6 +531,8 @@ void InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const
 
 void InsetExternal::draw(PainterInfo & pi, int x, int y) const
 {
+       if (renderer_->asButton())
+               renderer_->setRenderState(mouse_hover_[pi.base.bv]);
        renderer_->draw(pi, x, y);
 }
 
@@ -474,22 +553,6 @@ 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);
-       return from_utf8(external::doSubstitution(params, buffer,
-                               to_utf8(gui), false));
-}
-
 } // namespace anon
 
 
@@ -501,13 +564,14 @@ static bool isPreviewWanted(InsetExternalParams const & params)
 
 static docstring latexString(InsetExternal const & inset)
 {
-       odocstringstream os;
+       odocstringstream ods;
+       otexstream os(ods);
        // We don't need to set runparams.encoding since it is not used by
        // latex().
        OutputParams runparams(0);
        runparams.flavor = OutputParams::LATEX;
        inset.latex(os, runparams);
-       return os.str();
+       return ods.str();
 }
 
 
@@ -517,8 +581,7 @@ static void add_preview_and_start_loading(RenderMonitoredPreview & renderer,
 {
        InsetExternalParams const & params = inset.params();
 
-       if (RenderPreview::status() != LyXRC::PREVIEW_OFF &&
-           isPreviewWanted(params)) {
+       if (RenderPreview::previewText() && isPreviewWanted(params)) {
                renderer.setAbsFile(params.filename);
                docstring const snippet = latexString(inset);
                renderer.addPreview(snippet, buffer);
@@ -552,13 +615,13 @@ void InsetExternal::setParams(InsetExternalParams const & p)
                || !lyxrc.display_graphics
                || params_.preview_mode == PREVIEW_OFF
                || (params_.preview_mode == PREVIEW_INSTANT
-                   && RenderPreview::status() == LyXRC::PREVIEW_OFF)) {
+                   && !RenderPreview::previewText())) {
                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;
        }
 
@@ -568,15 +631,13 @@ void InsetExternal::setParams(InsetExternalParams const & p)
                LASSERT(false, return);
                break;
        case PREVIEW_INSTANT: {
+               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) {
@@ -597,7 +658,7 @@ void InsetExternal::fileChanged() const
                return;
 
        RenderMonitoredPreview * const ptr = renderer_->asMonitoredPreview();
-       LASSERT(ptr, /**/);
+       LASSERT(ptr, return);
 
        ptr->removePreview(*buffer);
        add_preview_and_start_loading(*ptr, *this, *buffer);
@@ -618,14 +679,14 @@ void InsetExternal::read(Lexer & lex)
 }
 
 
-int InsetExternal::latex(odocstream & os, OutputParams const & runparams) const
+void InsetExternal::latex(otexstream & os, OutputParams const & runparams) const
 {
        if (params_.draft) {
                // FIXME UNICODE
                os << "\\fbox{\\ttfamily{}"
                   << from_utf8(params_.filename.outputFileName(buffer().filePath()))
                   << "}\n";
-               return 1;
+               return;
        }
 
        // "nice" means that the buffer is exported to LaTeX format but not
@@ -641,35 +702,42 @@ int InsetExternal::latex(odocstream & os, OutputParams const & runparams) const
                external::Template const * const et_ptr =
                        external::getTemplatePtr(params_);
                if (!et_ptr)
-                       return 0;
+                       return;
                external::Template const & et = *et_ptr;
 
                external::Template::Formats::const_iterator cit =
                        et.formats.find("PDFLaTeX");
 
                if (cit != et.formats.end()) {
-                       return external::writeExternal(params_, "PDFLaTeX",
-                                                      buffer(), os,
-                                                      *(runparams.exportdata),
-                                                      external_in_tmpdir,
-                                                      dryrun);
+                       external::writeExternal(params_, "PDFLaTeX",
+                                               buffer(), os,
+                                               *(runparams.exportdata),
+                                               external_in_tmpdir,
+                                               dryrun);
+                       return;
                }
        }
 
-       return external::writeExternal(params_, "LaTeX", buffer(), os,
-                                      *(runparams.exportdata),
-                                      external_in_tmpdir,
-                                      dryrun);
+       external::writeExternal(params_, "LaTeX", buffer(), os,
+                               *(runparams.exportdata),
+                               external_in_tmpdir,
+                               dryrun);
 }
 
 
-int InsetExternal::plaintext(odocstream & os,
-                            OutputParams const & runparams) const
+int InsetExternal::plaintext(odocstringstream & os,
+                            OutputParams const & runparams, size_t) const
 {
-       os << '\n'; // output external material on a new line
-       external::writeExternal(params_, "Ascii", buffer(), os,
-                               *(runparams.exportdata), false,
-                               runparams.dryrun || runparams.inComment);
+       // this is too slow for constant use
+       if (runparams.for_tooltip)
+               return 0;
+
+       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), external_in_tmpdir, dryrun);
        return PLAINTEXT_NEWLINE;
 }
 
@@ -677,18 +745,27 @@ int InsetExternal::plaintext(odocstream & os,
 int InsetExternal::docbook(odocstream & os,
                           OutputParams const & runparams) const
 {
-       return external::writeExternal(params_, "DocBook", 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::writeExternal(params_, "DocBook", buffer(), ots,
+                               *(runparams.exportdata), external_in_tmpdir, dryrun);
+       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::writeExternal(params_, "XHTML", buffer(), ots,
+                                      *(runparams.exportdata), external_in_tmpdir, dryrun);
+       xs << XHTMLStream::ESCAPE_NONE << ods.str();
        return docstring();
 }
 
@@ -707,8 +784,10 @@ void InsetExternal::validate(LaTeXFeatures & features) const
        string format;
        switch (features.runparams().flavor) {
        case OutputParams::LATEX:
+       case OutputParams::DVILUATEX:
                format = "LaTeX";
                break;
+       case OutputParams::LUATEX:
        case OutputParams::PDFLATEX:
        case OutputParams::XETEX:
                format = "PDFLaTeX";
@@ -722,6 +801,9 @@ void InsetExternal::validate(LaTeXFeatures & features) const
        case OutputParams::TEXT:
                format = "text";
                break;
+       case OutputParams::LYX:
+               format = "lyx";
+               break;
        }
        external::Template::Formats::const_iterator cit =
                et.formats.find(format);
@@ -737,7 +819,7 @@ void InsetExternal::validate(LaTeXFeatures & features) const
                        return;
        }
 
-       // FIXME: We don't need that always
+       // FIXME: We don't need that always, see InsetGraphics
        features.require("lyxdot");
 
        vector<string>::const_iterator it  = cit->second.requirements.begin();
@@ -747,10 +829,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);
        }
@@ -758,7 +838,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)
@@ -772,9 +852,9 @@ void InsetExternal::addPreview(DocIterator const & /*inset_pos*/,
 }
 
 
-docstring InsetExternal::contextMenu(BufferView const &, int, int) const
+string InsetExternal::contextMenuName() const
 {
-       return from_ascii("context-external");
+       return "context-external";
 }