https://github.com/jks-liu/lisp-style-repl

Simple lisp style command line interpreter (repl) especially for embedded system.
https://github.com/jks-liu/lisp-style-repl

Last synced: about 2 months ago
JSON representation

Simple lisp style command line interpreter (repl) especially for embedded system.

• Host: GitHub
• URL: https://github.com/jks-liu/lisp-style-repl
• Owner: jks-liu
• Created: 2013-05-11T10:51:03.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-10-27T01:29:25.000Z (over 10 years ago)
• Last Synced: 2024-01-29T06:34:18.370Z (5 months ago)
• Language: C
• Size: 137 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Lists

• AwesomeInterpreter - lisp-style-repl

README

        
Lisp Style REPL

===============

Simple lisp style command line interpreter (REPL) especially for embedded system.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED",  "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119](http://tools.ietf.org/html/rfc2119).

Version number SHALL be compatible with [Semantic Versioning](http://semver.org/).

## Acronym used in documents and source files

- **REPL**: Read Evaluate Print & Loop

- **CLI**: Command Line Interface

## How to use

```scheme

;; Command MUST in one line

;; Nested parentheses SHALL NOT be used

(command arg0 arg1 ...)

```

### C APIs

**standard**: C99

All extern function or variable SHALL in the namespace 'lsr\_', 'Lsr\_' OR 'LSR\_' which is short for Lisp Style Repl.

The C APIs SHALL NOT reentrant. Which means it is not thread-safe.

#### Built-in command

```scheme

;; All built-in command SHALL return 0 if success or 1 if fail.

;; Except ($?) will return the same value as the last command

;; 

;; Show last command return value

($?)

;; Show all commands and a brief introduction.

(help)

;; Show manual of a specific command.

(man command)

;; + - * / (TODO)

(+ num0 num1 ...)

(- num0 num1 ...) ; num0 - num1 - num2 - ...

(* num0 num1 ...)

(/ num0 num1 ...) ; num0 / num1 / num2 / ...

```

#### Initialize and add your own command

You will get a example in [test/](https://github.com/jks-liu/lisp-style-repl/tree/master/test) directory.

A command named "copyright" MUST be implemented.

A command including built-in command which return non-zero SHALL be considered a error, So the ($?) will return a error even it executed successfully.

Command return value MUST in range \[0, 256\), this range is [POSIX-compatible](http://en.wikipedia.org/wiki/Exit_status).

#### Use C++ ?

There are something wrong c++

 - C++ did not define `restrict' 

 - C++ had [different semantics with compound literals](http://gcc.gnu.org/onlinedocs/gcc/Compound-Literals.html)

 Please refer [test-cpp/](https://github.com/jks-liu/lisp-style-repl/tree/master/test-cpp) for details to fix errors. 

### Authentication 

TODO

## License 

Copyright 2013 [jks Liu](http://jks-liu.github.io/). Some right reserved.

**License**: BSD.