]> git.lyx.org Git - lyx.git/blobdiff - src/converter.C
* filetools.[Ch]: Make functions that start with a capital
[lyx.git] / src / converter.C
index a3e5c6518effe4895c2bddd127b47d15d5135d34..750a03936bc4ad74e10c85560b3a8f2616948591 100644 (file)
 #include <config.h>
 
 #include "converter.h"
-#include "graph.h"
-#include "format.h"
-#include "lyxrc.h"
+
 #include "buffer.h"
-#include "bufferparams.h"
 #include "buffer_funcs.h"
-#include "bufferview_funcs.h"
-#include "errorlist.h"
-#include "LaTeX.h"
-#include "gettext.h"
+#include "bufferparams.h"
 #include "debug.h"
+#include "format.h"
+#include "gettext.h"
+#include "language.h"
+#include "LaTeX.h"
+#include "mover.h"
 
 #include "frontends/Alert.h"
-#include "frontends/LyXView.h"
 
 #include "support/filetools.h"
-#include "support/lyxfunctional.h"
 #include "support/lyxlib.h"
 #include "support/path.h"
-#include "support/tostr.h"
 #include "support/systemcall.h"
 
-#include <boost/signals/signal1.hpp>
-#include <boost/signals/trackable.hpp>
-
-#include <cctype>
-
-using namespace lyx::support;
+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;
 
-#ifndef CXX_GLOBAL_CSTD
-using std::isdigit;
-#endif
-
-using std::vector;
 using std::endl;
 using std::find_if;
+using std::string;
+using std::vector;
+using std::distance;
+
 
 namespace {
 
@@ -69,7 +77,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;
@@ -81,13 +89,27 @@ string const dvipdfm_options(BufferParams const & bp)
        return result;
 }
 
+
+class ConverterEqual : public std::binary_function<string, string, bool> {
+public:
+       ConverterEqual(string const & from, string const & to)
+               : from_(from), to_(to) {}
+       bool operator()(Converter const & c) const {
+               return c.from == from_ && c.to == to_;
+       }
+private:
+       string const from_;
+       string const to_;
+};
+
 } // namespace anon
 
 
-Converter::Converter(string const & f, string const & t, string const & c,
-         string const & l): from(f), to(t), command(c), flags(l),
-                            From(0), To(0), latex(false),
-                            original_dir(false), need_aux(false)
+Converter::Converter(string const & f, string const & t,
+                    string const & c, string const & l)
+       : from(f), to(t), command(c), flags(l),
+         From(0), To(0), latex(false), xml(false),
+         original_dir(false), need_aux(false)
 {}
 
 
@@ -100,6 +122,8 @@ void Converter::readFlags()
                flag_value = split(flag_value, flag_name, '=');
                if (flag_name == "latex")
                        latex = true;
+               else if (flag_name == "xml")
+                       xml = true;
                else if (flag_name == "originaldir")
                        original_dir = true;
                else if (flag_name == "needaux")
@@ -134,26 +158,12 @@ bool operator<(Converter const & a, Converter const & b)
 }
 
 
-class compare_Converter {
-public:
-       compare_Converter(string const & f, string const & t)
-               : from(f), to(t) {}
-       bool operator()(Converter const & c) {
-               return c.from == from && c.to == to;
-       }
-private:
-       string const & from;
-       string const & to;
-};
-
-
-
 Converter const * Converters::getConverter(string const & from,
-                                           string const & to)
+                                           string const & to) const
 {
-       ConverterList::const_iterator cit =
+       ConverterList::const_iterator const cit =
                find_if(converterlist_.begin(), converterlist_.end(),
-                       compare_Converter(from, to));
+                       ConverterEqual(from, to));
        if (cit != converterlist_.end())
                return &(*cit);
        else
@@ -161,13 +171,13 @@ Converter const * Converters::getConverter(string const & from,
 }
 
 
-int Converters::getNumber(string const & from, string const & to)
+int Converters::getNumber(string const & from, string const & to) const
 {
-       ConverterList::const_iterator cit =
+       ConverterList::const_iterator const cit =
                find_if(converterlist_.begin(), converterlist_.end(),
-                       compare_Converter(from, to));
+                       ConverterEqual(from, to));
        if (cit != converterlist_.end())
-               return cit - converterlist_.begin();
+               return distance(converterlist_.begin(), cit);
        else
                return -1;
 }
@@ -180,7 +190,7 @@ void Converters::add(string const & from, string const & to,
        formats.add(to);
        ConverterList::iterator it = find_if(converterlist_.begin(),
                                             converterlist_.end(),
-                                            compare_Converter(from, to));
+                                            ConverterEqual(from , to));
 
        Converter converter(from, to, command, flags);
        if (it != converterlist_.end() && !flags.empty() && flags[0] == '*') {
@@ -208,9 +218,10 @@ void Converters::add(string const & from, string const & to,
 
 void Converters::erase(string const & from, string const & to)
 {
-       ConverterList::iterator it = find_if(converterlist_.begin(),
-                                            converterlist_.end(),
-                                            compare_Converter(from, to));
+       ConverterList::iterator const it =
+               find_if(converterlist_.begin(),
+                       converterlist_.end(),
+                       ConverterEqual(from, to));
        if (it != converterlist_.end())
                converterlist_.erase(it);
 }
@@ -252,43 +263,72 @@ void Converters::sort()
 }
 
 
-bool Converters::usePdflatex(Graph::EdgePath const & path)
+OutputParams::FLAVOR Converters::getFlavor(Graph::EdgePath const & path)
 {
        for (Graph::EdgePath::const_iterator cit = path.begin();
             cit != path.end(); ++cit) {
                Converter const & conv = converterlist_[*cit];
                if (conv.latex)
-                       return contains(conv.to, "pdf");
+                       if (contains(conv.to, "pdf"))
+                               return OutputParams::PDFLATEX;
+               if (conv.xml)
+                       return OutputParams::XML;
        }
-       return false;
+       return OutputParams::LATEX;
 }
 
 
 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)
+                        string & to_file, bool try_default)
 {
-       to_file = ChangeExtension(to_file_base,
-                                 formats.extension(to_format));
+       string const to_ext = formats.extension(to_format);
+       to_file = changeExtension(to_file_base, to_ext);
 
        if (from_format == to_format)
-               return move(from_file, to_file, false);
+               return move(from_format, from_file, to_file, false);
 
        Graph::EdgePath edgepath = getPath(from_format, to_format);
        if (edgepath.empty()) {
+               if (try_default) {
+                       // if no special converter defined, then we take the
+                       // default one from ImageMagic.
+                       string const from_ext = from_format.empty() ?
+                               getExtension(from_file) :
+                               formats.extension(from_format);
+                       string const command =
+                               "sh " +
+                               quoteName(libFileSearch("scripts", "convertDefault.sh")) +
+                               ' ' +
+                               quoteName(from_ext + ':' + from_file) +
+                               ' ' +
+                               quoteName(to_ext + ':' + to_file);
+                       lyxerr[Debug::FILES]
+                               << "No converter defined! "
+                                  "I use convertDefault.sh:\n\t"
+                               << command << endl;
+                       Systemcall one;
+                       one.startscript(Systemcall::Wait, command);
+                       if (isFileReadable(to_file)) {
+                               return true;
+                       }
+               }
+               Alert::error(_("Cannot convert file"),
+                       bformat(_("No information for converting %1$s "
+                               "format files to %2$s.\n"
+                               "Define a convertor in the preferences."),
+                       from_format, to_format));
                return false;
        }
-       LatexRunParams runparams;
-       runparams.flavor = usePdflatex(edgepath) ?
-               LatexRunParams::PDFLATEX : LatexRunParams::LATEX;
-
-       string path = OnlyPath(from_file);
+       OutputParams runparams;
+       runparams.flavor = getFlavor(edgepath);
+       string path = onlyPath(from_file);
        Path p(path);
 
        bool run_latex = false;
-       string from_base = ChangeExtension(from_file, "");
-       string to_base = ChangeExtension(to_file, "");
+       string from_base = changeExtension(from_file, "");
+       string to_base = changeExtension(to_file, "");
        string infile;
        string outfile = from_file;
        for (Graph::EdgePath::const_iterator cit = edgepath.begin();
@@ -300,23 +340,23 @@ bool Converters::convert(Buffer const * buffer,
                               << conv.from << " to " << conv.to << endl;
                infile = outfile;
                outfile = conv.result_dir.empty()
-                       ? ChangeExtension(from_file, conv.To->extension())
-                       : AddName(subst(conv.result_dir,
+                       ? changeExtension(from_file, 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;
                if (outfile == infile) {
                        real_outfile = infile;
-                       outfile = AddName(buffer->tmppath, "tmpfile.out");
+                       outfile = addName(buffer->temppath(), "tmpfile.out");
                }
 
                if (conv.latex) {
                        run_latex = true;
-                       string command = subst(conv.command, token_from, "");
+                       string const command = subst(conv.command, token_from, "");
                        lyxerr[Debug::FILES] << "Running " << command << endl;
                        if (!runLaTeX(*buffer, command, runparams))
                                return false;
@@ -329,31 +369,33 @@ bool Converters::convert(Buffer const * buffer,
                                runLaTeX(*buffer, latex_command_, runparams);
                        }
 
-                       string infile2 = (conv.original_dir)
-                               ? infile : MakeRelPath(infile, path);
-                       string outfile2 = (conv.original_dir)
-                               ? outfile : MakeRelPath(outfile, path);
+                       string const infile2 = (conv.original_dir)
+                               ? infile : makeRelPath(infile, path);
+                       string const outfile2 = (conv.original_dir)
+                               ? outfile : makeRelPath(outfile, 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,
-                                                     buffer->params.dvips_options());
+                                                     buffer->params().dvips_options());
                        else if (conv.from == "dvi" && prefixIs(conv.to, "pdf"))
                                command = add_options(command,
-                                                     dvipdfm_options(buffer->params));
+                                                     dvipdfm_options(buffer->params()));
 
                        lyxerr[Debug::FILES] << "Calling " << command << endl;
-                       buffer->message(_("Executing command: ") + command);
+                       if (buffer)
+                               buffer->message(_("Executing command: ")
+                                       + command);
 
-                       Systemcall::Starttype type = (dummy)
+                       Systemcall::Starttype const type = (dummy)
                                ? Systemcall::DontWait : Systemcall::Wait;
                        Systemcall one;
                        int res;
@@ -364,21 +406,25 @@ bool Converters::convert(Buffer const * buffer,
                                res = one.startscript(type, command);
 
                        if (!real_outfile.empty()) {
-                               if (!rename(outfile, real_outfile))
+                               Mover const & mover = movers(conv.to);
+                               if (!mover.rename(outfile, real_outfile))
                                        res = -1;
                                else
                                        lyxerr[Debug::FILES]
                                                << "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);
+                                       " < " + quoteName(infile2 + ".out") +
+                                       " > " + quoteName(logfile);
                                one.startscript(Systemcall::Wait, command2);
                                if (!scanLog(*buffer, command, logfile))
                                        return false;
@@ -404,17 +450,17 @@ bool Converters::convert(Buffer const * buffer,
        if (conv.To->dummy())
                return true;
 
-
        if (!conv.result_dir.empty()) {
-               to_file = AddName(subst(conv.result_dir, token_base, to_base),
+               to_file = addName(subst(conv.result_dir, token_base, to_base),
                                  subst(conv.result_file,
-                                       token_base, OnlyFilename(to_base)));
+                                       token_base, onlyFilename(to_base)));
                if (from_base != to_base) {
-                       string from = subst(conv.result_dir,
+                       string const from = subst(conv.result_dir,
                                            token_base, from_base);
-                       string to = subst(conv.result_dir,
+                       string const to = subst(conv.result_dir,
                                          token_base, to_base);
-                       if (!rename(from, to)) {
+                       Mover const & mover = movers(conv.from);
+                       if (!mover.rename(from, to)) {
                                Alert::error(_("Cannot convert file"),
                                        bformat(_("Could not move a temporary file from %1$s to %2$s."),
                                                from, to));
@@ -423,38 +469,41 @@ bool Converters::convert(Buffer const * buffer,
                }
                return true;
        } else
-               return move(outfile, to_file, conv.latex);
+               return move(conv.to, outfile, to_file, conv.latex);
 }
 
 
-// If from = /path/file.ext and to = /path2/file2.ext2 then this method
-// moves each /path/file*.ext file to /path2/file2*.ext2'
-bool Converters::move(string const & from, string const & to, bool copy)
+bool Converters::move(string const & fmt,
+                     string const & from, string 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);
+       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));
+       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);
+                       to2 = changeExtension(to2, to_extension);
                        lyxerr[Debug::FILES] << "moving " << from2
                                             << " to " << to2 << endl;
-                       bool const moved = (copy)
-                               ? lyx::support::copy(from2, to2)
-                               : rename(from2, to2);
+
+                       Mover const & mover = movers(fmt);
+                       bool const moved = copy
+                               ? mover.copy(from2, to2)
+                               : mover.rename(from2, to2);
                        if (!moved && no_errors) {
                                Alert::error(_("Cannot convert file"),
-                                       bformat(_("Could not move a temporary file from %1$s to %2$s."),
+                                       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));
                                no_errors = false;
                        }
@@ -465,11 +514,12 @@ bool Converters::move(string const & from, string const & to, bool copy)
 
 bool Converters::convert(Buffer const * buffer,
                         string const & from_file, string const & to_file_base,
-                        string const & from_format, string const & to_format)
+                        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);
+                      to_file, try_default);
 }
 
 
@@ -488,11 +538,11 @@ bool Converters::formatIsUsed(string const & format)
 bool Converters::scanLog(Buffer const & buffer, string const & /*command*/,
                         string const & filename)
 {
-       LatexRunParams runparams;
-       runparams.flavor = LatexRunParams::LATEX;
+       OutputParams runparams;
+       runparams.flavor = OutputParams::LATEX;
        LaTeX latex("", runparams, filename, "");
        TeXErrors terr;
-       int result = latex.scanLogFile(terr);
+       int const result = latex.scanLogFile(terr);
 
        if (result & LaTeX::ERRORS)
                bufferErrors(buffer, terr);
@@ -500,12 +550,13 @@ bool Converters::scanLog(Buffer const & buffer, string const & /*command*/,
        return true;
 }
 
+
 namespace {
 
-class showMessage : public boost::signals::trackable {
+class showMessage : public std::unary_function<string, void>, public boost::signals::trackable {
 public:
        showMessage(Buffer const & b) : buffer_(b) {};
-       void operator()(string const & m)
+       void operator()(string const & m) const
        {
                buffer_.message(m);
        }
@@ -517,27 +568,30 @@ private:
 
 
 bool Converters::runLaTeX(Buffer const & buffer, string const & command,
-                         LatexRunParams const & runparams)
+                         OutputParams const & runparams)
 {
        buffer.busy(true);
        buffer.message(_("Running LaTeX..."));
 
+       runparams.document_language = buffer.params().language->babel();
+
        // do the LaTeX run(s)
-       string name = buffer.getLatexName();
+       string const name = buffer.getLatexName();
        LaTeX latex(command, runparams, name, buffer.filePath());
        TeXErrors terr;
        showMessage show(buffer);
        latex.message.connect(show);
-       int result = latex.run(terr);
+       int const result = latex.run(terr);
 
        if (result & LaTeX::ERRORS)
                bufferErrors(buffer, terr);
 
        // check return value from latex.run().
        if ((result & LaTeX::NO_LOGFILE)) {
-               string str = bformat(_("LaTeX did not run successfully. "
-                                      "Additionally, LyX could not locate "
-                                      "the LaTeX log %1$s."), name);
+               string const str =
+                       bformat(_("LaTeX did not run successfully. "
+                                 "Additionally, LyX could not locate "
+                                 "the LaTeX log %1$s."), name);
                Alert::error(_("LaTeX failed"), str);
        } else if (result & LaTeX::NO_OUTPUT) {
                Alert::warning(_("Output is empty"),
@@ -562,7 +616,7 @@ void Converters::buildGraph()
 {
        G_.init(formats.size());
        ConverterList::iterator beg = converterlist_.begin();
-       ConverterList::iterator end = converterlist_.end();
+       ConverterList::iterator const end = converterlist_.end();
        for (ConverterList::iterator it = beg; it != end ; ++it) {
                int const s = formats.getNumber(it->from);
                int const t = formats.getNumber(it->to);
@@ -577,7 +631,7 @@ Converters::intToFormat(std::vector<int> const & input)
        vector<Format const *> result(input.size());
 
        vector<int>::const_iterator it = input.begin();
-       vector<int>::const_iterator end = input.end();
+       vector<int>::const_iterator const end = input.end();
        vector<Format const *>::iterator rit = result.begin();
        for ( ; it != end; ++it, ++rit) {
                *rit = &formats.get(*it);
@@ -585,8 +639,9 @@ Converters::intToFormat(std::vector<int> const & input)
        return result;
 }
 
+
 vector<Format const *> const
-Converters::getReachableTo(string const & target, bool clear_visited)
+Converters::getReachableTo(string const & target, bool const clear_visited)
 {
        vector<int> const & reachablesto =
                G_.getReachableTo(formats.getNumber(target), clear_visited);
@@ -596,8 +651,8 @@ Converters::getReachableTo(string const & target, bool clear_visited)
 
 
 vector<Format const *> const
-Converters::getReachable(string const & from, bool only_viewable,
-                        bool clear_visited)
+Converters::getReachable(string const & from, bool const only_viewable,
+                        bool const clear_visited)
 {
        vector<int> const & reachables =
                G_.getReachable(formats.getNumber(from),