Merge branch 'main' into cli_parser

Author: dreamer-coding

code/logic/CMakeLists.txt

@@ -14,6 +14,7 @@ set(TEST_CODE
     output.c
     soap.c
     stream.c
+    keyboard.c
 )
 
 # Create the library target

code/logic/fossil/io/error.h

@@ -183,6 +183,188 @@ const char *fossil_io_what(fossil_status_t error_code);
 
 #ifdef __cplusplus
 }
+
+#include <exception>
+
+/**
+ * This namespace provides a set of functions for handling input and output operations.
+ */
+namespace fossil {
+    /**
+     * This namespace provides a set of functions for handling input and output operations.
+     */
+    namespace io {
+        /**
+         * Enum class for error codes.
+         */
+        enum class ErrorCode {
+            // Success and General Errors
+            OK = FOSSIL_ERROR_OK,
+            NULL_POINTER = FOSSIL_ERROR_NULL_POINTER,
+            INVALID_ARGUMENT = FOSSIL_ERROR_INVALID_ARGUMENT,
+            TYPE_MISMATCH = FOSSIL_ERROR_TYPE_MISMATCH,
+            INVALID_OPERATION = FOSSIL_ERROR_INVALID_OPERATION,
+            UNKNOWN = FOSSIL_ERROR_UNKNOWN,
+            CUSTOM = FOSSIL_ERROR_CUSTOM,
+            INTERNAL = FOSSIL_ERROR_INTERNAL,
+            UNKNOWN_ERROR_CODE = FOSSIL_ERROR_UNKNOWN_ERROR_CODE,
+
+            // Arithmetic Errors
+            OVERFLOW_INT = FOSSIL_ERROR_OVERFLOW_INT,
+            UNDERFLOW_INT = FOSSIL_ERROR_UNDERFLOW_INT,
+            OVERFLOW_FLOAT = FOSSIL_ERROR_OVERFLOW_FLOAT,
+            UNDERFLOW_FLOAT = FOSSIL_ERROR_UNDERFLOW_FLOAT,
+            DIVISION_BY_ZERO = FOSSIL_ERROR_DIVISION_BY_ZERO,
+            INVALID_CAST = FOSSIL_ERROR_INVALID_CAST,
+
+            // Memory Errors
+            OUT_OF_MEMORY = FOSSIL_ERROR_OUT_OF_MEMORY,
+            MEMORY_CORRUPTION = FOSSIL_ERROR_MEMORY_CORRUPTION,
+            BUFFER_OVERFLOW = FOSSIL_ERROR_BUFFER_OVERFLOW,
+            BUFFER_UNDERFLOW = FOSSIL_ERROR_BUFFER_UNDERFLOW,
+            BUFFER_OVERFLOW_STR = FOSSIL_ERROR_BUFFER_OVERFLOW_STR,
+            BUFFER_OVERFLOW_FMT = FOSSIL_ERROR_BUFFER_OVERFLOW_FMT,
+            BUFFER_OVERFLOW_FILE = FOSSIL_ERROR_BUFFER_OVERFLOW_FILE,
+            BUFFER_OVERFLOW_NET = FOSSIL_ERROR_BUFFER_OVERFLOW_NET,
+            BUFFER_OVERFLOW_CMD = FOSSIL_ERROR_BUFFER_OVERFLOW_CMD,
+            BUFFER_OVERFLOW_ENV = FOSSIL_ERROR_BUFFER_OVERFLOW_ENV,
+            MEMORY_LEAK = FOSSIL_ERROR_MEMORY_LEAK,
+            MEMORY_ALLOCATION_FAILURE = FOSSIL_ERROR_MEMORY_ALLOCATION_FAILURE,
+            MEMORY_ALIGNMENT_ISSUE = FOSSIL_ERROR_MEMORY_ALIGNMENT_ISSUE,
+
+            // File and I/O Errors
+            FILE_CORRUPTION = FOSSIL_ERROR_FILE_CORRUPTION,
+            FILE_NOT_FOUND = FOSSIL_ERROR_FILE_NOT_FOUND,
+            DIRECTORY_NOT_FOUND = FOSSIL_ERROR_DIRECTORY_NOT_FOUND,
+            TOO_MANY_OPEN_FILES = FOSSIL_ERROR_TOO_MANY_OPEN_FILES,
+            IO = FOSSIL_ERROR_IO,
+            UNSUPPORTED_OPERATION = FOSSIL_ERROR_UNSUPPORTED_OPERATION,
+            PIPE = FOSSIL_ERROR_PIPE,
+            SYSTEM_CALL_FAILED = FOSSIL_ERROR_SYSTEM_CALL_FAILED,
+            PERMISSION_DENIED = FOSSIL_ERROR_PERMISSION_DENIED,
+            READ_ONLY_FILESYSTEM = FOSSIL_ERROR_READ_ONLY_FILESYSTEM,
+            FILE_LOCK_FAILED = FOSSIL_ERROR_FILE_LOCK_FAILED,
+            FILE_WRITE_FAILED = FOSSIL_ERROR_FILE_WRITE_FAILED,
+            FILE_READ_FAILED = FOSSIL_ERROR_FILE_READ_FAILED,
+            FILE_SEEK_FAILED = FOSSIL_ERROR_FILE_SEEK_FAILED,
+            FILE_CLOSE_FAILED = FOSSIL_ERROR_FILE_CLOSE_FAILED,
+            FILE_TRUNCATE_FAILED = FOSSIL_ERROR_FILE_TRUNCATE_FAILED,
+            FILE_TOO_LARGE = FOSSIL_ERROR_FILE_TOO_LARGE,
+            DEVICE_NOT_READY = FOSSIL_ERROR_DEVICE_NOT_READY,
+            DEVICE_REMOVED = FOSSIL_ERROR_DEVICE_REMOVED,
+
+            // Resource and Process Errors
+            RESOURCE_UNAVAILABLE = FOSSIL_ERROR_RESOURCE_UNAVAILABLE,
+            BUSY = FOSSIL_ERROR_BUSY,
+            DEADLOCK = FOSSIL_ERROR_DEADLOCK,
+            INTERRUPTED = FOSSIL_ERROR_INTERRUPTED,
+            LIMIT_REACHED = FOSSIL_ERROR_LIMIT_REACHED,
+            PROCESS = FOSSIL_ERROR_PROCESS,
+            PROCESS_CREATION_FAILED = FOSSIL_ERROR_PROCESS_CREATION_FAILED,
+            PROCESS_EXITED_WITH_ERROR = FOSSIL_ERROR_PROCESS_EXITED_WITH_ERROR,
+            PROCESS_TIMEOUT = FOSSIL_ERROR_PROCESS_TIMEOUT,
+            RESOURCE_DEPLETION = FOSSIL_ERROR_RESOURCE_DEPLETION,
+            THREAD_CREATION_FAILED = FOSSIL_ERROR_THREAD_CREATION_FAILED,
+            THREAD_TERMINATION_FAILED = FOSSIL_ERROR_THREAD_TERMINATION_FAILED,
+
+            // Hardware Errors
+            HARDWARE_FAILURE = FOSSIL_ERROR_HARDWARE_FAILURE,
+            HARD_DISK_FAILURE = FOSSIL_ERROR_HARD_DISK_FAILURE,
+            GPU_FAILURE = FOSSIL_ERROR_GPU_FAILURE,
+            CPU_OVERHEAT = FOSSIL_ERROR_CPU_OVERHEAT,
+            MEMORY_FAILURE = FOSSIL_ERROR_MEMORY_FAILURE,
+            HARDWARE_OVERLOAD = FOSSIL_ERROR_HARDWARE_OVERLOAD,
+            DEVICE_TIMEOUT = FOSSIL_ERROR_DEVICE_TIMEOUT,
+            POWER_SUPPLY_FAILURE = FOSSIL_ERROR_POWER_SUPPLY_FAILURE,
+
+            // Network Errors
+            NETWORK_FAILURE = FOSSIL_ERROR_NETWORK_FAILURE,
+            TIMEOUT = FOSSIL_ERROR_TIMEOUT,
+            UNKNOWN_HOST = FOSSIL_ERROR_UNKNOWN_HOST,
+            CONNECTION_REFUSED = FOSSIL_ERROR_CONNECTION_REFUSED,
+            NETWORK_UNREACHABLE = FOSSIL_ERROR_NETWORK_UNREACHABLE,
+            PROTOCOL = FOSSIL_ERROR_PROTOCOL,
+            CONNECTION_RESET = FOSSIL_ERROR_CONNECTION_RESET,
+            DNS_RESOLUTION_FAILED = FOSSIL_ERROR_DNS_RESOLUTION_FAILED,
+            NETWORK_CONGESTION = FOSSIL_ERROR_NETWORK_CONGESTION,
+            BANDWIDTH_EXCEEDED = FOSSIL_ERROR_BANDWIDTH_EXCEEDED,
+            FIREWALL_BLOCKED = FOSSIL_ERROR_FIREWALL_BLOCKED,
+            SSL_HANDSHAKE_FAILED = FOSSIL_ERROR_SSL_HANDSHAKE_FAILED,
+            CERTIFICATE_EXPIRED = FOSSIL_ERROR_CERTIFICATE_EXPIRED,
+            CERTIFICATE_REVOKED = FOSSIL_ERROR_CERTIFICATE_REVOKED,
+
+            // Security Errors
+            SQL_INJECTION = FOSSIL_ERROR_SQL_INJECTION,
+            XSS_ATTACK = FOSSIL_ERROR_XSS_ATTACK,
+            CSRF_ATTACK = FOSSIL_ERROR_CSRF_ATTACK,
+            FORMAT_STRING_ATTACK = FOSSIL_ERROR_FORMAT_STRING_ATTACK,
+            CRYPTOGRAPHIC_WEAKNESS = FOSSIL_ERROR_CRYPTOGRAPHIC_WEAKNESS,
+            INSECURE_RANDOMNESS = FOSSIL_ERROR_INSECURE_RANDOMNESS,
+            INSECURE_CONFIGURATION = FOSSIL_ERROR_INSECURE_CONFIGURATION,
+            INSECURE_DESERIALIZATION = FOSSIL_ERROR_INSECURE_DESERIALIZATION,
+            INSECURE_FILE_HANDLING = FOSSIL_ERROR_INSECURE_FILE_HANDLING,
+            INSECURE_TEMPORARY_FILES = FOSSIL_ERROR_INSECURE_TEMPORARY_FILES,
+            INSECURE_COMMUNICATION = FOSSIL_ERROR_INSECURE_COMMUNICATION,
+            INSECURE_AUTHENTICATION = FOSSIL_ERROR_INSECURE_AUTHENTICATION,
+            INSECURE_ACCESS_CONTROL = FOSSIL_ERROR_INSECURE_ACCESS_CONTROL,
+            SESSION_HIJACKING = FOSSIL_ERROR_SESSION_HIJACKING,
+            DATA_TAMPERING = FOSSIL_ERROR_DATA_TAMPERING,
+            MAN_IN_THE_MIDDLE_ATTACK = FOSSIL_ERROR_MAN_IN_THE_MIDDLE_ATTACK,
+            PRIVILEGE_ESCALATION = FOSSIL_ERROR_PRIVILEGE_ESCALATION,
+
+            // User-Related and External Errors
+            USER_ABORT = FOSSIL_ERROR_USER_ABORT,
+            SIGNAL = FOSSIL_ERROR_SIGNAL,
+            USER_INPUT_TOO_LARGE = FOSSIL_ERROR_USER_INPUT_TOO_LARGE,
+            USER_INPUT_INVALID_FORMAT = FOSSIL_ERROR_USER_INPUT_INVALID_FORMAT,
+            USER_PERMISSION_REJECTED = FOSSIL_ERROR_USER_PERMISSION_REJECTED,
+
+            // Database Errors
+            DATABASE_CONNECTION_FAILED = FOSSIL_ERROR_DATABASE_CONNECTION_FAILED,
+            DATABASE_QUERY_FAILED = FOSSIL_ERROR_DATABASE_QUERY_FAILED,
+            DATABASE_TIMEOUT = FOSSIL_ERROR_DATABASE_TIMEOUT,
+            DATABASE_CORRUPTION = FOSSIL_ERROR_DATABASE_CORRUPTION,
+            DATABASE_DEADLOCK = FOSSIL_ERROR_DATABASE_DEADLOCK,
+            DATABASE_LOCK_FAILED = FOSSIL_ERROR_DATABASE_LOCK_FAILED,
+
+            // Serialization and Deserialization Errors
+            SERIALIZATION_FAILED = FOSSIL_ERROR_SERIALIZATION_FAILED,
+            DESERIALIZATION_FAILED = FOSSIL_ERROR_DESERIALIZATION_FAILED,
+            INVALID_SERIALIZATION_FORMAT = FOSSIL_ERROR_INVALID_SERIALIZATION_FORMAT,
+            DATA_CORRUPTION = FOSSIL_ERROR_DATA_CORRUPTION,
+
+            // Miscellaneous Errors
+            INDEX_OUT_OF_BOUNDS = FOSSIL_ERROR_INDEX_OUT_OF_BOUNDS,
+            FORMAT = FOSSIL_ERROR_FORMAT,
+            INCOMPATIBLE_VERSION = FOSSIL_ERROR_INCOMPATIBLE_VERSION,
+            JSON_PARSING_FAILED = FOSSIL_ERROR_JSON_PARSING_FAILED,
+            XML_PARSING_FAILED = FOSSIL_ERROR_XML_PARSING_FAILED,
+            YAML_PARSING_FAILED = FOSSIL_ERROR_YAML_PARSING_FAILED,
+            INVALID_CHECKSUM = FOSSIL_ERROR_INVALID_CHECKSUM,
+            TIMER_EXPIRED = FOSSIL_ERROR_TIMER_EXPIRED
+        };
+
+        /**
+         * Exception class for handling errors.
+         */
+        class Error : public std::exception {
+        public:
+            explicit Error(ErrorCode code) : code_(code) {}
+
+            const char* what() const noexcept override {
+                return fossil_io_what(static_cast<fossil_status_t>(code_));
+            }
+
+            ErrorCode code() const noexcept {
+                return code_;
+            }
+
+        private:
+            ErrorCode code_;
+        };
+    }
+}
+
 #endif
 
 #endif /* FOSSIL_IO_FRAMEWORK_H */

code/logic/fossil/io/framework.h

@@ -15,6 +15,7 @@
 #define FOSSIL_IO_FRAMEWORK_H
 
 // Include the necessary headers
+#include "keyboard.h"
 #include "output.h"
 #include "input.h"
 #include "error.h"

code/logic/fossil/io/keyboard.h

@@ -0,0 +1,145 @@
+/*
+ * -----------------------------------------------------------------------------
+ * Project: Fossil Logic
+ *
+ * This file is part of the Fossil Logic project, which aims to develop high-
+ * performance, cross-platform applications and libraries. The code contained
+ * herein is subject to the terms and conditions defined in the project license.
+ *
+ * Author: Michael Gene Brockus (Dreamer)
+ *
+ * Copyright (C) 2024 Fossil Logic. All rights reserved.
+ * -----------------------------------------------------------------------------
+ */
+#ifndef FOSSIL_IO_KEYBOARD_H
+#define FOSSIL_IO_KEYBOARD_H
+
+#include <stdint.h>
+#include <stddef.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// Define a keyboard event structure
+typedef struct {
+    int shift; // 1 if Shift is pressed, 0 otherwise
+    int ctrl;  // 1 if Ctrl is pressed, 0 otherwise
+    int alt;   // 1 if Alt is pressed, 0 otherwise
+    char key;  // The character of the key pressed
+} fossil_io_keyboard_event_t;
+
+// Define a callback type for key events
+typedef void (*fossil_io_keyboard_callback_t)(fossil_io_keyboard_event_t event);
+
+/**
+ * Initialize the keyboard library.
+ * Sets up any platform-specific configurations.
+ */
+void fossil_io_keyboard_init(void);
+
+/**
+ * Shut down the keyboard library.
+ * Cleans up any platform-specific configurations.
+ */
+void fossil_io_keyboard_shutdown(void);
+
+/**
+ * Clear all keybindings from the library.
+ */
+void fossil_io_keyboard_clear_bindings(void);
+
+/**
+ * Register a keybinding with the library.
+ *
+ * @param event     The keyboard event to bind to.
+ * @param callback  The callback function to call when the event occurs.
+ */
+void fossil_io_keyboard_register_binding(fossil_io_keyboard_event_t event, fossil_io_keyboard_callback_t callback);
+
+/**
+ * Unregister a keybinding with the library.
+ *
+ * @param event     The keyboard event to unbind.
+ */
+void fossil_io_keyboard_unregister_binding(fossil_io_keyboard_event_t event);
+
+/**
+ * Poll for keyboard events and trigger any registered callbacks.
+ * This function should be called in the main loop of the application.
+ */
+void fossil_io_keyboard_poll_events(void);
+
+#ifdef __cplusplus
+}
+
+/**
+ * C++ wrapper for the SOAP API.
+ */
+namespace fossil {
+
+    /**
+     * Namespace for I/O operations.
+     */
+    namespace io {
+        /**
+         * Class for interacting with the keyboard.
+         */
+        class keyboard {
+        public:
+            /**
+             * Initialize the keyboard library.
+             * Sets up any platform-specific configurations.
+             */
+            static void init() {
+                fossil_io_keyboard_init();
+            }
+
+            /**
+             * Shut down the keyboard library.
+             * Cleans up any platform-specific configurations.
+             */
+            static void shutdown() {
+                fossil_io_keyboard_shutdown();
+            }
+
+            /**
+             * Clear all keybindings from the library.
+             */
+            static void clear_bindings() {
+                fossil_io_keyboard_clear_bindings();
+            }
+
+            /**
+             * Register a keybinding with the library.
+             *
+             * @param event     The keyboard event to bind to.
+             * @param callback  The callback function to call when the event occurs.
+             */
+            static void register_binding(fossil_io_keyboard_event_t event, fossil_io_keyboard_callback_t callback) {
+                fossil_io_keyboard_register_binding(event, callback);
+            }
+
+            /**
+             * Unregister a keybinding with the library.
+             *
+             * @param event     The keyboard event to unbind.
+             */
+            static void unregister_binding(fossil_io_keyboard_event_t event) {
+                fossil_io_keyboard_unregister_binding(event);
+            }
+
+            /**
+             * Poll for keyboard events and trigger any registered callbacks.
+             * This function should be called in the main loop of the application.
+             */
+            static void poll_events() {
+                fossil_io_keyboard_poll_events();
+            }
+        };
+    }
+}
+
+#endif
+
+#endif /* FOSSIL_IO_FRAMEWORK_H */