]> git.lyx.org Git - lyx.git/blobdiff - src/Converter.cpp
Natbib authoryear uses (Ref1; Ref2) by default.
[lyx.git] / src / Converter.cpp
index b9c31bd00e5ed4ac0f62a2fd7b87b2280939dd76..abce7b8fccc3095515b6c669b91a3e8985dd5e2e 100644 (file)
 
 #include "Converter.h"
 
-#include "ConverterCache.h"
 #include "Buffer.h"
 #include "buffer_funcs.h"
 #include "BufferParams.h"
+#include "ConverterCache.h"
+#include "Encoding.h"
 #include "ErrorList.h"
 #include "Format.h"
 #include "Language.h"
@@ -31,7 +32,7 @@
 #include "support/lstrings.h"
 #include "support/os.h"
 #include "support/Package.h"
-#include "support/Path.h"
+#include "support/PathChanger.h"
 #include "support/Systemcall.h"
 
 using namespace std;
@@ -48,7 +49,10 @@ string const token_from("$$i");
 string const token_base("$$b");
 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_encoding("$$e");
+string const token_latex_encoding("$$E");
 
 
 string const add_options(string const & command, string const & options)
@@ -95,7 +99,7 @@ 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),
-         need_aux(false)
+         need_aux(false), nice(false)
 {}
 
 
@@ -106,9 +110,11 @@ void Converter::readFlags()
                string flag_name, flag_value;
                flag_list = split(flag_list, flag_value, ',');
                flag_value = split(flag_value, flag_name, '=');
-               if (flag_name == "latex")
+               if (flag_name == "latex") {
                        latex = true;
-               else if (flag_name == "xml")
+                       latex_flavor = flag_value.empty() ?
+                               "latex" : flag_value;
+               } else if (flag_name == "xml")
                        xml = true;
                else if (flag_name == "needaux")
                        need_aux = true;
@@ -119,6 +125,8 @@ void Converter::readFlags()
                        result_file = flag_value;
                else if (flag_name == "parselog")
                        parselog = flag_value;
+               else if (flag_name == "nice")
+                       nice = true;
        }
        if (!result_dir.empty() && result_file.empty())
                result_file = "index." + formats.extension(to);
@@ -127,21 +135,6 @@ void Converter::readFlags()
 }
 
 
-bool operator<(Converter const & a, Converter const & b)
-{
-       // use the compare_ascii_no_case instead of compare_no_case,
-       // because in turkish, 'i' is not the lowercase version of 'I',
-       // and thus turkish locale breaks parsing of tags.
-       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;
-       else
-               return i < 0;
-}
-
-
 Converter const * Converters::getConverter(string const & from,
                                            string const & to) const
 {
@@ -184,11 +177,25 @@ void Converters::add(string const & from, string const & to,
        }
        converter.readFlags();
 
-       if (converter.latex && (latex_command_.empty() || to == "dvi"))
-               latex_command_ = subst(command, token_from, "");
-       // If we have both latex & pdflatex, we set latex_command to latex.
        // The latex_command is used to update the .aux file when running
        // a converter that uses it.
+       if (converter.latex) {
+               if (latex_command_.empty() ||
+                   converter.latex_flavor == "latex")
+                       latex_command_ = subst(command, token_from, "");
+               if (dvilualatex_command_.empty() ||
+                   converter.latex_flavor == "dvilualatex")
+                       dvilualatex_command_ = subst(command, token_from, "");
+               if (lualatex_command_.empty() ||
+                   converter.latex_flavor == "lualatex")
+                       lualatex_command_ = subst(command, token_from, "");
+               if (pdflatex_command_.empty() ||
+                   converter.latex_flavor == "pdflatex")
+                       pdflatex_command_ = subst(command, token_from, "");
+               if (xelatex_command_.empty() ||
+                   converter.latex_flavor == "xelatex")
+                       xelatex_command_ = subst(command, token_from, "");
+       }
 
        if (it == converterlist_.end()) {
                converterlist_.push_back(converter);
@@ -241,24 +248,29 @@ void Converters::updateLast(Formats const & formats)
 }
 
 
-void Converters::sort()
-{
-       std::sort(converterlist_.begin(), converterlist_.end());
-}
-
-
-OutputParams::FLAVOR Converters::getFlavor(Graph::EdgePath const & path)
+OutputParams::FLAVOR Converters::getFlavor(Graph::EdgePath const & path,
+                                          Buffer const * buffer)
 {
        for (Graph::EdgePath::const_iterator cit = path.begin();
             cit != path.end(); ++cit) {
                Converter const & conv = converterlist_[*cit];
-               if (conv.latex)
-                       if (contains(conv.to, "pdf"))
+               if (conv.latex) {
+                       if (conv.latex_flavor == "latex")
+                               return OutputParams::LATEX;
+                       if (conv.latex_flavor == "xelatex")
+                               return OutputParams::XETEX;
+                       if (conv.latex_flavor == "lualatex")
+                               return OutputParams::LUATEX;
+                       if (conv.latex_flavor == "dvilualatex")
+                               return OutputParams::DVILUATEX;
+                       if (conv.latex_flavor == "pdflatex")
                                return OutputParams::PDFLATEX;
+               }
                if (conv.xml)
                        return OutputParams::XML;
        }
-       return OutputParams::LATEX;
+       return buffer ? buffer->params().getOutputFlavor()
+                     : OutputParams::LATEX;
 }
 
 
@@ -281,7 +293,7 @@ bool Converters::convert(Buffer const * buffer,
                        // if no special converter defined, then we take the
                        // default one from ImageMagic.
                        string const from_ext = from_format.empty() ?
-                               getExtension(from_file.absFilename()) :
+                               getExtension(from_file.absFileName()) :
                                formats.extension(from_format);
                        string const to_ext = formats.extension(to_format);
                        string const command =
@@ -294,7 +306,8 @@ 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);
+                       one.startscript(Systemcall::Wait, command, buffer ?
+                                       buffer->filePath() : string());
                        if (to_file.isReadableFile()) {
                                if (conversionflags & try_cache)
                                        ConverterCache::get().add(orig_from,
@@ -321,14 +334,25 @@ bool Converters::convert(Buffer const * buffer,
        // buffer is only invalid for importing, and then runparams is not
        // used anyway.
        OutputParams runparams(buffer ? &buffer->params().encoding() : 0);
-       runparams.flavor = getFlavor(edgepath);
+       runparams.flavor = getFlavor(edgepath, buffer);
+
+       if (buffer) {
+               runparams.use_japanese = buffer->params().bufferFormat() == "platex";
+               runparams.use_indices = buffer->params().use_indices;
+               runparams.bibtex_command = (buffer->params().bibtex_command == "default") ?
+                       string() : buffer->params().bibtex_command;
+               runparams.index_command = (buffer->params().index_command == "default") ?
+                       string() : buffer->params().index_command;
+       }
 
        // 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 const path(onlyPath(from_file.absFilename()));
+       // FIXME: This does not work if path is an UNC path on windows
+       //        (bug 6127).
+       string const path(onlyPath(from_file.absFileName()));
        // Prevent the compiler from optimizing away p
        FileName pp(path);
        PathChanger p(pp);
@@ -337,8 +361,8 @@ bool Converters::convert(Buffer const * buffer,
        errorList.clear();
 
        bool run_latex = false;
-       string from_base = changeExtension(from_file.absFilename(), "");
-       string to_base = changeExtension(to_file.absFilename(), "");
+       string from_base = changeExtension(from_file.absFileName(), "");
+       string to_base = changeExtension(to_file.absFileName(), "");
        FileName infile;
        FileName outfile = from_file;
        for (Graph::EdgePath::const_iterator cit = edgepath.begin();
@@ -350,50 +374,82 @@ bool Converters::convert(Buffer const * buffer,
                               << conv.from << " to " << conv.to);
                }
                infile = outfile;
-               outfile = FileName(conv.result_dir.empty()
-                       ? changeExtension(from_file.absFilename(), conv.To->extension())
+               outfile = FileName(conv.result_file.empty()
+                       ? changeExtension(from_file.absFileName(), 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)
                FileName real_outfile;
+               if (!conv.result_file.empty())
+                       real_outfile = FileName(changeExtension(from_file.absFileName(),
+                               conv.To->extension()));
                if (outfile == infile) {
                        real_outfile = infile;
                        // when importing, a buffer does not necessarily exist
                        if (buffer)
                                outfile = FileName(addName(buffer->temppath(), "tmpfile.out"));
                        else
-                               outfile = FileName(addName(package().temp_dir().absFilename(),
+                               outfile = FileName(addName(package().temp_dir().absFileName(),
                                                   "tmpfile.out"));
                }
 
                if (conv.latex) {
                        run_latex = true;
-                       string const command = subst(conv.command, token_from, "");
+                       string command = conv.command;
+                       command = subst(command, token_from, "");
+                       command = subst(command, token_latex_encoding, buffer ?
+                               buffer->params().encoding().latexName() : string());
                        LYXERR(Debug::FILES, "Running " << command);
                        if (!runLaTeX(*buffer, command, runparams, errorList))
                                return false;
                } else {
-                       if (conv.need_aux && !run_latex
-                           && !latex_command_.empty()) {
-                               LYXERR(Debug::FILES, "Running " << latex_command_
-                                       << " to update aux file");
-                               runLaTeX(*buffer, latex_command_, runparams, errorList);
+                       if (conv.need_aux && !run_latex) {
+                               string command;
+                               switch (runparams.flavor) {
+                               case OutputParams::DVILUATEX:
+                                       command = dvilualatex_command_;
+                                       break;
+                               case OutputParams::LUATEX:
+                                       command = lualatex_command_;
+                                       break;
+                               case OutputParams::PDFLATEX:
+                                       command = pdflatex_command_;
+                                       break;
+                               case OutputParams::XETEX:
+                                       command = xelatex_command_;
+                                       break;
+                               default:
+                                       command = latex_command_;
+                                       break;
+                               }
+                               if (!command.empty()) {
+                                       LYXERR(Debug::FILES, "Running "
+                                               << command
+                                               << " to update aux file");
+                                       if (!runLaTeX(*buffer, command,
+                                                     runparams, errorList))
+                                               return false;
+                               }
                        }
 
                        // FIXME UNICODE
-                       string const infile2 = 
-                               to_utf8(makeRelPath(from_utf8(infile.absFilename()), from_utf8(path)));
-                       string const outfile2 = 
-                               to_utf8(makeRelPath(from_utf8(outfile.absFilename()), from_utf8(path)));
+                       string const infile2 =
+                               to_utf8(makeRelPath(from_utf8(infile.absFileName()), from_utf8(path)));
+                       string const outfile2 =
+                               to_utf8(makeRelPath(from_utf8(outfile.absFileName()), from_utf8(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 = 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 = libScriptSearch(command);
 
                        if (!conv.parselog.empty())
@@ -415,12 +471,15 @@ bool Converters::convert(Buffer const * buffer,
                        int res;
                        if (dummy) {
                                res = one.startscript(Systemcall::DontWait,
-                                       to_filesystem8bit(from_utf8(command)));
+                                       to_filesystem8bit(from_utf8(command)),
+                                       buffer ? buffer->filePath() : string());
                                // We're not waiting for the result, so we can't do anything
                                // else here.
                        } else {
                                res = one.startscript(Systemcall::Wait,
-                                               to_filesystem8bit(from_utf8(command)));
+                                               to_filesystem8bit(from_utf8(command)),
+                                               buffer ? buffer->filePath()
+                                                      : string());
                                if (!real_outfile.empty()) {
                                        Mover const & mover = getMover(conv.to);
                                        if (!mover.rename(outfile, real_outfile))
@@ -440,7 +499,8 @@ bool Converters::convert(Buffer const * buffer,
                                                " < " + quoteName(infile2 + ".out") +
                                                " > " + quoteName(logfile);
                                        one.startscript(Systemcall::Wait,
-                                               to_filesystem8bit(from_utf8(command2)));
+                                               to_filesystem8bit(from_utf8(command2)),
+                                               buffer->filePath());
                                        if (!scanLog(*buffer, command, makeAbsPath(logfile, path), errorList))
                                                return false;
                                }
@@ -454,8 +514,8 @@ bool Converters::convert(Buffer const * buffer,
 // 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"),
-                                               from_utf8(command.substr(0, 50))));
+                                               bformat(_("An error occurred while running:\n%1$s"),
+                                               wrapParas(from_utf8(command))));
                                }
                                return false;
                        }
@@ -498,16 +558,16 @@ bool Converters::move(string const & fmt,
                return true;
 
        bool no_errors = true;
-       string const path = onlyPath(from.absFilename());
-       string const base = onlyFilename(removeExtension(from.absFilename()));
-       string const to_base = removeExtension(to.absFilename());
-       string const to_extension = getExtension(to.absFilename());
+       string const path = onlyPath(from.absFileName());
+       string const base = onlyFileName(removeExtension(from.absFileName()));
+       string const to_base = removeExtension(to.absFileName());
+       string const to_extension = getExtension(to.absFileName());
 
-       support::FileNameList const files = FileName(path).dirList(getExtension(from.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();
-               string const file2 = onlyFilename(from2);
+               string const from2 = it->absFileName();
+               string const file2 = onlyFileName(from2);
                if (prefixIs(file2, base)) {
                        string const to2 = changeExtension(
                                to_base + file2.substr(base.length()),
@@ -584,7 +644,8 @@ bool Converters::runLaTeX(Buffer const & buffer, string const & command,
 
        // do the LaTeX run(s)
        string const name = buffer.latexName();
-       LaTeX latex(command, runparams, FileName(makeAbsPath(name)));
+       LaTeX latex(command, runparams, FileName(makeAbsPath(name)),
+                   buffer.filePath());
        TeXErrors terr;
        ShowMessage show(buffer);
        latex.message.connect(show);
@@ -594,13 +655,13 @@ bool Converters::runLaTeX(Buffer const & buffer, string const & command,
                buffer.bufferErrors(terr, errorList);
 
        // check return value from latex.run().
-       if ((result & LaTeX::NO_LOGFILE)) {
+       if ((result & LaTeX::NO_LOGFILE) && !buffer.isClone()) {
                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) {
+       } else if ((result & LaTeX::NO_OUTPUT) && !buffer.isClone()) {
                Alert::warning(_("Output is empty"),
                               _("An empty output file was generated."));
        }
@@ -621,13 +682,17 @@ bool Converters::runLaTeX(Buffer const & buffer, string const & command,
 
 void Converters::buildGraph()
 {
+       // clear graph's data structures
        G_.init(formats.size());
-       ConverterList::iterator beg = converterlist_.begin();
+       // 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 (ConverterList::iterator it = beg; it != end ; ++it) {
-               int const s = formats.getNumber(it->from);
-               int const t = formats.getNumber(it->to);
-               G_.addEdge(s,t);
+       for (; it != end ; ++it) {
+               int const from = formats.getNumber(it->from);
+               int const to   = formats.getNumber(it->to);
+               G_.addEdge(from, to);
        }
 }
 
@@ -659,12 +724,20 @@ Converters::getReachableTo(string const & target, bool const clear_visited)
 
 vector<Format const *> const
 Converters::getReachable(string const & from, bool const only_viewable,
-                        bool const clear_visited)
+                        bool const clear_visited, set<string> const & excludes)
 {
+       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(formats.getNumber(*sit));
+
        vector<int> const & reachables =
                G_.getReachable(formats.getNumber(from),
                                only_viewable,
-                               clear_visited);
+                               clear_visited,
+                               excluded_numbers);
 
        return intToFormat(reachables);
 }
@@ -688,8 +761,9 @@ vector<Format const *> Converters::importableFormats()
 {
        vector<string> l = loaders();
        vector<Format const *> result = getReachableTo(l[0], true);
-       for (vector<string>::const_iterator it = l.begin() + 1;
-            it != l.end(); ++it) {
+       vector<string>::const_iterator it = l.begin() + 1;
+       vector<string>::const_iterator en = l.end();
+       for (; it != en; ++it) {
                vector<Format const *> r = getReachableTo(*it, false);
                result.insert(result.end(), r.begin(), r.end());
        }
@@ -697,6 +771,21 @@ vector<Format const *> Converters::importableFormats()
 }
 
 
+vector<Format const *> Converters::exportableFormats(bool only_viewable)
+{
+       vector<string> s = savers();
+       vector<Format const *> result = getReachable(s[0], only_viewable, true);
+       vector<string>::const_iterator it = s.begin() + 1;
+       vector<string>::const_iterator en = s.end();
+       for (; it != en; ++it) {
+               vector<Format const *> r =
+                       getReachable(*it, only_viewable, false);
+               result.insert(result.end(), r.begin(), r.end());
+       }
+       return result;
+}
+
+
 vector<string> Converters::loaders() const
 {
        vector<string> v;
@@ -707,4 +796,22 @@ vector<string> Converters::loaders() const
 }
 
 
+vector<string> Converters::savers() const
+{
+       vector<string> v;
+       v.push_back("docbook");
+       v.push_back("latex");
+       v.push_back("literate");
+       v.push_back("luatex");
+       v.push_back("dviluatex");
+       v.push_back("lyx");
+       v.push_back("xhtml");
+       v.push_back("pdflatex");
+       v.push_back("platex");
+       v.push_back("text");
+       v.push_back("xetex");
+       return v;
+}
+
+
 } // namespace lyx