oh well

[lyx.git] / src / mathed / math_parser.h

diff --git a/src/mathed/math_parser.h b/src/mathed/math_parser.h
index e49a4f7ce6c44616097c7180d34fd0dc8088a05c..0b51edbec19da0ca5ead06e3f0d0b55c8611e56c 100644 (file)
--- a/src/mathed/math_parser.h
+++ b/src/mathed/math_parser.h
@@ -2,7 +2,7 @@
 /*
  *  File:        math_parser.h
  *  Purpose:     Declaration of parsing utilities for mathed
- *  Author:      Alejandro Aguilar Sierra <asierra@servidor.unam.mx> 
+ *  Author:      Alejandro Aguilar Sierra <asierra@servidor.unam.mx>
  *  Created:     January 1996
  *  Description: Parse LaTeX2e math mode code.
  *
@@ -26,8 +26,6 @@
 #include "LString.h"
 #include "math_defs.h"
 
-class MathMatrixInset;
-class MathMacroTemplate;
 class MathAtom;
 class MathArray;
 class LyXLex;
@@ -59,8 +57,6 @@ enum MathTokenEnum
        LM_TK_BEGIN,
        ///
        LM_TK_END,
-       ///
-       LM_TK_NEWLINE,
        /// mathcal, mathrm...
        LM_TK_OLDFONT,
        /// cal,...
@@ -104,7 +100,7 @@ enum MathTokenEnum
        ///
        LM_TK_SPECIAL,
        ///
-       LM_TK_ARGUMENT, 
+       LM_TK_ARGUMENT,
        ///
        LM_TK_NEWCOMMAND,
        ///
@@ -112,7 +108,7 @@ enum MathTokenEnum
        ///
        LM_TK_NOT,
        ///
-       LM_TK_KERN,
+       LM_TK_UNDERSET,
        ///
        LM_TK_STACK
 };
@@ -120,34 +116,41 @@ enum MathTokenEnum
 
 ///
 struct latexkeys {
-       ///
+       /// name of the macro or primitive
        string name;
-       ///
-       short token;
-       ///
+       /// one of the categories above
+       MathTokenEnum token;
+       /// an id within a category if needed (only for spaces?)
        unsigned int id;
-       ///
-       unsigned char latex_font_id;
-       ///
-       MathSymbolTypes type;
+       /// which font to use (optional)
+       unsigned int latex_font_id;
+       /// operator/...
+       string type;
+       /// how is this called as XML entity?
+       string xmlname;
 };
 
 
-///
+/// check whether this is a well-known (La)TeX macro or primitive
 latexkeys const * in_word_set(string const & str);
 
-///
-void ReadSymbols(string const & file);
-
+/// parse formula from a string
 bool mathed_parse_normal(MathAtom &, string const &);
+/// ... a stream
 bool mathed_parse_normal(MathAtom &, std::istream &);
+/// ... the LyX lexxer
 bool mathed_parse_normal(MathAtom &, LyXLex &);
 
-string mathed_parse_macro(string const &);
-string mathed_parse_macro(std::istream &);
-string mathed_parse_macro(LyXLex &);
+/// parse a macro definition from a string, enter it into the macro table
+bool mathed_parse_macro(string &, string const &);
+/// ... a stream
+bool mathed_parse_macro(string &, std::istream &);
+/// ... the LyX lexxer
+bool mathed_parse_macro(string &, LyXLex &);
 
-void mathed_parse_cell(MathArray & ar, string const & str);
-void mathed_parse_cell(MathArray & ar, std::istream & is);
+/// parse a single cell from a string
+void mathed_parse_cell(MathArray & ar, string const &);
+/// ... a stream
+void mathed_parse_cell(MathArray & ar, std::istream &);
 
 #endif