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/docstring.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
156 ERRORS = TEX_ERROR + LATEX_ERROR + NONZERO_ERROR + BIBTEX_ERROR,
158 WARNINGS = TEX_WARNING + LATEX_WARNING + PACKAGE_WARNING
161 /// This signal emits an informative message
162 signals2::signal<void(docstring)> message;
166 cmd = the latex command, file = name of the (temporary) latex file,
167 path = name of the files original path,
168 clean_start = This forces a fresh run by deleting the files in the temp
169 dir. We set this e.g. if there was an error on previous
170 preview, which is good if the user installed a package
171 or changed certain document settings (#9061).
173 LaTeX(std::string const & cmd, OutputParams const &,
174 support::FileName const & file,
175 std::string const & path = empty_string(),
176 std::string const & lpath = empty_string(),
177 bool allow_cancellation = false,
178 bool const clean_start = false);
180 /// runs LaTeX several times
181 int run(TeXErrors &);
184 int getNumErrors() { return num_errors;}
187 int scanLogFile(TeXErrors &);
191 LaTeX(LaTeX const &);
192 void operator=(LaTeX const &);
194 /// use this for running LaTeX once
197 /// The dependency file.
198 support::FileName depfile;
201 void deplog(DepTable & head);
203 /// returns exit code
204 int runMakeIndex(std::string const &, OutputParams const &,
205 std::string const & = std::string());
207 /// returns exit code
208 int runMakeIndexNomencl(support::FileName const &,
209 std::string const &, std::string const &);
212 std::vector<AuxInfo> const scanAuxFiles(support::FileName const &,
213 bool const only_childbibs = false);
216 AuxInfo const scanAuxFile(support::FileName const &);
219 void scanAuxFile(support::FileName const &, AuxInfo &);
222 void updateBibtexDependencies(DepTable &,
223 std::vector<AuxInfo> const &);
226 int scanBlgFile(DepTable & head, TeXErrors & terr);
229 bool runBibTeX(std::vector<AuxInfo> const &,
230 OutputParams const &, int & exit_code);
233 void removeAuxiliaryFiles() const;
239 support::FileName file;
241 /// The document directory path.
244 /// Extra path, possibly relative to the document directory path.
247 /// used by scanLogFile
250 /// The name of the final output file.
251 support::FileName output_file;
254 OutputParams runparams;
259 std::vector <std::string> children;