polybar/include/modules/meta.hpp

#pragma once

#include <algorithm>
#include <condition_variable>
#include <fastdelegate/fastdelegate.hpp>
#include <mutex>

#include "common.hpp"
#include "components/builder.hpp"
#include "components/config.hpp"
#include "components/logger.hpp"
#include "utils/inotify.hpp"
#include "utils/string.hpp"
#include "utils/threading.hpp"

LEMONBUDDY_NS

#define DEFAULT_FORMAT "format"

#define DEFINE_MODULE(name, type) struct name : public type<name>
#define CONST_CAST_MODULE(name) static_cast<name const&>(*this)
#define CAST_MODULE(name) static_cast<name*>(this)

namespace modules {
  using namespace drawtypes;

  DEFINE_ERROR(module_error);
  DEFINE_CHILD_ERROR(undefined_format, module_error);
  DEFINE_CHILD_ERROR(undefined_format_tag, module_error);

  // class definition : module_format {{{

  struct module_format {
    string value;
    vector<string> tags;
    string fg;
    string bg;
    string ul;
    string ol;
    int spacing;
    int padding;
    int margin;
    int offset;

    string decorate(builder* builder, string output) {
      if (offset != 0)
        builder->offset(offset);
      if (margin > 0)
        builder->space(margin);
      if (!bg.empty())
        builder->background(bg);
      if (!fg.empty())
        builder->color(fg);
      if (!ul.empty())
        builder->underline(ul);
      if (!ol.empty())
        builder->overline(ol);
      if (padding > 0)
        builder->space(padding);

      builder->append(output);

      if (padding > 0)
        builder->space(padding);
      if (!ol.empty())
        builder->overline_close();
      if (!ul.empty())
        builder->underline_close();
      if (!fg.empty())
        builder->color_close();
      if (!bg.empty())
        builder->background_close();
      if (margin > 0)
        builder->space(margin);

      return builder->flush();
    }
  };

  // }}}
  // class definition : module_formatter {{{

  class module_formatter {
   public:
    explicit module_formatter(const config& conf, string modname)
        : m_conf(conf), m_modname(modname) {}

    void add(string name, string fallback, vector<string>&& tags, vector<string>&& whitelist = {}) {
      auto format = make_unique<module_format>();

      format->value = m_conf.get<string>(m_modname, name, fallback);
      format->fg = m_conf.get<string>(m_modname, name + "-foreground", "");
      format->bg = m_conf.get<string>(m_modname, name + "-background", "");
      format->ul = m_conf.get<string>(m_modname, name + "-underline", "");
      format->ol = m_conf.get<string>(m_modname, name + "-overline", "");
      format->spacing = m_conf.get<int>(m_modname, name + "-spacing", DEFAULT_SPACING);
      format->padding = m_conf.get<int>(m_modname, name + "-padding", 0);
      format->margin = m_conf.get<int>(m_modname, name + "-margin", 0);
      format->offset = m_conf.get<int>(m_modname, name + "-offset", 0);
      format->tags.swap(tags);

      for (auto&& tag : string_util::split(format->value, ' ')) {
        if (tag[0] != '<' || tag[tag.length() - 1] != '>')
          continue;
        if (std::find(format->tags.begin(), format->tags.end(), tag) != format->tags.end())
          continue;
        if (std::find(whitelist.begin(), whitelist.end(), tag) != whitelist.end())
          continue;
        throw undefined_format_tag("[" + m_modname + "] Undefined \"" + name + "\" tag: " + tag);
      }

      m_formats.insert(make_pair(name, std::move(format)));
    }

    shared_ptr<module_format> get(string format_name) {
      auto format = m_formats.find(format_name);
      if (format == m_formats.end())
        throw undefined_format("Format \"" + format_name + "\" has not been added");
      return format->second;
    }

    bool has(string tag, string format_name) {
      auto format = m_formats.find(format_name);
      if (format == m_formats.end())
        throw undefined_format(format_name.c_str());
      return format->second->value.find(tag) != string::npos;
    }

    bool has(string tag) {
      for (auto&& format : m_formats)
        if (format.second->value.find(tag) != string::npos)
          return true;
      return false;
    }

   protected:
    const config& m_conf;
    string m_modname;
    map<string, shared_ptr<module_format>> m_formats;
  };

  // }}}

  // class definition : module_interface {{{

  struct module_interface {
   public:
    virtual ~module_interface() {}

    virtual string name() const = 0;
    virtual bool running() const = 0;

    virtual void setup() = 0;
    virtual void start() = 0;
    virtual void stop() = 0;
    virtual void refresh() = 0;
    virtual string contents() = 0;

    virtual bool handle_event(string cmd) = 0;
    virtual bool receive_events() const = 0;

    delegate::Signal1<string> on_update;
    delegate::Signal1<string> on_stop;
  };

  // }}}
  // class definition : module {{{

  template <class Impl>
  class module : public module_interface {
   public:
    module(const bar_settings bar, const logger& logger, const config& config, string name)
        : m_bar(bar)
        , m_log(logger)
        , m_conf(config)
        , m_name("module/" + name)
        , m_builder(make_unique<builder>(bar))
        , m_formatter(make_unique<module_formatter>(m_conf, m_name)) {}

    ~module() {
      if (enabled())
        stop();

      std::lock_guard<threading_util::spin_lock> lck(this->update_lock);
      {
        if (m_broadcast_thread.joinable())
          m_broadcast_thread.join();

        for (auto&& thread_ : m_threads) {
          if (thread_.joinable())
            thread_.join();
        }
        m_threads.clear();
      }

      m_log.trace("%s: Done cleaning up", name());
    }

    string name() const {
      return m_name;
    }

    bool running() const {
      return enabled();
    }

    void setup() {
      m_log.trace("%s: Setup", name());
      CAST_MODULE(Impl)->setup();
    }

    void stop() {
      if (!enabled())
        return;
      m_log.trace("%s: Stop", name());
      enable(false);
      wakeup();
      if (!on_stop.empty())
        on_stop.emit(name());
    }

    void refresh() {
      m_cache = CAST_MODULE(Impl)->get_output();
    }

    string contents() {
      return m_cache;
    }

    bool handle_event(string cmd) {
      return CAST_MODULE(Impl)->handle_event(cmd);
    }

    bool receive_events() const {
      return false;
    }

   protected:
    bool enabled() const {
      return m_enabled;
    }

    void enable(bool state) {
      m_enabled = state;
    }

    void broadcast() {
      if (!enabled())
        return;

      refresh();

      if (contents().empty())
        return;
      else if (on_update.empty())
        m_log.warn("%s: No signal handlers connected... ignoring broadcast", name());
      else
        on_update.emit(name());
    }

    void idle() {}

    void sleep(chrono::duration<double> sleep_duration) {
      std::unique_lock<std::mutex> lck(m_sleeplock);
      m_sleephandler.wait_for(lck, sleep_duration);
    }

    void wakeup() {
      std::unique_lock<std::mutex> lck(m_sleeplock);
      m_log.trace("%s: Release sleep lock", name());
      m_sleephandler.notify_all();
    }

    string get_format() const {
      return DEFAULT_FORMAT;
    }

    string get_output() {
      if (!enabled()) {
        m_log.trace("%s: Module is disabled", name());
        return "";
      }

      auto format_name = CAST_MODULE(Impl)->get_format();
      auto format = m_formatter->get(format_name);

      int i = 0;
      bool tag_built = true;

      for (auto tag : string_util::split(format->value, ' ')) {
        bool is_blankspace = tag.empty();

        if (tag[0] == '<' && tag[tag.length() - 1] == '>') {
          if (i > 0)
            m_builder->space(format->spacing);
          if (!(tag_built = CAST_MODULE(Impl)->build(m_builder.get(), tag)) && i > 0)
            m_builder->remove_trailing_space(format->spacing);
          if (tag_built)
            i++;
        } else if (is_blankspace && tag_built) {
          m_builder->node(" ");
        } else if (!is_blankspace) {
          m_builder->node(tag);
        }
      }

      return format->decorate(m_builder.get(), m_builder->flush());
    }

   protected:
    // Called by modules after handling action events
    void event_handled() {
      std::lock_guard<threading_util::spin_lock> lck(this->update_lock);
      {
        if (m_broadcast_thread.joinable())
          m_broadcast_thread.join();
        m_broadcast_thread = thread(&module::broadcast, this);
      }
    }

    // concurrency::SpinLock output_lock;
    // concurrency::SpinLock broadcast_lock;
    threading_util::spin_lock update_lock;

    const bar_settings m_bar;
    const logger& m_log;
    const config& m_conf;

    std::mutex m_sleeplock;
    std::condition_variable m_sleephandler;

    string m_name;
    unique_ptr<builder> m_builder;
    unique_ptr<module_formatter> m_formatter;
    vector<thread> m_threads;

   private:
    stateflag m_enabled{false};
    string m_cache;
    thread m_broadcast_thread;
  };

  // }}}

  // class definition : static_module {{{

  template <class Impl>
  class static_module : public module<Impl> {
   public:
    using module<Impl>::module;

    void start() {
      CAST_MODULE(Impl)->setup();
      CAST_MODULE(Impl)->enable(true);
      CAST_MODULE(Impl)->broadcast();
    }

    bool build(builder*, string) {
      return true;
    }
  };

  // }}}
  // class definition : timer_module {{{

  using interval_t = chrono::duration<double>;

  template <class Impl>
  class timer_module : public module<Impl> {
   public:
    using module<Impl>::module;

    void start() {
      CAST_MODULE(Impl)->enable(true);
      CAST_MODULE(Impl)->m_threads.emplace_back(thread(&timer_module::runner, this));
    }

   protected:
    interval_t m_interval = 1s;

    void runner() {
      try {
        CAST_MODULE(Impl)->setup();

        while (CONST_CAST_MODULE(Impl).enabled()) {
          {
            std::lock_guard<threading_util::spin_lock> lck(this->update_lock);
            if (CAST_MODULE(Impl)->update())
              CAST_MODULE(Impl)->broadcast();
          }
          CAST_MODULE(Impl)->sleep(m_interval);
        }
      } catch (const application_error& err) {
        this->m_log.err("%s: %s", this->name(), err.what());
        this->m_log.warn("Stopping '%s'...", this->name());
        CAST_MODULE(Impl)->stop();
      }
    }
  };

  // }}}
  // class definition : event_module {{{

  template <class Impl>
  class event_module : public module<Impl> {
   public:
    using module<Impl>::module;

    void start() {
      CAST_MODULE(Impl)->enable(true);
      CAST_MODULE(Impl)->m_threads.emplace_back(thread(&event_module::runner, this));
    }

   protected:
    void runner() {
      try {
        CAST_MODULE(Impl)->setup();

        // warmup
        CAST_MODULE(Impl)->update();
        CAST_MODULE(Impl)->broadcast();

        while (CONST_CAST_MODULE(Impl).enabled()) {
          std::unique_lock<threading_util::spin_lock> lck(this->update_lock);

          if (!CAST_MODULE(Impl)->has_event())
            continue;

          if (!CAST_MODULE(Impl)->update())
            continue;

          CAST_MODULE(Impl)->broadcast();

          lck.unlock();
          CAST_MODULE(Impl)->idle();
        }
      } catch (const application_error& err) {
        this->m_log.err("%s: %s", this->name(), err.what());
        this->m_log.warn("Stopping '%s'...", this->name());
        CAST_MODULE(Impl)->stop();
      }
    }
  };

  // }}}
  // class definition : inotify_module {{{

  template <class Impl>
  class inotify_module : public module<Impl> {
   public:
    using module<Impl>::module;

    void start() {
      CAST_MODULE(Impl)->enable(true);
      CAST_MODULE(Impl)->m_threads.emplace_back(thread(&inotify_module::runner, this));
    }

   protected:
    void runner() {
      try {
        CAST_MODULE(Impl)->setup();
        CAST_MODULE(Impl)->on_event(nullptr);  // warmup
        CAST_MODULE(Impl)->broadcast();

        while (CAST_MODULE(Impl)->enabled()) {
          std::lock_guard<threading_util::spin_lock> lck(this->update_lock);
          CAST_MODULE(Impl)->poll_events();
        }
      } catch (const application_error& err) {
        this->m_log.err("%s: %s", this->name(), err.what());
        this->m_log.warn("Stopping '%s'...", this->name());
        CAST_MODULE(Impl)->stop();
      }
    }

    void watch(string path, int mask = IN_ALL_EVENTS) {
      this->m_log.trace("%s: Attach inotify at %s", this->name(), path);
      m_watchlist.insert(make_pair(path, mask));
    }

    void idle() {
      CAST_MODULE(Impl)->sleep(200ms);
    }

    void poll_events() {
      vector<unique_ptr<inotify_watch>> watches;

      try {
        for (auto&& w : m_watchlist) {
          watches.emplace_back(inotify_util::make_watch(w.first));
          watches.back()->attach(w.second);
        }
      } catch (const system_error& e) {
        watches.clear();
        this->m_log.err(
            "%s: Error while creating inotify watch (what: %s)", this->name(), e.what());
        CAST_MODULE(Impl)->sleep(0.1s);
        return;
      }

      while (CONST_CAST_MODULE(Impl).enabled()) {
        for (auto&& w : watches) {
          this->m_log.trace("%s: Poll inotify watch %s", this->name(), w->path());

          if (w->poll(1000 / watches.size())) {
            auto event = w->get_event();

            w->remove();

            if (CAST_MODULE(Impl)->on_event(event.get()))
              CAST_MODULE(Impl)->broadcast();

            return;
          }
        }
        CAST_MODULE(Impl)->idle();
      }
    }

   private:
    map<string, int> m_watchlist;
  };

  // }}}
}

LEMONBUDDY_NS_END