]> git.lyx.org Git - lyx.git/blobdiff - src/Converter.cpp
More requires --> required, for C++2a.
[lyx.git] / src / Converter.cpp
index 664a4bb7180a32fe615384c8a584d277c48b0a99..a64d7472a7b103d15425b20fea6531b42402794b 100644 (file)
@@ -123,9 +123,11 @@ void Converter::readFlags()
                                "latex" : flag_value;
                } else if (flag_name == "xml")
                        xml_ = true;
-               else if (flag_name == "needaux")
+               else if (flag_name == "needaux") {
                        need_aux_ = true;
-               else if (flag_name == "resultdir")
+                       latex_flavor_ = flag_value.empty() ?
+                               "latex" : flag_value;
+               } else if (flag_name == "resultdir")
                        result_dir_ = (flag_value.empty())
                                ? token_base : flag_value;
                else if (flag_name == "resultfile")
@@ -136,6 +138,8 @@ void Converter::readFlags()
                        nice_ = true;
                else if (flag_name == "needauth")
                        need_auth_ = true;
+               else if (flag_name == "hyperref-driver")
+                       href_driver_ = flag_value;
        }
        if (!result_dir_.empty() && result_file_.empty())
                result_file_ = "index." + theFormats().extension(to_);
@@ -263,7 +267,7 @@ 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()) {
+               if (conv.latex() || conv.need_aux()) {
                        if (conv.latex_flavor() == "latex")
                                return OutputParams::LATEX;
                        if (conv.latex_flavor() == "xelatex")
@@ -283,6 +287,18 @@ OutputParams::FLAVOR Converters::getFlavor(Graph::EdgePath const & path,
 }
 
 
+string Converters::getHyperrefDriver(Graph::EdgePath const & path)
+{
+       for (Graph::EdgePath::const_iterator cit = path.begin();
+            cit != path.end(); ++cit) {
+               Converter const & conv = converterlist_[*cit];
+               if (!conv.hyperref_driver().empty())
+                       return conv.hyperref_driver();
+       }
+       return string();
+}
+
+
 bool Converters::checkAuth(Converter const & conv, string const & doc_fname,
                           bool use_shell_escape)
 {
@@ -384,18 +400,20 @@ bool Converters::checkAuth(Converter const & conv, string const & doc_fname,
 }
 
 
-bool Converters::convert(Buffer const * buffer,
+Converters::RetVal Converters::convert(Buffer const * buffer,
                         FileName const & from_file, FileName const & to_file,
                         FileName const & orig_from,
                         string const & from_format, string const & to_format,
                         ErrorList & errorList, int conversionflags)
 {
        if (from_format == to_format)
-               return move(from_format, from_file, to_file, false);
+               return move(from_format, from_file, to_file, false) ?
+                     SUCCESS : FAILURE;
 
        if ((conversionflags & try_cache) &&
            ConverterCache::get().inCache(orig_from, to_format))
-               return ConverterCache::get().copy(orig_from, to_format, to_file);
+               return ConverterCache::get().copy(orig_from, to_format, to_file) ?
+                     SUCCESS : FAILURE;
 
        Graph::EdgePath edgepath = getPath(from_format, to_format);
        if (edgepath.empty()) {
@@ -416,21 +434,31 @@ bool Converters::convert(Buffer const * buffer,
                        LYXERR(Debug::FILES, "No converter defined! "
                                   "I use convertDefault.py:\n\t" << command);
                        Systemcall one;
-                       one.startscript(Systemcall::Wait, command,
-                                       buffer ? buffer->filePath() : string(),
-                                       buffer ? buffer->layoutPos() : string());
+                       Systemcall::Starttype starttype =
+                               (buffer && buffer->isClone()) ?
+                                       Systemcall::WaitLoop : Systemcall::Wait;
+                       int const exitval = one.startscript(starttype, command,
+                                       buffer ? buffer->filePath() : string(),
+                                       buffer ? buffer->layoutPos() : string());
+                       if (exitval == Systemcall::KILLED) {
+                               frontend::Alert::warning(
+                                       _("Converter killed"),
+                                       bformat(_("The following converter was killed by the user.\n %1$s\n"),
+                                               from_utf8(command)));
+                               return KILLED;
+                       }
                        if (to_file.isReadableFile()) {
                                if (conversionflags & try_cache)
                                        ConverterCache::get().add(orig_from,
                                                        to_format, to_file);
-                               return true;
+                               return SUCCESS;
                        }
                }
 
                // only warn once per session and per file type
                static std::map<string, string> warned;
                if (warned.find(from_format) != warned.end() && warned.find(from_format)->second == to_format) {
-                       return false;
+                       return FAILURE;
                }
                warned.insert(make_pair(from_format, to_format));
 
@@ -439,7 +467,7 @@ bool Converters::convert(Buffer const * buffer,
                                                    "format files to %2$s.\n"
                                                    "Define a converter in the preferences."),
                                                        from_ascii(from_format), from_ascii(to_format)));
-               return false;
+               return FAILURE;
        }
 
        // buffer is only invalid for importing, and then runparams is not
@@ -448,18 +476,22 @@ bool Converters::convert(Buffer const * buffer,
        runparams.flavor = getFlavor(edgepath, buffer);
 
        if (buffer) {
+               BufferParams const & bp = buffer->params();
                runparams.use_japanese =
-                       (buffer->params().bufferFormat() == "latex"
-                        || suffixIs(buffer->params().bufferFormat(), "-ja"))
-                       && buffer->params().encoding().package() == Encoding::japanese;
-               runparams.use_indices = buffer->params().use_indices;
-               runparams.bibtex_command = buffer->params().bibtexCommand();
-               runparams.index_command = (buffer->params().index_command == "default") ?
-                       string() : buffer->params().index_command;
-               runparams.document_language = buffer->params().language->babel();
-               runparams.only_childbibs = !buffer->params().useBiblatex()
-                               && !buffer->params().useBibtopic()
-                               && buffer->params().multibib == "child";
+                       (bp.bufferFormat() == "latex"
+                        || suffixIs(bp.bufferFormat(), "-ja"))
+                       && bp.encoding().package() == Encoding::japanese;
+               runparams.use_indices = bp.use_indices;
+               runparams.bibtex_command = bp.bibtexCommand();
+               runparams.index_command = (bp.index_command == "default") ?
+                       string() : bp.index_command;
+               runparams.document_language = bp.language->babel();
+               runparams.xindy_language = bp.language->xindy();
+               // Some macros rely on font encoding
+               runparams.main_fontenc = bp.main_font_encoding();
+               runparams.only_childbibs = !bp.useBiblatex()
+                               && !bp.useBibtopic()
+                               && bp.multibib == "child";
        }
 
        // Some converters (e.g. lilypond) can only output files to the
@@ -550,11 +582,11 @@ bool Converters::convert(Buffer const * buffer,
 
                if (!checkAuth(conv, buffer ? buffer->absFileName() : string(),
                               buffer && buffer->params().shell_escape))
-                       return false;
+                       return FAILURE;
 
                if (conv.latex()) {
                        // We are not importing, we have a buffer
-                       LATTEST(buffer);
+                       LASSERT(buffer, return FAILURE);
                        run_latex = true;
                        string command = conv.command();
                        command = subst(command, token_from, "");
@@ -564,12 +596,15 @@ bool Converters::convert(Buffer const * buffer,
                            && !contains(command, "-shell-escape"))
                                command += " -shell-escape ";
                        LYXERR(Debug::FILES, "Running " << command);
-                       if (!runLaTeX(*buffer, command, runparams, errorList))
-                               return false;
+                       // FIXME KILLED
+                       // Check changed return value here.
+                       RetVal const retval = runLaTeX(*buffer, command, runparams, errorList);
+                               if (retval != SUCCESS)
+                                       return retval;
                } else {
                        if (conv.need_aux() && !run_latex) {
                                // We are not importing, we have a buffer
-                               LATTEST(buffer);
+                               LASSERT(buffer, return FAILURE);
                                string command;
                                switch (runparams.flavor) {
                                case OutputParams::DVILUATEX:
@@ -592,9 +627,11 @@ bool Converters::convert(Buffer const * buffer,
                                        LYXERR(Debug::FILES, "Running "
                                                << command
                                                << " to update aux file");
-                                       if (!runLaTeX(*buffer, command,
-                                                     runparams, errorList))
-                                               return false;
+                                       // FIXME KILLED
+                                       // Check changed return value here.
+                                       RetVal const retval = runLaTeX(*buffer, command, runparams, errorList);
+                                               if (retval != SUCCESS)
+                                                       return retval;
                                }
                        }
 
@@ -640,12 +677,23 @@ bool Converters::convert(Buffer const * buffer,
                                // We're not waiting for the result, so we can't do anything
                                // else here.
                        } else {
-                               res = one.startscript(Systemcall::Wait,
+                               Systemcall::Starttype starttype =
+                                               (buffer && buffer->isClone()) ?
+                                                       Systemcall::WaitLoop : Systemcall::Wait;
+                               res = one.startscript(starttype,
                                                to_filesystem8bit(from_utf8(command)),
                                                buffer ? buffer->filePath()
                                                       : string(),
                                                buffer ? buffer->layoutPos()
                                                       : string());
+                               if (res == Systemcall::KILLED) {
+                                       frontend::Alert::warning(
+                                               _("Converter killed"),
+                                               bformat(_("The following converter was killed by the user.\n %1$s\n"), 
+                                                       from_utf8(command)));
+                                       return KILLED;
+                               }
+                               
                                if (!real_outfile.empty()) {
                                        Mover const & mover = getMover(conv.to());
                                        if (!mover.rename(outfile, real_outfile))
@@ -663,16 +711,35 @@ bool Converters::convert(Buffer const * buffer,
                                        string const command2 = conv.parselog() +
                                                " < " + quoteName(infile2 + ".out") +
                                                " > " + quoteName(logfile);
-                                       one.startscript(Systemcall::Wait,
+                                       res = one.startscript(starttype,
                                                to_filesystem8bit(from_utf8(command2)),
-                                               buffer->filePath(),
-                                               buffer->layoutPos());
-                                       if (!scanLog(*buffer, command, makeAbsPath(logfile, path), errorList))
-                                               return false;
+                                               buffer ? buffer->filePath() : string(),
+                                               buffer ? buffer->layoutPos() : string());
+                                       if (res == Systemcall::KILLED) {
+                                               frontend::Alert::warning(
+                                                       _("Converter killed"),
+                                                       bformat(_("The following converter was killed by the user.\n %1$s\n"), 
+                                                               from_utf8(command)));
+                                               return KILLED;
+                                       }
+                                       if (buffer && !scanLog(*buffer, command, makeAbsPath(logfile, path), errorList))
+                                               return FAILURE;
                                }
                        }
 
                        if (res) {
+                               if (res == Systemcall::KILLED) {
+                                       Alert::information(_("Process Killed"),
+                                               bformat(_("The conversion process was killed while running:\n%1$s"),
+                                                       wrapParas(from_utf8(command))));
+                                       return KILLED;
+                               } 
+                               if (res == Systemcall::TIMEOUT) {
+                                       Alert::information(_("Process Timed Out"),
+                                               bformat(_("The conversion process:\n%1$s\ntimed out before completing."),
+                                                       wrapParas(from_utf8(command))));
+                                       return KILLED;
+                               } 
                                if (conv.to() == "program") {
                                        Alert::error(_("Build errors"),
                                                _("There were errors during the build process."));
@@ -683,14 +750,14 @@ bool Converters::convert(Buffer const * buffer,
                                                bformat(_("An error occurred while running:\n%1$s"),
                                                wrapParas(from_utf8(command))));
                                }
-                               return false;
+                               return FAILURE;
                        }
                }
        }
 
        Converter const & conv = converterlist_[edgepath.back()];
        if (conv.To()->dummy())
-               return true;
+               return SUCCESS;
 
        if (!conv.result_dir().empty()) {
                // The converter has put the file(s) in a directory.
@@ -705,14 +772,14 @@ bool Converters::convert(Buffer const * buffer,
                                Alert::error(_("Cannot convert file"),
                                        bformat(_("Could not move a temporary directory from %1$s to %2$s."),
                                                from_utf8(from), from_utf8(to)));
-                               return false;
+                               return FAILURE;
                        }
                }
-               return true;
+               return SUCCESS;
        } else {
                if (conversionflags & try_cache)
                        ConverterCache::get().add(orig_from, to_format, outfile);
-               return move(conv.to(), outfile, to_file, conv.latex());
+               return move(conv.to(), outfile, to_file, conv.latex()) ? SUCCESS : FAILURE;
        }
 }
 
@@ -786,7 +853,7 @@ bool Converters::scanLog(Buffer const & buffer, string const & /*command*/,
 }
 
 
-bool Converters::runLaTeX(Buffer const & buffer, string const & command,
+Converters::RetVal Converters::runLaTeX(Buffer const & buffer, string const & command,
                          OutputParams const & runparams, ErrorList & errorList)
 {
        buffer.setBusy(true);
@@ -796,7 +863,7 @@ bool Converters::runLaTeX(Buffer const & buffer, string const & command,
        string const name = buffer.latexName();
        LaTeX latex(command, runparams, FileName(makeAbsPath(name)),
                    buffer.filePath(), buffer.layoutPos(),
-                   buffer.lastPreviewError());
+                   buffer.isClone(), buffer.freshStartRequired());
        TeXErrors terr;
        // The connection closes itself at the end of the scope when latex is
        // destroyed. One cannot close (and destroy) buffer while the converter is
@@ -806,9 +873,23 @@ bool Converters::runLaTeX(Buffer const & buffer, string const & command,
                });
        int const result = latex.run(terr);
 
+       if (result == Systemcall::KILLED) {
+               Alert::error(_("Export canceled"),
+                       _("The export process was terminated by the user."));
+               return KILLED;
+       }
+
        if (result & LaTeX::ERRORS)
                buffer.bufferErrors(terr, errorList);
 
+       if ((result & LaTeX::UNDEF_CIT) || (result & LaTeX::UNDEF_REF)) {
+               buffer.bufferRefs(terr, errorList);
+               if (errorList.empty())
+                       errorList.push_back(ErrorItem(_("Undefined reference"),
+                               _("Undefined reference or citation was found during the build, please check the Log."),
+                               &buffer));
+       }
+
        if (!errorList.empty()) {
          // We will show the LaTeX Errors GUI later which contains
          // specific error messages so it would be repetitive to give
@@ -832,15 +913,16 @@ bool Converters::runLaTeX(Buffer const & buffer, string const & command,
                               _("No output file was generated."));
        }
 
-
        buffer.setBusy(false);
 
        int const ERROR_MASK =
                        LaTeX::NO_LOGFILE |
                        LaTeX::ERRORS |
+                       LaTeX::UNDEF_CIT |
+                       LaTeX::UNDEF_REF |
                        LaTeX::NO_OUTPUT;
 
-       return (result & ERROR_MASK) == 0;
+       return (result & ERROR_MASK) == 0 ? SUCCESS : FAILURE;
 }