X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeX.h;h=0b46c607af6496e42492b645121742d2f64f0923;hb=c7d29be153debac82e3d2e8865fcc849f0a5f40d;hp=74e1317074f2df2a5cf603b081fd28d50beceb5a;hpb=db2a04226738a236fddabeb3c5eb57610835ba5f;p=lyx.git diff --git a/src/LaTeX.h b/src/LaTeX.h index 74e1317074..0b46c607af 100644 --- a/src/LaTeX.h +++ b/src/LaTeX.h @@ -1,51 +1,56 @@ // -*- C++ -*- -/* This file is part of - * ====================================================== - * - * LyX, The Document Processor - * Copyright 1995 Matthias Ettrich - * Copyright 1995-2000 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 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/docstring.h" +#include "support/FileName.h" +#include "support/signals.h" -#include "LString.h" -#include "DepTable.h" #include #include -#include -class MiniBuffer; +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: /// @@ -55,39 +60,48 @@ public: /// Errors::const_iterator end() const { return errors.end(); } /// - void insertError(int line, string const & error_desc, - 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() {} /// - string aux_file; + support::FileName aux_file; /// - std::set citations; + std::set citations; /// - std::set databases; + std::set databases; /// - std::set styles; - /// - operator==(Aux_Info const & o) const { - return aux_file == o.aux_file && - citations == o.citations && - databases == o.databases && - styles == o.styles; - } + std::set styles; }; + /// -class LaTeX : public noncopyable { +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: /** 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. */ @@ -123,72 +137,117 @@ 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 + 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, 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 const clean_start = false); - /// - virtual ~LaTeX() {} - /// runs LaTeX several times - int run(TeXErrors &, MiniBuffer *); + int run(TeXErrors &); /// int getNumErrors() { return num_errors;} - /// use this for running LaTeX once - int operator() (); - /// int scanLogFile(TeXErrors &); -protected: +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 &); + bool runMakeIndex(std::string const &, OutputParams const &, + std::string const & = std::string()); /// - std::vector const scanAuxFiles(string const &); + bool runMakeIndexNomencl(support::FileName const &, + std::string const &, std::string const &); /// - Aux_Info const scanAuxFile(string const &); + std::vector const scanAuxFiles(support::FileName const &, + bool const only_childbibs = false); /// - void scanAuxFile(string const &, Aux_Info &); - + AuxInfo const scanAuxFile(support::FileName const &); + /// - void updateBibtexDependencies(DepTable &, vector const &); + void scanAuxFile(support::FileName const &, AuxInfo &); /// - bool runBibTeX(vector const &); + void updateBibtexDependencies(DepTable &, + std::vector const &); /// - void deleteFilesOnError() const; - + int scanBlgFile(DepTable & head, TeXErrors & terr); + /// - string cmd; + bool runBibTeX(std::vector const &, + OutputParams const &); /// - string file; - + void removeAuxiliaryFiles() const; + + /// + 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. + support::FileName output_file; + + /// + OutputParams runparams; + + /// Do we use biber? + bool biber; + + /// + std::vector children; }; + +} // namespace lyx + #endif