goo/st-object.h

   1 /*
   2  * st-object.h
   3  *
   4  * Copyright (C) 2008 Vincent Geddes
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24
  25 #ifndef __ST_OBJECT_H__
  26 #define __ST_OBJECT_H__
  27
  28 #include <st-types.h>
  29 #include <st-small-integer.h>
  30 #include <st-utils.h>
  31 #include <st-mini.h>
  32 #include <st-class.h>
  33 #include <st-universe.h>
  34 #include <glib.h>
  35
  36 st_oop_t  st_object_new                 (st_oop_t klass);
  37 st_oop_t  st_object_new_arrayed         (st_oop_t klass, st_smi_t size);
  38
  39 void      st_object_initialize_header   (st_oop_t object, st_oop_t klass);
  40 void      st_object_initialize_body     (st_oop_t object, st_smi_t instance_size);
  41
  42 /* tag tests */
  43 INLINE int           st_object_tag           (st_oop_t object);
  44 INLINE bool          st_object_is_mark       (st_oop_t object);
  45 INLINE bool          st_object_is_heap       (st_oop_t object);
  46 INLINE bool          st_object_is_smi        (st_oop_t object);
  47
  48
  49 INLINE st_oop_t      st_object_class         (st_oop_t object);
  50 INLINE guint         st_object_hash          (st_oop_t object);
  51 INLINE st_vtable_t  *st_object_virtual       (st_oop_t object);
  52 INLINE st_vtable_t  *st_object_super_virtual (st_oop_t object);
  53 INLINE bool          st_object_equal         (st_oop_t object, st_oop_t another);
  54 INLINE bool          st_object_verify        (st_oop_t object);
  55
  56 /* type tests */
  57 INLINE bool  st_object_is_class           (st_oop_t object);
  58 INLINE bool  st_object_is_metaclass       (st_oop_t object);
  59 INLINE bool  st_object_is_association     (st_oop_t object);
  60 INLINE bool  st_object_is_symbol          (st_oop_t object);
  61 INLINE bool  st_object_is_compiled_method (st_oop_t object);
  62 INLINE bool  st_object_is_compiled_block  (st_oop_t object);
  63 INLINE bool  st_object_is_block_closure   (st_oop_t object);
  64 INLINE bool  st_object_is_method_context  (st_oop_t object);
  65 INLINE bool  st_object_is_block_context   (st_oop_t object);
  66 INLINE bool  st_object_is_arrayed         (st_oop_t object);
  67 INLINE bool  st_object_is_array           (st_oop_t object);
  68 INLINE bool  st_object_is_byte_array      (st_oop_t object);
  69
  70 st_vtable_t *st_object_vtable             (void);
  71
  72
  73 /* inline definitions */
  74
  75 INLINE int
  76 st_object_tag (st_oop_t object)
  77 {
  78         return object & st_tag_mask;
  79 }
  80
  81 INLINE bool
  82 st_object_is_mark (st_oop_t object)
  83 {
  84         return st_object_tag (object) == ST_MARK_TAG;
  85 }
  86
  87 INLINE bool
  88 st_object_is_heap  (st_oop_t object)
  89 {
  90         return st_object_tag (object) == ST_POINTER_TAG;
  91 }
  92
  93 INLINE bool
  94 st_object_is_smi (st_oop_t object)
  95 {
  96         return st_object_tag (object) == ST_SMI_TAG;
  97 }
  98
  99
 100
 101 INLINE st_oop_t
 102 st_object_class (st_oop_t object)
 103 {
 104         if (G_UNLIKELY (st_object_is_smi (object)))
 105                 return st_smi_class;
 106
 107         return st_heap_object_class (object);
 108 }
 109
 110 INLINE st_vtable_t *
 111 st_object_virtual (st_oop_t object)
 112 {
 113         if (G_UNLIKELY (st_object_is_smi (object)))
 114                 return st_smi_vtable ();
 115
 116         return (ST_CLASS_VTABLE (st_object_class (object)));
 117 }
 118
 119 INLINE st_vtable_t *
 120 st_object_super_virtual (st_oop_t object)
 121 {
 122         if (G_UNLIKELY (st_object_is_smi (object)))
 123                 return st_smi_vtable ()->parent_table;
 124
 125         return ST_CLASS_VTABLE (st_object_class (object))->parent_table;
 126 }
 127
 128
 129 INLINE bool
 130 st_object_equal (st_oop_t object, st_oop_t another)
 131 {
 132         return st_object_virtual (object)->equal (object, another);
 133 }
 134
 135 INLINE guint
 136 st_object_hash (st_oop_t object)
 137 {
 138         return st_object_virtual (object)->hash (object);
 139 }
 140
 141
 142 INLINE bool
 143 st_object_verify (st_oop_t object)
 144 {
 145         return st_object_virtual (object)->verify (object);
 146 }
 147
 148 INLINE char *
 149 st_object_describe (st_oop_t object)
 150 {
 151         return st_object_virtual (object)->describe (object);
 152 }
 153
 154 /* type tests
 155  *
 156  * We delegate the test to the vtable methods stored in object's class object
 157  *
 158  */
 159
 160 INLINE bool
 161 st_object_is_class (st_oop_t object)
 162 {
 163         return st_object_is_heap (object) &&
 164                st_object_virtual (object)->is_class ();
 165 }
 166
 167 INLINE bool
 168 st_object_is_metaclass (st_oop_t object)
 169 {
 170         return st_object_is_heap (object) &&
 171                st_object_virtual (object)->is_metaclass ();
 172 }
 173
 174 INLINE bool
 175 st_object_is_association (st_oop_t object)
 176 {
 177         return st_object_is_heap (object) &&
 178                st_object_virtual (object)->is_association ();
 179 }
 180
 181 INLINE bool
 182 st_object_is_symbol (st_oop_t object)
 183 {
 184         return st_object_is_heap (object) &&
 185                st_object_virtual (object)->is_symbol ();
 186 }
 187
 188 INLINE bool
 189 st_object_is_float (st_oop_t object)
 190 {
 191         return st_object_is_heap (object) &&
 192                st_object_virtual (object)->is_float ();
 193 }
 194
 195 INLINE bool
 196 st_object_is_dictionary (st_oop_t object)
 197 {
 198         return st_object_is_heap (object) &&
 199                st_object_virtual (object)->is_dictionary ();
 200 }
 201
 202 INLINE bool
 203 st_object_is_set (st_oop_t object)
 204 {
 205         return st_object_is_heap (object) &&
 206                st_object_virtual (object)->is_set ();
 207 }
 208
 209 INLINE bool
 210 st_object_is_compiled_method (st_oop_t object)
 211 {
 212         return st_object_is_heap (object) &&
 213                st_object_virtual (object)->is_compiled_method ();
 214 }
 215
 216 INLINE bool
 217 st_object_is_compiled_block (st_oop_t object)
 218 {
 219         return st_object_is_heap (object) &&
 220                st_object_virtual (object)->is_compiled_block ();
 221 }
 222
 223 INLINE bool
 224 st_object_is_block_closure (st_oop_t object)
 225 {
 226         return st_object_is_heap (object) &&
 227                st_object_virtual (object)->is_block_closure ();
 228 }
 229
 230 INLINE bool
 231 st_object_is_method_context (st_oop_t object)
 232 {
 233         return st_object_is_heap (object) &&
 234                st_object_virtual (object)->is_method_context ();
 235 }
 236
 237 INLINE bool
 238 st_object_is_block_context (st_oop_t object)
 239 {
 240         return st_object_is_heap (object) &&
 241                st_object_virtual (object)->is_block_context ();
 242 }
 243
 244 INLINE bool
 245 st_object_is_arrayed (st_oop_t object)
 246 {
 247         return st_object_is_heap (object) &&
 248                st_object_virtual (object)->is_arrayed ();
 249 }
 250
 251 INLINE bool
 252 st_object_is_array (st_oop_t object)
 253 {
 254         return st_object_is_heap (object) &&
 255                st_object_virtual (object)->is_array ();
 256 }
 257
 258 INLINE bool
 259 st_object_is_byte_array (st_oop_t object)
 260 {
 261         return st_object_is_heap (object) &&
 262                st_object_virtual (object)->is_byte_array ();
 263 }
 264
 265 #endif /* __ST_OBJECT_H__ */