Introducing 'as' keyword

AntoineLandrieux · AntoineLandrieux · commit bbbb628513de · 2025-10-26T18:40:35.000+01:00
diff --git a/CHANGELOG b/CHANGELOG
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,16 @@
+
+# SOARE Changelog
+
+---
+
+## v1.0.0+
+
+- First SOARE release
+
+## v1.2.0+
+
+- Implement external/custom functions and keywords
+
+## v1.2.3+
+
+- Introducing `as` keyword
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,20 @@
+
+# Contributor Code of Conduct
+
+## Our Commitment
+
+We are committed to providing a friendly, safe, and welcoming environment, regardless of age, body type, disability, ethnicity, etc.
+
+## Our Standards
+
+**Examples of positive behavior**:
+
+- Use welcoming and inclusive language
+- Respect different points of view
+- Accept constructive criticism
+
+## Reporting
+
+If you witness or experience inappropriate behavior, please contact us privately.
+
+Thank you for contributing to a healthy and respectful project! ❤️
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,18 @@
+
+# Contribute to `SOARE`
+
+If you wish to contribute to the project, I recommend focusing on the features outlined in the [TODO.md](TODO.md) and [issues](https://github.com/AntoineLandrieux/SOARE/issues).
+
+## Contribution Process
+
+1. Fork this repository
+2. Create a branch (`feature/my-new-feature`)
+3. Commit your changes
+4. Push your branch
+5. Open a Pull Request
+
+## Coding rules
+
+- Respect the project style
+- 1 feature = 1 Pull Request
+- Provide unit tests if possible
diff --git a/README.md b/README.md
@@ -24,7 +24,8 @@ soareinfo();
 ## 📖 Documentation
 
 > [!IMPORTANT]
-> See [SOARE Documentation](doc/documentation.md) and [SOARE Changelog](CHANGELOG)
+> See [SOARE Documentation](doc/documentation.md) and [SOARE Changelog](CHANGELOG.md)
+>
 
 ## 🛠️ Recommended tools
 
@@ -51,6 +52,11 @@ soareinfo();
 The SOARE source code is located in the Git repository at [github.com/AntoineLandrieux/SOARE](https://github.com/AntoineLandrieux/SOARE/).
 Contributions are most welcome by forking the repository and sending a pull request.
 
+> [!IMPORTANT]
+>
+> Please read the [Code of Conduct](CODE_OF_CONDUCT.md) and [contribution guidelines](CONTRIBUTING.md)
+>
+
 ## 📜 Credit
 
 See **[AUTHORS file](AUTHORS)**
diff --git a/TODO.md b/TODO.md
@@ -0,0 +1,18 @@
+
+# TODO
+
+## ✅/❌ Important Task List
+
+- [ ] Possibility of having more than 100 custom keywords/functions
+
+## ✅/❌ Optional Task List
+
+- [ ] Create more professional unit tests
+
+## 🧑‍💻 In progress
+
+- [ ] Possibility of having more than 100 custom keywords/functions
+
+## ✅ Done
+
+- [X] Introducing `as` keyword
diff --git a/core/Error.c b/core/Error.c
@@ -22,6 +22,9 @@ static unsigned char enable = 1;
 /* Error level */
 static char errorlevel = EXIT_SUCCESS;
 
+/* Last Error */
+static char *lasterror = "NoError";
+
 /* Exceptions */
 static char *Exceptions[] = {
 
@@ -71,6 +74,16 @@ void ClearException(void)
     errorlevel = EXIT_SUCCESS;
 }
 
+/**
+ * @brief Get last error
+ *
+ * @return char*
+ */
+char *GetError(void)
+{
+    return lasterror;
+}
+
 /**
  * @brief Returns the error level
  *
@@ -91,6 +104,11 @@ char ErrorLevel(void)
  */
 void *LeaveException(SoareExceptions error, char *string, Document file)
 {
+    // Set lasterror
+    lasterror = Exceptions[error];
+    // Set error at level EXIT_FAILURE (1)
+    errorlevel = EXIT_FAILURE;
+
     // If the errors are disabled, nothing is displayed
     if (enable)
     {
@@ -103,7 +121,7 @@ void *LeaveException(SoareExceptions error, char *string, Document file)
             //
             __soare_stderr,
             "\aExcept: %s\n\t\"%.13s\"\n\t ^~~~\n\tAt file %s:%lld:%lld\n",
-            Exceptions[error],
+            lasterror,
             string,
             file.file,
             file.ln,
@@ -117,7 +135,5 @@ void *LeaveException(SoareExceptions error, char *string, Document file)
 #endif /* __SOARE_COLORED_OUTPUT */
     }
 
-    // Set error at level EXIT_FAILURE (1)
-    errorlevel = EXIT_FAILURE;
     return NULL;
 }
diff --git a/core/Parser.c b/core/Parser.c
@@ -439,6 +439,19 @@ AST Parse(Tokens *tokens)
                 Node *iferror = Branch(NULL, NODE_IFERROR, old->file);
                 BranchJoin(curr->parent, iferror);
                 curr = iferror;
+
+                // iferror as <varname>
+                if (!strcmp(tokens->value, KEYWORD_AS) && tokens->type == TKN_KEYWORD)
+                {
+                    tokens = tokens->next;
+
+                    if (tokens->type != TKN_NAME)
+                        return LeaveException(SyntaxError, old->value, old->file);
+
+                    BranchJoin(curr, Branch(tokens->value, NODE_STRERROR, old->file));
+
+                    tokens = tokens->next;
+                }
             }
 
             else if (!strcmp(old->value, KEYWORD_IF) || !strcmp(old->value, KEYWORD_WHILE))
diff --git a/core/Runtime.c b/core/Runtime.c
@@ -212,6 +212,11 @@ static char *Runtime(AST tree)
             // Raise an exception
             return ExitStatementError(statement, RaiseException, curr->value, curr->file);
 
+        case NODE_STRERROR:
+            // Store error
+            MemPush(statement, curr->value, strdup(GetError()));
+            break;
+
         case NODE_IMPORT:
         {
             // Import external file and merge its AST
diff --git a/core/Tokenizer.c b/core/Tokenizer.c
@@ -108,6 +108,7 @@ static inline unsigned char strKeyword(char *string)
 {
     return (
         //
+        !strcmp(KEYWORD_AS, string) ||
         !strcmp(KEYWORD_DO, string) ||
         !strcmp(KEYWORD_FN, string) ||
         !strcmp(KEYWORD_IF, string) ||
@@ -340,7 +341,7 @@ void TokensLog(Tokens *token)
      * [TOKENS] [test.soare:00001:00001, 09, "write"]
      * [TOKENS] [test.soare:00001:00007, 03, "Hello"]
      * [TOKENS] [test.soare:00001:00014, 0B, ";"]
-     * [TOKENS] [test.soare:00000:00000, 00, "(null)"]
+     * [TOKENS] [test.soare:00000:00000, 00, "EOF"]
      *
      */
 
@@ -555,6 +556,7 @@ Tokens *Tokenizer(char *__restrict__ filename, char *__restrict__ text)
         col += type == TKN_STRING;
     }
 
+    curr->value = strdup("EOF");
     // Return token
     return token;
 }
diff --git a/doc/documentation.md b/doc/documentation.md
@@ -12,7 +12,7 @@
   - [Interpreter Commands](#interpreter-commands)
   - [Add Interpreter keywords/functions in C/C++](#add-interpreter-keywordsfunctions-in-cc)
   - [Loading a File](#loading-a-file)
-  - [Create your own interpreter]
+  - [Create your own interpreter](#create-your-own-interpreter)
 
 - [SOARE](#soare)
 
@@ -381,7 +381,7 @@ fn fib(n)
   return a;
 end;
 
-write("The last value is "; fib(100));
+write("The last value is ", fib(100));
 ```
 
 The `fn` keyword introduces a function definition. It must be followed by the function name and the list of formal parameters in parentheses and separated by a ;.
@@ -453,20 +453,21 @@ try
   ? Include standard functions like NaN (Not a Number)
   loadimport "script/math.soare";
 
-  let x = input("Enter a digit: ");
+  let x = input("Enter a number: ");
 
   if NaN(x) do
-    write("\nNot a number");
+    write("Not a number\n");
+  or x > 0 do
+    write("Positive\n");
   or x < 0 do
-    write("\nNegative");
-  or x == 0 do
-    write("\nZero");
+    write("Negative\n");
   else
-    write("\nPositive");
+    write("Zero\n");
   end;
 
-iferror
-  write("std.soare not found!")
+? Store the name of the error in the variable "error"
+iferror as error
+  werr("Error: "; error)
 end;
 ```
 
@@ -496,7 +497,7 @@ write(msg[0-2]; '\n'); ? Write the one before last character of "msg", here "d"
 
 ### User Inputs
 
-You can capture user input using `input`
+You can capture user input using `input()`
 
 ```soare
 let usr = input("Enter your name: ");
diff --git a/include/SOARE/SOARE.h b/include/SOARE/SOARE.h
@@ -21,7 +21,7 @@
 /* SOARE minor */
 #define SOARE_MINOR 2
 /* SOARE patch */
-#define SOARE_PATCH 2
+#define SOARE_PATCH 3
 
 /**
  * SOARE version
@@ -33,7 +33,7 @@
  * T: testing
  *
  */
-#define SOARE_VERSION "Rv1.2.2"
+#define SOARE_VERSION "Rv1.2.3"
 
 /* SOARE max input */
 #define __SOARE_MAX_INPUT__ 255
diff --git a/include/SOARE/core/error.h b/include/SOARE/core/error.h
@@ -59,6 +59,13 @@ void IgnoreException(unsigned char ignore);
  */
 void ClearException(void);
 
+/**
+ * @brief Get last error
+ *
+ * @return char*
+ */
+char *GetError(void);
+
 /**
  * @brief Returns the error level
  *
diff --git a/include/SOARE/core/parser.h b/include/SOARE/core/parser.h
@@ -41,6 +41,7 @@ typedef enum node_type
     NODE_REPETITION,
     NODE_BREAK,
     NODE_RETURN,
+    NODE_STRERROR,
     NODE_CUSTOM_KEYWORD
 
 } node_type;
diff --git a/include/SOARE/utils/keywords.h b/include/SOARE/utils/keywords.h
@@ -20,6 +20,7 @@
  * List of keywords (alpha-numeric order)
  */
 
+#define KEYWORD_AS          "as"
 #define KEYWORD_BREAK       "break"
 #define KEYWORD_DO          "do"
 #define KEYWORD_ELSE        "else"
diff --git a/script/math.min.soare b/script/math.min.soare
@@ -1,10 +1,10 @@
-let pi=3.14159265;let deg=180/pi;let rad=pi/180;fn M(f)return f;end;fn Math(f)return f*1;end;fn NaN(x)let i=0;while 1 do try let num=ord(x[i]);if num>=
-48&&num<=57 do i=i+1;else return 1;end;iferror break;end;end;return 0;end;fn abs(x)if x<0 do return x*M(0-1);end;return Math(x);end;fn not(x)return 
-x==0;end;fn floor(float)return float^0;end;fn integer_division(x;y)let res=0;while x>=y do x=x-y;res=res+1;end;return res;end;fn round(x)let sign=x<0
-;let y=abs(x);let t=floor(y);if sign do sign=0-1;else sign=1;end;if y-t>=0.5 do return sign*M(t+1);end;return sign*t;end;fn integer_sqrt(x)x=round(x);
-if x==0 do return 0;or x<0 do raise "Non-Real Number";end;let n=x;let a=0;while 1 do a=integer_division(n+integer_division(x;n);2)if a==n do return 
-n;end;n=a;end;end;fn pow(x;y)let res=1;let neg=y<0;y=floor(abs(y));while y do res=res*x;y=y-1;end;if neg do res=1/res;end;return res;end;fn factorial
-(x)let res=1;let n=1;x=floor(x);if x<0 do raise "Undefined";end;while n<x+1 do res=res*n;n=n+1;end;return res;end;fn radians(x)return x*rad;end;fn degrees
-(x)return x*deg;end;fn sin(x)let sine=0;let n=0;x=radians(x%180)while n<10 do sine=sine+pow(0-1;n)*pow(x;2*n+1)/factorial(2*n+1);n=n+1;end;return 
-sine;end;fn cos(x)let cosine=0;let n=0;x=radians(x%180);while n<10 do cosine=cosine+pow(0-1;n)*pow(x;2*n)/factorial(2*n);n=n+1;end;return cosine;end
-;fn tan(x)return sin(x)/cos(x);end;
+let pi=3.14159265;let deg=180/pi;let rad=pi/180;fn M(f)return f;end;fn Math(f)return f*1;end;fn NaN(x)let i=0;try if x[0]=='-'||x[0]=='+'do i=1;end;end
+;while 1 do try let num=ord(x[i]);if num>=48&&num<=57 do i=i+1;else return 1;end;iferror break;end;end;return 0;end;fn abs(x)if x<0 do return x*M(0-
+1);end;return Math(x);end;fn not(x)return x==0;end;fn floor(float)return float^0;end;fn integer_division(x;y)let res=0;while x>=y do x=x-y;res=res+1;
+end;return res;end;fn round(x)let sign=x<0;let y=abs(x);let t=floor(y);if sign do sign=0-1;else sign=1;end;if y-t>=0.5 do return sign*M(t+1);end;return 
+sign*t;end;fn integer_sqrt(x)x=round(x);if x==0 do return 0;or x<0 do raise "Non-Real Number";end;let n=x;let a=0;while 1 do a=integer_division(n+
+integer_division(x;n);2)if a==n do return n;end;n=a;end;end;fn pow(x;y)let res=1;let neg=y<0;y=floor(abs(y));while y do res=res*x;y=y-1;end;if neg do 
+res=1/res;end;return res;end;fn factorial(x)let res=1;let n=1;x=floor(x);if x<0 do raise "Undefined";end;while n<x+1 do res=res*n;n=n+1;end;return res
+;end;fn radians(x)return x*rad;end;fn degrees(x)return x*deg;end;fn sin(x)let sine=0;let n=0;x=radians(x%180)while n<10 do sine=sine+pow(0-1;n)*pow
+(x;2*n+1)/factorial(2*n+1);n=n+1;end;return sine;end;fn cos(x)let cosine=0;let n=0;x=radians(x%180);while n<10 do cosine=cosine+pow(0-1;n)*pow(x;2*n)
+/factorial(2*n);n=n+1;end;return cosine;end;fn tan(x)return sin(x)/cos(x);end;
diff --git a/script/math.soare b/script/math.soare
@@ -47,6 +47,11 @@ end;
 ? Returns true if a value is Not-a-Number
 fn NaN(x)
   let i = 0;
+  try
+    if x[0] == '-' || x[0] == '+' do
+      i = 1;
+    end;
+  end;
   while 1 do
     try
       let num = ord(x[i]);
diff --git a/test/try-iferror.soare b/test/try-iferror.soare
@@ -2,20 +2,20 @@
 ? Hello World
 try
   write('Hello World!\n');
-iferror
-  werr('Error ! (issue)\n');
+iferror as err
+  werr('Error ! (issue): '; err; '\n');
 end;
 
 ? Error ! #2 Error value: RaiseException
 try
   raise 'problem';
-iferror
-  werr('Error ! (normal)\n');
+iferror as err
+  werr('Error ! (normal): '; err; '\n');
 end;
 
 ? Error ! #3 Error value: DivideByZero
 try
   write(3/0);
-iferror
-  werr('Error ! (normal)\n');
+iferror as err
+  werr('Error ! (normal): '; err; '\n');
 end;

Original file line number	Diff line number	Diff line change
`@@ -108,6 +108,7 @@ static inline unsigned char strKeyword(char *string)`
`108`	`108`	`{`
`109`	`109`	`return (`
`110`	`110`	`//`
	`111`	`+ !strcmp(KEYWORD_AS, string) \|\|`
`111`	`112`	`!strcmp(KEYWORD_DO, string) \|\|`
`112`	`113`	`!strcmp(KEYWORD_FN, string) \|\|`
`113`	`114`	`!strcmp(KEYWORD_IF, string) \|\|`
`@@ -340,7 +341,7 @@ void TokensLog(Tokens *token)`
`340`	`341`	`* [TOKENS] [test.soare:00001:00001, 09, "write"]`
`341`	`342`	`* [TOKENS] [test.soare:00001:00007, 03, "Hello"]`
`342`	`343`	`* [TOKENS] [test.soare:00001:00014, 0B, ";"]`
`343`		`- * [TOKENS] [test.soare:00000:00000, 00, "(null)"]`
	`344`	`+ * [TOKENS] [test.soare:00000:00000, 00, "EOF"]`
`344`	`345`	`*`
`345`	`346`	`*/`
`346`	`347`
`@@ -555,6 +556,7 @@ Tokens Tokenizer(char __restrict__ filename, char *__restrict__ text)`
`555`	`556`	`col += type == TKN_STRING;`
`556`	`557`	`}`
`557`	`558`
	`559`	`+ curr->value = strdup("EOF");`
`558`	`560`	`// Return token`
`559`	`561`	`return token;`
`560`	`562`	`}`