-
Notifications
You must be signed in to change notification settings - Fork 2
/
org-clock-today.el
139 lines (113 loc) · 5.14 KB
/
org-clock-today.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
;;; org-clock-today.el --- Show total clocked time of the current day in the mode line -*- lexical-binding: t -*-
;; Copyright © 2016-2019 Tijs Mallaerts
;;
;; Author: Tijs Mallaerts <tijs.mallaerts@gmail.com>
;; Package-Requires: ((emacs "25"))
;; Version: 0.0.2
;; URL: https://github.com/mallt/org-clock-today-mode
;; 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
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;; This file is not part of GNU Emacs.
;;; Commentary:
;; Show the total clocked time of the current day in the mode line
;;; Code:
(require 'org-clock)
(defgroup org-clock-today nil
"Org clock today customizations."
:group 'org-clock)
(defcustom org-clock-today-hide-default-org-clock-mode-line nil
"Controls the visibility of the default org clock mode line string."
:type 'boolean
:group 'org-clock-today)
(defcustom org-clock-today-count-subtree nil
"If non-nil, count total minutes of the current subtree as well."
:type 'boolean
:group 'org-clock-today)
(defcustom org-clock-today-show-mode-line-when-clock-is-inactive nil
"If non-nil, show the mode line when no org clocks are active."
:type 'boolean
:group 'org-clock-today)
(defvar org-clock-today-string "" "The lighter.")
(defvar org-clock-today-subtree-time nil "Clock count extracted from subtree.")
(defvar org-clock-today-buffer-time nil "Clock count extracted from buffer.")
(defvar org-clock-today--timer nil)
(defun org-clock-today--total-minutes ()
"Return the total minutes."
(let ((org-clock-report-include-clocking-task t))
(org-duration-from-minutes (org-clock-sum-today))))
(defun org-clock-today--display-default ()
"Default function to return string for displaying clocks."
(concat
" "
(when org-clock-today-count-subtree
(concat org-clock-today-subtree-time " "))
org-clock-today-buffer-time))
(defcustom org-clock-today-display-format #'org-clock-today--display-default
"Function to call when building string for mode-line."
:type '(choice
(const :tag "Do nothing" ignore)
(function :tag "Custom function")))
(defun org-clock-today--update-mode-line ()
"Calculate the total clocked time of today and update the mode line."
(setq org-clock-today-string
(if (org-clock-is-active)
(with-current-buffer (org-clock-is-active)
(when org-clock-today-count-subtree
(save-excursion
(save-restriction
(goto-char org-clock-marker)
(org-narrow-to-subtree)
(setq org-clock-today-subtree-time
(org-clock-today--total-minutes)))))
(setq org-clock-today-buffer-time
(org-clock-today--total-minutes))
(funcall org-clock-today-display-format))
(if org-clock-today-show-mode-line-when-clock-is-inactive
(concat (funcall org-clock-today-display-format) " (inact)")
"")))
(force-mode-line-update))
(defun org-clock-today--start-timer ()
"Start the timer that will update the mode line every 60 seconds."
(setq org-clock-today--timer
(run-at-time 0 60 'org-clock-today--update-mode-line)))
(defun org-clock-today--stop-timer ()
"Stop the timer."
(org-clock-today--update-mode-line)
(cancel-timer org-clock-today--timer))
(defun org-clock-today--maybe-clear-org-mode-line-string ()
"Clear the org mode line string depending on the defcustom setting."
(when org-clock-today-hide-default-org-clock-mode-line
(setq org-mode-line-string "")
(force-mode-line-update)))
(defun org-clock-today-toggle-count-subtree ()
"Toggle count total minutes in subtree or buffer."
(interactive)
(setq org-clock-today-count-subtree (not org-clock-today-count-subtree))
(unless org-clock-today-count-subtree
(setq org-clock-today-subtree-time nil))
(org-clock-today--update-mode-line))
;;;###autoload
(define-minor-mode org-clock-today-mode
"Minor mode to show the total clocked time of the current day in the mode line."
:lighter org-clock-today-string
:global t
(if org-clock-today-mode
(progn
(add-hook 'org-clock-in-hook 'org-clock-today--start-timer)
(add-hook 'org-clock-out-hook 'org-clock-today--stop-timer)
(advice-add 'org-clock-update-mode-line :after
'org-clock-today--maybe-clear-org-mode-line-string))
(remove-hook 'org-clock-in-hook 'org-clock-today--start-timer)
(remove-hook 'org-clock-out-hook 'org-clock-today--stop-timer)
(advice-remove 'org-clock-update-mode-line
'org-clock-today--maybe-clear-org-mode-line-string)))
(provide 'org-clock-today)
;;; org-clock-today.el ends here