X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FConverter.h;h=0031d023f77b39e6f8b816e4eced9f607fccba7b;hb=dba1e40b520f67faeb49759b7cec9ec4f981f9a1;hp=6e09352acc0d057c3dff73f800ca0ec907849777;hpb=bfd5abac4c24a309cfdd331f6cd6755f9ab529ac;p=lyx.git diff --git a/src/Converter.h b/src/Converter.h index 6e09352acc..0031d023f7 100644 --- a/src/Converter.h +++ b/src/Converter.h @@ -14,8 +14,10 @@ #include "Graph.h" #include "OutputParams.h" +#include "support/trivstring.h" #include +#include #include @@ -27,9 +29,18 @@ class Buffer; class ErrorList; class Format; class Formats; -class OutputParams; + +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 FormatList; + /// class Converter { public: @@ -39,34 +50,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; } /// - std::string to; + Format const * From() const { return From_; } /// - std::string command; + void setFrom(Format const * From) { From_ = From; } /// - std::string flags; + void setTo(Format const * To) { To_ = To; } /// - Format const * From; + Format const * To() const { return To_; } /// - Format const * To; + bool latex() const { return latex_; } + /// + std::string const latex_flavor() const { return latex_flavor_; } + /// + bool xml() const { return xml_; } + /// + 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_; } + /// + bool nice() const { return nice_; } + /// + std::string const result_dir() const { return result_dir_; } + /// + 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: + /// + 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_; + /// 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_; }; @@ -77,9 +136,13 @@ public: typedef std::vector ConverterList; /// typedef ConverterList::const_iterator const_iterator; - /// - typedef std::vector FormatList; - + /// Return values for converter runs + enum RetVal { + SUCCESS = 0, + FAILURE = 1, + KILLED = 1000 + }; + /// Converter const & get(int i) const { return converterlist_[i]; } /// @@ -93,18 +156,16 @@ public: // void erase(std::string const & from, std::string const & to); /// - void sort(); - /// - std::vector const - getReachableTo(std::string const & target, bool clear_visited); + FormatList const + getReachableTo(std::string const & target, bool clear_visited); /// - std::vector const - getReachable(std::string const & from, bool only_viewable, - bool clear_visited, - std::vector const & excludes = std::vector()); + FormatList const + getReachable(std::string const & from, bool only_viewable, + bool clear_visited, + std::set const & excludes = std::set()); - std::vector importableFormats(); - std::vector exportableFormats(bool only_viewable); + FormatList importableFormats(); + FormatList exportableFormats(bool only_viewable); std::vector loaders() const; std::vector savers() const; @@ -114,7 +175,10 @@ public: /// Graph::EdgePath getPath(std::string const & from, std::string const & to); /// - OutputParams::FLAVOR getFlavor(Graph::EdgePath const & path); + 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 @@ -125,7 +189,7 @@ 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, @@ -142,22 +206,44 @@ 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 const + FormatList const intToFormat(std::vector const & input); /// 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_; /// - std::string latex_command_; + trivstring latex_command_; + /// + trivstring dvilualatex_command_; + /// + trivstring lualatex_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,