4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
16 #include "OutputParams.h"
24 namespace support { class FileName; }
37 Converter(std::string const & f, std::string const & t, std::string const & c,
38 std::string const & l);
54 /// The converter is latex or its derivatives
56 /// The latex derivate
57 std::string latex_flavor;
58 /// The converter is xml
60 /// This converter needs the .aux files
62 /// If the converter put the result in a directory, then result_dir
63 /// is the name of the directory
64 std::string result_dir;
65 /// If the converter put the result in a directory, then result_file
66 /// is the name of the main file in that directory
67 std::string result_file;
68 /// Command to convert the program output to a LaTeX log file format
77 typedef std::vector<Converter> ConverterList;
79 typedef ConverterList::const_iterator const_iterator;
81 Converter const & get(int i) const { return converterlist_[i]; }
83 Converter const * getConverter(std::string const & from,
84 std::string const & to) const;
86 int getNumber(std::string const & from, std::string const & to) const;
88 void add(std::string const & from, std::string const & to,
89 std::string const & command, std::string const & flags);
91 void erase(std::string const & from, std::string const & to);
95 std::vector<Format const *> const
96 getReachableTo(std::string const & target, bool clear_visited);
98 std::vector<Format const *> const
99 getReachable(std::string const & from, bool only_viewable,
102 std::vector<Format const *> importableFormats();
103 std::vector<Format const *> exportableFormats(bool only_viewable);
105 std::vector<std::string> loaders() const;
106 std::vector<std::string> savers() const;
108 /// Does a conversion path from format \p from to format \p to exist?
109 bool isReachable(std::string const & from, std::string const & to);
111 Graph::EdgePath getPath(std::string const & from, std::string const & to);
113 OutputParams::FLAVOR getFlavor(Graph::EdgePath const & path);
114 /// Flags for converting files
115 enum ConversionFlags {
118 /// Use the default converter if no converter is defined
119 try_default = 1 << 0,
120 /// Get the converted file from cache if possible
124 bool convert(Buffer const * buffer,
125 support::FileName const & from_file, support::FileName const & to_file,
126 support::FileName const & orig_from,
127 std::string const & from_format, std::string const & to_format,
128 ErrorList & errorList, int conversionflags = none);
130 void update(Formats const & formats);
132 void updateLast(Formats const & formats);
134 bool formatIsUsed(std::string const & format);
136 const_iterator begin() const { return converterlist_.begin(); }
138 const_iterator end() const { return converterlist_.end(); }
143 std::vector<Format const *> const
144 intToFormat(std::vector<int> const & input);
146 bool scanLog(Buffer const & buffer, std::string const & command,
147 support::FileName const & filename, ErrorList & errorList);
149 bool runLaTeX(Buffer const & buffer, std::string const & command,
150 OutputParams const &, ErrorList & errorList);
152 ConverterList converterlist_;
154 std::string latex_command_;
155 /// If \p from = /path/file.ext and \p to = /path2/file2.ext2 then
156 /// this method moves each /path/file*.ext file to /path2/file2*.ext2
157 bool move(std::string const & fmt,
158 support::FileName const & from, support::FileName const & to,
164 /// The global instance.
165 /// Implementation is in LyX.cpp.
166 extern Converters & theConverters();
168 /// The global copy after reading lyxrc.defaults.
169 /// Implementation is in LyX.cpp.
170 extern Converters & theSystemConverters();