1 ;;; org-clock.el --- The time clocking code for Org-mode
3 ;; Copyright (C) 2004-2014 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
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 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;; This file contains the time clocking code for Org-mode
35 (declare-function calendar-absolute-from-iso "cal-iso" (&optional date))
36 (declare-function notifications-notify "notifications" (&rest params))
37 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
38 (declare-function org-refresh-properties "org" (dprop tprop))
39 (defvar org-time-stamp-formats)
41 (defvar org-frame-title-format-backup frame-title-format)
43 (defgroup org-clock nil
44 "Options concerning clocking working time in Org-mode."
48 (defcustom org-clock-into-drawer org-log-into-drawer
49 "Should clocking info be wrapped into a drawer?
50 When t, clocking info will always be inserted into a :LOGBOOK: drawer.
51 If necessary, the drawer will be created.
52 When nil, the drawer will not be created, but used when present.
53 When an integer and the number of clocking entries in an item
54 reaches or exceeds this number, a drawer will be created.
55 When a string, it names the drawer to be used.
57 The default for this variable is the value of `org-log-into-drawer',
62 (const :tag "Always" t)
63 (const :tag "Only when drawer exists" nil)
64 (integer :tag "When at least N clock entries")
65 (const :tag "Into LOGBOOK drawer" "LOGBOOK")
66 (string :tag "Into Drawer named...")))
68 (defun org-clock-into-drawer ()
69 "Return the value of `org-clock-into-drawer', but let properties overrule.
70 If the current entry has or inherits a CLOCK_INTO_DRAWER
71 property, it will be used instead of the default value; otherwise
72 if the current entry has or inherits a LOG_INTO_DRAWER property,
73 it will be used instead of the default value.
74 The default is the value of the customizable variable `org-clock-into-drawer',
76 (let ((p (org-entry-get nil "CLOCK_INTO_DRAWER" 'inherit))
77 (q (org-entry-get nil "LOG_INTO_DRAWER" 'inherit)))
79 ((or (not (or p q)) (equal p "nil") (equal q "nil")) org-clock-into-drawer)
80 ((or (equal p "t") (equal q "t")) "LOGBOOK")
84 (defcustom org-clock-out-when-done t
85 "When non-nil, clock will be stopped when the clocked entry is marked DONE.
86 DONE here means any DONE-like state.
87 A nil value means clock will keep running until stopped explicitly with
88 `C-c C-x C-o', or until the clock is started in a different item.
89 Instead of t, this can also be a list of TODO states that should trigger
94 (const :tag "Yes, when done" t)
95 (repeat :tag "State list"
96 (string :tag "TODO keyword"))))
98 (defcustom org-clock-rounding-minutes 0
99 "Rounding minutes when clocking in or out.
100 The default value is 0 so that no rounding is done.
101 When set to a non-integer value, use the car of
102 `org-time-stamp-rounding-minutes', like for setting a time-stamp.
104 E.g. if `org-clock-rounding-minutes' is set to 5, time is 14:47
105 and you clock in: then the clock starts at 14:45. If you clock
106 out within the next 5 minutes, the clock line will be removed;
107 if you clock out 8 minutes after your clocked in, the clock
108 out time will be 14:50."
111 :package-version '(Org . "8.0")
113 (integer :tag "Minutes (0 for no rounding)")
114 (symbol :tag "Use `org-time-stamp-rounding-minutes'" 'same-as-time-stamp)))
116 (defcustom org-clock-out-remove-zero-time-clocks nil
117 "Non-nil means remove the clock line when the resulting time is zero."
121 (defcustom org-clock-in-switch-to-state nil
122 "Set task to a special todo state while clocking it.
123 The value should be the state to which the entry should be
124 switched. If the value is a function, it must take one
125 parameter (the current TODO state of the item) and return the
126 state to switch it to."
130 (const :tag "Don't force a state" nil)
131 (string :tag "State")
132 (symbol :tag "Function")))
134 (defcustom org-clock-out-switch-to-state nil
135 "Set task to a special todo state after clocking out.
136 The value should be the state to which the entry should be
137 switched. If the value is a function, it must take one
138 parameter (the current TODO state of the item) and return the
139 state to switch it to."
143 (const :tag "Don't force a state" nil)
144 (string :tag "State")
145 (symbol :tag "Function")))
147 (defcustom org-clock-history-length 5
148 "Number of clock tasks to remember in history."
152 (defcustom org-clock-goto-may-find-recent-task t
153 "Non-nil means `org-clock-goto' can go to recent task if no active clock."
157 (defcustom org-clock-heading-function nil
158 "When non-nil, should be a function to create `org-clock-heading'.
159 This is the string shown in the mode line when a clock is running.
160 The function is called with point at the beginning of the headline."
162 :type '(choice (const nil) (function)))
164 (defcustom org-clock-string-limit 0
165 "Maximum length of clock strings in the mode line. 0 means no limit."
169 (defcustom org-clock-in-resume nil
170 "If non-nil, resume clock when clocking into task with open clock.
171 When clocking into a task with a clock entry which has not been closed,
172 the clock can be resumed from that point."
176 (defcustom org-clock-persist nil
177 "When non-nil, save the running clock when Emacs is closed.
178 The clock is resumed when Emacs restarts.
179 When this is t, both the running clock, and the entire clock
180 history are saved. When this is the symbol `clock', only the
181 running clock is saved. When this is the symbol `history', only
182 the clock history is saved.
184 When Emacs restarts with saved clock information, the file containing
185 the running clock as well as all files mentioned in the clock history
188 All this depends on running `org-clock-persistence-insinuate' in your
189 Emacs initialization file."
192 (const :tag "Just the running clock" clock)
193 (const :tag "Just the history" history)
194 (const :tag "Clock and history" t)
195 (const :tag "No persistence" nil)))
197 (defcustom org-clock-persist-file (convert-standard-filename
198 (concat user-emacs-directory "org-clock-save.el"))
199 "File to save clock data to."
203 (defcustom org-clock-persist-query-save nil
204 "When non-nil, ask before saving the current clock on exit."
208 (defcustom org-clock-persist-query-resume t
209 "When non-nil, ask before resuming any stored clock during load."
213 (defcustom org-clock-sound nil
214 "Sound to use for notifications.
218 t Standard Emacs beep
219 file name Play this sound file, fall back to beep"
222 (const :tag "No sound" nil)
223 (const :tag "Standard beep" t)
224 (file :tag "Play sound file")))
226 (define-obsolete-variable-alias 'org-clock-modeline-total
227 'org-clock-mode-line-total "24.3")
229 (defcustom org-clock-mode-line-total 'auto
230 "Default setting for the time included for the mode line clock.
231 This can be overruled locally using the CLOCK_MODELINE_TOTAL property.
234 current Only the time in the current instance of the clock
235 today All time clocked into this task today
236 repeat All time clocked into this task since last repeat
237 all All time ever recorded for this task
238 auto Automatically, either `all', or `repeat' for repeating tasks"
241 (const :tag "Current clock" current)
242 (const :tag "Today's task time" today)
243 (const :tag "Since last repeat" repeat)
244 (const :tag "All task time" all)
245 (const :tag "Automatically, `all' or since `repeat'" auto)))
247 (org-defvaralias 'org-task-overrun-text 'org-clock-task-overrun-text)
248 (defcustom org-clock-task-overrun-text nil
249 "Extra mode line text to indicate that the clock is overrun.
250 The can be nil to indicate that instead of adding text, the clock time
251 should get a different face (`org-mode-line-clock-overrun').
252 When this is a string, it is prepended to the clock string as an indication,
253 also using the face `org-mode-line-clock-overrun'."
257 (const :tag "Just mark the time string" nil)
258 (string :tag "Text to prepend")))
260 (defcustom org-show-notification-handler nil
261 "Function or program to send notification with.
262 The function or program will be called with the notification
267 (string :tag "Program")
268 (function :tag "Function")))
270 (defgroup org-clocktable nil
271 "Options concerning the clock table in Org-mode."
272 :tag "Org Clock Table"
275 (defcustom org-clocktable-defaults
278 :lang (or (org-bound-and-true-p org-export-default-language) "en")
298 "Default properties for clock tables."
303 (defcustom org-clock-clocktable-formatter 'org-clocktable-write-default
304 "Function to turn clocking data into a table.
305 For more information, see `org-clocktable-write-default'."
306 :group 'org-clocktable
310 ;; FIXME: translate es and nl last string "Clock summary at"
311 (defcustom org-clock-clocktable-language-setup
312 '(("en" "File" "L" "Timestamp" "Headline" "Time" "ALL" "Total time" "File time" "Clock summary at")
313 ("es" "Archivo" "N" "Fecha y hora" "Tarea" "Tiempo" "TODO" "Tiempo total" "Tiempo archivo" "Clock summary at")
314 ("fr" "Fichier" "N" "Horodatage" "En-tête" "Durée" "TOUT" "Durée totale" "Durée fichier" "Horodatage sommaire à")
315 ("nl" "Bestand" "N" "Tijdstip" "Hoofding" "Duur" "ALLES" "Totale duur" "Bestandstijd" "Clock summary at"))
316 "Terms used in clocktable, translated to different languages."
317 :group 'org-clocktable
321 (defcustom org-clock-clocktable-default-properties '(:maxlevel 2 :scope file)
322 "Default properties for new clocktables.
323 These will be inserted into the BEGIN line, to make it easy for users to
325 :group 'org-clocktable
328 (defcustom org-clock-idle-time nil
329 "When non-nil, resolve open clocks if the user is idle more than X minutes."
332 (const :tag "Never" nil)
333 (integer :tag "After N minutes")))
335 (defcustom org-clock-auto-clock-resolution 'when-no-clock-is-running
336 "When to automatically resolve open clocks found in Org buffers."
339 (const :tag "Never" nil)
340 (const :tag "Always" t)
341 (const :tag "When no clock is running" when-no-clock-is-running)))
343 (defcustom org-clock-report-include-clocking-task nil
344 "When non-nil, include the current clocking task time in clock reports."
349 (defcustom org-clock-resolve-expert nil
350 "Non-nil means do not show the splash buffer with the clock resolver."
355 (defcustom org-clock-continuously nil
356 "Non-nil means to start clocking from the last clock-out time, if any."
361 (defcustom org-clock-total-time-cell-format "*%s*"
362 "Format string for the total time cells."
367 (defcustom org-clock-file-time-cell-format "*%s*"
368 "Format string for the file time cells."
373 (defcustom org-clock-clocked-in-display 'mode-line
374 "When clocked in for a task, org-mode can display the current
375 task and accumulated time in the mode line and/or frame title.
378 both displays in both mode line and frame title
379 mode-line displays only in mode line (default)
380 frame-title displays only in frame title
381 nil current clock is not displayed"
384 (const :tag "Mode line" mode-line)
385 (const :tag "Frame title" frame-title)
386 (const :tag "Both" both)
387 (const :tag "None" nil)))
389 (defcustom org-clock-frame-title-format '(t org-mode-line-string)
390 "The value for `frame-title-format' when clocking in.
392 When `org-clock-clocked-in-display' is set to 'frame-title
393 or 'both, clocking in will replace `frame-title-format' with
394 this value. Clocking out will restore `frame-title-format'.
396 `org-frame-title-string' is a format string using the same
397 specifications than `frame-title-format', which see."
402 (defcustom org-clock-x11idle-program-name "x11idle"
403 "Name of the program which prints X11 idle time in milliseconds.
405 You can find x11idle.c in the contrib/scripts directory of the
406 Org git distribution. Or, you can do:
408 sudo apt-get install xprintidle
410 if you are using Debian."
413 :package-version '(Org . "8.0")
416 (defvar org-clock-in-prepare-hook nil
417 "Hook run when preparing the clock.
418 This hook is run before anything happens to the task that
419 you want to clock in. For example, you can use this hook
420 to add an effort property.")
421 (defvar org-clock-in-hook nil
422 "Hook run when starting the clock.")
423 (defvar org-clock-out-hook nil
424 "Hook run when stopping the current clock.")
426 (defvar org-clock-cancel-hook nil
427 "Hook run when cancelling the current clock.")
428 (defvar org-clock-goto-hook nil
429 "Hook run when selecting the currently clocked-in entry.")
430 (defvar org-clock-has-been-used nil
431 "Has the clock been used during the current Emacs session?")
433 ;;; The clock for measuring work time.
435 (defvar org-mode-line-string "")
436 (put 'org-mode-line-string 'risky-local-variable t)
438 (defvar org-clock-mode-line-timer nil)
439 (defvar org-clock-idle-timer nil)
440 (defvar org-clock-heading) ; defined in org.el
441 (defvar org-clock-start-time "")
443 (defvar org-clock-leftover-time nil
444 "If non-nil, user cancelled a clock; this is when leftover time started.")
446 (defvar org-clock-effort ""
447 "Effort estimate of the currently clocking task.")
449 (defvar org-clock-total-time nil
450 "Holds total time, spent previously on currently clocked item.
451 This does not include the time in the currently running clock.")
453 (defvar org-clock-history nil
454 "List of marker pointing to recent clocked tasks.")
456 (defvar org-clock-default-task (make-marker)
457 "Marker pointing to the default task that should clock time.
458 The clock can be made to switch to this task after clocking out
459 of a different task.")
461 (defvar org-clock-interrupted-task (make-marker)
462 "Marker pointing to the task that has been interrupted by the current clock.")
464 (defvar org-clock-mode-line-map (make-sparse-keymap))
465 (define-key org-clock-mode-line-map [mode-line mouse-2] 'org-clock-goto)
466 (define-key org-clock-mode-line-map [mode-line mouse-1] 'org-clock-menu)
468 (defun org-clock-menu ()
472 ["Clock out" org-clock-out t]
473 ["Change effort estimate" org-clock-modify-effort-estimate t]
474 ["Go to clock entry" org-clock-goto t]
475 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"])))
477 (defun org-clock-history-push (&optional pos buffer)
478 "Push a marker to the clock history."
479 (setq org-clock-history-length (max 1 (min 35 org-clock-history-length)))
480 (let ((m (move-marker (make-marker)
481 (or pos (point)) (org-base-buffer
482 (or buffer (current-buffer)))))
484 (while (setq n (member m org-clock-history))
485 (move-marker (car n) nil))
486 (setq org-clock-history
488 (mapcar (lambda (x) (if (marker-buffer x) x nil))
490 (when (>= (setq l (length org-clock-history)) org-clock-history-length)
491 (setq org-clock-history
493 (nthcdr (- l org-clock-history-length -1)
494 (nreverse org-clock-history)))))
495 (push m org-clock-history)))
497 (defun org-clock-save-markers-for-cut-and-paste (beg end)
498 "Save relative positions of markers in region."
499 (org-check-and-save-marker org-clock-marker beg end)
500 (org-check-and-save-marker org-clock-hd-marker beg end)
501 (org-check-and-save-marker org-clock-default-task beg end)
502 (org-check-and-save-marker org-clock-interrupted-task beg end)
503 (mapc (lambda (m) (org-check-and-save-marker m beg end))
506 (defun org-clocking-buffer ()
507 "Return the clocking buffer if we are currently clocking a task or nil."
508 (marker-buffer org-clock-marker))
510 (defun org-clocking-p ()
511 "Return t when clocking a task."
512 (not (equal (org-clocking-buffer) nil)))
514 (defvar org-clock-before-select-task-hook nil
515 "Hook called in task selection just before prompting the user.")
517 (defun org-clock-select-task (&optional prompt)
518 "Select a task that was recently associated with clocking."
520 (let (och chl sel-list rpl (i 0) s)
521 ;; Remove successive dups from the clock history to consider
522 (mapc (lambda (c) (if (not (equal c (car och))) (push c och)))
524 (setq och (reverse och) chl (length och))
526 (user-error "No recent clock")
527 (save-window-excursion
528 (org-switch-to-buffer-other-window
529 (get-buffer-create "*Clock Task Select*"))
531 (when (marker-buffer org-clock-default-task)
532 (insert (org-add-props "Default Task\n" nil 'face 'bold))
533 (setq s (org-clock-insert-selection-line ?d org-clock-default-task))
535 (when (marker-buffer org-clock-interrupted-task)
536 (insert (org-add-props "The task interrupted by starting the last one\n" nil 'face 'bold))
537 (setq s (org-clock-insert-selection-line ?i org-clock-interrupted-task))
539 (when (org-clocking-p)
540 (insert (org-add-props "Current Clocking Task\n" nil 'face 'bold))
541 (setq s (org-clock-insert-selection-line ?c org-clock-marker))
543 (insert (org-add-props "Recent Tasks\n" nil 'face 'bold))
546 (when (marker-buffer m)
548 s (org-clock-insert-selection-line
552 (if (fboundp 'int-to-char) (setf (car s) (int-to-char (car s))))
555 (run-hooks 'org-clock-before-select-task-hook)
556 (goto-char (point-min))
557 ;; Set min-height relatively to circumvent a possible but in
558 ;; `fit-window-to-buffer'
559 (fit-window-to-buffer nil nil (if (< chl 10) chl (+ 5 chl)))
560 (message (or prompt "Select task for clocking:"))
561 (setq cursor-type nil rpl (read-char-exclusive))
565 ((assoc rpl sel-list) (cdr (assoc rpl sel-list)))
566 (t (user-error "Invalid task choice %c" rpl)))))))
568 (defun org-clock-insert-selection-line (i marker)
569 "Insert a line for the clock selection menu.
570 And return a cons cell with the selection character integer and the marker
572 (when (marker-buffer marker)
573 (let (file cat task heading prefix)
574 (with-current-buffer (org-base-buffer (marker-buffer marker))
580 (setq file (buffer-file-name (marker-buffer marker))
581 cat (org-get-category)
582 heading (org-get-heading 'notags)
583 prefix (save-excursion
584 (org-back-to-heading t)
585 (looking-at org-outline-regexp)
588 (org-fontify-like-in-org-mode
589 (concat prefix heading)
591 (length prefix)))))))
593 (insert (format "[%c] %-12s %s\n" i cat task))
596 (defvar org-clock-task-overrun nil
597 "Internal flag indicating if the clock has overrun the planned time.")
598 (defvar org-clock-update-period 60
599 "Number of seconds between mode line clock string updates.")
601 (defun org-clock-get-clock-string ()
602 "Form a clock-string, that will be shown in the mode line.
603 If an effort estimate was defined for the current item, use
604 01:30/01:50 format (clocked/estimated).
605 If not, show simply the clocked time like 01:50."
606 (let ((clocked-time (org-clock-get-clocked-time)))
608 (let* ((effort-in-minutes
609 (org-duration-string-to-minutes org-clock-effort))
612 (org-minutes-to-clocksum-string clocked-time)
613 'face (if (and org-clock-task-overrun (not org-clock-task-overrun-text))
614 'org-mode-line-clock-overrun 'org-mode-line-clock)))
615 (effort-str (org-minutes-to-clocksum-string effort-in-minutes))
616 (clockstr (org-propertize
617 (concat " [%s/" effort-str
618 "] (" (replace-regexp-in-string "%" "%%" org-clock-heading) ")")
619 'face 'org-mode-line-clock)))
620 (format clockstr work-done-str))
621 (org-propertize (concat "[" (org-minutes-to-clocksum-string clocked-time)
622 (format " (%s)" org-clock-heading) "]")
623 'face 'org-mode-line-clock))))
625 (defun org-clock-get-last-clock-out-time ()
626 "Get the last clock-out time for the current subtree."
628 (let ((end (save-excursion (org-end-of-subtree))))
629 (when (re-search-forward (concat org-clock-string
630 ".*\\]--\\(\\[[^]]+\\]\\)") end t)
631 (org-time-string-to-time (match-string 1))))))
633 (defun org-clock-update-mode-line ()
635 (org-clock-notify-once-if-expired)
636 (setq org-clock-task-overrun nil))
637 (setq org-mode-line-string
639 (let ((clock-string (org-clock-get-clock-string))
640 (help-text "Org-mode clock is running.\nmouse-1 shows a menu\nmouse-2 will jump to task"))
641 (if (and (> org-clock-string-limit 0)
642 (> (length clock-string) org-clock-string-limit))
644 (substring clock-string 0 org-clock-string-limit)
645 'help-echo (concat help-text ": " org-clock-heading))
646 (org-propertize clock-string 'help-echo help-text)))
647 'local-map org-clock-mode-line-map
648 'mouse-face (if (featurep 'xemacs) 'highlight 'mode-line-highlight)))
649 (if (and org-clock-task-overrun org-clock-task-overrun-text)
650 (setq org-mode-line-string
651 (concat (org-propertize
652 org-clock-task-overrun-text
653 'face 'org-mode-line-clock-overrun) org-mode-line-string)))
654 (force-mode-line-update))
656 (defun org-clock-get-clocked-time ()
657 "Get the clocked time for the current item in minutes.
658 The time returned includes the time spent on this task in
659 previous clocking intervals."
660 (let ((currently-clocked-time
661 (floor (- (org-float-time)
662 (org-float-time org-clock-start-time)) 60)))
663 (+ currently-clocked-time (or org-clock-total-time 0))))
665 (defun org-clock-modify-effort-estimate (&optional value)
666 "Add to or set the effort estimate of the item currently being clocked.
667 VALUE can be a number of minutes, or a string with format hh:mm or mm.
668 When the string starts with a + or a - sign, the current value of the effort
669 property will be changed by that amount. If the effort value is expressed
670 as an `org-effort-durations' (e.g. \"3h\"), the modified value will be
671 converted to a hh:mm duration.
673 This command will update the \"Effort\" property of the currently
674 clocked item, and the value displayed in the mode line."
676 (if (org-clock-is-active)
677 (let ((current org-clock-effort) sign)
679 ;; Prompt user for a value or a change
682 (format "Set effort (hh:mm or mm%s): "
684 (format ", prefix + to add to %s" org-clock-effort)
686 (when (stringp value)
687 ;; A string. See if it is a delta
688 (setq sign (string-to-char value))
689 (if (member sign '(?- ?+))
690 (setq current (org-duration-string-to-minutes current)
691 value (substring value 1))
693 (setq value (org-duration-string-to-minutes value))
695 (setq value (- current value))
696 (if (equal ?+ sign) (setq value (+ current value)))))
697 (setq value (max 0 value)
698 org-clock-effort (org-minutes-to-clocksum-string value))
699 (org-entry-put org-clock-marker "Effort" org-clock-effort)
700 (org-clock-update-mode-line)
701 (message "Effort is now %s" org-clock-effort))
702 (message "Clock is not currently active")))
704 (defvar org-clock-notification-was-shown nil
705 "Shows if we have shown notification already.")
707 (defun org-clock-notify-once-if-expired ()
708 "Show notification if we spent more time than we estimated before.
709 Notification is shown only once."
710 (when (org-clocking-p)
711 (let ((effort-in-minutes (org-duration-string-to-minutes org-clock-effort))
712 (clocked-time (org-clock-get-clocked-time)))
713 (if (setq org-clock-task-overrun
714 (if (or (null effort-in-minutes) (zerop effort-in-minutes))
716 (>= clocked-time effort-in-minutes)))
717 (unless org-clock-notification-was-shown
718 (setq org-clock-notification-was-shown t)
720 (format "Task '%s' should be finished by now. (%s)"
721 org-clock-heading org-clock-effort) org-clock-sound))
722 (setq org-clock-notification-was-shown nil)))))
724 (defun org-notify (notification &optional play-sound)
725 "Send a NOTIFICATION and maybe PLAY-SOUND.
726 If PLAY-SOUND is non-nil, it overrides `org-clock-sound'."
727 (org-show-notification notification)
728 (if play-sound (org-clock-play-sound play-sound)))
730 (defun org-show-notification (notification)
732 Use `org-show-notification-handler' if defined,
733 use libnotify if available, or fall back on a message."
734 (cond ((functionp org-show-notification-handler)
735 (funcall org-show-notification-handler notification))
736 ((stringp org-show-notification-handler)
737 (start-process "emacs-timer-notification" nil
738 org-show-notification-handler notification))
739 ((fboundp 'notifications-notify)
740 (notifications-notify
741 :title "Org-mode message"
743 ;; FIXME how to link to the Org icon?
744 ;; :app-icon "~/.emacs.d/icons/mail.png"
746 ((executable-find "notify-send")
747 (start-process "emacs-timer-notification" nil
748 "notify-send" notification))
749 ;; Maybe the handler will send a message, so only use message as
750 ;; a fall back option
751 (t (message "%s" notification))))
753 (defun org-clock-play-sound (&optional clock-sound)
754 "Play sound as configured by `org-clock-sound'.
755 Use alsa's aplay tool if available.
756 If CLOCK-SOUND is non-nil, it overrides `org-clock-sound'."
757 (let ((org-clock-sound (or clock-sound org-clock-sound)))
759 ((not org-clock-sound))
760 ((eq org-clock-sound t) (beep t) (beep t))
761 ((stringp org-clock-sound)
762 (let ((file (expand-file-name org-clock-sound)))
763 (if (file-exists-p file)
764 (if (executable-find "aplay")
765 (start-process "org-clock-play-notification" nil
768 (play-sound-file file)
769 (error (beep t) (beep t))))))))))
771 (defvar org-clock-mode-line-entry nil
772 "Information for the mode line about the running clock.")
774 (defun org-find-open-clocks (file)
775 "Search through the given file and find all open clocks."
776 (let ((buf (or (get-file-buffer file)
777 (find-file-noselect file)))
779 (with-current-buffer buf
781 (goto-char (point-min))
782 (while (re-search-forward "CLOCK: \\(\\[.*?\\]\\)$" nil t)
783 (push (cons (copy-marker (match-end 1) t)
784 (org-time-string-to-time (match-string 1))) clocks))))
787 (defsubst org-is-active-clock (clock)
788 "Return t if CLOCK is the currently active clock."
789 (and (org-clock-is-active)
790 (= org-clock-marker (car clock))))
792 (defmacro org-with-clock-position (clock &rest forms)
793 "Evaluate FORMS with CLOCK as the current active clock."
794 `(with-current-buffer (marker-buffer (car ,clock))
798 (goto-char (car ,clock))
801 (def-edebug-spec org-with-clock-position (form body))
802 (put 'org-with-clock-position 'lisp-indent-function 1)
804 (defmacro org-with-clock (clock &rest forms)
805 "Evaluate FORMS with CLOCK as the current active clock.
806 This macro also protects the current active clock from being altered."
807 `(org-with-clock-position ,clock
808 (let ((org-clock-start-time (cdr ,clock))
809 (org-clock-total-time)
812 (org-clock-marker (car ,clock))
813 (org-clock-hd-marker (save-excursion
814 (outline-back-to-heading t)
817 (def-edebug-spec org-with-clock (form body))
818 (put 'org-with-clock 'lisp-indent-function 1)
820 (defsubst org-clock-clock-in (clock &optional resume start-time)
821 "Clock in to the clock located by CLOCK.
822 If necessary, clock-out of the currently active clock."
823 (org-with-clock-position clock
824 (let ((org-clock-in-resume (or resume org-clock-in-resume)))
825 (org-clock-in nil start-time))))
827 (defsubst org-clock-clock-out (clock &optional fail-quietly at-time)
828 "Clock out of the clock located by CLOCK."
829 (let ((temp (copy-marker (car clock)
830 (marker-insertion-type (car clock)))))
831 (if (org-is-active-clock clock)
832 (org-clock-out nil fail-quietly at-time)
833 (org-with-clock clock
834 (org-clock-out nil fail-quietly at-time)))
835 (setcar clock temp)))
837 (defsubst org-clock-clock-cancel (clock)
838 "Cancel the clock located by CLOCK."
839 (let ((temp (copy-marker (car clock)
840 (marker-insertion-type (car clock)))))
841 (if (org-is-active-clock clock)
843 (org-with-clock clock
845 (setcar clock temp)))
847 (defvar org-clock-clocking-in nil)
848 (defvar org-clock-resolving-clocks nil)
849 (defvar org-clock-resolving-clocks-due-to-idleness nil)
851 (defun org-clock-resolve-clock (clock resolve-to clock-out-time
852 &optional close-p restart-p fail-quietly)
853 "Resolve `CLOCK' given the time `RESOLVE-TO', and the present.
854 `CLOCK' is a cons cell of the form (MARKER START-TIME)."
855 (let ((org-clock-resolving-clocks t))
858 (org-clock-clock-cancel clock)
859 (if (and restart-p (not org-clock-clocking-in))
860 (org-clock-clock-in clock)))
862 ((eq resolve-to 'now)
864 (error "RESTART-P is not valid here"))
865 (if (or close-p org-clock-clocking-in)
866 (org-clock-clock-out clock fail-quietly)
867 (unless (org-is-active-clock clock)
868 (org-clock-clock-in clock t))))
870 ((not (time-less-p resolve-to (current-time)))
871 (error "RESOLVE-TO must refer to a time in the past"))
875 (error "RESTART-P is not valid here"))
876 (org-clock-clock-out clock fail-quietly (or clock-out-time
878 (unless org-clock-clocking-in
880 (setq org-clock-leftover-time (and (null clock-out-time)
882 (org-clock-clock-in clock nil (and clock-out-time
885 (defun org-clock-jump-to-current-clock (&optional effective-clock)
887 (let ((org-clock-into-drawer (org-clock-into-drawer))
888 (clock (or effective-clock (cons org-clock-marker
889 org-clock-start-time))))
890 (unless (marker-buffer (car clock))
891 (error "No clock is currently running"))
892 (org-with-clock clock (org-clock-goto))
893 (with-current-buffer (marker-buffer (car clock))
894 (goto-char (car clock))
895 (if org-clock-into-drawer
897 (if (stringp org-clock-into-drawer)
898 (concat ":" org-clock-into-drawer ":")
903 (outline-back-to-heading t)
904 (search-forward logbook)
905 (goto-char (match-beginning 0)))
907 (outline-back-to-heading t)
908 (search-forward logbook)
909 (search-forward ":END:")
910 (goto-char (match-end 0)))
913 (defun org-clock-resolve (clock &optional prompt-fn last-valid fail-quietly)
914 "Resolve an open org-mode clock.
915 An open clock was found, with `dangling' possibly being non-nil.
916 If this function was invoked with a prefix argument, non-dangling
917 open clocks are ignored. The given clock requires some sort of
918 user intervention to resolve it, either because a clock was left
919 dangling or due to an idle timeout. The clock resolution can
922 (a) deleted, the user doesn't care about the clock
923 (b) restarted from the current time (if no other clock is open)
924 (c) closed, giving the clock X minutes
925 (d) closed and then restarted
926 (e) resumed, as if the user had never left
928 The format of clock is (CONS MARKER START-TIME), where MARKER
929 identifies the buffer and position the clock is open at (and
930 thus, the heading it's under), and START-TIME is when the clock
934 (save-window-excursion
936 (unless org-clock-resolving-clocks-due-to-idleness
937 (org-clock-jump-to-current-clock clock))
938 (unless org-clock-resolve-expert
939 (with-output-to-temp-buffer "*Org Clock*"
940 (princ "Select a Clock Resolution Command:
942 i/q Ignore this question; the same as keeping all the idle time.
944 k/K Keep X minutes of the idle time (default is all). If this
945 amount is less than the default, you will be clocked out
946 that many minutes after the time that idling began, and then
947 clocked back in at the present time.
949 g/G Indicate that you \"got back\" X minutes ago. This is quite
950 different from 'k': it clocks you out from the beginning of
951 the idle period and clock you back in X minutes ago.
953 s/S Subtract the idle time from the current clock. This is the
954 same as keeping 0 minutes.
956 C Cancel the open timer altogether. It will be as though you
959 j/J Jump to the current clock, to make manual adjustments.
961 For all these options, using uppercase makes your final state
962 to be CLOCKED OUT.")))
963 (org-fit-window-to-buffer (get-buffer-window "*Org Clock*"))
965 (when (featurep 'xemacs)
966 (message (concat (funcall prompt-fn clock)
968 (setq char-pressed (read-char-exclusive)))
969 (while (or (null char-pressed)
970 (and (not (memq char-pressed
971 '(?k ?K ?g ?G ?s ?S ?C
975 (read-char (concat (funcall prompt-fn clock)
978 (and (not (memq char-pressed '(?i ?q))) char-pressed)))))
980 (floor (/ (org-float-time
981 (time-subtract (current-time) last-valid)) 60)))
983 (and (memq ch '(?k ?K))
984 (read-number "Keep how many minutes? " default)))
986 (and (memq ch '(?g ?G))
987 (read-number "Got back how many minutes ago? " default)))
988 (subtractp (memq ch '(?s ?S)))
989 (barely-started-p (< (- (org-float-time last-valid)
990 (org-float-time (cdr clock))) 45))
991 (start-over (and subtractp barely-started-p)))
995 (org-clock-resolve-clock clock 'now nil t nil fail-quietly))
996 (org-clock-jump-to-current-clock clock))
998 (not (memq ch '(?k ?K ?g ?G ?s ?S ?C))))
1001 (org-clock-resolve-clock
1004 ;; If the time on the clock was less than a minute before
1005 ;; the user went away, and they've ask to subtract all the
1010 (and gotback (= gotback 0)))
1012 ((or (and keep (= keep default))
1013 (and gotback (= gotback default)))
1016 (time-add last-valid (seconds-to-time (* 60 keep))))
1018 (time-subtract (current-time)
1019 (seconds-to-time (* 60 gotback))))
1021 (error "Unexpected, please report this as a bug")))
1022 (and gotback last-valid)
1023 (memq ch '(?K ?G ?S))
1025 (not (memq ch '(?K ?G ?S ?C))))
1029 (defun org-resolve-clocks (&optional only-dangling-p prompt-fn last-valid)
1030 "Resolve all currently open org-mode clocks.
1031 If `only-dangling-p' is non-nil, only ask to resolve dangling
1032 \(i.e., not currently open and valid) clocks."
1034 (unless org-clock-resolving-clocks
1035 (let ((org-clock-resolving-clocks t))
1036 (dolist (file (org-files-list))
1037 (let ((clocks (org-find-open-clocks file)))
1038 (dolist (clock clocks)
1039 (let ((dangling (or (not (org-clock-is-active))
1040 (/= (car clock) org-clock-marker))))
1041 (if (or (not only-dangling-p) dangling)
1048 "Dangling clock started %d mins ago"
1050 (/ (- (org-float-time (current-time))
1051 (org-float-time (cdr clock))) 60))))))
1053 (cdr clock)))))))))))
1055 (defun org-emacs-idle-seconds ()
1056 "Return the current Emacs idle time in seconds, or nil if not idle."
1057 (let ((idle-time (current-idle-time)))
1059 (org-float-time idle-time)
1062 (defun org-mac-idle-seconds ()
1063 "Return the current Mac idle time in seconds."
1064 (string-to-number (shell-command-to-string "ioreg -c IOHIDSystem | perl -ane 'if (/Idle/) {$idle=(pop @F)/1000000000; print $idle; last}'")))
1066 (defvar org-x11idle-exists-p
1067 ;; Check that x11idle exists
1068 (and (eq window-system 'x)
1069 (eq (call-process-shell-command "command" nil nil nil "-v" org-clock-x11idle-program-name) 0)
1070 ;; Check that x11idle can retrieve the idle time
1071 (eq (call-process-shell-command org-clock-x11idle-program-name nil nil nil) 0)))
1073 (defun org-x11-idle-seconds ()
1074 "Return the current X11 idle time in seconds."
1075 (/ (string-to-number (shell-command-to-string org-clock-x11idle-program-name)) 1000))
1077 (defun org-user-idle-seconds ()
1078 "Return the number of seconds the user has been idle for.
1079 This routine returns a floating point number."
1081 ((eq system-type 'darwin)
1082 (org-mac-idle-seconds))
1083 ((and (eq window-system 'x) org-x11idle-exists-p)
1084 (org-x11-idle-seconds))
1086 (org-emacs-idle-seconds))))
1088 (defvar org-clock-user-idle-seconds)
1090 (defun org-resolve-clocks-if-idle ()
1091 "Resolve all currently open org-mode clocks.
1092 This is performed after `org-clock-idle-time' minutes, to check
1093 if the user really wants to stay clocked in after being idle for
1095 (when (and org-clock-idle-time (not org-clock-resolving-clocks)
1096 org-clock-marker (marker-buffer org-clock-marker))
1097 (let* ((org-clock-user-idle-seconds (org-user-idle-seconds))
1098 (org-clock-user-idle-start
1099 (time-subtract (current-time)
1100 (seconds-to-time org-clock-user-idle-seconds)))
1101 (org-clock-resolving-clocks-due-to-idleness t))
1102 (if (> org-clock-user-idle-seconds (* 60 org-clock-idle-time))
1104 (cons org-clock-marker
1105 org-clock-start-time)
1108 (format "Clocked in & idle for %.1f mins"
1110 (time-subtract (current-time)
1111 org-clock-user-idle-start))
1113 org-clock-user-idle-start)))))
1115 (defvar org-clock-current-task nil "Task currently clocked in.")
1116 (defvar org-clock-out-time nil) ; store the time of the last clock-out
1117 (defvar org--msg-extra)
1120 (defun org-clock-in (&optional select start-time)
1121 "Start the clock on the current item.
1122 If necessary, clock-out of the currently active clock.
1123 With a prefix argument SELECT (\\[universal-argument]), offer a list of recently clocked
1124 tasks to clock into. When SELECT is \\[universal-argument] \\[universal-argument], clock into the current task
1125 and mark it as the default task, a special task that will always be offered
1126 in the clocking selection, associated with the letter `d'.
1127 When SELECT is \\[universal-argument] \\[universal-argument] \\[universal-argument], \
1128 clock in by using the last clock-out
1129 time as the start time \(see `org-clock-continuously' to
1130 make this the default behavior.)"
1132 (setq org-clock-notification-was-shown nil)
1133 (org-refresh-properties org-effort-property 'org-effort)
1135 (let ((interrupting (and (not org-clock-resolving-clocks-due-to-idleness)
1137 ts selected-task target-pos (org--msg-extra "")
1138 (leftover (and (not org-clock-resolving-clocks)
1139 org-clock-leftover-time)))
1141 (when (and org-clock-auto-clock-resolution
1142 (or (not interrupting)
1143 (eq t org-clock-auto-clock-resolution))
1144 (not org-clock-clocking-in)
1145 (not org-clock-resolving-clocks))
1146 (setq org-clock-leftover-time nil)
1147 (let ((org-clock-clocking-in t))
1148 (org-resolve-clocks))) ; check if any clocks are dangling
1150 (when (equal select '(64))
1151 ;; Set start-time to `org-clock-out-time'
1152 (let ((org-clock-continuously t))
1153 (org-clock-in nil org-clock-out-time)))
1155 (when (equal select '(4))
1156 (setq selected-task (org-clock-select-task "Clock-in on task: "))
1158 (setq selected-task (copy-marker selected-task))
1161 (when (equal select '(16))
1162 ;; Mark as default clocking task
1163 (org-clock-mark-default-task))
1166 ;; We are interrupting the clocking of a different task.
1167 ;; Save a marker to this task, so that we can go back.
1168 ;; First check if we are trying to clock into the same task!
1169 (when (save-excursion
1170 (unless selected-task
1171 (org-back-to-heading t))
1172 (and (equal (marker-buffer org-clock-hd-marker)
1174 (marker-buffer selected-task)
1176 (= (marker-position org-clock-hd-marker)
1178 (marker-position selected-task)
1180 (equal org-clock-current-task (nth 4 (org-heading-components)))))
1181 (message "Clock continues in \"%s\"" org-clock-heading)
1183 (move-marker org-clock-interrupted-task
1184 (marker-position org-clock-marker)
1185 (marker-buffer org-clock-marker))
1186 (let ((org-clock-clocking-in t))
1187 (org-clock-out nil t)))
1189 ;; Clock in at which position?
1191 (if (and (eobp) (not (org-at-heading-p)))
1195 (when (and selected-task (marker-buffer selected-task))
1196 ;; There is a selected task, move to the correct buffer
1197 ;; and set the new target position.
1198 (set-buffer (org-base-buffer (marker-buffer selected-task)))
1199 (setq target-pos (marker-position selected-task))
1200 (move-marker selected-task nil))
1204 (goto-char target-pos)
1205 (org-back-to-heading t)
1206 (or interrupting (move-marker org-clock-interrupted-task nil))
1207 (run-hooks 'org-clock-in-prepare-hook)
1208 (org-clock-history-push)
1209 (setq org-clock-current-task (nth 4 (org-heading-components)))
1210 (cond ((functionp org-clock-in-switch-to-state)
1211 (looking-at org-complex-heading-regexp)
1212 (let ((newstate (funcall org-clock-in-switch-to-state
1214 (if newstate (org-todo newstate))))
1215 ((and org-clock-in-switch-to-state
1216 (not (looking-at (concat org-outline-regexp "[ \t]*"
1217 org-clock-in-switch-to-state
1219 (org-todo org-clock-in-switch-to-state)))
1220 (setq org-clock-heading
1221 (cond ((and org-clock-heading-function
1222 (functionp org-clock-heading-function))
1223 (funcall org-clock-heading-function))
1224 ((nth 4 (org-heading-components))
1225 (replace-regexp-in-string
1226 "\\[\\[.*?\\]\\[\\(.*?\\)\\]\\]" "\\1"
1227 (match-string-no-properties 4)))
1229 (org-clock-find-position org-clock-in-resume)
1231 ((and org-clock-in-resume
1233 (concat "^[ \t]*" org-clock-string
1234 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1235 " *\\sw+\.? +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
1236 (message "Matched %s" (match-string 1))
1237 (setq ts (concat "[" (match-string 1) "]"))
1238 (goto-char (match-end 1))
1239 (setq org-clock-start-time
1241 (org-parse-time-string (match-string 1))))
1242 (setq org-clock-effort (org-entry-get (point) org-effort-property))
1243 (setq org-clock-total-time (org-clock-sum-current-item
1244 (org-clock-get-sum-start))))
1245 ((eq org-clock-in-resume 'auto-restart)
1246 ;; called from org-clock-load during startup,
1247 ;; do not interrupt, but warn!
1248 (message "Cannot restart clock because task does not contain unfinished clock")
1253 (insert-before-markers "\n")
1256 (when (and (save-excursion
1259 (beginning-of-line 1)
1260 (org-indent-line-to (- (org-get-indentation) 2)))
1261 (insert org-clock-string " ")
1262 (setq org-clock-effort (org-entry-get (point) org-effort-property))
1263 (setq org-clock-total-time (org-clock-sum-current-item
1264 (org-clock-get-sum-start)))
1265 (setq org-clock-start-time
1266 (or (and org-clock-continuously org-clock-out-time)
1270 "You stopped another clock %d mins ago; start this one from then? "
1271 (/ (- (org-float-time
1272 (org-current-time org-clock-rounding-minutes t))
1273 (org-float-time leftover)) 60)))
1276 (org-current-time org-clock-rounding-minutes t)))
1277 (setq ts (org-insert-time-stamp org-clock-start-time
1278 'with-hm 'inactive))))
1279 (move-marker org-clock-marker (point) (buffer-base-buffer))
1280 (move-marker org-clock-hd-marker
1281 (save-excursion (org-back-to-heading t) (point))
1282 (buffer-base-buffer))
1283 (setq org-clock-has-been-used t)
1285 (when (or (eq org-clock-clocked-in-display 'mode-line)
1286 (eq org-clock-clocked-in-display 'both))
1287 (or global-mode-string (setq global-mode-string '("")))
1288 (or (memq 'org-mode-line-string global-mode-string)
1289 (setq global-mode-string
1290 (append global-mode-string '(org-mode-line-string)))))
1291 ;; add to frame title
1292 (when (or (eq org-clock-clocked-in-display 'frame-title)
1293 (eq org-clock-clocked-in-display 'both))
1294 (setq frame-title-format org-clock-frame-title-format))
1295 (org-clock-update-mode-line)
1296 (when org-clock-mode-line-timer
1297 (cancel-timer org-clock-mode-line-timer)
1298 (setq org-clock-mode-line-timer nil))
1299 (when org-clock-clocked-in-display
1300 (setq org-clock-mode-line-timer
1301 (run-with-timer org-clock-update-period
1302 org-clock-update-period
1303 'org-clock-update-mode-line)))
1304 (when org-clock-idle-timer
1305 (cancel-timer org-clock-idle-timer)
1306 (setq org-clock-idle-timer nil))
1307 (setq org-clock-idle-timer
1308 (run-with-timer 60 60 'org-resolve-clocks-if-idle))
1309 (message "Clock starts at %s - %s" ts org--msg-extra)
1310 (run-hooks 'org-clock-in-hook)))))))
1313 (defun org-clock-in-last (&optional arg)
1314 "Clock in the last closed clocked item.
1315 When already clocking in, send an warning.
1316 With a universal prefix argument, select the task you want to
1317 clock in from the last clocked in tasks.
1318 With two universal prefix arguments, start clocking using the
1319 last clock-out time, if any.
1320 With three universal prefix arguments, interactively prompt
1321 for a todo state to switch to, overriding the existing value
1322 `org-clock-in-switch-to-state'."
1324 (if (equal arg '(4))
1325 (org-clock-in (org-clock-select-task))
1326 (let ((start-time (if (or org-clock-continuously (equal arg '(16)))
1327 (or org-clock-out-time
1328 (org-current-time org-clock-rounding-minutes t))
1329 (org-current-time org-clock-rounding-minutes t))))
1330 (if (null org-clock-history)
1331 (message "No last clock")
1332 (let ((org-clock-in-switch-to-state
1333 (if (and (not org-clock-current-task) (equal arg '(64)))
1334 (completing-read "Switch to state: "
1335 (and org-clock-history
1336 (with-current-buffer
1337 (marker-buffer (car org-clock-history))
1338 org-todo-keywords-1)))
1339 org-clock-in-switch-to-state))
1340 (already-clocking org-clock-current-task))
1341 (org-clock-clock-in (list (car org-clock-history)) nil start-time)
1342 (or already-clocking
1343 ;; Don't display a message if we are already clocking in
1344 (message "Clocking back: %s (in %s)"
1345 org-clock-current-task
1346 (buffer-name (marker-buffer org-clock-marker)))))))))
1348 (defun org-clock-mark-default-task ()
1349 "Mark current task as default task."
1352 (org-back-to-heading t)
1353 (move-marker org-clock-default-task (point))))
1355 (defun org-clock-get-sum-start ()
1356 "Return the time from which clock times should be counted.
1357 This is for the currently running clock as it is displayed
1358 in the mode line. This function looks at the properties
1359 LAST_REPEAT and in particular CLOCK_MODELINE_TOTAL and the
1360 corresponding variable `org-clock-mode-line-total' and then
1361 decides which time to use."
1362 (let ((cmt (or (org-entry-get nil "CLOCK_MODELINE_TOTAL")
1363 (symbol-name org-clock-mode-line-total)))
1364 (lr (org-entry-get nil "LAST_REPEAT")))
1366 ((equal cmt "current")
1367 (setq org--msg-extra "showing time in current clock instance")
1369 ((equal cmt "today")
1370 (setq org--msg-extra "showing today's task time.")
1371 (let* ((dt (decode-time (current-time))))
1372 (setq dt (append (list 0 0 0) (nthcdr 3 dt)))
1373 (if org-extend-today-until
1374 (setf (nth 2 dt) org-extend-today-until))
1375 (apply 'encode-time dt)))
1376 ((or (equal cmt "all")
1377 (and (or (not cmt) (equal cmt "auto"))
1379 (setq org--msg-extra "showing entire task time.")
1381 ((or (equal cmt "repeat")
1382 (and (or (not cmt) (equal cmt "auto"))
1384 (setq org--msg-extra "showing task time since last repeat.")
1387 (org-time-string-to-time lr)))
1390 (defun org-clock-find-position (find-unclosed)
1391 "Find the location where the next clock line should be inserted.
1392 When FIND-UNCLOSED is non-nil, first check if there is an unclosed clock
1393 line and position cursor in that line."
1394 (org-back-to-heading t)
1396 (let* ((org-clock-into-drawer (org-clock-into-drawer))
1397 (beg (save-excursion
1398 (beginning-of-line 2)
1399 (or (bolp) (newline))
1401 (end (progn (outline-next-heading) (point)))
1402 (re (concat "^[ \t]*" org-clock-string))
1404 (drawer (if (stringp org-clock-into-drawer)
1405 org-clock-into-drawer "LOGBOOK"))
1406 first last ind-last)
1408 (when (and find-unclosed
1410 (concat "^[ \t]*" org-clock-string
1411 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1412 " *\\sw+ +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")
1414 (beginning-of-line 1)
1416 (when (eobp) (newline) (setq end (max (point) end)))
1417 (when (re-search-forward (concat "^[ \t]*:" drawer ":") end t)
1418 ;; we seem to have a CLOCK drawer, so go there.
1419 (beginning-of-line 2)
1420 (or org-log-states-order-reversed
1421 (and (re-search-forward org-property-end-re nil t)
1422 (goto-char (match-beginning 0))))
1424 ;; Lets count the CLOCK lines
1426 (while (re-search-forward re end t)
1427 (setq first (or first (match-beginning 0))
1428 last (match-beginning 0)
1430 (when (and (integerp org-clock-into-drawer)
1432 (>= (1+ cnt) org-clock-into-drawer))
1433 ;; Wrap current entries into a new drawer
1435 (setq ind-last (org-get-indentation))
1436 (beginning-of-line 2)
1437 (if (and (>= (org-get-indentation) ind-last)
1439 (when (and (>= (org-get-indentation) ind-last)
1441 (let ((struct (org-list-struct)))
1442 (goto-char (org-list-get-bottom-point struct)))))
1444 (beginning-of-line 0)
1445 (org-indent-line-to ind-last)
1447 (insert ":" drawer ":\n")
1448 (beginning-of-line 0)
1451 (beginning-of-line 2)
1452 (or org-log-states-order-reversed
1453 (and (re-search-forward org-property-end-re nil t)
1454 (goto-char (match-beginning 0))))
1458 (while (and (looking-at (concat "[ \t]*" org-keyword-time-regexp))
1459 (not (equal (match-string 1) org-clock-string)))
1460 ;; Planning info, skip to after it
1461 (beginning-of-line 2)
1462 (or (bolp) (newline)))
1463 (when (or (eq org-clock-into-drawer t)
1464 (stringp org-clock-into-drawer)
1465 (and (integerp org-clock-into-drawer)
1466 (< org-clock-into-drawer 2)))
1467 (insert ":" drawer ":\n:END:\n")
1468 (beginning-of-line -1)
1471 (beginning-of-line 2)
1474 (or org-log-states-order-reversed
1475 (and (re-search-forward org-property-end-re nil t)
1476 (goto-char (match-beginning 0))))))))
1479 (defun org-clock-out (&optional switch-to-state fail-quietly at-time)
1480 "Stop the currently running clock.
1481 Throw an error if there is no running clock and FAIL-QUIETLY is nil.
1482 With a universal prefix, prompt for a state to switch the clocked out task
1483 to, overriding the existing value of `org-clock-out-switch-to-state'."
1486 (when (not (org-clocking-p))
1487 (setq global-mode-string
1488 (delq 'org-mode-line-string global-mode-string))
1489 (setq frame-title-format org-frame-title-format-backup)
1490 (force-mode-line-update)
1491 (if fail-quietly (throw 'exit t) (user-error "No active clock")))
1492 (let ((org-clock-out-switch-to-state
1494 (completing-read "Switch to state: "
1495 (with-current-buffer
1496 (marker-buffer org-clock-marker)
1497 org-todo-keywords-1)
1499 org-clock-out-switch-to-state))
1500 (now (org-current-time org-clock-rounding-minutes))
1502 (setq org-clock-out-time now)
1503 (save-excursion ; Do not replace this with `with-current-buffer'.
1504 (org-no-warnings (set-buffer (org-clocking-buffer)))
1507 (goto-char org-clock-marker)
1508 (beginning-of-line 1)
1509 (if (and (looking-at (concat "[ \t]*" org-keyword-time-regexp))
1510 (equal (match-string 1) org-clock-string))
1511 (setq ts (match-string 2))
1512 (if fail-quietly (throw 'exit nil) (error "Clock start time is gone")))
1513 (goto-char (match-end 0))
1514 (delete-region (point) (point-at-eol))
1516 (setq te (org-insert-time-stamp (or at-time now) 'with-hm 'inactive))
1517 (setq s (- (org-float-time (apply 'encode-time (org-parse-time-string te)))
1518 (org-float-time (apply 'encode-time (org-parse-time-string ts))))
1519 h (floor (/ s 3600))
1523 (insert " => " (format "%2d:%02d" h m))
1524 (when (setq remove (and org-clock-out-remove-zero-time-clocks
1526 (beginning-of-line 1)
1527 (delete-region (point) (point-at-eol))
1528 (and (looking-at "\n") (> (point-max) (1+ (point)))
1530 (move-marker org-clock-marker nil)
1531 (move-marker org-clock-hd-marker nil)
1532 (when org-log-note-clock-out
1533 (org-add-log-setup 'clock-out nil nil nil nil
1534 (concat "# Task: " (org-get-heading t) "\n\n")))
1535 (when org-clock-mode-line-timer
1536 (cancel-timer org-clock-mode-line-timer)
1537 (setq org-clock-mode-line-timer nil))
1538 (when org-clock-idle-timer
1539 (cancel-timer org-clock-idle-timer)
1540 (setq org-clock-idle-timer nil))
1541 (setq global-mode-string
1542 (delq 'org-mode-line-string global-mode-string))
1543 (setq frame-title-format org-frame-title-format-backup)
1544 (when org-clock-out-switch-to-state
1546 (org-back-to-heading t)
1547 (let ((org-inhibit-logging t)
1548 (org-clock-out-when-done nil))
1550 ((functionp org-clock-out-switch-to-state)
1551 (looking-at org-complex-heading-regexp)
1552 (let ((newstate (funcall org-clock-out-switch-to-state
1554 (if newstate (org-todo newstate))))
1555 ((and org-clock-out-switch-to-state
1556 (not (looking-at (concat org-outline-regexp "[ \t]*"
1557 org-clock-out-switch-to-state
1559 (org-todo org-clock-out-switch-to-state))))))
1560 (force-mode-line-update)
1561 (message (concat "Clock stopped at %s after "
1562 (org-minutes-to-clocksum-string (+ (* 60 h) m)) "%s")
1563 te (if remove " => LINE REMOVED" ""))
1564 (let ((h org-clock-out-hook))
1565 ;; If a closing note needs to be stored in the drawer
1566 ;; where clocks are stored, let's temporarily disable
1567 ;; `org-clock-remove-empty-clock-drawer'
1568 (if (and (equal org-clock-into-drawer org-log-into-drawer)
1569 (eq org-log-done 'note)
1570 org-clock-out-when-done)
1571 (setq h (delq 'org-clock-remove-empty-clock-drawer h)))
1572 (mapc (lambda (f) (funcall f)) h))
1573 (unless (org-clocking-p)
1574 (setq org-clock-current-task nil)))))))
1576 (add-hook 'org-clock-out-hook 'org-clock-remove-empty-clock-drawer)
1578 (defun org-clock-remove-empty-clock-drawer nil
1579 "Remove empty clock drawer in the current subtree."
1580 (let* ((olid (or (org-entry-get (point) "LOG_INTO_DRAWER")
1581 org-log-into-drawer))
1582 (clock-drawer (if (eq t olid) "LOGBOOK" olid))
1583 (end (save-excursion (org-end-of-subtree t t))))
1586 (org-back-to-heading t)
1587 (while (and (< (point) end)
1588 (search-forward clock-drawer end t))
1589 (goto-char (match-beginning 0))
1590 (org-remove-empty-drawer-at clock-drawer (point))
1591 (forward-line 1))))))
1593 (defun org-clock-timestamps-up (&optional n)
1594 "Increase CLOCK timestamps at cursor.
1595 Optional argument N tells to change by that many units."
1597 (org-clock-timestamps-change 'up n))
1599 (defun org-clock-timestamps-down (&optional n)
1600 "Increase CLOCK timestamps at cursor.
1601 Optional argument N tells to change by that many units."
1603 (org-clock-timestamps-change 'down n))
1605 (defun org-clock-timestamps-change (updown &optional n)
1606 "Change CLOCK timestamps synchronously at cursor.
1607 UPDOWN tells whether to change 'up or 'down.
1608 Optional argument N tells to change by that many units."
1609 (setq org-ts-what nil)
1610 (when (org-at-timestamp-p t)
1611 (let ((tschange (if (eq updown 'up) 'org-timestamp-up
1612 'org-timestamp-down))
1613 ts1 begts1 ts2 begts2 updatets1 tdiff)
1615 (move-beginning-of-line 1)
1616 (re-search-forward org-ts-regexp3 nil t)
1617 (setq ts1 (match-string 0) begts1 (match-beginning 0))
1618 (when (re-search-forward org-ts-regexp3 nil t)
1619 (setq ts2 (match-string 0) begts2 (match-beginning 0))))
1620 ;; Are we on the second timestamp?
1621 (if (<= begts2 (point)) (setq updatets1 t))
1623 ;; fall back on org-timestamp-up if there is only one
1624 (funcall tschange n)
1625 ;; setq this so that (boundp 'org-ts-what is non-nil)
1626 (funcall tschange n)
1627 (let ((ts (if updatets1 ts2 ts1))
1628 (begts (if updatets1 begts1 begts2)))
1631 (org-time-string-to-time org-last-changed-timestamp)
1632 (org-time-string-to-time ts)))
1635 (org-timestamp-change
1636 (round (/ (org-float-time tdiff)
1637 (cond ((eq org-ts-what 'minute) 60)
1638 ((eq org-ts-what 'hour) 3600)
1639 ((eq org-ts-what 'day) (* 24 3600))
1640 ((eq org-ts-what 'month) (* 24 3600 31))
1641 ((eq org-ts-what 'year) (* 24 3600 365.2)))))
1642 org-ts-what 'updown)))))))
1645 (defun org-clock-cancel ()
1646 "Cancel the running clock by removing the start timestamp."
1648 (when (not (org-clocking-p))
1649 (setq global-mode-string
1650 (delq 'org-mode-line-string global-mode-string))
1651 (setq frame-title-format org-frame-title-format-backup)
1652 (force-mode-line-update)
1653 (error "No active clock"))
1654 (save-excursion ; Do not replace this with `with-current-buffer'.
1655 (org-no-warnings (set-buffer (org-clocking-buffer)))
1656 (goto-char org-clock-marker)
1657 (if (org-looking-back (concat "^[ \t]*" org-clock-string ".*"))
1658 (progn (delete-region (1- (point-at-bol)) (point-at-eol))
1659 (org-remove-empty-drawer-at "LOGBOOK" (point)))
1660 (message "Clock gone, cancel the timer anyway")
1662 (move-marker org-clock-marker nil)
1663 (move-marker org-clock-hd-marker nil)
1664 (setq global-mode-string
1665 (delq 'org-mode-line-string global-mode-string))
1666 (setq frame-title-format org-frame-title-format-backup)
1667 (force-mode-line-update)
1668 (message "Clock canceled")
1669 (run-hooks 'org-clock-cancel-hook))
1671 (defcustom org-clock-goto-before-context 2
1672 "Number of lines of context to display before currently clocked-in entry.
1673 This applies when using `org-clock-goto'."
1678 (defun org-clock-goto (&optional select)
1679 "Go to the currently clocked-in entry, or to the most recently clocked one.
1680 With prefix arg SELECT, offer recently clocked tasks for selection."
1685 (or (org-clock-select-task "Select task to go to: ")
1686 (error "No task selected")))
1687 ((org-clocking-p) org-clock-marker)
1688 ((and org-clock-goto-may-find-recent-task
1689 (car org-clock-history)
1690 (marker-buffer (car org-clock-history)))
1692 (car org-clock-history))
1693 (t (error "No active or recent clock task")))))
1694 (org-pop-to-buffer-same-window (marker-buffer m))
1695 (if (or (< m (point-min)) (> m (point-max))) (widen))
1698 (org-back-to-heading t)
1699 (org-cycle-hide-drawers 'children)
1700 (recenter org-clock-goto-before-context)
1703 (message "No running clock, this is the most recently clocked task"))
1704 (run-hooks 'org-clock-goto-hook)))
1706 (defvar org-clock-file-total-minutes nil
1707 "Holds the file total time in minutes, after a call to `org-clock-sum'.")
1708 (make-variable-buffer-local 'org-clock-file-total-minutes)
1710 (defun org-clock-sum-today (&optional headline-filter)
1711 "Sum the times for each subtree for today."
1713 (let ((range (org-clock-special-range 'today)))
1714 (org-clock-sum (car range) (cadr range) nil :org-clock-minutes-today)))
1717 (defun org-clock-sum (&optional tstart tend headline-filter propname)
1718 "Sum the times for each subtree.
1719 Puts the resulting times in minutes as a text property on each headline.
1720 TSTART and TEND can mark a time range to be considered.
1721 HEADLINE-FILTER is a zero-arg function that, if specified, is called for
1722 each headline in the time range with point at the headline. Headlines for
1723 which HEADLINE-FILTER returns nil are excluded from the clock summation.
1724 PROPNAME lets you set a custom text property instead of :org-clock-minutes."
1726 (org-with-silent-modifications
1727 (let* ((re (concat "^\\(\\*+\\)[ \t]\\|^[ \t]*"
1729 "[ \t]*\\(?:\\(\\[.*?\\]\\)-+\\(\\[.*?\\]\\)\\|=>[ \t]+\\([0-9]+\\):\\([0-9]+\\)\\)"))
1731 (ltimes (make-vector lmax 0))
1736 (if (stringp tstart) (setq tstart (org-time-string-to-seconds tstart)))
1737 (if (stringp tend) (setq tend (org-time-string-to-seconds tend)))
1738 (if (consp tstart) (setq tstart (org-float-time tstart)))
1739 (if (consp tend) (setq tend (org-float-time tend)))
1740 (remove-text-properties (point-min) (point-max)
1741 `(,(or propname :org-clock-minutes) t
1742 :org-clock-force-headline-inclusion t))
1744 (goto-char (point-max))
1745 (while (re-search-backward re nil t)
1749 (setq ts (match-string 2)
1752 (apply 'encode-time (org-parse-time-string ts)))
1754 (apply 'encode-time (org-parse-time-string te)))
1755 ts (if tstart (max ts tstart) ts)
1756 te (if tend (min te tend) te)
1758 t1 (if (> dt 0) (+ t1 (floor (/ dt 60))) t1)))
1761 (setq t1 (+ t1 (string-to-number (match-string 5))
1762 (* 60 (string-to-number (match-string 4))))))
1764 ;; Add the currently clocking item time to the total
1765 (when (and org-clock-report-include-clocking-task
1766 (equal (org-clocking-buffer) (current-buffer))
1767 (equal (marker-position org-clock-hd-marker) (point))
1770 (>= (org-float-time org-clock-start-time) tstart)
1771 (<= (org-float-time org-clock-start-time) tend))
1772 (let ((time (floor (- (org-float-time)
1773 (org-float-time org-clock-start-time)) 60)))
1774 (setq t1 (+ t1 time))))
1775 (let* ((headline-forced
1776 (get-text-property (point)
1777 :org-clock-force-headline-inclusion))
1779 (or (null headline-filter)
1781 (save-match-data (funcall headline-filter))))))
1782 (setq level (- (match-end 1) (match-beginning 1)))
1783 (when (or (> t1 0) (> (aref ltimes level) 0))
1784 (when (or headline-included headline-forced)
1785 (if headline-included
1786 (loop for l from 0 to level do
1787 (aset ltimes l (+ (aref ltimes l) t1))))
1788 (setq time (aref ltimes level))
1789 (goto-char (match-beginning 0))
1790 (put-text-property (point) (point-at-eol)
1791 (or propname :org-clock-minutes) time)
1796 (> (funcall outline-level) 1)
1797 (outline-up-heading 1 t)
1799 (point) (point-at-eol)
1800 :org-clock-force-headline-inclusion t))))))
1802 (loop for l from level to (1- lmax) do
1803 (aset ltimes l 0)))))))
1804 (setq org-clock-file-total-minutes (aref ltimes 0))))))
1806 (defun org-clock-sum-current-item (&optional tstart)
1807 "Return time, clocked on current item in total."
1810 (org-narrow-to-subtree)
1811 (org-clock-sum tstart)
1812 org-clock-file-total-minutes)))
1815 (defun org-clock-display (&optional total-only)
1816 "Show subtree times in the entire buffer.
1817 If TOTAL-ONLY is non-nil, only show the total time for the entire file
1820 Use \\[org-clock-remove-overlays] to remove the subtree times."
1822 (org-clock-remove-overlays)
1827 (goto-char (point-min))
1828 (while (or (and (equal (setq p (point)) (point-min))
1829 (get-text-property p :org-clock-minutes))
1830 (setq p (next-single-property-change
1831 (point) :org-clock-minutes)))
1833 (when (setq time (get-text-property p :org-clock-minutes))
1834 (org-clock-put-overlay time (funcall outline-level))))
1835 (setq h (/ org-clock-file-total-minutes 60)
1836 m (- org-clock-file-total-minutes (* 60 h)))
1837 ;; Arrange to remove the overlays upon next change.
1838 (when org-remove-highlights-with-change
1839 (org-add-hook 'before-change-functions 'org-clock-remove-overlays
1841 (message (concat "Total file time: "
1842 (org-minutes-to-clocksum-string org-clock-file-total-minutes)
1843 " (%d hours and %d minutes)") h m)))
1845 (defvar org-clock-overlays nil)
1846 (make-variable-buffer-local 'org-clock-overlays)
1848 (defun org-clock-put-overlay (time &optional level)
1849 "Put an overlays on the current line, displaying TIME.
1850 If LEVEL is given, prefix time with a corresponding number of stars.
1851 This creates a new overlay and stores it in `org-clock-overlays', so that it
1852 will be easy to remove."
1853 (let* ((c 60) (h (floor (/ time 60))) (m (- time (* 60 h)))
1854 (l (if level (org-get-valid-level level 0) 0))
1857 (org-move-to-column c)
1858 (unless (eolp) (skip-chars-backward "^ \t"))
1859 (skip-chars-backward " \t")
1860 (setq ov (make-overlay (point-at-bol) (point-at-eol))
1861 tx (concat (buffer-substring (point-at-bol) (point))
1862 (make-string (+ off (max 0 (- c (current-column)))) ?.)
1863 (org-add-props (concat (make-string l ?*) " "
1864 (org-minutes-to-clocksum-string time)
1865 (make-string (- 16 l) ?\ ))
1866 (list 'face 'org-clock-overlay))
1868 (if (not (featurep 'xemacs))
1869 (overlay-put ov 'display tx)
1870 (overlay-put ov 'invisible t)
1871 (overlay-put ov 'end-glyph (make-glyph tx)))
1872 (push ov org-clock-overlays)))
1875 (defun org-clock-remove-overlays (&optional beg end noremove)
1876 "Remove the occur highlights from the buffer.
1877 BEG and END are ignored. If NOREMOVE is nil, remove this function
1878 from the `before-change-functions' in the current buffer."
1880 (unless org-inhibit-highlight-removal
1881 (mapc 'delete-overlay org-clock-overlays)
1882 (setq org-clock-overlays nil)
1884 (remove-hook 'before-change-functions
1885 'org-clock-remove-overlays 'local))))
1887 (defvar org-state) ;; dynamically scoped into this function
1888 (defun org-clock-out-if-current ()
1889 "Clock out if the current entry contains the running clock.
1890 This is used to stop the clock after a TODO entry is marked DONE,
1891 and is only done if the variable `org-clock-out-when-done' is not nil."
1892 (when (and (org-clocking-p)
1893 org-clock-out-when-done
1894 (marker-buffer org-clock-marker)
1895 (or (and (eq t org-clock-out-when-done)
1896 (member org-state org-done-keywords))
1897 (and (listp org-clock-out-when-done)
1898 (member org-state org-clock-out-when-done)))
1899 (equal (or (buffer-base-buffer (org-clocking-buffer))
1900 (org-clocking-buffer))
1901 (or (buffer-base-buffer (current-buffer))
1903 (< (point) org-clock-marker)
1904 (> (save-excursion (outline-next-heading) (point))
1906 ;; Clock out, but don't accept a logging message for this.
1907 (let ((org-log-note-clock-out nil)
1908 (org-clock-out-switch-to-state nil))
1911 (add-hook 'org-after-todo-state-change-hook
1912 'org-clock-out-if-current)
1915 (defun org-clock-get-clocktable (&rest props)
1916 "Get a formatted clocktable with parameters according to PROPS.
1917 The table is created in a temporary buffer, fully formatted and
1918 fontified, and then returned."
1920 (setq props (plist-put props :name "clocktable"))
1921 (unless (plist-member props :maxlevel)
1922 (setq props (plist-put props :maxlevel 2)))
1923 (unless (plist-member props :scope)
1924 (setq props (plist-put props :scope 'agenda)))
1927 (org-create-dblock props)
1929 (font-lock-fontify-buffer)
1931 (buffer-substring (point) (progn
1932 (re-search-forward "^[ \t]*#\\+END" nil t)
1936 (defun org-clock-report (&optional arg)
1937 "Create a table containing a report about clocked time.
1938 If the cursor is inside an existing clocktable block, then the table
1939 will be updated. If not, a new clocktable will be inserted. The scope
1940 of the new clock will be subtree when called from within a subtree, and
1943 When called with a prefix argument, move to the first clock table in the
1944 buffer and update it."
1946 (org-clock-remove-overlays)
1948 (org-find-dblock "clocktable")
1950 (if (org-in-clocktable-p)
1951 (goto-char (org-in-clocktable-p))
1952 (let ((props (if (ignore-errors
1953 (save-excursion (org-back-to-heading)))
1954 (list :name "clocktable" :scope 'subtree)
1955 (list :name "clocktable"))))
1957 (org-combine-plists org-clock-clocktable-default-properties props))))
1958 (org-update-dblock))
1960 (defun org-day-of-week (day month year)
1961 "Returns the day of the week as an integer."
1965 (format "%d-%02d-%02dT00:00:00" year month day)))))
1967 (defun org-quarter-to-date (quarter year)
1968 "Get the date (week day year) of the first day of a given quarter."
1972 (setq startday (org-day-of-week 1 1 year))
1975 (list 52 7 (- year 1)))
1977 (list 52 6 (- year 1)))
1979 (list 1 startday year))
1981 (list 53 startday (- year 1)))
1985 (setq startday (org-day-of-week 1 4 year))
1988 (list 13 startday year))
1990 (list 14 startday year))
1992 (list 13 startday year))
1996 (setq startday (org-day-of-week 1 7 year))
1999 (list 26 startday year))
2001 (list 27 startday year))
2003 (list 26 startday year))
2007 (setq startday (org-day-of-week 1 10 year))
2010 (list 39 startday year))
2012 (list 40 startday year))
2014 (list 39 startday year)))))))
2016 (defun org-clock-special-range (key &optional time as-strings wstart mstart)
2017 "Return two times bordering a special time range.
2018 Key is a symbol specifying the range and can be one of `today', `yesterday',
2019 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
2020 By default, a week starts Monday 0:00 and ends Sunday 24:00.
2021 The range is determined relative to TIME, which defaults to current time.
2022 The return value is a cons cell with two internal times like the ones
2023 returned by `current time' or `encode-time'.
2024 If AS-STRINGS is non-nil, the returned times will be formatted strings.
2025 If WSTART is non-nil, use this number to specify the starting day of a
2027 If MSTART is non-nil, use this number to specify the starting day of a
2028 month (1 is the first day of the month).
2029 If you can combine both, the month starting day will have priority."
2030 (if (integerp key) (setq key (intern (number-to-string key))))
2031 (let* ((tm (decode-time (or time (current-time))))
2032 (s 0) (m (nth 1 tm)) (h (nth 2 tm))
2033 (d (nth 3 tm)) (month (nth 4 tm)) (y (nth 5 tm))
2037 (skey (symbol-name key))
2039 (q (cond ((>= (nth 4 tm) 10) 4)
2040 ((>= (nth 4 tm) 7) 3)
2041 ((>= (nth 4 tm) 4) 2)
2042 ((>= (nth 4 tm) 1) 1)))
2043 s1 m1 h1 d1 month1 y1 diff ts te fm txt w date
2044 interval tmp shiftedy shiftedm shiftedq)
2046 ((string-match "^[0-9]+$" skey)
2047 (setq y (string-to-number skey) m 1 d 1 key 'year))
2048 ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)$" skey)
2049 (setq y (string-to-number (match-string 1 skey))
2050 month (string-to-number (match-string 2 skey))
2052 ((string-match "^\\([0-9]+\\)-[wW]\\([0-9]\\{1,2\\}\\)$" skey)
2054 (setq y (string-to-number (match-string 1 skey))
2055 w (string-to-number (match-string 2 skey)))
2056 (setq date (calendar-gregorian-from-absolute
2057 (calendar-absolute-from-iso (list w 1 y))))
2058 (setq d (nth 1 date) month (car date) y (nth 2 date)
2061 ((string-match "^\\([0-9]+\\)-[qQ]\\([1-4]\\)$" skey)
2063 (setq y (string-to-number (match-string 1 skey)))
2064 (setq q (string-to-number (match-string 2 skey)))
2065 (setq date (calendar-gregorian-from-absolute
2066 (calendar-absolute-from-iso (org-quarter-to-date q y))))
2067 (setq d (nth 1 date) month (car date) y (nth 2 date)
2070 ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)-\\([0-9]\\{1,2\\}\\)$" skey)
2071 (setq y (string-to-number (match-string 1 skey))
2072 month (string-to-number (match-string 2 skey))
2073 d (string-to-number (match-string 3 skey))
2075 ((string-match "\\([-+][0-9]+\\)$" skey)
2076 (setq shift (string-to-number (match-string 1 skey))
2077 key (intern (substring skey 0 (match-beginning 1))))
2078 (if (and (memq key '(quarter thisq)) (> shift 0))
2079 (error "Looking forward with quarters isn't implemented"))))
2082 (cond ((eq key 'yesterday) (setq key 'today shift -1))
2083 ((eq key 'lastweek) (setq key 'week shift -1))
2084 ((eq key 'lastmonth) (setq key 'month shift -1))
2085 ((eq key 'lastyear) (setq key 'year shift -1))
2086 ((eq key 'lastq) (setq key 'quarter shift -1))))
2088 ((memq key '(day today))
2089 (setq d (+ d shift) h 0 m 0 h1 24 m1 0))
2090 ((memq key '(week thisweek))
2091 (setq diff (+ (* -7 shift) (if (= dow 0) (- 7 ws) (- dow ws)))
2092 m 0 h 0 d (- d diff) d1 (+ 7 d)))
2093 ((memq key '(month thismonth))
2094 (setq d (or ms 1) h 0 m 0 d1 (or ms 1)
2095 month (+ month shift) month1 (1+ month) h1 0 m1 0))
2096 ((memq key '(quarter thisq))
2097 ;; Compute if this shift remains in this year. If not, compute
2098 ;; how many years and quarters we have to shift (via floor*) and
2099 ;; compute the shifted years, months and quarters.
2101 ((< (+ (- q 1) shift) 0) ; shift not in this year
2102 (setq interval (* -1 (+ (- q 1) shift)))
2103 ;; Set tmp to ((years to shift) (quarters to shift)).
2104 (setq tmp (org-floor* interval 4))
2105 ;; Due to the use of floor, 0 quarters actually means 4.
2106 (if (= 0 (nth 1 tmp))
2107 (setq shiftedy (- y (nth 0 tmp))
2110 (setq shiftedy (- y (+ 1 (nth 0 tmp)))
2111 shiftedm (- 13 (* 3 (nth 1 tmp)))
2112 shiftedq (- 5 (nth 1 tmp))))
2113 (setq d 1 h 0 m 0 d1 1 month shiftedm month1 (+ 3 shiftedm) h1 0 m1 0 y shiftedy))
2114 ((> (+ q shift) 0) ; shift is within this year
2115 (setq shiftedq (+ q shift))
2117 (setq d 1 h 0 m 0 d1 1 month (+ 1 (* 3 (- (+ q shift) 1))) month1 (+ 4 (* 3 (- (+ q shift) 1))) h1 0 m1 0))))
2118 ((memq key '(year thisyear))
2119 (setq m 0 h 0 d 1 month 1 y (+ y shift) y1 (1+ y)))
2120 (t (error "No such time block %s" key)))
2121 (setq ts (encode-time s m h d month y)
2122 te (encode-time (or s1 s) (or m1 m) (or h1 h)
2123 (or d1 d) (or month1 month) (or y1 y)))
2124 (setq fm (cdr org-time-stamp-formats))
2126 ((memq key '(day today))
2127 (setq txt (format-time-string "%A, %B %d, %Y" ts)))
2128 ((memq key '(week thisweek))
2129 (setq txt (format-time-string "week %G-W%V" ts)))
2130 ((memq key '(month thismonth))
2131 (setq txt (format-time-string "%B %Y" ts)))
2132 ((memq key '(year thisyear))
2133 (setq txt (format-time-string "the year %Y" ts)))
2134 ((memq key '(quarter thisq))
2135 (setq txt (concat (org-count-quarter shiftedq) " quarter of " (number-to-string shiftedy)))))
2137 (list (format-time-string fm ts) (format-time-string fm te) txt)
2140 (defun org-count-quarter (n)
2148 (defun org-clocktable-shift (dir n)
2149 "Try to shift the :block date of the clocktable at point.
2150 Point must be in the #+BEGIN: line of a clocktable, or this function
2151 will throw an error.
2152 DIR is a direction, a symbol `left', `right', `up', or `down'.
2153 Both `left' and `down' shift the block toward the past, `up' and `right'
2154 push it toward the future.
2155 N is the number of shift steps to take. The size of the step depends on
2156 the currently selected interval size."
2157 (setq n (prefix-numeric-value n))
2158 (and (memq dir '(left down)) (setq n (- n)))
2160 (goto-char (point-at-bol))
2161 (if (not (looking-at "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>.*?:block[ \t]+\\(\\S-+\\)"))
2162 (error "Line needs a :block definition before this command works")
2163 (let* ((b (match-beginning 1)) (e (match-end 1))
2164 (s (match-string 1))
2165 block shift ins y mw d date wp m)
2167 ((equal s "yesterday") (setq s "today-1"))
2168 ((equal s "lastweek") (setq s "thisweek-1"))
2169 ((equal s "lastmonth") (setq s "thismonth-1"))
2170 ((equal s "lastyear") (setq s "thisyear-1"))
2171 ((equal s "lastq") (setq s "thisq-1")))
2174 ((string-match "^\\(today\\|thisweek\\|thismonth\\|thisyear\\|thisq\\)\\([-+][0-9]+\\)?$" s)
2175 (setq block (match-string 1 s)
2176 shift (if (match-end 2)
2177 (string-to-number (match-string 2 s))
2179 (setq shift (+ shift n))
2180 (setq ins (if (= shift 0) block (format "%s%+d" block shift))))
2181 ((string-match "\\([0-9]+\\)\\(-\\([wWqQ]?\\)\\([0-9]\\{1,2\\}\\)\\(-\\([0-9]\\{1,2\\}\\)\\)?\\)?" s)
2182 ;; 1 1 2 3 3 4 4 5 6 6 5 2
2183 (setq y (string-to-number (match-string 1 s))
2184 wp (and (match-end 3) (match-string 3 s))
2185 mw (and (match-end 4) (string-to-number (match-string 4 s)))
2186 d (and (match-end 6) (string-to-number (match-string 6 s))))
2188 (d (setq ins (format-time-string
2190 (encode-time 0 0 0 (+ d n) m y))))
2191 ((and wp (string-match "w\\|W" wp) mw (> (length wp) 0))
2193 (setq date (calendar-gregorian-from-absolute
2194 (calendar-absolute-from-iso (list (+ mw n) 1 y))))
2195 (setq ins (format-time-string
2197 (encode-time 0 0 0 (nth 1 date) (car date) (nth 2 date)))))
2198 ((and wp (string-match "q\\|Q" wp) mw (> (length wp) 0))
2200 ; if the 4th + 1 quarter is requested we flip to the 1st quarter of the next year
2205 ; if the 1st - 1 quarter is requested we flip to the 4th quarter of the previous year
2210 (setq date (calendar-gregorian-from-absolute
2211 (calendar-absolute-from-iso (org-quarter-to-date (+ mw n) y))))
2212 (setq ins (format-time-string
2213 (concat (number-to-string y) "-Q" (number-to-string (+ mw n)))
2214 (encode-time 0 0 0 (nth 1 date) (car date) (nth 2 date)))))
2216 (setq ins (format-time-string
2218 (encode-time 0 0 0 1 (+ mw n) y))))
2220 (setq ins (number-to-string (+ y n))))))
2221 (t (error "Cannot shift clocktable block")))
2225 (delete-region (point) (+ (point) (- e b)))
2226 (beginning-of-line 1)
2231 (defun org-dblock-write:clocktable (params)
2232 "Write the standard clocktable."
2233 (setq params (org-combine-plists org-clocktable-defaults params))
2235 (let* ((scope (plist-get params :scope))
2236 (block (plist-get params :block))
2237 (ts (plist-get params :tstart))
2238 (te (plist-get params :tend))
2239 (link (plist-get params :link))
2240 (maxlevel (or (plist-get params :maxlevel) 3))
2241 (ws (plist-get params :wstart))
2242 (ms (plist-get params :mstart))
2243 (step (plist-get params :step))
2244 (timestamp (plist-get params :timestamp))
2245 (formatter (or (plist-get params :formatter)
2246 org-clock-clocktable-formatter
2247 'org-clocktable-write-default))
2248 cc range-text ipos pos one-file-with-archives
2249 scope-is-list tbls level)
2250 ;; Check if we need to do steps
2252 ;; Get the range text for the header
2253 (setq cc (org-clock-special-range block nil t ws ms)
2254 ts (car cc) te (nth 1 cc) range-text (nth 2 cc)))
2256 ;; Write many tables, in steps
2257 (unless (or block (and ts te))
2258 (error "Clocktable `:step' can only be used with `:block' or `:tstart,:end'"))
2259 (org-clocktable-steps params)
2262 (setq ipos (point)) ; remember the insertion position
2264 ;; Get the right scope
2267 ((and scope (listp scope) (symbolp (car scope)))
2268 (setq scope (eval scope)))
2270 (setq scope (org-agenda-files t)))
2271 ((eq scope 'agenda-with-archives)
2272 (setq scope (org-agenda-files t))
2273 (setq scope (org-add-archive-files scope)))
2274 ((eq scope 'file-with-archives)
2275 (setq scope (org-add-archive-files (list (buffer-file-name)))
2276 one-file-with-archives t)))
2277 (setq scope-is-list (and scope (listp scope)))
2279 ;; we collect from several files
2280 (let* ((files scope)
2282 (org-agenda-prepare-buffers files)
2283 (while (setq file (pop files))
2284 (with-current-buffer (find-buffer-visiting file)
2287 (push (org-clock-get-table-data file params) tbls))))))
2288 ;; Just from the current file
2290 ;; get the right range into the restriction
2291 (org-agenda-prepare-buffers (list (buffer-file-name)))
2293 ((not scope)) ; use the restriction as it is now
2294 ((eq scope 'file) (widen))
2295 ((eq scope 'subtree) (org-narrow-to-subtree))
2297 (while (org-up-heading-safe))
2298 (org-narrow-to-subtree))
2299 ((and (symbolp scope) (string-match "^tree\\([0-9]+\\)$"
2300 (symbol-name scope)))
2301 (setq level (string-to-number (match-string 1 (symbol-name scope))))
2303 (while (org-up-heading-safe)
2304 (looking-at org-outline-regexp)
2305 (if (<= (org-reduced-level (funcall outline-level)) level)
2306 (throw 'exit nil))))
2307 (org-narrow-to-subtree)))
2308 ;; do the table, with no file name.
2309 (push (org-clock-get-table-data nil params) tbls)))
2311 ;; OK, at this point we tbls as a list of tables, one per file
2312 (setq tbls (nreverse tbls))
2314 (setq params (plist-put params :multifile scope-is-list))
2315 (setq params (plist-put params :one-file-with-archives
2316 one-file-with-archives))
2318 (funcall formatter ipos tbls params))))
2320 (defun org-clocktable-write-default (ipos tables params)
2321 "Write out a clock table at position IPOS in the current buffer.
2322 TABLES is a list of tables with clocking data as produced by
2323 `org-clock-get-table-data'. PARAMS is the parameter property list obtained
2324 from the dynamic block definition."
2325 ;; This function looks quite complicated, mainly because there are a
2326 ;; lot of options which can add or remove columns. I have massively
2327 ;; commented this function, the I hope it is understandable. If
2328 ;; someone wants to write their own special formatter, this maybe
2329 ;; much easier because there can be a fixed format with a
2330 ;; well-defined number of columns...
2331 (let* ((hlchars '((1 . "*") (2 . "/")))
2332 (lwords (assoc (or (plist-get params :lang)
2333 (org-bound-and-true-p org-export-default-language)
2335 org-clock-clocktable-language-setup))
2336 (multifile (plist-get params :multifile))
2337 (block (plist-get params :block))
2338 (ts (plist-get params :tstart))
2339 (te (plist-get params :tend))
2340 (header (plist-get params :header))
2341 (narrow (plist-get params :narrow))
2342 (ws (or (plist-get params :wstart) 1))
2343 (ms (or (plist-get params :mstart) 1))
2344 (link (plist-get params :link))
2345 (maxlevel (or (plist-get params :maxlevel) 3))
2346 (emph (plist-get params :emphasize))
2347 (level-p (plist-get params :level))
2348 (org-time-clocksum-use-effort-durations
2349 (plist-get params :effort-durations))
2350 (timestamp (plist-get params :timestamp))
2351 (properties (plist-get params :properties))
2352 (ntcol (max 1 (or (plist-get params :tcolumns) 100)))
2353 (rm-file-column (plist-get params :one-file-with-archives))
2354 (indent (plist-get params :indent))
2355 (case-fold-search t)
2356 range-text total-time tbl level hlc formula pcol
2357 file-time entries entry headline
2358 recalc content narrow-cut-p tcol)
2360 ;; Implement abbreviations
2361 (when (plist-get params :compact)
2362 (setq level nil indent t narrow (or narrow '40!) ntcol 1))
2364 ;; Some consistency test for parameters
2365 (unless (integerp ntcol)
2366 (setq params (plist-put params :tcolumns (setq ntcol 100))))
2368 (when (and narrow (integerp narrow) link)
2369 ;; We cannot have both integer narrow and link
2371 "Using hard narrowing in clocktable to allow for links")
2372 (setq narrow (intern (format "%d!" narrow))))
2377 ((and (symbolp narrow)
2378 (string-match "\\`[0-9]+!\\'" (symbol-name narrow)))
2379 (setq narrow-cut-p t
2380 narrow (string-to-number (substring (symbol-name narrow)
2383 (error "Invalid value %s of :narrow property in clock table"
2387 ;; Get the range text for the header
2388 (setq range-text (nth 2 (org-clock-special-range block nil t ws ms))))
2390 ;; Compute the total time
2391 (setq total-time (apply '+ (mapcar 'cadr tables)))
2393 ;; Now we need to output this tsuff
2396 ;; Insert the text *before* the actual table
2397 (insert-before-markers
2399 ;; Format the standard header
2404 (format-time-string (cdr org-time-stamp-formats))
2407 (if block (concat ", for " range-text ".") "")
2410 ;; Insert the narrowing line
2411 (when (and narrow (integerp narrow) (not narrow-cut-p))
2412 (insert-before-markers
2413 "|" ; table line starter
2414 (if multifile "|" "") ; file column, maybe
2415 (if level-p "|" "") ; level column, maybe
2416 (if timestamp "|" "") ; timestamp column, maybe
2417 (if properties (make-string (length properties) ?|) "") ;properties columns, maybe
2418 (format "<%d>| |\n" narrow))) ; headline and time columns
2420 ;; Insert the table header line
2421 (insert-before-markers
2422 "|" ; table line starter
2423 (if multifile (concat (nth 1 lwords) "|") "") ; file column, maybe
2424 (if level-p (concat (nth 2 lwords) "|") "") ; level column, maybe
2425 (if timestamp (concat (nth 3 lwords) "|") "") ; timestamp column, maybe
2426 (if properties (concat (mapconcat 'identity properties "|") "|") "") ;properties columns, maybe
2427 (concat (nth 4 lwords) "|"
2428 (nth 5 lwords) "|\n")) ; headline and time columns
2430 ;; Insert the total time in the table
2431 (insert-before-markers
2433 "|" ; table line starter
2434 (if multifile (concat "| " (nth 6 lwords) " ") "")
2435 ; file column, maybe
2436 (if level-p "|" "") ; level column, maybe
2437 (if timestamp "|" "") ; timestamp column, maybe
2438 (if properties (make-string (length properties) ?|) "") ; properties columns, maybe
2439 (concat (format org-clock-total-time-cell-format (nth 7 lwords)) "| ") ; instead of a headline
2440 (format org-clock-total-time-cell-format
2441 (org-minutes-to-clocksum-string (or total-time 0))) ; the time
2444 ;; Now iterate over the tables and insert the data
2445 ;; but only if any time has been collected
2446 (when (and total-time (> total-time 0))
2448 (while (setq tbl (pop tables))
2449 ;; now tbl is the table resulting from one file.
2450 (setq file-time (nth 1 tbl))
2451 (when (or (and file-time (> file-time 0))
2452 (not (plist-get params :fileskip0)))
2453 (insert-before-markers "|-\n") ; a hline because a new file starts
2454 ;; First the file time, if we have multiple files
2456 ;; Summarize the time collected from this file
2457 (insert-before-markers
2458 (format (concat "| %s %s | %s%s"
2459 (format org-clock-file-time-cell-format (nth 8 lwords))
2461 (file-name-nondirectory (car tbl))
2462 (if level-p "| " "") ; level column, maybe
2463 (if timestamp "| " "") ; timestamp column, maybe
2464 (if properties (make-string (length properties) ?|) "") ;properties columns, maybe
2465 (org-minutes-to-clocksum-string (nth 1 tbl))))) ; the time
2467 ;; Get the list of node entries and iterate over it
2468 (setq entries (nth 2 tbl))
2469 (while (setq entry (pop entries))
2470 (setq level (car entry)
2471 headline (nth 1 entry)
2472 hlc (if emph (or (cdr (assoc level hlchars)) "") ""))
2474 (if (and (string-match (concat "\\`" org-bracket-link-regexp
2479 (format "[[%s][%s]]"
2480 (match-string 1 headline)
2481 (org-shorten-string (match-string 3 headline)
2483 (setq headline (org-shorten-string headline narrow))))
2484 (insert-before-markers
2485 "|" ; start the table line
2486 (if multifile "|" "") ; free space for file name column?
2487 (if level-p (format "%d|" (car entry)) "") ; level, maybe
2488 (if timestamp (concat (nth 2 entry) "|") "") ; timestamp, maybe
2492 (lambda (p) (or (cdr (assoc p (nth 4 entry))) ""))
2493 properties "|") "|") "") ;properties columns, maybe
2494 (if indent (org-clocktable-indent-string level) "") ; indentation
2495 hlc headline hlc "|" ; headline
2496 (make-string (min (1- ntcol) (or (- level 1))) ?|)
2497 ; empty fields for higher levels
2498 hlc (org-minutes-to-clocksum-string (nth 3 entry)) hlc ; time
2501 ;; When exporting subtrees or regions the region might be
2502 ;; activated, so let's disable ̀delete-active-region'
2503 (let ((delete-active-region nil)) (backward-delete-char 1))
2504 (if (setq formula (plist-get params :formula))
2507 ;; compute the column where the % numbers need to go
2512 (min maxlevel (or ntcol 100))))
2513 ;; compute the column where the total time is
2517 (if timestamp 1 0)))
2520 "\n#+TBLFM: $%d='(org-clock-time%% @%d$%d $%d..$%d);%%.1f"
2521 pcol ; the column where the % numbers should go
2522 (if (and narrow (not narrow-cut-p)) 3 2) ; row of the total time
2523 tcol ; column of the total time
2524 tcol (1- pcol) ; range of columns where times can be found
2528 (insert "\n#+TBLFM: " formula)
2530 (t (error "Invalid formula in clocktable")))
2531 ;; Should we rescue an old formula?
2532 (when (stringp (setq content (plist-get params :content)))
2533 (when (string-match "^\\([ \t]*#\\+tblfm:.*\\)" content)
2535 (insert "\n" (match-string 1 (plist-get params :content)))
2536 (beginning-of-line 0))))
2537 ;; Back to beginning, align the table, recalculate if necessary
2539 (skip-chars-forward "^|")
2541 (when org-hide-emphasis-markers
2542 ;; we need to align a second time
2547 (if (and narrow (not narrow-cut-p)) (beginning-of-line 2))
2548 (org-table-goto-column pcol nil 'force)
2550 (org-table-recalculate 'all))
2551 (when rm-file-column
2552 ;; The file column is actually not wanted
2554 (org-table-delete-column))
2557 (defun org-clocktable-indent-string (level)
2562 (setq level (1- level)
2563 str (concat str "___")))
2566 (defun org-clocktable-steps (params)
2567 "Step through the range to make a number of clock tables."
2568 (let* ((p1 (copy-sequence params))
2569 (ts (plist-get p1 :tstart))
2570 (te (plist-get p1 :tend))
2571 (ws (plist-get p1 :wstart))
2572 (ms (plist-get p1 :mstart))
2573 (step0 (plist-get p1 :step))
2574 (step (cdr (assoc step0 '((day . 86400) (week . 604800)))))
2575 (stepskip0 (plist-get p1 :stepskip0))
2576 (block (plist-get p1 :block))
2577 cc range-text step-time tsb)
2579 (setq cc (org-clock-special-range block nil t ws ms)
2580 ts (car cc) te (nth 1 cc) range-text (nth 2 cc)))
2583 ;; If ts is a number, it's an absolute day number from org-agenda.
2584 (destructuring-bind (month day year) (calendar-gregorian-from-absolute ts)
2585 (setq ts (org-float-time (encode-time 0 0 0 day month year)))))
2587 (setq ts (org-float-time
2588 (apply 'encode-time (org-parse-time-string ts))))))
2592 (destructuring-bind (month day year) (calendar-gregorian-from-absolute te)
2593 (setq te (org-float-time (encode-time 0 0 0 day month year)))))
2595 (setq te (org-float-time
2596 (apply 'encode-time (org-parse-time-string te))))))
2598 (if (eq step0 'week)
2599 (- ts (* 86400 (- (nth 6 (decode-time (seconds-to-time ts))) ws)))
2601 (setq p1 (plist-put p1 :header ""))
2602 (setq p1 (plist-put p1 :step nil))
2603 (setq p1 (plist-put p1 :block nil))
2605 (or (bolp) (insert "\n"))
2606 (setq p1 (plist-put p1 :tstart (format-time-string
2607 (org-time-stamp-format nil t)
2608 (seconds-to-time (max tsb ts)))))
2609 (setq p1 (plist-put p1 :tend (format-time-string
2610 (org-time-stamp-format nil t)
2611 (seconds-to-time (min te (setq tsb (+ tsb step)))))))
2612 (insert "\n" (if (eq step0 'day) "Daily report: "
2613 "Weekly report starting on: ")
2614 (plist-get p1 :tstart) "\n")
2615 (setq step-time (org-dblock-write:clocktable p1))
2616 (re-search-forward "^[ \t]*#\\+END:")
2617 (when (and (equal step-time 0) stepskip0)
2618 ;; Remove the empty table
2619 (delete-region (point-at-bol)
2621 (re-search-backward "^\\(Daily\\|Weekly\\) report"
2626 (defun org-clock-get-table-data (file params)
2627 "Get the clocktable data for file FILE, with parameters PARAMS.
2628 FILE is only for identification - this function assumes that
2629 the correct buffer is current, and that the wanted restriction is
2631 The return value will be a list with the file name and the total
2632 file time (in minutes) as 1st and 2nd elements. The third element
2633 of this list will be a list of headline entries. Each entry has the
2634 following structure:
2636 (LEVEL HEADLINE TIMESTAMP TIME)
2638 LEVEL: The level of the headline, as an integer. This will be
2639 the reduced leve, so 1,2,3,... even if only odd levels
2641 HEADLINE: The text of the headline. Depending on PARAMS, this may
2642 already be formatted like a link.
2643 TIMESTAMP: If PARAMS require it, this will be a time stamp found in the
2644 entry, any of SCHEDULED, DEADLINE, NORMAL, or first inactive,
2646 TIME: The sum of all time spend in this tree, in minutes. This time
2647 will of cause be restricted to the time block and tags match
2648 specified in PARAMS."
2649 (let* ((maxlevel (or (plist-get params :maxlevel) 3))
2650 (timestamp (plist-get params :timestamp))
2651 (ts (plist-get params :tstart))
2652 (te (plist-get params :tend))
2653 (ws (plist-get params :wstart))
2654 (ms (plist-get params :mstart))
2655 (block (plist-get params :block))
2656 (link (plist-get params :link))
2657 (tags (plist-get params :tags))
2658 (properties (plist-get params :properties))
2659 (inherit-property-p (plist-get params :inherit-props))
2661 (matcher (if tags (cdr (org-make-tags-matcher tags))))
2662 cc range-text st p time level hdl props tsp tbl)
2664 (setq org-clock-file-total-minutes nil)
2666 (setq cc (org-clock-special-range block nil t ws ms)
2667 ts (car cc) te (nth 1 cc) range-text (nth 2 cc)))
2668 (when (integerp ts) (setq ts (calendar-gregorian-from-absolute ts)))
2669 (when (integerp te) (setq te (calendar-gregorian-from-absolute te)))
2670 (when (and ts (listp ts))
2671 (setq ts (format "%4d-%02d-%02d" (nth 2 ts) (car ts) (nth 1 ts))))
2672 (when (and te (listp te))
2673 (setq te (format "%4d-%02d-%02d" (nth 2 te) (car te) (nth 1 te))))
2674 ;; Now the times are strings we can parse.
2675 (if ts (setq ts (org-float-time
2676 (seconds-to-time (org-matcher-time ts)))))
2677 (if te (setq te (org-float-time
2678 (seconds-to-time (org-matcher-time te)))))
2680 (org-clock-sum ts te
2681 (unless (null matcher)
2683 (let* ((tags-list (org-get-tags-at))
2684 (org-scanner-tags tags-list)
2685 (org-trust-scanner-tags t))
2687 (goto-char (point-min))
2689 (while (or (and (bobp) (prog1 st (setq st nil))
2690 (get-text-property (point) :org-clock-minutes)
2691 (setq p (point-min)))
2692 (setq p (next-single-property-change
2693 (point) :org-clock-minutes)))
2695 (when (setq time (get-text-property p :org-clock-minutes))
2697 (beginning-of-line 1)
2698 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@#%:]+:\\)?[ \t]*$"))
2699 (setq level (org-reduced-level
2700 (- (match-end 1) (match-beginning 1))))
2701 (<= level maxlevel))
2702 (setq hdl (if (not link)
2704 (org-make-link-string
2705 (format "file:%s::%s"
2708 (org-make-org-heading-search-string
2712 (setq props (org-entry-properties (point)))
2713 (or (cdr (assoc "SCHEDULED" props))
2714 (cdr (assoc "DEADLINE" props))
2715 (cdr (assoc "TIMESTAMP" props))
2716 (cdr (assoc "TIMESTAMP_IA" props))))
2717 props (when properties
2721 (when (org-entry-get (point) p inherit-property-p)
2722 (cons p (org-entry-get (point) p inherit-property-p))))
2724 (when (> time 0) (push (list level hdl tsp time props) tbl))))))
2725 (setq tbl (nreverse tbl))
2726 (list file org-clock-file-total-minutes tbl))))
2728 (defun org-clock-time% (total &rest strings)
2729 "Compute a time fraction in percent.
2730 TOTAL s a time string like 10:21 specifying the total times.
2731 STRINGS is a list of strings that should be checked for a time.
2732 The first string that does have a time will be used.
2733 This function is made for clock tables."
2734 (let ((re "\\([0-9]+\\):\\([0-9]+\\)")
2738 (if (not (string-match re total))
2740 (setq tot (+ (string-to-number (match-string 2 total))
2741 (* 60 (string-to-number (match-string 1 total)))))
2742 (if (= tot 0.) (throw 'exit 0.)))
2743 (while (setq s (pop strings))
2744 (if (string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
2746 (/ (* 100.0 (+ (string-to-number (match-string 2 s))
2747 (* 60 (string-to-number
2748 (match-string 1 s)))))
2752 ;; Saving and loading the clock
2754 (defvar org-clock-loaded nil
2755 "Was the clock file loaded?")
2758 (defun org-clock-update-time-maybe ()
2759 "If this is a CLOCK line, update it and return t.
2760 Otherwise, return nil."
2763 (beginning-of-line 1)
2764 (skip-chars-forward " \t")
2765 (when (looking-at org-clock-string)
2766 (let ((re (concat "[ \t]*" org-clock-string
2767 " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
2768 "\\([ \t]*=>.*\\)?\\)?"))
2771 ((not (looking-at re))
2773 ((not (match-end 2))
2774 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
2775 (> org-clock-marker (point))
2776 (<= org-clock-marker (point-at-eol)))
2777 ;; The clock is running here
2778 (setq org-clock-start-time
2780 (org-parse-time-string (match-string 1))))
2781 (org-clock-update-mode-line)))
2783 (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
2785 (setq ts (match-string 1)
2786 te (match-string 3))
2787 (setq s (- (org-float-time
2788 (apply 'encode-time (org-parse-time-string te)))
2790 (apply 'encode-time (org-parse-time-string ts))))
2793 h (floor (/ s 3600))
2797 (insert " => " (format (if neg "-%d:%02d" "%2d:%02d") h m))
2800 (defun org-clock-save ()
2801 "Persist various clock-related data to disk.
2802 The details of what will be saved are regulated by the variable
2803 `org-clock-persist'."
2804 (when (and org-clock-persist
2805 (or org-clock-loaded
2806 org-clock-has-been-used
2807 (not (file-exists-p org-clock-persist-file))))
2809 (with-current-buffer (find-file (expand-file-name org-clock-persist-file))
2811 (delete-region (point-min) (point-max))
2813 (insert (format ";; org-persist.el - %s at %s\n"
2814 system-name (format-time-string
2815 (cdr org-time-stamp-formats))))
2816 (if (and (memq org-clock-persist '(t clock))
2817 (setq b (org-clocking-buffer))
2818 (setq b (or (buffer-base-buffer b) b))
2820 (buffer-file-name b)
2821 (or (not org-clock-persist-query-save)
2822 (y-or-n-p (concat "Save current clock ("
2823 org-clock-heading ") "))))
2824 (insert "(setq resume-clock '(\""
2825 (buffer-file-name (org-clocking-buffer))
2826 "\" . " (int-to-string (marker-position org-clock-marker))
2828 ;; Store clocked task history. Tasks are stored reversed to make
2830 (when (and (memq org-clock-persist '(t history))
2833 "(setq stored-clock-history '("
2836 (when (and (setq b (marker-buffer m))
2837 (setq b (or (buffer-base-buffer b) b))
2839 (buffer-file-name b))
2840 (concat "(\"" (buffer-file-name b)
2841 "\" . " (int-to-string (marker-position m))
2843 (reverse org-clock-history) " ") "))\n"))
2845 (kill-buffer (current-buffer)))))))
2847 (defun org-clock-load ()
2848 "Load clock-related data from disk, maybe resuming a stored clock."
2849 (when (and org-clock-persist (not org-clock-loaded))
2850 (let ((filename (expand-file-name org-clock-persist-file))
2851 (org-clock-in-resume 'auto-restart)
2852 resume-clock stored-clock-history)
2853 (if (not (file-readable-p filename))
2854 (message "Not restoring clock data; %s not found"
2855 org-clock-persist-file)
2856 (message "%s" "Restoring clock data")
2857 (setq org-clock-loaded t)
2858 (load-file filename)
2860 (when stored-clock-history
2861 (save-window-excursion
2862 (mapc (lambda (task)
2863 (if (file-exists-p (car task))
2864 (org-clock-history-push (cdr task)
2865 (find-file (car task)))))
2866 stored-clock-history)))
2868 (when (and resume-clock org-clock-persist
2869 (file-exists-p (car resume-clock))
2870 (or (not org-clock-persist-query-resume)
2874 (with-current-buffer (find-file (car resume-clock))
2876 (goto-char (cdr resume-clock))
2877 (org-back-to-heading t)
2878 (and (looking-at org-complex-heading-regexp)
2881 (when (file-exists-p (car resume-clock))
2882 (with-current-buffer (find-file (car resume-clock))
2883 (goto-char (cdr resume-clock))
2884 (let ((org-clock-auto-clock-resolution nil))
2886 (if (outline-invisible-p)
2887 (org-show-context))))))))))
2889 ;; Suggested bindings
2890 (org-defkey org-mode-map "\C-c\C-x\C-e" 'org-clock-modify-effort-estimate)
2892 (provide 'org-clock)
2895 ;; generated-autoload-file: "org-loaddefs.el"
2898 ;;; org-clock.el ends here