forked from gergely/org-clock-waybar
Compare commits
15 Commits
bc61218f92
...
header-fix
Author | SHA1 | Date | |
---|---|---|---|
c22231dfa1 | |||
1c922fd4b4 | |||
d5a776c761 | |||
c327eb18c6 | |||
754fd9d2fa | |||
a144ee13c0 | |||
612c0d1e31 | |||
|
3e71766f85 | ||
e4987c99ad | |||
c92eeff06e | |||
dc3a934d62 | |||
f90fee167f | |||
7648b9629c | |||
c6caa3276f | |||
eb03af79d9 |
21
README.md
21
README.md
@@ -10,6 +10,27 @@ You can set the file to be written by customizing `org-clock-waybar-filename`; i
|
||||
`$XDG_CACHE_HOME/waybar-current-task.json` (`$XDG_CACHE_HOME` defaults to `$HOME/.cache` on XDG
|
||||
compatible systems, like Linux.)
|
||||
|
||||
### Quelpa
|
||||
|
||||
If you only have [`quelpa`](https://github.com/quelpa/quelpa) installed:
|
||||
|
||||
```elisp
|
||||
(quelpa
|
||||
'(org-clock-waybar
|
||||
:fetcher git
|
||||
:url "https://gitea.polonkai.eu/gergely/org-clock-waybar.git"))
|
||||
```
|
||||
|
||||
or, if you have [`quelpa-use-package`](https://github.com/quelpa/quelpa-use-package) installed,
|
||||
too:
|
||||
|
||||
```elisp
|
||||
(quelpa-use-package org-clock-waybar
|
||||
:quelpa (org-clock-waybar
|
||||
:fetcher git
|
||||
:url "https://gitea.polonkai.eu/gergely/org-clock-waybar.git"))
|
||||
```
|
||||
|
||||
## Waybar configuration
|
||||
|
||||
To add the current task to Waybar, add this snippet to your config:
|
||||
|
@@ -1,12 +1,13 @@
|
||||
;;; org-clock-waybar --- Summary
|
||||
;;; ... -*- lexical-binding: t -*-
|
||||
;;; org-clock-waybar.el --- Summary
|
||||
|
||||
;; Copyright (C) 2021 Gergely Polonkai
|
||||
|
||||
;; Author: Gergely Polonkai <gergely@polonkai.eu>
|
||||
;; Keywords: org, clocking, waybar
|
||||
;; Version: 1.0
|
||||
;; Package-Requires: ((emacs "26.1"))
|
||||
;; URL: https://gitea.polonkai.eu/gergely/org-clock-waybar
|
||||
;; Package-Version: 1.0
|
||||
;; Package-Requires: ((emacs "26.1") (org-mode "9"))
|
||||
|
||||
;; This program is free software; you can redistribute it and/or modify
|
||||
;; it under the terms of the GNU General Public License as published by
|
||||
@@ -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)
|
||||
@@ -64,72 +67,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-text)
|
||||
(org-clock-waybar--get-task-category)
|
||||
(org-clock-waybar--get-task-title)
|
||||
(org-duration-from-minutes clocked-time)))))
|
||||
|
||||
(defun org-clock-waybar--get-clocked-task-json (&optional clocking-out)
|
||||
"Get the currently clocked-in task’s data as a stringified JSON object.
|
||||
(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'.
|
||||
|
||||
If CLOCKING-OUT is non-nil, `org-clock-current-task' will be treated as if it
|
||||
were nil; this is required because `org-clock-out' calls the hook functions
|
||||
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))
|
||||
value of `org-clock-waybar-not-clocked-in-text'."
|
||||
(let* ((category (org-clock-waybar--get-task-category))
|
||||
(title (org-clock-waybar--get-task-title))
|
||||
(tooltip (org-clock-waybar--get-tooltip))
|
||||
(output (json-new-object)))
|
||||
(setq output (json-add-to-object
|
||||
output
|
||||
"text"
|
||||
(if title
|
||||
title
|
||||
org-clock-waybar-not-clocked-in-text)))
|
||||
(setq output (json-add-to-object output "alt" (if category category "")))
|
||||
(setq output (json-add-to-object output "tooltip" (if tooltip tooltip "")))
|
||||
(setq output (json-add-to-object output "class" ""))
|
||||
(or title org-clock-waybar-not-clocked-in-text)))
|
||||
(setq output (json-add-to-object output "alt" (or category "")))
|
||||
(setq output (json-add-to-object output "tooltip" (or tooltip "")))
|
||||
(setq output (json-add-to-object output "class" (or (org-clock-waybar--get-tags) "")))
|
||||
(setq output (json-add-to-object output "percentage" ""))
|
||||
(json-encode output)))
|
||||
|
||||
(defun org-clock-waybar-save-task (&optional clocking-out)
|
||||
"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."
|
||||
(defun org-clock-waybar-save-task ()
|
||||
"Save the current clocked in task to `org-clock-waybar-filename'."
|
||||
(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 ()
|
||||
(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-task)
|
||||
(add-hook 'kill-emacs-hook #'org-clock-waybar-clear-task))
|
||||
(add-hook 'org-clock-out-hook #'org-clock-waybar-save-task)
|
||||
(add-hook 'kill-emacs-hook #'org-clock-waybar-save-task))
|
||||
|
||||
(provide 'org-clock-waybar)
|
||||
;;; org-clock-waybar.el ends here
|
||||
|
Reference in New Issue
Block a user