1 ;;; org-timer.el --- The relative timer code for Org-mode
3 ;; Copyright (C) 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
28 ;; This file contains the relative timer code for Org-mode
34 (declare-function org-notify "org-clock" (notification &optional play-sound))
35 (declare-function org-agenda-error "org-agenda" ())
37 (defvar org-timer-start-time nil
38 "t=0 for the running timer.")
40 (defvar org-timer-pause-time nil
41 "Time when the timer was paused.")
43 (defconst org-timer-re "\\([-+]?[0-9]+\\):\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)"
44 "Regular expression used to match timer stamps.")
46 (defcustom org-timer-format "%s "
47 "The format to insert the time of the timer.
48 This format must contain one instance of \"%s\" which will be replaced by
49 the value of the relative timer."
53 (defcustom org-timer-default-timer 0
54 "The default timer when a timer is set.
55 When 0, the user is prompted for a value."
59 (defvar org-timer-start-hook nil
60 "Hook run after relative timer is started.")
62 (defvar org-timer-stop-hook nil
63 "Hook run before relative timer is stopped.")
65 (defvar org-timer-pause-hook nil
66 "Hook run before relative timer is paused.")
68 (defvar org-timer-set-hook nil
69 "Hook run after countdown timer is set.")
71 (defvar org-timer-done-hook nil
72 "Hook run after countdown timer reaches zero.")
74 (defvar org-timer-cancel-hook nil
75 "Hook run before countdown timer is canceled.")
78 (defun org-timer-start (&optional offset)
79 "Set the starting time for the relative timer to now.
80 When called with prefix argument OFFSET, prompt the user for an offset time,
81 with the default taken from a timer stamp at point, if any.
82 If OFFSET is a string or an integer, it is directly taken to be the offset
83 without user interaction.
84 When called with a double prefix arg, all timer strings in the active
85 region will be shifted by a specific amount. You will be prompted for
86 the amount, with the default to make the first timer string in
89 (if (equal offset '(16))
90 (call-interactively 'org-timer-change-times-in-region)
93 (setq org-timer-start-time (current-time))
95 ((integerp offset) (setq delta offset))
96 ((stringp offset) (setq delta (org-timer-hms-to-secs offset)))
98 (setq def (if (org-in-regexp org-timer-re)
102 (format "Restart timer with offset [%s]: " def)))
103 (unless (string-match "\\S-" s) (setq s def))
104 (setq delta (org-timer-hms-to-secs (org-timer-fix-incomplete s)))))
105 (setq org-timer-start-time
107 (- (org-float-time) delta))))
108 (org-timer-set-mode-line 'on)
109 (message "Timer start time set to %s, current value is %s"
110 (format-time-string "%T" org-timer-start-time)
111 (org-timer-secs-to-hms (or delta 0)))
112 (run-hooks 'org-timer-start-hook))))
114 (defun org-timer-pause-or-continue (&optional stop)
115 "Pause or continue the relative timer.
116 With prefix arg STOP, stop it entirely."
119 (stop (org-timer-stop))
120 ((not org-timer-start-time) (error "No timer is running"))
121 (org-timer-pause-time
122 ;; timer is paused, continue
123 (setq org-timer-start-time
127 (- (org-float-time org-timer-pause-time)
128 (org-float-time org-timer-start-time))))
129 org-timer-pause-time nil)
130 (org-timer-set-mode-line 'on)
131 (message "Timer continues at %s" (org-timer-value-string)))
134 (run-hooks 'org-timer-pause-hook)
135 (setq org-timer-pause-time (current-time))
136 (org-timer-set-mode-line 'pause)
137 (message "Timer paused at %s" (org-timer-value-string)))))
139 (defun org-timer-stop ()
140 "Stop the relative timer."
142 (run-hooks 'org-timer-stop-hook)
143 (setq org-timer-start-time nil
144 org-timer-pause-time nil)
145 (org-timer-set-mode-line 'off))
148 (defun org-timer (&optional restart no-insert-p)
149 "Insert a H:MM:SS string from the timer into the buffer.
150 The first time this command is used, the timer is started. When used with
151 a \\[universal-argument] prefix, force restarting the timer.
152 When used with a double prefix argument \\[universal-argument], change all the timer string
153 in the region by a fixed amount. This can be used to recalibrate a timer
154 that was not started at the correct moment.
156 If NO-INSERT-P is non-nil, return the string instead of inserting
159 (when (or (equal restart '(4)) (not org-timer-start-time))
162 (org-timer-value-string)
163 (insert (org-timer-value-string))))
165 (defun org-timer-value-string ()
166 (format org-timer-format (org-timer-secs-to-hms (floor (org-timer-seconds)))))
168 (defvar org-timer-timer-is-countdown nil)
169 (defun org-timer-seconds ()
170 (if org-timer-timer-is-countdown
171 (- (org-float-time org-timer-start-time)
172 (org-float-time (current-time)))
173 (- (org-float-time (or org-timer-pause-time (current-time)))
174 (org-float-time org-timer-start-time))))
177 (defun org-timer-change-times-in-region (beg end delta)
178 "Change all h:mm:ss time in region by a DELTA."
180 "r\nsEnter time difference like \"-1:08:26\". Default is first time to zero: ")
181 (let ((re "[-+]?[0-9]+:[0-9]\\{2\\}:[0-9]\\{2\\}") p)
182 (unless (string-match "\\S-" delta)
185 (when (re-search-forward re end t)
186 (setq delta (match-string 0))
187 (if (equal (string-to-char delta) ?-)
188 (setq delta (substring delta 1))
189 (setq delta (concat "-" delta))))))
190 (setq delta (org-timer-hms-to-secs (org-timer-fix-incomplete delta)))
191 (when (= delta 0) (error "No change"))
194 (while (re-search-backward re beg t)
198 (org-timer-secs-to-hms (+ (org-timer-hms-to-secs (match-string 0)) delta)))
203 (defun org-timer-item (&optional arg)
204 "Insert a description-type item with the current timer value."
207 ;; In a timer list, insert with `org-list-insert-item-generic'.
208 ((and (org-in-item-p)
209 (save-excursion (org-beginning-of-item) (org-at-item-timer-p)))
210 (org-list-insert-item-generic
211 (point) nil (concat (org-timer (when arg '(4)) t) ":: ")))
212 ;; In a list of another type, don't break anything: throw an error.
214 (error "This is not a timer list"))
215 ;; Else, insert the timer correctly indented at bol.
218 (org-indent-line-function)
220 (org-timer (when arg '(4)))
223 (defun org-timer-fix-incomplete (hms)
224 "If hms is a H:MM:SS string with missing hour or hour and minute, fix it."
225 (if (string-match "\\(?:\\([0-9]+:\\)?\\([0-9]+:\\)\\)?\\([0-9]+\\)" hms)
227 (format "%d:%02d:%02d"
228 (if (match-end 1) (string-to-number (match-string 1 hms)) 0)
229 (if (match-end 2) (string-to-number (match-string 2 hms)) 0)
230 (string-to-number (match-string 3 hms)))
232 (error "Cannot parse HMS string \"%s\"" hms)))
234 (defun org-timer-hms-to-secs (hms)
235 "Convert h:mm:ss string to an integer time.
236 If the string starts with a minus sign, the integer will be negative."
237 (if (not (string-match
238 "\\([-+]?[0-9]+\\):\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)"
241 (let* ((h (string-to-number (match-string 1 hms)))
242 (m (string-to-number (match-string 2 hms)))
243 (s (string-to-number (match-string 3 hms)))
244 (sign (equal (substring (match-string 1 hms) 0 1) "-")))
246 (* (if sign -1 1) (+ s (* 60 (+ m (* 60 h))))))))
248 (defun org-timer-secs-to-hms (s)
249 "Convert integer S into h:mm:ss.
250 If the integer is negative, the string will start with \"-\"."
252 (setq sign (if (< s 0) "-" "")
254 m (/ s 60) s (- s (* 60 m))
255 h (/ m 60) m (- m (* 60 h)))
256 (format "%s%d:%02d:%02d" sign h m s)))
258 (defvar org-timer-mode-line-timer nil)
259 (defvar org-timer-mode-line-string nil)
261 (defun org-timer-set-mode-line (value)
262 "Set the mode-line display of the relative timer.
263 VALUE can be `on', `off', or `pause'."
264 (or global-mode-string (setq global-mode-string '("")))
265 (or (memq 'org-timer-mode-line-string global-mode-string)
266 (setq global-mode-string
267 (append global-mode-string '(org-timer-mode-line-string))))
270 (when org-timer-mode-line-timer
271 (cancel-timer org-timer-mode-line-timer)
272 (setq org-timer-mode-line-timer nil))
273 (setq global-mode-string
274 (delq 'org-timer-mode-line-string global-mode-string))
275 (force-mode-line-update))
276 ((equal value 'pause)
277 (when org-timer-mode-line-timer
278 (cancel-timer org-timer-mode-line-timer)
279 (setq org-timer-mode-line-timer nil)))
281 (or global-mode-string (setq global-mode-string '("")))
282 (or (memq 'org-timer-mode-line-string global-mode-string)
283 (setq global-mode-string
284 (append global-mode-string '(org-timer-mode-line-string))))
285 (org-timer-update-mode-line)
286 (when org-timer-mode-line-timer
287 (cancel-timer org-timer-mode-line-timer))
288 (setq org-timer-mode-line-timer
289 (run-with-timer 1 1 'org-timer-update-mode-line)))))
291 (defun org-timer-update-mode-line ()
292 "Update the timer time in the mode line."
293 (if org-timer-pause-time
295 (setq org-timer-mode-line-string
296 (concat " <" (substring (org-timer-value-string) 0 -1) ">"))
297 (force-mode-line-update)))
299 (defvar org-timer-current-timer nil)
300 (defun org-timer-cancel-timer ()
301 "Cancel the current timer."
303 (when (eval org-timer-current-timer)
304 (run-hooks 'org-timer-cancel-hook)
305 (cancel-timer org-timer-current-timer)
306 (setq org-timer-current-timer nil)
307 (setq org-timer-timer-is-countdown nil)
308 (org-timer-set-mode-line 'off))
309 (message "Last timer canceled"))
311 (defun org-timer-show-remaining-time ()
312 "Display the remaining time before the timer ends."
315 (if (not org-timer-current-timer)
316 (message "No timer set")
317 (let* ((rtime (decode-time
318 (time-subtract (timer--time org-timer-current-timer)
320 (rsecs (nth 0 rtime))
321 (rmins (nth 1 rtime)))
322 (message "%d minute(s) %d seconds left before next time out"
326 (defun org-timer-set-timer (&optional opt)
327 "Prompt for a duration and set a timer.
329 If `org-timer-default-timer' is not zero, suggest this value as
330 the default duration for the timer. If a timer is already set,
331 prompt the user if she wants to replace it.
333 Called with a numeric prefix argument, use this numeric value as
334 the duration of the timer.
336 Called with a `C-u' prefix arguments, use `org-timer-default-timer'
337 without prompting the user for a duration.
339 With two `C-u' prefix arguments, use `org-timer-default-timer'
340 without prompting the user for a duration and automatically
341 replace any running timer."
343 (let ((minutes (or (and (numberp opt) (number-to-string opt))
344 (and (listp opt) (not (null opt))
345 (number-to-string org-timer-default-timer))
346 (read-from-minibuffer
347 "How many minutes left? "
348 (if (not (eq org-timer-default-timer 0))
349 (number-to-string org-timer-default-timer))))))
350 (if (not (string-match "[0-9]+" minutes))
351 (org-timer-show-remaining-time)
352 (let* ((mins (string-to-number (match-string 0 minutes)))
355 ((string-match "Org Agenda" (buffer-name))
356 (let* ((marker (or (get-text-property (point) 'org-marker)
358 (hdmarker (or (get-text-property (point) 'org-hd-marker)
360 (pos (marker-position marker)))
361 (with-current-buffer (marker-buffer marker)
365 (or (ignore-errors (org-get-heading))
366 (concat "File:" (file-name-nondirectory (buffer-file-name)))))))
367 ((eq major-mode 'org-mode)
368 (or (ignore-errors (org-get-heading))
369 (concat "File:" (file-name-nondirectory (buffer-file-name)))))
370 (t (error "Not in an Org buffer"))))
372 (if (or (and org-timer-current-timer
373 (or (equal opt '(16))
374 (y-or-n-p "Replace current timer? ")))
375 (not org-timer-current-timer))
378 (when org-timer-current-timer
379 (cancel-timer org-timer-current-timer))
380 (setq org-timer-current-timer
383 (setq org-timer-current-timer nil)
384 (org-notify ,(format "%s: time out" hl) t)
385 (setq org-timer-timer-is-countdown nil)
386 (org-timer-set-mode-line 'off)
387 (run-hooks 'org-timer-done-hook))))
388 (run-hooks 'org-timer-set-hook)
389 (setq org-timer-timer-is-countdown t
391 (time-add (current-time) (seconds-to-time (* mins 60))))
392 (org-timer-set-mode-line 'on))
393 (message "No timer set"))))))
398 ;;; org-timer.el ends here