7adace4ee1
- CLJNIM_RECOMMENDATIONS.md: mark all 12 recommendations as implemented - README.md: add --lib-path, first-class functions, multi-arity, rest params - User guides (EN/BG): add sections for docstrings, multi-arity, rest params, keyword-as-function, first-class functions, loop/recur, --lib-path flag - TASKS.md: add Phase 11 with all BRing compiler fixes
3.9 KiB
3.9 KiB
Bara Lang User Guide
Installation
Prerequisites
- Nim >= 2.0
- GCC or Clang
- make
Build from Source
git clone https://gitlab.com/balvatar/lisp-nim.git
cd lisp-nim
make build
CLI Commands
compile — Compile to Nim
./cljnim compile input.clj output.nim
Generates a .nim file from Clojure source.
run — Compile and Execute
./cljnim run examples/hello.clj
Compiles to Nim, then to C, then to a binary, and runs it.
Global Flags
--lib-path <dir> — Custom Library Directory
Override the default lib/ search path. Checked before CLJNIM_LIB_PATH env var and built-in paths.
./cljnim --lib-path ./my_project/lib run app.clj
Environment variable alternative:
export CLJNIM_LIB_PATH=./my_project/lib
./cljnim run app.clj
read — Parse and Print AST
./cljnim read examples/hello.clj
Shows the Clojure AST as S-expressions.
repl — Interactive REPL
# Human-friendly mode
./cljnim repl
# AI mode (structured JSON)
./cljnim repl --json
Writing Bara Lang Programs
Basic Syntax
; Comments start with semicolon
; Define a variable
(def x 42)
; Define a function
(defn greet [name]
(println "Hello, " name))
; Function with docstring
(defn greet "Says hello to someone" [name]
(str "Hello, " name))
; Multi-arity function
(defn greet-multi
([name] (greet-multi name "Hello"))
([name greeting] (str greeting ", " name)))
; Function with rest parameters
(defn sum-all [x & rest]
(+ x (reduce + rest)))
; Call a function
(greet "World")
(greet-multi "Alice") ;; => "Hello, Alice"
(greet-multi "Alice" "Hi") ;; => "Hi, Alice"
(sum-all 1 2 3 4) ;; => 10
; Arithmetic
(+ 1 2 3) ; => 6
(* 10 20) ; => 200
(/ 100 4) ; => 25
; Conditionals
(if (> x 0)
"positive"
"non-positive")
; Local bindings
(let [a 10
b 20]
(+ a b)) ; => 30
Working with Data
; Vectors (use Nim seq internally)
(def nums [1 2 3 4 5])
; Keywords
(def person {:name "Alice" :age 30})
; Keyword as function (lookup in map)
(:name person) ;; => "Alice"
(:age person) ;; => 30
; Maps and sets use persistent HAMT data structures
; with structural sharing and O(log₃₂ n) operations.
Recursion
(defn factorial [n]
(if (= n 0)
1
(* n (factorial (- n 1)))))
(println (factorial 5)) ; => 120
First-Class Functions
User-defined functions can be passed as values to higher-order functions:
(defn square [x] (* x x))
(defn odd? [x] (= 1 (mod x 2)))
(map square [1 2 3 4]) ;; => [1 4 9 16]
(filter odd? [1 2 3 4]) ;; => [1 3]
(apply + [1 2 3]) ;; => 6
Loop / Recur
(defn find-header [headers name]
(loop [pairs (seq headers)]
(if (empty? pairs)
nil
(let [[k v] (first pairs)]
(if (= k name)
v
(recur (rest pairs)))))))
(find-header [[:content-type "text/html"] [:accept "*/*"]] :accept)
;; => "*/*"
AI REPL Guide
The JSON REPL is designed for programmatic interaction.
Start AI REPL
./cljnim repl --json
Evaluate a Form
{"op": "eval", "form": "(+ 1 2 3)"}
Response:
{
"status": "ok",
"result": {"printed": "6"},
"meta": {"ns": "user", "ms": 861, "form": "(+ 1 2 3)"}
}
Batch Evaluation
{"op": "eval-batch", "forms": ["(defn f [x] x)", "(f 42)"]}
List Definitions
{"op": "get-defs"}
Response:
{"status": "ok", "defs": ["f"], "ns": "user"}
Clear Session
{"op": "clear"}
Exit
{"op": "quit"}
Tips
- Use
:helpin human REPL for available commands. - Definitions in REPL persist across evaluations in the same session.
- The
--jsonflag makes the REPL fully machine-readable.