Add custom function/keyword | Rv1.2.0

Author: AntoineLandrieux

.github/workflows/c-cpp.yml

@@ -37,7 +37,7 @@ jobs:
       uses: actions/checkout@v4
 
     - name: Install dependencies
-      run: sudo apt-get install -y build-essential binutils
+      run: sudo apt-get install -y build-essential binutils make
 
     - name: Build project
       run: make

CHANGELOG

@@ -6,3 +6,8 @@ SOARE Changelog
 - v1.0.0
 
 First SOARE release
+
+- v1.2.0
+
+First SOARE release
+

Makefile

@@ -12,7 +12,7 @@
 #
 
 APP = soare
-VERSION_MAJ = 1
+VERSION_MAJOR = 1
 
 AR = ar
 CC = gcc
@@ -26,6 +26,7 @@ INCLUDE = include
 CFLAGS := -Wall
 CFLAGS += -Wextra
 CFLAGS += -Wno-unused-result
+CFLAGS += -Wno-unused-parameter
 CFLAGS += -Wno-implicit-fallthrough
 
 ifeq ($(OS), Windows_NT)
@@ -41,7 +42,7 @@ SOARE_FLAGS += -D __SOARE_COLORED_OUTPUT
 
 default: $(BIN)/$(APP)
 
-$(LIB)/libsoare$(VERSION_MAJ).a: $(CORE_OBJS)
+$(LIB)/libsoare$(VERSION_MAJOR).a: $(CORE_OBJS)
 
 CORE_OBJS := $(patsubst $(CORE)/%.c, $(LIB)/%.o, $(wildcard $(CORE)/*.c))
 
@@ -54,8 +55,8 @@ $(LIB)/%.o: $(CORE)/%.c
 $(BIN)/$(APP): $(LIB) $(CORE_OBJS) $(SRC)/Main.c
 	mkdir -p $(BIN)
 	$(WINDRES) windows/resources/app.rc -coff $(RES)
-	$(AR) rcs $(LIB)/libsoare$(VERSION_MAJ).a $(CORE_OBJS)
-	$(CC) $(RES) $(SRC)/Main.c -o $(BIN)/$(APP) -I $(INCLUDE) -L$(LIB) -lsoare$(VERSION_MAJ) $(CFLAGS) $(SOARE_FLAGS)
+	$(AR) rcs $(LIB)/libsoare$(VERSION_MAJOR).a $(CORE_OBJS)
+	$(CC) $(RES) $(SRC)/*.c -o $(BIN)/$(APP) -I $(INCLUDE) -L$(LIB) -lsoare$(VERSION_MAJOR) $(CFLAGS) $(SOARE_FLAGS)
 	rm $(CORE_OBJS) $(RES)
 
 run:

README.md

@@ -7,14 +7,19 @@ SOARE is distributed under the [MIT License](LICENSE).
 
 ## 📖 Documentation
 
-> [!IMPORTANT]  
+> [!IMPORTANT]
 > See [SOARE Documentation](doc/documentation.md) and [SOARE Changelog](CHANGELOG)
 
 ## 🧑‍💻 INTERPRETER
 
 ```txt
+
 ? This is your first SOARE code !
-write "Hello World!";
+write("Hello World!");
+
+? SOARE information
+soareinfo();
+
 ```
 
 ## 🛠️ Recommended tools

core/Custom.c

@@ -0,0 +1,254 @@
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+/**
+ *  _____  _____  ___  ______ _____
+ * /  ___||  _  |/ _ \ | ___ \  ___|
+ * \ `--. | | | / /_\ \| |_/ / |__
+ *  `--. \| | | |  _  ||    /|  __|
+ * /\__/ /\ \_/ / | | || |\ \| |___
+ * \____/  \___/\_| |_/\_| \_\____/
+ *
+ * Antoine LANDRIEUX (MIT License) <Custom.c>
+ * <https://github.com/AntoineLandrieux/SOARE/>
+ *
+ */
+
+#include <SOARE/SOARE.h>
+
+/*
+
+==============================================================
+Example: Custom Function - Add Numbers with Variable Arguments
+==============================================================
+
+This example demonstrates how to implement a custom function
+that adds together an unknown number of integer arguments.
+
+----------------------------------------------------------
+Function Name:
+    char *int_add(soare_arguments_list args)
+
+Arguments:
+    - args: A linked list of arguments passed to the function.
+        Use soare_getarg(args, i) to retrieve the i-th argument
+        as a string.
+
+Return Value:
+    - Returns NULL (no value returned to SOARE).
+    - If you want to return a value, allocate memory for the
+        result string before returning.
+
+----------------------------------------------------------
+Implementation Steps:
+    1. Initialize result accumulator.
+    2. Loop through arguments using soare_getarg.
+    3. Convert each argument from string to integer.
+    4. Add to result.
+    5. Print the result.
+    6. Return NULL (or a string if needed).
+
+----------------------------------------------------------
+Memory Management:
+    - If returning a string, always allocate memory for it.
+    - Example:
+        char *ret = malloc(6 * sizeof(char));
+        if (!ret)
+            return NULL;
+        strcpy(ret, "value");
+        return ret;
+
+----------------------------------------------------------
+Code:
+----------------------------------------------------------
+
+char *int_add(soare_arguments_list args)
+{
+    // Accumulator for the sum
+    int result = 0;
+    // Pointer to current argument string
+    char *x = NULL;
+
+    // Loop through all arguments
+    for (int i = 0; 1; i++)
+    {
+        // Retrieve the i-th argument
+        x = soare_getarg(args, i);
+        if (!x)
+            // Exit loop if no more arguments
+            break;
+
+        // Convert argument to integer and add to result
+        result += atoi(x);
+    }
+
+    // Output the result to the console
+    printf("%d", result);
+
+    // Return NULL (no value returned to SOARE)
+    // If you need to return a value, allocate memory as shown above
+    return NULL;
+}
+
+Implement this function: soare_addfunction(<function name>, <function>)
+
+soare_addfunction("int_add", int_add);
+
+----------------------------------------------------------
+
+*/
+
+/* Functions */
+static struct soare_functions functions_list[100];
+/* Count */
+static size_t functions_count = 0;
+
+/**
+ * @brief Add defined function
+ *
+ * @param name
+ * @param function
+ * @return unsigned int
+ */
+unsigned int soare_addfunction(char *name, char *(*function)(soare_arguments_list))
+{
+    if (functions_count >= 99 || !name || !function)
+        return 0;
+
+    struct soare_functions fn = {name, function};
+
+    functions_list[functions_count] = fn;
+    functions_list[functions_count + 1].name = NULL;
+
+    functions_count = functions_count + 1;
+    return functions_count;
+}
+
+/**
+ * @brief Get defined function
+ *
+ * @param name
+ * @return soare_function
+ */
+soare_function soare_getfunction(char *name)
+{
+    static soare_function none = {NULL, NULL};
+
+    if (!name)
+        return none;
+
+    for (size_t i = 0; i < functions_count; i++)
+        if (!strcmp(functions_list[i].name, name))
+            return functions_list[i];
+
+    return none;
+}
+
+/**
+ * @brief Get argument from a function call
+ *
+ * @param args
+ * @param position
+ * @return char*
+ */
+char *soare_getarg(soare_arguments_list args, unsigned int position)
+{
+    for (; position && args; position--)
+        args = args->sibling;
+    return Eval(args);
+}
+
+/*
+
+==============================================================
+Example: Custom Keyword - Clear screen
+==============================================================
+
+This example demonstrates how to implement a custom keyword.
+
+----------------------------------------------------------
+Function Name:
+    void clear(void)
+
+----------------------------------------------------------
+Code:
+----------------------------------------------------------
+
+void clear(void)
+{
+    // ANSI escape code to clear the screen
+    printf("\033c\033[3J");
+}
+
+Implement this keyword: soare_addkeyword(<keyword name>, <function>)
+
+soare_addkeyword("clear", clear);
+
+----------------------------------------------------------
+
+*/
+
+/* Keyword */
+static struct soare_keywords keywords_list[100];
+/* Count */
+static size_t keywords_count = 0;
+
+/**
+ * @brief Add defined keyword
+ *
+ * @param name
+ * @param keyword
+ * @return unsigned int
+ */
+unsigned int soare_addkeyword(char *name, void (*keyword)(void))
+{
+    if (keywords_count >= 99 || !name || !keyword)
+        return 0;
+
+    struct soare_keywords fn = {name, keyword};
+
+    keywords_list[keywords_count] = fn;
+    keywords_list[keywords_count + 1].name = NULL;
+
+    keywords_count = keywords_count + 1;
+    return keywords_count;
+}
+
+/**
+ * @brief Get defined keyword
+ *
+ * @param name
+ * @return soare_keyword
+ */
+soare_keyword soare_getkeyword(char *name)
+{
+    static soare_keyword none = {NULL, NULL};
+
+    if (!name)
+        return none;
+
+    for (size_t i = 0; i < keywords_count; i++)
+        if (!strcmp(keywords_list[i].name, name))
+            return keywords_list[i];
+
+    return none;
+}
+
+/**
+ * @brief Check if a keyword exists
+ *
+ * @param name
+ * @return unsigned char
+ */
+unsigned char soare_iskeyword(char *name)
+{
+    if (!name)
+        return 0;
+
+    for (size_t i = 0; i < keywords_count; i++)
+        if (!strcmp(keywords_list[i].name, name))
+            return 1;
+
+    return 0;
+}

core/Error.c

@@ -103,7 +103,7 @@ void *LeaveException(SoareExceptions error, char *string, Document file)
         soare_write(
             //
             __soare_stderr,
-            "Except: %s\n\t\"%.13s\"\n\t ^~~~\n\tAt file %s:%lld:%lld\n",
+            "\aExcept: %s\n\t\"%.13s\"\n\t ^~~~\n\tAt file %s:%lld:%lld\n",
             Exceptions[error],
             string,
             file.file,
@@ -120,9 +120,5 @@ void *LeaveException(SoareExceptions error, char *string, Document file)
 
     // Set error at level EXIT_FAILURE (1)
     errorlevel = EXIT_FAILURE;
-
-    // Store the error in the `__ERROR__` variable
-    MemSet(MemGet(MEMORY, "__ERROR__"), strdup(Exceptions[error]));
-
     return NULL;
 }

core/Math.c

@@ -107,7 +107,7 @@ static void zeros(char *string)
  */
 static char *__int(int number)
 {
-    // Convert long double to string
+    // Convert int to string
     char string[100] = {0};
     sprintf(string, "%d", number);
 

core/Memory.c

@@ -27,7 +27,7 @@ MEM MEMORY = NULL;
  */
 MEM Mem(void)
 {
-    MEM memory = (mem*)malloc(sizeof(struct mem));
+    MEM memory = (mem *)malloc(sizeof(struct mem));
 
     if (!memory)
         return __SOARE_OUT_OF_MEMORY();
@@ -142,6 +142,8 @@ MEM MemSet(MEM memory, char *value)
     return memory;
 }
 
+#ifdef __SOARE_DEBUG
+
 /**
  * @brief Display all variables
  *
@@ -159,6 +161,8 @@ void MemLog(MEM memory)
     MemLog(memory->next);
 }
 
+#endif /* __SOARE_DEBUG */
+
 /**
  * @brief Join 2 memories
  *