https://github.com/croydon/cubescript
A CubeScript implementation which can be embedded in other applications
https://github.com/croydon/cubescript
Last synced: 2 months ago
JSON representation
A CubeScript implementation which can be embedded in other applications
- Host: GitHub
- URL: https://github.com/croydon/cubescript
- Owner: Croydon
- License: zlib
- Created: 2020-12-06T23:52:33.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2020-12-12T06:22:05.000Z (over 4 years ago)
- Last Synced: 2024-12-28T11:44:09.766Z (4 months ago)
- Language: C++
- Size: 1.32 MB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CubeScript
## Overview
CubeScript is an embeddable implementation of the CubeScript scripting
language. CubeScript is the console/config language of the Cube engines/games
(and derived engines/games). It's a simplistic language defined around the
idea of everything being a string, with Lisp-like syntax (allowing various
control structures to be defined as commands).
## Benefits and use cases
CubeScript is suitable for any use that calls for a simple scripting language
that is easy to embed. It's particularly strong at macro processing, so it can
be used as a preprocessor, or for any string-heavy use. Since it has descended
from a console language for a video game, it can still be used for that very
purpose, as well as a configuration file language.
Its thread-friendliness allows for usage in any context that requires parallel
processing and involvement of the scripting system in it.
As far as benefits over the original implementation go, while it is based on
the original implementation, it's largely rewritten; thus, it's gained many
advantages, including:
* Independent implementation (can be embedded in any project)
* No global state (multiple CubeScripts in a single program)
* Modern C++17 API (no macros, use of strongly typed enums, lambdas, ranges etc.)
* C++17 lambdas can be used as commands (including captures and type inference)
* Error handling including recovery (protected call system similar to Lua)
* Stricter parsing (strings cannot be left unfinished etc.)
* Loop control statements (`break` and `continue`)
* No manual memory mangement, values manage themselves
* Clean codebase that is easy to read and contribute to
* Support for arbitrary size integers and floats (can be set at compile time)
* Allows building into a static or shared library, supports `-fvisibility=hidden`
There are some features that are a work in progress and will come later:
* More helpful debug information (proper line infos at both parse and run time)
* A degree of thread safety (see below)
* Custom allocator support (control over how heap memory is allocated)
* Coroutines
The API is currently very unstable, as is the actual codebase. Therefore you
should not use the project in production environments just yet, but you're
also free to experiment - feedback is welcome.
**The project is also open for contributions.** You can use pull requests on
GitHub and you can issues for suggestions and discussions.
## Threads and coroutines
*(In progress)*
CubeScript supports integration with coroutines and threads by providing a
concept of threads itself. You can create a thread (child state) using the
main state and it will share global data with the main state, but it also
has its own call stack.
The "global" state is thread safe, allowing concurrent access from multiple
threads. The "local" state can be yielded as a part of the coroutine without
affecting any other threads.
This functionality is not exposed into the language itself, but it can be
utilized in the outside native code.
## Build requirements
* a compiler with C++20 support
* Python >= 3.6
* Conan >= 1.29.2
* CMake >= 3.15
* Meson >= 0.46
## Building and usage
You have to build it in a subdirectory, hence a typical build should look like this:
~~~
mkdir build && cd build
cmake ..
cmake --build .
~~~
Link the CubeScript library together with your application and everything should
work.
It also builds the REPL.
The project also bundles the linenoise line editing library which has been modified
to compile cleanly as C++ (with the same flags as CubeScript). It's used strictly
for the REPL only (you don't need it to build CubeScript itself). The version
in the repository tracks Git revision https://github.com/antirez/linenoise/commit/c894b9e59f02203dbe4e2be657572cf88c4230c3.
## Licensing
This is a fork of [libcubescript](https://github.com/OctaForge/libcubescript)
(which relied on [libostd](https://github.com/OctaForge/libostd)).
Libcubescript is a fork of [Cube 2: Sauerbraten](http://sauerbraten.org).
CubeScript and Libcubescript is provided to you under the terms of the zlib license, just
like the source it was originally derived from.
The software is originally based on the CubeScript implementation in the Cube 2
game/engine, which by now serves mostly as an inspiration, as the code has been
largely rewritten (though isolated bits of the original source may remain).
For copyright holders beyond just CubeScript, please refer to Cube 2's original
license file.
See the LICENSE file for licensing information.
### Licensing exception
CubeScript bundles the linenoise line editing library for REPL usage.
This library is available under the BSD 2-clause license, which is available
within its source code.