X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeX.h;h=6b71f0f8a72b0240d2b16cc872f74ff150f319df;hb=3bb588f4aaa810fa9cf00a93cf1bd6015cc4d8cf;hp=d3a375ae746a1615e4d1a7d7a7c4fdf1ac8fdae6;hpb=e3fc8227837296d5cbc800b549ffe53c4617a12c;p=lyx.git

diff --git a/src/LaTeX.h b/src/LaTeX.h
index d3a375ae74..6b71f0f8a7 100644
--- a/src/LaTeX.h
+++ b/src/LaTeX.h
@@ -1,47 +1,57 @@
 // -*- C++ -*-
-/* This file is part of
- * ======================================================
+/**
+ * \file LaTeX.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           LyX, The Document Processor
- *	     Copyright 1995 Matthias Ettrich
- *           Copyright 1995-2001 The Lyx Team
+ * \author Lars Gullik Bjønnes
+ * \author Angus Leeming
+ * \author Dekel Tsur
  *
- *           This file is Copyright 1996-2001
- *           Lars Gullik Bjønnes
- *
- * ======================================================
+ * Full author contact details are available in file CREDITS.
  */
 
 #ifndef LATEX_H
 #define LATEX_H
 
-#include "latexrunparams.h"
-#include "LString.h"
-#include "DepTable.h"
+#include "OutputParams.h"
+
+#include "support/docstring.h"
+#include "support/FileName.h"
+
+#include <boost/signal.hpp>
+
 #include <vector>
 #include <set>
 
-#include <boost/utility.hpp>
-#include <boost/signals/signal1.hpp>
+
+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:
 	///
@@ -51,36 +61,43 @@ 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());
 private:
 	///
 	Errors errors;
 };
 
 
-class Aux_Info {
+class AuxInfo {
 public:
 	///
-	Aux_Info() {}
+	AuxInfo() {}
 	///
-	string aux_file;
+	support::FileName aux_file;
 	///
-	std::set<string> citations;
+	std::set<std::string> citations;
 	///
-	std::set<string> databases;
+	std::set<std::string> databases;
 	///
-	std::set<string> styles;
+	std::set<std::string> styles;
 };
 
 
 ///
-bool operator==(Aux_Info const &, Aux_Info const &);
-bool operator!=(Aux_Info const &, Aux_Info const &);
+bool operator==(AuxInfo const &, AuxInfo const &);
+bool operator!=(AuxInfo const &, AuxInfo const &);
 
 
-///
-class LaTeX : boost::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 {
 public:
 	/** Return values from scanLogFile() and run() (to come)
 
@@ -119,21 +136,26 @@ 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
-	boost::signal1<void, string> message;
+	boost::signal<void(docstring)> message;
 
 
 	/**
 	   cmd = the latex command, file = name of the (temporary) latex file,
 	   path = name of the files original path.
 	*/
-	LaTeX(string const & cmd, LatexRunParams const &,
-	      string const & file, string const & path);
+	LaTeX(std::string const & cmd, OutputParams const &,
+	      support::FileName const & file,
+	      std::string const & path = empty_string());
 
 	/// runs LaTeX several times
 	int run(TeXErrors &);
@@ -145,54 +167,73 @@ public:
 	int scanLogFile(TeXErrors &);
 
 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());
+
+	///
+	bool runMakeIndexNomencl(support::FileName const &, 
+				 std::string const &, std::string const &);
 
 	///
-	std::vector<Aux_Info> const scanAuxFiles(string const &);
+	std::vector<AuxInfo> const scanAuxFiles(support::FileName const &);
 
 	///
-	Aux_Info const scanAuxFile(string const &);
+	AuxInfo const scanAuxFile(support::FileName const &);
 
 	///
-	void scanAuxFile(string const &, Aux_Info &);
+	void scanAuxFile(support::FileName const &, AuxInfo &);
 
 	///
 	void updateBibtexDependencies(DepTable &,
-				      std::vector<Aux_Info> const &);
+				      std::vector<AuxInfo> const &);
 
 	///
-	bool runBibTeX(std::vector<Aux_Info> const &);
+	int scanBlgFile(DepTable & head, TeXErrors & terr);
+
+	///
+	bool runBibTeX(std::vector<AuxInfo> const &,
+		       OutputParams const &);
 
 	///
 	void deleteFilesOnError() const;
 
 	///
-	string cmd;
+	std::string cmd;
 
 	///
-	string file;
+	support::FileName file;
 
 	///
-	string path;
+	std::string path;
 
 	/// used by scanLogFile
 	int num_errors;
 
 	/// The name of the final output file.
-	string output_file;
+	support::FileName output_file;
 
 	///
-	LatexRunParams runparams;
+	OutputParams runparams;
+	
+	/// Do we use biber?
+	bool biber;
 };
 
+
+} // namespace lyx
+
 #endif