// -*- 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/utility.hpp>
+#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)
: 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:
///
///
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;
///
Aux_Info() {}
///
- 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 &);
-///
+/**
+ * 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 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);
/// runs LaTeX several times
int run(TeXErrors &);
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 &, OutputParams const &,
+ std::string const &, std::string const &);
///
- std::vector<Aux_Info> const scanAuxFiles(string const &);
+ std::vector<Aux_Info> const scanAuxFiles(support::FileName const &);
///
- Aux_Info const scanAuxFile(string const &);
+ Aux_Info const scanAuxFile(support::FileName const &);
///
- void scanAuxFile(string const &, Aux_Info &);
+ void scanAuxFile(support::FileName const &, Aux_Info &);
///
void updateBibtexDependencies(DepTable &,
void deleteFilesOnError() const;
///
- string cmd;
+ std::string cmd;
///
- string file;
-
- ///
- string path;
+ support::FileName file;
/// used by scanLogFile
int num_errors;
/// The name of the final output file.
- string output_file;
+ support::FileName output_file;
///
- LatexRunParams runparams;
+ OutputParams runparams;
};
+
+} // namespace lyx
+
#endif