X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fconverter.C;h=0ffdc49179d8a669ba48d5bc720fd28a9aa92da8;hb=35204f8f33d7400a5fefeffea533fb4cb4097211;hp=7ce839105aa506ca9198d7b5c0ce05ea5d73ff9f;hpb=e5706b107da902bc6a28cba0de3ccd6f75d9fee7;p=lyx.git diff --git a/src/converter.C b/src/converter.C index 7ce839105a..0ffdc49179 100644 --- a/src/converter.C +++ b/src/converter.C @@ -12,6 +12,7 @@ #include "converter.h" +#include "ConverterCache.h" #include "buffer.h" #include "buffer_funcs.h" #include "bufferparams.h" @@ -26,26 +27,33 @@ #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::split; -using lyx::support::subst; -using lyx::support::Systemcall; + +namespace lyx { + +using support::absolutePath; +using support::addName; +using support::bformat; +using support::changeExtension; +using support::compare_ascii_no_case; +using support::contains; +using support::dirList; +using support::getExtension; +using support::isFileReadable; +using support::libFileSearch; +using support::libScriptSearch; +using support::makeRelPath; +using support::onlyFilename; +using support::onlyPath; +using support::Path; +using support::prefixIs; +using support::quoteName; +using support::split; +using support::subst; +using support::Systemcall; using std::endl; using std::find_if; @@ -53,6 +61,8 @@ using std::string; using std::vector; using std::distance; +namespace Alert = lyx::frontend::Alert; + namespace { @@ -75,7 +85,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; @@ -103,10 +113,11 @@ private: } // 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), xml(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) {} @@ -158,7 +169,7 @@ bool operator<(Converter const & a, Converter const & b) Converter const * Converters::getConverter(string const & from, string const & to) const { - ConverterList::const_iterator cit = + ConverterList::const_iterator const cit = find_if(converterlist_.begin(), converterlist_.end(), ConverterEqual(from, to)); if (cit != converterlist_.end()) @@ -170,7 +181,7 @@ Converter const * Converters::getConverter(string const & from, 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(), ConverterEqual(from, to)); if (cit != converterlist_.end()) @@ -215,9 +226,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(), - ConverterEqual(from, to)); + ConverterList::iterator const it = + find_if(converterlist_.begin(), + converterlist_.end(), + ConverterEqual(from, to)); if (it != converterlist_.end()) converterlist_.erase(it); } @@ -275,28 +287,75 @@ 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) + string const & from_file, string const & to_file, + string 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)); + BOOST_ASSERT(absolutePath(from_file)); + BOOST_ASSERT(absolutePath(to_file)); + BOOST_ASSERT(absolutePath(orig_from)); 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 (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) : + formats.extension(from_format); + string const to_ext = formats.extension(to_format); + string const command = + support::os::python() + ' ' + + quoteName(libFileSearch("scripts", "convertDefault.py")) + + ' ' + + quoteName(from_ext + ':' + from_file) + + ' ' + + quoteName(to_ext + ':' + to_file); + 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; } 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); 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 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(); @@ -308,25 +367,25 @@ 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->temppath(), "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)) + if (!runLaTeX(*buffer, command, runparams, errorList)) return false; } else { if (conv.need_aux && !run_latex @@ -334,22 +393,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 : 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, @@ -361,9 +420,9 @@ bool Converters::convert(Buffer const * buffer, lyxerr[Debug::FILES] << "Calling " << command << endl; if (buffer) buffer->message(_("Executing command: ") - + command); + + from_utf8(command)); - Systemcall::Starttype type = (dummy) + Systemcall::Starttype const type = (dummy) ? Systemcall::DontWait : Systemcall::Wait; Systemcall one; int res; @@ -382,16 +441,19 @@ 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); + " < " + quoteName(infile2 + ".out") + + " > " + quoteName(logfile); one.startscript(Systemcall::Wait, command2); - if (!scanLog(*buffer, command, logfile)) + if (!scanLog(*buffer, command, logfile, errorList)) return false; } @@ -402,9 +464,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_ascii(command.substr(0, 50)))); } return false; } @@ -416,30 +478,30 @@ 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 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); 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)); + bformat(_("Could not move a temporary directory from %1$s to %2$s."), + from_ascii(from), from_ascii(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); + } } -// 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 & fmt, string const & from, string const & to, bool copy) { @@ -447,18 +509,18 @@ bool Converters::move(string const & fmt, 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 files = DirList(OnlyPath(from), GetExtension(from)); + 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); + to2 = changeExtension(to2, to_extension); lyxerr[Debug::FILES] << "moving " << from2 << " to " << to2 << endl; @@ -468,8 +530,10 @@ bool Converters::move(string const & fmt, : 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."), - 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_ascii(from2), from_ascii(to2))); no_errors = false; } } @@ -477,16 +541,6 @@ bool Converters::move(string const & fmt, } -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(); @@ -500,26 +554,27 @@ bool Converters::formatIsUsed(string const & format) bool Converters::scanLog(Buffer const & buffer, string const & /*command*/, - string const & filename) + string const & filename, ErrorList & errorList) { 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 std::unary_function, 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) const + void operator()(docstring const & m) const { buffer_.message(m); } @@ -531,7 +586,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...")); @@ -539,21 +594,22 @@ bool Converters::runLaTeX(Buffer const & buffer, string const & command, 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); + 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"), @@ -578,7 +634,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); @@ -593,7 +649,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); @@ -601,8 +657,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); @@ -612,8 +669,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), @@ -644,3 +701,6 @@ Converters converters; // The global copy after reading lyxrc.defaults Converters system_converters; + + +} // namespace lyx