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 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
#[cfg(all(feature = "json-fmt", not(feature = "toml-fmt")))] use serde_json as serde_fmt; #[cfg(not(any(feature = "toml-fmt", feature = "json-fmt")))] use serde_yaml as serde_fmt; #[cfg(all(feature = "toml-fmt", not(feature = "json-fmt")))] use toml as serde_fmt; use tokio::prelude::stream::{self, Stream}; use dirs; use std::fs::File; use std::io::{Error as IOError, ErrorKind, Read}; use std::path::Path; use std::sync::mpsc::{self, Receiver, Sender, TryRecvError}; use std::sync::{Arc, Mutex, MutexGuard}; use std::thread; use crate::components::{Component, ComponentID, ComponentStream}; use crate::config::Config; use crate::event::Event; const PATH_LOAD_ORDER: [&str; 3] = [ "{config}/{name}.{ext}", "{home}/.{name}.{ext}", "/etc/{name}/{name}.{ext}", ]; /// Wrapper around the bar configuration. /// /// This is a safe wrapper around the bar configuration. It can notify consumers about any updates /// to the state of the configuration file. /// /// The `Bar` is the central point of interaction for any consumer. The [`Config`] can be accessed /// through an instance of `Bar` using the [`load`] method. The [`recv`] and [`try_recv`] methods /// should be used to check for updates of any component of the configuration file. /// /// [`Config`]: config/struct.Config.html /// [`load`]: #method.load /// [`recv`]: #method.recv /// [`try_recv`]: #method.try_recv #[derive(Debug)] pub struct Bar { error_count: usize, config: Arc<Mutex<Config>>, events: Option<(Sender<ComponentID>, Receiver<ComponentID>)>, } impl Bar { /// Load the initial bar configuration. /// /// Loads the initial state of the bar configuration from the specified source. /// /// The method will not launch any of the components that are specified in the configuration /// file, this is done with the [`recv`] and [`try_recv`] methods. /// /// # Errors /// /// If the `config_file` cannot be read or its content is not valid. If the configuration is /// invalid, the [`io::ErrorKind::InvalidData`] value is returned. /// /// # Examples /// /// ``` /// use bar_config::Bar; /// use std::io::Cursor; /// /// let config_file = Cursor::new(String::from( /// "height: 30\n\ /// monitors:\n\ /// - { name: \"DVI-1\" }" /// )); /// /// let bar = Bar::load(config_file).unwrap(); /// let config = bar.lock(); /// /// assert_eq!(config.height, 30); /// assert_eq!(config.monitors.len(), 1); /// assert_eq!(config.monitors[0].name, "DVI-1"); /// ``` /// /// [`io::ErrorKind::InvalidData`]: /// https://doc.rust-lang.org/std/io/enum.ErrorKind.html#variant.InvalidData /// [`recv`]: #method.recv /// [`try_recv`]: #method.try_recv pub fn load<T: Read>(mut config_file: T) -> Result<Self, IOError> { let mut content = String::new(); config_file.read_to_string(&mut content)?; let config = serde_fmt::from_str(&content).map_err(|e| IOError::new(ErrorKind::InvalidData, e))?; Ok(Bar { events: None, error_count: 0, config: Arc::new(Mutex::new(config)), }) } /// Blocking poll for updates. /// /// Polls the event buffer for the next event. If no event is currently queued, this will block /// until the next event is received. /// /// # Examples /// /// ```no_run /// use bar_config::Bar; /// use std::io::Cursor; /// /// let config_file = Cursor::new(String::from( /// "height: 30\n\ /// monitors:\n\ /// - { name: \"DVI-1\" }\n\ /// left:\n\ /// - { name: \"clock\" }" /// )); /// /// let mut bar = Bar::load(config_file).unwrap(); /// let component_id = bar.recv(); /// println!("Component {:?} was updated!", component_id); /// ``` pub fn recv(&mut self) -> ComponentID { if self.events.is_none() { self.events = Some(self.start_loop()); } self.events.as_ref().unwrap().1.recv().unwrap() } /// Non-Blocking poll for updates. /// /// Polls the event buffer for the next event. If no event is currently queued, this will /// return `None`. /// /// # Examples /// /// ``` /// use bar_config::Bar; /// use std::io::Cursor; /// /// let config_file = Cursor::new(String::from( /// "height: 30\n\ /// monitors:\n\ /// - { name: \"DVI-1\" }\n\ /// left:\n\ /// - { name: \"clock\" }" /// )); /// /// let mut bar = Bar::load(config_file).unwrap(); /// if let Some(component_id) = bar.try_recv() { /// println!("Component {:?} was updated!", component_id); /// } else { /// println!("No new event!"); /// } /// ``` pub fn try_recv(&mut self) -> Option<ComponentID> { if self.events.is_none() { self.events = Some(self.start_loop()); } match self.events.as_ref().unwrap().1.try_recv() { Ok(comp_id) => Some(comp_id), Err(TryRecvError::Empty) => None, Err(e) => Err(e).unwrap(), } } /// Lock the configuration file. /// /// Locks the configuration file so its state can be used to render the bar. Since this creates /// a `MutexGuard`, no events will be received while the lock is held. /// /// # Examples /// ``` /// use bar_config::Bar; /// use std::io::Cursor; /// /// let config_file = Cursor::new(String::from( /// "height: 30\n\ /// monitors:\n\ /// - { name: \"DVI-1\" }" /// )); /// /// let mut bar = Bar::load(config_file).unwrap(); /// let config = bar.lock(); /// /// assert_eq!(config.height, 30); /// assert_eq!(config.monitors.len(), 1); /// assert_eq!(config.monitors[0].name, "DVI-1"); /// ``` pub fn lock(&self) -> MutexGuard<Config> { self.config.lock().unwrap() } /// Send an event to all components. /// /// Notifies all components that a new event is available. The components then have the choice /// to react upon the event or ignore it completely. /// /// If a component handles the event and marks itself as `dirty` as a result of the event, a /// new redraw request will be queued for the [`recv`] and [`try_recv`] methods. /// /// # Examples /// ``` /// use bar_config::event::{Event, Point}; /// use bar_config::Bar; /// use std::io::Cursor; /// /// let config_file = Cursor::new(String::from( /// "height: 30\n\ /// monitors:\n\ /// - { name: \"DVI-1\" }" /// )); /// /// let mut bar = Bar::load(config_file).unwrap(); /// bar.notify(Event::MouseMotion(Point { x: 0, y: 0 })); /// ``` /// /// [`recv`]: #method.recv /// [`try_recv`]: #method.try_recv pub fn notify(&mut self, event: Event) { let mut config = self.lock(); // Find all dirty components let mut dirty_comps = Vec::new(); let mut notify = |comps: &mut Vec<Box<Component>>| { for comp in comps { if comp.notify(event) { dirty_comps.push(comp.id()); } } }; notify(&mut config.left); notify(&mut config.center); notify(&mut config.right); drop(config); if let Some((ref events_tx, _)) = self.events { for comp_id in dirty_comps { events_tx.send(comp_id).unwrap(); } } } // Starts the event loop in a new thread fn start_loop(&self) -> (Sender<ComponentID>, Receiver<ComponentID>) { let (events_tx, events_rx) = mpsc::channel(); let bar_events_tx = events_tx.clone(); let config = self.config.clone(); thread::spawn(move || { // Combine all component events into one blocking iterator let combined = { let config = config.lock().unwrap(); let mut combined: ComponentStream = Box::new(stream::empty()); for comp in config .left .iter() .chain(&config.center) .chain(&config.right) { combined = Box::new(combined.select(comp.stream())); } combined }; // Propagate events let combined = combined.for_each(move |comp_id| { let mut config = config.lock().unwrap(); // Try to find the component with a matching ID and update it let update_comps = |comps: &mut Vec<Box<Component>>| { if let Some(true) = comps .iter_mut() .find(|comp| comp_id == comp.id()) .map(|comp| comp.update()) { events_tx.send(comp_id).unwrap(); true } else { false } }; // Short-circuit update the component with a matching ID let _ = update_comps(&mut config.left) || update_comps(&mut config.center) || update_comps(&mut config.right); Ok(()) }); // Iterate over all component events forever tokio::run(combined); }); (bar_events_tx, events_rx) } } /// Find the configuration file. /// /// This looks for the configuration file of the bar in a predefined list of directories. /// The `name` parameter is used for the configuration file name and the extension is based /// on the enabled features. /// /// The directories are used in the following order: /// ```text /// ~/.config/name.ext /// ~/.name.ext /// /etc/name/name.ext /// ``` /// /// The file endings map to the specified library features: /// /// Feature | Extension /// ---------|---------- /// default | yml /// toml-fmt | toml /// json-fmt | json /// /// # Errors /// /// This method will fail if the configuration file cannot be opened. If there was no file present /// in any of the directories, the [`io::ErrorKind::NotFound`] error will be returned. /// /// # Examples /// /// ``` /// use bar_config::config_file; /// use std::io::ErrorKind; /// /// let file_result = config_file("mybar"); /// assert_eq!(file_result.err().unwrap().kind(), ErrorKind::NotFound); /// ``` /// /// [`io::ErrorKind::NotFound`]: https://doc.rust-lang.org/std/io/enum.ErrorKind.html#variant.NotFound pub fn config_file(name: &str) -> Result<File, IOError> { for path in &PATH_LOAD_ORDER[..] { let mut path = path.to_string(); #[cfg_attr(feature = "cargo-clippy", allow(ifs_same_cond))] let extension = if cfg!(feature = "toml-fmt") && !cfg!(feature = "json-fmt") { "toml" } else if cfg!(feature = "json-fmt") && !cfg!(feature = "toml-fmt") { "json" } else { "yml" }; path = path.replace("{ext}", extension); path = path.replace( "{home}", &dirs::home_dir() .and_then(|p| Some(p.to_string_lossy().to_string())) .unwrap_or_else(String::new), ); path = path.replace( "{config}", &dirs::config_dir() .and_then(|p| Some(p.to_string_lossy().to_string())) .unwrap_or_else(String::new), ); path = path.replace("{name}", name); let metadata = Path::new(&path).metadata(); if let Ok(metadata) = metadata { if metadata.is_file() { return Ok(File::open(path)?); } } } Err(IOError::new(ErrorKind::NotFound, "no config file present")) }