]> git.lyx.org Git - lyx.git/blobdiff - src/converter.C
Add a Buffer::fully_loaded member function, returning true only when
[lyx.git] / src / converter.C
index 405020e2ffc79c762155f6bbdb31a9eaba9bf6b7..370843056bf2a18ce44abe252813bc62dd0746c0 100644 (file)
@@ -5,42 +5,52 @@
  *
  * \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 "LaTeX.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"
-
-#include <cctype>
-
-#ifndef CXX_GLOBAL_CSTD
-using std::isdigit;
-#endif
+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;
 
-using std::vector;
 using std::endl;
 using std::find_if;
+using std::string;
+using std::vector;
+
 
 namespace {
 
@@ -58,6 +68,23 @@ 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.papersize2 != VM_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;
+}
+
 } // namespace anon
 
 
@@ -67,6 +94,7 @@ Converter::Converter(string const & f, string const & t, string const & c,
                             original_dir(false), need_aux(false)
 {}
 
+
 void Converter::readFlags()
 {
        string flag_list(flags);
@@ -103,14 +131,13 @@ 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)
@@ -256,6 +283,9 @@ bool Converters::convert(Buffer const * buffer,
        if (edgepath.empty()) {
                return false;
        }
+       LatexRunParams runparams;
+       runparams.flavor = usePdflatex(edgepath) ?
+               LatexRunParams::PDFLATEX : LatexRunParams::LATEX;
 
        string path = OnlyPath(from_file);
        Path p(path);
@@ -285,14 +315,14 @@ bool Converters::convert(Buffer const * buffer,
                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, "");
                        lyxerr[Debug::FILES] << "Running " << command << endl;
-                       if (!runLaTeX(buffer, command))
+                       if (!runLaTeX(*buffer, command, runparams))
                                return false;
                } else {
                        if (conv.need_aux && !run_latex
@@ -300,7 +330,7 @@ bool Converters::convert(Buffer const * buffer,
                                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)
@@ -319,27 +349,26 @@ bool Converters::convert(Buffer const * buffer,
 
                        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::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))
+                               if (!rename(outfile, real_outfile))
                                        res = -1;
                                else
                                        lyxerr[Debug::FILES]
@@ -355,7 +384,7 @@ bool Converters::convert(Buffer const * buffer,
                                        " < " + QuoteName(infile2 + ".out") +
                                        " > " + QuoteName(logfile);
                                one.startscript(Systemcall::Wait, command2);
-                               if (!scanLog(buffer, command, logfile))
+                               if (!scanLog(*buffer, command, logfile))
                                        return false;
                        }
 
@@ -364,9 +393,11 @@ bool Converters::convert(Buffer const * buffer,
                                        Alert::error(_("Build errors"),
                                                _("There were errors during the build process."));
                                } else {
-                                       Alert::alert(_("Cannot convert file"),
-                                                  _("Error while executing"),
-                                                  command.substr(0, 50));
+// 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;
                        }
@@ -387,14 +418,10 @@ bool Converters::convert(Buffer const * buffer,
                                            token_base, from_base);
                        string 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
+                       if (!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;
                        }
                }
@@ -427,16 +454,12 @@ bool Converters::move(string const & from, string const & to, bool copy)
                        lyxerr[Debug::FILES] << "moving " << from2
                                             << " to " << to2 << endl;
                        bool const moved = (copy)
-                               ? lyx::copy(from2, to2)
-                               : lyx::rename(from2, to2);
+                               ? lyx::support::copy(from2, to2)
+                               : 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(_("Could not move a temporary file from %1$s to %2$s."),
+                                               from2, to2));
                                no_errors = false;
                        }
                }
@@ -445,8 +468,8 @@ 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)
 {
        string to_file;
        return convert(buffer, from_file, to_file_base, from_format, to_format,
@@ -466,119 +489,67 @@ bool Converters::formatIsUsed(string const & format)
 }
 
 
-namespace {
-
-void alertErrors(string const & prog, int nr_errors)
+bool Converters::scanLog(Buffer const & buffer, string const & /*command*/,
+                        string const & filename)
 {
-       string s;
-#if USE_BOOST_FORMAT
-       if (nr_errors == 1) {
-               boost::format fmt(_("One error detected when running %1$s.\n"));
-               fmt % prog;
-               s = fmt.str();
-       } else {
-               boost::format fmt(_("%1$s errors detected when running %2$s.\n"));
-               fmt % tostr(nr_errors);
-               fmt % prog;
-               s = fmt.str();
-       }
-#else
-       if (nr_errors == 1) {
-               s = _("One error detected");
-       } else {
-               s = tostr(nr_errors);
-               s += _(" errors detected.");
-       }
-#endif
-       Alert::error(_("Errors found"), s);
-}
-
-}
+       LatexRunParams runparams;
+       runparams.flavor = LatexRunParams::LATEX;
+       LaTeX latex("", runparams, filename, "");
+       TeXErrors terr;
+       int result = latex.scanLogFile(terr);
 
+       if (result & LaTeX::ERRORS)
+               bufferErrors(buffer, terr);
 
-bool Converters::scanLog(Buffer const * buffer, string const & command,
-                       string const & filename)
-{
-       if (!buffer)
-               return false;
+       return true;
+}
 
-       BufferView * bv = buffer->getUser();
-       if (bv) {
-               bv->owner()->busy(true);
-               // all error insets should have been removed by now
-       }
+namespace {
 
-       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);
+class showMessage : public boost::signals::trackable {
+public:
+       showMessage(Buffer const & b) : buffer_(b) {};
+       void operator()(string const & m)
+       {
+               buffer_.message(m);
        }
+private:
+       Buffer const & buffer_;
+};
 
-       if ((result & LaTeX::ERRORS)) {
-               string head;
-               split(command, head, ' ');
-               alertErrors(head, latex.getNumErrors());
-               return false;
-       } else if (result & LaTeX::NO_OUTPUT) {
-               Alert::warning(_("Output is empty"),
-                       _("An empty output file was generated."));
-               return false;
-       }
-       return true;
 }
 
 
-bool Converters::runLaTeX(Buffer const * buffer, string const & command)
+bool Converters::runLaTeX(Buffer const & buffer, string const & command,
+                         LatexRunParams const & runparams)
 {
-       if (!buffer)
-               return false;
-
-       BufferView * bv = buffer->getUser();
-
-       if (bv) {
-               bv->owner()->busy(true);
-               bv->owner()->message(_("Running LaTeX..."));
-               // all the autoinsets have already been removed
-       }
+       buffer.busy(true);
+       buffer.message(_("Running LaTeX..."));
 
        // do the LaTeX run(s)
-       string name = buffer->getLatexName();
-       LaTeX latex(command, name, buffer->filePath());
+       string 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 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)) {
-               alertErrors("LaTeX", latex.getNumErrors());
-       }  else if (result & LaTeX::NO_OUTPUT) {
+               string 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."));
+                              _("An empty output file was generated."));
        }
 
-       if (bv)
-               bv->owner()->busy(false);
+
+       buffer.busy(false);
 
        int const ERROR_MASK =
                        LaTeX::NO_LOGFILE |
@@ -590,55 +561,6 @@ 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()
 {
@@ -652,7 +574,8 @@ void Converters::buildGraph()
        }
 }
 
-vector<Format const *> const
+
+std::vector<Format const *> const
 Converters::intToFormat(std::vector<int> const & input)
 {
        vector<Format const *> result(input.size());
@@ -675,9 +598,10 @@ Converters::getReachableTo(string const & target, bool clear_visited)
        return intToFormat(reachablesto);
 }
 
+
 vector<Format const *> const
 Converters::getReachable(string const & from, bool only_viewable,
-            bool clear_visited)
+                        bool clear_visited)
 {
        vector<int> const & reachables =
                G_.getReachable(formats.getNumber(from),
@@ -687,12 +611,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)
 {
@@ -700,6 +626,7 @@ Converters::getPath(string const & from, string const & to)
                          formats.getNumber(to));
 }
 
+
 /// The global instance
 Converters converters;