Merge branch 'maint'
[org-mode.git] / lisp / org-timer.el
bloba314564b94a6978fb3bf02c678c4ccb0da5d9cb0
1 ;;; org-timer.el --- The relative timer code for Org-mode
3 ;; Copyright (C) 2008-2012 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;; Commentary:
27 ;; This file contains the relative timer code for Org-mode
29 ;;; Code:
31 (require 'org)
33 (declare-function org-notify "org-clock" (notification &optional play-sound))
34 (declare-function org-agenda-error "org-agenda" ())
36 (defvar org-timer-start-time nil
37 "t=0 for the running timer.")
39 (defvar org-timer-pause-time nil
40 "Time when the timer was paused.")
42 (defconst org-timer-re "\\([-+]?[0-9]+\\):\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)"
43 "Regular expression used to match timer stamps.")
45 (defcustom org-timer-format "%s "
46 "The format to insert the time of the timer.
47 This format must contain one instance of \"%s\" which will be replaced by
48 the value of the relative timer."
49 :group 'org-time
50 :type 'string)
52 (defcustom org-timer-default-timer 0
53 "The default timer when a timer is set.
54 When 0, the user is prompted for a value."
55 :group 'org-time
56 :version "24.1"
57 :type 'number)
59 (defcustom org-timer-display 'mode-line
60 "When a timer is running, org-mode can display it in the mode
61 line and/or frame title.
62 Allowed values are:
64 both displays in both mode line and frame title
65 mode-line displays only in mode line (default)
66 frame-title displays only in frame title
67 nil current timer is not displayed"
68 :group 'org-time
69 :type '(choice
70 (const :tag "Mode line" mode-line)
71 (const :tag "Frame title" frame-title)
72 (const :tag "Both" both)
73 (const :tag "None" nil)))
75 (defvar org-timer-start-hook nil
76 "Hook run after relative timer is started.")
78 (defvar org-timer-stop-hook nil
79 "Hook run before relative timer is stopped.")
81 (defvar org-timer-pause-hook nil
82 "Hook run before relative timer is paused.")
84 (defvar org-timer-continue-hook nil
85 "Hook run after relative timer is continued.")
87 (defvar org-timer-set-hook nil
88 "Hook run after countdown timer is set.")
90 (defvar org-timer-done-hook nil
91 "Hook run after countdown timer reaches zero.")
93 (defvar org-timer-cancel-hook nil
94 "Hook run before countdown timer is canceled.")
96 ;;;###autoload
97 (defun org-timer-start (&optional offset)
98 "Set the starting time for the relative timer to now.
99 When called with prefix argument OFFSET, prompt the user for an offset time,
100 with the default taken from a timer stamp at point, if any.
101 If OFFSET is a string or an integer, it is directly taken to be the offset
102 without user interaction.
103 When called with a double prefix arg, all timer strings in the active
104 region will be shifted by a specific amount. You will be prompted for
105 the amount, with the default to make the first timer string in
106 the region 0:00:00."
107 (interactive "P")
108 (if (equal offset '(16))
109 (call-interactively 'org-timer-change-times-in-region)
110 (let (delta def s)
111 (if (not offset)
112 (setq org-timer-start-time (current-time))
113 (cond
114 ((integerp offset) (setq delta offset))
115 ((stringp offset) (setq delta (org-timer-hms-to-secs offset)))
117 (setq def (if (org-in-regexp org-timer-re)
118 (match-string 0)
119 "0:00:00")
120 s (read-string
121 (format "Restart timer with offset [%s]: " def)))
122 (unless (string-match "\\S-" s) (setq s def))
123 (setq delta (org-timer-hms-to-secs (org-timer-fix-incomplete s)))))
124 (setq org-timer-start-time
125 (seconds-to-time
126 (- (org-float-time) delta))))
127 (org-timer-set-mode-line 'on)
128 (message "Timer start time set to %s, current value is %s"
129 (format-time-string "%T" org-timer-start-time)
130 (org-timer-secs-to-hms (or delta 0)))
131 (run-hooks 'org-timer-start-hook))))
133 (defun org-timer-pause-or-continue (&optional stop)
134 "Pause or continue the relative timer.
135 With prefix arg STOP, stop it entirely."
136 (interactive "P")
137 (cond
138 (stop (org-timer-stop))
139 ((not org-timer-start-time) (error "No timer is running"))
140 (org-timer-pause-time
141 ;; timer is paused, continue
142 (setq org-timer-start-time
143 (seconds-to-time
145 (org-float-time)
146 (- (org-float-time org-timer-pause-time)
147 (org-float-time org-timer-start-time))))
148 org-timer-pause-time nil)
149 (org-timer-set-mode-line 'on)
150 (run-hooks 'org-timer-continue-hook)
151 (message "Timer continues at %s" (org-timer-value-string)))
153 ;; pause timer
154 (run-hooks 'org-timer-pause-hook)
155 (setq org-timer-pause-time (current-time))
156 (org-timer-set-mode-line 'pause)
157 (message "Timer paused at %s" (org-timer-value-string)))))
159 (defun org-timer-stop ()
160 "Stop the relative timer."
161 (interactive)
162 (run-hooks 'org-timer-stop-hook)
163 (setq org-timer-start-time nil
164 org-timer-pause-time nil)
165 (org-timer-set-mode-line 'off))
167 ;;;###autoload
168 (defun org-timer (&optional restart no-insert-p)
169 "Insert a H:MM:SS string from the timer into the buffer.
170 The first time this command is used, the timer is started. When used with
171 a \\[universal-argument] prefix, force restarting the timer.
172 When used with a double prefix argument \\[universal-argument], change all the timer string
173 in the region by a fixed amount. This can be used to recalibrate a timer
174 that was not started at the correct moment.
176 If NO-INSERT-P is non-nil, return the string instead of inserting
177 it in the buffer."
178 (interactive "P")
179 (when (or (equal restart '(4)) (not org-timer-start-time))
180 (org-timer-start))
181 (if no-insert-p
182 (org-timer-value-string)
183 (insert (org-timer-value-string))))
185 (defun org-timer-value-string ()
186 (format org-timer-format (org-timer-secs-to-hms (floor (org-timer-seconds)))))
188 (defvar org-timer-timer-is-countdown nil)
189 (defun org-timer-seconds ()
190 (if org-timer-timer-is-countdown
191 (- (org-float-time org-timer-start-time)
192 (org-float-time (current-time)))
193 (- (org-float-time (or org-timer-pause-time (current-time)))
194 (org-float-time org-timer-start-time))))
196 ;;;###autoload
197 (defun org-timer-change-times-in-region (beg end delta)
198 "Change all h:mm:ss time in region by a DELTA."
199 (interactive
200 "r\nsEnter time difference like \"-1:08:26\". Default is first time to zero: ")
201 (let ((re "[-+]?[0-9]+:[0-9]\\{2\\}:[0-9]\\{2\\}") p)
202 (unless (string-match "\\S-" delta)
203 (save-excursion
204 (goto-char beg)
205 (when (re-search-forward re end t)
206 (setq delta (match-string 0))
207 (if (equal (string-to-char delta) ?-)
208 (setq delta (substring delta 1))
209 (setq delta (concat "-" delta))))))
210 (setq delta (org-timer-hms-to-secs (org-timer-fix-incomplete delta)))
211 (when (= delta 0) (error "No change"))
212 (save-excursion
213 (goto-char end)
214 (while (re-search-backward re beg t)
215 (setq p (point))
216 (replace-match
217 (save-match-data
218 (org-timer-secs-to-hms (+ (org-timer-hms-to-secs (match-string 0)) delta)))
219 t t)
220 (goto-char p)))))
222 ;;;###autoload
223 (defun org-timer-item (&optional arg)
224 "Insert a description-type item with the current timer value."
225 (interactive "P")
226 (let ((itemp (org-in-item-p)) (pos (point)))
227 (cond
228 ;; In a timer list, insert with `org-list-insert-item',
229 ;; then fix the list.
230 ((and itemp (goto-char itemp) (org-at-item-timer-p))
231 (let* ((struct (org-list-struct))
232 (prevs (org-list-prevs-alist struct))
233 (s (concat (org-timer (when arg '(4)) t) ":: ")))
234 (setq struct (org-list-insert-item pos struct prevs nil s))
235 (org-list-write-struct struct (org-list-parents-alist struct))
236 (looking-at org-list-full-item-re)
237 (goto-char (match-end 0))))
238 ;; In a list of another type, don't break anything: throw an error.
239 (itemp (goto-char pos) (error "This is not a timer list"))
240 ;; Else, start a new list.
242 (beginning-of-line)
243 (org-indent-line)
244 (insert "- ")
245 (org-timer (when arg '(4)))
246 (insert ":: ")))))
248 (defun org-timer-fix-incomplete (hms)
249 "If hms is a H:MM:SS string with missing hour or hour and minute, fix it."
250 (if (string-match "\\(?:\\([0-9]+:\\)?\\([0-9]+:\\)\\)?\\([0-9]+\\)" hms)
251 (replace-match
252 (format "%d:%02d:%02d"
253 (if (match-end 1) (string-to-number (match-string 1 hms)) 0)
254 (if (match-end 2) (string-to-number (match-string 2 hms)) 0)
255 (string-to-number (match-string 3 hms)))
256 t t hms)
257 (error "Cannot parse HMS string \"%s\"" hms)))
259 (defun org-timer-hms-to-secs (hms)
260 "Convert h:mm:ss string to an integer time.
261 If the string starts with a minus sign, the integer will be negative."
262 (if (not (string-match
263 "\\([-+]?[0-9]+\\):\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)"
264 hms))
266 (let* ((h (string-to-number (match-string 1 hms)))
267 (m (string-to-number (match-string 2 hms)))
268 (s (string-to-number (match-string 3 hms)))
269 (sign (equal (substring (match-string 1 hms) 0 1) "-")))
270 (setq h (abs h))
271 (* (if sign -1 1) (+ s (* 60 (+ m (* 60 h))))))))
273 (defun org-timer-secs-to-hms (s)
274 "Convert integer S into h:mm:ss.
275 If the integer is negative, the string will start with \"-\"."
276 (let (sign m h)
277 (setq sign (if (< s 0) "-" "")
278 s (abs s)
279 m (/ s 60) s (- s (* 60 m))
280 h (/ m 60) m (- m (* 60 h)))
281 (format "%s%d:%02d:%02d" sign h m s)))
283 (defvar org-timer-mode-line-timer nil)
284 (defvar org-timer-mode-line-string nil)
286 (defun org-timer-set-mode-line (value)
287 "Set the mode-line display of the relative timer.
288 VALUE can be `on', `off', or `pause'."
289 (when (or (eq org-timer-display 'mode-line)
290 (eq org-timer-display 'both))
291 (or global-mode-string (setq global-mode-string '("")))
292 (or (memq 'org-timer-mode-line-string global-mode-string)
293 (setq global-mode-string
294 (append global-mode-string '(org-timer-mode-line-string)))))
295 (when (or (eq org-timer-display 'frame-title)
296 (eq org-timer-display 'both))
297 (or (memq 'org-timer-mode-line-string frame-title-format)
298 (setq frame-title-format
299 (append frame-title-format '(org-timer-mode-line-string)))))
300 (cond
301 ((equal value 'off)
302 (when org-timer-mode-line-timer
303 (cancel-timer org-timer-mode-line-timer)
304 (setq org-timer-mode-line-timer nil))
305 (when (or (eq org-timer-display 'mode-line)
306 (eq org-timer-display 'both))
307 (setq global-mode-string
308 (delq 'org-timer-mode-line-string global-mode-string)))
309 (when (or (eq org-timer-display 'frame-title)
310 (eq org-timer-display 'both))
311 (setq frame-title-format
312 (delq 'org-timer-mode-line-string frame-title-format)))
313 (force-mode-line-update))
314 ((equal value 'pause)
315 (when org-timer-mode-line-timer
316 (cancel-timer org-timer-mode-line-timer)
317 (setq org-timer-mode-line-timer nil)))
318 ((equal value 'on)
319 (when (or (eq org-timer-display 'mode-line)
320 (eq org-timer-display 'both))
321 (or global-mode-string (setq global-mode-string '("")))
322 (or (memq 'org-timer-mode-line-string global-mode-string)
323 (setq global-mode-string
324 (append global-mode-string '(org-timer-mode-line-string)))))
325 (when (or (eq org-timer-display 'frame-title)
326 (eq org-timer-display 'both))
327 (or (memq 'org-timer-mode-line-string frame-title-format)
328 (setq frame-title-format
329 (append frame-title-format '(org-timer-mode-line-string)))))
330 (org-timer-update-mode-line)
331 (when org-timer-mode-line-timer
332 (cancel-timer org-timer-mode-line-timer)
333 (setq org-timer-mode-line-timer nil))
334 (when org-timer-display
335 (setq org-timer-mode-line-timer
336 (run-with-timer 1 1 'org-timer-update-mode-line))))))
338 (defun org-timer-update-mode-line ()
339 "Update the timer time in the mode line."
340 (if org-timer-pause-time
342 (setq org-timer-mode-line-string
343 (concat " <" (substring (org-timer-value-string) 0 -1) ">"))
344 (force-mode-line-update)))
346 (defvar org-timer-current-timer nil)
347 (defun org-timer-cancel-timer ()
348 "Cancel the current timer."
349 (interactive)
350 (when (eval org-timer-current-timer)
351 (run-hooks 'org-timer-cancel-hook)
352 (cancel-timer org-timer-current-timer)
353 (setq org-timer-current-timer nil)
354 (setq org-timer-timer-is-countdown nil)
355 (org-timer-set-mode-line 'off))
356 (message "Last timer canceled"))
358 (defun org-timer-show-remaining-time ()
359 "Display the remaining time before the timer ends."
360 (interactive)
361 (require 'time)
362 (if (not org-timer-current-timer)
363 (message "No timer set")
364 (let* ((rtime (decode-time
365 (time-subtract (timer--time org-timer-current-timer)
366 (current-time))))
367 (rsecs (nth 0 rtime))
368 (rmins (nth 1 rtime)))
369 (message "%d minute(s) %d seconds left before next time out"
370 rmins rsecs))))
372 ;;;###autoload
373 (defun org-timer-set-timer (&optional opt)
374 "Prompt for a duration and set a timer.
376 If `org-timer-default-timer' is not zero, suggest this value as
377 the default duration for the timer. If a timer is already set,
378 prompt the user if she wants to replace it.
380 Called with a numeric prefix argument, use this numeric value as
381 the duration of the timer.
383 Called with a `C-u' prefix arguments, use `org-timer-default-timer'
384 without prompting the user for a duration.
386 With two `C-u' prefix arguments, use `org-timer-default-timer'
387 without prompting the user for a duration and automatically
388 replace any running timer."
389 (interactive "P")
390 (let ((minutes (or (and (numberp opt) (number-to-string opt))
391 (and (listp opt) (not (null opt))
392 (number-to-string org-timer-default-timer))
393 (read-from-minibuffer
394 "How many minutes left? "
395 (if (not (eq org-timer-default-timer 0))
396 (number-to-string org-timer-default-timer))))))
397 (if (not (string-match "[0-9]+" minutes))
398 (org-timer-show-remaining-time)
399 (let* ((mins (string-to-number (match-string 0 minutes)))
400 (secs (* mins 60))
401 (hl (cond
402 ((string-match "Org Agenda" (buffer-name))
403 (let* ((marker (or (get-text-property (point) 'org-marker)
404 (org-agenda-error)))
405 (hdmarker (or (get-text-property (point) 'org-hd-marker)
406 marker))
407 (pos (marker-position marker)))
408 (with-current-buffer (marker-buffer marker)
409 (widen)
410 (goto-char pos)
411 (org-show-entry)
412 (or (ignore-errors (org-get-heading))
413 (concat "File:" (file-name-nondirectory (buffer-file-name)))))))
414 ((derived-mode-p 'org-mode)
415 (or (ignore-errors (org-get-heading))
416 (concat "File:" (file-name-nondirectory (buffer-file-name)))))
417 (t (error "Not in an Org buffer"))))
418 timer-set)
419 (if (or (and org-timer-current-timer
420 (or (equal opt '(16))
421 (y-or-n-p "Replace current timer? ")))
422 (not org-timer-current-timer))
423 (progn
424 (require 'org-clock)
425 (when org-timer-current-timer
426 (cancel-timer org-timer-current-timer))
427 (setq org-timer-current-timer
428 (run-with-timer
429 secs nil `(lambda ()
430 (setq org-timer-current-timer nil)
431 (org-notify ,(format "%s: time out" hl) t)
432 (setq org-timer-timer-is-countdown nil)
433 (org-timer-set-mode-line 'off)
434 (run-hooks 'org-timer-done-hook))))
435 (run-hooks 'org-timer-set-hook)
436 (setq org-timer-timer-is-countdown t
437 org-timer-start-time
438 (time-add (current-time) (seconds-to-time (* mins 60))))
439 (org-timer-set-mode-line 'on))
440 (message "No timer set"))))))
442 (provide 'org-timer)
444 ;; Local variables:
445 ;; generated-autoload-file: "org-loaddefs.el"
446 ;; End:
448 ;;; org-timer.el ends here