make doc++ able to generate the source documentation for lyx

[features.git] / src / mathed / math_macro.h

diff --git a/src/mathed/math_macro.h b/src/mathed/math_macro.h
index b6031988592157ea9ede387f7e64e748b798ea87..bd87b701af471c7b5a4284f474fa6e57dd39fc9c 100644 (file)
--- a/src/mathed/math_macro.h
+++ b/src/mathed/math_macro.h
@@ -8,7 +8,7 @@
  *
  *  Dependencies: Mathed
  *
- *  Copyright: (c) 1996, 1997 Alejandro Aguilar Sierra
+ *  Copyright: 1996, 1997 Alejandro Aguilar Sierra
  *
  *   Version: 0.2, Mathed & Lyx project.
  *
@@ -25,132 +25,132 @@
 #include "debug.h"
 
 ///
-typedef MathParInset* MathParInsetP;
+typedef MathParInset * MathParInsetP;
 ///
-typedef LyxArrayBase *LyxArrayBaseP;
+typedef LyxArrayBase * LyxArrayBaseP;
 
 class MathMacroTemplate;
 
 
 /// This class contains the data for a macro
-class MathMacro: public MathParInset
+class MathMacro : public MathParInset
 {
- public:
+public:
     /// A macro can only be builded from an existing template
+    explicit
     MathMacro(MathMacroTemplate *);
     /// or from another macro.
-    MathMacro(MathMacro*);
-       ///
+    explicit
+    MathMacro(MathMacro *);
+    ///
     ~MathMacro();
-       ///
-    void Draw(int, int);
-       ///
+    ///
+    void draw(Painter &, int, int);
+    ///
     void Metrics();
-       ///
+    ///
     MathedInset * Clone();
-       ///
-    void Write(FILE *);
-       ///
-    void Write(string &);
-       ///
+    ///
+    void Write(std::ostream &, bool fragile);
+    ///
     bool setArgumentIdx(int);
-       ///
+    ///
     int  getArgumentIdx();
-       ///
+    ///
     int  getMaxArgumentIdx();
-       ///
+    ///
     int GetColumns();
-       ///
-    void GetXY(int&, int&) const;
-       ///
+    ///
+    void GetXY(int &, int &) const;
+    ///
     void SetFocus(int, int);
-       ///
-    LyxArrayBase *GetData();
-       ///
-    MathedRowSt *getRowSt() const { return args[idx].row; }
-       ///
+    ///
+    LyxArrayBase * GetData();
+    ///
+    MathedRowSt * getRowSt() const { return args[idx].row; }
+    ///
     void SetData(LyxArrayBase *);
-       ///
+    ///
     MathedTextCodes getTCode() { return tcode; }
-       ///
+    ///
     bool Permit(short);
     
- private:
-       ///
-    MathMacroTemplate *tmplate;
-       ///
+private:
+    ///
+    MathMacroTemplate * tmplate;
+    ///
     struct MacroArgumentBase {
        /// Position of the macro
        int x, y;
-           ///
-       MathedRowSt *row;
-           ///
-       LyxArrayBase *array;
-           ///
-       MacroArgumentBase() { x = y = 0;  array = 0; row = 0; }
-    } *args;
        ///
-    int idx;
+       MathedRowSt * row;
        ///
-    int nargs;
+       LyxArrayBase * array;
        ///
+       MacroArgumentBase() { x = y = 0;  array = 0; row = 0; }
+    };
+    MacroArgumentBase * args;
+    ///
+    int idx;
+    ///
+    int nargs;
+    ///
     MathedTextCodes tcode;
-       ///
+    ///
     friend class MathMacroTemplate;
 };
 
 
 /// An argument
-class MathMacroArgument: public MathParInset
-{
- public:
+class MathMacroArgument: public MathParInset {
+public:
     ///
-    MathMacroArgument() { expnd_mode = false; number = 1;  SetType(LM_OT_MACRO_ARG); }
+    MathMacroArgument() {
+           expnd_mode = false;
+           number = 1;
+           SetType(LM_OT_MACRO_ARG);
+    }
     ///
+    explicit
     MathMacroArgument(int);
     ///
-       ~MathMacroArgument() { lyxerr << "help, destroyme!" << endl; }
+    ~MathMacroArgument() { lyxerr << "help, destroyme!" << std::endl; }
     ///
     MathedInset * Clone() { return this; }
-       ///
+    ///
     void Metrics();
-       ///
-    void Draw(int x, int baseline);
-       ///
-    void Write(FILE*);
-       ///
-    void Write(string &);
+    ///
+    void draw(Painter &, int x, int baseline);
+    ///
+    void Write(std::ostream &, bool fragile);
     ///
     void setNumber(int n) { number = n; }
     /// Is expanded or not
     void setExpand(bool e) { expnd_mode = e; }
     /// Is expanded or not
     bool getExpand() { return expnd_mode; }
-    
- private:
-       ///
+private:
+    ///
     bool expnd_mode;
-       ///
+    ///
     int number;
 };
 
 
 /// This class contains the macro definition
-class MathMacroTemplate: public MathParInset
-{
- public:
+class MathMacroTemplate: public MathParInset {
+public:
     /// A template constructor needs all the data
-    MathMacroTemplate(char const*, int na= 0, int f= 0);
-       ///
+    explicit
+    MathMacroTemplate(char const *, int na = 0, int f = 0);
+    ///
     ~MathMacroTemplate();
-       ///
-    void Draw(int, int);
-       ///
+    ///
+    void draw(Painter &, int, int);
+    ///
     void Metrics();
-       ///
-    void WriteDef(FILE *); 
-       ///
-    void WriteDef(string &); 
+    ///
+    void WriteDef(std::ostream &, bool fragile);
     /// useful for special insets
     void  setTCode(MathedTextCodes t) { tcode = t; }
     ///
@@ -160,24 +160,24 @@ class MathMacroTemplate: public MathParInset
     /// Number of arguments
     int getNoArgs() { return nargs; }
     ///
-    void GetMacroXY(int, int&, int&) const;
+    void GetMacroXY(int, int &, int &) const;
     ///
-    MathParInset *getMacroPar(int) const;
+    MathParInset * getMacroPar(int) const;
+    ///
+    void SetMacroFocus(int &, int, int);
     ///
-    void SetMacroFocus(int&, int, int);
-       ///
     void setEditMode(bool);
 
     /// Replace the appropriate arguments with a specific macro's data
-    void update(MathMacro* m= 0);
+    void update(MathMacro * m = 0);
       
- private:
+private:
     ///
     short flags;
     ///
     MathedTextCodes tcode;
     ///
-    MathMacroArgument *args;
+    MathMacroArgument * args;
     ///
     int nargs;
     ///
@@ -186,38 +186,38 @@ class MathMacroTemplate: public MathParInset
      
 
 ///
-typedef MathMacro *MathMacroP;
+typedef MathMacro * MathMacroP;
 ///
-typedef MathMacroTemplate *MathMacroTemplateP;
+typedef MathMacroTemplate * MathMacroTemplateP;
 
 ///
-class MathMacroTable 
-{
- public:
-       ///
+class MathMacroTable {
+public:
+    ///
+    explicit
     MathMacroTable(int);
-       ///
+    ///
     ~MathMacroTable();
-       ///
+    ///
     void addTemplate(MathMacroTemplate *);
-       ///
-    MathMacro *getMacro(char const*) const;
-       ///
-    MathMacroTemplate *getTemplate(char const*) const;
-       ///
+    ///
+    MathMacro * getMacro(char const *) const;
+    ///
+    MathMacroTemplate * getTemplate(char const *) const;
+    ///
     void builtinMacros();
-       ///
+    ///
     static MathMacroTable mathMTable;
-       ///
+    ///
     static bool built;
     
- private:
-       ///
+private:
+    ///
     const int max_macros;
-       ///
+    ///
     int num_macros;
-       ///
-    MathMacroTemplateP *macro_table;
+    ///
+    MathMacroTemplateP * macro_table;
 };
 
 
@@ -227,7 +227,7 @@ class MathMacroTable
 inline
 bool MathMacro::setArgumentIdx(int i)
 {
-    if (i>= 0 && i<nargs) {
+    if (i >= 0 && i < nargs) {
        idx = i;
        return true;
     } else
@@ -243,30 +243,30 @@ int  MathMacro::getArgumentIdx()
 inline
 int  MathMacro::getMaxArgumentIdx() 
 { 
-    return nargs-1; 
+    return nargs - 1; 
 } 
 
 
 inline
-LyxArrayBase *MathMacro::GetData() 
+LyxArrayBase * MathMacro::GetData() 
 { 
     return args[idx].array; 
 } 
 
 
 inline
-void MathMacro::SetData(LyxArrayBase *a)
+void MathMacro::SetData(LyxArrayBase * a)
 {
    args[idx].array = a;
 }
 
 
 inline 
-MathMacro *MathMacroTable::getMacro(char const* name) const
- {
-     MathMacroTemplate *mt = getTemplate(name);
-     return (mt) ? new MathMacro(mt): 0;
- }
+MathMacro * MathMacroTable::getMacro(char const * name) const
+{
+       MathMacroTemplate * mt = getTemplate(name);
+       return (mt) ? new MathMacro(mt): 0;
+}
 
 
 #endif