Natbib authoryear uses (Ref1; Ref2) by default.

[lyx.git] / src / LaTeX.h

diff --git a/src/LaTeX.h b/src/LaTeX.h
index 52c6e4d7495f5d68a9ccc9cc92d2c8a819f7b528..e82af858d6fe23ec30b29c8122fb4a9fd7640e7f 100644 (file)
--- a/src/LaTeX.h
+++ b/src/LaTeX.h
@@ -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
  *
@@ -14,33 +14,45 @@
 #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/noncopyable.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,
+                     std::string const & fname)
                        : error_in_line(line),
                          error_desc(desc),
-                         error_text(text) {}
+                         error_text(text),
+                         child_name(fname) {}
                /// 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;
+               /// The name of the child where error occurred, empty otherwise.
+               std::string child_name;
        };
 public:
        ///
@@ -50,35 +62,42 @@ 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 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)
@@ -124,15 +143,16 @@ public:
        };
 
        /// 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 &);
@@ -148,50 +168,65 @@ private:
        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 &);
+       void scanBlgFile(DepTable & head);
+
+       ///
+       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