Restructure the shared parts of the lib

Cargo.lock

@@ -636,6 +636,7 @@ version = "0.0.1"
 dependencies = [
  "battery",
  "chrono",
+ "directories",
  "env_logger",
  "log",
  "once_cell",

swayr/src/cmds.rs

@@ -16,9 +16,9 @@
 //! Functions and data structures of the swayr client.
 
 use crate::config as cfg;
-use crate::ipc;
-use crate::ipc::NodeMethods;
 use crate::layout;
+use crate::shared::ipc;
+use crate::shared::ipc::NodeMethods;
 use crate::tree as t;
 use crate::util;
 use crate::util::DisplayFormat;

swayr/src/config.rs

@@ -15,13 +15,11 @@
 
 //! TOML configuration for swayr.
 
-use directories::ProjectDirs;
+use crate::shared::util as shared_util;
 use serde::{Deserialize, Serialize};
 use std::collections::HashMap;
-use std::fs::DirBuilder;
 use std::fs::OpenOptions;
 use std::io::{Read, Write};
-use std::path::Path;
 
 #[derive(Debug, Serialize, Deserialize)]
 pub struct Config {
@@ -304,24 +302,8 @@ impl Default for Config {
     }
 }
 
-fn get_config_file_path() -> Box<Path> {
-    let proj_dirs = ProjectDirs::from("", "", "swayr").expect("");
-    let user_config_dir = proj_dirs.config_dir();
-    if !user_config_dir.exists() {
-        let sys_config_file = Path::new("/etc/xdg/swayr/config.toml");
-        if sys_config_file.exists() {
-            return sys_config_file.into();
-        }
-        DirBuilder::new()
-            .recursive(true)
-            .create(user_config_dir)
-            .unwrap();
-    }
-    user_config_dir.join("config.toml").into_boxed_path()
-}
-
 pub fn save_config(cfg: Config) {
-    let path = get_config_file_path();
+    let path = shared_util::get_config_file_path("swayr");
     let content =
         toml::to_string_pretty(&cfg).expect("Cannot serialize config.");
     let mut file = OpenOptions::new()
@@ -334,7 +316,7 @@ pub fn save_config(cfg: Config) {
 }
 
 pub fn load_config() -> Config {
-    let path = get_config_file_path();
+    let path = shared_util::get_config_file_path("swayr");
     if !path.exists() {
         save_config(Config::default());
         // Tell the user that a fresh default config has been created.

swayr/src/fmt_replace.rs

@@ -1,74 +0,0 @@
-// Copyright (C) 2022  Tassilo Horn <tsdh@gnu.org>
-//
-// This program is free software: you can redistribute it and/or modify it
-// under the terms of the GNU General Public License as published by the Free
-// Software Foundation, either version 3 of the License, or (at your option)
-// any later version.
-//
-// This program is distributed in the hope that it will be useful, but WITHOUT
-// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
-// more details.
-//
-// You should have received a copy of the GNU General Public License along with
-// this program.  If not, see <https://www.gnu.org/licenses/>.
-
-use once_cell::sync::Lazy;
-use regex::Regex;
-
-pub static PLACEHOLDER_RX: Lazy<Regex> = Lazy::new(|| {
-    Regex::new(
-        r"\{(?P<name>[^}:]+)(?::(?P<fmtstr>\{[^}]*\})(?P<clipstr>[^}]*))?\}",
-    )
-    .unwrap()
-});
-
-pub fn maybe_html_escape(do_it: bool, text: String) -> String {
-    if do_it {
-        text.replace('<', "&lt;")
-            .replace('>', "&gt;")
-            .replace('&', "&amp;")
-    } else {
-        text
-    }
-}
-
-macro_rules! fmt_replace {
-    ( $fmt_str:expr, $html_escape:expr,
-      { $( $($pat:pat_param)|+ => $exp:expr, )+ }
-    ) => {
-        $crate::fmt_replace::PLACEHOLDER_RX
-            .replace_all($fmt_str, |caps: &regex::Captures| {
-                let value: String = match &caps["name"] {
-                    $(
-                        $( $pat )|+ => {
-                            let val = $crate::rtfmt::FmtArg::from($exp);
-                            let fmt_str = caps.name("fmtstr")
-                                .map_or("{}", |m| m.as_str());
-                            let clipped_str = caps.name("clipstr")
-                                .map_or("", |m| m.as_str());
-                            $crate::fmt_replace::maybe_html_escape(
-                                $html_escape,
-                                $crate::rtfmt::format(fmt_str, val, clipped_str),
-                            )
-                        }
-                    )+
-                        _ => caps[0].to_string(),
-                };
-                value
-            }).into()
-    };
-}
-
-pub(crate) use fmt_replace;
-
-#[test]
-fn foo() {
-    let foo = "{a}, {b}";
-    let html_escape = true;
-    let x: String = fmt_replace!(foo, html_escape, {
-        "a" => "1".to_string(),
-        "b" =>  "2".to_string(),
-        "c" => "3".to_owned(),
-    });
-}

swayr/src/layout.rs

@@ -16,8 +16,8 @@
 //! Functions and data structures of the swayrd demon.
 
 use crate::config;
-use crate::ipc;
-use crate::ipc::NodeMethods;
+use crate::shared::ipc;
+use crate::shared::ipc::NodeMethods;
 use std::collections::HashMap;
 use swayipc as s;
 

swayr/src/lib.rs

@@ -22,9 +22,7 @@ pub mod client;
 pub mod cmds;
 pub mod config;
 pub mod demon;
-pub mod fmt_replace;
-pub mod ipc;
 pub mod layout;
-pub mod rtfmt;
+pub mod shared;
 pub mod tree;
 pub mod util;

swayr/src/shared/fmt.rs

@@ -13,10 +13,8 @@
 // You should have received a copy of the GNU General Public License along with
 // this program.  If not, see <https://www.gnu.org/licenses/>.
 
-//! Provides runtime formatting of strings since our format strings are read
-//! from the swayr config, not specified as literals, e.g., `{name:{:.30}}` in
-//! `format.window_format`.
-
+use once_cell::sync::Lazy;
+use regex::Regex;
 use rt_format::{
     Format, FormatArgument, NoNamedArguments, ParsedFormat, Specifier,
 };
@@ -148,3 +146,60 @@ fn test_format() {
     assert_eq!(format("{:.5}", "sway window", "..."), "sw...");
     assert_eq!(format("{:.2}", "sway", "..."), "...");
 }
+
+pub static PLACEHOLDER_RX: Lazy<Regex> = Lazy::new(|| {
+    Regex::new(
+        r"\{(?P<name>[^}:]+)(?::(?P<fmtstr>\{[^}]*\})(?P<clipstr>[^}]*))?\}",
+    )
+    .unwrap()
+});
+
+pub fn maybe_html_escape(do_it: bool, text: String) -> String {
+    if do_it {
+        text.replace('<', "&lt;")
+            .replace('>', "&gt;")
+            .replace('&', "&amp;")
+    } else {
+        text
+    }
+}
+
+macro_rules! fmt_replace {
+    ( $fmt_str:expr, $html_escape:expr,
+      { $( $($pat:pat_param)|+ => $exp:expr, )+ }
+    ) => {
+        $crate::shared::fmt::PLACEHOLDER_RX
+            .replace_all($fmt_str, |caps: &regex::Captures| {
+                let value: String = match &caps["name"] {
+                    $(
+                        $( $pat )|+ => {
+                            let val = $crate::shared::fmt::FmtArg::from($exp);
+                            let fmt_str = caps.name("fmtstr")
+                                .map_or("{}", |m| m.as_str());
+                            let clipped_str = caps.name("clipstr")
+                                .map_or("", |m| m.as_str());
+                            $crate::shared::fmt::maybe_html_escape(
+                                $html_escape,
+                                $crate::shared::fmt::format(fmt_str, val, clipped_str),
+                            )
+                        }
+                    )+
+                        _ => caps[0].to_string(),
+                };
+                value
+            }).into()
+    };
+}
+
+pub(crate) use fmt_replace;
+
+#[test]
+fn foo() {
+    let foo = "{a}, {b}";
+    let html_escape = true;
+    let x: String = fmt_replace!(foo, html_escape, {
+        "a" => "1".to_string(),
+        "b" =>  "2".to_string(),
+        "c" => "3".to_owned(),
+    });
+}

swayr/src/shared/mod.rs

@@ -0,0 +1,18 @@
+// Copyright (C) 2021-2022  Tassilo Horn <tsdh@gnu.org>
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License as published by the Free
+// Software Foundation, either version 3 of the License, or (at your option)
+// any later version.
+//
+// This program is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+// more details.
+//
+// You should have received a copy of the GNU General Public License along with
+// this program.  If not, see <https://www.gnu.org/licenses/>.
+
+pub mod fmt;
+pub mod ipc;
+pub mod util;

swayr/src/shared/util.rs

@@ -0,0 +1,36 @@
+// Copyright (C) 2021-2022  Tassilo Horn <tsdh@gnu.org>
+//
+// This program is free software: you can redistribute it and/or modify it
+// under the terms of the GNU General Public License as published by the Free
+// Software Foundation, either version 3 of the License, or (at your option)
+// any later version.
+//
+// This program is distributed in the hope that it will be useful, but WITHOUT
+// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
+// more details.
+//
+// You should have received a copy of the GNU General Public License along with
+// this program.  If not, see <https://www.gnu.org/licenses/>.
+
+/// Utility stuff shared by swayr and swayrbar.
+use directories::ProjectDirs;
+use std::fs::DirBuilder;
+use std::path::Path;
+
+pub fn get_config_file_path(project: &str) -> Box<Path> {
+    let proj_dirs = ProjectDirs::from("", "", project).expect("");
+    let user_config_dir = proj_dirs.config_dir();
+    if !user_config_dir.exists() {
+        let sys_path = format!("/etc/xdg/{}/config.toml", project);
+        let sys_config_file = Path::new(sys_path.as_str());
+        if sys_config_file.exists() {
+            return sys_config_file.into();
+        }
+        DirBuilder::new()
+            .recursive(true)
+            .create(user_config_dir)
+            .unwrap();
+    }
+    user_config_dir.join("config.toml").into_boxed_path()
+}

swayr/src/tree.rs

@@ -16,9 +16,9 @@
 //! Convenience data structures built from the IPC structs.
 
 use crate::config;
-use crate::fmt_replace::fmt_replace;
-use crate::ipc;
-use crate::ipc::NodeMethods;
+use crate::shared::fmt::fmt_replace;
+use crate::shared::ipc;
+use crate::shared::ipc::NodeMethods;
 use crate::util;
 use crate::util::DisplayFormat;
 use once_cell::sync::Lazy;
@@ -186,7 +186,7 @@ impl<'a> Tree<'a> {
         self.as_display_nodes(&v, IndentLevel::WorkspacesZeroWindowsOne)
     }
 
-    fn sort_by_urgency_and_lru_time_1(&self, v: &mut Vec<&s::Node>) {
+    fn sort_by_urgency_and_lru_time_1(&self, v: &mut [&s::Node]) {
         v.sort_by(|a, b| {
             if a.urgent && !b.urgent {
                 cmp::Ordering::Less

swayrbar/Cargo.toml

@@ -7,11 +7,10 @@ repository = "https://git.sr.ht/~tsdh/swayr"
 authors = ["Tassilo Horn <tsdh@gnu.org>"]
 license = "GPL-3.0+"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 battery = "0.7.8"
 chrono = "0.4"
+directories = "4.0"
 env_logger = { version = "0.9.0", default-features = false, features = ["termcolor", "atty", "humantime"] }  # without regex
 log = "0.4"
 once_cell = "1.10.0"

swayrbar/src/bar/module/battery.rs

@@ -17,7 +17,7 @@
 
 use crate::bar::config;
 use crate::bar::module::BarModuleFn;
-use crate::fmt_replace::fmt_replace;
+use crate::shared::fmt::fmt_replace;
 use battery as bat;
 use std::collections::{HashMap, HashSet};
 use swaybar_types as s;

swayrbar/src/bar/module/sysinfo.rs

@@ -17,7 +17,7 @@
 
 use crate::bar::config;
 use crate::bar::module::BarModuleFn;
-use crate::fmt_replace::fmt_replace;
+use crate::shared::fmt::fmt_replace;
 use std::collections::HashMap;
 use std::sync::Mutex;
 use std::sync::Once;

swayrbar/src/bar/module/window.rs

@@ -19,9 +19,9 @@ use std::collections::HashMap;
 
 use crate::bar::config;
 use crate::bar::module::BarModuleFn;
-use crate::fmt_replace::fmt_replace;
-use crate::ipc;
-use crate::ipc::NodeMethods;
+use crate::shared::fmt::fmt_replace;
+use crate::shared::ipc;
+use crate::shared::ipc::NodeMethods;
 use swaybar_types as s;
 
 const NAME: &str = "window";

swayrbar/src/fmt_replace.rs

@@ -1 +0,0 @@
-../../swayr/src/fmt_replace.rs

swayrbar/src/ipc.rs

@@ -1 +0,0 @@
-../../swayr/src/ipc.rs

swayrbar/src/lib.rs

@@ -14,6 +14,4 @@
 // this program.  If not, see <https://www.gnu.org/licenses/>.
 
 pub mod bar;
-pub mod fmt_replace;
-pub mod ipc;
-pub mod rtfmt;
+pub mod shared;

swayrbar/src/rtfmt.rs

@@ -1 +0,0 @@
-../../swayr/src/rtfmt.rs

swayrbar/src/shared

@@ -0,0 +1 @@
+../../swayr/src/shared