From f4e8051e9e3e6705336e9c5ee2de24aa6242ab85 Mon Sep 17 00:00:00 2001
From: Michael Carlberg <c@rlberg.se>
Date: Tue, 10 Jan 2017 05:12:53 +0100
Subject: [PATCH] refactor(script): Merge back script handling

---
 include/modules/cmdscript.hpp    |  18 ----
 include/modules/meta/base.hpp    |   2 +-
 include/modules/meta/factory.hpp |   8 +-
 include/modules/script.hpp       |  19 ++--
 include/modules/tailscript.hpp   |  18 ----
 include/modules/unsupported.hpp  |   4 +-
 src/modules/cmdscript.cpp        |  35 -------
 src/modules/script.cpp           | 172 ++++++++++++++++++++++---------
 src/modules/tailscript.cpp       |  44 --------
 9 files changed, 132 insertions(+), 188 deletions(-)
 delete mode 100644 include/modules/cmdscript.hpp
 delete mode 100644 include/modules/tailscript.hpp
 delete mode 100644 src/modules/cmdscript.cpp
 delete mode 100644 src/modules/tailscript.cpp

diff --git a/include/modules/cmdscript.hpp b/include/modules/cmdscript.hpp
deleted file mode 100644
index 3b2d2a5d..00000000
--- a/include/modules/cmdscript.hpp
+++ /dev/null
@@ -1,18 +0,0 @@
-#pragma once
-
-#include "modules/script.hpp"
-
-POLYBAR_NS
-
-namespace modules {
-  class cmdscript_module : virtual public script_module {
-   public:
-    explicit cmdscript_module(const bar_settings&, string);
-
-   protected:
-    void process();
-    chrono::duration<double> sleep_duration();
-  };
-}
-
-POLYBAR_NS_END
diff --git a/include/modules/meta/base.hpp b/include/modules/meta/base.hpp
index 0aa82690..182e59b7 100644
--- a/include/modules/meta/base.hpp
+++ b/include/modules/meta/base.hpp
@@ -130,7 +130,7 @@ namespace modules {
    protected:
     void broadcast();
     void idle();
-    void sleep(chrono::duration<double> sleep_duration);
+    void sleep(chrono::duration<double> duration);
     void wakeup();
     string get_format() const;
     string get_output();
diff --git a/include/modules/meta/factory.hpp b/include/modules/meta/factory.hpp
index d412b9fe..8535ba4c 100644
--- a/include/modules/meta/factory.hpp
+++ b/include/modules/meta/factory.hpp
@@ -5,7 +5,6 @@
 #include "modules/backlight.hpp"
 #include "modules/battery.hpp"
 #include "modules/bspwm.hpp"
-#include "modules/cmdscript.hpp"
 #include "modules/counter.hpp"
 #include "modules/cpu.hpp"
 #include "modules/date.hpp"
@@ -18,7 +17,6 @@
 #if DEBUG
 #include "modules/systray.hpp"
 #endif
-#include "modules/tailscript.hpp"
 #include "modules/temperature.hpp"
 #include "modules/text.hpp"
 #include "modules/xbacklight.hpp"
@@ -95,11 +93,7 @@ namespace {
     } else if (name == "custom/text") {
       return new text_module(bar, move(module_name));
     } else if (name == "custom/script") {
-      if (config::make().get<bool>("module/" + module_name, "tail", false)) {
-        return new tailscript_module(bar, move(module_name));
-      } else {
-        return new cmdscript_module(bar, move(module_name));
-      }
+      return new script_module(bar, move(module_name));
     } else if (name == "custom/menu") {
       return new menu_module(bar, move(module_name));
     } else if (name == "custom/ipc") {
diff --git a/include/modules/script.hpp b/include/modules/script.hpp
index ccfea03e..c1ec50bc 100644
--- a/include/modules/script.hpp
+++ b/include/modules/script.hpp
@@ -10,21 +10,23 @@ namespace modules {
   class script_module : public module<script_module> {
    public:
     explicit script_module(const bar_settings&, string);
-    virtual ~script_module() {}
+    ~script_module() {}
 
-    virtual void start();
-    virtual void stop();
+    void start();
+    void stop();
 
     string get_output();
     bool build(builder* builder, const string& tag) const;
 
    protected:
-    virtual void process() = 0;
-    virtual chrono::duration<double> sleep_duration() = 0;
+    chrono::duration<double> process(const mutex_wrapper<function<chrono::duration<double>()>>& handler) const;
+    bool check_condition();
 
-    static constexpr const char* TAG_OUTPUT{"<output>"};
+   private:
     static constexpr const char* TAG_LABEL{"<label>"};
 
+    mutex_wrapper<function<chrono::duration<double>()>> m_handler;
+
     unique_ptr<command> m_command;
 
     string m_exec;
@@ -38,11 +40,6 @@ namespace modules {
     string m_prev;
     int m_counter{0};
 
-    // @deprecated
-    size_t m_maxlen{0};
-    // @deprecated
-    bool m_ellipsis{true};
-
     bool m_stopping{false};
   };
 }
diff --git a/include/modules/tailscript.hpp b/include/modules/tailscript.hpp
deleted file mode 100644
index 53e251c3..00000000
--- a/include/modules/tailscript.hpp
+++ /dev/null
@@ -1,18 +0,0 @@
-#pragma once
-
-#include "modules/script.hpp"
-
-POLYBAR_NS
-
-namespace modules {
-  class tailscript_module : virtual public script_module {
-   public:
-    explicit tailscript_module(const bar_settings&, string);
-
-   protected:
-    void process();
-    chrono::duration<double> sleep_duration();
-  };
-}
-
-POLYBAR_NS_END
diff --git a/include/modules/unsupported.hpp b/include/modules/unsupported.hpp
index 0325107b..caec4c90 100644
--- a/include/modules/unsupported.hpp
+++ b/include/modules/unsupported.hpp
@@ -14,7 +14,7 @@ namespace modules {
 #define DEFINE_UNSUPPORTED_MODULE(MODULE_NAME, MODULE_TYPE)                             \
   class MODULE_NAME : public module_interface {                                         \
    public:                                                                              \
-    MODULE_NAME(const bar_settings, string) {             \
+    MODULE_NAME(const bar_settings, string) {                                           \
       throw application_error("No built-in support for '" + string{MODULE_TYPE} + "'"); \
     }                                                                                   \
     string name() const {                                                               \
@@ -29,8 +29,6 @@ namespace modules {
     string contents() {                                                                 \
       return "";                                                                        \
     }                                                                                   \
-    void set_update_cb(callback<>&&) {}                                                 \
-    void set_stop_cb(callback<>&&) {}                                                   \
   }
 
 #if not ENABLE_I3
diff --git a/src/modules/cmdscript.cpp b/src/modules/cmdscript.cpp
deleted file mode 100644
index c81a7e69..00000000
--- a/src/modules/cmdscript.cpp
+++ /dev/null
@@ -1,35 +0,0 @@
-#include "modules/cmdscript.hpp"
-#include "drawtypes/label.hpp"
-
-#include "modules/meta/base.inl"
-
-POLYBAR_NS
-
-namespace modules {
-  cmdscript_module::cmdscript_module(const bar_settings& bar, string name_) : script_module(bar, move(name_)) {
-    m_interval = m_conf.get<decltype(m_interval)>(name(), "interval", 5s);
-  }
-
-  void cmdscript_module::process() {
-    try {
-      auto exec = string_util::replace_all(m_exec, "%counter%", to_string(++m_counter));
-      m_log.info("%s: Invoking shell command: \"%s\"", name(), exec);
-      m_command = command_util::make_command(exec);
-      m_command->exec(true);
-    } catch (const exception& err) {
-      m_log.err("%s: %s", name(), err.what());
-      throw module_error("Failed to execute command, stopping module...");
-    }
-
-    if ((m_output = m_command->readline()) != m_prev) {
-      broadcast();
-      m_prev = m_output;
-    }
-  }
-
-  chrono::duration<double> cmdscript_module::sleep_duration() {
-    return std::max(m_command->get_exit_status() == 0 ? m_interval : 1s, m_interval);
-  }
-}
-
-POLYBAR_NS_END
diff --git a/src/modules/script.cpp b/src/modules/script.cpp
index ad70a4cc..6c641904 100644
--- a/src/modules/script.cpp
+++ b/src/modules/script.cpp
@@ -8,53 +8,100 @@ POLYBAR_NS
 namespace modules {
   template class module<script_module>;
 
-  script_module::script_module(const bar_settings& bar, string name_) : module<script_module>(bar, move(name_)) {
+  /**
+   * Construct script module by loading configuration values
+   * and setting up formatting objects
+   */
+  script_module::script_module(const bar_settings& bar, string name_)
+      : module<script_module>(bar, move(name_)), m_handler([&]() -> function<chrono::duration<double>()> {
+        // Handler for continuous tail commands {{{
+
+        if (m_conf.get(name(), "tail", false)) {
+          return [&] {
+            if (!m_command || !m_command->is_running()) {
+              string exec{string_util::replace_all(m_exec, "%counter%", to_string(++m_counter))};
+              m_log.info("%s: Invoking shell command: \"%s\"", name(), exec);
+              m_command = command_util::make_command(exec);
+
+              try {
+                m_command->exec(false);
+              } catch (const exception& err) {
+                m_log.err("%s: %s", name(), err.what());
+                throw module_error("Failed to execute command, stopping module...");
+              }
+            }
+
+            if (io_util::poll(m_command->get_stdout(PIPE_READ), POLLIN, 0)) {
+              if ((m_output = m_command->readline()) != m_prev) {
+                m_prev = m_output;
+                broadcast();
+              }
+            }
+
+            if (m_command && !m_command->is_running()) {
+              return std::max(m_command->get_exit_status() == 0 ? m_interval : 1s, m_interval);
+            } else {
+              return m_interval;
+            }
+          };
+        }
+
+        // }}}
+        // Handler for basic shell commands {{{
+
+        return [&] {
+          try {
+            auto exec = string_util::replace_all(m_exec, "%counter%", to_string(++m_counter));
+            m_log.info("%s: Invoking shell command: \"%s\"", name(), exec);
+            m_command = command_util::make_command(exec);
+            m_command->exec(true);
+          } catch (const exception& err) {
+            m_log.err("%s: %s", name(), err.what());
+            throw module_error("Failed to execute command, stopping module...");
+          }
+
+          if ((m_output = m_command->readline()) != m_prev) {
+            broadcast();
+            m_prev = m_output;
+          }
+
+          return std::max(m_command->get_exit_status() == 0 ? m_interval : 1s, m_interval);
+        };
+
+        // }}}
+      }()) {
+    // Load configuration values
     m_exec = m_conf.get(name(), "exec", m_exec);
     m_exec_if = m_conf.get(name(), "exec-if", m_exec_if);
-    m_maxlen = m_conf.get(name(), "maxlen", m_maxlen);
-    m_ellipsis = m_conf.get(name(), "ellipsis", m_ellipsis);
     m_interval = m_conf.get<decltype(m_interval)>(name(), "interval", 5s);
 
-    m_conf.warn_deprecated(
-        name(), "maxlen", "\"format = <label>\" and \"label = %output:0:" + to_string(m_maxlen) + "%\"");
-
+    // Load configured click handlers
     m_actions[mousebtn::LEFT] = m_conf.get(name(), "click-left", ""s);
     m_actions[mousebtn::MIDDLE] = m_conf.get(name(), "click-middle", ""s);
     m_actions[mousebtn::RIGHT] = m_conf.get(name(), "click-right", ""s);
     m_actions[mousebtn::SCROLL_UP] = m_conf.get(name(), "scroll-up", ""s);
     m_actions[mousebtn::SCROLL_DOWN] = m_conf.get(name(), "scroll-down", ""s);
 
-    m_formatter->add(DEFAULT_FORMAT, TAG_LABEL, {TAG_OUTPUT, TAG_LABEL});
-
+    // Setup formatting
+    m_formatter->add(DEFAULT_FORMAT, TAG_LABEL, {TAG_LABEL});
     if (m_formatter->has(TAG_LABEL)) {
       m_label = load_optional_label(m_conf, name(), "label", "%output%");
-    } else if (m_formatter->has(TAG_OUTPUT)) {
-      m_log.warn("%s: The format tag <output> is deprecated, use <label> instead", name());
     }
   }
 
+  /**
+   * Start the module worker
+   */
   void script_module::start() {
-    m_mainthread = thread([this] {
+    m_mainthread = thread([&] {
       try {
         while (running() && !m_stopping) {
-          std::unique_lock<mutex> guard(m_updatelock);
-
-          // Execute the condition command if specified
-          if (!m_exec_if.empty() && command_util::make_command(m_exec_if)->exec(true) != 0) {
-            if (!m_output.empty()) {
-              broadcast();
-              m_output.clear();
-              m_prev.clear();
-            }
-
-            if (m_interval >= 1s) {
-              sleep(m_interval);
-            } else {
-              sleep(1s);
-            }
+          if (check_condition()) {
+            sleep(process(m_handler));
+          } else if (m_interval > 1s) {
+            sleep(m_interval);
           } else {
-            this->process();
-            this->sleep(this->sleep_duration());
+            sleep(1s);
           }
         }
       } catch (const exception& err) {
@@ -63,22 +110,50 @@ namespace modules {
     });
   }
 
+  /**
+   * Stop the module worker by terminating any running commands
+   */
   void script_module::stop() {
-    std::lock_guard<mutex> guard(m_updatelock, std::adopt_lock);
-
+    std::lock_guard<decltype(m_handler)> guard(m_handler);
     m_stopping = true;
-    this->wakeup();
+    wakeup();
 
-    if (m_command) {
-      if (m_command->is_running()) {
-        m_log.warn("%s: Stopping shell command", name());
-      }
+    if (m_command && m_command->is_running()) {
+      m_log.warn("%s: Stopping shell command", name());
       m_command->terminate();
     }
 
-    this->module::stop();
+    m_command.reset();
+    module::stop();
   }
 
+  /**
+   * Check if defined condition is met
+   */
+  bool script_module::check_condition() {
+    if (m_exec_if.empty()) {
+      return true;
+    } else if (command_util::make_command(m_exec_if)->exec(true) == 0) {
+      return true;
+    } else if (!m_output.empty()) {
+      broadcast();
+      m_output.clear();
+      m_prev.clear();
+    }
+    return false;
+  }
+
+  /**
+   * Process mutex wrapped script handler
+   */
+  chrono::duration<double> script_module::process(const decltype(m_handler) & handler) const {
+    std::lock_guard<decltype(handler)> guard(handler);
+    return handler();
+  }
+
+  /**
+   * Generate module output
+   */
   string script_module::get_output() {
     if (m_output.empty()) {
       return "";
@@ -89,30 +164,24 @@ namespace modules {
       m_label->replace_token("%output%", m_output);
     }
 
-    if (m_maxlen > 0 && m_output.length() > m_maxlen) {
-      m_output.erase(m_maxlen);
-      m_output += m_ellipsis ? "..." : "";
-    }
-
-    auto counter_str = to_string(m_counter);
+    string cnt{to_string(m_counter)};
     string output{module::get_output()};
 
     if (!m_actions[mousebtn::LEFT].empty()) {
-      m_builder->cmd(mousebtn::LEFT, string_util::replace_all(m_actions[mousebtn::LEFT], "%counter%", counter_str));
+      m_builder->cmd(mousebtn::LEFT, string_util::replace_all(m_actions[mousebtn::LEFT], "%counter%", cnt));
     }
     if (!m_actions[mousebtn::MIDDLE].empty()) {
-      m_builder->cmd(mousebtn::MIDDLE, string_util::replace_all(m_actions[mousebtn::MIDDLE], "%counter%", counter_str));
+      m_builder->cmd(mousebtn::MIDDLE, string_util::replace_all(m_actions[mousebtn::MIDDLE], "%counter%", cnt));
     }
     if (!m_actions[mousebtn::RIGHT].empty()) {
-      m_builder->cmd(mousebtn::RIGHT, string_util::replace_all(m_actions[mousebtn::RIGHT], "%counter%", counter_str));
+      m_builder->cmd(mousebtn::RIGHT, string_util::replace_all(m_actions[mousebtn::RIGHT], "%counter%", cnt));
     }
     if (!m_actions[mousebtn::SCROLL_UP].empty()) {
-      m_builder->cmd(
-          mousebtn::SCROLL_UP, string_util::replace_all(m_actions[mousebtn::SCROLL_UP], "%counter%", counter_str));
+      m_builder->cmd(mousebtn::SCROLL_UP, string_util::replace_all(m_actions[mousebtn::SCROLL_UP], "%counter%", cnt));
     }
     if (!m_actions[mousebtn::SCROLL_DOWN].empty()) {
       m_builder->cmd(
-          mousebtn::SCROLL_DOWN, string_util::replace_all(m_actions[mousebtn::SCROLL_DOWN], "%counter%", counter_str));
+          mousebtn::SCROLL_DOWN, string_util::replace_all(m_actions[mousebtn::SCROLL_DOWN], "%counter%", cnt));
     }
 
     m_builder->append(output);
@@ -120,10 +189,11 @@ namespace modules {
     return m_builder->flush();
   }
 
+  /**
+   * Output format tags
+   */
   bool script_module::build(builder* builder, const string& tag) const {
-    if (tag == TAG_OUTPUT) {
-      builder->node(m_output);
-    } else if (tag == TAG_LABEL) {
+    if (tag == TAG_LABEL) {
       builder->node(m_label);
     } else {
       return false;
diff --git a/src/modules/tailscript.cpp b/src/modules/tailscript.cpp
deleted file mode 100644
index 5a1c795b..00000000
--- a/src/modules/tailscript.cpp
+++ /dev/null
@@ -1,44 +0,0 @@
-#include "modules/tailscript.hpp"
-#include "drawtypes/label.hpp"
-
-#include "modules/meta/base.inl"
-
-POLYBAR_NS
-
-namespace modules {
-  tailscript_module::tailscript_module(const bar_settings& bar, string name_) : script_module(bar, move(name_)) {
-    m_interval = m_conf.get<decltype(m_interval)>(name(), "interval", 0s);
-  }
-
-  void tailscript_module::process() {
-    if (!m_command || !m_command->is_running()) {
-      string exec{string_util::replace_all(m_exec, "%counter%", to_string(++m_counter))};
-      m_log.info("%s: Invoking shell command: \"%s\"", name(), exec);
-      m_command = command_util::make_command(exec);
-
-      try {
-        m_command->exec(false);
-      } catch (const exception& err) {
-        m_log.err("%s: %s", name(), err.what());
-        throw module_error("Failed to execute command, stopping module...");
-      }
-    }
-
-    if (io_util::poll(m_command->get_stdout(PIPE_READ), POLLIN, 0)) {
-      if ((m_output = m_command->readline()) != m_prev) {
-        m_prev = m_output;
-        broadcast();
-      }
-    }
-  }
-
-  chrono::duration<double> tailscript_module::sleep_duration() {
-    if (m_command && !m_command->is_running()) {
-      return std::max(m_command->get_exit_status() == 0 ? m_interval : 1s, m_interval);
-    } else {
-      return m_interval;
-    }
-  }
-}
-
-POLYBAR_NS_END