small changes

.github/workflows/test.yml

@@ -50,7 +50,6 @@ jobs:
       - name: Install snowball
         run: |
           set -x
-          sudo make install
           mkdir -p ~/.snowball
           cp -r stdlib/ ~/.snowball/stdlib
           ls ~/.snowball

stdlib/Assert.sn

@@ -20,7 +20,7 @@
  * You can use this class to capture and handle assertion failures in your code.
  */
 public class AssertionError extends Exception 
-  { }
+  { /* ._. nothing to see here! 👋 */ }
 /**
  * @macro assert
  * @brief Asserts a condition.
@@ -35,16 +35,45 @@ public class AssertionError extends Exception
  * and is used to provide additional context when the assertion fails.
  *
  * @throws AssertionError if the provided condition is false. The error message will
- * contain the specified message or a default message if none is provided.
+ *  contain the specified message or a default message if none is provided.
  *
  * Example Usage:
  * ```c
- * #assert(x > 0, "x must be greater than 0");
+ * assert!(x > 0, "x must be greater than 0");
  * ```
  */
 @export
 macro assert(condition: expr, message: const[str] = "Assertion failed!") {
+  // todo: Should this be inside a macro or a function?
   if !(#condition) {
+    // We use the `pkg!` macro here to ensure that the `AssertionError` class is
+    // properly imported into the current scope.
     throw pkg!(new AssertionError(#message));
   }
-}
+}
+/**
+ * @macro assert_eq
+ * @brief Asserts that two values are equal.
+ * 
+ * The `assert_eq` macro is used to check whether two values are equal. If the values
+ * are not equal, an `AssertionError` exception is thrown, allowing you to capture
+ * and handle the assertion failure. This macro is a fundamental tool for validating
+ * assumptions and ensuring the correctness of your code.
+ * 
+ * @param[in] left The left-hand side of the equality check.
+ * @param[in] right The right-hand side of the equality check.
+ * @param[in] message The message to display if the assertion fails. This message is optional
+ *  and is used to provide additional context when the assertion fails.
+ * 
+ * @throws AssertionError if the provided values are not equal. The error message will
+ *  contain the specified message or a default message if none is provided.
+ * @note Both values must support the `==` operator.
+*/
+@export
+macro assert_eq(left: expr, right: expr, message: const[str] = "Assertion failed!") {
+  if !(#left == #right) {
+    // We use the `pkg!` macro here to ensure that the `AssertionError` class is
+    // properly imported into the current scope.
+    throw pkg!(new AssertionError(#message));
+  }
+}

stdlib/CLib.sn

@@ -2,14 +2,43 @@
  * @file Common bindings for the C standard library
  */
 
+/**
+ * @brief C equivalent of an unknown pointer type.
+ * @note This type is used to represent a pointer to an unknown type.
+ * It is used in situations where the type of the pointer is not known.
+ * For example, when calling a C function that returns a pointer to an unknown type.
+ */
 public type c_obj = *const void;
+/**
+ * @brief C equivalent of an i32.
+ * @note This type is used to represent a 32-bit signed integer.
+ */
 public type c_int = i32;
+/**
+ * @brief C equivalent of an i8.
+ * @note This type is used to represent an 8-bit signed integer.
+ */
 public type c_char = i8;
-public type c_bool = bool;
+/**
+ * @brief C equivalent of a float (32-bit).
+ * @note This type is used to represent a 32-bit floating point number.
+ */
 public type c_float = f32;
+/**
+ * @brief C equivalent of a double (64-bit).
+ * @note This type is used to represent a 64-bit floating point number.
+ */
 public type c_double = f64;
+/**
+ * @brief C equivalent of a long (64-bit).
+ * @note This type is used to represent a 64-bit signed integer.
+ */
 public type c_long = i64;
-// TODO: add more types
+/**
+ * @brief C equivalent of a long long (128-bit).
+ * @note This type is used to represent a 128-bit signed integer.
+ */
+public type c_long_long = i128;
 
 /**
  * @brief Allocates size bytes of uninitialized storage.
@@ -192,15 +221,3 @@ public external unsafe func strcpy(*const c_char, *const c_char) *const c_char;
 public external unsafe func strcat(*const c_char, *const c_char) *const c_char;
 } // namespace c_string
 
-/**
- * @brief a namespace that contains some utility math functions.
-*/
-namespace cmath {
-/**
- * @brief It converts a string into a double.
- * @param str(&char) - string to be converted
-
- * @return f64 - number
-*/
-public external unsafe func strtod(*const c_char, c_obj) f64;
-}

stdlib/Char.sn

@@ -7,8 +7,8 @@
  */
 @inline
 public func is_space(c: u8) bool {
-    return c == ' ' || c == '\t' 
-       || c == '\n' || c == '\r';
+  return c == ' ' || c == '\t' 
+     || c == '\n' || c == '\r';
 }
 /**
  * Returns true if the given character is an
@@ -31,7 +31,7 @@ public func is_upper(c: u8) bool
  */
 @inline
 public func is_lower(c: u8) bool
-    { return c >= 'a' && c <= 'z'; }
+  { return c >= 'a' && c <= 'z'; }
 /**
  * Returns true if the given character is a
  *  digit.
@@ -42,7 +42,7 @@ public func is_lower(c: u8) bool
  */
 @inline
 public func is_digit(c: u8) bool
-    { return c >= '0' && c <= '9'; }
+  { return c >= '0' && c <= '9'; }
 /**
  * Returns true if the given character is a
  *  hexadecimal digit.
@@ -53,8 +53,8 @@ public func is_digit(c: u8) bool
  */
 @inline
 public func is_hex(c: u8) bool { 
-    return is_digit(c) || (c >= 'a' && c <= 'f') 
-      || (c >= 'A' && c <= 'F'); 
+  return is_digit(c) || (c >= 'a' && c <= 'f') 
+    || (c >= 'A' && c <= 'F'); 
 }
 /**
  * Returns true if the given character is an
@@ -66,7 +66,7 @@ public func is_hex(c: u8) bool {
  */
 @inline
 public func is_oct(c: u8) bool
-    { return c >= '0' && c <= '7'; }
+  { return c >= '0' && c <= '7'; }
 /**
  * Returns true if the given character is a
  *  letter.
@@ -77,7 +77,7 @@ public func is_oct(c: u8) bool
  */
 @inline
 public func is_alpha(c: u8) bool
-    { return is_upper(c) || is_lower(c); }
+  { return is_upper(c) || is_lower(c); }
 /**
  * Returns true if the given character is a
  *  letter or digit.
@@ -88,7 +88,7 @@ public func is_alpha(c: u8) bool
  */
 @inline
 public func is_alpha_num(c: u8) bool
-    { return is_alpha(c) || is_digit(c); }
+  { return is_alpha(c) || is_digit(c); }
 /**
  * Returns true if the given character is a
  *  control character.
@@ -99,7 +99,7 @@ public func is_alpha_num(c: u8) bool
  */
 @inline
 public func is_control(c: u8) bool
-    { return c < 32 || c == 127; }
+  { return c < 32 || c == 127; }
 /**
  * Returns true if the given character is a
  *  printable character.
@@ -110,7 +110,7 @@ public func is_control(c: u8) bool
  */
 @inline
 public func is_print(c: u8) bool
-    { return !is_control(c); }
+  { return !is_control(c); }
 /**
  * Returns true if the given character is a
  *  punctuation character.
@@ -121,17 +121,18 @@ public func is_print(c: u8) bool
  */
 @inline
 public func is_punc(c: u8) bool {
-    return c == '!' || c == '"' || c == '#' 
-      || c == '$' || c == '%' || c == '&' 
-      || c == '\'' || c == '(' || c == ')' 
-      || c == '*' || c == '+' || c == ',' 
-      || c == '-' || c == '.' || c == '/' 
-      || c == ':' || c == ';' || c == '<' 
-      || c == '=' || c == '>' || c == '?' 
-      || c == '@' || c == '[' || c == '\\' 
-      || c == ']' || c == '^' || c == '_' 
-      || c == '`' || c == '{' || c == '|' 
-      || c == '}' || c == '~';
+  // TODO: faster implementation
+  return c == '!' || c == '"' || c == '#' 
+    || c == '$' || c == '%' || c == '&' 
+    || c == '\'' || c == '(' || c == ')' 
+    || c == '*' || c == '+' || c == ',' 
+    || c == '-' || c == '.' || c == '/' 
+    || c == ':' || c == ';' || c == '<' 
+    || c == '=' || c == '>' || c == '?' 
+    || c == '@' || c == '[' || c == '\\' 
+    || c == ']' || c == '^' || c == '_' 
+    || c == '`' || c == '{' || c == '|' 
+    || c == '}' || c == '~';
 }
 /**
  * Returns true if the given character is a
@@ -143,12 +144,12 @@ public func is_punc(c: u8) bool {
  */
 @inline
 public func is_sym(c: u8) bool {
-    return c == '+' || c == '-' || c == '*' 
-      || c == '/' || c == '\\' || c == '|' 
-      || c == '&' || c == '^' || c == '<' 
-      || c == '>' || c == '=' || c == '~' 
-      || c == '@' || c == '$' || c == '%' 
-      || c == '!' || c == '?';
+  return c == '+' || c == '-' || c == '*' 
+    || c == '/' || c == '\\' || c == '|' 
+    || c == '&' || c == '^' || c == '<' 
+    || c == '>' || c == '=' || c == '~' 
+    || c == '@' || c == '$' || c == '%' 
+    || c == '!' || c == '?';
 }
 /**
  * Returns true if the given character is a
@@ -160,14 +161,14 @@ public func is_sym(c: u8) bool {
  */
 @inline
 public func is_mark(c: u8) bool {
-    return c == '`' || c == '\'' || c == '^' 
-      || c == '"' || c == '~' || c == '.' 
-      || c == '-' || c == '_' || c == '*' 
-      || c == '+' || c == '=' || c == '<' 
-      || c == '>' || c == '@' || c == ':' 
-      || c == '/' || c == '\\' || c == '|' 
-      || c == '!' || c == '?' || c == '#' 
-      || c == '$' || c == '%' || c == '&' 
-      || c == '(' || c == ')' || c == '[' 
-      || c == ']' || c == '{' || c == '}';
+  return c == '`' || c == '\'' || c == '^' 
+    || c == '"' || c == '~' || c == '.' 
+    || c == '-' || c == '_' || c == '*' 
+    || c == '+' || c == '=' || c == '<' 
+    || c == '>' || c == '@' || c == ':' 
+    || c == '/' || c == '\\' || c == '|' 
+    || c == '!' || c == '?' || c == '#' 
+    || c == '$' || c == '%' || c == '&' 
+    || c == '(' || c == ')' || c == '[' 
+    || c == ']' || c == '{' || c == '}';
 }