X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeX.h;h=b76ec1fd428c79f05e76541b73f9e6c957233c64;hb=5f0720e9475daa2ce865fc641a4e97d94b4b36a1;hp=c4739b19072639910daf03711253b294a8c7b4ab;hpb=ccce6b9662e3a753d8864b1832d766a8f4ceef02;p=lyx.git diff --git a/src/LaTeX.h b/src/LaTeX.h index c4739b1907..b76ec1fd42 100644 --- a/src/LaTeX.h +++ b/src/LaTeX.h @@ -1,48 +1,56 @@ // -*- C++ -*- -/* This file is part of - * ====================================================== +/** + * \file LaTeX.h + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * - * LyX, The Document Processor - * Copyright 1995 Matthias Ettrich - * Copyright 1995-2001 The Lyx Team + * \author Lars Gullik Bjønnes + * \author Angus Leeming + * \author Dekel Tsur * - * This file is Copyright 1996-2001 - * Lars Gullik Bjønnes - * - * ====================================================== + * Full author contact details are available in file CREDITS. */ #ifndef LATEX_H #define LATEX_H -#include "latexrunparams.h" -#include "LString.h" -#include "DepTable.h" +#include "OutputParams.h" + +#include "support/docstring.h" +#include "support/FileName.h" +#include "support/signals.h" + #include #include -#include -class LyXFunc; +namespace lyx { + +class DepTable; /// class TeXErrors { private: /// - struct Error { + class Error { + public: /// Error () : error_in_line(0) {} /// - Error(int line, string const & desc, 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 - string error_desc; + docstring error_desc; /// The line/cmd that caused the error. - string error_text; + docstring error_text; + /// The name of the child where error occurred, empty otherwise. + std::string child_name; }; public: /// @@ -52,36 +60,57 @@ public: /// Errors::const_iterator end() const { return errors.end(); } /// - void insertError(int line, string const & error_desc, - string const & error_text); + 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, + 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() {} /// - string aux_file; + support::FileName aux_file; /// - std::set citations; + std::set citations; /// - std::set databases; + std::set databases; /// - std::set styles; + std::set styles; }; /// -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) @@ -120,21 +149,40 @@ 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 + 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(string const & cmd, LatexRunParams const &, - string const & file, string const & path); + LaTeX(std::string const & cmd, OutputParams const &, + 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 &, LyXFunc *); + int run(TeXErrors &); /// int getNumErrors() { return num_errors;} @@ -143,54 +191,84 @@ public: int scanLogFile(TeXErrors &); private: + /// noncopyable + LaTeX(LaTeX const &); + void operator=(LaTeX const &); + /// use this for running LaTeX once int startscript(); /// The dependency file. - string depfile; + support::FileName depfile; /// void deplog(DepTable & head); - /// - bool runMakeIndex(string const &); + /// 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(string const &); + std::vector const scanAuxFiles(support::FileName const &, + bool const only_childbibs = false); /// - Aux_Info const scanAuxFile(string const &); + AuxInfo const scanAuxFile(support::FileName const &); /// - void scanAuxFile(string const &, Aux_Info &); + void scanAuxFile(support::FileName const &, AuxInfo &); /// void updateBibtexDependencies(DepTable &, - std::vector const &); + std::vector const &); + + /// + int scanBlgFile(DepTable & head, TeXErrors & terr); /// - bool runBibTeX(std::vector const &); + int scanIlgFile(TeXErrors & terr); /// - void deleteFilesOnError() const; + bool runBibTeX(std::vector const &, + OutputParams const &, int & exit_code); /// - string cmd; + void removeAuxiliaryFiles() const; /// - string file; + std::string cmd; /// - string path; + 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. - string output_file; + support::FileName output_file; + + /// + OutputParams runparams; + /// Do we use biber? + bool biber; /// - LatexRunParams runparams; + std::vector children; + /// + bool allow_cancel; }; + +} // namespace lyx + #endif