]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetexternal.C
My patch from yesterday
[lyx.git] / src / insets / insetexternal.C
index 881c9d4068f410effcabd939d01b147ace0d70e4..fd5fe30017f1c40deb2e1380df6d4912eb95d9e1 100644 (file)
@@ -1,41 +1,48 @@
-/* This file is part of
- * ======================================================
+/**
+ * \file insetexternal.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           LyX, The Document Processor
- *     
- *         Copyright 1995 Matthias Ettrich
- *          Copyright 1995-2000 The LyX Team.
+ * \author Asger Alstrup Nielsen
  *
- * ====================================================== */
+ * Full author contact details are available in file CREDITS
+ */
 
 #include <config.h>
 
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
-#include <cstdio>
-#include <utility>
 
 #include "insetexternal.h"
 #include "ExternalTemplate.h"
 #include "BufferView.h"
 #include "buffer.h"
-#include "LyXView.h"
-#include "frontends/Dialogs.h"
+#include "funcrequest.h"
 #include "lyx_main.h"
 #include "LaTeXFeatures.h"
+#include "gettext.h"
+#include "debug.h"
+#include "lyxlex.h"
+
+#include "frontends/LyXView.h"
+#include "frontends/Dialogs.h"
+
 #include "support/filetools.h"
 #include "support/lstrings.h"
 #include "support/path.h"
-#include "support/syscall.h"
+#include "support/systemcall.h"
+#include "support/FileInfo.h"
 
+#include <cstdio>
+#include <utility>
+
+
+using std::ostream;
 using std::endl;
 
-InsetExternal::InsetExternal() 
-       : view(0)
+
+InsetExternal::InsetExternal()
+       : view_(0)
 {
-       tempname = lyx::tempName(string(), "lyxext");
+       tempname_ = lyx::tempName(string(), "lyxext");
        //ExternalTemplateManager::Templates::const_iterator i1;
        params_.templ = ExternalTemplateManager::get().getTemplates().begin()->second;
 }
@@ -43,59 +50,102 @@ InsetExternal::InsetExternal()
 
 InsetExternal::~InsetExternal()
 {
-       lyx::unlink(tempname);
-       hideDialog();
+       lyx::unlink(tempname_);
+       InsetExternalMailer mailer(*this);
+       mailer.hideDialog();
 }
 
 
-InsetExternal::Params InsetExternal::params() const
+InsetExternal::Params const & InsetExternal::params() const
 {
        return params_;
 }
+
+
+dispatch_result InsetExternal::localDispatch(FuncRequest const & cmd)
+{
+       dispatch_result result = UNDISPATCHED;
+
+       switch (cmd.action) {
+       case LFUN_INSET_MODIFY: {
+               InsetExternal::Params p;
+               InsetExternalMailer::string2params(cmd.argument, p);
+               if (p.filename.empty())
+                       break;
+
+               setFromParams(p);
+               cmd.view()->updateInset(this);
+               result = DISPATCHED;
+       }
+       break;
+
+       case LFUN_INSET_DIALOG_UPDATE: {
+               InsetExternalMailer mailer(*this);
+               mailer.updateDialog(cmd.view());
+       }
+       break;
+
+       case LFUN_MOUSE_RELEASE:
+               edit(cmd.view(), cmd.x, cmd.y, cmd.button());
+               break;
+
+       default:
+               break;
+       }
+
+       return result;
+}
+
+
 void InsetExternal::setFromParams(Params const & p)
 {
        params_.filename = p.filename;
        params_.parameters = p.parameters;
        params_.templ = p.templ;
-}      
+}
 
 
-string const InsetExternal::EditMessage() const
+string const InsetExternal::editMessage() const
 {
        return doSubstitution(0, params_.templ.guiName);
 }
 
 
-void InsetExternal::Edit(BufferView * bv,
-                        int /*x*/, int /*y*/, unsigned int /*button*/)
+void InsetExternal::edit(BufferView * bv, int, int, mouse_button::state)
+{
+       InsetExternalMailer mailer(*this);
+       mailer.showDialog(bv);
+}
+
+
+void InsetExternal::edit(BufferView * bv, bool)
 {
-       view = bv;
-       view->owner()->getDialogs()->showExternal(this);
+       edit(bv, 0, 0, mouse_button::none);
 }
 
 
-void InsetExternal::Write(Buffer const *, std::ostream & os) const
+void InsetExternal::write(Buffer const *, ostream & os) const
 {
-       os << "External " << params_.templ.lyxName << ",\"" << params_.filename 
-          << "\",\"" << params_.parameters << "\"\n";
+       os << "External " << params_.templ.lyxName << ",\""
+          << params_.filename << "\",\"" << params_.parameters << "\"\n";
 }
 
 
-void InsetExternal::Read(Buffer const *, LyXLex & lex)
+void InsetExternal::read(Buffer const *, LyXLex & lex)
 {
        string format;
        string token;
 
        // Read inset data from lex and store in format
-       if (lex.EatLine()) {
-               format = lex.GetString();
-       } else
+       if (lex.eatLine()) {
+               format = lex.getString();
+       } else {
                lex.printError("InsetExternal: Parse error: `$$Token'");
-       while (lex.IsOK()) {
+       }
+
+       while (lex.isOK()) {
                lex.nextToken();
-               token = lex.GetString();
+               token = lex.getString();
                if (token == "\\end_inset")
                        break;
        }
@@ -105,68 +155,63 @@ void InsetExternal::Read(Buffer const *, LyXLex & lex)
        }
 
        // Parse string format...
-       string::size_type const pos1 = format.find(",");
+       string::size_type const pos1 = format.find(',');
        params_.templ = ExternalTemplateManager::get().getTemplateByName(format.substr(0, pos1));
        string::size_type const pos2 = format.find("\",\"", pos1);
        params_.filename = format.substr(pos1 + 2, pos2 - (pos1 + 2));
        params_.parameters = format.substr(pos2 + 3, format.length() - (pos2 + 4));
 
        lyxerr[Debug::INFO] << "InsetExternal::Read: " << params_.templ.lyxName
-                           << " " << params_.filename
-                           << " " << params_.parameters << endl;
+                           << ' ' << params_.filename
+                           << ' ' << params_.parameters << endl;
 }
 
 
 int InsetExternal::write(string const & format,
-                        Buffer const * buf, std::ostream & os) const
+                        Buffer const * buf, ostream & os) const
 {
        ExternalTemplate const & et = params_.templ;
        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;
+                      << "' not specified in template "
+                      << params_.templ.lyxName << endl;
                return 0;
        }
-       
-       if (et.automaticProduction) {
-               executeCommand(doSubstitution(buf,
-                                             (*cit).second.updateCommand),
-                              buf);
-       }
-       
-       os << doSubstitution(buf, (*cit).second.product);
+
+       updateExternal(format, buf);
+       os << doSubstitution(buf, cit->second.product);
        return 0; // CHECK  (FIXME check what ? - jbl)
 }
 
 
-int InsetExternal::Latex(Buffer const * buf,
-                        std::ostream & os, bool, bool) const
+int InsetExternal::latex(Buffer const * buf,
+                        ostream & os, bool, bool) const
 {
        return write("LaTeX", buf, os);
 }
 
 
-int InsetExternal::Ascii(Buffer const * buf, std::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, std::ostream & os) const
+int InsetExternal::linuxdoc(Buffer const * buf, ostream & os) const
 {
        return write("LinuxDoc", buf, os);
 }
 
 
-int InsetExternal::DocBook(Buffer const * buf, std::ostream & os) const
+int InsetExternal::docbook(Buffer const * buf, ostream & os, bool) const
 {
        return write("DocBook", buf, os);
 }
 
 
-void InsetExternal::Validate(LaTeXFeatures & features) const
+void InsetExternal::validate(LaTeXFeatures & features) const
 {
        ExternalTemplate const & et = params_.templ;
        ExternalTemplate::Formats::const_iterator cit =
@@ -174,25 +219,28 @@ void InsetExternal::Validate(LaTeXFeatures & features) const
 
        if (cit == et.formats.end())
                return;
-       
-       if (!(*cit).second.requirement.empty()) {
-               features.require((*cit).second.requirement);
+
+       if (!cit->second.requirement.empty()) {
+               features.require(cit->second.requirement);
        }
-       if (!(*cit).second.preamble.empty()) {
-               features.externalPreambles += (*cit).second.preamble + "\n";
+       if (!cit->second.preamble.empty()) {
+               features.addExternalPreamble(cit->second.preamble + "\n");
        }
 }
 
 
-Inset * InsetExternal::Clone(Buffer const &) const
+Inset * InsetExternal::clone(Buffer const &, bool same_id) const
 {
-       InsetExternal * inset = new InsetExternal();
+       InsetExternal * inset = new InsetExternal;
        inset->params_ = params_;
+       inset->view_ = view_;
+       if (same_id)
+               inset->id_ = id_;
        return inset;
 }
 
 
-string const InsetExternal::getScreenLabel() const
+string const InsetExternal::getScreenLabel(Buffer const *) const
 {
        ExternalTemplate const & et = params_.templ;
        if (et.guiName.empty())
@@ -205,30 +253,32 @@ string const InsetExternal::getScreenLabel() const
 void InsetExternal::executeCommand(string const & s,
                                   Buffer const * buffer) const
 {
-       string buf = MakeAbsPath(buffer->fileName());
-       string path = OnlyPath(buf);
-       Path p(path);
-       Systemcalls one;
+       Path p(buffer->filePath());
+       Systemcall one;
        if (lyxerr.debugging()) {
                lyxerr << "Executing '" << s << "' in '"
-                      << path << "'" << endl;
+                      << buffer->filePath() << '\'' << endl;
        }
-       one.startscript(Systemcalls::Wait, s);
+       one.startscript(Systemcall::Wait, s);
 }
 
 
 string const InsetExternal::doSubstitution(Buffer const * buffer,
-                                    string const & s) const
+                                          string const & s) const
 {
        string result;
        string const basename = ChangeExtension(params_.filename, string());
+       string filepath;
+       if (buffer && !buffer->tmppath.empty() && !buffer->niceFile) {
+               filepath = buffer->filePath();
+       }
        result = subst(s, "$$FName", params_.filename);
        result = subst(result, "$$Basename", basename);
        result = subst(result, "$$Parameters", params_.parameters);
-       result = ReplaceEnvironmentPath(result);
-       result = subst(result, "$$Tempname", tempname);
+       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(\"")) {
 
@@ -238,9 +288,7 @@ string const InsetExternal::doSubstitution(Buffer const * buffer,
                string contents;
                if (buffer) {
                        // Make sure we are in the directory of the buffer
-                       string const buf = MakeAbsPath(buffer->fileName());
-                       string const path = OnlyPath(buf);
-                       Path p(path);
+                       Path p(buffer->filePath());
                        contents = GetFileContents(file);
                } else {
                        contents = GetFileContents(file);
@@ -255,55 +303,121 @@ string const InsetExternal::doSubstitution(Buffer const * buffer,
 
 
 void InsetExternal::updateExternal() const
+{
+       updateExternal("LaTeX", view_->buffer());
+}
+
+void InsetExternal::updateExternal(string const & format,
+                                  Buffer const * buf) const
 {
        ExternalTemplate const & et = params_.templ;
        ExternalTemplate::Formats::const_iterator cit =
-               et.formats.find("LaTeX");
-       if (cit == et.formats.end())
+               et.formats.find(format);
+
+       if (cit == et.formats.end() ||
+           cit->second.updateCommand.empty() ||
+           !et.automaticProduction)
                return;
-       
-       executeCommand(doSubstitution(view->buffer(),
-                                     (*cit).second.updateCommand),
-                      view->buffer());
+
+       if (!cit->second.updateResult.empty()) {
+               string const resultfile = doSubstitution(buf,
+                                                        cit->second.updateResult);
+               FileInfo fi(params_.filename);
+               FileInfo fi2(resultfile);
+               if (fi2.exist() && fi.exist() &&
+                   difftime(fi2.getModificationTime(),
+                            fi.getModificationTime()) >= 0) {
+                       lyxerr[Debug::FILES] << resultfile
+                                            << " is up to date" << endl;
+                       return;
+               }
+       }
+
+       executeCommand(doSubstitution(buf, cit->second.updateCommand), buf);
 }
 
 
 void InsetExternal::viewExternal() const
 {
        ExternalTemplate const & et = params_.templ;
-       if (et.automaticProduction)
-               updateExternal();
+       if (et.viewCommand.empty())
+               return;
 
-       executeCommand(doSubstitution(view->buffer(),
+       updateExternal();
+       executeCommand(doSubstitution(view_->buffer(),
                                      et.viewCommand),
-                      view->buffer());
+                      view_->buffer());
 }
 
 
 void InsetExternal::editExternal() const
 {
        ExternalTemplate const & et = params_.templ;
-       if (et.automaticProduction)
-               updateExternal();
+       if (et.editCommand.empty())
+               return;
 
-       executeCommand(doSubstitution(view->buffer(),
+       updateExternal();
+       executeCommand(doSubstitution(view_->buffer(),
                                      et.editCommand),
-                      view->buffer());
+                      view_->buffer());
 }
 
 
-bool operator==(InsetExternal::Params const & left,
-               InsetExternal::Params const & right)
+string const InsetExternalMailer::name_("external");
+
+InsetExternalMailer::InsetExternalMailer(InsetExternal & inset)
+       : inset_(inset)
+{}
+
+
+string const InsetExternalMailer::inset2string() const
 {
-       return ((left.filename   == right.filename) &&
-               (left.parameters == right.parameters) &&
-               (left.templ.lyxName == right.templ.lyxName));
+       return params2string(inset_.params());
 }
 
 
-bool operator!=(InsetExternal::Params const & left,
-               InsetExternal::Params const & right)
+void InsetExternalMailer::string2params(string const & in,
+                                       InsetExternal::Params & params)
 {
-       return  !(left == right);
+       params = InsetExternal::Params();
+
+       istringstream data(in);
+       LyXLex lex(0,0);
+       lex.setStream(data);
+
+       if (lex.isOK()) {
+               lex.next();
+               string const token = lex.getString();
+               if (token != name_)
+                       return;
+       }
+
+       // This is part of the inset proper that is usually swallowed
+       // by Buffer::readInset
+       if (lex.isOK()) {
+               lex.next();
+               string const token = lex.getString();
+               if (token != "External")
+                       return;
+       }
+
+       if (lex.isOK()) {
+               InsetExternal inset;    
+               inset.read(0, lex);
+               params = inset.params();
+       }
 }
 
+
+string const
+InsetExternalMailer::params2string(InsetExternal::Params const & params)
+{
+       InsetExternal inset;
+       inset.setFromParams(params);
+       ostringstream data;
+       data << name_ << ' ';
+       inset.write(0, data);
+       data << "\\end_inset\n";
+
+       return data.str();
+}