From 336e57e269655ce2ab25f12b451b6a91edb0878b Mon Sep 17 00:00:00 2001 From: CPunch Date: Sun, 24 Jan 2021 20:26:54 -0600 Subject: [PATCH] Added basic control.md docs --- docs/control.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++ docs/operators.md | 3 +++ docs/types.md | 2 +- 3 files changed, 70 insertions(+), 1 deletion(-) create mode 100644 docs/control.md diff --git a/docs/control.md b/docs/control.md new file mode 100644 index 0000000..4d206fc --- /dev/null +++ b/docs/control.md @@ -0,0 +1,66 @@ +# Control statements + +Control statements are used to control program flow. Using logical expressions, different branches of code will be run. + +## if statements + +The syntax for if statements in cosmo looks like: + +``` +if 1 == 1 then + // true branch here + print("true") +else + // false branch here + print("false") +end +``` +> true + +the `elseif` keyword can also be used to have an else conditional branch: + +``` +if false then + print("bye") +elseif true then + print("hi") +end +``` +> hi + +## while loops + +While loops are basic "repeat while X is true" loops. Their syntax consists of the `while` keyword, followed by the logical expression and the `do` keyword. The loop body is ended by the matching `end` keyword. In practice this looks like: + +``` +while true do + print("oh no! infinite loop!") +end +``` +> oh no! infinite loop!oh no! infinite loop!oh no! infinite loop!... + +## for loops + +There are two main types of for loops, the traditional c-style for loops, and the for-each loop which requires an iterator object (see `objects.md`) + +The c-style for loops starts with the `for` keyword, followed by '(' and an initializer, a conditional expression, and an iterator statement each separated by a ';', followed by ')' then the `do` keyword. The loop body is ended by the matching `end` keyword. Like so: + +``` +var total = 0 +for (var i = 0; i < 10; i++) do + total = total + i +end +print(total) +``` +> 45 + +The for-each loops are a little different, the absence of the starting '(' marks it as a for-each loop. After the `for` keyword, the values expected during iteration are expected, each separated by a ','. After that, the `in` keyword is expected and the iterator object is expected. The loop body is ended by the matching `end` keyword. The start of the loop body is marked by the `do` keyword. Like so: + +``` +for key, val in ["hello", "world"] do + print("[" .. key .. "] = " .. val) +end +``` +> `[0] = hello [1] = world` + +Tables have a built-in iterator in the VM and are accepted in for-each loops. However, iterations over tables are not guaranteed to be in any specific order. \ No newline at end of file diff --git a/docs/operators.md b/docs/operators.md index 4e20a13..c94bcfd 100644 --- a/docs/operators.md +++ b/docs/operators.md @@ -17,6 +17,9 @@ | -------- | ---------------------------- | -------------------------------------- | | `!` | "Not" logical operator, flips the logical polarity. | `print(!true)` -> `false` | | `#` | "Count" calls '__count' metamethod on objects or gives the count of entries in tables | `print(#[1,2,3])` -> `3`, `print(#{__count = function(self) return self.x end, x = 1337})` -> `1337` | +| `++` | Increment operator. | `var i = 0 print(++i .. ", " .. i++ .. ", " .. i)` -> `1, 1, 2` | +| `--` | Decrement operator. | `var i = 0 print(--i .. ", " .. i-- .. ", " .. i)` -> `-1, -1, -2` | +| `( ... )` | Call operator. Arguments should be separated using `,`. | `print("Hello", " ", "world!")` -> `Hello world!` | > -> means 'outputs' ## Logical diff --git a/docs/types.md b/docs/types.md index 1dea121..1e8ca9c 100644 --- a/docs/types.md +++ b/docs/types.md @@ -1,6 +1,6 @@ # Types -There are two main types of datatypes in Cosmo, primitives and references. Primitives exist directly in variables and tables. References are references to objects in memory, such as objects, tables, and functions. +There are two main types of datatypes in Cosmo, primitives and references. Primitives exist directly in variables and tables. References are references to objects in memory, such as objects, tables, and functions. Objects are cleaned up and free'd by the garbage collector as soon as no references to the objects exist. ## Primitives