Merge pull request #16 from dreamer-coding/apply_soap_awareness

Apply soap awareness

Author: dreamer-coding

code/logic/error.c

@@ -30,9 +30,6 @@ void fossil_io_error(const char *format, ...) {
     char buffer[FOSSIL_IO_BUFFER_SIZE];
     vsnprintf(buffer, sizeof(buffer), format, args);
 
-    // Sanitize the buffer
-    fossil_soap_sanitize(buffer);
-
     // Print the sanitized error message
     fprintf(stderr, "ERROR: %s\n", buffer);
 

code/logic/fossil/io/soap.h

@@ -15,48 +15,54 @@
 #define FOSSIL_IO_SOAP_H
 
 #include <stdint.h>
+#include <stddef.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /**
- * Sanitize a string by replacing curse words with asterisks.
- * This function scans the input string for offensive words and replaces them with asterisks,
- * thereby making the string suitable for use in contexts where offensive language is not allowed.
- * The input string is modified in place.
+ * @brief Sanitize input text by removing or replacing "rot-brain" and meme-based language.
  *
- * @param input The input string to be sanitized in-place.
+ * @param text The input text to sanitize.
+ * @return A dynamically allocated sanitized string (must be freed by the caller).
  */
-void fossil_soap_sanitize(char *input);
+char *fossil_io_soap_sanitize(const char *text);
 
 /**
- * Check if a word is an offensive word or phrase.
- * Returns EXIT_FAILURE if the word is considered offensive, EXIT_SUCCESS otherwise.
+ * @brief Suggest proper alternatives for rot-brain words or grammar fixes.
+ *
+ * @param text The input text.
+ * @return A dynamically allocated string with suggestions (must be freed by the caller).
  */
-int32_t fossil_soap_is_offensive(const char *word);
+char *fossil_io_soap_suggest(const char *text);
 
 /**
- * Check if a word is meme speak.
- * Returns EXIT_FAILURE if the word is considered meme speak, EXIT_SUCCESS otherwise.
+ * @brief Add a custom word or phrase to the filter.
+ *
+ * @param phrase The phrase to add.
+ * @return 0 on success, nonzero on failure.
  */
-int32_t fossil_soap_is_rotbrain(const char *word);
+int fossil_io_soap_add_custom_filter(const char *phrase);
 
 /**
- * Count offensive words in a string.
- * Returns the number of offensive words found in the input string.
+ * @brief Clear all custom filters.
  */
-int32_t fossil_soap_count_offensive(const char *input);
+void fossil_io_soap_clear_custom_filters(void);
 
 /**
- * Count meme speak words in a string.
- * Returns the number of meme speak words found in the input string.
+ * @brief Detect the tone of a sentence.
+ *
+ * @param text The input text.
+ * @return A string representing the detected tone ("formal", "casual", "sarcastic", etc.).
  */
-int32_t fossil_soap_count_rotbrain(const char *input);
+const char *fossil_io_soap_detect_tone(const char *text);
 
 #ifdef __cplusplus
 }
 
+#include <string>
+
 /**
  * C++ wrapper for the SOAP API.
  */
@@ -72,50 +78,98 @@ namespace fossil {
         class Soap {
         public:
             /**
-             * Sanitize a string by replacing curse words with asterisks.
-             * This function scans the input string for offensive words and replaces them with asterisks,
-             * thereby making the string suitable for use in contexts where offensive language is not allowed.
-             * The input string is modified in place.
+             * Sanitize input text by removing or replacing "rot-brain" and meme-based language.
+             *
+             * @param text The input text to sanitize.
+             * @return A dynamically allocated sanitized string (must be freed by the caller).
+             */
+            static std::string sanitize(const std::string &text) {
+                return fossil_io_soap_sanitize(text.c_str());
+            }
+
+            /**
+             * Suggest proper alternatives for rot-brain words or grammar fixes.
+             *
+             * @param text The input text.
+             * @param format_type Custom format for output (e.g., "*" or "#").
+             * @return A dynamically allocated string with suggestions (must be freed by the caller).
+             */
+            static std::string suggest(const std::string &text) {
+                return fossil_io_soap_suggest(text.c_str());
+            }
+
+            /**
+             * Add a custom word or phrase to the filter.
+             *
+             * @param phrase The phrase to add.
+             * @return 0 on success, nonzero on failure.
+             */
+            static int add_custom_filter(const std::string &phrase) {
+                return fossil_io_soap_add_custom_filter(phrase.c_str());
+            }
+
+            /**
+             * Clear all custom filters.
+             */
+            static void clear_custom_filters() {
+                fossil_io_soap_clear_custom_filters();
+            }
+
+            /**
+             * Detect the tone of a sentence.
              *
-             * @param input The input string to be sanitized in-place.
+             * @param text The input text.
+             * @return A string representing the detected tone ("formal", "casual", "sarcastic", etc.).
              */
-            static void sanitize(char *input) {
-                fossil_soap_sanitize(input);
+            static std::string detect_tone(const std::string &text) {
+                return fossil_io_soap_detect_tone(text.c_str());
             }
 
             /**
-             * Check if a word is an offensive word or phrase.
-             * Returns EXIT_FAILURE if the word is considered offensive, EXIT_SUCCESS otherwise.
+             * Sanitize input text by removing or replacing "rot-brain" and meme-based language.
+             *
+             * @param text The input text to sanitize.
+             * @return A dynamically allocated sanitized string (must be freed by the caller).
              */
-            static int32_t is_offensive(const char *word) {
-                return fossil_soap_is_offensive(word);
+            static char* sanitize(const char* text) {
+                return fossil_io_soap_sanitize(text);
             }
 
             /**
-             * Check if a word is meme speak.
-             * Returns EXIT_FAILURE if the word is considered meme speak, EXIT_SUCCESS otherwise.
+             * Suggest proper alternatives for rot-brain words or grammar fixes.
+             *
+             * @param text The input text.
+             * @param format_type Custom format for output (e.g., "*" or "#").
+             * @return A dynamically allocated string with suggestions (must be freed by the caller).
              */
-            static int32_t is_rotbrain(const char *word) {
-                return fossil_soap_is_rotbrain(word);
+            static char* suggest(const char* text) {
+                return fossil_io_soap_suggest(text);
             }
 
             /**
-             * Count offensive words in a string.
-             * Returns the number of offensive words found in the input string.
+             * Add a custom word or phrase to the filter.
+             *
+             * @param phrase The phrase to add.
+             * @return 0 on success, nonzero on failure.
              */
-            static int32_t count_offensive(const char *input) {
-                return fossil_soap_count_offensive(input);
+            static int add_custom_filter(const char* phrase) {
+                return fossil_io_soap_add_custom_filter(phrase);
             }
 
             /**
-             * Count meme speak words in a string.
-             * Returns the number of meme speak words found in the input string.
+             * Detect the tone of a sentence.
+             *
+             * @param text The input text.
+             * @return A string representing the detected tone ("formal", "casual", "sarcastic", etc.).
              */
-            static int32_t count_rotbrain(const char *input) {
-                return fossil_soap_count_rotbrain(input);
+            static const char* detect_tone(const char* text) {
+                return fossil_io_soap_detect_tone(text);
             }
+
         };
+
     }
+
 }
 
 #endif

code/logic/input.c

@@ -12,7 +12,6 @@
  * -----------------------------------------------------------------------------
  */
 #include "fossil/io/input.h"
-#include "fossil/io/soap.h"
 #include "fossil/io/output.h"
 
 #include <ctype.h>
@@ -54,7 +53,7 @@ void fossil_io_trim(char *str) {
 // Function to get a sanitized line of input from a provided stream (or stdin by default)
 char *fossil_io_gets_from_stream(char *buf, size_t size, FILE *input_stream) {
     if (buf == NULL || size == 0 || input_stream == NULL) {
-        fprintf(stderr, "Error: Invalid buffer or stream\n");
+        fprintf(stderr, "Error: Invalid buffer or stream.\n");
         return NULL;
     }
 
@@ -63,7 +62,7 @@ char *fossil_io_gets_from_stream(char *buf, size_t size, FILE *input_stream) {
         if (feof(input_stream)) {
             return NULL; // End of file reached
         }
-        fprintf(stderr, "Error: Failed to read from input stream\n");
+        fprintf(stderr, "Error: Failed to read from input stream.\n");
         return NULL;
     }
 
@@ -73,9 +72,6 @@ char *fossil_io_gets_from_stream(char *buf, size_t size, FILE *input_stream) {
         buf[len - 1] = '\0'; // Remove the newline character
     }
 
-    // Sanitize the input buffer
-    fossil_soap_sanitize(buf);
-
     // Trim any leading or trailing whitespace
     fossil_io_trim(buf);
 
@@ -84,7 +80,7 @@ char *fossil_io_gets_from_stream(char *buf, size_t size, FILE *input_stream) {
 
 char *fossil_io_gets_from_stream_ex(char *buf, size_t size, FILE *input_stream, int *error_code) {
     if (buf == NULL || size == 0 || input_stream == NULL || error_code == NULL) {
-        fprintf(stderr, "Error: Invalid buffer, stream, or error code\n");
+        fprintf(stderr, "Error: Invalid buffer, stream, or error code.\n");
         return NULL;
     }
 
@@ -95,7 +91,7 @@ char *fossil_io_gets_from_stream_ex(char *buf, size_t size, FILE *input_stream,
             return NULL; // End of file reached
         }
         *error_code = ferror(input_stream);
-        fprintf(stderr, "Error: Failed to read from input stream\n");
+        fprintf(stderr, "Error: Failed to read from input stream.\n");
         return NULL;
     }
 
@@ -105,9 +101,6 @@ char *fossil_io_gets_from_stream_ex(char *buf, size_t size, FILE *input_stream,
         buf[len - 1] = '\0'; // Remove the newline character
     }
 
-    // Sanitize the input buffer
-    fossil_soap_sanitize(buf);
-
     // Trim any leading or trailing whitespace
     fossil_io_trim(buf);
 
@@ -132,7 +125,7 @@ int fossil_io_fscanf(FILE *input_stream, const char *format, ...) {
 
 int fossil_io_validate_input_buffer(const char *buf, size_t size) {
     if (buf == NULL || size == 0) {
-        fprintf(stderr, "Error: Invalid buffer or size\n");
+        fprintf(stderr, "Error: Invalid buffer or size.\n");
         return 0;
     }
     return 1;
@@ -148,7 +141,7 @@ char *fossil_io_gets_utf8(char *buf, size_t size, FILE *input_stream) {
         if (feof(input_stream)) {
             return NULL; // End of file reached
         }
-        fprintf(stderr, "Error: Failed to read from input stream\n");
+        fprintf(stderr, "Error: Failed to read from input stream.\n");
         return NULL;
     }
 
@@ -158,9 +151,6 @@ char *fossil_io_gets_utf8(char *buf, size_t size, FILE *input_stream) {
         buf[len - 1] = '\0'; // Remove the newline character
     }
 
-    // Sanitize the input buffer
-    fossil_soap_sanitize(buf);
-
     // Trim any leading or trailing whitespace
     fossil_io_trim(buf);
 
@@ -250,9 +240,6 @@ int fossil_io_validate_sanitize_string(const char *input, char *output, size_t o
     // Copy the input string to the output buffer
     strncpy(output, input, output_size);
 
-    // Sanitize the output buffer
-    fossil_soap_sanitize(output);
-
     return 1;
 }
 

code/logic/output.c

@@ -12,7 +12,6 @@
  * -----------------------------------------------------------------------------
  */
 #include "fossil/io/output.h"
-#include "fossil/io/soap.h"
 
 #include <stdio.h>
 #include <stdarg.h>
@@ -136,7 +135,6 @@ void fossil_io_puts(const char *str) {
         char sanitized_str[FOSSIL_IO_BUFFER_SIZE];
         strncpy(sanitized_str, str, sizeof(sanitized_str));
         sanitized_str[sizeof(sanitized_str) - 1] = '\0'; // Ensure null termination
-        fossil_soap_sanitize(sanitized_str);
 
         // Print the sanitized string with attributes
         fossil_io_print_with_attributes(sanitized_str);
@@ -164,9 +162,6 @@ void fossil_io_printf(const char *format, ...) {
     char buffer[FOSSIL_IO_BUFFER_SIZE];
     vsnprintf(buffer, sizeof(buffer), format, args);
 
-    // Sanitize the buffer
-    fossil_soap_sanitize(buffer);
-
     // Print the sanitized output with attributes
     fossil_io_print_with_attributes(buffer);