12 #ifndef K_API_OBJECT_H
13 #define K_API_OBJECT_H
15 #include <kApi/kObject.x.h>
101 return xkObject_CloneImpl(
object, source, objectAllocator, objectAllocator,
kNULL);
143 return xkObject_CloneImpl(
object, source, objectAllocator, valueAllocator, context);
212 return xkObject_DestroyImpl(
object,
kFALSE);
240 return xkObject_DestroyImpl(
object,
kTRUE);
282 xkObject_RawVerifyTag(
object) &&
kType_Is(obj->type, type);
299 return xkObject_VTable(
object)->VEquals(
object, other);
314 return xkObject_VTable(
object)->VHashCode(
object);
345 return xkObject_VTable(
object)->VAllocTraits(
object);
373 return xkObject_VTable(
object)->VSize(
object);
411 return xkObject_VTable(
object)->VHasShared(
object);
436 obj->tag = xkOBJECT_TAG;
627 return xkHashPointer(
object);
646 return (
object == other);
kStatus kObject_VRelease(kObject object)
Protected virtual method that deallocates any resources owned by the object.
Definition: kObject.h:518
kType kObject_Type(kObject object)
Returns the type of the object.
Definition: kObject.h:257
kAllocTrait kObject_VAllocTraits(kObject object)
Protected virtual method that gets the bitset of allocator traits for any allocators used within this...
Definition: kObject.h:587
kStatus kAlloc_Get(kAlloc alloc, kSize size, void *mem, kMemoryAlignment alignment)
Allocates a block of memory.
Definition: kAlloc.h:39
kAllocTrait kObject_AllocTraits(kObject object)
Gets the bitset of allocator traits for any allocators used within this object, including aggregated ...
Definition: kObject.h:343
kAlloc kObject_Alloc(kObject object)
Gets the memory allocator associated with this object.
Definition: kObject.h:329
kBool kObject_Equals(kObject object, kObject other)
Determines whether the object is equal to another object.
Definition: kObject.h:297
kSize kObject_HashCode(kObject object)
Gets a hash code representing the state of this object.
Definition: kObject.h:312
#define kIsNull(POINTER)
Tests for equality with null pointer.
Definition: kApiDef.h:341
kBool kObject_Is(kObject object, kType type)
Determines whether this object is an instance of the specified type.
Definition: kObject.h:277
k32s kAtomic32s_Increment(kAtomic32s *atomic)
Increments an atomic variable.
Definition: kAtomic.h:50
kStatus kObject_Init(kObject object, kType type, kAlloc alloc)
Protected method called by derived classes to initialize the kObject base class.
Definition: kObject.h:429
Represents an unsigned integer that can store a pointer address.
Abstract base class for memory allocator types.
kStatus kObject_Share(kObject object)
Increments the reference count associated with this object.
Definition: kObject.h:162
kSize kObject_VHashCode(kObject object)
Protected virtual method that calculates a hash code representing the object instance.
Definition: kObject.h:625
kStatus kAlloc_Free(kAlloc alloc, void *mem)
Frees a block of memory.
Definition: kAlloc.h:122
kStatus kObject_FreeMemRef(kObject object, void *mem)
Protected method called by derived classes to free memory (and reset the provided memory pointer to k...
Definition: kObject.h:500
#define kInlineFx(TYPE)
Inline method declaration helper.
Definition: kApiDef.h:26
kBool kObject_HasShared(kObject object)
Reports whether an object or any of its aggregated child elements has a reference count greater than ...
Definition: kObject.h:409
kStatus kAlloc_GetZero(kAlloc alloc, kSize size, void *mem, kMemoryAlignment alignment)
Allocates a block of memory and zero-initializes the block.
Definition: kAlloc.h:70
#define kTRUE
Boolean true.
Definition: kApiDef.h:356
kBool kObject_IsShared(kObject object)
Reports whether the object is currently shared (reference count greater than one).
Definition: kObject.h:392
kStatus kObject_VClone(kObject object, kObject source, kAlloc valueAllocator, kObject context)
Protected virtual method that clones (makes a deep copy of) the specified source object.
Definition: kObject.h:545
kStatus kObject_Clone(kObject *object, kObject source, kAlloc objectAllocator)
Constructs a new object by copying an existing object, including any aggregated child elements...
Definition: kObject.h:97
#define kObj(TypeName_T, T_object)
Declares a local "obj" (this-pointer) variable and initializes it from a type-checked object handle...
Definition: kApiDef.h:3383
#define kObjR(TypeName_T, T_object)
Declares a local "obj" (this-pointer) variable and initializes it from an object handle, without type-checking.
Definition: kApiDef.h:3395
Supports reclaiming objects upon destruction.
Core Zen type declarations.
kBool kObject_HasForeignData(kObject object)
Reports whether the object, including aggregated child elements, contains any foreign memory referenc...
Definition: kObject.h:355
kBool kObject_VHasShared(kObject object)
Protected virtual method that reports whether an object or any of its aggregated child elements has a...
Definition: kObject.h:573
kStatus kAlloc_FreeRef(kAlloc alloc, void *mem)
Frees a block of memory and sets the memory pointer to kNULL.
Definition: kAlloc.h:135
kStatus kObject_Destroy(kObject object)
Destroys the object.
Definition: kObject.h:208
#define kALLOC_TRAIT_FOREIGN
Allocates memory in a foreign memory domain (non-host address space).
Definition: kApiDef.h:2236
#define kERROR_UNIMPLEMENTED
Feature is not implemented.
Definition: kApiDef.h:494
Represents metadata about a type (class, interface, or value).
kBool kObject_VEquals(kObject object, kObject other)
Protected virtual method that compares two objects for equality.
Definition: kObject.h:644
kAllocTrait kAlloc_Traits(kAlloc alloc)
Gets the traits associated with this allocator.
Definition: kAlloc.h:179
kStatus kObject_Dispose(kObject object)
Destroys the object and any aggregated child elements.
Definition: kObject.h:236
kStatus kObject_SetPool(kObject object, kObjectPool pool)
Sets the object pool associated with this object.
Definition: kObject.h:183
kSize kType_InnerSize(kType type)
Gets the internal size of a type.
Definition: kType.h:321
kSize kObject_Size(kObject object)
Estimates the memory consumed by this object, including any aggregated child elements.
Definition: kObject.h:371
#define kOK
Operation successful.
Definition: kApiDef.h:515
void kAtomic32s_Init(kAtomic32s *atomic, k32s value)
Initializes an atomic variable with a particular value.
Definition: kAtomic.h:36
Represents an error code.
kStatus kObject_GetMem(kObject object, kSize size, void *mem)
Protected method called by derived classes to allocate memory using the object's allocator.
Definition: kObject.h:454
#define kNULL
Null pointer.
Definition: kApiDef.h:269
kStatus kObject_GetMemZero(kObject object, kSize size, void *mem)
Protected method called by derived classes to allocate and zero memory using the object's allocator...
Definition: kObject.h:470
kBool kType_Is(kType type, kType other)
Determines whether a type is equivalent to another type.
Definition: kType.h:89
kStatus kObject_VDisposeItems(kObject object)
Protected virtual method that destroys any aggregated child objects associated with a collection...
Definition: kObject.h:561
Represents a memory allocator trait.
Represents a boolean value.
#define kFALSE
Boolean false.
Definition: kApiDef.h:355
kStatus kObject_FreeMem(kObject object, void *mem)
Protected method called by derived classes to free memory using the object's allocator.
Definition: kObject.h:485
k32s kAtomic32s_Get(kAtomic32s *atomic)
Gets the current value of an atomic variable.
Definition: kAtomic.h:111
kSize kObject_VSize(kObject object)
Protected virtual method that calculates the total size (in bytes) of the object instance.
Definition: kObject.h:608