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 
63 kFx(kStatus) kReplaceRef(kObject* object, kObject source);
64 
74 kFx(kStatus) kLoad5(kObject* object, const kChar* fileName, kAlloc allocator);
75 
84 kFx(kStatus) kSave5(kObject object, const kChar* fileName);
85 
95 kFx(kStatus) kLoad6(kObject* object, const kChar* fileName, kAlloc allocator);
96 
105 kFx(kStatus) kSave6(kObject object, const kChar* fileName);
106 
117 kFx(kStatus) kMemAlloc(kSize size, void* mem);
118 
129 kFx(kStatus) kMemAllocZero(kSize size, void* mem);
130 
138 kFx(kStatus) kMemFree(void* mem);
139 
147 kFx(kStatus) kMemFreeRef(void* mem);
148 
158 kFx(kStatus) kMemSet(void* dest, kByte fill, kSize size);
159 
169 kFx(kStatus) kMemCopy(void* dest, const void* src, kSize size);
170 
180 kFx(kStatus) kMemMove(void* dest, const void* src, kSize size);
181 
191 kFx(kBool) kMemEquals(const void* a, const void* b, kSize size);
192 
207 kFx(kStatus) kStrCopy(kChar* dest, kSize capacity, const kChar* src);
208 
223 kFx(kStatus) kStrCat(kChar* dest, kSize capacity, const kChar* src);
224 
234 kFx(kStatus) kStrToLower(kChar* str);
235 
244 kFx(kBool) kStrEquals(const kChar* a, const kChar* b);
245 
259 kFx(k32s) kStrCompare(const kChar* a, const kChar* b);
260 
271 kFx(k32s) kStrCompareLower(const kChar* a, const kChar* b);
272 
280 kFx(kSize) kStrLength(const kChar* str);
281 
290 kFx(const kChar*) kStrFindFirst(const kChar* str, const kChar* subStr);
291 
300 kFx(const kChar*) kStrFindLast(const kChar* str, const kChar* subStr);
301 
316 kFx(kStatus) kStrPrintf(kChar* dest, kSize capacity, const kChar* format, ...);
317 
329 kFx(kStatus) kStrPrintvf(kChar* dest, kSize capacity, const kChar* format, kVarArgList argList);
330 
339 kFx(kStatus) kLogf(const kChar* format, ...);
340 
350 kFx(kStatus) kLogvf(const kChar* format, kVarArgList argList);
351 
358 kFx(k32u) kRandom32u();
359 
366 kFx(k64u) kRandom64u();
367 
374 kFx(kSize) kRandomSize();
375 
383 kFx(kChar) kChar_ToLower(kChar ch);
384 
392 kFx(kChar) kChar_ToUpper(kChar ch);
393 
401 kFx(kBool) kChar_IsSpace(kChar ch);
402 
410 kFx(kBool) kChar_IsLetter(kChar ch);
411 
419 kFx(kBool) kChar_IsDigit(kChar ch);
420 
421 #define kChar_ToLower_(IN) kxChar_ToLower_(IN)
422 #define kChar_ToUpper_(IN) kxChar_ToUpper_(IN)
423 
424 kEndHeader()
425 
426 #include <kApi/Utils/kUtils.x.h>
427 
428 #endif
kSize kStrLength(const kChar *str)
Determines the number of kChar units in a characater sequence.
Represents a 32-bit unsigned integer.
kChar kChar_ToUpper(kChar ch)
Convert ASCII character to upper case.
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.
kBool kChar_IsLetter(kChar ch)
Checks whether ASCII character is a letter.
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.
kChar kChar_ToLower(kChar ch)
Convert ASCII character to lower case.
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.
kBool kChar_IsSpace(kChar ch)
Checks whether ASCII character is a some kind of white space character type.
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.
kBool kChar_IsDigit(kChar ch)
Checks whether ASCII character is a digit.
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 kReplaceRef(kObject *object, kObject source)
Replaces a reference to existing object with a new object.
kStatus kMemSet(void *dest, kByte fill, kSize size)
Sets a block of memory to the given byte value.