judah/jc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add Memory Management section to STYLEGUIDE

Browse source
This commit is contained in:
Judah Caruso 2025-05-27 00:52:43 -06:00
parent bcaa847501
commit b06efe88a2
1 changed files with 30 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
STYLEGUIDE
View file

@ -130,21 +130,23 @@ When authoring a new module, use this as a base plate:
} }
Bindings Memory Management
-------- -----------------
Binding modules should default to static linking and take If a custom type needs memory to function, it should
an optional '#module_parameter' to link dynamically. always assume the memory it requested came from an arena
Libraries should be pinned to a specific version, and all allocator. This means it is the responsibility of the
binaries (.dll, .dylib, etc.) *must* be checked into arena to free the memory, not the custom data type.
source control. If possible, use the release build of the
library that includes debug information.
Bindings should stay as close as possible to the original In other words:
library. To jai-ify the bindings, create a submodule
called 'wrapper' that import and wraps the api.
See: 'thirdparty/raylib' for example bindings. Do *not* add procedures that 'free' or 'delete' the memory
allocated by the data type.
Instead, add procedures that 'reset' the data type,
allowing the already allocated memory to be reused. For
examples, see the 'reset' procedures in 'jc/kv'
or 'jc/array'.
OS-Specific Code OS-Specific Code
@ -177,3 +179,19 @@ When writing code for a specific architecture, use
the 'jc/arch' module. NEVER create a new file unless the 'jc/arch' module. NEVER create a new file unless
absolutely needed. absolutely needed.
Bindings
--------
Binding modules should default to static linking and take
an optional '#module_parameter' to link dynamically.
Libraries should be pinned to a specific version, and all
binaries (.dll, .dylib, etc.) *must* be checked into
source control. If possible, use the release build of the
library that includes debug information.
Bindings should stay as close as possible to the original
library. To jai-ify the bindings, create a submodule
called 'wrapper' that import and wraps the api.
See: 'thirdparty/raylib' for example bindings.