micro library via copying and pasting into one source file?

[mofosyne]

I noticed that we have lots of single function clibs.

Seems a bit overkill in some case to include all of the functions in individual folders...

I'm wondering if it makes sense to have a mode where you would have something like microlib.clib.h where installing a package would copy and paste it into one single .c and .h file

or perhaps copy and paste a specially marked up section into a source file? This would be useful for single file programs.

For this to work you may need:

• Code style independent checksum, so you can check if the micro function or macros were modified or not (after stripping out all the comments). You could try adapt this source scanner for this purpose
  • This will make the code section robust against being seen as tampered with, if it's only just clang-format changes.
  • Use something like xxHash as the purpose is just to alert if the code was unintentionally modified.
• A markup to indicate the start and end of a micro lib section.

E.g.

#include <stdio.h>

/* start of clib micro library */
/* Bound And Clamp (clib micropackage)
 * package=mofosyne/bound_and_clamp.c version=0.1.0 checksum=70bb9e41 */
#define is_above_bound(value, max) ((value) > (max))
#define is_below_bound(value, min) ((value) < (min))
#define is_within_bound(value, min, max) ((value) >= (min) && (value) <= (max))
#define is_out_of_bound(value, min, max) ((value) < (min) || (value) > (max))
#define clamp_upper(value, max) ((value) < (max) ? (value) : (max))
#define clamp_lower(value, min) ((value) > (min) ? (value) : (min))
#define clamp_range(value, min, max) clamp_lower(min, clamp_upper(value, max))
/* end of clib micro library */

int main(void)
{
    printf("clamp_upper(3, 5)=%2d\n", clamp_upper(3, 5));
}

Not sure I like the syntax, but you get the idea (Maybe use preprocessor ifdef / endif as sections?)

One possible way to skip the need for 'start' and 'end' marker is if we include the number of C tokens and hash...

#include <stdio.h>

/* Bound And Clamp (clib micropackage)
 * package=mofosyne/bound_and_clamp.c version=0.1.0 
 * checksum=70bb9e41 charcount=478 */
#define is_above_bound(value, max) ((value) > (max))
#define is_below_bound(value, min) ((value) < (min))
#define is_within_bound(value, min, max) ((value) >= (min) && (value) <= (max))
#define is_out_of_bound(value, min, max) ((value) < (min) || (value) > (max))
#define clamp_upper(value, max) ((value) < (max) ? (value) : (max))
#define clamp_lower(value, min) ((value) > (min) ? (value) : (min))
#define clamp_range(value, min, max) clamp_lower(min, clamp_upper(value, max))

int main(void)
{
    printf("clamp_upper(3, 5)=%2d\n", clamp_upper(3, 5));
}

only issue is that the section won't be recognized if anyone tampered with it

[jwerle]

it is pretty easy to create an umbrella or an amalgamated package simply with clib.json and a wrapping API

[mofosyne]

Oh is that so? Is this documented anywhere I can read at least? Especially this wrapping API thing? Not sure what you mean by that.

Also what would clib.json have in this context? A copy of the source code baked in?

[stephenmathieson]

Since clib.json lists all source files (clib.json#src: [ ... ]), one could pretty easily write a program which creates an amalgamated build.

A great example of an amalgamated build is sophia. Its build script shows how we could accomplish this.