X-Git-Url: https://git.stderr.nl/gitweb?a=blobdiff_plain;f=docs%2Freference%2Fblorb-library.sgml;fp=docs%2Freference%2Fblorb-library.sgml;h=c333f022bbc7f31163e7c75412fff9f924bfa092;hb=6478a4f44526dde5ec7b1090d97b2255ed2879a1;hp=0000000000000000000000000000000000000000;hpb=e887e681be593844f5b785cab709d6c5a63f175f;p=rodin%2Fchimara.git diff --git a/docs/reference/blorb-library.sgml b/docs/reference/blorb-library.sgml new file mode 100644 index 0000000..c333f02 --- /dev/null +++ b/docs/reference/blorb-library.sgml @@ -0,0 +1,31 @@ + + + + +What the Library Does +3 +CHIMARA Library + + +What the Library Does +How to implement the Blorb layer in your library + + +Description + +Each library must implement giblorb_set_resource_map(), if it wishes to support Blorb at all. Generally, this function should create a Blorb map and stash it away somewhere. It may also want to stash the stream itself, so that the library can read data directly from it. + + +giblorb_set_resource_map() should return giblorb_err_None (0) if it succeeded, or the appropriate Blorb error code if not. See Blorb Errors. + + +The library must also link in the gi_blorb.c file. Most of this should compile without difficulty on any platform. However, it does need to allocate memory. As supplied, gi_blorb.c calls the ANSI functions malloc(), realloc(), and free(). If this is not appropriate on your OS, feel free to change these calls. They are isolated at the end of the file. + +Chimara + +The Chimara library uses the GLib functions g_malloc(), g_realloc(), and g_free() because of their additional error-checking features. + + +