Skip to content

Commit

Permalink
feat!: improve CLI structure, add new commands
Browse files Browse the repository at this point in the history
This splits most CLI/IPC commands into two categories:

- `var` for ironvars
- `bar` for controlling individual bars.

It also introduces more commands for visibility, as well as breaking existing ones.

New commands:

- `show`
- `hide`
- `toggle_visible`
- `set_popup_visible`
- `get_popup_visible`

Lastly, the implementation of some existing commands has been improved.

BREAKING CHANGE: All IPC commands have changed. Namely, `type` has been changed to `command`, and bar/var related commands are now under a `subcommand`. The full spec can be found on the wiki.

BREAKING CHANGE: Several CLI commands are now located under the `var` and `bar` categories. Usage of any commands to get/set Ironvars or control bar visibility will need to be updated.

BREAKING CHANGE: The `open_popup` and `close_popup` IPC commands are now called `show_popup` and `hide_popup` respectively.

BREAKING CHANGE: The popup `name` argument has been renamed to `widget_name` on all IPC commands.

BREAKING CHANGE: The `set-visibility` CLI command now takes a `true`/`false` positional argument in place of the `-v` flag.
  • Loading branch information
JakeStanger committed May 18, 2024
1 parent 67e4723 commit 146f88b
Show file tree
Hide file tree
Showing 8 changed files with 506 additions and 381 deletions.
178 changes: 133 additions & 45 deletions docs/Controlling Ironbar.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,38 @@ It also includes a command line interface, which can be used for interacting wit
# CLI

This is shipped as part of the `ironbar` binary. To view commands, you can use `ironbar --help`.
You can also view help per-command, for example using `ironbar set --help`.
You can also view help per sub-command or command, for example using `ironbar var --help` or `ironbar var set --help`.

Responses are handled by writing their type to stdout, followed by any value starting on the next line.
Error responses are written to stderr in the same format.
The CLI supports plaintext and JSON output. Plaintext will:

- Print `ok` for empty success responses
- Print the returned body for success responses
- Print `error` to followed by the error on the next line for error responses. This is printed to `stderr`.

Example:

```shell
$ ironbar set subject world
$ ironbar var set subject world
ok

$ ironbar get subject
ok
$ ironbar var get subject
world

$ ironbar var get foo
error
Variable not found
```

All error responses will cause the CLI to exit code 3.

# IPC

The server listens on a Unix socket.
This can usually be found at `/run/user/$UID/ironbar-ipc.sock`.
The path is printed on startup, and can usually be found at `/run/user/$UID/ironbar-ipc.sock`.

Commands and responses are sent as JSON objects.

Commands and responses are sent as JSON objects, denoted by their `type` key.
Commands will have a `command` key, and a `subcommand` key when part of a sub-command.

The message buffer is currently limited to `1024` bytes.
Particularly large messages will be truncated or cause an error.
Expand All @@ -47,7 +57,7 @@ Responds with `ok`.

```json
{
"type": "ping"
"command": "ping"
}
```

Expand All @@ -59,7 +69,7 @@ Responds with `ok`.

```json
{
"type": "inspect"
"command": "inspect"
}
```

Expand All @@ -73,38 +83,57 @@ Responds with `ok`.

```json
{
"type": "reload"
"command": "reload"
}
```

### `load_css`

Loads an additional CSS stylesheet, with hot-reloading enabled.

Responds with `ok` if the stylesheet exists, otherwise `error`.

```json
{
"command": "load_css",
"path": "/path/to/style.css"
}
```

### `get`
### `var`

Subcommand for controlling Ironvars.

#### `get`

Gets an [ironvar](ironvars) value.

Responds with `ok_value` if the value exists, otherwise `error`.

```json
{
"type": "get",
"command": "var",
"subcommand": "get",
"key": "foo"
}
```

### `set`
#### `set`

Sets an [ironvar](ironvars) value.

Responds with `ok`.

```json
{
"type": "set",
"command": "var",
"subcommand": "set",
"key": "foo",
"value": "bar"
}
```

### list
#### `list`

Gets a list of all [ironvar](ironvars) values.

Expand All @@ -114,89 +143,148 @@ Each key/value pair is on its own `\n` separated newline. The key and value are

```json
{
"type": "list"
"command": "var",
"subcommand": "list"
}
```

### `load_css`
### `bar`

Loads an additional CSS stylesheet, with hot-reloading enabled.
#### `show`

Responds with `ok` if the stylesheet exists, otherwise `error`.
Forces a bar to be shown, regardless of the current visibility state.

```json
{
"type": "load_css",
"path": "/path/to/style.css"
"command": "bar",
"subcommand": "show",
"name": "bar-123"
}
```

#### `hide`

Forces a bar to be hidden, regardless of the current visibility state.

```json
{
"command": "bar",
"subcommand": "hide",
"name": "bar-123"
}
```

### `set_visible`
#### `set_visible`

Sets a bar's visibility.
Sets a bar's visibility to one of shown/hidden.

Responds with `ok` if the bar exists, otherwise `error`.

```json
{
"type": "set_visible",
"bar_name": "bar-123",
"command": "bar",
"subcommand": "set_visible",
"name": "bar-123",
"visible": true
}
```

### `get_visible`
#### `toggle_visible`

Toggles the current visibility state of a bar between shown and hidden.

```json
{
"command": "bar",
"subcommand": "toggle_visible",
"name": "bar-123"
}
```

#### `get_visible`

Gets a bar's visibility.

Responds with `ok_value` and the visibility (`true`/`false`) if the bar exists, otherwise `error`.

```json
{
"type": "get_visible",
"bar_name": "bar-123"
"command": "bar",
"subcommand": "get_visible",
"name": "bar-123"
}
```

### `toggle_popup`
#### `show_popup`

Toggles the open/closed state for a module's popup.
Sets a module's popup open, regardless of its current state.
Since each bar only has a single popup, any open popup on the bar is closed.

Responds with `ok` if the popup exists, otherwise `error`.
Responds with `ok` if the bar and widget exist, otherwise `error`.

```json
{
"type": "toggle_popup",
"bar_name": "bar-123",
"name": "clock"
"command": "bar",
"subcommand": "show_popup",
"name": "bar-123",
"widget_name": "clock"
}
```

### `open_popup`
#### `hide_popup`

Sets a module's popup open, regardless of its current state.
Sets the popup on a bar closed, regardless of which module it is open for.

Responds with `ok` if the bar and widget exist, otherwise `error`.

```json
{
"command": "bar",
"subcommand": "hide_popup",
"bar_name": "bar-123"
}
```

#### `set_popup_visible`

Sets a popup's visibility to one of shown/hidden.

Responds with `ok` if the bar and widget exist, otherwise `error`.

```json
{
"command": "bar",
"subcommand": "set_popup_visible",
"name": "bar-123",
"widget_name": "clock",
"visible": true
}
```

#### `toggle_popup`

Toggles the open/closed state for a module's popup.
Since each bar only has a single popup, any open popup on the bar is closed.

Responds with `ok` if the popup exists, otherwise `error`.
Responds with `ok` if the bar and widget exist, otherwise `error`.

```json
{
"type": "open_popup",
"command": "bar",
"subcommand": "toggle_popup",
"bar_name": "bar-123",
"name": "clock"
"widget_name": "clock"
}
```

### `close_popup`

Sets the popup on a bar closed, regardless of which module it is open for.
#### `get_popup_visible`

Responds with `ok` if the popup exists, otherwise `error`.
Gets the popup's current visibility state.

```json
{
"type": "close_popup",
"command": "bar",
"subcommand": "get_popup_visible",
"bar_name": "bar-123"
}
```
Expand Down
9 changes: 9 additions & 0 deletions src/bar.rs
Original file line number Diff line number Diff line change
Expand Up @@ -320,6 +320,15 @@ impl Bar {
Inner::Loaded { popup } => popup.clone(),
}
}

pub fn visible(&self) -> bool {
self.window.is_visible()
}

/// Sets the window visibility status
pub fn set_visible(&self, visible: bool) {
self.window.set_visible(visible)
}
}

/// Creates a `gtk::Box` container to place widgets inside.
Expand Down
Loading

0 comments on commit 146f88b

Please sign in to comment.