4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Angus Leeming
11 * Full author contact details are available in file CREDITS.
17 #include "OutputParams.h"
19 #include "support/strfwd.h"
20 #include "support/FileName.h"
21 #include "support/signals.h"
38 Error () : error_in_line(0) {}
40 Error(int line, docstring const & desc, docstring const & text,
41 std::string const & fname)
42 : error_in_line(line),
46 /// what line in the TeX file the error occurred in
50 /// The line/cmd that caused the error.
52 /// The name of the child where error occurred, empty otherwise.
53 std::string child_name;
57 typedef std::vector<Error> Errors;
59 Errors::const_iterator begin() const { return errors.begin(); }
61 Errors::const_iterator end() const { return errors.end(); }
63 Errors::const_iterator begin_ref() const { return undef_ref.begin(); }
65 Errors::const_iterator end_ref() const { return undef_ref.end(); }
67 void insertError(int line, docstring const & error_desc,
68 docstring const & error_text,
69 std::string const & child_name = empty_string());
71 void clearErrors() { errors.clear(); }
73 void insertRef(int line, docstring const & error_desc,
74 docstring const & error_text,
75 std::string const & child_name = empty_string());
77 void clearRefs() { undef_ref.clear(); }
81 /// For missing Citation and references
91 support::FileName aux_file;
93 std::set<std::string> citations;
95 std::set<std::string> databases;
97 std::set<std::string> styles;
102 bool operator==(AuxInfo const &, AuxInfo const &);
103 bool operator!=(AuxInfo const &, AuxInfo const &);
107 * Class to run the LaTeX compiler and needed auxiliary programs.
108 * The main .tex file must be in the current directory. The current directory
109 * must not change as long as an object of this class lives.
110 * This is required by the LaTeX compiler, and we also make use of it by
111 * various support::makeAbsPath() calls.
115 /** Return values from scanLogFile() and run() (to come)
117 This enum should be enlarged a bit so that one could
118 get more feedback from the LaTeX run.
128 UNDEF_REF = 4, // Reference '...' on page ... undefined.
130 UNDEF_CIT = 8, // Citation '...' on page ... undefined.
132 RERUN = 16, // Label(s) may have changed. Rerun to get...
142 PACKAGE_WARNING = 512,
148 TOO_MANY_ERRORS = 4096,
152 BIBTEX_ERROR = 16384,
154 NONZERO_ERROR = 32768, // the command exited with nonzero status
158 UNDEF_UNKNOWN_REF = 131072,
160 ERRORS = TEX_ERROR + LATEX_ERROR + NONZERO_ERROR + BIBTEX_ERROR + INDEX_ERROR,
162 WARNINGS = TEX_WARNING + LATEX_WARNING + PACKAGE_WARNING
165 /// This signal emits an informative message
166 signals2::signal<void(docstring)> message;
170 cmd = the latex command, file = name of the (temporary) latex file,
171 path = name of the files original path,
172 clean_start = This forces a fresh run by deleting the files in the temp
173 dir. We set this e.g. if there was an error on previous
174 preview, which is good if the user installed a package
175 or changed certain document settings (#9061).
177 LaTeX(std::string const & cmd, OutputParams const &,
178 support::FileName const & file,
179 std::string const & path = empty_string(),
180 std::string const & lpath = empty_string(),
181 bool allow_cancellation = false,
182 bool const clean_start = false);
184 /// runs LaTeX several times
185 int run(TeXErrors &);
188 int getNumErrors() { return num_errors;}
191 int scanLogFile(TeXErrors &);
195 LaTeX(LaTeX const &);
196 void operator=(LaTeX const &);
198 /// use this for running LaTeX once
201 /// The dependency file.
202 support::FileName depfile;
205 void deplog(DepTable & head);
207 /// returns exit code
208 int runMakeIndex(std::string const &, OutputParams const &,
209 std::string const & = std::string());
211 /// returns exit code
212 int runMakeIndexNomencl(support::FileName const &,
213 std::string const &, std::string const &);
216 std::vector<AuxInfo> const scanAuxFiles(support::FileName const &,
217 bool const only_childbibs = false);
220 AuxInfo const scanAuxFile(support::FileName const &);
223 void scanAuxFile(support::FileName const &, AuxInfo &);
226 void updateBibtexDependencies(DepTable &,
227 std::vector<AuxInfo> const &);
230 int scanBlgFile(DepTable & head, TeXErrors & terr);
233 int scanIlgFile(TeXErrors & terr);
236 bool runBibTeX(std::vector<AuxInfo> const &,
237 OutputParams const &, int & exit_code);
240 void removeAuxiliaryFiles() const;
246 support::FileName file;
248 /// The document directory path.
251 /// Extra path, possibly relative to the document directory path.
254 /// used by scanLogFile
257 /// The name of the final output file.
258 support::FileName output_file;
261 OutputParams runparams;
266 std::vector <std::string> children;