X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeX.h;h=569114d369899f6072ae02b0b5528178a0b6988c;hb=HEAD;hp=9af22c954f2c377fa9bc7d68f825efe504132f0b;hpb=8e6e970d7ba017dba14bdb821f4c4489665d947c;p=lyx.git diff --git a/src/LaTeX.h b/src/LaTeX.h index 9af22c954f..569114d369 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,13 +14,11 @@ #ifndef LATEX_H #define LATEX_H -#include "outputparams.h" +#include "OutputParams.h" -#include "support/docstring.h" -#include "support/filename.h" - -#include -#include +#include "support/strfwd.h" +#include "support/FileName.h" +#include "support/signals.h" #include #include @@ -39,16 +37,20 @@ private: /// Error () : error_in_line(0) {} /// - Error(int line, docstring const & desc, docstring 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 docstring error_desc; /// The line/cmd that caused the error. docstring error_text; + /// The name of the child where error occurred, empty otherwise. + std::string child_name; }; public: /// @@ -58,20 +60,35 @@ public: /// Errors::const_iterator end() const { return errors.end(); } /// + Errors::const_iterator begin_ref() const { return undef_ref.begin(); } + /// + Errors::const_iterator end_ref() const { return undef_ref.end(); } + /// void insertError(int line, docstring const & error_desc, - docstring const & error_text); + docstring const & error_text, + std::string const & child_name = empty_string()); + /// + void clearErrors() { errors.clear(); } + /// + void insertRef(int line, docstring const & error_desc, + docstring const & error_text, + std::string const & child_name = empty_string()); + /// + void clearRefs() { undef_ref.clear(); } private: /// Errors errors; + /// For missing Citation and references + Errors undef_ref; }; -class Aux_Info { +class AuxInfo { public: /// - Aux_Info() {} + AuxInfo() {} /// - std::string aux_file; + support::FileName aux_file; /// std::set citations; /// @@ -82,12 +99,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) @@ -126,32 +149,52 @@ public: /// ERROR_RERUN = 8192, /// - ERRORS = TEX_ERROR + LATEX_ERROR, + BIBTEX_ERROR = 16384, + /// + NONZERO_ERROR = 32768, // the command exited with nonzero status + /// + INDEX_ERROR = 65536, + /// + UNDEF_UNKNOWN_REF = 131072, + /// + ERRORS = TEX_ERROR + LATEX_ERROR + NONZERO_ERROR + BIBTEX_ERROR + INDEX_ERROR, /// WARNINGS = TEX_WARNING + LATEX_WARNING + PACKAGE_WARNING }; /// This signal emits an informative message - boost::signal message; + 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 allow_cancellation = false, + bool const clean_start = false); /// runs LaTeX several times int run(TeXErrors &); /// - int getNumErrors() { return num_errors;} + int getNumErrors() const { return num_errors;} /// int scanLogFile(TeXErrors &); private: + /// noncopyable + LaTeX(LaTeX const &); + void operator=(LaTeX const &); + /// use this for running LaTeX once int startscript(); @@ -161,46 +204,68 @@ private: /// void deplog(DepTable & head); - /// - bool runMakeIndex(std::string const &, OutputParams const &, - std::string const & = std::string()); + /// returns exit code + int runMakeIndex(std::string const &, OutputParams const &, + std::string const & = std::string()); + + /// returns exit code + int runMakeIndexNomencl(support::FileName const &, + std::string const &, std::string const &); /// - std::vector const scanAuxFiles(std::string const &); + std::vector const scanAuxFiles(support::FileName const &, + bool const only_childbibs = false); /// - Aux_Info const scanAuxFile(std::string const &); + AuxInfo const scanAuxFile(support::FileName const &); /// - void scanAuxFile(std::string const &, Aux_Info &); + 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; + int scanIlgFile(TeXErrors & terr); /// - std::string cmd; + bool runBibTeX(std::vector const &, + OutputParams const &, int & exit_code); + + /// + 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; + /// + bool allow_cancel; };