Drop hard-coded whitespace and render icon as a placeholder

NEWS.md

@@ -1,6 +1,6 @@
 # i3status-rust 0.30.0 [unreleased]
 
-Block documentation was moved from `docs/blocks.md` to: https://greshake.github.io/i3status-rust/i3status_rs/blocks/index.html  
+Block documentation was moved from `docs/blocks.md` to: https://greshake.github.io/i3status-rust/i3status_rs/blocks/index.html
 Formatter documentation is available here: https://greshake.github.io/i3status-rust/i3status_rs/formatting/index.html
 
 ### Breaking changes
@@ -61,12 +61,37 @@ This is a major release which rewrites the core code to be asynchronous.
   ```
 - `theme` and `icons`: `name` and `file` options have been merged into `theme`/`icons`. See above for an example.
 
+- Major icons and whitespace change. Icons are now part of `format` option as a placeholder in blocks where format is customizable.
+  If you've modified `format` and would like to keep the same behaviour (icon, whitespace)
+  you need to update the value. For example,
+  ```toml
+  [[block]]
+  block = "cpu"
+  format = "cpu:{utilization}"
+  ```
+  needs to be changed to:
+  ```toml
+  [[block]]
+  block = "cpu"
+  format = " $icon $utilization "
+  ```
+
+- **battery**: `hide_missing` option is replaced with `missing_format`. You can set `missing_format = ""` to maintain the behavior
+- **battery**: `hide_full` option is removed. You can set `full_format = ""` to maintain the behavior
+- **bluetooth**: hide_disconnected option is replaced with `disconnected_format`. You can set `disconnected_format = ""` to hide the block
+- **focused_window**: `autohide` is removed. You can format to `" $title.str(0,21) | Missing "` to display the block when title is missing
+- **net**: `hide_missing` and `hide_inactive` are removed. You can set `missing_format = ""`
+- **toggle**: `text` option is removed and now you can use `format` to set the text
+- **notmuch**: `name` option is removed and now you can use `format` to set the name
+- **{apt, dnf, pacman}**: `hide_when_uptodate` option is removed and now you can use `format_up_to_date = ""` to hide the block
+
 ### New features and bugfixes
 - When blocks error they no longer take down the entire bar. Instead, they now enter error mode: "X" will be shown and on left click the full error message will be shown in the bar.
 - `custom_dbus` block can now be used more than one in your config
 - `custom` block has new config option `"persistent"` which runs a command in the background and updates the block text for each received output line.
 - `focused_window` block now supports the river window manager if ristate (https://gitlab.com/snakedye/ristate) is installed
 - `battery` now supports `empty_threshold` to specify below which percentage the battery is considered empty, and `empty_format` to use a custom format when the battery is empty
+- more blocks now support `format` option (custom, custom_dbus, hueshift, maildir, notmuch, pomodoro, time, uptime)
 
 ### Dependencies that are no longer required
 

examples/config.toml

@@ -23,13 +23,13 @@ unit = "GB"
 interval = 20
 warning = 20.0
 alert = 10.0
-format = "root: $available.eng(2)"
+format = " $icon root: $available.eng(2) "
 
 [[block]]
 block = "memory"
 display_type = "memory"
-format_mem = "$mem_total_used_percents.eng(2)"
-format_swap = "$swap_used_percents.eng(2)"
+format_mem = " $icon $mem_total_used_percents.eng(2) "
+format_swap = " $icon $swap_used_percents.eng(2) "
 
 [[block]]
 block = "sound"
@@ -40,6 +40,4 @@ cmd = "pavucontrol"
 [[block]]
 block = "time"
 interval = 5
-format = "%a %d/%m %R"
-[block.icons_overrides]
-time = ""
+format = " %a %d/%m %R "

src/blocks.rs

@@ -162,7 +162,7 @@ impl CommonApi {
     /// let mut widget = api
     ///     .new_widget()
     ///     .with_icon("docker")?
-    ///     .with_format(config.format.with_default("$running.eng(1)")?);
+    ///     .with_format(config.format.with_default(" $icon $running.eng(1) ")?);
     /// ```
     pub fn new_widget(&self) -> Widget {
         Widget::new(self.id, self.shared_config.clone())

src/blocks/apt.rs

@@ -9,16 +9,16 @@
 //! Key | Values | Default
 //! ----|--------|--------
 //! `interval` | Update interval in seconds. | `600`
-//! `format` | A string to customise the output of this block. See below for available placeholders. | `"$count.eng(1)"`
-//! `format_singular` | Same as `format`, but for when exactly one update is available. | `"$count.eng(1)"`
-//! `format_up_to_date` | Same as `format`, but for when no updates are available. | `"$count.eng(1)"`
+//! `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon $count.eng(1) "`
+//! `format_singular` | Same as `format`, but for when exactly one update is available. | `" $icon $count.eng(1) "`
+//! `format_up_to_date` | Same as `format`, but for when no updates are available. | `" $icon $count.eng(1) "`
 //! `warning_updates_regex` | Display block as warning if updates matching regex are available. | `None`
 //! `critical_updates_regex` | Display block as critical if updates matching regex are available. | `None`
-//! `hide_when_uptodate` | Hides the block when there are no updates available | `false`
 //!
-//! Key | Value | Type | Unit
-//! ----|-------|------|------
-//! `count` | Number of updates available | Number | -
+//! Placeholder | Value                       | Type   | Unit
+//! ------------|-----------------------------|--------|------
+//! `icon`      | A static icon               | Icon   | -
+//! `count`     | Number of updates available | Number | -
 //!
 //! # Example
 //!
@@ -28,9 +28,9 @@
 //! [[block]]
 //! block = "apt"
 //! interval = 1800
-//! format = "$count updates available"
-//! format_singular = "One update available"
-//! format_up_to_date = "system up to date"
+//! format = " $icon $count updates available "
+//! format_singular = " $icon One update available "
+//! format_up_to_date = " $icon system up to date "
 //! critical_updates_regex = "(linux|linux-lts|linux-zen)"
 //! [[block.click]]
 //! # shows dmenu with cached available updates. Any dmenu alternative should also work.
@@ -61,14 +61,13 @@ struct AptConfig {
     format_up_to_date: FormatConfig,
     warning_updates_regex: Option<String>,
     critical_updates_regex: Option<String>,
-    hide_when_uptodate: bool,
 }
 
 pub async fn run(config: toml::Value, mut api: CommonApi) -> Result<()> {
     let config = AptConfig::deserialize(config).config_error()?;
-    let mut widget = api.new_widget().with_icon("update")?;
+    let mut widget = api.new_widget();
 
-    let format = config.format.with_default("$count.eng(1)")?;
+    let format = config.format.with_default(" $icon $count.eng(1) ")?;
     let format_singular = config.format_singular.with_default("$count.eng(1)")?;
     let format_up_to_date = config.format_up_to_date.with_default("$count.eng(1)")?;
 
@@ -116,37 +115,36 @@ pub async fn run(config: toml::Value, mut api: CommonApi) -> Result<()> {
         let updates = get_updates_list(config_file.to_str().unwrap()).await?;
         let count = get_update_count(&updates);
 
-        if count == 0 && config.hide_when_uptodate {
-            api.hide().await?;
-        } else {
-            widget.set_format(match count {
-                0 => format_up_to_date.clone(),
-                1 => format_singular.clone(),
-                _ => format.clone(),
-            });
-            widget.set_values(map!("count" => Value::number(count)));
-
-            let warning = warning_updates_regex
-                .as_ref()
-                .map_or(false, |regex| has_matching_update(&updates, regex));
-            let critical = critical_updates_regex
-                .as_ref()
-                .map_or(false, |regex| has_matching_update(&updates, regex));
-            widget.state = match count {
-                0 => State::Idle,
-                _ => {
-                    if critical {
-                        State::Critical
-                    } else if warning {
-                        State::Warning
-                    } else {
-                        State::Info
-                    }
+        widget.set_format(match count {
+            0 => format_up_to_date.clone(),
+            1 => format_singular.clone(),
+            _ => format.clone(),
+        });
+        widget.set_values(map!(
+            "count" => Value::number(count),
+            "icon" => Value::icon(api.get_icon("update")?)
+        ));
+
+        let warning = warning_updates_regex
+            .as_ref()
+            .map_or(false, |regex| has_matching_update(&updates, regex));
+        let critical = critical_updates_regex
+            .as_ref()
+            .map_or(false, |regex| has_matching_update(&updates, regex));
+        widget.state = match count {
+            0 => State::Idle,
+            _ => {
+                if critical {
+                    State::Critical
+                } else if warning {
+                    State::Warning
+                } else {
+                    State::Info
                 }
-            };
+            }
+        };
 
-            api.set_widget(&widget).await?;
-        }
+        api.set_widget(&widget).await?;
 
         loop {
             select! {

src/blocks/backlight.rs

@@ -14,17 +14,18 @@
 //! Key | Values | Default
 //! ----|--------|--------
 //! `device` | The `/sys/class/backlight` device to read brightness information from.  When there is no `device` specified, this block will display information from the first device found in the `/sys/class/backlight` directory. If you only have one display, this approach should find it correctly.| Default device
-//! `format` | A string to customise the output of this block. See below for available placeholders. | `"$brightness"`
+//! `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon $brightness "`
 //! `step_width` | The brightness increment to use when scrolling, in percent | `5`
 //! `minimum` | The minimum brightness that can be scrolled down to | `5`
 //! `maximum` | The maximum brightness that can be scrolled up to | `100`
 //! `cycle` | The brightnesses to cycle through on each click | `[minimum, maximum]`
 //! `root_scaling` | Scaling exponent reciprocal (ie. root) | `1.0`
 //! `invert_icons` | Invert icons' ordering, useful if you have colorful emoji | `false`
 //!
-//! Placeholder  | Value              | Type   | Unit
-//! -------------|--------------------|--------|---------------
-//! `brightness` | Current brightness | Number | %
+//! Placeholder  | Value                                     | Type   | Unit
+//! -------------|-------------------------------------------|--------|---------------
+//! `icon`       | Icon based on backlight's state           | Icon   | -
+//! `brightness` | Current brightness                        | Number | %
 //!
 //! # Example
 //!
@@ -129,7 +130,7 @@ pub async fn run(config: toml::Value, mut api: CommonApi) -> Result<()> {
     let config = BacklightConfig::deserialize(config).config_error()?;
     let mut widget = api
         .new_widget()
-        .with_format(config.format.with_default("$brightness")?);
+        .with_format(config.format.with_default(" $icon $brightness ")?);
 
     let mut cycle = config
         .cycle
@@ -158,8 +159,10 @@ pub async fn run(config: toml::Value, mut api: CommonApi) -> Result<()> {
             icon_index = BACKLIGHT_ICONS.len() - icon_index - 1;
         }
 
-        widget.set_icon(BACKLIGHT_ICONS[icon_index])?;
-        widget.set_values(map! { "brightness" => Value::percents(brightness) });
+        widget.set_values(map! {
+            "icon" => Value::icon(api.get_icon(BACKLIGHT_ICONS[icon_index])?),
+            "brightness" => Value::percents(brightness)
+        });
         api.set_widget(&widget).await?;
 
         loop {

src/blocks/battery.rs

@@ -10,11 +10,10 @@
 //! `device` | The device in `/sys/class/power_supply/` to read from. When using UPower, this can also be `"DisplayDevice"`. Regular expressions can be used. | Any battery device
 //! `driver` | One of `"sysfs"`, `"apc_ups"`, or `"upower"` | `"sysfs"`
 //! `interval` | Update interval, in seconds. Only relevant for `driver = "sysfs"` \|\| "apc_ups"`. | `10`
-//! `format` | A string to customise the output of this block. See below for available placeholders. | <code>"$percentage&vert;"</code>
-//! `full_format` | Same as `format` but for when the battery is full | `""`
-//! `empty_format` | Same as `format` but for when the battery is empty | `""`
-//! `hide_missing` | Completely hide this block if the battery cannot be found. | `false`
-//! `hide_full` | Hide the block if battery is full | `false`
+//! `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon $percentage "`
+//! `full_format` | Same as `format` but for when the battery is full | `" $icon "`
+//! `empty_format` | Same as `format` but for when the battery is empty | `" $icon "`
+//! `missing_format` | Same as `format` if the battery cannot be found. | `" $icon "`
 //! `info` | Minimum battery level, where state is set to info | `60`
 //! `good` | Minimum battery level, where state is set to good | `60`
 //! `warning` | Minimum battery level, where state is set to warning | `30`
@@ -24,6 +23,7 @@
 //!
 //! Placeholder  | Value                                                                   | Type              | Unit
 //! -------------|-------------------------------------------------------------------------|-------------------|-----
+//! `icon`       | Icon based on battery's state                                           | Icon   | -
 //! `percentage` | Battery level, in percent                                               | String or Integer | Percents
 //! `time`       | Time remaining until (dis)charge is complete. Presented only if battery's status is (dis)charging. | String | -
 //! `power`      | Power consumption by the battery or from the power supply when charging | String or Float   | Watts
@@ -35,15 +35,15 @@
 //! ```toml
 //! [block]
 //! block = "battery"
-//! format = "$percentage|N/A"
+//! format = " $icon $percentage "
 //! ```
 //!
 //! Hide missing battery:
 //!
 //! ```toml
 //! [block]
 //! block = "battery"
-//! hide_missing = true
+//! missing_format = ""
 //! ```
 //!
 //! # Icons Used
@@ -83,8 +83,7 @@ struct BatteryConfig {
     format: FormatConfig,
     full_format: FormatConfig,
     empty_format: FormatConfig,
-    hide_missing: bool,
-    hide_full: bool,
+    missing_format: FormatConfig,
     #[default(60.0)]
     info: f64,
     #[default(60.0)]
@@ -110,9 +109,10 @@ enum BatteryDriver {
 
 pub async fn run(config: toml::Value, mut api: CommonApi) -> Result<()> {
     let config = BatteryConfig::deserialize(config).config_error()?;
-    let format = config.format.with_default("$percentage")?;
-    let format_full = config.full_format.with_default("")?;
-    let format_empty = config.empty_format.with_default("")?;
+    let format = config.format.with_default(" $icon $percentage ")?;
+    let format_full = config.full_format.with_default(" $icon ")?;
+    let format_empty = config.empty_format.with_default(" $icon ")?;
+    let missing_format = config.missing_format.with_default(" $icon ")?;
     let mut widget = api.new_widget();
 
     let dev_name = DeviceName::new(config.device)?;
@@ -134,17 +134,17 @@ pub async fn run(config: toml::Value, mut api: CommonApi) -> Result<()> {
         }
 
         match info {
-            Some(info) if info.status == BatteryStatus::Full && config.hide_full => {
-                api.hide().await?;
-            }
             Some(info) => {
                 widget.set_format(match info.status {
                     BatteryStatus::Empty => format_empty.clone(),
                     BatteryStatus::Full | BatteryStatus::NotCharging => format_full.clone(),
                     _ => format.clone(),
                 });
 
-                let mut values = map!("percentage" => Value::percents(info.capacity));
+                let mut values = map!(
+                    "percentage" => Value::percents(info.capacity)
+                );
+
                 info.power
                     .map(|p| values.insert("power".into(), Value::watts(p)));
                 info.time_remaining.map(|t| {
@@ -157,7 +157,6 @@ pub async fn run(config: toml::Value, mut api: CommonApi) -> Result<()> {
                         )),
                     )
                 });
-                widget.set_values(values);
 
                 let (icon, state) = match (info.status, info.capacity) {
                     (BatteryStatus::Empty, _) => (battery_level_icon(0, false), State::Critical),
@@ -179,18 +178,15 @@ pub async fn run(config: toml::Value, mut api: CommonApi) -> Result<()> {
                         },
                     ),
                 };
+                values.insert("icon".into(), Value::icon(api.get_icon(icon)?));
 
-                widget.set_icon(icon)?;
+                widget.set_values(values);
                 widget.state = state;
                 api.set_widget(&widget).await?;
             }
-            None if config.hide_missing => {
-                api.hide().await?;
-            }
             None => {
-                widget.set_icon("bat_not_available")?;
-                widget.set_format(format.clone());
-                widget.set_values(default());
+                widget.set_format(missing_format.clone());
+                widget.set_values(map!("icon" => Value::icon(api.get_icon("bat_not_available")?)));
                 widget.state = State::Critical;
                 api.set_widget(&widget).await?;
             }