enable single-file library use (merge build.h into tinyfseq.h)

Author: Cryptkeeper

CMakeLists.txt

@@ -1,20 +1,27 @@
 cmake_minimum_required(VERSION 3.21)
 
 project(tinyfseq
-        VERSION 1.1.0
+        VERSION 1.2.0
         DESCRIPTION "A tiny library for decoding FSEQ (.fseq) v2.0+ sequence files"
         HOMEPAGE_URL "https://github.com/Cryptkeeper/libtinyfseq"
         LANGUAGES C)
 
 set(CMAKE_C_STANDARD 90)
 
+# enables you to disable replace all error strings returned by `tf_err_str` with "NULL"
+# this reduces the compiled size of the object + memory footprint
+#
+# you may also `#define TF_STRIP_ERR_STRINGS` prior to including `tinyfseq.h` to disable
+#       error strings without using CMake
 set(TF_INCLUDE_ERR_STRINGS true)
 
-configure_file(${PROJECT_SOURCE_DIR}/build.h.in ${PROJECT_SOURCE_DIR}/build.h)
+if (NOT ${TF_INCLUDE_ERR_STRINGS})
+        add_compile_definitions(TF_STRIP_ERR_STRINGS)
+endif ()
 
 add_library(tinyfseq tinyfseq.h tinyfseq.c)
 
-set_target_properties(tinyfseq PROPERTIES PUBLIC_HEADER "tinyfseq.h;build.h")
+set_target_properties(tinyfseq PROPERTIES PUBLIC_HEADER "tinyfseq.h")
 
 install(TARGETS tinyfseq
         LIBRARY DESTINATION lib/tinyfseq

README.md

@@ -7,7 +7,7 @@ at [Cryptkeeper/fseq-file-format](https://github.com/Cryptkeeper/fseq-file-forma
 
 ## Installation
 
-libtinyfseq uses [CMake](https://cmake.org/) for building and packaging the library.
+You may either install the library, or use `tinyfseq.h` & `tinyfseq.c` directly as a single-file library. libtinyfseq uses [CMake](https://cmake.org/) for building and packaging the library.
 
 - Generate Makefiles using `cmake .`
 - Compile the library using `make`
@@ -18,8 +18,8 @@ If optionally installed, `install_manifest.txt` will be created, containing the
 
 ## Build Configuration
 
-For devices with limited memory, a `TF_INCLUDE_ERR_STRINGS` definition is included in [CMakeLists.txt](CMakeLists.txt)
-to disable the inclusion of error strings in the build. Calls to `tf_err_str` will instead return `"NULL"` (as a string).
+For devices with limited memory, a `TF_INCLUDE_ERR_STRINGS` setting is included in [CMakeLists.txt](CMakeLists.txt)
+to disable the inclusion of error strings in the build. Calls to `tf_err_str` will instead return `"NULL"` (as a string). You may also `#define TF_STRIP_ERR_STRINGS` prior to including `tinyfseq.h` to disable error strings without using CMake.
 
 ## Compatibility
 
@@ -37,10 +37,10 @@ to disable the inclusion of error strings in the build. Calls to `tf_err_str` wi
 libtinyfseq only defines three functions for reading the various components of a FSEQ file. See [tinyfseq.h](tinyfseq.h)
 for comments describing their usage.
 
-| Function | Schema |
-| --- | --- |
-| `tf_read_file_header` | https://github.com/Cryptkeeper/fseq-file-format#header |
-| `tf_read_var_header` | https://github.com/Cryptkeeper/fseq-file-format#variable |
+| Function                | Schema                                                       |
+| ----------------------- | ------------------------------------------------------------ |
+| `tf_read_file_header`   | https://github.com/Cryptkeeper/fseq-file-format#header       |
+| `tf_read_var_header`    | https://github.com/Cryptkeeper/fseq-file-format#variable     |
 | `tf_read_channel_range` | https://github.com/Cryptkeeper/fseq-file-format#sparse-range |
 
 Two additional utility functions are provided:

build.h.in

@@ -26,7 +26,7 @@
 #include <string.h>
 
 const char *tf_err_str(enum tf_err_t err) {
-#ifdef TF_INCLUDE_ERR_STRINGS
+#ifndef TF_STRIP_ERR_STRINGS
     switch (err) {
         case TF_OK:
             return "TF_OK (ok)";

tinyfseq.c

@@ -26,8 +26,7 @@
 
 #include <stdint.h>
 
-// `build.h` is generated by CMake using the `build.h.in` template
-#include "build.h"
+#define TF_LIB_VERSION "1.2.0"
 
 enum tf_err_t {
     TF_OK = 0,
@@ -44,7 +43,7 @@ enum tf_err_t {
  * `tf_err_str` does not allocate, its return values should not be freed. `tf_err_str` will never return a NULL value.
  *
  * @param err Unknown/invalid values will default to returning "unknown `tf_err_t` value"
- * @return A string version of the given value, or "NULL" (as a string) if the library is built without `TF_INCLUDE_ERR_STRINGS` defined
+ * @return A string version of the given value, or "NULL" (as a string) if the library is built with `TF_STRIP_ERR_STRINGS` defined
  */
 const char *tf_err_str(enum tf_err_t err);