]> git.lyx.org Git - lyx.git/blobdiff - src/Converter.cpp
Only create a new view for lyxfiles-open if no view is open (#12894)
[lyx.git] / src / Converter.cpp
index 118d0b66ce3ba3da302be53b4693e125b7e83cc8..b63f77146a6f57e4dee563ef07d0e3066a553071 100644 (file)
@@ -13,9 +13,9 @@
 #include "Converter.h"
 
 #include "Buffer.h"
-#include "buffer_funcs.h"
 #include "BufferParams.h"
 #include "ConverterCache.h"
+#include "TextClass.h"
 #include "Encoding.h"
 #include "ErrorList.h"
 #include "Format.h"
@@ -24,6 +24,7 @@
 #include "LaTeX.h"
 #include "LyXRC.h"
 #include "Mover.h"
+#include "OutputParams.h"
 #include "ParagraphList.h"
 #include "Session.h"
 
@@ -58,9 +59,11 @@ string const token_to("$$o");
 string const token_path("$$p");
 string const token_orig_path("$$r");
 string const token_orig_from("$$f");
+string const token_textclass("$$c");
+string const token_modules("$$m");
 string const token_encoding("$$e");
 string const token_latex_encoding("$$E");
-
+string const token_python("$${python}");
 
 string const add_options(string const & command, string const & options)
 {
@@ -105,7 +108,7 @@ private:
 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),
+         From_(nullptr), To_(nullptr), latex_(false), docbook_(false),
          need_aux_(false), nice_(false), need_auth_(false)
 {}
 
@@ -122,7 +125,7 @@ void Converter::readFlags()
                        latex_flavor_ = flag_value.empty() ?
                                "latex" : flag_value;
                } else if (flag_name == "xml")
-                       xml_ = true;
+                       docbook_ = true;
                else if (flag_name == "needaux") {
                        need_aux_ = true;
                        latex_flavor_ = flag_value.empty() ?
@@ -148,6 +151,12 @@ void Converter::readFlags()
 }
 
 
+void Converter::setCommand(std::string const & command)
+{
+       command_ = subst(command, token_python, os::python());
+}
+
+
 Converter const * Converters::getConverter(string const & from,
                                            string const & to) const
 {
@@ -157,7 +166,7 @@ Converter const * Converters::getConverter(string const & from,
        if (cit != converterlist_.end())
                return &(*cit);
        else
-               return 0;
+               return nullptr;
 }
 
 
@@ -240,11 +249,9 @@ void Converters::erase(string const & from, string const & to)
 // a list (instead of a vector), but this will cause other problems).
 void Converters::update(Formats const & formats)
 {
-       ConverterList::iterator it = converterlist_.begin();
-       ConverterList::iterator end = converterlist_.end();
-       for (; it != end; ++it) {
-               it->setFrom(formats.getFormat(it->from()));
-               it->setTo(formats.getFormat(it->to()));
+       for (auto & cv : converterlist_) {
+               cv.setFrom(formats.getFormat(cv.from()));
+               cv.setTo(formats.getFormat(cv.to()));
        }
 }
 
@@ -261,37 +268,35 @@ void Converters::updateLast(Formats const & formats)
 }
 
 
-OutputParams::FLAVOR Converters::getFlavor(Graph::EdgePath const & path,
-                                          Buffer const * buffer)
+Flavor Converters::getFlavor(Graph::EdgePath const & path,
+                                          Buffer const * buffer) const
 {
-       for (Graph::EdgePath::const_iterator cit = path.begin();
-            cit != path.end(); ++cit) {
-               Converter const & conv = converterlist_[*cit];
+       for (auto const & edge : path) {
+               Converter const & conv = converterlist_[edge];
                if (conv.latex() || conv.need_aux()) {
                        if (conv.latex_flavor() == "latex")
-                               return OutputParams::LATEX;
+                               return Flavor::LaTeX;
                        if (conv.latex_flavor() == "xelatex")
-                               return OutputParams::XETEX;
+                               return Flavor::XeTeX;
                        if (conv.latex_flavor() == "lualatex")
-                               return OutputParams::LUATEX;
+                               return Flavor::LuaTeX;
                        if (conv.latex_flavor() == "dvilualatex")
-                               return OutputParams::DVILUATEX;
+                               return Flavor::DviLuaTeX;
                        if (conv.latex_flavor() == "pdflatex")
-                               return OutputParams::PDFLATEX;
+                               return Flavor::PdfLaTeX;
                }
-               if (conv.xml())
-                       return OutputParams::XML;
+               if (conv.docbook())
+                       return Flavor::DocBook5;
        }
        return buffer ? buffer->params().getOutputFlavor()
-                     : OutputParams::LATEX;
+                     : Flavor::LaTeX;
 }
 
 
-string Converters::getHyperrefDriver(Graph::EdgePath const & path)
+string Converters::getHyperrefDriver(Graph::EdgePath const & path) const
 {
-       for (Graph::EdgePath::const_iterator cit = path.begin();
-            cit != path.end(); ++cit) {
-               Converter const & conv = converterlist_[*cit];
+       for (auto const & edge : path) {
+               Converter const & conv = converterlist_[edge];
                if (!conv.hyperref_driver().empty())
                        return conv.hyperref_driver();
        }
@@ -404,7 +409,7 @@ 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)
+                        ErrorList & errorList, int conversionflags, bool includeall)
 {
        if (from_format == to_format)
                return move(from_format, from_file, to_file, false) ?
@@ -470,25 +475,28 @@ Converters::RetVal Converters::convert(Buffer const * buffer,
                return FAILURE;
        }
 
-       // buffer is only invalid for importing, and then runparams is not
+       // buffer can only be null for importing, and then runparams is not
        // used anyway.
-       OutputParams runparams(buffer ? &buffer->params().encoding() : 0);
+       OutputParams runparams(buffer ? &buffer->params().encoding() : nullptr);
        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.main_fontenc = buffer->params().main_font_encoding();
-               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(true);
+               runparams.index_command = (bp.index_command == "default") ?
+                       string() : bp.index_command;
+               runparams.document_language = bp.language->lang();
+               // Some macros rely on font encoding
+               runparams.main_fontenc = bp.main_font_encoding();
+               runparams.only_childbibs = !bp.useBiblatex()
+                               && !bp.useBibtopic()
+                               && bp.multibib == "child";
+               runparams.includeall = includeall;
        }
 
        // Some converters (e.g. lilypond) can only output files to the
@@ -511,9 +519,8 @@ Converters::RetVal Converters::convert(Buffer const * buffer,
        string to_base = changeExtension(to_file.absFileName(), "");
        FileName infile;
        FileName outfile = from_file;
-       for (Graph::EdgePath::const_iterator cit = edgepath.begin();
-            cit != edgepath.end(); ++cit) {
-               Converter const & conv = converterlist_[*cit];
+       for (auto const & edge : edgepath) {
+               Converter const & conv = converterlist_[edge];
                bool dummy = conv.To()->dummy() && conv.to() != "program";
                if (!dummy) {
                        LYXERR(Debug::FILES, "Converting from  "
@@ -583,7 +590,7 @@ Converters::RetVal Converters::convert(Buffer const * buffer,
 
                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, "");
@@ -596,24 +603,24 @@ Converters::RetVal Converters::convert(Buffer const * buffer,
                        // FIXME KILLED
                        // Check changed return value here.
                        RetVal const retval = runLaTeX(*buffer, command, runparams, errorList);
-                               if (retval != SUCCESS)
-                                       return retval;
+                       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:
+                               case Flavor::DviLuaTeX:
                                        command = dvilualatex_command_;
                                        break;
-                               case OutputParams::LUATEX:
+                               case Flavor::LuaTeX:
                                        command = lualatex_command_;
                                        break;
-                               case OutputParams::PDFLATEX:
+                               case Flavor::PdfLaTeX:
                                        command = pdflatex_command_;
                                        break;
-                               case OutputParams::XETEX:
+                               case Flavor::XeTeX:
                                        command = xelatex_command_;
                                        break;
                                default:
@@ -639,13 +646,25 @@ Converters::RetVal Converters::convert(Buffer const * buffer,
                                to_utf8(makeRelPath(from_utf8(outfile.absFileName()), from_utf8(path)));
 
                        string command = conv.command();
+                       BufferParams const & bparams = buffer ? buffer->params() : defaultBufferParams();
                        command = subst(command, token_from, quoteName(infile2));
                        command = subst(command, token_base, quoteName(from_base));
                        command = subst(command, token_to, quoteName(outfile2));
                        command = subst(command, token_path, quoteName(onlyPath(infile.absFileName())));
                        command = subst(command, token_orig_path, quoteName(onlyPath(orig_from.absFileName())));
                        command = subst(command, token_orig_from, quoteName(onlyFileName(orig_from.absFileName())));
-                       command = subst(command, token_encoding, buffer ? buffer->params().encoding().iconvName() : string());
+                       command = subst(command, token_textclass, quoteName(bparams.documentClass().name()));
+                       string modules = bparams.getModules().asString();
+                       // FIXME: remove when SystemCall uses QProcess with the list API.
+                       // Currently the QProcess parser is not able to encode an
+                       // empty argument as ""; work around this by passing a
+                       // single comma, that will be interpreted as a list of two
+                       // empty module names.
+                       if (modules.empty())
+                               modules = ",";
+                       command = subst(command, token_modules, quoteName(modules));
+                       command = subst(command, token_encoding, quoteName(bparams.encoding().iconvName()));
+                       command = subst(command, token_python, os::python());
 
                        if (!conv.parselog().empty())
                                command += " 2> " + quoteName(infile2 + ".out");
@@ -686,11 +705,11 @@ Converters::RetVal Converters::convert(Buffer const * buffer,
                                if (res == Systemcall::KILLED) {
                                        frontend::Alert::warning(
                                                _("Converter killed"),
-                                               bformat(_("The following converter was killed by the user.\n %1$s\n"), 
+                                               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))
@@ -710,16 +729,16 @@ Converters::RetVal Converters::convert(Buffer const * buffer,
                                                " > " + quoteName(logfile);
                                        res = one.startscript(starttype,
                                                to_filesystem8bit(from_utf8(command2)),
-                                               buffer->filePath(),
-                                               buffer->layoutPos());
+                                               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"), 
+                                                       bformat(_("The following converter was killed by the user.\n %1$s\n"),
                                                                from_utf8(command)));
                                                return KILLED;
                                        }
-                                       if (!scanLog(*buffer, command, makeAbsPath(logfile, path), errorList))
+                                       if (buffer && !scanLog(*buffer, command, makeAbsPath(logfile, path), errorList))
                                                return FAILURE;
                                }
                        }
@@ -730,13 +749,13 @@ Converters::RetVal Converters::convert(Buffer const * buffer,
                                                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."));
@@ -794,9 +813,8 @@ bool Converters::move(string const & fmt,
        string const to_extension = getExtension(to.absFileName());
 
        support::FileNameList const files = FileName(path).dirList(getExtension(from.absFileName()));
-       for (support::FileNameList::const_iterator it = files.begin();
-            it != files.end(); ++it) {
-               string const from2 = it->absFileName();
+       for (auto const & f : files) {
+               string const from2 = f.absFileName();
                string const file2 = onlyFileName(from2);
                if (prefixIs(file2, base)) {
                        string const to2 = changeExtension(
@@ -806,8 +824,8 @@ bool Converters::move(string const & fmt,
 
                        Mover const & mover = getMover(fmt);
                        bool const moved = copy
-                               ? mover.copy(*it, FileName(to2))
-                               : mover.rename(*it, FileName(to2));
+                               ? mover.copy(f, FileName(to2))
+                               : mover.rename(f, FileName(to2));
                        if (!moved && no_errors) {
                                Alert::error(_("Cannot convert file"),
                                        bformat(copy ?
@@ -822,12 +840,10 @@ bool Converters::move(string const & fmt,
 }
 
 
-bool Converters::formatIsUsed(string const & format)
+bool Converters::formatIsUsed(string const & format) const
 {
-       ConverterList::const_iterator cit = converterlist_.begin();
-       ConverterList::const_iterator end = converterlist_.end();
-       for (; cit != end; ++cit) {
-               if (cit->from() == format || cit->to() == format)
+       for (auto const & cvt : converterlist_) {
+               if (cvt.from() == format || cvt.to() == format)
                        return true;
        }
        return false;
@@ -837,8 +853,8 @@ bool Converters::formatIsUsed(string const & format)
 bool Converters::scanLog(Buffer const & buffer, string const & /*command*/,
                         FileName const & filename, ErrorList & errorList)
 {
-       OutputParams runparams(0);
-       runparams.flavor = OutputParams::LATEX;
+       OutputParams runparams(nullptr);
+       runparams.flavor = Flavor::LaTeX;
        LaTeX latex("", runparams, filename);
        TeXErrors terr;
        int const result = latex.scanLogFile(terr);
@@ -858,9 +874,9 @@ Converters::RetVal Converters::runLaTeX(Buffer const & buffer, string const & co
 
        // do the LaTeX run(s)
        string const name = buffer.latexName();
-       LaTeX latex(command, runparams, FileName(makeAbsPath(name)),
+       LaTeX latex(command, runparams, makeAbsPath(name),
                    buffer.filePath(), buffer.layoutPos(),
-                   buffer.isClone(), 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
@@ -870,7 +886,7 @@ Converters::RetVal Converters::runLaTeX(Buffer const & buffer, string const & co
                });
        int const result = latex.run(terr);
 
-       if (result == Systemcall::KILLED) {
+       if (result == Systemcall::KILLED || result == Systemcall::TIMEOUT) {
                Alert::error(_("Export canceled"),
                        _("The export process was terminated by the user."));
                return KILLED;
@@ -879,6 +895,15 @@ Converters::RetVal Converters::runLaTeX(Buffer const & buffer, string const & co
        if (result & LaTeX::ERRORS)
                buffer.bufferErrors(terr, errorList);
 
+       if ((result & LaTeX::UNDEF_CIT) || (result & LaTeX::UNDEF_UNKNOWN_REF)) {
+               buffer.bufferRefs(terr, errorList);
+               if (errorList.empty())
+                       errorList.push_back(ErrorItem(_("Undefined reference"),
+                               _("Undefined references or citations were found during the build.\n"
+                                 "Please check the warnings in the LaTeX log (Document > LaTeX 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
@@ -907,6 +932,8 @@ Converters::RetVal Converters::runLaTeX(Buffer const & buffer, string const & co
        int const ERROR_MASK =
                        LaTeX::NO_LOGFILE |
                        LaTeX::ERRORS |
+                       LaTeX::UNDEF_CIT |
+                       LaTeX::UNDEF_UNKNOWN_REF |
                        LaTeX::NO_OUTPUT;
 
        return (result & ERROR_MASK) == 0 ? SUCCESS : FAILURE;
@@ -921,11 +948,9 @@ void Converters::buildGraph()
        // each of the converters knows how to convert one format to another
        // so, for each of them, we create an arrow on the graph, going from
        // the one to the other
-       ConverterList::iterator it = converterlist_.begin();
-       ConverterList::iterator const end = converterlist_.end();
-       for (; it != end ; ++it) {
-               int const from = theFormats().getNumber(it->from());
-               int const to   = theFormats().getNumber(it->to());
+       for (auto const & cvt : converterlist_) {
+               int const from = theFormats().getNumber(cvt.from());
+               int const to   = theFormats().getNumber(cvt.to());
                LASSERT(from >= 0, continue);
                LASSERT(to >= 0, continue);
                G_.addEdge(from, to);
@@ -963,10 +988,8 @@ FormatList const Converters::getReachable(string const & from,
 {
        set<int> excluded_numbers;
 
-       set<string>::const_iterator sit = excludes.begin();
-       set<string>::const_iterator const end = excludes.end();
-       for (; sit != end; ++sit)
-               excluded_numbers.insert(theFormats().getNumber(*sit));
+       for (auto const & ex : excludes)
+               excluded_numbers.insert(theFormats().getNumber(ex));
 
        vector<int> const & reachables =
                G_.getReachable(theFormats().getNumber(from),