1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
# Documentation
This is an overview of the documentation on Tomo.
## Topics
A few topics that are documented:
- [Compilation Pipeline](compilation.md)
- [Functions](functions.md)
- [Libraries/Modules](libraries.md)
- [Namespacing](namespacing.md)
- [Operator Overloading](operators.md)
- [Special Methods](metamethods.md)
## Types
Information about Tomo's built-in types can be found here:
- [Arrays](arrays.md)
- [Booleans](booleans.md)
- [Channels](channels.md)
- [Enums](enums.md)
- [Floating point numbers](nums.md)
- [Integer Ranges](ranges.md)
- [Integers](integers.md)
- [Languages](langs.md)
- [Paths](paths.md)
- [Sets](sets.md)
- [Structs](structs.md)
- [Tables](tables.md)
- [Text](text.md)
- [Threads](threads.md)
## Built-in Functions
### `ask`
**Description:**
Gets a line of user input text with a prompt.
**Usage:**
```markdown
ask(prompt:Text, bold:Bool = yes, force_tty:Bool = yes) -> Void
```
**Parameters:**
- `prompt`: The text to print as a prompt before getting the input.
- `bold`: Whether or not to print make the prompt appear bold on a console
using the ANSI escape sequence `\x1b[1m`.
- `force_tty`: When a program is receiving input from a pipe or writing its
output to a pipe, this flag (which is enabled by default) forces the program
to write the prompt to `/dev/tty` and read the input from `/dev/tty`, which
circumvents the pipe. This means that `foo | ./tomo your-program | baz` will
still show a visible prompt and read user input, despite the pipes. Setting
this flag to `no` will mean that the prompt is written to `stdout` and input
is read from `stdin`, even if those are pipes.
**Returns:**
A line of user input text without a trailing newline, or empty text if
something went wrong (e.g. the user hit `Ctrl-D`).
**Example:**
```markdown
>> ask("What's your name? ")
= "Arthur Dent"
```
---
### `exit`
**Description:**
Exits the program with a given status and optionally prints a message.
**Usage:**
```markdown
ask(message:Text = "", status:Int32 = 0_i32) -> Void
```
**Parameters:**
- `message`: If nonempty, this message will be printed (with a newline) before
exiting.
- `status`: The status code that the program with exit with.
**Returns:**
This function never returns.
**Example:**
```markdown
exit(status=1, "Goodbye forever!")
```
---
### `say`
**Description:**
Prints a message to the console.
**Usage:**
```markdown
say(text:Text, newline:Bool = yes) -> Void
```
**Parameters:**
- `text`: The text to print.
- `newline`: Whether or not to print a newline after the text.
**Returns:**
Nothing.
**Example:**
```markdown
say("Hello ", newline=no)
say("world!")
```
---
### `fail`
**Description:**
Prints a message to the console, aborts the program, and prints a stack trace.
**Usage:**
```markdown
fail(message:Text) -> Abort
```
**Parameters:**
- `message`: The error message to print.
**Returns:**
Nothing, aborts the program.
**Example:**
```markdown
fail("Oh no!")
```
|
