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 ("de" "Datei" "E" "Zeitstempel" "Kopfzeile" "Dauer" "GESAMT"
325 "Gesamtdauer" "Dateizeit" "Erstellt am"))
326 "Terms used in clocktable, translated to different languages."
327 :group
'org-clocktable
331 (defcustom org-clock-clocktable-default-properties
'(:maxlevel
2 :scope file
)
332 "Default properties for new clocktables.
333 These will be inserted into the BEGIN line, to make it easy for users to
335 :group
'org-clocktable
338 (defcustom org-clock-idle-time nil
339 "When non-nil, resolve open clocks if the user is idle more than X minutes."
342 (const :tag
"Never" nil
)
343 (integer :tag
"After N minutes")))
345 (defcustom org-clock-auto-clock-resolution
'when-no-clock-is-running
346 "When to automatically resolve open clocks found in Org buffers."
349 (const :tag
"Never" nil
)
350 (const :tag
"Always" t
)
351 (const :tag
"When no clock is running" when-no-clock-is-running
)))
353 (defcustom org-clock-report-include-clocking-task nil
354 "When non-nil, include the current clocking task time in clock reports."
359 (defcustom org-clock-resolve-expert nil
360 "Non-nil means do not show the splash buffer with the clock resolver."
365 (defcustom org-clock-continuously nil
366 "Non-nil means to start clocking from the last clock-out time, if any."
371 (defcustom org-clock-total-time-cell-format
"*%s*"
372 "Format string for the total time cells."
377 (defcustom org-clock-file-time-cell-format
"*%s*"
378 "Format string for the file time cells."
383 (defcustom org-clock-clocked-in-display
'mode-line
384 "When clocked in for a task, Org can display the current
385 task and accumulated time in the mode line and/or frame title.
388 both displays in both mode line and frame title
389 mode-line displays only in mode line (default)
390 frame-title displays only in frame title
391 nil current clock is not displayed"
394 (const :tag
"Mode line" mode-line
)
395 (const :tag
"Frame title" frame-title
)
396 (const :tag
"Both" both
)
397 (const :tag
"None" nil
)))
399 (defcustom org-clock-frame-title-format
'(t org-mode-line-string
)
400 "The value for `frame-title-format' when clocking in.
402 When `org-clock-clocked-in-display' is set to `frame-title'
403 or `both', clocking in will replace `frame-title-format' with
404 this value. Clocking out will restore `frame-title-format'.
406 `org-frame-title-string' is a format string using the same
407 specifications than `frame-title-format', which see."
412 (defcustom org-clock-x11idle-program-name
"x11idle"
413 "Name of the program which prints X11 idle time in milliseconds.
415 You can find x11idle.c in the contrib/scripts directory of the
416 Org git distribution. Or, you can do:
418 sudo apt-get install xprintidle
420 if you are using Debian."
423 :package-version
'(Org .
"8.0")
426 (defcustom org-clock-goto-before-context
2
427 "Number of lines of context to display before currently clocked-in entry.
428 This applies when using `org-clock-goto'."
432 (defcustom org-clock-display-default-range
'thisyear
433 "Default range when displaying clocks with `org-clock-display'."
435 :type
'(choice (const today
)
444 (const :tag
"Select range interactively" interactive
)))
446 (defvar org-clock-in-prepare-hook nil
447 "Hook run when preparing the clock.
448 This hook is run before anything happens to the task that
449 you want to clock in. For example, you can use this hook
450 to add an effort property.")
451 (defvar org-clock-in-hook nil
452 "Hook run when starting the clock.")
453 (defvar org-clock-out-hook nil
454 "Hook run when stopping the current clock.")
456 (defvar org-clock-cancel-hook nil
457 "Hook run when canceling the current clock.")
458 (defvar org-clock-goto-hook nil
459 "Hook run when selecting the currently clocked-in entry.")
460 (defvar org-clock-has-been-used nil
461 "Has the clock been used during the current Emacs session?")
463 (defvar org-clock-stored-history nil
464 "Clock history, populated by `org-clock-load'")
465 (defvar org-clock-stored-resume-clock nil
466 "Clock to resume, saved by `org-clock-load'")
468 (defconst org-clock--oldest-date
470 (lambda (min max pred
)
471 (if (funcall pred min
) min
473 (while (> (- max min
) 1)
474 (let ((mean (+ (ash min -
1) (ash max -
1) (logand min max
1))))
475 (if (funcall pred mean
) (setq max mean
) (setq min mean
)))))
481 (lambda (m) (ignore-errors (decode-time (list m
0))))))
486 (lambda (m) (ignore-errors (decode-time (list high m
)))))))
488 "Internal time for oldest date representable on the system.")
490 ;;; The clock for measuring work time.
492 (defvar org-mode-line-string
"")
493 (put 'org-mode-line-string
'risky-local-variable t
)
495 (defvar org-clock-mode-line-timer nil
)
496 (defvar org-clock-idle-timer nil
)
497 (defvar org-clock-heading
) ; defined in org.el
498 (defvar org-clock-start-time
"")
500 (defvar org-clock-leftover-time nil
501 "If non-nil, user canceled a clock; this is when leftover time started.")
503 (defvar org-clock-effort
""
504 "Effort estimate of the currently clocking task.")
506 (defvar org-clock-total-time nil
507 "Holds total time, spent previously on currently clocked item.
508 This does not include the time in the currently running clock.")
510 (defvar org-clock-history nil
511 "List of marker pointing to recent clocked tasks.")
513 (defvar org-clock-default-task
(make-marker)
514 "Marker pointing to the default task that should clock time.
515 The clock can be made to switch to this task after clocking out
516 of a different task.")
518 (defvar org-clock-interrupted-task
(make-marker)
519 "Marker pointing to the task that has been interrupted by the current clock.")
521 (defvar org-clock-mode-line-map
(make-sparse-keymap))
522 (define-key org-clock-mode-line-map
[mode-line mouse-2
] 'org-clock-goto
)
523 (define-key org-clock-mode-line-map
[mode-line mouse-1
] 'org-clock-menu
)
525 (defun org-clock--translate (s language
)
526 "Translate string S into using string LANGUAGE.
527 Assume S in the English term to translate. Return S as-is if it
528 cannot be translated."
530 ("File" 1) ("L" 2) ("Timestamp" 3) ("Headline" 4) ("Time" 5)
531 ("ALL" 6) ("Total time" 7) ("File time" 8) ("Clock summary at" 9))
532 (assoc-string language org-clock-clocktable-language-setup t
))
535 (defun org-clock-menu ()
539 ["Clock out" org-clock-out t
]
540 ["Change effort estimate" org-clock-modify-effort-estimate t
]
541 ["Go to clock entry" org-clock-goto t
]
542 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t
:keys
"C-u C-c C-x C-i"])))
544 (defun org-clock-history-push (&optional pos buffer
)
545 "Push a marker to the clock history."
546 (setq org-clock-history-length
(max 1 (min 35 org-clock-history-length
)))
547 (let ((m (move-marker (make-marker)
548 (or pos
(point)) (org-base-buffer
549 (or buffer
(current-buffer)))))
551 (while (setq n
(member m org-clock-history
))
552 (move-marker (car n
) nil
))
553 (setq org-clock-history
555 (mapcar (lambda (x) (if (marker-buffer x
) x nil
))
557 (when (>= (setq l
(length org-clock-history
)) org-clock-history-length
)
558 (setq org-clock-history
560 (nthcdr (- l org-clock-history-length -
1)
561 (nreverse org-clock-history
)))))
562 (push m org-clock-history
)))
564 (defun org-clock-save-markers-for-cut-and-paste (beg end
)
565 "Save relative positions of markers in region."
566 (org-check-and-save-marker org-clock-marker beg end
)
567 (org-check-and-save-marker org-clock-hd-marker beg end
)
568 (org-check-and-save-marker org-clock-default-task beg end
)
569 (org-check-and-save-marker org-clock-interrupted-task beg end
)
570 (dolist (m org-clock-history
)
571 (org-check-and-save-marker m beg end
)))
573 (defun org-clock-drawer-name ()
574 "Return clock drawer's name for current entry, or nil."
575 (let ((drawer (org-clock-into-drawer)))
576 (cond ((integerp drawer
)
577 (let ((log-drawer (org-log-into-drawer)))
578 (if (stringp log-drawer
) log-drawer
"LOGBOOK")))
579 ((stringp drawer
) drawer
)
582 (defun org-clocking-buffer ()
583 "Return the clocking buffer if we are currently clocking a task or nil."
584 (marker-buffer org-clock-marker
))
586 (defun org-clocking-p ()
587 "Return t when clocking a task."
588 (not (equal (org-clocking-buffer) nil
)))
590 (defvar org-clock-before-select-task-hook nil
591 "Hook called in task selection just before prompting the user.")
593 (defun org-clock-select-task (&optional prompt
)
594 "Select a task that was recently associated with clocking.
595 Return marker position of the selected task. Raise an error if
596 there is no recent clock to choose from."
597 (let (och chl sel-list rpl
(i 0) s
)
598 ;; Remove successive dups from the clock history to consider
599 (dolist (c org-clock-history
)
600 (unless (equal c
(car och
)) (push c och
)))
601 (setq och
(reverse och
) chl
(length och
))
603 (user-error "No recent clock")
604 (save-window-excursion
605 (org-switch-to-buffer-other-window
606 (get-buffer-create "*Clock Task Select*"))
608 (when (marker-buffer org-clock-default-task
)
609 (insert (org-add-props "Default Task\n" nil
'face
'bold
))
610 (setq s
(org-clock-insert-selection-line ?d org-clock-default-task
))
612 (when (marker-buffer org-clock-interrupted-task
)
613 (insert (org-add-props "The task interrupted by starting the last one\n" nil
'face
'bold
))
614 (setq s
(org-clock-insert-selection-line ?i org-clock-interrupted-task
))
616 (when (org-clocking-p)
617 (insert (org-add-props "Current Clocking Task\n" nil
'face
'bold
))
618 (setq s
(org-clock-insert-selection-line ?c org-clock-marker
))
620 (insert (org-add-props "Recent Tasks\n" nil
'face
'bold
))
622 (when (marker-buffer m
)
624 s
(org-clock-insert-selection-line
628 (if (fboundp 'int-to-char
) (setf (car s
) (int-to-char (car s
))))
630 (run-hooks 'org-clock-before-select-task-hook
)
631 (goto-char (point-min))
632 ;; Set min-height relatively to circumvent a possible but in
633 ;; `fit-window-to-buffer'
634 (fit-window-to-buffer nil nil
(if (< chl
10) chl
(+ 5 chl
)))
635 (message (or prompt
"Select task for clocking:"))
636 (setq cursor-type nil rpl
(read-char-exclusive))
641 ((assoc rpl sel-list
) (cdr (assoc rpl sel-list
)))
642 (t (user-error "Invalid task choice %c" rpl
)))))))
644 (defun org-clock-insert-selection-line (i marker
)
645 "Insert a line for the clock selection menu.
646 And return a cons cell with the selection character integer and the marker
648 (when (marker-buffer marker
)
649 (let (cat task heading prefix
)
650 (with-current-buffer (org-base-buffer (marker-buffer marker
))
651 (org-with-wide-buffer
654 (setq cat
(org-get-category)
655 heading
(org-get-heading 'notags
)
656 prefix
(save-excursion
657 (org-back-to-heading t
)
658 (looking-at org-outline-regexp
)
661 (org-fontify-like-in-org-mode
662 (concat prefix heading
)
666 (insert (format "[%c] %-12s %s\n" i cat task
))
669 (defvar org-clock-task-overrun nil
670 "Internal flag indicating if the clock has overrun the planned time.")
671 (defvar org-clock-update-period
60
672 "Number of seconds between mode line clock string updates.")
674 (defun org-clock-get-clock-string ()
675 "Form a clock-string, that will be shown in the mode line.
676 If an effort estimate was defined for the current item, use
677 01:30/01:50 format (clocked/estimated).
678 If not, show simply the clocked time like 01:50."
679 (let ((clocked-time (org-clock-get-clocked-time)))
681 (let* ((effort-in-minutes (org-duration-to-minutes org-clock-effort
))
684 (org-duration-from-minutes clocked-time
)
685 'face
(if (and org-clock-task-overrun
(not org-clock-task-overrun-text
))
686 'org-mode-line-clock-overrun
'org-mode-line-clock
)))
687 (effort-str (org-duration-from-minutes effort-in-minutes
))
688 (clockstr (propertize
689 (concat " [%s/" effort-str
690 "] (" (replace-regexp-in-string "%" "%%" org-clock-heading
) ")")
691 'face
'org-mode-line-clock
)))
692 (format clockstr work-done-str
))
693 (propertize (concat " [" (org-duration-from-minutes clocked-time
)
694 "]" (format " (%s)" org-clock-heading
))
695 'face
'org-mode-line-clock
))))
697 (defun org-clock-get-last-clock-out-time ()
698 "Get the last clock-out time for the current subtree."
700 (let ((end (save-excursion (org-end-of-subtree))))
701 (when (re-search-forward (concat org-clock-string
702 ".*\\]--\\(\\[[^]]+\\]\\)") end t
)
703 (org-time-string-to-time (match-string 1))))))
705 (defun org-clock-update-mode-line ()
707 (org-clock-notify-once-if-expired)
708 (setq org-clock-task-overrun nil
))
709 (setq org-mode-line-string
711 (let ((clock-string (org-clock-get-clock-string))
712 (help-text "Org mode clock is running.\nmouse-1 shows a \
713 menu\nmouse-2 will jump to task"))
714 (if (and (> org-clock-string-limit
0)
715 (> (length clock-string
) org-clock-string-limit
))
717 (substring clock-string
0 org-clock-string-limit
)
718 'help-echo
(concat help-text
": " org-clock-heading
))
719 (propertize clock-string
'help-echo help-text
)))
720 'local-map org-clock-mode-line-map
721 'mouse-face
'mode-line-highlight
))
722 (if (and org-clock-task-overrun org-clock-task-overrun-text
)
723 (setq org-mode-line-string
725 org-clock-task-overrun-text
726 'face
'org-mode-line-clock-overrun
) org-mode-line-string
)))
727 (force-mode-line-update))
729 (defun org-clock-get-clocked-time ()
730 "Get the clocked time for the current item in minutes.
731 The time returned includes the time spent on this task in
732 previous clocking intervals."
733 (let ((currently-clocked-time
734 (floor (- (float-time)
735 (float-time org-clock-start-time
)) 60)))
736 (+ currently-clocked-time
(or org-clock-total-time
0))))
738 (defun org-clock-modify-effort-estimate (&optional value
)
739 "Add to or set the effort estimate of the item currently being clocked.
740 VALUE can be a number of minutes, or a string with format hh:mm or mm.
741 When the string starts with a + or a - sign, the current value of the effort
742 property will be changed by that amount. If the effort value is expressed
743 as an `org-effort-durations' (e.g. \"3h\"), the modified value will be
744 converted to a hh:mm duration.
746 This command will update the \"Effort\" property of the currently
747 clocked item, and the value displayed in the mode line."
749 (if (org-clock-is-active)
750 (let ((current org-clock-effort
) sign
)
752 ;; Prompt user for a value or a change
755 (format "Set effort (hh:mm or mm%s): "
757 (format ", prefix + to add to %s" org-clock-effort
)
759 (when (stringp value
)
760 ;; A string. See if it is a delta
761 (setq sign
(string-to-char value
))
762 (if (member sign
'(?- ?
+))
763 (setq current
(org-duration-to-minutes current
)
764 value
(substring value
1))
766 (setq value
(org-duration-to-minutes value
))
768 (setq value
(- current value
))
769 (if (equal ?
+ sign
) (setq value
(+ current value
)))))
770 (setq value
(max 0 value
)
771 org-clock-effort
(org-duration-from-minutes value
))
772 (org-entry-put org-clock-marker
"Effort" org-clock-effort
)
773 (org-clock-update-mode-line)
774 (message "Effort is now %s" org-clock-effort
))
775 (message "Clock is not currently active")))
777 (defvar org-clock-notification-was-shown nil
778 "Shows if we have shown notification already.")
780 (defun org-clock-notify-once-if-expired ()
781 "Show notification if we spent more time than we estimated before.
782 Notification is shown only once."
783 (when (org-clocking-p)
784 (let ((effort-in-minutes (org-duration-to-minutes org-clock-effort
))
785 (clocked-time (org-clock-get-clocked-time)))
786 (if (setq org-clock-task-overrun
787 (if (or (null effort-in-minutes
) (zerop effort-in-minutes
))
789 (>= clocked-time effort-in-minutes
)))
790 (unless org-clock-notification-was-shown
791 (setq org-clock-notification-was-shown t
)
793 (format-message "Task `%s' should be finished by now. (%s)"
794 org-clock-heading org-clock-effort
)
796 (setq org-clock-notification-was-shown nil
)))))
798 (defun org-notify (notification &optional play-sound
)
799 "Send a NOTIFICATION and maybe PLAY-SOUND.
800 If PLAY-SOUND is non-nil, it overrides `org-clock-sound'."
801 (org-show-notification notification
)
802 (if play-sound
(org-clock-play-sound play-sound
)))
804 (defun org-show-notification (notification)
806 Use `org-show-notification-handler' if defined,
807 use libnotify if available, or fall back on a message."
808 (cond ((functionp org-show-notification-handler
)
809 (funcall org-show-notification-handler notification
))
810 ((stringp org-show-notification-handler
)
811 (start-process "emacs-timer-notification" nil
812 org-show-notification-handler notification
))
813 ((fboundp 'notifications-notify
)
814 (notifications-notify
815 :title
"Org mode message"
817 ;; FIXME how to link to the Org icon?
818 ;; :app-icon "~/.emacs.d/icons/mail.png"
820 ((executable-find "notify-send")
821 (start-process "emacs-timer-notification" nil
822 "notify-send" notification
))
823 ;; Maybe the handler will send a message, so only use message as
824 ;; a fall back option
825 (t (message "%s" notification
))))
827 (defun org-clock-play-sound (&optional clock-sound
)
828 "Play sound as configured by `org-clock-sound'.
829 Use alsa's aplay tool if available.
830 If CLOCK-SOUND is non-nil, it overrides `org-clock-sound'."
831 (let ((org-clock-sound (or clock-sound org-clock-sound
)))
833 ((not org-clock-sound
))
834 ((eq org-clock-sound t
) (beep t
) (beep t
))
835 ((stringp org-clock-sound
)
836 (let ((file (expand-file-name org-clock-sound
)))
837 (if (file-exists-p file
)
838 (if (executable-find "aplay")
839 (start-process "org-clock-play-notification" nil
842 (play-sound-file file
)
843 (error (beep t
) (beep t
))))))))))
845 (defvar org-clock-mode-line-entry nil
846 "Information for the mode line about the running clock.")
848 (defun org-find-open-clocks (file)
849 "Search through the given file and find all open clocks."
850 (let ((buf (or (get-file-buffer file
)
851 (find-file-noselect file
)))
852 (org-clock-re (concat org-clock-string
" \\(\\[.*?\\]\\)$"))
854 (with-current-buffer buf
856 (goto-char (point-min))
857 (while (re-search-forward org-clock-re nil t
)
858 (push (cons (copy-marker (match-end 1) t
)
859 (org-time-string-to-time (match-string 1))) clocks
))))
862 (defsubst org-is-active-clock
(clock)
863 "Return t if CLOCK is the currently active clock."
864 (and (org-clock-is-active)
865 (= org-clock-marker
(car clock
))))
867 (defmacro org-with-clock-position
(clock &rest forms
)
868 "Evaluate FORMS with CLOCK as the current active clock."
869 `(with-current-buffer (marker-buffer (car ,clock
))
870 (org-with-wide-buffer
871 (goto-char (car ,clock
))
874 (def-edebug-spec org-with-clock-position
(form body
))
875 (put 'org-with-clock-position
'lisp-indent-function
1)
877 (defmacro org-with-clock
(clock &rest forms
)
878 "Evaluate FORMS with CLOCK as the current active clock.
879 This macro also protects the current active clock from being altered."
880 `(org-with-clock-position ,clock
881 (let ((org-clock-start-time (cdr ,clock
))
882 (org-clock-total-time)
885 (org-clock-marker (car ,clock
))
886 (org-clock-hd-marker (save-excursion
887 (org-back-to-heading t
)
890 (def-edebug-spec org-with-clock
(form body
))
891 (put 'org-with-clock
'lisp-indent-function
1)
893 (defsubst org-clock-clock-in
(clock &optional resume start-time
)
894 "Clock in to the clock located by CLOCK.
895 If necessary, clock-out of the currently active clock."
896 (org-with-clock-position clock
897 (let ((org-clock-in-resume (or resume org-clock-in-resume
)))
898 (org-clock-in nil start-time
))))
900 (defsubst org-clock-clock-out
(clock &optional fail-quietly at-time
)
901 "Clock out of the clock located by CLOCK."
902 (let ((temp (copy-marker (car clock
)
903 (marker-insertion-type (car clock
)))))
904 (if (org-is-active-clock clock
)
905 (org-clock-out nil fail-quietly at-time
)
906 (org-with-clock clock
907 (org-clock-out nil fail-quietly at-time
)))
908 (setcar clock temp
)))
910 (defsubst org-clock-clock-cancel
(clock)
911 "Cancel the clock located by CLOCK."
912 (let ((temp (copy-marker (car clock
)
913 (marker-insertion-type (car clock
)))))
914 (if (org-is-active-clock clock
)
916 (org-with-clock clock
918 (setcar clock temp
)))
920 (defvar org-clock-clocking-in nil
)
921 (defvar org-clock-resolving-clocks nil
)
922 (defvar org-clock-resolving-clocks-due-to-idleness nil
)
924 (defun org-clock-resolve-clock (clock resolve-to clock-out-time
925 &optional close-p restart-p fail-quietly
)
926 "Resolve `CLOCK' given the time `RESOLVE-TO', and the present.
927 `CLOCK' is a cons cell of the form (MARKER START-TIME)."
928 (let ((org-clock-resolving-clocks t
))
931 (org-clock-clock-cancel clock
)
932 (if (and restart-p
(not org-clock-clocking-in
))
933 (org-clock-clock-in clock
)))
935 ((eq resolve-to
'now
)
937 (error "RESTART-P is not valid here"))
938 (if (or close-p org-clock-clocking-in
)
939 (org-clock-clock-out clock fail-quietly
)
940 (unless (org-is-active-clock clock
)
941 (org-clock-clock-in clock t
))))
943 ((not (time-less-p resolve-to
(current-time)))
944 (error "RESOLVE-TO must refer to a time in the past"))
948 (error "RESTART-P is not valid here"))
949 (org-clock-clock-out clock fail-quietly
(or clock-out-time
951 (unless org-clock-clocking-in
953 (setq org-clock-leftover-time
(and (null clock-out-time
)
955 (org-clock-clock-in clock nil
(and clock-out-time
958 (defun org-clock-jump-to-current-clock (&optional effective-clock
)
960 (let ((drawer (org-clock-into-drawer))
961 (clock (or effective-clock
(cons org-clock-marker
962 org-clock-start-time
))))
963 (unless (marker-buffer (car clock
))
964 (error "No clock is currently running"))
965 (org-with-clock clock
(org-clock-goto))
966 (with-current-buffer (marker-buffer (car clock
))
967 (goto-char (car clock
))
969 (org-with-wide-buffer
970 (let ((drawer-re (format "^[ \t]*:%s:[ \t]*$"
971 (regexp-quote (if (stringp drawer
) drawer
"LOGBOOK"))))
972 (beg (save-excursion (org-back-to-heading t
) (point))))
974 (while (re-search-backward drawer-re beg t
)
975 (let ((element (org-element-at-point)))
976 (when (eq (org-element-type element
) 'drawer
)
977 (when (> (org-element-property :end element
) (car clock
))
978 (org-flag-drawer nil element
))
979 (throw 'exit nil
)))))))))))
981 (defun org-clock-resolve (clock &optional prompt-fn last-valid fail-quietly
)
982 "Resolve an open Org clock.
983 An open clock was found, with `dangling' possibly being non-nil.
984 If this function was invoked with a prefix argument, non-dangling
985 open clocks are ignored. The given clock requires some sort of
986 user intervention to resolve it, either because a clock was left
987 dangling or due to an idle timeout. The clock resolution can
990 (a) deleted, the user doesn't care about the clock
991 (b) restarted from the current time (if no other clock is open)
992 (c) closed, giving the clock X minutes
993 (d) closed and then restarted
994 (e) resumed, as if the user had never left
996 The format of clock is (CONS MARKER START-TIME), where MARKER
997 identifies the buffer and position the clock is open at (and
998 thus, the heading it's under), and START-TIME is when the clock
1002 (save-window-excursion
1004 (unless org-clock-resolving-clocks-due-to-idleness
1005 (org-clock-jump-to-current-clock clock
))
1006 (unless org-clock-resolve-expert
1007 (with-output-to-temp-buffer "*Org Clock*"
1008 (princ (format-message "Select a Clock Resolution Command:
1010 i/q Ignore this question; the same as keeping all the idle time.
1012 k/K Keep X minutes of the idle time (default is all). If this
1013 amount is less than the default, you will be clocked out
1014 that many minutes after the time that idling began, and then
1015 clocked back in at the present time.
1017 g/G Indicate that you \"got back\" X minutes ago. This is quite
1018 different from `k': it clocks you out from the beginning of
1019 the idle period and clock you back in X minutes ago.
1021 s/S Subtract the idle time from the current clock. This is the
1022 same as keeping 0 minutes.
1024 C Cancel the open timer altogether. It will be as though you
1027 j/J Jump to the current clock, to make manual adjustments.
1029 For all these options, using uppercase makes your final state
1030 to be CLOCKED OUT."))))
1031 (org-fit-window-to-buffer (get-buffer-window "*Org Clock*"))
1033 (while (or (null char-pressed
)
1034 (and (not (memq char-pressed
1035 '(?k ?K ?g ?G ?s ?S ?C
1039 (read-char (concat (funcall prompt-fn clock
)
1042 (and (not (memq char-pressed
'(?i ?q
))) char-pressed
)))))
1044 (floor (/ (float-time
1045 (time-subtract (current-time) last-valid
)) 60)))
1047 (and (memq ch
'(?k ?K
))
1048 (read-number "Keep how many minutes? " default
)))
1050 (and (memq ch
'(?g ?G
))
1051 (read-number "Got back how many minutes ago? " default
)))
1052 (subtractp (memq ch
'(?s ?S
)))
1053 (barely-started-p (< (- (float-time last-valid
)
1054 (float-time (cdr clock
))) 45))
1055 (start-over (and subtractp barely-started-p
)))
1059 (org-clock-resolve-clock clock
'now nil t nil fail-quietly
))
1060 (org-clock-jump-to-current-clock clock
))
1062 (not (memq ch
'(?k ?K ?g ?G ?s ?S ?C
))))
1065 (org-clock-resolve-clock
1068 ;; If the time on the clock was less than a minute before
1069 ;; the user went away, and they've ask to subtract all the
1074 (and gotback
(= gotback
0)))
1076 ((or (and keep
(= keep default
))
1077 (and gotback
(= gotback default
)))
1080 (time-add last-valid
(seconds-to-time (* 60 keep
))))
1082 (time-subtract (current-time)
1083 (seconds-to-time (* 60 gotback
))))
1085 (error "Unexpected, please report this as a bug")))
1086 (and gotback last-valid
)
1087 (memq ch
'(?K ?G ?S
))
1089 (not (memq ch
'(?K ?G ?S ?C
))))
1093 (defun org-resolve-clocks (&optional only-dangling-p prompt-fn last-valid
)
1094 "Resolve all currently open Org clocks.
1095 If `only-dangling-p' is non-nil, only ask to resolve dangling
1096 \(i.e., not currently open and valid) clocks."
1098 (unless org-clock-resolving-clocks
1099 (let ((org-clock-resolving-clocks t
))
1100 (dolist (file (org-files-list))
1101 (let ((clocks (org-find-open-clocks file
)))
1102 (dolist (clock clocks
)
1103 (let ((dangling (or (not (org-clock-is-active))
1104 (/= (car clock
) org-clock-marker
))))
1105 (if (or (not only-dangling-p
) dangling
)
1112 "Dangling clock started %d mins ago"
1113 (floor (- (float-time)
1114 (float-time (cdr clock
)))
1117 (cdr clock
)))))))))))
1119 (defun org-emacs-idle-seconds ()
1120 "Return the current Emacs idle time in seconds, or nil if not idle."
1121 (let ((idle-time (current-idle-time)))
1123 (float-time idle-time
)
1126 (defun org-mac-idle-seconds ()
1127 "Return the current Mac idle time in seconds."
1128 (string-to-number (shell-command-to-string "ioreg -c IOHIDSystem | perl -ane 'if (/Idle/) {$idle=(pop @F)/1000000000; print $idle; last}'")))
1130 (defvar org-x11idle-exists-p
1131 ;; Check that x11idle exists
1132 (and (eq window-system
'x
)
1133 (eq 0 (call-process-shell-command
1134 (format "command -v %s" org-clock-x11idle-program-name
)))
1135 ;; Check that x11idle can retrieve the idle time
1136 ;; FIXME: Why "..-shell-command" rather than just `call-process'?
1137 (eq 0 (call-process-shell-command org-clock-x11idle-program-name
))))
1139 (defun org-x11-idle-seconds ()
1140 "Return the current X11 idle time in seconds."
1141 (/ (string-to-number (shell-command-to-string org-clock-x11idle-program-name
)) 1000))
1143 (defun org-user-idle-seconds ()
1144 "Return the number of seconds the user has been idle for.
1145 This routine returns a floating point number."
1147 ((eq system-type
'darwin
)
1148 (org-mac-idle-seconds))
1149 ((and (eq window-system
'x
) org-x11idle-exists-p
)
1150 (org-x11-idle-seconds))
1152 (org-emacs-idle-seconds))))
1154 (defvar org-clock-user-idle-seconds
)
1156 (defun org-resolve-clocks-if-idle ()
1157 "Resolve all currently open Org clocks.
1158 This is performed after `org-clock-idle-time' minutes, to check
1159 if the user really wants to stay clocked in after being idle for
1161 (when (and org-clock-idle-time
(not org-clock-resolving-clocks
)
1162 org-clock-marker
(marker-buffer org-clock-marker
))
1163 (let* ((org-clock-user-idle-seconds (org-user-idle-seconds))
1164 (org-clock-user-idle-start
1165 (time-subtract (current-time)
1166 (seconds-to-time org-clock-user-idle-seconds
)))
1167 (org-clock-resolving-clocks-due-to-idleness t
))
1168 (if (> org-clock-user-idle-seconds
(* 60 org-clock-idle-time
))
1170 (cons org-clock-marker
1171 org-clock-start-time
)
1173 (format "Clocked in & idle for %.1f mins"
1175 (time-subtract (current-time)
1176 org-clock-user-idle-start
))
1178 org-clock-user-idle-start
)))))
1180 (defvar org-clock-current-task nil
"Task currently clocked in.")
1181 (defvar org-clock-out-time nil
) ; store the time of the last clock-out
1182 (defvar org--msg-extra
)
1185 (defun org-clock-in (&optional select start-time
)
1186 "Start the clock on the current item.
1188 If necessary, clock-out of the currently active clock.
1190 With a `\\[universal-argument]' prefix argument SELECT, offer a list of \
1192 tasks to clock into.
1194 When SELECT is `\\[universal-argument] \ \\[universal-argument]', \
1195 clock into the current task and mark it as
1196 the default task, a special task that will always be offered in the
1197 clocking selection, associated with the letter `d'.
1199 When SELECT is `\\[universal-argument] \\[universal-argument] \
1200 \\[universal-argument]', clock in by using the last clock-out
1201 time as the start time. See `org-clock-continuously' to make this
1202 the default behavior."
1204 (setq org-clock-notification-was-shown nil
)
1205 (org-refresh-effort-properties)
1207 (let ((interrupting (and (not org-clock-resolving-clocks-due-to-idleness
)
1209 ts selected-task target-pos
(org--msg-extra "")
1210 (leftover (and (not org-clock-resolving-clocks
)
1211 org-clock-leftover-time
)))
1213 (when (and org-clock-auto-clock-resolution
1214 (or (not interrupting
)
1215 (eq t org-clock-auto-clock-resolution
))
1216 (not org-clock-clocking-in
)
1217 (not org-clock-resolving-clocks
))
1218 (setq org-clock-leftover-time nil
)
1219 (let ((org-clock-clocking-in t
))
1220 (org-resolve-clocks))) ; check if any clocks are dangling
1222 (when (equal select
'(64))
1223 ;; Set start-time to `org-clock-out-time'
1224 (let ((org-clock-continuously t
))
1225 (org-clock-in nil org-clock-out-time
)))
1227 (when (equal select
'(4))
1228 (setq selected-task
(org-clock-select-task "Clock-in on task: "))
1230 (setq selected-task
(copy-marker selected-task
))
1233 (when (equal select
'(16))
1234 ;; Mark as default clocking task
1235 (org-clock-mark-default-task))
1238 ;; We are interrupting the clocking of a different task.
1239 ;; Save a marker to this task, so that we can go back.
1240 ;; First check if we are trying to clock into the same task!
1241 (when (save-excursion
1242 (unless selected-task
1243 (org-back-to-heading t
))
1244 (and (equal (marker-buffer org-clock-hd-marker
)
1246 (marker-buffer selected-task
)
1248 (= (marker-position org-clock-hd-marker
)
1250 (marker-position selected-task
)
1252 (equal org-clock-current-task
(nth 4 (org-heading-components)))))
1253 (message "Clock continues in \"%s\"" org-clock-heading
)
1255 (move-marker org-clock-interrupted-task
1256 (marker-position org-clock-marker
)
1257 (marker-buffer org-clock-marker
))
1258 (let ((org-clock-clocking-in t
))
1259 (org-clock-out nil t
)))
1261 ;; Clock in at which position?
1263 (if (and (eobp) (not (org-at-heading-p)))
1267 (when (and selected-task
(marker-buffer selected-task
))
1268 ;; There is a selected task, move to the correct buffer
1269 ;; and set the new target position.
1270 (set-buffer (org-base-buffer (marker-buffer selected-task
)))
1271 (setq target-pos
(marker-position selected-task
))
1272 (move-marker selected-task nil
))
1273 (org-with-wide-buffer
1274 (goto-char target-pos
)
1275 (org-back-to-heading t
)
1276 (or interrupting
(move-marker org-clock-interrupted-task nil
))
1277 (run-hooks 'org-clock-in-prepare-hook
)
1278 (org-clock-history-push)
1279 (setq org-clock-current-task
(nth 4 (org-heading-components)))
1280 (cond ((functionp org-clock-in-switch-to-state
)
1281 (let ((case-fold-search nil
))
1282 (looking-at org-complex-heading-regexp
))
1283 (let ((newstate (funcall org-clock-in-switch-to-state
1285 (when newstate
(org-todo newstate
))))
1286 ((and org-clock-in-switch-to-state
1287 (not (looking-at (concat org-outline-regexp
"[ \t]*"
1288 org-clock-in-switch-to-state
1290 (org-todo org-clock-in-switch-to-state
)))
1291 (setq org-clock-heading
1292 (cond ((and org-clock-heading-function
1293 (functionp org-clock-heading-function
))
1294 (funcall org-clock-heading-function
))
1295 ((nth 4 (org-heading-components))
1296 (replace-regexp-in-string
1297 "\\[\\[.*?\\]\\[\\(.*?\\)\\]\\]" "\\1"
1298 (match-string-no-properties 4)))
1300 (org-clock-find-position org-clock-in-resume
)
1302 ((and org-clock-in-resume
1304 (concat "^[ \t]*" org-clock-string
1305 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1306 " *\\sw+.? +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
1307 (message "Matched %s" (match-string 1))
1308 (setq ts
(concat "[" (match-string 1) "]"))
1309 (goto-char (match-end 1))
1310 (setq org-clock-start-time
1312 (org-parse-time-string (match-string 1))))
1313 (setq org-clock-effort
(org-entry-get (point) org-effort-property
))
1314 (setq org-clock-total-time
(org-clock-sum-current-item
1315 (org-clock-get-sum-start))))
1316 ((eq org-clock-in-resume
'auto-restart
)
1317 ;; called from org-clock-load during startup,
1318 ;; do not interrupt, but warn!
1319 (message "Cannot restart clock because task does not contain unfinished clock")
1324 (insert-before-markers "\n")
1327 (when (and (save-excursion
1330 (beginning-of-line 1)
1331 (indent-line-to (- (org-get-indentation) 2)))
1332 (insert org-clock-string
" ")
1333 (setq org-clock-effort
(org-entry-get (point) org-effort-property
))
1334 (setq org-clock-total-time
(org-clock-sum-current-item
1335 (org-clock-get-sum-start)))
1336 (setq org-clock-start-time
1337 (or (and org-clock-continuously org-clock-out-time
)
1341 "You stopped another clock %d mins ago; start this one from then? "
1343 (org-current-time org-clock-rounding-minutes t
))
1344 (float-time leftover
))
1348 (org-current-time org-clock-rounding-minutes t
)))
1349 (setq ts
(org-insert-time-stamp org-clock-start-time
1350 'with-hm
'inactive
))))
1351 (move-marker org-clock-marker
(point) (buffer-base-buffer))
1352 (move-marker org-clock-hd-marker
1353 (save-excursion (org-back-to-heading t
) (point))
1354 (buffer-base-buffer))
1355 (setq org-clock-has-been-used t
)
1357 (when (or (eq org-clock-clocked-in-display
'mode-line
)
1358 (eq org-clock-clocked-in-display
'both
))
1359 (or global-mode-string
(setq global-mode-string
'("")))
1360 (or (memq 'org-mode-line-string global-mode-string
)
1361 (setq global-mode-string
1362 (append global-mode-string
'(org-mode-line-string)))))
1363 ;; add to frame title
1364 (when (or (eq org-clock-clocked-in-display
'frame-title
)
1365 (eq org-clock-clocked-in-display
'both
))
1366 (setq frame-title-format org-clock-frame-title-format
))
1367 (org-clock-update-mode-line)
1368 (when org-clock-mode-line-timer
1369 (cancel-timer org-clock-mode-line-timer
)
1370 (setq org-clock-mode-line-timer nil
))
1371 (when org-clock-clocked-in-display
1372 (setq org-clock-mode-line-timer
1373 (run-with-timer org-clock-update-period
1374 org-clock-update-period
1375 'org-clock-update-mode-line
)))
1376 (when org-clock-idle-timer
1377 (cancel-timer org-clock-idle-timer
)
1378 (setq org-clock-idle-timer nil
))
1379 (setq org-clock-idle-timer
1380 (run-with-timer 60 60 'org-resolve-clocks-if-idle
))
1381 (message "Clock starts at %s - %s" ts org--msg-extra
)
1382 (run-hooks 'org-clock-in-hook
))))))
1385 (defun org-clock-in-last (&optional arg
)
1386 "Clock in the last closed clocked item.
1387 When already clocking in, send an warning.
1388 With a universal prefix argument, select the task you want to
1389 clock in from the last clocked in tasks.
1390 With two universal prefix arguments, start clocking using the
1391 last clock-out time, if any.
1392 With three universal prefix arguments, interactively prompt
1393 for a todo state to switch to, overriding the existing value
1394 `org-clock-in-switch-to-state'."
1396 (if (equal arg
'(4)) (org-clock-in arg
)
1397 (let ((start-time (if (or org-clock-continuously
(equal arg
'(16)))
1398 (or org-clock-out-time
1399 (org-current-time org-clock-rounding-minutes t
))
1400 (org-current-time org-clock-rounding-minutes t
))))
1401 (if (null org-clock-history
)
1402 (message "No last clock")
1403 (let ((org-clock-in-switch-to-state
1404 (if (and (not org-clock-current-task
) (equal arg
'(64)))
1405 (completing-read "Switch to state: "
1406 (and org-clock-history
1407 (with-current-buffer
1408 (marker-buffer (car org-clock-history
))
1409 org-todo-keywords-1
)))
1410 org-clock-in-switch-to-state
))
1411 (already-clocking org-clock-current-task
))
1412 (org-clock-clock-in (list (car org-clock-history
)) nil start-time
)
1413 (or already-clocking
1414 ;; Don't display a message if we are already clocking in
1415 (message "Clocking back: %s (in %s)"
1416 org-clock-current-task
1417 (buffer-name (marker-buffer org-clock-marker
)))))))))
1419 (defun org-clock-mark-default-task ()
1420 "Mark current task as default task."
1423 (org-back-to-heading t
)
1424 (move-marker org-clock-default-task
(point))))
1426 (defun org-clock-get-sum-start ()
1427 "Return the time from which clock times should be counted.
1429 This is for the currently running clock as it is displayed in the
1430 mode line. This function looks at the properties LAST_REPEAT and
1431 in particular CLOCK_MODELINE_TOTAL and the corresponding variable
1432 `org-clock-mode-line-total' and then decides which time to use.
1434 The time is always returned as UTC."
1435 (let ((cmt (or (org-entry-get nil
"CLOCK_MODELINE_TOTAL")
1436 (symbol-name org-clock-mode-line-total
)))
1437 (lr (org-entry-get nil
"LAST_REPEAT")))
1439 ((equal cmt
"current")
1440 (setq org--msg-extra
"showing time in current clock instance")
1442 ((equal cmt
"today")
1443 (setq org--msg-extra
"showing today's task time.")
1444 (let* ((dt (org-decode-time nil t
))
1447 (if (< hour org-extend-today-until
) (setf (nth 3 dt
) (1- day
)))
1448 (setf (nth 2 dt
) org-extend-today-until
)
1449 (setq dt
(append (list 0 0) (nthcdr 2 dt
) '(t)))
1450 (apply #'encode-time dt
)))
1451 ((or (equal cmt
"all")
1452 (and (or (not cmt
) (equal cmt
"auto"))
1454 (setq org--msg-extra
"showing entire task time.")
1456 ((or (equal cmt
"repeat")
1457 (and (or (not cmt
) (equal cmt
"auto"))
1459 (setq org--msg-extra
"showing task time since last repeat.")
1460 (and lr
(org-time-string-to-time lr t
)))
1463 (defun org-clock-find-position (find-unclosed)
1464 "Find the location where the next clock line should be inserted.
1465 When FIND-UNCLOSED is non-nil, first check if there is an unclosed clock
1466 line and position cursor in that line."
1467 (org-back-to-heading t
)
1469 (let* ((beg (line-beginning-position))
1470 (end (save-excursion (outline-next-heading) (point)))
1471 (org-clock-into-drawer (org-clock-into-drawer))
1472 (drawer (org-clock-drawer-name)))
1473 ;; Look for a running clock if FIND-UNCLOSED in non-nil.
1475 (let ((open-clock-re
1478 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1479 " *\\sw+ +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
1480 (while (re-search-forward open-clock-re end t
)
1481 (let ((element (org-element-at-point)))
1482 (when (and (eq (org-element-type element
) 'clock
)
1483 (eq (org-element-property :status element
) 'running
))
1485 (throw 'exit t
))))))
1486 ;; Look for an existing clock drawer.
1489 (let ((drawer-re (concat "^[ \t]*:" (regexp-quote drawer
) ":[ \t]*$")))
1490 (while (re-search-forward drawer-re end t
)
1491 (let ((element (org-element-at-point)))
1492 (when (eq (org-element-type element
) 'drawer
)
1493 (let ((cend (org-element-property :contents-end element
)))
1494 (if (and (not org-log-states-order-reversed
) cend
)
1497 (throw 'exit t
)))))))
1499 (let ((clock-re (concat "^[ \t]*" org-clock-string
))
1502 ;; Count the CLOCK lines and store their positions.
1504 (while (re-search-forward clock-re end t
)
1505 (let ((element (org-element-at-point)))
1506 (when (eq (org-element-type element
) 'clock
)
1507 (setq positions
(cons (line-beginning-position) positions
)
1508 count
(1+ count
))))))
1511 ;; Skip planning line and property drawer, if any.
1512 (org-end-of-meta-data)
1513 (unless (bolp) (insert "\n"))
1514 ;; Create a new drawer if necessary.
1515 (when (and org-clock-into-drawer
1516 (or (not (wholenump org-clock-into-drawer
))
1517 (< org-clock-into-drawer
2)))
1518 (let ((beg (point)))
1519 (insert ":" drawer
":\n:END:\n")
1520 (org-indent-region beg
(point))
1524 ;; When a clock drawer needs to be created because of the
1525 ;; number of clock items or simply if it is missing, collect
1526 ;; all clocks in the section and wrap them within the drawer.
1527 ((if (wholenump org-clock-into-drawer
)
1528 (>= (1+ count
) org-clock-into-drawer
)
1530 ;; Skip planning line and property drawer, if any.
1531 (org-end-of-meta-data)
1532 (let ((beg (point)))
1538 (org-trim (delete-and-extract-region
1539 (save-excursion (skip-chars-backward " \r\t\n")
1540 (line-beginning-position 2))
1541 (line-beginning-position 2)))))
1544 (let ((end (point-marker)))
1546 (save-excursion (insert ":" drawer
":\n"))
1548 (org-indent-region (point) end
)
1550 (unless org-log-states-order-reversed
1552 (beginning-of-line -
1))
1553 (set-marker end nil
))))
1554 (org-log-states-order-reversed (goto-char (car (last positions
))))
1555 (t (goto-char (car positions
))))))))
1558 (defun org-clock-out (&optional switch-to-state fail-quietly at-time
)
1559 "Stop the currently running clock.
1560 Throw an error if there is no running clock and FAIL-QUIETLY is nil.
1561 With a universal prefix, prompt for a state to switch the clocked out task
1562 to, overriding the existing value of `org-clock-out-switch-to-state'."
1565 (when (not (org-clocking-p))
1566 (setq global-mode-string
1567 (delq 'org-mode-line-string global-mode-string
))
1568 (setq frame-title-format org-frame-title-format-backup
)
1569 (force-mode-line-update)
1570 (if fail-quietly
(throw 'exit t
) (user-error "No active clock")))
1571 (let ((org-clock-out-switch-to-state
1573 (completing-read "Switch to state: "
1574 (with-current-buffer
1575 (marker-buffer org-clock-marker
)
1576 org-todo-keywords-1
)
1578 org-clock-out-switch-to-state
))
1579 (now (org-current-time org-clock-rounding-minutes
))
1581 (setq org-clock-out-time now
)
1582 (save-excursion ; Do not replace this with `with-current-buffer'.
1583 (with-no-warnings (set-buffer (org-clocking-buffer)))
1586 (goto-char org-clock-marker
)
1587 (beginning-of-line 1)
1588 (if (and (looking-at (concat "[ \t]*" org-keyword-time-regexp
))
1589 (equal (match-string 1) org-clock-string
))
1590 (setq ts
(match-string 2))
1591 (if fail-quietly
(throw 'exit nil
) (error "Clock start time is gone")))
1592 (goto-char (match-end 0))
1593 (delete-region (point) (point-at-eol))
1595 (setq te
(org-insert-time-stamp (or at-time now
) 'with-hm
'inactive
))
1596 (setq s
(- (float-time
1597 (apply #'encode-time
(org-parse-time-string te nil t
)))
1599 (apply #'encode-time
(org-parse-time-string ts nil t
))))
1600 h
(floor (/ s
3600))
1604 (insert " => " (format "%2d:%02d" h m
))
1605 (move-marker org-clock-marker nil
)
1606 (move-marker org-clock-hd-marker nil
)
1607 ;; Possibly remove zero time clocks. However, do not add
1608 ;; a note associated to the CLOCK line in this case.
1609 (cond ((and org-clock-out-remove-zero-time-clocks
1612 (delete-region (line-beginning-position)
1613 (line-beginning-position 2)))
1614 (org-log-note-clock-out
1616 'clock-out nil nil nil
1617 (concat "# Task: " (org-get-heading t
) "\n\n"))))
1618 (when org-clock-mode-line-timer
1619 (cancel-timer org-clock-mode-line-timer
)
1620 (setq org-clock-mode-line-timer nil
))
1621 (when org-clock-idle-timer
1622 (cancel-timer org-clock-idle-timer
)
1623 (setq org-clock-idle-timer nil
))
1624 (setq global-mode-string
1625 (delq 'org-mode-line-string global-mode-string
))
1626 (setq frame-title-format org-frame-title-format-backup
)
1627 (when org-clock-out-switch-to-state
1629 (org-back-to-heading t
)
1630 (let ((org-clock-out-when-done nil
))
1632 ((functionp org-clock-out-switch-to-state
)
1633 (let ((case-fold-search nil
))
1634 (looking-at org-complex-heading-regexp
))
1635 (let ((newstate (funcall org-clock-out-switch-to-state
1637 (when newstate
(org-todo newstate
))))
1638 ((and org-clock-out-switch-to-state
1639 (not (looking-at (concat org-outline-regexp
"[ \t]*"
1640 org-clock-out-switch-to-state
1642 (org-todo org-clock-out-switch-to-state
))))))
1643 (force-mode-line-update)
1644 (message (concat "Clock stopped at %s after "
1645 (org-duration-from-minutes (+ (* 60 h
) m
)) "%s")
1646 te
(if remove
" => LINE REMOVED" ""))
1647 (run-hooks 'org-clock-out-hook
)
1648 (unless (org-clocking-p)
1649 (setq org-clock-current-task nil
)))))))
1651 (add-hook 'org-clock-out-hook
'org-clock-remove-empty-clock-drawer
)
1653 (defun org-clock-remove-empty-clock-drawer ()
1654 "Remove empty clock drawers in current subtree."
1656 (org-back-to-heading t
)
1659 (let ((drawer (org-clock-drawer-name))
1660 (case-fold-search t
))
1662 (let ((re (format "^[ \t]*:%s:[ \t]*$" (regexp-quote drawer
)))
1663 (end (save-excursion (outline-next-heading))))
1664 (while (re-search-forward re end t
)
1665 (org-remove-empty-drawer-at (point))))))))))
1667 (defun org-clock-timestamps-up (&optional n
)
1668 "Increase CLOCK timestamps at cursor.
1669 Optional argument N tells to change by that many units."
1671 (org-clock-timestamps-change 'up n
))
1673 (defun org-clock-timestamps-down (&optional n
)
1674 "Increase CLOCK timestamps at cursor.
1675 Optional argument N tells to change by that many units."
1677 (org-clock-timestamps-change 'down n
))
1679 (defun org-clock-timestamps-change (updown &optional n
)
1680 "Change CLOCK timestamps synchronously at cursor.
1681 UPDOWN tells whether to change `up' or `down'.
1682 Optional argument N tells to change by that many units."
1683 (let ((tschange (if (eq updown
'up
) 'org-timestamp-up
1684 'org-timestamp-down
))
1685 (timestamp?
(org-at-timestamp-p 'lax
))
1686 ts1 begts1 ts2 begts2 updatets1 tdiff
)
1689 (move-beginning-of-line 1)
1690 (re-search-forward org-ts-regexp3 nil t
)
1691 (setq ts1
(match-string 0) begts1
(match-beginning 0))
1692 (when (re-search-forward org-ts-regexp3 nil t
)
1693 (setq ts2
(match-string 0) begts2
(match-beginning 0))))
1694 ;; Are we on the second timestamp?
1695 (if (<= begts2
(point)) (setq updatets1 t
))
1697 ;; fall back on org-timestamp-up if there is only one
1698 (funcall tschange n
)
1699 (funcall tschange n
)
1700 (let ((ts (if updatets1 ts2 ts1
))
1701 (begts (if updatets1 begts1 begts2
)))
1704 (org-time-string-to-time org-last-changed-timestamp t
)
1705 (org-time-string-to-time ts t
)))
1708 (org-timestamp-change
1709 (round (/ (float-time tdiff
)
1714 (`month
(* 24 3600 31))
1715 (`year
(* 24 3600 365.2)))))
1716 timestamp?
'updown
)))))))
1719 (defun org-clock-cancel ()
1720 "Cancel the running clock by removing the start timestamp."
1722 (when (not (org-clocking-p))
1723 (setq global-mode-string
1724 (delq 'org-mode-line-string global-mode-string
))
1725 (setq frame-title-format org-frame-title-format-backup
)
1726 (force-mode-line-update)
1727 (error "No active clock"))
1728 (save-excursion ; Do not replace this with `with-current-buffer'.
1729 (with-no-warnings (set-buffer (org-clocking-buffer)))
1730 (goto-char org-clock-marker
)
1731 (if (looking-back (concat "^[ \t]*" org-clock-string
".*")
1732 (line-beginning-position))
1733 (progn (delete-region (1- (point-at-bol)) (point-at-eol))
1734 (org-remove-empty-drawer-at (point)))
1735 (message "Clock gone, cancel the timer anyway")
1737 (move-marker org-clock-marker nil
)
1738 (move-marker org-clock-hd-marker nil
)
1739 (setq global-mode-string
1740 (delq 'org-mode-line-string global-mode-string
))
1741 (setq frame-title-format org-frame-title-format-backup
)
1742 (force-mode-line-update)
1743 (message "Clock canceled")
1744 (run-hooks 'org-clock-cancel-hook
))
1747 (defun org-clock-goto (&optional select
)
1748 "Go to the currently clocked-in entry, or to the most recently clocked one.
1749 With prefix arg SELECT, offer recently clocked tasks for selection."
1754 (or (org-clock-select-task "Select task to go to: ")
1755 (error "No task selected")))
1756 ((org-clocking-p) org-clock-marker
)
1757 ((and org-clock-goto-may-find-recent-task
1758 (car org-clock-history
)
1759 (marker-buffer (car org-clock-history
)))
1761 (car org-clock-history
))
1762 (t (error "No active or recent clock task")))))
1763 (pop-to-buffer-same-window (marker-buffer m
))
1764 (if (or (< m
(point-min)) (> m
(point-max))) (widen))
1767 (org-back-to-heading t
)
1768 (org-cycle-hide-drawers 'children
)
1769 (recenter org-clock-goto-before-context
)
1772 (message "No running clock, this is the most recently clocked task"))
1773 (run-hooks 'org-clock-goto-hook
)))
1775 (defvar-local org-clock-file-total-minutes nil
1776 "Holds the file total time in minutes, after a call to `org-clock-sum'.")
1778 (defun org-clock-sum-today (&optional headline-filter
)
1779 "Sum the times for each subtree for today."
1780 (let ((range (org-clock-special-range 'today
)))
1781 (org-clock-sum (car range
) (cadr range
)
1782 headline-filter
:org-clock-minutes-today
)))
1784 (defun org-clock-sum-custom (&optional headline-filter range propname
)
1785 "Sum the times for each subtree for today."
1786 (let ((r (or (and (symbolp range
) (org-clock-special-range range
))
1787 (org-clock-special-range
1788 (intern (completing-read
1790 '("today" "yesterday" "thisweek" "lastweek"
1791 "thismonth" "lastmonth" "thisyear" "lastyear"
1794 (org-clock-sum (car r
) (cadr r
)
1795 headline-filter
(or propname
:org-clock-minutes-custom
))))
1798 (defun org-clock-sum (&optional tstart tend headline-filter propname
)
1799 "Sum the times for each subtree.
1800 Puts the resulting times in minutes as a text property on each headline.
1801 TSTART and TEND can mark a time range to be considered.
1802 HEADLINE-FILTER is a zero-arg function that, if specified, is called for
1803 each headline in the time range with point at the headline. Headlines for
1804 which HEADLINE-FILTER returns nil are excluded from the clock summation.
1805 PROPNAME lets you set a custom text property instead of :org-clock-minutes."
1806 (org-with-silent-modifications
1807 (let* ((re (concat "^\\(\\*+\\)[ \t]\\|^[ \t]*"
1809 "[ \t]*\\(?:\\(\\[.*?\\]\\)-+\\(\\[.*?\\]\\)\\|=>[ \t]+\\([0-9]+\\):\\([0-9]+\\)\\)"))
1811 (ltimes (make-vector lmax
0))
1813 (tstart (cond ((stringp tstart
) (org-time-string-to-seconds tstart t
))
1814 ((consp tstart
) (float-time tstart
))
1816 (tend (cond ((stringp tend
) (org-time-string-to-seconds tend t
))
1817 ((consp tend
) (float-time tend
))
1821 (remove-text-properties (point-min) (point-max)
1822 `(,(or propname
:org-clock-minutes
) t
1823 :org-clock-force-headline-inclusion t
))
1825 (goto-char (point-max))
1826 (while (re-search-backward re nil t
)
1830 (let* ((ts (float-time
1831 (apply #'encode-time
1833 (org-parse-time-string
1834 (match-string 2) nil t
)))))
1836 (apply #'encode-time
1837 (org-parse-time-string (match-string 3) nil t
))))
1838 (dt (- (if tend
(min te tend
) te
)
1839 (if tstart
(max ts tstart
) ts
))))
1840 (when (> dt
0) (cl-incf t1
(floor (/ dt
60))))))
1843 (setq t1
(+ t1
(string-to-number (match-string 5))
1844 (* 60 (string-to-number (match-string 4))))))
1846 ;; Add the currently clocking item time to the total.
1847 (when (and org-clock-report-include-clocking-task
1848 (eq (org-clocking-buffer) (current-buffer))
1849 (eq (marker-position org-clock-hd-marker
) (point))
1852 (>= (float-time org-clock-start-time
) tstart
)
1853 (<= (float-time org-clock-start-time
) tend
))
1854 (let ((time (floor (- (float-time)
1855 (float-time org-clock-start-time
))
1857 (setq t1
(+ t1 time
))))
1858 (let* ((headline-forced
1859 (get-text-property (point)
1860 :org-clock-force-headline-inclusion
))
1862 (or (null headline-filter
)
1864 (save-match-data (funcall headline-filter
))))))
1865 (setq level
(- (match-end 1) (match-beginning 1)))
1866 (when (>= level lmax
)
1867 (setq ltimes
(vconcat ltimes
(make-vector lmax
0)) lmax
(* 2 lmax
)))
1868 (when (or (> t1
0) (> (aref ltimes level
) 0))
1869 (when (or headline-included headline-forced
)
1870 (if headline-included
1871 (cl-loop for l from
0 to level do
1872 (aset ltimes l
(+ (aref ltimes l
) t1
))))
1873 (setq time
(aref ltimes level
))
1874 (goto-char (match-beginning 0))
1875 (put-text-property (point) (point-at-eol)
1876 (or propname
:org-clock-minutes
) time
)
1877 (when headline-filter
1880 (while (org-up-heading-safe)
1882 (point) (line-end-position)
1883 :org-clock-force-headline-inclusion t
))))))
1885 (cl-loop for l from level to
(1- lmax
) do
1886 (aset ltimes l
0)))))))
1887 (setq org-clock-file-total-minutes
(aref ltimes
0))))))
1889 (defun org-clock-sum-current-item (&optional tstart
)
1890 "Return time, clocked on current item in total."
1893 (org-narrow-to-subtree)
1894 (org-clock-sum tstart
)
1895 org-clock-file-total-minutes
)))
1898 (defun org-clock-display (&optional arg
)
1899 "Show subtree times in the entire buffer.
1901 By default, show the total time for the range defined in
1902 `org-clock-display-default-range'. With `\\[universal-argument]' \
1904 the total time for today instead.
1906 With `\\[universal-argument] \\[universal-argument]' prefix, \
1907 use a custom range, entered at prompt.
1909 With `\\[universal-argument] \ \\[universal-argument] \
1910 \\[universal-argument]' prefix, display the total time in the
1913 Use `\\[org-clock-remove-overlays]' to remove the subtree times."
1915 (org-clock-remove-overlays)
1916 (let* ((todayp (equal arg
'(4)))
1917 (customp (member arg
'((16) today yesterday
1918 thisweek lastweek thismonth
1919 lastmonth thisyear lastyear
1920 untilnow interactive
)))
1921 (prop (cond ((not arg
) :org-clock-minutes-default
)
1922 (todayp :org-clock-minutes-today
)
1923 (customp :org-clock-minutes-custom
)
1924 (t :org-clock-minutes
)))
1926 (cond ((not arg
) (org-clock-sum-custom
1927 nil org-clock-display-default-range prop
))
1928 (todayp (org-clock-sum-today))
1929 (customp (org-clock-sum-custom nil arg
))
1930 (t (org-clock-sum)))
1931 (unless (eq arg
'(64))
1933 (goto-char (point-min))
1934 (while (or (and (equal (setq p
(point)) (point-min))
1935 (get-text-property p prop
))
1936 (setq p
(next-single-property-change
1939 (when (setq time
(get-text-property p prop
))
1940 (org-clock-put-overlay time
)))
1941 (setq h
(/ org-clock-file-total-minutes
60)
1942 m
(- org-clock-file-total-minutes
(* 60 h
)))
1943 ;; Arrange to remove the overlays upon next change.
1944 (when org-remove-highlights-with-change
1945 (add-hook 'before-change-functions
'org-clock-remove-overlays
1947 (message (concat (format "Total file time%s: "
1948 (cond (todayp " for today")
1949 (customp " (custom)")
1951 (org-duration-from-minutes
1952 org-clock-file-total-minutes
)
1953 " (%d hours and %d minutes)")
1956 (defvar-local org-clock-overlays nil
)
1958 (defun org-clock-put-overlay (time)
1959 "Put an overlays on the current line, displaying TIME.
1960 This creates a new overlay and stores it in `org-clock-overlays', so that it
1961 will be easy to remove."
1964 (let ((case-fold-search nil
))
1965 (when (looking-at org-complex-heading-regexp
)
1966 (goto-char (match-beginning 4))))
1967 (setq ov
(make-overlay (point) (point-at-eol))
1968 tx
(concat (buffer-substring-no-properties (point) (match-end 4))
1971 (max 0 (- (- 60 (current-column))
1972 (- (match-end 4) (match-beginning 4))
1973 (length (org-get-at-bol 'line-prefix
))))
1977 (format " %9s " (org-duration-from-minutes time
))
1978 '(face org-clock-overlay
))
1980 (overlay-put ov
'display tx
)
1981 (push ov org-clock-overlays
)))
1984 (defun org-clock-remove-overlays (&optional _beg _end noremove
)
1985 "Remove the occur highlights from the buffer.
1986 If NOREMOVE is nil, remove this function from the
1987 `before-change-functions' in the current buffer."
1989 (unless org-inhibit-highlight-removal
1990 (mapc #'delete-overlay org-clock-overlays
)
1991 (setq org-clock-overlays nil
)
1993 (remove-hook 'before-change-functions
1994 'org-clock-remove-overlays
'local
))))
1996 (defvar org-state
) ;; dynamically scoped into this function
1997 (defun org-clock-out-if-current ()
1998 "Clock out if the current entry contains the running clock.
1999 This is used to stop the clock after a TODO entry is marked DONE,
2000 and is only done if the variable `org-clock-out-when-done' is not nil."
2001 (when (and (org-clocking-p)
2002 org-clock-out-when-done
2003 (marker-buffer org-clock-marker
)
2004 (or (and (eq t org-clock-out-when-done
)
2005 (member org-state org-done-keywords
))
2006 (and (listp org-clock-out-when-done
)
2007 (member org-state org-clock-out-when-done
)))
2008 (equal (or (buffer-base-buffer (org-clocking-buffer))
2009 (org-clocking-buffer))
2010 (or (buffer-base-buffer (current-buffer))
2012 (< (point) org-clock-marker
)
2013 (> (save-excursion (outline-next-heading) (point))
2015 ;; Clock out, but don't accept a logging message for this.
2016 (let ((org-log-note-clock-out nil
)
2017 (org-clock-out-switch-to-state nil
))
2020 (add-hook 'org-after-todo-state-change-hook
2021 'org-clock-out-if-current
)
2024 (defun org-clock-get-clocktable (&rest props
)
2025 "Get a formatted clocktable with parameters according to PROPS.
2026 The table is created in a temporary buffer, fully formatted and
2027 fontified, and then returned."
2029 (setq props
(plist-put props
:name
"clocktable"))
2030 (unless (plist-member props
:maxlevel
)
2031 (setq props
(plist-put props
:maxlevel
2)))
2032 (unless (plist-member props
:scope
)
2033 (setq props
(plist-put props
:scope
'agenda
)))
2036 (org-create-dblock props
)
2038 (org-font-lock-ensure)
2040 (buffer-substring (point) (progn
2041 (re-search-forward "^[ \t]*#\\+END" nil t
)
2045 (defun org-clock-report (&optional arg
)
2046 "Create a table containing a report about clocked time.
2047 If the cursor is inside an existing clocktable block, then the table
2048 will be updated. If not, a new clocktable will be inserted. The scope
2049 of the new clock will be subtree when called from within a subtree, and
2052 When called with a prefix argument, move to the first clock table in the
2053 buffer and update it."
2055 (org-clock-remove-overlays)
2057 (org-find-dblock "clocktable")
2059 (if (org-in-clocktable-p)
2060 (goto-char (org-in-clocktable-p))
2061 (let ((props (if (ignore-errors
2062 (save-excursion (org-back-to-heading)))
2063 (list :name
"clocktable" :scope
'subtree
)
2064 (list :name
"clocktable"))))
2066 (org-combine-plists org-clock-clocktable-default-properties props
))))
2067 (org-update-dblock))
2069 (defun org-day-of-week (day month year
)
2070 "Returns the day of the week as an integer."
2074 (format "%d-%02d-%02dT00:00:00" year month day
)))))
2076 (defun org-quarter-to-date (quarter year
)
2077 "Get the date (week day year) of the first day of a given quarter."
2081 (setq startday
(org-day-of-week 1 1 year
))
2084 (list 52 7 (- year
1)))
2086 (list 52 6 (- year
1)))
2088 (list 1 startday year
))
2090 (list 53 startday
(- year
1)))
2094 (setq startday
(org-day-of-week 1 4 year
))
2097 (list 13 startday year
))
2099 (list 14 startday year
))
2101 (list 13 startday year
))
2105 (setq startday
(org-day-of-week 1 7 year
))
2108 (list 26 startday year
))
2110 (list 27 startday year
))
2112 (list 26 startday year
))
2116 (setq startday
(org-day-of-week 1 10 year
))
2119 (list 39 startday year
))
2121 (list 40 startday year
))
2123 (list 39 startday year
)))))))
2125 (defun org-clock-special-range (key &optional time as-strings wstart mstart
)
2126 "Return two times bordering a special time range.
2128 KEY is a symbol specifying the range and can be one of `today',
2129 `yesterday', `thisweek', `lastweek', `thismonth', `lastmonth',
2130 `thisyear', `lastyear' or `untilnow'. If set to `interactive',
2131 user is prompted for range boundaries. It can be a string or an
2134 By default, a week starts Monday 0:00 and ends Sunday 24:00. The
2135 range is determined relative to TIME, which defaults to current
2138 The return value is a list containing two internal times, one for
2139 the beginning of the range and one for its end, like the ones
2140 returned by `current time' or `encode-time' and a string used to
2141 display information. If AS-STRINGS is non-nil, the returned
2142 times will be formatted strings.
2144 If WSTART is non-nil, use this number to specify the starting day
2145 of a week (monday is 1). If MSTART is non-nil, use this number
2146 to specify the starting day of a month (1 is the first day of the
2147 month). If you can combine both, the month starting day will
2149 (let* ((tm (decode-time time
))
2156 (skey (format "%s" key
))
2158 (q (cond ((>= month
10) 4)
2162 m1 h1 d1 month1 y1 shiftedy shiftedm shiftedq
)
2164 ((string-match "\\`[0-9]+\\'" skey
)
2165 (setq y
(string-to-number skey
) month
1 d
1 key
'year
))
2166 ((string-match "\\`\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)\\'" skey
)
2167 (setq y
(string-to-number (match-string 1 skey
))
2168 month
(string-to-number (match-string 2 skey
))
2171 ((string-match "\\`\\([0-9]+\\)-[wW]\\([0-9]\\{1,2\\}\\)\\'" skey
)
2173 (let ((date (calendar-gregorian-from-absolute
2174 (calendar-iso-to-absolute
2175 (list (string-to-number (match-string 2 skey
))
2177 (string-to-number (match-string 1 skey
)))))))
2178 (setq d
(nth 1 date
)
2183 ((string-match "\\`\\([0-9]+\\)-[qQ]\\([1-4]\\)\\'" skey
)
2185 (setq q
(string-to-number (match-string 2 skey
)))
2186 (let ((date (calendar-gregorian-from-absolute
2187 (calendar-iso-to-absolute
2188 (org-quarter-to-date
2189 q
(string-to-number (match-string 1 skey
)))))))
2190 (setq d
(nth 1 date
)
2196 "\\`\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)-\\([0-9]\\{1,2\\}\\)\\'"
2198 (setq y
(string-to-number (match-string 1 skey
))
2199 month
(string-to-number (match-string 2 skey
))
2200 d
(string-to-number (match-string 3 skey
))
2202 ((string-match "\\([-+][0-9]+\\)\\'" skey
)
2203 (setq shift
(string-to-number (match-string 1 skey
))
2204 key
(intern (substring skey
0 (match-beginning 1))))
2205 (when (and (memq key
'(quarter thisq
)) (> shift
0))
2206 (error "Looking forward with quarters isn't implemented"))))
2209 (`yesterday
(setq key
'today shift -
1))
2210 (`lastweek
(setq key
'week shift -
1))
2211 (`lastmonth
(setq key
'month shift -
1))
2212 (`lastyear
(setq key
'year shift -
1))
2213 (`lastq
(setq key
'quarter shift -
1))))
2214 ;; Prepare start and end times depending on KEY's type.
2216 ((or `day
`today
) (setq m
0 h
0 h1
24 d
(+ d shift
)))
2217 ((or `week
`thisweek
)
2218 (let* ((ws (or wstart
1))
2219 (diff (+ (* -
7 shift
) (if (= dow
0) (- 7 ws
) (- dow ws
)))))
2220 (setq m
0 h
0 d
(- d diff
) d1
(+ 7 d
))))
2221 ((or `month
`thismonth
)
2222 (setq h
0 m
0 d
(or mstart
1) month
(+ month shift
) month1
(1+ month
)))
2223 ((or `quarter
`thisq
)
2224 ;; Compute if this shift remains in this year. If not, compute
2225 ;; how many years and quarters we have to shift (via floor*) and
2226 ;; compute the shifted years, months and quarters.
2228 ((< (+ (- q
1) shift
) 0) ; Shift not in this year.
2229 (let* ((interval (* -
1 (+ (- q
1) shift
)))
2230 ;; Set tmp to ((years to shift) (quarters to shift)).
2231 (tmp (cl-floor interval
4)))
2232 ;; Due to the use of floor, 0 quarters actually means 4.
2233 (if (= 0 (nth 1 tmp
))
2234 (setq shiftedy
(- y
(nth 0 tmp
))
2237 (setq shiftedy
(- y
(+ 1 (nth 0 tmp
)))
2238 shiftedm
(- 13 (* 3 (nth 1 tmp
)))
2239 shiftedq
(- 5 (nth 1 tmp
)))))
2240 (setq m
0 h
0 d
1 month shiftedm month1
(+ 3 shiftedm
) y shiftedy
))
2241 ((> (+ q shift
) 0) ; Shift is within this year.
2242 (setq shiftedq
(+ q shift
))
2244 (let ((qshift (* 3 (1- (+ q shift
)))))
2245 (setq m
0 h
0 d
1 month
(+ 1 qshift
) month1
(+ 4 qshift
))))))
2246 ((or `year
`thisyear
)
2247 (setq m
0 h
0 d
1 month
1 y
(+ y shift
) y1
(1+ y
)))
2248 ((or `interactive
`untilnow
)) ; Special cases, ignore them.
2249 (_ (user-error "No such time block %s" key
)))
2250 ;; Format start and end times according to AS-STRINGS.
2251 (let* ((start (pcase key
2252 (`interactive
(org-read-date nil t nil
"Range start? "))
2253 (`untilnow org-clock--oldest-date
)
2254 (_ (encode-time 0 m h d month y
))))
2256 (`interactive
(org-read-date nil t nil
"Range end? "))
2257 (`untilnow
(current-time))
2266 ((or `day
`today
) (format-time-string "%A, %B %d, %Y" start
))
2267 ((or `week
`thisweek
) (format-time-string "week %G-W%V" start
))
2268 ((or `month
`thismonth
) (format-time-string "%B %Y" start
))
2269 ((or `year
`thisyear
) (format-time-string "the year %Y" start
))
2270 ((or `quarter
`thisq
)
2271 (concat (org-count-quarter shiftedq
)
2272 " quarter of " (number-to-string shiftedy
)))
2273 (`interactive
"(Range interactively set)")
2274 (`untilnow
"now"))))
2275 (if (not as-strings
) (list start end text
)
2276 (let ((f (cdr org-time-stamp-formats
)))
2277 (list (format-time-string f start
)
2278 (format-time-string f end
)
2281 (defun org-count-quarter (n)
2289 (defun org-clocktable-shift (dir n
)
2290 "Try to shift the :block date of the clocktable at point.
2291 Point must be in the #+BEGIN: line of a clocktable, or this function
2292 will throw an error.
2293 DIR is a direction, a symbol `left', `right', `up', or `down'.
2294 Both `left' and `down' shift the block toward the past, `up' and `right'
2295 push it toward the future.
2296 N is the number of shift steps to take. The size of the step depends on
2297 the currently selected interval size."
2298 (setq n
(prefix-numeric-value n
))
2299 (and (memq dir
'(left down
)) (setq n
(- n
)))
2301 (goto-char (point-at-bol))
2302 (if (not (looking-at "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>.*?:block[ \t]+\\(\\S-+\\)"))
2303 (error "Line needs a :block definition before this command works")
2304 (let* ((b (match-beginning 1)) (e (match-end 1))
2305 (s (match-string 1))
2306 block shift ins y mw d date wp m
)
2308 ((equal s
"yesterday") (setq s
"today-1"))
2309 ((equal s
"lastweek") (setq s
"thisweek-1"))
2310 ((equal s
"lastmonth") (setq s
"thismonth-1"))
2311 ((equal s
"lastyear") (setq s
"thisyear-1"))
2312 ((equal s
"lastq") (setq s
"thisq-1")))
2315 ((string-match "^\\(today\\|thisweek\\|thismonth\\|thisyear\\|thisq\\)\\([-+][0-9]+\\)?$" s
)
2316 (setq block
(match-string 1 s
)
2317 shift
(if (match-end 2)
2318 (string-to-number (match-string 2 s
))
2320 (setq shift
(+ shift n
))
2321 (setq ins
(if (= shift
0) block
(format "%s%+d" block shift
))))
2322 ((string-match "\\([0-9]+\\)\\(-\\([wWqQ]?\\)\\([0-9]\\{1,2\\}\\)\\(-\\([0-9]\\{1,2\\}\\)\\)?\\)?" s
)
2323 ;; 1 1 2 3 3 4 4 5 6 6 5 2
2324 (setq y
(string-to-number (match-string 1 s
))
2325 wp
(and (match-end 3) (match-string 3 s
))
2326 mw
(and (match-end 4) (string-to-number (match-string 4 s
)))
2327 d
(and (match-end 6) (string-to-number (match-string 6 s
))))
2329 (d (setq ins
(format-time-string
2331 (encode-time 0 0 0 (+ d n
) m y
))))
2332 ((and wp
(string-match "w\\|W" wp
) mw
(> (length wp
) 0))
2334 (setq date
(calendar-gregorian-from-absolute
2335 (calendar-iso-to-absolute (list (+ mw n
) 1 y
))))
2336 (setq ins
(format-time-string
2338 (encode-time 0 0 0 (nth 1 date
) (car date
) (nth 2 date
)))))
2339 ((and wp
(string-match "q\\|Q" wp
) mw
(> (length wp
) 0))
2341 ; if the 4th + 1 quarter is requested we flip to the 1st quarter of the next year
2346 ; if the 1st - 1 quarter is requested we flip to the 4th quarter of the previous year
2351 (setq date
(calendar-gregorian-from-absolute
2352 (calendar-iso-to-absolute (org-quarter-to-date (+ mw n
) y
))))
2353 (setq ins
(format-time-string
2354 (concat (number-to-string y
) "-Q" (number-to-string (+ mw n
)))
2355 (encode-time 0 0 0 (nth 1 date
) (car date
) (nth 2 date
)))))
2357 (setq ins
(format-time-string
2359 (encode-time 0 0 0 1 (+ mw n
) y
))))
2361 (setq ins
(number-to-string (+ y n
))))))
2362 (t (error "Cannot shift clocktable block")))
2366 (delete-region (point) (+ (point) (- e b
)))
2367 (beginning-of-line 1)
2372 (defun org-dblock-write:clocktable
(params)
2373 "Write the standard clocktable."
2374 (setq params
(org-combine-plists org-clocktable-defaults params
))
2376 (let* ((scope (plist-get params
:scope
))
2379 (org-agenda-files t
))
2380 (`agenda-with-archives
2381 (org-add-archive-files (org-agenda-files t
)))
2382 (`file-with-archives
2383 (and buffer-file-name
2384 (org-add-archive-files (list buffer-file-name
))))
2385 ((pred functionp
) (funcall scope
))
2386 ((pred consp
) scope
)
2387 (_ (or (buffer-file-name) (current-buffer)))))
2388 (block (plist-get params
:block
))
2389 (ts (plist-get params
:tstart
))
2390 (te (plist-get params
:tend
))
2391 (ws (plist-get params
:wstart
))
2392 (ms (plist-get params
:mstart
))
2393 (step (plist-get params
:step
))
2394 (formatter (or (plist-get params
:formatter
)
2395 org-clock-clocktable-formatter
2396 'org-clocktable-write-default
))
2398 ;; Check if we need to do steps
2400 ;; Get the range text for the header
2401 (setq cc
(org-clock-special-range block nil t ws ms
)
2405 ;; Write many tables, in steps
2406 (unless (or block
(and ts te
))
2407 (error "Clocktable `:step' can only be used with `:block' or `:tstart,:end'"))
2408 (org-clocktable-steps params
)
2411 (org-agenda-prepare-buffers (if (consp files
) files
(list files
)))
2413 (let ((origin (point))
2416 (mapcar (lambda (file)
2417 (with-current-buffer (find-buffer-visiting file
)
2420 (org-clock-get-table-data file params
)))))
2422 ;; Get the right restriction for the scope.
2425 ((not scope
)) ;use the restriction as it is now
2426 ((eq scope
'file
) (widen))
2427 ((eq scope
'subtree
) (org-narrow-to-subtree))
2429 (while (org-up-heading-safe))
2430 (org-narrow-to-subtree))
2431 ((and (symbolp scope
)
2432 (string-match "\\`tree\\([0-9]+\\)\\'"
2433 (symbol-name scope
)))
2434 (let ((level (string-to-number
2435 (match-string 1 (symbol-name scope
)))))
2437 (while (org-up-heading-safe)
2438 (looking-at org-outline-regexp
)
2439 (when (<= (org-reduced-level (funcall outline-level
))
2441 (throw 'exit nil
))))
2442 (org-narrow-to-subtree))))
2443 (list (org-clock-get-table-data nil params
)))))
2445 ;; Even though `file-with-archives' can consist of
2446 ;; multiple files, we consider this is one extended file
2448 (and (consp files
) (not (eq scope
'file-with-archives
)))))
2453 (org-combine-plists params
`(:multifile
,multifile
)))))))
2455 (defun org-clocktable-write-default (ipos tables params
)
2456 "Write out a clock table at position IPOS in the current buffer.
2457 TABLES is a list of tables with clocking data as produced by
2458 `org-clock-get-table-data'. PARAMS is the parameter property list obtained
2459 from the dynamic block definition."
2460 ;; This function looks quite complicated, mainly because there are a
2461 ;; lot of options which can add or remove columns. I have massively
2462 ;; commented this function, the I hope it is understandable. If
2463 ;; someone wants to write their own special formatter, this maybe
2464 ;; much easier because there can be a fixed format with a
2465 ;; well-defined number of columns...
2466 (let* ((lang (or (plist-get params
:lang
) "en"))
2467 (multifile (plist-get params
:multifile
))
2468 (block (plist-get params
:block
))
2469 (sort (plist-get params
:sort
))
2470 (header (plist-get params
:header
))
2471 (link (plist-get params
:link
))
2472 (maxlevel (or (plist-get params
:maxlevel
) 3))
2473 (emph (plist-get params
:emphasize
))
2474 (compact?
(plist-get params
:compact
))
2475 (narrow (or (plist-get params
:narrow
) (and compact?
'40!)))
2476 (level?
(and (not compact?
) (plist-get params
:level
)))
2477 (timestamp (plist-get params
:timestamp
))
2478 (properties (plist-get params
:properties
))
2480 (if (or compact?
(< maxlevel
2)) 1
2481 ;; Deepest headline level is a hard limit for the number
2487 (`(,_
,(and (pred wholenump
) (pred (/= 0))) ,entries
)
2488 (mapcar #'car entries
))))
2491 (or (plist-get params
:tcolumns
) 100)
2492 (if (null levels
) 1 (apply #'max levels
))))))
2493 (indent (or compact?
(plist-get params
:indent
)))
2494 (formula (plist-get params
:formula
))
2495 (case-fold-search t
)
2496 (total-time (apply #'+ (mapcar #'cadr tables
)))
2497 recalc narrow-cut-p
)
2499 (when (and narrow
(integerp narrow
) link
)
2500 ;; We cannot have both integer narrow and link.
2501 (message "Using hard narrowing in clocktable to allow for links")
2502 (setq narrow
(intern (format "%d!" narrow
))))
2505 ((or `nil
(pred integerp
)) nil
) ;nothing to do
2506 ((and (pred symbolp
)
2507 (guard (string-match-p "\\`[0-9]+!\\'" (symbol-name narrow
))))
2508 (setq narrow-cut-p t
)
2509 (setq narrow
(string-to-number (symbol-name narrow
))))
2510 (_ (error "Invalid value %s of :narrow property in clock table" narrow
)))
2512 ;; Now we need to output this table stuff.
2515 ;; Insert the text *before* the actual table.
2516 (insert-before-markers
2518 ;; Format the standard header.
2519 (format "#+CAPTION: %s %s%s\n"
2520 (org-clock--translate "Clock summary at" lang
)
2521 (format-time-string (org-time-stamp-format t t
))
2524 (nth 2 (org-clock-special-range
2526 (plist-get params
:wstart
)
2527 (plist-get params
:mstart
)))))
2528 (format ", for %s." range-text
))
2531 ;; Insert the narrowing line
2532 (when (and narrow
(integerp narrow
) (not narrow-cut-p
))
2533 (insert-before-markers
2534 "|" ;table line starter
2535 (if multifile
"|" "") ;file column, maybe
2536 (if level?
"|" "") ;level column, maybe
2537 (if timestamp
"|" "") ;timestamp column, maybe
2538 (if properties
;properties columns, maybe
2539 (make-string (length properties
) ?|
)
2541 (format "<%d>| |\n" narrow
))) ;headline and time columns
2543 ;; Insert the table header line
2544 (insert-before-markers
2545 "|" ;table line starter
2546 (if multifile
;file column, maybe
2547 (concat (org-clock--translate "File" lang
) "|")
2549 (if level?
;level column, maybe
2550 (concat (org-clock--translate "L" lang
) "|")
2552 (if timestamp
;timestamp column, maybe
2553 (concat (org-clock--translate "Timestamp" lang
) "|")
2555 (if properties
;properties columns, maybe
2556 (concat (mapconcat #'identity properties
"|") "|")
2558 (concat (org-clock--translate "Headline" lang
)"|")
2559 (concat (org-clock--translate "Time" lang
) "|")
2560 (make-string (max 0 (1- time-columns
)) ?|
) ;other time columns
2561 (if (eq formula
'%
) "%|\n" "\n"))
2563 ;; Insert the total time in the table
2564 (insert-before-markers
2566 "|" ;table line starter
2567 (if multifile
(format "| %s " (org-clock--translate "ALL" lang
)) "")
2569 (if level?
"|" "") ;level column, maybe
2570 (if timestamp
"|" "") ;timestamp column, maybe
2571 (make-string (length properties
) ?|
) ;properties columns, maybe
2572 (concat (format org-clock-total-time-cell-format
2573 (org-clock--translate "Total time" lang
))
2575 (format org-clock-total-time-cell-format
2576 (org-duration-from-minutes (or total-time
0))) ;time
2578 (make-string (max 0 (1- time-columns
)) ?|
)
2579 (cond ((not (eq formula
'%
)) "")
2580 ((or (not total-time
) (= total-time
0)) "0.0|")
2584 ;; Now iterate over the tables and insert the data but only if any
2585 ;; time has been collected.
2586 (when (and total-time
(> total-time
0))
2587 (pcase-dolist (`(,file-name
,file-time
,entries
) tables
)
2588 (when (or (and file-time
(> file-time
0))
2589 (not (plist-get params
:fileskip0
)))
2590 (insert-before-markers "|-\n") ;hline at new file
2591 ;; First the file time, if we have multiple files.
2593 ;; Summarize the time collected from this file.
2594 (insert-before-markers
2595 (format (concat "| %s %s | %s%s"
2596 (format org-clock-file-time-cell-format
2597 (org-clock--translate "File time" lang
))
2599 (file-name-nondirectory file-name
)
2600 (if level?
"| " "") ;level column, maybe
2601 (if timestamp
"| " "") ;timestamp column, maybe
2602 (if properties
;properties columns, maybe
2603 (make-string (length properties
) ?|
)
2605 (org-duration-from-minutes file-time
)))) ;time
2607 ;; Get the list of node entries and iterate over it
2608 (when (> maxlevel
0)
2609 (pcase-dolist (`(,level
,headline
,ts
,time
,props
) entries
)
2612 (if (and (string-match
2613 (format "\\`%s\\'" org-bracket-link-regexp
)
2616 (format "[[%s][%s]]"
2617 (match-string 1 headline
)
2618 (org-shorten-string (match-string 3 headline
)
2620 (org-shorten-string headline narrow
))))
2621 (cl-flet ((format-field (f) (format (cond ((not emph
) "%s |")
2622 ((= level
1) "*%s* |")
2623 ((= level
2) "/%s/ |")
2626 (insert-before-markers
2627 "|" ;start the table line
2628 (if multifile
"|" "") ;free space for file name column?
2629 (if level?
(format "%d|" level
) "") ;level, maybe
2630 (if timestamp
(concat ts
"|") "") ;timestamp, maybe
2631 (if properties
;properties columns, maybe
2632 (concat (mapconcat (lambda (p) (or (cdr (assoc p props
)) ""))
2637 (if indent
;indentation
2638 (org-clocktable-indent-string level
)
2640 (format-field headline
)
2641 ;; Empty fields for higher levels.
2642 (make-string (max 0 (1- (min time-columns level
))) ?|
)
2643 (format-field (org-duration-from-minutes time
))
2644 (make-string (max 0 (- time-columns level
)) ?|
)
2646 (format "%.1f |" (* 100 (/ time
(float total-time
))))
2651 ;; Possibly rescue old formula?
2652 ((or (not formula
) (eq formula
'%
))
2653 (let ((contents (org-string-nw-p (plist-get params
:content
))))
2654 (when (and contents
(string-match "^\\([ \t]*#\\+tblfm:.*\\)" contents
))
2656 (insert "\n" (match-string 1 contents
))
2657 (beginning-of-line 0))))
2658 ;; Insert specified formula line.
2660 (insert "\n#+TBLFM: " formula
)
2663 (user-error "Invalid :formula parameter in clocktable")))
2664 ;; Back to beginning, align the table, recalculate if necessary.
2666 (skip-chars-forward "^|")
2668 (when org-hide-emphasis-markers
2669 ;; We need to align a second time.
2673 (org-table-goto-line 3)
2674 (org-table-goto-column (car sort
))
2675 (org-table-sort-lines nil
(cdr sort
))))
2676 (when recalc
(org-table-recalculate 'all
))
2679 (defun org-clocktable-indent-string (level)
2680 "Return indentation string according to LEVEL.
2681 LEVEL is an integer. Indent by two spaces per level above 1."
2683 (concat "\\_" (make-string (* 2 (1- level
)) ?\s
))))
2685 (defun org-clocktable-steps (params)
2686 "Step through the range to make a number of clock tables."
2687 (let* ((p1 (copy-sequence params
))
2688 (ts (plist-get p1
:tstart
))
2689 (te (plist-get p1
:tend
))
2690 (ws (plist-get p1
:wstart
))
2691 (ms (plist-get p1
:mstart
))
2692 (step0 (plist-get p1
:step
))
2693 (step (cdr (assoc step0
'((day .
86400) (week .
604800)))))
2694 (stepskip0 (plist-get p1
:stepskip0
))
2695 (block (plist-get p1
:block
))
2698 (setq cc
(org-clock-special-range block nil t ws ms
)
2703 ;; If ts is a number, it's an absolute day number from
2705 (pcase-let ((`(,month
,day
,year
) (calendar-gregorian-from-absolute ts
)))
2706 (setq ts
(float-time (encode-time 0 0 0 day month year
)))))
2708 (setq ts
(float-time (apply #'encode-time
(org-parse-time-string ts
))))))
2712 (pcase-let ((`(,month
,day
,year
) (calendar-gregorian-from-absolute te
)))
2713 (setq te
(float-time (encode-time 0 0 0 day month year
)))))
2715 (setq te
(float-time (apply #'encode-time
(org-parse-time-string te
))))))
2717 (if (eq step0
'week
)
2718 (- ts
(* 86400 (- (nth 6 (decode-time (seconds-to-time ts
))) ws
)))
2720 (setq p1
(plist-put p1
:header
""))
2721 (setq p1
(plist-put p1
:step nil
))
2722 (setq p1
(plist-put p1
:block nil
))
2724 (or (bolp) (insert "\n"))
2725 (setq p1
(plist-put p1
:tstart
(format-time-string
2726 (org-time-stamp-format nil t
)
2727 (seconds-to-time (max tsb ts
)))))
2728 (setq p1
(plist-put p1
:tend
(format-time-string
2729 (org-time-stamp-format nil t
)
2730 (seconds-to-time (min te
(setq tsb
(+ tsb step
)))))))
2731 (insert "\n" (if (eq step0
'day
) "Daily report: "
2732 "Weekly report starting on: ")
2733 (plist-get p1
:tstart
) "\n")
2734 (setq step-time
(org-dblock-write:clocktable p1
))
2735 (re-search-forward "^[ \t]*#\\+END:")
2736 (when (and (equal step-time
0) stepskip0
)
2737 ;; Remove the empty table
2738 (delete-region (point-at-bol)
2740 (re-search-backward "^\\(Daily\\|Weekly\\) report"
2745 (defun org-clock-get-table-data (file params
)
2746 "Get the clocktable data for file FILE, with parameters PARAMS.
2747 FILE is only for identification - this function assumes that
2748 the correct buffer is current, and that the wanted restriction is
2750 The return value will be a list with the file name and the total
2751 file time (in minutes) as 1st and 2nd elements. The third element
2752 of this list will be a list of headline entries. Each entry has the
2753 following structure:
2755 (LEVEL HEADLINE TIMESTAMP TIME PROPERTIES)
2757 LEVEL: The level of the headline, as an integer. This will be
2758 the reduced level, so 1,2,3,... even if only odd levels
2760 HEADLINE: The text of the headline. Depending on PARAMS, this may
2761 already be formatted like a link.
2762 TIMESTAMP: If PARAMS require it, this will be a time stamp found in the
2763 entry, any of SCHEDULED, DEADLINE, NORMAL, or first inactive,
2765 TIME: The sum of all time spend in this tree, in minutes. This time
2766 will of cause be restricted to the time block and tags match
2767 specified in PARAMS.
2768 PROPERTIES: The list properties specified in the `:properties' parameter
2769 along with their value, as an alist following the pattern
2771 (let* ((maxlevel (or (plist-get params
:maxlevel
) 3))
2772 (timestamp (plist-get params
:timestamp
))
2773 (ts (plist-get params
:tstart
))
2774 (te (plist-get params
:tend
))
2775 (ws (plist-get params
:wstart
))
2776 (ms (plist-get params
:mstart
))
2777 (block (plist-get params
:block
))
2778 (link (plist-get params
:link
))
2779 (tags (plist-get params
:tags
))
2780 (properties (plist-get params
:properties
))
2781 (inherit-property-p (plist-get params
:inherit-props
))
2782 (matcher (and tags
(cdr (org-make-tags-matcher tags
))))
2785 (setq org-clock-file-total-minutes nil
)
2787 (setq cc
(org-clock-special-range block nil t ws ms
)
2790 (when (integerp ts
) (setq ts
(calendar-gregorian-from-absolute ts
)))
2791 (when (integerp te
) (setq te
(calendar-gregorian-from-absolute te
)))
2792 (when (and ts
(listp ts
))
2793 (setq ts
(format "%4d-%02d-%02d" (nth 2 ts
) (car ts
) (nth 1 ts
))))
2794 (when (and te
(listp te
))
2795 (setq te
(format "%4d-%02d-%02d" (nth 2 te
) (car te
) (nth 1 te
))))
2796 ;; Now the times are strings we can parse.
2797 (if ts
(setq ts
(org-matcher-time ts
)))
2798 (if te
(setq te
(org-matcher-time te
)))
2800 (org-clock-sum ts te
2803 (let* ((tags-list (org-get-tags-at))
2804 (org-scanner-tags tags-list
)
2805 (org-trust-scanner-tags t
))
2806 (funcall ,matcher nil tags-list nil
)))))
2807 (goto-char (point-min))
2809 (while (or (and (bobp) (prog1 st
(setq st nil
))
2810 (get-text-property (point) :org-clock-minutes
)
2811 (setq p
(point-min)))
2812 (setq p
(next-single-property-change
2813 (point) :org-clock-minutes
)))
2815 (let ((time (get-text-property p
:org-clock-minutes
)))
2816 (when (and time
(> time
0) (org-at-heading-p))
2817 (let ((level (org-reduced-level (org-current-level))))
2818 (when (<= level maxlevel
)
2819 (let* ((headline (org-get-heading t t t t
))
2821 (if (not link
) headline
2823 (org-make-org-heading-search-string headline
)))
2824 (org-make-link-string
2825 (if (not (buffer-file-name)) search
2826 (format "file:%s::%s" (buffer-file-name) search
))
2827 ;; Prune statistics cookies. Replace
2828 ;; links with their description, or
2829 ;; a plain link if there is none.
2831 (org-link-display-format
2832 (replace-regexp-in-string
2833 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
2837 (cl-some (lambda (p) (org-entry-get (point) p
))
2838 '("SCHEDULED" "DEADLINE" "TIMESTAMP"
2845 (let ((v (org-entry-get
2846 (point) p inherit-property-p
)))
2847 (and v
(cons p v
))))
2849 (push (list level hdl tsp time props
) tbl
)))))))
2850 (list file org-clock-file-total-minutes
(nreverse tbl
)))))
2852 ;; Saving and loading the clock
2854 (defvar org-clock-loaded nil
2855 "Was the clock file loaded?")
2858 (defun org-clock-update-time-maybe ()
2859 "If this is a CLOCK line, update it and return t.
2860 Otherwise, return nil."
2863 (beginning-of-line 1)
2864 (skip-chars-forward " \t")
2865 (when (looking-at org-clock-string
)
2866 (let ((re (concat "[ \t]*" org-clock-string
2867 " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
2868 "\\([ \t]*=>.*\\)?\\)?"))
2871 ((not (looking-at re
))
2873 ((not (match-end 2))
2874 (when (and (equal (marker-buffer org-clock-marker
) (current-buffer))
2875 (> org-clock-marker
(point))
2876 (<= org-clock-marker
(point-at-eol)))
2877 ;; The clock is running here
2878 (setq org-clock-start-time
2880 (org-parse-time-string (match-string 1))))
2881 (org-clock-update-mode-line)))
2883 (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
2885 (setq ts
(match-string 1)
2886 te
(match-string 3))
2887 (setq s
(- (float-time
2888 (apply #'encode-time
(org-parse-time-string te nil t
)))
2890 (apply #'encode-time
(org-parse-time-string ts nil t
))))
2893 h
(floor (/ s
3600))
2897 (insert " => " (format (if neg
"-%d:%02d" "%2d:%02d") h m
))
2900 (defun org-clock-save ()
2901 "Persist various clock-related data to disk.
2902 The details of what will be saved are regulated by the variable
2903 `org-clock-persist'."
2904 (when (and org-clock-persist
2905 (or org-clock-loaded
2906 org-clock-has-been-used
2907 (not (file-exists-p org-clock-persist-file
))))
2908 (with-temp-file org-clock-persist-file
2909 (insert (format ";; %s - %s at %s\n"
2910 (file-name-nondirectory org-clock-persist-file
)
2912 (format-time-string (org-time-stamp-format t
))))
2913 ;; Store clock to be resumed.
2914 (when (and (memq org-clock-persist
'(t clock
))
2915 (let ((b (org-base-buffer (org-clocking-buffer))))
2916 (and (buffer-live-p b
)
2917 (buffer-file-name b
)
2918 (or (not org-clock-persist-query-save
)
2919 (y-or-n-p (format "Save current clock (%s) "
2920 org-clock-heading
))))))
2922 (format "(setq org-clock-stored-resume-clock '(%S . %d))\n"
2923 (buffer-file-name (org-base-buffer (org-clocking-buffer)))
2924 (marker-position org-clock-marker
))))
2925 ;; Store clocked task history. Tasks are stored reversed to
2926 ;; make reading simpler.
2927 (when (and (memq org-clock-persist
'(t history
))
2930 (format "(setq org-clock-stored-history '(%s))\n"
2933 (let ((b (org-base-buffer (marker-buffer m
))))
2934 (when (and (buffer-live-p b
)
2935 (buffer-file-name b
))
2937 (buffer-file-name b
)
2938 (marker-position m
)))))
2939 (reverse org-clock-history
)
2942 (defun org-clock-load ()
2943 "Load clock-related data from disk, maybe resuming a stored clock."
2944 (when (and org-clock-persist
(not org-clock-loaded
))
2945 (if (not (file-readable-p org-clock-persist-file
))
2946 (message "Not restoring clock data; %S not found" org-clock-persist-file
)
2947 (message "Restoring clock data")
2949 (load-file org-clock-persist-file
)
2950 (setq org-clock-loaded t
)
2951 (pcase-dolist (`(,(and file
(pred file-exists-p
)) .
,position
)
2952 org-clock-stored-history
)
2953 (org-clock-history-push position
(find-file-noselect file
)))
2955 (pcase org-clock-stored-resume-clock
2956 (`(,(and file
(pred file-exists-p
)) .
,position
)
2957 (with-current-buffer (find-file-noselect file
)
2958 (when (or (not org-clock-persist-query-resume
)
2959 (y-or-n-p (format "Resume clock (%s) "
2961 (goto-char position
)
2962 (org-get-heading t t
)))))
2963 (goto-char position
)
2964 (let ((org-clock-in-resume 'auto-restart
)
2965 (org-clock-auto-clock-resolution nil
))
2967 (when (org-invisible-p) (org-show-context))))))
2970 ;; Suggested bindings
2971 (org-defkey org-mode-map
"\C-c\C-x\C-e" 'org-clock-modify-effort-estimate
)
2973 (provide 'org-clock
)
2976 ;; generated-autoload-file: "org-loaddefs.el"
2979 ;;; org-clock.el ends here
