X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeX.h;h=569114d369899f6072ae02b0b5528178a0b6988c;hb=26ba2a65838731ce639a09539f617cb0f0be3b22;hp=209849541867195ba96dc0e281da5e98deaa17d7;hpb=65b49997597efd5a5ba920c739ba6cd8384e1eeb;p=lyx.git diff --git a/src/LaTeX.h b/src/LaTeX.h index 2098495418..569114d369 100644 --- a/src/LaTeX.h +++ b/src/LaTeX.h @@ -1,110 +1,122 @@ // -*- C++ -*- -/* This file is part of - * ====================================================== - * - * LyX, The Document Processor - * Copyright 1995 Matthias Ettrich - * Copyright 1995-1996 The Lyx Team +/** + * \file LaTeX.h + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * - * This file is Copyright (C) 1996-1999 - * Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes + * \author Angus Leeming + * \author Dekel Tsur * - * ====================================================== + * Full author contact details are available in file CREDITS. */ #ifndef LATEX_H #define LATEX_H -#ifdef __GNUG__ -#pragma interface -#endif +#include "OutputParams.h" + +#include "support/strfwd.h" +#include "support/FileName.h" +#include "support/signals.h" -#include "LString.h" -#include "DepTable.h" #include -using std::vector; +#include + + +namespace lyx { -class MiniBuffer; +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: /// - typedef vector Errors; + typedef std::vector Errors; /// Errors::const_iterator begin() const { return errors.begin(); } /// 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 AuxInfo { +public: + /// + AuxInfo() {} + /// + support::FileName aux_file; + /// + std::set citations; + /// + std::set databases; + /// + std::set styles; }; /// +bool operator==(AuxInfo const &, AuxInfo const &); +bool operator!=(AuxInfo const &, AuxInfo const &); + + +/** + * 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: - /** All the different files produced by TeX. - - This is the files mentioned on page 208-9 in Lamports book + - .ltx and .tex files. - */ - enum TEX_FILES { - /// - NO_FILES = 0, - /// used for table of contents et.al. - AUX = 1, - /// written by BibTeX - BBL = 2, - /// LaTeX's output - DVI = 4, - /// glossary (not supported by LyX so far) - GLO = 8, - ///index - IDX = 16, - /// written by makeindex - IND = 32, - /// list of figures - LOF = 64, - /// the LaTeX log file - LOG = 128, - /// list of tables - LOT = 256, - /// table of contents - TOC = 512, - /// latex files - LTX = 1024, - /// tex files - TEX = 2048, - /// list of algorithms - LOA = 4096 - }; - /** Return values from scanLogFile() and run() (to come) - This enum should be enlarged a bit so that one could - get more feedback from the LaTeX run. - */ + This enum should be enlarged a bit so that one could + get more feedback from the LaTeX run. + */ enum log_status { /// NO_ERRORS = 0, @@ -135,66 +147,128 @@ public: /// TOO_MANY_ERRORS = 4096, /// - ERRORS = TEX_ERROR + LATEX_ERROR, + ERROR_RERUN = 8192, + /// + 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 + 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, 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 &, MiniBuffer *); + int run(TeXErrors &); + + /// + int getNumErrors() const { return num_errors;} /// - int getNumErrors() { return num_errors;} + int scanLogFile(TeXErrors &); + +private: + /// noncopyable + LaTeX(LaTeX const &); + void operator=(LaTeX const &); /// use this for running LaTeX once - int operator() (); -protected: + int startscript(); + /// The dependency file. - string depfile; + support::FileName depfile; - /// unavail - LaTeX(LaTeX const &); - /// unavail - LaTeX & operator= (LaTeX const &); - /// void deplog(DepTable & head); + /// 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 &); + /// - void deptex(DepTable & head); - + std::vector const scanAuxFiles(support::FileName const &, + bool const only_childbibs = false); + /// - int scanLogFile(TeXErrors &); + AuxInfo const scanAuxFile(support::FileName const &); + + /// + void scanAuxFile(support::FileName const &, AuxInfo &); /// - bool runMakeIndex(string const &); + void updateBibtexDependencies(DepTable &, + std::vector const &); /// - bool runBibTeX(string const &, DepTable &); - + int scanBlgFile(DepTable & head, TeXErrors & terr); + /// - string cmd; + int scanIlgFile(TeXErrors & terr); /// - string file; - + bool runBibTeX(std::vector const &, + OutputParams const &, int & exit_code); + /// - string path; + void removeAuxiliaryFiles() const; + /// - TEX_FILES tex_files; - + std::string cmd; + /// - int file_count; + support::FileName file; + + /// The document directory path. + std::string path; - // used by scanLogFile + /// 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. + support::FileName output_file; + + /// + OutputParams runparams; + + /// Do we use biber? + bool biber; + /// + std::vector children; + /// + bool allow_cancel; }; + +} // namespace lyx + #endif