zaphar/ucg
1
0
Fork 0
mirror of https://github.com/zaphar/ucg.git synced 2025-07-22 18:19:54 -04:00
Code Issues Packages Projects Releases Wiki Activity

DOCS: Update our reference.

Browse Source 
* add the `in` operator.
* add the include expression.
This commit is contained in:
Jeremy Wall 2019-01-04 10:34:57 -06:00
parent c4b765bd69
commit 9d6737149f
1 changed files with 31 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docsite/site/content/reference/expressions.md
View File

@ -91,7 +91,7 @@ version both sides must be the same type, either string or list.
### Comparison Operators
UCG supports the comparison operators `==`, `!=`, `>=`, `<=`, `<`, and `>`.
UCG supports the comparison operators `==`, `!=`, `>=`, `<=`, `<`, `>`, and `in`.
They all expect both sides to be of the same type.
The `>`, `<`, `>=`, and `>=` operators are only supported on numeric types
@ -128,6 +128,25 @@ tpl1 == tpl3; // returns false
Because tuples are an ordered set both tuples in a comparison must have their
fields in the same order to compare as equal.
The `in` operator tests for the existence of a field in a tuple or an element in a
list.
```
let tpl = { foo = "bar" };
foo in tpl; // evaluates to true
"foo" in tpl; // also evaluates to true.
```
Lists do a deep equal comparison when testing for the existence of an element.
```
let lst = [1, "two", {three = 3}];
1 in lst; // evaluates to true;
{three = 3} in lst; // evaluates to true
{three = "3"} in lst; // evaluates to false
{three = 3, two = 2} in lst // evaluates to false
```
#### Operator Precedence
UCG binary operators follow the typical operator precedence for math. `*` and
@ -207,6 +226,17 @@ should be placed. Any primitive value can be used as an argument.
"https://@:@/" % (host, port)
```
Include expressions
-------------------
UCG can include the contents of other files as an expression. Currently we only
support strings but we plan to support yaml, and json and possibly base64 encoding
in the future. include expressions start with the `include` keyword a type (currently only `str`), and a path. Relative paths are calculated relative to the including file.
```
let script = include str "./script.sh";
```
Conditionals
----------