rom/oop/include/oop.h

   1 #ifndef OOP_OOP_H
   2 #define OOP_OOP_H
   3
   4 /*
   5     Copyright © 1995-2011, 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     CONST_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 IntOOPBase   *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     OOP_Class           *superclass;
  74 };
  75
  76
  77
  78 struct _OOP_Object
  79 {
  80     OOP_Class *o_Class;
  81 };
  82
  83
  84
  85 /* Macros */
  86
  87
  88 #define OOP_BASEOBJECT(obj) ((OOP_Object *)(_OOP_OBJ(obj) + 1))
  89 #define _OOP_OBJECT(obj) (_OOP_OBJ(obj) - 1)
  90 #define _OOP_OBJ(obj) ((struct _OOP_Object *)(obj))
  91
  92 #define OOP_INST_DATA(cl, obj) \
  93         ((APTR)(((UBYTE *)obj) + (cl)->InstOffset))
  94
  95 #define OOP_OCLASS(obj) \
  96         (_OOP_OBJECT(obj)->o_Class)
  97
  98 #define OOP_OOPBASE(obj) \
  99         (OOP_OCLASS(obj)->OOPBasePtr)
 100
 101 #define OOP_DoMethod(o, msg) ( (OOP_OCLASS(o))->cl_DoMethod((o), (msg)) )
 102 #define OOP_DoSuperMethod(cl, o, msg) ((cl)->cl_DoSuperMethod(cl, o, msg))
 103 #define OOP_CoerceMethod(cl, o, msg) ((cl)->cl_CoerceMethod(cl, o, msg))
 104
 105 #define OOP_GET(o, attr) ({IPTR _val; OOP_GetAttr(o, attr, &_val); _val;})
 106
 107 #define OOP_METHODDEF(x) (IPTR (*)())x
 108
 109 #define IS_IF_ATTR(attr, idx, attrbase, numifattrs) ( ((idx) = (attr) - (attrbase)) < (numifattrs) )
 110
 111 struct OOP_InterfaceDescr
 112 {
 113     const struct OOP_MethodDescr *MethodTable;
 114     CONST_STRPTR InterfaceID;
 115     ULONG  NumMethods; /* Number of methods in the methodtable */
 116 };
 117
 118 typedef IPTR (*OOP_MethodFunc)(OOP_Class *cl, OOP_Object *o, OOP_Msg msg);
 119
 120 struct OOP_MethodDescr
 121 {
 122     OOP_MethodFunc MethodFunc;
 123     ULONG MethodIdx;
 124 };
 125
 126
 127 /* Some basic interfaces and classes */
 128
 129 /*********************
 130 **  rootclass defs  **
 131 *********************/
 132
 133 #define IID_Root "Root"
 134 #define CLID_Root "rootclass"
 135
 136
 137 enum
 138 {
 139     moRoot_New = 0,
 140     moRoot_Dispose,
 141     moRoot_Set,
 142     moRoot_Get,
 143
 144     num_Root_Methods
 145 };
 146
 147
 148 struct pRoot_New
 149 {
 150     OOP_MethodID mID;
 151     struct TagItem *attrList;
 152 };
 153
 154 struct pRoot_Dispose {
 155     OOP_MethodID mID;
 156 };
 157
 158 struct pRoot_Set
 159 {
 160     OOP_MethodID mID;
 161     struct TagItem *attrList;
 162 };
 163
 164 struct pRoot_Get
 165 {
 166     OOP_MethodID mID;
 167     ULONG attrID;
 168     IPTR *storage;
 169 };
 170
 171 /**************************
 172 **  meta interface defs  **
 173 **************************/
 174
 175 #define IID_Meta "Meta"
 176
 177 #define MetaAttrBase (__IMeta)
 178
 179
 180 enum
 181 {
 182     num_Meta_Methods
 183 };
 184
 185 enum {
 186     aoMeta_SuperID = 0,
 187     aoMeta_InterfaceDescr,
 188     aoMeta_ID,
 189     aoMeta_SuperPtr,
 190     aoMeta_InstSize,
 191     aoMeta_DoMethod,
 192     aoMeta_CoerceMethod,
 193     aoMeta_DoSuperMethod,
 194
 195     num_Meta_Attrs
 196 };
 197
 198 #define aMeta_SuperID           (MetaAttrBase + aoMeta_SuperID)
 199 #define aMeta_InterfaceDescr    (MetaAttrBase + aoMeta_InterfaceDescr)
 200 #define aMeta_ID                (MetaAttrBase + aoMeta_ID)
 201 #define aMeta_SuperPtr          (MetaAttrBase + aoMeta_SuperPtr)
 202 #define aMeta_InstSize          (MetaAttrBase + aoMeta_InstSize)
 203 #define aMeta_DoMethod          (MetaAttrBase + aoMeta_DoMethod)
 204 #define aMeta_CoerceMethod      (MetaAttrBase + aoMeta_CoerceMethod)
 205 #define aMeta_DoSuperMethod     (MetaAttrBase + aoMeta_DoSuperMethod)
 206
 207 /***********************
 208 **  methodclass defs  **
 209 ***********************/
 210
 211 extern ULONG __IMethod;
 212
 213 #define IID_Method "Method"
 214
 215 #define CLID_Method "methodclass"
 216
 217 #define MethodAttrBase (__IMethod)
 218
 219 #define OOP_CallMethod(m) ( (m)->methodFunc((m)->methodClass, (m)->targetObject, (m)->message) )
 220
 221 enum {
 222     aoMethod_TargetObject= 0,
 223     aoMethod_Message,
 224     aoMethod_MethodID,
 225
 226     num_Method_Attrs
 227 };
 228
 229 #define aMethod_TargetObject    (MethodAttrBase + aoMethod_TargetObject)
 230 #define aMethod_Message         (MethodAttrBase + aoMethod_Message)
 231 #define aMethod_MethodID        (MethodAttrBase + aoMethod_MethodID)
 232
 233 typedef struct
 234 {
 235     OOP_Object          *targetObject;
 236     OOP_Msg             message;
 237     OOP_Class           *methodClass;
 238     OOP_MethodFunc      methodFunc;
 239 } OOP_Method;
 240
 241
 242 /**************************
 243 **  interfaceclass defs  **
 244 **************************/
 245
 246 extern ULONG __IInterface;
 247
 248 #define IID_Interface "Interface"
 249
 250 #define CLID_Interface "interfaceclass"
 251
 252 #define InterfaceAttrBase (__IInterface)
 253
 254
 255 enum {
 256     aoInterface_TargetObject= 0,
 257     aoInterface_InterfaceID,
 258
 259     NUM_A_Interface
 260 };
 261
 262 #define aInterface_TargetObject         (InterfaceAttrBase + aoInterface_TargetObject)
 263 #define aInterface_InterfaceID          (InterfaceAttrBase + aoInterface_InterfaceID)
 264
 265
 266 typedef struct OOP_InterfaceStruct
 267 {
 268     IPTR        (*callMethod)(struct OOP_InterfaceStruct *, OOP_Msg);
 269     OOP_Object  *targetObject;
 270
 271 } OOP_Interface;
 272
 273
 274 /***********************
 275 **  Some metaclasses  **
 276 ***********************/
 277
 278 #define CLID_MIMeta   "mimetaclass"     /* Supports multiple interfaces   */
 279 #define CLID_SIMeta   "simetaclass"     /* Supports only single intefaces */
 280
 281
 282
 283 #endif /* OOP_OOP_H */