]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeXFeatures.h
more cursor dispatch
[lyx.git] / src / LaTeXFeatures.h
index 6b884de02de58739cdac9b60d563a046f494c4ad..c3d62de312b60008994785b162e7b917d799c597 100644 (file)
@@ -1,32 +1,26 @@
 // -*- C++ -*-
-/* This file is part of
-* ====================================================== 
-* 
-*           LyX, The Document Processor
-*        
-*           Copyright 1995 Matthias Ettrich
-*           Copyright 1995-2001 the LyX Team.
-*
-* ====================================================== */
+/**
+ * \file LaTeXFeatures.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ *
+ * Full author contact details are available in file CREDITS.
+ */
 
 #ifndef LATEXFEATURES_H
 #define LATEXFEATURES_H
 
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "support/types.h"
-
-#include "LString.h"
-
-#include <vector>
 #include <set>
 #include <list>
 #include <map>
+#include <string>
 
-class BufferParams; 
+class Buffer;
+class BufferParams;
 struct Language;
 
 /** The packages and commands that a buffer needs. This class
@@ -35,82 +29,91 @@ struct Language;
 
     i.e require("amssymb")
 
-    To add support you should only need to require() the package name as 
+    To add support you should only need to require() the package name as
     packages which don't have special requirements are handled automatically.
     If your new package does need special consideration you'll need to alter
     string const getPackages() const;
-    Remember to update the validate function in buffer.C and paragraph.C 
+    Remember to update the validate function in buffer.C and paragraph.C
     when you do so.
 */
 class LaTeXFeatures {
 public:
        ///
-       LaTeXFeatures(BufferParams const &, lyx::layout_type n) ;
+       LaTeXFeatures(Buffer const &, BufferParams const &, bool);
        /// The packages needed by the document
-       string const getPackages() const;
+       std::string const getPackages() const;
        /// The macros definitions needed by the document
-       string const getMacros() const;
+       std::string const getMacros() const;
+       ///
+       std::string const getBabelOptions() const;
        /// The definitions needed by the document's textclass
-       string const getTClassPreamble() const;
+       std::string const getTClassPreamble() const;
        /// The sgml definitions needed by the document (dobook/linuxdoc)
-       string const getLyXSGMLEntities() const;
+       std::string const getLyXSGMLEntities() const;
        /// The SGML Required to include the files added with includeFile();
-       string const getIncludedFiles(string const & fname) const;
+       std::string const getIncludedFiles(std::string const & fname) const;
        /// Include a file for use with the SGML entities
-       void includeFile(string const & key, string const & name);
+       void includeFile(std::string const & key, std::string const & name);
        /// The float definitions.
        void getFloatDefinitions(std::ostream & os) const;
        /// Print requirements to lyxerr
        void showStruct() const;
-       /// 
-       void addExternalPreamble(string const &);
+       ///
+       void addExternalPreamble(std::string const &);
        /// Provide a string name-space to the requirements
-       void require(string const & name);
+       void require(std::string const & name);
        /// Is the package required?
-       bool isRequired(string const & name) const;
+       bool isRequired(std::string const & name) const;
        ///
-       void useFloat(string const & name);
+       void useFloat(std::string const & name);
        ///
        void useLanguage(Language const *);
        ///
-       bool hasLanguages();
+       bool hasLanguages() const;
        ///
-       string getLanguages() const;
+       std::string getLanguages() const;
        ///
-       std::set<string> getEncodingSet(string const & doc_encoding);
+       std::set<std::string> getEncodingSet(std::string const & doc_encoding) const;
        ///
+       void useLayout(std::string const & lyt);
        ///
-       void useLayout(std::vector<bool>::size_type const & idx);
+       Buffer const & buffer() const;
        ///
        BufferParams const & bufferParams() const;
+       /// the return value is dependent upon both LyXRC and LaTeXFeatures.
+       bool useBabel() const;
        ///
+       bool nice() const { return nice_; };
 
 private:
-       string externalPreambles;
-
-       std::vector<bool> layout;
+       std::list<std::string> usedLayouts_;
 
        /// Static preamble bits from the external material insets
-
-
-       typedef std::list<string> FeaturesList;
+       typedef std::list<std::string> FeaturesList;
+       ///
+       FeaturesList features_;
        ///
-       FeaturesList features;
+       FeaturesList preamble_snippets_;
        ///
        typedef std::set<Language const *> LanguageList;
        ///
-       LanguageList UsedLanguages;
+       LanguageList UsedLanguages_;
        ///
-       typedef std::set<string> UsedFloats;
+       typedef std::set<std::string> UsedFloats;
        ///
-       UsedFloats usedFloats;
+       UsedFloats usedFloats_;
        ///
-       typedef std::map<string , string> FileMap;
+       typedef std::map<std::string , std::string> FileMap;
        ///
-       FileMap IncludedFiles;
+       FileMap IncludedFiles_;
        ///
+       Buffer const & buffer_;
        ///
-       BufferParams const & params;
+       BufferParams const & params_;
+       /** If we are writing a nice LaTeX file or not.
+        *  Only needed by InsetInclude::validate().
+        */
+       bool nice_;
 };
 
 #endif