]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeX.h
Exporter.cpp: revert r34230 because this interferes with Enrico's new LyXVC feature...
[lyx.git] / src / LaTeX.h
index 9af22c954f2c377fa9bc7d68f825efe504132f0b..78c283d85a6fb6c350a9c1dcc3f80cfb872c4db5 100644 (file)
@@ -4,7 +4,7 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  * \author Angus Leeming
  * \author Dekel Tsur
  *
 #ifndef LATEX_H
 #define LATEX_H
 
-#include "outputparams.h"
+#include "OutputParams.h"
 
 #include "support/docstring.h"
-#include "support/filename.h"
+#include "support/FileName.h"
 
-#include <boost/utility.hpp>
+#include <boost/noncopyable.hpp>
 #include <boost/signal.hpp>
 
 #include <vector>
@@ -66,12 +66,12 @@ private:
 };
 
 
-class Aux_Info {
+class AuxInfo {
 public:
        ///
-       Aux_Info() {}
+       AuxInfo() {}
        ///
-       std::string aux_file;
+       support::FileName aux_file;
        ///
        std::set<std::string> citations;
        ///
@@ -82,11 +82,17 @@ public:
 
 
 ///
-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 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)
@@ -140,7 +146,7 @@ public:
           path = name of the files original path.
        */
        LaTeX(std::string const & cmd, OutputParams const &,
-             std::string const & file, std::string const & path);
+             support::FileName const & file);
 
        /// runs LaTeX several times
        int run(TeXErrors &);
@@ -163,41 +169,41 @@ private:
 
        ///
        bool runMakeIndex(std::string const &, OutputParams const &,
-                         std::string const & = std::string());
+                         std::string const & = std::string());
 
        ///
-       std::vector<Aux_Info> const scanAuxFiles(std::string const &);
+       bool runMakeIndexNomencl(support::FileName const &, 
+                                std::string const &, std::string const &);
 
        ///
-       Aux_Info const scanAuxFile(std::string const &);
+       std::vector<AuxInfo> const scanAuxFiles(support::FileName const &);
 
        ///
-       void scanAuxFile(std::string const &, Aux_Info &);
+       AuxInfo const scanAuxFile(support::FileName const &);
 
        ///
-       void updateBibtexDependencies(DepTable &,
-                                     std::vector<Aux_Info> const &);
+       void scanAuxFile(support::FileName const &, AuxInfo &);
 
        ///
-       bool runBibTeX(std::vector<Aux_Info> const &);
+       void updateBibtexDependencies(DepTable &, std::vector<AuxInfo> const &);
 
        ///
-       void deleteFilesOnError() const;
+       bool runBibTeX(std::vector<AuxInfo> const &, OutputParams const &);
 
        ///
-       std::string cmd;
+       void deleteFilesOnError() const;
 
        ///
-       std::string file;
+       std::string cmd;
 
        ///
-       std::string path;
+       support::FileName file;
 
        /// used by scanLogFile
        int num_errors;
 
        /// The name of the final output file.
-       std::string output_file;
+       support::FileName output_file;
 
        ///
        OutputParams runparams;