Add expressions.md

This commit is contained in:
Richard Feldman 2025-12-21 17:07:26 -05:00
parent 667085624f
commit 7be6ae4be6
4 changed files with 62 additions and 12 deletions

View file

@ -13,6 +13,7 @@ If you're looking for a beginner tutoral, check out [roc-lang.org/tutorial](http
- [Blocks](expressions#blocks)
- [Statements](expressions#statements)
- [`=` (assignment)](expressions#assignment)
- [`import`](expressions#expect)
- [`expect`](expressions#expect)
- [`return`](expressions#return)
- [`break`](expressions#break)

View file

@ -1,17 +1,49 @@
# Expressions
An expression is something that evaluates to a [value](#values).
You can wrap expressions in parentheses without changing what they do. Non-expressions
can't be wrapped in parentheses without causing an error. Some examples:
- `x` is a valid expression. It evaluates to a value. `(x)` is valid.
- `foo(1)` is a valid expression. It evaluates to a value. `(foo(1))` is valid.
- `1` is a valid expression. It's already a value `(1)` is valid.
- `import Foo` is a [statement](statements) not an expression. `(import Foo)` is invalid.
- `# Something` is a [comment](comments), not an expression. `(# Something)` is invalid.
- `package […]` is a [module heaader](modules#headers), not an expression. `(package […])` is invalid.
## Values
A Roc value is a semantically immutable piece of data.
Since values take up memory at runtime, each value has a [memory address](https://en.wikipedia.org/wiki/Memory_address).
Roc treats memory addresses as behind-the-scenes implementation details that should not affect
program behavior, and by design exposes no language-level way to access or compare addresses.
This implies that Roc has no concept of [pointers](https://en.wikipedia.org/wiki/Pointer_(computer_programming)), [value identity](https://en.wikipedia.org/wiki/Identity_(object-oriented_programming)), or reference equality (also known as [physical equality](https://ocaml.org/manual/5.4/api/Repr.html#VALphys_equal)), all of which are semantic concepts based on memory addresses.
> Note that platform authors can choose to implement features based on memory addresses,
> since platforms have access to lower-level languages which can naturally see the addresses
> of any Roc value the platform receives. This means it's up to a platform author to decide
> whether it's a good idea for users of their platform to start needing to think about memory
> addresses, when the rest of the language is designed to keep them behind the scenes.
### [Reference Counting Without Cycles](#reference-counting) {#reference-counting}
Heap-allocated Roc values are automatically [reference-counted](https://en.wikipedia.org/wiki/Reference_counting) ([atomically](https://en.wikipedia.org/wiki/Linearizability#Primitive_atomic_instructions), for thread-safety).
Heap-allocated values include as strings, lists, boxes, and recursive tag unions. Numbers,
records, tuples, and non-recursive tag unions are stack-allocated, and so are not reference counted.
Other languages support [reference cycles](https://en.wikipedia.org/wiki/Reference_counting#Dealing_with_reference_cycles), which create problems for reference counting systems. Solutions to these problems include runtime tracing garbage collectors for cycles, or a concept of [weak references](https://en.wikipedia.org/wiki/Weak_reference). By design, Roc has no way to express reference cycles, so none of these solutions are necessary.
### Opportunistic Mutation
Roc's compiler does _opportunistic mutation_ using the [Perceus](https://www.microsoft.com/en-us/research/wp-content/uploads/2020/11/perceus-tr-v4.pdf) "functional-but-in-place" reference counting system. The way this works is:
- Builtin operations on reference-counted values will update them in place when their reference counts are 1
- When their reference counts are greater than 1, they will be shallowly cloned first, and then the clone will be updated and returned.
For example, when [`List.set`](../builtins/List#set) is passed a unique list (reference count is 1), then that list will have the given element replaced. When it's given a shared list (reference count is not 1), it will first shallowly clone the list, and then replace the given element in the clone. Either way, the modified list will be returned—regardless of whether the clone or the original was the one modified.
## Blocks
## Statements
### `=` (assignment)
### `expect`
### `return`
### `break`
### `continue`

View file

@ -4,8 +4,12 @@
## Imports
## Module Headers
## Package Modules
## Platform Modules
## Application Modules
### Headerless Application Modules

13
langref/statements.md Normal file
View file

@ -0,0 +1,13 @@
# Statements
### `=` (assignment)
### `import`
### `expect`
### `return`
### `break`
### `continue`