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 typedef std::vector<std::string> FormatList;
84 Converter const & get(int i) const { return converterlist_[i]; }
86 Converter const * getConverter(std::string const & from,
87 std::string const & to) const;
89 int getNumber(std::string const & from, std::string const & to) const;
91 void add(std::string const & from, std::string const & to,
92 std::string const & command, std::string const & flags);
94 void erase(std::string const & from, std::string const & to);
98 std::vector<Format const *> const
99 getReachableTo(std::string const & target, bool clear_visited);
101 std::vector<Format const *> const
102 getReachable(std::string const & from, bool only_viewable,
104 std::vector<std::string> const & excludes = std::vector<std::string>());
106 std::vector<Format const *> importableFormats();
107 std::vector<Format const *> exportableFormats(bool only_viewable);
109 std::vector<std::string> loaders() const;
110 std::vector<std::string> savers() const;
112 /// Does a conversion path from format \p from to format \p to exist?
113 bool isReachable(std::string const & from, std::string const & to);
115 Graph::EdgePath getPath(std::string const & from, std::string const & to);
117 OutputParams::FLAVOR getFlavor(Graph::EdgePath const & path);
118 /// Flags for converting files
119 enum ConversionFlags {
122 /// Use the default converter if no converter is defined
123 try_default = 1 << 0,
124 /// Get the converted file from cache if possible
128 bool convert(Buffer const * buffer,
129 support::FileName const & from_file, support::FileName const & to_file,
130 support::FileName const & orig_from,
131 std::string const & from_format, std::string const & to_format,
132 ErrorList & errorList, int conversionflags = none);
134 void update(Formats const & formats);
136 void updateLast(Formats const & formats);
138 bool formatIsUsed(std::string const & format);
140 const_iterator begin() const { return converterlist_.begin(); }
142 const_iterator end() const { return converterlist_.end(); }
147 std::vector<Format const *> const
148 intToFormat(std::vector<int> const & input);
150 bool scanLog(Buffer const & buffer, std::string const & command,
151 support::FileName const & filename, ErrorList & errorList);
153 bool runLaTeX(Buffer const & buffer, std::string const & command,
154 OutputParams const &, ErrorList & errorList);
156 ConverterList converterlist_;
158 std::string latex_command_;
160 std::string xelatex_command_;
161 /// If \p from = /path/file.ext and \p to = /path2/file2.ext2 then
162 /// this method moves each /path/file*.ext file to /path2/file2*.ext2
163 bool move(std::string const & fmt,
164 support::FileName const & from, support::FileName const & to,
170 /// The global instance.
171 /// Implementation is in LyX.cpp.
172 extern Converters & theConverters();
174 /// The global copy after reading lyxrc.defaults.
175 /// Implementation is in LyX.cpp.
176 extern Converters & theSystemConverters();