1 ;;; org-clock.el --- The time clocking code for Org-mode
3 ;; Copyright (C) 2004-2013 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."
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
266 (string :tag
"Program")
267 (function :tag
"Function")))
269 (defgroup org-clocktable nil
270 "Options concerning the clock table in Org-mode."
271 :tag
"Org Clock Table"
274 (defcustom org-clocktable-defaults
277 :lang
(or (org-bound-and-true-p org-export-default-language
) "en")
297 "Default properties for clock tables."
302 (defcustom org-clock-clocktable-formatter
'org-clocktable-write-default
303 "Function to turn clocking data into a table.
304 For more information, see `org-clocktable-write-default'."
305 :group
'org-clocktable
309 ;; FIXME: translate es and nl last string "Clock summary at"
310 (defcustom org-clock-clocktable-language-setup
311 '(("en" "File" "L" "Timestamp" "Headline" "Time" "ALL" "Total time" "File time" "Clock summary at")
312 ("es" "Archivo" "N" "Fecha y hora" "Tarea" "Tiempo" "TODO" "Tiempo total" "Tiempo archivo" "Clock summary at")
313 ("fr" "Fichier" "N" "Horodatage" "En-tête" "Durée" "TOUT" "Durée totale" "Durée fichier" "Horodatage sommaire à ")
314 ("nl" "Bestand" "N" "Tijdstip" "Hoofding" "Duur" "ALLES" "Totale duur" "Bestandstijd" "Clock summary at"))
315 "Terms used in clocktable, translated to different languages."
316 :group
'org-clocktable
320 (defcustom org-clock-clocktable-default-properties
'(:maxlevel
2 :scope file
)
321 "Default properties for new clocktables.
322 These will be inserted into the BEGIN line, to make it easy for users to
324 :group
'org-clocktable
327 (defcustom org-clock-idle-time nil
328 "When non-nil, resolve open clocks if the user is idle more than X minutes."
331 (const :tag
"Never" nil
)
332 (integer :tag
"After N minutes")))
334 (defcustom org-clock-auto-clock-resolution
'when-no-clock-is-running
335 "When to automatically resolve open clocks found in Org buffers."
338 (const :tag
"Never" nil
)
339 (const :tag
"Always" t
)
340 (const :tag
"When no clock is running" when-no-clock-is-running
)))
342 (defcustom org-clock-report-include-clocking-task nil
343 "When non-nil, include the current clocking task time in clock reports."
348 (defcustom org-clock-resolve-expert nil
349 "Non-nil means do not show the splash buffer with the clock resolver."
354 (defcustom org-clock-continuously nil
355 "Non-nil means to start clocking from the last clock-out time, if any."
360 (defcustom org-clock-total-time-cell-format
"*%s*"
361 "Format string for the total time cells."
366 (defcustom org-clock-file-time-cell-format
"*%s*"
367 "Format string for the file time cells."
372 (defcustom org-clock-clocked-in-display
'mode-line
373 "When clocked in for a task, org-mode can display the current
374 task and accumulated time in the mode line and/or frame title.
377 both displays in both mode line and frame title
378 mode-line displays only in mode line (default)
379 frame-title displays only in frame title
380 nil current clock is not displayed"
383 (const :tag
"Mode line" mode-line
)
384 (const :tag
"Frame title" frame-title
)
385 (const :tag
"Both" both
)
386 (const :tag
"None" nil
)))
388 (defcustom org-clock-frame-title-format
'(t org-mode-line-string
)
389 "The value for `frame-title-format' when clocking in.
391 When `org-clock-clocked-in-display' is set to 'frame-title
392 or 'both, clocking in will replace `frame-title-format' with
393 this value. Clocking out will restore `frame-title-format'.
395 `org-frame-title-string' is a format string using the same
396 specifications than `frame-title-format', which see."
401 (defcustom org-clock-x11idle-program-name
"x11idle"
402 "Name of the program which prints X11 idle time in milliseconds.
404 You can find x11idle.c in the contrib/scripts directory of the
405 Org git distribution. Or, you can do:
407 sudo apt-get install xprintidle
409 if you are using Debian."
412 :package-version
'(Org .
"8.0")
415 (defvar org-clock-in-prepare-hook nil
416 "Hook run when preparing the clock.
417 This hook is run before anything happens to the task that
418 you want to clock in. For example, you can use this hook
419 to add an effort property.")
420 (defvar org-clock-in-hook nil
421 "Hook run when starting the clock.")
422 (defvar org-clock-out-hook nil
423 "Hook run when stopping the current clock.")
425 (defvar org-clock-cancel-hook nil
426 "Hook run when cancelling the current clock.")
427 (defvar org-clock-goto-hook nil
428 "Hook run when selecting the currently clocked-in entry.")
429 (defvar org-clock-has-been-used nil
430 "Has the clock been used during the current Emacs session?")
432 ;;; The clock for measuring work time.
434 (defvar org-mode-line-string
"")
435 (put 'org-mode-line-string
'risky-local-variable t
)
437 (defvar org-clock-mode-line-timer nil
)
438 (defvar org-clock-idle-timer nil
)
439 (defvar org-clock-heading
) ; defined in org.el
440 (defvar org-clock-start-time
"")
442 (defvar org-clock-leftover-time nil
443 "If non-nil, user cancelled a clock; this is when leftover time started.")
445 (defvar org-clock-effort
""
446 "Effort estimate of the currently clocking task.")
448 (defvar org-clock-total-time nil
449 "Holds total time, spent previously on currently clocked item.
450 This does not include the time in the currently running clock.")
452 (defvar org-clock-history nil
453 "List of marker pointing to recent clocked tasks.")
455 (defvar org-clock-default-task
(make-marker)
456 "Marker pointing to the default task that should clock time.
457 The clock can be made to switch to this task after clocking out
458 of a different task.")
460 (defvar org-clock-interrupted-task
(make-marker)
461 "Marker pointing to the task that has been interrupted by the current clock.")
463 (defvar org-clock-mode-line-map
(make-sparse-keymap))
464 (define-key org-clock-mode-line-map
[mode-line mouse-2
] 'org-clock-goto
)
465 (define-key org-clock-mode-line-map
[mode-line mouse-1
] 'org-clock-menu
)
467 (defun org-clock-menu ()
471 ["Clock out" org-clock-out t
]
472 ["Change effort estimate" org-clock-modify-effort-estimate t
]
473 ["Go to clock entry" org-clock-goto t
]
474 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t
:keys
"C-u C-c C-x C-i"])))
476 (defun org-clock-history-push (&optional pos buffer
)
477 "Push a marker to the clock history."
478 (setq org-clock-history-length
(max 1 (min 35 org-clock-history-length
)))
479 (let ((m (move-marker (make-marker)
480 (or pos
(point)) (org-base-buffer
481 (or buffer
(current-buffer)))))
483 (while (setq n
(member m org-clock-history
))
484 (move-marker (car n
) nil
))
485 (setq org-clock-history
487 (mapcar (lambda (x) (if (marker-buffer x
) x nil
))
489 (when (>= (setq l
(length org-clock-history
)) org-clock-history-length
)
490 (setq org-clock-history
492 (nthcdr (- l org-clock-history-length -
1)
493 (nreverse org-clock-history
)))))
494 (push m org-clock-history
)))
496 (defun org-clock-save-markers-for-cut-and-paste (beg end
)
497 "Save relative positions of markers in region."
498 (org-check-and-save-marker org-clock-marker beg end
)
499 (org-check-and-save-marker org-clock-hd-marker beg end
)
500 (org-check-and-save-marker org-clock-default-task beg end
)
501 (org-check-and-save-marker org-clock-interrupted-task beg end
)
502 (mapc (lambda (m) (org-check-and-save-marker m beg end
))
505 (defun org-clocking-buffer ()
506 "Return the clocking buffer if we are currently clocking a task or nil."
507 (marker-buffer org-clock-marker
))
509 (defun org-clocking-p ()
510 "Return t when clocking a task."
511 (not (equal (org-clocking-buffer) nil
)))
513 (defvar org-clock-before-select-task-hook nil
514 "Hook called in task selection just before prompting the user.")
516 (defun org-clock-select-task (&optional prompt
)
517 "Select a task that recently was associated with clocking."
519 (let (sel-list rpl
(i 0) s
)
520 (save-window-excursion
521 (org-switch-to-buffer-other-window
522 (get-buffer-create "*Clock Task Select*"))
524 (when (marker-buffer org-clock-default-task
)
525 (insert (org-add-props "Default Task\n" nil
'face
'bold
))
526 (setq s
(org-clock-insert-selection-line ?d org-clock-default-task
))
528 (when (marker-buffer org-clock-interrupted-task
)
529 (insert (org-add-props "The task interrupted by starting the last one\n" nil
'face
'bold
))
530 (setq s
(org-clock-insert-selection-line ?i org-clock-interrupted-task
))
532 (when (org-clocking-p)
533 (insert (org-add-props "Current Clocking Task\n" nil
'face
'bold
))
534 (setq s
(org-clock-insert-selection-line ?c org-clock-marker
))
536 (insert (org-add-props "Recent Tasks\n" nil
'face
'bold
))
539 (when (marker-buffer m
)
541 s
(org-clock-insert-selection-line
545 (if (fboundp 'int-to-char
) (setf (car s
) (int-to-char (car s
))))
548 (run-hooks 'org-clock-before-select-task-hook
)
549 (org-fit-window-to-buffer)
550 (message (or prompt
"Select task for clocking:"))
551 (setq rpl
(read-char-exclusive))
555 ((assoc rpl sel-list
) (cdr (assoc rpl sel-list
)))
556 (t (error "Invalid task choice %c" rpl
))))))
558 (defun org-clock-insert-selection-line (i marker
)
559 "Insert a line for the clock selection menu.
560 And return a cons cell with the selection character integer and the marker
562 (when (marker-buffer marker
)
563 (let (file cat task heading prefix
)
564 (with-current-buffer (org-base-buffer (marker-buffer marker
))
570 (setq file
(buffer-file-name (marker-buffer marker
))
571 cat
(org-get-category)
572 heading
(org-get-heading 'notags
)
573 prefix
(save-excursion
574 (org-back-to-heading t
)
575 (looking-at org-outline-regexp
)
578 (org-fontify-like-in-org-mode
579 (concat prefix heading
)
581 (length prefix
)))))))
583 (insert (format "[%c] %-15s %s\n" i cat task
))
586 (defvar org-clock-task-overrun nil
587 "Internal flag indicating if the clock has overrun the planned time.")
588 (defvar org-clock-update-period
60
589 "Number of seconds between mode line clock string updates.")
591 (defun org-clock-get-clock-string ()
592 "Form a clock-string, that will be shown in the mode line.
593 If an effort estimate was defined for the current item, use
594 01:30/01:50 format (clocked/estimated).
595 If not, show simply the clocked time like 01:50."
596 (let ((clocked-time (org-clock-get-clocked-time)))
598 (let* ((effort-in-minutes
599 (org-duration-string-to-minutes org-clock-effort
))
602 (org-minutes-to-clocksum-string clocked-time
)
603 'face
(if (and org-clock-task-overrun
(not org-clock-task-overrun-text
))
604 'org-mode-line-clock-overrun
'org-mode-line-clock
)))
605 (effort-str (org-minutes-to-clocksum-string effort-in-minutes
))
606 (clockstr (org-propertize
607 (concat " [%s/" effort-str
608 "] (" (replace-regexp-in-string "%" "%%" org-clock-heading
) ")")
609 'face
'org-mode-line-clock
)))
610 (format clockstr work-done-str
))
611 (org-propertize (concat "[" (org-minutes-to-clocksum-string clocked-time
)
612 (format " (%s)" org-clock-heading
) "]")
613 'face
'org-mode-line-clock
))))
615 (defun org-clock-get-last-clock-out-time ()
616 "Get the last clock-out time for the current subtree."
618 (let ((end (save-excursion (org-end-of-subtree))))
619 (when (re-search-forward (concat org-clock-string
620 ".*\\]--\\(\\[[^]]+\\]\\)") end t
)
621 (org-time-string-to-time (match-string 1))))))
623 (defun org-clock-update-mode-line ()
625 (org-clock-notify-once-if-expired)
626 (setq org-clock-task-overrun nil
))
627 (setq org-mode-line-string
629 (let ((clock-string (org-clock-get-clock-string))
630 (help-text "Org-mode clock is running.\nmouse-1 shows a menu\nmouse-2 will jump to task"))
631 (if (and (> org-clock-string-limit
0)
632 (> (length clock-string
) org-clock-string-limit
))
634 (substring clock-string
0 org-clock-string-limit
)
635 'help-echo
(concat help-text
": " org-clock-heading
))
636 (org-propertize clock-string
'help-echo help-text
)))
637 'local-map org-clock-mode-line-map
638 'mouse-face
(if (featurep 'xemacs
) 'highlight
'mode-line-highlight
)))
639 (if (and org-clock-task-overrun org-clock-task-overrun-text
)
640 (setq org-mode-line-string
641 (concat (org-propertize
642 org-clock-task-overrun-text
643 'face
'org-mode-line-clock-overrun
) org-mode-line-string
)))
644 (force-mode-line-update))
646 (defun org-clock-get-clocked-time ()
647 "Get the clocked time for the current item in minutes.
648 The time returned includes the time spent on this task in
649 previous clocking intervals."
650 (let ((currently-clocked-time
651 (floor (- (org-float-time)
652 (org-float-time org-clock-start-time
)) 60)))
653 (+ currently-clocked-time
(or org-clock-total-time
0))))
655 (defun org-clock-modify-effort-estimate (&optional value
)
656 "Add to or set the effort estimate of the item currently being clocked.
657 VALUE can be a number of minutes, or a string with format hh:mm or mm.
658 When the string starts with a + or a - sign, the current value of the effort
659 property will be changed by that amount.
660 This will update the \"Effort\" property of currently clocked item, and
663 (if (org-clock-is-active)
664 (let ((current org-clock-effort
) sign
)
666 ;; Prompt user for a value or a change
669 (format "Set effort (hh:mm or mm%s): "
671 (format ", prefix + to add to %s" org-clock-effort
)
673 (when (stringp value
)
674 ;; A string. See if it is a delta
675 (setq sign
(string-to-char value
))
676 (if (member sign
'(?- ?
+))
677 (setq current
(org-duration-string-to-minutes current
)
678 value
(substring value
1))
680 (setq value
(org-duration-string-to-minutes value
))
682 (setq value
(- current value
))
683 (if (equal ?
+ sign
) (setq value
(+ current value
)))))
684 (setq value
(max 0 value
)
685 org-clock-effort
(org-minutes-to-clocksum-string value
))
686 (org-entry-put org-clock-marker
"Effort" org-clock-effort
)
687 (org-clock-update-mode-line)
688 (message "Effort is now %s" org-clock-effort
))
689 (message "Clock is not currently active")))
691 (defvar org-clock-notification-was-shown nil
692 "Shows if we have shown notification already.")
694 (defun org-clock-notify-once-if-expired ()
695 "Show notification if we spent more time than we estimated before.
696 Notification is shown only once."
697 (when (org-clocking-p)
698 (let ((effort-in-minutes (org-duration-string-to-minutes org-clock-effort
))
699 (clocked-time (org-clock-get-clocked-time)))
700 (if (setq org-clock-task-overrun
701 (if (or (null effort-in-minutes
) (zerop effort-in-minutes
))
703 (>= clocked-time effort-in-minutes
)))
704 (unless org-clock-notification-was-shown
705 (setq org-clock-notification-was-shown t
)
707 (format "Task '%s' should be finished by now. (%s)"
708 org-clock-heading org-clock-effort
) t
))
709 (setq org-clock-notification-was-shown nil
)))))
711 (defun org-notify (notification &optional play-sound
)
712 "Send a NOTIFICATION and maybe PLAY-SOUND.
713 If PLAY-SOUND is non-nil, it overrides `org-clock-sound'."
714 (org-show-notification notification
)
715 (if play-sound
(org-clock-play-sound play-sound
)))
717 (defun org-show-notification (notification)
719 Use `org-show-notification-handler' if defined,
720 use libnotify if available, or fall back on a message."
721 (cond ((functionp org-show-notification-handler
)
722 (funcall org-show-notification-handler notification
))
723 ((stringp org-show-notification-handler
)
724 (start-process "emacs-timer-notification" nil
725 org-show-notification-handler notification
))
726 ((fboundp 'notifications-notify
)
727 (notifications-notify
728 :title
"Org-mode message"
730 ;; FIXME how to link to the Org icon?
731 ;; :app-icon "~/.emacs.d/icons/mail.png"
733 ((executable-find "notify-send")
734 (start-process "emacs-timer-notification" nil
735 "notify-send" notification
))
736 ;; Maybe the handler will send a message, so only use message as
737 ;; a fall back option
738 (t (message "%s" notification
))))
740 (defun org-clock-play-sound (&optional clock-sound
)
741 "Play sound as configured by `org-clock-sound'.
742 Use alsa's aplay tool if available.
743 If CLOCK-SOUND is non-nil, it overrides `org-clock-sound'."
744 (let ((org-clock-sound (or clock-sound org-clock-sound
)))
746 ((not org-clock-sound
))
747 ((eq org-clock-sound t
) (beep t
) (beep t
))
748 ((stringp org-clock-sound
)
749 (let ((file (expand-file-name org-clock-sound
)))
750 (if (file-exists-p file
)
751 (if (executable-find "aplay")
752 (start-process "org-clock-play-notification" nil
755 (play-sound-file file
)
756 (error (beep t
) (beep t
))))))))))
758 (defvar org-clock-mode-line-entry nil
759 "Information for the mode line about the running clock.")
761 (defun org-find-open-clocks (file)
762 "Search through the given file and find all open clocks."
763 (let ((buf (or (get-file-buffer file
)
764 (find-file-noselect file
)))
766 (with-current-buffer buf
768 (goto-char (point-min))
769 (while (re-search-forward "CLOCK: \\(\\[.*?\\]\\)$" nil t
)
770 (push (cons (copy-marker (match-end 1) t
)
771 (org-time-string-to-time (match-string 1))) clocks
))))
774 (defsubst org-is-active-clock
(clock)
775 "Return t if CLOCK is the currently active clock."
776 (and (org-clock-is-active)
777 (= org-clock-marker
(car clock
))))
779 (defmacro org-with-clock-position
(clock &rest forms
)
780 "Evaluate FORMS with CLOCK as the current active clock."
781 `(with-current-buffer (marker-buffer (car ,clock
))
785 (goto-char (car ,clock
))
788 (def-edebug-spec org-with-clock-position
(form body
))
789 (put 'org-with-clock-position
'lisp-indent-function
1)
791 (defmacro org-with-clock
(clock &rest forms
)
792 "Evaluate FORMS with CLOCK as the current active clock.
793 This macro also protects the current active clock from being altered."
794 `(org-with-clock-position ,clock
795 (let ((org-clock-start-time (cdr ,clock
))
796 (org-clock-total-time)
799 (org-clock-marker (car ,clock
))
800 (org-clock-hd-marker (save-excursion
801 (outline-back-to-heading t
)
804 (def-edebug-spec org-with-clock
(form body
))
805 (put 'org-with-clock
'lisp-indent-function
1)
807 (defsubst org-clock-clock-in
(clock &optional resume start-time
)
808 "Clock in to the clock located by CLOCK.
809 If necessary, clock-out of the currently active clock."
810 (org-with-clock-position clock
811 (let ((org-clock-in-resume (or resume org-clock-in-resume
)))
812 (org-clock-in nil start-time
))))
814 (defsubst org-clock-clock-out
(clock &optional fail-quietly at-time
)
815 "Clock out of the clock located by CLOCK."
816 (let ((temp (copy-marker (car clock
)
817 (marker-insertion-type (car clock
)))))
818 (if (org-is-active-clock clock
)
819 (org-clock-out nil fail-quietly at-time
)
820 (org-with-clock clock
821 (org-clock-out nil fail-quietly at-time
)))
822 (setcar clock temp
)))
824 (defsubst org-clock-clock-cancel
(clock)
825 "Cancel the clock located by CLOCK."
826 (let ((temp (copy-marker (car clock
)
827 (marker-insertion-type (car clock
)))))
828 (if (org-is-active-clock clock
)
830 (org-with-clock clock
832 (setcar clock temp
)))
834 (defvar org-clock-clocking-in nil
)
835 (defvar org-clock-resolving-clocks nil
)
836 (defvar org-clock-resolving-clocks-due-to-idleness nil
)
838 (defun org-clock-resolve-clock (clock resolve-to clock-out-time
839 &optional close-p restart-p fail-quietly
)
840 "Resolve `CLOCK' given the time `RESOLVE-TO', and the present.
841 `CLOCK' is a cons cell of the form (MARKER START-TIME)."
842 (let ((org-clock-resolving-clocks t
))
845 (org-clock-clock-cancel clock
)
846 (if (and restart-p
(not org-clock-clocking-in
))
847 (org-clock-clock-in clock
)))
849 ((eq resolve-to
'now
)
851 (error "RESTART-P is not valid here"))
852 (if (or close-p org-clock-clocking-in
)
853 (org-clock-clock-out clock fail-quietly
)
854 (unless (org-is-active-clock clock
)
855 (org-clock-clock-in clock t
))))
857 ((not (time-less-p resolve-to
(current-time)))
858 (error "RESOLVE-TO must refer to a time in the past"))
862 (error "RESTART-P is not valid here"))
863 (org-clock-clock-out clock fail-quietly
(or clock-out-time
865 (unless org-clock-clocking-in
867 (setq org-clock-leftover-time
(and (null clock-out-time
)
869 (org-clock-clock-in clock nil
(and clock-out-time
872 (defun org-clock-jump-to-current-clock (&optional effective-clock
)
874 (let ((org-clock-into-drawer (org-clock-into-drawer))
875 (clock (or effective-clock
(cons org-clock-marker
876 org-clock-start-time
))))
877 (unless (marker-buffer (car clock
))
878 (error "No clock is currently running"))
879 (org-with-clock clock
(org-clock-goto))
880 (with-current-buffer (marker-buffer (car clock
))
881 (goto-char (car clock
))
882 (if org-clock-into-drawer
884 (if (stringp org-clock-into-drawer
)
885 (concat ":" org-clock-into-drawer
":")
890 (outline-back-to-heading t
)
891 (search-forward logbook
)
892 (goto-char (match-beginning 0)))
894 (outline-back-to-heading t
)
895 (search-forward logbook
)
896 (search-forward ":END:")
897 (goto-char (match-end 0)))
900 (defun org-clock-resolve (clock &optional prompt-fn last-valid fail-quietly
)
901 "Resolve an open org-mode clock.
902 An open clock was found, with `dangling' possibly being non-nil.
903 If this function was invoked with a prefix argument, non-dangling
904 open clocks are ignored. The given clock requires some sort of
905 user intervention to resolve it, either because a clock was left
906 dangling or due to an idle timeout. The clock resolution can
909 (a) deleted, the user doesn't care about the clock
910 (b) restarted from the current time (if no other clock is open)
911 (c) closed, giving the clock X minutes
912 (d) closed and then restarted
913 (e) resumed, as if the user had never left
915 The format of clock is (CONS MARKER START-TIME), where MARKER
916 identifies the buffer and position the clock is open at (and
917 thus, the heading it's under), and START-TIME is when the clock
921 (save-window-excursion
923 (unless org-clock-resolving-clocks-due-to-idleness
924 (org-clock-jump-to-current-clock clock
))
925 (unless org-clock-resolve-expert
926 (with-output-to-temp-buffer "*Org Clock*"
927 (princ "Select a Clock Resolution Command:
929 i/q/C-g Ignore this question; the same as keeping all the idle time.
931 k/K Keep X minutes of the idle time (default is all). If this
932 amount is less than the default, you will be clocked out
933 that many minutes after the time that idling began, and then
934 clocked back in at the present time.
935 g/G Indicate that you \"got back\" X minutes ago. This is quite
936 different from 'k': it clocks you out from the beginning of
937 the idle period and clock you back in X minutes ago.
938 s/S Subtract the idle time from the current clock. This is the
939 same as keeping 0 minutes.
940 C Cancel the open timer altogether. It will be as though you
942 j/J Jump to the current clock, to make manual adjustments.
944 For all these options, using uppercase makes your final state
945 to be CLOCKED OUT.")))
946 (org-fit-window-to-buffer (get-buffer-window "*Org Clock*"))
948 (when (featurep 'xemacs
)
949 (message (concat (funcall prompt-fn clock
)
951 (setq char-pressed
(read-char-exclusive)))
952 (while (or (null char-pressed
)
953 (and (not (memq char-pressed
954 '(?k ?K ?g ?G ?s ?S ?C
958 (read-char (concat (funcall prompt-fn clock
)
961 (and (not (memq char-pressed
'(?i ?q
))) char-pressed
)))))
963 (floor (/ (org-float-time
964 (time-subtract (current-time) last-valid
)) 60)))
966 (and (memq ch
'(?k ?K
))
967 (read-number "Keep how many minutes? " default
)))
969 (and (memq ch
'(?g ?G
))
970 (read-number "Got back how many minutes ago? " default
)))
971 (subtractp (memq ch
'(?s ?S
)))
972 (barely-started-p (< (- (org-float-time last-valid
)
973 (org-float-time (cdr clock
))) 45))
974 (start-over (and subtractp barely-started-p
)))
978 (org-clock-resolve-clock clock
'now nil t nil fail-quietly
))
979 (org-clock-jump-to-current-clock clock
))
981 (not (memq ch
'(?k ?K ?g ?G ?s ?S ?C
))))
984 (org-clock-resolve-clock
987 ;; If the time on the clock was less than a minute before
988 ;; the user went away, and they've ask to subtract all the
993 (and gotback
(= gotback
0)))
995 ((or (and keep
(= keep default
))
996 (and gotback
(= gotback default
)))
999 (time-add last-valid
(seconds-to-time (* 60 keep
))))
1001 (time-subtract (current-time)
1002 (seconds-to-time (* 60 gotback
))))
1004 (error "Unexpected, please report this as a bug")))
1005 (and gotback last-valid
)
1006 (memq ch
'(?K ?G ?S
))
1008 (not (memq ch
'(?K ?G ?S ?C
))))
1012 (defun org-resolve-clocks (&optional only-dangling-p prompt-fn last-valid
)
1013 "Resolve all currently open org-mode clocks.
1014 If `only-dangling-p' is non-nil, only ask to resolve dangling
1015 \(i.e., not currently open and valid) clocks."
1017 (unless org-clock-resolving-clocks
1018 (let ((org-clock-resolving-clocks t
))
1019 (dolist (file (org-files-list))
1020 (let ((clocks (org-find-open-clocks file
)))
1021 (dolist (clock clocks
)
1022 (let ((dangling (or (not (org-clock-is-active))
1023 (/= (car clock
) org-clock-marker
))))
1024 (if (or (not only-dangling-p
) dangling
)
1031 "Dangling clock started %d mins ago"
1033 (/ (- (org-float-time (current-time))
1034 (org-float-time (cdr clock
))) 60))))))
1036 (cdr clock
)))))))))))
1038 (defun org-emacs-idle-seconds ()
1039 "Return the current Emacs idle time in seconds, or nil if not idle."
1040 (let ((idle-time (current-idle-time)))
1042 (org-float-time idle-time
)
1045 (defun org-mac-idle-seconds ()
1046 "Return the current Mac idle time in seconds."
1047 (string-to-number (shell-command-to-string "ioreg -c IOHIDSystem | perl -ane 'if (/Idle/) {$idle=(pop @F)/1000000000; print $idle; last}'")))
1049 (defvar org-x11idle-exists-p
1050 ;; Check that x11idle exists
1051 (and (eq window-system
'x
)
1052 (eq (call-process-shell-command "command" nil nil nil
"-v" org-clock-x11idle-program-name
) 0)
1053 ;; Check that x11idle can retrieve the idle time
1054 (eq (call-process-shell-command org-clock-x11idle-program-name nil nil nil
) 0)))
1056 (defun org-x11-idle-seconds ()
1057 "Return the current X11 idle time in seconds."
1058 (/ (string-to-number (shell-command-to-string org-clock-x11idle-program-name
)) 1000))
1060 (defun org-user-idle-seconds ()
1061 "Return the number of seconds the user has been idle for.
1062 This routine returns a floating point number."
1064 ((eq system-type
'darwin
)
1065 (org-mac-idle-seconds))
1066 ((and (eq window-system
'x
) org-x11idle-exists-p
)
1067 (org-x11-idle-seconds))
1069 (org-emacs-idle-seconds))))
1071 (defvar org-clock-user-idle-seconds
)
1073 (defun org-resolve-clocks-if-idle ()
1074 "Resolve all currently open org-mode clocks.
1075 This is performed after `org-clock-idle-time' minutes, to check
1076 if the user really wants to stay clocked in after being idle for
1078 (when (and org-clock-idle-time
(not org-clock-resolving-clocks
)
1080 (let* ((org-clock-user-idle-seconds (org-user-idle-seconds))
1081 (org-clock-user-idle-start
1082 (time-subtract (current-time)
1083 (seconds-to-time org-clock-user-idle-seconds
)))
1084 (org-clock-resolving-clocks-due-to-idleness t
))
1085 (if (> org-clock-user-idle-seconds
(* 60 org-clock-idle-time
))
1087 (cons org-clock-marker
1088 org-clock-start-time
)
1091 (format "Clocked in & idle for %.1f mins"
1093 (time-subtract (current-time)
1094 org-clock-user-idle-start
))
1096 org-clock-user-idle-start
)))))
1098 (defvar org-clock-current-task nil
"Task currently clocked in.")
1099 (defvar org-clock-out-time nil
) ; store the time of the last clock-out
1102 (defun org-clock-in (&optional select start-time
)
1103 "Start the clock on the current item.
1104 If necessary, clock-out of the currently active clock.
1105 With a prefix argument SELECT (\\[universal-argument]), offer a list of recently clocked
1106 tasks to clock into. When SELECT is \\[universal-argument] \\[universal-argument], clock into the current task
1107 and mark it as the default task, a special task that will always be offered
1108 in the clocking selection, associated with the letter `d'.
1109 When SELECT is \\[universal-argument] \\[universal-argument] \\[universal-argument], \
1110 clock in by using the last clock-out
1111 time as the start time \(see `org-clock-continuously' to
1112 make this the default behavior.)"
1114 (setq org-clock-notification-was-shown nil
)
1115 (org-refresh-properties org-effort-property
'org-effort
)
1117 (let ((interrupting (and (not org-clock-resolving-clocks-due-to-idleness
)
1119 ts selected-task target-pos
(msg-extra "")
1120 (leftover (and (not org-clock-resolving-clocks
)
1121 org-clock-leftover-time
)))
1123 (when (and org-clock-auto-clock-resolution
1124 (or (not interrupting
)
1125 (eq t org-clock-auto-clock-resolution
))
1126 (not org-clock-clocking-in
)
1127 (not org-clock-resolving-clocks
))
1128 (setq org-clock-leftover-time nil
)
1129 (let ((org-clock-clocking-in t
))
1130 (org-resolve-clocks))) ; check if any clocks are dangling
1132 (when (equal select
'(64))
1133 ;; Set start-time to `org-clock-out-time'
1134 (let ((org-clock-continuously t
))
1135 (org-clock-in nil org-clock-out-time
)))
1137 (when (equal select
'(4))
1138 (setq selected-task
(org-clock-select-task "Clock-in on task: "))
1140 (setq selected-task
(copy-marker selected-task
))
1143 (when (equal select
'(16))
1144 ;; Mark as default clocking task
1145 (org-clock-mark-default-task))
1148 ;; We are interrupting the clocking of a different task.
1149 ;; Save a marker to this task, so that we can go back.
1150 ;; First check if we are trying to clock into the same task!
1151 (when (save-excursion
1152 (unless selected-task
1153 (org-back-to-heading t
))
1154 (and (equal (marker-buffer org-clock-hd-marker
)
1156 (marker-buffer selected-task
)
1158 (= (marker-position org-clock-hd-marker
)
1160 (marker-position selected-task
)
1162 (equal org-clock-current-task
(nth 4 (org-heading-components)))))
1163 (message "Clock continues in \"%s\"" org-clock-heading
)
1165 (move-marker org-clock-interrupted-task
1166 (marker-position org-clock-marker
)
1167 (marker-buffer org-clock-marker
))
1168 (let ((org-clock-clocking-in t
))
1169 (org-clock-out nil t
)))
1171 ;; Clock in at which position?
1173 (if (and (eobp) (not (org-at-heading-p)))
1177 (when (and selected-task
(marker-buffer selected-task
))
1178 ;; There is a selected task, move to the correct buffer
1179 ;; and set the new target position.
1180 (set-buffer (org-base-buffer (marker-buffer selected-task
)))
1181 (setq target-pos
(marker-position selected-task
))
1182 (move-marker selected-task nil
))
1186 (goto-char target-pos
)
1187 (org-back-to-heading t
)
1188 (or interrupting
(move-marker org-clock-interrupted-task nil
))
1190 (forward-char) ;; make sure the marker is not at the
1191 ;; beginning of the heading, since the
1192 ;; user is liking to insert stuff here
1194 (run-hooks 'org-clock-in-prepare-hook
)
1195 (org-clock-history-push))
1196 (setq org-clock-current-task
(nth 4 (org-heading-components)))
1197 (cond ((functionp org-clock-in-switch-to-state
)
1198 (looking-at org-complex-heading-regexp
)
1199 (let ((newstate (funcall org-clock-in-switch-to-state
1201 (if newstate
(org-todo newstate
))))
1202 ((and org-clock-in-switch-to-state
1203 (not (looking-at (concat org-outline-regexp
"[ \t]*"
1204 org-clock-in-switch-to-state
1206 (org-todo org-clock-in-switch-to-state
)))
1207 (setq org-clock-heading
1208 (cond ((and org-clock-heading-function
1209 (functionp org-clock-heading-function
))
1210 (funcall org-clock-heading-function
))
1211 ((nth 4 (org-heading-components))
1212 (replace-regexp-in-string
1213 "\\[\\[.*?\\]\\[\\(.*?\\)\\]\\]" "\\1"
1214 (match-string-no-properties 4)))
1216 (org-clock-find-position org-clock-in-resume
)
1218 ((and org-clock-in-resume
1220 (concat "^[ \t]*" org-clock-string
1221 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1222 " *\\sw+\.? +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
1223 (message "Matched %s" (match-string 1))
1224 (setq ts
(concat "[" (match-string 1) "]"))
1225 (goto-char (match-end 1))
1226 (setq org-clock-start-time
1228 (org-parse-time-string (match-string 1))))
1229 (setq org-clock-effort
(org-entry-get (point) org-effort-property
))
1230 (setq org-clock-total-time
(org-clock-sum-current-item
1231 (org-clock-get-sum-start))))
1232 ((eq org-clock-in-resume
'auto-restart
)
1233 ;; called from org-clock-load during startup,
1234 ;; do not interrupt, but warn!
1235 (message "Cannot restart clock because task does not contain unfinished clock")
1240 (insert-before-markers "\n")
1243 (when (and (save-excursion
1246 (beginning-of-line 1)
1247 (org-indent-line-to (- (org-get-indentation) 2)))
1248 (insert org-clock-string
" ")
1249 (setq org-clock-effort
(org-entry-get (point) org-effort-property
))
1250 (setq org-clock-total-time
(org-clock-sum-current-item
1251 (org-clock-get-sum-start)))
1252 (setq org-clock-start-time
1253 (or (and org-clock-continuously org-clock-out-time
)
1257 "You stopped another clock %d mins ago; start this one from then? "
1258 (/ (- (org-float-time
1259 (org-current-time org-clock-rounding-minutes t
))
1260 (org-float-time leftover
)) 60)))
1263 (org-current-time org-clock-rounding-minutes t
)))
1264 (setq ts
(org-insert-time-stamp org-clock-start-time
1265 'with-hm
'inactive
))))
1266 (move-marker org-clock-marker
(point) (buffer-base-buffer))
1267 (move-marker org-clock-hd-marker
1268 (save-excursion (org-back-to-heading t
) (point))
1269 (buffer-base-buffer))
1270 (setq org-clock-has-been-used t
)
1272 (when (or (eq org-clock-clocked-in-display
'mode-line
)
1273 (eq org-clock-clocked-in-display
'both
))
1274 (or global-mode-string
(setq global-mode-string
'("")))
1275 (or (memq 'org-mode-line-string global-mode-string
)
1276 (setq global-mode-string
1277 (append global-mode-string
'(org-mode-line-string)))))
1278 ;; add to frame title
1279 (when (or (eq org-clock-clocked-in-display
'frame-title
)
1280 (eq org-clock-clocked-in-display
'both
))
1281 (setq frame-title-format org-clock-frame-title-format
))
1282 (org-clock-update-mode-line)
1283 (when org-clock-mode-line-timer
1284 (cancel-timer org-clock-mode-line-timer
)
1285 (setq org-clock-mode-line-timer nil
))
1286 (when org-clock-clocked-in-display
1287 (setq org-clock-mode-line-timer
1288 (run-with-timer org-clock-update-period
1289 org-clock-update-period
1290 'org-clock-update-mode-line
)))
1291 (when org-clock-idle-timer
1292 (cancel-timer org-clock-idle-timer
)
1293 (setq org-clock-idle-timer nil
))
1294 (setq org-clock-idle-timer
1295 (run-with-timer 60 60 'org-resolve-clocks-if-idle
))
1296 (message "Clock starts at %s - %s" ts msg-extra
)
1297 (run-hooks 'org-clock-in-hook
)))))))
1300 (defun org-clock-in-last (&optional arg
)
1301 "Clock in the last closed clocked item.
1302 When already clocking in, send an warning.
1303 With a universal prefix argument, select the task you want to
1304 clock in from the last clocked in tasks.
1305 With two universal prefix arguments, start clocking using the
1306 last clock-out time, if any.
1307 With three universal prefix arguments, interactively prompt
1308 for a todo state to switch to, overriding the existing value
1309 `org-clock-in-switch-to-state'."
1311 (if (equal arg
'(4))
1312 (org-clock-in (org-clock-select-task))
1313 (let ((start-time (if (or org-clock-continuously
(equal arg
'(16)))
1314 (or org-clock-out-time
1315 (org-current-time org-clock-rounding-minutes t
))
1316 (org-current-time org-clock-rounding-minutes t
))))
1317 (if (null org-clock-history
)
1318 (message "No last clock")
1319 (let ((org-clock-in-switch-to-state
1320 (if (and (not org-clock-current-task
) (equal arg
'(64)))
1321 (completing-read "Switch to state: "
1322 (and org-clock-history
1323 (with-current-buffer
1324 (marker-buffer (car org-clock-history
))
1325 org-todo-keywords-1
)))
1326 org-clock-in-switch-to-state
))
1327 (already-clocking org-clock-current-task
))
1328 (org-clock-clock-in (list (car org-clock-history
)) nil start-time
)
1329 (or already-clocking
1330 ;; Don't display a message if we are already clocking in
1331 (message "Clocking back: %s (in %s)"
1332 org-clock-current-task
1333 (buffer-name (marker-buffer org-clock-marker
)))))))))
1335 (defun org-clock-mark-default-task ()
1336 "Mark current task as default task."
1339 (org-back-to-heading t
)
1340 (move-marker org-clock-default-task
(point))))
1343 (defun org-clock-get-sum-start ()
1344 "Return the time from which clock times should be counted.
1345 This is for the currently running clock as it is displayed
1346 in the mode line. This function looks at the properties
1347 LAST_REPEAT and in particular CLOCK_MODELINE_TOTAL and the
1348 corresponding variable `org-clock-mode-line-total' and then
1349 decides which time to use."
1350 (let ((cmt (or (org-entry-get nil
"CLOCK_MODELINE_TOTAL")
1351 (symbol-name org-clock-mode-line-total
)))
1352 (lr (org-entry-get nil
"LAST_REPEAT")))
1354 ((equal cmt
"current")
1355 (setq msg-extra
"showing time in current clock instance")
1357 ((equal cmt
"today")
1358 (setq msg-extra
"showing today's task time.")
1359 (let* ((dt (decode-time (current-time))))
1360 (setq dt
(append (list 0 0 0) (nthcdr 3 dt
)))
1361 (if org-extend-today-until
1362 (setf (nth 2 dt
) org-extend-today-until
))
1363 (apply 'encode-time dt
)))
1364 ((or (equal cmt
"all")
1365 (and (or (not cmt
) (equal cmt
"auto"))
1367 (setq msg-extra
"showing entire task time.")
1369 ((or (equal cmt
"repeat")
1370 (and (or (not cmt
) (equal cmt
"auto"))
1372 (setq msg-extra
"showing task time since last repeat.")
1375 (org-time-string-to-time lr
)))
1378 (defun org-clock-find-position (find-unclosed)
1379 "Find the location where the next clock line should be inserted.
1380 When FIND-UNCLOSED is non-nil, first check if there is an unclosed clock
1381 line and position cursor in that line."
1382 (org-back-to-heading t
)
1384 (let* ((org-clock-into-drawer (org-clock-into-drawer))
1385 (beg (save-excursion
1386 (beginning-of-line 2)
1387 (or (bolp) (newline))
1389 (end (progn (outline-next-heading) (point)))
1390 (re (concat "^[ \t]*" org-clock-string
))
1392 (drawer (if (stringp org-clock-into-drawer
)
1393 org-clock-into-drawer
"LOGBOOK"))
1394 first last ind-last
)
1396 (when (and find-unclosed
1398 (concat "^[ \t]*" org-clock-string
1399 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1400 " *\\sw+ +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")
1402 (beginning-of-line 1)
1404 (when (eobp) (newline) (setq end
(max (point) end
)))
1405 (when (re-search-forward (concat "^[ \t]*:" drawer
":") end t
)
1406 ;; we seem to have a CLOCK drawer, so go there.
1407 (beginning-of-line 2)
1408 (or org-log-states-order-reversed
1409 (and (re-search-forward org-property-end-re nil t
)
1410 (goto-char (match-beginning 0))))
1412 ;; Lets count the CLOCK lines
1414 (while (re-search-forward re end t
)
1415 (setq first
(or first
(match-beginning 0))
1416 last
(match-beginning 0)
1418 (when (and (integerp org-clock-into-drawer
)
1420 (>= (1+ cnt
) org-clock-into-drawer
))
1421 ;; Wrap current entries into a new drawer
1423 (setq ind-last
(org-get-indentation))
1424 (beginning-of-line 2)
1425 (if (and (>= (org-get-indentation) ind-last
)
1427 (when (and (>= (org-get-indentation) ind-last
)
1429 (let ((struct (org-list-struct)))
1430 (goto-char (org-list-get-bottom-point struct
)))))
1432 (beginning-of-line 0)
1433 (org-indent-line-to ind-last
)
1435 (insert ":" drawer
":\n")
1436 (beginning-of-line 0)
1439 (beginning-of-line 2)
1440 (or org-log-states-order-reversed
1441 (and (re-search-forward org-property-end-re nil t
)
1442 (goto-char (match-beginning 0))))
1446 (while (and (looking-at (concat "[ \t]*" org-keyword-time-regexp
))
1447 (not (equal (match-string 1) org-clock-string
)))
1448 ;; Planning info, skip to after it
1449 (beginning-of-line 2)
1450 (or (bolp) (newline)))
1451 (when (or (eq org-clock-into-drawer t
)
1452 (stringp org-clock-into-drawer
)
1453 (and (integerp org-clock-into-drawer
)
1454 (< org-clock-into-drawer
2)))
1455 (insert ":" drawer
":\n:END:\n")
1456 (beginning-of-line -
1)
1459 (beginning-of-line 2)
1462 (or org-log-states-order-reversed
1463 (and (re-search-forward org-property-end-re nil t
)
1464 (goto-char (match-beginning 0))))))))
1467 (defun org-clock-out (&optional switch-to-state fail-quietly at-time
)
1468 "Stop the currently running clock.
1469 Throw an error if there is no running clock and FAIL-QUIETLY is nil.
1470 With a universal prefix, prompt for a state to switch the clocked out task
1471 to, overriding the existing value of `org-clock-out-switch-to-state'."
1474 (when (not (org-clocking-p))
1475 (setq global-mode-string
1476 (delq 'org-mode-line-string global-mode-string
))
1477 (setq frame-title-format org-frame-title-format-backup
)
1478 (force-mode-line-update)
1479 (if fail-quietly
(throw 'exit t
) (user-error "No active clock")))
1480 (let ((org-clock-out-switch-to-state
1482 (completing-read "Switch to state: "
1483 (with-current-buffer
1484 (marker-buffer org-clock-marker
)
1485 org-todo-keywords-1
)
1487 org-clock-out-switch-to-state
))
1488 (now (org-current-time org-clock-rounding-minutes
))
1490 (setq org-clock-out-time now
)
1491 (save-excursion ; Do not replace this with `with-current-buffer'.
1492 (org-no-warnings (set-buffer (org-clocking-buffer)))
1495 (goto-char org-clock-marker
)
1496 (beginning-of-line 1)
1497 (if (and (looking-at (concat "[ \t]*" org-keyword-time-regexp
))
1498 (equal (match-string 1) org-clock-string
))
1499 (setq ts
(match-string 2))
1500 (if fail-quietly
(throw 'exit nil
) (error "Clock start time is gone")))
1501 (goto-char (match-end 0))
1502 (delete-region (point) (point-at-eol))
1504 (setq te
(org-insert-time-stamp (or at-time now
) 'with-hm
'inactive
))
1505 (setq s
(- (org-float-time (apply 'encode-time
(org-parse-time-string te
)))
1506 (org-float-time (apply 'encode-time
(org-parse-time-string ts
))))
1507 h
(floor (/ s
3600))
1511 (insert " => " (format "%2d:%02d" h m
))
1512 (when (setq remove
(and org-clock-out-remove-zero-time-clocks
1514 (beginning-of-line 1)
1515 (delete-region (point) (point-at-eol))
1516 (and (looking-at "\n") (> (point-max) (1+ (point)))
1518 (move-marker org-clock-marker nil
)
1519 (move-marker org-clock-hd-marker nil
)
1520 (when org-log-note-clock-out
1521 (org-add-log-setup 'clock-out nil nil nil nil
1522 (concat "# Task: " (org-get-heading t
) "\n\n")))
1523 (when org-clock-mode-line-timer
1524 (cancel-timer org-clock-mode-line-timer
)
1525 (setq org-clock-mode-line-timer nil
))
1526 (when org-clock-idle-timer
1527 (cancel-timer org-clock-idle-timer
)
1528 (setq org-clock-idle-timer nil
))
1529 (setq global-mode-string
1530 (delq 'org-mode-line-string global-mode-string
))
1531 (setq frame-title-format org-frame-title-format-backup
)
1532 (when org-clock-out-switch-to-state
1534 (org-back-to-heading t
)
1535 (let ((org-inhibit-logging t
)
1536 (org-clock-out-when-done nil
))
1538 ((functionp org-clock-out-switch-to-state
)
1539 (looking-at org-complex-heading-regexp
)
1540 (let ((newstate (funcall org-clock-out-switch-to-state
1542 (if newstate
(org-todo newstate
))))
1543 ((and org-clock-out-switch-to-state
1544 (not (looking-at (concat org-outline-regexp
"[ \t]*"
1545 org-clock-out-switch-to-state
1547 (org-todo org-clock-out-switch-to-state
))))))
1548 (force-mode-line-update)
1549 (message (concat "Clock stopped at %s after "
1550 (org-minutes-to-clocksum-string (+ (* 60 h
) m
)) "%s")
1551 te
(if remove
" => LINE REMOVED" ""))
1552 (let ((h org-clock-out-hook
))
1553 ;; If a closing note needs to be stored in the drawer
1554 ;; where clocks are stored, let's temporarily disable
1555 ;; `org-clock-remove-empty-clock-drawer'
1556 (if (and (equal org-clock-into-drawer org-log-into-drawer
)
1557 (eq org-log-done
'note
)
1558 org-clock-out-when-done
)
1559 (setq h
(delq 'org-clock-remove-empty-clock-drawer h
)))
1560 (mapc (lambda (f) (funcall f
)) h
))
1561 (unless (org-clocking-p)
1562 (setq org-clock-current-task nil
)))))))
1564 (add-hook 'org-clock-out-hook
'org-clock-remove-empty-clock-drawer
)
1566 (defun org-clock-remove-empty-clock-drawer nil
1567 "Remove empty clock drawer in the current subtree."
1568 (let* ((olid (or (org-entry-get (point) "LOG_INTO_DRAWER")
1569 org-log-into-drawer
))
1570 (clock-drawer (if (eq t olid
) "LOGBOOK" olid
))
1571 (end (save-excursion (org-end-of-subtree t t
))))
1574 (org-back-to-heading t
)
1575 (while (and (< (point) end
)
1576 (search-forward clock-drawer end t
))
1577 (goto-char (match-beginning 0))
1578 (org-remove-empty-drawer-at clock-drawer
(point))
1579 (forward-line 1))))))
1581 (defun org-clock-timestamps-up (&optional n
)
1582 "Increase CLOCK timestamps at cursor.
1583 Optional argument N tells to change by that many units."
1585 (org-clock-timestamps-change 'up n
))
1587 (defun org-clock-timestamps-down (&optional n
)
1588 "Increase CLOCK timestamps at cursor.
1589 Optional argument N tells to change by that many units."
1591 (org-clock-timestamps-change 'down n
))
1593 (defun org-clock-timestamps-change (updown &optional n
)
1594 "Change CLOCK timestamps synchronously at cursor.
1595 UPDOWN tells whether to change 'up or 'down.
1596 Optional argument N tells to change by that many units."
1597 (setq org-ts-what nil
)
1598 (when (org-at-timestamp-p t
)
1599 (let ((tschange (if (eq updown
'up
) 'org-timestamp-up
1600 'org-timestamp-down
))
1601 ts1 begts1 ts2 begts2 updatets1 tdiff
)
1603 (move-beginning-of-line 1)
1604 (re-search-forward org-ts-regexp3 nil t
)
1605 (setq ts1
(match-string 0) begts1
(match-beginning 0))
1606 (when (re-search-forward org-ts-regexp3 nil t
)
1607 (setq ts2
(match-string 0) begts2
(match-beginning 0))))
1608 ;; Are we on the second timestamp?
1609 (if (<= begts2
(point)) (setq updatets1 t
))
1611 ;; fall back on org-timestamp-up if there is only one
1612 (funcall tschange n
)
1613 ;; setq this so that (boundp 'org-ts-what is non-nil)
1614 (funcall tschange n
)
1615 (let ((ts (if updatets1 ts2 ts1
))
1616 (begts (if updatets1 begts1 begts2
)))
1619 (org-time-string-to-time org-last-changed-timestamp
)
1620 (org-time-string-to-time ts
)))
1623 (org-timestamp-change
1624 (round (/ (org-float-time tdiff
)
1625 (cond ((eq org-ts-what
'minute
) 60)
1626 ((eq org-ts-what
'hour
) 3600)
1627 ((eq org-ts-what
'day
) (* 24 3600))
1628 ((eq org-ts-what
'month
) (* 24 3600 31))
1629 ((eq org-ts-what
'year
) (* 24 3600 365.2)))))
1630 org-ts-what
'updown
)))))))
1633 (defun org-clock-cancel ()
1634 "Cancel the running clock by removing the start timestamp."
1636 (when (not (org-clocking-p))
1637 (setq global-mode-string
1638 (delq 'org-mode-line-string global-mode-string
))
1639 (setq frame-title-format org-frame-title-format-backup
)
1640 (force-mode-line-update)
1641 (error "No active clock"))
1642 (save-excursion ; Do not replace this with `with-current-buffer'.
1643 (org-no-warnings (set-buffer (org-clocking-buffer)))
1644 (goto-char org-clock-marker
)
1645 (if (org-looking-back (concat "^[ \t]*" org-clock-string
".*"))
1646 (progn (delete-region (1- (point-at-bol)) (point-at-eol))
1647 (org-remove-empty-drawer-at "LOGBOOK" (point)))
1648 (message "Clock gone, cancel the timer anyway")
1650 (move-marker org-clock-marker nil
)
1651 (move-marker org-clock-hd-marker nil
)
1652 (setq global-mode-string
1653 (delq 'org-mode-line-string global-mode-string
))
1654 (setq frame-title-format org-frame-title-format-backup
)
1655 (force-mode-line-update)
1656 (message "Clock canceled")
1657 (run-hooks 'org-clock-cancel-hook
))
1660 (defun org-clock-goto (&optional select
)
1661 "Go to the currently clocked-in entry, or to the most recently clocked one.
1662 With prefix arg SELECT, offer recently clocked tasks for selection."
1667 (or (org-clock-select-task "Select task to go to: ")
1668 (error "No task selected")))
1669 ((org-clocking-p) org-clock-marker
)
1670 ((and org-clock-goto-may-find-recent-task
1671 (car org-clock-history
)
1672 (marker-buffer (car org-clock-history
)))
1674 (car org-clock-history
))
1675 (t (error "No active or recent clock task")))))
1676 (org-pop-to-buffer-same-window (marker-buffer m
))
1677 (if (or (< m
(point-min)) (> m
(point-max))) (widen))
1680 (org-back-to-heading t
)
1681 (org-cycle-hide-drawers 'children
)
1685 (message "No running clock, this is the most recently clocked task"))
1686 (run-hooks 'org-clock-goto-hook
)))
1688 (defvar org-clock-file-total-minutes nil
1689 "Holds the file total time in minutes, after a call to `org-clock-sum'.")
1690 (make-variable-buffer-local 'org-clock-file-total-minutes
)
1692 (defun org-clock-sum-today (&optional headline-filter
)
1693 "Sum the times for each subtree for today."
1695 (let ((range (org-clock-special-range 'today
)))
1696 (org-clock-sum (car range
) (cadr range
) nil
:org-clock-minutes-today
)))
1699 (defun org-clock-sum (&optional tstart tend headline-filter propname
)
1700 "Sum the times for each subtree.
1701 Puts the resulting times in minutes as a text property on each headline.
1702 TSTART and TEND can mark a time range to be considered.
1703 HEADLINE-FILTER is a zero-arg function that, if specified, is called for
1704 each headline in the time range with point at the headline. Headlines for
1705 which HEADLINE-FILTER returns nil are excluded from the clock summation.
1706 PROPNAME lets you set a custom text property instead of :org-clock-minutes."
1708 (org-with-silent-modifications
1709 (let* ((re (concat "^\\(\\*+\\)[ \t]\\|^[ \t]*"
1711 "[ \t]*\\(?:\\(\\[.*?\\]\\)-+\\(\\[.*?\\]\\)\\|=>[ \t]+\\([0-9]+\\):\\([0-9]+\\)\\)"))
1713 (ltimes (make-vector lmax
0))
1718 (if (stringp tstart
) (setq tstart
(org-time-string-to-seconds tstart
)))
1719 (if (stringp tend
) (setq tend
(org-time-string-to-seconds tend
)))
1720 (if (consp tstart
) (setq tstart
(org-float-time tstart
)))
1721 (if (consp tend
) (setq tend
(org-float-time tend
)))
1722 (remove-text-properties (point-min) (point-max)
1723 `(,(or propname
:org-clock-minutes
) t
1724 :org-clock-force-headline-inclusion t
))
1726 (goto-char (point-max))
1727 (while (re-search-backward re nil t
)
1731 (setq ts
(match-string 2)
1734 (apply 'encode-time
(org-parse-time-string ts
)))
1736 (apply 'encode-time
(org-parse-time-string te
)))
1737 ts
(if tstart
(max ts tstart
) ts
)
1738 te
(if tend
(min te tend
) te
)
1740 t1
(if (> dt
0) (+ t1
(floor (/ dt
60))) t1
)))
1743 (setq t1
(+ t1
(string-to-number (match-string 5))
1744 (* 60 (string-to-number (match-string 4))))))
1746 ;; Add the currently clocking item time to the total
1747 (when (and org-clock-report-include-clocking-task
1748 (equal (org-clocking-buffer) (current-buffer))
1749 (equal (marker-position org-clock-hd-marker
) (point))
1752 (>= (org-float-time org-clock-start-time
) tstart
)
1753 (<= (org-float-time org-clock-start-time
) tend
))
1754 (let ((time (floor (- (org-float-time)
1755 (org-float-time org-clock-start-time
)) 60)))
1756 (setq t1
(+ t1 time
))))
1757 (let* ((headline-forced
1758 (get-text-property (point)
1759 :org-clock-force-headline-inclusion
))
1761 (or (null headline-filter
)
1763 (save-match-data (funcall headline-filter
))))))
1764 (setq level
(- (match-end 1) (match-beginning 1)))
1765 (when (or (> t1
0) (> (aref ltimes level
) 0))
1766 (when (or headline-included headline-forced
)
1767 (if headline-included
1768 (loop for l from
0 to level do
1769 (aset ltimes l
(+ (aref ltimes l
) t1
))))
1770 (setq time
(aref ltimes level
))
1771 (goto-char (match-beginning 0))
1772 (put-text-property (point) (point-at-eol)
1773 (or propname
:org-clock-minutes
) time
)
1778 (> (funcall outline-level
) 1)
1779 (outline-up-heading 1 t
)
1781 (point) (point-at-eol)
1782 :org-clock-force-headline-inclusion t
))))))
1784 (loop for l from level to
(1- lmax
) do
1785 (aset ltimes l
0)))))))
1786 (setq org-clock-file-total-minutes
(aref ltimes
0))))))
1788 (defun org-clock-sum-current-item (&optional tstart
)
1789 "Return time, clocked on current item in total."
1792 (org-narrow-to-subtree)
1793 (org-clock-sum tstart
)
1794 org-clock-file-total-minutes
)))
1797 (defun org-clock-display (&optional total-only
)
1798 "Show subtree times in the entire buffer.
1799 If TOTAL-ONLY is non-nil, only show the total time for the entire file
1802 Use \\[org-clock-remove-overlays] to remove the subtree times."
1804 (org-clock-remove-overlays)
1809 (goto-char (point-min))
1810 (while (or (and (equal (setq p
(point)) (point-min))
1811 (get-text-property p
:org-clock-minutes
))
1812 (setq p
(next-single-property-change
1813 (point) :org-clock-minutes
)))
1815 (when (setq time
(get-text-property p
:org-clock-minutes
))
1816 (org-clock-put-overlay time
(funcall outline-level
))))
1817 (setq h
(/ org-clock-file-total-minutes
60)
1818 m
(- org-clock-file-total-minutes
(* 60 h
)))
1819 ;; Arrange to remove the overlays upon next change.
1820 (when org-remove-highlights-with-change
1821 (org-add-hook 'before-change-functions
'org-clock-remove-overlays
1823 (message (concat "Total file time: "
1824 (org-minutes-to-clocksum-string org-clock-file-total-minutes
)
1825 " (%d hours and %d minutes)") h m
)))
1827 (defvar org-clock-overlays nil
)
1828 (make-variable-buffer-local 'org-clock-overlays
)
1830 (defun org-clock-put-overlay (time &optional level
)
1831 "Put an overlays on the current line, displaying TIME.
1832 If LEVEL is given, prefix time with a corresponding number of stars.
1833 This creates a new overlay and stores it in `org-clock-overlays', so that it
1834 will be easy to remove."
1835 (let* ((c 60) (h (floor (/ time
60))) (m (- time
(* 60 h
)))
1836 (l (if level
(org-get-valid-level level
0) 0))
1839 (org-move-to-column c
)
1840 (unless (eolp) (skip-chars-backward "^ \t"))
1841 (skip-chars-backward " \t")
1842 (setq ov
(make-overlay (point-at-bol) (point-at-eol))
1843 tx
(concat (buffer-substring (point-at-bol) (point))
1844 (make-string (+ off
(max 0 (- c
(current-column)))) ?.
)
1845 (org-add-props (concat (make-string l ?
*) " "
1846 (org-minutes-to-clocksum-string time
)
1847 (make-string (- 16 l
) ?\
))
1848 (list 'face
'org-clock-overlay
))
1850 (if (not (featurep 'xemacs
))
1851 (overlay-put ov
'display tx
)
1852 (overlay-put ov
'invisible t
)
1853 (overlay-put ov
'end-glyph
(make-glyph tx
)))
1854 (push ov org-clock-overlays
)))
1856 (defun org-clock-remove-overlays (&optional beg end noremove
)
1857 "Remove the occur highlights from the buffer.
1858 BEG and END are ignored. If NOREMOVE is nil, remove this function
1859 from the `before-change-functions' in the current buffer."
1861 (unless org-inhibit-highlight-removal
1862 (mapc 'delete-overlay org-clock-overlays
)
1863 (setq org-clock-overlays nil
)
1865 (remove-hook 'before-change-functions
1866 'org-clock-remove-overlays
'local
))))
1868 (defvar org-state
) ;; dynamically scoped into this function
1869 (defun org-clock-out-if-current ()
1870 "Clock out if the current entry contains the running clock.
1871 This is used to stop the clock after a TODO entry is marked DONE,
1872 and is only done if the variable `org-clock-out-when-done' is not nil."
1873 (when (and (org-clocking-p)
1874 org-clock-out-when-done
1875 (marker-buffer org-clock-marker
)
1876 (or (and (eq t org-clock-out-when-done
)
1877 (member org-state org-done-keywords
))
1878 (and (listp org-clock-out-when-done
)
1879 (member org-state org-clock-out-when-done
)))
1880 (equal (or (buffer-base-buffer (org-clocking-buffer))
1881 (org-clocking-buffer))
1882 (or (buffer-base-buffer (current-buffer))
1884 (< (point) org-clock-marker
)
1885 (> (save-excursion (outline-next-heading) (point))
1887 ;; Clock out, but don't accept a logging message for this.
1888 (let ((org-log-note-clock-out nil
)
1889 (org-clock-out-switch-to-state nil
))
1892 (add-hook 'org-after-todo-state-change-hook
1893 'org-clock-out-if-current
)
1896 (defun org-clock-get-clocktable (&rest props
)
1897 "Get a formatted clocktable with parameters according to PROPS.
1898 The table is created in a temporary buffer, fully formatted and
1899 fontified, and then returned."
1901 (setq props
(plist-put props
:name
"clocktable"))
1902 (unless (plist-member props
:maxlevel
)
1903 (setq props
(plist-put props
:maxlevel
2)))
1904 (unless (plist-member props
:scope
)
1905 (setq props
(plist-put props
:scope
'agenda
)))
1908 (org-create-dblock props
)
1910 (font-lock-fontify-buffer)
1912 (buffer-substring (point) (progn
1913 (re-search-forward "^[ \t]*#\\+END" nil t
)
1917 (defun org-clock-report (&optional arg
)
1918 "Create a table containing a report about clocked time.
1919 If the cursor is inside an existing clocktable block, then the table
1920 will be updated. If not, a new clocktable will be inserted. The scope
1921 of the new clock will be subtree when called from within a subtree, and
1924 When called with a prefix argument, move to the first clock table in the
1925 buffer and update it."
1927 (org-clock-remove-overlays)
1929 (org-find-dblock "clocktable")
1931 (if (org-in-clocktable-p)
1932 (goto-char (org-in-clocktable-p))
1933 (let ((props (if (ignore-errors
1934 (save-excursion (org-back-to-heading)))
1935 (list :name
"clocktable" :scope
'subtree
)
1936 (list :name
"clocktable"))))
1938 (org-combine-plists org-clock-clocktable-default-properties props
))))
1939 (org-update-dblock))
1941 (defun org-day-of-week (day month year
)
1942 "Returns the day of the week as an integer."
1946 (format "%d-%02d-%02dT00:00:00" year month day
)))))
1948 (defun org-quarter-to-date (quarter year
)
1949 "Get the date (week day year) of the first day of a given quarter."
1953 (setq startday
(org-day-of-week 1 1 year
))
1956 (list 52 7 (- year
1)))
1958 (list 52 6 (- year
1)))
1960 (list 1 startday year
))
1962 (list 53 startday
(- year
1)))
1966 (setq startday
(org-day-of-week 1 4 year
))
1969 (list 13 startday year
))
1971 (list 14 startday year
))
1973 (list 13 startday year
))
1977 (setq startday
(org-day-of-week 1 7 year
))
1980 (list 26 startday year
))
1982 (list 27 startday year
))
1984 (list 26 startday year
))
1988 (setq startday
(org-day-of-week 1 10 year
))
1991 (list 39 startday year
))
1993 (list 40 startday year
))
1995 (list 39 startday year
)))))))
1997 (defun org-clock-special-range (key &optional time as-strings wstart mstart
)
1998 "Return two times bordering a special time range.
1999 Key is a symbol specifying the range and can be one of `today', `yesterday',
2000 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
2001 By default, a week starts Monday 0:00 and ends Sunday 24:00.
2002 The range is determined relative to TIME, which defaults to current time.
2003 The return value is a cons cell with two internal times like the ones
2004 returned by `current time' or `encode-time'.
2005 If AS-STRINGS is non-nil, the returned times will be formatted strings.
2006 If WSTART is non-nil, use this number to specify the starting day of a
2008 If MSTART is non-nil, use this number to specify the starting day of a
2009 month (1 is the first day of the month).
2010 If you can combine both, the month starting day will have priority."
2011 (if (integerp key
) (setq key
(intern (number-to-string key
))))
2012 (let* ((tm (decode-time (or time
(current-time))))
2013 (s 0) (m (nth 1 tm
)) (h (nth 2 tm
))
2014 (d (nth 3 tm
)) (month (nth 4 tm
)) (y (nth 5 tm
))
2018 (skey (symbol-name key
))
2020 (q (cond ((>= (nth 4 tm
) 10) 4)
2021 ((>= (nth 4 tm
) 7) 3)
2022 ((>= (nth 4 tm
) 4) 2)
2023 ((>= (nth 4 tm
) 1) 1)))
2024 s1 m1 h1 d1 month1 y1 diff ts te fm txt w date
2025 interval tmp shiftedy shiftedm shiftedq
)
2027 ((string-match "^[0-9]+$" skey
)
2028 (setq y
(string-to-number skey
) m
1 d
1 key
'year
))
2029 ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)$" skey
)
2030 (setq y
(string-to-number (match-string 1 skey
))
2031 month
(string-to-number (match-string 2 skey
))
2033 ((string-match "^\\([0-9]+\\)-[wW]\\([0-9]\\{1,2\\}\\)$" skey
)
2035 (setq y
(string-to-number (match-string 1 skey
))
2036 w
(string-to-number (match-string 2 skey
)))
2037 (setq date
(calendar-gregorian-from-absolute
2038 (calendar-absolute-from-iso (list w
1 y
))))
2039 (setq d
(nth 1 date
) month
(car date
) y
(nth 2 date
)
2042 ((string-match "^\\([0-9]+\\)-[qQ]\\([1-4]\\)$" skey
)
2044 (setq y
(string-to-number (match-string 1 skey
)))
2045 (setq q
(string-to-number (match-string 2 skey
)))
2046 (setq date
(calendar-gregorian-from-absolute
2047 (calendar-absolute-from-iso (org-quarter-to-date q y
))))
2048 (setq d
(nth 1 date
) month
(car date
) y
(nth 2 date
)
2051 ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)-\\([0-9]\\{1,2\\}\\)$" skey
)
2052 (setq y
(string-to-number (match-string 1 skey
))
2053 month
(string-to-number (match-string 2 skey
))
2054 d
(string-to-number (match-string 3 skey
))
2056 ((string-match "\\([-+][0-9]+\\)$" skey
)
2057 (setq shift
(string-to-number (match-string 1 skey
))
2058 key
(intern (substring skey
0 (match-beginning 1))))
2059 (if (and (memq key
'(quarter thisq
)) (> shift
0))
2060 (error "Looking forward with quarters isn't implemented"))))
2063 (cond ((eq key
'yesterday
) (setq key
'today shift -
1))
2064 ((eq key
'lastweek
) (setq key
'week shift -
1))
2065 ((eq key
'lastmonth
) (setq key
'month shift -
1))
2066 ((eq key
'lastyear
) (setq key
'year shift -
1))
2067 ((eq key
'lastq
) (setq key
'quarter shift -
1))))
2069 ((memq key
'(day today
))
2070 (setq d
(+ d shift
) h
0 m
0 h1
24 m1
0))
2071 ((memq key
'(week thisweek
))
2072 (setq diff
(+ (* -
7 shift
) (if (= dow
0) (- 7 ws
) (- dow ws
)))
2073 m
0 h
0 d
(- d diff
) d1
(+ 7 d
)))
2074 ((memq key
'(month thismonth
))
2075 (setq d
(or ms
1) h
0 m
0 d1
(or ms
1)
2076 month
(+ month shift
) month1
(1+ month
) h1
0 m1
0))
2077 ((memq key
'(quarter thisq
))
2078 ;; Compute if this shift remains in this year. If not, compute
2079 ;; how many years and quarters we have to shift (via floor*) and
2080 ;; compute the shifted years, months and quarters.
2082 ((< (+ (- q
1) shift
) 0) ; shift not in this year
2083 (setq interval
(* -
1 (+ (- q
1) shift
)))
2084 ;; Set tmp to ((years to shift) (quarters to shift)).
2085 (setq tmp
(org-floor* interval
4))
2086 ;; Due to the use of floor, 0 quarters actually means 4.
2087 (if (= 0 (nth 1 tmp
))
2088 (setq shiftedy
(- y
(nth 0 tmp
))
2091 (setq shiftedy
(- y
(+ 1 (nth 0 tmp
)))
2092 shiftedm
(- 13 (* 3 (nth 1 tmp
)))
2093 shiftedq
(- 5 (nth 1 tmp
))))
2094 (setq d
1 h
0 m
0 d1
1 month shiftedm month1
(+ 3 shiftedm
) h1
0 m1
0 y shiftedy
))
2095 ((> (+ q shift
) 0) ; shift is within this year
2096 (setq shiftedq
(+ q shift
))
2098 (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))))
2099 ((memq key
'(year thisyear
))
2100 (setq m
0 h
0 d
1 month
1 y
(+ y shift
) y1
(1+ y
)))
2101 (t (error "No such time block %s" key
)))
2102 (setq ts
(encode-time s m h d month y
)
2103 te
(encode-time (or s1 s
) (or m1 m
) (or h1 h
)
2104 (or d1 d
) (or month1 month
) (or y1 y
)))
2105 (setq fm
(cdr org-time-stamp-formats
))
2107 ((memq key
'(day today
))
2108 (setq txt
(format-time-string "%A, %B %d, %Y" ts
)))
2109 ((memq key
'(week thisweek
))
2110 (setq txt
(format-time-string "week %G-W%V" ts
)))
2111 ((memq key
'(month thismonth
))
2112 (setq txt
(format-time-string "%B %Y" ts
)))
2113 ((memq key
'(year thisyear
))
2114 (setq txt
(format-time-string "the year %Y" ts
)))
2115 ((memq key
'(quarter thisq
))
2116 (setq txt
(concat (org-count-quarter shiftedq
) " quarter of " (number-to-string shiftedy
)))))
2118 (list (format-time-string fm ts
) (format-time-string fm te
) txt
)
2121 (defun org-count-quarter (n)
2128 (defun org-clocktable-shift (dir n
)
2129 "Try to shift the :block date of the clocktable at point.
2130 Point must be in the #+BEGIN: line of a clocktable, or this function
2131 will throw an error.
2132 DIR is a direction, a symbol `left', `right', `up', or `down'.
2133 Both `left' and `down' shift the block toward the past, `up' and `right'
2134 push it toward the future.
2135 N is the number of shift steps to take. The size of the step depends on
2136 the currently selected interval size."
2137 (setq n
(prefix-numeric-value n
))
2138 (and (memq dir
'(left down
)) (setq n
(- n
)))
2140 (goto-char (point-at-bol))
2141 (if (not (looking-at "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>.*?:block[ \t]+\\(\\S-+\\)"))
2142 (error "Line needs a :block definition before this command works")
2143 (let* ((b (match-beginning 1)) (e (match-end 1))
2144 (s (match-string 1))
2145 block shift ins y mw d date wp m
)
2147 ((equal s
"yesterday") (setq s
"today-1"))
2148 ((equal s
"lastweek") (setq s
"thisweek-1"))
2149 ((equal s
"lastmonth") (setq s
"thismonth-1"))
2150 ((equal s
"lastyear") (setq s
"thisyear-1"))
2151 ((equal s
"lastq") (setq s
"thisq-1")))
2154 ((string-match "^\\(today\\|thisweek\\|thismonth\\|thisyear\\|thisq\\)\\([-+][0-9]+\\)?$" s
)
2155 (setq block
(match-string 1 s
)
2156 shift
(if (match-end 2)
2157 (string-to-number (match-string 2 s
))
2159 (setq shift
(+ shift n
))
2160 (setq ins
(if (= shift
0) block
(format "%s%+d" block shift
))))
2161 ((string-match "\\([0-9]+\\)\\(-\\([wWqQ]?\\)\\([0-9]\\{1,2\\}\\)\\(-\\([0-9]\\{1,2\\}\\)\\)?\\)?" s
)
2162 ;; 1 1 2 3 3 4 4 5 6 6 5 2
2163 (setq y
(string-to-number (match-string 1 s
))
2164 wp
(and (match-end 3) (match-string 3 s
))
2165 mw
(and (match-end 4) (string-to-number (match-string 4 s
)))
2166 d
(and (match-end 6) (string-to-number (match-string 6 s
))))
2168 (d (setq ins
(format-time-string
2170 (encode-time 0 0 0 (+ d n
) m y
))))
2171 ((and wp
(string-match "w\\|W" wp
) mw
(> (length wp
) 0))
2173 (setq date
(calendar-gregorian-from-absolute
2174 (calendar-absolute-from-iso (list (+ mw n
) 1 y
))))
2175 (setq ins
(format-time-string
2177 (encode-time 0 0 0 (nth 1 date
) (car date
) (nth 2 date
)))))
2178 ((and wp
(string-match "q\\|Q" wp
) mw
(> (length wp
) 0))
2180 ; if the 4th + 1 quarter is requested we flip to the 1st quarter of the next year
2185 ; if the 1st - 1 quarter is requested we flip to the 4th quarter of the previous year
2190 (setq date
(calendar-gregorian-from-absolute
2191 (calendar-absolute-from-iso (org-quarter-to-date (+ mw n
) y
))))
2192 (setq ins
(format-time-string
2193 (concat (number-to-string y
) "-Q" (number-to-string (+ mw n
)))
2194 (encode-time 0 0 0 (nth 1 date
) (car date
) (nth 2 date
)))))
2196 (setq ins
(format-time-string
2198 (encode-time 0 0 0 1 (+ mw n
) y
))))
2200 (setq ins
(number-to-string (+ y n
))))))
2201 (t (error "Cannot shift clocktable block")))
2205 (delete-region (point) (+ (point) (- e b
)))
2206 (beginning-of-line 1)
2211 (defun org-dblock-write:clocktable
(params)
2212 "Write the standard clocktable."
2213 (setq params
(org-combine-plists org-clocktable-defaults params
))
2215 (let* ((scope (plist-get params
:scope
))
2216 (block (plist-get params
:block
))
2217 (ts (plist-get params
:tstart
))
2218 (te (plist-get params
:tend
))
2219 (link (plist-get params
:link
))
2220 (maxlevel (or (plist-get params
:maxlevel
) 3))
2221 (ws (plist-get params
:wstart
))
2222 (ms (plist-get params
:mstart
))
2223 (step (plist-get params
:step
))
2224 (timestamp (plist-get params
:timestamp
))
2225 (formatter (or (plist-get params
:formatter
)
2226 org-clock-clocktable-formatter
2227 'org-clocktable-write-default
))
2228 cc range-text ipos pos one-file-with-archives
2229 scope-is-list tbls level
)
2230 ;; Check if we need to do steps
2232 ;; Get the range text for the header
2233 (setq cc
(org-clock-special-range block nil t ws ms
)
2234 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2236 ;; Write many tables, in steps
2237 (unless (or block
(and ts te
))
2238 (error "Clocktable `:step' can only be used with `:block' or `:tstart,:end'"))
2239 (org-clocktable-steps params
)
2242 (setq ipos
(point)) ; remember the insertion position
2244 ;; Get the right scope
2247 ((and scope
(listp scope
) (symbolp (car scope
)))
2248 (setq scope
(eval scope
)))
2250 (setq scope
(org-agenda-files t
)))
2251 ((eq scope
'agenda-with-archives
)
2252 (setq scope
(org-agenda-files t
))
2253 (setq scope
(org-add-archive-files scope
)))
2254 ((eq scope
'file-with-archives
)
2255 (setq scope
(org-add-archive-files (list (buffer-file-name)))
2256 one-file-with-archives t
)))
2257 (setq scope-is-list
(and scope
(listp scope
)))
2259 ;; we collect from several files
2260 (let* ((files scope
)
2262 (org-agenda-prepare-buffers files
)
2263 (while (setq file
(pop files
))
2264 (with-current-buffer (find-buffer-visiting file
)
2267 (push (org-clock-get-table-data file params
) tbls
))))))
2268 ;; Just from the current file
2270 ;; get the right range into the restriction
2271 (org-agenda-prepare-buffers (list (buffer-file-name)))
2273 ((not scope
)) ; use the restriction as it is now
2274 ((eq scope
'file
) (widen))
2275 ((eq scope
'subtree
) (org-narrow-to-subtree))
2277 (while (org-up-heading-safe))
2278 (org-narrow-to-subtree))
2279 ((and (symbolp scope
) (string-match "^tree\\([0-9]+\\)$"
2280 (symbol-name scope
)))
2281 (setq level
(string-to-number (match-string 1 (symbol-name scope
))))
2283 (while (org-up-heading-safe)
2284 (looking-at org-outline-regexp
)
2285 (if (<= (org-reduced-level (funcall outline-level
)) level
)
2286 (throw 'exit nil
))))
2287 (org-narrow-to-subtree)))
2288 ;; do the table, with no file name.
2289 (push (org-clock-get-table-data nil params
) tbls
)))
2291 ;; OK, at this point we tbls as a list of tables, one per file
2292 (setq tbls
(nreverse tbls
))
2294 (setq params
(plist-put params
:multifile scope-is-list
))
2295 (setq params
(plist-put params
:one-file-with-archives
2296 one-file-with-archives
))
2298 (funcall formatter ipos tbls params
))))
2300 (defun org-clocktable-write-default (ipos tables params
)
2301 "Write out a clock table at position IPOS in the current buffer.
2302 TABLES is a list of tables with clocking data as produced by
2303 `org-clock-get-table-data'. PARAMS is the parameter property list obtained
2304 from the dynamic block definition."
2305 ;; This function looks quite complicated, mainly because there are a
2306 ;; lot of options which can add or remove columns. I have massively
2307 ;; commented this function, the I hope it is understandable. If
2308 ;; someone wants to write their own special formatter, this maybe
2309 ;; much easier because there can be a fixed format with a
2310 ;; well-defined number of columns...
2311 (let* ((hlchars '((1 .
"*") (2 .
"/")))
2312 (lwords (assoc (or (plist-get params
:lang
)
2313 (org-bound-and-true-p org-export-default-language
)
2315 org-clock-clocktable-language-setup
))
2316 (multifile (plist-get params
:multifile
))
2317 (block (plist-get params
:block
))
2318 (ts (plist-get params
:tstart
))
2319 (te (plist-get params
:tend
))
2320 (header (plist-get params
:header
))
2321 (narrow (plist-get params
:narrow
))
2322 (ws (or (plist-get params
:wstart
) 1))
2323 (ms (or (plist-get params
:mstart
) 1))
2324 (link (plist-get params
:link
))
2325 (maxlevel (or (plist-get params
:maxlevel
) 3))
2326 (emph (plist-get params
:emphasize
))
2327 (level-p (plist-get params
:level
))
2328 (org-time-clocksum-use-effort-durations
2329 (plist-get params
:effort-durations
))
2330 (timestamp (plist-get params
:timestamp
))
2331 (properties (plist-get params
:properties
))
2332 (ntcol (max 1 (or (plist-get params
:tcolumns
) 100)))
2333 (rm-file-column (plist-get params
:one-file-with-archives
))
2334 (indent (plist-get params
:indent
))
2335 (case-fold-search t
)
2336 range-text total-time tbl level hlc formula pcol
2337 file-time entries entry headline
2338 recalc content narrow-cut-p tcol
)
2340 ;; Implement abbreviations
2341 (when (plist-get params
:compact
)
2342 (setq level nil indent t narrow
(or narrow
'40!) ntcol
1))
2344 ;; Some consistency test for parameters
2345 (unless (integerp ntcol
)
2346 (setq params
(plist-put params
:tcolumns
(setq ntcol
100))))
2348 (when (and narrow
(integerp narrow
) link
)
2349 ;; We cannot have both integer narrow and link
2351 "Using hard narrowing in clocktable to allow for links")
2352 (setq narrow
(intern (format "%d!" narrow
))))
2357 ((and (symbolp narrow
)
2358 (string-match "\\`[0-9]+!\\'" (symbol-name narrow
)))
2359 (setq narrow-cut-p t
2360 narrow
(string-to-number (substring (symbol-name narrow
)
2363 (error "Invalid value %s of :narrow property in clock table"
2367 ;; Get the range text for the header
2368 (setq range-text
(nth 2 (org-clock-special-range block nil t ws ms
))))
2370 ;; Compute the total time
2371 (setq total-time
(apply '+ (mapcar 'cadr tables
)))
2373 ;; Now we need to output this tsuff
2376 ;; Insert the text *before* the actual table
2377 (insert-before-markers
2379 ;; Format the standard header
2384 (format-time-string (cdr org-time-stamp-formats
))
2387 (if block
(concat ", for " range-text
".") "")
2390 ;; Insert the narrowing line
2391 (when (and narrow
(integerp narrow
) (not narrow-cut-p
))
2392 (insert-before-markers
2393 "|" ; table line starter
2394 (if multifile
"|" "") ; file column, maybe
2395 (if level-p
"|" "") ; level column, maybe
2396 (if timestamp
"|" "") ; timestamp column, maybe
2397 (if properties
(make-string (length properties
) ?|
) "") ;properties columns, maybe
2398 (format "<%d>| |\n" narrow
))) ; headline and time columns
2400 ;; Insert the table header line
2401 (insert-before-markers
2402 "|" ; table line starter
2403 (if multifile
(concat (nth 1 lwords
) "|") "") ; file column, maybe
2404 (if level-p
(concat (nth 2 lwords
) "|") "") ; level column, maybe
2405 (if timestamp
(concat (nth 3 lwords
) "|") "") ; timestamp column, maybe
2406 (if properties
(concat (mapconcat 'identity properties
"|") "|") "") ;properties columns, maybe
2407 (concat (nth 4 lwords
) "|"
2408 (nth 5 lwords
) "|\n")) ; headline and time columns
2410 ;; Insert the total time in the table
2411 (insert-before-markers
2413 "|" ; table line starter
2414 (if multifile
(concat "| " (nth 6 lwords
) " ") "")
2415 ; file column, maybe
2416 (if level-p
"|" "") ; level column, maybe
2417 (if timestamp
"|" "") ; timestamp column, maybe
2418 (if properties
(make-string (length properties
) ?|
) "") ; properties columns, maybe
2419 (concat (format org-clock-total-time-cell-format
(nth 7 lwords
)) "| ") ; instead of a headline
2420 (format org-clock-total-time-cell-format
2421 (org-minutes-to-clocksum-string (or total-time
0))) ; the time
2424 ;; Now iterate over the tables and insert the data
2425 ;; but only if any time has been collected
2426 (when (and total-time
(> total-time
0))
2428 (while (setq tbl
(pop tables
))
2429 ;; now tbl is the table resulting from one file.
2430 (setq file-time
(nth 1 tbl
))
2431 (when (or (and file-time
(> file-time
0))
2432 (not (plist-get params
:fileskip0
)))
2433 (insert-before-markers "|-\n") ; a hline because a new file starts
2434 ;; First the file time, if we have multiple files
2436 ;; Summarize the time collected from this file
2437 (insert-before-markers
2438 (format (concat "| %s %s | %s%s"
2439 (format org-clock-file-time-cell-format
(nth 8 lwords
))
2441 (file-name-nondirectory (car tbl
))
2442 (if level-p
"| " "") ; level column, maybe
2443 (if timestamp
"| " "") ; timestamp column, maybe
2444 (if properties
(make-string (length properties
) ?|
) "") ;properties columns, maybe
2445 (org-minutes-to-clocksum-string (nth 1 tbl
))))) ; the time
2447 ;; Get the list of node entries and iterate over it
2448 (setq entries
(nth 2 tbl
))
2449 (while (setq entry
(pop entries
))
2450 (setq level
(car entry
)
2451 headline
(nth 1 entry
)
2452 hlc
(if emph
(or (cdr (assoc level hlchars
)) "") ""))
2454 (if (and (string-match (concat "\\`" org-bracket-link-regexp
2459 (format "[[%s][%s]]"
2460 (match-string 1 headline
)
2461 (org-shorten-string (match-string 3 headline
)
2463 (setq headline
(org-shorten-string headline narrow
))))
2464 (insert-before-markers
2465 "|" ; start the table line
2466 (if multifile
"|" "") ; free space for file name column?
2467 (if level-p
(format "%d|" (car entry
)) "") ; level, maybe
2468 (if timestamp
(concat (nth 2 entry
) "|") "") ; timestamp, maybe
2472 (lambda (p) (or (cdr (assoc p
(nth 4 entry
))) ""))
2473 properties
"|") "|") "") ;properties columns, maybe
2474 (if indent
(org-clocktable-indent-string level
) "") ; indentation
2475 hlc headline hlc
"|" ; headline
2476 (make-string (min (1- ntcol
) (or (- level
1))) ?|
)
2477 ; empty fields for higher levels
2478 hlc
(org-minutes-to-clocksum-string (nth 3 entry
)) hlc
; time
2481 ;; When exporting subtrees or regions the region might be
2482 ;; activated, so let's disable ̀delete-active-region'
2483 (let ((delete-active-region nil
)) (backward-delete-char 1))
2484 (if (setq formula
(plist-get params
:formula
))
2487 ;; compute the column where the % numbers need to go
2492 (min maxlevel
(or ntcol
100))))
2493 ;; compute the column where the total time is
2497 (if timestamp
1 0)))
2500 "\n#+TBLFM: $%d='(org-clock-time%% @%d$%d $%d..$%d);%%.1f"
2501 pcol
; the column where the % numbers should go
2502 (if (and narrow
(not narrow-cut-p
)) 3 2) ; row of the total time
2503 tcol
; column of the total time
2504 tcol
(1- pcol
) ; range of columns where times can be found
2508 (insert "\n#+TBLFM: " formula
)
2510 (t (error "Invalid formula in clocktable")))
2511 ;; Should we rescue an old formula?
2512 (when (stringp (setq content
(plist-get params
:content
)))
2513 (when (string-match "^\\([ \t]*#\\+tblfm:.*\\)" content
)
2515 (insert "\n" (match-string 1 (plist-get params
:content
)))
2516 (beginning-of-line 0))))
2517 ;; Back to beginning, align the table, recalculate if necessary
2519 (skip-chars-forward "^|")
2521 (when org-hide-emphasis-markers
2522 ;; we need to align a second time
2527 (if (and narrow
(not narrow-cut-p
)) (beginning-of-line 2))
2528 (org-table-goto-column pcol nil
'force
)
2530 (org-table-recalculate 'all
))
2531 (when rm-file-column
2532 ;; The file column is actually not wanted
2534 (org-table-delete-column))
2537 (defun org-clocktable-indent-string (level)
2542 (setq level
(1- level
)
2543 str
(concat str
"___")))
2546 (defun org-clocktable-steps (params)
2547 "Step through the range to make a number of clock tables."
2548 (let* ((p1 (copy-sequence params
))
2549 (ts (plist-get p1
:tstart
))
2550 (te (plist-get p1
:tend
))
2551 (ws (plist-get p1
:wstart
))
2552 (ms (plist-get p1
:mstart
))
2553 (step0 (plist-get p1
:step
))
2554 (step (cdr (assoc step0
'((day .
86400) (week .
604800)))))
2555 (stepskip0 (plist-get p1
:stepskip0
))
2556 (block (plist-get p1
:block
))
2557 cc range-text step-time tsb
)
2559 (setq cc
(org-clock-special-range block nil t ws ms
)
2560 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2563 ;; If ts is a number, it's an absolute day number from org-agenda.
2564 (destructuring-bind (month day year
) (calendar-gregorian-from-absolute ts
)
2565 (setq ts
(org-float-time (encode-time 0 0 0 day month year
)))))
2567 (setq ts
(org-float-time
2568 (apply 'encode-time
(org-parse-time-string ts
))))))
2572 (destructuring-bind (month day year
) (calendar-gregorian-from-absolute te
)
2573 (setq te
(org-float-time (encode-time 0 0 0 day month year
)))))
2575 (setq te
(org-float-time
2576 (apply 'encode-time
(org-parse-time-string te
))))))
2578 (if (eq step0
'week
)
2579 (- ts
(* 86400 (- (nth 6 (decode-time (seconds-to-time ts
))) ws
)))
2581 (setq p1
(plist-put p1
:header
""))
2582 (setq p1
(plist-put p1
:step nil
))
2583 (setq p1
(plist-put p1
:block nil
))
2585 (or (bolp) (insert "\n"))
2586 (setq p1
(plist-put p1
:tstart
(format-time-string
2587 (org-time-stamp-format nil t
)
2588 (seconds-to-time (max tsb ts
)))))
2589 (setq p1
(plist-put p1
:tend
(format-time-string
2590 (org-time-stamp-format nil t
)
2591 (seconds-to-time (min te
(setq tsb
(+ tsb step
)))))))
2592 (insert "\n" (if (eq step0
'day
) "Daily report: "
2593 "Weekly report starting on: ")
2594 (plist-get p1
:tstart
) "\n")
2595 (setq step-time
(org-dblock-write:clocktable p1
))
2596 (re-search-forward "^[ \t]*#\\+END:")
2597 (when (and (equal step-time
0) stepskip0
)
2598 ;; Remove the empty table
2599 (delete-region (point-at-bol)
2601 (re-search-backward "^\\(Daily\\|Weekly\\) report"
2606 (defun org-clock-get-table-data (file params
)
2607 "Get the clocktable data for file FILE, with parameters PARAMS.
2608 FILE is only for identification - this function assumes that
2609 the correct buffer is current, and that the wanted restriction is
2611 The return value will be a list with the file name and the total
2612 file time (in minutes) as 1st and 2nd elements. The third element
2613 of this list will be a list of headline entries. Each entry has the
2614 following structure:
2616 (LEVEL HEADLINE TIMESTAMP TIME)
2618 LEVEL: The level of the headline, as an integer. This will be
2619 the reduced leve, so 1,2,3,... even if only odd levels
2621 HEADLINE: The text of the headline. Depending on PARAMS, this may
2622 already be formatted like a link.
2623 TIMESTAMP: If PARAMS require it, this will be a time stamp found in the
2624 entry, any of SCHEDULED, DEADLINE, NORMAL, or first inactive,
2626 TIME: The sum of all time spend in this tree, in minutes. This time
2627 will of cause be restricted to the time block and tags match
2628 specified in PARAMS."
2629 (let* ((maxlevel (or (plist-get params
:maxlevel
) 3))
2630 (timestamp (plist-get params
:timestamp
))
2631 (ts (plist-get params
:tstart
))
2632 (te (plist-get params
:tend
))
2633 (ws (plist-get params
:wstart
))
2634 (ms (plist-get params
:mstart
))
2635 (block (plist-get params
:block
))
2636 (link (plist-get params
:link
))
2637 (tags (plist-get params
:tags
))
2638 (properties (plist-get params
:properties
))
2639 (inherit-property-p (plist-get params
:inherit-props
))
2641 (matcher (if tags
(cdr (org-make-tags-matcher tags
))))
2642 cc range-text st p time level hdl props tsp tbl
)
2644 (setq org-clock-file-total-minutes nil
)
2646 (setq cc
(org-clock-special-range block nil t ws ms
)
2647 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2648 (when (integerp ts
) (setq ts
(calendar-gregorian-from-absolute ts
)))
2649 (when (integerp te
) (setq te
(calendar-gregorian-from-absolute te
)))
2650 (when (and ts
(listp ts
))
2651 (setq ts
(format "%4d-%02d-%02d" (nth 2 ts
) (car ts
) (nth 1 ts
))))
2652 (when (and te
(listp te
))
2653 (setq te
(format "%4d-%02d-%02d" (nth 2 te
) (car te
) (nth 1 te
))))
2654 ;; Now the times are strings we can parse.
2655 (if ts
(setq ts
(org-float-time
2656 (seconds-to-time (org-matcher-time ts
)))))
2657 (if te
(setq te
(org-float-time
2658 (seconds-to-time (org-matcher-time te
)))))
2660 (org-clock-sum ts te
2661 (unless (null matcher
)
2663 (let* ((tags-list (org-get-tags-at))
2664 (org-scanner-tags tags-list
)
2665 (org-trust-scanner-tags t
))
2667 (goto-char (point-min))
2669 (while (or (and (bobp) (prog1 st
(setq st nil
))
2670 (get-text-property (point) :org-clock-minutes
)
2671 (setq p
(point-min)))
2672 (setq p
(next-single-property-change
2673 (point) :org-clock-minutes
)))
2675 (when (setq time
(get-text-property p
:org-clock-minutes
))
2677 (beginning-of-line 1)
2678 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@#%:]+:\\)?[ \t]*$"))
2679 (setq level
(org-reduced-level
2680 (- (match-end 1) (match-beginning 1))))
2681 (<= level maxlevel
))
2682 (setq hdl
(if (not link
)
2684 (org-make-link-string
2685 (format "file:%s::%s"
2688 (org-make-org-heading-search-string
2692 (setq props
(org-entry-properties (point)))
2693 (or (cdr (assoc "SCHEDULED" props
))
2694 (cdr (assoc "DEADLINE" props
))
2695 (cdr (assoc "TIMESTAMP" props
))
2696 (cdr (assoc "TIMESTAMP_IA" props
))))
2697 props
(when properties
2701 (when (org-entry-get (point) p inherit-property-p
)
2702 (cons p
(org-entry-get (point) p inherit-property-p
))))
2704 (when (> time
0) (push (list level hdl tsp time props
) tbl
))))))
2705 (setq tbl
(nreverse tbl
))
2706 (list file org-clock-file-total-minutes tbl
))))
2708 (defun org-clock-time%
(total &rest strings
)
2709 "Compute a time fraction in percent.
2710 TOTAL s a time string like 10:21 specifying the total times.
2711 STRINGS is a list of strings that should be checked for a time.
2712 The first string that does have a time will be used.
2713 This function is made for clock tables."
2714 (let ((re "\\([0-9]+\\):\\([0-9]+\\)")
2718 (if (not (string-match re total
))
2720 (setq tot
(+ (string-to-number (match-string 2 total
))
2721 (* 60 (string-to-number (match-string 1 total
)))))
2722 (if (= tot
0.
) (throw 'exit
0.
)))
2723 (while (setq s
(pop strings
))
2724 (if (string-match "\\([0-9]+\\):\\([0-9]+\\)" s
)
2726 (/ (* 100.0 (+ (string-to-number (match-string 2 s
))
2727 (* 60 (string-to-number
2728 (match-string 1 s
)))))
2732 ;; Saving and loading the clock
2734 (defvar org-clock-loaded nil
2735 "Was the clock file loaded?")
2737 (defun org-clock-update-time-maybe ()
2738 "If this is a CLOCK line, update it and return t.
2739 Otherwise, return nil."
2742 (beginning-of-line 1)
2743 (skip-chars-forward " \t")
2744 (when (looking-at org-clock-string
)
2745 (let ((re (concat "[ \t]*" org-clock-string
2746 " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
2747 "\\([ \t]*=>.*\\)?\\)?"))
2750 ((not (looking-at re
))
2752 ((not (match-end 2))
2753 (when (and (equal (marker-buffer org-clock-marker
) (current-buffer))
2754 (> org-clock-marker
(point))
2755 (<= org-clock-marker
(point-at-eol)))
2756 ;; The clock is running here
2757 (setq org-clock-start-time
2759 (org-parse-time-string (match-string 1))))
2760 (org-clock-update-mode-line)))
2762 (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
2764 (setq ts
(match-string 1)
2765 te
(match-string 3))
2766 (setq s
(- (org-float-time
2767 (apply 'encode-time
(org-parse-time-string te
)))
2769 (apply 'encode-time
(org-parse-time-string ts
))))
2772 h
(floor (/ s
3600))
2776 (insert " => " (format (if neg
"-%d:%02d" "%2d:%02d") h m
))
2779 (defun org-clock-save ()
2780 "Persist various clock-related data to disk.
2781 The details of what will be saved are regulated by the variable
2782 `org-clock-persist'."
2783 (when (and org-clock-persist
2784 (or org-clock-loaded
2785 org-clock-has-been-used
2786 (not (file-exists-p org-clock-persist-file
))))
2788 (with-current-buffer (find-file (expand-file-name org-clock-persist-file
))
2790 (delete-region (point-min) (point-max))
2792 (insert (format ";; org-persist.el - %s at %s\n"
2793 system-name
(format-time-string
2794 (cdr org-time-stamp-formats
))))
2795 (if (and (memq org-clock-persist
'(t clock
))
2796 (setq b
(org-clocking-buffer))
2797 (setq b
(or (buffer-base-buffer b
) b
))
2799 (buffer-file-name b
)
2800 (or (not org-clock-persist-query-save
)
2801 (y-or-n-p (concat "Save current clock ("
2802 org-clock-heading
") "))))
2803 (insert "(setq resume-clock '(\""
2804 (buffer-file-name (org-clocking-buffer))
2805 "\" . " (int-to-string (marker-position org-clock-marker
))
2807 ;; Store clocked task history. Tasks are stored reversed to make
2809 (when (and (memq org-clock-persist
'(t history
))
2812 "(setq stored-clock-history '("
2815 (when (and (setq b
(marker-buffer m
))
2816 (setq b
(or (buffer-base-buffer b
) b
))
2818 (buffer-file-name b
))
2819 (concat "(\"" (buffer-file-name b
)
2820 "\" . " (int-to-string (marker-position m
))
2822 (reverse org-clock-history
) " ") "))\n"))
2824 (kill-buffer (current-buffer)))))))
2826 (defun org-clock-load ()
2827 "Load clock-related data from disk, maybe resuming a stored clock."
2828 (when (and org-clock-persist
(not org-clock-loaded
))
2829 (let ((filename (expand-file-name org-clock-persist-file
))
2830 (org-clock-in-resume 'auto-restart
)
2831 resume-clock stored-clock-history
)
2832 (if (not (file-readable-p filename
))
2833 (message "Not restoring clock data; %s not found"
2834 org-clock-persist-file
)
2835 (message "%s" "Restoring clock data")
2836 (setq org-clock-loaded t
)
2837 (load-file filename
)
2839 (when stored-clock-history
2840 (save-window-excursion
2841 (mapc (lambda (task)
2842 (if (file-exists-p (car task
))
2843 (org-clock-history-push (cdr task
)
2844 (find-file (car task
)))))
2845 stored-clock-history
)))
2847 (when (and resume-clock org-clock-persist
2848 (file-exists-p (car resume-clock
))
2849 (or (not org-clock-persist-query-resume
)
2853 (with-current-buffer (find-file (car resume-clock
))
2855 (goto-char (cdr resume-clock
))
2856 (org-back-to-heading t
)
2857 (and (looking-at org-complex-heading-regexp
)
2860 (when (file-exists-p (car resume-clock
))
2861 (with-current-buffer (find-file (car resume-clock
))
2862 (goto-char (cdr resume-clock
))
2863 (let ((org-clock-auto-clock-resolution nil
))
2865 (if (outline-invisible-p)
2866 (org-show-context))))))))))
2868 ;; Suggested bindings
2869 (org-defkey org-mode-map
"\C-c\C-x\C-e" 'org-clock-modify-effort-estimate
)
2871 (provide 'org-clock
)
2874 ;; generated-autoload-file: "org-loaddefs.el"
2877 ;;; org-clock.el ends here
