summaryrefslogtreecommitdiffstats
path: root/src/bar.h
blob: 20d92a993baf6902fa9be6a4a543c93ab8bdc849 (plain)
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
// Copyright © Tavian Barnes <tavianator@tavianator.com>
// SPDX-License-Identifier: 0BSD

/**
 * A terminal status bar.
 */

#ifndef BFS_BAR_H
#define BFS_BAR_H

/** A terminal status bar. */
struct bfs_bar;

/**
 * Create a terminal status bar.  Only one status bar is supported at a time.
 *
 * @return
 *         A pointer to the new status bar, or NULL on failure.
 */
struct bfs_bar *bfs_bar_show(void);

/**
 * Get the width of the status bar.
 */
unsigned int bfs_bar_width(const struct bfs_bar *bar);

/**
 * Update the status bar message.
 *
 * @param bar
 *         The status bar to update.
 * @param str
 *         The string to display.
 * @return
 *         0 on success, -1 on failure.
 */
int bfs_bar_update(struct bfs_bar *bar, const char *str);

/**
 * Hide the status bar.
 */
void bfs_bar_hide(struct bfs_bar *status);

#endif // BFS_BAR_H