@@ -1,6 +1,6 @@ # kcore -**kcore** is the foundation for the rest of libk. it defines types and structs that are needed by every program, and provides the stub that launches a program's "entry" function. +**kcore** is the foundation for the rest of libk. it defines types and structs that are needed by every program, and provides the stub that launches a program's "entry" function. unlike the non-core modules, kcore definitions simply use the prefix `k-`. ## entry when using libk, your program's entry point will not be the `int main(int,char**)` function that libc opens into. libk will call the function `stat entry(kenv)` instead. like libc, the value returned by `entry` will be returned to the host platform. @@ -31,4 +31,35 @@ `kvar` is a struct that abstracts over platform environment variables. * `kstr name` - the name of an environment variable * `kstr val` - the value of an environment variable * `char* platform` - a pointer into the platform's underlying representation + +## functions + +### kstop() + +`noreturn void kstop(stat)` terminates the program immediately, returning the specified integer to the OS as an exit status. the type of integer it takes depends on your operating system. consider using the `enum kbad` defines in ``, which are designed to standardize exit statuses across different software and are synchronized with a FreeBSD effort to do the same (`` and ``. since libk is designed for new, modern code, breaking old code isn't a concern, and we turn on all these new keywords as soon as you load ``. + +libk attempts to find the best possible definition and implementation for these various types and keywords, abstracting across different C versions and dialects. you can go ahead and use the normal version of the keywords (e.g. `noreturn`, `bool`) no matter what kind of compiler you're using and you're guaranteed that as long as you don't go fiddling with undefined- or implementation behavior, your code will behave the same every time. at worst, it may lack a few optimizations or warnings. + +(the one minor exception is `null`, a new keyword which libk uses in preference to the ugly, hard-to-type C macro `NULL`.) + +`bool` is implemented as a `_Bool` typedef if `_Bool` is available, and as an enum typedef otherwise. either way, and regardless of whether `KFclean` has been defined, booleans can be used and set to the values `true`, `false`, `yes`, or `no`. `yes` and `true` are synonyms, as are `false` and `no`. + +### macros + +if the flag `KFclean` has not been defined, kcore defines a number of macros to abstract over nonstandard C features. for instance, the `KA*` macros can be used to specify GNU/clang attributes without worrying about compatibility, as they'll automatically be blanked under an incompatible compiler. the KA series includes: + + * `KApure` - marks a "pure" function that changes no state and only takes purely numeric arguments, allowing the compiler to avoid repetetive calls to it or even evaluate it at runtime. + * `KAnoreturn` - the GNU/clang-specific version of `noreturn`. + * `KAunused` - acknowledges that a variable is unused and tells the compiler to shut up about it. + * `KAinline` - forces the compiler to inline a function whether it likes it or not. + * `KAflatten` - placed on a function, will force-inline all function calls *made by* that function — sort of like `KAinline` in reverse. + * `KAformat()` - specifies that the function has printf-style syntax for error-checking purposes. worst hack in history. + +if you wish to add more (there are like, hundreds) please consider making a merge request. however, the generic macro KA() is also available in the interim: `KA(unused)`. + +however, unlike C++ attributes, GNU-style attributes can only be placed on a function declaration, *not* its definition.