1 ;;; org-clock.el --- The time clocking code for Org mode -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2004-2017 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
34 (declare-function calendar-iso-to-absolute
"cal-iso" (date))
35 (declare-function notifications-notify
"notifications" (&rest params
))
36 (declare-function org-element-property
"org-element" (property element
))
37 (declare-function org-element-type
"org-element" (element))
38 (declare-function org-table-goto-line
"org-table" (n))
40 (defvar org-frame-title-format-backup frame-title-format
)
41 (defvar org-time-stamp-formats
)
44 (defgroup org-clock nil
45 "Options concerning clocking working time in Org mode."
49 (defcustom org-clock-into-drawer t
50 "Non-nil when clocking info should be wrapped into a drawer.
52 When non-nil, clocking info will be inserted into the same drawer
53 as log notes (see variable `org-log-into-drawer'), if it exists,
54 or \"LOGBOOK\" otherwise. If necessary, the drawer will be
57 When an integer, the drawer is created only when the number of
58 clocking entries in an item reaches or exceeds this value.
60 When a string, it becomes the name of the drawer, ignoring the
61 log notes drawer altogether.
63 Do not check directly this variable in a Lisp program. Call
64 function `org-clock-into-drawer' instead."
68 :package-version
'(Org .
"8.3")
70 (const :tag
"Always" t
)
71 (const :tag
"Only when drawer exists" nil
)
72 (integer :tag
"When at least N clock entries")
73 (const :tag
"Into LOGBOOK drawer" "LOGBOOK")
74 (string :tag
"Into Drawer named...")))
76 (defun org-clock-into-drawer ()
77 "Value of `org-clock-into-drawer'. but let properties overrule.
79 If the current entry has or inherits a CLOCK_INTO_DRAWER
80 property, it will be used instead of the default value.
82 Return value is either a string, an integer, or nil."
83 (let ((p (org-entry-get nil
"CLOCK_INTO_DRAWER" 'inherit t
)))
84 (cond ((equal p
"nil") nil
)
85 ((equal p
"t") (or (org-log-into-drawer) "LOGBOOK"))
87 (if (string-match-p "\\`[0-9]+\\'" p
) (string-to-number p
) p
))
88 ((org-string-nw-p org-clock-into-drawer
))
89 ((integerp org-clock-into-drawer
) org-clock-into-drawer
)
90 ((not org-clock-into-drawer
) nil
)
91 ((org-log-into-drawer))
94 (defcustom org-clock-out-when-done t
95 "When non-nil, clock will be stopped when the clocked entry is marked DONE.
97 DONE here means any DONE-like state.
98 A nil value means clock will keep running until stopped explicitly with
99 `\\[org-clock-out]', or until the clock is started in a different item.
100 Instead of t, this can also be a list of TODO states that should trigger
104 (const :tag
"No" nil
)
105 (const :tag
"Yes, when done" t
)
106 (repeat :tag
"State list"
107 (string :tag
"TODO keyword"))))
109 (defcustom org-clock-rounding-minutes
0
110 "Rounding minutes when clocking in or out.
111 The default value is 0 so that no rounding is done.
112 When set to a non-integer value, use the car of
113 `org-time-stamp-rounding-minutes', like for setting a time-stamp.
115 E.g. if `org-clock-rounding-minutes' is set to 5, time is 14:47
116 and you clock in: then the clock starts at 14:45. If you clock
117 out within the next 5 minutes, the clock line will be removed;
118 if you clock out 8 minutes after your clocked in, the clock
119 out time will be 14:50."
122 :package-version
'(Org .
"8.0")
124 (integer :tag
"Minutes (0 for no rounding)")
125 (symbol :tag
"Use `org-time-stamp-rounding-minutes'" 'same-as-time-stamp
)))
127 (defcustom org-clock-out-remove-zero-time-clocks nil
128 "Non-nil means remove the clock line when the resulting time is zero."
132 (defcustom org-clock-in-switch-to-state nil
133 "Set task to a special todo state while clocking it.
134 The value should be the state to which the entry should be
135 switched. If the value is a function, it must take one
136 parameter (the current TODO state of the item) and return the
137 state to switch it to."
141 (const :tag
"Don't force a state" nil
)
142 (string :tag
"State")
143 (symbol :tag
"Function")))
145 (defcustom org-clock-out-switch-to-state nil
146 "Set task to a special todo state after clocking out.
147 The value should be the state to which the entry should be
148 switched. If the value is a function, it must take one
149 parameter (the current TODO state of the item) and return the
150 state to switch it to."
154 (const :tag
"Don't force a state" nil
)
155 (string :tag
"State")
156 (symbol :tag
"Function")))
158 (defcustom org-clock-history-length
5
159 "Number of clock tasks to remember in history."
163 (defcustom org-clock-goto-may-find-recent-task t
164 "Non-nil means `org-clock-goto' can go to recent task if no active clock."
168 (defcustom org-clock-heading-function nil
169 "When non-nil, should be a function to create `org-clock-heading'.
170 This is the string shown in the mode line when a clock is running.
171 The function is called with point at the beginning of the headline."
173 :type
'(choice (const nil
) (function)))
175 (defcustom org-clock-string-limit
0
176 "Maximum length of clock strings in the mode line. 0 means no limit."
180 (defcustom org-clock-in-resume nil
181 "If non-nil, resume clock when clocking into task with open clock.
182 When clocking into a task with a clock entry which has not been closed,
183 the clock can be resumed from that point."
187 (defcustom org-clock-persist nil
188 "When non-nil, save the running clock when Emacs is closed.
189 The clock is resumed when Emacs restarts.
190 When this is t, both the running clock, and the entire clock
191 history are saved. When this is the symbol `clock', only the
192 running clock is saved. When this is the symbol `history', only
193 the clock history is saved.
195 When Emacs restarts with saved clock information, the file containing
196 the running clock as well as all files mentioned in the clock history
199 All this depends on running `org-clock-persistence-insinuate' in your
200 Emacs initialization file."
203 (const :tag
"Just the running clock" clock
)
204 (const :tag
"Just the history" history
)
205 (const :tag
"Clock and history" t
)
206 (const :tag
"No persistence" nil
)))
208 (defcustom org-clock-persist-file
(convert-standard-filename
209 (concat user-emacs-directory
"org-clock-save.el"))
210 "File to save clock data to."
214 (defcustom org-clock-persist-query-save nil
215 "When non-nil, ask before saving the current clock on exit."
219 (defcustom org-clock-persist-query-resume t
220 "When non-nil, ask before resuming any stored clock during load."
224 (defcustom org-clock-sound nil
225 "Sound to use for notifications.
229 t Standard Emacs beep
230 file name Play this sound file, fall back to beep"
233 (const :tag
"No sound" nil
)
234 (const :tag
"Standard beep" t
)
235 (file :tag
"Play sound file")))
237 (defcustom org-clock-mode-line-total
'auto
238 "Default setting for the time included for the mode line clock.
239 This can be overruled locally using the CLOCK_MODELINE_TOTAL property.
242 current Only the time in the current instance of the clock
243 today All time clocked into this task today
244 repeat All time clocked into this task since last repeat
245 all All time ever recorded for this task
246 auto Automatically, either `all', or `repeat' for repeating tasks"
249 (const :tag
"Current clock" current
)
250 (const :tag
"Today's task time" today
)
251 (const :tag
"Since last repeat" repeat
)
252 (const :tag
"All task time" all
)
253 (const :tag
"Automatically, `all' or since `repeat'" auto
)))
255 (defvaralias 'org-task-overrun-text
'org-clock-task-overrun-text
)
256 (defcustom org-clock-task-overrun-text nil
257 "Extra mode line text to indicate that the clock is overrun.
258 The can be nil to indicate that instead of adding text, the clock time
259 should get a different face (`org-mode-line-clock-overrun').
260 When this is a string, it is prepended to the clock string as an indication,
261 also using the face `org-mode-line-clock-overrun'."
265 (const :tag
"Just mark the time string" nil
)
266 (string :tag
"Text to prepend")))
268 (defcustom org-show-notification-handler nil
269 "Function or program to send notification with.
270 The function or program will be called with the notification
275 (string :tag
"Program")
276 (function :tag
"Function")))
278 (defgroup org-clocktable nil
279 "Options concerning the clock table in Org mode."
280 :tag
"Org Clock Table"
283 (defcustom org-clocktable-defaults
286 :lang
(or (bound-and-true-p org-export-default-language
) "en")
306 "Default properties for clock tables."
311 (defcustom org-clock-clocktable-formatter
'org-clocktable-write-default
312 "Function to turn clocking data into a table.
313 For more information, see `org-clocktable-write-default'."
314 :group
'org-clocktable
318 ;; FIXME: translate es and nl last string "Clock summary at"
319 (defcustom org-clock-clocktable-language-setup
320 '(("en" "File" "L" "Timestamp" "Headline" "Time" "ALL" "Total time" "File time" "Clock summary at")
321 ("es" "Archivo" "N" "Fecha y hora" "Tarea" "Tiempo" "TODO" "Tiempo total" "Tiempo archivo" "Clock summary at")
322 ("fr" "Fichier" "N" "Horodatage" "En-tête" "Durée" "TOUT" "Durée totale" "Durée fichier" "Horodatage sommaire à ")
323 ("nl" "Bestand" "N" "Tijdstip" "Hoofding" "Duur" "ALLES" "Totale duur" "Bestandstijd" "Clock summary at"))
324 "Terms used in clocktable, translated to different languages."
325 :group
'org-clocktable
329 (defcustom org-clock-clocktable-default-properties
'(:maxlevel
2 :scope file
)
330 "Default properties for new clocktables.
331 These will be inserted into the BEGIN line, to make it easy for users to
333 :group
'org-clocktable
336 (defcustom org-clock-idle-time nil
337 "When non-nil, resolve open clocks if the user is idle more than X minutes."
340 (const :tag
"Never" nil
)
341 (integer :tag
"After N minutes")))
343 (defcustom org-clock-auto-clock-resolution
'when-no-clock-is-running
344 "When to automatically resolve open clocks found in Org buffers."
347 (const :tag
"Never" nil
)
348 (const :tag
"Always" t
)
349 (const :tag
"When no clock is running" when-no-clock-is-running
)))
351 (defcustom org-clock-report-include-clocking-task nil
352 "When non-nil, include the current clocking task time in clock reports."
357 (defcustom org-clock-resolve-expert nil
358 "Non-nil means do not show the splash buffer with the clock resolver."
363 (defcustom org-clock-continuously nil
364 "Non-nil means to start clocking from the last clock-out time, if any."
369 (defcustom org-clock-total-time-cell-format
"*%s*"
370 "Format string for the total time cells."
375 (defcustom org-clock-file-time-cell-format
"*%s*"
376 "Format string for the file time cells."
381 (defcustom org-clock-clocked-in-display
'mode-line
382 "When clocked in for a task, Org can display the current
383 task and accumulated time in the mode line and/or frame title.
386 both displays in both mode line and frame title
387 mode-line displays only in mode line (default)
388 frame-title displays only in frame title
389 nil current clock is not displayed"
392 (const :tag
"Mode line" mode-line
)
393 (const :tag
"Frame title" frame-title
)
394 (const :tag
"Both" both
)
395 (const :tag
"None" nil
)))
397 (defcustom org-clock-frame-title-format
'(t org-mode-line-string
)
398 "The value for `frame-title-format' when clocking in.
400 When `org-clock-clocked-in-display' is set to `frame-title'
401 or `both', clocking in will replace `frame-title-format' with
402 this value. Clocking out will restore `frame-title-format'.
404 `org-frame-title-string' is a format string using the same
405 specifications than `frame-title-format', which see."
410 (defcustom org-clock-x11idle-program-name
"x11idle"
411 "Name of the program which prints X11 idle time in milliseconds.
413 You can find x11idle.c in the contrib/scripts directory of the
414 Org git distribution. Or, you can do:
416 sudo apt-get install xprintidle
418 if you are using Debian."
421 :package-version
'(Org .
"8.0")
424 (defcustom org-clock-goto-before-context
2
425 "Number of lines of context to display before currently clocked-in entry.
426 This applies when using `org-clock-goto'."
430 (defcustom org-clock-display-default-range
'thisyear
431 "Default range when displaying clocks with `org-clock-display'."
433 :type
'(choice (const today
)
442 (const :tag
"Select range interactively" interactive
)))
444 (defvar org-clock-in-prepare-hook nil
445 "Hook run when preparing the clock.
446 This hook is run before anything happens to the task that
447 you want to clock in. For example, you can use this hook
448 to add an effort property.")
449 (defvar org-clock-in-hook nil
450 "Hook run when starting the clock.")
451 (defvar org-clock-out-hook nil
452 "Hook run when stopping the current clock.")
454 (defvar org-clock-cancel-hook nil
455 "Hook run when canceling the current clock.")
456 (defvar org-clock-goto-hook nil
457 "Hook run when selecting the currently clocked-in entry.")
458 (defvar org-clock-has-been-used nil
459 "Has the clock been used during the current Emacs session?")
461 (defvar org-clock-stored-history nil
462 "Clock history, populated by `org-clock-load'")
463 (defvar org-clock-stored-resume-clock nil
464 "Clock to resume, saved by `org-clock-load'")
466 (defconst org-clock--oldest-date
468 (lambda (min max pred
)
469 (if (funcall pred min
) min
471 (while (> (- max min
) 1)
472 (let ((mean (+ (ash min -
1) (ash max -
1) (logand min max
1))))
473 (if (funcall pred mean
) (setq max mean
) (setq min mean
)))))
479 (lambda (m) (ignore-errors (decode-time (list m
0))))))
484 (lambda (m) (ignore-errors (decode-time (list high m
)))))))
486 "Internal time for oldest date representable on the system.")
488 ;;; The clock for measuring work time.
490 (defvar org-mode-line-string
"")
491 (put 'org-mode-line-string
'risky-local-variable t
)
493 (defvar org-clock-mode-line-timer nil
)
494 (defvar org-clock-idle-timer nil
)
495 (defvar org-clock-heading
) ; defined in org.el
496 (defvar org-clock-start-time
"")
498 (defvar org-clock-leftover-time nil
499 "If non-nil, user canceled a clock; this is when leftover time started.")
501 (defvar org-clock-effort
""
502 "Effort estimate of the currently clocking task.")
504 (defvar org-clock-total-time nil
505 "Holds total time, spent previously on currently clocked item.
506 This does not include the time in the currently running clock.")
508 (defvar org-clock-history nil
509 "List of marker pointing to recent clocked tasks.")
511 (defvar org-clock-default-task
(make-marker)
512 "Marker pointing to the default task that should clock time.
513 The clock can be made to switch to this task after clocking out
514 of a different task.")
516 (defvar org-clock-interrupted-task
(make-marker)
517 "Marker pointing to the task that has been interrupted by the current clock.")
519 (defvar org-clock-mode-line-map
(make-sparse-keymap))
520 (define-key org-clock-mode-line-map
[mode-line mouse-2
] 'org-clock-goto
)
521 (define-key org-clock-mode-line-map
[mode-line mouse-1
] 'org-clock-menu
)
523 (defun org-clock--translate (s language
)
524 "Translate string S into using string LANGUAGE.
525 Assume S in the English term to translate. Return S as-is if it
526 cannot be translated."
528 ("File" 1) ("L" 2) ("Timestamp" 3) ("Headline" 4) ("Time" 5)
529 ("ALL" 6) ("Total time" 7) ("File time" 8) ("Clock summary at" 9))
530 (assoc-string language org-clock-clocktable-language-setup t
))
533 (defun org-clock-menu ()
537 ["Clock out" org-clock-out t
]
538 ["Change effort estimate" org-clock-modify-effort-estimate t
]
539 ["Go to clock entry" org-clock-goto t
]
540 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t
:keys
"C-u C-c C-x C-i"])))
542 (defun org-clock-history-push (&optional pos buffer
)
543 "Push a marker to the clock history."
544 (setq org-clock-history-length
(max 1 (min 35 org-clock-history-length
)))
545 (let ((m (move-marker (make-marker)
546 (or pos
(point)) (org-base-buffer
547 (or buffer
(current-buffer)))))
549 (while (setq n
(member m org-clock-history
))
550 (move-marker (car n
) nil
))
551 (setq org-clock-history
553 (mapcar (lambda (x) (if (marker-buffer x
) x nil
))
555 (when (>= (setq l
(length org-clock-history
)) org-clock-history-length
)
556 (setq org-clock-history
558 (nthcdr (- l org-clock-history-length -
1)
559 (nreverse org-clock-history
)))))
560 (push m org-clock-history
)))
562 (defun org-clock-save-markers-for-cut-and-paste (beg end
)
563 "Save relative positions of markers in region."
564 (org-check-and-save-marker org-clock-marker beg end
)
565 (org-check-and-save-marker org-clock-hd-marker beg end
)
566 (org-check-and-save-marker org-clock-default-task beg end
)
567 (org-check-and-save-marker org-clock-interrupted-task beg end
)
568 (dolist (m org-clock-history
)
569 (org-check-and-save-marker m beg end
)))
571 (defun org-clock-drawer-name ()
572 "Return clock drawer's name for current entry, or nil."
573 (let ((drawer (org-clock-into-drawer)))
574 (cond ((integerp drawer
)
575 (let ((log-drawer (org-log-into-drawer)))
576 (if (stringp log-drawer
) log-drawer
"LOGBOOK")))
577 ((stringp drawer
) drawer
)
580 (defun org-clocking-buffer ()
581 "Return the clocking buffer if we are currently clocking a task or nil."
582 (marker-buffer org-clock-marker
))
584 (defun org-clocking-p ()
585 "Return t when clocking a task."
586 (not (equal (org-clocking-buffer) nil
)))
588 (defvar org-clock-before-select-task-hook nil
589 "Hook called in task selection just before prompting the user.")
591 (defun org-clock-select-task (&optional prompt
)
592 "Select a task that was recently associated with clocking."
594 (let (och chl sel-list rpl
(i 0) s
)
595 ;; Remove successive dups from the clock history to consider
596 (dolist (c org-clock-history
)
597 (unless (equal c
(car och
)) (push c och
)))
598 (setq och
(reverse och
) chl
(length och
))
600 (user-error "No recent clock")
601 (save-window-excursion
602 (org-switch-to-buffer-other-window
603 (get-buffer-create "*Clock Task Select*"))
605 (when (marker-buffer org-clock-default-task
)
606 (insert (org-add-props "Default Task\n" nil
'face
'bold
))
607 (setq s
(org-clock-insert-selection-line ?d org-clock-default-task
))
609 (when (marker-buffer org-clock-interrupted-task
)
610 (insert (org-add-props "The task interrupted by starting the last one\n" nil
'face
'bold
))
611 (setq s
(org-clock-insert-selection-line ?i org-clock-interrupted-task
))
613 (when (org-clocking-p)
614 (insert (org-add-props "Current Clocking Task\n" nil
'face
'bold
))
615 (setq s
(org-clock-insert-selection-line ?c org-clock-marker
))
617 (insert (org-add-props "Recent Tasks\n" nil
'face
'bold
))
619 (when (marker-buffer m
)
621 s
(org-clock-insert-selection-line
625 (if (fboundp 'int-to-char
) (setf (car s
) (int-to-char (car s
))))
627 (run-hooks 'org-clock-before-select-task-hook
)
628 (goto-char (point-min))
629 ;; Set min-height relatively to circumvent a possible but in
630 ;; `fit-window-to-buffer'
631 (fit-window-to-buffer nil nil
(if (< chl
10) chl
(+ 5 chl
)))
632 (message (or prompt
"Select task for clocking:"))
633 (setq cursor-type nil rpl
(read-char-exclusive))
638 ((assoc rpl sel-list
) (cdr (assoc rpl sel-list
)))
639 (t (user-error "Invalid task choice %c" rpl
)))))))
641 (defun org-clock-insert-selection-line (i marker
)
642 "Insert a line for the clock selection menu.
643 And return a cons cell with the selection character integer and the marker
645 (when (marker-buffer marker
)
646 (let (cat task heading prefix
)
647 (with-current-buffer (org-base-buffer (marker-buffer marker
))
648 (org-with-wide-buffer
651 (setq cat
(org-get-category)
652 heading
(org-get-heading 'notags
)
653 prefix
(save-excursion
654 (org-back-to-heading t
)
655 (looking-at org-outline-regexp
)
658 (org-fontify-like-in-org-mode
659 (concat prefix heading
)
663 (insert (format "[%c] %-12s %s\n" i cat task
))
666 (defvar org-clock-task-overrun nil
667 "Internal flag indicating if the clock has overrun the planned time.")
668 (defvar org-clock-update-period
60
669 "Number of seconds between mode line clock string updates.")
671 (defun org-clock-get-clock-string ()
672 "Form a clock-string, that will be shown in the mode line.
673 If an effort estimate was defined for the current item, use
674 01:30/01:50 format (clocked/estimated).
675 If not, show simply the clocked time like 01:50."
676 (let ((clocked-time (org-clock-get-clocked-time)))
678 (let* ((effort-in-minutes (org-duration-to-minutes org-clock-effort
))
681 (org-duration-from-minutes clocked-time
)
682 'face
(if (and org-clock-task-overrun
(not org-clock-task-overrun-text
))
683 'org-mode-line-clock-overrun
'org-mode-line-clock
)))
684 (effort-str (org-duration-from-minutes effort-in-minutes
))
685 (clockstr (propertize
686 (concat " [%s/" effort-str
687 "] (" (replace-regexp-in-string "%" "%%" org-clock-heading
) ")")
688 'face
'org-mode-line-clock
)))
689 (format clockstr work-done-str
))
690 (propertize (concat " [" (org-duration-from-minutes clocked-time
)
691 "]" (format " (%s)" org-clock-heading
))
692 'face
'org-mode-line-clock
))))
694 (defun org-clock-get-last-clock-out-time ()
695 "Get the last clock-out time for the current subtree."
697 (let ((end (save-excursion (org-end-of-subtree))))
698 (when (re-search-forward (concat org-clock-string
699 ".*\\]--\\(\\[[^]]+\\]\\)") end t
)
700 (org-time-string-to-time (match-string 1))))))
702 (defun org-clock-update-mode-line ()
704 (org-clock-notify-once-if-expired)
705 (setq org-clock-task-overrun nil
))
706 (setq org-mode-line-string
708 (let ((clock-string (org-clock-get-clock-string))
709 (help-text "Org mode clock is running.\nmouse-1 shows a \
710 menu\nmouse-2 will jump to task"))
711 (if (and (> org-clock-string-limit
0)
712 (> (length clock-string
) org-clock-string-limit
))
714 (substring clock-string
0 org-clock-string-limit
)
715 'help-echo
(concat help-text
": " org-clock-heading
))
716 (propertize clock-string
'help-echo help-text
)))
717 'local-map org-clock-mode-line-map
718 'mouse-face
'mode-line-highlight
))
719 (if (and org-clock-task-overrun org-clock-task-overrun-text
)
720 (setq org-mode-line-string
722 org-clock-task-overrun-text
723 'face
'org-mode-line-clock-overrun
) org-mode-line-string
)))
724 (force-mode-line-update))
726 (defun org-clock-get-clocked-time ()
727 "Get the clocked time for the current item in minutes.
728 The time returned includes the time spent on this task in
729 previous clocking intervals."
730 (let ((currently-clocked-time
731 (floor (- (float-time)
732 (float-time org-clock-start-time
)) 60)))
733 (+ currently-clocked-time
(or org-clock-total-time
0))))
735 (defun org-clock-modify-effort-estimate (&optional value
)
736 "Add to or set the effort estimate of the item currently being clocked.
737 VALUE can be a number of minutes, or a string with format hh:mm or mm.
738 When the string starts with a + or a - sign, the current value of the effort
739 property will be changed by that amount. If the effort value is expressed
740 as an `org-effort-durations' (e.g. \"3h\"), the modified value will be
741 converted to a hh:mm duration.
743 This command will update the \"Effort\" property of the currently
744 clocked item, and the value displayed in the mode line."
746 (if (org-clock-is-active)
747 (let ((current org-clock-effort
) sign
)
749 ;; Prompt user for a value or a change
752 (format "Set effort (hh:mm or mm%s): "
754 (format ", prefix + to add to %s" org-clock-effort
)
756 (when (stringp value
)
757 ;; A string. See if it is a delta
758 (setq sign
(string-to-char value
))
759 (if (member sign
'(?- ?
+))
760 (setq current
(org-duration-to-minutes current
)
761 value
(substring value
1))
763 (setq value
(org-duration-to-minutes value
))
765 (setq value
(- current value
))
766 (if (equal ?
+ sign
) (setq value
(+ current value
)))))
767 (setq value
(max 0 value
)
768 org-clock-effort
(org-duration-from-minutes value
))
769 (org-entry-put org-clock-marker
"Effort" org-clock-effort
)
770 (org-clock-update-mode-line)
771 (message "Effort is now %s" org-clock-effort
))
772 (message "Clock is not currently active")))
774 (defvar org-clock-notification-was-shown nil
775 "Shows if we have shown notification already.")
777 (defun org-clock-notify-once-if-expired ()
778 "Show notification if we spent more time than we estimated before.
779 Notification is shown only once."
780 (when (org-clocking-p)
781 (let ((effort-in-minutes (org-duration-to-minutes org-clock-effort
))
782 (clocked-time (org-clock-get-clocked-time)))
783 (if (setq org-clock-task-overrun
784 (if (or (null effort-in-minutes
) (zerop effort-in-minutes
))
786 (>= clocked-time effort-in-minutes
)))
787 (unless org-clock-notification-was-shown
788 (setq org-clock-notification-was-shown t
)
790 (format-message "Task `%s' should be finished by now. (%s)"
791 org-clock-heading org-clock-effort
)
793 (setq org-clock-notification-was-shown nil
)))))
795 (defun org-notify (notification &optional play-sound
)
796 "Send a NOTIFICATION and maybe PLAY-SOUND.
797 If PLAY-SOUND is non-nil, it overrides `org-clock-sound'."
798 (org-show-notification notification
)
799 (if play-sound
(org-clock-play-sound play-sound
)))
801 (defun org-show-notification (notification)
803 Use `org-show-notification-handler' if defined,
804 use libnotify if available, or fall back on a message."
805 (cond ((functionp org-show-notification-handler
)
806 (funcall org-show-notification-handler notification
))
807 ((stringp org-show-notification-handler
)
808 (start-process "emacs-timer-notification" nil
809 org-show-notification-handler notification
))
810 ((fboundp 'notifications-notify
)
811 (notifications-notify
812 :title
"Org mode message"
814 ;; FIXME how to link to the Org icon?
815 ;; :app-icon "~/.emacs.d/icons/mail.png"
817 ((executable-find "notify-send")
818 (start-process "emacs-timer-notification" nil
819 "notify-send" notification
))
820 ;; Maybe the handler will send a message, so only use message as
821 ;; a fall back option
822 (t (message "%s" notification
))))
824 (defun org-clock-play-sound (&optional clock-sound
)
825 "Play sound as configured by `org-clock-sound'.
826 Use alsa's aplay tool if available.
827 If CLOCK-SOUND is non-nil, it overrides `org-clock-sound'."
828 (let ((org-clock-sound (or clock-sound org-clock-sound
)))
830 ((not org-clock-sound
))
831 ((eq org-clock-sound t
) (beep t
) (beep t
))
832 ((stringp org-clock-sound
)
833 (let ((file (expand-file-name org-clock-sound
)))
834 (if (file-exists-p file
)
835 (if (executable-find "aplay")
836 (start-process "org-clock-play-notification" nil
839 (play-sound-file file
)
840 (error (beep t
) (beep t
))))))))))
842 (defvar org-clock-mode-line-entry nil
843 "Information for the mode line about the running clock.")
845 (defun org-find-open-clocks (file)
846 "Search through the given file and find all open clocks."
847 (let ((buf (or (get-file-buffer file
)
848 (find-file-noselect file
)))
849 (org-clock-re (concat org-clock-string
" \\(\\[.*?\\]\\)$"))
851 (with-current-buffer buf
853 (goto-char (point-min))
854 (while (re-search-forward org-clock-re nil t
)
855 (push (cons (copy-marker (match-end 1) t
)
856 (org-time-string-to-time (match-string 1))) clocks
))))
859 (defsubst org-is-active-clock
(clock)
860 "Return t if CLOCK is the currently active clock."
861 (and (org-clock-is-active)
862 (= org-clock-marker
(car clock
))))
864 (defmacro org-with-clock-position
(clock &rest forms
)
865 "Evaluate FORMS with CLOCK as the current active clock."
866 `(with-current-buffer (marker-buffer (car ,clock
))
867 (org-with-wide-buffer
868 (goto-char (car ,clock
))
871 (def-edebug-spec org-with-clock-position
(form body
))
872 (put 'org-with-clock-position
'lisp-indent-function
1)
874 (defmacro org-with-clock
(clock &rest forms
)
875 "Evaluate FORMS with CLOCK as the current active clock.
876 This macro also protects the current active clock from being altered."
877 `(org-with-clock-position ,clock
878 (let ((org-clock-start-time (cdr ,clock
))
879 (org-clock-total-time)
882 (org-clock-marker (car ,clock
))
883 (org-clock-hd-marker (save-excursion
884 (org-back-to-heading t
)
887 (def-edebug-spec org-with-clock
(form body
))
888 (put 'org-with-clock
'lisp-indent-function
1)
890 (defsubst org-clock-clock-in
(clock &optional resume start-time
)
891 "Clock in to the clock located by CLOCK.
892 If necessary, clock-out of the currently active clock."
893 (org-with-clock-position clock
894 (let ((org-clock-in-resume (or resume org-clock-in-resume
)))
895 (org-clock-in nil start-time
))))
897 (defsubst org-clock-clock-out
(clock &optional fail-quietly at-time
)
898 "Clock out of the clock located by CLOCK."
899 (let ((temp (copy-marker (car clock
)
900 (marker-insertion-type (car clock
)))))
901 (if (org-is-active-clock clock
)
902 (org-clock-out nil fail-quietly at-time
)
903 (org-with-clock clock
904 (org-clock-out nil fail-quietly at-time
)))
905 (setcar clock temp
)))
907 (defsubst org-clock-clock-cancel
(clock)
908 "Cancel the clock located by CLOCK."
909 (let ((temp (copy-marker (car clock
)
910 (marker-insertion-type (car clock
)))))
911 (if (org-is-active-clock clock
)
913 (org-with-clock clock
915 (setcar clock temp
)))
917 (defvar org-clock-clocking-in nil
)
918 (defvar org-clock-resolving-clocks nil
)
919 (defvar org-clock-resolving-clocks-due-to-idleness nil
)
921 (defun org-clock-resolve-clock (clock resolve-to clock-out-time
922 &optional close-p restart-p fail-quietly
)
923 "Resolve `CLOCK' given the time `RESOLVE-TO', and the present.
924 `CLOCK' is a cons cell of the form (MARKER START-TIME)."
925 (let ((org-clock-resolving-clocks t
))
928 (org-clock-clock-cancel clock
)
929 (if (and restart-p
(not org-clock-clocking-in
))
930 (org-clock-clock-in clock
)))
932 ((eq resolve-to
'now
)
934 (error "RESTART-P is not valid here"))
935 (if (or close-p org-clock-clocking-in
)
936 (org-clock-clock-out clock fail-quietly
)
937 (unless (org-is-active-clock clock
)
938 (org-clock-clock-in clock t
))))
940 ((not (time-less-p resolve-to
(current-time)))
941 (error "RESOLVE-TO must refer to a time in the past"))
945 (error "RESTART-P is not valid here"))
946 (org-clock-clock-out clock fail-quietly
(or clock-out-time
948 (unless org-clock-clocking-in
950 (setq org-clock-leftover-time
(and (null clock-out-time
)
952 (org-clock-clock-in clock nil
(and clock-out-time
955 (defun org-clock-jump-to-current-clock (&optional effective-clock
)
957 (let ((drawer (org-clock-into-drawer))
958 (clock (or effective-clock
(cons org-clock-marker
959 org-clock-start-time
))))
960 (unless (marker-buffer (car clock
))
961 (error "No clock is currently running"))
962 (org-with-clock clock
(org-clock-goto))
963 (with-current-buffer (marker-buffer (car clock
))
964 (goto-char (car clock
))
966 (org-with-wide-buffer
967 (let ((drawer-re (format "^[ \t]*:%s:[ \t]*$"
968 (regexp-quote (if (stringp drawer
) drawer
"LOGBOOK"))))
969 (beg (save-excursion (org-back-to-heading t
) (point))))
971 (while (re-search-backward drawer-re beg t
)
972 (let ((element (org-element-at-point)))
973 (when (eq (org-element-type element
) 'drawer
)
974 (when (> (org-element-property :end element
) (car clock
))
975 (org-flag-drawer nil element
))
976 (throw 'exit nil
)))))))))))
978 (defun org-clock-resolve (clock &optional prompt-fn last-valid fail-quietly
)
979 "Resolve an open Org clock.
980 An open clock was found, with `dangling' possibly being non-nil.
981 If this function was invoked with a prefix argument, non-dangling
982 open clocks are ignored. The given clock requires some sort of
983 user intervention to resolve it, either because a clock was left
984 dangling or due to an idle timeout. The clock resolution can
987 (a) deleted, the user doesn't care about the clock
988 (b) restarted from the current time (if no other clock is open)
989 (c) closed, giving the clock X minutes
990 (d) closed and then restarted
991 (e) resumed, as if the user had never left
993 The format of clock is (CONS MARKER START-TIME), where MARKER
994 identifies the buffer and position the clock is open at (and
995 thus, the heading it's under), and START-TIME is when the clock
999 (save-window-excursion
1001 (unless org-clock-resolving-clocks-due-to-idleness
1002 (org-clock-jump-to-current-clock clock
))
1003 (unless org-clock-resolve-expert
1004 (with-output-to-temp-buffer "*Org Clock*"
1005 (princ (format-message "Select a Clock Resolution Command:
1007 i/q Ignore this question; the same as keeping all the idle time.
1009 k/K Keep X minutes of the idle time (default is all). If this
1010 amount is less than the default, you will be clocked out
1011 that many minutes after the time that idling began, and then
1012 clocked back in at the present time.
1014 g/G Indicate that you \"got back\" X minutes ago. This is quite
1015 different from `k': it clocks you out from the beginning of
1016 the idle period and clock you back in X minutes ago.
1018 s/S Subtract the idle time from the current clock. This is the
1019 same as keeping 0 minutes.
1021 C Cancel the open timer altogether. It will be as though you
1024 j/J Jump to the current clock, to make manual adjustments.
1026 For all these options, using uppercase makes your final state
1027 to be CLOCKED OUT."))))
1028 (org-fit-window-to-buffer (get-buffer-window "*Org Clock*"))
1030 (while (or (null char-pressed
)
1031 (and (not (memq char-pressed
1032 '(?k ?K ?g ?G ?s ?S ?C
1036 (read-char (concat (funcall prompt-fn clock
)
1039 (and (not (memq char-pressed
'(?i ?q
))) char-pressed
)))))
1041 (floor (/ (float-time
1042 (time-subtract (current-time) last-valid
)) 60)))
1044 (and (memq ch
'(?k ?K
))
1045 (read-number "Keep how many minutes? " default
)))
1047 (and (memq ch
'(?g ?G
))
1048 (read-number "Got back how many minutes ago? " default
)))
1049 (subtractp (memq ch
'(?s ?S
)))
1050 (barely-started-p (< (- (float-time last-valid
)
1051 (float-time (cdr clock
))) 45))
1052 (start-over (and subtractp barely-started-p
)))
1056 (org-clock-resolve-clock clock
'now nil t nil fail-quietly
))
1057 (org-clock-jump-to-current-clock clock
))
1059 (not (memq ch
'(?k ?K ?g ?G ?s ?S ?C
))))
1062 (org-clock-resolve-clock
1065 ;; If the time on the clock was less than a minute before
1066 ;; the user went away, and they've ask to subtract all the
1071 (and gotback
(= gotback
0)))
1073 ((or (and keep
(= keep default
))
1074 (and gotback
(= gotback default
)))
1077 (time-add last-valid
(seconds-to-time (* 60 keep
))))
1079 (time-subtract (current-time)
1080 (seconds-to-time (* 60 gotback
))))
1082 (error "Unexpected, please report this as a bug")))
1083 (and gotback last-valid
)
1084 (memq ch
'(?K ?G ?S
))
1086 (not (memq ch
'(?K ?G ?S ?C
))))
1090 (defun org-resolve-clocks (&optional only-dangling-p prompt-fn last-valid
)
1091 "Resolve all currently open Org clocks.
1092 If `only-dangling-p' is non-nil, only ask to resolve dangling
1093 \(i.e., not currently open and valid) clocks."
1095 (unless org-clock-resolving-clocks
1096 (let ((org-clock-resolving-clocks t
))
1097 (dolist (file (org-files-list))
1098 (let ((clocks (org-find-open-clocks file
)))
1099 (dolist (clock clocks
)
1100 (let ((dangling (or (not (org-clock-is-active))
1101 (/= (car clock
) org-clock-marker
))))
1102 (if (or (not only-dangling-p
) dangling
)
1109 "Dangling clock started %d mins ago"
1110 (floor (- (float-time)
1111 (float-time (cdr clock
)))
1114 (cdr clock
)))))))))))
1116 (defun org-emacs-idle-seconds ()
1117 "Return the current Emacs idle time in seconds, or nil if not idle."
1118 (let ((idle-time (current-idle-time)))
1120 (float-time idle-time
)
1123 (defun org-mac-idle-seconds ()
1124 "Return the current Mac idle time in seconds."
1125 (string-to-number (shell-command-to-string "ioreg -c IOHIDSystem | perl -ane 'if (/Idle/) {$idle=(pop @F)/1000000000; print $idle; last}'")))
1127 (defvar org-x11idle-exists-p
1128 ;; Check that x11idle exists
1129 (and (eq window-system
'x
)
1130 (eq 0 (call-process-shell-command
1131 (format "command -v %s" org-clock-x11idle-program-name
)))
1132 ;; Check that x11idle can retrieve the idle time
1133 ;; FIXME: Why "..-shell-command" rather than just `call-process'?
1134 (eq 0 (call-process-shell-command org-clock-x11idle-program-name
))))
1136 (defun org-x11-idle-seconds ()
1137 "Return the current X11 idle time in seconds."
1138 (/ (string-to-number (shell-command-to-string org-clock-x11idle-program-name
)) 1000))
1140 (defun org-user-idle-seconds ()
1141 "Return the number of seconds the user has been idle for.
1142 This routine returns a floating point number."
1144 ((eq system-type
'darwin
)
1145 (org-mac-idle-seconds))
1146 ((and (eq window-system
'x
) org-x11idle-exists-p
)
1147 (org-x11-idle-seconds))
1149 (org-emacs-idle-seconds))))
1151 (defvar org-clock-user-idle-seconds
)
1153 (defun org-resolve-clocks-if-idle ()
1154 "Resolve all currently open Org clocks.
1155 This is performed after `org-clock-idle-time' minutes, to check
1156 if the user really wants to stay clocked in after being idle for
1158 (when (and org-clock-idle-time
(not org-clock-resolving-clocks
)
1159 org-clock-marker
(marker-buffer org-clock-marker
))
1160 (let* ((org-clock-user-idle-seconds (org-user-idle-seconds))
1161 (org-clock-user-idle-start
1162 (time-subtract (current-time)
1163 (seconds-to-time org-clock-user-idle-seconds
)))
1164 (org-clock-resolving-clocks-due-to-idleness t
))
1165 (if (> org-clock-user-idle-seconds
(* 60 org-clock-idle-time
))
1167 (cons org-clock-marker
1168 org-clock-start-time
)
1170 (format "Clocked in & idle for %.1f mins"
1172 (time-subtract (current-time)
1173 org-clock-user-idle-start
))
1175 org-clock-user-idle-start
)))))
1177 (defvar org-clock-current-task nil
"Task currently clocked in.")
1178 (defvar org-clock-out-time nil
) ; store the time of the last clock-out
1179 (defvar org--msg-extra
)
1182 (defun org-clock-in (&optional select start-time
)
1183 "Start the clock on the current item.
1185 If necessary, clock-out of the currently active clock.
1187 With a `\\[universal-argument]' prefix argument SELECT, offer a list of \
1189 tasks to clock into.
1191 When SELECT is `\\[universal-argument] \ \\[universal-argument]', \
1192 clock into the current task and mark it as
1193 the default task, a special task that will always be offered in the
1194 clocking selection, associated with the letter `d'.
1196 When SELECT is `\\[universal-argument] \\[universal-argument] \
1197 \\[universal-argument]', clock in by using the last clock-out
1198 time as the start time. See `org-clock-continuously' to make this
1199 the default behavior."
1201 (setq org-clock-notification-was-shown nil
)
1202 (org-refresh-effort-properties)
1204 (let ((interrupting (and (not org-clock-resolving-clocks-due-to-idleness
)
1206 ts selected-task target-pos
(org--msg-extra "")
1207 (leftover (and (not org-clock-resolving-clocks
)
1208 org-clock-leftover-time
)))
1210 (when (and org-clock-auto-clock-resolution
1211 (or (not interrupting
)
1212 (eq t org-clock-auto-clock-resolution
))
1213 (not org-clock-clocking-in
)
1214 (not org-clock-resolving-clocks
))
1215 (setq org-clock-leftover-time nil
)
1216 (let ((org-clock-clocking-in t
))
1217 (org-resolve-clocks))) ; check if any clocks are dangling
1219 (when (equal select
'(64))
1220 ;; Set start-time to `org-clock-out-time'
1221 (let ((org-clock-continuously t
))
1222 (org-clock-in nil org-clock-out-time
)))
1224 (when (equal select
'(4))
1225 (setq selected-task
(org-clock-select-task "Clock-in on task: "))
1227 (setq selected-task
(copy-marker selected-task
))
1230 (when (equal select
'(16))
1231 ;; Mark as default clocking task
1232 (org-clock-mark-default-task))
1235 ;; We are interrupting the clocking of a different task.
1236 ;; Save a marker to this task, so that we can go back.
1237 ;; First check if we are trying to clock into the same task!
1238 (when (save-excursion
1239 (unless selected-task
1240 (org-back-to-heading t
))
1241 (and (equal (marker-buffer org-clock-hd-marker
)
1243 (marker-buffer selected-task
)
1245 (= (marker-position org-clock-hd-marker
)
1247 (marker-position selected-task
)
1249 (equal org-clock-current-task
(nth 4 (org-heading-components)))))
1250 (message "Clock continues in \"%s\"" org-clock-heading
)
1252 (move-marker org-clock-interrupted-task
1253 (marker-position org-clock-marker
)
1254 (marker-buffer org-clock-marker
))
1255 (let ((org-clock-clocking-in t
))
1256 (org-clock-out nil t
)))
1258 ;; Clock in at which position?
1260 (if (and (eobp) (not (org-at-heading-p)))
1264 (when (and selected-task
(marker-buffer selected-task
))
1265 ;; There is a selected task, move to the correct buffer
1266 ;; and set the new target position.
1267 (set-buffer (org-base-buffer (marker-buffer selected-task
)))
1268 (setq target-pos
(marker-position selected-task
))
1269 (move-marker selected-task nil
))
1270 (org-with-wide-buffer
1271 (goto-char target-pos
)
1272 (org-back-to-heading t
)
1273 (or interrupting
(move-marker org-clock-interrupted-task nil
))
1274 (run-hooks 'org-clock-in-prepare-hook
)
1275 (org-clock-history-push)
1276 (setq org-clock-current-task
(nth 4 (org-heading-components)))
1277 (cond ((functionp org-clock-in-switch-to-state
)
1278 (let ((case-fold-search nil
))
1279 (looking-at org-complex-heading-regexp
))
1280 (let ((newstate (funcall org-clock-in-switch-to-state
1282 (when newstate
(org-todo newstate
))))
1283 ((and org-clock-in-switch-to-state
1284 (not (looking-at (concat org-outline-regexp
"[ \t]*"
1285 org-clock-in-switch-to-state
1287 (org-todo org-clock-in-switch-to-state
)))
1288 (setq org-clock-heading
1289 (cond ((and org-clock-heading-function
1290 (functionp org-clock-heading-function
))
1291 (funcall org-clock-heading-function
))
1292 ((nth 4 (org-heading-components))
1293 (replace-regexp-in-string
1294 "\\[\\[.*?\\]\\[\\(.*?\\)\\]\\]" "\\1"
1295 (match-string-no-properties 4)))
1297 (org-clock-find-position org-clock-in-resume
)
1299 ((and org-clock-in-resume
1301 (concat "^[ \t]*" org-clock-string
1302 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1303 " *\\sw+.? +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
1304 (message "Matched %s" (match-string 1))
1305 (setq ts
(concat "[" (match-string 1) "]"))
1306 (goto-char (match-end 1))
1307 (setq org-clock-start-time
1309 (org-parse-time-string (match-string 1))))
1310 (setq org-clock-effort
(org-entry-get (point) org-effort-property
))
1311 (setq org-clock-total-time
(org-clock-sum-current-item
1312 (org-clock-get-sum-start))))
1313 ((eq org-clock-in-resume
'auto-restart
)
1314 ;; called from org-clock-load during startup,
1315 ;; do not interrupt, but warn!
1316 (message "Cannot restart clock because task does not contain unfinished clock")
1321 (insert-before-markers "\n")
1324 (when (and (save-excursion
1327 (beginning-of-line 1)
1328 (indent-line-to (- (org-get-indentation) 2)))
1329 (insert org-clock-string
" ")
1330 (setq org-clock-effort
(org-entry-get (point) org-effort-property
))
1331 (setq org-clock-total-time
(org-clock-sum-current-item
1332 (org-clock-get-sum-start)))
1333 (setq org-clock-start-time
1334 (or (and org-clock-continuously org-clock-out-time
)
1338 "You stopped another clock %d mins ago; start this one from then? "
1340 (org-current-time org-clock-rounding-minutes t
))
1341 (float-time leftover
))
1345 (org-current-time org-clock-rounding-minutes t
)))
1346 (setq ts
(org-insert-time-stamp org-clock-start-time
1347 'with-hm
'inactive
))))
1348 (move-marker org-clock-marker
(point) (buffer-base-buffer))
1349 (move-marker org-clock-hd-marker
1350 (save-excursion (org-back-to-heading t
) (point))
1351 (buffer-base-buffer))
1352 (setq org-clock-has-been-used t
)
1354 (when (or (eq org-clock-clocked-in-display
'mode-line
)
1355 (eq org-clock-clocked-in-display
'both
))
1356 (or global-mode-string
(setq global-mode-string
'("")))
1357 (or (memq 'org-mode-line-string global-mode-string
)
1358 (setq global-mode-string
1359 (append global-mode-string
'(org-mode-line-string)))))
1360 ;; add to frame title
1361 (when (or (eq org-clock-clocked-in-display
'frame-title
)
1362 (eq org-clock-clocked-in-display
'both
))
1363 (setq frame-title-format org-clock-frame-title-format
))
1364 (org-clock-update-mode-line)
1365 (when org-clock-mode-line-timer
1366 (cancel-timer org-clock-mode-line-timer
)
1367 (setq org-clock-mode-line-timer nil
))
1368 (when org-clock-clocked-in-display
1369 (setq org-clock-mode-line-timer
1370 (run-with-timer org-clock-update-period
1371 org-clock-update-period
1372 'org-clock-update-mode-line
)))
1373 (when org-clock-idle-timer
1374 (cancel-timer org-clock-idle-timer
)
1375 (setq org-clock-idle-timer nil
))
1376 (setq org-clock-idle-timer
1377 (run-with-timer 60 60 'org-resolve-clocks-if-idle
))
1378 (message "Clock starts at %s - %s" ts org--msg-extra
)
1379 (run-hooks 'org-clock-in-hook
))))))
1382 (defun org-clock-in-last (&optional arg
)
1383 "Clock in the last closed clocked item.
1384 When already clocking in, send an warning.
1385 With a universal prefix argument, select the task you want to
1386 clock in from the last clocked in tasks.
1387 With two universal prefix arguments, start clocking using the
1388 last clock-out time, if any.
1389 With three universal prefix arguments, interactively prompt
1390 for a todo state to switch to, overriding the existing value
1391 `org-clock-in-switch-to-state'."
1393 (if (equal arg
'(4)) (org-clock-in arg
)
1394 (let ((start-time (if (or org-clock-continuously
(equal arg
'(16)))
1395 (or org-clock-out-time
1396 (org-current-time org-clock-rounding-minutes t
))
1397 (org-current-time org-clock-rounding-minutes t
))))
1398 (if (null org-clock-history
)
1399 (message "No last clock")
1400 (let ((org-clock-in-switch-to-state
1401 (if (and (not org-clock-current-task
) (equal arg
'(64)))
1402 (completing-read "Switch to state: "
1403 (and org-clock-history
1404 (with-current-buffer
1405 (marker-buffer (car org-clock-history
))
1406 org-todo-keywords-1
)))
1407 org-clock-in-switch-to-state
))
1408 (already-clocking org-clock-current-task
))
1409 (org-clock-clock-in (list (car org-clock-history
)) nil start-time
)
1410 (or already-clocking
1411 ;; Don't display a message if we are already clocking in
1412 (message "Clocking back: %s (in %s)"
1413 org-clock-current-task
1414 (buffer-name (marker-buffer org-clock-marker
)))))))))
1416 (defun org-clock-mark-default-task ()
1417 "Mark current task as default task."
1420 (org-back-to-heading t
)
1421 (move-marker org-clock-default-task
(point))))
1423 (defun org-clock-get-sum-start ()
1424 "Return the time from which clock times should be counted.
1425 This is for the currently running clock as it is displayed
1426 in the mode line. This function looks at the properties
1427 LAST_REPEAT and in particular CLOCK_MODELINE_TOTAL and the
1428 corresponding variable `org-clock-mode-line-total' and then
1429 decides which time to use."
1430 (let ((cmt (or (org-entry-get nil
"CLOCK_MODELINE_TOTAL")
1431 (symbol-name org-clock-mode-line-total
)))
1432 (lr (org-entry-get nil
"LAST_REPEAT")))
1434 ((equal cmt
"current")
1435 (setq org--msg-extra
"showing time in current clock instance")
1437 ((equal cmt
"today")
1438 (setq org--msg-extra
"showing today's task time.")
1439 (let* ((dt (decode-time))
1442 (if (< hour org-extend-today-until
) (setf (nth 3 dt
) (1- day
)))
1443 (setf (nth 2 dt
) org-extend-today-until
)
1444 (setq dt
(append (list 0 0) (nthcdr 2 dt
)))
1445 (apply 'encode-time dt
)))
1446 ((or (equal cmt
"all")
1447 (and (or (not cmt
) (equal cmt
"auto"))
1449 (setq org--msg-extra
"showing entire task time.")
1451 ((or (equal cmt
"repeat")
1452 (and (or (not cmt
) (equal cmt
"auto"))
1454 (setq org--msg-extra
"showing task time since last repeat.")
1457 (org-time-string-to-time lr
)))
1460 (defun org-clock-find-position (find-unclosed)
1461 "Find the location where the next clock line should be inserted.
1462 When FIND-UNCLOSED is non-nil, first check if there is an unclosed clock
1463 line and position cursor in that line."
1464 (org-back-to-heading t
)
1466 (let* ((beg (line-beginning-position))
1467 (end (save-excursion (outline-next-heading) (point)))
1468 (org-clock-into-drawer (org-clock-into-drawer))
1469 (drawer (org-clock-drawer-name)))
1470 ;; Look for a running clock if FIND-UNCLOSED in non-nil.
1472 (let ((open-clock-re
1475 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1476 " *\\sw+ +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
1477 (while (re-search-forward open-clock-re end t
)
1478 (let ((element (org-element-at-point)))
1479 (when (and (eq (org-element-type element
) 'clock
)
1480 (eq (org-element-property :status element
) 'running
))
1482 (throw 'exit t
))))))
1483 ;; Look for an existing clock drawer.
1486 (let ((drawer-re (concat "^[ \t]*:" (regexp-quote drawer
) ":[ \t]*$")))
1487 (while (re-search-forward drawer-re end t
)
1488 (let ((element (org-element-at-point)))
1489 (when (eq (org-element-type element
) 'drawer
)
1490 (let ((cend (org-element-property :contents-end element
)))
1491 (if (and (not org-log-states-order-reversed
) cend
)
1494 (throw 'exit t
)))))))
1496 (let ((clock-re (concat "^[ \t]*" org-clock-string
))
1499 ;; Count the CLOCK lines and store their positions.
1501 (while (re-search-forward clock-re end t
)
1502 (let ((element (org-element-at-point)))
1503 (when (eq (org-element-type element
) 'clock
)
1504 (setq positions
(cons (line-beginning-position) positions
)
1505 count
(1+ count
))))))
1508 ;; Skip planning line and property drawer, if any.
1509 (org-end-of-meta-data)
1510 (unless (bolp) (insert "\n"))
1511 ;; Create a new drawer if necessary.
1512 (when (and org-clock-into-drawer
1513 (or (not (wholenump org-clock-into-drawer
))
1514 (< org-clock-into-drawer
2)))
1515 (let ((beg (point)))
1516 (insert ":" drawer
":\n:END:\n")
1517 (org-indent-region beg
(point))
1521 ;; When a clock drawer needs to be created because of the
1522 ;; number of clock items or simply if it is missing, collect
1523 ;; all clocks in the section and wrap them within the drawer.
1524 ((if (wholenump org-clock-into-drawer
)
1525 (>= (1+ count
) org-clock-into-drawer
)
1527 ;; Skip planning line and property drawer, if any.
1528 (org-end-of-meta-data)
1529 (let ((beg (point)))
1535 (org-trim (delete-and-extract-region
1536 (save-excursion (skip-chars-backward " \r\t\n")
1537 (line-beginning-position 2))
1538 (line-beginning-position 2)))))
1541 (let ((end (point-marker)))
1543 (save-excursion (insert ":" drawer
":\n"))
1545 (org-indent-region (point) end
)
1547 (unless org-log-states-order-reversed
1549 (beginning-of-line -
1))
1550 (set-marker end nil
))))
1551 (org-log-states-order-reversed (goto-char (car (last positions
))))
1552 (t (goto-char (car positions
))))))))
1555 (defun org-clock-out (&optional switch-to-state fail-quietly at-time
)
1556 "Stop the currently running clock.
1557 Throw an error if there is no running clock and FAIL-QUIETLY is nil.
1558 With a universal prefix, prompt for a state to switch the clocked out task
1559 to, overriding the existing value of `org-clock-out-switch-to-state'."
1562 (when (not (org-clocking-p))
1563 (setq global-mode-string
1564 (delq 'org-mode-line-string global-mode-string
))
1565 (setq frame-title-format org-frame-title-format-backup
)
1566 (force-mode-line-update)
1567 (if fail-quietly
(throw 'exit t
) (user-error "No active clock")))
1568 (let ((org-clock-out-switch-to-state
1570 (completing-read "Switch to state: "
1571 (with-current-buffer
1572 (marker-buffer org-clock-marker
)
1573 org-todo-keywords-1
)
1575 org-clock-out-switch-to-state
))
1576 (now (org-current-time org-clock-rounding-minutes
))
1578 (setq org-clock-out-time now
)
1579 (save-excursion ; Do not replace this with `with-current-buffer'.
1580 (with-no-warnings (set-buffer (org-clocking-buffer)))
1583 (goto-char org-clock-marker
)
1584 (beginning-of-line 1)
1585 (if (and (looking-at (concat "[ \t]*" org-keyword-time-regexp
))
1586 (equal (match-string 1) org-clock-string
))
1587 (setq ts
(match-string 2))
1588 (if fail-quietly
(throw 'exit nil
) (error "Clock start time is gone")))
1589 (goto-char (match-end 0))
1590 (delete-region (point) (point-at-eol))
1592 (setq te
(org-insert-time-stamp (or at-time now
) 'with-hm
'inactive
))
1593 (setq s
(- (float-time
1594 (apply #'encode-time
(org-parse-time-string te
)))
1596 (apply #'encode-time
(org-parse-time-string ts
))))
1597 h
(floor (/ s
3600))
1601 (insert " => " (format "%2d:%02d" h m
))
1602 (move-marker org-clock-marker nil
)
1603 (move-marker org-clock-hd-marker nil
)
1604 ;; Possibly remove zero time clocks. However, do not add
1605 ;; a note associated to the CLOCK line in this case.
1606 (cond ((and org-clock-out-remove-zero-time-clocks
1609 (delete-region (line-beginning-position)
1610 (line-beginning-position 2)))
1611 (org-log-note-clock-out
1613 'clock-out nil nil nil
1614 (concat "# Task: " (org-get-heading t
) "\n\n"))))
1615 (when org-clock-mode-line-timer
1616 (cancel-timer org-clock-mode-line-timer
)
1617 (setq org-clock-mode-line-timer nil
))
1618 (when org-clock-idle-timer
1619 (cancel-timer org-clock-idle-timer
)
1620 (setq org-clock-idle-timer nil
))
1621 (setq global-mode-string
1622 (delq 'org-mode-line-string global-mode-string
))
1623 (setq frame-title-format org-frame-title-format-backup
)
1624 (when org-clock-out-switch-to-state
1626 (org-back-to-heading t
)
1627 (let ((org-inhibit-logging t
)
1628 (org-clock-out-when-done nil
))
1630 ((functionp org-clock-out-switch-to-state
)
1631 (let ((case-fold-search nil
))
1632 (looking-at org-complex-heading-regexp
))
1633 (let ((newstate (funcall org-clock-out-switch-to-state
1635 (when newstate
(org-todo newstate
))))
1636 ((and org-clock-out-switch-to-state
1637 (not (looking-at (concat org-outline-regexp
"[ \t]*"
1638 org-clock-out-switch-to-state
1640 (org-todo org-clock-out-switch-to-state
))))))
1641 (force-mode-line-update)
1642 (message (concat "Clock stopped at %s after "
1643 (org-duration-from-minutes (+ (* 60 h
) m
)) "%s")
1644 te
(if remove
" => LINE REMOVED" ""))
1645 (run-hooks 'org-clock-out-hook
)
1646 (unless (org-clocking-p)
1647 (setq org-clock-current-task nil
)))))))
1649 (add-hook 'org-clock-out-hook
'org-clock-remove-empty-clock-drawer
)
1651 (defun org-clock-remove-empty-clock-drawer ()
1652 "Remove empty clock drawers in current subtree."
1654 (org-back-to-heading t
)
1657 (let ((drawer (org-clock-drawer-name))
1658 (case-fold-search t
))
1660 (let ((re (format "^[ \t]*:%s:[ \t]*$" (regexp-quote drawer
)))
1661 (end (save-excursion (outline-next-heading))))
1662 (while (re-search-forward re end t
)
1663 (org-remove-empty-drawer-at (point))))))))))
1665 (defun org-clock-timestamps-up (&optional n
)
1666 "Increase CLOCK timestamps at cursor.
1667 Optional argument N tells to change by that many units."
1669 (org-clock-timestamps-change 'up n
))
1671 (defun org-clock-timestamps-down (&optional n
)
1672 "Increase CLOCK timestamps at cursor.
1673 Optional argument N tells to change by that many units."
1675 (org-clock-timestamps-change 'down n
))
1677 (defun org-clock-timestamps-change (updown &optional n
)
1678 "Change CLOCK timestamps synchronously at cursor.
1679 UPDOWN tells whether to change `up' or `down'.
1680 Optional argument N tells to change by that many units."
1681 (let ((tschange (if (eq updown
'up
) 'org-timestamp-up
1682 'org-timestamp-down
))
1683 (timestamp?
(org-at-timestamp-p t
))
1684 ts1 begts1 ts2 begts2 updatets1 tdiff
)
1687 (move-beginning-of-line 1)
1688 (re-search-forward org-ts-regexp3 nil t
)
1689 (setq ts1
(match-string 0) begts1
(match-beginning 0))
1690 (when (re-search-forward org-ts-regexp3 nil t
)
1691 (setq ts2
(match-string 0) begts2
(match-beginning 0))))
1692 ;; Are we on the second timestamp?
1693 (if (<= begts2
(point)) (setq updatets1 t
))
1695 ;; fall back on org-timestamp-up if there is only one
1696 (funcall tschange n
)
1697 (funcall tschange n
)
1698 (let ((ts (if updatets1 ts2 ts1
))
1699 (begts (if updatets1 begts1 begts2
)))
1702 (org-time-string-to-time org-last-changed-timestamp
)
1703 (org-time-string-to-time ts
)))
1706 (org-timestamp-change
1707 (round (/ (float-time tdiff
)
1712 (`month
(* 24 3600 31))
1713 (`year
(* 24 3600 365.2)))))
1714 timestamp?
'updown
)))))))
1717 (defun org-clock-cancel ()
1718 "Cancel the running clock by removing the start timestamp."
1720 (when (not (org-clocking-p))
1721 (setq global-mode-string
1722 (delq 'org-mode-line-string global-mode-string
))
1723 (setq frame-title-format org-frame-title-format-backup
)
1724 (force-mode-line-update)
1725 (error "No active clock"))
1726 (save-excursion ; Do not replace this with `with-current-buffer'.
1727 (with-no-warnings (set-buffer (org-clocking-buffer)))
1728 (goto-char org-clock-marker
)
1729 (if (looking-back (concat "^[ \t]*" org-clock-string
".*")
1730 (line-beginning-position))
1731 (progn (delete-region (1- (point-at-bol)) (point-at-eol))
1732 (org-remove-empty-drawer-at (point)))
1733 (message "Clock gone, cancel the timer anyway")
1735 (move-marker org-clock-marker nil
)
1736 (move-marker org-clock-hd-marker nil
)
1737 (setq global-mode-string
1738 (delq 'org-mode-line-string global-mode-string
))
1739 (setq frame-title-format org-frame-title-format-backup
)
1740 (force-mode-line-update)
1741 (message "Clock canceled")
1742 (run-hooks 'org-clock-cancel-hook
))
1745 (defun org-clock-goto (&optional select
)
1746 "Go to the currently clocked-in entry, or to the most recently clocked one.
1747 With prefix arg SELECT, offer recently clocked tasks for selection."
1752 (or (org-clock-select-task "Select task to go to: ")
1753 (error "No task selected")))
1754 ((org-clocking-p) org-clock-marker
)
1755 ((and org-clock-goto-may-find-recent-task
1756 (car org-clock-history
)
1757 (marker-buffer (car org-clock-history
)))
1759 (car org-clock-history
))
1760 (t (error "No active or recent clock task")))))
1761 (pop-to-buffer-same-window (marker-buffer m
))
1762 (if (or (< m
(point-min)) (> m
(point-max))) (widen))
1765 (org-back-to-heading t
)
1766 (org-cycle-hide-drawers 'children
)
1767 (recenter org-clock-goto-before-context
)
1770 (message "No running clock, this is the most recently clocked task"))
1771 (run-hooks 'org-clock-goto-hook
)))
1773 (defvar-local org-clock-file-total-minutes nil
1774 "Holds the file total time in minutes, after a call to `org-clock-sum'.")
1776 (defun org-clock-sum-today (&optional headline-filter
)
1777 "Sum the times for each subtree for today."
1778 (let ((range (org-clock-special-range 'today
)))
1779 (org-clock-sum (car range
) (cadr range
)
1780 headline-filter
:org-clock-minutes-today
)))
1782 (defun org-clock-sum-custom (&optional headline-filter range propname
)
1783 "Sum the times for each subtree for today."
1784 (let ((r (or (and (symbolp range
) (org-clock-special-range range
))
1785 (org-clock-special-range
1786 (intern (completing-read
1788 '("today" "yesterday" "thisweek" "lastweek"
1789 "thismonth" "lastmonth" "thisyear" "lastyear"
1792 (org-clock-sum (car r
) (cadr r
)
1793 headline-filter
(or propname
:org-clock-minutes-custom
))))
1796 (defun org-clock-sum (&optional tstart tend headline-filter propname
)
1797 "Sum the times for each subtree.
1798 Puts the resulting times in minutes as a text property on each headline.
1799 TSTART and TEND can mark a time range to be considered.
1800 HEADLINE-FILTER is a zero-arg function that, if specified, is called for
1801 each headline in the time range with point at the headline. Headlines for
1802 which HEADLINE-FILTER returns nil are excluded from the clock summation.
1803 PROPNAME lets you set a custom text property instead of :org-clock-minutes."
1804 (org-with-silent-modifications
1805 (let* ((re (concat "^\\(\\*+\\)[ \t]\\|^[ \t]*"
1807 "[ \t]*\\(?:\\(\\[.*?\\]\\)-+\\(\\[.*?\\]\\)\\|=>[ \t]+\\([0-9]+\\):\\([0-9]+\\)\\)"))
1809 (ltimes (make-vector lmax
0))
1814 (if (stringp tstart
) (setq tstart
(org-time-string-to-seconds tstart
)))
1815 (if (stringp tend
) (setq tend
(org-time-string-to-seconds tend
)))
1816 (if (consp tstart
) (setq tstart
(float-time tstart
)))
1817 (if (consp tend
) (setq tend
(float-time tend
)))
1818 (remove-text-properties (point-min) (point-max)
1819 `(,(or propname
:org-clock-minutes
) t
1820 :org-clock-force-headline-inclusion t
))
1822 (goto-char (point-max))
1823 (while (re-search-backward re nil t
)
1827 (setq ts
(match-string 2)
1830 (apply #'encode-time
(org-parse-time-string ts
)))
1832 (apply #'encode-time
(org-parse-time-string te
)))
1833 ts
(if tstart
(max ts tstart
) ts
)
1834 te
(if tend
(min te tend
) te
)
1836 t1
(if (> dt
0) (+ t1
(floor (/ dt
60))) t1
)))
1839 (setq t1
(+ t1
(string-to-number (match-string 5))
1840 (* 60 (string-to-number (match-string 4))))))
1842 ;; Add the currently clocking item time to the total
1843 (when (and org-clock-report-include-clocking-task
1844 (equal (org-clocking-buffer) (current-buffer))
1845 (equal (marker-position org-clock-hd-marker
) (point))
1848 (>= (float-time org-clock-start-time
) tstart
)
1849 (<= (float-time org-clock-start-time
) tend
))
1850 (let ((time (floor (- (float-time)
1851 (float-time org-clock-start-time
))
1853 (setq t1
(+ t1 time
))))
1854 (let* ((headline-forced
1855 (get-text-property (point)
1856 :org-clock-force-headline-inclusion
))
1858 (or (null headline-filter
)
1860 (save-match-data (funcall headline-filter
))))))
1861 (setq level
(- (match-end 1) (match-beginning 1)))
1862 (when (>= level lmax
)
1863 (setq ltimes
(vconcat ltimes
(make-vector lmax
0)) lmax
(* 2 lmax
)))
1864 (when (or (> t1
0) (> (aref ltimes level
) 0))
1865 (when (or headline-included headline-forced
)
1866 (if headline-included
1867 (cl-loop for l from
0 to level do
1868 (aset ltimes l
(+ (aref ltimes l
) t1
))))
1869 (setq time
(aref ltimes level
))
1870 (goto-char (match-beginning 0))
1871 (put-text-property (point) (point-at-eol)
1872 (or propname
:org-clock-minutes
) time
)
1873 (when headline-filter
1876 (while (org-up-heading-safe)
1878 (point) (line-end-position)
1879 :org-clock-force-headline-inclusion t
))))))
1881 (cl-loop for l from level to
(1- lmax
) do
1882 (aset ltimes l
0)))))))
1883 (setq org-clock-file-total-minutes
(aref ltimes
0))))))
1885 (defun org-clock-sum-current-item (&optional tstart
)
1886 "Return time, clocked on current item in total."
1889 (org-narrow-to-subtree)
1890 (org-clock-sum tstart
)
1891 org-clock-file-total-minutes
)))
1894 (defun org-clock-display (&optional arg
)
1895 "Show subtree times in the entire buffer.
1897 By default, show the total time for the range defined in
1898 `org-clock-display-default-range'. With `\\[universal-argument]' \
1900 the total time for today instead.
1902 With `\\[universal-argument] \\[universal-argument]' prefix, \
1903 use a custom range, entered at prompt.
1905 With `\\[universal-argument] \ \\[universal-argument] \
1906 \\[universal-argument]' prefix, display the total time in the
1909 Use `\\[org-clock-remove-overlays]' to remove the subtree times."
1911 (org-clock-remove-overlays)
1912 (let* ((todayp (equal arg
'(4)))
1913 (customp (member arg
'((16) today yesterday
1914 thisweek lastweek thismonth
1915 lastmonth thisyear lastyear
1916 untilnow interactive
)))
1917 (prop (cond ((not arg
) :org-clock-minutes-default
)
1918 (todayp :org-clock-minutes-today
)
1919 (customp :org-clock-minutes-custom
)
1920 (t :org-clock-minutes
)))
1922 (cond ((not arg
) (org-clock-sum-custom
1923 nil org-clock-display-default-range prop
))
1924 (todayp (org-clock-sum-today))
1925 (customp (org-clock-sum-custom nil arg
))
1926 (t (org-clock-sum)))
1927 (unless (eq arg
'(64))
1929 (goto-char (point-min))
1930 (while (or (and (equal (setq p
(point)) (point-min))
1931 (get-text-property p prop
))
1932 (setq p
(next-single-property-change
1935 (when (setq time
(get-text-property p prop
))
1936 (org-clock-put-overlay time
)))
1937 (setq h
(/ org-clock-file-total-minutes
60)
1938 m
(- org-clock-file-total-minutes
(* 60 h
)))
1939 ;; Arrange to remove the overlays upon next change.
1940 (when org-remove-highlights-with-change
1941 (add-hook 'before-change-functions
'org-clock-remove-overlays
1943 (message (concat (format "Total file time%s: "
1944 (cond (todayp " for today")
1945 (customp " (custom)")
1947 (org-duration-from-minutes
1948 org-clock-file-total-minutes
)
1949 " (%d hours and %d minutes)")
1952 (defvar-local org-clock-overlays nil
)
1954 (defun org-clock-put-overlay (time)
1955 "Put an overlays on the current line, displaying TIME.
1956 This creates a new overlay and stores it in `org-clock-overlays', so that it
1957 will be easy to remove."
1960 (let ((case-fold-search nil
))
1961 (when (looking-at org-complex-heading-regexp
)
1962 (goto-char (match-beginning 4))))
1963 (setq ov
(make-overlay (point) (point-at-eol))
1964 tx
(concat (buffer-substring-no-properties (point) (match-end 4))
1967 (max 0 (- (- 60 (current-column))
1968 (- (match-end 4) (match-beginning 4))
1969 (length (org-get-at-bol 'line-prefix
)))) ?·
)
1972 (format " %9s " (org-duration-from-minutes time
))
1973 '(face org-clock-overlay
))
1975 (overlay-put ov
'display tx
)
1976 (push ov org-clock-overlays
)))
1979 (defun org-clock-remove-overlays (&optional _beg _end noremove
)
1980 "Remove the occur highlights from the buffer.
1981 If NOREMOVE is nil, remove this function from the
1982 `before-change-functions' in the current buffer."
1984 (unless org-inhibit-highlight-removal
1985 (mapc #'delete-overlay org-clock-overlays
)
1986 (setq org-clock-overlays nil
)
1988 (remove-hook 'before-change-functions
1989 'org-clock-remove-overlays
'local
))))
1991 (defvar org-state
) ;; dynamically scoped into this function
1992 (defun org-clock-out-if-current ()
1993 "Clock out if the current entry contains the running clock.
1994 This is used to stop the clock after a TODO entry is marked DONE,
1995 and is only done if the variable `org-clock-out-when-done' is not nil."
1996 (when (and (org-clocking-p)
1997 org-clock-out-when-done
1998 (marker-buffer org-clock-marker
)
1999 (or (and (eq t org-clock-out-when-done
)
2000 (member org-state org-done-keywords
))
2001 (and (listp org-clock-out-when-done
)
2002 (member org-state org-clock-out-when-done
)))
2003 (equal (or (buffer-base-buffer (org-clocking-buffer))
2004 (org-clocking-buffer))
2005 (or (buffer-base-buffer (current-buffer))
2007 (< (point) org-clock-marker
)
2008 (> (save-excursion (outline-next-heading) (point))
2010 ;; Clock out, but don't accept a logging message for this.
2011 (let ((org-log-note-clock-out nil
)
2012 (org-clock-out-switch-to-state nil
))
2015 (add-hook 'org-after-todo-state-change-hook
2016 'org-clock-out-if-current
)
2019 (defun org-clock-get-clocktable (&rest props
)
2020 "Get a formatted clocktable with parameters according to PROPS.
2021 The table is created in a temporary buffer, fully formatted and
2022 fontified, and then returned."
2024 (setq props
(plist-put props
:name
"clocktable"))
2025 (unless (plist-member props
:maxlevel
)
2026 (setq props
(plist-put props
:maxlevel
2)))
2027 (unless (plist-member props
:scope
)
2028 (setq props
(plist-put props
:scope
'agenda
)))
2031 (org-create-dblock props
)
2033 (org-font-lock-ensure)
2035 (buffer-substring (point) (progn
2036 (re-search-forward "^[ \t]*#\\+END" nil t
)
2040 (defun org-clock-report (&optional arg
)
2041 "Create a table containing a report about clocked time.
2042 If the cursor is inside an existing clocktable block, then the table
2043 will be updated. If not, a new clocktable will be inserted. The scope
2044 of the new clock will be subtree when called from within a subtree, and
2047 When called with a prefix argument, move to the first clock table in the
2048 buffer and update it."
2050 (org-clock-remove-overlays)
2052 (org-find-dblock "clocktable")
2054 (if (org-in-clocktable-p)
2055 (goto-char (org-in-clocktable-p))
2056 (let ((props (if (ignore-errors
2057 (save-excursion (org-back-to-heading)))
2058 (list :name
"clocktable" :scope
'subtree
)
2059 (list :name
"clocktable"))))
2061 (org-combine-plists org-clock-clocktable-default-properties props
))))
2062 (org-update-dblock))
2064 (defun org-day-of-week (day month year
)
2065 "Returns the day of the week as an integer."
2069 (format "%d-%02d-%02dT00:00:00" year month day
)))))
2071 (defun org-quarter-to-date (quarter year
)
2072 "Get the date (week day year) of the first day of a given quarter."
2076 (setq startday
(org-day-of-week 1 1 year
))
2079 (list 52 7 (- year
1)))
2081 (list 52 6 (- year
1)))
2083 (list 1 startday year
))
2085 (list 53 startday
(- year
1)))
2089 (setq startday
(org-day-of-week 1 4 year
))
2092 (list 13 startday year
))
2094 (list 14 startday year
))
2096 (list 13 startday year
))
2100 (setq startday
(org-day-of-week 1 7 year
))
2103 (list 26 startday year
))
2105 (list 27 startday year
))
2107 (list 26 startday year
))
2111 (setq startday
(org-day-of-week 1 10 year
))
2114 (list 39 startday year
))
2116 (list 40 startday year
))
2118 (list 39 startday year
)))))))
2120 (defun org-clock-special-range (key &optional time as-strings wstart mstart
)
2121 "Return two times bordering a special time range.
2123 KEY is a symbol specifying the range and can be one of `today',
2124 `yesterday', `thisweek', `lastweek', `thismonth', `lastmonth',
2125 `thisyear', `lastyear' or `untilnow'. If set to `interactive',
2126 user is prompted for range boundaries. It can be a string or an
2129 By default, a week starts Monday 0:00 and ends Sunday 24:00. The
2130 range is determined relative to TIME, which defaults to current
2133 The return value is a list containing two internal times, one for
2134 the beginning of the range and one for its end, like the ones
2135 returned by `current time' or `encode-time' and a string used to
2136 display information. If AS-STRINGS is non-nil, the returned
2137 times will be formatted strings.
2139 If WSTART is non-nil, use this number to specify the starting day
2140 of a week (monday is 1). If MSTART is non-nil, use this number
2141 to specify the starting day of a month (1 is the first day of the
2142 month). If you can combine both, the month starting day will
2144 (let* ((tm (decode-time time
))
2151 (skey (format "%s" key
))
2153 (q (cond ((>= month
10) 4)
2157 m1 h1 d1 month1 y1 shiftedy shiftedm shiftedq
)
2159 ((string-match "\\`[0-9]+\\'" skey
)
2160 (setq y
(string-to-number skey
) month
1 d
1 key
'year
))
2161 ((string-match "\\`\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)\\'" skey
)
2162 (setq y
(string-to-number (match-string 1 skey
))
2163 month
(string-to-number (match-string 2 skey
))
2166 ((string-match "\\`\\([0-9]+\\)-[wW]\\([0-9]\\{1,2\\}\\)\\'" skey
)
2168 (let ((date (calendar-gregorian-from-absolute
2169 (calendar-iso-to-absolute
2170 (list (string-to-number (match-string 2 skey
))
2172 (string-to-number (match-string 1 skey
)))))))
2173 (setq d
(nth 1 date
)
2178 ((string-match "\\`\\([0-9]+\\)-[qQ]\\([1-4]\\)\\'" skey
)
2180 (setq q
(string-to-number (match-string 2 skey
)))
2181 (let ((date (calendar-gregorian-from-absolute
2182 (calendar-iso-to-absolute
2183 (org-quarter-to-date
2184 q
(string-to-number (match-string 1 skey
)))))))
2185 (setq d
(nth 1 date
)
2191 "\\`\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)-\\([0-9]\\{1,2\\}\\)\\'"
2193 (setq y
(string-to-number (match-string 1 skey
))
2194 month
(string-to-number (match-string 2 skey
))
2195 d
(string-to-number (match-string 3 skey
))
2197 ((string-match "\\([-+][0-9]+\\)\\'" skey
)
2198 (setq shift
(string-to-number (match-string 1 skey
))
2199 key
(intern (substring skey
0 (match-beginning 1))))
2200 (when (and (memq key
'(quarter thisq
)) (> shift
0))
2201 (error "Looking forward with quarters isn't implemented"))))
2204 (`yesterday
(setq key
'today shift -
1))
2205 (`lastweek
(setq key
'week shift -
1))
2206 (`lastmonth
(setq key
'month shift -
1))
2207 (`lastyear
(setq key
'year shift -
1))
2208 (`lastq
(setq key
'quarter shift -
1))))
2209 ;; Prepare start and end times depending on KEY's type.
2211 ((or `day
`today
) (setq m
0 h
0 h1
24 d
(+ d shift
)))
2212 ((or `week
`thisweek
)
2213 (let* ((ws (or wstart
1))
2214 (diff (+ (* -
7 shift
) (if (= dow
0) (- 7 ws
) (- dow ws
)))))
2215 (setq m
0 h
0 d
(- d diff
) d1
(+ 7 d
))))
2216 ((or `month
`thismonth
)
2217 (setq h
0 m
0 d
(or mstart
1) month
(+ month shift
) month1
(1+ month
)))
2218 ((or `quarter
`thisq
)
2219 ;; Compute if this shift remains in this year. If not, compute
2220 ;; how many years and quarters we have to shift (via floor*) and
2221 ;; compute the shifted years, months and quarters.
2223 ((< (+ (- q
1) shift
) 0) ; Shift not in this year.
2224 (let* ((interval (* -
1 (+ (- q
1) shift
)))
2225 ;; Set tmp to ((years to shift) (quarters to shift)).
2226 (tmp (cl-floor interval
4)))
2227 ;; Due to the use of floor, 0 quarters actually means 4.
2228 (if (= 0 (nth 1 tmp
))
2229 (setq shiftedy
(- y
(nth 0 tmp
))
2232 (setq shiftedy
(- y
(+ 1 (nth 0 tmp
)))
2233 shiftedm
(- 13 (* 3 (nth 1 tmp
)))
2234 shiftedq
(- 5 (nth 1 tmp
)))))
2235 (setq m
0 h
0 d
1 month shiftedm month1
(+ 3 shiftedm
) y shiftedy
))
2236 ((> (+ q shift
) 0) ; Shift is within this year.
2237 (setq shiftedq
(+ q shift
))
2239 (let ((qshift (* 3 (1- (+ q shift
)))))
2240 (setq m
0 h
0 d
1 month
(+ 1 qshift
) month1
(+ 4 qshift
))))))
2241 ((or `year
`thisyear
)
2242 (setq m
0 h
0 d
1 month
1 y
(+ y shift
) y1
(1+ y
)))
2243 ((or `interactive
`untilnow
)) ; Special cases, ignore them.
2244 (_ (user-error "No such time block %s" key
)))
2245 ;; Format start and end times according to AS-STRINGS.
2246 (let* ((start (pcase key
2247 (`interactive
(org-read-date nil t nil
"Range start? "))
2248 (`untilnow org-clock--oldest-date
)
2249 (_ (encode-time 0 m h d month y
))))
2251 (`interactive
(org-read-date nil t nil
"Range end? "))
2252 (`untilnow
(current-time))
2261 ((or `day
`today
) (format-time-string "%A, %B %d, %Y" start
))
2262 ((or `week
`thisweek
) (format-time-string "week %G-W%V" start
))
2263 ((or `month
`thismonth
) (format-time-string "%B %Y" start
))
2264 ((or `year
`thisyear
) (format-time-string "the year %Y" start
))
2265 ((or `quarter
`thisq
)
2266 (concat (org-count-quarter shiftedq
)
2267 " quarter of " (number-to-string shiftedy
)))
2268 (`interactive
"(Range interactively set)")
2269 (`untilnow
"now"))))
2270 (if (not as-strings
) (list start end text
)
2271 (let ((f (cdr org-time-stamp-formats
)))
2272 (list (format-time-string f start
)
2273 (format-time-string f end
)
2276 (defun org-count-quarter (n)
2284 (defun org-clocktable-shift (dir n
)
2285 "Try to shift the :block date of the clocktable at point.
2286 Point must be in the #+BEGIN: line of a clocktable, or this function
2287 will throw an error.
2288 DIR is a direction, a symbol `left', `right', `up', or `down'.
2289 Both `left' and `down' shift the block toward the past, `up' and `right'
2290 push it toward the future.
2291 N is the number of shift steps to take. The size of the step depends on
2292 the currently selected interval size."
2293 (setq n
(prefix-numeric-value n
))
2294 (and (memq dir
'(left down
)) (setq n
(- n
)))
2296 (goto-char (point-at-bol))
2297 (if (not (looking-at "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>.*?:block[ \t]+\\(\\S-+\\)"))
2298 (error "Line needs a :block definition before this command works")
2299 (let* ((b (match-beginning 1)) (e (match-end 1))
2300 (s (match-string 1))
2301 block shift ins y mw d date wp m
)
2303 ((equal s
"yesterday") (setq s
"today-1"))
2304 ((equal s
"lastweek") (setq s
"thisweek-1"))
2305 ((equal s
"lastmonth") (setq s
"thismonth-1"))
2306 ((equal s
"lastyear") (setq s
"thisyear-1"))
2307 ((equal s
"lastq") (setq s
"thisq-1")))
2310 ((string-match "^\\(today\\|thisweek\\|thismonth\\|thisyear\\|thisq\\)\\([-+][0-9]+\\)?$" s
)
2311 (setq block
(match-string 1 s
)
2312 shift
(if (match-end 2)
2313 (string-to-number (match-string 2 s
))
2315 (setq shift
(+ shift n
))
2316 (setq ins
(if (= shift
0) block
(format "%s%+d" block shift
))))
2317 ((string-match "\\([0-9]+\\)\\(-\\([wWqQ]?\\)\\([0-9]\\{1,2\\}\\)\\(-\\([0-9]\\{1,2\\}\\)\\)?\\)?" s
)
2318 ;; 1 1 2 3 3 4 4 5 6 6 5 2
2319 (setq y
(string-to-number (match-string 1 s
))
2320 wp
(and (match-end 3) (match-string 3 s
))
2321 mw
(and (match-end 4) (string-to-number (match-string 4 s
)))
2322 d
(and (match-end 6) (string-to-number (match-string 6 s
))))
2324 (d (setq ins
(format-time-string
2326 (encode-time 0 0 0 (+ d n
) m y
))))
2327 ((and wp
(string-match "w\\|W" wp
) mw
(> (length wp
) 0))
2329 (setq date
(calendar-gregorian-from-absolute
2330 (calendar-iso-to-absolute (list (+ mw n
) 1 y
))))
2331 (setq ins
(format-time-string
2333 (encode-time 0 0 0 (nth 1 date
) (car date
) (nth 2 date
)))))
2334 ((and wp
(string-match "q\\|Q" wp
) mw
(> (length wp
) 0))
2336 ; if the 4th + 1 quarter is requested we flip to the 1st quarter of the next year
2341 ; if the 1st - 1 quarter is requested we flip to the 4th quarter of the previous year
2346 (setq date
(calendar-gregorian-from-absolute
2347 (calendar-iso-to-absolute (org-quarter-to-date (+ mw n
) y
))))
2348 (setq ins
(format-time-string
2349 (concat (number-to-string y
) "-Q" (number-to-string (+ mw n
)))
2350 (encode-time 0 0 0 (nth 1 date
) (car date
) (nth 2 date
)))))
2352 (setq ins
(format-time-string
2354 (encode-time 0 0 0 1 (+ mw n
) y
))))
2356 (setq ins
(number-to-string (+ y n
))))))
2357 (t (error "Cannot shift clocktable block")))
2361 (delete-region (point) (+ (point) (- e b
)))
2362 (beginning-of-line 1)
2367 (defun org-dblock-write:clocktable
(params)
2368 "Write the standard clocktable."
2369 (setq params
(org-combine-plists org-clocktable-defaults params
))
2371 (let* ((scope (plist-get params
:scope
))
2374 (org-agenda-files t
))
2375 (`agenda-with-archives
2376 (org-add-archive-files (org-agenda-files t
)))
2377 (`file-with-archives
2378 (and buffer-file-name
2379 (org-add-archive-files (list buffer-file-name
))))
2380 ((pred consp
) scope
)
2381 (_ (or (buffer-file-name) (current-buffer)))))
2382 (block (plist-get params
:block
))
2383 (ts (plist-get params
:tstart
))
2384 (te (plist-get params
:tend
))
2385 (ws (plist-get params
:wstart
))
2386 (ms (plist-get params
:mstart
))
2387 (step (plist-get params
:step
))
2388 (formatter (or (plist-get params
:formatter
)
2389 org-clock-clocktable-formatter
2390 'org-clocktable-write-default
))
2392 ;; Check if we need to do steps
2394 ;; Get the range text for the header
2395 (setq cc
(org-clock-special-range block nil t ws ms
)
2399 ;; Write many tables, in steps
2400 (unless (or block
(and ts te
))
2401 (error "Clocktable `:step' can only be used with `:block' or `:tstart,:end'"))
2402 (org-clocktable-steps params
)
2405 (org-agenda-prepare-buffers (if (consp files
) files
(list files
)))
2407 (let ((origin (point))
2410 (mapcar (lambda (file)
2411 (with-current-buffer (find-buffer-visiting file
)
2414 (org-clock-get-table-data file params
)))))
2416 ;; Get the right restriction for the scope.
2418 ((not scope
)) ;use the restriction as it is now
2419 ((eq scope
'file
) (widen))
2420 ((eq scope
'subtree
) (org-narrow-to-subtree))
2422 (while (org-up-heading-safe))
2423 (org-narrow-to-subtree))
2424 ((and (symbolp scope
)
2425 (string-match "\\`tree\\([0-9]+\\)\\'"
2426 (symbol-name scope
)))
2427 (let ((level (string-to-number
2428 (match-string 1 (symbol-name scope
)))))
2430 (while (org-up-heading-safe)
2431 (looking-at org-outline-regexp
)
2432 (when (<= (org-reduced-level (funcall outline-level
))
2434 (throw 'exit nil
))))
2435 (org-narrow-to-subtree))))
2436 (list (org-clock-get-table-data nil params
))))
2438 ;; Even though `file-with-archives' can consist of
2439 ;; multiple files, we consider this is one extended file
2441 (and (consp files
) (not (eq scope
'file-with-archives
)))))
2446 (org-combine-plists params
`(:multifile
,multifile
)))))))
2448 (defun org-clocktable-write-default (ipos tables params
)
2449 "Write out a clock table at position IPOS in the current buffer.
2450 TABLES is a list of tables with clocking data as produced by
2451 `org-clock-get-table-data'. PARAMS is the parameter property list obtained
2452 from the dynamic block definition."
2453 ;; This function looks quite complicated, mainly because there are a
2454 ;; lot of options which can add or remove columns. I have massively
2455 ;; commented this function, the I hope it is understandable. If
2456 ;; someone wants to write their own special formatter, this maybe
2457 ;; much easier because there can be a fixed format with a
2458 ;; well-defined number of columns...
2459 (let* ((lang (or (plist-get params
:lang
) "en"))
2460 (multifile (plist-get params
:multifile
))
2461 (block (plist-get params
:block
))
2462 (sort (plist-get params
:sort
))
2463 (header (plist-get params
:header
))
2464 (link (plist-get params
:link
))
2465 (maxlevel (or (plist-get params
:maxlevel
) 3))
2466 (emph (plist-get params
:emphasize
))
2467 (compact?
(plist-get params
:compact
))
2468 (narrow (or (plist-get params
:narrow
) (and compact?
'40!)))
2469 (level?
(and (not compact?
) (plist-get params
:level
)))
2470 (timestamp (plist-get params
:timestamp
))
2471 (properties (plist-get params
:properties
))
2472 (time-columns (if compact?
1
2473 (min maxlevel
(or (plist-get params
:tcolumns
) 100))))
2474 (indent (or compact?
(plist-get params
:indent
)))
2475 (formula (plist-get params
:formula
))
2476 (case-fold-search t
)
2477 (total-time (apply #'+ (mapcar #'cadr tables
)))
2478 recalc narrow-cut-p
)
2480 (when (and narrow
(integerp narrow
) link
)
2481 ;; We cannot have both integer narrow and link.
2482 (message "Using hard narrowing in clocktable to allow for links")
2483 (setq narrow
(intern (format "%d!" narrow
))))
2486 ((or `nil
(pred integerp
)) nil
) ;nothing to do
2487 ((and (pred symbolp
)
2488 (guard (string-match-p "\\`[0-9]+!\\'" (symbol-name narrow
))))
2489 (setq narrow-cut-p t
)
2490 (setq narrow
(string-to-number (symbol-name narrow
))))
2491 (_ (error "Invalid value %s of :narrow property in clock table" narrow
)))
2493 ;; Now we need to output this table stuff.
2496 ;; Insert the text *before* the actual table.
2497 (insert-before-markers
2499 ;; Format the standard header.
2500 (format "#+CAPTION: %s %s%s\n"
2501 (org-clock--translate "Clock summary at" lang
)
2502 (format-time-string (org-time-stamp-format t t
))
2505 (nth 2 (org-clock-special-range
2507 (plist-get params
:wstart
)
2508 (plist-get params
:mstart
)))))
2509 (format ", for %s." range-text
))
2512 ;; Insert the narrowing line
2513 (when (and narrow
(integerp narrow
) (not narrow-cut-p
))
2514 (insert-before-markers
2515 "|" ;table line starter
2516 (if multifile
"|" "") ;file column, maybe
2517 (if level?
"|" "") ;level column, maybe
2518 (if timestamp
"|" "") ;timestamp column, maybe
2519 (if properties
;properties columns, maybe
2520 (make-string (length properties
) ?|
)
2522 (format "<%d>| |\n" narrow
))) ;headline and time columns
2524 ;; Insert the table header line
2525 (insert-before-markers
2526 "|" ;table line starter
2527 (if multifile
;file column, maybe
2528 (concat (org-clock--translate "File" lang
) "|")
2530 (if level?
;level column, maybe
2531 (concat (org-clock--translate "L" lang
) "|")
2533 (if timestamp
;timestamp column, maybe
2534 (concat (org-clock--translate "Timestamp" lang
) "|")
2536 (if properties
;properties columns, maybe
2537 (concat (mapconcat #'identity properties
"|") "|")
2539 (concat (org-clock--translate "Headline" lang
)"|")
2540 (concat (org-clock--translate "Time" lang
) "|")
2541 (make-string (max 0 (1- time-columns
)) ?|
) ;other time columns
2542 (if (eq formula
'%
) "%|\n" "\n"))
2544 ;; Insert the total time in the table
2545 (insert-before-markers
2547 "|" ;table line starter
2548 (if multifile
(format "| %s " (org-clock--translate "ALL" lang
)) "")
2550 (if level?
"|" "") ;level column, maybe
2551 (if timestamp
"|" "") ;timestamp column, maybe
2552 (make-string (length properties
) ?|
) ;properties columns, maybe
2553 (concat (format org-clock-total-time-cell-format
2554 (org-clock--translate "Total time" lang
))
2556 (format org-clock-total-time-cell-format
2557 (org-duration-from-minutes (or total-time
0))) ;time
2559 (make-string (max 0 (1- time-columns
)) ?|
)
2560 (cond ((not (eq formula
'%
)) "")
2561 ((or (not total-time
) (= total-time
0)) "0.0|")
2565 ;; Now iterate over the tables and insert the data but only if any
2566 ;; time has been collected.
2567 (when (and total-time
(> total-time
0))
2568 (pcase-dolist (`(,file-name
,file-time
,entries
) tables
)
2569 (when (or (and file-time
(> file-time
0))
2570 (not (plist-get params
:fileskip0
)))
2571 (insert-before-markers "|-\n") ;hline at new file
2572 ;; First the file time, if we have multiple files.
2574 ;; Summarize the time collected from this file.
2575 (insert-before-markers
2576 (format (concat "| %s %s | %s%s"
2577 (format org-clock-file-time-cell-format
2578 (org-clock--translate "File time" lang
))
2580 (file-name-nondirectory file-name
)
2581 (if level?
"| " "") ;level column, maybe
2582 (if timestamp
"| " "") ;timestamp column, maybe
2583 (if properties
;properties columns, maybe
2584 (make-string (length properties
) ?|
)
2586 (org-duration-from-minutes file-time
)))) ;time
2588 ;; Get the list of node entries and iterate over it
2589 (when (> maxlevel
0)
2590 (pcase-dolist (`(,level
,headline
,ts
,time .
,props
) entries
)
2593 (if (and (string-match
2594 (format "\\`%s\\'" org-bracket-link-regexp
)
2597 (format "[[%s][%s]]"
2598 (match-string 1 headline
)
2599 (org-shorten-string (match-string 3 headline
)
2601 (org-shorten-string headline narrow
))))
2602 (cl-flet ((format-field
2603 (let ((marker (pcase level
2604 ((guard (not emph
)) "")
2605 (1 "*") (2 "/") (_ ""))))
2607 (format "%s%s%s |" marker field marker
)))))
2608 (insert-before-markers
2609 "|" ;start the table line
2610 (if multifile
"|" "") ;free space for file name column?
2611 (if level?
(format "%d|" level
) "") ;level, maybe
2612 (if timestamp
(concat ts
"|") "") ;timestamp, maybe
2613 (if properties
;properties columns, maybe
2614 (concat (mapconcat (lambda (p) (or (cdr (assoc p props
)) ""))
2619 (if indent
;indentation
2620 (org-clocktable-indent-string level
)
2622 (format-field headline
)
2623 ;; Empty fields for higher levels.
2624 (make-string (max 0 (1- (min time-columns level
))) ?|
)
2625 (format-field (org-duration-from-minutes time
))
2627 (format "%.1f |" (* 100 (/ time
(float total-time
))))
2632 ;; Possibly rescue old formula?
2633 ((or (not formula
) (eq formula
'%
))
2634 (let ((contents (org-string-nw-p (plist-get params
:content
))))
2635 (when (and contents
(string-match "^\\([ \t]*#\\+tblfm:.*\\)" contents
))
2637 (insert "\n" (match-string 1 contents
))
2638 (beginning-of-line 0))))
2639 ;; Insert specified formula line.
2641 (insert "\n#+TBLFM: " formula
)
2644 (user-error "Invalid :formula parameter in clocktable")))
2645 ;; Back to beginning, align the table, recalculate if necessary.
2647 (skip-chars-forward "^|")
2649 (when org-hide-emphasis-markers
2650 ;; We need to align a second time.
2654 (org-table-goto-line 3)
2655 (org-table-goto-column (car sort
))
2656 (org-table-sort-lines nil
(cdr sort
))))
2657 (when recalc
(org-table-recalculate 'all
))
2660 (defun org-clocktable-indent-string (level)
2661 "Return indentation string according to LEVEL.
2662 LEVEL is an integer. Indent by two spaces per level above 1."
2664 (concat "\\_" (make-string (* 2 (1- level
)) ?\s
))))
2666 (defun org-clocktable-steps (params)
2667 "Step through the range to make a number of clock tables."
2668 (let* ((p1 (copy-sequence params
))
2669 (ts (plist-get p1
:tstart
))
2670 (te (plist-get p1
:tend
))
2671 (ws (plist-get p1
:wstart
))
2672 (ms (plist-get p1
:mstart
))
2673 (step0 (plist-get p1
:step
))
2674 (step (cdr (assoc step0
'((day .
86400) (week .
604800)))))
2675 (stepskip0 (plist-get p1
:stepskip0
))
2676 (block (plist-get p1
:block
))
2679 (setq cc
(org-clock-special-range block nil t ws ms
)
2684 ;; If ts is a number, it's an absolute day number from
2686 (pcase-let ((`(,month
,day
,year
) (calendar-gregorian-from-absolute ts
)))
2687 (setq ts
(float-time (encode-time 0 0 0 day month year
)))))
2689 (setq ts
(float-time (apply #'encode-time
(org-parse-time-string ts
))))))
2693 (pcase-let ((`(,month
,day
,year
) (calendar-gregorian-from-absolute te
)))
2694 (setq te
(float-time (encode-time 0 0 0 day month year
)))))
2696 (setq te
(float-time (apply #'encode-time
(org-parse-time-string te
))))))
2698 (if (eq step0
'week
)
2699 (- ts
(* 86400 (- (nth 6 (decode-time (seconds-to-time ts
))) ws
)))
2701 (setq p1
(plist-put p1
:header
""))
2702 (setq p1
(plist-put p1
:step nil
))
2703 (setq p1
(plist-put p1
:block nil
))
2705 (or (bolp) (insert "\n"))
2706 (setq p1
(plist-put p1
:tstart
(format-time-string
2707 (org-time-stamp-format nil t
)
2708 (seconds-to-time (max tsb ts
)))))
2709 (setq p1
(plist-put p1
:tend
(format-time-string
2710 (org-time-stamp-format nil t
)
2711 (seconds-to-time (min te
(setq tsb
(+ tsb step
)))))))
2712 (insert "\n" (if (eq step0
'day
) "Daily report: "
2713 "Weekly report starting on: ")
2714 (plist-get p1
:tstart
) "\n")
2715 (setq step-time
(org-dblock-write:clocktable p1
))
2716 (re-search-forward "^[ \t]*#\\+END:")
2717 (when (and (equal step-time
0) stepskip0
)
2718 ;; Remove the empty table
2719 (delete-region (point-at-bol)
2721 (re-search-backward "^\\(Daily\\|Weekly\\) report"
2726 (defun org-clock-get-table-data (file params
)
2727 "Get the clocktable data for file FILE, with parameters PARAMS.
2728 FILE is only for identification - this function assumes that
2729 the correct buffer is current, and that the wanted restriction is
2731 The return value will be a list with the file name and the total
2732 file time (in minutes) as 1st and 2nd elements. The third element
2733 of this list will be a list of headline entries. Each entry has the
2734 following structure:
2736 (LEVEL HEADLINE TIMESTAMP TIME)
2738 LEVEL: The level of the headline, as an integer. This will be
2739 the reduced level, so 1,2,3,... even if only odd levels
2741 HEADLINE: The text of the headline. Depending on PARAMS, this may
2742 already be formatted like a link.
2743 TIMESTAMP: If PARAMS require it, this will be a time stamp found in the
2744 entry, any of SCHEDULED, DEADLINE, NORMAL, or first inactive,
2746 TIME: The sum of all time spend in this tree, in minutes. This time
2747 will of cause be restricted to the time block and tags match
2748 specified in PARAMS."
2749 (let* ((maxlevel (or (plist-get params
:maxlevel
) 3))
2750 (timestamp (plist-get params
:timestamp
))
2751 (ts (plist-get params
:tstart
))
2752 (te (plist-get params
:tend
))
2753 (ws (plist-get params
:wstart
))
2754 (ms (plist-get params
:mstart
))
2755 (block (plist-get params
:block
))
2756 (link (plist-get params
:link
))
2757 (tags (plist-get params
:tags
))
2758 (properties (plist-get params
:properties
))
2759 (inherit-property-p (plist-get params
:inherit-props
))
2760 (matcher (and tags
(cdr (org-make-tags-matcher tags
))))
2761 cc st p time level hdl props tsp tbl
)
2763 (setq org-clock-file-total-minutes nil
)
2765 (setq cc
(org-clock-special-range block nil t ws ms
)
2768 (when (integerp ts
) (setq ts
(calendar-gregorian-from-absolute ts
)))
2769 (when (integerp te
) (setq te
(calendar-gregorian-from-absolute te
)))
2770 (when (and ts
(listp ts
))
2771 (setq ts
(format "%4d-%02d-%02d" (nth 2 ts
) (car ts
) (nth 1 ts
))))
2772 (when (and te
(listp te
))
2773 (setq te
(format "%4d-%02d-%02d" (nth 2 te
) (car te
) (nth 1 te
))))
2774 ;; Now the times are strings we can parse.
2775 (if ts
(setq ts
(org-matcher-time ts
)))
2776 (if te
(setq te
(org-matcher-time te
)))
2778 (org-clock-sum ts te
2781 (let* ((tags-list (org-get-tags-at))
2782 (org-scanner-tags tags-list
)
2783 (org-trust-scanner-tags t
))
2784 (funcall ,matcher nil tags-list nil
)))))
2785 (goto-char (point-min))
2787 (while (or (and (bobp) (prog1 st
(setq st nil
))
2788 (get-text-property (point) :org-clock-minutes
)
2789 (setq p
(point-min)))
2790 (setq p
(next-single-property-change
2791 (point) :org-clock-minutes
)))
2793 (when (setq time
(get-text-property p
:org-clock-minutes
))
2795 (beginning-of-line 1)
2796 (when (and (looking-at "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@#%:]+:\\)?[ \t]*$")
2797 (setq level
(org-reduced-level
2798 (- (match-end 1) (match-beginning 1))))
2799 (<= level maxlevel
))
2800 (setq hdl
(if (not link
)
2802 (org-make-link-string
2803 (format "file:%s::%s"
2807 (org-make-org-heading-search-string
2808 (replace-regexp-in-string
2809 org-bracket-link-regexp
2810 (lambda (m) (or (match-string 3 m
)
2811 (match-string 1 m
)))
2812 (match-string 2)))))
2814 (setq props
(org-entry-properties (point)))
2815 (or (cdr (assoc "SCHEDULED" props
))
2816 (cdr (assoc "DEADLINE" props
))
2817 (cdr (assoc "TIMESTAMP" props
))
2818 (cdr (assoc "TIMESTAMP_IA" props
))))
2819 props
(when properties
2823 (when (org-entry-get (point) p inherit-property-p
)
2824 (cons p
(org-entry-get (point) p inherit-property-p
))))
2826 (when (> time
0) (push (list level hdl tsp time props
) tbl
))))))
2827 (setq tbl
(nreverse tbl
))
2828 (list file org-clock-file-total-minutes tbl
))))
2830 ;; Saving and loading the clock
2832 (defvar org-clock-loaded nil
2833 "Was the clock file loaded?")
2836 (defun org-clock-update-time-maybe ()
2837 "If this is a CLOCK line, update it and return t.
2838 Otherwise, return nil."
2841 (beginning-of-line 1)
2842 (skip-chars-forward " \t")
2843 (when (looking-at org-clock-string
)
2844 (let ((re (concat "[ \t]*" org-clock-string
2845 " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
2846 "\\([ \t]*=>.*\\)?\\)?"))
2849 ((not (looking-at re
))
2851 ((not (match-end 2))
2852 (when (and (equal (marker-buffer org-clock-marker
) (current-buffer))
2853 (> org-clock-marker
(point))
2854 (<= org-clock-marker
(point-at-eol)))
2855 ;; The clock is running here
2856 (setq org-clock-start-time
2858 (org-parse-time-string (match-string 1))))
2859 (org-clock-update-mode-line)))
2861 (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
2863 (setq ts
(match-string 1)
2864 te
(match-string 3))
2865 (setq s
(- (float-time
2866 (apply #'encode-time
(org-parse-time-string te
)))
2868 (apply #'encode-time
(org-parse-time-string ts
))))
2871 h
(floor (/ s
3600))
2875 (insert " => " (format (if neg
"-%d:%02d" "%2d:%02d") h m
))
2878 (defun org-clock-save ()
2879 "Persist various clock-related data to disk.
2880 The details of what will be saved are regulated by the variable
2881 `org-clock-persist'."
2882 (when (and org-clock-persist
2883 (or org-clock-loaded
2884 org-clock-has-been-used
2885 (not (file-exists-p org-clock-persist-file
))))
2886 (with-temp-file org-clock-persist-file
2887 (insert (format ";; %s - %s at %s\n"
2888 (file-name-nondirectory org-clock-persist-file
)
2890 (format-time-string (org-time-stamp-format t
))))
2891 ;; Store clock to be resumed.
2892 (when (and (memq org-clock-persist
'(t clock
))
2893 (let ((b (org-base-buffer (org-clocking-buffer))))
2894 (and (buffer-live-p b
)
2895 (buffer-file-name b
)
2896 (or (not org-clock-persist-query-save
)
2897 (y-or-n-p (format "Save current clock (%s) "
2898 org-clock-heading
))))))
2900 (format "(setq org-clock-stored-resume-clock '(%S . %d))\n"
2901 (buffer-file-name (org-base-buffer (org-clocking-buffer)))
2902 (marker-position org-clock-marker
))))
2903 ;; Store clocked task history. Tasks are stored reversed to
2904 ;; make reading simpler.
2905 (when (and (memq org-clock-persist
'(t history
))
2908 (format "(setq org-clock-stored-history '(%s))\n"
2911 (let ((b (org-base-buffer (marker-buffer m
))))
2912 (when (and (buffer-live-p b
)
2913 (buffer-file-name b
))
2915 (buffer-file-name b
)
2916 (marker-position m
)))))
2917 (reverse org-clock-history
)
2920 (defun org-clock-load ()
2921 "Load clock-related data from disk, maybe resuming a stored clock."
2922 (when (and org-clock-persist
(not org-clock-loaded
))
2923 (if (not (file-readable-p org-clock-persist-file
))
2924 (message "Not restoring clock data; %S not found" org-clock-persist-file
)
2925 (message "Restoring clock data")
2927 (load-file org-clock-persist-file
)
2928 (setq org-clock-loaded t
)
2929 (pcase-dolist (`(,(and file
(pred file-exists-p
)) .
,position
)
2930 org-clock-stored-history
)
2931 (org-clock-history-push position
(find-file-noselect file
)))
2933 (pcase org-clock-stored-resume-clock
2934 (`(,(and file
(pred file-exists-p
)) .
,position
)
2935 (with-current-buffer (find-file-noselect file
)
2936 (when (or (not org-clock-persist-query-resume
)
2937 (y-or-n-p (format "Resume clock (%s) "
2939 (goto-char position
)
2940 (org-get-heading t t
)))))
2941 (goto-char position
)
2942 (let ((org-clock-in-resume 'auto-restart
)
2943 (org-clock-auto-clock-resolution nil
))
2945 (when (outline-invisible-p) (org-show-context))))))
2948 ;; Suggested bindings
2949 (org-defkey org-mode-map
"\C-c\C-x\C-e" 'org-clock-modify-effort-estimate
)
2951 (provide 'org-clock
)
2954 ;; generated-autoload-file: "org-loaddefs.el"
2957 ;;; org-clock.el ends here
