Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Zaba505/sand
Package for creating interpreters
https://github.com/Zaba505/sand
Last synced: 14 days ago
JSON representation
Package for creating interpreters
- Host: GitHub
- URL: https://github.com/Zaba505/sand
- Owner: Zaba505
- License: mit
- Created: 2018-11-18T22:44:41.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2018-11-21T19:13:47.000Z (almost 6 years ago)
- Last Synced: 2024-07-31T20:43:28.093Z (3 months ago)
- Language: Go
- Size: 44.9 KB
- Stars: 25
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - sand - Simple API for creating interpreters and so much more. (Command Line / Standard CLI)
- fucking-awesome-go - sand - Simple API for creating interpreters and so much more. (Command Line / Standard CLI)
- awesome-go - sand - Simple API for creating interpreters and so much more. (Command Line / Standard CLI)
- awesome-go - sand - Simple API for creating interpreters and so much more. (Command Line / Standard CLI)
- awesome-go-extra - sand - 11-18T22:44:41Z|2018-11-21T19:13:47Z| (Build Automation / Standard CLI)
- awesome-go-with-stars - sand - Simple API for creating interpreters and so much more. (Command Line / Standard CLI)
- awesome-go-plus - sand - Simple API for creating interpreters and so much more. (Command Line / Standard CLI)
- awesome-go-plus - sand - Simple API for creating interpreters and so much more.   (Command Line / Standard CLI)
README
[](https://godoc.org/github.com/Zaba505/sand)
[](https://goreportcard.com/report/github.com/Zaba505/sand)
[](https://travis-ci.com/Zaba505/sand)
[](https://codecov.io/github/Zaba505/sand?branch=master)
# sand
`sand` is for creating interpreters, like the Python interpreter and Haskell interpreter.
It can also be used for creating text based games and CLI test environments.
For examples, check out the [examples](https://github.com/Zaba505/sand/tree/master/example) folder.
#### Design
`sand` implements a concurrent model. It views an interpreter as two seperate components:
the User Interface, `sand.UI`, and the Command Processor,`sand.Engine`. The following
diagram shows how under the hood `sand` operates. Every square is a goroutine.
```text
+--------+ +--------------------------+
| | +-------------> Engines Manager +--------------+
| Read <----------+ | +--------------------------+ |
| | | | |
+----+---+ | | |
| +-+---+------+ +-------v------+
| | | | | +----------+
+------------> UI | | Engine | | Engine |
| (usually +----------------------------------------> Runner +---->+ Exec |
+------------> main) | | | | |
| | | XXXXXXXXXXXXXXXXXXXXXXXXXXXX | | +----------+
| +-+----------+ X Manager connects UI X +--------------+
+----+---+ | X to Engine Runner X
| | | XXXXXXXXXXXXXXXXXXXXXXXXXXXX
| Write <----------+
| |
+--------+
```
`sand.UI` is a `struct` that is provided for you and is implemented as broad as possible;
however there are few features missing, which are commonly found in popular interpreters,
namely: Line history and Auto-completion. These features may be added later, but as for
now they are not planned for.
`sand.Engine` is an `interface`, which must be implemented by the user. Implementations
of `sand.Engine` must have a comparable underlying type, see [Go Spec](https://golang.org/ref/spec#Comparison_operators)
for comparable types in Go.