]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetExternal.cpp
Fix GRAPHICS_EDIT of InsetGraphics
[lyx.git] / src / insets / InsetExternal.cpp
index ff4e19c9906643a6dc151d7be05d66e2146b0ddd..79d47ca8a519aa2b3ee085b0792cc406c0799c17 100644 (file)
 
 #include "Buffer.h"
 #include "Cursor.h"
-#include "support/debug.h"
 #include "DispatchResult.h"
 #include "Exporter.h"
 #include "FuncStatus.h"
 #include "FuncRequest.h"
-#include "support/gettext.h"
 #include "LaTeXFeatures.h"
 #include "Lexer.h"
+#include "LyX.h" // use_gui
 #include "LyXRC.h"
 #include "MetricsInfo.h"
 #include "OutputParams.h"
 
+#include "frontends/alert.h"
+
 #include "graphics/PreviewLoader.h"
 
+#include "support/debug.h"
+#include "support/ExceptionMessage.h"
 #include "support/filetools.h"
+#include "support/gettext.h"
 #include "support/lstrings.h"
 #include "support/lyxlib.h"
 #include "support/convert.h"
@@ -59,17 +63,17 @@ string defaultTemplateName;
 
 namespace lyx {
 
-extern bool use_gui;
+namespace Alert = frontend::Alert;
 
 namespace external {
 
 TempName::TempName()
 {
-       support::FileName const tempname(support::tempName(support::FileName(), "lyxext"));
+       FileName const tempname = FileName::tempName("lyxext");
        // FIXME: This is unsafe
        tempname.removeFile();
        // must have an extension for the converter code to work correctly.
-       tempname_ = support::FileName(tempname.absFilename() + ".tmp");
+       tempname_ = FileName(tempname.absFilename() + ".tmp");
 }
 
 
@@ -177,21 +181,15 @@ void InsetExternalParams::settemplate(string const & name)
 }
 
 
-void InsetExternalParams::write(Buffer const & buffer, ostream & os) const
+void InsetExternalParams::write(Buffer const & buf, ostream & os) const
 {
        os << "External\n"
           << "\ttemplate " << templatename() << '\n';
 
        if (!filename.empty()) {
-               // when we save, we still use the original filename
-               EmbeddedFiles::EmbeddedFileList::const_iterator it = 
-                       buffer.embeddedFiles().find(filename.toFilesystemEncoding());
-               if (it != buffer.embeddedFiles().end())
-                       os << "\tfilename " << DocFileName(it->absFilename()).outputFilename(buffer.filePath()) << '\n';
-               else
-                       os << "\tfilename " << filename.outputFilename(buffer.filePath()) << '\n';
-       }
-
+               os << "\tfilename " << filename.outputFilename(buf.filePath()) << '\n';
+               os << "\tembed " << (filename.embedded() ? filename.inzipName() : "\"\"") << '\n';
+       }
        if (display != defaultDisplayType)
                os << "\tdisplay "
                   << external::displayTranslator().find(display)
@@ -224,7 +222,6 @@ void InsetExternalParams::write(Buffer const & buffer, ostream & os) const
        }
 
        if (!resizedata.no_resize()) {
-               using support::float_equal;
                double const scl = convert<double>(resizedata.scale);
                if (!float_equal(scl, 0.0, 0.05)) {
                        if (!float_equal(scl, 100.0, 0.05))
@@ -249,6 +246,7 @@ bool InsetExternalParams::read(Buffer const & buffer, Lexer & lex)
        enum ExternalTags {
                EX_TEMPLATE = 1,
                EX_FILENAME,
+               EX_EMBED,
                EX_DISPLAY,
                EX_LYXSCALE,
                EX_DRAFT,
@@ -270,6 +268,7 @@ bool InsetExternalParams::read(Buffer const & buffer, Lexer & lex)
                { "clip",            EX_CLIP },
                { "display",         EX_DISPLAY},
                { "draft",           EX_DRAFT},
+               { "embed",           EX_EMBED},
                { "extra",           EX_EXTRA },
                { "filename",        EX_FILENAME},
                { "height",          EX_HEIGHT },
@@ -298,12 +297,14 @@ bool InsetExternalParams::read(Buffer const & buffer, Lexer & lex)
                        lex.eatLine();
                        string const name = lex.getString();
                        filename.set(name, buffer.filePath());
-                       // maybe this file is embedded
-                       EmbeddedFiles::EmbeddedFileList::const_iterator it = buffer.embeddedFiles().find(filename.toFilesystemEncoding());
-                       if (it != buffer.embeddedFiles().end())
-                               // using available file, embedded or external, depending on file availability and
-                               // embedding status.
-                               filename = DocFileName(it->availableFile(&buffer));
+                       break;
+               }
+               
+               case EX_EMBED: {
+                       lex.next();
+                       string const name = lex.getString();
+                       filename.setInzipName(name);
+                       filename.setEmbed(!name.empty());
                        break;
                }
 
@@ -417,15 +418,26 @@ InsetExternal::InsetExternal(InsetExternal const & other)
 {}
 
 
-Inset * InsetExternal::clone() const
+InsetExternal::~InsetExternal()
 {
-       return new InsetExternal(*this);
+       InsetExternalMailer(*this).hideDialog();
 }
 
 
-InsetExternal::~InsetExternal()
+void InsetExternal::setBuffer(Buffer & buffer)
 {
-       InsetExternalMailer(*this).hideDialog();
+       if (buffer_) {
+               try {
+                       // a file may not be copied successfully when, e.g. buffer_
+                       // has already been closed.
+                       params_.filename = params_.filename.copyTo(&buffer);
+               } catch (ExceptionMessage const & message) {
+                       Alert::error(message.title_, message.details_);
+                       // failed to embed
+                       params_.filename.setEmbed(false);
+               }
+       }
+       Inset::setBuffer(buffer);
 }
 
 
@@ -440,18 +452,16 @@ void InsetExternal::doDispatch(Cursor & cur, FuncRequest & cmd)
        switch (cmd.action) {
 
        case LFUN_EXTERNAL_EDIT: {
-               Buffer const & buffer = cur.buffer();
                InsetExternalParams p;
-               InsetExternalMailer::string2params(to_utf8(cmd.argument()), buffer, p);
-               external::editExternal(p, buffer);
+               InsetExternalMailer::string2params(to_utf8(cmd.argument()), buffer(), p);
+               external::editExternal(p, buffer());
                break;
        }
 
        case LFUN_INSET_MODIFY: {
-               Buffer const & buffer = cur.buffer();
                InsetExternalParams p;
-               InsetExternalMailer::string2params(to_utf8(cmd.argument()), buffer, p);
-               setParams(p, buffer);
+               InsetExternalMailer::string2params(to_utf8(cmd.argument()), buffer(), p);
+               setParams(p);
                break;
        }
 
@@ -487,14 +497,19 @@ bool InsetExternal::getStatus(Cursor & cur, FuncRequest const & cmd,
 }
 
 
-void InsetExternal::registerEmbeddedFiles(Buffer const &,
-       EmbeddedFiles & files) const
+void InsetExternal::registerEmbeddedFiles(EmbeddedFileList & files) const
 {
-       files.registerFile(params_.filename.absFilename(), false, this);
+       files.registerFile(params_.filename, this, buffer());
 }
 
 
-void InsetExternal::edit(Cursor & cur, bool)
+void InsetExternal::updateEmbeddedFile(EmbeddedFile const & file)
+{
+       params_.filename = file;
+}
+
+
+void InsetExternal::edit(Cursor & cur, bool, EntryDirection)
 {
        InsetExternalMailer(*this).showDialog(&cur.bv());
 }
@@ -545,7 +560,8 @@ graphics::Params get_grfx_params(InsetExternalParams const & eparams)
 {
        graphics::Params gparams;
 
-       gparams.filename = eparams.filename;
+       gparams.filename = eparams.filename.availableFile();
+       gparams.icon = eparams.filename.embedded() ? "pin.png" : "";
        gparams.scale = eparams.lyxscale;
        if (eparams.clipdata.clip)
                gparams.bb = eparams.clipdata.bbox;
@@ -580,14 +596,14 @@ graphics::Params get_grfx_params(InsetExternalParams const & eparams)
 }
 
 
-docstring const getScreenLabel(InsetExternalParams const & params,
+docstring screenLabel(InsetExternalParams const & params,
                            Buffer const & buffer)
 {
        external::Template const * const ptr =
                external::getTemplatePtr(params);
        if (!ptr)
                // FIXME UNICODE
-               return support::bformat((_("External template %1$s is not installed")),
+               return bformat((_("External template %1$s is not installed")),
                                        from_utf8(params.templatename()));
        // FIXME UNICODE
        docstring gui = _(ptr->guiName);
@@ -595,21 +611,51 @@ docstring const getScreenLabel(InsetExternalParams const & params,
                                to_utf8(gui), false));
 }
 
-void add_preview_and_start_loading(RenderMonitoredPreview &,
-                                  InsetExternal const &,
-                                  Buffer const &);
-
 } // namespace anon
 
 
+static bool isPreviewWanted(InsetExternalParams const & params)
+{
+       return params.display == external::PreviewDisplay &&
+               params.filename.isReadableFile();
+}
+
+
+static docstring latexString(InsetExternal const & inset)
+{
+       odocstringstream os;
+       // 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();
+}
+
+
+static 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 &&
+           isPreviewWanted(params)) {
+               renderer.setAbsFile(params.filename);
+               docstring const snippet = latexString(inset);
+               renderer.addPreview(snippet, buffer);
+               renderer.startLoading(buffer);
+       }
+}
+
+
 InsetExternalParams const & InsetExternal::params() const
 {
        return params_;
 }
 
 
-void InsetExternal::setParams(InsetExternalParams const & p,
-                             Buffer const & buffer)
+void InsetExternal::setParams(InsetExternalParams const & p)
 {
        params_ = p;
 
@@ -625,7 +671,7 @@ void InsetExternal::setParams(InsetExternalParams const & p,
                        button_ptr = renderer_->asButton();
                }
 
-               button_ptr->update(getScreenLabel(params_, buffer), true);
+               button_ptr->update(screenLabel(params_, buffer()), true);
                break;
        }
 
@@ -653,7 +699,7 @@ void InsetExternal::setParams(InsetExternalParams const & p,
 
                if (preview_ptr->monitoring())
                        preview_ptr->stopMonitoring();
-               add_preview_and_start_loading(*preview_ptr, *this, buffer);
+               add_preview_and_start_loading(*preview_ptr, *this, buffer());
 
                break;
        }
@@ -675,27 +721,29 @@ void InsetExternal::fileChanged() const
 }
 
 
-void InsetExternal::write(Buffer const & buffer, ostream & os) const
+void InsetExternal::write(ostream & os) const
 {
-       params_.write(buffer, os);
+       params_.write(buffer(), os);
 }
 
 
-void InsetExternal::read(Buffer const & buffer, Lexer & lex)
+void InsetExternal::read(Lexer & lex)
 {
        InsetExternalParams params;
-       if (params.read(buffer, lex))
-               setParams(params, buffer);
+       if (params.read(buffer(), lex)) {
+               // exception handling is not needed as long as embedded files are in place.
+               params.filename.enable(buffer().embedded(), &buffer(), false);
+               setParams(params);
+       }
 }
 
 
-int InsetExternal::latex(Buffer const & buf, odocstream & os,
-                        OutputParams const & runparams) const
+int InsetExternal::latex(odocstream & os, OutputParams const & runparams) const
 {
        if (params_.draft) {
                // FIXME UNICODE
                os << "\\fbox{\\ttfamily{}"
-                  << from_utf8(params_.filename.outputFilename(buf.filePath()))
+                  << from_utf8(params_.filename.outputFilename(buffer().filePath()))
                   << "}\n";
                return 1;
        }
@@ -721,35 +769,35 @@ int InsetExternal::latex(Buffer const & buf, odocstream & os,
 
                if (cit != et.formats.end()) {
                        return external::writeExternal(params_, "PDFLaTeX",
-                                                      buf, os,
+                                                      buffer(), os,
                                                       *(runparams.exportdata),
                                                       external_in_tmpdir,
                                                       dryrun);
                }
        }
 
-       return external::writeExternal(params_, "LaTeX", buf, os,
+       return external::writeExternal(params_, "LaTeX", buffer(), os,
                                       *(runparams.exportdata),
                                       external_in_tmpdir,
                                       dryrun);
 }
 
 
-int InsetExternal::plaintext(Buffer const & buf, odocstream & os,
+int InsetExternal::plaintext(odocstream & os,
                             OutputParams const & runparams) const
 {
        os << '\n'; // output external material on a new line
-       external::writeExternal(params_, "Ascii", buf, os,
+       external::writeExternal(params_, "Ascii", buffer(), os,
                                *(runparams.exportdata), false,
                                runparams.dryrun || runparams.inComment);
        return PLAINTEXT_NEWLINE;
 }
 
 
-int InsetExternal::docbook(Buffer const & buf, odocstream & os,
+int InsetExternal::docbook(odocstream & os,
                           OutputParams const & runparams) const
 {
-       return external::writeExternal(params_, "DocBook", buf, os,
+       return external::writeExternal(params_, "DocBook", buffer(), os,
                                       *(runparams.exportdata), false,
                                       runparams.dryrun || runparams.inComment);
 }
@@ -807,54 +855,15 @@ void InsetExternal::validate(LaTeXFeatures & features) const
 // preview stuff
 //
 
-namespace {
-
-bool preview_wanted(InsetExternalParams const & params)
-{
-       return params.display == external::PreviewDisplay &&
-               params.filename.isReadableFile();
-}
-
-
-docstring const latex_string(InsetExternal const & inset, Buffer const & buffer)
-{
-       odocstringstream os;
-       // We don't need to set runparams.encoding since it is not used by
-       // latex().
-       OutputParams runparams(0);
-       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())) {
+       if (isPreviewWanted(params())) {
                ptr->setAbsFile(params_.filename);
-               docstring const snippet = latex_string(*this, ploader.buffer());
+               docstring const snippet = latexString(*this);
                ptr->addPreview(snippet, ploader);
        }
 }