Merge pull request #29 from lucifer1004/string-macro

feat: support string interpolation in string macros (#28)

Author: lucifer1004

CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## [v0.2.1] - Unreleased
+
+### Changed
+
+- String macros `@monkey_eval_str`, `@monkey_vm_str` and `@monkey_julia_str` now support string interpolations.
+
 ## [v0.2.0] - 2022-02-04
 
 ### Added

Project.toml

@@ -1,7 +1,7 @@
 name = "MonkeyLang"
 uuid = "2e3b8ffb-b112-4a86-975c-b56a8cdf8971"
 authors = ["Gabriel Wu <wuzihua@pku.edu.cn> and contributors"]
-version = "0.2.0"
+version = "0.2.1"
 
 [deps]
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"

README.md

@@ -9,6 +9,7 @@
 **Table of Contents**
 
 - [MonkeyLang](#monkeylang)
+  - [Using Monkey in Julia](#using-monkey-in-julia)
   - [Compile MonkeyLang.jl to a standalone executable](#compile-monkeylangjl-to-a-standalone-executable)
   - [Start the REPL](#start-the-repl)
   - [Documentation](#documentation)
@@ -49,6 +50,30 @@
       - [A custom `reduce` function](#a-custom-reduce-function)
     - [Macro System](#macro-system)
 
+## Using Monkey in Julia
+
+You can start the REPL within Julia:
+
+```julia
+using MonkeyLang
+
+start_repl()
+```
+
+Or you can evaluate Monkey programs using string macros:
+
+```julia
+using MonkeyLang
+
+a = 2
+
+monkey_eval"let b = $a; puts(b)"
+
+monkey_vm"let c = [$a, $a]; puts(c)"
+
+monkey_julia"let d = {$a: $a}; puts(d)"
+```
+
 ## Compile MonkeyLang.jl to a standalone executable
 
 Clone the repo, and run `make build` in the root directory.

benchmark/Manifest.toml

@@ -43,7 +43,7 @@ uuid = "a63ad114-7e13-5084-954f-fe012c677804"
 deps = ["BenchmarkTools", "Printf"]
 path = ".."
 uuid = "2e3b8ffb-b112-4a86-975c-b56a8cdf8971"
-version = "0.2.0"
+version = "0.2.1"
 
 [[deps.OpenBLAS_jll]]
 deps = ["Artifacts", "CompilerSupportLibraries_jll", "Libdl"]

src/MonkeyLang.jl

@@ -1,8 +1,10 @@
 module MonkeyLang
 
+export start_repl, @monkey_eval_str, @monkey_vm_str
+
 using Printf
 
-const MONKEY_VERSION = v"0.2.0"
+const MONKEY_VERSION = v"0.2.1"
 const MONKEY_AUTHOR = "Gabriel Wu"
 
 # Tokens
@@ -50,6 +52,9 @@ include("repl.jl")
 # Transpilers
 include("transpilers/transpilers.jl")
 
+using .Transpilers.JuliaTranspiler: @monkey_julia_str
+export @monkey_julia_str
+
 # CLI
 include("cli.jl")
 

src/analyzer.jl

@@ -8,7 +8,11 @@ function analyze(code::String; input::IO = stdin, output::IO = stdout)
     end
 end
 
-function analyze(program::Program; existing_symbol_table::Union{SymbolTable,Nothing} = nothing, exisiting_env::Union{Environment,Nothing} = nothing)
+function analyze(
+    program::Program;
+    existing_symbol_table::Union{SymbolTable,Nothing} = nothing,
+    exisiting_env::Union{Environment,Nothing} = nothing,
+)
     if !isnothing(existing_symbol_table)
         symbol_table = SymbolTable(existing_symbol_table)
     else
@@ -53,13 +57,17 @@ function analyze(ls::LetStatement, symbol_table::SymbolTable)
             return ErrorObj("identifier not found: $(ls.name.value)")
         end
 
-        if sym.scope == FunctionScope || (sym.scope == OuterScope && sym.ptr.scope == FunctionScope)
+        if sym.scope == FunctionScope ||
+           (sym.scope == OuterScope && sym.ptr.scope == FunctionScope)
             return ErrorObj(
                 "cannot reassign the current function being defined: $(ls.name.value)",
             )
         end
     else
-        if !isnothing(sym) && (sym.scope == LocalScope || (is_global(symbol_table) && sym.scope == GlobalScope))
+        if !isnothing(sym) && (
+            sym.scope == LocalScope ||
+            (is_global(symbol_table) && sym.scope == GlobalScope)
+        )
             return ErrorObj("$(ls.name.value) is already defined")
         end
 

src/evaluator.jl

@@ -1,5 +1,7 @@
 macro monkey_eval_str(code::String)
-    :(evaluate($code))
+    quote
+        run($(esc(Meta.parse("\"$(escape_string(code))\""))))
+    end
 end
 
 evaluate(code::String; input = stdin, output = stdout) = begin

src/repl.jl

@@ -62,7 +62,8 @@ function start_repl(; input::IO = stdin, output::IO = stdout, use_vm::Bool = fal
                 expanded = expand_macros(program, macro_env)
 
                 if use_vm
-                    syntax_check_result = analyze(expanded; existing_symbol_table = symbol_table)
+                    syntax_check_result =
+                        analyze(expanded; existing_symbol_table = symbol_table)
                     if isa(syntax_check_result, ErrorObj)
                         println(output, syntax_check_result)
                         continue

src/symbol_table.jl

@@ -23,7 +23,8 @@ mutable struct SymbolTable
     SymbolTable(; outer::Union{SymbolTable,Nothing} = nothing, within_loop::Bool = false) =
         new(Dict(), 0, outer, within_loop, [])
 
-    SymbolTable(s::SymbolTable) = new(copy(s.store), s.definition_count, s.outer, s.within_loop, s.free_symbols)
+    SymbolTable(s::SymbolTable) =
+        new(copy(s.store), s.definition_count, s.outer, s.within_loop, s.free_symbols)
 end
 
 is_global(s::SymbolTable) = isnothing(s.outer)

src/transpilers/julia/julia_transpiler.jl

@@ -259,7 +259,9 @@ run(code::String; input::IO = stdin, output::IO = stdout) = begin
 end
 
 macro monkey_julia_str(code::String)
-    :(run($code))
+    quote
+        run($(esc(Meta.parse("\"$(escape_string(code))\""))))
+    end
 end
 
 end

src/vm.jl

@@ -66,7 +66,9 @@ current_frame(vm::VM) = vm.frames[end]
 instructions(vm::VM) = instructions(current_frame(vm))
 
 macro monkey_vm_str(code::String)
-    :(run($code))
+    quote
+        run($(esc(Meta.parse("\"$(escape_string(code))\""))))
+    end
 end
 
 run(code::String; input = stdin, output = stdout) = begin

test/backend_test.jl

@@ -361,24 +361,22 @@ function test_backend(run::Function, name::String; check_object::Bool = true)
         end
 
         @testset "Redefine" begin
-            for (code, expected) in [
-                (
-                    """
-                    let x = 5;
-                    let y = 1;
-                    let z = 0;
-                    while (y > 0) {
-                        z = z + x;
-                        let x = 9;
-                        z = z + x;
-                        y = y - 1;
-                    }
+            for (code, expected) in [(
+                """
+                let x = 5;
+                let y = 1;
+                let z = 0;
+                while (y > 0) {
                     z = z + x;
-                    z;
-                    """,
-                    19,
-                ),
-            ]
+                    let x = 9;
+                    z = z + x;
+                    y = y - 1;
+                }
+                z = z + x;
+                z;
+                """,
+                19,
+            )]
                 if name == "julia"
                     @test_broken run(code) == expected
                 else
@@ -415,43 +413,43 @@ function test_backend(run::Function, name::String; check_object::Bool = true)
 
         @testset "Closure" begin
             for (code, expected) in [(
-                    """
-                   let newAdder = fn(x) { 
-                     fn(y) { x + y };
-                   }
-
-                   let addTwo = newAdder(2);
-                   addTwo(2);
-                   """,
-                    4,
-                ), (
-                    """
-                    let a = 2;
-                    let ans = [];
-
-                    let g = fn() {
-                        let b = 2;
-                        let f = fn() {
-                            b = b - 1;
-                            return b;
-                        }
-                        return f;
+                """
+               let newAdder = fn(x) { 
+                 fn(y) { x + y };
+               }
+
+               let addTwo = newAdder(2);
+               addTwo(2);
+               """,
+                4,
+            ), (
+                """
+                let a = 2;
+                let ans = [];
+
+                let g = fn() {
+                    let b = 2;
+                    let f = fn() {
+                        b = b - 1;
+                        return b;
                     }
+                    return f;
+                }
 
-                    let f = g();
+                let f = g();
 
-                    ans = push(ans, f());
-                    ans = push(ans, f());
+                ans = push(ans, f());
+                ans = push(ans, f());
 
-                    let ff = g();
+                let ff = g();
 
-                    ans = push(ans, ff());
-                    ans = push(ans, ff());
+                ans = push(ans, ff());
+                ans = push(ans, ff());
 
-                    ans;
-                    """,
-                    [1, 0, 1, 0],
-                )]
+                ans;
+                """,
+                [1, 0, 1, 0],
+            )]
                 check(code, expected)
             end
         end