coffee/ChaiScript
1
0
Fork 0
mirror of https://github.com/ChaiScript/ChaiScript.git synced 2025-12-06 16:57:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #468 from vocaviking/patch-1

Browse Source 
Updated cheatsheet.md
This commit is contained in:
Rob Loach 2018-12-26 08:38:03 -05:00 committed by GitHub
commit b0c1483f70
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
cheatsheet.md
View File

@ -11,13 +11,11 @@ ChaiScript tries to follow the [Semantic Versioning](http://semver.org/) scheme.
# Initializing ChaiScript # Initializing ChaiScript
``` ```
chaiscript::ChaiScript chai; // loads stdlib from loadable module on file system chaiscript::ChaiScript chai; // initializes ChaiScript, adding the standard ChaiScript types (map, string, ...)
chaiscript::ChaiScript chai(chaiscript::Std_Lib::library()); // compiles in stdlib
``` ```
Note that ChaiScript cannot be used as a global / static object unless it is being compiled with `CHAISCRIPT_NO_THREADS`. Note that ChaiScript cannot be used as a global / static object unless it is being compiled with `CHAISCRIPT_NO_THREADS`.
# Adding Things To The Engine # Adding Things To The Engine
## Adding a Function / Method / Member ## Adding a Function / Method / Member
@ -571,23 +569,6 @@ If both a 2 parameter and a 3 parameter signature match, the 3 parameter functio
# Built In Functions # Built In Functions
## Disabling Built-Ins
When constructing a ChaiScript object, a vector of parameters can be passed in to disable or enable various built-in methods.
Current options:
```
enum class Options
{
Load_Modules,
No_Load_Modules,
External_Scripts,
No_External_Scripts
};
```
## Evaluation ## Evaluation
``` ```
@ -603,3 +584,6 @@ Both `use` and `eval_file` search the 'usepaths' passed to the ChaiScript constr
* `from_json` converts a JSON string into its strongly typed (map, vector, int, double, string) representations * `from_json` converts a JSON string into its strongly typed (map, vector, int, double, string) representations
* `to_json` converts a ChaiScript object (either a `Object` or one of map, vector, int, double, string) tree into its JSON string representation * `to_json` converts a ChaiScript object (either a `Object` or one of map, vector, int, double, string) tree into its JSON string representation
## Extras
ChaiScript itself does not provide a link to the math functions defined in `<cmath>`. You can either add them yourself, or use the [https://github.com/ChaiScript/ChaiScript_Extras](ChaiScript_Extras) helper library. (Which also provides some additional string functions.)