Docs + fix FIO_FIOBJ miss-inclusion when using single header

facil-io · Oct 22, 2023 · 0d010a9 · 0d010a9
1 parent 2a87e68
commit 0d010a9
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 26 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,11 @@
-# facil.io 0.8.x for C - now with an integrated C STL
-
-## The Web microFramework and Server Toolbox library for C
+# facil.io 0.8.x for C - The C Server Toolbox Library (C STL)
 
 [![POSIX C/C++ CI](https://github.com/facil-io/cstl/actions/workflows/c-cpp.yml/badge.svg)](https://github.com/facil-io/cstl/actions/workflows/c-cpp.yml) [![Windows C/C++ CI](https://github.com/facil-io/cstl/actions/workflows/windows.yml/badge.svg)](https://github.com/facil-io/cstl/actions/workflows/windows.yml)
 
+> **The [facil.io](http://facil.io) C STL aims to provide C developers with easy-to-use tools to write memory safe and performant programs**.
+
+## The C Server Toolbox Library Powers a Web microFramework
+
 The [facil.io library](https://facil.io) is much more than a Web Application Framework and includes core tools and type templates that any C (and C++) project will find useful.
 
 In addition to useful helpers, [facil.io](https://facil.io) allows developers to use MACROS to generate code for different common types, such as Hash Maps, Arrays, Binary-Safe Strings, etc'.
@@ -49,7 +51,7 @@ There are a number of examples in the [./examples](examples) folder, including:
 
 ### Examples for authoring network applications:
 
-* [An HTTP Echo and WebSockets/SSE Chat Server with static file service](examples/server.c).
+* [Mix an HTTP/1.1 Server to serve data with a WebSockets/SSE Chat Server](examples/server.c).
 * [A simple network client example](examples/client.c).
 * [Pub/Sub based text Chat server](examples/chat.c).
 

diff --git a/fio-stl.h b/fio-stl.h
@@ -2133,21 +2133,19 @@ Everything Inclusion
 #define FIO_SOCK
 #define FIO_STATE
 #define FIO_THREADS
-#elif !defined(H___FIO_EVERYTHING2___H)
-#define H___FIO_EVERYTHING2___H
+
+#else
+#undef H___FIO_EVERYTHING1___H
+#undef FIO_EVERYTHING
+#define H___FIO_EVERYTHING___H
 #define FIO_FIOBJ
 #define FIO_HTTP
 #define FIO_MALLOC
 #define FIO_MUSTACHE
 #define FIO_PUBSUB
 #define FIO_SERVER
-#else
-#define H___FIO_EVERYTHING___H
-#undef H___FIO_EVERYTHING1___H
-#undef H___FIO_EVERYTHING2___H
-#undef FIO_EVERYTHING
-#undef FIO_MEMALT
 #define FIO_MEMALT
+
 #endif
 
 #define FIO___INCLUDE_AGAIN
@@ -2174,11 +2172,13 @@ Basics Inclusion
 #define FIO_CRYPT
 #define FIO_STATE
 #define FIO_THREADS
+
 #elif !defined(H___FIO_BASIC_ROUND2___H)
 #define H___FIO_BASIC_ROUND2___H
 #define FIO_FIOBJ
 #define FIO_MUSTACHE
 #define FIOBJ_MALLOC
+
 #else
 #define H___FIO_BASIC___H
 #undef H___FIO_BASIC_ROUND1___H
@@ -41575,7 +41575,7 @@ typedef struct {
 #define FIO_ARRAY_TYPE_CMP(a, b) (a).obj == (b).obj
 #define FIO_ARRAY_NAME           fiobj___stack
 #define FIO_ARRAY_TYPE           fiobj___stack_element_s
-#define FIO___RECURSIVE_INCLUDE
+#define FIO___RECURSIVE_INCLUDE  1
 #include FIO_INCLUDE_FILE
 #undef FIO___RECURSIVE_INCLUDE
 
@@ -42007,7 +42007,7 @@ FIOBJ JSON parsing
 ***************************************************************************** */
 
 #define FIO_JSON
-#define FIO___RECURSIVE_INCLUDE
+#define FIO___RECURSIVE_INCLUDE 1
 #include FIO_INCLUDE_FILE
 #undef FIO___RECURSIVE_INCLUDE
 
@@ -42282,8 +42282,8 @@ FIOBJ cleanup
 #endif /* FIO_EXTERN_COMPLETE */
 #undef FIOBJ_EXTERN_OBJ
 #undef FIOBJ_EXTERN_OBJ_IMP
-#endif /* FIO_FIOBJ */
 #undef FIO_FIOBJ
+#endif /* FIO_FIOBJ */
 /* ************************************************************************* */
 #if !defined(FIO_INCLUDE_FILE) /* Dev test - ignore line */
 #define FIO___DEV___           /* Development inclusion - ignore line */

diff --git a/fio-stl/000 dependencies.h b/fio-stl/000 dependencies.h
@@ -69,21 +69,19 @@ Everything Inclusion
 #define FIO_SOCK
 #define FIO_STATE
 #define FIO_THREADS
-#elif !defined(H___FIO_EVERYTHING2___H)
-#define H___FIO_EVERYTHING2___H
+
+#else
+#undef H___FIO_EVERYTHING1___H
+#undef FIO_EVERYTHING
+#define H___FIO_EVERYTHING___H
 #define FIO_FIOBJ
 #define FIO_HTTP
 #define FIO_MALLOC
 #define FIO_MUSTACHE
 #define FIO_PUBSUB
 #define FIO_SERVER
-#else
-#define H___FIO_EVERYTHING___H
-#undef H___FIO_EVERYTHING1___H
-#undef H___FIO_EVERYTHING2___H
-#undef FIO_EVERYTHING
-#undef FIO_MEMALT
 #define FIO_MEMALT
+
 #endif
 
 #define FIO___INCLUDE_AGAIN
@@ -110,11 +108,13 @@ Basics Inclusion
 #define FIO_CRYPT
 #define FIO_STATE
 #define FIO_THREADS
+
 #elif !defined(H___FIO_BASIC_ROUND2___H)
 #define H___FIO_BASIC_ROUND2___H
 #define FIO_FIOBJ
 #define FIO_MUSTACHE
 #define FIOBJ_MALLOC
+
 #else
 #define H___FIO_BASIC___H
 #undef H___FIO_BASIC_ROUND1___H

diff --git a/fio-stl/500 fiobj.h b/fio-stl/500 fiobj.h
@@ -1486,7 +1486,7 @@ typedef struct {
 #define FIO_ARRAY_TYPE_CMP(a, b) (a).obj == (b).obj
 #define FIO_ARRAY_NAME           fiobj___stack
 #define FIO_ARRAY_TYPE           fiobj___stack_element_s
-#define FIO___RECURSIVE_INCLUDE
+#define FIO___RECURSIVE_INCLUDE  1
 #include FIO_INCLUDE_FILE
 #undef FIO___RECURSIVE_INCLUDE
 
@@ -1918,7 +1918,7 @@ FIOBJ JSON parsing
 ***************************************************************************** */
 
 #define FIO_JSON
-#define FIO___RECURSIVE_INCLUDE
+#define FIO___RECURSIVE_INCLUDE 1
 #include FIO_INCLUDE_FILE
 #undef FIO___RECURSIVE_INCLUDE
 
@@ -2193,5 +2193,5 @@ FIOBJ cleanup
 #endif /* FIO_EXTERN_COMPLETE */
 #undef FIOBJ_EXTERN_OBJ
 #undef FIOBJ_EXTERN_OBJ_IMP
-#endif /* FIO_FIOBJ */
 #undef FIO_FIOBJ
+#endif /* FIO_FIOBJ */