From 2ec6d67c879c64ad6c87d04198dbfce59febbb1e Mon Sep 17 00:00:00 2001 From: Scott Duensing Date: Thu, 6 Sep 2018 00:20:24 +0000 Subject: [PATCH] Update JoeyLib Definitions --- JoeyLib-Definitions.md | 31 ++++++++++++++++++++++++++++++- 1 file changed, 30 insertions(+), 1 deletion(-) diff --git a/JoeyLib-Definitions.md b/JoeyLib-Definitions.md index 9f928c6..330c174 100644 --- a/JoeyLib-Definitions.md +++ b/JoeyLib-Definitions.md @@ -1,3 +1,32 @@ #### JOEY_DEBUG -If defined in `joey.h`, enables several debugging functions. JoeyLib memory management operations will be double-checked and tracked. In addition, after the program exits, JoeyLib will generate a file named `JLSTATS` containing allocation statistics and the contents of `why` that was passed to `jlDie()`. +If defined in `joey.h`, enables several debugging functions. JoeyLib memory management operations will be double-checked and tracked. In addition, after the program exits, JoeyLib will generate a file named `JLSTATS` containing allocation statistics and the contents of `why` that was passed to `jlDie()`. Recommended to use this when bracketing debug code in your apps that use JoeyLib. +#### JOEY_MEM_BLOCKS +In `joey.h` this controls how many concurrent allocations the JoeyLib memory debugging routines will track. If you receive an error about being out of blocks, increase this value. A fixed number of memory block entries is currently used instead of re-implementing the stack code without JoeyLib. + +#### JOEY_BIG_ENDIAN +Defined if the platform the application is running on uses big-endian memory order. + +#### JOEY_LITTLE_ENDIAN +Defined if the platform the application is running on uses little-endian memory order. + +#### JOEY_PC +Defined if the application is running on a PC platform (Windows, Linux, macOS). Embedded and single board computers such as the Raspberry Pi are not considered to be PCs. + +#### JOEY_LINUX +Defined if the application is running on a PC under Linux. + +#### JOEY_MACOS +Defined if the application is running on a PC under macOS. + +#### JOEY_WINDOWS +Defined if the application is running on a PC under Windows. + +#### JOEY_IIGS +Defined if the application is running on an Apple IIgs. + +#### JOEY_AMIGA +Defined if the application is running on a Commodore Amiga. + +#### JOEY_ST +Defined if the application is running on an Atari ST.