src/LaTeX.h

   1 // -*- C++ -*-
   2 /**
   3  * \file LaTeX.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Angus Leeming
   9  * \author Dekel Tsur
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef LATEX_H
  15 #define LATEX_H
  16
  17 #include "OutputParams.h"
  18
  19 #include "support/docstring.h"
  20 #include "support/FileName.h"
  21
  22 #include <boost/signal.hpp>
  23
  24 #include <vector>
  25 #include <set>
  26
  27
  28 namespace lyx {
  29
  30 class DepTable;
  31
  32 ///
  33 class TeXErrors {
  34 private:
  35         ///
  36         class Error {
  37         public:
  38                 ///
  39                 Error () : error_in_line(0) {}
  40                 ///
  41                 Error(int line, docstring const & desc, docstring const & text,
  42                       std::string const & fname)
  43                         : error_in_line(line),
  44                           error_desc(desc),
  45                           error_text(text),
  46                           child_name(fname) {}
  47                 /// what line in the TeX file the error occurred in
  48                 int error_in_line;
  49                 /// The kind of error
  50                 docstring error_desc;
  51                 /// The line/cmd that caused the error.
  52                 docstring error_text;
  53                 /// The name of the child where error occurred, empty otherwise.
  54                 std::string child_name;
  55         };
  56 public:
  57         ///
  58         typedef std::vector<Error> Errors;
  59         ///
  60         Errors::const_iterator begin() const { return errors.begin(); }
  61         ///
  62         Errors::const_iterator end() const { return errors.end(); }
  63         ///
  64         void insertError(int line, docstring const & error_desc,
  65                          docstring const & error_text,
  66                          std::string const & child_name = empty_string());
  67 private:
  68         ///
  69         Errors errors;
  70 };
  71
  72
  73 class AuxInfo {
  74 public:
  75         ///
  76         AuxInfo() {}
  77         ///
  78         support::FileName aux_file;
  79         ///
  80         std::set<std::string> citations;
  81         ///
  82         std::set<std::string> databases;
  83         ///
  84         std::set<std::string> styles;
  85 };
  86
  87
  88 ///
  89 bool operator==(AuxInfo const &, AuxInfo const &);
  90 bool operator!=(AuxInfo const &, AuxInfo const &);
  91
  92
  93 /**
  94  * Class to run the LaTeX compiler and needed auxiliary programs.
  95  * The main .tex file must be in the current directory. The current directory
  96  * must not change as long as an object of this class lives.
  97  * This is required by the LaTeX compiler, and we also make use of it by
  98  * various support::makeAbsPath() calls.
  99  */
 100 class LaTeX {
 101 public:
 102         /** Return values from scanLogFile() and run() (to come)
 103
 104             This enum should be enlarged a bit so that one could
 105             get more feedback from the LaTeX run.
 106         */
 107         enum log_status {
 108                 ///
 109                 NO_ERRORS = 0,
 110                 ///
 111                 NO_LOGFILE = 1,
 112                 ///
 113                 NO_OUTPUT = 2,
 114                 ///
 115                 UNDEF_REF = 4, // Reference '...' on page ... undefined.
 116                 ///
 117                 UNDEF_CIT = 8, // Citation '...' on page ... undefined.
 118                 ///
 119                 RERUN = 16, // Label(s) may have changed. Rerun to get...
 120                 ///
 121                 TEX_ERROR = 32,
 122                 ///
 123                 TEX_WARNING = 64,
 124                 ///
 125                 LATEX_ERROR = 128,
 126                 ///
 127                 LATEX_WARNING = 256,
 128                 ///
 129                 PACKAGE_WARNING = 512,
 130                 ///
 131                 NO_FILE = 1024,
 132                 ///
 133                 NO_CHANGE = 2048,
 134                 ///
 135                 TOO_MANY_ERRORS = 4096,
 136                 ///
 137                 ERROR_RERUN = 8192,
 138                 ///
 139                 BIBTEX_ERROR = 16384,
 140                 ///
 141                 NONZERO_ERROR = 32768, // the command exited with nonzero status
 142                 ///
 143                 ERRORS = TEX_ERROR + LATEX_ERROR + NONZERO_ERROR + BIBTEX_ERROR,
 144                 ///
 145                 WARNINGS = TEX_WARNING + LATEX_WARNING + PACKAGE_WARNING
 146         };
 147
 148         /// This signal emits an informative message
 149         boost::signal<void(docstring)> message;
 150
 151
 152         /**
 153            cmd = the latex command, file = name of the (temporary) latex file,
 154            path = name of the files original path,
 155            clean_start = This forces a fresh run by deleting the files in the temp
 156                          dir. We set this e.g. if there was an error on previous
 157                          preview, which is good if the user installed a package
 158                          or changed certain document settings (#9061).
 159         */
 160         LaTeX(std::string const & cmd, OutputParams const &,
 161               support::FileName const & file,
 162               std::string const & path = empty_string(),
 163               bool const clean_start = false);
 164
 165         /// runs LaTeX several times
 166         int run(TeXErrors &);
 167
 168         ///
 169         int getNumErrors() { return num_errors;}
 170
 171         ///
 172         int scanLogFile(TeXErrors &);
 173
 174 private:
 175         /// noncopyable
 176         LaTeX(LaTeX const &);
 177         void operator=(LaTeX const &);
 178
 179         /// use this for running LaTeX once
 180         int startscript();
 181
 182         /// The dependency file.
 183         support::FileName depfile;
 184
 185         ///
 186         void deplog(DepTable & head);
 187
 188         ///
 189         bool runMakeIndex(std::string const &, OutputParams const &,
 190                           std::string const & = std::string());
 191
 192         ///
 193         bool runMakeIndexNomencl(support::FileName const &,
 194                                  std::string const &, std::string const &);
 195
 196         ///
 197         std::vector<AuxInfo> const scanAuxFiles(support::FileName const &);
 198
 199         ///
 200         AuxInfo const scanAuxFile(support::FileName const &);
 201
 202         ///
 203         void scanAuxFile(support::FileName const &, AuxInfo &);
 204
 205         ///
 206         void updateBibtexDependencies(DepTable &,
 207                                       std::vector<AuxInfo> const &);
 208
 209         ///
 210         int scanBlgFile(DepTable & head, TeXErrors & terr);
 211
 212         ///
 213         bool runBibTeX(std::vector<AuxInfo> const &,
 214                        OutputParams const &);
 215
 216         ///
 217         void removeAuxiliaryFiles() const;
 218
 219         ///
 220         std::string cmd;
 221
 222         ///
 223         support::FileName file;
 224
 225         ///
 226         std::string path;
 227
 228         /// used by scanLogFile
 229         int num_errors;
 230
 231         /// The name of the final output file.
 232         support::FileName output_file;
 233
 234         ///
 235         OutputParams runparams;
 236
 237         /// Do we use biber?
 238         bool biber;
 239 };
 240
 241
 242 } // namespace lyx
 243
 244 #endif