# Goldfish Scheme **Repository Path**: tree_3/goldfish ## Basic Information - **Project Name**: Goldfish Scheme - **Description**: Goldfish Scheme：让Scheme和Python一样易用且实用 - **Primary Language**: Scheme - **License**: Apache-2.0 - **Default Branch**: main - **Homepage**: https://github.com/LiiiLabs/goldfish - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 29 - **Created**: 2025-02-05 - **Last Updated**: 2025-05-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Goldfish Scheme / [金鱼 Scheme](README_ZH.md) > Make Scheme as easy to use and practical as Python! Goldfish Scheme is a Scheme interpreter with the following features: + R7RS-small compatible + Scala-like functional collection + Python-like versatile standard library + Small and fast 示例图片 ## Demo Code ### Named parameter ``` scheme (define* (person (name "Bob") (age 21)) (string-append name ": " (number->string age))) (person :name "Alice" :age 3) ``` ### Unicode Support ``` scheme ($ "你好，世界" 0) ; => 你 ($ "你好，世界" 4) ; => 界 ($ "你好，世界" :length) ; => 5 ``` ### Functional Data Pipeline ![](r7rs_vs_goldfish.png) With `prime?` provided, filter twin prime numbers in this way: ``` scheme (($ 1 :to 100) :filter prime? :filter (lambda (x) (prime? (+ x 2))) :map (lambda (x) (cons x (+ x 2))) :collect) ``` ### Scala like case class ``` scheme (define-case-class person ((name string?) (age integer?)) (define (%to-string) (string-append "I am " name " " (number->string age) " years old!")) (define (%greet x) (string-append "Hi " x ", " (%to-string)))) (define bob (person "Bob" 21)) (bob :to-string) ; => "I am Bob 21 years old!" (bob :greet "Alice") ; => "Hi Alice, I am Bob 21 years old!" ``` ## Simplicity is Beauty Goldfish Scheme still follows the same principle of simplicity as S7 Scheme. Currently, Goldfish Scheme only depends on [S7 Scheme](https://ccrma.stanford.edu/software/s7/), [tbox](https://gitee.com/tboox/tbox) and C++ standard library defined in C++ 98. Just like S7 Scheme, [src/goldfish.hpp](src/goldfish.hpp) and [src/goldfish.cpp](src/goldfish.cpp) are the only key source code needed to build the goldfish interpreter binary. ## Standard Library ### Python-like standard library and Scala-like collections | Library | Description | Example functions | | ------------------------------------------------- | ------------------------------------ | ---------------------------------------------------------------- | | [(liii lang)](goldfish/liii/lang.scm) | Scala-like Collection | `box` for functional api, `rich-char`, `rich-string` for unicode | | [(liii base)](goldfish/liii/base.scm) | Basic routines | `==`, `!=`, `display*` | | [(liii error)](goldfish/liii/error.scm) | Python like Errors | `os-error` to raise `'os-error` just like OSError in Python | | [(liii check)](goldfish/liii/check.scm) | Test framework based on SRFI-78 | `check`, `check-catch` | | [(liii case)](goldfish/liii/case.scm) | Pattern matching | `case*` | | [(liii list)](goldfish/liii/list.scm) | List Library | `list-view`, `fold` | | [(liii bitwise)](goldfish/liii/bitwise.scm) | Bitwise Library | `bitwise-and`, `bitwise-or` | | [(liii string)](goldfish/liii/string.scm) | String Library | `string-join` | | [(liii vector)](goldfish/liii/vector.scm) | Vector Library | `vector-index` | | [(liii hash-table)](goldfish/liii/hash-table.scm) | Hash Table Library | `hash-table-empty?`, `hash-table-contains?` | | [(liii sys)](goldfish/liii/sys.scm) | Library looks like Python sys module | `argv` | | [(liii os)](goldfish/liii/os.scm) | Library looks like Python os module | `getenv`, `mkdir` | | [(liii path)](goldfish/liii/path.scm) | Path Library | `path-dir?`, `path-file?` | | [(liii uuid)](goldfish/liii/uuid.scm) | UUID generation | `uuid4` | ### SRFI | Library | Status | Description | | ----------------- | -------- | ---------------------------- | | `(srfi srfi-1)` | Part | List Library | | `(srfi srfi-8)` | Complete | Provide `receive` | | `(srfi srfi-9)` | Complete | Provide `define-record-type` | | `(srfi srfi-13)` | Complete | String Library | | `(srfi srfi-16)` | Complete | Provide `case-lambda` | | `(srfi srfi-39)` | Complete | Parameter Objects | | `(srfi srfi-78)` | Part | Lightweigted Test Framework | | `(srfi srfi-125)` | Part | Hash Table | | `(srfi srfi-133)` | Part | Vector | | `(srfi srfi-151)` | Part | Bitwise Operations | | `(srfi srfi-216)` | Part | SICP | ### R7RS Standard Libraries | Library | Description | | ---------------------- | --------------------- | | `(scheme base)` | Base library | | `(scheme case-lambda)` | Provide `case-lambda` | | `(scheme char)` | Character Library | | `(scheme file)` | File operations | | `(scheme time)` | Time library | ## Installation Goldfish Scheme is bundled in Mogan Research (since v1.2.8), just [install Mogan Research](https://mogan.app/guide/Install.html) to install Goldfish Scheme. Besides the Goldfish Scheme interpreter, a nice structured [Goldfish Scheme REPL](https://mogan.app/guide/plugin_goldfish.html) is availabe in Mogan Research. The following guide will help you build and install Goldfish step by step. ### GNU/Linux Here are commandlines to build it on Debian bookworm: ``` sudo apt install xmake git unzip curl g++ git clone https://gitee.com/LiiiLabs/goldfish.git # git clone https://github.com/LiiiLabs/goldfish.git cd goldfish xmake b goldfish bin/goldfish --version ``` You can also install it to `/opt`: ``` sudo xmake i -o /opt/goldfish --root /opt/goldfish/bin/goldfish ``` For uninstallation, just: ``` sudo rm -rf /opt/goldfish ``` ## Commandlinefu This section assumes you have executed `xmake b goldfish` sucessfully and `bin/goldfish` is available. ### Zero Option Without any options, it will print the help message: ``` > bin/goldfish Goldfish Scheme 17.10.0 by LiiiLabs --version display version -e -e '(+ 1 2)' -l FILE Load the scheme code on path FILE Load the scheme code on path and print the evaluated result ``` ### Version Option `--version` will print the Goldfish Scheme version and the underlying S7 Scheme version: ``` > bin/goldfish --version Goldfish Scheme 17.10.0 by LiiiLabs based on S7 Scheme 10.11 (2-July-2024) ``` ### Mode Option `-m` helps you specify the standard libray mode. + `default`: `-m default` is the equiv of `-m liii` + `liii`: Goldfish Scheme with `(liii lang)`, `(liii base)` and `(liii error)` + `scheme`: Goldfish Scheme with `(liii base)` and `(liii error)` + `sicp`: S7 Scheme with `(scheme base)` and `(srfi sicp)` + `r7rs`: S7 Scheme with `(scheme base)` + `s7`: S7 Scheme without any extra library ### Other Options `-e` helps you evaluate the scheme code on the fly: ``` > bin/goldfish -e "(+ 1 2)" 3 > bin/goldfish -e "(begin (import (srfi srfi-1)) (first (list 1 2 3)))" 1 > bin/goldfish -e "(begin (import (liii sys)) (display (argv)) (newline))" 1 2 3 ("bin/goldfish" "-e" "(begin (import (liii sys)) (display (argv)) (newline))" "1" "2" 3) #\newline ``` `-l` helps you load the FILE: ``` > bin/goldfish -l tests/demo_error.scm ;car argument, (), is nil but should be a pair ; (list) ; tests/demo_error.scm, line 1, position: 10 ; (list) > bin/goldfish -l tests/demo_no_error.scm > bin/goldfish -l tests/demo_argv.scm 1 2 3 ("bin/goldfish" "tests/demo_argv.scm" "1" "2" "3") ``` If no options provided, it will load the FILE and print the eval result: ``` > bin/goldfish tests/demo_no_error.scm tests/demo_no_error.scm => 3 > bin/goldfish tests/demo_error.scm ;car argument, (), is nil but should be a pair ; (list) ; tests/demo_error.scm, line 1, position: 10 ; (list) tests/demo_error.scm => wrong-type-arg > bin/goldfish tests/demo_argv.scm 1 2 3 ("bin/goldfish" "tests/demo_argv.scm" "1" "2" "3") tests/demo_argv.scm => #\newline ``` Notice, the FILE and the eval result are separated by ` => `. ## Versioning Goldfish Scheme x.y.z means that it is using the tbox x, based on S7 Scheme y, and z is the patch version. To clarify, the second version of Goldfish Scheme is `17.10.1`, it means that it is using `tbox 1.7.x`, based on `S7 Scheme 10.x`, the patch version is `1`. ## Why we created Goldfish Scheme Goldfish Scheme is implemented to overcome the defects of [S7 Scheme](https://ccrma.stanford.edu/software/s7/): 1. Distribute the ready-to-use Goldfish Scheme interpreter and structured REPL on Linux/macOS/Windows 2. Try to implement the [R7RS-small](https://small.r7rs.org) standard 3. Try to provide the useful SRFI in R7RS library format ## License Goldfish Scheme is licensed under Apache 2.0, some of the code snippets which are derived from the S7 Scheme repo and SRFI have been explicitly claimed in the related source files. ## Citation The reader can cite our work with the following BibTeX entry: ``` @book{goldfish, author = {Da Shen and Nian Liu and Yansong Li and Shuting Zhao and Shen Wei and Andy Yu and Siyu Xing and Jiayi Dong and Yancheng Li and Xinyi Yu and Zhiwen Fu and Duolei Wang and Leiyu He and Yingyao Zhou and Noctis Zhang}, title = {Goldfish Scheme: A Scheme Interpreter with Python-Like Standard Library}, publisher = {LIII NETWORK}, year = {2024}, url = {https://github.com/LiiiLabs/goldfish/releases/download/v17.10.9/Goldfish.pdf} } ```