rom/oop/include/oop.h

   1 #ifndef OOP_OOP_H
   2 #define OOP_OOP_H
   3
   4 /*
   5     Copyright © 1995-2005, The AROS Development Team. All rights reserved.
   6     $Id$
   7 */
   8
   9 #ifndef EXEC_TYPES_H
  10 #   include <exec/types.h>
  11 #endif
  12
  13 #ifndef EXEC_NODES_H
  14 #   include <exec/nodes.h>
  15 #endif
  16
  17 #ifndef EXEC_LIBRARIES_H
  18 #   include <exec/libraries.h>
  19 #endif
  20
  21 #ifndef UTILITY_TAGITEM_H
  22 #   include <utility/tagitem.h>
  23 #endif
  24
  25 #define AROSOOP_NAME "oop.library"
  26
  27 typedef ULONG OOP_Object;
  28
  29 typedef ULONG OOP_MethodID;
  30 typedef ULONG OOP_AttrID;
  31
  32 typedef ULONG OOP_AttrBase;
  33
  34 typedef ULONG OOP_AttrCheck;
  35
  36 #define GOT_ATTR(code, pre_tag, pre_ac) \
  37     ((pre_ac ## _attrcheck & (1L << pre_tag ## _ ## code)) == (1L << pre_tag ## _ ## code))
  38
  39 #define FOUND_ATTR(code, pre_tag, pre_ac)       \
  40     pre_ac ## _attrcheck |= (1L << pre_tag ## _ ## code)
  41
  42 #define DECLARE_ATTRCHECK(pre_tag)      \
  43     OOP_AttrCheck pre_tag ## _attrcheck = 0UL
  44
  45 #define ATTRCHECK(pre_tag)      \
  46     pre_tag ## _attrcheck
  47
  48 enum {
  49     ooperr_ParseAttrs_TooManyAttrs = 1
  50 };
  51
  52 typedef OOP_MethodID * OOP_Msg;
  53
  54
  55 struct OOP_ABDescr
  56 {
  57     STRPTR          interfaceID;
  58     OOP_AttrBase    *attrBase;
  59 };
  60
  61 typedef struct OOP_IClass OOP_Class;
  62
  63 struct OOP_IClass
  64 {
  65     /* Array of pointers to methodtables for this class */
  66     struct Node         ClassNode;
  67     struct Library      *OOPBasePtr;
  68     ULONG               InstOffset;
  69     APTR                UserData;
  70     IPTR                (*cl_DoMethod)(OOP_Object *, OOP_Msg);
  71     IPTR                (*cl_CoerceMethod)(OOP_Class *, OOP_Object *, OOP_Msg);
  72     IPTR                (*cl_DoSuperMethod)(OOP_Class *, OOP_Object *, OOP_Msg);
  73 };
  74
  75
  76
  77 struct _OOP_Object
  78 {
  79     OOP_Class *o_Class;
  80 };
  81
  82
  83
  84 /* Macros */
  85
  86
  87 #define OOP_BASEOBJECT(obj) ((OOP_Object *)(_OOP_OBJ(obj) + 1))
  88 #define _OOP_OBJECT(obj) (_OOP_OBJ(obj) - 1)
  89 #define _OOP_OBJ(obj) ((struct _OOP_Object *)(obj))
  90
  91 #define OOP_INST_DATA(cl, obj) \
  92         ((APTR)(((UBYTE *)obj) + (cl)->InstOffset))
  93
  94 #define OOP_OCLASS(obj) \
  95         (_OOP_OBJECT(obj)->o_Class)
  96
  97 #define OOP_OOPBASE(obj) \
  98         (OOP_OCLASS(obj)->OOPBasePtr)
  99
 100 #define OOP_DoMethod(o, msg) ( (OOP_OCLASS(o))->cl_DoMethod((o), (msg)) )
 101 #define OOP_DoSuperMethod(cl, o, msg) ((cl)->cl_DoSuperMethod(cl, o, msg))
 102 #define OOP_CoerceMethod(cl, o, msg) ((cl)->cl_CoerceMethod(cl, o, msg))
 103
 104 #define OOP_METHODDEF(x) (IPTR (*)())x
 105
 106
 107 #define IS_IF_ATTR(attr, idx, attrbase, numifattrs) ( ((idx) = (attr) - (attrbase)) < (numifattrs) )
 108
 109 struct OOP_InterfaceDescr
 110 {
 111     struct OOP_MethodDescr  *MethodTable;
 112     STRPTR                  InterfaceID;
 113     ULONG                   NumMethods; /* Number of methods in the methodtable */
 114 };
 115
 116 typedef IPTR (*OOP_MethodFunc)(OOP_Class *cl, OOP_Object *o, OOP_Msg msg);
 117
 118 struct OOP_MethodDescr
 119 {
 120     OOP_MethodFunc MethodFunc;
 121     ULONG   MethodIdx;
 122 };
 123
 124
 125 /* Some basic interfaces and classes */
 126
 127 /*********************
 128 **  rootclass defs  **
 129 *********************/
 130
 131 #define IID_Root "Root"
 132 #define CLID_Root "rootclass"
 133
 134
 135 enum
 136 {
 137     moRoot_New = 0,
 138     moRoot_Dispose,
 139     moRoot_Set,
 140     moRoot_Get,
 141
 142     num_Root_Methods
 143 };
 144
 145
 146 struct pRoot_New
 147 {
 148     OOP_MethodID mID;
 149     struct TagItem *attrList;
 150 };
 151
 152 struct pRoot_Set
 153 {
 154     OOP_MethodID mID;
 155     struct TagItem *attrList;
 156 };
 157
 158 struct pRoot_Get
 159 {
 160     OOP_MethodID mID;
 161     ULONG attrID;
 162     IPTR *storage;
 163 };
 164
 165 /**************************
 166 **  meta interface defs  **
 167 **************************/
 168
 169 #define IID_Meta "Meta"
 170
 171 #define MetaAttrBase (__IMeta)
 172
 173
 174 enum
 175 {
 176     num_Meta_Methods
 177 };
 178
 179 enum {
 180     aoMeta_SuperID = 0,
 181     aoMeta_InterfaceDescr,
 182     aoMeta_ID,
 183     aoMeta_SuperPtr,
 184     aoMeta_InstSize,
 185     aoMeta_DoMethod,
 186     aoMeta_CoerceMethod,
 187     aoMeta_DoSuperMethod,
 188
 189     num_Meta_Attrs
 190 };
 191
 192 #define aMeta_SuperID           (MetaAttrBase + aoMeta_SuperID)
 193 #define aMeta_InterfaceDescr    (MetaAttrBase + aoMeta_InterfaceDescr)
 194 #define aMeta_ID                (MetaAttrBase + aoMeta_ID)
 195 #define aMeta_SuperPtr          (MetaAttrBase + aoMeta_SuperPtr)
 196 #define aMeta_InstSize          (MetaAttrBase + aoMeta_InstSize)
 197 #define aMeta_DoMethod          (MetaAttrBase + aoMeta_DoMethod)
 198 #define aMeta_CoerceMethod      (MetaAttrBase + aoMeta_CoerceMethod)
 199 #define aMeta_DoSuperMethod     (MetaAttrBase + aoMeta_DoSuperMethod)
 200
 201 /***********************
 202 **  methodclass defs  **
 203 ***********************/
 204
 205 extern ULONG __IMethod;
 206
 207 #define IID_Method "Method"
 208
 209 #define CLID_Method "methodclass"
 210
 211 #define MethodAttrBase (__IMethod)
 212
 213 #define OOP_CallMethod(m) ( (m)->methodFunc((m)->methodClass, (m)->targetObject, (m)->message) )
 214
 215 enum {
 216     aoMethod_TargetObject= 0,
 217     aoMethod_Message,
 218     aoMethod_MethodID,
 219
 220     num_Method_Attrs
 221 };
 222
 223 #define aMethod_TargetObject    (MethodAttrBase + aoMethod_TargetObject)
 224 #define aMethod_Message         (MethodAttrBase + aoMethod_Message)
 225 #define aMethod_MethodID        (MethodAttrBase + aoMethod_MethodID)
 226
 227 typedef struct
 228 {
 229     OOP_Object          *targetObject;
 230     OOP_Msg             message;
 231     OOP_Class           *methodClass;
 232     OOP_MethodFunc      methodFunc;
 233 } OOP_Method;
 234
 235
 236 /**************************
 237 **  interfaceclass defs  **
 238 **************************/
 239
 240 extern ULONG __IInterface;
 241
 242 #define IID_Interface "Interface"
 243
 244 #define CLID_Interface "interfaceclass"
 245
 246 #define InterfaceAttrBase (__IInterface)
 247
 248
 249 enum {
 250     aoInterface_TargetObject= 0,
 251     aoInterface_InterfaceID,
 252
 253     NUM_A_Interface
 254 };
 255
 256 #define aInterface_TargetObject         (InterfaceAttrBase + aoInterface_TargetObject)
 257 #define aInterface_InterfaceID          (InterfaceAttrBase + aoInterface_InterfaceID)
 258
 259
 260 typedef struct OOP_InterfaceStruct
 261 {
 262     IPTR        (*callMethod)(struct OOP_InterfaceStruct *, OOP_Msg);
 263     OOP_Object  *targetObject;
 264
 265 } OOP_Interface;
 266
 267
 268 /***********************
 269 **  Some metaclasses  **
 270 ***********************/
 271
 272 #define CLID_MIMeta   "mimetaclass"     /* Supports multiple interfaces   */
 273 #define CLID_SIMeta   "simetaclass"     /* Supports only single intefaces */
 274
 275
 276
 277 #endif /* OOP_OOP_H */