]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetExternal.cpp
This should be the last of the commits refactoring the InsetLayout code.
[lyx.git] / src / insets / InsetExternal.cpp
index d3a6cb3a258764d1ca3f6539eb6fe29c44367107..102fb5398d0f38a320e900dc9048cecbce50b8a2 100644 (file)
 
 #include "Buffer.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 "LyX.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"
 
 #include <sstream>
 
-using std::endl;
-using std::string;
-using std::auto_ptr;
-using std::istringstream;
-using std::ostream;
-using std::ostringstream;
-using std::vector;
-
+using namespace std;
+using namespace lyx::support;
 
 namespace {
 
@@ -59,22 +56,24 @@ lyx::external::DisplayType const defaultDisplayType = lyx::external::NoDisplay;
 
 unsigned int const defaultLyxScale = 100;
 
-string defaultTemplateName = "RasterImage";
+string defaultTemplateName;
 
 } // namespace anon
 
 
 namespace lyx {
 
+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
-       support::unlink(tempname);
+       tempname.removeFile();
        // must have an extension for the converter code to work correctly.
-       tempname_ = support::FileName(tempname.absFilename() + ".tmp");
+       tempname_ = FileName(tempname.absFilename() + ".tmp");
 }
 
 
@@ -86,12 +85,11 @@ TempName::TempName(TempName const &)
 
 TempName::~TempName()
 {
-       support::unlink(tempname_);
+       tempname_.removeFile();
 }
 
 
-TempName &
-TempName::operator=(TempName const & other)
+TempName & TempName::operator=(TempName const & other)
 {
        if (this != &other)
                tempname_ = TempName()();
@@ -132,9 +130,15 @@ Translator<DisplayType, string> const & displayTranslator()
 InsetExternalParams::InsetExternalParams()
        : display(defaultDisplayType),
          lyxscale(defaultLyxScale),
-         draft(false),
-         templatename_(defaultTemplateName)
-{}
+         draft(false)
+{
+       if (defaultTemplateName.empty()) {
+               external::TemplateManager const & etm =
+                       external::TemplateManager::get();
+               templatename_ = etm.getTemplates().begin()->first;
+       } else
+               templatename_ = defaultTemplateName;
+}
 
 
 namespace {
@@ -148,7 +152,7 @@ void clearIfNotFound(T & data, external::TransformID value,
 
        const_iterator it  = ids.begin();
        const_iterator end = ids.end();
-       it = std::find(it, end, value);
+       it = find(it, end, value);
        if (it == end)
                data = T();
 }
@@ -182,11 +186,10 @@ void InsetExternalParams::write(Buffer const & buffer, ostream & os) const
        os << "External\n"
           << "\ttemplate " << templatename() << '\n';
 
-       if (!filename.empty())
-               os << "\tfilename "
-                  << filename.outputFilename(buffer.filePath())
-                  << '\n';
-
+       if (!filename.empty()) {
+               os << "\tfilename " << filename.outputFilename(buffer.filePath()) << '\n';
+               os << "\tembed " << (filename.embedded() ? filename.inzipName() : "\"\"") << '\n';
+       }
        if (display != defaultDisplayType)
                os << "\tdisplay "
                   << external::displayTranslator().find(display)
@@ -219,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))
@@ -244,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,
@@ -265,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 },
@@ -295,6 +299,14 @@ bool InsetExternalParams::read(Buffer const & buffer, Lexer & lex)
                        filename.set(name, buffer.filePath());
                        break;
                }
+               
+               case EX_EMBED: {
+                       lex.next();
+                       string const name = lex.getString();
+                       filename.setInzipName(name);
+                       filename.setEmbed(!name.empty());
+                       break;
+               }
 
                case EX_DISPLAY: {
                        lex.next();
@@ -369,8 +381,7 @@ bool InsetExternalParams::read(Buffer const & buffer, Lexer & lex)
                        break;
 
                default:
-                       lex.printError("ExternalInset::read: "
-                                      "Wrong tag: $$Token");
+                       lex.printError("ExternalInset::read: Wrong tag: $$Token");
                        read_error = true;
                        break;
                }
@@ -407,9 +418,9 @@ InsetExternal::InsetExternal(InsetExternal const & other)
 {}
 
 
-auto_ptr<Inset> InsetExternal::doClone() const
+Inset * InsetExternal::clone() const
 {
-       return auto_ptr<Inset>(new InsetExternal(*this));
+       return new InsetExternal(*this);
 }
 
 
@@ -421,7 +432,7 @@ InsetExternal::~InsetExternal()
 
 void InsetExternal::statusChanged() const
 {
-       LyX::cref().updateInset(this);
+       updateFrontend();
 }
 
 
@@ -441,6 +452,15 @@ void InsetExternal::doDispatch(Cursor & cur, FuncRequest & cmd)
                Buffer const & buffer = cur.buffer();
                InsetExternalParams p;
                InsetExternalMailer::string2params(to_utf8(cmd.argument()), buffer, p);
+               if (!p.filename.empty()) {
+                       try {
+                               p.filename.enable(buffer.embedded(), &buffer);
+                       } catch (ExceptionMessage const & message) {
+                               Alert::error(message.title_, message.details_);
+                               // do not set parameter if an error happens
+                               break;
+                       }
+               }
                setParams(p, buffer);
                break;
        }
@@ -477,24 +497,38 @@ bool InsetExternal::getStatus(Cursor & cur, FuncRequest const & cmd,
 }
 
 
-void InsetExternal::edit(Cursor & cur, bool)
+void InsetExternal::registerEmbeddedFiles(Buffer const & buffer,
+       EmbeddedFileList & files) const
+{
+       files.registerFile(params_.filename, this, buffer);
+}
+
+
+void InsetExternal::updateEmbeddedFile(Buffer const & buf,
+       EmbeddedFile const & file)
+{
+       // when embedding is enabled, change of embedding status leads to actions
+       EmbeddedFile temp = file;
+       temp.enable(buf.embedded(), &buf);
+       // this will not be set if an exception is thorwn in enable()
+       params_.filename = temp;
+}
+
+
+void InsetExternal::edit(Cursor & cur, bool, EntryDirection)
 {
        InsetExternalMailer(*this).showDialog(&cur.bv());
 }
 
 
-bool InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const
+void 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);
 }
 
@@ -532,7 +566,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;
@@ -558,7 +593,7 @@ graphics::Params get_grfx_params(InsetExternalParams const & eparams)
                BOOST_ASSERT(false);
        }
        if (gparams.display == graphics::DefaultDisplay)
-               gparams.display = lyxrc.display_graphics;
+               gparams.display = graphics::DisplayType(lyxrc.display_graphics);
        // Override the above if we're not using a gui
        if (!use_gui)
                gparams.display = graphics::NoDisplay;
@@ -574,11 +609,12 @@ docstring const getScreenLabel(InsetExternalParams const & params,
                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);
        return from_utf8(external::doSubstitution(params, buffer,
-                               ptr->guiName, false));
+                               to_utf8(gui), false));
 }
 
 void add_preview_and_start_loading(RenderMonitoredPreview &,
@@ -613,8 +649,9 @@ void InsetExternal::setParams(InsetExternalParams const & p,
 
                button_ptr->update(getScreenLabel(params_, buffer), true);
                break;
+       }
 
-       case RENDERGRAPHIC: {
+       case RENDERGRAPHIC: {
                RenderGraphic * graphic_ptr = renderer_->asGraphic();
                if (!graphic_ptr) {
                        renderer_.reset(new RenderGraphic(this));
@@ -624,8 +661,9 @@ void InsetExternal::setParams(InsetExternalParams const & p,
                graphic_ptr->update(get_grfx_params(params_));
 
                break;
+       }
 
-       case RENDERPREVIEW: {
+       case RENDERPREVIEW: {
                RenderMonitoredPreview * preview_ptr =
                        renderer_->asMonitoredPreview();
                if (!preview_ptr) {
@@ -647,16 +685,15 @@ void InsetExternal::setParams(InsetExternalParams const & p,
 
 void InsetExternal::fileChanged() const
 {
-       Buffer const * const buffer_ptr = LyX::cref().updateInset(this);
-       if (!buffer_ptr)
+       Buffer const * const buffer = updateFrontend();
+       if (!buffer)
                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);
+       ptr->removePreview(*buffer);
+       add_preview_and_start_loading(*ptr, *this, *buffer);
 }
 
 
@@ -669,8 +706,11 @@ void InsetExternal::write(Buffer const & buffer, ostream & os) const
 void InsetExternal::read(Buffer const & buffer, Lexer & lex)
 {
        InsetExternalParams params;
-       if (params.read(buffer, lex))
+       if (params.read(buffer, lex)) {
+               // exception handling is not needed as long as embedded files are in place.
+               params.filename.enable(buffer.embedded(), & buffer);
                setParams(params, buffer);
+       }
 }
 
 
@@ -797,7 +837,7 @@ namespace {
 bool preview_wanted(InsetExternalParams const & params)
 {
        return params.display == external::PreviewDisplay &&
-               support::isFileReadable(params.filename);
+               params.filename.isReadableFile();
 }