Add force-poll command

CHANGELOG.md

@@ -20,6 +20,7 @@ All notable changes to eww will be listed here, starting at changes since versio
 - Add trigonometric functions (`sin`, `cos`, `tan`, `cot`) and degree/radian conversions (`degtorad`, `radtodeg`) (By: end-4)
 - Add `substring` function to simplexpr
 - Add `--duration` flag to `eww open`
+- Add `force-poll` command (By: ZaheenJ)
 
 ## [0.4.0] (04.09.2022)
 

crates/eww/src/app.rs

@@ -5,7 +5,7 @@ use crate::{
     error_handling_ctx,
     gtk::prelude::{ContainerExt, CssProviderExt, GtkWindowExt, MonitorExt, StyleContextExt, WidgetExt},
     paths::EwwPaths,
-    script_var_handler::ScriptVarHandlerHandle,
+    script_var_handler::{run_poll_once, ScriptVarHandlerHandle},
     state::scope_graph::{ScopeGraph, ScopeIndex},
     *,
 };
@@ -41,6 +41,7 @@ use yuck::{
 pub enum DaemonCommand {
     NoOp,
     UpdateVars(Vec<(VarName, DynVal)>),
+    ForcePoll(Vec<VarName>),
     ReloadConfigAndCss(DaemonResponseSender),
     OpenInspector,
     OpenMany {
@@ -148,6 +149,15 @@ impl<B: DisplayBackend> App<B> {
                         self.update_global_variable(var_name, new_value);
                     }
                 }
+                DaemonCommand::ForcePoll(vars) => {
+                    for var in vars {
+                        if let ScriptVarDefinition::Poll(poll_var) = self.eww_config.get_script_var(&var)? {
+                            self.update_global_variable(var, run_poll_once(poll_var)?);
+                        } else {
+                            Err(anyhow!(format!("No poll var named '{}' exists", var)))?
+                        }
+                    }
+                }
                 DaemonCommand::ReloadConfigAndCss(sender) => {
                     let mut errors = Vec::new();
 

crates/eww/src/opts.rs

@@ -91,6 +91,10 @@ pub enum ActionWithServer {
         mappings: Vec<(VarName, DynVal)>,
     },
 
+    /// Manually tells  polling variables to update
+    #[clap(name = "force-poll", alias = "fp")]
+    ForcePoll { vars: Vec<VarName> },
+
     /// Open the GTK debugger
     #[command(name = "inspector", alias = "debugger")]
     OpenInspector,
@@ -210,6 +214,7 @@ impl ActionWithServer {
     pub fn into_daemon_command(self) -> (app::DaemonCommand, Option<daemon_response::DaemonResponseReceiver>) {
         let command = match self {
             ActionWithServer::Update { mappings } => app::DaemonCommand::UpdateVars(mappings),
+            ActionWithServer::ForcePoll { vars } => app::DaemonCommand::ForcePoll(vars),
             ActionWithServer::OpenInspector => app::DaemonCommand::OpenInspector,
 
             ActionWithServer::KillServer => app::DaemonCommand::KillServer,

crates/eww/src/script_var_handler.rs

@@ -192,7 +192,7 @@ impl PollVarHandler {
     }
 }
 
-fn run_poll_once(var: &PollScriptVar) -> Result<DynVal> {
+pub fn run_poll_once(var: &PollScriptVar) -> Result<DynVal> {
     match &var.command {
         VarSource::Shell(span, command) => {
             script_var::run_command(command).map_err(|e| anyhow!(create_script_var_failed_warn(*span, &var.name, &e.to_string())))

docs/src/configuration.md

@@ -191,6 +191,8 @@ They may also be useful to have buttons within eww change what is shown within y
 ```
 
 A polling variable is a variable which runs a provided shell-script repeatedly, in a given interval.
+You can also manually poll it by running `eww force-poll foo`.
+This is very useful for information like volume or brightness which change with a keypress but you may still want to update regularly.
 
 This may be the most commonly used type of variable.
 They are useful to access any quickly retrieved value repeatedly,