Name 

Description 

containers 

This type stores data, it has a self-contained length in bytes of the data stored. 

filesys 

This is namespace sack::filesys. 

image 

This is namespace sack::image. 

logging 

This is namespace sack::logging. 

math 

Namespace for integer fraction math library. Only very basic operations supported. 

memory 

This is namespace sack::memory. 

timers 

This is namespace sack::timers. 

Name 

Description 

Functions 

The following table lists functions in this documentation. 

Types 

The following table lists types in this documentation. 

Macros 

The following table lists macros in this documentation. 

 

Name 

Description 

 

BAG_Exit 

Define a routine to call for exit(). This triggers specific code to handle shutdown event registration 

 

is_deadstart_complete 

This is function sack::is_deadstart_complete. 

Name 

Description 

_32f 

32 bit unsigned decimal output printf format specifier. This would otherwise be defined in <inttypes.h> 

_32fs 

64 bit signed decimal output printf format specifier. This would otherwise be defined in <inttypes.h> 

_32fx 

32 bit hex output printf format specifier. This would otherwise be defined in <inttypes.h> 

_32fX 

32 bit HEX output printf format specifier. This would otherwise be defined in <inttypes.h> 

_64f 

defined( _MSC_VER ) 64 bit unsigned decimal output printf format specifier. This would otherwise be defined in <inttypes.h> as PRIu64 

_64fs 

64 bit signed decimal output printf format specifier. This would otherwise be defined in <inttypes.h> as PRIdFAST64 

_64fx 

64 bit hex output printf format specifier. This would otherwise be defined in <inttypes.h> as PRIxFAST64 

_64fX 

64 bit HEX output printf format specifier. This would otherwise be defined in <inttypes.h> as PRIxFAST64 

_cWIDE 

Modified WIDE wrapper that actually forces non-unicode string. 

_WIDE 

This is macro sack::_WIDE. 

_WIDE__FILE__ 

This is macro sack::_WIDE__FILE__. 

c_32f 

format string for output _32 as unsigned decimal. Size changes by platform. Non unicode. 

c_32fs 

format string for output _32 as unsigned decimal. Size changes by platform. Non unicode. 

c_32fx 

format string for output _32 as unsigned hex. Size changes by platform. Non unicode. 

c_32fX 

format string for output _32 as unsigned HEX. Size changes by platform. Non unicode. 

cPTRSZVALfs 

format string for output PTRSZVAL as unsigned hex. Size changes by platform. Non unicode. 

cPTRSZVALfx 

format string for output PTRSZVAL as unsigned hex. Size changes by platform. Non unicode. 

cWIDE 

This is macro sack::cWIDE. 

DBG_AVAILABLE 

in NDEBUG mode, pass nothing 

DBG_FILELINEFMT 

in NDEBUG mode, pass nothing 

DBG_PASS 

in NDEBUG mode, pass nothing.

This function allows specification of DBG_RELAY or DBG_SRC under debug compilation. Otherwise, the simple AddLink macro should be used. DBG_RELAY can be used to forward file and line information which has been passed via DBG_PASS declaration in the function parameters.

This is a part of a set of macros which allow additional logging information to be passed.

These 3 are the most commonly used.

DBG_SRC - this passes the current __FILE__, __LINE__ parameters.
DBG_PASS - this is used on a function declaration, is a filename and line number from DBG_SRC or DBG_RELAY.
DBG_RELAY -... more 

DBG_RELAY 

in NDEBUG mode, pass nothing 

DBG_SRC 

in NDEBUG mode, pass nothing 

DBG_VARSRC 

This is macro sack::DBG_VARSRC. 

DBG_VOIDPASS 

This is macro sack::DBG_VOIDPASS. 

DBG_VOIDRELAY 

in NDEBUG mode, pass nothing 

DBG_VOIDSRC 

#define DBG_LEADSRC in NDEBUG mode, declare (void) 

DeclareLink 

#error blah general macros for linking lists using 

exit 

This is macro sack::exit. 

FALSE 

typedef enum { FALSE, TRUE } LOGICAL; // smallest information 

FILELINE 

a constant text string that represents the current source filename and line... fourmated as "source.c(11) :" 

FILELINE_FILELINEFMT 

specify a consistant macro to format file and line information for printf formated strings. 

FILELINE_PASS 

#define FILELINE_LEADPASS CTEXTSTR pFile, _32 nLine, specify a consistant macro to define file and line parameters. This are appended parameters, and common usage is to only use these with _DEBUG set. 

FILELINE_RELAY 

specify a consistant macro to forward file and line parameters. This are appended parameters, and common usage is to only use these with _DEBUG set. 

FILELINE_SRC 

specify a consistant macro to pass current file and line information. This are appended parameters, and common usage is to only use these with _DEBUG set. 

FILELINE_VARSRC 

#define FILELINE_NULL , NULL, 0 #define FILELINE_VOIDNULL NULL, 0 define static parameters which are the declaration's current file and line, for stubbing in where debugging is being stripped. usage FILELINE_VARSRC: // declare pFile and nLine variables. 

FILELINE_VOIDPASS 

#define FILELINE_LEADSRC (CTEXTSTR)_WIDE(__FILE__), __LINE__, specify a consistant macro to define file and line parameters, to functions with otherwise void param lists. This are appended parameters, and common usage is to only use these with _DEBUG set. 

FILELINE_VOIDRELAY 

specify a consistant macro to forward file and line parameters, to functions which have void parameter lists without this information. This are appended parameters, and common usage is to only use these with _DEBUG set. 

FILELINE_VOIDSRC 

specify a consistant macro to pass current file and line information, to functions which void param lists. This are appended parameters, and common usage is to only use these with _DEBUG set. 

FLAGROUND 

how many bits to add to make sure we round to the next greater index if even 1 bit overflows 

FLAGSET 

declare a set of flags... 

FLAGSETSIZE 

how big the flag set is in count of FLAGSETTYPEs required in a row ( size of the array of FLAGSETTYPE that contains n bits) 

FLAGSETTYPE 

the default type to use for flag sets - flag sets are arrays of bits which can be toggled on and off by an index. 

FLAGTYPE_INDEX 

the index of the FLAGSETTYPE which contains the bit in question 

FLAGTYPEBITS 

the number of bits a specific type is. 

GETMASK 

get the value of a field 

GetMyThreadID 

This is macro sack::GetMyThreadID. 

GetMyThreadIDNL 

This is macro sack::GetMyThreadIDNL. 

GETPID_RETURNS_PPID 

this is now always the case it's a safer solution anyhow... 

GrabThing 

this has two expressions duplicated... but in being so safe in this expression, the self-circular link needs to be duplicated. GrabThing is used for nodes which are circularly bound 

INVALID_INDEX 

An index which is not valid; equates to 0xFFFFFFFFUL or negative one cast as an INDEX... ((INDEX)-1). 

LinkLast 

Link a node to the end of a list. Link thing inserts the new node as the new head of the list. 

LinkThing 

Link a new node into the list. 

LinkThingAfter 

put 'Thing' after 'node 

LinkThingBefore 

put 'Thing' before 'node'... so (*node->me) = thing 

MASK_MASK 

the mast in the dword shifted to the left to overlap the field in the word 

MASK_MASK_VAL 

masks value with the mask size, then applies that mask back to the correct word indexing 

MASK_MAX_LENGTH 

32 bits max for range on mask 

MASK_MAX_ROUND 

define MAX_MAX_ROUND factor based on MASKSET_READTYPE - how to read it... 

MASK_MAX_TYPEBITS 

the maximum number of bits storable in a type 

MASK_TOP_MASK 

the mask in the dword resulting from shift-right. (gets a mask of X bits in length) 

MASK_TOP_MASK_VAL 

declare a set of flags... 

MASKROUND 

round up to the next count of types that fits 1 bit - used as a cieling round factor 

MASKSET 

declare a mask set. 

MASKSET_READTYPE 

gives a 32 bit mask possible from flagset.. 

MASKSETSIZE 

The number of bytes the set would be. 

MASKSETTYPE 

gives byte index... 

MASKTYPE_INDEX 

byte index of the start of the mask 

MASKTYPEBITS 

how many bits the type specified can hold 

NextLink 

Go to the next node with links declared by DeclareLink 

NextThing 

everything else is called a thing... should probably migrate to using this... 

pragnote 

try and define a way to emit comipler messages... but like no compilers support standard ways to do this accross the board. 

pragnoteonly 

try and define a way to emit comipler messages... but like no compilers support standard ways to do this accross the board. 

PTRSZVALf 

This is macro sack::PTRSZVALf. 

PTRSZVALfs 

format string for output PTRSZVAL as unsigned decimal. Size changes by platform. 

PTRSZVALfx 

format string for output PTRSZVAL as unsigned hex. Size changes by platform. 

RelinkThing 

This is macro sack::RelinkThing. 

RESETFLAG 

clear a single flag index 

SETFLAG 

set a single flag index 

SETMASK 

set a field index to a value 

STRSYM 

This is macro sack::STRSYM. 

TESTFLAG 

test if a flags is set 

TOCHR 

This is macro sack::TOCHR. 

TOGGLEFLAG 

reverse a flag from 1 to 0 and vice versa 

TOSTR 

This is macro sack::TOSTR. 

TRUE 

Define TRUE when not previously defined in the platform. TRUE is (!FALSE) so anything not 0 is true. 

UnlinkThing 

Remove a node from a list. Requires only the node. 

WIDE 

This is macro sack::WIDE. 

WIDE__FILE__ 

This is macro sack::WIDE__FILE__. 

Name 

Description 

_16 

Would be otherwise defined in stdint.h as uint16_t 

_64 

have to do this on a per structure basis - otherwise any included headers with structures to use will get FUCKED 

_8 

portability type for porting legacy 16 bit applications. Would be otherwise defined in stdint.h as uint16_t 

BIT_FIELD 

#endif
 

• several compilers are rather picky about the types of data
• used for bit field declaration, therefore this type
• should be used instead of _32

 

CPOINTER 

This is a pointer to constant data. void const *. Compatible with things like char const *. 

CTEXTSTR 

constant text string content 

INDEX 

an unsigned type meant to index arrays. (By convention, arrays are not indexed negatively.) An index which is not valid is INVALID_INDEX, which equates to 0xFFFFFFFFUL or negative one cast as an INDEX... ((INDEX)-1). 

LOGICAL 

Meant to hold boolean and only boolean values. Should be implemented per-platform as appropriate for the bool type the compiler provides. 

P_0 

cannot declare _0 since that overloads the vector library definition for origin (0,0,0,0,...) typedef void _0; // totally unusable to declare 0 size things.
#ifdef __NO_WIN32API__ #define P_0 void* #ifdef __cplusplus_cli // long is 32, int is 64 #define _32 unsigned long #else #define _32 unsigned int #endif #define _8 unsigned char #define P_8 _8 * #define _16 unsigned short #define P_16 _16 * #define P_32 _32 * #define PC_32 const _32 * #define S_8 signed char #define PS_8 S_8 * #define S_16 signed short #define PS_16 S_16 * #define S_32 signed long #define PS_32 S_32 * #define X_8 char... more 

P_16 

Would be otherwise defined in stdint.h as uint16_t 

P_32 

An pointer to an unsigned integer type that is 32 bits long. 

P_64 

A pointer to an unsigned integer type that is 64 bits long. 

P_8 

Would be otherwise defined in stdint.h as uint8_t 

PC_32 

An pointer to a constant unsigned integer type that is 32 bits long. 

PCTEXTSTR 

char const *const 

pid_t 

This is type sack::pid_t. 

POINTER 

This is a pointer. It is a void*. It is meant to point to a single thing, and cannot be used to reference arrays of bytes without recasting. 

PS_16 

An pointer to a signed integer type that is 16 bits long. 

PS_32 

A pointer to a signed integer type that is 32 bits long. 

PS_64 

A pointer to a signed integer type that is 64 bits long. 

PS_8 

An pointer to a signed integer type that is 8 bits long. 

PTRSIZEVAL 

see PTRSZVAL this just has more letters. 

PTRSZVAL 

This is an unsigned integer type that has the same length as a pointer, so that simple byte offset calculations can be performed against an integer. non-standard compiler extensions allow void* to be added with an index and increase in bytes, but void itself is of 0 size, so anything times 0 should be 0, and no offset should apply. So translation of pointers to integer types allows greater flexibility without relying on compiler features which may not exist. 

PV_32 

An pointer to a volatile unsigned integer type that is 32 bits long. 

PV_64 

An pointer to a volatile unsigned integer type that is 64 bits long. 

PVPTRSZVAL 

An pointer to a volatile pointer size type that is as long as a pointer. 

PX_16 

This is a pointer to wchar_t. A 16 bit value that is character data, and is not signed or unsigned. 

PX_8 

A pointer to character type, it is not signed or unsigned. 

S_16 

A signed integer type that is 16 bits long. 

S_32 

A signed integer type that is 32 bits long. 

S_64 

A signed integer type that is 64 bits long. 

S_8 

A signed integer type that is 8 bits long. 

TEXTCHAR 

a text 8 bit character 

TEXTSTR 

A non constant array of TEXTCHAR. A pointer to TEXTCHAR. A pointer to non-constant characters. (A non-static string probably) 

THREAD_ID 

This should be for several years a sufficiently large type to represent threads and processes. 

X_16 

may consider changing this to P_16 for unicode... 

X_8 

A character type, it is not signed or unsigned.