]> git.lyx.org Git - lyx.git/blobdiff - src/graphics/GraphicsConverter.cpp
Prevent the PreviewLoader from orphaning children
[lyx.git] / src / graphics / GraphicsConverter.cpp
index 3a69da9bdc76befc5cf2f67b6c125a449439fd0a..ccfb57ce4b4a02f9dfa3a1507713de677856987c 100644 (file)
 
 #include "GraphicsConverter.h"
 
-#include "converter.h"
-#include "debug.h"
-#include "format.h"
+#include "Converter.h"
+#include "Format.h"
 
-#include "support/filetools.h"
-#include "support/forkedcallqueue.h"
+#include "support/lassert.h"
 #include "support/convert.h"
+#include "support/debug.h"
+#include "support/FileName.h"
+#include "support/filetools.h"
+#include "support/ForkedCalls.h"
 #include "support/lstrings.h"
-#include "support/lyxlib.h"
 #include "support/os.h"
 
-#include <boost/bind.hpp>
+#include "support/bind.h"
 
 #include <sstream>
 #include <fstream>
 
-namespace support = lyx::support;
-
-using support::addExtension;
-using support::changeExtension;
-using support::FileName;
-using support::Forkedcall;
-using support::ForkedCallQueue;
-using support::getExtension;
-using support::libScriptSearch;
-using support::onlyPath;
-using support::onlyFilename;
-using support::quoteName;
-using support::quote_python;
-using support::subst;
-using support::tempName;
-using support::unlink;
-
-using std::endl;
-using std::ostream;
-using std::ostringstream;
-using std::string;
-
+using namespace std;
+using namespace lyx::support;
 
 namespace lyx {
+
 namespace graphics {
 
 class Converter::Impl : public boost::signals::trackable {
@@ -102,9 +84,10 @@ Converter::Converter(FileName const & from_file, string const & to_file_base,
 {}
 
 
-// Empty d-tor out-of-line to keep boost::scoped_ptr happy.
 Converter::~Converter()
-{}
+{
+       delete pimpl_;
+}
 
 
 void Converter::startConversion() const
@@ -128,7 +111,7 @@ FileName const & Converter::convertedFile() const
 /** Build the conversion script.
  *  The script is output to the stream \p script.
  */
-static void build_script(FileName const & from_file, string const & to_file_base,
+static void build_script(string const & from_file, string const & to_file_base,
                  string const & from_format, string const & to_format,
                  ostream & script);
 
@@ -137,11 +120,11 @@ Converter::Impl::Impl(FileName const & from_file, string const & to_file_base,
                      string const & from_format, string const & to_format)
        : valid_process_(false), finished_(false)
 {
-       LYXERR(Debug::GRAPHICS) << "Converter c-tor:\n"
+       LYXERR(Debug::GRAPHICS, "Converter c-tor:\n"
                << "\tfrom_file:      " << from_file
                << "\n\tto_file_base: " << to_file_base
                << "\n\tfrom_format:  " << from_format
-               << "\n\tto_format:    " << to_format << endl;
+               << "\n\tto_format:    " << to_format);
 
        // The converted image is to be stored in this file (we do not
        // use ChangeExtension because this is a basename which may
@@ -150,23 +133,25 @@ Converter::Impl::Impl(FileName const & from_file, string const & to_file_base,
 
        // The conversion commands are stored in a stringstream
        ostringstream script;
-       build_script(from_file, to_file_base, from_format, to_format, script);
-       LYXERR(Debug::GRAPHICS) << "\tConversion script:"
-               << "\n--------------------------------------\n"
+       build_script(from_file.toFilesystemEncoding(),
+                    to_file_.toFilesystemEncoding(),
+                    from_format, to_format, script);
+       LYXERR(Debug::GRAPHICS, "\tConversion script:"
+                  "\n--------------------------------------\n"
                << script.str()
-               << "\n--------------------------------------\n";
+               << "\n--------------------------------------\n");
 
        // Output the script to file.
        static int counter = 0;
        script_file_ = FileName(onlyPath(to_file_base) + "lyxconvert" +
                convert<string>(counter++) + ".py");
 
-       std::ofstream fs(script_file_.toFilesystemEncoding().c_str());
+       ofstream fs(script_file_.toFilesystemEncoding().c_str());
        if (!fs.good()) {
                lyxerr << "Unable to write the conversion script to \""
                       << script_file_ << '\n'
                       << "Please check your directory permissions."
-                      << std::endl;
+                      << endl;
                return;
        }
 
@@ -177,9 +162,9 @@ Converter::Impl::Impl(FileName const & from_file, string const & to_file_base,
        // We create a dummy command for ease of understanding of the
        // list of forked processes.
        // Note: 'python ' is absolutely essential, or execvp will fail.
-       script_command_ = support::os::python() + ' ' +
+       script_command_ = os::python() + ' ' +
                quoteName(script_file_.toFilesystemEncoding()) + ' ' +
-               quoteName(onlyFilename(from_file.toFilesystemEncoding())) + ' ' +
+               quoteName(onlyFileName(from_file.toFilesystemEncoding())) + ' ' +
                quoteName(to_format);
        // All is ready to go
        valid_process_ = true;
@@ -193,13 +178,12 @@ void Converter::Impl::startConversion()
                return;
        }
 
-       Forkedcall::SignalTypePtr
-               ptr = ForkedCallQueue::get().add(script_command_);
-
-       ptr->connect(boost::bind(&Impl::converted, this, _1, _2));
-
+       ForkedCall::SignalTypePtr ptr =
+               ForkedCallQueue::add(script_command_);
+       ptr->connect(bind(&Impl::converted, this, _1, _2));
 }
 
+
 void Converter::Impl::converted(pid_t /* pid */, int retval)
 {
        if (finished_)
@@ -208,10 +192,10 @@ void Converter::Impl::converted(pid_t /* pid */, int retval)
 
        finished_ = true;
        // Clean-up behind ourselves
-       unlink(script_file_);
+       script_file_.removeFile();
 
        if (retval > 0) {
-               unlink(to_file_);
+               to_file_.removeFile();
                to_file_.erase();
                finishedConversion(false);
        } else {
@@ -257,52 +241,39 @@ static void build_conversion_command(string const & command, ostream & script)
        // If this occurs, move ${outfile}.0 to ${outfile}
        // and delete ${outfile}.? (ignore errors)
        script << "if not os.path.isfile(outfile):\n"
-                 "  if os.path.isfile(outfile + '.0'):\n"
-                 "    os.rename(outfile + '.0', outfile)\n"
-                 "    import glob\n"
-                 "    for file in glob.glob(outfile + '.?'):\n"
-                 "      unlinkNoThrow(file)\n"
-                 "  else:\n"
-                 "    sys.exit(1)\n\n";
+                 "  if os.path.isfile(outfile + '.0'):\n"
+                 "    os.rename(outfile + '.0', outfile)\n"
+                 "    import glob\n"
+                 "    for file in glob.glob(outfile + '.?'):\n"
+                 "      unlinkNoThrow(file)\n"
+                 "  else:\n"
+                 "    sys.exit(1)\n\n";
 
        // Delete the infile
-       script << "unlinkNoThrow(infile)\n\n";
+       script << "if infile != outfile:\n"
+                 "  unlinkNoThrow(infile)\n\n";
 }
 
 
-static void build_script(FileName const & from_file,
-                 string const & to_file_base,
+static void build_script(string const & from_file,
+                 string const & to_file,
                  string const & from_format,
                  string const & to_format,
                  ostream & script)
 {
-       BOOST_ASSERT(from_format != to_format);
-       LYXERR(Debug::GRAPHICS) << "build_script ... ";
-       typedef Converters::EdgePath EdgePath;
+       LASSERT(from_format != to_format, /**/);
+       LYXERR(Debug::GRAPHICS, "build_script ... ");
+       typedef Graph::EdgePath EdgePath;
 
        script << "#!/usr/bin/env python\n"
-                 "# -*- coding: utf-8 -*-\n"
-                 "import os, shutil, sys, locale\n\n"
-                 "def unlinkNoThrow(file):\n"
-                 "  ''' remove a file, do not throw if an error occurs '''\n"
-                 "  try:\n"
-                 "    os.unlink(file)\n"
-                 "  except:\n"
-                 "    pass\n\n"
-                 "def utf8ToDefaultEncoding(file):\n"
-                 "  ''' if possible, convert to the default encoding '''\n"
-                 "  try:\n"
-                 "    language, output_encoding = locale.getdefaultlocale()\n"
-                 "    if output_encoding == None:\n"
-                 "      output_encoding = 'latin1'\n"
-                 "    return unicode(file, 'utf8').encode(output_encoding)\n"
-                 "  except:\n"
-                 "    return file\n\n";
-
-       // 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);
+                 "# -*- coding: utf-8 -*-\n"
+                 "import os, shutil, sys\n\n"
+                 "def unlinkNoThrow(file):\n"
+                 "  ''' remove a file, do not throw if an error occurs '''\n"
+                 "  try:\n"
+                 "    os.unlink(file)\n"
+                 "  except:\n"
+                 "    pass\n\n";
 
        EdgePath const edgepath = from_format.empty() ?
                EdgePath() :
@@ -312,39 +283,40 @@ static void build_script(FileName const & from_file,
        // Remember to remove the temp file because we only want the name...
        static int counter = 0;
        string const tmp = "gconvert" + convert<string>(counter++);
-       FileName const to_base(tempName(FileName(), tmp));
-       unlink(to_base);
+       string const to_base = FileName::tempName(tmp).toFilesystemEncoding();
 
        // Create a copy of the file in case the original name contains
        // problematic characters like ' or ". We can work around that problem
        // in python, but the converters might be shell scripts and have more
        // troubles with it.
-       string outfile = addExtension(to_base.absFilename(), getExtension(from_file.absFilename()));
-       script << "infile = utf8ToDefaultEncoding("
-                       << quoteName(from_file.absFilename(), quote_python)
-                       << ")\n"
-                 "outfile = " << quoteName(outfile, quote_python) << "\n"
-                 "shutil.copy(infile, outfile)\n";
+       string outfile = addExtension(to_base, getExtension(from_file));
+       script << "infile = "
+                       << quoteName(from_file, quote_python)
+                       << "\n"
+                 "outfile = "
+                       << quoteName(outfile, quote_python) << "\n"
+                 "shutil.copy(infile, outfile)\n";
 
        // Some converters (e.g. lilypond) can only output files to the
        // current directory, so we need to change the current directory.
        // This has the added benefit that all other files that may be
        // generated by the converter are deleted when LyX closes and do not
        // clutter the real working directory.
-       script << "os.chdir(" << quoteName(onlyPath(outfile)) << ")\n";
+       script << "os.chdir("
+              << quoteName(onlyPath(outfile)) << ")\n";
 
        if (edgepath.empty()) {
                // Either from_format is unknown or we don't have a
                // converter path from from_format to to_format, so we use
                // the default converter.
                script << "infile = outfile\n"
-                      << "outfile = " << quoteName(to_file, quote_python)
-                      << '\n';
+                      << "outfile = "
+                      << quoteName(to_file, quote_python) << "\n";
 
                ostringstream os;
-               os << support::os::python() << ' '
+               os << os::python() << ' '
                   << libScriptSearch("$$s/scripts/convertDefault.py",
-                                     quote_python) << ' ';
+                                     quote_python) << ' ';
                if (!from_format.empty())
                        os << from_format << ':';
                // The extra " quotes around infile and outfile are needed
@@ -354,18 +326,19 @@ static void build_script(FileName const & from_file,
                   << to_format << ":' + '\"' + outfile + '\"' + '";
                string const command = os.str();
 
-               LYXERR(Debug::GRAPHICS)
-                       << "\tNo converter defined! I use convertDefault.py\n\t"
-                       << command << endl;
+               LYXERR(Debug::GRAPHICS,
+                       "\tNo converter defined! I use convertDefault.py\n\t"
+                       << command);
 
                build_conversion_command(command, script);
        }
 
        // The conversion commands may contain these tokens that need to be
-       // changed to infile, infile_base, outfile respectively.
-       string const token_from("$$i");
-       string const token_base("$$b");
-       string const token_to("$$o");
+       // changed to infile, infile_base, outfile and output directory respectively.
+       string const token_from  = "$$i";
+       string const token_base  = "$$b";
+       string const token_to    = "$$o";
+       string const token_todir = "$$d";
 
        EdgePath::const_iterator it  = edgepath.begin();
        EdgePath::const_iterator end = edgepath.end();
@@ -376,19 +349,35 @@ static void build_script(FileName const & from_file,
                // Build the conversion command
                string const infile      = outfile;
                string const infile_base = changeExtension(infile, string());
-               outfile = addExtension(to_base.absFilename(), conv.To->extension());
+               outfile = conv.result_file.empty()
+                       ? addExtension(to_base, conv.To->extension())
+                       : addName(subst(conv.result_dir,
+                                       token_base, infile_base),
+                                 subst(conv.result_file,
+                                       token_base, onlyFileName(infile_base)));
+
+               // If two formats share the same extension we may get identical names
+               if (outfile == infile && conv.result_file.empty()) {
+                       string const new_base = FileName::tempName(tmp).toFilesystemEncoding();
+                       outfile = addExtension(new_base, conv.To->extension());
+               }
 
                // Store these names in the python script
-               script << "infile = "      << quoteName(infile, quote_python) << "\n"
-                         "infile_base = " << quoteName(infile_base, quote_python) << "\n"
-                         "outfile = "     << quoteName(outfile, quote_python) << '\n';
+               script << "infile = "
+                               << quoteName(infile, quote_python) << "\n"
+                         "infile_base = "
+                               << quoteName(infile_base, quote_python) << "\n"
+                         "outfile = "
+                               << quoteName(outfile, quote_python) << "\n"
+                         "outdir  = os.path.dirname(outfile)\n" ;
 
                // See comment about extra " quotes above (although that
                // applies only for the first loop run here).
                string command = conv.command;
-               command = subst(command, token_from, "' + '\"' + infile + '\"' + '");
-               command = subst(command, token_base, "' + '\"' + infile_base + '\"' + '");
-               command = subst(command, token_to,   "' + '\"' + outfile + '\"' + '");
+               command = subst(command, token_from,  "' + '\"' + infile + '\"' + '");
+               command = subst(command, token_base,  "' + '\"' + infile_base + '\"' + '");
+               command = subst(command, token_to,    "' + '\"' + outfile + '\"' + '");
+               command = subst(command, token_todir, "' + '\"' + outdir + '\"' + '");
                command = libScriptSearch(command, quote_python);
 
                build_conversion_command(command, script);
@@ -396,9 +385,8 @@ static void build_script(FileName const & from_file,
 
        // Move the final outfile to to_file
        script << move_file("outfile", quoteName(to_file, quote_python));
-       LYXERR(Debug::GRAPHICS) << "ready!" << endl;
+       LYXERR(Debug::GRAPHICS, "ready!");
 }
 
 } // namespace graphics
-
 } // namespace lyx