include/Cnx/BasicTypes.h file

Enums

enum CnxCompare { CNX_LESS_THAN = -1, CNX_EQUAL = 0, CNX_GREATER_THAN = 1 }

Type signifying how a given value compares to another.

Typedefs

using nullptr_t = void*

nullptr_t makes using NULL to represent a null pointer (aka a nullptr) a first-class type of its own

using u8 = uint8_t

u8 is a fixed-width 8 bit unsigned integer

using u16 = uint16_t

u16 is a fixed-width 16 bit unsigned integer

using u32 = uint32_t

u32 is a fixed-width 32 bit unsigned integer

using u64 = uint64_t

u64 is a fixed-width 64 bit unsigned integer

using usize = size_t

usize is the unsigned, platform-dependent type to represent a size

using byte = u8

a byte is an 8 bit unsigned integer

using i8 = int8_t

i8 is a fixed-width 8 bit signed integer

using i16 = int16_t

i16 is a fixed-width 16 bit signed integer

using i32 = int32_t

i32 is a fixed-width 32 bit signed integer

using i64 = int64_t

i64 is a fixed-width 64 bit signed integer

using isize = ssize_t

isize is the platform-dependent type to represent a signed size. It is the signed alternative to usize

using f32 = float

f32 is a 32-bit floating point number

using f64 = double

f64 is a 64-bit floating point number

using CnxCompare = enum CnxCompare

Type signifying how a given value compares to another.

using u8_ptr = u8*

alias for a u8 pointer

using u16_ptr = u16*

alias for a u16 pointer

using u32_ptr = u32*

alias for a u32 pointer

using u64_ptr = u64*

alias for a u64 pointer

using usize_ptr = usize*

alias for a usize pointer

using i8_ptr = i8*

alias for a i8 pointer

using i16_ptr = i16*

alias for a i16 pointer

using i32_ptr = i32*

alias for a i32 pointer

using i64_ptr = i64*

alias for a i64 pointer

using isize_ptr = isize*

alias for a isize pointer

using f32_ptr = f32*

alias for a f32 pointer

using f64_ptr = f64*

alias for a f64 pointer

using const_u8_ptr = const u8*

alias for a const u8 pointer

using const_u16_ptr = const u16*

alias for a const u16 pointer

using const_u32_ptr = const u32*

alias for a const u32 pointer

using const_u64_ptr = const u64*

alias for a const u64 pointer

using const_usize_ptr = const usize*

alias for a const usize pointer

using const_i8_ptr = const i8*

alias for a const i8 pointer

using const_i16_ptr = const i16*

alias for a const i16 pointer

using const_i32_ptr = const i32*

alias for a const i32 pointer

using const_i64_ptr = const i64*

alias for a const i64 pointer

using const_isize_ptr = const isize*

alias for a const isize pointer

using const_f32_ptr = const f32*

alias for a const f32 pointer

using const_f64_ptr = const f64*

alias for a const f64 pointer

using cstring = char*

cstring represents a null-terminated legacy C-style string (aka a char*) and should be preferred when semantically referring to a string instead of char* to differentiate from references to a pointer to single char

using const_cstring = const char*

const_cstring represents a const null-terminated legacy C-style string (aka a const char*) and should be preferred when semantically referring to a string instead of char* to differentiate from references to a pointer to single const char

using wcstring = wchar_t*

wcstring represents a null-terminated legacy C-style wide string (aka a wchar_t*) and should be preferred when semantically referring to a wide string instead of wchar_t* to differentiate from references to a pointer to single wchar_t

using const_wcstring = const wchar_t*

const_wcstring represents a const null-terminated legacy C-style wide string (aka a const wchar_t*) and should be preferred when semantically referring to a wide string instead of const wchar_t* to differentiate from references to a pointer to single const wchar_t

using char_ptr = char*

char_ptr represents a pointer to a single char and should be preferred when referring to a pointer to single char over char* to differentiate from references to a string

using const_char_ptr = const char*

const_char_ptr represents a pointer to a single const char and should be preferred when referring to a pointer to single const char over const char* to differentiate from references to a const string

using wchar_t_ptr = wchar_t*

wchar_t_ptr represents a pointer to a single wchar_t and should be preferred when referring to a pointer to single wchar_t over wchar_t* to differentiate from references to a wide string

using const_wchar_t_ptr = const wchar_t*

const_wchar_t_ptr represents a pointer to a single const wchar_t and should be preferred when referring to a pointer to single const wchar_t over const wchar_t* to differentiate from references to a wide string

using cstring_ptr = char_ptr*

Alias for char_ptr*. This should be preferred wherever possible when semantically referring to a pointer to cstring

using const_cstring_ptr = const char**

Alias for const char_ptr*. This should be preferred wherever possible when semantically referring to a pointer to const cstring

using wcstring_ptr = wchar_t_ptr*

Alias for wchar_t_ptr*. This should be preferred wherever possible when semantically referring to a pointer to wcstring

using const_wcstring_ptr = const wchar_t**

Alias for const wchar_t_ptr*. This should be preferred wherever possible when semantically referring to a pointer to const wcstring

using Ref = char_ptr(char)

Alias for char_ptr used for the inner type of reference-like types (ie iterators)

using ConstRef = const_char_ptr(char)

Alias for const_char_ptr used for the inner type of reference-like types (ie iterators)

using wchar_t_ptr_ref = wchar_t_ptr*

Alias for wchar_t_ptr* used for the inner type of reference-like types (ie iterators). This should be preferred when semantically referring to a reference to a pointer to a single wchar_t

using const_wchar_t_ptr_ref = const wchar_t_ptr*

Alias for const wchar_t_ptr* used for the inner type of reference-like types (ie iterators). This should be preferred when semantically referring to a reference to a const pointer to a single wchar_t

Defines

#define CNX_BASIC_TYPES

Declarations and definitions related to Cnx's builtin types.

#define nullptr

nullptr is a NULL pointer

#define CNX_OFORMAT_U8

u8 decimal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_U16

u16 decimal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_U32

u32 decimal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_U64

u64 decimal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_USIZE

usize decimal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_UMAX

umax decimal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_BYTE

byte decimal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_I8

i8 decimal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_I16

i16 decimal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_I32

i32 decimal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_I64

i64 decimal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_ISIZE

isize decimal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_IMAX

imax decimal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_U8_OCT

u8 octal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_U16_OCT

u16 octal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_U32_OCT

u32 octal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_U64_OCT

u64 octal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_USIZE_OCT

usize octal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_UMAX_OCT

umax octal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_BYTE_OCT

byte octal format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_U8_HEX

u8 lower-case hex format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_U16_HEX

u16 lower-case hex format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_U32_HEX

u32 lower-case hex format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_U64_HEX

u64 lower-case hex format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_USIZE_HEX

usize lower-case hex format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_UMAX_HEX

umax lower-case hex format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_BYTE_HEX

byte lower-case hex format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_U8_HEX_UP

u8 upper-case hex format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_U16_HEX_UP

u16 upper-case hex format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_U32_HEX_UP

u32 upper-case hex format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_U64_HEX_UP

u64 upper-case hex format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_USIZE_HEX_UP

usize upper-case hex format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_UMAX_HEX_UP

umax upper-case hex format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_OFORMAT_BYTE_HEX_UP

byte upper-case hex format specifier for legacy formatted output functions (printf, fprintf, etc)

#define CNX_IFORMAT_U8

u8 decimal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_U16

u16 decimal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_U32

u32 decimal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_U64

u64 decimal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_USIZE

usize decimal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_UMAX

umax decimal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_BYTE

byte decimal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_I8

i8 decimal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_I16

i16 decimal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_I32

i32 decimal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_I64

i64 decimal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_ISIZE

isize decimal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_IMAX

imax decimal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_U8_OCT

u8 octal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_U16_OCT

u16 octal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_U32_OCT

u32 octal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_U64_OCT

u64 octal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_USIZE_OCT

usize octal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_UMAX_OCT

umax octal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_BYTE_OCT

byte octal format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_U8_HEX

u8 lower-case hex format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_U16_HEX

u16 lower-case hex format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_U32_HEX

u32 lower-case hex format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_U64_HEX

u64 lower-case hex format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_USIZE_HEX

usize lower-case hex format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_UMAX_HEX

umax lower-case hex format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_BYTE_HEX

byte lower-case hex format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_U8_HEX_UP

u8 upper-case hex format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_U16_HEX_UP

u16 upper-case hex format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_U32_HEX_UP

u32 upper-case hex format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_U64_HEX_UP

u64 upper-case hex format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_UMAX_HEX_UP

umax upper-case hex format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define CNX_IFORMAT_BYTE_HEX_UP

byte upper-case hex format specifier for legacy formatted input functions (scanf, fscanf, etc)

#define cnx_max_u8

Maximum value of a u8

#define cnx_max_u16

Maximum value of a u16

#define cnx_max_u32

Maximum value of a u32

#define cnx_max_u64

Maximum value of a u64

#define cnx_max_usize

Maximum value of a usize

#define cnx_max_i8

Maximum value of an i8

#define cnx_max_i16

Maximum value of an i16

#define cnx_max_i32

Maximum value of an i32

#define cnx_max_i64

Maximum value of an i64

#define cnx_max_isize

Maximum value of an isize

#define cnx_max_f32

Maximum value of an f32

#define cnx_max_f64

Maximum value of an f64

#define cnx_min_u8

Minimum value of a u8

#define cnx_min_u16

Minimum value of a u16

#define cnx_min_u32

Minimum value of a u32

#define cnx_min_u64

Minimum value of a u64

#define cnx_min_usize

Minimum value of a usize

#define cnx_min_i8

Minimum value of an i8

#define cnx_min_i16

Minimum value of an i16

#define cnx_min_i32

Minimum value of an i32

#define cnx_min_i64

Minimum value of an i64

#define cnx_min_isize

Minimum value of an isize

#define cnx_min_f32

Minimum value of an f32

#define cnx_min_f64

Minimum value of an f64

#define cnx_min_diff_f32

Minimum discernible difference value of an f32

#define cnx_min_diff_f64

Minimum discernible difference value of an f64

#define cnx_max_value(T)

Returns the maximum possible value of the given type.

#define cnx_min_value(T)

Returns the minimum possible value of the given type.

Typedef documentation