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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
% API
# Builtins
## USE_COLOR
```tomo
USE_COLOR : Bool
```
Whether or not the console prefers ANSI color escape sequences in the output.
## ask
```tomo
ask : func(prompt: Text, bold: Bool = yes, force_tty: Bool = yes -> Text?)
```
Gets a line of user input text with a prompt.
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.
Argument | Type | Description | Default
---------|------|-------------|---------
prompt | `Text` | The text to print as a prompt before getting the input. |
bold | `Bool` | Whether or not to print make the prompt appear bold on a console. | **Default:** `yes`
force_tty | `Bool` | Whether or not to force the use of /dev/tty. | **Default:** `yes`
**Return:** 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:**
```tomo
>> ask("What's your name? ")
= "Arthur Dent"
```
## exit
```tomo
exit : func(message: Text? = !Text, status: Int32 = Int32(1) -> Void)
```
Exits the program with a given status and optionally prints a message.
Argument | Type | Description | Default
---------|------|-------------|---------
message | `Text?` | If nonempty, this message will be printed (with a newline) before exiting. | **Default:** `!Text`
status | `Int32` | The status code that the program with exit with. | **Default:** `Int32(1)`
**Return:** This function never returns.
**Example:**
```tomo
exit(status=1, "Goodbye forever!")
```
## fail
```tomo
fail : func(message: Text -> Abort)
```
Prints a message to the console, aborts the program, and prints a stack trace.
Argument | Type | Description | Default
---------|------|-------------|---------
message | `Text` | The error message to print. |
**Return:** Nothing, aborts the program.
**Example:**
```tomo
fail("Oh no!")
```
## getenv
```tomo
getenv : func(name: Text -> Text?)
```
Gets an environment variable.
Argument | Type | Description | Default
---------|------|-------------|---------
name | `Text` | The name of the environment variable to get. |
**Return:** If set, the environment variable's value, otherwise, `none`.
**Example:**
```tomo
>> getenv("TERM")
= "xterm-256color"?
```
## print
```tomo
print : func(text: Text, newline: Bool = yes -> Void)
```
Prints a message to the console (alias for [`say`](#say)).
Argument | Type | Description | Default
---------|------|-------------|---------
text | `Text` | The text to print. |
newline | `Bool` | Whether or not to print a newline after the text. | **Default:** `yes`
**Return:** Nothing.
**Example:**
```tomo
print("Hello ", newline=no)
print("world!")
```
## say
```tomo
say : func(text: Text, newline: Bool = yes -> Void)
```
Prints a message to the console.
Argument | Type | Description | Default
---------|------|-------------|---------
text | `Text` | The text to print. |
newline | `Bool` | Whether or not to print a newline after the text. | **Default:** `yes`
**Return:** Nothing.
**Example:**
```tomo
say("Hello ", newline=no)
say("world!")
```
## setenv
```tomo
setenv : func(name: Text, value: Text -> Void)
```
Sets an environment variable.
Argument | Type | Description | Default
---------|------|-------------|---------
name | `Text` | The name of the environment variable to set. |
value | `Text` | The new value of the environment variable. |
**Return:** Nothing.
**Example:**
```tomo
setenv("FOOBAR", "xyz")
```
## sleep
```tomo
sleep : func(seconds: Num -> Void)
```
Pause execution for a given number of seconds.
Argument | Type | Description | Default
---------|------|-------------|---------
seconds | `Num` | How many seconds to sleep for. |
**Return:** Nothing.
**Example:**
```tomo
sleep(1.5)
```
|
