]> git.lyx.org Git - lyx.git/blobdiff - src/graphics/GraphicsConverter.C
Fix InsetInclude properly. Data is now stored in an InsetCommandParams
[lyx.git] / src / graphics / GraphicsConverter.C
index 31ac475372c7c077a72cafbd03cbe4f9e0868679..b75095ecd0fca4d1514d0be53f2f3638d6183334 100644 (file)
@@ -1,43 +1,57 @@
 /**
- *  \file GraphicsConverter.C
- *  Copyright 2002 the LyX Team
- *  Read the file COPYING
+ * \file GraphicsConverter.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *  \author Angus Leeming <leeming@lyx.org>
+ * \author Angus Leeming
+ *
+ * Full author contact details are available in file CREDITS.
  */
 
 #include <config.h>
 
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
 #include "GraphicsConverter.h"
 
 #include "converter.h"
 #include "debug.h"
+#include "format.h"
 
 #include "support/filetools.h"
-#include "support/forkedcall.h"
+#include "support/forkedcallqueue.h"
+#include "support/tostr.h"
+#include "support/lstrings.h"
 #include "support/lyxlib.h"
 
 #include <boost/bind.hpp>
-#include <boost/signals/trackable.hpp>
 
-#include "Lsstream.h"
+#include "support/std_sstream.h"
 #include <fstream>
-#include <sys/types.h> // needed for pid_t
 
-extern string system_lyxdir;
+namespace support = lyx::support;
+
+using support::ChangeExtension;
+using support::Forkedcall;
+using support::ForkedCallQueue;
+using support::LibFileSearch;
+using support::LibScriptSearch;
+using support::OnlyPath;
+using support::OnlyFilename;
+using support::QuoteName;
+using support::subst;
+using support::tempName;
+using support::unlink;
 
 using std::endl;
+using std::ostream;
+using std::ostringstream;
 
-namespace grfx {
+
+namespace lyx {
+namespace graphics {
 
 struct Converter::Impl : public boost::signals::trackable {
        ///
-       Impl(Converter &,
-            string const &, string const &, string const &, string const &);
+       Impl(string const &, string const &, string const &, string const &);
 
        ///
        void startConversion();
@@ -47,7 +61,14 @@ struct Converter::Impl : public boost::signals::trackable {
         *  Cleans-up the temporary files, emits the finishedConversion
         *  signal and removes the Converter from the list of all processes.
         */
-       void converted(string const & cmd, pid_t pid, int retval);
+       void converted(pid_t pid, int retval);
+
+       /** At the end of the conversion process inform the outside world
+        *  by emitting a signal.
+        */
+       typedef boost::signal1<void, bool> SignalType;
+       ///
+       SignalType finishedConversion;
 
        ///
        string script_command_;
@@ -56,35 +77,39 @@ struct Converter::Impl : public boost::signals::trackable {
        ///
        string to_file_;
        ///
-       Converter & parent_;
-       ///
        bool valid_process_;
        ///
        bool finished_;
 };
 
 
+bool Converter::isReachable(string const & from_format_name,
+                           string const & to_format_name)
+{
+       return converters.isReachable(from_format_name, to_format_name);
+}
+
+
 Converter::Converter(string const & from_file,   string const & to_file_base,
                     string const & from_format, string const & to_format)
-       : pimpl_(new Impl(*this,
-                         from_file, to_file_base, from_format, to_format))
+       : pimpl_(new Impl(from_file, to_file_base, from_format, to_format))
 {}
 
 
+// Empty d-tor out-of-line to keep boost::scoped_ptr happy.
 Converter::~Converter()
 {}
 
-void Converter::startConversion()
+
+void Converter::startConversion() const
 {
        pimpl_->startConversion();
 }
 
 
-bool Converter::isReachable(string const & from_format_name,
-                           string const & to_format_name)
+boost::signals::connection Converter::connect(slot_type const & slot) const
 {
-       return converters.isReachable(from_format_name, to_format_name);
+       return pimpl_->finishedConversion.connect(slot);
 }
 
 
@@ -93,8 +118,10 @@ string const & Converter::convertedFile() const
        static string const empty;
        return pimpl_->finished_ ? pimpl_->to_file_ : empty;
 }
-} // namespace grfx
+
+} // namespace graphics
+} // namespace lyx
+
 
 //------------------------------
 // Implementation details follow
@@ -107,17 +134,17 @@ namespace {
  */
 bool build_script(string const & from_file, string const & to_file_base,
                  string const & from_format, string const & to_format,
-                 ostringstream & script);
+                 ostream & script);
 
 } // namespace anon
 
 
-namespace grfx {
+namespace lyx {
+namespace graphics {
 
-Converter::Impl::Impl(Converter & p,
-                     string const & from_file,   string const & to_file_base,
+Converter::Impl::Impl(string const & from_file,   string const & to_file_base,
                      string const & from_format, string const & to_format)
-       : parent_(p), valid_process_(false), finished_(false)
+       : valid_process_(false), finished_(false)
 {
        lyxerr[Debug::GRAPHICS] << "Converter c-tor:\n"
                << "\tfrom_file:      " << from_file
@@ -125,44 +152,53 @@ Converter::Impl::Impl(Converter & p,
                << "\n\tfrom_format:  " << from_format
                << "\n\tto_format:    " << to_format << endl;
 
+       // The converted image is to be stored in this file (we do not
+       // use ChangeExtension because this is a basename which may
+       // nevertheless contain a '.')
+       to_file_ = to_file_base + '.' +  formats.extension(to_format);
+
        // The conversion commands are stored in a stringstream
        ostringstream script;
        script << "#!/bin/sh\n";
        bool const success = build_script(from_file, to_file_base,
                                          from_format, to_format, script);
 
-       if (!success)
-               return;
-
-       lyxerr[Debug::GRAPHICS] << "\tConversion script:"
-                               << "\n--------------------------------------\n"
-                               << script.str().c_str() 
-                               << "\n--------------------------------------\n";
-
-       // Output the script to file.
-       static int counter = 0;
-       script_file_ = OnlyPath(to_file_base) + "lyxconvert" +
-                      tostr(counter++) + ".sh";
-
-       std::ofstream fs(script_file_.c_str());
-       if (!fs.good())
-               return;
+       if (!success) {
+               script_command_ =
+                       "sh " + LibFileSearch("scripts", "convertDefault.sh") +
+                       ' ' + from_format + ':' + from_file + ' ' +
+                       to_format + ':' + to_file_;
 
-       fs << script.str().c_str();
-       fs.close();
+               lyxerr[Debug::GRAPHICS]
+                       << "\tNo converter defined! I use convertDefault.sh\n\t"
+                       << script_command_ << endl;
 
-       // The converted image is to be stored in this file
-       // We do not use ChangeExtension here because this is a
-       // basename, which may nevertheless contain a dot
-       to_file_ = to_file_base + '.' + formats.extension(to_format);
-
-       // The command needed to run the conversion process
-       // We create a dummy command for ease of understanding of the
-       // list of forked processes.
-       // Note that 'sh ' is absolutely essential, or execvp will fail.
-       script_command_ = "sh " + script_file_ + " " +
-                         OnlyFilename(from_file) + " " + to_format;
+       } else {
 
+               lyxerr[Debug::GRAPHICS] << "\tConversion script:"
+                       << "\n--------------------------------------\n"
+                       << script.str()
+                       << "\n--------------------------------------\n";
+
+               // Output the script to file.
+               static int counter = 0;
+               script_file_ = OnlyPath(to_file_base) + "lyxconvert" +
+                       tostr(counter++) + ".sh";
+
+               std::ofstream fs(script_file_.c_str());
+               if (!fs.good())
+                       return;
+
+               fs << script.str();
+               fs.close();
+
+               // The command needed to run the conversion process
+               // We create a dummy command for ease of understanding of the
+               // list of forked processes.
+               // Note: 'sh ' is absolutely essential, or execvp will fail.
+               script_command_ = "sh " + script_file_ + ' ' +
+                       OnlyFilename(from_file) + ' ' + to_format;
+       }
        // All is ready to go
        valid_process_ = true;
 }
@@ -171,28 +207,18 @@ Converter::Impl::Impl(Converter & p,
 void Converter::Impl::startConversion()
 {
        if (!valid_process_) {
-               converted(string(), 0, 1);
+               converted(0, 1);
                return;
        }
-               
-       // Initiate the conversion
-       Forkedcall::SignalTypePtr convert_ptr;
-       convert_ptr.reset(new Forkedcall::SignalType);
 
-       convert_ptr->connect(
-               boost::bind(&Impl::converted, this, _1, _2, _3));
+       Forkedcall::SignalTypePtr
+               ptr = ForkedCallQueue::get().add(script_command_);
 
-       Forkedcall call;
-       int retval = call.startscript(script_command_, convert_ptr);
-       if (retval > 0) {
-               // Unable to even start the script, so clean-up the mess!
-               converted(string(), 0, 1);
-       }
-}
+       ptr->connect(boost::bind(&Impl::converted, this, _1, _2));
 
+}
 
-void Converter::Impl::converted(string const & /* cmd */,
-                               pid_t /* pid */, int retval)
+void Converter::Impl::converted(pid_t /* pid */, int retval)
 {
        if (finished_)
                // We're done already!
@@ -200,18 +226,19 @@ void Converter::Impl::converted(string const & /* cmd */,
 
        finished_ = true;
        // Clean-up behind ourselves
-       lyx::unlink(script_file_);
+       unlink(script_file_);
 
        if (retval > 0) {
-               lyx::unlink(to_file_);
+               unlink(to_file_);
                to_file_.erase();
-               parent_.finishedConversion(false);
+               finishedConversion(false);
        } else {
-               parent_.finishedConversion(true);
+               finishedConversion(true);
        }
 }
 
-} // namespace grfx
+} // namespace graphics
+} // namespace lyx
 
 namespace {
 
@@ -223,29 +250,32 @@ string const move_file(string const & from_file, string const & to_file)
        ostringstream command;
        command << "fromfile=" << from_file << "\n"
                << "tofile="   << to_file << "\n\n"
-               << "'mv' -f ${fromfile} ${tofile}\n"
-               << "if [ $? -ne 0 ]; then\n"
-               << "\t'cp' -f ${fromfile} ${tofile}\n"
-               << "\tif [ $? -ne 0 ]; then\n"
+               << "'mv' -f ${fromfile} ${tofile} ||\n"
+               << "{\n"
+               << "\t'cp' -f ${fromfile} ${tofile} ||\n"
+               << "\t{\n"
                << "\t\texit 1\n"
-               << "\tfi\n"
+               << "\t}\n"
                << "\t'rm' -f ${fromfile}\n"
-               << "fi\n";
+               << "}\n";
 
-       return command.str().c_str();
+       return command.str();
 }
 
+
 bool build_script(string const & from_file,
                  string const & to_file_base,
                  string const & from_format,
                  string const & to_format,
-                 ostringstream & script)
+                 ostream & script)
 {
        lyxerr[Debug::GRAPHICS] << "build_script ... ";
        typedef Converters::EdgePath EdgePath;
 
-       string const to_file = ChangeExtension(to_file_base,
-                                              formats.extension(to_format));
+       // we do not use ChangeExtension because this is a basename
+       // which may nevertheless contain a '.'
+       string const to_file = to_file_base + '.'
+               + formats.extension(to_format);
 
        if (from_format == to_format) {
                script << move_file(QuoteName(from_file), QuoteName(to_file));
@@ -264,8 +294,8 @@ bool build_script(string const & from_file,
        // Remember to remove the temp file because we only want the name...
        static int counter = 0;
        string const tmp = "gconvert" + tostr(counter++);
-       string const to_base = lyx::tempName(string(), tmp);
-       lyx::unlink(to_base);
+       string const to_base = tempName(string(), tmp);
+       unlink(to_base);
 
        string outfile = from_file;
 
@@ -274,10 +304,10 @@ bool build_script(string const & from_file,
        string const token_from("$$i");
        string const token_base("$$b");
        string const token_to("$$o");
-       string const token_lib("$$s");
 
        EdgePath::const_iterator it  = edgepath.begin();
        EdgePath::const_iterator end = edgepath.end();
+
        for (; it != end; ++it) {
                ::Converter const & conv = converters.get(*it);
 
@@ -295,17 +325,17 @@ bool build_script(string const & from_file,
                command = subst(command, token_from, "${infile}");
                command = subst(command, token_base, "${infile_base}");
                command = subst(command, token_to,   "${outfile}");
-               command = subst(command, token_lib,  system_lyxdir + "scripts");
+               command = LibScriptSearch(command);
 
                // Store in the shell script
-               script << "\n" << command << "\n\n";
+               script << "\n" << command << " ||\n";
 
                // Test that this was successful. If not, remove
                // ${outfile} and exit the shell script
-               script << "if [ $? -ne 0 ]; then\n"
+               script << "{\n"
                       << "\t'rm' -f ${outfile}\n"
                       << "\texit 1\n"
-                      << "fi\n\n";
+                      << "}\n\n";
 
                // Test that the outfile exists.
                // ImageMagick's convert will often create ${outfile}.0,
@@ -333,5 +363,5 @@ bool build_script(string const & from_file,
 
        return true;
 }
+
 } // namespace anon