Zen API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kUtils.h
Go to the documentation of this file.
1 
10 #include <kApi/kApiDef.h> //--inclusion order controlled by kApiDef
11 
12 #ifndef K_API_UTILS_H
13 #define K_API_UTILS_H
14 
15 kBeginHeader()
16 
17 
31 kFx(kStatus) kDestroyRef(kObject* object);
32 
40 kFx(kStatus) kDisposeRef(kObject* object);
41 
50 kFx(kStatus) kShareRef(kObject* object, kObject source);
51 
61 kFx(kStatus) kLoad5(kObject* object, const kChar* fileName, kAlloc allocator);
62 
71 kFx(kStatus) kSave5(kObject object, const kChar* fileName);
72 
82 kFx(kStatus) kLoad6(kObject* object, const kChar* fileName, kAlloc allocator);
83 
92 kFx(kStatus) kSave6(kObject object, const kChar* fileName);
93 
104 kFx(kStatus) kMemAlloc(kSize size, void* mem);
105 
116 kFx(kStatus) kMemAllocZero(kSize size, void* mem);
117 
125 kFx(kStatus) kMemFree(void* mem);
126 
134 kFx(kStatus) kMemFreeRef(void* mem);
135 
145 kFx(kStatus) kMemSet(void* dest, kByte fill, kSize size);
146 
156 kFx(kStatus) kMemCopy(void* dest, const void* src, kSize size);
157 
167 kFx(kStatus) kMemMove(void* dest, const void* src, kSize size);
168 
178 kFx(kBool) kMemEquals(const void* a, const void* b, kSize size);
179 
194 kFx(kStatus) kStrCopy(kChar* dest, kSize capacity, const kChar* src);
195 
210 kFx(kStatus) kStrCat(kChar* dest, kSize capacity, const kChar* src);
211 
221 kFx(kStatus) kStrToLower(kChar* str);
222 
231 kFx(kBool) kStrEquals(const kChar* a, const kChar* b);
232 
246 kFx(k32s) kStrCompare(const kChar* a, const kChar* b);
247 
258 kFx(k32s) kStrCompareLower(const kChar* a, const kChar* b);
259 
267 kFx(kSize) kStrLength(const kChar* str);
268 
277 kFx(const kChar*) kStrFindFirst(const kChar* str, const kChar* subStr);
278 
287 kFx(const kChar*) kStrFindLast(const kChar* str, const kChar* subStr);
288 
303 kFx(kStatus) kStrPrintf(kChar* dest, kSize capacity, const kChar* format, ...);
304 
316 kFx(kStatus) kStrPrintvf(kChar* dest, kSize capacity, const kChar* format, kVarArgList argList);
317 
326 kFx(kStatus) kLogf(const kChar* format, ...);
327 
337 kFx(kStatus) kLogvf(const kChar* format, kVarArgList argList);
338 
345 kFx(k32u) kRandom32u();
346 
353 kFx(k64u) kRandom64u();
354 
361 kFx(kSize) kRandomSize();
362 
363 kEndHeader()
364 
365 #include <kApi/Utils/kUtils.x.h>
366 
367 #endif
kSize kStrLength(const kChar *str)
Determines the number of kChar units in a characater sequence.
Represents a 32-bit unsigned integer.
kStatus kStrPrintvf(kChar *dest, kSize capacity, const kChar *format, kVarArgList argList)
Variable-argument version of kStrPrintf.
kStatus kMemFree(void *mem)
Frees a block of memory that was allocated using kMemAlloc or kMemAllocZero.
Represents a 64-bit unsigned integer.
kStatus kLoad5(kObject *object, const kChar *fileName, kAlloc allocator)
Loads an object from file using kDat-5 serialization.
kStatus kStrCat(kChar *dest, kSize capacity, const kChar *src)
Appends characters from source to destination.
kStatus kMemMove(void *dest, const void *src, kSize size)
Copies memory from a source buffer to a potentially-overlapping destination.
k32s kStrCompareLower(const kChar *a, const kChar *b)
Performs a case-insenstive comparison of two strings.
kStatus kLogvf(const kChar *format, kVarArgList argList)
Variable-argument version of kLogf.
const kChar * kStrFindLast(const kChar *str, const kChar *subStr)
Finds the last occurrence of a character sequence.
kBool kStrEquals(const kChar *a, const kChar *b)
Tests a pair of character sequences for equality.
kStatus kSave5(kObject object, const kChar *fileName)
Saves an object to file using kDat-5 serialization.
Represents an unsigned integer that can store a pointer address.
Abstract base class for memory allocator types.
kStatus kMemAlloc(kSize size, void *mem)
Allocates a block of memory from the application heap.
kStatus kShareRef(kObject *object, kObject source)
Shares an object and sets a handle to refer to the shared object.
k32s kStrCompare(const kChar *a, const kChar *b)
Compares one string to another.
kStatus kStrToLower(kChar *str)
Converts characters in the given sequence to lower case.
kBool kMemEquals(const void *a, const void *b, kSize size)
Compares one memory buffer with another.
kStatus kMemCopy(void *dest, const void *src, kSize size)
Copies memory from a source buffer to a non-overlapping destination.
Represents a single unit (byte) in a UTF-8 character.
Represents a byte on the current platform.
kStatus kDisposeRef(kObject *object)
Disposes an object and resets the object handle to kNULL.
kStatus kMemFreeRef(void *mem)
Frees a block of memory that was allocated using kMemAlloc or kMemAllocZero and resets the memory poi...
k32u kRandom32u()
Generates a random 32-bit number.
kStatus kDestroyRef(kObject *object)
Destroys an object and resets the object handle to kNULL.
kStatus kLogf(const kChar *format,...)
Writes to logging handler (if registered).
kStatus kSave6(kObject object, const kChar *fileName)
Saves an object to file using kDat-6 serialization.
kStatus kLoad6(kObject *object, const kChar *fileName, kAlloc allocator)
Loads an object from file using kDat-6 serialization.
kStatus kMemAllocZero(kSize size, void *mem)
Allocates and zero-initializes block of memory from the application heap.
Core Zen type declarations.
Represents a 32-bit signed integer.
k64u kRandom64u()
Generates a random 64-bit number.
kStatus kStrPrintf(kChar *dest, kSize capacity, const kChar *format,...)
Formats a string using printf-style arguments.
kStatus kStrCopy(kChar *dest, kSize capacity, const kChar *src)
Copies characters from source to destination.
kSize kRandomSize()
Generates a random number of type kSize.
Root of all Zen classes.
Represents an error code.
const kChar * kStrFindFirst(const kChar *str, const kChar *subStr)
Finds the first occurrence of a character sequence.
Represents a boolean value.
kStatus kMemSet(void *dest, kByte fill, kSize size)
Sets a block of memory to the given byte value.