mirrors/madlisp
1
0
Fork 0
mirror of https://github.com/peklaiho/madlisp.git synced 2024-11-29 16:38:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

add safe-mode to readme

Browse Source
This commit is contained in:
Pekka Laiho 2020-12-05 11:43:53 +07:00
parent 35ebe02e0a
commit 6d6754a09d
1 changed files with 36 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
README.md
View File

@ -52,6 +52,10 @@ You can create an init file in your home directory with the name `.madlisp_init`
You can use the [LispFactory](src/LispFactory.php) class to create an instance of the interpreter if you wish to embed the MadLisp language in your PHP application and call it directly from your code. You can use the [LispFactory](src/LispFactory.php) class to create an instance of the interpreter if you wish to embed the MadLisp language in your PHP application and call it directly from your code.
### Safe-mode
The language features a safe-mode that disables functions which allow external I/O. This allows a "sandbox" to be created where the evaluated scripts do not have access to the file system or similar resources. It is intended to be used when MadLisp is used as an embedded scripting language inside another application.
## Types ## Types
### Numbers ### Numbers
@ -140,39 +144,39 @@ You can also retrieve the parent environment:
## Special forms ## Special forms
Name | Example | Example result | Description Name | Safe-mode | Example | Example result | Description
----- | ------- | -------------- | ----------- ----- | --------- | ------- | -------------- | -----------
and | `(and 1 0 2)` | `0` | Return the first value that evaluates to false, or the last value. and | yes | `(and 1 0 2)` | `0` | Return the first value that evaluates to false, or the last value.
case | `(case (= 1 0) 0 (= 1 1) 1)` | `1` | Treat odd arguments as tests and even arguments as values. Evaluate and return the value after the first test that evaluates to true. case | yes | `(case (= 1 0) 0 (= 1 1) 1)` | `1` | Treat odd arguments as tests and even arguments as values. Evaluate and return the value after the first test that evaluates to true.
| `(case (= 1 0) 0 "no match")` | `"no match"` | You can also give optional last argument to case which is returned if none of the tests evaluated to true. | yes | `(case (= 1 0) 0 "no match")` | `"no match"` | You can also give optional last argument to case which is returned if none of the tests evaluated to true.
def | `(def addOne (fn (a) (+ a 1)))` | `<function>` | Define a value in the current environment. def | yes | `(def addOne (fn (a) (+ a 1)))` | `<function>` | Define a value in the current environment.
do | `(do (print 1) 2)` | `12` | Evaluate multiple expressions and return the value of the last. do | yes | `(do (print 1) 2)` | `12` | Evaluate multiple expressions and return the value of the last.
env | `(env +)` | `<function>` | Return a definition from the current environment represented by argument. Without arguments return the current environment as a hash-map. env | no | `(env +)` | `<function>` | Return a definition from the current environment represented by argument. Without arguments return the current environment as a hash-map.
eval | `(eval (quote (+ 1 2)))` | `3` | Evaluate the argument. eval | no | `(eval (quote (+ 1 2)))` | `3` | Evaluate the argument.
fn | `(fn (a b) (+ a b))` | `<function>` | Create a function. Arguments can also be given as a vector instead of a list. fn | yes | `(fn (a b) (+ a b))` | `<function>` | Create a function. Arguments can also be given as a vector instead of a list.
if | `(if (< 1 2) "yes" "no")` | `"yes"` | If the first argument evaluates to true, evaluate and return the second argument, otherwise the third argument. If the third argument is omitted return `null` in its place. if | yes | `(if (< 1 2) "yes" "no")` | `"yes"` | If the first argument evaluates to true, evaluate and return the second argument, otherwise the third argument. If the third argument is omitted return `null` in its place.
let | `(let (a (+ 1 2)) a)` | `3` | Create a new local environment using the first argument (list) to define values. Odd arguments are treated as keys and even arguments are treated as values. The last argument is the body of the let-expression which is evaluated using this new environment. let | yes | `(let (a (+ 1 2)) a)` | `3` | Create a new local environment using the first argument (list) to define values. Odd arguments are treated as keys and even arguments are treated as values. The last argument is the body of the let-expression which is evaluated using this new environment.
load | `(load "file.mad")` | | Read and evaluate a file. The contents are implicitly wrapped in a `do` expression. load | no | `(load "file.mad")` | | Read and evaluate a file. The contents are implicitly wrapped in a `do` expression.
or | `(or false 0 1)` | `1` | Return the first value that evaluates to true, or the last value. or | yes | `(or false 0 1)` | `1` | Return the first value that evaluates to true, or the last value.
quote | `(quote (1 2 3))` | `(1 2 3)` | Return the argument without evaluation. This is same as the `'` shortcut described above. quote | yes | `(quote (1 2 3))` | `(1 2 3)` | Return the argument without evaluation. This is same as the `'` shortcut described above.
## Functions ## Functions
### Core functions ### Core functions
Name | Example | Example result | Description Name | Safe-mode | Example | Example result | Description
----- | ------- | -------------- | ----------- ----- | --------- | ------- | -------------- | -----------
debug | `(debug)` | `true` | Toggle debug output. debug | no | `(debug)` | `true` | Toggle debug output.
doc | `(doc +)` | `"Return the sum of all arguments."` | Show the documentation string for a function. doc | yes | `(doc +)` | `"Return the sum of all arguments."` | Show the documentation string for a function.
doc | `(doc myfn "Documentation string.")` | `"Documentation string."` | Set the documentation string for a function. | yes | `(doc myfn "Documentation string.")` | `"Documentation string."` | Set the documentation string for a function.
error | `(error "invalid value")` | `error: invalid value` | Throw an exception with message as argument. error | yes | `(error "invalid value")` | `error: invalid value` | Throw an exception with message as argument.
exit | `(exit 1)` | | Terminate the script with given exit code using [exit](https://www.php.net/manual/en/function.exit.php). exit | no | `(exit 1)` | | Terminate the script with given exit code using [exit](https://www.php.net/manual/en/function.exit.php).
loop | `(loop (fn (a) (do (print a) (coinflip))) "hello ")` | `hello hello hello false` | Call the given function repeatedly in a loop until it returns false. loop | yes | `(loop (fn (a) (do (print a) (coinflip))) "hello ")` | `hello hello hello false` | Call the given function repeatedly in a loop until it returns false.
meta | `(meta (env) "name")` | `"root/user"` | Read meta information of an entity. meta | no | `(meta (env) "name")` | `"root/user"` | Read meta information of an entity.
print | `(print "hello world")` | `"hello world"null` | Print expression on the screen. Print returns null (which is shown due to the extra print in repl). Give optional second argument as `true` to show strings in readable format. print | no | `(print "hello world")` | `"hello world"null` | Print expression on the screen. Print returns null (which is shown due to the extra print in repl). Give optional second argument as `true` to show strings in readable format.
read | `(read "(+ 1 2 3)")` | `(+ 1 2 3)` | Read a string as code and return the expression. read | no | `(read "(+ 1 2 3)")` | `(+ 1 2 3)` | Read a string as code and return the expression.
sleep | `(sleep 2000)` | `null` | Sleep for the given period given in milliseconds using [usleep](https://www.php.net/manual/en/function.usleep). sleep | no | `(sleep 2000)` | `null` | Sleep for the given period given in milliseconds using [usleep](https://www.php.net/manual/en/function.usleep).
timer | `(timer (fn (d) (sleep d)) 200)` | `0.20010209` | Measure the execution time of a function and return it in seconds. timer | no | `(timer (fn (d) (sleep d)) 200)` | `0.20010209` | Measure the execution time of a function and return it in seconds.
### Collection functions ### Collection functions
@ -227,7 +231,7 @@ Name | Example | Example result | Description
### Database functions ### Database functions
This is a simple wrapper for [PDO](https://www.php.net/manual/en/book.pdo.php). This is a simple wrapper for [PDO](https://www.php.net/manual/en/book.pdo.php). This library is disabled in safe-mode.
Name | Example | Example result | Description Name | Example | Example result | Description
----------- | ------- | -------------- | ----------- ----------- | ------- | -------------- | -----------
@ -241,7 +245,7 @@ db-rollback | `(db-rollback d)` | `true` | Roll back a transaction.
### Http functions ### Http functions
This is a simple wrapper for [cURL](https://www.php.net/manual/en/book.curl.php). This is a simple wrapper for [cURL](https://www.php.net/manual/en/book.curl.php). This library is disabled in safe-mode.
Name | Example | Example result | Description Name | Example | Example result | Description
----------- | ------- | -------------- | ----------- ----------- | ------- | -------------- | -----------
@ -249,6 +253,8 @@ http | `(http "POST" "http://example.com/" (to-json {"key":"value"}) {"Co
### IO functions ### IO functions
This library is disabled in safe-mode.
Name | Example | Example result | Description Name | Example | Example result | Description
------- | ------- | -------------- | ----------- ------- | ------- | -------------- | -----------
wd | `(wd)` | `"/home/pekka/code/madlisp/"` | Get the current working directory. wd | `(wd)` | `"/home/pekka/code/madlisp/"` | Get the current working directory.