add C++ class for input

Author: dreamer-coding

code/logic/fossil/io/input.h

@@ -15,6 +15,7 @@
 #define FOSSIL_IO_INPUT_H
 
 #include <stddef.h>
+#include <stdarg.h>
 #include <stdio.h>
 
 #ifdef __cplusplus
@@ -32,27 +33,128 @@ extern "C" {
 char *fossil_io_gets_from_stream(char *buf, size_t size, FILE *input_stream);
 
 /**
- * Reads a line from the input stream and stores it into the buffer pointed to by 'buf'.
+ * Reads a line from the input stream with error reporting.
+ *
+ * @param buf           Pointer to the buffer where the line will be stored.
+ * @param size          Maximum number of characters to be read, including the null terminator.
+ * @param input_stream  Pointer to the input stream to read from.
+ * @param error_code    Pointer to an integer to store the error code (e.g., EOF, input error).
+ * @return              On success, the function returns 'buf'. If the end-of-file is reached or an error occurs, it returns NULL.
+ */
+char *fossil_io_gets_from_stream_ex(char *buf, size_t size, FILE *input_stream, int *error_code);
+
+/**
+ * Reads formatted input from the standard input stream.
  * 
- * @param buf   Pointer to the buffer where the line will be stored.
- * @param size  Maximum number of characters to be read, including the null terminator.
- * @return      On success, the function returns 'buf'. If the end-of-file is reached or an error occurs, it returns NULL.
+ * @param format        The format string specifying how the input should be interpreted.
+ * @param ...           Additional arguments for storing the input values.
+ * @return              On success, the number of input items successfully matched and assigned is returned.
+ *                      On failure, EOF is returned.
  */
-char *fossil_io_gets(char *buf, size_t size);
+int fossil_io_scanf(const char *format, ...);
 
 /**
- * Reads a line from the input stream and stores it into the buffer pointed to by 'buf',
- * while displaying a dialog message to the user.
+ * Reads formatted input from the specified input stream.
  * 
- * @param buf       Pointer to the buffer where the line will be stored.
- * @param size      Maximum number of characters to be read, including the null terminator.
- * @param dialog    Dialog message to be displayed to the user.
- * @return          On success, the function returns 'buf'. If the end-of-file is reached or an error occurs, it returns NULL.
+ * @param input_stream  Pointer to the input stream to read from.
+ * @param format        The format string specifying how the input should be interpreted.
+ * @param ...           Additional arguments for storing the input values.
+ * @return              On success, the number of input items successfully matched and assigned is returned.
+ *                      On failure, EOF is returned.
+ */
+int fossil_io_fscanf(FILE *input_stream, const char *format, ...);
+
+/**
+ * Validates the input buffer and size before reading.
+ *
+ * @param buf           Pointer to the buffer where the input will be stored.
+ * @param size          Size of the buffer.
+ * @return              1 if the buffer and size are valid; 0 otherwise.
  */
-char *fossil_io_gets_with_dialog(char *buf, size_t size, const char *dialog);
+int fossil_io_validate_input_buffer(const char *buf, size_t size);
+
+/**
+ * Reads a UTF-8 encoded line from the input stream.
+ *
+ * @param buf           Pointer to the buffer where the line will be stored.
+ * @param size          Maximum number of characters to be read, including the null terminator.
+ * @param input_stream  Pointer to the input stream to read from.
+ * @return              On success, the function returns 'buf'. If the end-of-file is reached or an error occurs, it returns NULL.
+ */
+char *fossil_io_gets_utf8(char *buf, size_t size, FILE *input_stream);
 
 #ifdef __cplusplus
 }
+
+/**
+ * Namespace for the Fossil Logic I/O library.
+ */
+namespace fossil {
+
+    /**
+     * Namespace for the I/O utilities.
+     */
+    namespace io {
+
+        /**
+         * Class for handling input operations.
+         */
+        class Input {
+        public:
+            /**
+             * Reads a line from the input stream and stores it into the buffer pointed to by 'buf'.
+             *
+             * @param buf           Pointer to the buffer where the line will be stored.
+             * @param size          Maximum number of characters to be read, including the null terminator.
+             * @param input_stream  Pointer to the input stream to read from.
+             * @return              On success, the function returns 'buf'. If the end-of-file is reached or an error occurs, it returns NULL.
+             */
+            static char *gets_from_stream(char *buf, size_t size, FILE *input_stream) {
+                return fossil_io_gets_from_stream(buf, size, input_stream);
+            }
+
+            /**
+             * Reads a line from the input stream with error reporting.
+             *
+             * @param buf           Pointer to the buffer where the line will be stored.
+             * @param size          Maximum number of characters to be read, including the null terminator.
+             * @param input_stream  Pointer to the input stream to read from.
+             * @param error_code    Pointer to an integer to store the error code (e.g., EOF, input error).
+             * @return              On success, the function returns 'buf'. If the end-of-file is reached or an error occurs, it returns NULL.
+             */
+            static char *gets_from_stream_ex(char *buf, size_t size, FILE *input_stream, int *error_code) {
+                return fossil_io_gets_from_stream_ex(buf, size, input_stream, error_code);
+            }
+
+            /**
+             * Validates the input buffer and size before reading.
+             *
+             * @param buf           Pointer to the buffer where the input will be stored.
+             * @param size          Size of the buffer.
+             * @return              1 if the buffer and size are valid; 0 otherwise.
+             */
+            static int validate_input_buffer(const char *buf, size_t size) {
+                return fossil_io_validate_input_buffer(buf, size);
+            }
+
+            /**
+             * Reads a UTF-8 encoded line from the input stream.
+             *
+             * @param buf           Pointer to the buffer where the line will be stored.
+             * @param size          Maximum number of characters to be read, including the null terminator.
+             * @param input_stream  Pointer to the input stream to read from.
+             * @return              On success, the function returns 'buf'. If the end-of-file is reached or an error occurs, it returns NULL.
+             */
+            static char *gets_utf8(char *buf, size_t size, FILE *input_stream) {
+                return fossil_io_gets_utf8(buf, size, input_stream);
+            }
+
+        };
+
+    }
+
+}
+
 #endif
 
 #endif /* FOSSIL_IO_FRAMEWORK_H */