Make different parts of the output configurable by setting user functions

Factor out clocked-out title generation to get-task-title
Rename most functions to remove the double dashes
2025-03-31 17:33:35 +02:00 · 2025-03-31 17:33:35 +02:00 · 2025-03-31 17:33:34 +02:00 · 2025-02-27 12:03:42 +00:00 · 2025-02-27 11:53:10 +00:00 · 2023-01-31 08:47:36 +01:00
1 changed files with 16 additions and 8 deletions
--- a/org-clock-waybar.el
+++ b/org-clock-waybar.el
@@ -1,3 +1,4 @@
+;;; ...  -*- lexical-binding: t -*-
 ;;; org-clock-waybar.el --- Summary

 ;; Copyright (C) 2021 Gergely Polonkai
@@ -38,7 +39,7 @@

 ;;; Code:

-(require 'xdg)
+(require 'xdg nil t)
 (require 'json)
 (require 'org-clock)

@@ -47,7 +48,9 @@
  :group 'emacs)

 (defcustom org-clock-waybar-filename
+  (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)
@@ -135,12 +138,12 @@ When nil, the percentage text will be an empty string."
 (defun org-clock-waybar-get-tags ()
  "Get the tags of the currently clocked-in task."
  (when (org-clocking-p)
-    (save-window-excursion
-      (org-clock-goto)
-      (org-get-tags))))
+    (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.
+  "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
@@ -191,19 +194,24 @@ value of `org-clock-waybar-not-clocked-in-text'."
    (insert (org-clock-waybar--get-clocked-task-json))
    (write-file org-clock-waybar-filename)))

-(defun org-clock-waybar-ouptut-task ()
+(defun org-clock-waybar-output-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-save-task)
  (add-hook 'kill-emacs-hook #'org-clock-waybar-save-task))
Author	SHA1	Message	Date
Gergely Polonkai	3779adda25	Make different parts of the output configurable by setting user functions	2025-03-31 17:33:35 +02:00
Gergely Polonkai	3301967d3d	Factor out clocked-out title generation to get-task-title	2025-03-31 17:33:35 +02:00
Gergely Polonkai	82faddc8c3	Rename most functions to remove the double dashes This naming convention denotes “private” functions; however, if we want to introduce more customization, we should make these available and documented well.	2025-03-31 17:33:34 +02:00
Stuart Mumford	1c922fd4b4	Some more tweaks	2025-02-27 12:03:42 +00:00
Stuart Mumford	d5a776c761	fix typo	2025-02-27 11:53:10 +00:00
Gergely Polonkai	c327eb18c6	Make the xdg dependency optional We now default to using `~/.cache/waybar-current-task.json` if the `xdg` package is not present.	2023-01-31 08:47:36 +01:00
Gergely Polonkai	754fd9d2fa	Merge pull request '[Bugfix] Make sure we remove all text properties before outputting JSON data' (#8 ) from remove-text-properties into main Reviewed-on: #8	2021-10-16 10:24:06 +00:00
Gergely Polonkai	a144ee13c0	[Bugfix] Make sure we remove all text properties before outputting JSON data	2021-10-16 06:25:34 +02:00
Stuart Mumford	612c0d1e31	Do not use org-clock-goto to get tags	2021-03-29 10:20:01 +01:00
lh@hrdl.eu	3e71766f85	Add-hook org-clock-cancel-hook	2021-03-13 16:01:43 +01:00