X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeX.h;h=25e83e8703c32b8e50700f5459cb91f2a860cdbb;hb=ad91dd139c4d6665704b11d9bd34770c3b769543;hp=dfa5937ddb5ccfb6a79c776b7951b4014ead5be4;hpb=16fde21f405aa478a4c63fccf6fa8a37417828f2;p=lyx.git diff --git a/src/LaTeX.h b/src/LaTeX.h index dfa5937ddb..25e83e8703 100644 --- a/src/LaTeX.h +++ b/src/LaTeX.h @@ -1,51 +1,54 @@ // -*- 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 +#include -#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) : error_in_line(line), error_desc(desc), error_text(text) {} /// what line in the TeX file the error occured 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; }; public: /// @@ -55,47 +58,45 @@ 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); private: /// Errors errors; }; + class Aux_Info { public: /// Aux_Info() {} /// - string aux_file; - /// - std::set citations; + support::FileName aux_file; /// - std::set databases; + std::set citations; /// - std::set styles; + std::set databases; /// - friend - bool operator==(Aux_Info const & a, Aux_Info const & o); + std::set styles; }; /// -inline -bool operator==(Aux_Info const & a, Aux_Info const & o) -{ - return a.aux_file == o.aux_file && - a.citations == o.citations && - a.databases == o.databases && - a.styles == o.styles; -} +bool operator==(Aux_Info const &, Aux_Info const &); +bool operator!=(Aux_Info const &, Aux_Info const &); -/// -class LaTeX : public 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 : boost::noncopyable { 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. */ @@ -135,69 +136,81 @@ public: /// WARNINGS = TEX_WARNING + LATEX_WARNING + PACKAGE_WARNING }; - + + /// This signal emits an informative message + boost::signal message; + /** cmd = the latex command, file = name of the (temporary) latex file, path = name of the files original path. */ - LaTeX(string const & cmd, string const & file, string const & path); + LaTeX(std::string const & cmd, OutputParams const &, + support::FileName const & file); - /// - 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: + /// 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 &, OutputParams const &, + std::string const &, std::string const &); /// - Aux_Info const scanAuxFile(string const &); + std::vector const scanAuxFiles(support::FileName const &); /// - void scanAuxFile(string const &, Aux_Info &); - + Aux_Info const scanAuxFile(support::FileName const &); + + /// + void scanAuxFile(support::FileName const &, Aux_Info &); + /// void updateBibtexDependencies(DepTable &, std::vector const &); /// - bool runBibTeX(vector const &); + bool runBibTeX(std::vector const &); /// void deleteFilesOnError() const; - - /// - string cmd; /// - string file; - + std::string cmd; + /// - string path; + support::FileName file; /// used by scanLogFile int num_errors; + + /// The name of the final output file. + support::FileName output_file; + + /// + OutputParams runparams; }; + +} // namespace lyx + #endif