Add instructions for configuring for the Eww bar

Why would we use markdown in the Emacs world, right?

README.md

@@ -1,83 +0,0 @@
-# org-clock-waybar – Export the currently clocked-in task to be displayed on Waybar
-
-## Installation
-
-Put `org-clock-waybar.el` somewhere in your `load-path`, and `(require 'org-clock-waybar)`.
-
-MELPA version may come soon.
-
-You can set the file to be written by customizing `org-clock-waybar-filename`; it defaults to
-`$XDG_CACHE_HOME/waybar-current-task.json` (`$XDG_CACHE_HOME` defaults to `$HOME/.cache` on XDG
-compatible systems, like Linux.)
-
-## Waybar configuration
-
-To add the current task to Waybar, add this snippet to your config:
-
-```json
-"custom/org": {
-  "format": " {}",
-  "return-type": "json",
-  "restart-interval": 5,
-  "exec": "cat /home/yourusername/.cache/waybar-current-task.json"
-}
-```
-
-Then, add `custom/org` to `modules-left`/`modules-center`/`module-right` if your bar’s
-configuration.  You can find a minimal working configuration in the [`examples`](./examples)
-directory.
-
-### Additional Configuration
-
-You can also display an icon specific to the clocked tasks category with the `format-icons` key:
-
-```json
-"custom/org": {
-    "format": "{icon} {}",
-    "return-type": "json",
-    "restart-interval": 1,
-    "format-icons": {
-      "refile": "",
-      "ToDo": "",
-    },
-  "exec": "cat /home/yourusername/.cache/waybar-current-task.json"
-}
-```
-
-If you use Emacs as a daemon (e.g. starting it as `emacs --daemon` or calling `(server-start)`),
-you can change the `exec` command to invoke `emacsclient` directly.  Note that, since Emacsclient
-can’t actually write stuff to the terminal, it will output an Emacs string full of backslashes
-(see [this Emacs SE answer for details](https://emacs.stackexchange.com/a/28668/507)); thus, you
-have to pipe the output through `jq fromjson`.
-
-If you run emacs in this mode you can also eval commands on click, middle click or scroll.:
-
-```json
-"custom/org": {
-    "format": "{icon} {}",
-    "return-type": "json",
-    "restart-interval": 1,
-    "format-icons": {
-      "refile": "",
-      "ToDo": "",
-    },
-    "exec": "emacsclient --eval '(org-clock-waybar-ouptut-task)' | jq fromjson --unbuffered --compact-output",
-    "on-click": "emacsclient --eval '(org-clock-out)'",
-    "on-middle-click": "emacsclient --eval '(org-clock-in-last)'",
-},
-
-```
-
-If you want the taskbar to show nothing or some other content if the emacs server is not running then you need to write a short bash script to catch when the emacsclient command returns a non-zero exit code. An example of this is:
-
-```bash
-#!/bin/bash
-
-json=$(emacsclient --eval '(org-clock-waybar-ouptut-task)' 2> /dev/null)
-status=$?
-[ $status -eq 0 ] && echo $(echo $json | jq fromjson --unbuffered --compact-output) || echo ""
-```
-
-## Customization
-
-To see a list of configurable parts, use `M-x customize-group <RET> org-clock-waybar`.

README.org

@@ -0,0 +1,119 @@
+#+TITLE: org-clock-waybar – Export the currently clocked-in task to be displayed on Waybar
+
+* Installation
+
+Put ~org-clock-waybar.el~ somewhere in your ~load-path~, and ~(require 'org-clock-waybar)~.
+
+MELPA version may come soon.
+
+** Quelpa
+
+If you only have [[https://github.com/quelpa/quelpa][quelpa]] installed:
+
+#+begin_src emacs-lisp
+(quelpa
+ '(org-clock-waybar
+   :fetcher git
+   :url "https://gitea.polonkai.eu/gergely/org-clock-waybar.git"))
+#+end_src
+
+or, if you have [[https://github.com/quelpa/quelpa-use-package][quelpa-use-package] installed,
+too:
+
+#+begin_src emacs-lisp
+(quelpa-use-package org-clock-waybar
+  :quelpa (org-clock-waybar
+           :fetcher git
+           :url "https://gitea.polonkai.eu/gergely/org-clock-waybar.git"))
+#+end_src
+
+* Customization
+
+To see a list of configurable parts, use ~M-x customize-group <RET> org-clock-waybar~.
+
+You can set the file to be written by customizing ~org-clock-waybar-filename~; it
+defaults to ~$XDG_CACHE_HOME/waybar-current-task.json~ (~$XDG_CACHE_HOME~ defaults
+to ~$HOME/.cache~ on XDG compatible systems, like Linux.)
+
+* Waybar configuration
+
+To add the current task to Waybar, add this snippet to your config:
+
+#+begin_src json
+"custom/org": {
+  "format": " {}",
+  "return-type": "json",
+  "restart-interval": 5,
+  "exec": "cat /home/yourusername/.cache/waybar-current-task.json"
+}
+#+end_src
+
+Then, add ~custom/org~ to your ~modules-left~, ~modules-center~, or ~module-right~
+section in your bar’s configuration.  You can find a minimal working
+configuration in the [[./examples][examples]] directory.
+
+** Additional Configuration
+
+You can also display an icon specific to the clocked tasks category with the ~format-icons~ key:
+
+#+begin_src json
+"custom/org": {
+    "format": "{icon} {}",
+    "return-type": "json",
+    "restart-interval": 1,
+    "format-icons": {
+      "refile": "",
+      "ToDo": "",
+    },
+  "exec": "cat /home/yourusername/.cache/waybar-current-task.json"
+}
+#+end_src
+
+If you use Emacs as a daemon (e.g. starting it as ~emacs --daemon~ or calling
+~(server-start)~), you can change the ~exec~ command to invoke ~emacsclient~ directly.
+Note that, since Emacsclient can’t actually write stuff to the terminal, it will
+output an Emacs string full of backslashes (see [[https://emacs.stackexchange.com/a/28668/507][this Emacs SE answer for
+details]]); thus, you have to pipe the output through ~jq fromjson~.
+
+If you run emacs in this mode you can also eval commands on click, middle click or scroll.:
+
+#+begin_src json
+"custom/org": {
+    "format": "{icon} {}",
+    "return-type": "json",
+    "restart-interval": 1,
+    "format-icons": {
+      "refile": "",
+      "ToDo": "",
+    },
+    "exec": "emacsclient --eval '(org-clock-waybar-ouptut-task)' | jq fromjson --unbuffered --compact-output",
+    "on-click": "emacsclient --eval '(org-clock-out)'",
+    "on-middle-click": "emacsclient --eval '(org-clock-in-last)'",
+},
+#+end_src
+
+If you want the taskbar to show nothing or some other content if the emacs server is not running then you need to write a short bash script to catch when the emacsclient command returns a non-zero exit code. An example of this is:
+
+#+begin_src bash
+#!/bin/bash
+
+json=$(emacsclient --eval '(org-clock-waybar-ouptut-task)' 2> /dev/null)
+status=$?
+[ $status -eq 0 ] && echo $(echo $json | jq fromjson --unbuffered --compact-output) || echo ""
+#+end_src
+
+* Eww bar configuration
+
+Waybar is still popular, but it also seems [[https://elkowar.github.io/eww/][Eww]] is also gaining popularity.
+
+#+begin_src yuck
+(defpoll current-org-task :interval "1s" :initial "{}" "cat /home/yourusername/.cache/waybar-current-task.json")
+
+(defwidget current-org-task-widget []
+  {current-org-task.text})
+
+(defwidget bar []
+  (box
+   :orientation "h"
+   (current-org-task-widget)))
+#+end_src

org-clock-waybar.el

@@ -1,4 +1,4 @@
-;;; org-clock-waybar --- Summary
+;;; org-clock-waybar.el --- Summary
 
 ;; Copyright (C) 2021 Gergely Polonkai
 
@@ -38,7 +38,7 @@
 
 ;;; Code:
 
-(require 'xdg)
+(require 'xdg nil t)
 (require 'json)
 (require 'org-clock)
 
@@ -47,7 +47,9 @@
   :group 'emacs)
 
 (defcustom org-clock-waybar-filename
-  (expand-file-name "waybar-current-task.json" (xdg-cache-home))
+  (if (fboundp 'xdg-cache-home)
+      (expand-file-name "waybar-current-task.json" (xdg-cache-home))
+    (expand-file-name "~/.cache/waybar-current-task.json"))
   "Name of the file to save task data to."
   :type 'string
   :group 'org-clock-waybar)
@@ -64,72 +66,79 @@
     'emacs-mule)
   "Coding system of the file `org-clock-waybar-filename'.")
 
-(defun org-clock-waybar-tooltip ()
+(defsubst org-clock-waybar--get-task-title ()
+  "Get the title of TASK."
+  (when (org-clocking-p) (substring-no-properties org-clock-current-task)))
+
+(defsubst org-clock-waybar--get-task-category ()
+  "Get the category of TASK."
+  (when (org-clocking-p) (get-text-property 0 'org-category org-clock-current-task)))
+
+(defun org-clock-waybar--get-tooltip ()
   "The default tooltip to send to waybar."
-  (when org-clock-current-task
+  (when (org-clocking-p)
     (let ((clocked-time (org-clock-get-clocked-time)))
       (format "%s: %s (%s)"
-              (org-clock-waybar-alt)
+              (org-clock-waybar--get-task-category)
-              (org-clock-waybar-text)
+              (org-clock-waybar--get-task-title)
               (org-duration-from-minutes clocked-time)))))
 
-(defun org-clock-waybar--get-clocked-task-json (&optional clocking-out)
+(defun org-clock-waybar--get-tags ()
+  "Get the tags of the currently clocked-in task."
+  (when (org-clocking-p)
+    (or (org-with-point-at org-clock-marker (org-get-tags))
+        "")
+    ))
+
+(defun org-clock-waybar--get-clocked-task-json ()
   "Get the currently clocked-in task’s data as a stringified JSON object.
 
 The output is in JSON format constructed in a way so Waybar can process it.
 If there is no clocked in task, alt becomes empty and text will be set to the
-value of `org-clock-waybar-not-clocked-in-text'.
+value of `org-clock-waybar-not-clocked-in-text'."
-
+  (let* ((category (org-clock-waybar--get-task-category))
-If CLOCKING-OUT is non-nil, `org-clock-current-task' will be treated as if it
+         (title (org-clock-waybar--get-task-title))
-were nil; this is required because `org-clock-out' calls the hook functions
+         (tooltip (org-clock-waybar--get-tooltip))
-before setting `org-clock-current-task' to nil."
-  (let* ((task (if clocking-out nil org-clock-current-task))
-         (category (when task (get-text-property 0 'org-category task)))
-         (title (when task (substring-no-properties task)))
-         (tooltip (org-clock-waybar-tooltip))
          (output (json-new-object)))
     (setq output (json-add-to-object
                   output
                   "text"
-                  (if title
+                  (or title org-clock-waybar-not-clocked-in-text)))
-                      title
+    (setq output (json-add-to-object output "alt" (or category "")))
-                    org-clock-waybar-not-clocked-in-text)))
+    (setq output (json-add-to-object output "tooltip" (or tooltip "")))
-    (setq output (json-add-to-object output "alt" (if category category "")))
+    (setq output (json-add-to-object output "class" (or (org-clock-waybar--get-tags) "")))
-    (setq output (json-add-to-object output "tooltip" (if tooltip tooltip "")))
-    (setq output (json-add-to-object output "class" ""))
     (setq output (json-add-to-object output "percentage" ""))
     (json-encode output)))
 
-(defun org-clock-waybar-save-task (&optional clocking-out)
+(defun org-clock-waybar-save-task ()
-  "Save the current clocked in task to `org-clock-waybar-filename'.
+  "Save the current clocked in task to `org-clock-waybar-filename'."
-
-If CLOCKING-OUT is non-nil, treat the current task as if it were nil."
   (with-temp-buffer
     (erase-buffer)
     (set-buffer-file-coding-system org-clock-waybar-filename-coding-system)
-    (insert (org-clock-waybar--get-clocked-task-json clocking-out))
+    (insert (org-clock-waybar--get-clocked-task-json))
     (write-file org-clock-waybar-filename)))
 
-(defun org-clock-waybar-clear-task ()
-  "Clear the current task from `org-clock-waybar-filename'."
-  (org-clock-waybar-save-task t))
-
 (defun org-clock-waybar-ouptut-task ()
   "Output the current task in JSON format Waybar can understand.
 
 This function is ought to be used via Emacsclient:
 
 emacsclient --eval '(org-clock-waybar-output-task)'"
-  (org-clock-waybar--get-clocked-task-json))
+  (let* ((output (org-clock-waybar--get-clocked-task-json))
+         (start 0)
+         (end (length output)))
+    (set-text-properties start end nil output)
+    output))
 
 (defun org-clock-waybar-setup ()
   "Setup org-clock-waybar.
 
 It adds `org-clock-waybar-save-task' to both `org-clock-in-hook' and
 `org-clock-out-hook'."
+  (add-hook 'org-clock-cancel-hook #'org-clock-waybar-save-task)
   (add-hook 'org-clock-in-hook #'org-clock-waybar-save-task)
-  (add-hook 'org-clock-out-hook #'org-clock-waybar-task)
+  (add-hook 'org-clock-out-hook #'org-clock-waybar-save-task)
-  (add-hook 'kill-emacs-hook #'org-clock-waybar-clear-task))
+  (add-hook 'kill-emacs-hook #'org-clock-waybar-save-task))
 
 (provide 'org-clock-waybar)
 ;;; org-clock-waybar.el ends here