Merge pull request #24 from nathanfallet/feature/js-support

Adding support to be called by JS
nathanfallet · Nov 4, 2023 · 23f02a3 · 23f02a3
2 parents 7f53ca7 + 08416a7
commit 23f02a3
Show file tree

Hide file tree

Showing 86 changed files with 2,671 additions and 2,150 deletions.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -7,7 +7,7 @@ plugins {
 }
 
 group = "me.nathanfallet.makth"
-version = "1.2.1"
+version = "1.2.2"
 
 repositories {
     mavenCentral()
@@ -25,7 +25,9 @@ kotlin {
     }
     js {
         binaries.library()
+        nodejs()
         browser()
+        //generateTypeScriptDefinitions() // Not supported for now because of collections etc...
     }
     val hostOs = System.getProperty("os.name")
     val isArm64 = System.getProperty("os.arch") == "aarch64"
@@ -41,6 +43,11 @@ kotlin {
 
 
     sourceSets {
+        all {
+            languageSettings.apply {
+                optIn("kotlin.js.ExperimentalJsExport")
+            }
+        }
         val commonMain by getting
         val commonTest by getting {
             dependencies {

diff --git a/docs/actions/action_set.md b/docs/actions/action_set.md
@@ -9,7 +9,7 @@ SetAction("name", value)
 Or
 
 ```kotlin
-SetAction(Variable.instantiate("name"), value)
+SetAction(VariableFactory.instantiate("name"), value)
 ```
 
 ## Makth lexer syntax

diff --git a/docs/actions/introduction.md b/docs/actions/introduction.md
@@ -4,11 +4,12 @@ You can execute actions to play with a context:
 
 ```kotlin
 val result = Context().execute(listOf(
-    SetAction("x", Integer.instantiate(2)),
-    WhileAction(Equality(Variable.instantiate("x"), Integer.instantiate(10), Equality.Operator.LessThan), listOf(
-        SetAction("x", Sum(Variable.instantiate("x"), Integer.instantiate(1)))
+    SetAction("x", IntegerFactory.instantiate(2)),
+    WhileAction(
+        Equality(VariableFactory.instantiate("x"), IntegerFactory.instantiate(10), Equality.Operator.LessThan), listOf(
+            SetAction("x", Sum(VariableFactory.instantiate("x"), IntegerFactory.instantiate(1)))
     )),
-    PrintAction(listOf(StringValue("x = "), Variable.instantiate("x")))
+    PrintAction(listOf(StringValue("x = "), VariableFactory.instantiate("x")))
 ))
 ```
 
@@ -17,10 +18,10 @@ val result = Context().execute(listOf(
 ```kotlin
 Context(
     mapOf(
-        "x" to Integer.instantiate(10) // The value of x
+        "x" to IntegerFactory.instantiate(10) // The value of x
     ),
     listOf(
-        StringValue("x = "), Integer.instantiate(10), StringValue("\n") // What we printed
+        StringValue("x = "), IntegerFactory.instantiate(10), StringValue("\n") // What we printed
     )
 )
 ```
diff --git a/docs/getstarted/install.md b/docs/getstarted/install.md
@@ -8,7 +8,7 @@ Add the following to your `pom.xml` file;
 <dependency>
     <groupId>me.nathanfallet.makth</groupId>
     <artifactId>makth-jvm</artifactId>
-    <version>1.2.1</version>
+    <version>1.2.2</version>
 </dependency>
 ```
 
@@ -22,6 +22,22 @@ repositories {
 }
 
 dependencies {
-    implementation 'me.nathanfallet.makth:makth:1.2.1'
+    implementation 'me.nathanfallet.makth:makth:1.2.2'
 }
 ```
+
+## npm
+
+Install the package using npm:
+
+```bash
+npm install makth
+```
+
+## yarn
+
+Install the package using yarn:
+
+```bash
+yarn add makth
+```
diff --git a/docs/numbers/instantiate.md b/docs/numbers/instantiate.md
@@ -1,13 +1,13 @@
 # Instantiate numbers
 
 ```kotlin
-val integer = Integer.instantiate(2) // 2
-val rational = Rational.instantiate(3, 2) // 3/2
-val real = Real.instantiate(1.23456789) // 1.23456789
+val integer = IntegerFactory.instantiate(2) // 2
+val rational = RationalFactory.instantiate(3, 2) // 3/2
+val real = RealFactory.instantiate(1.23456789) // 1.23456789
 ```
 
 ## Predefined constants
 
 ```kotlin
-val pi = Real.pi
+val pi = RealFactory.pi
 ```
diff --git a/docs/numbers/lexer.md b/docs/numbers/lexer.md
@@ -16,7 +16,7 @@ Thanks to the context, you can pass variables:
 
 ```kotlin
 val context = Context(mapOf(
-    "x" to Integer.instantiate(2)
+    "x" to IntegerFactory.instantiate(2)
 ))
 val result = MathLexer("x + 3").execute(context) // 5
 ```
diff --git a/src/commonMain/kotlin/me/nathanfallet/makth/actions/ForAction.kt b/src/commonMain/kotlin/me/nathanfallet/makth/actions/ForAction.kt
@@ -1,5 +1,8 @@
 package me.nathanfallet.makth.actions
 
+import me.nathanfallet.makth.exceptions.ExecutionException
+import me.nathanfallet.makth.exceptions.NotIterableException
+import me.nathanfallet.makth.exceptions.UnknownVariablesException
 import me.nathanfallet.makth.extensions.StringValue
 import me.nathanfallet.makth.extensions.indentedLines
 import me.nathanfallet.makth.interfaces.Action
@@ -8,14 +11,17 @@ import me.nathanfallet.makth.interfaces.Value
 import me.nathanfallet.makth.lexers.AlgorithmLexer.IncorrectArgumentCountException
 import me.nathanfallet.makth.lexers.AlgorithmLexer.IncorrectArgumentTypeException
 import me.nathanfallet.makth.resolvables.Context
-import me.nathanfallet.makth.resolvables.Variable
+import me.nathanfallet.makth.resolvables.variables.Variable
+import kotlin.js.JsExport
+import kotlin.jvm.JvmStatic
 
 /**
  * Action that executes a list of actions for a given set or interval.
  * @param identifier Identifier of the current iterated value
  * @param iterable Iterable to iterate during the loop
  * @param actions Actions to execute while condition is true
  */
+@JsExport
 data class ForAction(val identifier: String, val iterable: Value, val actions: List<Action>) : Action {
 
     companion object {
@@ -25,6 +31,7 @@ data class ForAction(val identifier: String, val iterable: Value, val actions: L
          * @param args List of arguments
          * @return Action created from arguments
          */
+        @JvmStatic
         fun handler(args: List<Value>): Action {
             if (args.count() != 2) {
                 throw IncorrectArgumentCountException("for", args.count(), 2)
@@ -38,19 +45,19 @@ data class ForAction(val identifier: String, val iterable: Value, val actions: L
         }
     }
 
-    @Throws(Action.ExecutionException::class)
+    @Throws(ExecutionException::class)
     override fun execute(context: Context): Context {
         // Eval iterator
         val evaluatedIterable = iterable.compute(context)
 
         // Check if there are missing variables
         evaluatedIterable.variables.takeIf { it.isNotEmpty() }?.let {
-            throw Action.UnknownVariablesException(this, context, it)
+            throw UnknownVariablesException(this, context, it)
         }
 
         // Check if condition is a boolean
         if (evaluatedIterable !is Iterable) {
-            throw Action.NotIterableException(this, context, evaluatedIterable)
+            throw NotIterableException(this, context, evaluatedIterable)
         }
 
         // Iterate

diff --git a/src/commonMain/kotlin/me/nathanfallet/makth/actions/IfAction.kt b/src/commonMain/kotlin/me/nathanfallet/makth/actions/IfAction.kt
@@ -1,11 +1,17 @@
 package me.nathanfallet.makth.actions
 
+import me.nathanfallet.makth.exceptions.ExecutionException
+import me.nathanfallet.makth.exceptions.NotABooleanException
+import me.nathanfallet.makth.exceptions.UnknownVariablesException
 import me.nathanfallet.makth.extensions.BooleanValue
 import me.nathanfallet.makth.extensions.indentedLines
 import me.nathanfallet.makth.interfaces.Action
 import me.nathanfallet.makth.interfaces.Value
 import me.nathanfallet.makth.lexers.AlgorithmLexer.IncorrectArgumentCountException
 import me.nathanfallet.makth.resolvables.Context
+import kotlin.js.JsExport
+import kotlin.jvm.JvmOverloads
+import kotlin.jvm.JvmStatic
 
 /**
  * Action that executes a list of actions if a condition is true,
@@ -14,7 +20,8 @@ import me.nathanfallet.makth.resolvables.Context
  * @param actions Actions to execute if condition is true
  * @param elseActions Actions to execute if condition is false
  */
-data class IfAction(
+@JsExport
+data class IfAction @JvmOverloads constructor(
         val condition: Value,
         val actions: List<Action>,
         val elseActions: List<Action> = listOf()
@@ -27,6 +34,7 @@ data class IfAction(
          * @param args List of arguments
          * @return Action created from arguments
          */
+        @JvmStatic
         fun handler(args: List<Value>): Action {
             if (args.count() != 1) {
                 throw IncorrectArgumentCountException("if", args.count(), 1)
@@ -35,19 +43,19 @@ data class IfAction(
         }
     }
 
-    @Throws(Action.ExecutionException::class)
+    @Throws(ExecutionException::class)
     override fun execute(context: Context): Context {
         // Eval condition
         val evaluatedCondition = condition.compute(context)
 
         // Check if there are missing variables
         evaluatedCondition.variables.takeIf { it.isNotEmpty() }?.let {
-            throw Action.UnknownVariablesException(this, context, it)
+            throw UnknownVariablesException(this, context, it)
         }
 
         // Check if condition is a boolean
         if (evaluatedCondition !is BooleanValue) {
-            throw Action.NotABooleanException(this, context, evaluatedCondition)
+            throw NotABooleanException(this, context, evaluatedCondition)
         }
 
         // Execute if it is true

diff --git a/src/commonMain/kotlin/me/nathanfallet/makth/actions/PrintAction.kt b/src/commonMain/kotlin/me/nathanfallet/makth/actions/PrintAction.kt
@@ -1,14 +1,19 @@
 package me.nathanfallet.makth.actions
 
+import me.nathanfallet.makth.exceptions.ExecutionException
+import me.nathanfallet.makth.exceptions.UnknownVariablesException
 import me.nathanfallet.makth.extensions.StringValue
 import me.nathanfallet.makth.interfaces.Action
 import me.nathanfallet.makth.interfaces.Value
 import me.nathanfallet.makth.resolvables.Context
+import kotlin.js.JsExport
+import kotlin.jvm.JvmStatic
 
 /**
  * Action that prints values
  * @param values Values to print
  */
+@JsExport
 data class PrintAction(val values: List<Value>) : Action {
 
     companion object {
@@ -18,12 +23,13 @@ data class PrintAction(val values: List<Value>) : Action {
          * @param args Arguments of the action
          * @return Action created from the arguments
          */
+        @JvmStatic
         fun handler(args: List<Value>): Action {
             return PrintAction(args.toList())
         }
     }
 
-    @Throws(Action.ExecutionException::class)
+    @Throws(ExecutionException::class)
     override fun execute(context: Context): Context {
         // Generate output
         val output =
@@ -33,7 +39,7 @@ data class PrintAction(val values: List<Value>) : Action {
 
                     // Check for missing variables
                     computed.variables.takeIf { it.isNotEmpty() }?.let {
-                        throw Action.UnknownVariablesException(this, context, it)
+                        throw UnknownVariablesException(this, context, it)
                     }
 
                     // Return

diff --git a/src/commonMain/kotlin/me/nathanfallet/makth/actions/SetAction.kt b/src/commonMain/kotlin/me/nathanfallet/makth/actions/SetAction.kt
@@ -1,18 +1,23 @@
 package me.nathanfallet.makth.actions
 
+import me.nathanfallet.makth.exceptions.ExecutionException
+import me.nathanfallet.makth.exceptions.UnknownVariablesException
 import me.nathanfallet.makth.extensions.StringValue
 import me.nathanfallet.makth.interfaces.Action
 import me.nathanfallet.makth.interfaces.Value
 import me.nathanfallet.makth.lexers.AlgorithmLexer.IncorrectArgumentCountException
 import me.nathanfallet.makth.lexers.AlgorithmLexer.IncorrectArgumentTypeException
 import me.nathanfallet.makth.resolvables.Context
-import me.nathanfallet.makth.resolvables.Variable
+import me.nathanfallet.makth.resolvables.variables.Variable
+import kotlin.js.JsExport
+import kotlin.jvm.JvmStatic
 
 /**
  * Action that sets a variable
  * @param identifier Identifier of the variable to set
  * @param value Value to set
  */
+@JsExport
 data class SetAction(val identifier: String, val value: Value) : Action {
 
     companion object {
@@ -22,6 +27,7 @@ data class SetAction(val identifier: String, val value: Value) : Action {
          * @param args Arguments of the action
          * @return Action created from the arguments
          */
+        @JvmStatic
         fun handler(args: List<Value>): Action {
             if (args.count() != 2) {
                 throw IncorrectArgumentCountException("set", args.count(), 2)
@@ -35,14 +41,14 @@ data class SetAction(val identifier: String, val value: Value) : Action {
         }
     }
 
-    @Throws(Action.ExecutionException::class)
+    @Throws(ExecutionException::class)
     override fun execute(context: Context): Context {
         // First, compute the value with the given context
         val valueToSet = value.compute(context)
 
         // Check if there are missing variables
         valueToSet.variables.takeIf { it.isNotEmpty() }?.let {
-            throw Action.UnknownVariablesException(this, context, it)
+            throw UnknownVariablesException(this, context, it)
         }
 
         // Return the new context

diff --git a/src/commonMain/kotlin/me/nathanfallet/makth/actions/WhileAction.kt b/src/commonMain/kotlin/me/nathanfallet/makth/actions/WhileAction.kt
@@ -1,17 +1,23 @@
 package me.nathanfallet.makth.actions
 
+import me.nathanfallet.makth.exceptions.ExecutionException
+import me.nathanfallet.makth.exceptions.NotABooleanException
+import me.nathanfallet.makth.exceptions.UnknownVariablesException
 import me.nathanfallet.makth.extensions.BooleanValue
 import me.nathanfallet.makth.extensions.indentedLines
 import me.nathanfallet.makth.interfaces.Action
 import me.nathanfallet.makth.interfaces.Value
 import me.nathanfallet.makth.lexers.AlgorithmLexer.IncorrectArgumentCountException
 import me.nathanfallet.makth.resolvables.Context
+import kotlin.js.JsExport
+import kotlin.jvm.JvmStatic
 
 /**
  * Action that executes a list of actions while a condition is true.
  * @param condition Condition to check
  * @param actions Actions to execute while condition is true
  */
+@JsExport
 data class WhileAction(val condition: Value, val actions: List<Action>) : Action {
 
     companion object {
@@ -21,6 +27,7 @@ data class WhileAction(val condition: Value, val actions: List<Action>) : Action
          * @param args List of arguments
          * @return Action created from arguments
          */
+        @JvmStatic
         fun handler(args: List<Value>): Action {
             if (args.count() != 1) {
                 throw IncorrectArgumentCountException("while", args.count(), 1)
@@ -29,19 +36,19 @@ data class WhileAction(val condition: Value, val actions: List<Action>) : Action
         }
     }
 
-    @Throws(Action.ExecutionException::class)
+    @Throws(ExecutionException::class)
     override fun execute(context: Context): Context {
         // Eval condition
         val evaluatedCondition = condition.compute(context)
 
         // Check if there are missing variables
         evaluatedCondition.variables.takeIf { it.isNotEmpty() }?.let {
-            throw Action.UnknownVariablesException(this, context, it)
+            throw UnknownVariablesException(this, context, it)
         }
 
         // Check if condition is a boolean
         if (evaluatedCondition !is BooleanValue) {
-            throw Action.NotABooleanException(this, context, evaluatedCondition)
+            throw NotABooleanException(this, context, evaluatedCondition)
         }
 
         // Execute if it is true