// -*- 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
+#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 <vector>
+#include <set>
-#include "LString.h"
-#include "DepTable.h"
-class LyXLex;
-class MiniBuffer;
+namespace lyx {
+
+class DepTable;
///
class TeXErrors {
-public:
+private:
///
- TeXErrors() {
- errors = NULL;
- next_error = NULL;
- status = 0;
- number_of_errors = 0;
- }
+ class Error {
+ public:
+ ///
+ Error () : error_in_line(0) {}
+ ///
+ Error(int line, docstring const & desc, docstring const & text,
+ std::string const & fname)
+ : error_in_line(line),
+ error_desc(desc),
+ error_text(text),
+ child_name(fname) {}
+ /// what line in the TeX file the error occurred in
+ int error_in_line;
+ /// The kind of error
+ docstring error_desc;
+ /// The line/cmd that caused the error.
+ docstring error_text;
+ /// The name of the child where error occurred, empty otherwise.
+ std::string child_name;
+ };
+public:
///
- ~TeXErrors();
+ typedef std::vector<Error> Errors;
///
- void scanError(LyXLex &);
+ Errors::const_iterator begin() const { return errors.begin(); }
///
- bool getFirstError(int *line, LString *text);
+ Errors::const_iterator end() const { return errors.end(); }
///
- bool getNextError(int *line, LString *text);
+ Errors::const_iterator begin_ref() const { return undef_ref.begin(); }
///
- void insertError(int line, LString const &error_desc,
- LString const &error_text);
+ Errors::const_iterator end_ref() const { return undef_ref.end(); }
///
- void printErrors();
+ void insertError(int line, docstring const & error_desc,
+ docstring const & error_text,
+ std::string const & child_name = empty_string());
///
- void printWarnings();
+ void clearErrors() { errors.clear(); }
///
- void printStatus();
+ void insertRef(int line, docstring const & error_desc,
+ docstring const & error_text,
+ std::string const & child_name = empty_string());
///
- int getStatus() { return status; }
+ void clearRefs() { undef_ref.clear(); }
private:
///
- friend class LaTeX;
+ Errors errors;
+ /// For missing Citation and references
+ Errors undef_ref;
+};
+
+
+class AuxInfo {
+public:
///
- int status;
+ AuxInfo() {}
///
- int number_of_errors;
+ support::FileName aux_file;
///
- struct Error {
- ///
- Error () {
- next_error = NULL;
- error_in_line = 0;
- }
- ///
- Error(int line, LString const &desc, LString const &text) {
- next_error = NULL;
- error_in_line = line;
- error_desc = desc;
- error_text = text;
- }
- ///
- ~Error() {
- }
- ///
- Error *next_error;
- /// what line in the TeX file the error occured in
- int error_in_line;
- /// The kind of error
- LString error_desc;
- /// The line/cmd that caused the error.
- LString error_text;
- };
+ std::set<std::string> citations;
///
- Error *errors;
+ std::set<std::string> databases;
///
- Error *next_error;
+ std::set<std::string> 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,
///
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<void(docstring)> message;
+
/**
- cmd = the latex command, file = name of the (temporary) latex file,
- path = name of the files original path.
- */
- LaTeX(LString const & cmd, LString const & file, LString const & path);
-
+ cmd = the latex command, file = name of the (temporary) latex file,
+ 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(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() { return num_errors;}
+ int getNumErrors() const { return num_errors;}
+
+ ///
+ int scanLogFile(TeXErrors &);
+
+private:
+ /// noncopyable
+ LaTeX(LaTeX const &);
+ void operator=(LaTeX const &);
/// use this for running LaTeX once
- int operator() ();
-protected:
- /** The dependency file.
-
- We store the file dependencies in this file.
- the depency file is on the format:
- <file> <new checksum> <old checksum>
- */
- LString depfile;
+ int startscript();
+
+ /// The dependency file.
+ support::FileName depfile;
- ///
- LaTeX() {}
-
- ///
- LaTeX(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 &);
+
+ ///
+ std::vector<AuxInfo> const scanAuxFiles(support::FileName const &,
+ bool const only_childbibs = false);
+
///
- void deptex(DepTable & head);
-
+ AuxInfo const scanAuxFile(support::FileName const &);
+
///
- int scanLogFile(TeXErrors &);
+ void scanAuxFile(support::FileName const &, AuxInfo &);
///
- bool runMakeIndex(LString const &);
+ void updateBibtexDependencies(DepTable &,
+ std::vector<AuxInfo> const &);
///
- bool runBibTeX(LString const &);
-
+ int scanBlgFile(DepTable & head, TeXErrors & terr);
+
///
- LString cmd;
+ int scanIlgFile(TeXErrors & terr);
///
- LString file;
-
+ bool runBibTeX(std::vector<AuxInfo> const &,
+ OutputParams const &, int & exit_code);
+
///
- LString path;
+ void removeAuxiliaryFiles() const;
+
///
- TEX_FILES tex_files;
-
+ std::string cmd;
+
///
- int file_count;
+ 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
+ /// 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 <std::string> children;
+ ///
+ bool allow_cancel;
};
+
+} // namespace lyx
+
#endif
projects / lyx.git / blobdiff