slint/docs/langref.md
2020-06-18 17:16:34 +02:00

187 lines
3.1 KiB
Markdown

# The `.60` language reference
This page is work in progress as the language is not yet set in stones.
## Comments
C-style comments are supported:
- line comments: `//` means everything to the end of the line is commented.
- block comments: `/* .. */` (FIXME, make possible to embedd them)
## `.60` files
The basic idea is that the .60 files contains one or several "component" (FIXME: name to be
adjusted).
These "components" are consisting of a bunch of elements that form a tree of elements.
Each declared component can be re-used as an element later. There are also a bunch
of builtin elements.
```60
MyButton := Rectangle {
// ...
}
MyApp := Window {
MyButton {
text: "hello";
}
MyButton {
text: "world";
}
}
```
Here, both `MyButton` and `MyApp` are components. MyApp is the main component because it is the last one
(FIXME, maybe there should be a keyword or something)
One can give name to the elements using the `:=` syntax within a component
```60
//...
MyApp := Window {
hello := MyButton {
text: "hello";
}
world := MyButton {
text: "world";
}
}
```
The root element of a component is always called `root`
## Properties
The elements can have properties
```60
Example := Rectangle {
// Simple expression: ends with a semi colon
width: 42;
// or a code block
height: { 42 }
}
```
You can declare properties. The properties declared at the top level of the main component
are public.
property are declared like so:
```60
Example := Rectangle {
// declare a property of type int
property<int32> my_property;
// declare a property with a default value
property<int32> my_second_property: 42;
}
```
The value of properties are an expression (see later).
You can access properties in these expression, and the bindings are automatically
re-evaluated if the property changes.
```60
Example := Rectangle {
// declare a property of type int
property<int32> my_property;
// This access the property
width: root.my_property * 20;
}
```
If one change the `my_property`, the width will be updated automatically.
## Types
- `int32`
- `float32`
- `string`
- `color`
- FIXME: more
## Expressions
Basic arithmetic expression do what they do in most languages
```60
Example := Rectangle {
x: 1 * 2 + 3 * 4; // same as (1 * 2) + (3 * 4)
}
```
Access properties with `.`
```60
Example := Rectangle {
x: foo.x;
foo := Rectangle {
x: 42;
}
}
```
Strings are with quote.
(FIXME what is the escaping, should we support using stuff like "hello {name}"?)
```60
Example := Text {
text: "hello";
}
```
Color literal use the CSS syntax:
```60
Example := Rectangle {
color: blue;
property<color> c1: #ffaaff;
}
```
Array / Object
```
TODO
```
## Signal
FIXME: rename event?
```60
Example := Rectangle {
// declares a signal
signal hello;
area := TouchArea {
// sets a handler with `=>`
clicked => {
// emit the signal
root.hello()
}
}
}
```
## Repetition
The `for` syntax
```60
Example := Rectangle {
for person[index] in model: Button {
}
}
```