1 ;;; org-clock.el --- The time clocking code for Org-mode
3 ;; Copyright (C) 2004-2016 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;; This file contains the time clocking code for Org-mode
35 (declare-function calendar-iso-to-absolute
"cal-iso" (&optional date
))
36 (declare-function notifications-notify
"notifications" (&rest params
))
37 (declare-function org-pop-to-buffer-same-window
"org-compat" (&optional buffer-or-name norecord label
))
38 (declare-function org-element-property
"org-element" (property element
))
39 (declare-function org-element-type
"org-element" (element))
40 (declare-function org-table-goto-line
"org-table" (n))
41 (defvar org-time-stamp-formats
)
43 (defvar org-frame-title-format-backup frame-title-format
)
45 (defgroup org-clock nil
46 "Options concerning clocking working time in Org-mode."
50 (defcustom org-clock-into-drawer t
51 "Non-nil when clocking info should be wrapped into a drawer.
53 When non-nil, clocking info will be inserted into the same drawer
54 as log notes (see variable `org-log-into-drawer'), if it exists,
55 or \"LOGBOOK\" otherwise. If necessary, the drawer will be
58 When an integer, the drawer is created only when the number of
59 clocking entries in an item reaches or exceeds this value.
61 When a string, it becomes the name of the drawer, ignoring the
62 log notes drawer altogether.
64 Do not check directly this variable in a Lisp program. Call
65 function `org-clock-into-drawer' instead."
69 :package-version
'(Org .
"8.3")
71 (const :tag
"Always" t
)
72 (const :tag
"Only when drawer exists" nil
)
73 (integer :tag
"When at least N clock entries")
74 (const :tag
"Into LOGBOOK drawer" "LOGBOOK")
75 (string :tag
"Into Drawer named...")))
77 (defun org-clock-into-drawer ()
78 "Value of `org-clock-into-drawer'. but let properties overrule.
80 If the current entry has or inherits a CLOCK_INTO_DRAWER
81 property, it will be used instead of the default value.
83 Return value is either a string, an integer, or nil."
84 (let ((p (org-entry-get nil
"CLOCK_INTO_DRAWER" 'inherit t
)))
85 (cond ((equal p
"nil") nil
)
86 ((equal p
"t") (or (org-log-into-drawer) "LOGBOOK"))
88 (if (org-string-match-p "\\`[0-9]+\\'" p
) (string-to-number p
) p
))
89 ((org-string-nw-p org-clock-into-drawer
))
90 ((integerp org-clock-into-drawer
) org-clock-into-drawer
)
91 ((not org-clock-into-drawer
) nil
)
92 ((org-log-into-drawer))
95 (defcustom org-clock-out-when-done t
96 "When non-nil, clock will be stopped when the clocked entry is marked DONE.
98 DONE here means any DONE-like state.
99 A nil value means clock will keep running until stopped explicitly with
100 `\\[org-clock-out]', or until the clock is started in a different item.
101 Instead of t, this can also be a list of TODO states that should trigger
105 (const :tag
"No" nil
)
106 (const :tag
"Yes, when done" t
)
107 (repeat :tag
"State list"
108 (string :tag
"TODO keyword"))))
110 (defcustom org-clock-rounding-minutes
0
111 "Rounding minutes when clocking in or out.
112 The default value is 0 so that no rounding is done.
113 When set to a non-integer value, use the car of
114 `org-time-stamp-rounding-minutes', like for setting a time-stamp.
116 E.g. if `org-clock-rounding-minutes' is set to 5, time is 14:47
117 and you clock in: then the clock starts at 14:45. If you clock
118 out within the next 5 minutes, the clock line will be removed;
119 if you clock out 8 minutes after your clocked in, the clock
120 out time will be 14:50."
123 :package-version
'(Org .
"8.0")
125 (integer :tag
"Minutes (0 for no rounding)")
126 (symbol :tag
"Use `org-time-stamp-rounding-minutes'" 'same-as-time-stamp
)))
128 (defcustom org-clock-out-remove-zero-time-clocks nil
129 "Non-nil means remove the clock line when the resulting time is zero."
133 (defcustom org-clock-in-switch-to-state nil
134 "Set task to a special todo state while clocking it.
135 The value should be the state to which the entry should be
136 switched. If the value is a function, it must take one
137 parameter (the current TODO state of the item) and return the
138 state to switch it to."
142 (const :tag
"Don't force a state" nil
)
143 (string :tag
"State")
144 (symbol :tag
"Function")))
146 (defcustom org-clock-out-switch-to-state nil
147 "Set task to a special todo state after clocking out.
148 The value should be the state to which the entry should be
149 switched. If the value is a function, it must take one
150 parameter (the current TODO state of the item) and return the
151 state to switch it to."
155 (const :tag
"Don't force a state" nil
)
156 (string :tag
"State")
157 (symbol :tag
"Function")))
159 (defcustom org-clock-history-length
5
160 "Number of clock tasks to remember in history."
164 (defcustom org-clock-goto-may-find-recent-task t
165 "Non-nil means `org-clock-goto' can go to recent task if no active clock."
169 (defcustom org-clock-heading-function nil
170 "When non-nil, should be a function to create `org-clock-heading'.
171 This is the string shown in the mode line when a clock is running.
172 The function is called with point at the beginning of the headline."
174 :type
'(choice (const nil
) (function)))
176 (defcustom org-clock-string-limit
0
177 "Maximum length of clock strings in the mode line. 0 means no limit."
181 (defcustom org-clock-in-resume nil
182 "If non-nil, resume clock when clocking into task with open clock.
183 When clocking into a task with a clock entry which has not been closed,
184 the clock can be resumed from that point."
188 (defcustom org-clock-persist nil
189 "When non-nil, save the running clock when Emacs is closed.
190 The clock is resumed when Emacs restarts.
191 When this is t, both the running clock, and the entire clock
192 history are saved. When this is the symbol `clock', only the
193 running clock is saved. When this is the symbol `history', only
194 the clock history is saved.
196 When Emacs restarts with saved clock information, the file containing
197 the running clock as well as all files mentioned in the clock history
200 All this depends on running `org-clock-persistence-insinuate' in your
201 Emacs initialization file."
204 (const :tag
"Just the running clock" clock
)
205 (const :tag
"Just the history" history
)
206 (const :tag
"Clock and history" t
)
207 (const :tag
"No persistence" nil
)))
209 (defcustom org-clock-persist-file
(convert-standard-filename
210 (concat user-emacs-directory
"org-clock-save.el"))
211 "File to save clock data to."
215 (defcustom org-clock-persist-query-save nil
216 "When non-nil, ask before saving the current clock on exit."
220 (defcustom org-clock-persist-query-resume t
221 "When non-nil, ask before resuming any stored clock during load."
225 (defcustom org-clock-sound nil
226 "Sound to use for notifications.
230 t Standard Emacs beep
231 file name Play this sound file, fall back to beep"
234 (const :tag
"No sound" nil
)
235 (const :tag
"Standard beep" t
)
236 (file :tag
"Play sound file")))
238 (define-obsolete-variable-alias 'org-clock-modeline-total
239 'org-clock-mode-line-total
"24.3")
241 (defcustom org-clock-mode-line-total
'auto
242 "Default setting for the time included for the mode line clock.
243 This can be overruled locally using the CLOCK_MODELINE_TOTAL property.
246 current Only the time in the current instance of the clock
247 today All time clocked into this task today
248 repeat All time clocked into this task since last repeat
249 all All time ever recorded for this task
250 auto Automatically, either `all', or `repeat' for repeating tasks"
253 (const :tag
"Current clock" current
)
254 (const :tag
"Today's task time" today
)
255 (const :tag
"Since last repeat" repeat
)
256 (const :tag
"All task time" all
)
257 (const :tag
"Automatically, `all' or since `repeat'" auto
)))
259 (org-defvaralias 'org-task-overrun-text
'org-clock-task-overrun-text
)
260 (defcustom org-clock-task-overrun-text nil
261 "Extra mode line text to indicate that the clock is overrun.
262 The can be nil to indicate that instead of adding text, the clock time
263 should get a different face (`org-mode-line-clock-overrun').
264 When this is a string, it is prepended to the clock string as an indication,
265 also using the face `org-mode-line-clock-overrun'."
269 (const :tag
"Just mark the time string" nil
)
270 (string :tag
"Text to prepend")))
272 (defcustom org-show-notification-handler nil
273 "Function or program to send notification with.
274 The function or program will be called with the notification
279 (string :tag
"Program")
280 (function :tag
"Function")))
282 (defgroup org-clocktable nil
283 "Options concerning the clock table in Org-mode."
284 :tag
"Org Clock Table"
287 (defcustom org-clocktable-defaults
290 :lang
(or (org-bound-and-true-p org-export-default-language
) "en")
310 "Default properties for clock tables."
315 (defcustom org-clock-clocktable-formatter
'org-clocktable-write-default
316 "Function to turn clocking data into a table.
317 For more information, see `org-clocktable-write-default'."
318 :group
'org-clocktable
322 ;; FIXME: translate es and nl last string "Clock summary at"
323 (defcustom org-clock-clocktable-language-setup
324 '(("en" "File" "L" "Timestamp" "Headline" "Time" "ALL" "Total time" "File time" "Clock summary at")
325 ("es" "Archivo" "N" "Fecha y hora" "Tarea" "Tiempo" "TODO" "Tiempo total" "Tiempo archivo" "Clock summary at")
326 ("fr" "Fichier" "N" "Horodatage" "En-tête" "Durée" "TOUT" "Durée totale" "Durée fichier" "Horodatage sommaire à ")
327 ("nl" "Bestand" "N" "Tijdstip" "Hoofding" "Duur" "ALLES" "Totale duur" "Bestandstijd" "Clock summary at"))
328 "Terms used in clocktable, translated to different languages."
329 :group
'org-clocktable
333 (defcustom org-clock-clocktable-default-properties
'(:maxlevel
2 :scope file
)
334 "Default properties for new clocktables.
335 These will be inserted into the BEGIN line, to make it easy for users to
337 :group
'org-clocktable
340 (defcustom org-clock-idle-time nil
341 "When non-nil, resolve open clocks if the user is idle more than X minutes."
344 (const :tag
"Never" nil
)
345 (integer :tag
"After N minutes")))
347 (defcustom org-clock-auto-clock-resolution
'when-no-clock-is-running
348 "When to automatically resolve open clocks found in Org buffers."
351 (const :tag
"Never" nil
)
352 (const :tag
"Always" t
)
353 (const :tag
"When no clock is running" when-no-clock-is-running
)))
355 (defcustom org-clock-report-include-clocking-task nil
356 "When non-nil, include the current clocking task time in clock reports."
361 (defcustom org-clock-resolve-expert nil
362 "Non-nil means do not show the splash buffer with the clock resolver."
367 (defcustom org-clock-continuously nil
368 "Non-nil means to start clocking from the last clock-out time, if any."
373 (defcustom org-clock-total-time-cell-format
"*%s*"
374 "Format string for the total time cells."
379 (defcustom org-clock-file-time-cell-format
"*%s*"
380 "Format string for the file time cells."
385 (defcustom org-clock-clocked-in-display
'mode-line
386 "When clocked in for a task, org-mode can display the current
387 task and accumulated time in the mode line and/or frame title.
390 both displays in both mode line and frame title
391 mode-line displays only in mode line (default)
392 frame-title displays only in frame title
393 nil current clock is not displayed"
396 (const :tag
"Mode line" mode-line
)
397 (const :tag
"Frame title" frame-title
)
398 (const :tag
"Both" both
)
399 (const :tag
"None" nil
)))
401 (defcustom org-clock-frame-title-format
'(t org-mode-line-string
)
402 "The value for `frame-title-format' when clocking in.
404 When `org-clock-clocked-in-display' is set to `frame-title'
405 or `both', clocking in will replace `frame-title-format' with
406 this value. Clocking out will restore `frame-title-format'.
408 `org-frame-title-string' is a format string using the same
409 specifications than `frame-title-format', which see."
414 (defcustom org-clock-x11idle-program-name
"x11idle"
415 "Name of the program which prints X11 idle time in milliseconds.
417 You can find x11idle.c in the contrib/scripts directory of the
418 Org git distribution. Or, you can do:
420 sudo apt-get install xprintidle
422 if you are using Debian."
425 :package-version
'(Org .
"8.0")
428 (defcustom org-clock-goto-before-context
2
429 "Number of lines of context to display before currently clocked-in entry.
430 This applies when using `org-clock-goto'."
434 (defcustom org-clock-display-default-range
'thisyear
435 "Default range when displaying clocks with `org-clock-display'."
437 :type
'(choice (const today
)
446 (const :tag
"Select range interactively" interactive
)))
448 (defvar org-clock-in-prepare-hook nil
449 "Hook run when preparing the clock.
450 This hook is run before anything happens to the task that
451 you want to clock in. For example, you can use this hook
452 to add an effort property.")
453 (defvar org-clock-in-hook nil
454 "Hook run when starting the clock.")
455 (defvar org-clock-out-hook nil
456 "Hook run when stopping the current clock.")
458 (defvar org-clock-cancel-hook nil
459 "Hook run when canceling the current clock.")
460 (defvar org-clock-goto-hook nil
461 "Hook run when selecting the currently clocked-in entry.")
462 (defvar org-clock-has-been-used nil
463 "Has the clock been used during the current Emacs session?")
465 (defconst org-clock--oldest-date
467 (lambda (min max pred
)
468 (if (funcall pred min
) min
470 (while (> (- max min
) 1)
471 (let ((mean (+ (ash min -
1) (ash max -
1) (logand min max
1))))
472 (if (funcall pred mean
) (setq max mean
) (setq min mean
)))))
478 (lambda (m) (ignore-errors (decode-time (list m
0))))))
483 (lambda (m) (ignore-errors (decode-time (list high m
)))))))
485 "Internal time for oldest date representable on the system.")
487 ;;; The clock for measuring work time.
489 (defvar org-mode-line-string
"")
490 (put 'org-mode-line-string
'risky-local-variable t
)
492 (defvar org-clock-mode-line-timer nil
)
493 (defvar org-clock-idle-timer nil
)
494 (defvar org-clock-heading
) ; defined in org.el
495 (defvar org-clock-start-time
"")
497 (defvar org-clock-leftover-time nil
498 "If non-nil, user canceled a clock; this is when leftover time started.")
500 (defvar org-clock-effort
""
501 "Effort estimate of the currently clocking task.")
503 (defvar org-clock-total-time nil
504 "Holds total time, spent previously on currently clocked item.
505 This does not include the time in the currently running clock.")
507 (defvar org-clock-history nil
508 "List of marker pointing to recent clocked tasks.")
510 (defvar org-clock-default-task
(make-marker)
511 "Marker pointing to the default task that should clock time.
512 The clock can be made to switch to this task after clocking out
513 of a different task.")
515 (defvar org-clock-interrupted-task
(make-marker)
516 "Marker pointing to the task that has been interrupted by the current clock.")
518 (defvar org-clock-mode-line-map
(make-sparse-keymap))
519 (define-key org-clock-mode-line-map
[mode-line mouse-2
] 'org-clock-goto
)
520 (define-key org-clock-mode-line-map
[mode-line mouse-1
] 'org-clock-menu
)
522 (defun org-clock-menu ()
526 ["Clock out" org-clock-out t
]
527 ["Change effort estimate" org-clock-modify-effort-estimate t
]
528 ["Go to clock entry" org-clock-goto t
]
529 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t
:keys
"C-u C-c C-x C-i"])))
531 (defun org-clock-history-push (&optional pos buffer
)
532 "Push a marker to the clock history."
533 (setq org-clock-history-length
(max 1 (min 35 org-clock-history-length
)))
534 (let ((m (move-marker (make-marker)
535 (or pos
(point)) (org-base-buffer
536 (or buffer
(current-buffer)))))
538 (while (setq n
(member m org-clock-history
))
539 (move-marker (car n
) nil
))
540 (setq org-clock-history
542 (mapcar (lambda (x) (if (marker-buffer x
) x nil
))
544 (when (>= (setq l
(length org-clock-history
)) org-clock-history-length
)
545 (setq org-clock-history
547 (nthcdr (- l org-clock-history-length -
1)
548 (nreverse org-clock-history
)))))
549 (push m org-clock-history
)))
551 (defun org-clock-save-markers-for-cut-and-paste (beg end
)
552 "Save relative positions of markers in region."
553 (org-check-and-save-marker org-clock-marker beg end
)
554 (org-check-and-save-marker org-clock-hd-marker beg end
)
555 (org-check-and-save-marker org-clock-default-task beg end
)
556 (org-check-and-save-marker org-clock-interrupted-task beg end
)
557 (mapc (lambda (m) (org-check-and-save-marker m beg end
))
560 (defun org-clock-drawer-name ()
561 "Return clock drawer's name for current entry, or nil."
562 (let ((drawer (org-clock-into-drawer)))
563 (cond ((integerp drawer
) (org-log-into-drawer))
564 ((stringp drawer
) drawer
)
567 (defun org-clocking-buffer ()
568 "Return the clocking buffer if we are currently clocking a task or nil."
569 (marker-buffer org-clock-marker
))
571 (defun org-clocking-p ()
572 "Return t when clocking a task."
573 (not (equal (org-clocking-buffer) nil
)))
575 (defvar org-clock-before-select-task-hook nil
576 "Hook called in task selection just before prompting the user.")
578 (defun org-clock-select-task (&optional prompt
)
579 "Select a task that was recently associated with clocking."
581 (let (och chl sel-list rpl
(i 0) s
)
582 ;; Remove successive dups from the clock history to consider
583 (mapc (lambda (c) (if (not (equal c
(car och
))) (push c och
)))
585 (setq och
(reverse och
) chl
(length och
))
587 (user-error "No recent clock")
588 (save-window-excursion
589 (org-switch-to-buffer-other-window
590 (get-buffer-create "*Clock Task Select*"))
592 (when (marker-buffer org-clock-default-task
)
593 (insert (org-add-props "Default Task\n" nil
'face
'bold
))
594 (setq s
(org-clock-insert-selection-line ?d org-clock-default-task
))
596 (when (marker-buffer org-clock-interrupted-task
)
597 (insert (org-add-props "The task interrupted by starting the last one\n" nil
'face
'bold
))
598 (setq s
(org-clock-insert-selection-line ?i org-clock-interrupted-task
))
600 (when (org-clocking-p)
601 (insert (org-add-props "Current Clocking Task\n" nil
'face
'bold
))
602 (setq s
(org-clock-insert-selection-line ?c org-clock-marker
))
604 (insert (org-add-props "Recent Tasks\n" nil
'face
'bold
))
607 (when (marker-buffer m
)
609 s
(org-clock-insert-selection-line
613 (if (fboundp 'int-to-char
) (setf (car s
) (int-to-char (car s
))))
616 (run-hooks 'org-clock-before-select-task-hook
)
617 (goto-char (point-min))
618 ;; Set min-height relatively to circumvent a possible but in
619 ;; `fit-window-to-buffer'
620 (fit-window-to-buffer nil nil
(if (< chl
10) chl
(+ 5 chl
)))
621 (message (or prompt
"Select task for clocking:"))
622 (setq cursor-type nil rpl
(read-char-exclusive))
627 ((assoc rpl sel-list
) (cdr (assoc rpl sel-list
)))
628 (t (user-error "Invalid task choice %c" rpl
)))))))
630 (defun org-clock-insert-selection-line (i marker
)
631 "Insert a line for the clock selection menu.
632 And return a cons cell with the selection character integer and the marker
634 (when (marker-buffer marker
)
635 (let (file cat task heading prefix
)
636 (with-current-buffer (org-base-buffer (marker-buffer marker
))
642 (setq file
(buffer-file-name (marker-buffer marker
))
643 cat
(org-get-category)
644 heading
(org-get-heading 'notags
)
645 prefix
(save-excursion
646 (org-back-to-heading t
)
647 (looking-at org-outline-regexp
)
650 (org-fontify-like-in-org-mode
651 (concat prefix heading
)
653 (length prefix
)))))))
655 (insert (format "[%c] %-12s %s\n" i cat task
))
658 (defvar org-clock-task-overrun nil
659 "Internal flag indicating if the clock has overrun the planned time.")
660 (defvar org-clock-update-period
60
661 "Number of seconds between mode line clock string updates.")
663 (defun org-clock-get-clock-string ()
664 "Form a clock-string, that will be shown in the mode line.
665 If an effort estimate was defined for the current item, use
666 01:30/01:50 format (clocked/estimated).
667 If not, show simply the clocked time like 01:50."
668 (let ((clocked-time (org-clock-get-clocked-time)))
670 (let* ((effort-in-minutes
671 (org-duration-string-to-minutes org-clock-effort
))
674 (org-minutes-to-clocksum-string clocked-time
)
675 'face
(if (and org-clock-task-overrun
(not org-clock-task-overrun-text
))
676 'org-mode-line-clock-overrun
'org-mode-line-clock
)))
677 (effort-str (org-minutes-to-clocksum-string effort-in-minutes
))
678 (clockstr (org-propertize
679 (concat " [%s/" effort-str
680 "] (" (replace-regexp-in-string "%" "%%" org-clock-heading
) ")")
681 'face
'org-mode-line-clock
)))
682 (format clockstr work-done-str
))
683 (org-propertize (concat "[" (org-minutes-to-clocksum-string clocked-time
)
684 (format " (%s)" org-clock-heading
) "]")
685 'face
'org-mode-line-clock
))))
687 (defun org-clock-get-last-clock-out-time ()
688 "Get the last clock-out time for the current subtree."
690 (let ((end (save-excursion (org-end-of-subtree))))
691 (when (re-search-forward (concat org-clock-string
692 ".*\\]--\\(\\[[^]]+\\]\\)") end t
)
693 (org-time-string-to-time (match-string 1))))))
695 (defun org-clock-update-mode-line ()
697 (org-clock-notify-once-if-expired)
698 (setq org-clock-task-overrun nil
))
699 (setq org-mode-line-string
701 (let ((clock-string (org-clock-get-clock-string))
702 (help-text "Org-mode clock is running.\nmouse-1 shows a menu\nmouse-2 will jump to task"))
703 (if (and (> org-clock-string-limit
0)
704 (> (length clock-string
) org-clock-string-limit
))
706 (substring clock-string
0 org-clock-string-limit
)
707 'help-echo
(concat help-text
": " org-clock-heading
))
708 (org-propertize clock-string
'help-echo help-text
)))
709 'local-map org-clock-mode-line-map
710 'mouse-face
(if (featurep 'xemacs
) 'highlight
'mode-line-highlight
)))
711 (if (and org-clock-task-overrun org-clock-task-overrun-text
)
712 (setq org-mode-line-string
713 (concat (org-propertize
714 org-clock-task-overrun-text
715 'face
'org-mode-line-clock-overrun
) org-mode-line-string
)))
716 (force-mode-line-update))
718 (defun org-clock-get-clocked-time ()
719 "Get the clocked time for the current item in minutes.
720 The time returned includes the time spent on this task in
721 previous clocking intervals."
722 (let ((currently-clocked-time
723 (floor (- (org-float-time)
724 (org-float-time org-clock-start-time
)) 60)))
725 (+ currently-clocked-time
(or org-clock-total-time
0))))
727 (defun org-clock-modify-effort-estimate (&optional value
)
728 "Add to or set the effort estimate of the item currently being clocked.
729 VALUE can be a number of minutes, or a string with format hh:mm or mm.
730 When the string starts with a + or a - sign, the current value of the effort
731 property will be changed by that amount. If the effort value is expressed
732 as an `org-effort-durations' (e.g. \"3h\"), the modified value will be
733 converted to a hh:mm duration.
735 This command will update the \"Effort\" property of the currently
736 clocked item, and the value displayed in the mode line."
738 (if (org-clock-is-active)
739 (let ((current org-clock-effort
) sign
)
741 ;; Prompt user for a value or a change
744 (format "Set effort (hh:mm or mm%s): "
746 (format ", prefix + to add to %s" org-clock-effort
)
748 (when (stringp value
)
749 ;; A string. See if it is a delta
750 (setq sign
(string-to-char value
))
751 (if (member sign
'(?- ?
+))
752 (setq current
(org-duration-string-to-minutes current
)
753 value
(substring value
1))
755 (setq value
(org-duration-string-to-minutes value
))
757 (setq value
(- current value
))
758 (if (equal ?
+ sign
) (setq value
(+ current value
)))))
759 (setq value
(max 0 value
)
760 org-clock-effort
(org-minutes-to-clocksum-string value
))
761 (org-entry-put org-clock-marker
"Effort" org-clock-effort
)
762 (org-clock-update-mode-line)
763 (message "Effort is now %s" org-clock-effort
))
764 (message "Clock is not currently active")))
766 (defvar org-clock-notification-was-shown nil
767 "Shows if we have shown notification already.")
769 (defun org-clock-notify-once-if-expired ()
770 "Show notification if we spent more time than we estimated before.
771 Notification is shown only once."
772 (when (org-clocking-p)
773 (let ((effort-in-minutes (org-duration-string-to-minutes org-clock-effort
))
774 (clocked-time (org-clock-get-clocked-time)))
775 (if (setq org-clock-task-overrun
776 (if (or (null effort-in-minutes
) (zerop effort-in-minutes
))
778 (>= clocked-time effort-in-minutes
)))
779 (unless org-clock-notification-was-shown
780 (setq org-clock-notification-was-shown t
)
782 (format-message "Task `%s' should be finished by now. (%s)"
783 org-clock-heading org-clock-effort
)
785 (setq org-clock-notification-was-shown nil
)))))
787 (defun org-notify (notification &optional play-sound
)
788 "Send a NOTIFICATION and maybe PLAY-SOUND.
789 If PLAY-SOUND is non-nil, it overrides `org-clock-sound'."
790 (org-show-notification notification
)
791 (if play-sound
(org-clock-play-sound play-sound
)))
793 (defun org-show-notification (notification)
795 Use `org-show-notification-handler' if defined,
796 use libnotify if available, or fall back on a message."
797 (cond ((functionp org-show-notification-handler
)
798 (funcall org-show-notification-handler notification
))
799 ((stringp org-show-notification-handler
)
800 (start-process "emacs-timer-notification" nil
801 org-show-notification-handler notification
))
802 ((fboundp 'notifications-notify
)
803 (notifications-notify
804 :title
"Org-mode message"
806 ;; FIXME how to link to the Org icon?
807 ;; :app-icon "~/.emacs.d/icons/mail.png"
809 ((executable-find "notify-send")
810 (start-process "emacs-timer-notification" nil
811 "notify-send" notification
))
812 ;; Maybe the handler will send a message, so only use message as
813 ;; a fall back option
814 (t (message "%s" notification
))))
816 (defun org-clock-play-sound (&optional clock-sound
)
817 "Play sound as configured by `org-clock-sound'.
818 Use alsa's aplay tool if available.
819 If CLOCK-SOUND is non-nil, it overrides `org-clock-sound'."
820 (let ((org-clock-sound (or clock-sound org-clock-sound
)))
822 ((not org-clock-sound
))
823 ((eq org-clock-sound t
) (beep t
) (beep t
))
824 ((stringp org-clock-sound
)
825 (let ((file (expand-file-name org-clock-sound
)))
826 (if (file-exists-p file
)
827 (if (executable-find "aplay")
828 (start-process "org-clock-play-notification" nil
831 (play-sound-file file
)
832 (error (beep t
) (beep t
))))))))))
834 (defvar org-clock-mode-line-entry nil
835 "Information for the mode line about the running clock.")
837 (defun org-find-open-clocks (file)
838 "Search through the given file and find all open clocks."
839 (let ((buf (or (get-file-buffer file
)
840 (find-file-noselect file
)))
841 (org-clock-re (concat org-clock-string
" \\(\\[.*?\\]\\)$"))
843 (with-current-buffer buf
845 (goto-char (point-min))
846 (while (re-search-forward org-clock-re nil t
)
847 (push (cons (copy-marker (match-end 1) t
)
848 (org-time-string-to-time (match-string 1))) clocks
))))
851 (defsubst org-is-active-clock
(clock)
852 "Return t if CLOCK is the currently active clock."
853 (and (org-clock-is-active)
854 (= org-clock-marker
(car clock
))))
856 (defmacro org-with-clock-position
(clock &rest forms
)
857 "Evaluate FORMS with CLOCK as the current active clock."
858 `(with-current-buffer (marker-buffer (car ,clock
))
862 (goto-char (car ,clock
))
865 (def-edebug-spec org-with-clock-position
(form body
))
866 (put 'org-with-clock-position
'lisp-indent-function
1)
868 (defmacro org-with-clock
(clock &rest forms
)
869 "Evaluate FORMS with CLOCK as the current active clock.
870 This macro also protects the current active clock from being altered."
871 `(org-with-clock-position ,clock
872 (let ((org-clock-start-time (cdr ,clock
))
873 (org-clock-total-time)
876 (org-clock-marker (car ,clock
))
877 (org-clock-hd-marker (save-excursion
878 (org-back-to-heading t
)
881 (def-edebug-spec org-with-clock
(form body
))
882 (put 'org-with-clock
'lisp-indent-function
1)
884 (defsubst org-clock-clock-in
(clock &optional resume start-time
)
885 "Clock in to the clock located by CLOCK.
886 If necessary, clock-out of the currently active clock."
887 (org-with-clock-position clock
888 (let ((org-clock-in-resume (or resume org-clock-in-resume
)))
889 (org-clock-in nil start-time
))))
891 (defsubst org-clock-clock-out
(clock &optional fail-quietly at-time
)
892 "Clock out of the clock located by CLOCK."
893 (let ((temp (copy-marker (car clock
)
894 (marker-insertion-type (car clock
)))))
895 (if (org-is-active-clock clock
)
896 (org-clock-out nil fail-quietly at-time
)
897 (org-with-clock clock
898 (org-clock-out nil fail-quietly at-time
)))
899 (setcar clock temp
)))
901 (defsubst org-clock-clock-cancel
(clock)
902 "Cancel the clock located by CLOCK."
903 (let ((temp (copy-marker (car clock
)
904 (marker-insertion-type (car clock
)))))
905 (if (org-is-active-clock clock
)
907 (org-with-clock clock
909 (setcar clock temp
)))
911 (defvar org-clock-clocking-in nil
)
912 (defvar org-clock-resolving-clocks nil
)
913 (defvar org-clock-resolving-clocks-due-to-idleness nil
)
915 (defun org-clock-resolve-clock (clock resolve-to clock-out-time
916 &optional close-p restart-p fail-quietly
)
917 "Resolve `CLOCK' given the time `RESOLVE-TO', and the present.
918 `CLOCK' is a cons cell of the form (MARKER START-TIME)."
919 (let ((org-clock-resolving-clocks t
))
922 (org-clock-clock-cancel clock
)
923 (if (and restart-p
(not org-clock-clocking-in
))
924 (org-clock-clock-in clock
)))
926 ((eq resolve-to
'now
)
928 (error "RESTART-P is not valid here"))
929 (if (or close-p org-clock-clocking-in
)
930 (org-clock-clock-out clock fail-quietly
)
931 (unless (org-is-active-clock clock
)
932 (org-clock-clock-in clock t
))))
934 ((not (time-less-p resolve-to
(current-time)))
935 (error "RESOLVE-TO must refer to a time in the past"))
939 (error "RESTART-P is not valid here"))
940 (org-clock-clock-out clock fail-quietly
(or clock-out-time
942 (unless org-clock-clocking-in
944 (setq org-clock-leftover-time
(and (null clock-out-time
)
946 (org-clock-clock-in clock nil
(and clock-out-time
949 (defun org-clock-jump-to-current-clock (&optional effective-clock
)
951 (let ((drawer (org-clock-into-drawer))
952 (clock (or effective-clock
(cons org-clock-marker
953 org-clock-start-time
))))
954 (unless (marker-buffer (car clock
))
955 (error "No clock is currently running"))
956 (org-with-clock clock
(org-clock-goto))
957 (with-current-buffer (marker-buffer (car clock
))
958 (goto-char (car clock
))
960 (org-with-wide-buffer
961 (let ((drawer-re (format "^[ \t]*:%s:[ \t]*$"
962 (regexp-quote (if (stringp drawer
) drawer
"LOGBOOK"))))
963 (beg (save-excursion (org-back-to-heading t
) (point))))
965 (while (re-search-backward drawer-re beg t
)
966 (let ((element (org-element-at-point)))
967 (when (eq (org-element-type element
) 'drawer
)
968 (when (> (org-element-property :end element
) (car clock
))
969 (org-flag-drawer nil element
))
970 (throw 'exit nil
)))))))))))
972 (defun org-clock-resolve (clock &optional prompt-fn last-valid fail-quietly
)
973 "Resolve an open org-mode clock.
974 An open clock was found, with `dangling' possibly being non-nil.
975 If this function was invoked with a prefix argument, non-dangling
976 open clocks are ignored. The given clock requires some sort of
977 user intervention to resolve it, either because a clock was left
978 dangling or due to an idle timeout. The clock resolution can
981 (a) deleted, the user doesn't care about the clock
982 (b) restarted from the current time (if no other clock is open)
983 (c) closed, giving the clock X minutes
984 (d) closed and then restarted
985 (e) resumed, as if the user had never left
987 The format of clock is (CONS MARKER START-TIME), where MARKER
988 identifies the buffer and position the clock is open at (and
989 thus, the heading it's under), and START-TIME is when the clock
993 (save-window-excursion
995 (unless org-clock-resolving-clocks-due-to-idleness
996 (org-clock-jump-to-current-clock clock
))
997 (unless org-clock-resolve-expert
998 (with-output-to-temp-buffer "*Org Clock*"
999 (princ (format-message "Select a Clock Resolution Command:
1001 i/q Ignore this question; the same as keeping all the idle time.
1003 k/K Keep X minutes of the idle time (default is all). If this
1004 amount is less than the default, you will be clocked out
1005 that many minutes after the time that idling began, and then
1006 clocked back in at the present time.
1008 g/G Indicate that you \"got back\" X minutes ago. This is quite
1009 different from `k': it clocks you out from the beginning of
1010 the idle period and clock you back in X minutes ago.
1012 s/S Subtract the idle time from the current clock. This is the
1013 same as keeping 0 minutes.
1015 C Cancel the open timer altogether. It will be as though you
1018 j/J Jump to the current clock, to make manual adjustments.
1020 For all these options, using uppercase makes your final state
1021 to be CLOCKED OUT."))))
1022 (org-fit-window-to-buffer (get-buffer-window "*Org Clock*"))
1024 (when (featurep 'xemacs
)
1025 (message (concat (funcall prompt-fn clock
)
1026 " [jkKgGsScCiq]? "))
1027 (setq char-pressed
(read-char-exclusive)))
1028 (while (or (null char-pressed
)
1029 (and (not (memq char-pressed
1030 '(?k ?K ?g ?G ?s ?S ?C
1034 (read-char (concat (funcall prompt-fn clock
)
1037 (and (not (memq char-pressed
'(?i ?q
))) char-pressed
)))))
1039 (floor (/ (org-float-time
1040 (time-subtract (current-time) last-valid
)) 60)))
1042 (and (memq ch
'(?k ?K
))
1043 (read-number "Keep how many minutes? " default
)))
1045 (and (memq ch
'(?g ?G
))
1046 (read-number "Got back how many minutes ago? " default
)))
1047 (subtractp (memq ch
'(?s ?S
)))
1048 (barely-started-p (< (- (org-float-time last-valid
)
1049 (org-float-time (cdr clock
))) 45))
1050 (start-over (and subtractp barely-started-p
)))
1054 (org-clock-resolve-clock clock
'now nil t nil fail-quietly
))
1055 (org-clock-jump-to-current-clock clock
))
1057 (not (memq ch
'(?k ?K ?g ?G ?s ?S ?C
))))
1060 (org-clock-resolve-clock
1063 ;; If the time on the clock was less than a minute before
1064 ;; the user went away, and they've ask to subtract all the
1069 (and gotback
(= gotback
0)))
1071 ((or (and keep
(= keep default
))
1072 (and gotback
(= gotback default
)))
1075 (time-add last-valid
(seconds-to-time (* 60 keep
))))
1077 (time-subtract (current-time)
1078 (seconds-to-time (* 60 gotback
))))
1080 (error "Unexpected, please report this as a bug")))
1081 (and gotback last-valid
)
1082 (memq ch
'(?K ?G ?S
))
1084 (not (memq ch
'(?K ?G ?S ?C
))))
1088 (defun org-resolve-clocks (&optional only-dangling-p prompt-fn last-valid
)
1089 "Resolve all currently open org-mode clocks.
1090 If `only-dangling-p' is non-nil, only ask to resolve dangling
1091 \(i.e., not currently open and valid) clocks."
1093 (unless org-clock-resolving-clocks
1094 (let ((org-clock-resolving-clocks t
))
1095 (dolist (file (org-files-list))
1096 (let ((clocks (org-find-open-clocks file
)))
1097 (dolist (clock clocks
)
1098 (let ((dangling (or (not (org-clock-is-active))
1099 (/= (car clock
) org-clock-marker
))))
1100 (if (or (not only-dangling-p
) dangling
)
1107 "Dangling clock started %d mins ago"
1108 (floor (- (org-float-time)
1109 (org-float-time (cdr clock
)))
1112 (cdr clock
)))))))))))
1114 (defun org-emacs-idle-seconds ()
1115 "Return the current Emacs idle time in seconds, or nil if not idle."
1116 (let ((idle-time (current-idle-time)))
1118 (org-float-time idle-time
)
1121 (defun org-mac-idle-seconds ()
1122 "Return the current Mac idle time in seconds."
1123 (string-to-number (shell-command-to-string "ioreg -c IOHIDSystem | perl -ane 'if (/Idle/) {$idle=(pop @F)/1000000000; print $idle; last}'")))
1125 (defvar org-x11idle-exists-p
1126 ;; Check that x11idle exists
1127 (and (eq window-system
'x
)
1128 (eq 0 (call-process-shell-command
1129 (format "command -v %s" org-clock-x11idle-program-name
)))
1130 ;; Check that x11idle can retrieve the idle time
1131 ;; FIXME: Why "..-shell-command" rather than just `call-process'?
1132 (eq 0 (call-process-shell-command org-clock-x11idle-program-name
))))
1134 (defun org-x11-idle-seconds ()
1135 "Return the current X11 idle time in seconds."
1136 (/ (string-to-number (shell-command-to-string org-clock-x11idle-program-name
)) 1000))
1138 (defun org-user-idle-seconds ()
1139 "Return the number of seconds the user has been idle for.
1140 This routine returns a floating point number."
1142 ((eq system-type
'darwin
)
1143 (org-mac-idle-seconds))
1144 ((and (eq window-system
'x
) org-x11idle-exists-p
)
1145 (org-x11-idle-seconds))
1147 (org-emacs-idle-seconds))))
1149 (defvar org-clock-user-idle-seconds
)
1151 (defun org-resolve-clocks-if-idle ()
1152 "Resolve all currently open org-mode clocks.
1153 This is performed after `org-clock-idle-time' minutes, to check
1154 if the user really wants to stay clocked in after being idle for
1156 (when (and org-clock-idle-time
(not org-clock-resolving-clocks
)
1157 org-clock-marker
(marker-buffer org-clock-marker
))
1158 (let* ((org-clock-user-idle-seconds (org-user-idle-seconds))
1159 (org-clock-user-idle-start
1160 (time-subtract (current-time)
1161 (seconds-to-time org-clock-user-idle-seconds
)))
1162 (org-clock-resolving-clocks-due-to-idleness t
))
1163 (if (> org-clock-user-idle-seconds
(* 60 org-clock-idle-time
))
1165 (cons org-clock-marker
1166 org-clock-start-time
)
1169 (format "Clocked in & idle for %.1f mins"
1171 (time-subtract (current-time)
1172 org-clock-user-idle-start
))
1174 org-clock-user-idle-start
)))))
1176 (defvar org-clock-current-task nil
"Task currently clocked in.")
1177 (defvar org-clock-out-time nil
) ; store the time of the last clock-out
1178 (defvar org--msg-extra
)
1181 (defun org-clock-in (&optional select start-time
)
1182 "Start the clock on the current item.
1183 If necessary, clock-out of the currently active clock.
1184 With a prefix argument SELECT (\\[universal-argument]), offer a list of recently clocked
1185 tasks to clock into. When SELECT is \\[universal-argument] \\[universal-argument], clock into the current task
1186 and mark it as the default task, a special task that will always be offered
1187 in the clocking selection, associated with the letter `d'.
1188 When SELECT is \\[universal-argument] \\[universal-argument] \\[universal-argument], \
1189 clock in by using the last clock-out
1190 time as the start time \(see `org-clock-continuously' to
1191 make this the default behavior.)"
1193 (setq org-clock-notification-was-shown nil
)
1194 (org-refresh-properties
1195 org-effort-property
'((effort . identity
)
1196 (effort-minutes . org-duration-string-to-minutes
)))
1198 (let ((interrupting (and (not org-clock-resolving-clocks-due-to-idleness
)
1200 ts selected-task target-pos
(org--msg-extra "")
1201 (leftover (and (not org-clock-resolving-clocks
)
1202 org-clock-leftover-time
)))
1204 (when (and org-clock-auto-clock-resolution
1205 (or (not interrupting
)
1206 (eq t org-clock-auto-clock-resolution
))
1207 (not org-clock-clocking-in
)
1208 (not org-clock-resolving-clocks
))
1209 (setq org-clock-leftover-time nil
)
1210 (let ((org-clock-clocking-in t
))
1211 (org-resolve-clocks))) ; check if any clocks are dangling
1213 (when (equal select
'(64))
1214 ;; Set start-time to `org-clock-out-time'
1215 (let ((org-clock-continuously t
))
1216 (org-clock-in nil org-clock-out-time
)))
1218 (when (equal select
'(4))
1219 (setq selected-task
(org-clock-select-task "Clock-in on task: "))
1221 (setq selected-task
(copy-marker selected-task
))
1224 (when (equal select
'(16))
1225 ;; Mark as default clocking task
1226 (org-clock-mark-default-task))
1229 ;; We are interrupting the clocking of a different task.
1230 ;; Save a marker to this task, so that we can go back.
1231 ;; First check if we are trying to clock into the same task!
1232 (when (save-excursion
1233 (unless selected-task
1234 (org-back-to-heading t
))
1235 (and (equal (marker-buffer org-clock-hd-marker
)
1237 (marker-buffer selected-task
)
1239 (= (marker-position org-clock-hd-marker
)
1241 (marker-position selected-task
)
1243 (equal org-clock-current-task
(nth 4 (org-heading-components)))))
1244 (message "Clock continues in \"%s\"" org-clock-heading
)
1246 (move-marker org-clock-interrupted-task
1247 (marker-position org-clock-marker
)
1248 (marker-buffer org-clock-marker
))
1249 (let ((org-clock-clocking-in t
))
1250 (org-clock-out nil t
)))
1252 ;; Clock in at which position?
1254 (if (and (eobp) (not (org-at-heading-p)))
1258 (when (and selected-task
(marker-buffer selected-task
))
1259 ;; There is a selected task, move to the correct buffer
1260 ;; and set the new target position.
1261 (set-buffer (org-base-buffer (marker-buffer selected-task
)))
1262 (setq target-pos
(marker-position selected-task
))
1263 (move-marker selected-task nil
))
1267 (goto-char target-pos
)
1268 (org-back-to-heading t
)
1269 (or interrupting
(move-marker org-clock-interrupted-task nil
))
1270 (run-hooks 'org-clock-in-prepare-hook
)
1271 (org-clock-history-push)
1272 (setq org-clock-current-task
(nth 4 (org-heading-components)))
1273 (cond ((functionp org-clock-in-switch-to-state
)
1274 (looking-at org-complex-heading-regexp
)
1275 (let ((newstate (funcall org-clock-in-switch-to-state
1277 (if newstate
(org-todo newstate
))))
1278 ((and org-clock-in-switch-to-state
1279 (not (looking-at (concat org-outline-regexp
"[ \t]*"
1280 org-clock-in-switch-to-state
1282 (org-todo org-clock-in-switch-to-state
)))
1283 (setq org-clock-heading
1284 (cond ((and org-clock-heading-function
1285 (functionp org-clock-heading-function
))
1286 (funcall org-clock-heading-function
))
1287 ((nth 4 (org-heading-components))
1288 (replace-regexp-in-string
1289 "\\[\\[.*?\\]\\[\\(.*?\\)\\]\\]" "\\1"
1290 (match-string-no-properties 4)))
1292 (org-clock-find-position org-clock-in-resume
)
1294 ((and org-clock-in-resume
1296 (concat "^[ \t]*" org-clock-string
1297 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1298 " *\\sw+.? +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
1299 (message "Matched %s" (match-string 1))
1300 (setq ts
(concat "[" (match-string 1) "]"))
1301 (goto-char (match-end 1))
1302 (setq org-clock-start-time
1304 (org-parse-time-string (match-string 1))))
1305 (setq org-clock-effort
(org-entry-get (point) org-effort-property
))
1306 (setq org-clock-total-time
(org-clock-sum-current-item
1307 (org-clock-get-sum-start))))
1308 ((eq org-clock-in-resume
'auto-restart
)
1309 ;; called from org-clock-load during startup,
1310 ;; do not interrupt, but warn!
1311 (message "Cannot restart clock because task does not contain unfinished clock")
1316 (insert-before-markers "\n")
1319 (when (and (save-excursion
1322 (beginning-of-line 1)
1323 (org-indent-line-to (- (org-get-indentation) 2)))
1324 (insert org-clock-string
" ")
1325 (setq org-clock-effort
(org-entry-get (point) org-effort-property
))
1326 (setq org-clock-total-time
(org-clock-sum-current-item
1327 (org-clock-get-sum-start)))
1328 (setq org-clock-start-time
1329 (or (and org-clock-continuously org-clock-out-time
)
1333 "You stopped another clock %d mins ago; start this one from then? "
1334 (/ (- (org-float-time
1335 (org-current-time org-clock-rounding-minutes t
))
1336 (org-float-time leftover
)) 60)))
1339 (org-current-time org-clock-rounding-minutes t
)))
1340 (setq ts
(org-insert-time-stamp org-clock-start-time
1341 'with-hm
'inactive
))))
1342 (move-marker org-clock-marker
(point) (buffer-base-buffer))
1343 (move-marker org-clock-hd-marker
1344 (save-excursion (org-back-to-heading t
) (point))
1345 (buffer-base-buffer))
1346 (setq org-clock-has-been-used t
)
1348 (when (or (eq org-clock-clocked-in-display
'mode-line
)
1349 (eq org-clock-clocked-in-display
'both
))
1350 (or global-mode-string
(setq global-mode-string
'("")))
1351 (or (memq 'org-mode-line-string global-mode-string
)
1352 (setq global-mode-string
1353 (append global-mode-string
'(org-mode-line-string)))))
1354 ;; add to frame title
1355 (when (or (eq org-clock-clocked-in-display
'frame-title
)
1356 (eq org-clock-clocked-in-display
'both
))
1357 (setq frame-title-format org-clock-frame-title-format
))
1358 (org-clock-update-mode-line)
1359 (when org-clock-mode-line-timer
1360 (cancel-timer org-clock-mode-line-timer
)
1361 (setq org-clock-mode-line-timer nil
))
1362 (when org-clock-clocked-in-display
1363 (setq org-clock-mode-line-timer
1364 (run-with-timer org-clock-update-period
1365 org-clock-update-period
1366 'org-clock-update-mode-line
)))
1367 (when org-clock-idle-timer
1368 (cancel-timer org-clock-idle-timer
)
1369 (setq org-clock-idle-timer nil
))
1370 (setq org-clock-idle-timer
1371 (run-with-timer 60 60 'org-resolve-clocks-if-idle
))
1372 (message "Clock starts at %s - %s" ts org--msg-extra
)
1373 (run-hooks 'org-clock-in-hook
)))))))
1376 (defun org-clock-in-last (&optional arg
)
1377 "Clock in the last closed clocked item.
1378 When already clocking in, send an warning.
1379 With a universal prefix argument, select the task you want to
1380 clock in from the last clocked in tasks.
1381 With two universal prefix arguments, start clocking using the
1382 last clock-out time, if any.
1383 With three universal prefix arguments, interactively prompt
1384 for a todo state to switch to, overriding the existing value
1385 `org-clock-in-switch-to-state'."
1387 (if (equal arg
'(4)) (org-clock-in arg
)
1388 (let ((start-time (if (or org-clock-continuously
(equal arg
'(16)))
1389 (or org-clock-out-time
1390 (org-current-time org-clock-rounding-minutes t
))
1391 (org-current-time org-clock-rounding-minutes t
))))
1392 (if (null org-clock-history
)
1393 (message "No last clock")
1394 (let ((org-clock-in-switch-to-state
1395 (if (and (not org-clock-current-task
) (equal arg
'(64)))
1396 (completing-read "Switch to state: "
1397 (and org-clock-history
1398 (with-current-buffer
1399 (marker-buffer (car org-clock-history
))
1400 org-todo-keywords-1
)))
1401 org-clock-in-switch-to-state
))
1402 (already-clocking org-clock-current-task
))
1403 (org-clock-clock-in (list (car org-clock-history
)) nil start-time
)
1404 (or already-clocking
1405 ;; Don't display a message if we are already clocking in
1406 (message "Clocking back: %s (in %s)"
1407 org-clock-current-task
1408 (buffer-name (marker-buffer org-clock-marker
)))))))))
1410 (defun org-clock-mark-default-task ()
1411 "Mark current task as default task."
1414 (org-back-to-heading t
)
1415 (move-marker org-clock-default-task
(point))))
1417 (defun org-clock-get-sum-start ()
1418 "Return the time from which clock times should be counted.
1419 This is for the currently running clock as it is displayed
1420 in the mode line. This function looks at the properties
1421 LAST_REPEAT and in particular CLOCK_MODELINE_TOTAL and the
1422 corresponding variable `org-clock-mode-line-total' and then
1423 decides which time to use."
1424 (let ((cmt (or (org-entry-get nil
"CLOCK_MODELINE_TOTAL")
1425 (symbol-name org-clock-mode-line-total
)))
1426 (lr (org-entry-get nil
"LAST_REPEAT")))
1428 ((equal cmt
"current")
1429 (setq org--msg-extra
"showing time in current clock instance")
1431 ((equal cmt
"today")
1432 (setq org--msg-extra
"showing today's task time.")
1433 (let* ((dt (decode-time))
1436 (if (< hour org-extend-today-until
) (setf (nth 3 dt
) (1- day
)))
1437 (setf (nth 2 dt
) org-extend-today-until
)
1438 (setq dt
(append (list 0 0) (nthcdr 2 dt
)))
1439 (apply 'encode-time dt
)))
1440 ((or (equal cmt
"all")
1441 (and (or (not cmt
) (equal cmt
"auto"))
1443 (setq org--msg-extra
"showing entire task time.")
1445 ((or (equal cmt
"repeat")
1446 (and (or (not cmt
) (equal cmt
"auto"))
1448 (setq org--msg-extra
"showing task time since last repeat.")
1451 (org-time-string-to-time lr
)))
1454 (defun org-clock-find-position (find-unclosed)
1455 "Find the location where the next clock line should be inserted.
1456 When FIND-UNCLOSED is non-nil, first check if there is an unclosed clock
1457 line and position cursor in that line."
1458 (org-back-to-heading t
)
1460 (let* ((beg (line-beginning-position))
1461 (end (save-excursion (outline-next-heading) (point)))
1462 (org-clock-into-drawer (org-clock-into-drawer))
1463 (drawer (org-clock-drawer-name)))
1464 ;; Look for a running clock if FIND-UNCLOSED in non-nil.
1466 (let ((open-clock-re
1469 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1470 " *\\sw+ +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
1471 (while (re-search-forward open-clock-re end t
)
1472 (let ((element (org-element-at-point)))
1473 (when (and (eq (org-element-type element
) 'clock
)
1474 (eq (org-element-property :status element
) 'running
))
1476 (throw 'exit t
))))))
1477 ;; Look for an existing clock drawer.
1480 (let ((drawer-re (concat "^[ \t]*:" (regexp-quote drawer
) ":[ \t]*$")))
1481 (while (re-search-forward drawer-re end t
)
1482 (let ((element (org-element-at-point)))
1483 (when (eq (org-element-type element
) 'drawer
)
1484 (let ((cend (org-element-property :contents-end element
)))
1485 (if (and (not org-log-states-order-reversed
) cend
)
1488 (throw 'exit t
)))))))
1490 (let ((clock-re (concat "^[ \t]*" org-clock-string
))
1491 (count 0) positions first
)
1492 ;; Count the CLOCK lines and store their positions.
1494 (while (re-search-forward clock-re end t
)
1495 (let ((element (org-element-at-point)))
1496 (when (eq (org-element-type element
) 'clock
)
1497 (setq positions
(cons (line-beginning-position) positions
)
1498 count
(1+ count
))))))
1501 ;; Skip planning line and property drawer, if any.
1502 (org-end-of-meta-data)
1503 (unless (bolp) (insert "\n"))
1504 ;; Create a new drawer if necessary.
1505 (when (and org-clock-into-drawer
1506 (or (not (wholenump org-clock-into-drawer
))
1507 (< org-clock-into-drawer
2)))
1508 (let ((beg (point)))
1509 (insert ":" drawer
":\n:END:\n")
1510 (org-indent-region beg
(point))
1514 ;; When a clock drawer needs to be created because of the
1515 ;; number of clock items or simply if it is missing, collect
1516 ;; all clocks in the section and wrap them within the drawer.
1518 (and (wholenump org-clock-into-drawer
)
1519 (>= (1+ count
) org-clock-into-drawer
)))
1520 ;; Skip planning line and property drawer, if any.
1521 (org-end-of-meta-data)
1522 (let ((beg (point)))
1528 (org-trim (delete-and-extract-region
1529 (save-excursion (skip-chars-backward " \r\t\n")
1530 (line-beginning-position 2))
1531 (line-beginning-position 2)))))
1534 (let ((end (point-marker)))
1536 (save-excursion (insert ":" drawer
":\n"))
1538 (org-indent-region (point) end
)
1540 (unless org-log-states-order-reversed
1542 (beginning-of-line -
1))
1543 (set-marker end nil
))))
1544 (org-log-states-order-reversed (goto-char (car (last positions
))))
1545 (t (goto-char (car positions
))))))))
1548 (defun org-clock-out (&optional switch-to-state fail-quietly at-time
)
1549 "Stop the currently running clock.
1550 Throw an error if there is no running clock and FAIL-QUIETLY is nil.
1551 With a universal prefix, prompt for a state to switch the clocked out task
1552 to, overriding the existing value of `org-clock-out-switch-to-state'."
1555 (when (not (org-clocking-p))
1556 (setq global-mode-string
1557 (delq 'org-mode-line-string global-mode-string
))
1558 (setq frame-title-format org-frame-title-format-backup
)
1559 (force-mode-line-update)
1560 (if fail-quietly
(throw 'exit t
) (user-error "No active clock")))
1561 (let ((org-clock-out-switch-to-state
1563 (completing-read "Switch to state: "
1564 (with-current-buffer
1565 (marker-buffer org-clock-marker
)
1566 org-todo-keywords-1
)
1568 org-clock-out-switch-to-state
))
1569 (now (org-current-time org-clock-rounding-minutes
))
1571 (setq org-clock-out-time now
)
1572 (save-excursion ; Do not replace this with `with-current-buffer'.
1573 (org-no-warnings (set-buffer (org-clocking-buffer)))
1576 (goto-char org-clock-marker
)
1577 (beginning-of-line 1)
1578 (if (and (looking-at (concat "[ \t]*" org-keyword-time-regexp
))
1579 (equal (match-string 1) org-clock-string
))
1580 (setq ts
(match-string 2))
1581 (if fail-quietly
(throw 'exit nil
) (error "Clock start time is gone")))
1582 (goto-char (match-end 0))
1583 (delete-region (point) (point-at-eol))
1585 (setq te
(org-insert-time-stamp (or at-time now
) 'with-hm
'inactive
))
1586 (setq s
(- (org-float-time (apply 'encode-time
(org-parse-time-string te
)))
1587 (org-float-time (apply 'encode-time
(org-parse-time-string ts
))))
1588 h
(floor (/ s
3600))
1592 (insert " => " (format "%2d:%02d" h m
))
1593 (when (setq remove
(and org-clock-out-remove-zero-time-clocks
1595 (beginning-of-line 1)
1596 (delete-region (point) (point-at-eol))
1597 (and (looking-at "\n") (> (point-max) (1+ (point)))
1599 (move-marker org-clock-marker nil
)
1600 (move-marker org-clock-hd-marker nil
)
1601 (when org-log-note-clock-out
1602 (org-add-log-setup 'clock-out nil nil nil nil
1603 (concat "# Task: " (org-get-heading t
) "\n\n")))
1604 (when org-clock-mode-line-timer
1605 (cancel-timer org-clock-mode-line-timer
)
1606 (setq org-clock-mode-line-timer nil
))
1607 (when org-clock-idle-timer
1608 (cancel-timer org-clock-idle-timer
)
1609 (setq org-clock-idle-timer nil
))
1610 (setq global-mode-string
1611 (delq 'org-mode-line-string global-mode-string
))
1612 (setq frame-title-format org-frame-title-format-backup
)
1613 (when org-clock-out-switch-to-state
1615 (org-back-to-heading t
)
1616 (let ((org-inhibit-logging t
)
1617 (org-clock-out-when-done nil
))
1619 ((functionp org-clock-out-switch-to-state
)
1620 (looking-at org-complex-heading-regexp
)
1621 (let ((newstate (funcall org-clock-out-switch-to-state
1623 (if newstate
(org-todo newstate
))))
1624 ((and org-clock-out-switch-to-state
1625 (not (looking-at (concat org-outline-regexp
"[ \t]*"
1626 org-clock-out-switch-to-state
1628 (org-todo org-clock-out-switch-to-state
))))))
1629 (force-mode-line-update)
1630 (message (concat "Clock stopped at %s after "
1631 (org-minutes-to-clocksum-string (+ (* 60 h
) m
)) "%s")
1632 te
(if remove
" => LINE REMOVED" ""))
1633 (let ((h org-clock-out-hook
)
1634 (clock-drawer (org-clock-into-drawer)))
1635 ;; If a closing note needs to be stored in the drawer
1636 ;; where clocks are stored, let's temporarily disable
1637 ;; `org-clock-remove-empty-clock-drawer'.
1638 (if (and clock-drawer
1639 (not (stringp clock-drawer
))
1640 (org-log-into-drawer)
1641 (eq org-log-done
'note
)
1642 org-clock-out-when-done
)
1643 (setq h
(delq 'org-clock-remove-empty-clock-drawer h
)))
1644 (mapc (lambda (f) (funcall f
)) h
))
1645 (unless (org-clocking-p)
1646 (setq org-clock-current-task nil
)))))))
1648 (add-hook 'org-clock-out-hook
'org-clock-remove-empty-clock-drawer
)
1650 (defun org-clock-remove-empty-clock-drawer ()
1651 "Remove empty clock drawers in current subtree."
1653 (org-back-to-heading t
)
1656 (let ((drawer (org-clock-drawer-name))
1657 (case-fold-search t
))
1659 (let ((re (format "^[ \t]*:%s:[ \t]*$" (regexp-quote drawer
)))
1660 (end (save-excursion (outline-next-heading))))
1661 (while (re-search-forward re end t
)
1662 (org-remove-empty-drawer-at (point))))))))))
1664 (defun org-clock-timestamps-up (&optional n
)
1665 "Increase CLOCK timestamps at cursor.
1666 Optional argument N tells to change by that many units."
1668 (org-clock-timestamps-change 'up n
))
1670 (defun org-clock-timestamps-down (&optional n
)
1671 "Increase CLOCK timestamps at cursor.
1672 Optional argument N tells to change by that many units."
1674 (org-clock-timestamps-change 'down n
))
1676 (defun org-clock-timestamps-change (updown &optional n
)
1677 "Change CLOCK timestamps synchronously at cursor.
1678 UPDOWN tells whether to change `up' or `down'.
1679 Optional argument N tells to change by that many units."
1680 (setq org-ts-what nil
)
1681 (when (org-at-timestamp-p t
)
1682 (let ((tschange (if (eq updown
'up
) 'org-timestamp-up
1683 'org-timestamp-down
))
1684 ts1 begts1 ts2 begts2 updatets1 tdiff
)
1686 (move-beginning-of-line 1)
1687 (re-search-forward org-ts-regexp3 nil t
)
1688 (setq ts1
(match-string 0) begts1
(match-beginning 0))
1689 (when (re-search-forward org-ts-regexp3 nil t
)
1690 (setq ts2
(match-string 0) begts2
(match-beginning 0))))
1691 ;; Are we on the second timestamp?
1692 (if (<= begts2
(point)) (setq updatets1 t
))
1694 ;; fall back on org-timestamp-up if there is only one
1695 (funcall tschange n
)
1696 ;; setq this so that (boundp 'org-ts-what is non-nil)
1697 (funcall tschange n
)
1698 (let ((ts (if updatets1 ts2 ts1
))
1699 (begts (if updatets1 begts1 begts2
)))
1702 (org-time-string-to-time org-last-changed-timestamp
)
1703 (org-time-string-to-time ts
)))
1706 (org-timestamp-change
1707 (round (/ (org-float-time tdiff
)
1708 (cond ((eq org-ts-what
'minute
) 60)
1709 ((eq org-ts-what
'hour
) 3600)
1710 ((eq org-ts-what
'day
) (* 24 3600))
1711 ((eq org-ts-what
'month
) (* 24 3600 31))
1712 ((eq org-ts-what
'year
) (* 24 3600 365.2)))))
1713 org-ts-what
'updown
)))))))
1716 (defun org-clock-cancel ()
1717 "Cancel the running clock by removing the start timestamp."
1719 (when (not (org-clocking-p))
1720 (setq global-mode-string
1721 (delq 'org-mode-line-string global-mode-string
))
1722 (setq frame-title-format org-frame-title-format-backup
)
1723 (force-mode-line-update)
1724 (error "No active clock"))
1725 (save-excursion ; Do not replace this with `with-current-buffer'.
1726 (org-no-warnings (set-buffer (org-clocking-buffer)))
1727 (goto-char org-clock-marker
)
1728 (if (org-looking-back (concat "^[ \t]*" org-clock-string
".*")
1729 (line-beginning-position))
1730 (progn (delete-region (1- (point-at-bol)) (point-at-eol))
1731 (org-remove-empty-drawer-at (point)))
1732 (message "Clock gone, cancel the timer anyway")
1734 (move-marker org-clock-marker nil
)
1735 (move-marker org-clock-hd-marker nil
)
1736 (setq global-mode-string
1737 (delq 'org-mode-line-string global-mode-string
))
1738 (setq frame-title-format org-frame-title-format-backup
)
1739 (force-mode-line-update)
1740 (message "Clock canceled")
1741 (run-hooks 'org-clock-cancel-hook
))
1744 (defun org-clock-goto (&optional select
)
1745 "Go to the currently clocked-in entry, or to the most recently clocked one.
1746 With prefix arg SELECT, offer recently clocked tasks for selection."
1751 (or (org-clock-select-task "Select task to go to: ")
1752 (error "No task selected")))
1753 ((org-clocking-p) org-clock-marker
)
1754 ((and org-clock-goto-may-find-recent-task
1755 (car org-clock-history
)
1756 (marker-buffer (car org-clock-history
)))
1758 (car org-clock-history
))
1759 (t (error "No active or recent clock task")))))
1760 (org-pop-to-buffer-same-window (marker-buffer m
))
1761 (if (or (< m
(point-min)) (> m
(point-max))) (widen))
1764 (org-back-to-heading t
)
1765 (org-cycle-hide-drawers 'children
)
1766 (recenter org-clock-goto-before-context
)
1769 (message "No running clock, this is the most recently clocked task"))
1770 (run-hooks 'org-clock-goto-hook
)))
1772 (defvar org-clock-file-total-minutes nil
1773 "Holds the file total time in minutes, after a call to `org-clock-sum'.")
1774 (make-variable-buffer-local 'org-clock-file-total-minutes
)
1776 (defun org-clock-sum-today (&optional headline-filter
)
1777 "Sum the times for each subtree for today."
1778 (let ((range (org-clock-special-range 'today
)))
1779 (org-clock-sum (car range
) (cadr range
)
1780 headline-filter
:org-clock-minutes-today
)))
1782 (defun org-clock-sum-custom (&optional headline-filter range propname
)
1783 "Sum the times for each subtree for today."
1784 (let ((r (or (and (symbolp range
) (org-clock-special-range range
))
1785 (org-clock-special-range
1786 (intern (completing-read
1788 '("today" "yesterday" "thisweek" "lastweek"
1789 "thismonth" "lastmonth" "thisyear" "lastyear"
1792 (org-clock-sum (car r
) (cadr r
)
1793 headline-filter
(or propname
:org-clock-minutes-custom
))))
1796 (defun org-clock-sum (&optional tstart tend headline-filter propname
)
1797 "Sum the times for each subtree.
1798 Puts the resulting times in minutes as a text property on each headline.
1799 TSTART and TEND can mark a time range to be considered.
1800 HEADLINE-FILTER is a zero-arg function that, if specified, is called for
1801 each headline in the time range with point at the headline. Headlines for
1802 which HEADLINE-FILTER returns nil are excluded from the clock summation.
1803 PROPNAME lets you set a custom text property instead of :org-clock-minutes."
1804 (org-with-silent-modifications
1805 (let* ((re (concat "^\\(\\*+\\)[ \t]\\|^[ \t]*"
1807 "[ \t]*\\(?:\\(\\[.*?\\]\\)-+\\(\\[.*?\\]\\)\\|=>[ \t]+\\([0-9]+\\):\\([0-9]+\\)\\)"))
1809 (ltimes (make-vector lmax
0))
1814 (if (stringp tstart
) (setq tstart
(org-time-string-to-seconds tstart
)))
1815 (if (stringp tend
) (setq tend
(org-time-string-to-seconds tend
)))
1816 (if (consp tstart
) (setq tstart
(org-float-time tstart
)))
1817 (if (consp tend
) (setq tend
(org-float-time tend
)))
1818 (remove-text-properties (point-min) (point-max)
1819 `(,(or propname
:org-clock-minutes
) t
1820 :org-clock-force-headline-inclusion t
))
1822 (goto-char (point-max))
1823 (while (re-search-backward re nil t
)
1827 (setq ts
(match-string 2)
1830 (apply 'encode-time
(org-parse-time-string ts
)))
1832 (apply 'encode-time
(org-parse-time-string te
)))
1833 ts
(if tstart
(max ts tstart
) ts
)
1834 te
(if tend
(min te tend
) te
)
1836 t1
(if (> dt
0) (+ t1
(floor (/ dt
60))) t1
)))
1839 (setq t1
(+ t1
(string-to-number (match-string 5))
1840 (* 60 (string-to-number (match-string 4))))))
1842 ;; Add the currently clocking item time to the total
1843 (when (and org-clock-report-include-clocking-task
1844 (equal (org-clocking-buffer) (current-buffer))
1845 (equal (marker-position org-clock-hd-marker
) (point))
1848 (>= (org-float-time org-clock-start-time
) tstart
)
1849 (<= (org-float-time org-clock-start-time
) tend
))
1850 (let ((time (floor (- (org-float-time)
1851 (org-float-time org-clock-start-time
)) 60)))
1852 (setq t1
(+ t1 time
))))
1853 (let* ((headline-forced
1854 (get-text-property (point)
1855 :org-clock-force-headline-inclusion
))
1857 (or (null headline-filter
)
1859 (save-match-data (funcall headline-filter
))))))
1860 (setq level
(- (match-end 1) (match-beginning 1)))
1861 (when (>= level lmax
)
1862 (setq ltimes
(vconcat ltimes
(make-vector lmax
0)) lmax
(* 2 lmax
)))
1863 (when (or (> t1
0) (> (aref ltimes level
) 0))
1864 (when (or headline-included headline-forced
)
1865 (if headline-included
1866 (loop for l from
0 to level do
1867 (aset ltimes l
(+ (aref ltimes l
) t1
))))
1868 (setq time
(aref ltimes level
))
1869 (goto-char (match-beginning 0))
1870 (put-text-property (point) (point-at-eol)
1871 (or propname
:org-clock-minutes
) time
)
1876 (> (funcall outline-level
) 1)
1877 (outline-up-heading 1 t
)
1879 (point) (point-at-eol)
1880 :org-clock-force-headline-inclusion t
))))))
1882 (loop for l from level to
(1- lmax
) do
1883 (aset ltimes l
0)))))))
1884 (setq org-clock-file-total-minutes
(aref ltimes
0))))))
1886 (defun org-clock-sum-current-item (&optional tstart
)
1887 "Return time, clocked on current item in total."
1890 (org-narrow-to-subtree)
1891 (org-clock-sum tstart
)
1892 org-clock-file-total-minutes
)))
1895 (defun org-clock-display (&optional arg
)
1896 "Show subtree times in the entire buffer.
1898 By default, show the total time for the range defined in
1899 `org-clock-display-default-range'. With \\[universal-argument] \
1901 the total time for today instead. With \\[universal-argument] \
1902 \\[universal-argument] prefix, use
1903 a custom range, entered at the prompt. With \\[universal-argument] \
1904 \\[universal-argument] \\[universal-argument]
1905 prefix, display the total time in the echo area.
1907 Use \\[org-clock-remove-overlays] to remove the subtree times."
1909 (org-clock-remove-overlays)
1910 (let* ((todayp (equal arg
'(4)))
1911 (customp (member arg
'((16) today yesterday
1912 thisweek lastweek thismonth
1913 lastmonth thisyear lastyear
1914 untilnow interactive
)))
1915 (prop (cond ((not arg
) :org-clock-minutes-default
)
1916 (todayp :org-clock-minutes-today
)
1917 (customp :org-clock-minutes-custom
)
1918 (t :org-clock-minutes
)))
1920 (cond ((not arg
) (org-clock-sum-custom
1921 nil org-clock-display-default-range prop
))
1922 (todayp (org-clock-sum-today))
1923 (customp (org-clock-sum-custom nil arg
))
1924 (t (org-clock-sum)))
1925 (unless (eq arg
'(64))
1927 (goto-char (point-min))
1928 (while (or (and (equal (setq p
(point)) (point-min))
1929 (get-text-property p prop
))
1930 (setq p
(next-single-property-change
1933 (when (setq time
(get-text-property p prop
))
1934 (org-clock-put-overlay time
)))
1935 (setq h
(/ org-clock-file-total-minutes
60)
1936 m
(- org-clock-file-total-minutes
(* 60 h
)))
1937 ;; Arrange to remove the overlays upon next change.
1938 (when org-remove-highlights-with-change
1939 (org-add-hook 'before-change-functions
'org-clock-remove-overlays
1941 (message (concat (format "Total file time%s: "
1942 (cond (todayp " for today")
1943 (customp " (custom)")
1945 (org-minutes-to-clocksum-string
1946 org-clock-file-total-minutes
)
1947 " (%d hours and %d minutes)")
1950 (defvar org-clock-overlays nil
)
1951 (make-variable-buffer-local 'org-clock-overlays
)
1953 (defun org-clock-put-overlay (time)
1954 "Put an overlays on the current line, displaying TIME.
1955 This creates a new overlay and stores it in `org-clock-overlays', so that it
1956 will be easy to remove."
1959 (when (looking-at org-complex-heading-regexp
)
1960 (goto-char (match-beginning 4)))
1961 (setq ov
(make-overlay (point) (point-at-eol))
1962 tx
(concat (buffer-substring-no-properties (point) (match-end 4))
1965 (max 0 (- (- 60 (current-column))
1966 (- (match-end 4) (match-beginning 4))
1967 (length (org-get-at-bol 'line-prefix
)))) ?·
)
1970 (format " %9s " (org-minutes-to-clocksum-string time
))
1971 '(face org-clock-overlay
))
1973 (if (not (featurep 'xemacs
))
1974 (overlay-put ov
'display tx
)
1975 (overlay-put ov
'invisible t
)
1976 (overlay-put ov
'end-glyph
(make-glyph tx
)))
1977 (push ov org-clock-overlays
)))
1980 (defun org-clock-remove-overlays (&optional beg end noremove
)
1981 "Remove the occur highlights from the buffer.
1982 BEG and END are ignored. If NOREMOVE is nil, remove this function
1983 from the `before-change-functions' in the current buffer."
1985 (unless org-inhibit-highlight-removal
1986 (mapc 'delete-overlay org-clock-overlays
)
1987 (setq org-clock-overlays nil
)
1989 (remove-hook 'before-change-functions
1990 'org-clock-remove-overlays
'local
))))
1992 (defvar org-state
) ;; dynamically scoped into this function
1993 (defun org-clock-out-if-current ()
1994 "Clock out if the current entry contains the running clock.
1995 This is used to stop the clock after a TODO entry is marked DONE,
1996 and is only done if the variable `org-clock-out-when-done' is not nil."
1997 (when (and (org-clocking-p)
1998 org-clock-out-when-done
1999 (marker-buffer org-clock-marker
)
2000 (or (and (eq t org-clock-out-when-done
)
2001 (member org-state org-done-keywords
))
2002 (and (listp org-clock-out-when-done
)
2003 (member org-state org-clock-out-when-done
)))
2004 (equal (or (buffer-base-buffer (org-clocking-buffer))
2005 (org-clocking-buffer))
2006 (or (buffer-base-buffer (current-buffer))
2008 (< (point) org-clock-marker
)
2009 (> (save-excursion (outline-next-heading) (point))
2011 ;; Clock out, but don't accept a logging message for this.
2012 (let ((org-log-note-clock-out nil
)
2013 (org-clock-out-switch-to-state nil
))
2016 (add-hook 'org-after-todo-state-change-hook
2017 'org-clock-out-if-current
)
2020 (defun org-clock-get-clocktable (&rest props
)
2021 "Get a formatted clocktable with parameters according to PROPS.
2022 The table is created in a temporary buffer, fully formatted and
2023 fontified, and then returned."
2025 (setq props
(plist-put props
:name
"clocktable"))
2026 (unless (plist-member props
:maxlevel
)
2027 (setq props
(plist-put props
:maxlevel
2)))
2028 (unless (plist-member props
:scope
)
2029 (setq props
(plist-put props
:scope
'agenda
)))
2032 (org-create-dblock props
)
2034 (org-font-lock-ensure)
2036 (buffer-substring (point) (progn
2037 (re-search-forward "^[ \t]*#\\+END" nil t
)
2041 (defun org-clock-report (&optional arg
)
2042 "Create a table containing a report about clocked time.
2043 If the cursor is inside an existing clocktable block, then the table
2044 will be updated. If not, a new clocktable will be inserted. The scope
2045 of the new clock will be subtree when called from within a subtree, and
2048 When called with a prefix argument, move to the first clock table in the
2049 buffer and update it."
2051 (org-clock-remove-overlays)
2053 (org-find-dblock "clocktable")
2055 (if (org-in-clocktable-p)
2056 (goto-char (org-in-clocktable-p))
2057 (let ((props (if (ignore-errors
2058 (save-excursion (org-back-to-heading)))
2059 (list :name
"clocktable" :scope
'subtree
)
2060 (list :name
"clocktable"))))
2062 (org-combine-plists org-clock-clocktable-default-properties props
))))
2063 (org-update-dblock))
2065 (defun org-day-of-week (day month year
)
2066 "Returns the day of the week as an integer."
2070 (format "%d-%02d-%02dT00:00:00" year month day
)))))
2072 (defun org-quarter-to-date (quarter year
)
2073 "Get the date (week day year) of the first day of a given quarter."
2077 (setq startday
(org-day-of-week 1 1 year
))
2080 (list 52 7 (- year
1)))
2082 (list 52 6 (- year
1)))
2084 (list 1 startday year
))
2086 (list 53 startday
(- year
1)))
2090 (setq startday
(org-day-of-week 1 4 year
))
2093 (list 13 startday year
))
2095 (list 14 startday year
))
2097 (list 13 startday year
))
2101 (setq startday
(org-day-of-week 1 7 year
))
2104 (list 26 startday year
))
2106 (list 27 startday year
))
2108 (list 26 startday year
))
2112 (setq startday
(org-day-of-week 1 10 year
))
2115 (list 39 startday year
))
2117 (list 40 startday year
))
2119 (list 39 startday year
)))))))
2121 (defun org-clock-special-range (key &optional time as-strings wstart mstart
)
2122 "Return two times bordering a special time range.
2124 KEY is a symbol specifying the range and can be one of `today',
2125 `yesterday', `thisweek', `lastweek', `thismonth', `lastmonth',
2126 `thisyear', `lastyear' or `untilnow'. If set to `interactive',
2127 user is prompted for range boundaries. It can be a string or an
2130 By default, a week starts Monday 0:00 and ends Sunday 24:00. The
2131 range is determined relative to TIME, which defaults to current
2134 The return value is a list containing two internal times, one for
2135 the beginning of the range and one for its end, like the ones
2136 returned by `current time' or `encode-time' and a string used to
2137 display information. If AS-STRINGS is non-nil, the returned
2138 times will be formatted strings.
2140 If WSTART is non-nil, use this number to specify the starting day
2141 of a week (monday is 1). If MSTART is non-nil, use this number
2142 to specify the starting day of a month (1 is the first day of the
2143 month). If you can combine both, the month starting day will
2145 (let* ((tm (decode-time time
))
2152 (skey (format "%s" key
))
2154 (q (cond ((>= month
10) 4)
2158 m1 h1 d1 month1 y1 shiftedy shiftedm shiftedq
)
2160 ((string-match "\\`[0-9]+\\'" skey
)
2161 (setq y
(string-to-number skey
) month
1 d
1 key
'year
))
2162 ((string-match "\\`\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)\\'" skey
)
2163 (setq y
(string-to-number (match-string 1 skey
))
2164 month
(string-to-number (match-string 2 skey
))
2167 ((string-match "\\`\\([0-9]+\\)-[wW]\\([0-9]\\{1,2\\}\\)\\'" skey
)
2169 (let ((date (calendar-gregorian-from-absolute
2170 (calendar-iso-to-absolute
2171 (list (string-to-number (match-string 2 skey
))
2173 (string-to-number (match-string 1 skey
)))))))
2174 (setq d
(nth 1 date
)
2179 ((string-match "\\`\\([0-9]+\\)-[qQ]\\([1-4]\\)\\'" skey
)
2181 (setq q
(string-to-number (match-string 2 skey
)))
2182 (let ((date (calendar-gregorian-from-absolute
2183 (calendar-iso-to-absolute
2184 (org-quarter-to-date
2185 q
(string-to-number (match-string 1 skey
)))))))
2186 (setq d
(nth 1 date
)
2192 "\\`\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)-\\([0-9]\\{1,2\\}\\)\\'"
2194 (setq y
(string-to-number (match-string 1 skey
))
2195 month
(string-to-number (match-string 2 skey
))
2196 d
(string-to-number (match-string 3 skey
))
2198 ((string-match "\\([-+][0-9]+\\)\\'" skey
)
2199 (setq shift
(string-to-number (match-string 1 skey
))
2200 key
(intern (substring skey
0 (match-beginning 1))))
2201 (when (and (memq key
'(quarter thisq
)) (> shift
0))
2202 (error "Looking forward with quarters isn't implemented"))))
2205 (yesterday (setq key
'today shift -
1))
2206 (lastweek (setq key
'week shift -
1))
2207 (lastmonth (setq key
'month shift -
1))
2208 (lastyear (setq key
'year shift -
1))
2209 (lastq (setq key
'quarter shift -
1))))
2210 ;; Prepare start and end times depending on KEY's type.
2212 ((day today
) (setq m
0 h
0 h1
24 d
(+ d shift
)))
2214 (let* ((ws (or wstart
1))
2215 (diff (+ (* -
7 shift
) (if (= dow
0) (- 7 ws
) (- dow ws
)))))
2216 (setq m
0 h
0 d
(- d diff
) d1
(+ 7 d
))))
2218 (setq h
0 m
0 d
(or mstart
1) month
(+ month shift
) month1
(1+ month
)))
2220 ;; Compute if this shift remains in this year. If not, compute
2221 ;; how many years and quarters we have to shift (via floor*) and
2222 ;; compute the shifted years, months and quarters.
2224 ((< (+ (- q
1) shift
) 0) ; Shift not in this year.
2225 (let* ((interval (* -
1 (+ (- q
1) shift
)))
2226 ;; Set tmp to ((years to shift) (quarters to shift)).
2227 (tmp (org-floor* interval
4)))
2228 ;; Due to the use of floor, 0 quarters actually means 4.
2229 (if (= 0 (nth 1 tmp
))
2230 (setq shiftedy
(- y
(nth 0 tmp
))
2233 (setq shiftedy
(- y
(+ 1 (nth 0 tmp
)))
2234 shiftedm
(- 13 (* 3 (nth 1 tmp
)))
2235 shiftedq
(- 5 (nth 1 tmp
)))))
2236 (setq m
0 h
0 d
1 month shiftedm month1
(+ 3 shiftedm
) y shiftedy
))
2237 ((> (+ q shift
) 0) ; Shift is within this year.
2238 (setq shiftedq
(+ q shift
))
2240 (let ((qshift (* 3 (1- (+ q shift
)))))
2241 (setq m
0 h
0 d
1 month
(+ 1 qshift
) month1
(+ 4 qshift
))))))
2243 (setq m
0 h
0 d
1 month
1 y
(+ y shift
) y1
(1+ y
)))
2244 ((interactive untilnow
)) ; Special cases, ignore them.
2245 (t (user-error "No such time block %s" key
)))
2246 ;; Format start and end times according to AS-STRINGS.
2247 (let* ((start (case key
2248 (interactive (org-read-date nil t nil
"Range start? "))
2249 (untilnow org-clock--oldest-date
)
2250 (t (encode-time 0 m h d month y
))))
2252 (interactive (org-read-date nil t nil
"Range end? "))
2253 (untilnow (current-time))
2262 ((day today
) (format-time-string "%A, %B %d, %Y" start
))
2263 ((week thisweek
) (format-time-string "week %G-W%V" start
))
2264 ((month thismonth
) (format-time-string "%B %Y" start
))
2265 ((year thisyear
) (format-time-string "the year %Y" start
))
2267 (concat (org-count-quarter shiftedq
)
2268 " quarter of " (number-to-string shiftedy
)))
2269 (interactive "(Range interactively set)")
2271 (if (not as-strings
) (list start end text
)
2272 (let ((f (cdr org-time-stamp-formats
)))
2273 (list (format-time-string f start
)
2274 (format-time-string f end
)
2277 (defun org-count-quarter (n)
2285 (defun org-clocktable-shift (dir n
)
2286 "Try to shift the :block date of the clocktable at point.
2287 Point must be in the #+BEGIN: line of a clocktable, or this function
2288 will throw an error.
2289 DIR is a direction, a symbol `left', `right', `up', or `down'.
2290 Both `left' and `down' shift the block toward the past, `up' and `right'
2291 push it toward the future.
2292 N is the number of shift steps to take. The size of the step depends on
2293 the currently selected interval size."
2294 (setq n
(prefix-numeric-value n
))
2295 (and (memq dir
'(left down
)) (setq n
(- n
)))
2297 (goto-char (point-at-bol))
2298 (if (not (looking-at "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>.*?:block[ \t]+\\(\\S-+\\)"))
2299 (error "Line needs a :block definition before this command works")
2300 (let* ((b (match-beginning 1)) (e (match-end 1))
2301 (s (match-string 1))
2302 block shift ins y mw d date wp m
)
2304 ((equal s
"yesterday") (setq s
"today-1"))
2305 ((equal s
"lastweek") (setq s
"thisweek-1"))
2306 ((equal s
"lastmonth") (setq s
"thismonth-1"))
2307 ((equal s
"lastyear") (setq s
"thisyear-1"))
2308 ((equal s
"lastq") (setq s
"thisq-1")))
2311 ((string-match "^\\(today\\|thisweek\\|thismonth\\|thisyear\\|thisq\\)\\([-+][0-9]+\\)?$" s
)
2312 (setq block
(match-string 1 s
)
2313 shift
(if (match-end 2)
2314 (string-to-number (match-string 2 s
))
2316 (setq shift
(+ shift n
))
2317 (setq ins
(if (= shift
0) block
(format "%s%+d" block shift
))))
2318 ((string-match "\\([0-9]+\\)\\(-\\([wWqQ]?\\)\\([0-9]\\{1,2\\}\\)\\(-\\([0-9]\\{1,2\\}\\)\\)?\\)?" s
)
2319 ;; 1 1 2 3 3 4 4 5 6 6 5 2
2320 (setq y
(string-to-number (match-string 1 s
))
2321 wp
(and (match-end 3) (match-string 3 s
))
2322 mw
(and (match-end 4) (string-to-number (match-string 4 s
)))
2323 d
(and (match-end 6) (string-to-number (match-string 6 s
))))
2325 (d (setq ins
(format-time-string
2327 (encode-time 0 0 0 (+ d n
) m y
))))
2328 ((and wp
(string-match "w\\|W" wp
) mw
(> (length wp
) 0))
2330 (setq date
(calendar-gregorian-from-absolute
2331 (calendar-iso-to-absolute (list (+ mw n
) 1 y
))))
2332 (setq ins
(format-time-string
2334 (encode-time 0 0 0 (nth 1 date
) (car date
) (nth 2 date
)))))
2335 ((and wp
(string-match "q\\|Q" wp
) mw
(> (length wp
) 0))
2337 ; if the 4th + 1 quarter is requested we flip to the 1st quarter of the next year
2342 ; if the 1st - 1 quarter is requested we flip to the 4th quarter of the previous year
2347 (setq date
(calendar-gregorian-from-absolute
2348 (calendar-iso-to-absolute (org-quarter-to-date (+ mw n
) y
))))
2349 (setq ins
(format-time-string
2350 (concat (number-to-string y
) "-Q" (number-to-string (+ mw n
)))
2351 (encode-time 0 0 0 (nth 1 date
) (car date
) (nth 2 date
)))))
2353 (setq ins
(format-time-string
2355 (encode-time 0 0 0 1 (+ mw n
) y
))))
2357 (setq ins
(number-to-string (+ y n
))))))
2358 (t (error "Cannot shift clocktable block")))
2362 (delete-region (point) (+ (point) (- e b
)))
2363 (beginning-of-line 1)
2368 (defun org-dblock-write:clocktable
(params)
2369 "Write the standard clocktable."
2370 (setq params
(org-combine-plists org-clocktable-defaults params
))
2372 (let* ((scope (plist-get params
:scope
))
2373 (block (plist-get params
:block
))
2374 (ts (plist-get params
:tstart
))
2375 (te (plist-get params
:tend
))
2376 (link (plist-get params
:link
))
2377 (maxlevel (or (plist-get params
:maxlevel
) 3))
2378 (ws (plist-get params
:wstart
))
2379 (ms (plist-get params
:mstart
))
2380 (step (plist-get params
:step
))
2381 (timestamp (plist-get params
:timestamp
))
2382 (formatter (or (plist-get params
:formatter
)
2383 org-clock-clocktable-formatter
2384 'org-clocktable-write-default
))
2385 cc range-text ipos pos one-file-with-archives
2386 scope-is-list tbls level
)
2387 ;; Check if we need to do steps
2389 ;; Get the range text for the header
2390 (setq cc
(org-clock-special-range block nil t ws ms
)
2391 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2393 ;; Write many tables, in steps
2394 (unless (or block
(and ts te
))
2395 (error "Clocktable `:step' can only be used with `:block' or `:tstart,:end'"))
2396 (org-clocktable-steps params
)
2399 (setq ipos
(point)) ; remember the insertion position
2401 ;; Get the right scope
2404 ((and scope
(listp scope
) (symbolp (car scope
)))
2405 (setq scope
(eval scope
)))
2407 (setq scope
(org-agenda-files t
)))
2408 ((eq scope
'agenda-with-archives
)
2409 (setq scope
(org-agenda-files t
))
2410 (setq scope
(org-add-archive-files scope
)))
2411 ((eq scope
'file-with-archives
)
2412 (setq scope
(and buffer-file-name
2413 (org-add-archive-files (list buffer-file-name
)))
2414 one-file-with-archives t
)))
2415 (setq scope-is-list
(and scope
(listp scope
)))
2417 ;; we collect from several files
2418 (let* ((files scope
)
2420 (org-agenda-prepare-buffers files
)
2421 (while (setq file
(pop files
))
2422 (with-current-buffer (find-buffer-visiting file
)
2425 (push (org-clock-get-table-data file params
) tbls
))))))
2426 ;; Just from the current file
2428 ;; get the right range into the restriction
2429 (org-agenda-prepare-buffers (list (or (buffer-file-name)
2432 ((not scope
)) ; use the restriction as it is now
2433 ((eq scope
'file
) (widen))
2434 ((eq scope
'subtree
) (org-narrow-to-subtree))
2436 (while (org-up-heading-safe))
2437 (org-narrow-to-subtree))
2438 ((and (symbolp scope
) (string-match "^tree\\([0-9]+\\)$"
2439 (symbol-name scope
)))
2440 (setq level
(string-to-number (match-string 1 (symbol-name scope
))))
2442 (while (org-up-heading-safe)
2443 (looking-at org-outline-regexp
)
2444 (if (<= (org-reduced-level (funcall outline-level
)) level
)
2445 (throw 'exit nil
))))
2446 (org-narrow-to-subtree)))
2447 ;; do the table, with no file name.
2448 (push (org-clock-get-table-data nil params
) tbls
)))
2450 ;; OK, at this point we tbls as a list of tables, one per file
2451 (setq tbls
(nreverse tbls
))
2453 (setq params
(plist-put params
:multifile scope-is-list
))
2454 (setq params
(plist-put params
:one-file-with-archives
2455 one-file-with-archives
))
2457 (funcall formatter ipos tbls params
))))
2459 (defun org-clocktable-write-default (ipos tables params
)
2460 "Write out a clock table at position IPOS in the current buffer.
2461 TABLES is a list of tables with clocking data as produced by
2462 `org-clock-get-table-data'. PARAMS is the parameter property list obtained
2463 from the dynamic block definition."
2464 ;; This function looks quite complicated, mainly because there are a
2465 ;; lot of options which can add or remove columns. I have massively
2466 ;; commented this function, the I hope it is understandable. If
2467 ;; someone wants to write their own special formatter, this maybe
2468 ;; much easier because there can be a fixed format with a
2469 ;; well-defined number of columns...
2470 (let* ((hlchars '((1 .
"*") (2 .
"/")))
2471 (lwords (assoc (or (plist-get params
:lang
)
2472 (org-bound-and-true-p org-export-default-language
)
2474 org-clock-clocktable-language-setup
))
2475 (multifile (plist-get params
:multifile
))
2476 (block (plist-get params
:block
))
2477 (sort (plist-get params
:sort
))
2478 (ts (plist-get params
:tstart
))
2479 (te (plist-get params
:tend
))
2480 (header (plist-get params
:header
))
2481 (narrow (plist-get params
:narrow
))
2482 (ws (or (plist-get params
:wstart
) 1))
2483 (ms (or (plist-get params
:mstart
) 1))
2484 (link (plist-get params
:link
))
2485 (maxlevel (or (plist-get params
:maxlevel
) 3))
2486 (emph (plist-get params
:emphasize
))
2487 (level-p (plist-get params
:level
))
2488 (org-time-clocksum-use-effort-durations
2489 (plist-get params
:effort-durations
))
2490 (timestamp (plist-get params
:timestamp
))
2491 (properties (plist-get params
:properties
))
2492 (ntcol (max 1 (or (plist-get params
:tcolumns
) 100)))
2493 (rm-file-column (plist-get params
:one-file-with-archives
))
2494 (indent (plist-get params
:indent
))
2495 (case-fold-search t
)
2496 range-text total-time tbl level hlc formula pcol
2497 file-time entries entry headline
2498 recalc content narrow-cut-p tcol
)
2500 ;; Implement abbreviations
2501 (when (plist-get params
:compact
)
2502 (setq level nil indent t narrow
(or narrow
'40!) ntcol
1))
2504 ;; Some consistency test for parameters
2505 (unless (integerp ntcol
)
2506 (setq params
(plist-put params
:tcolumns
(setq ntcol
100))))
2508 (when (and narrow
(integerp narrow
) link
)
2509 ;; We cannot have both integer narrow and link
2511 "Using hard narrowing in clocktable to allow for links")
2512 (setq narrow
(intern (format "%d!" narrow
))))
2517 ((and (symbolp narrow
)
2518 (string-match "\\`[0-9]+!\\'" (symbol-name narrow
)))
2519 (setq narrow-cut-p t
2520 narrow
(string-to-number (substring (symbol-name narrow
)
2523 (error "Invalid value %s of :narrow property in clock table"
2527 ;; Get the range text for the header
2528 (setq range-text
(nth 2 (org-clock-special-range block nil t ws ms
))))
2530 ;; Compute the total time
2531 (setq total-time
(apply '+ (mapcar 'cadr tables
)))
2533 ;; Now we need to output this tsuff
2536 ;; Insert the text *before* the actual table
2537 (insert-before-markers
2539 ;; Format the standard header
2544 (format-time-string (cdr org-time-stamp-formats
))
2547 (if block
(concat ", for " range-text
".") "")
2550 ;; Insert the narrowing line
2551 (when (and narrow
(integerp narrow
) (not narrow-cut-p
))
2552 (insert-before-markers
2553 "|" ; table line starter
2554 (if multifile
"|" "") ; file column, maybe
2555 (if level-p
"|" "") ; level column, maybe
2556 (if timestamp
"|" "") ; timestamp column, maybe
2557 (if properties
(make-string (length properties
) ?|
) "") ;properties columns, maybe
2558 (format "<%d>| |\n" narrow
))) ; headline and time columns
2560 ;; Insert the table header line
2561 (insert-before-markers
2562 "|" ; table line starter
2563 (if multifile
(concat (nth 1 lwords
) "|") "") ; file column, maybe
2564 (if level-p
(concat (nth 2 lwords
) "|") "") ; level column, maybe
2565 (if timestamp
(concat (nth 3 lwords
) "|") "") ; timestamp column, maybe
2566 (if properties
(concat (mapconcat 'identity properties
"|") "|") "") ;properties columns, maybe
2567 (concat (nth 4 lwords
) "|"
2568 (nth 5 lwords
) "|\n")) ; headline and time columns
2570 ;; Insert the total time in the table
2571 (insert-before-markers
2573 "|" ; table line starter
2574 (if multifile
(concat "| " (nth 6 lwords
) " ") "")
2575 ; file column, maybe
2576 (if level-p
"|" "") ; level column, maybe
2577 (if timestamp
"|" "") ; timestamp column, maybe
2578 (if properties
(make-string (length properties
) ?|
) "") ; properties columns, maybe
2579 (concat (format org-clock-total-time-cell-format
(nth 7 lwords
)) "| ") ; instead of a headline
2580 (format org-clock-total-time-cell-format
2581 (org-minutes-to-clocksum-string (or total-time
0))) ; the time
2584 ;; Now iterate over the tables and insert the data
2585 ;; but only if any time has been collected
2586 (when (and total-time
(> total-time
0))
2588 (while (setq tbl
(pop tables
))
2589 ;; now tbl is the table resulting from one file.
2590 (setq file-time
(nth 1 tbl
))
2591 (when (or (and file-time
(> file-time
0))
2592 (not (plist-get params
:fileskip0
)))
2593 (insert-before-markers "|-\n") ; a hline because a new file starts
2594 ;; First the file time, if we have multiple files
2596 ;; Summarize the time collected from this file
2597 (insert-before-markers
2598 (format (concat "| %s %s | %s%s"
2599 (format org-clock-file-time-cell-format
(nth 8 lwords
))
2601 (file-name-nondirectory (car tbl
))
2602 (if level-p
"| " "") ; level column, maybe
2603 (if timestamp
"| " "") ; timestamp column, maybe
2604 (if properties
(make-string (length properties
) ?|
) "") ;properties columns, maybe
2605 (org-minutes-to-clocksum-string (nth 1 tbl
))))) ; the time
2607 ;; Get the list of node entries and iterate over it
2608 (setq entries
(nth 2 tbl
))
2609 (while (setq entry
(pop entries
))
2610 (setq level
(car entry
)
2611 headline
(nth 1 entry
)
2612 hlc
(if emph
(or (cdr (assoc level hlchars
)) "") ""))
2614 (if (and (string-match (concat "\\`" org-bracket-link-regexp
2619 (format "[[%s][%s]]"
2620 (match-string 1 headline
)
2621 (org-shorten-string (match-string 3 headline
)
2623 (setq headline
(org-shorten-string headline narrow
))))
2624 (insert-before-markers
2625 "|" ; start the table line
2626 (if multifile
"|" "") ; free space for file name column?
2627 (if level-p
(format "%d|" (car entry
)) "") ; level, maybe
2628 (if timestamp
(concat (nth 2 entry
) "|") "") ; timestamp, maybe
2632 (lambda (p) (or (cdr (assoc p
(nth 4 entry
))) ""))
2633 properties
"|") "|") "") ;properties columns, maybe
2634 (if indent
(org-clocktable-indent-string level
) "") ; indentation
2635 hlc headline hlc
"|" ; headline
2636 (make-string (min (1- ntcol
) (or (- level
1))) ?|
)
2637 ; empty fields for higher levels
2638 hlc
(org-minutes-to-clocksum-string (nth 3 entry
)) hlc
; time
2641 ;; When exporting subtrees or regions the region might be
2642 ;; activated, so let's disable ̀delete-active-region'
2643 (let ((delete-active-region nil
)) (backward-delete-char 1))
2644 (if (setq formula
(plist-get params
:formula
))
2647 ;; compute the column where the % numbers need to go
2653 (min maxlevel
(or ntcol
100))))
2654 ;; compute the column where the total time is
2659 (if timestamp
1 0)))
2662 "\n#+TBLFM: $%d='(org-clock-time%% @%d$%d $%d..$%d);%%.1f"
2663 pcol
; the column where the % numbers should go
2664 (if (and narrow
(not narrow-cut-p
)) 3 2) ; row of the total time
2665 tcol
; column of the total time
2666 tcol
(1- pcol
) ; range of columns where times can be found
2670 (insert "\n#+TBLFM: " formula
)
2672 (t (error "Invalid formula in clocktable")))
2673 ;; Should we rescue an old formula?
2674 (when (stringp (setq content
(plist-get params
:content
)))
2675 (when (string-match "^\\([ \t]*#\\+tblfm:.*\\)" content
)
2677 (insert "\n" (match-string 1 (plist-get params
:content
)))
2678 (beginning-of-line 0))))
2679 ;; Back to beginning, align the table, recalculate if necessary
2681 (skip-chars-forward "^|")
2683 (when org-hide-emphasis-markers
2684 ;; we need to align a second time
2688 (org-table-goto-line 3)
2689 (org-table-goto-column (car sort
))
2690 (org-table-sort-lines nil
(cdr sort
))))
2694 (if (and narrow
(not narrow-cut-p
)) (beginning-of-line 2))
2695 (org-table-goto-column pcol nil
'force
)
2697 (org-table-recalculate 'all
))
2698 (when rm-file-column
2699 ;; The file column is actually not wanted
2701 (org-table-delete-column))
2704 (defun org-clocktable-indent-string (level)
2705 "Return indentation string according to LEVEL.
2706 LEVEL is an integer. Indent by two spaces per level above 1."
2708 (concat "\\_" (make-string (* 2 (1- level
)) ?\s
))))
2710 (defun org-clocktable-steps (params)
2711 "Step through the range to make a number of clock tables."
2712 (let* ((p1 (copy-sequence params
))
2713 (ts (plist-get p1
:tstart
))
2714 (te (plist-get p1
:tend
))
2715 (ws (plist-get p1
:wstart
))
2716 (ms (plist-get p1
:mstart
))
2717 (step0 (plist-get p1
:step
))
2718 (step (cdr (assoc step0
'((day .
86400) (week .
604800)))))
2719 (stepskip0 (plist-get p1
:stepskip0
))
2720 (block (plist-get p1
:block
))
2721 cc range-text step-time tsb
)
2723 (setq cc
(org-clock-special-range block nil t ws ms
)
2724 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2727 ;; If ts is a number, it's an absolute day number from org-agenda.
2728 (destructuring-bind (month day year
) (calendar-gregorian-from-absolute ts
)
2729 (setq ts
(org-float-time (encode-time 0 0 0 day month year
)))))
2731 (setq ts
(org-float-time
2732 (apply 'encode-time
(org-parse-time-string ts
))))))
2736 (destructuring-bind (month day year
) (calendar-gregorian-from-absolute te
)
2737 (setq te
(org-float-time (encode-time 0 0 0 day month year
)))))
2739 (setq te
(org-float-time
2740 (apply 'encode-time
(org-parse-time-string te
))))))
2742 (if (eq step0
'week
)
2743 (- ts
(* 86400 (- (nth 6 (decode-time (seconds-to-time ts
))) ws
)))
2745 (setq p1
(plist-put p1
:header
""))
2746 (setq p1
(plist-put p1
:step nil
))
2747 (setq p1
(plist-put p1
:block nil
))
2749 (or (bolp) (insert "\n"))
2750 (setq p1
(plist-put p1
:tstart
(format-time-string
2751 (org-time-stamp-format nil t
)
2752 (seconds-to-time (max tsb ts
)))))
2753 (setq p1
(plist-put p1
:tend
(format-time-string
2754 (org-time-stamp-format nil t
)
2755 (seconds-to-time (min te
(setq tsb
(+ tsb step
)))))))
2756 (insert "\n" (if (eq step0
'day
) "Daily report: "
2757 "Weekly report starting on: ")
2758 (plist-get p1
:tstart
) "\n")
2759 (setq step-time
(org-dblock-write:clocktable p1
))
2760 (re-search-forward "^[ \t]*#\\+END:")
2761 (when (and (equal step-time
0) stepskip0
)
2762 ;; Remove the empty table
2763 (delete-region (point-at-bol)
2765 (re-search-backward "^\\(Daily\\|Weekly\\) report"
2770 (defun org-clock-get-table-data (file params
)
2771 "Get the clocktable data for file FILE, with parameters PARAMS.
2772 FILE is only for identification - this function assumes that
2773 the correct buffer is current, and that the wanted restriction is
2775 The return value will be a list with the file name and the total
2776 file time (in minutes) as 1st and 2nd elements. The third element
2777 of this list will be a list of headline entries. Each entry has the
2778 following structure:
2780 (LEVEL HEADLINE TIMESTAMP TIME)
2782 LEVEL: The level of the headline, as an integer. This will be
2783 the reduced leve, so 1,2,3,... even if only odd levels
2785 HEADLINE: The text of the headline. Depending on PARAMS, this may
2786 already be formatted like a link.
2787 TIMESTAMP: If PARAMS require it, this will be a time stamp found in the
2788 entry, any of SCHEDULED, DEADLINE, NORMAL, or first inactive,
2790 TIME: The sum of all time spend in this tree, in minutes. This time
2791 will of cause be restricted to the time block and tags match
2792 specified in PARAMS."
2793 (let* ((maxlevel (or (plist-get params
:maxlevel
) 3))
2794 (timestamp (plist-get params
:timestamp
))
2795 (ts (plist-get params
:tstart
))
2796 (te (plist-get params
:tend
))
2797 (ws (plist-get params
:wstart
))
2798 (ms (plist-get params
:mstart
))
2799 (block (plist-get params
:block
))
2800 (link (plist-get params
:link
))
2801 (tags (plist-get params
:tags
))
2802 (properties (plist-get params
:properties
))
2803 (inherit-property-p (plist-get params
:inherit-props
))
2805 (matcher (if tags
(cdr (org-make-tags-matcher tags
))))
2806 cc range-text st p time level hdl props tsp tbl
)
2808 (setq org-clock-file-total-minutes nil
)
2810 (setq cc
(org-clock-special-range block nil t ws ms
)
2811 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2812 (when (integerp ts
) (setq ts
(calendar-gregorian-from-absolute ts
)))
2813 (when (integerp te
) (setq te
(calendar-gregorian-from-absolute te
)))
2814 (when (and ts
(listp ts
))
2815 (setq ts
(format "%4d-%02d-%02d" (nth 2 ts
) (car ts
) (nth 1 ts
))))
2816 (when (and te
(listp te
))
2817 (setq te
(format "%4d-%02d-%02d" (nth 2 te
) (car te
) (nth 1 te
))))
2818 ;; Now the times are strings we can parse.
2819 (if ts
(setq ts
(org-matcher-time ts
)))
2820 (if te
(setq te
(org-matcher-time te
)))
2822 (org-clock-sum ts te
2823 (unless (null matcher
)
2825 (let* ((tags-list (org-get-tags-at))
2826 (org-scanner-tags tags-list
)
2827 (org-trust-scanner-tags t
))
2829 (goto-char (point-min))
2831 (while (or (and (bobp) (prog1 st
(setq st nil
))
2832 (get-text-property (point) :org-clock-minutes
)
2833 (setq p
(point-min)))
2834 (setq p
(next-single-property-change
2835 (point) :org-clock-minutes
)))
2837 (when (setq time
(get-text-property p
:org-clock-minutes
))
2839 (beginning-of-line 1)
2840 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@#%:]+:\\)?[ \t]*$"))
2841 (setq level
(org-reduced-level
2842 (- (match-end 1) (match-beginning 1))))
2843 (<= level maxlevel
))
2844 (setq hdl
(if (not link
)
2846 (org-make-link-string
2847 (format "file:%s::%s"
2851 (org-make-org-heading-search-string
2852 (replace-regexp-in-string
2853 org-bracket-link-regexp
2854 (lambda (m) (or (match-string 3 m
)
2855 (match-string 1 m
)))
2856 (match-string 2)))))
2858 (setq props
(org-entry-properties (point)))
2859 (or (cdr (assoc "SCHEDULED" props
))
2860 (cdr (assoc "DEADLINE" props
))
2861 (cdr (assoc "TIMESTAMP" props
))
2862 (cdr (assoc "TIMESTAMP_IA" props
))))
2863 props
(when properties
2867 (when (org-entry-get (point) p inherit-property-p
)
2868 (cons p
(org-entry-get (point) p inherit-property-p
))))
2870 (when (> time
0) (push (list level hdl tsp time props
) tbl
))))))
2871 (setq tbl
(nreverse tbl
))
2872 (list file org-clock-file-total-minutes tbl
))))
2874 (defun org-clock-time%
(total &rest strings
)
2875 "Compute a time fraction in percent.
2876 TOTAL s a time string like 10:21 specifying the total times.
2877 STRINGS is a list of strings that should be checked for a time.
2878 The first string that does have a time will be used.
2879 This function is made for clock tables."
2880 (let ((re "\\([0-9]+\\):\\([0-9]+\\)")
2884 (if (not (string-match re total
))
2886 (setq tot
(+ (string-to-number (match-string 2 total
))
2887 (* 60 (string-to-number (match-string 1 total
)))))
2888 (if (= tot
0.
) (throw 'exit
0.
)))
2889 (while (setq s
(pop strings
))
2890 (if (string-match "\\([0-9]+\\):\\([0-9]+\\)" s
)
2892 (/ (* 100.0 (+ (string-to-number (match-string 2 s
))
2893 (* 60 (string-to-number
2894 (match-string 1 s
)))))
2898 ;; Saving and loading the clock
2900 (defvar org-clock-loaded nil
2901 "Was the clock file loaded?")
2904 (defun org-clock-update-time-maybe ()
2905 "If this is a CLOCK line, update it and return t.
2906 Otherwise, return nil."
2909 (beginning-of-line 1)
2910 (skip-chars-forward " \t")
2911 (when (looking-at org-clock-string
)
2912 (let ((re (concat "[ \t]*" org-clock-string
2913 " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
2914 "\\([ \t]*=>.*\\)?\\)?"))
2917 ((not (looking-at re
))
2919 ((not (match-end 2))
2920 (when (and (equal (marker-buffer org-clock-marker
) (current-buffer))
2921 (> org-clock-marker
(point))
2922 (<= org-clock-marker
(point-at-eol)))
2923 ;; The clock is running here
2924 (setq org-clock-start-time
2926 (org-parse-time-string (match-string 1))))
2927 (org-clock-update-mode-line)))
2929 (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
2931 (setq ts
(match-string 1)
2932 te
(match-string 3))
2933 (setq s
(- (org-float-time
2934 (apply 'encode-time
(org-parse-time-string te
)))
2936 (apply 'encode-time
(org-parse-time-string ts
))))
2939 h
(floor (/ s
3600))
2943 (insert " => " (format (if neg
"-%d:%02d" "%2d:%02d") h m
))
2946 (defun org-clock-save ()
2947 "Persist various clock-related data to disk.
2948 The details of what will be saved are regulated by the variable
2949 `org-clock-persist'."
2950 (when (and org-clock-persist
2951 (or org-clock-loaded
2952 org-clock-has-been-used
2953 (not (file-exists-p org-clock-persist-file
))))
2955 (with-current-buffer (find-file (expand-file-name org-clock-persist-file
))
2957 (delete-region (point-min) (point-max))
2959 (insert (format ";; org-persist.el - %s at %s\n"
2960 (system-name) (format-time-string
2961 (cdr org-time-stamp-formats
))))
2962 (if (and (memq org-clock-persist
'(t clock
))
2963 (setq b
(org-clocking-buffer))
2964 (setq b
(or (buffer-base-buffer b
) b
))
2966 (buffer-file-name b
)
2967 (or (not org-clock-persist-query-save
)
2968 (y-or-n-p (concat "Save current clock ("
2969 org-clock-heading
") "))))
2970 (insert "(setq resume-clock '(\""
2971 (buffer-file-name (org-clocking-buffer))
2972 "\" . " (int-to-string (marker-position org-clock-marker
))
2974 ;; Store clocked task history. Tasks are stored reversed to make
2976 (when (and (memq org-clock-persist
'(t history
))
2979 "(setq stored-clock-history '("
2982 (when (and (setq b
(marker-buffer m
))
2983 (setq b
(or (buffer-base-buffer b
) b
))
2985 (buffer-file-name b
))
2986 (concat "(\"" (buffer-file-name b
)
2987 "\" . " (int-to-string (marker-position m
))
2989 (reverse org-clock-history
) " ") "))\n"))
2991 (kill-buffer (current-buffer)))))))
2993 (defun org-clock-load ()
2994 "Load clock-related data from disk, maybe resuming a stored clock."
2995 (when (and org-clock-persist
(not org-clock-loaded
))
2996 (let ((filename (expand-file-name org-clock-persist-file
))
2997 (org-clock-in-resume 'auto-restart
)
2998 resume-clock stored-clock-history
)
2999 (if (not (file-readable-p filename
))
3000 (message "Not restoring clock data; %s not found"
3001 org-clock-persist-file
)
3002 (message "%s" "Restoring clock data")
3003 (setq org-clock-loaded t
)
3004 (load-file filename
)
3006 (when stored-clock-history
3007 (save-window-excursion
3008 (mapc (lambda (task)
3009 (if (file-exists-p (car task
))
3010 (org-clock-history-push (cdr task
)
3011 (find-file (car task
)))))
3012 stored-clock-history
)))
3014 (when (and resume-clock org-clock-persist
3015 (file-exists-p (car resume-clock
))
3016 (or (not org-clock-persist-query-resume
)
3020 (with-current-buffer (find-file (car resume-clock
))
3022 (goto-char (cdr resume-clock
))
3023 (org-back-to-heading t
)
3024 (and (looking-at org-complex-heading-regexp
)
3027 (when (file-exists-p (car resume-clock
))
3028 (with-current-buffer (find-file (car resume-clock
))
3029 (goto-char (cdr resume-clock
))
3030 (let ((org-clock-auto-clock-resolution nil
))
3032 (if (outline-invisible-p)
3033 (org-show-context))))))))))
3035 ;; Suggested bindings
3036 (org-defkey org-mode-map
"\C-c\C-x\C-e" 'org-clock-modify-effort-estimate
)
3038 (provide 'org-clock
)
3041 ;; generated-autoload-file: "org-loaddefs.el"
3044 ;;; org-clock.el ends here
