X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fconverter.C;h=8d2390c1fe838d4668727fd95bd46551f96e604b;hb=3ef684e752bb5afdbfdea51d4c3df4afe1461916;hp=c93b39f3f6a77ccee80a9c08d04eaf86e0161d71;hpb=3508b308714eec50c77e361bb32431defc78a8d8;p=lyx.git diff --git a/src/converter.C b/src/converter.C index c93b39f3f6..8d2390c1fe 100644 --- a/src/converter.C +++ b/src/converter.C @@ -5,43 +5,62 @@ * * \author Dekel Tsur * - * Full author contact details are available in file CREDITS + * Full author contact details are available in file CREDITS. */ #include #include "converter.h" -#include "graph.h" -#include "format.h" -#include "lyxrc.h" + #include "buffer.h" #include "buffer_funcs.h" -#include "bufferview_funcs.h" -#include "errorlist.h" -#include "LaTeX.h" -#include "lyx_cb.h" // ShowMessage() -#include "gettext.h" -#include "BufferView.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/os.h" #include "support/path.h" -#include "support/tostr.h" #include "support/systemcall.h" -#include -#ifndef CXX_GLOBAL_CSTD -using std::isdigit; -#endif +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::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::vector; using std::endl; using std::find_if; +using std::string; +using std::vector; +using std::distance; + +namespace Alert = lyx::frontend::Alert; + namespace { @@ -59,15 +78,47 @@ string const add_options(string const & command, string const & options) return head + ' ' + options + ' ' + tail; } + +string const dvipdfm_options(BufferParams const & bp) +{ + string result; + + if (bp.papersize != PAPER_CUSTOM) { + string const paper_size = bp.paperSizeName(); + if (paper_size != "b5" && paper_size != "foolscap") + result = "-p "+ paper_size; + + if (bp.orientation == ORIENTATION_LANDSCAPE) + result += " -l"; + } + + 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) {} + void Converter::readFlags() { string flag_list(flags); @@ -77,6 +128,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") @@ -104,34 +157,19 @@ bool operator<(Converter const & a, Converter const & b) int const i = compare_ascii_no_case(a.From->prettyname(), b.From->prettyname()); if (i == 0) - return compare_ascii_no_case(a.To->prettyname(), b.To->prettyname()) - < 0; + return compare_ascii_no_case(a.To->prettyname(), + b.To->prettyname()) < 0; else return i < 0; } - -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 @@ -139,13 +177,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; } @@ -158,7 +196,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] == '*') { @@ -186,9 +224,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); } @@ -230,43 +269,81 @@ 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, ErrorList & errorList, 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 = + 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)) { + 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); 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(); @@ -278,25 +355,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->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)) + if (!runLaTeX(*buffer, command, runparams, errorList)) return false; } else { if (conv.need_aux && !run_latex @@ -304,62 +381,67 @@ 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, - dvips_options(buffer)); + buffer->params().dvips_options()); else if (conv.from == "dvi" && prefixIs(conv.to, "pdf")) command = add_options(command, - dvipdfm_options(buffer)); + dvipdfm_options(buffer->params())); lyxerr[Debug::FILES] << "Calling " << command << endl; if (buffer) - ShowMessage(buffer, _("Executing command:"), command); + 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 && buffer) { + if (conv.original_dir) { Path p(buffer->filePath()); res = one.startscript(type, command); } else res = one.startscript(type, command); if (!real_outfile.empty()) { - if (!lyx::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)) + if (!scanLog(*buffer, command, logfile, errorList)) return false; } @@ -370,9 +452,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; } @@ -383,58 +465,61 @@ 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 (!lyx::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)); + from_ascii(from), from_ascii(to))); return false; } } 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 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; - bool const moved = (copy) - ? lyx::copy(from2, to2) - : lyx::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."), - 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; } } @@ -443,12 +528,13 @@ 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_file, string const & to_file_base, + string const & from_format, string const & to_format, + ErrorList & errorList, bool try_default) { string to_file; return convert(buffer, from_file, to_file_base, from_format, to_format, - to_file); + to_file, errorList, try_default); } @@ -464,62 +550,71 @@ bool Converters::formatIsUsed(string const & format) } -bool Converters::scanLog(Buffer const * buffer, string const & /*command*/, - string const & filename) +bool Converters::scanLog(Buffer const & buffer, string const & /*command*/, + string const & filename, ErrorList & errorList) { - if (!buffer) - return false; - - BufferView * bv = buffer->getUser(); - 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 (bv && (result & LaTeX::ERRORS)) - parseErrors(*buffer, terr); + if (result & LaTeX::ERRORS) + bufferErrors(buffer, terr, errorList); return true; } -bool Converters::runLaTeX(Buffer const * buffer, string const & command, - LatexRunParams const & runparams) -{ - if (!buffer) - return false; - - BufferView * bv = buffer->getUser(); +namespace { - if (bv) { - bv->owner()->busy(true); - bv->owner()->message(_("Running LaTeX...")); - // all the autoinsets have already been removed +class showMessage : public std::unary_function, public boost::signals::trackable { +public: + showMessage(Buffer const & b) : buffer_(b) {}; + void operator()(docstring const & m) const + { + buffer_.message(m); } +private: + Buffer const & buffer_; +}; + +} + + +bool Converters::runLaTeX(Buffer const & buffer, string const & command, + 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, name, buffer.filePath()); TeXErrors terr; - int result = latex.run(terr, - bv ? &bv->owner()->getLyXFunc() : 0); + showMessage show(buffer); + latex.message.connect(show); + int const result = latex.run(terr); - if (bv && (result & LaTeX::ERRORS)) - parseErrors(*buffer, terr); + if (result & LaTeX::ERRORS) + 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"), - _("An empty output file was generated.")); + _("An empty output file was generated.")); } - if (bv) - bv->owner()->busy(false); + + buffer.busy(false); int const ERROR_MASK = LaTeX::NO_LOGFILE | @@ -531,61 +626,12 @@ bool Converters::runLaTeX(Buffer const * buffer, string const & command, } -string const Converters::dvips_options(Buffer const * buffer) -{ - string result; - if (!buffer) - return result; - - if (buffer->params.use_geometry - && buffer->params.papersize2 == BufferParams::VM_PAPER_CUSTOM - && !lyxrc.print_paper_dimension_flag.empty() - && !buffer->params.paperwidth.empty() - && !buffer->params.paperheight.empty()) { - // using a custom papersize - result = lyxrc.print_paper_dimension_flag; - result += ' ' + buffer->params.paperwidth; - result += ',' + buffer->params.paperheight; - } else { - string const paper_option = papersize(buffer); - if (paper_option != "letter" || - buffer->params.orientation != BufferParams::ORIENTATION_LANDSCAPE) { - // dvips won't accept -t letter -t landscape. In all other - // cases, include the paper size explicitly. - result = lyxrc.print_paper_flag; - result += ' ' + paper_option; - } - } - if (buffer->params.orientation == BufferParams::ORIENTATION_LANDSCAPE && - buffer->params.papersize2 != BufferParams::VM_PAPER_CUSTOM) - result += ' ' + lyxrc.print_landscape_flag; - return result; -} - - -string const Converters::dvipdfm_options(Buffer const * buffer) -{ - string result; - if (!buffer) - return result; - - if (buffer->params.papersize2 != BufferParams::VM_PAPER_CUSTOM) { - string const paper_size = papersize(buffer); - if (paper_size != "b5" && paper_size != "foolscap") - result = "-p "+ paper_size; - - if (buffer->params.orientation == BufferParams::ORIENTATION_LANDSCAPE) - result += " -l"; - } - - return result; -} 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,13 +639,14 @@ void Converters::buildGraph() } } -vector const + +std::vector const 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); @@ -607,8 +654,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); @@ -616,9 +664,10 @@ Converters::getReachableTo(string const & target, bool clear_visited) return intToFormat(reachablesto); } + 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), @@ -628,12 +677,14 @@ Converters::getReachable(string const & from, bool only_viewable, return intToFormat(reachables); } + bool Converters::isReachable(string const & from, string const & to) { return G_.isReachable(formats.getNumber(from), formats.getNumber(to)); } + Graph::EdgePath const Converters::getPath(string const & from, string const & to) { @@ -641,8 +692,12 @@ 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