first commit

Author: devfacet

.clang-format

@@ -0,0 +1,9 @@
+BasedOnStyle: LLVM
+IndentWidth: 4
+TabWidth: 4
+UseTab: Never
+BreakBeforeBraces: Attach
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: Inline
+ColumnLimit: 0

.gitignore

@@ -0,0 +1,11 @@
+.DS_Store
+*.o
+.so
+*.dylib
+build
+
+.vscode/*
+!.vscode/c_cpp_properties.json
+!.vscode/launch.json
+!.vscode/settings.json
+!.vscode/tasks.json

.vscode/settings.json

@@ -0,0 +1,17 @@
+{
+  "[c]": {
+    "editor.tabSize": 4,
+    "editor.insertSpaces": true,
+    "editor.detectIndentation": true,
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "ms-vscode.cpptools"
+  },
+  "cSpell.words": [
+    "CMSIS",
+    "ctest",
+    "tinyclib"
+  ],
+  "files.associations": {
+    ".clang-format": "yaml",
+  }
+}

CMakeLists.txt

@@ -0,0 +1,95 @@
+cmake_minimum_required(VERSION 3.25)
+
+project(tinyclib LANGUAGES C)
+
+# Set the output directories for libraries and executables
+set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+
+# Set the C standard to C11 and fallback to C99 if not supported
+set(CMAKE_C_STANDARD 11)
+set(CMAKE_C_STANDARD_REQUIRED ON)
+set(CMAKE_C_EXTENSIONS OFF)
+include(CheckCCompilerFlag)
+check_c_compiler_flag("-std=c11" COMPILER_SUPPORTS_C11)
+if(NOT COMPILER_SUPPORTS_C11)
+    message(WARNING "C11 is not supported by the compiler. Falling back to C99.")
+    set(CMAKE_C_STANDARD 99)
+endif()
+
+# Add include directories
+include_directories(${CMAKE_SOURCE_DIR}/include)
+
+# Source files
+set(SOURCES
+    src/tl_app.c
+    src/tl_config.c
+    src/tl_error.c
+    src/tl_test.c
+)
+
+# Header files
+set(HEADERS
+    include/tl_app.h
+    include/tl_config.h
+    include/tl_constants.h
+    include/tl_debug.h
+    include/tl_error.h
+    include/tl_test.h
+)
+
+# Create a static library
+add_library(tinyclib STATIC ${SOURCES} ${HEADERS})
+
+# Fetch dependencies
+include(FetchContent)
+
+# Fetch Unity test framework
+FetchContent_Declare(
+    Unity
+    GIT_REPOSITORY https://github.com/ThrowTheSwitch/Unity.git
+    GIT_TAG v2.6.1
+)
+FetchContent_GetProperties(Unity)
+if(NOT Unity_POPULATED)
+    FetchContent_MakeAvailable(Unity)
+    set(Unity_SOURCE_DIR ${CMAKE_BINARY_DIR}/_deps/unity-src)
+    if(NOT TARGET Unity)
+        add_library(Unity STATIC ${Unity_SOURCE_DIR}/src/unity.c)
+        target_include_directories(Unity PUBLIC ${Unity_SOURCE_DIR}/src)
+    endif()
+endif()
+
+# Build tests
+option(BUILD_TESTS "Build tests" ON)
+if(BUILD_TESTS)
+    enable_testing()
+
+    include_directories(${unity_SOURCE_DIR}/src)
+
+    # Add test executable for tl_app
+    add_executable(tl_app_test tests/arch/generic/tl_app_test.c)
+    target_link_libraries(tl_app_test Unity tinyclib)
+    add_test(NAME tl_app_test COMMAND tl_app_test)
+
+    # Add test executable for tl_config
+    add_executable(tl_config_test tests/arch/generic/tl_config_test.c)
+    target_link_libraries(tl_config_test Unity tinyclib)
+    add_test(NAME tl_config_test COMMAND tl_config_test)
+
+    # Add test executable for tl_debug
+    add_executable(tl_debug_test tests/arch/generic/tl_debug_test.c)
+    target_link_libraries(tl_debug_test Unity tinyclib)
+    add_test(NAME tl_debug_test COMMAND tl_debug_test)
+
+    # Add test executable for tl_error
+    add_executable(tl_error_test tests/arch/generic/tl_error_test.c)
+    target_link_libraries(tl_error_test Unity tinyclib)
+    add_test(NAME tl_error_test COMMAND tl_error_test)
+
+    # Add test executable for tl_test
+    add_executable(tl_test_test tests/arch/generic/tl_test_test.c)
+    target_link_libraries(tl_test_test Unity tinyclib)
+    add_test(NAME tl_test_test COMMAND tl_test_test)
+endif()

CMakePresets.json

@@ -0,0 +1,53 @@
+{
+  "version": 6,
+  "cmakeMinimumRequired": {
+    "major": 3,
+    "minor": 25
+  },
+  "configurePresets": [
+    {
+      "name": "default",
+      "generator": "Ninja",
+      "binaryDir": "${sourceDir}/build",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Debug",
+        "BUILD_TESTS": "ON"
+      }
+    }
+  ],
+  "buildPresets": [
+    {
+      "name": "default",
+      "configurePreset": "default",
+      "jobs": 4
+    }
+  ],
+  "testPresets": [
+    {
+      "name": "default",
+      "configurePreset": "default",
+      "output": {
+        "outputOnFailure": true
+      }
+    }
+  ],
+  "workflowPresets": [
+    {
+      "name": "default",
+      "steps": [
+        {
+          "name": "default",
+          "type": "configure"
+        },
+        {
+          "name": "default",
+          "type": "build"
+        },
+        {
+          "name": "default",
+          "type": "test"
+        }
+      ]
+    }
+  ]
+}

CONTRIBUTING.md

@@ -0,0 +1,9 @@
+# Contributing
+
+- Code contributions must be through pull requests.
+- Run tests, linting and formatting before make a pull request.
+- Pull requests can not be merged without being reviewed.
+- Use "Issues" for bug reports, feature requests, discussions and typos.
+- Do not refactor existing code without a discussion.
+- Do not add a new third party dependency without a discussion.
+- Use semantic versioning and git tags for versioning.

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Fatih Cetinkaya - https://github.com/devfacet/tinyclib
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,40 @@
+# tinyclib - A tiny C library
+
+tinyclib is a tiny C library for building applications across various platforms, 
+from server-grade hardware to desktops, mobile, and embedded devices.
+
+## Requirements
+
+- [Clang](https://clang.llvm.org/) or similar C compiler
+- [CMake](https://cmake.org/)
+
+### Recommended tools
+
+- [Visual Studio Code](https://code.visualstudio.com/)
+- [C/C++ for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools)
+- [CMake Tools for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools)
+
+## Installation
+
+```shell
+git clone https://github.com/devfacet/tinyclib.git
+cd tinyclib/
+cmake --workflow --preset default
+```
+
+## Usage
+
+## Test
+
+```shell
+ctest --preset default
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md)
+
+## License
+
+Licensed under The MIT License (MIT)  
+For the full copyright and license information, please view the LICENSE.txt file.

include/tl_app.h

@@ -0,0 +1,46 @@
+// See LICENSE.txt and CONTRIBUTING.md for details.
+
+#ifndef TL_APP_H
+#define TL_APP_H
+
+#include <stdbool.h>
+
+/**
+ * @brief Initializes the running app with the given command line arguments.
+ *
+ * @param argc The number of command line arguments.
+ * @param argv The command line arguments.
+ *
+ * @return void
+ */
+void tl_init_app(int argc, char *argv[]);
+
+/**
+ * @brief Parses the given command line arguments.
+ *
+ * @param argc The number of command line arguments.
+ * @param argv The command line arguments.
+ *
+ * @return void
+ */
+void tl_parse_args(int argc, char *argv[]);
+
+/**
+ * @brief Looks up a specific flag.
+ *
+ * @param flag The flag to look up.
+ *
+ * @return true if the flag is found, false otherwise.
+ */
+bool tl_lookup_flag(const char *flag);
+
+/**
+ * @brief Returns the value of a specific flag.
+ *
+ * @param flag The flag to get.
+ *
+ * @return The value of the flag, or NULL if not found.
+ */
+const char *tl_get_flag(const char *flag);
+
+#endif // TL_APP_H

include/tl_config.h

@@ -0,0 +1,61 @@
+// See LICENSE.txt and CONTRIBUTING.md for details.
+
+#ifndef TL_CONFIG_H
+#define TL_CONFIG_H
+
+#include "tl_error.h"
+#include <stdbool.h>
+
+/**
+ * @brief Defines whether ARM NEON is available.
+ *
+ * @note Available for certain ARM architectures.
+ */
+#if defined(__ARM_NEON) || defined(__ARM_NEON__)
+#define TL_NEON_AVAILABLE 1
+#else
+#define TL_NEON_AVAILABLE 0
+#endif
+
+/**
+ * @brief Defines whether ARM CMSIS-DSP is available.
+ *
+ * @note Available for all ARM architectures.
+ */
+#if defined(__ARM_ARCH)
+#define TL_CMSIS_DSP_AVAILABLE 1
+#else
+#define TL_CMSIS_DSP_AVAILABLE 0
+#endif
+
+/**
+ * @brief Returns the debug level.
+ *
+ * @return The debug level.
+ */
+int tl_get_debug_level();
+
+/**
+ * @brief Sets the debug level.
+ *
+ * @param level The debug level.
+ *
+ * @return True or false.
+ */
+bool tl_set_debug_level(int level);
+
+/**
+ * @brief Returns whether ARM NEON is available.
+ *
+ * @return True or false.
+ */
+bool tl_neon_available();
+
+/**
+ * @brief Returns whether ARM CMSIS-DSP is available.
+ *
+ * @return True or false.
+ */
+bool tl_cmsis_dsp_available();
+
+#endif // TL_CONFIG_H

include/tl_constants.h

@@ -0,0 +1,11 @@
+// See LICENSE.txt and CONTRIBUTING.md for details.
+
+#ifndef TL_CONSTANTS_H
+#define TL_CONSTANTS_H
+
+/**
+ * @brief Epsilon value for numerical stability
+ */
+#define TL_EPSILON 1e-7
+
+#endif // TL_CONSTANTS_H