Fix #10778 (issue with CJK and language nesting)

[lyx.git] / src / LaTeX.h

diff --git a/src/LaTeX.h b/src/LaTeX.h
index 717172ebecfae57276c37f81e065fa73bb5b6d84..4d27e68a1d30ca687b5504343ad7b3907f141b77 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,12 +14,11 @@
 #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/signal.hpp>
 
 #include <vector>
@@ -39,16 +38,20 @@ private:
                ///
                Error () : error_in_line(0) {}
                ///
-               Error(int line, docstring const & desc, docstring 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
                docstring error_desc;
                /// The line/cmd that caused the error.
                docstring error_text;
+               /// The name of the child where error occurred, empty otherwise.
+               std::string child_name;
        };
 public:
        ///
@@ -59,19 +62,22 @@ public:
        Errors::const_iterator end() const { return errors.end(); }
        ///
        void insertError(int line, docstring const & error_desc,
-                        docstring const & error_text);
+                        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() {}
        ///
-       std::string aux_file;
+       support::FileName aux_file;
        ///
        std::set<std::string> citations;
        ///
@@ -82,12 +88,18 @@ 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 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)
 
@@ -126,7 +138,11 @@ 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
        };
@@ -137,10 +153,17 @@ public:
 
        /**
           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(std::string const & cmd, OutputParams const &,
-             std::string const & file);
+             support::FileName const & file,
+             std::string const & path = empty_string(),
+             std::string const & lpath = empty_string(),
+             bool const clean_start = false);
 
        /// runs LaTeX several times
        int run(TeXErrors &);
@@ -152,6 +175,10 @@ public:
        int scanLogFile(TeXErrors &);
 
 private:
+       /// noncopyable
+       LaTeX(LaTeX const &);
+       void operator=(LaTeX const &);
+
        /// use this for running LaTeX once
        int startscript();
 
@@ -163,41 +190,58 @@ 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(support::FileName 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 &);
+
+       ///
+       int scanBlgFile(DepTable & head, TeXErrors & terr);
 
        ///
-       bool runBibTeX(std::vector<Aux_Info> const &);
+       bool runBibTeX(std::vector<AuxInfo> const &,
+                      OutputParams const &);
 
        ///
-       void deleteFilesOnError() const;
+       void removeAuxiliaryFiles() const;
 
        ///
        std::string cmd;
 
        ///
-       std::string file;
+       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.
-       std::string output_file;
+       support::FileName output_file;
 
        ///
        OutputParams runparams;
+       
+       /// Do we use biber?
+       bool biber;
 };