X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fconverter.C;h=18dddd33dc3869effef6c00e4a194c8a0b7067af;hb=e7f4618bcce770369cf46335c2c7f0164b4b8857;hp=48cad85390c2d2e2f0788524bd309fba9702cd7b;hpb=57a24ea9124812ddc5108ff1ad304ff61acc826a;p=lyx.git diff --git a/src/converter.C b/src/converter.C index 48cad85390..18dddd33dc 100644 --- a/src/converter.C +++ b/src/converter.C @@ -12,44 +12,58 @@ #include "converter.h" +#include "ConverterCache.h" #include "buffer.h" #include "buffer_funcs.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 "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::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::rename; -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; - +using std::string; using std::vector; +using std::distance; + +namespace Alert = lyx::frontend::Alert; namespace { @@ -73,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; @@ -85,13 +99,27 @@ string const dvipdfm_options(BufferParams const & bp) return result; } + +class ConverterEqual : public std::binary_function { +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) {} @@ -104,6 +132,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") @@ -138,26 +168,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 @@ -165,13 +181,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; } @@ -184,7 +200,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] == '*') { @@ -212,9 +228,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); } @@ -256,45 +273,89 @@ 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) + FileName const & from_file, FileName const & to_file, + FileName const & orig_from, + string const & from_format, string const & to_format, + ErrorList & errorList, int conversionflags) { - to_file = ChangeExtension(to_file_base, - formats.extension(to_format)); - if (from_format == to_format) - return move(from_file, to_file, false); + 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 (conversionflags & 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.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.py:\n\t" + << command << endl; + Systemcall one; + one.startscript(Systemcall::Wait, command); + 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" + "Define a converter in the preferences."), + from_ascii(from_format), from_ascii(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); + + // 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]; @@ -303,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 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)) + if (!runLaTeX(*buffer, command, runparams, errorList)) return false; } else { if (conv.need_aux && !run_latex @@ -330,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 infile2 = (conv.original_dir) - ? infile : MakeRelPath(infile, path); - string outfile2 = (conv.original_dir) - ? outfile : MakeRelPath(outfile, path); + string const infile2 = (conv.original_dir) + ? infile.absFilename() : makeRelPath(infile.absFilename(), path); + string const outfile2 = (conv.original_dir) + ? 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, @@ -355,36 +416,45 @@ bool Converters::convert(Buffer const * buffer, dvipdfm_options(buffer->params())); lyxerr[Debug::FILES] << "Calling " << command << endl; - buffer->message(_("Executing command: ") + command); + if (buffer) + buffer->message(_("Executing command: ") + + from_utf8(command)); - Systemcall::Starttype type = (dummy) + Systemcall::Starttype const type = (dummy) ? Systemcall::DontWait : Systemcall::Wait; Systemcall one; 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()) { - if (!rename(outfile, real_outfile)) + Mover const & mover = getMover(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); - 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; } @@ -395,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; } @@ -408,75 +478,74 @@ 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), - 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 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 = 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 - return move(outfile, to_file, conv.latex); + } else { + if (conversionflags & try_cache) + ConverterCache::get().add(orig_from, to_format, outfile); + 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, + 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 files = DirList(OnlyPath(from), GetExtension(from)); - for (vector::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 const files = dirList(FileName(path), + getExtension(from.absFilename())); + for (vector::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; - bool const moved = (copy) - ? lyx::support::copy(from2, to2) - : rename(from2, to2); + + Mover const & mover = getMover(fmt); + bool const moved = copy + ? mover.copy(*it, FileName(to2)) + : mover.rename(*it, FileName(to2)); if (!moved && no_errors) { Alert::error(_("Cannot convert file"), - bformat(_("Could not move a temporary file from %1$s to %2$s."), - from2, to2)); + 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."), + 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) -{ - string to_file; - return convert(buffer, from_file, to_file_base, from_format, to_format, - to_file); -} - - bool Converters::formatIsUsed(string const & format) { ConverterList::const_iterator cit = converterlist_.begin(); @@ -490,26 +559,27 @@ bool Converters::formatIsUsed(string const & format) bool Converters::scanLog(Buffer const & buffer, string const & /*command*/, - string const & filename) + FileName const & filename, ErrorList & errorList) { - LatexRunParams runparams; - runparams.flavor = LatexRunParams::LATEX; - LaTeX latex("", runparams, filename, ""); + 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); + bufferErrors(buffer, terr, errorList); return true; } + namespace { -class showMessage : public boost::signals::trackable { +class showMessage : public std::unary_function, public boost::signals::trackable { public: showMessage(Buffer const & b) : buffer_(b) {}; - void operator()(string const & m) + void operator()(docstring const & m) const { buffer_.message(m); } @@ -521,27 +591,30 @@ private: bool Converters::runLaTeX(Buffer const & buffer, string const & command, - LatexRunParams const & runparams) + OutputParams const & runparams, ErrorList & errorList) { buffer.busy(true); buffer.message(_("Running LaTeX...")); + runparams.document_language = buffer.params().language->babel(); + // do the LaTeX run(s) - string name = buffer.getLatexName(); - LaTeX latex(command, runparams, name, buffer.filePath()); + string const name = buffer.getLatexName(); + LaTeX latex(command, runparams, FileName(makeAbsPath(name))); 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); + bufferErrors(buffer, terr, errorList); // 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); + docstring const str = + bformat(_("LaTeX did not run successfully. " + "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"), @@ -566,7 +639,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); @@ -581,7 +654,7 @@ Converters::intToFormat(std::vector const & input) vector result(input.size()); vector::const_iterator it = input.begin(); - vector::const_iterator end = input.end(); + vector::const_iterator const end = input.end(); vector::iterator rit = result.begin(); for ( ; it != end; ++it, ++rit) { *rit = &formats.get(*it); @@ -589,8 +662,9 @@ Converters::intToFormat(std::vector const & input) return result; } + vector const -Converters::getReachableTo(string const & target, bool clear_visited) +Converters::getReachableTo(string const & target, bool const clear_visited) { vector const & reachablesto = G_.getReachableTo(formats.getNumber(target), clear_visited); @@ -600,8 +674,8 @@ Converters::getReachableTo(string const & target, bool clear_visited) vector 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 const & reachables = G_.getReachable(formats.getNumber(from), @@ -626,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