KFoundation  v2.1
A Better Foundation Library for C++
 All Classes Functions Variables Typedefs Enumerations Enumerator Groups Pages
Classes | Macros | Typedefs | Enumerations
Macros and Typedefs

Classes

struct  kfoundation::kf_uref_t
 Unique Entry Reference. More...
 

Macros

#define KF_LINUX
 is defined if the target platform is linux.
 
#define KF_SUPPORTED
 is defined when the target platform is supported.
 
#define KF_MAC
 is defined when the target platform is Mac OS.
 
#define KF_MACH
 is defined when the target platform is based on Mach kernel.
 
#define KF_SOLARIS
 is defined when the target platform is Solaris.
 
#define KF_FREE_BSD
 is defined when the target platform is FreeBSD.
 
#define NOT_NULL(X)   (X)
 Tests if the argument is not null. More...
 
#define IS_NULL(X)   !(X)
 Tests if the argument is null. More...
 
#define KF_EXPORT   __attribute__((visibility("default")))
 Used to mark exported symbols. More...
 
#define KF_NOP   while(false){}
 Used for consuming semicolon in other macros. More...
 

Typedefs

typedef unsigned char kfoundation::kf_octet_t
 8-bit unsigned numeric type.
 
typedef char kfoundation::kf_int8_t
 8-bit signed numeric type.
 
typedef short int kfoundation::kf_int16_t
 16-bit signed numeric type.
 
typedef int kfoundation::kf_int32_t
 32-bit signed numeric type.
 
typedef long int kfoundation::kf_int64_t
 64-bit signed numeric type.
 

Enumerations

enum  kfoundation::kf_comparison_t { kfoundation::SMALLER = -1, kfoundation::EQUAL = 0, kfoundation::GREATER = 1 }
 Encodes the comparison result between two values. More...
 
enum  kfoundation::kf_onoff_t { , kfoundation::OFF = false }
 Alternative to boolean values, used for better code readability. More...
 

Detailed Description

Macro Definition Documentation

#define IS_NULL (   X)    !(X)

Tests if the argument is null.

Recommended to be used to improve code readability.

#define KF_EXPORT   __attribute__((visibility("default")))

Used to mark exported symbols.

Recommended to be used in place of compiler-specific method.

#define KF_NOP   while(false){}

Used for consuming semicolon in other macros.

Performs no operation.

#define NOT_NULL (   X)    (X)

Tests if the argument is not null.

Recommended to be used to improve code readability.

Enumeration Type Documentation

Encodes the comparison result between two values.

Enumerator
SMALLER 

Smaller.

EQUAL 

Eqla.

GREATER 

Greater.

Alternative to boolean values, used for better code readability.

Enumerator
OFF 

Equals true.