Zen API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kUtils Class Reference

Description

Collection of utility functions.

Inheritance diagram for kUtils:
Inheritance graph

Public Member Functions

kStatus kDestroyRef (kObject *object)
 Destroys an object and resets the object handle to kNULL. More...
 
kStatus kDisposeRef (kObject *object)
 Disposes an object and resets the object handle to kNULL. More...
 
kStatus kLoad5 (kObject *object, const kChar *fileName, kAlloc allocator)
 Loads an object from file using kDat-5 serialization. More...
 
kStatus kLoad6 (kObject *object, const kChar *fileName, kAlloc allocator)
 Loads an object from file using kDat-6 serialization. More...
 
kStatus kLogf (const kChar *format,...)
 Writes to logging handler (if registered). More...
 
kStatus kLogvf (const kChar *format, kVarArgList argList)
 Variable-argument version of kLogf. More...
 
kStatus kMemAlloc (kSize size, void *mem)
 Allocates a block of memory from the application heap. More...
 
kStatus kMemAllocZero (kSize size, void *mem)
 Allocates and zero-initializes block of memory from the application heap. More...
 
kStatus kMemCopy (void *dest, const void *src, kSize size)
 Copies memory from a source buffer to a non-overlapping destination. More...
 
kBool kMemEquals (const void *a, const void *b, kSize size)
 Compares one memory buffer with another. More...
 
kStatus kMemFree (void *mem)
 Frees a block of memory that was allocated using kMemAlloc or kMemAllocZero. More...
 
kStatus kMemFreeRef (void *mem)
 Frees a block of memory that was allocated using kMemAlloc or kMemAllocZero and resets the memory pointer to kNULL. More...
 
kStatus kMemMove (void *dest, const void *src, kSize size)
 Copies memory from a source buffer to a potentially-overlapping destination. More...
 
kStatus kMemSet (void *dest, kByte fill, kSize size)
 Sets a block of memory to the given byte value. More...
 
k32u kRandom32u ()
 Generates a random 32-bit number. More...
 
k64u kRandom64u ()
 Generates a random 64-bit number. More...
 
kSize kRandomSize ()
 Generates a random number of type kSize. More...
 
kStatus kSave5 (kObject object, const kChar *fileName)
 Saves an object to file using kDat-5 serialization. More...
 
kStatus kSave6 (kObject object, const kChar *fileName)
 Saves an object to file using kDat-6 serialization. More...
 
kStatus kShareRef (kObject *object, kObject source)
 Shares an object and sets a handle to refer to the shared object. More...
 
kStatus kStrCat (kChar *dest, kSize capacity, const kChar *src)
 Appends characters from source to destination. More...
 
k32s kStrCompare (const kChar *a, const kChar *b)
 Compares one string to another. More...
 
k32s kStrCompareLower (const kChar *a, const kChar *b)
 Performs a case-insenstive comparison of two strings. More...
 
kStatus kStrCopy (kChar *dest, kSize capacity, const kChar *src)
 Copies characters from source to destination. More...
 
kBool kStrEquals (const kChar *a, const kChar *b)
 Tests a pair of character sequences for equality. More...
 
const kCharkStrFindFirst (const kChar *str, const kChar *subStr)
 Finds the first occurrence of a character sequence. More...
 
const kCharkStrFindLast (const kChar *str, const kChar *subStr)
 Finds the last occurrence of a character sequence. More...
 
kSize kStrLength (const kChar *str)
 Determines the number of kChar units in a characater sequence. More...
 
kStatus kStrPrintf (kChar *dest, kSize capacity, const kChar *format,...)
 Formats a string using printf-style arguments. More...
 
kStatus kStrPrintvf (kChar *dest, kSize capacity, const kChar *format, kVarArgList argList)
 Variable-argument version of kStrPrintf. More...
 
kStatus kStrToLower (kChar *str)
 Converts characters in the given sequence to lower case. More...
 
- Public Member Functions inherited from kObject
kAlloc kObject_Alloc (kObject object)
 Gets the memory allocator associated with this object. More...
 
kStatus kObject_Clone (kObject *object, kObject source, kAlloc allocator)
 Constructs a new object by copying an existing object, including any aggregated child elements. More...
 
kStatus kObject_Destroy (kObject object)
 Destroys the object. More...
 
kStatus kObject_Dispose (kObject object)
 Destroys the object and any aggregated child elements. More...
 
kBool kObject_Equals (kObject object, kObject other)
 Determines whether the object is equal to another object. More...
 
kSize kObject_HashCode (kObject object)
 Gets a hash code representing the state of this object. More...
 
kBool kObject_Is (kObject object, kType type)
 Determines whether this object is an instance of the specified type. More...
 
kBool kObject_IsShared (kObject object)
 Reports whether the object is currently shared (reference count greater than one). More...
 
kStatus kObject_SetPool (kObject object, kObjectPool pool)
 Sets the object pool associated with this object. More...
 
kStatus kObject_Share (kObject object)
 Increments the reference count associated with this object. More...
 
kSize kObject_Size (kObject object)
 Estimates the memory consumed by this object, including any aggregated child elements. More...
 
kType kObject_Type (kObject object)
 Returns the type of the object. More...
 

Additional Inherited Members


The documentation for this class was generated from the following file: