]> git.lyx.org Git - features.git/blobdiff - src/insets/insetexternal.C
Replace LString.h with support/std_string.h,
[features.git] / src / insets / insetexternal.C
index de1ae3c924b3ac9086f9273e490492e867815f6b..664d1a8035c0fcdf22263d0bf3269d2bf933ef8e 100644 (file)
@@ -5,7 +5,7 @@
  *
  * \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 "funcrequest.h"
 #include "gettext.h"
 #include "LaTeXFeatures.h"
-#include "latexrunparams.h"
-#include "lyx_main.h"
 #include "lyxlex.h"
 #include "lyxrc.h"
-#include "Lsstream.h"
+#include "support/std_sstream.h"
 
 #include "frontends/lyx_gui.h"
-#include "frontends/LyXView.h"
-#include "frontends/Dialogs.h"
 
-#include "support/FileInfo.h"
 #include "support/filetools.h"
 #include "support/forkedcall.h"
 #include "support/lstrings.h"
 #include "support/lyxalgo.h"
+#include "support/lyxlib.h"
 #include "support/path.h"
+#include "support/path_defines.h"
 #include "support/tostr.h"
+#include "support/translator.h"
 
 #include <boost/bind.hpp>
 
-#include <cstdio>
-#include <utility>
+namespace support = lyx::support;
 
-using namespace lyx::support;
-
-using std::ostream;
 using std::endl;
+using std::auto_ptr;
+using std::ostream;
+
+
+namespace lyx {
+namespace graphics {
+/// The translator between the DisplayType and the corresponding lyx string.
+extern Translator<DisplayType, string> displayTranslator;
+}
+}
 
 namespace {
 
@@ -57,10 +61,10 @@ 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
 
@@ -69,8 +73,8 @@ InsetExternal::Params::Params()
        : display(defaultDisplayType),
          lyxscale(defaultLyxScale)
 {
-       tempname = tempName(string(), "lyxext");
-       unlink(tempname);
+       tempname = support::tempName(string(), "lyxext");
+       support::unlink(tempname);
        // must have an extension for the converter code to work correctly.
        tempname += ".tmp";
 }
@@ -78,7 +82,7 @@ InsetExternal::Params::Params()
 
 InsetExternal::Params::~Params()
 {
-       unlink(tempname);
+       support::unlink(tempname);
 }
 
 
@@ -88,7 +92,7 @@ InsetExternal::InsetExternal()
 
 
 InsetExternal::InsetExternal(InsetExternal const & other)
-       : Inset(other),
+       : InsetOld(other),
          boost::signals::trackable(),
          params_(other.params_),
          renderer_(other.renderer_->clone())
@@ -100,10 +104,9 @@ InsetExternal::InsetExternal(InsetExternal const & other)
 }
 
 
-InsetBase * InsetExternal::clone() const
+auto_ptr<InsetBase> InsetExternal::clone() const
 {
-       InsetExternal * inset = new InsetExternal(*this);
-       return inset;
+       return auto_ptr<InsetBase>(new InsetExternal(*this));
 }
 
 
@@ -126,9 +129,9 @@ dispatch_result InsetExternal::localDispatch(FuncRequest const & cmd)
        switch (cmd.action) {
 
        case LFUN_EXTERNAL_EDIT: {
-               Assert(cmd.view());
+               support::Assert(cmd.view());
 
-               Buffer const * buffer = cmd.view()->buffer();
+               Buffer const & buffer = *cmd.view()->buffer();
                InsetExternal::Params p;
                InsetExternalMailer::string2params(cmd.argument, buffer, p);
                editExternal(p, buffer);
@@ -136,12 +139,12 @@ dispatch_result InsetExternal::localDispatch(FuncRequest const & cmd)
        }
 
        case LFUN_INSET_MODIFY: {
-               Assert(cmd.view());
+               support::Assert(cmd.view());
 
-               Buffer const * buffer = cmd.view()->buffer();
+               Buffer const & buffer = *cmd.view()->buffer();
                InsetExternal::Params p;
                InsetExternalMailer::string2params(cmd.argument, buffer, p);
-               setParams(p);
+               setParams(p, buffer);
                cmd.view()->updateInset(this);
                return DISPATCHED;
        }
@@ -205,13 +208,14 @@ 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 support::bformat(_("External template %1$s is not installed"),
+                                       params.templatename);
+       return doSubstitution(params, buffer, ptr->guiName);
 }
 
 } // namespace anon
@@ -223,7 +227,7 @@ InsetExternal::Params const & InsetExternal::params() const
 }
 
 
-void InsetExternal::setParams(Params const & p)
+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;
@@ -244,7 +248,7 @@ void InsetExternal::setParams(Params const & p)
                        renderer_.reset(button_ptr);
                }
 
-               button_ptr->update(getScreenLabel(params_), true);
+               button_ptr->update(getScreenLabel(params_, buffer), true);
 
        } else {
                GraphicRenderer * graphic_ptr =
@@ -261,26 +265,14 @@ void InsetExternal::setParams(Params const & p)
 }
 
 
-BufferView * InsetExternal::view() const
-{
-       return renderer_->view();
-}
-
-
-string const InsetExternal::editMessage() const
-{
-       return getScreenLabel(params_);
-}
-
-
-void InsetExternal::write(Buffer const * buffer, 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.outputFilename(buffer->filePath())
+                  << params_.filename.outputFilename(buffer.filePath())
                   << '\n';
 
        if (params_.display != defaultDisplayType)
@@ -292,7 +284,7 @@ void InsetExternal::write(Buffer const * buffer, ostream & os) const
 }
 
 
-void InsetExternal::read(Buffer const * buffer, LyXLex & lex)
+void InsetExternal::read(Buffer const & buffer, LyXLex & lex)
 {
        enum ExternalTags {
                EX_TEMPLATE = 1,
@@ -310,7 +302,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;
@@ -327,7 +319,7 @@ void InsetExternal::read(Buffer const * buffer, LyXLex & lex)
                case EX_FILENAME: {
                        lex.next();
                        string const name = lex.getString();
-                       params.filename.set(name, buffer->filePath());
+                       params.filename.set(name, buffer.filePath());
                        break;
                }
 
@@ -364,22 +356,21 @@ void InsetExternal::read(Buffer const * buffer, LyXLex & lex)
                               "Missing \\end_inset.");
        }
 
-       lex.popTable();
-
        // Replace the inset's store
-       setParams(params);
-
-       lyxerr[Debug::INFO] << "InsetExternal::Read: "
-                           << "template: '" << params_.templatename
-                           << "' filename: '" << params_.filename.absFilename()
-                           << "' display: '" << params_.display
-                           << "' scale: '" << params_.lyxscale
-                           << '\'' << endl;
+       setParams(params, buffer);
+
+       lyxerr[Debug::EXTERNAL]
+               << "InsetExternal::Read: "
+               << "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_);
@@ -390,9 +381,10 @@ int InsetExternal::write(string const & format,
        ExternalTemplate::Formats::const_iterator cit =
                et.formats.find(format);
        if (cit == et.formats.end()) {
-               lyxerr << "External template format '" << format
-                      << "' not specified in template "
-                      << params_.templatename << endl;
+               lyxerr[Debug::EXTERNAL]
+                       << "External template format '" << format
+                       << "' not specified in template "
+                       << params_.templatename << endl;
                return 0;
        }
 
@@ -403,7 +395,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
@@ -411,7 +403,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.
@@ -431,19 +423,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);
 }
@@ -456,23 +448,22 @@ void InsetExternal::validate(LaTeXFeatures & features) const
                return;
        ExternalTemplate const & et = *et_ptr;
 
-       ExternalTemplate::Formats::const_iterator cit =
-               et.formats.find("LaTeX");
-
+       ExternalTemplate::Formats::const_iterator cit = et.formats.find("LaTeX");
        if (cit == et.formats.end())
                return;
 
-       if (!cit->second.requirement.empty()) {
+       if (!cit->second.requirement.empty())
                features.require(cit->second.requirement);
-       }
-       if (!cit->second.preamble.empty()) {
-               features.addExternalPreamble(cit->second.preamble + "\n");
-       }
+
+       ExternalTemplateManager & etm = ExternalTemplateManager::get();
+       string const preamble = etm.getPreambleDefByName(cit->second.preambleName);
+       if (!preamble.empty())
+               features.addExternalPreamble(preamble);
 }
 
 
 void InsetExternal::updateExternal(string const & format,
-                                  Buffer const * buf,
+                                  Buffer const & buf,
                                   bool external_in_tmpdir) const
 {
        ExternalTemplate const * const et_ptr = getTemplatePtr(params_);
@@ -503,7 +494,7 @@ void InsetExternal::updateExternal(string const & format,
                        return;
 
                // Try and ascertain the file format from its contents.
-               from_format = getExtFromContents(from_file);
+               from_format = support::getExtFromContents(from_file);
                if (from_format.empty())
                        return;
        }
@@ -513,35 +504,42 @@ void InsetExternal::updateExternal(string const & format,
                return;
 
        if (!converters.isReachable(from_format, to_format)) {
-               lyxerr << "InsetExternal::updateExternal. "
-                       "Unable to convert from "
-                      << from_format << " to " << to_format << endl;
+               lyxerr[Debug::EXTERNAL]
+                       << "InsetExternal::updateExternal. "
+                       << "Unable to convert from "
+                       << from_format << " to " << to_format << endl;
                return;
        }
 
        if (external_in_tmpdir && !from_file.empty()) {
                // We are running stuff through LaTeX
-               from_file = copyFileToDir(buf->tmppath, from_file);
-               if (from_file.empty())
+               string const temp_file =
+                       support::MakeAbsPath(params_.filename.mangledFilename(),
+                                            buf.tmppath);
+               unsigned long const from_checksum = support::sum(from_file);
+               unsigned long const temp_checksum = support::sum(temp_file);
+
+               // Nothing to do...
+               if (from_checksum == temp_checksum)
                        return;
+
+               // Cannot proceed...
+               if (!support::copy(from_file, temp_file))
+                       return;
+               from_file = temp_file;
        }
 
        string const to_file = doSubstitution(params_, buf,
                                              outputFormat.updateResult);
+       string const abs_to_file = support::MakeAbsPath(to_file, buf.filePath());
 
-       FileInfo fi(from_file);
-       string abs_to_file = to_file;
-       if (!AbsolutePath(to_file))
-               abs_to_file = MakeAbsPath(to_file, OnlyPath(from_file));
-       FileInfo fi2(abs_to_file);
-       if (fi2.exist() && fi.exist() &&
-           difftime(fi2.getModificationTime(),
-                    fi.getModificationTime()) >= 0) {
-       } else {
-               string const to_filebase = ChangeExtension(to_file, string());
-               converters.convert(buf, from_file, to_filebase,
-                                  from_format, to_format);
-       }
+       // Do we need to perform the conversion?
+       // Yes if to_file does not exist or if from_file is newer than to_file
+       if (support::compare_timestamps(from_file, abs_to_file) < 0)
+               return;
+       
+       string const to_filebase = support::ChangeExtension(to_file, string());
+       converters.convert(&buf, from_file, to_filebase, from_format, to_format);
 }
 
 
@@ -549,49 +547,46 @@ 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 absfilename = params.filename.absFilename();
-       string const basename = ChangeExtension(absfilename, string());
-       string filepath;
+       string const buffer_path = buffer.filePath();
+       string const filename = params.filename.outputFilename(buffer_path);
+       string const basename = support::ChangeExtension(filename, string());
+       string const filepath = support::OnlyPath(filename);
 
-       result = subst(s, "$$FName", absfilename);
-       result = subst(result, "$$Basename", basename);
-       result = subst(result, "$$FPath", filepath);
-       result = subst(result, "$$Tempname", params.tempname);
-       result = subst(result, "$$Sysdir", system_lyxdir);
+       result = support::subst(s, "$$FName", filename);
+       result = support::subst(result, "$$Basename", basename);
+       result = support::subst(result, "$$FPath", filepath);
+       result = support::subst(result, "$$Tempname", params.tempname);
+       result = support::subst(result, "$$Sysdir", support::system_lyxdir());
 
        // Handle the $$Contents(filename) syntax
-       if (contains(result, "$$Contents(\"")) {
+       if (support::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);
+
+               string const filepath = support::IsFileReadable(file) ?
+                       buffer.filePath() : buffer.tmppath;
+               support::Path p(filepath);
+
+               if (support::IsFileReadable(file))
+                       contents = support::GetFileContents(file);
+
+               result = support::subst(result,
+                                       ("$$Contents(\"" + file + "\")").c_str(),
+                                       contents);
        }
 
        return result;
 }
 
 
-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;
@@ -602,13 +597,13 @@ void editExternal(InsetExternal::Params const & params, Buffer const * buffer)
 
        string const command = doSubstitution(params, buffer, et.editCommand);
 
-       Path p(buffer->filePath());
-       Forkedcall call;
-       if (lyxerr.debugging()) {
+       support::Path p(buffer.filePath());
+       support::Forkedcall call;
+       if (lyxerr.debugging(Debug::EXTERNAL)) {
                lyxerr << "Executing '" << command << "' in '"
-                      << buffer->filePath() << '\'' << endl;
+                      << buffer.filePath() << '\'' << endl;
        }
-       call.startscript(Forkedcall::DontWait, command);
+       call.startscript(support::Forkedcall::DontWait, command);
 }
 
 } // namespace anon
@@ -620,17 +615,14 @@ InsetExternalMailer::InsetExternalMailer(InsetExternal & inset)
 {}
 
 
-string const InsetExternalMailer::inset2string() const
+string const InsetExternalMailer::inset2string(Buffer const & buffer) const
 {
-       BufferView * bv = inset_.view();
-       if (!bv)
-               return string();
-       return params2string(inset_.params(), bv->buffer());
+       return params2string(inset_.params(), buffer);
 }
 
 
 void InsetExternalMailer::string2params(string const & in,
-                                       Buffer const * buffer,
+                                       Buffer const & buffer,
                                        InsetExternal::Params & params)
 {
        params = InsetExternal::Params();
@@ -668,10 +660,10 @@ void InsetExternalMailer::string2params(string const & in,
 
 string const
 InsetExternalMailer::params2string(InsetExternal::Params const & params,
-                                  Buffer const * buffer)
+                                  Buffer const & buffer)
 {
        InsetExternal inset;
-       inset.setParams(params);
+       inset.setParams(params, buffer);
        ostringstream data;
        data << name_ << ' ';
        inset.write(buffer, data);