]> git.lyx.org Git - lyx.git/blobdiff - src/converter.C
* src/tabular.[Ch]: simplify plaintext methods, because there
[lyx.git] / src / converter.C
index 1784d915cd4f4cfb4d53486774415879919f9c78..18dddd33dc3869effef6c00e4a194c8a0b7067af 100644 (file)
@@ -12,6 +12,7 @@
 
 #include "converter.h"
 
+#include "ConverterCache.h"
 #include "buffer.h"
 #include "buffer_funcs.h"
 #include "bufferparams.h"
 
 #include "support/filetools.h"
 #include "support/lyxlib.h"
+#include "support/os.h"
 #include "support/path.h"
 #include "support/systemcall.h"
 
-using lyx::support::AddName;
-using lyx::support::bformat;
-using lyx::support::ChangeExtension;
-using lyx::support::compare_ascii_no_case;
-using lyx::support::contains;
-using lyx::support::DirList;
-using lyx::support::GetExtension;
-using lyx::support::IsFileReadable;
-using lyx::support::LibFileSearch;
-using lyx::support::LibScriptSearch;
-using lyx::support::MakeRelPath;
-using lyx::support::OnlyFilename;
-using lyx::support::OnlyPath;
-using lyx::support::Path;
-using lyx::support::prefixIs;
-using lyx::support::QuoteName;
-using lyx::support::split;
-using lyx::support::subst;
-using lyx::support::Systemcall;
+
+namespace lyx {
+
+using support::addName;
+using support::bformat;
+using support::changeExtension;
+using support::compare_ascii_no_case;
+using support::contains;
+using support::dirList;
+using support::FileName;
+using support::getExtension;
+using support::isFileReadable;
+using support::libFileSearch;
+using support::libScriptSearch;
+using support::makeAbsPath;
+using support::makeRelPath;
+using support::onlyFilename;
+using support::onlyPath;
+using support::Path;
+using support::prefixIs;
+using support::quoteName;
+using support::removeExtension;
+using support::split;
+using support::subst;
+using support::Systemcall;
 
 using std::endl;
 using std::find_if;
@@ -55,6 +63,8 @@ using std::string;
 using std::vector;
 using std::distance;
 
+namespace Alert = lyx::frontend::Alert;
+
 
 namespace {
 
@@ -77,7 +87,7 @@ string const dvipdfm_options(BufferParams const & bp)
 {
        string result;
 
-       if (bp.papersize2 != VM_PAPER_CUSTOM) {
+       if (bp.papersize != PAPER_CUSTOM) {
                string const paper_size = bp.paperSizeName();
                if (paper_size != "b5" && paper_size != "foolscap")
                        result = "-p "+ paper_size;
@@ -279,53 +289,73 @@ OutputParams::FLAVOR Converters::getFlavor(Graph::EdgePath const & path)
 
 
 bool Converters::convert(Buffer const * buffer,
-                        string const & from_file, string const & to_file_base,
-                        string const & from_format, string const & to_format,
-                        string & to_file, bool try_default)
+                         FileName const & from_file, FileName const & to_file,
+                         FileName const & orig_from,
+                         string const & from_format, string const & to_format,
+                         ErrorList & errorList, int conversionflags)
 {
-       string const to_ext = formats.extension(to_format);
-       to_file = ChangeExtension(to_file_base, to_ext);
-
        if (from_format == to_format)
                return move(from_format, from_file, to_file, false);
 
+       if ((conversionflags & try_cache) &&
+           ConverterCache::get().inCache(orig_from, to_format))
+               return ConverterCache::get().copy(orig_from, to_format, to_file);
+
        Graph::EdgePath edgepath = getPath(from_format, to_format);
        if (edgepath.empty()) {
-               if (try_default) {
+               if (conversionflags & try_default) {
                        // if no special converter defined, then we take the
                        // default one from ImageMagic.
-                       string const from_ext = formats.extension(from_format);
-                       string const command = "sh " +
-                               LibFileSearch("scripts", "convertDefault.sh") +
-                               ' ' + from_ext + ':' + from_file +
-                               ' ' + to_ext   + ':' + to_file;
+                       string const from_ext = from_format.empty() ?
+                               getExtension(from_file.absFilename()) :
+                               formats.extension(from_format);
+                       string const to_ext = formats.extension(to_format);
+                       string const command =
+                               support::os::python() + ' ' +
+                               quoteName(libFileSearch("scripts", "convertDefault.py").toFilesystemEncoding()) +
+                               ' ' +
+                               quoteName(from_ext + ':' + from_file.toFilesystemEncoding()) +
+                               ' ' +
+                               quoteName(to_ext + ':' + to_file.toFilesystemEncoding());
                        lyxerr[Debug::FILES]
                                << "No converter defined! "
-                                  "I use convertDefault.sh:\n\t"
+                                  "I use convertDefault.py:\n\t"
                                << command << endl;
                        Systemcall one;
                        one.startscript(Systemcall::Wait, command);
-                       if (IsFileReadable(to_file)) {
+                       if (isFileReadable(to_file)) {
+                               if (conversionflags & try_cache)
+                                       ConverterCache::get().add(orig_from,
+                                                       to_format, to_file);
                                return true;
                        }
                }
                Alert::error(_("Cannot convert file"),
-                       bformat(_("No information for converting %1$s "
-                               "format files to %2$s.\n"
-                               "Try defining a convertor in the preferences."),
-                       from_format, to_format));
+                            bformat(_("No information for converting %1$s "
+                                                   "format files to %2$s.\n"
+                                                   "Define a converter in the preferences."),
+                                                       from_ascii(from_format), from_ascii(to_format)));
                return false;
        }
        OutputParams runparams;
        runparams.flavor = getFlavor(edgepath);
-       string path = OnlyPath(from_file);
+
+       // 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.
+       string path = onlyPath(from_file.absFilename());
        Path p(path);
 
+       // empty the error list before any new conversion takes place.
+       errorList.clear();
+
        bool run_latex = false;
-       string from_base = ChangeExtension(from_file, "");
-       string to_base = ChangeExtension(to_file, "");
-       string infile;
-       string outfile = from_file;
+       string from_base = changeExtension(from_file.absFilename(), "");
+       string to_base = changeExtension(to_file.absFilename(), "");
+       FileName infile;
+       FileName outfile = from_file;
        for (Graph::EdgePath::const_iterator cit = edgepath.begin();
             cit != edgepath.end(); ++cit) {
                Converter const & conv = converterlist_[*cit];
@@ -334,26 +364,26 @@ bool Converters::convert(Buffer const * buffer,
                        lyxerr[Debug::FILES] << "Converting from  "
                               << conv.from << " to " << conv.to << endl;
                infile = outfile;
-               outfile = conv.result_dir.empty()
-                       ? ChangeExtension(from_file, conv.To->extension())
-                       : AddName(subst(conv.result_dir,
+               outfile = FileName(conv.result_dir.empty()
+                       ? changeExtension(from_file.absFilename(), conv.To->extension())
+                       : addName(subst(conv.result_dir,
                                        token_base, from_base),
                                  subst(conv.result_file,
-                                       token_base, OnlyFilename(from_base)));
+                                       token_base, onlyFilename(from_base))));
 
                // if input and output files are equal, we use a
                // temporary file as intermediary (JMarc)
-               string real_outfile;
+               FileName real_outfile;
                if (outfile == infile) {
                        real_outfile = infile;
-                       outfile = AddName(buffer->temppath(), "tmpfile.out");
+                       outfile = FileName(addName(buffer->temppath(), "tmpfile.out"));
                }
 
                if (conv.latex) {
                        run_latex = true;
                        string const command = subst(conv.command, token_from, "");
                        lyxerr[Debug::FILES] << "Running " << command << endl;
-                       if (!runLaTeX(*buffer, command, runparams))
+                       if (!runLaTeX(*buffer, command, runparams, errorList))
                                return false;
                } else {
                        if (conv.need_aux && !run_latex
@@ -361,22 +391,22 @@ bool Converters::convert(Buffer const * buffer,
                                lyxerr[Debug::FILES]
                                        << "Running " << latex_command_
                                        << " to update aux file"<<  endl;
-                               runLaTeX(*buffer, latex_command_, runparams);
+                               runLaTeX(*buffer, latex_command_, runparams, errorList);
                        }
 
                        string const infile2 = (conv.original_dir)
-                               ? infile : MakeRelPath(infile, path);
+                               ? infile.absFilename() : makeRelPath(infile.absFilename(), path);
                        string const outfile2 = (conv.original_dir)
-                               ? outfile : MakeRelPath(outfile, path);
+                               ? outfile.absFilename() : makeRelPath(outfile.absFilename(), path);
 
                        string command = conv.command;
-                       command = subst(command, token_from, QuoteName(infile2));
-                       command = subst(command, token_base, QuoteName(from_base));
-                       command = subst(command, token_to, QuoteName(outfile2));
-                       command = LibScriptSearch(command);
+                       command = subst(command, token_from, quoteName(infile2));
+                       command = subst(command, token_base, quoteName(from_base));
+                       command = subst(command, token_to, quoteName(outfile2));
+                       command = libScriptSearch(command);
 
                        if (!conv.parselog.empty())
-                               command += " 2> " + QuoteName(infile2 + ".out");
+                               command += " 2> " + quoteName(infile2 + ".out");
 
                        if (conv.from == "dvi" && conv.to == "ps")
                                command = add_options(command,
@@ -388,7 +418,7 @@ bool Converters::convert(Buffer const * buffer,
                        lyxerr[Debug::FILES] << "Calling " << command << endl;
                        if (buffer)
                                buffer->message(_("Executing command: ")
-                                       + command);
+                               + from_utf8(command));
 
                        Systemcall::Starttype const type = (dummy)
                                ? Systemcall::DontWait : Systemcall::Wait;
@@ -396,12 +426,14 @@ bool Converters::convert(Buffer const * buffer,
                        int res;
                        if (conv.original_dir) {
                                Path p(buffer->filePath());
-                               res = one.startscript(type, command);
+                               res = one.startscript(type,
+                                       to_filesystem8bit(from_utf8(command)));
                        } else
-                               res = one.startscript(type, command);
+                               res = one.startscript(type,
+                                       to_filesystem8bit(from_utf8(command)));
 
                        if (!real_outfile.empty()) {
-                               Mover const & mover = movers(conv.to);
+                               Mover const & mover = getMover(conv.to);
                                if (!mover.rename(outfile, real_outfile))
                                        res = -1;
                                else
@@ -409,16 +441,20 @@ bool Converters::convert(Buffer const * buffer,
                                                << "renaming file " << outfile
                                                << " to " << real_outfile
                                                << endl;
+                               // Finally, don't forget to tell any future
+                               // converters to use the renamed file...
+                               outfile = real_outfile;
                        }
 
                        if (!conv.parselog.empty()) {
                                string const logfile =  infile2 + ".log";
-                               string const script = LibScriptSearch(conv.parselog);
+                               string const script = libScriptSearch(conv.parselog);
                                string const command2 = script +
-                                       " < " + QuoteName(infile2 + ".out") +
-                                       " > " + QuoteName(logfile);
-                               one.startscript(Systemcall::Wait, command2);
-                               if (!scanLog(*buffer, command, logfile))
+                                       " < " + quoteName(infile2 + ".out") +
+                                       " > " + quoteName(logfile);
+                               one.startscript(Systemcall::Wait,
+                                       to_filesystem8bit(from_utf8(command2)));
+                               if (!scanLog(*buffer, command, makeAbsPath(logfile, path), errorList))
                                        return false;
                        }
 
@@ -429,9 +465,9 @@ bool Converters::convert(Buffer const * buffer,
                                } else {
 // FIXME: this should go out of here. For example, here we cannot say if
 // it is a document (.lyx) or something else. Same goes for elsewhere.
-                               Alert::error(_("Cannot convert file"),
-                                       bformat(_("An error occurred whilst running %1$s"),
-                                               command.substr(0, 50)));
+                                       Alert::error(_("Cannot convert file"),
+                                               bformat(_("An error occurred whilst running %1$s"),
+                                               from_utf8(command.substr(0, 50))));
                                }
                                return false;
                        }
@@ -443,78 +479,73 @@ bool Converters::convert(Buffer const * buffer,
                return true;
 
        if (!conv.result_dir.empty()) {
-               to_file = AddName(subst(conv.result_dir, token_base, to_base),
-                                 subst(conv.result_file,
-                                       token_base, OnlyFilename(to_base)));
+               // The converter has put the file(s) in a directory.
+               // In this case we ignore the given to_file.
                if (from_base != to_base) {
                        string const from = subst(conv.result_dir,
                                            token_base, from_base);
                        string const to = subst(conv.result_dir,
                                          token_base, to_base);
-                       Mover const & mover = movers(conv.from);
-                       if (!mover.rename(from, to)) {
+                       Mover const & mover = getMover(conv.from);
+                       if (!mover.rename(FileName(from), FileName(to))) {
                                Alert::error(_("Cannot convert file"),
-                                       bformat(_("Could not move a temporary file from %1$s to %2$s."),
-                                               from, to));
+                                       bformat(_("Could not move a temporary directory from %1$s to %2$s."),
+                                               from_utf8(from), from_utf8(to)));
                                return false;
                        }
                }
                return true;
-       } else
+       } else {
+               if (conversionflags & try_cache)
+                       ConverterCache::get().add(orig_from, to_format, outfile);
                return move(conv.to, outfile, to_file, conv.latex);
+       }
 }
 
 
 bool Converters::move(string const & fmt,
-                     string const & from, string const & to, bool copy)
+                     FileName const & from, FileName const & to, bool copy)
 {
        if (from == to)
                return true;
 
        bool no_errors = true;
-       string const path = OnlyPath(from);
-       string const base = OnlyFilename(ChangeExtension(from, ""));
-       string const to_base = ChangeExtension(to, "");
-       string const to_extension = GetExtension(to);
-
-       vector<string> files = DirList(OnlyPath(from), GetExtension(from));
-       for (vector<string>::const_iterator it = files.begin();
-            it != files.end(); ++it)
-               if (prefixIs(*it, base)) {
-                       string const from2 = path + *it;
-                       string to2 = to_base + it->substr(base.length());
-                       to2 = ChangeExtension(to2, to_extension);
+       string const path = onlyPath(from.absFilename());
+       string const base = onlyFilename(removeExtension(from.absFilename()));
+       string const to_base = removeExtension(to.absFilename());
+       string const to_extension = getExtension(to.absFilename());
+
+       vector<FileName> const files = dirList(FileName(path),
+                       getExtension(from.absFilename()));
+       for (vector<FileName>::const_iterator it = files.begin();
+            it != files.end(); ++it) {
+               string const from2 = it->absFilename();
+               string const file2 = onlyFilename(from2);
+               if (prefixIs(file2, base)) {
+                       string const to2 = changeExtension(
+                               to_base + file2.substr(base.length()),
+                               to_extension);
                        lyxerr[Debug::FILES] << "moving " << from2
                                             << " to " << to2 << endl;
 
-                       Mover const & mover = movers(fmt);
+                       Mover const & mover = getMover(fmt);
                        bool const moved = copy
-                               ? mover.copy(from2, to2)
-                               : mover.rename(from2, to2);
+                               ? mover.copy(*it, FileName(to2))
+                               : mover.rename(*it, FileName(to2));
                        if (!moved && no_errors) {
                                Alert::error(_("Cannot convert file"),
                                        bformat(copy ?
-                                               _("Could not copy a temporary file from %1$s to %2$s.") :
-                                               _("Could not move a temporary file from %1$s to %2$s."),
-                                               from2, to2));
+                                               _("Could not copy a temporary file from %1$s to %2$s.") :
+                                               _("Could not move a temporary file from %1$s to %2$s."),
+                                               from_utf8(from2), from_utf8(to2)));
                                no_errors = false;
                        }
                }
+       }
        return no_errors;
 }
 
 
-bool Converters::convert(Buffer const * buffer,
-                        string const & from_file, string const & to_file_base,
-                        string const & from_format, string const & to_format,
-                         bool try_default)
-{
-       string to_file;
-       return convert(buffer, from_file, to_file_base, from_format, to_format,
-                      to_file, try_default);
-}
-
-
 bool Converters::formatIsUsed(string const & format)
 {
        ConverterList::const_iterator cit = converterlist_.begin();
@@ -528,16 +559,16 @@ bool Converters::formatIsUsed(string const & format)
 
 
 bool Converters::scanLog(Buffer const & buffer, string const & /*command*/,
-                        string const & filename)
+                        FileName const & filename, ErrorList & errorList)
 {
        OutputParams runparams;
        runparams.flavor = OutputParams::LATEX;
-       LaTeX latex("", runparams, filename, "");
+       LaTeX latex("", runparams, filename);
        TeXErrors terr;
        int const result = latex.scanLogFile(terr);
 
        if (result & LaTeX::ERRORS)
-               bufferErrors(buffer, terr);
+               bufferErrors(buffer, terr, errorList);
 
        return true;
 }
@@ -545,10 +576,10 @@ bool Converters::scanLog(Buffer const & buffer, string const & /*command*/,
 
 namespace {
 
-class showMessage : public std::unary_function<string, void>, public boost::signals::trackable {
+class showMessage : public std::unary_function<docstring, void>, public boost::signals::trackable {
 public:
        showMessage(Buffer const & b) : buffer_(b) {};
-       void operator()(string const & m) const
+       void operator()(docstring const & m) const
        {
                buffer_.message(m);
        }
@@ -560,7 +591,7 @@ private:
 
 
 bool Converters::runLaTeX(Buffer const & buffer, string const & command,
-                         OutputParams const & runparams)
+                         OutputParams const & runparams, ErrorList & errorList)
 {
        buffer.busy(true);
        buffer.message(_("Running LaTeX..."));
@@ -569,21 +600,21 @@ bool Converters::runLaTeX(Buffer const & buffer, string const & command,
 
        // do the LaTeX run(s)
        string const name = buffer.getLatexName();
-       LaTeX latex(command, runparams, name, buffer.filePath());
+       LaTeX latex(command, runparams, FileName(makeAbsPath(name)));
        TeXErrors terr;
        showMessage show(buffer);
        latex.message.connect(show);
        int const result = latex.run(terr);
 
        if (result & LaTeX::ERRORS)
-               bufferErrors(buffer, terr);
+               bufferErrors(buffer, terr, errorList);
 
        // check return value from latex.run().
        if ((result & LaTeX::NO_LOGFILE)) {
-               string const str =
+               docstring const str =
                        bformat(_("LaTeX did not run successfully. "
-                                 "Additionally, LyX could not locate "
-                                 "the LaTeX log %1$s."), name);
+                                              "Additionally, LyX could not locate "
+                                              "the LaTeX log %1$s."), from_utf8(name));
                Alert::error(_("LaTeX failed"), str);
        } else if (result & LaTeX::NO_OUTPUT) {
                Alert::warning(_("Output is empty"),
@@ -669,9 +700,4 @@ Converters::getPath(string const & from, string const & to)
                          formats.getNumber(to));
 }
 
-
-/// The global instance
-Converters converters;
-
-// The global copy after reading lyxrc.defaults
-Converters system_converters;
+} // namespace lyx