aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--builtins/functions.c10
-rw-r--r--docs/README.md41
2 files changed, 47 insertions, 4 deletions
diff --git a/builtins/functions.c b/builtins/functions.c
index b69f81d9..b6132494 100644
--- a/builtins/functions.c
+++ b/builtins/functions.c
@@ -264,13 +264,19 @@ public Text_t ask(Text_t prompt, bool bold, bool force_tty)
if (force_tty && !isatty(STDIN_FILENO)) {
in = fopen("/dev/tty", "r");
- if (!in) goto cleanup;
+ if (!in) {
+ fputs("\n", out); // finish the line, since the user can't
+ goto cleanup;
+ }
}
char *line = NULL;
size_t bufsize = 0;
ssize_t length = getline(&line, &bufsize, in);
- if (length == -1) goto cleanup;
+ if (length == -1) {
+ fputs("\n", out); // finish the line, since we didn't get any input
+ goto cleanup;
+ }
if (length > 0 && line[length-1] == '\n') {
line[length-1] = '\0';
diff --git a/docs/README.md b/docs/README.md
index 2f0dabb0..3c4e3d62 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -33,6 +33,41 @@ Information about Tomo's built-in types can be found here:
## 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"
+```
+
+---
+
### `say`
**Description:**
@@ -40,19 +75,21 @@ Prints a message to the console.
**Usage:**
```markdown
-say(text:Text) -> Void
+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 world!")
+say("Hello ", newline=no)
+say("world!")
```
---