]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetexternal.C
Enable the external inset to handle unknown templates gracefully.
[lyx.git] / src / insets / insetexternal.C
index 4965851200fe976117797c60e98e2a7f755f8348..ee0cbea2bce080049438023f1904924b09d052e6 100644 (file)
@@ -54,20 +54,37 @@ grfx::DisplayType const defaultDisplayType = grfx::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);
+
+/// Invoke the external editor.
+void editExternal(InsetExternal::Params const & params, Buffer const * buffer);
+
 } // namespace anon
 
 
 InsetExternal::Params::Params()
        : display(defaultDisplayType),
          lyxscale(defaultLyxScale)
-{}
+{
+       tempname = lyx::tempName(string(), "lyxext");
+       lyx::unlink(tempname);
+       // must have an extension for the converter code to work correctly.
+       tempname += ".tmp";
+}
+
+
+InsetExternal::Params::~Params()
+{
+       lyx::unlink(tempname);
+}
 
 
 InsetExternal::InsetExternal()
-       : graphic_(new GraphicInset)
+       : renderer_(new GraphicInset)
 {
-       graphic_->connect(boost::bind(&InsetExternal::statusChanged, this));
-       params_.templ = ExternalTemplateManager::get().getTemplates().begin()->second;
+       renderer_->connect(boost::bind(&InsetExternal::statusChanged, this));
 }
 
 
@@ -75,9 +92,9 @@ InsetExternal::InsetExternal(InsetExternal const & other)
        : Inset(other),
          boost::signals::trackable(),
          params_(other.params_),
-         graphic_(new GraphicInset(*other.graphic_))
+         renderer_(new GraphicInset(*other.renderer_))
 {
-       graphic_->connect(boost::bind(&InsetExternal::statusChanged, this));
+       renderer_->connect(boost::bind(&InsetExternal::statusChanged, this));
 }
 
 
@@ -90,15 +107,13 @@ Inset * InsetExternal::clone() const
 
 InsetExternal::~InsetExternal()
 {
-       if (!tempname_.empty())
-               lyx::unlink(tempname_);
        InsetExternalMailer(*this).hideDialog();
 }
 
 
 void InsetExternal::statusChanged()
 {
-       BufferView * bv = graphic_->view();
+       BufferView * bv = renderer_->view();
        if (bv)
                bv->updateInset(this);
 }
@@ -114,7 +129,18 @@ dispatch_result InsetExternal::localDispatch(FuncRequest const & cmd)
 {
        switch (cmd.action) {
 
+       case LFUN_EXTERNAL_EDIT: {
+               lyx::Assert(cmd.view());
+
+               InsetExternal::Params p;
+               InsetExternalMailer::string2params(cmd.argument, p);
+               editExternal(p, cmd.view()->buffer());
+               return DISPATCHED_NOUPDATE;
+       }
+       
        case LFUN_INSET_MODIFY: {
+               lyx::Assert(cmd.view());
+
                InsetExternal::Params p;
                InsetExternalMailer::string2params(cmd.argument, p);
                setParams(p, cmd.view()->buffer()->filePath());
@@ -137,21 +163,15 @@ dispatch_result InsetExternal::localDispatch(FuncRequest const & cmd)
 }
 
 
-void InsetExternal::cache(BufferView * bv) const
-{
-       graphic_->view(bv);
-}
-
-
 void InsetExternal::metrics(MetricsInfo & mi, Dimension & dim) const
 {
-       graphic_->metrics(mi, dim);
+       renderer_->metrics(mi, dim);
 }
 
 
 void InsetExternal::draw(PainterInfo & pi, int x, int y) const
 {
-       graphic_->draw(pi, x, y);
+       renderer_->draw(pi, x, y);
 }
 
 
@@ -180,34 +200,60 @@ grfx::Params get_grfx_params(InsetExternal::Params const & eparams,
        return gparams;
 }
 
+
+ExternalTemplate const * getTemplatePtr(InsetExternal::Params const & params)
+{
+       ExternalTemplateManager & etm = ExternalTemplateManager::get();
+       ExternalTemplate const & templ = etm.getTemplateByName(params.templatename);
+       if (templ.lyxName.empty())
+               return 0;
+       return &templ;
+}
+
+
+string const getScreenLabel(InsetExternal::Params const & params)
+{
+       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);
+}
+
 } // namespace anon
 
 
 void InsetExternal::setParams(Params const & p, string const & filepath)
 {
+       // The stored params; what we would like to happen in an ideal world.
        params_.filename = p.filename;
-       params_.templ = p.templ;
+       params_.templatename = p.templatename;
        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())
-               graphic_->update(get_grfx_params(params_, filepath));   
-       string const msg = doSubstitution(0, params_.templ.guiName);
-       graphic_->setNoDisplayMessage(msg);
+               renderer_->update(get_grfx_params(tmp, filepath));      
+       renderer_->setNoDisplayMessage(getScreenLabel(params_));
 }
 
 
 string const InsetExternal::editMessage() const
 {
-       return doSubstitution(0, params_.templ.guiName);
+       return getScreenLabel(params_);
 }
 
 
 void InsetExternal::write(Buffer const *, ostream & os) const
 {
        os << "External\n"
-          << "\ttemplate " << params_.templ.lyxName << '\n';
+          << "\ttemplate " << params_.templatename << '\n';
 
        if (!params_.filename.empty())
                os << "\tfilename " << params_.filename << '\n';
@@ -249,10 +295,7 @@ void InsetExternal::read(Buffer const * buffer, LyXLex & lex)
                switch (lex.lex()) {
                case EX_TEMPLATE: {
                        lex.next();
-                       string const name = lex.getString();
-                       ExternalTemplateManager & etm =
-                               ExternalTemplateManager::get();
-                       params.templ = etm.getTemplateByName(name);
+                       params.templatename = lex.getString();
                        break;
                }
 
@@ -299,20 +342,15 @@ void InsetExternal::read(Buffer const * buffer, LyXLex & lex)
        lex.popTable();
 
        // Replace the inset's store
-       params_ = params;
+       string const path = buffer ? buffer->filePath() : string();
+       setParams(params, path);
 
        lyxerr[Debug::INFO] << "InsetExternal::Read: "
-              << "template: '" << params_.templ.lyxName
+              << "template: '" << params_.templatename
               << "' filename: '" << params_.filename
               << "' display: '" << params_.display
               << "' scale: '" << params_.lyxscale
               << '\'' << endl;
-
-       // Update the display using the new parameters.
-       if (buffer)
-               graphic_->update(get_grfx_params(params_, buffer->filePath()));
-       string const msg = doSubstitution(0, params_.templ.guiName);
-       graphic_->setNoDisplayMessage(msg);
 }
 
 
@@ -320,18 +358,22 @@ int InsetExternal::write(string const & format,
                         Buffer const * buf, ostream & os,
                         bool external_in_tmpdir) const
 {
-       ExternalTemplate const & et = params_.templ;
+       ExternalTemplate const * const et_ptr = getTemplatePtr(params_);
+       if (!et_ptr)
+               return 0;
+       ExternalTemplate const & et = *et_ptr;
+
        ExternalTemplate::Formats::const_iterator cit =
                et.formats.find(format);
        if (cit == et.formats.end()) {
                lyxerr << "External template format '" << format
                       << "' not specified in template "
-                      << params_.templ.lyxName << endl;
+                      << params_.templatename << endl;
                return 0;
        }
 
        updateExternal(format, buf, external_in_tmpdir);
-       string const str = doSubstitution(buf, cit->second.product);
+       string const str = doSubstitution(params_, buf, cit->second.product);
        os << str;
        return int(lyx::count(str.begin(), str.end(),'\n') + 1);
 }
@@ -350,7 +392,11 @@ int InsetExternal::latex(Buffer const * buf, ostream & os,
        // If the template has specified a PDFLaTeX output, then we try and
        // use that.
        if (runparams.flavor == LatexRunParams::PDFLATEX) {
-               ExternalTemplate const & et = params_.templ;
+               ExternalTemplate const * const et_ptr = getTemplatePtr(params_);
+               if (!et_ptr)
+                       return 0;
+               ExternalTemplate const & et = *et_ptr;
+
                ExternalTemplate::Formats::const_iterator cit =
                        et.formats.find("PDFLaTeX");
                if (cit != et.formats.end())
@@ -381,7 +427,11 @@ int InsetExternal::docbook(Buffer const * buf, ostream & os, bool) const
 
 void InsetExternal::validate(LaTeXFeatures & features) const
 {
-       ExternalTemplate const & et = params_.templ;
+       ExternalTemplate const * const et_ptr = getTemplatePtr(params_);
+       if (!et_ptr)
+               return;
+       ExternalTemplate const & et = *et_ptr;
+
        ExternalTemplate::Formats::const_iterator cit =
                et.formats.find("LaTeX");
 
@@ -397,61 +447,15 @@ void InsetExternal::validate(LaTeXFeatures & features) const
 }
 
 
-string const InsetExternal::doSubstitution(Buffer const * buffer,
-                                          string const & s) const
-{
-       string result;
-       string const basename = ChangeExtension(params_.filename, string());
-       string filepath;
-       bool external_in_tmpdir = false;
-       if (buffer && !buffer->tmppath.empty() && !buffer->niceFile) {
-               filepath = buffer->filePath();
-               if (lyxrc.use_tempdir)
-                       external_in_tmpdir = true;
-       }
-       if (tempname_.empty()) {
-               string const path = external_in_tmpdir ? buffer->tmppath : string();
-               tempname_ = lyx::tempName(path, "lyxext");
-               lyx::unlink(tempname_);
-               // must have an extension for the converter code to work correctly.
-               tempname_ += ".tmp";
-       }
-       result = subst(s, "$$FName", params_.filename);
-       result = subst(result, "$$Basename", basename);
-       result = subst(result, "$$FPath", filepath);
-       result = subst(result, "$$Tempname", tempname_);
-       result = subst(result, "$$Sysdir", system_lyxdir);
-
-       // Handle the $$Contents(filename) syntax
-       if (contains(result, "$$Contents(\"")) {
-
-               string::size_type const pos = result.find("$$Contents(\"");
-               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);
-               }
-               result = subst(result,
-                              ("$$Contents(\"" + file + "\")").c_str(),
-                              contents);
-       }
-
-       return result;
-}
-
-
 void InsetExternal::updateExternal(string const & format,
                                   Buffer const * buf,
                                   bool external_in_tmpdir) const
 {
-       ExternalTemplate const & et = params_.templ;
+       ExternalTemplate const * const et_ptr = getTemplatePtr(params_);
+       if (!et_ptr)
+               return;
+       ExternalTemplate const & et = *et_ptr;
+
        if (!et.automaticProduction)
                return;
 
@@ -499,7 +503,8 @@ void InsetExternal::updateExternal(string const & format,
                        return;
        }
 
-       string const to_file = doSubstitution(buf, outputFormat.updateResult);
+       string const to_file = doSubstitution(params_, buf,
+                                             outputFormat.updateResult);
 
        FileInfo fi(from_file);
        string abs_to_file = to_file;
@@ -517,18 +522,61 @@ void InsetExternal::updateExternal(string const & format,
 }
 
 
-void InsetExternal::editExternal() const
+namespace {
+
+/// Substitute meta-variables in this string
+string const doSubstitution(InsetExternal::Params const & params,
+                           Buffer const * buffer, string const & s)
 {
-       ExternalTemplate const & et = params_.templ;
-       if (et.editCommand.empty())
-               return;
+       string result;
+       string const basename = ChangeExtension(params.filename, string());
+       string filepath;
+
+       result = subst(s, "$$FName", params.filename);
+       result = subst(result, "$$Basename", basename);
+       result = subst(result, "$$FPath", filepath);
+       result = subst(result, "$$Tempname", params.tempname);
+       result = subst(result, "$$Sysdir", system_lyxdir);
 
-       BufferView const * bv = graphic_->view();
-       Buffer const * buffer = bv ? bv->buffer() : 0;
+       // Handle the $$Contents(filename) syntax
+       if (contains(result, "$$Contents(\"")) {
+
+               string::size_type const pos = result.find("$$Contents(\"");
+               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);
+               }
+               result = subst(result,
+                              ("$$Contents(\"" + file + "\")").c_str(),
+                              contents);
+       }
+
+       return result;
+}
+
+
+void editExternal(InsetExternal::Params const & params, Buffer const * buffer)
+{
        if (!buffer)
                return;
 
-       string const command = doSubstitution(buffer, et.editCommand);
+       ExternalTemplate const * const et_ptr = getTemplatePtr(params);
+       if (!et_ptr)
+               return;
+       ExternalTemplate const & et = *et_ptr;
+
+       if (et.editCommand.empty())
+               return;
+
+       string const command = doSubstitution(params, buffer, et.editCommand);
 
        Path p(buffer->filePath());
        Forkedcall call;
@@ -539,6 +587,7 @@ void InsetExternal::editExternal() const
        call.startscript(Forkedcall::DontWait, command);
 }
 
+} // namespace anon
 
 string const InsetExternalMailer::name_("external");