Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xtlsoft/pisp
A lisp-like language for php.
https://github.com/xtlsoft/pisp
language lisp parser php php-library php7
Last synced: 17 days ago
JSON representation
A lisp-like language for php.
- Host: GitHub
- URL: https://github.com/xtlsoft/pisp
- Owner: xtlsoft
- License: mit
- Created: 2018-08-16T02:59:53.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-12-31T08:13:10.000Z (almost 6 years ago)
- Last Synced: 2024-10-09T19:34:32.448Z (29 days ago)
- Topics: language, lisp, parser, php, php-library, php7
- Language: PHP
- Size: 36.1 KB
- Stars: 25
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pisp
A lisp-like language for php.
## Overview
This is a sample Hello World code of it.
PHP Code:
```php
define("print", function ($args, $vm) {
foreach ($args as $v) {
if (is_string($v) || method_exists($v, "__toString")) {
echo $v;
} else {
var_dump($v);
}
}
});
$pisp->execute($code);
```
Content of code.pisp:
```lisp
(print "Hello World" "\n")
```
Result:
```plain
Hello World
```
## Installation
```bash
composer require xtlsoft/pisp
```
## Documentation
### Basic PHP API
#### \Pisp\Pisp
We have built a facade for you.
You can use it easily.
```php
execute($code);
```
#### \Pisp\VM\VM
This is the main VM class.
We have a define and a delete method which are used to define and delete functions.
Yes! Variables are also functions in Pisp because it is purely functional.
```php
define("abc", 123);
$vm->define("+", function ($args, $vm) {
return $args[0] + $args[1];
});
$vm->delete("abc");
echo $vm->execute("(+ 1 2)"); // 3
```
Have you noticed? When defining a function, it must a valid callback with 2 parameters.
The first one is the array of the real arguments, and the second one is the instance of the \Pisp\VM\VM class.
You can dynamically add functions.
#### \Pisp\Parser\Parser
This is for parsing code.
```php
parse('(print ["Hello World\n"])');
var_export($rslt instanceof \Pisp\Parser\AST\Root); // true
```
#### \Pisp\Parser\ASTWalker
This is for walking the AST.
```php
walk(function (\Pisp\Parser\AST\Node $node) {
echo $node->name, PHP_EOL;
});
```
### Grammar and language specifications
#### Basic Grammar
A function call starts with a `(` and ends with a `)` .
Function name and arguments are separated by any blank characters.
Arguments are optional.
For example:
```lisp
(+ 1 2)
(+
1
2
)
( + 1 2 )
(a_function_call_without_arguments)
```
The literals are not surrounded by `[` and `]` now.
For example:
```lisp
(+ 1 2)
(print "a string")
(+ 1.2 1.4)
```
Moreover, Pisp supports lazy calls.
Just add an `@` before the function name and the arguments will be their ASTs.
```lisp
(@print (undefined_function))
```
This will outputs the var_dump result of the `\Pisp\Parser\AST\CallingNode` class.
#### Default Functions
Pisp doesn't include any functions by default. This means, if you runs the examples above, you will get a `NoFunctionException`. You must define them by yourself.
However, there's a useful StdLib, just:
```php
\Pisp\StdLib\StandardLibrary::register($vm);
```
#### Comments
Pisp only supports block comments starting with `#|` and ending with `|#`.
```lisp
#| This is the function comment |#
(do_something (some_function) ["literal"]) #| ok too |#
```
Pisp supports nested comments.
Example:
```lisp
#| comment some code
(print "Hello World") #| This prints "Hello World" |#
|#
```
You can also use a little trick to let it support it:
```php
define("rem", function ($args, $vm) {
return;
});
```
Then, you can just use:
```lisp
(@rem "This is a comment")
```
And this won't be executed.
#### Literals
Pisp now support many literals.
Literals are not surrounded by `[` and `]` now.
There are currently three types of literals: numeric, string and list.
##### Numeric
Numeric is an integer or float.
Example:
```lisp
(print 123 123.456 1e10 0x3f3f3f3f)
```
##### String
Strings are surrounded by quotes. Supports muiltiple quotes.
`\n` or other things are not fully supported at the moment.
Example:
```lisp
(print "Hello World" 'Another \'test\' Hello World')
```
##### List
List is a collection of values.
It is surrounded with `[` and `]`, each value is separated with a `,`.
Example:
```lisp
(print [1, 2, [3, 4]] ["Hello", 234, "World", 'you'])
```