Correct comment

[lyx.git] / src / Converter.h

diff --git a/src/Converter.h b/src/Converter.h
index da3136a69c69c3abcae42bb4cbbdfdf7ec117592..fe95be6ed8948e099df16fac6990c4037e7df432 100644 (file)
--- a/src/Converter.h
+++ b/src/Converter.h
@@ -30,9 +30,17 @@ class ErrorList;
 class Format;
 class Formats;
 
-typedef std::vector<Format const *> FormatList;
+class ConversionException : public std::exception {
+public:
+       ConversionException() {}
+       virtual ~ConversionException() throw() {}
+       virtual const char * what() const throw() 
+               { return "Exception caught in conversion routine!"; }
+};
 
 
+typedef std::vector<Format const *> FormatList;
+
 ///
 class Converter {
 public:
@@ -66,7 +74,7 @@ public:
        ///
        std::string const latex_flavor() const { return latex_flavor_; }
        ///
-       bool xml() const { return xml_; }
+       bool docbook() const { return docbook_; }
        ///
        bool need_aux() const { return need_aux_; }
        /// Return whether or not the needauth option is set for this converter
@@ -79,6 +87,8 @@ public:
        std::string const result_file() const { return result_file_; }
        ///
        std::string const parselog() const { return parselog_; }
+       ///
+       std::string const hyperref_driver() const { return href_driver_; }
 
 private:
        ///
@@ -98,8 +108,8 @@ private:
        bool latex_;
        /// The latex derivate
        trivstring latex_flavor_;
-       /// The converter is xml
-       bool xml_;
+       /// The converter is DocBook
+       bool docbook_;
        /// This converter needs the .aux files
        bool need_aux_;
        /// we need a "nice" file from the backend, c.f. OutputParams.nice.
@@ -114,6 +124,8 @@ private:
        trivstring result_file_;
        /// Command to convert the program output to a LaTeX log file format
        trivstring parselog_;
+       /// The hyperref driver
+       trivstring href_driver_;
 };
 
 
@@ -124,7 +136,13 @@ public:
        typedef std::vector<Converter> ConverterList;
        ///
        typedef ConverterList::const_iterator const_iterator;
-
+       /// Return values for converter runs
+       enum RetVal {
+               SUCCESS = 0,
+               FAILURE = 1,
+               KILLED  = 1000
+       };
+       
        ///
        Converter const & get(int i) const { return converterlist_[i]; }
        ///
@@ -158,7 +176,9 @@ public:
        Graph::EdgePath getPath(std::string const & from, std::string const & to);
        ///
        OutputParams::FLAVOR getFlavor(Graph::EdgePath const & path,
-                                      Buffer const * buffer = 0);
+                                          Buffer const * buffer = nullptr);
+       ///
+       std::string getHyperrefDriver(Graph::EdgePath const & path);
        /// Flags for converting files
        enum ConversionFlags {
                /// No special flags
@@ -169,11 +189,11 @@ public:
                try_cache = 1 << 1
        };
        ///
-       bool convert(Buffer const * buffer,
+       RetVal convert(Buffer const * buffer,
                     support::FileName const & from_file, support::FileName const & to_file,
                     support::FileName const & orig_from,
                     std::string const & from_format, std::string const & to_format,
-                    ErrorList & errorList, int conversionflags = none);
+                    ErrorList & errorList, int conversionflags = none, bool includeall = false);
        ///
        void update(Formats const & formats);
        ///
@@ -193,8 +213,14 @@ public:
        /// 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
-       bool checkAuth(Converter const & conv, std::string const & doc_fname);
+       /// 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:
        ///
@@ -204,7 +230,7 @@ private:
        bool scanLog(Buffer const & buffer, std::string const & command,
                     support::FileName const & filename, ErrorList & errorList);
        ///
-       bool runLaTeX(Buffer const & buffer, std::string const & command,
+       RetVal runLaTeX(Buffer const & buffer, std::string const & command,
                      OutputParams const &, ErrorList & errorList);
        ///
        ConverterList converterlist_;