*
* \author Dekel Tsur
*
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "converter.h"
-#include "graph.h"
-#include "format.h"
-#include "lyxrc.h"
+
#include "buffer.h"
-#include "bufferview_funcs.h"
-#include "LaTeX.h"
-#include "lyx_cb.h" // ShowMessage()
-#include "gettext.h"
-#include "BufferView.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 "frontends/LyXView.h"
#include "support/filetools.h"
-#include "support/lyxfunctional.h"
+#include "support/lyxlib.h"
#include "support/path.h"
#include "support/systemcall.h"
-#include "BoostFormat.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;
-#include <cctype>
-
-#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 {
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<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)
{}
+
void Converter::readFlags()
{
string flag_list(flags);
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")
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
}
-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;
}
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] == '*') {
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);
}
}
-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"
+ "Try defining a convertor in the preferences."),
+ from_format, to_format));
return false;
}
-
+ OutputParams runparams;
+ runparams.flavor = getFlavor(edgepath);
string path = OnlyPath(from_file);
Path p(path);
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))
+ if (!runLaTeX(*buffer, command, runparams))
return false;
} else {
if (conv.need_aux && !run_latex
lyxerr[Debug::FILES]
<< "Running " << latex_command_
<< " to update aux file"<< endl;
- runLaTeX(buffer, latex_command_);
+ runLaTeX(*buffer, latex_command_, runparams);
}
- string infile2 = (conv.original_dir)
+ string const infile2 = (conv.original_dir)
? infile : MakeRelPath(infile, path);
- string outfile2 = (conv.original_dir)
+ string const outfile2 = (conv.original_dir)
? outfile : MakeRelPath(outfile, path);
string command = conv.command;
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: ")
+ + 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()) {
" < " + QuoteName(infile2 + ".out") +
" > " + QuoteName(logfile);
one.startscript(Systemcall::Wait, command2);
- if (!scanLog(buffer, command, logfile))
+ if (!scanLog(*buffer, command, logfile))
return false;
}
if (res) {
- if (conv.to == "program")
- Alert::alert(_("There were errors during the Build process."),
- _("You should try to fix them."));
- else
- Alert::alert(_("Cannot convert file"),
- _("Error while executing"),
- command.substr(0, 50));
+ if (conv.to == "program") {
+ Alert::error(_("Build errors"),
+ _("There were errors during the build process."));
+ } 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)));
+ }
return false;
}
}
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)));
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)) {
-#if USE_BOOST_FORMAT
- Alert::alert(_("Error while trying to move directory:"),
- from, boost::io::str(boost::format(_("to %1$s")) % to));
-#else
- Alert::alert(_("Error while trying to move directory:"),
- from, _("to ") + to);
-#endif
+ 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));
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;
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) {
-#if USE_BOOST_FORMAT
- Alert::alert(_("Error while trying to move file:"),
- from2, boost::io::str(boost::format(_("to %1$s")) % to2));
-#else
- Alert::alert(_("Error while trying to move file:"),
- from2, _("to ") + to2);
-#endif
+ 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));
no_errors = false;
}
}
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,
+ bool try_default)
{
string to_file;
return convert(buffer, from_file, to_file_base, from_format, to_format,
- to_file);
+ to_file, try_default);
}
}
-bool Converters::scanLog(Buffer const * buffer, string const & command,
- string const & filename)
+bool Converters::scanLog(Buffer const & buffer, string const & /*command*/,
+ string const & filename)
{
- if (!buffer)
- return false;
+ OutputParams runparams;
+ runparams.flavor = OutputParams::LATEX;
+ LaTeX latex("", runparams, filename, "");
+ TeXErrors terr;
+ int const result = latex.scanLogFile(terr);
- BufferView * bv = buffer->getUser();
- if (bv) {
- bv->owner()->busy(true);
- // all error insets should have been removed by now
- }
+ if (result & LaTeX::ERRORS)
+ bufferErrors(buffer, terr);
- LaTeX latex("", filename, "");
- TeXErrors terr;
- int result = latex.scanLogFile(terr);
- if (bv) {
- if ((result & LaTeX::ERRORS)) {
- // Insert all errors as errors boxes
- bv->insertErrors(terr);
-#warning repaint() or update() or nothing ?
- bv->repaint();
- bv->fitCursor();
- }
- bv->owner()->busy(false);
- }
+ return true;
+}
- if ((result & LaTeX::ERRORS)) {
- int num_errors = latex.getNumErrors();
- string s;
- string t;
- if (num_errors == 1) {
- s = _("One error detected");
- t = _("You should try to fix it.");
- } else {
- s = tostr(num_errors);
- s += _(" errors detected.");
- t = _("You should try to fix them.");
- }
- string head;
- split(command, head, ' ');
-#if USE_BOOST_FORMAT
- Alert::alert(boost::io::str(boost::format(_("There were errors during running of %1$s")) % head),
- s, t);
-#else
- Alert::alert(_("There were errors during running of ") + head,
- s, t);
-#endif
- return false;
- } else if (result & LaTeX::NO_OUTPUT) {
- string const s = _("The operation resulted in");
- string const t = _("an empty file.");
- Alert::alert(_("Resulting file is empty"), s, t);
- return false;
+
+namespace {
+
+class showMessage : public std::unary_function<string, void>, public boost::signals::trackable {
+public:
+ showMessage(Buffer const & b) : buffer_(b) {};
+ void operator()(string const & m) const
+ {
+ buffer_.message(m);
}
- return true;
+private:
+ Buffer const & buffer_;
+};
+
}
-bool Converters::runLaTeX(Buffer const * buffer, string const & command)
+bool Converters::runLaTeX(Buffer const & buffer, string const & command,
+ OutputParams const & runparams)
{
- if (!buffer)
- return false;
+ buffer.busy(true);
+ buffer.message(_("Running LaTeX..."));
- BufferView * bv = buffer->getUser();
-
- if (bv) {
- bv->owner()->busy(true);
- bv->owner()->message(_("Running LaTeX..."));
- // all the autoinsets have already been removed
- }
+ runparams.document_language = buffer.params().language->babel();
// do the LaTeX run(s)
- string name = buffer->getLatexName();
- LaTeX latex(command, 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);
-
- if (bv) {
- if ((result & LaTeX::ERRORS)) {
- // Insert all errors as errors boxes
- bv->insertErrors(terr);
-#warning repaint() or update() or nothing ?
- bv->repaint();
- bv->fitCursor();
- }
- }
+ showMessage show(buffer);
+ latex.message.connect(show);
+ int const result = latex.run(terr);
+
+ if (result & LaTeX::ERRORS)
+ bufferErrors(buffer, terr);
// check return value from latex.run().
if ((result & LaTeX::NO_LOGFILE)) {
- Alert::alert(_("LaTeX did not work!"),
- _("Missing log file:"), name);
- } else if ((result & LaTeX::ERRORS)) {
- int num_errors = latex.getNumErrors();
- string s;
- string t;
- if (num_errors == 1) {
- s = _("One error detected");
- t = _("You should try to fix it.");
- } else {
- s = tostr(num_errors);
- s += _(" errors detected.");
- t = _("You should try to fix them.");
- }
- Alert::alert(_("There were errors during the LaTeX run."),
- s, t);
- } else if (result & LaTeX::NO_OUTPUT) {
- string const s = _("The operation resulted in");
- string const t = _("an empty file.");
- Alert::alert(_("Resulting file is empty"), s, t);
+ 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"),
+ _("An empty output file was generated."));
}
- if (bv)
- bv->owner()->busy(false);
+
+ buffer.busy(false);
int const ERROR_MASK =
LaTeX::NO_LOGFILE |
}
-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);
}
}
-vector<Format const *> const
+
+std::vector<Format const *> const
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);
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 =
+ vector<int> const & reachablesto =
G_.getReachableTo(formats.getNumber(target), clear_visited);
return intToFormat(reachablesto);
}
+
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),
- only_viewable,
+ vector<int> const & reachables =
+ G_.getReachable(formats.getNumber(from),
+ only_viewable,
clear_visited);
return intToFormat(reachables);
}
+
bool Converters::isReachable(string const & from, string const & to)
{
return G_.isReachable(formats.getNumber(from),
formats.getNumber(to));
}
-Graph::EdgePath const
+
+Graph::EdgePath const
Converters::getPath(string const & from, string const & to)
{
return G_.getPath(formats.getNumber(from),
formats.getNumber(to));
}
+
/// The global instance
Converters converters;