Skip to content

Commit

Permalink
feat(music): ability to truncate button text
Browse files Browse the repository at this point in the history 
Adds new `truncate.mode` and `truncate.length` options, and `truncate` shorthand for mode.

Resolves #56.
  • Loading branch information
@JakeStanger
JakeStanger committed Jan 28, 2023
1 parent 012762e commit 8691824
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 11 deletions.
24 changes: 15 additions & 9 deletions docs/modules/Music.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,17 @@ in MPRIS mode, the widget will listen to all players and automatically detect/di

> Type: `music`
| | Type | Default | Description |
|----------------|------------------|-----------------------------|----------------------------------------------------------------------------------|
| `player_type` | `mpris` or `mpd` | `mpris` | Whether to connect to MPRIS players or an MPD server. |
| `format` | `string` | `{icon} {title} / {artist}` | Format string for the widget. More info below. |
| `icons.play` | `string` | `` | Icon to show when playing. |
| `icons.pause` | `string` | `` | Icon to show when paused. |
| `icons.volume` | `string` | `墳` | Icon to show under popup volume slider. |
| `host` | `string` | `localhost:6600` | [MPD Only] TCP or Unix socket for the MPD server. |
| `music_dir` | `string` | `$HOME/Music` | [MPD Only] Path to MPD server's music directory on disc. Required for album art. |
| | Type | Default | Description |
|-------------------------------|------------------------------|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| `player_type` | `mpris` or `mpd` | `mpris` | Whether to connect to MPRIS players or an MPD server. |
| `format` | `string` | `{icon} {title} / {artist}` | Format string for the widget. More info below. |
| `truncate` or `truncate.mode` | `start` or `middle` or `end` | `null` | The location of the ellipses and where to truncate text from. Leave null to avoid truncating. Use the long-hand version if specifying a length. |
| `truncate.length` | `integer` | `null` | The maximum number of characters before truncating. Leave blank to let GTK automatically handle. |
| `icons.play` | `string` | `` | Icon to show when playing. |
| `icons.pause` | `string` | `` | Icon to show when paused. |
| `icons.volume` | `string` | `墳` | Icon to show under popup volume slider. |
| `host` | `string` | `localhost:6600` | [MPD Only] TCP or Unix socket for the MPD server. |
| `music_dir` | `string` | `$HOME/Music` | [MPD Only] Path to MPD server's music directory on disc. Required for album art. |

<details>
<summary>JSON</summary>
Expand All @@ -31,6 +33,7 @@ in MPRIS mode, the widget will listen to all players and automatically detect/di
"type": "music",
"player_type": "mpd",
"format": "{icon} {title} / {artist}",
"truncate": "end",
"icons": {
"play": "",
"pause": ""
Expand All @@ -52,6 +55,7 @@ type = "music"
player_type = "mpd"
format = "{icon} {title} / {artist}"
music_dir = "/home/jake/Music"
truncate = "end"

[[start.icons]]
play = ""
Expand All @@ -68,6 +72,7 @@ start:
- type: "music"
player_type: "mpd"
format: "{icon} {title} / {artist}"
truncate: "end"
icons:
play: ""
pause: ""
Expand All @@ -86,6 +91,7 @@ start:
type = "music"
player_type = "mpd"
format = "{icon} {title} / {artist}"
truncate = "end"
icons.play = ""
icons.pause = ""
music_dir = "/home/jake/Music"
Expand Down
60 changes: 59 additions & 1 deletion src/modules/music.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ use color_eyre::Result;
use dirs::{audio_dir, home_dir};
use glib::Continue;
use gtk::gdk_pixbuf::Pixbuf;
use gtk::pango::EllipsizeMode as GtkEllipsizeMode;
use gtk::prelude::*;
use gtk::{Button, Image, Label, Orientation, Scale};
use regex::Regex;
Expand Down Expand Up @@ -53,7 +54,6 @@ impl Default for Icons {
#[derive(Debug, Deserialize, Clone, Copy)]
#[serde(rename_all = "snake_case")]
pub enum PlayerType {
// Auto,
Mpd,
Mpris,
}
Expand All @@ -64,6 +64,50 @@ impl Default for PlayerType {
}
}

#[derive(Debug, Deserialize, Clone, Copy)]
#[serde(rename_all = "snake_case")]
pub enum EllipsizeMode {
Start,
Middle,
End,
}

impl From<EllipsizeMode> for GtkEllipsizeMode {
fn from(value: EllipsizeMode) -> Self {
match value {
EllipsizeMode::Start => Self::Start,
EllipsizeMode::Middle => Self::Middle,
EllipsizeMode::End => Self::End,
}
}
}

#[derive(Debug, Deserialize, Clone, Copy)]
#[serde(untagged)]
enum TruncateMode {
Auto(EllipsizeMode),
MaxLength {
mode: EllipsizeMode,
length: Option<i32>,
},
}

impl TruncateMode {
fn mode(&self) -> EllipsizeMode {
match self {
TruncateMode::Auto(mode) => *mode,
TruncateMode::MaxLength { mode, .. } => *mode,
}
}

fn length(&self) -> Option<i32> {
match self {
TruncateMode::Auto(_) => None,
TruncateMode::MaxLength { length, .. } => *length,
}
}
}

#[derive(Debug, Deserialize, Clone)]
pub struct MusicModule {
/// Type of player to connect to
Expand All @@ -78,6 +122,8 @@ pub struct MusicModule {
#[serde(default)]
icons: Icons,

truncate: Option<TruncateMode>,

// -- MPD --
/// TCP or Unix socket address.
#[serde(default = "default_socket")]
Expand Down Expand Up @@ -245,8 +291,20 @@ impl Module<Button> for MusicModule {
info: &ModuleInfo,
) -> Result<ModuleWidget<Button>> {
let button = Button::new();

let label = Label::new(None);
label.set_angle(info.bar_position.get_angle());

if let Some(truncate) = self.truncate {
println!("{truncate:?}");

label.set_ellipsize(truncate.mode().into());

if let Some(max_length) = truncate.length() {
label.set_max_width_chars(max_length);
}
}

button.add(&label);

let orientation = info.bar_position.get_orientation();
Expand Down
2 changes: 1 addition & 1 deletion src/modules/script.rs
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
use crate::config::CommonConfig;
use crate::modules::{Module, ModuleInfo, ModuleUpdateEvent, ModuleWidget, WidgetContext};
use crate::script::{OutputStream, Script, ScriptMode};
use crate::try_send;
use color_eyre::{Help, Report, Result};
use gtk::prelude::*;
use gtk::Label;
use serde::Deserialize;
use tokio::spawn;
use tokio::sync::mpsc::{Receiver, Sender};
use tracing::error;
use crate::try_send;

#[derive(Debug, Deserialize, Clone)]
pub struct ScriptModule {
Expand Down

0 comments on commit 8691824

Please sign in to comment.