X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeX.h;h=44920c362a5c7493132be00164caa2912c6bd211;hb=28be7d552f62cc02fa86d7f79201d089bfb2d7b5;hp=7675e039fd4f144668934c1eac5927acb4d47edc;hpb=cd424d78530c9e38502ee7f989ef5c426c97ad61;p=lyx.git diff --git a/src/LaTeX.h b/src/LaTeX.h index 7675e039fd..44920c362a 100644 --- a/src/LaTeX.h +++ b/src/LaTeX.h @@ -4,7 +4,7 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes * \author Angus Leeming * \author Dekel Tsur * @@ -14,34 +14,43 @@ #ifndef LATEX_H #define LATEX_H -#include "outputparams.h" +#include "OutputParams.h" -#include -#include +#include "support/docstring.h" +#include "support/FileName.h" +#include "support/signals.h" #include #include + +namespace lyx { + class DepTable; /// class TeXErrors { private: /// - struct Error { + class Error { + public: /// Error () : error_in_line(0) {} /// - Error(int line, std::string const & desc, std::string const & text) + Error(int line, docstring const & desc, docstring const & text, + std::string const & fname) : error_in_line(line), error_desc(desc), - error_text(text) {} - /// what line in the TeX file the error occured in + error_text(text), + child_name(fname) {} + /// what line in the TeX file the error occurred in int error_in_line; /// The kind of error - std::string error_desc; + docstring error_desc; /// The line/cmd that caused the error. - std::string error_text; + docstring error_text; + /// The name of the child where error occurred, empty otherwise. + std::string child_name; }; public: /// @@ -51,20 +60,23 @@ public: /// Errors::const_iterator end() const { return errors.end(); } /// - void insertError(int line, std::string const & error_desc, - std::string const & error_text); + void insertError(int line, docstring const & error_desc, + docstring const & error_text, + std::string const & child_name = empty_string()); + /// + void clearErrors() { errors.clear(); } private: /// Errors errors; }; -class Aux_Info { +class AuxInfo { public: /// - Aux_Info() {} + AuxInfo() {} /// - std::string aux_file; + support::FileName aux_file; /// std::set citations; /// @@ -75,12 +87,18 @@ public: /// -bool operator==(Aux_Info const &, Aux_Info const &); -bool operator!=(Aux_Info const &, Aux_Info const &); +bool operator==(AuxInfo const &, AuxInfo const &); +bool operator!=(AuxInfo const &, AuxInfo const &); -/// -class LaTeX : boost::noncopyable { +/** + * Class to run the LaTeX compiler and needed auxiliary programs. + * The main .tex file must be in the current directory. The current directory + * must not change as long as an object of this class lives. + * This is required by the LaTeX compiler, and we also make use of it by + * various support::makeAbsPath() calls. + */ +class LaTeX { public: /** Return values from scanLogFile() and run() (to come) @@ -119,21 +137,32 @@ public: /// ERROR_RERUN = 8192, /// - ERRORS = TEX_ERROR + LATEX_ERROR, + BIBTEX_ERROR = 16384, + /// + NONZERO_ERROR = 32768, // the command exited with nonzero status + /// + ERRORS = TEX_ERROR + LATEX_ERROR + NONZERO_ERROR + BIBTEX_ERROR, /// WARNINGS = TEX_WARNING + LATEX_WARNING + PACKAGE_WARNING }; /// This signal emits an informative message - boost::signal1 message; + signals2::signal message; /** cmd = the latex command, file = name of the (temporary) latex file, - path = name of the files original path. + path = name of the files original path, + clean_start = This forces a fresh run by deleting the files in the temp + dir. We set this e.g. if there was an error on previous + preview, which is good if the user installed a package + or changed certain document settings (#9061). */ LaTeX(std::string const & cmd, OutputParams const &, - std::string const & file, std::string const & path); + support::FileName const & file, + std::string const & path = empty_string(), + std::string const & lpath = empty_string(), + bool const clean_start = false); /// runs LaTeX several times int run(TeXErrors &); @@ -145,54 +174,80 @@ public: int scanLogFile(TeXErrors &); private: + /// noncopyable + LaTeX(LaTeX const &); + void operator=(LaTeX const &); + /// use this for running LaTeX once int startscript(); /// The dependency file. - std::string depfile; + support::FileName depfile; /// void deplog(DepTable & head); /// - bool runMakeIndex(std::string const &); + bool runMakeIndex(std::string const &, OutputParams const &, + std::string const & = std::string()); /// - std::vector const scanAuxFiles(std::string const &); + bool runMakeIndexNomencl(support::FileName const &, + std::string const &, std::string const &); /// - Aux_Info const scanAuxFile(std::string const &); + std::vector const scanAuxFiles(support::FileName const &, + bool const only_childbibs = false); /// - void scanAuxFile(std::string const &, Aux_Info &); + AuxInfo const scanAuxFile(support::FileName const &); + + /// + void scanAuxFile(support::FileName const &, AuxInfo &); /// void updateBibtexDependencies(DepTable &, - std::vector const &); + std::vector const &); /// - bool runBibTeX(std::vector const &); + int scanBlgFile(DepTable & head, TeXErrors & terr); /// - void deleteFilesOnError() const; + bool runBibTeX(std::vector const &, + OutputParams const &); /// - std::string cmd; + void removeAuxiliaryFiles() const; /// - std::string file; + std::string cmd; /// + support::FileName file; + + /// The document directory path. std::string path; + /// Extra path, possibly relative to the document directory path. + std::string lpath; + /// used by scanLogFile int num_errors; /// The name of the final output file. - std::string output_file; + support::FileName output_file; /// OutputParams runparams; + + /// Do we use biber? + bool biber; + + /// + std::vector children; }; + +} // namespace lyx + #endif