]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetexternal.C
Enable convertDefault.sh to run even if its executable bit is not set.
[lyx.git] / src / insets / insetexternal.C
index ee0cbea2bce080049438023f1904924b09d052e6..126eb3065179d7d10bbdca2f7497825542257063 100644 (file)
@@ -5,13 +5,13 @@
  *
  * \author Asger Alstrup Nielsen
  *
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
  */
 
 #include <config.h>
 
 #include "insetexternal.h"
-#include "insets/graphicinset.h"
+#include "insets/renderers.h"
 
 #include "buffer.h"
 #include "BufferView.h"
 #include "support/lstrings.h"
 #include "support/lyxalgo.h"
 #include "support/path.h"
+#include "support/path_defines.h"
 #include "support/tostr.h"
+#include "support/LAssert.h"
+#include "support/translator.h"
 
 #include <boost/bind.hpp>
 
 #include <cstdio>
 #include <utility>
 
+using namespace lyx::support;
+
 using std::ostream;
 using std::endl;
+using std::auto_ptr;
 
+namespace lyx {
+namespace graphics {
+/// The translator between the DisplayType and the corresponding lyx string.
+extern Translator<DisplayType, string> displayTranslator;
+}
+}
 
 namespace {
 
-grfx::DisplayType const defaultDisplayType = grfx::NoDisplay;
+lyx::graphics::DisplayType const defaultDisplayType = lyx::graphics::NoDisplay;
 
 unsigned int defaultLyxScale = 100;
 
 /// Substitute meta-variables in string s, makeing use of params and buffer.
 string const doSubstitution(InsetExternal::Params const & params,
-                           Buffer const * buffer, string const & s);
+                           Buffer const & buffer, string const & s);
 
 /// Invoke the external editor.
-void editExternal(InsetExternal::Params const & params, Buffer const * buffer);
+void editExternal(InsetExternal::Params const & params, Buffer const & buffer);
 
 } // namespace anon
 
@@ -68,8 +80,8 @@ InsetExternal::Params::Params()
        : display(defaultDisplayType),
          lyxscale(defaultLyxScale)
 {
-       tempname = lyx::tempName(string(), "lyxext");
-       lyx::unlink(tempname);
+       tempname = tempName(string(), "lyxext");
+       unlink(tempname);
        // must have an extension for the converter code to work correctly.
        tempname += ".tmp";
 }
@@ -77,31 +89,31 @@ InsetExternal::Params::Params()
 
 InsetExternal::Params::~Params()
 {
-       lyx::unlink(tempname);
+       unlink(tempname);
 }
 
 
 InsetExternal::InsetExternal()
-       : renderer_(new GraphicInset)
-{
-       renderer_->connect(boost::bind(&InsetExternal::statusChanged, this));
-}
+       : renderer_(new ButtonRenderer)
+{}
 
 
 InsetExternal::InsetExternal(InsetExternal const & other)
-       : Inset(other),
+       : InsetOld(other),
          boost::signals::trackable(),
          params_(other.params_),
-         renderer_(new GraphicInset(*other.renderer_))
+         renderer_(other.renderer_->clone())
 {
-       renderer_->connect(boost::bind(&InsetExternal::statusChanged, this));
+       GraphicRenderer * ptr = dynamic_cast<GraphicRenderer *>(renderer_.get());
+       if (ptr) {
+               ptr->connect(boost::bind(&InsetExternal::statusChanged, this));
+       }
 }
 
 
-Inset * InsetExternal::clone() const
+auto_ptr<InsetBase> InsetExternal::clone() const
 {
-       InsetExternal * inset = new InsetExternal(*this);
-       return inset;
+       return auto_ptr<InsetBase>(new InsetExternal(*this));
 }
 
 
@@ -117,12 +129,6 @@ void InsetExternal::statusChanged()
        if (bv)
                bv->updateInset(this);
 }
-       
-
-InsetExternal::Params const & InsetExternal::params() const
-{
-       return params_;
-}
 
 
 dispatch_result InsetExternal::localDispatch(FuncRequest const & cmd)
@@ -130,20 +136,22 @@ dispatch_result InsetExternal::localDispatch(FuncRequest const & cmd)
        switch (cmd.action) {
 
        case LFUN_EXTERNAL_EDIT: {
-               lyx::Assert(cmd.view());
+               Assert(cmd.view());
 
+               Buffer const & buffer = *cmd.view()->buffer();
                InsetExternal::Params p;
-               InsetExternalMailer::string2params(cmd.argument, p);
-               editExternal(p, cmd.view()->buffer());
+               InsetExternalMailer::string2params(cmd.argument, buffer, p);
+               editExternal(p, buffer);
                return DISPATCHED_NOUPDATE;
        }
-       
+
        case LFUN_INSET_MODIFY: {
-               lyx::Assert(cmd.view());
+               Assert(cmd.view());
 
+               Buffer const & buffer = *cmd.view()->buffer();
                InsetExternal::Params p;
-               InsetExternalMailer::string2params(cmd.argument, p);
-               setParams(p, cmd.view()->buffer()->filePath());
+               InsetExternalMailer::string2params(cmd.argument, buffer, p);
+               setParams(p, buffer);
                cmd.view()->updateInset(this);
                return DISPATCHED;
        }
@@ -166,6 +174,7 @@ dispatch_result InsetExternal::localDispatch(FuncRequest const & cmd)
 void InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const
 {
        renderer_->metrics(mi, dim);
+       dim_ = dim;
 }
 
 
@@ -177,25 +186,20 @@ void InsetExternal::draw(PainterInfo & pi, int x, int y) const
 
 namespace {
 
-grfx::Params get_grfx_params(InsetExternal::Params const & eparams,
-                            string const & filepath)
+lyx::graphics::Params get_grfx_params(InsetExternal::Params const & eparams)
 {
-       grfx::Params gparams;
-
-       if (!eparams.filename.empty()) {
-               lyx::Assert(AbsolutePath(filepath));
-               gparams.filename = MakeAbsPath(eparams.filename, filepath);
-       }
+       lyx::graphics::Params gparams;
 
+       gparams.filename = eparams.filename.absFilename();
        gparams.scale = eparams.lyxscale;
        gparams.display = eparams.display;
 
-       if (gparams.display == grfx::DefaultDisplay)
+       if (gparams.display == lyx::graphics::DefaultDisplay)
                gparams.display = lyxrc.display_graphics;
 
        // Override the above if we're not using a gui
        if (!lyx_gui::use_gui)
-               gparams.display = grfx::NoDisplay;
+               gparams.display = lyx::graphics::NoDisplay;
 
        return gparams;
 }
@@ -211,19 +215,26 @@ ExternalTemplate const * getTemplatePtr(InsetExternal::Params const & params)
 }
 
 
-string const getScreenLabel(InsetExternal::Params const & params)
+string const getScreenLabel(InsetExternal::Params const & params,
+                           Buffer const & buffer)
 {
        ExternalTemplate const * const ptr = getTemplatePtr(params);
        if (!ptr)
                return bformat(_("External template %1$s is not installed"),
                               params.templatename);
-       return doSubstitution(params, 0, ptr->guiName);
+       return doSubstitution(params, buffer, ptr->guiName);
 }
 
 } // namespace anon
 
 
-void InsetExternal::setParams(Params const & p, string const & filepath)
+InsetExternal::Params const & InsetExternal::params() const
+{
+       return params_;
+}
+
+
+void InsetExternal::setParams(Params const & p, Buffer const & buffer)
 {
        // The stored params; what we would like to happen in an ideal world.
        params_.filename = p.filename;
@@ -231,35 +242,48 @@ void InsetExternal::setParams(Params const & p, string const & filepath)
        params_.display = p.display;
        params_.lyxscale = p.lyxscale;
 
-       // A temporary set of params; whether the thing can be displayed
-       // within LyX depends on the availability of this template.
-       Params tmp = params_;
-       if (!getTemplatePtr(params_))
-               tmp.display = grfx::NoDisplay;
-       
-       // Update the display using the new parameters.
-       if (params_.filename.empty() || !filepath.empty())
-               renderer_->update(get_grfx_params(tmp, filepath));      
-       renderer_->setNoDisplayMessage(getScreenLabel(params_));
-}
+       // We display the inset as a button by default.
+       bool display_button = (!getTemplatePtr(params_) ||
+                              params_.filename.empty() ||
+                              params_.display == lyx::graphics::NoDisplay);
+
+       if (display_button) {
+               ButtonRenderer * button_ptr =
+                       dynamic_cast<ButtonRenderer *>(renderer_.get());
+               if (!button_ptr) {
+                       button_ptr = new ButtonRenderer;
+                       renderer_.reset(button_ptr);
+               }
 
+               button_ptr->update(getScreenLabel(params_, buffer), true);
 
-string const InsetExternal::editMessage() const
-{
-       return getScreenLabel(params_);
+       } else {
+               GraphicRenderer * graphic_ptr =
+                       dynamic_cast<GraphicRenderer *>(renderer_.get());
+               if (!graphic_ptr) {
+                       graphic_ptr = new GraphicRenderer;
+                       graphic_ptr->connect(
+                               boost::bind(&InsetExternal::statusChanged, this));
+                       renderer_.reset(graphic_ptr);
+               }
+
+               graphic_ptr->update(get_grfx_params(params_));
+       }
 }
 
 
-void InsetExternal::write(Buffer const *, ostream & os) const
+void InsetExternal::write(Buffer const & buffer, ostream & os) const
 {
        os << "External\n"
           << "\ttemplate " << params_.templatename << '\n';
 
        if (!params_.filename.empty())
-               os << "\tfilename " << params_.filename << '\n';
+               os << "\tfilename "
+                  << params_.filename.outputFilename(buffer.filePath())
+                  << '\n';
 
        if (params_.display != defaultDisplayType)
-               os << "\tdisplay " << grfx::displayTranslator.find(params_.display)
+               os << "\tdisplay " << lyx::graphics::displayTranslator.find(params_.display)
                   << '\n';
 
        if (params_.lyxscale != defaultLyxScale)
@@ -267,7 +291,7 @@ void InsetExternal::write(Buffer const *, ostream & os) const
 }
 
 
-void InsetExternal::read(Buffer const * buffer, LyXLex & lex)
+void InsetExternal::read(Buffer const & buffer, LyXLex & lex)
 {
        enum ExternalTags {
                EX_TEMPLATE = 1,
@@ -285,7 +309,7 @@ void InsetExternal::read(Buffer const * buffer, LyXLex & lex)
                { "template", EX_TEMPLATE }
        };
 
-       lex.pushTable(external_tags, EX_END);
+       pushpophelper pph(lex, external_tags, EX_END);
 
        bool found_end  = false;
        bool read_error = false;
@@ -302,14 +326,14 @@ void InsetExternal::read(Buffer const * buffer, LyXLex & lex)
                case EX_FILENAME: {
                        lex.next();
                        string const name = lex.getString();
-                       params.filename = name;
+                       params.filename.set(name, buffer.filePath());
                        break;
                }
 
                case EX_DISPLAY: {
                        lex.next();
                        string const name = lex.getString();
-                       params.display = grfx::displayTranslator.find(name);
+                       params.display = lyx::graphics::displayTranslator.find(name);
                        break;
                }
 
@@ -339,23 +363,20 @@ void InsetExternal::read(Buffer const * buffer, LyXLex & lex)
                               "Missing \\end_inset.");
        }
 
-       lex.popTable();
-
        // Replace the inset's store
-       string const path = buffer ? buffer->filePath() : string();
-       setParams(params, path);
+       setParams(params, buffer);
 
        lyxerr[Debug::INFO] << "InsetExternal::Read: "
-              << "template: '" << params_.templatename
-              << "' filename: '" << params_.filename
-              << "' display: '" << params_.display
-              << "' scale: '" << params_.lyxscale
-              << '\'' << endl;
+                           << "template: '" << params_.templatename
+                           << "' filename: '" << params_.filename.absFilename()
+                           << "' display: '" << params_.display
+                           << "' scale: '" << params_.lyxscale
+                           << '\'' << endl;
 }
 
 
 int InsetExternal::write(string const & format,
-                        Buffer const * buf, ostream & os,
+                        Buffer const & buf, ostream & os,
                         bool external_in_tmpdir) const
 {
        ExternalTemplate const * const et_ptr = getTemplatePtr(params_);
@@ -379,7 +400,7 @@ int InsetExternal::write(string const & format,
 }
 
 
-int InsetExternal::latex(Buffer const * buf, ostream & os,
+int InsetExternal::latex(Buffer const & buf, ostream & os,
                         LatexRunParams const & runparams) const
 {
        // "nice" means that the buffer is exported to LaTeX format but not
@@ -387,7 +408,7 @@ int InsetExternal::latex(Buffer const * buf, ostream & os,
        // 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->tmppath.empty() && !runparams.nice;
+               lyxrc.use_tempdir && !buf.tmppath.empty() && !runparams.nice;
 
        // If the template has specified a PDFLaTeX output, then we try and
        // use that.
@@ -407,19 +428,19 @@ int InsetExternal::latex(Buffer const * buf, ostream & os,
 }
 
 
-int InsetExternal::ascii(Buffer const * buf, ostream & os, int) const
+int InsetExternal::ascii(Buffer const & buf, ostream & os, int) const
 {
        return write("Ascii", buf, os);
 }
 
 
-int InsetExternal::linuxdoc(Buffer const * buf, ostream & os) const
+int InsetExternal::linuxdoc(Buffer const & buf, ostream & os) const
 {
        return write("LinuxDoc", buf, os);
 }
 
 
-int InsetExternal::docbook(Buffer const * buf, ostream & os, bool) const
+int InsetExternal::docbook(Buffer const & buf, ostream & os, bool) const
 {
        return write("DocBook", buf, os);
 }
@@ -448,7 +469,7 @@ void InsetExternal::validate(LaTeXFeatures & features) const
 
 
 void InsetExternal::updateExternal(string const & format,
-                                  Buffer const * buf,
+                                  Buffer const & buf,
                                   bool external_in_tmpdir) const
 {
        ExternalTemplate const * const et_ptr = getTemplatePtr(params_);
@@ -472,8 +493,7 @@ void InsetExternal::updateExternal(string const & format,
        if (from_format.empty())
                return;
 
-       string from_file = params_.filename.empty() ?
-               string() : MakeAbsPath(params_.filename, buf->filePath());
+       string from_file = params_.filename.absFilename();
 
        if (from_format == "*") {
                if (from_file.empty())
@@ -498,7 +518,7 @@ void InsetExternal::updateExternal(string const & format,
 
        if (external_in_tmpdir && !from_file.empty()) {
                // We are running stuff through LaTeX
-               from_file = copyFileToDir(buf->tmppath, from_file);
+               from_file = copyFileToDir(buf.tmppath, from_file);
                if (from_file.empty())
                        return;
        }
@@ -516,7 +536,7 @@ void InsetExternal::updateExternal(string const & format,
                     fi.getModificationTime()) >= 0) {
        } else {
                string const to_filebase = ChangeExtension(to_file, string());
-               converters.convert(buf, from_file, to_filebase,
+               converters.convert(&buf, from_file, to_filebase,
                                   from_format, to_format);
        }
 }
@@ -526,17 +546,19 @@ namespace {
 
 /// Substitute meta-variables in this string
 string const doSubstitution(InsetExternal::Params const & params,
-                           Buffer const * buffer, string const & s)
+                           Buffer const & buffer, string const & s)
 {
        string result;
-       string const basename = ChangeExtension(params.filename, string());
-       string filepath;
+       string const buffer_path = buffer.filePath();
+       string const filename = params.filename.outputFilename(buffer_path);
+       string const basename = ChangeExtension(filename, string());
+       string const filepath = OnlyPath(filename);
 
-       result = subst(s, "$$FName", params.filename);
+       result = subst(s, "$$FName", filename);
        result = subst(result, "$$Basename", basename);
        result = subst(result, "$$FPath", filepath);
        result = subst(result, "$$Tempname", params.tempname);
-       result = subst(result, "$$Sysdir", system_lyxdir);
+       result = subst(result, "$$Sysdir", system_lyxdir());
 
        // Handle the $$Contents(filename) syntax
        if (contains(result, "$$Contents(\"")) {
@@ -545,15 +567,15 @@ string const doSubstitution(InsetExternal::Params const & params,
                string::size_type const end = result.find("\")", pos);
                string const file = result.substr(pos + 12, end - (pos + 12));
                string contents;
-               if (buffer) {
-                       Path p(buffer->filePath());
-                       if (!IsFileReadable(file))
-                               Path p(buffer->tmppath);
-                       if (IsFileReadable(file))
-                               contents = GetFileContents(file);
-               } else {
-                       contents = GetFileContents(file);
+               Path p(buffer.filePath());
+               if (!IsFileReadable(file)) {
+#warning Is this really working as intended?
+                       Path p(buffer.tmppath);
                }
+
+               if (IsFileReadable(file))
+                       contents = GetFileContents(file);
+
                result = subst(result,
                               ("$$Contents(\"" + file + "\")").c_str(),
                               contents);
@@ -563,11 +585,8 @@ string const doSubstitution(InsetExternal::Params const & params,
 }
 
 
-void editExternal(InsetExternal::Params const & params, Buffer const * buffer)
+void editExternal(InsetExternal::Params const & params, Buffer const & buffer)
 {
-       if (!buffer)
-               return;
-
        ExternalTemplate const * const et_ptr = getTemplatePtr(params);
        if (!et_ptr)
                return;
@@ -578,11 +597,11 @@ void editExternal(InsetExternal::Params const & params, Buffer const * buffer)
 
        string const command = doSubstitution(params, buffer, et.editCommand);
 
-       Path p(buffer->filePath());
+       Path p(buffer.filePath());
        Forkedcall call;
        if (lyxerr.debugging()) {
                lyxerr << "Executing '" << command << "' in '"
-                      << buffer->filePath() << '\'' << endl;
+                      << buffer.filePath() << '\'' << endl;
        }
        call.startscript(Forkedcall::DontWait, command);
 }
@@ -596,13 +615,14 @@ InsetExternalMailer::InsetExternalMailer(InsetExternal & inset)
 {}
 
 
-string const InsetExternalMailer::inset2string() const
+string const InsetExternalMailer::inset2string(Buffer const & buffer) const
 {
-       return params2string(inset_.params());
+       return params2string(inset_.params(), buffer);
 }
 
 
 void InsetExternalMailer::string2params(string const & in,
+                                       Buffer const & buffer,
                                        InsetExternal::Params & params)
 {
        params = InsetExternal::Params();
@@ -632,20 +652,21 @@ void InsetExternalMailer::string2params(string const & in,
 
        if (lex.isOK()) {
                InsetExternal inset;
-               inset.read(0, lex);
+               inset.read(buffer, lex);
                params = inset.params();
        }
 }
 
 
 string const
-InsetExternalMailer::params2string(InsetExternal::Params const & params)
+InsetExternalMailer::params2string(InsetExternal::Params const & params,
+                                  Buffer const & buffer)
 {
        InsetExternal inset;
-       inset.setParams(params, string());
+       inset.setParams(params, buffer);
        ostringstream data;
        data << name_ << ' ';
-       inset.write(0, data);
+       inset.write(buffer, data);
        data << "\\end_inset\n";
        return STRCONV(data.str());
 }