sml/classmember.h

Go to the documentation of this file.

/******************************************************************************
 *
 * \file sml/classmember.h
 * \brief SML CLASSMEMBER
 *
 * \if NODOC
 * $Log: classmember.h_v $
 * Revision 1.5  2011/10/12 14:37:54  mju
 * Remove redundant hdr.
 *
 * Revision 1.4  2009/11/25 18:52:25  mju
 * Doxygen update.
 *
 * Revision 1.3  2007/05/08 15:45:32  dwilliss
 * SML namespace
 *
 * Revision 1.2  2007/05/04 22:34:14  dwilliss
 * moved more stuff here
 *
 * Revision 1.1  2007/05/04 22:30:31  dwilliss
 * Initial revision
 *
 * \endif
*/
/*****************************************************************************/

#ifndef INC_SML_CLASSMEMBER_H
#define INC_SML_CLASSMEMBER_H

#ifndef  INC_MI32_STDDEFNS_H
#include <mi32/stddefns.h>
#endif

#ifndef  INC_SML_STYPE_H
#include <sml/stype.h>
#endif

namespace SML {

union ARG;
class FLAG;
class FUNC;
class CLASS;
class CONTEXT;

#ifdef RVCSYSDLL
   #define RVCSYSLIBEXPORT MI_DLLEXPORT
   #define RVCSYSLIBCLASSEXPORT MI_DLLCLASSEXPORT
#else
   #define RVCSYSLIBEXPORT MI_DLLIMPORT
   #define RVCSYSLIBCLASSEXPORT MI_DLLCLASSIMPORT
#endif

class CLASSMEMBER {
   public:

   enum TYPE {
      TYPE_ByteBoolean = 1,
      TYPE_IntBoolean    = 2,
      TYPE_INT8 = 3,
      TYPE_UINT8 = 4,
      TYPE_INT16 = 5,
      TYPE_UINT16 = 6,
      TYPE_INT32 = 7,
      TYPE_UINT32 = 8,
      TYPE_Float = 9,
      TYPE_Double = 10,
      TYPE_String = 11,
      TYPE_Unicode = 12,
      TYPE_Bool    = 19,
      TYPE_MISTRING = 50,
      TYPE_Enum = 51
      };

   const char *name;
   SMLSTYPE type;          
   void (*ReadFunc)(CONTEXT *context, CLASSMEMBER *, void *obj, ARG *ret); 
   void (*WriteFunc)(CONTEXT *context, CLASSMEMBER *, void *obj, ARG *data);  
   FUNC *func;                   
   const char *ClassName;           
   UINT32 offset;                   
   int subtype;                     
   int size;                        
   const char *ResourceType;        
   const char *ResourceName;        
   FLAG *smlflags;         
   const char *description;         
   CLASS *MemberClass;     
   CLASS *ThisClass;    
   };



/*
** These functions can be used by class members to access simple stuff
*/

RVCSYSLIBEXPORT void CLASSReadSimple (
   CONTEXT *,
   CLASSMEMBER *,
   void *,
   ARG *
   );

RVCSYSLIBEXPORT void CLASSWriteSimple (
   CONTEXT *,
   CLASSMEMBER *,
   void *,
   ARG *
   );

RVCSYSLIBEXPORT void CLASSReadOnly (
   CONTEXT *,
   CLASSMEMBER *,
   void *,
   ARG *
   );

void CLASSReadPassThrough (CONTEXT *, CLASSMEMBER *, void *vdata, ARG *ret);

RVCSYSLIBEXPORT void CLASSReadULONGFlag (
   CONTEXT *,
   CLASSMEMBER *,
   void *,
   ARG *
   );

RVCSYSLIBEXPORT void CLASSWriteULONGFlag (
   CONTEXT *,
   CLASSMEMBER *,
   void *,
   ARG *
   );

void CLASSWriteTableNum (CONTEXT *context, CLASSMEMBER *member, void *vdata, ARG *arg);



/*****************************************************************************/
#define SMLCLASSMEMBER_NUM_RO(smlname, Class, membername, subtype, desc) \
   { smlname, STYPE_Num, SMLCLASSReadSimple, NULL, NULL, NULL, offsetof(Class, membername), subtype, 0, NULL, NULL, NULL, desc}

#define SMLCLASSMEMBER_NUM_RW(smlname, Class, membername, subtype, desc) \
   { smlname, STYPE_Num, SMLCLASSReadSimple, SMLCLASSWriteSimple, NULL, NULL, offsetof(Class, membername), subtype, 0, NULL, NULL, NULL, desc}

#define SMLCLASSMEMBER_STR_PTR_RO(smlname, Class, membername, subtype, desc) \
   { smlname, STYPE_String, SMLCLASSReadSimple, NULL, NULL, NULL, offsetof(Class, membername), subtype, 0, NULL, NULL, NULL, desc}

#define SMLCLASSMEMBER_STR_PTR_RW(smlname, Class, membername, subtype, desc) \
   { smlname, STYPE_String, SMLCLASSReadSimple, SMLCLASSWriteSimple, NULL, NULL, offsetof(Class, membername), subtype, 0, NULL, NULL, NULL, desc}

#define SMLCLASSMEMBER_STR_FIXEDSIZE_RO(smlname, Class, membername, subtype, sizeOf, desc) \
   { smlname, STYPE_String, SMLCLASSReadSimple, NULL, NULL, NULL, offsetof(Class, membername), subtype, sizeOf, NULL, NULL, NULL, desc}

#define SMLCLASSMEMBER_STR_FIXEDSIZE_RW(smlname, Class, membername, subtype, sizeOf, desc) \
   { smlname, STYPE_String, SMLCLASSReadSimple, SMLCLASSWriteSimple, NULL, NULL, offsetof(Class, membername), subtype, sizeOf, NULL, NULL, NULL, desc}

#define SMLCLASSMEMBER_STRUCT_PTR_RO(smlname, Class, membername, classname, desc) \
   { smlname, STYPE_ClassRef, SMLCLASSReadSimple, NULL, NULL, classname, offsetof(Class::membername), 0, 0, NULL, NULL, NULL, desc}

#define SMLCLASSMEMBER_STRUCT_PTR_RW(smlname, Class, membername, classname, desc) \
   { smlname, STYPE_ClassRef, SMLCLASSReadSimple, SMLCLASSWriteSimple, NULL, classname, offsetof(Class::membername), 0, 0, NULL, NULL, NULL, desc}

#define SMLCLASSMEMBER_STRUCT_INLINE_RO(smlname, Class, membername, classname, desc) \
   { smlname, STYPE_ClassRef, SMLCLASSReadSimple, SMLCLASSReadOnly, NULL, classname, offsetof(Class, membername), 1, 0, NULL, NULL, NULL, desc}

#define SMLCLASSMEMBER_STRUCT_INLINE_RW(smlname, Class, membername, classname, desc) \
   { smlname, STYPE_ClassRef, SMLCLASSReadSimple, SMLCLASSWriteSimple, NULL, classname, offsetof(Class, membername), 1, 0, NULL, NULL, NULL, desc}

#define SMLCLASSMEMBER_UINT32FLAG_RO(smlname, Class, membername, flagval, invert, desc) \
   { smlname, STYPE_Num, SMLCLASSReadULONGFlag, NULL, NULL, classname, offsetof(Class, membername), flagval, invert, NULL, NULL, NULL, desc}

#define SMLCLASSMEMBER_UINT32FLAG_RW(smlname, Class, membername, flagval, invert, desc) \
   { smlname, STYPE_Num, SMLCLASSReadULONGFlag, SMLCLASSWriteULONGFlag, NULL, classname, offsetof(Class, membername), flagval, invert, NULL, NULL, NULL, desc}

#define SMLCLASSMEMBER_SMLFLAG_RO(smlname, Class, membername, subtype, smlflags, mask, desc) \
   { smlname, STYPE_String, SMLCLASSReadSimple, NULL, NULL, NULL, offsetof(Class, membername), subtype, size, NULL, NULL, smlflags, desc}

#define SMLCLASSMEMBER_SMLFLAG_RW(smlname, Class, membername, subtype, smlflags, mask, desc) \
   { smlname, STYPE_String, SMLCLASSReadSimple, SMLCLASSWriteSimple, NULL, NULL, offsetof(Class, membername), subtype, mask, NULL, NULL, smlflags, desc}

#define SMLCLASSMEMBER_ENUM_RO(smlname, Class, membername, subtype, enumname, mask, desc) \
   { smlname, STYPE_Enum, SMLCLASSReadSimple, NULL, NULL, NULL, offsetof(Class, membername), subtype, size, NULL, enumname, NULL, desc}

#define SMLCLASSMEMBER_ENUM_RW(smlname, Class, membername, subtype, enumname, mask, desc) \
   { smlname, STYPE_Enum, SMLCLASSReadSimple, SMLCLASSWriteSimple, NULL, NULL, offsetof(Class, membername), subtype, mask, NULL, enumname, NULL, desc}

#define SMLCLASSMETHOD(func) { #func, STYPE_Constant, NULL, NULL, &FUNC_##func }

} // end of SML namespace


typedef SML::CLASSMEMBER SMLCLASSMEMBER;

#define SMLCLASSWriteTableNum SML::CLASSWriteTableNum
#define SMLCLASSReadSimple SML::CLASSReadSimple 
#define SMLCLASSWriteSimple SML::CLASSWriteSimple 
#define SMLCLASSReadOnly SML::CLASSReadOnly 
#define SMLCLASSReadPassThrough SML::CLASSReadPassThrough 
#define SMLCLASSReadULONGFlag SML::CLASSReadULONGFlag 
#define SMLCLASSWriteULONGFlag SML::CLASSWriteULONGFlag


#undef RVCSYSLIBEXPORT
#undef RVCSYSLIBCLASSEXPORT

#endif      //  INC_SML_CLASSMEMBER_H

---