Move #includes out of header files.

[lyx.git] / src / lyxlex.h

diff --git a/src/lyxlex.h b/src/lyxlex.h
index 9825fc962ed05e7b574e2327d2e91c27f78ff756..32c58834437fcd525005e143beab32a27a107abe 100644 (file)
--- a/src/lyxlex.h
+++ b/src/lyxlex.h
@@ -1,27 +1,33 @@
 // -*- C++ -*-
+/**
+ * \file lyxlex.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Alejandro Aguilar Sierra
+ * \author Lars Gullik Bjønnes
+ *
+ * Full author contact details are available in file CREDITS.
+ */
+
 //  Generalized simple lexical analizer.
 //  It can be used for simple syntax parsers, like lyxrc,
-//  texclass and others to come.   [asierra30/03/96]
-//
-//   Copyright 1996 Lyx Team.
+//  texclass and others to come.
+
 #ifndef LYXLEX_H
 #define LYXLEX_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include <iosfwd>
 
 #include "LString.h"
-#include "support/utility.hpp"
+#include <boost/utility.hpp>
 
 ///
 struct keyword_item {
        ///
        char const * tag;
        ///
-       short code;
+       int code;
 };
 
 /** Generalized simple lexical analizer.
@@ -29,13 +35,13 @@ struct keyword_item {
     texclass and others to come.
     @see lyxrc.C for an example of usage.
   */
-class LyXLex : public noncopyable { 
+class LyXLex : boost::noncopyable {
 public:
        ///
-       LyXLex (keyword_item *, int);
+       LyXLex(keyword_item *, int);
        ///
        ~LyXLex();
-       
+
        /// Lex basic codes
        enum {
                ///
@@ -49,16 +55,18 @@ public:
        };
 
        /// file is open and end of file is not reached
-       bool IsOK() const;
+       bool isOK() const;
        /// return true if able to open file, else false
        bool setFile(string const & filename);
        ///
-       void setStream(std::istream & i);
+       void setStream(std::istream & is);
        ///
        std::istream & getStream();
        /// Danger! Don't use it unless you know what you are doing.
        void setLineNo(int l);
-       
+       /// Change the character that begins a comment. Default is '#'
+       void setCommentChar(char c);
+
        /// returns a lex code
        int lex();
 
@@ -74,19 +82,19 @@ public:
        bool nextToken();
        /// Push a token, that next token got from lyxlex.
        void pushToken(string const &);
-       
-       /// 
-       int GetLineNo() const;
-       
+
+       ///
+       int getLineNo() const;
+
        ///
-       int GetInteger() const;
+       int getInteger() const;
        ///
-       bool GetBool() const;
+       bool getBool() const;
        ///
-       float GetFloat() const;
+       float getFloat() const;
        ///
-       string const GetString() const;
-       
+       string const getString() const;
+
        /** Get a long string, ended by the tag `endtag'.
            This string can span several lines. The first line
            serves as a template for how many spaces the lines
@@ -95,21 +103,16 @@ public:
            perfectly if you use tabs.
        */
        string const getLongString(string const & endtag);
-       
-       ///
-       bool EatLine();
-       ///
-       int FindToken(char const * str[]);
-       ///
-       int CheckToken(char const * str[], int print_error);
 
        ///
-       char const * const text() const;
+       bool eatLine();
+       ///
+       int findToken(char const * str[]);
 
        /** Pushes a token list on a stack and replaces it with a new one.
         */
        void pushTable(keyword_item *, int);
-       
+
        /** Pops a token list into void and replaces it with the one now
            on top of the stack.
        */
@@ -132,19 +135,22 @@ private:
 };
 
 
-/** Use to enable multipe exit points.
+/** Use to enable multiple exit points.
     This is needed to ensure that the pop is done upon exit from methods
     with more than one exit point or that can return as a response to
     exceptions.
     @autor Lgb
 */
 struct pushpophelper {
+       ///
        pushpophelper(LyXLex & lexrc, keyword_item * i, int s) : lex(lexrc) {
                lex.pushTable(i, s);
        }
+       ///
        ~pushpophelper() {
                lex.popTable();
        }
+       ///
        LyXLex & lex;
 };
 /** Avoid wrong usage of pushpophelper.