// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2001 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-2001
- * 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 <boost/signal.hpp>
-#include "LString.h"
-#include "DepTable.h"
#include <vector>
#include <set>
-#include <boost/utility.hpp>
-class LyXFunc;
+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:
///
///
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());
+ ///
+ void clearErrors() { errors.clear(); }
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;
};
///
-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==(AuxInfo const &, AuxInfo const &);
+bool operator!=(AuxInfo const &, AuxInfo const &);
-///
-inline
-bool operator!=(Aux_Info const & a, Aux_Info const & o)
-{
- return !(a == o);
-}
-
-
-///
-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)
-
+
This enum should be enlarged a bit so that one could
get more feedback from the LaTeX run.
*/
///
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::signal<void(docstring)> message;
+
/**
cmd = the latex command, file = name of the (temporary) latex file,
- path = name of the files original path.
+ 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(string const & cmd, string const & file, string const & path);
+ LaTeX(std::string const & cmd, OutputParams const &,
+ support::FileName const & file,
+ std::string const & path = empty_string(),
+ std::string const & lpath = empty_string(),
+ bool const clean_start = false);
- ///
- virtual ~LaTeX() {}
-
/// runs LaTeX several times
- int run(TeXErrors &, LyXFunc *);
+ int run(TeXErrors &);
///
int getNumErrors() { return num_errors;}
- /// use this for running LaTeX once
- int operator() ();
-
///
int scanLogFile(TeXErrors &);
-protected:
+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());
///
- std::vector<Aux_Info> const scanAuxFiles(string const &);
+ bool runMakeIndexNomencl(support::FileName const &,
+ std::string const &, std::string const &);
///
- Aux_Info const scanAuxFile(string const &);
+ std::vector<AuxInfo> const scanAuxFiles(support::FileName const &);
///
- void scanAuxFile(string const &, Aux_Info &);
-
+ AuxInfo const scanAuxFile(support::FileName const &);
+
+ ///
+ 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);
///
- void deleteFilesOnError() const;
-
+ bool runBibTeX(std::vector<AuxInfo> const &,
+ OutputParams const &);
+
///
- string cmd;
+ void removeAuxiliaryFiles() const;
///
- string file;
-
+ std::string cmd;
+
///
- string path;
+ 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
int num_errors;
+
+ /// The name of the final output file.
+ support::FileName output_file;
+
+ ///
+ OutputParams runparams;
+
+ /// Do we use biber?
+ bool biber;
};
+
+} // namespace lyx
+
#endif
projects / lyx.git / blobdiff