]> git.lyx.org Git - lyx.git/blobdiff - src/Converter.h
Provide proper fallback if a bibliography processor is not found
[lyx.git] / src / Converter.h
index 3429ce7154d2322c206bf034b8c238dc1eba685e..e144ca2fa46459764d6492e83b0b9ff1ec029c8e 100644 (file)
@@ -14,6 +14,7 @@
 
 #include "Graph.h"
 #include "OutputParams.h"
+#include "support/trivstring.h"
 
 #include <vector>
 #include <set>
@@ -28,7 +29,8 @@ class Buffer;
 class ErrorList;
 class Format;
 class Formats;
-class OutputParams;
+
+typedef std::vector<Format const *> FormatList;
 
 
 ///
@@ -40,36 +42,82 @@ public:
        ///
        void readFlags();
        ///
-       std::string from;
+       std::string const from() const { return from_; }
+       ///
+       std::string const to() const { return to_; }
+       ///
+       std::string const command() const { return command_; }
+       ///
+       void setCommand(std::string const & command) { command_ = command; }
+       ///
+       std::string const flags() const { return flags_; }
+       ///
+       void setFlags(std::string const & flags) { flags_ = flags; }
+       ///
+       Format const * From() const { return From_; }
+       ///
+       void setFrom(Format const * From) { From_ = From; }
+       ///
+       void setTo(Format const * To) { To_ = To; }
+       ///
+       Format const * To() const { return To_; }
+       ///
+       bool latex() const { return latex_; }
+       ///
+       std::string const latex_flavor() const { return latex_flavor_; }
+       ///
+       bool xml() const { return xml_; }
        ///
-       std::string to;
+       bool need_aux() const { return need_aux_; }
+       /// Return whether or not the needauth option is set for this converter
+       bool need_auth() const { return need_auth_; }
        ///
-       std::string command;
+       bool nice() const { return nice_; }
        ///
-       std::string flags;
+       std::string const result_dir() const { return result_dir_; }
        ///
-       Format const * From;
+       std::string const result_file() const { return result_file_; }
        ///
-       Format const * To;
+       std::string const parselog() const { return parselog_; }
+       ///
+       std::string const hyperref_driver() const { return href_driver_; }
+
+private:
+       ///
+       trivstring from_;
+       ///
+       trivstring to_;
+       ///
+       trivstring command_;
+       ///
+       trivstring flags_;
+       ///
+       Format const * From_;
+       ///
+       Format const * To_;
 
        /// The converter is latex or its derivatives
-       bool latex;
+       bool latex_;
        /// The latex derivate
-       std::string latex_flavor;
+       trivstring latex_flavor_;
        /// The converter is xml
-       bool xml;
+       bool xml_;
        /// This converter needs the .aux files
-       bool need_aux;
+       bool need_aux_;
        /// we need a "nice" file from the backend, c.f. OutputParams.nice.
-       bool nice;
+       bool nice_;
+       /// Use of this converter needs explicit user authorization
+       bool need_auth_;
        /// If the converter put the result in a directory, then result_dir
        /// is the name of the directory
-       std::string result_dir;
+       trivstring result_dir_;
        /// If the converter put the result in a directory, then result_file
        /// is the name of the main file in that directory
-       std::string result_file;
+       trivstring result_file_;
        /// Command to convert the program output to a LaTeX log file format
-       std::string parselog;
+       trivstring parselog_;
+       /// The hyperref driver
+       trivstring href_driver_;
 };
 
 
@@ -94,16 +142,16 @@ public:
        //
        void erase(std::string const & from, std::string const & to);
        ///
-       std::vector<Format const *> const
-       getReachableTo(std::string const & target, bool clear_visited);
+       FormatList const
+               getReachableTo(std::string const & target, bool clear_visited);
        ///
-       std::vector<Format const *> const
-       getReachable(std::string const & from, bool only_viewable,
-              bool clear_visited,
-              std::set<std::string> const & excludes = std::set<std::string>());
+       FormatList const
+               getReachable(std::string const & from, bool only_viewable,
+                   bool clear_visited,
+                   std::set<std::string> const & excludes = std::set<std::string>());
 
-       std::vector<Format const *> importableFormats();
-       std::vector<Format const *> exportableFormats(bool only_viewable);
+       FormatList importableFormats();
+       FormatList exportableFormats(bool only_viewable);
 
        std::vector<std::string> loaders() const;
        std::vector<std::string> savers() const;
@@ -115,6 +163,8 @@ public:
        ///
        OutputParams::FLAVOR getFlavor(Graph::EdgePath const & path,
                                       Buffer const * buffer = 0);
+       ///
+       std::string getHyperrefDriver(Graph::EdgePath const & path);
        /// Flags for converting files
        enum ConversionFlags {
                /// No special flags
@@ -142,9 +192,25 @@ public:
        const_iterator end() const { return converterlist_.end(); }
        ///
        void buildGraph();
+
+       /// Check whether converter conv is authorized to be run for elements
+       /// within document doc_fname.
+       /// The check succeeds for safe converters, whilst for those potentially
+       /// able to execute arbitrary code, tagged with the 'needauth' option,
+       /// authorization is: always denied if lyxrc.use_converter_needauth_forbidden
+       /// is enabled; always allowed if the lyxrc.use_converter_needauth
+       /// is disabled; user is prompted otherwise.
+       /// However, if use_shell_escape is true and a LaTeX backend is
+       /// going to be executed, both lyxrc.use_converter_needauth and
+       /// lyxrc.use_converter_needauth_forbidden are ignored, because in
+       /// this case the backend has to be executed and LyX will add the
+       /// -shell-escape option, so that user consent is always needed.
+       bool checkAuth(Converter const & conv, std::string const & doc_fname,
+                      bool use_shell_escape = false);
+
 private:
        ///
-       std::vector<Format const *> const
+       FormatList const
        intToFormat(std::vector<int> const & input);
        ///
        bool scanLog(Buffer const & buffer, std::string const & command,
@@ -155,15 +221,15 @@ private:
        ///
        ConverterList converterlist_;
        ///
-       std::string latex_command_;
+       trivstring latex_command_;
        ///
-       std::string dvilualatex_command_;
+       trivstring dvilualatex_command_;
        ///
-       std::string lualatex_command_;
+       trivstring lualatex_command_;
        ///
-       std::string pdflatex_command_;
+       trivstring pdflatex_command_;
        ///
-       std::string xelatex_command_;
+       trivstring xelatex_command_;
        /// If \p from = /path/file.ext and \p to = /path2/file2.ext2 then
        /// this method moves each /path/file*.ext file to /path2/file2*.ext2
        bool move(std::string const & fmt,