1 ;;; org-clock.el --- The time clocking code for Org-mode
3 ;; Copyright (C) 2004-2014 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;; This file contains the time clocking code for Org-mode
35 (declare-function calendar-absolute-from-iso
"cal-iso" (&optional date
))
36 (declare-function notifications-notify
"notifications" (&rest params
))
37 (declare-function org-pop-to-buffer-same-window
"org-compat" (&optional buffer-or-name norecord label
))
38 (declare-function org-refresh-properties
"org" (dprop tprop
))
39 (declare-function org-table-goto-line
"org-table" (n))
40 (defvar org-time-stamp-formats
)
42 (defvar org-frame-title-format-backup frame-title-format
)
44 (defgroup org-clock nil
45 "Options concerning clocking working time in Org-mode."
49 (defcustom org-clock-into-drawer org-log-into-drawer
50 "Should clocking info be wrapped into a drawer?
51 When t, clocking info will always be inserted into a :LOGBOOK: drawer.
52 If necessary, the drawer will be created.
53 When nil, the drawer will not be created, but used when present.
54 When an integer and the number of clocking entries in an item
55 reaches or exceeds this number, a drawer will be created.
56 When a string, it names the drawer to be used.
58 The default for this variable is the value of `org-log-into-drawer',
63 (const :tag
"Always" t
)
64 (const :tag
"Only when drawer exists" nil
)
65 (integer :tag
"When at least N clock entries")
66 (const :tag
"Into LOGBOOK drawer" "LOGBOOK")
67 (string :tag
"Into Drawer named...")))
69 (defun org-clock-into-drawer ()
70 "Return the value of `org-clock-into-drawer', but let properties overrule.
71 If the current entry has or inherits a CLOCK_INTO_DRAWER
72 property, it will be used instead of the default value; otherwise
73 if the current entry has or inherits a LOG_INTO_DRAWER property,
74 it will be used instead of the default value.
75 The default is the value of the customizable variable `org-clock-into-drawer',
77 (let ((p (org-entry-get nil
"CLOCK_INTO_DRAWER" 'inherit t
))
78 (q (org-entry-get nil
"LOG_INTO_DRAWER" 'inherit t
)))
79 (cond ((equal p
"nil") nil
)
85 (t org-clock-into-drawer
))))
87 (defcustom org-clock-out-when-done t
88 "When non-nil, clock will be stopped when the clocked entry is marked DONE.
89 DONE here means any DONE-like state.
90 A nil value means clock will keep running until stopped explicitly with
91 `C-c C-x C-o', or until the clock is started in a different item.
92 Instead of t, this can also be a list of TODO states that should trigger
97 (const :tag
"Yes, when done" t
)
98 (repeat :tag
"State list"
99 (string :tag
"TODO keyword"))))
101 (defcustom org-clock-rounding-minutes
0
102 "Rounding minutes when clocking in or out.
103 The default value is 0 so that no rounding is done.
104 When set to a non-integer value, use the car of
105 `org-time-stamp-rounding-minutes', like for setting a time-stamp.
107 E.g. if `org-clock-rounding-minutes' is set to 5, time is 14:47
108 and you clock in: then the clock starts at 14:45. If you clock
109 out within the next 5 minutes, the clock line will be removed;
110 if you clock out 8 minutes after your clocked in, the clock
111 out time will be 14:50."
114 :package-version
'(Org .
"8.0")
116 (integer :tag
"Minutes (0 for no rounding)")
117 (symbol :tag
"Use `org-time-stamp-rounding-minutes'" 'same-as-time-stamp
)))
119 (defcustom org-clock-out-remove-zero-time-clocks nil
120 "Non-nil means remove the clock line when the resulting time is zero."
124 (defcustom org-clock-in-switch-to-state nil
125 "Set task to a special todo state while clocking it.
126 The value should be the state to which the entry should be
127 switched. If the value is a function, it must take one
128 parameter (the current TODO state of the item) and return the
129 state to switch it to."
133 (const :tag
"Don't force a state" nil
)
134 (string :tag
"State")
135 (symbol :tag
"Function")))
137 (defcustom org-clock-out-switch-to-state nil
138 "Set task to a special todo state after clocking out.
139 The value should be the state to which the entry should be
140 switched. If the value is a function, it must take one
141 parameter (the current TODO state of the item) and return the
142 state to switch it to."
146 (const :tag
"Don't force a state" nil
)
147 (string :tag
"State")
148 (symbol :tag
"Function")))
150 (defcustom org-clock-history-length
5
151 "Number of clock tasks to remember in history."
155 (defcustom org-clock-goto-may-find-recent-task t
156 "Non-nil means `org-clock-goto' can go to recent task if no active clock."
160 (defcustom org-clock-heading-function nil
161 "When non-nil, should be a function to create `org-clock-heading'.
162 This is the string shown in the mode line when a clock is running.
163 The function is called with point at the beginning of the headline."
165 :type
'(choice (const nil
) (function)))
167 (defcustom org-clock-string-limit
0
168 "Maximum length of clock strings in the mode line. 0 means no limit."
172 (defcustom org-clock-in-resume nil
173 "If non-nil, resume clock when clocking into task with open clock.
174 When clocking into a task with a clock entry which has not been closed,
175 the clock can be resumed from that point."
179 (defcustom org-clock-persist nil
180 "When non-nil, save the running clock when Emacs is closed.
181 The clock is resumed when Emacs restarts.
182 When this is t, both the running clock, and the entire clock
183 history are saved. When this is the symbol `clock', only the
184 running clock is saved. When this is the symbol `history', only
185 the clock history is saved.
187 When Emacs restarts with saved clock information, the file containing
188 the running clock as well as all files mentioned in the clock history
191 All this depends on running `org-clock-persistence-insinuate' in your
192 Emacs initialization file."
195 (const :tag
"Just the running clock" clock
)
196 (const :tag
"Just the history" history
)
197 (const :tag
"Clock and history" t
)
198 (const :tag
"No persistence" nil
)))
200 (defcustom org-clock-persist-file
(convert-standard-filename
201 (concat user-emacs-directory
"org-clock-save.el"))
202 "File to save clock data to."
206 (defcustom org-clock-persist-query-save nil
207 "When non-nil, ask before saving the current clock on exit."
211 (defcustom org-clock-persist-query-resume t
212 "When non-nil, ask before resuming any stored clock during load."
216 (defcustom org-clock-sound nil
217 "Sound to use for notifications.
221 t Standard Emacs beep
222 file name Play this sound file, fall back to beep"
225 (const :tag
"No sound" nil
)
226 (const :tag
"Standard beep" t
)
227 (file :tag
"Play sound file")))
229 (define-obsolete-variable-alias 'org-clock-modeline-total
230 'org-clock-mode-line-total
"24.3")
232 (defcustom org-clock-mode-line-total
'auto
233 "Default setting for the time included for the mode line clock.
234 This can be overruled locally using the CLOCK_MODELINE_TOTAL property.
237 current Only the time in the current instance of the clock
238 today All time clocked into this task today
239 repeat All time clocked into this task since last repeat
240 all All time ever recorded for this task
241 auto Automatically, either `all', or `repeat' for repeating tasks"
244 (const :tag
"Current clock" current
)
245 (const :tag
"Today's task time" today
)
246 (const :tag
"Since last repeat" repeat
)
247 (const :tag
"All task time" all
)
248 (const :tag
"Automatically, `all' or since `repeat'" auto
)))
250 (org-defvaralias 'org-task-overrun-text
'org-clock-task-overrun-text
)
251 (defcustom org-clock-task-overrun-text nil
252 "Extra mode line text to indicate that the clock is overrun.
253 The can be nil to indicate that instead of adding text, the clock time
254 should get a different face (`org-mode-line-clock-overrun').
255 When this is a string, it is prepended to the clock string as an indication,
256 also using the face `org-mode-line-clock-overrun'."
260 (const :tag
"Just mark the time string" nil
)
261 (string :tag
"Text to prepend")))
263 (defcustom org-show-notification-handler nil
264 "Function or program to send notification with.
265 The function or program will be called with the notification
270 (string :tag
"Program")
271 (function :tag
"Function")))
273 (defgroup org-clocktable nil
274 "Options concerning the clock table in Org-mode."
275 :tag
"Org Clock Table"
278 (defcustom org-clocktable-defaults
281 :lang
(or (org-bound-and-true-p org-export-default-language
) "en")
301 "Default properties for clock tables."
306 (defcustom org-clock-clocktable-formatter
'org-clocktable-write-default
307 "Function to turn clocking data into a table.
308 For more information, see `org-clocktable-write-default'."
309 :group
'org-clocktable
313 ;; FIXME: translate es and nl last string "Clock summary at"
314 (defcustom org-clock-clocktable-language-setup
315 '(("en" "File" "L" "Timestamp" "Headline" "Time" "ALL" "Total time" "File time" "Clock summary at")
316 ("es" "Archivo" "N" "Fecha y hora" "Tarea" "Tiempo" "TODO" "Tiempo total" "Tiempo archivo" "Clock summary at")
317 ("fr" "Fichier" "N" "Horodatage" "En-tête" "Durée" "TOUT" "Durée totale" "Durée fichier" "Horodatage sommaire à ")
318 ("nl" "Bestand" "N" "Tijdstip" "Hoofding" "Duur" "ALLES" "Totale duur" "Bestandstijd" "Clock summary at"))
319 "Terms used in clocktable, translated to different languages."
320 :group
'org-clocktable
324 (defcustom org-clock-clocktable-default-properties
'(:maxlevel
2 :scope file
)
325 "Default properties for new clocktables.
326 These will be inserted into the BEGIN line, to make it easy for users to
328 :group
'org-clocktable
331 (defcustom org-clock-idle-time nil
332 "When non-nil, resolve open clocks if the user is idle more than X minutes."
335 (const :tag
"Never" nil
)
336 (integer :tag
"After N minutes")))
338 (defcustom org-clock-auto-clock-resolution
'when-no-clock-is-running
339 "When to automatically resolve open clocks found in Org buffers."
342 (const :tag
"Never" nil
)
343 (const :tag
"Always" t
)
344 (const :tag
"When no clock is running" when-no-clock-is-running
)))
346 (defcustom org-clock-report-include-clocking-task nil
347 "When non-nil, include the current clocking task time in clock reports."
352 (defcustom org-clock-resolve-expert nil
353 "Non-nil means do not show the splash buffer with the clock resolver."
358 (defcustom org-clock-continuously nil
359 "Non-nil means to start clocking from the last clock-out time, if any."
364 (defcustom org-clock-total-time-cell-format
"*%s*"
365 "Format string for the total time cells."
370 (defcustom org-clock-file-time-cell-format
"*%s*"
371 "Format string for the file time cells."
376 (defcustom org-clock-clocked-in-display
'mode-line
377 "When clocked in for a task, org-mode can display the current
378 task and accumulated time in the mode line and/or frame title.
381 both displays in both mode line and frame title
382 mode-line displays only in mode line (default)
383 frame-title displays only in frame title
384 nil current clock is not displayed"
387 (const :tag
"Mode line" mode-line
)
388 (const :tag
"Frame title" frame-title
)
389 (const :tag
"Both" both
)
390 (const :tag
"None" nil
)))
392 (defcustom org-clock-frame-title-format
'(t org-mode-line-string
)
393 "The value for `frame-title-format' when clocking in.
395 When `org-clock-clocked-in-display' is set to 'frame-title
396 or 'both, clocking in will replace `frame-title-format' with
397 this value. Clocking out will restore `frame-title-format'.
399 `org-frame-title-string' is a format string using the same
400 specifications than `frame-title-format', which see."
405 (defcustom org-clock-x11idle-program-name
"x11idle"
406 "Name of the program which prints X11 idle time in milliseconds.
408 You can find x11idle.c in the contrib/scripts directory of the
409 Org git distribution. Or, you can do:
411 sudo apt-get install xprintidle
413 if you are using Debian."
416 :package-version
'(Org .
"8.0")
419 (defcustom org-clock-goto-before-context
2
420 "Number of lines of context to display before currently clocked-in entry.
421 This applies when using `org-clock-goto'."
425 (defcustom org-clock-display-default-range
'thisyear
426 "Default range when displaying clocks with `org-clock-display'."
428 :type
'(choice (const today
)
436 (const :tag
"Select range interactively" interactive
)))
438 (defvar org-clock-in-prepare-hook nil
439 "Hook run when preparing the clock.
440 This hook is run before anything happens to the task that
441 you want to clock in. For example, you can use this hook
442 to add an effort property.")
443 (defvar org-clock-in-hook nil
444 "Hook run when starting the clock.")
445 (defvar org-clock-out-hook nil
446 "Hook run when stopping the current clock.")
448 (defvar org-clock-cancel-hook nil
449 "Hook run when canceling the current clock.")
450 (defvar org-clock-goto-hook nil
451 "Hook run when selecting the currently clocked-in entry.")
452 (defvar org-clock-has-been-used nil
453 "Has the clock been used during the current Emacs session?")
455 ;;; The clock for measuring work time.
457 (defvar org-mode-line-string
"")
458 (put 'org-mode-line-string
'risky-local-variable t
)
460 (defvar org-clock-mode-line-timer nil
)
461 (defvar org-clock-idle-timer nil
)
462 (defvar org-clock-heading
) ; defined in org.el
463 (defvar org-clock-start-time
"")
465 (defvar org-clock-leftover-time nil
466 "If non-nil, user canceled a clock; this is when leftover time started.")
468 (defvar org-clock-effort
""
469 "Effort estimate of the currently clocking task.")
471 (defvar org-clock-total-time nil
472 "Holds total time, spent previously on currently clocked item.
473 This does not include the time in the currently running clock.")
475 (defvar org-clock-history nil
476 "List of marker pointing to recent clocked tasks.")
478 (defvar org-clock-default-task
(make-marker)
479 "Marker pointing to the default task that should clock time.
480 The clock can be made to switch to this task after clocking out
481 of a different task.")
483 (defvar org-clock-interrupted-task
(make-marker)
484 "Marker pointing to the task that has been interrupted by the current clock.")
486 (defvar org-clock-mode-line-map
(make-sparse-keymap))
487 (define-key org-clock-mode-line-map
[mode-line mouse-2
] 'org-clock-goto
)
488 (define-key org-clock-mode-line-map
[mode-line mouse-1
] 'org-clock-menu
)
490 (defun org-clock-menu ()
494 ["Clock out" org-clock-out t
]
495 ["Change effort estimate" org-clock-modify-effort-estimate t
]
496 ["Go to clock entry" org-clock-goto t
]
497 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t
:keys
"C-u C-c C-x C-i"])))
499 (defun org-clock-history-push (&optional pos buffer
)
500 "Push a marker to the clock history."
501 (setq org-clock-history-length
(max 1 (min 35 org-clock-history-length
)))
502 (let ((m (move-marker (make-marker)
503 (or pos
(point)) (org-base-buffer
504 (or buffer
(current-buffer)))))
506 (while (setq n
(member m org-clock-history
))
507 (move-marker (car n
) nil
))
508 (setq org-clock-history
510 (mapcar (lambda (x) (if (marker-buffer x
) x nil
))
512 (when (>= (setq l
(length org-clock-history
)) org-clock-history-length
)
513 (setq org-clock-history
515 (nthcdr (- l org-clock-history-length -
1)
516 (nreverse org-clock-history
)))))
517 (push m org-clock-history
)))
519 (defun org-clock-save-markers-for-cut-and-paste (beg end
)
520 "Save relative positions of markers in region."
521 (org-check-and-save-marker org-clock-marker beg end
)
522 (org-check-and-save-marker org-clock-hd-marker beg end
)
523 (org-check-and-save-marker org-clock-default-task beg end
)
524 (org-check-and-save-marker org-clock-interrupted-task beg end
)
525 (mapc (lambda (m) (org-check-and-save-marker m beg end
))
528 (defun org-clocking-buffer ()
529 "Return the clocking buffer if we are currently clocking a task or nil."
530 (marker-buffer org-clock-marker
))
532 (defun org-clocking-p ()
533 "Return t when clocking a task."
534 (not (equal (org-clocking-buffer) nil
)))
536 (defvar org-clock-before-select-task-hook nil
537 "Hook called in task selection just before prompting the user.")
539 (defun org-clock-select-task (&optional prompt
)
540 "Select a task that was recently associated with clocking."
542 (let (och chl sel-list rpl
(i 0) s
)
543 ;; Remove successive dups from the clock history to consider
544 (mapc (lambda (c) (if (not (equal c
(car och
))) (push c och
)))
546 (setq och
(reverse och
) chl
(length och
))
548 (user-error "No recent clock")
549 (save-window-excursion
550 (org-switch-to-buffer-other-window
551 (get-buffer-create "*Clock Task Select*"))
553 (when (marker-buffer org-clock-default-task
)
554 (insert (org-add-props "Default Task\n" nil
'face
'bold
))
555 (setq s
(org-clock-insert-selection-line ?d org-clock-default-task
))
557 (when (marker-buffer org-clock-interrupted-task
)
558 (insert (org-add-props "The task interrupted by starting the last one\n" nil
'face
'bold
))
559 (setq s
(org-clock-insert-selection-line ?i org-clock-interrupted-task
))
561 (when (org-clocking-p)
562 (insert (org-add-props "Current Clocking Task\n" nil
'face
'bold
))
563 (setq s
(org-clock-insert-selection-line ?c org-clock-marker
))
565 (insert (org-add-props "Recent Tasks\n" nil
'face
'bold
))
568 (when (marker-buffer m
)
570 s
(org-clock-insert-selection-line
574 (if (fboundp 'int-to-char
) (setf (car s
) (int-to-char (car s
))))
577 (run-hooks 'org-clock-before-select-task-hook
)
578 (goto-char (point-min))
579 ;; Set min-height relatively to circumvent a possible but in
580 ;; `fit-window-to-buffer'
581 (fit-window-to-buffer nil nil
(if (< chl
10) chl
(+ 5 chl
)))
582 (message (or prompt
"Select task for clocking:"))
583 (setq cursor-type nil rpl
(read-char-exclusive))
587 ((assoc rpl sel-list
) (cdr (assoc rpl sel-list
)))
588 (t (user-error "Invalid task choice %c" rpl
)))))))
590 (defun org-clock-insert-selection-line (i marker
)
591 "Insert a line for the clock selection menu.
592 And return a cons cell with the selection character integer and the marker
594 (when (marker-buffer marker
)
595 (let (file cat task heading prefix
)
596 (with-current-buffer (org-base-buffer (marker-buffer marker
))
602 (setq file
(buffer-file-name (marker-buffer marker
))
603 cat
(org-get-category)
604 heading
(org-get-heading 'notags
)
605 prefix
(save-excursion
606 (org-back-to-heading t
)
607 (looking-at org-outline-regexp
)
610 (org-fontify-like-in-org-mode
611 (concat prefix heading
)
613 (length prefix
)))))))
615 (insert (format "[%c] %-12s %s\n" i cat task
))
618 (defvar org-clock-task-overrun nil
619 "Internal flag indicating if the clock has overrun the planned time.")
620 (defvar org-clock-update-period
60
621 "Number of seconds between mode line clock string updates.")
623 (defun org-clock-get-clock-string ()
624 "Form a clock-string, that will be shown in the mode line.
625 If an effort estimate was defined for the current item, use
626 01:30/01:50 format (clocked/estimated).
627 If not, show simply the clocked time like 01:50."
628 (let ((clocked-time (org-clock-get-clocked-time)))
630 (let* ((effort-in-minutes
631 (org-duration-string-to-minutes org-clock-effort
))
634 (org-minutes-to-clocksum-string clocked-time
)
635 'face
(if (and org-clock-task-overrun
(not org-clock-task-overrun-text
))
636 'org-mode-line-clock-overrun
'org-mode-line-clock
)))
637 (effort-str (org-minutes-to-clocksum-string effort-in-minutes
))
638 (clockstr (org-propertize
639 (concat " [%s/" effort-str
640 "] (" (replace-regexp-in-string "%" "%%" org-clock-heading
) ")")
641 'face
'org-mode-line-clock
)))
642 (format clockstr work-done-str
))
643 (org-propertize (concat "[" (org-minutes-to-clocksum-string clocked-time
)
644 (format " (%s)" org-clock-heading
) "]")
645 'face
'org-mode-line-clock
))))
647 (defun org-clock-get-last-clock-out-time ()
648 "Get the last clock-out time for the current subtree."
650 (let ((end (save-excursion (org-end-of-subtree))))
651 (when (re-search-forward (concat org-clock-string
652 ".*\\]--\\(\\[[^]]+\\]\\)") end t
)
653 (org-time-string-to-time (match-string 1))))))
655 (defun org-clock-update-mode-line ()
657 (org-clock-notify-once-if-expired)
658 (setq org-clock-task-overrun nil
))
659 (setq org-mode-line-string
661 (let ((clock-string (org-clock-get-clock-string))
662 (help-text "Org-mode clock is running.\nmouse-1 shows a menu\nmouse-2 will jump to task"))
663 (if (and (> org-clock-string-limit
0)
664 (> (length clock-string
) org-clock-string-limit
))
666 (substring clock-string
0 org-clock-string-limit
)
667 'help-echo
(concat help-text
": " org-clock-heading
))
668 (org-propertize clock-string
'help-echo help-text
)))
669 'local-map org-clock-mode-line-map
670 'mouse-face
(if (featurep 'xemacs
) 'highlight
'mode-line-highlight
)))
671 (if (and org-clock-task-overrun org-clock-task-overrun-text
)
672 (setq org-mode-line-string
673 (concat (org-propertize
674 org-clock-task-overrun-text
675 'face
'org-mode-line-clock-overrun
) org-mode-line-string
)))
676 (force-mode-line-update))
678 (defun org-clock-get-clocked-time ()
679 "Get the clocked time for the current item in minutes.
680 The time returned includes the time spent on this task in
681 previous clocking intervals."
682 (let ((currently-clocked-time
683 (floor (- (org-float-time)
684 (org-float-time org-clock-start-time
)) 60)))
685 (+ currently-clocked-time
(or org-clock-total-time
0))))
687 (defun org-clock-modify-effort-estimate (&optional value
)
688 "Add to or set the effort estimate of the item currently being clocked.
689 VALUE can be a number of minutes, or a string with format hh:mm or mm.
690 When the string starts with a + or a - sign, the current value of the effort
691 property will be changed by that amount. If the effort value is expressed
692 as an `org-effort-durations' (e.g. \"3h\"), the modified value will be
693 converted to a hh:mm duration.
695 This command will update the \"Effort\" property of the currently
696 clocked item, and the value displayed in the mode line."
698 (if (org-clock-is-active)
699 (let ((current org-clock-effort
) sign
)
701 ;; Prompt user for a value or a change
704 (format "Set effort (hh:mm or mm%s): "
706 (format ", prefix + to add to %s" org-clock-effort
)
708 (when (stringp value
)
709 ;; A string. See if it is a delta
710 (setq sign
(string-to-char value
))
711 (if (member sign
'(?- ?
+))
712 (setq current
(org-duration-string-to-minutes current
)
713 value
(substring value
1))
715 (setq value
(org-duration-string-to-minutes value
))
717 (setq value
(- current value
))
718 (if (equal ?
+ sign
) (setq value
(+ current value
)))))
719 (setq value
(max 0 value
)
720 org-clock-effort
(org-minutes-to-clocksum-string value
))
721 (org-entry-put org-clock-marker
"Effort" org-clock-effort
)
722 (org-clock-update-mode-line)
723 (message "Effort is now %s" org-clock-effort
))
724 (message "Clock is not currently active")))
726 (defvar org-clock-notification-was-shown nil
727 "Shows if we have shown notification already.")
729 (defun org-clock-notify-once-if-expired ()
730 "Show notification if we spent more time than we estimated before.
731 Notification is shown only once."
732 (when (org-clocking-p)
733 (let ((effort-in-minutes (org-duration-string-to-minutes org-clock-effort
))
734 (clocked-time (org-clock-get-clocked-time)))
735 (if (setq org-clock-task-overrun
736 (if (or (null effort-in-minutes
) (zerop effort-in-minutes
))
738 (>= clocked-time effort-in-minutes
)))
739 (unless org-clock-notification-was-shown
740 (setq org-clock-notification-was-shown t
)
742 (format "Task '%s' should be finished by now. (%s)"
743 org-clock-heading org-clock-effort
) org-clock-sound
))
744 (setq org-clock-notification-was-shown nil
)))))
746 (defun org-notify (notification &optional play-sound
)
747 "Send a NOTIFICATION and maybe PLAY-SOUND.
748 If PLAY-SOUND is non-nil, it overrides `org-clock-sound'."
749 (org-show-notification notification
)
750 (if play-sound
(org-clock-play-sound play-sound
)))
752 (defun org-show-notification (notification)
754 Use `org-show-notification-handler' if defined,
755 use libnotify if available, or fall back on a message."
756 (cond ((functionp org-show-notification-handler
)
757 (funcall org-show-notification-handler notification
))
758 ((stringp org-show-notification-handler
)
759 (start-process "emacs-timer-notification" nil
760 org-show-notification-handler notification
))
761 ((fboundp 'notifications-notify
)
762 (notifications-notify
763 :title
"Org-mode message"
765 ;; FIXME how to link to the Org icon?
766 ;; :app-icon "~/.emacs.d/icons/mail.png"
768 ((executable-find "notify-send")
769 (start-process "emacs-timer-notification" nil
770 "notify-send" notification
))
771 ;; Maybe the handler will send a message, so only use message as
772 ;; a fall back option
773 (t (message "%s" notification
))))
775 (defun org-clock-play-sound (&optional clock-sound
)
776 "Play sound as configured by `org-clock-sound'.
777 Use alsa's aplay tool if available.
778 If CLOCK-SOUND is non-nil, it overrides `org-clock-sound'."
779 (let ((org-clock-sound (or clock-sound org-clock-sound
)))
781 ((not org-clock-sound
))
782 ((eq org-clock-sound t
) (beep t
) (beep t
))
783 ((stringp org-clock-sound
)
784 (let ((file (expand-file-name org-clock-sound
)))
785 (if (file-exists-p file
)
786 (if (executable-find "aplay")
787 (start-process "org-clock-play-notification" nil
790 (play-sound-file file
)
791 (error (beep t
) (beep t
))))))))))
793 (defvar org-clock-mode-line-entry nil
794 "Information for the mode line about the running clock.")
796 (defun org-find-open-clocks (file)
797 "Search through the given file and find all open clocks."
798 (let ((buf (or (get-file-buffer file
)
799 (find-file-noselect file
)))
800 (org-clock-re (concat org-clock-string
" \\(\\[.*?\\]\\)$"))
802 (with-current-buffer buf
804 (goto-char (point-min))
805 (while (re-search-forward org-clock-re nil t
)
806 (push (cons (copy-marker (match-end 1) t
)
807 (org-time-string-to-time (match-string 1))) clocks
))))
810 (defsubst org-is-active-clock
(clock)
811 "Return t if CLOCK is the currently active clock."
812 (and (org-clock-is-active)
813 (= org-clock-marker
(car clock
))))
815 (defmacro org-with-clock-position
(clock &rest forms
)
816 "Evaluate FORMS with CLOCK as the current active clock."
817 `(with-current-buffer (marker-buffer (car ,clock
))
821 (goto-char (car ,clock
))
824 (def-edebug-spec org-with-clock-position
(form body
))
825 (put 'org-with-clock-position
'lisp-indent-function
1)
827 (defmacro org-with-clock
(clock &rest forms
)
828 "Evaluate FORMS with CLOCK as the current active clock.
829 This macro also protects the current active clock from being altered."
830 `(org-with-clock-position ,clock
831 (let ((org-clock-start-time (cdr ,clock
))
832 (org-clock-total-time)
835 (org-clock-marker (car ,clock
))
836 (org-clock-hd-marker (save-excursion
837 (outline-back-to-heading t
)
840 (def-edebug-spec org-with-clock
(form body
))
841 (put 'org-with-clock
'lisp-indent-function
1)
843 (defsubst org-clock-clock-in
(clock &optional resume start-time
)
844 "Clock in to the clock located by CLOCK.
845 If necessary, clock-out of the currently active clock."
846 (org-with-clock-position clock
847 (let ((org-clock-in-resume (or resume org-clock-in-resume
)))
848 (org-clock-in nil start-time
))))
850 (defsubst org-clock-clock-out
(clock &optional fail-quietly at-time
)
851 "Clock out of the clock located by CLOCK."
852 (let ((temp (copy-marker (car clock
)
853 (marker-insertion-type (car clock
)))))
854 (if (org-is-active-clock clock
)
855 (org-clock-out nil fail-quietly at-time
)
856 (org-with-clock clock
857 (org-clock-out nil fail-quietly at-time
)))
858 (setcar clock temp
)))
860 (defsubst org-clock-clock-cancel
(clock)
861 "Cancel the clock located by CLOCK."
862 (let ((temp (copy-marker (car clock
)
863 (marker-insertion-type (car clock
)))))
864 (if (org-is-active-clock clock
)
866 (org-with-clock clock
868 (setcar clock temp
)))
870 (defvar org-clock-clocking-in nil
)
871 (defvar org-clock-resolving-clocks nil
)
872 (defvar org-clock-resolving-clocks-due-to-idleness nil
)
874 (defun org-clock-resolve-clock (clock resolve-to clock-out-time
875 &optional close-p restart-p fail-quietly
)
876 "Resolve `CLOCK' given the time `RESOLVE-TO', and the present.
877 `CLOCK' is a cons cell of the form (MARKER START-TIME)."
878 (let ((org-clock-resolving-clocks t
))
881 (org-clock-clock-cancel clock
)
882 (if (and restart-p
(not org-clock-clocking-in
))
883 (org-clock-clock-in clock
)))
885 ((eq resolve-to
'now
)
887 (error "RESTART-P is not valid here"))
888 (if (or close-p org-clock-clocking-in
)
889 (org-clock-clock-out clock fail-quietly
)
890 (unless (org-is-active-clock clock
)
891 (org-clock-clock-in clock t
))))
893 ((not (time-less-p resolve-to
(current-time)))
894 (error "RESOLVE-TO must refer to a time in the past"))
898 (error "RESTART-P is not valid here"))
899 (org-clock-clock-out clock fail-quietly
(or clock-out-time
901 (unless org-clock-clocking-in
903 (setq org-clock-leftover-time
(and (null clock-out-time
)
905 (org-clock-clock-in clock nil
(and clock-out-time
908 (defun org-clock-jump-to-current-clock (&optional effective-clock
)
910 (let ((org-clock-into-drawer (org-clock-into-drawer))
911 (clock (or effective-clock
(cons org-clock-marker
912 org-clock-start-time
))))
913 (unless (marker-buffer (car clock
))
914 (error "No clock is currently running"))
915 (org-with-clock clock
(org-clock-goto))
916 (with-current-buffer (marker-buffer (car clock
))
917 (goto-char (car clock
))
918 (if org-clock-into-drawer
920 (if (stringp org-clock-into-drawer
)
921 (concat ":" org-clock-into-drawer
":")
926 (outline-back-to-heading t
)
927 (search-forward logbook
)
928 (goto-char (match-beginning 0)))
930 (outline-back-to-heading t
)
931 (search-forward logbook
)
932 (search-forward ":END:")
933 (goto-char (match-end 0)))
936 (defun org-clock-resolve (clock &optional prompt-fn last-valid fail-quietly
)
937 "Resolve an open org-mode clock.
938 An open clock was found, with `dangling' possibly being non-nil.
939 If this function was invoked with a prefix argument, non-dangling
940 open clocks are ignored. The given clock requires some sort of
941 user intervention to resolve it, either because a clock was left
942 dangling or due to an idle timeout. The clock resolution can
945 (a) deleted, the user doesn't care about the clock
946 (b) restarted from the current time (if no other clock is open)
947 (c) closed, giving the clock X minutes
948 (d) closed and then restarted
949 (e) resumed, as if the user had never left
951 The format of clock is (CONS MARKER START-TIME), where MARKER
952 identifies the buffer and position the clock is open at (and
953 thus, the heading it's under), and START-TIME is when the clock
957 (save-window-excursion
959 (unless org-clock-resolving-clocks-due-to-idleness
960 (org-clock-jump-to-current-clock clock
))
961 (unless org-clock-resolve-expert
962 (with-output-to-temp-buffer "*Org Clock*"
963 (princ "Select a Clock Resolution Command:
965 i/q Ignore this question; the same as keeping all the idle time.
967 k/K Keep X minutes of the idle time (default is all). If this
968 amount is less than the default, you will be clocked out
969 that many minutes after the time that idling began, and then
970 clocked back in at the present time.
972 g/G Indicate that you \"got back\" X minutes ago. This is quite
973 different from 'k': it clocks you out from the beginning of
974 the idle period and clock you back in X minutes ago.
976 s/S Subtract the idle time from the current clock. This is the
977 same as keeping 0 minutes.
979 C Cancel the open timer altogether. It will be as though you
982 j/J Jump to the current clock, to make manual adjustments.
984 For all these options, using uppercase makes your final state
985 to be CLOCKED OUT.")))
986 (org-fit-window-to-buffer (get-buffer-window "*Org Clock*"))
988 (when (featurep 'xemacs
)
989 (message (concat (funcall prompt-fn clock
)
991 (setq char-pressed
(read-char-exclusive)))
992 (while (or (null char-pressed
)
993 (and (not (memq char-pressed
994 '(?k ?K ?g ?G ?s ?S ?C
998 (read-char (concat (funcall prompt-fn clock
)
1001 (and (not (memq char-pressed
'(?i ?q
))) char-pressed
)))))
1003 (floor (/ (org-float-time
1004 (time-subtract (current-time) last-valid
)) 60)))
1006 (and (memq ch
'(?k ?K
))
1007 (read-number "Keep how many minutes? " default
)))
1009 (and (memq ch
'(?g ?G
))
1010 (read-number "Got back how many minutes ago? " default
)))
1011 (subtractp (memq ch
'(?s ?S
)))
1012 (barely-started-p (< (- (org-float-time last-valid
)
1013 (org-float-time (cdr clock
))) 45))
1014 (start-over (and subtractp barely-started-p
)))
1018 (org-clock-resolve-clock clock
'now nil t nil fail-quietly
))
1019 (org-clock-jump-to-current-clock clock
))
1021 (not (memq ch
'(?k ?K ?g ?G ?s ?S ?C
))))
1024 (org-clock-resolve-clock
1027 ;; If the time on the clock was less than a minute before
1028 ;; the user went away, and they've ask to subtract all the
1033 (and gotback
(= gotback
0)))
1035 ((or (and keep
(= keep default
))
1036 (and gotback
(= gotback default
)))
1039 (time-add last-valid
(seconds-to-time (* 60 keep
))))
1041 (time-subtract (current-time)
1042 (seconds-to-time (* 60 gotback
))))
1044 (error "Unexpected, please report this as a bug")))
1045 (and gotback last-valid
)
1046 (memq ch
'(?K ?G ?S
))
1048 (not (memq ch
'(?K ?G ?S ?C
))))
1052 (defun org-resolve-clocks (&optional only-dangling-p prompt-fn last-valid
)
1053 "Resolve all currently open org-mode clocks.
1054 If `only-dangling-p' is non-nil, only ask to resolve dangling
1055 \(i.e., not currently open and valid) clocks."
1057 (unless org-clock-resolving-clocks
1058 (let ((org-clock-resolving-clocks t
))
1059 (dolist (file (org-files-list))
1060 (let ((clocks (org-find-open-clocks file
)))
1061 (dolist (clock clocks
)
1062 (let ((dangling (or (not (org-clock-is-active))
1063 (/= (car clock
) org-clock-marker
))))
1064 (if (or (not only-dangling-p
) dangling
)
1071 "Dangling clock started %d mins ago"
1073 (/ (- (org-float-time (current-time))
1074 (org-float-time (cdr clock
))) 60))))))
1076 (cdr clock
)))))))))))
1078 (defun org-emacs-idle-seconds ()
1079 "Return the current Emacs idle time in seconds, or nil if not idle."
1080 (let ((idle-time (current-idle-time)))
1082 (org-float-time idle-time
)
1085 (defun org-mac-idle-seconds ()
1086 "Return the current Mac idle time in seconds."
1087 (string-to-number (shell-command-to-string "ioreg -c IOHIDSystem | perl -ane 'if (/Idle/) {$idle=(pop @F)/1000000000; print $idle; last}'")))
1089 (defvar org-x11idle-exists-p
1090 ;; Check that x11idle exists
1091 (and (eq window-system
'x
)
1092 (eq (call-process-shell-command "command" nil nil nil
"-v" org-clock-x11idle-program-name
) 0)
1093 ;; Check that x11idle can retrieve the idle time
1094 (eq (call-process-shell-command org-clock-x11idle-program-name nil nil nil
) 0)))
1096 (defun org-x11-idle-seconds ()
1097 "Return the current X11 idle time in seconds."
1098 (/ (string-to-number (shell-command-to-string org-clock-x11idle-program-name
)) 1000))
1100 (defun org-user-idle-seconds ()
1101 "Return the number of seconds the user has been idle for.
1102 This routine returns a floating point number."
1104 ((eq system-type
'darwin
)
1105 (org-mac-idle-seconds))
1106 ((and (eq window-system
'x
) org-x11idle-exists-p
)
1107 (org-x11-idle-seconds))
1109 (org-emacs-idle-seconds))))
1111 (defvar org-clock-user-idle-seconds
)
1113 (defun org-resolve-clocks-if-idle ()
1114 "Resolve all currently open org-mode clocks.
1115 This is performed after `org-clock-idle-time' minutes, to check
1116 if the user really wants to stay clocked in after being idle for
1118 (when (and org-clock-idle-time
(not org-clock-resolving-clocks
)
1119 org-clock-marker
(marker-buffer org-clock-marker
))
1120 (let* ((org-clock-user-idle-seconds (org-user-idle-seconds))
1121 (org-clock-user-idle-start
1122 (time-subtract (current-time)
1123 (seconds-to-time org-clock-user-idle-seconds
)))
1124 (org-clock-resolving-clocks-due-to-idleness t
))
1125 (if (> org-clock-user-idle-seconds
(* 60 org-clock-idle-time
))
1127 (cons org-clock-marker
1128 org-clock-start-time
)
1131 (format "Clocked in & idle for %.1f mins"
1133 (time-subtract (current-time)
1134 org-clock-user-idle-start
))
1136 org-clock-user-idle-start
)))))
1138 (defvar org-clock-current-task nil
"Task currently clocked in.")
1139 (defvar org-clock-out-time nil
) ; store the time of the last clock-out
1140 (defvar org--msg-extra
)
1143 (defun org-clock-in (&optional select start-time
)
1144 "Start the clock on the current item.
1145 If necessary, clock-out of the currently active clock.
1146 With a prefix argument SELECT (\\[universal-argument]), offer a list of recently clocked
1147 tasks to clock into. When SELECT is \\[universal-argument] \\[universal-argument], clock into the current task
1148 and mark it as the default task, a special task that will always be offered
1149 in the clocking selection, associated with the letter `d'.
1150 When SELECT is \\[universal-argument] \\[universal-argument] \\[universal-argument], \
1151 clock in by using the last clock-out
1152 time as the start time \(see `org-clock-continuously' to
1153 make this the default behavior.)"
1155 (setq org-clock-notification-was-shown nil
)
1156 (org-refresh-properties
1157 org-effort-property
'((effort . identity
)
1158 (effort-minutes . org-duration-string-to-minutes
)))
1160 (let ((interrupting (and (not org-clock-resolving-clocks-due-to-idleness
)
1162 ts selected-task target-pos
(org--msg-extra "")
1163 (leftover (and (not org-clock-resolving-clocks
)
1164 org-clock-leftover-time
)))
1166 (when (and org-clock-auto-clock-resolution
1167 (or (not interrupting
)
1168 (eq t org-clock-auto-clock-resolution
))
1169 (not org-clock-clocking-in
)
1170 (not org-clock-resolving-clocks
))
1171 (setq org-clock-leftover-time nil
)
1172 (let ((org-clock-clocking-in t
))
1173 (org-resolve-clocks))) ; check if any clocks are dangling
1175 (when (equal select
'(64))
1176 ;; Set start-time to `org-clock-out-time'
1177 (let ((org-clock-continuously t
))
1178 (org-clock-in nil org-clock-out-time
)))
1180 (when (equal select
'(4))
1181 (setq selected-task
(org-clock-select-task "Clock-in on task: "))
1183 (setq selected-task
(copy-marker selected-task
))
1186 (when (equal select
'(16))
1187 ;; Mark as default clocking task
1188 (org-clock-mark-default-task))
1191 ;; We are interrupting the clocking of a different task.
1192 ;; Save a marker to this task, so that we can go back.
1193 ;; First check if we are trying to clock into the same task!
1194 (when (save-excursion
1195 (unless selected-task
1196 (org-back-to-heading t
))
1197 (and (equal (marker-buffer org-clock-hd-marker
)
1199 (marker-buffer selected-task
)
1201 (= (marker-position org-clock-hd-marker
)
1203 (marker-position selected-task
)
1205 (equal org-clock-current-task
(nth 4 (org-heading-components)))))
1206 (message "Clock continues in \"%s\"" org-clock-heading
)
1208 (move-marker org-clock-interrupted-task
1209 (marker-position org-clock-marker
)
1210 (marker-buffer org-clock-marker
))
1211 (let ((org-clock-clocking-in t
))
1212 (org-clock-out nil t
)))
1214 ;; Clock in at which position?
1216 (if (and (eobp) (not (org-at-heading-p)))
1220 (when (and selected-task
(marker-buffer selected-task
))
1221 ;; There is a selected task, move to the correct buffer
1222 ;; and set the new target position.
1223 (set-buffer (org-base-buffer (marker-buffer selected-task
)))
1224 (setq target-pos
(marker-position selected-task
))
1225 (move-marker selected-task nil
))
1229 (goto-char target-pos
)
1230 (org-back-to-heading t
)
1231 (or interrupting
(move-marker org-clock-interrupted-task nil
))
1232 (run-hooks 'org-clock-in-prepare-hook
)
1233 (org-clock-history-push)
1234 (setq org-clock-current-task
(nth 4 (org-heading-components)))
1235 (cond ((functionp org-clock-in-switch-to-state
)
1236 (looking-at org-complex-heading-regexp
)
1237 (let ((newstate (funcall org-clock-in-switch-to-state
1239 (if newstate
(org-todo newstate
))))
1240 ((and org-clock-in-switch-to-state
1241 (not (looking-at (concat org-outline-regexp
"[ \t]*"
1242 org-clock-in-switch-to-state
1244 (org-todo org-clock-in-switch-to-state
)))
1245 (setq org-clock-heading
1246 (cond ((and org-clock-heading-function
1247 (functionp org-clock-heading-function
))
1248 (funcall org-clock-heading-function
))
1249 ((nth 4 (org-heading-components))
1250 (replace-regexp-in-string
1251 "\\[\\[.*?\\]\\[\\(.*?\\)\\]\\]" "\\1"
1252 (match-string-no-properties 4)))
1254 (org-clock-find-position org-clock-in-resume
)
1256 ((and org-clock-in-resume
1258 (concat "^[ \t]*" org-clock-string
1259 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1260 " *\\sw+\.? +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
1261 (message "Matched %s" (match-string 1))
1262 (setq ts
(concat "[" (match-string 1) "]"))
1263 (goto-char (match-end 1))
1264 (setq org-clock-start-time
1266 (org-parse-time-string (match-string 1))))
1267 (setq org-clock-effort
(org-entry-get (point) org-effort-property
))
1268 (setq org-clock-total-time
(org-clock-sum-current-item
1269 (org-clock-get-sum-start))))
1270 ((eq org-clock-in-resume
'auto-restart
)
1271 ;; called from org-clock-load during startup,
1272 ;; do not interrupt, but warn!
1273 (message "Cannot restart clock because task does not contain unfinished clock")
1278 (insert-before-markers "\n")
1281 (when (and (save-excursion
1284 (beginning-of-line 1)
1285 (org-indent-line-to (- (org-get-indentation) 2)))
1286 (insert org-clock-string
" ")
1287 (setq org-clock-effort
(org-entry-get (point) org-effort-property
))
1288 (setq org-clock-total-time
(org-clock-sum-current-item
1289 (org-clock-get-sum-start)))
1290 (setq org-clock-start-time
1291 (or (and org-clock-continuously org-clock-out-time
)
1295 "You stopped another clock %d mins ago; start this one from then? "
1296 (/ (- (org-float-time
1297 (org-current-time org-clock-rounding-minutes t
))
1298 (org-float-time leftover
)) 60)))
1301 (org-current-time org-clock-rounding-minutes t
)))
1302 (setq ts
(org-insert-time-stamp org-clock-start-time
1303 'with-hm
'inactive
))))
1304 (move-marker org-clock-marker
(point) (buffer-base-buffer))
1305 (move-marker org-clock-hd-marker
1306 (save-excursion (org-back-to-heading t
) (point))
1307 (buffer-base-buffer))
1308 (setq org-clock-has-been-used t
)
1310 (when (or (eq org-clock-clocked-in-display
'mode-line
)
1311 (eq org-clock-clocked-in-display
'both
))
1312 (or global-mode-string
(setq global-mode-string
'("")))
1313 (or (memq 'org-mode-line-string global-mode-string
)
1314 (setq global-mode-string
1315 (append global-mode-string
'(org-mode-line-string)))))
1316 ;; add to frame title
1317 (when (or (eq org-clock-clocked-in-display
'frame-title
)
1318 (eq org-clock-clocked-in-display
'both
))
1319 (setq frame-title-format org-clock-frame-title-format
))
1320 (org-clock-update-mode-line)
1321 (when org-clock-mode-line-timer
1322 (cancel-timer org-clock-mode-line-timer
)
1323 (setq org-clock-mode-line-timer nil
))
1324 (when org-clock-clocked-in-display
1325 (setq org-clock-mode-line-timer
1326 (run-with-timer org-clock-update-period
1327 org-clock-update-period
1328 'org-clock-update-mode-line
)))
1329 (when org-clock-idle-timer
1330 (cancel-timer org-clock-idle-timer
)
1331 (setq org-clock-idle-timer nil
))
1332 (setq org-clock-idle-timer
1333 (run-with-timer 60 60 'org-resolve-clocks-if-idle
))
1334 (message "Clock starts at %s - %s" ts org--msg-extra
)
1335 (run-hooks 'org-clock-in-hook
)))))))
1338 (defun org-clock-in-last (&optional arg
)
1339 "Clock in the last closed clocked item.
1340 When already clocking in, send an warning.
1341 With a universal prefix argument, select the task you want to
1342 clock in from the last clocked in tasks.
1343 With two universal prefix arguments, start clocking using the
1344 last clock-out time, if any.
1345 With three universal prefix arguments, interactively prompt
1346 for a todo state to switch to, overriding the existing value
1347 `org-clock-in-switch-to-state'."
1349 (if (equal arg
'(4))
1350 (org-clock-in (org-clock-select-task))
1351 (let ((start-time (if (or org-clock-continuously
(equal arg
'(16)))
1352 (or org-clock-out-time
1353 (org-current-time org-clock-rounding-minutes t
))
1354 (org-current-time org-clock-rounding-minutes t
))))
1355 (if (null org-clock-history
)
1356 (message "No last clock")
1357 (let ((org-clock-in-switch-to-state
1358 (if (and (not org-clock-current-task
) (equal arg
'(64)))
1359 (completing-read "Switch to state: "
1360 (and org-clock-history
1361 (with-current-buffer
1362 (marker-buffer (car org-clock-history
))
1363 org-todo-keywords-1
)))
1364 org-clock-in-switch-to-state
))
1365 (already-clocking org-clock-current-task
))
1366 (org-clock-clock-in (list (car org-clock-history
)) nil start-time
)
1367 (or already-clocking
1368 ;; Don't display a message if we are already clocking in
1369 (message "Clocking back: %s (in %s)"
1370 org-clock-current-task
1371 (buffer-name (marker-buffer org-clock-marker
)))))))))
1373 (defun org-clock-mark-default-task ()
1374 "Mark current task as default task."
1377 (org-back-to-heading t
)
1378 (move-marker org-clock-default-task
(point))))
1380 (defun org-clock-get-sum-start ()
1381 "Return the time from which clock times should be counted.
1382 This is for the currently running clock as it is displayed
1383 in the mode line. This function looks at the properties
1384 LAST_REPEAT and in particular CLOCK_MODELINE_TOTAL and the
1385 corresponding variable `org-clock-mode-line-total' and then
1386 decides which time to use."
1387 (let ((cmt (or (org-entry-get nil
"CLOCK_MODELINE_TOTAL")
1388 (symbol-name org-clock-mode-line-total
)))
1389 (lr (org-entry-get nil
"LAST_REPEAT")))
1391 ((equal cmt
"current")
1392 (setq org--msg-extra
"showing time in current clock instance")
1394 ((equal cmt
"today")
1395 (setq org--msg-extra
"showing today's task time.")
1396 (let* ((dt (decode-time (current-time)))
1399 (if (< hour org-extend-today-until
) (setf (nth 3 dt
) (1- day
)))
1400 (setf (nth 2 dt
) org-extend-today-until
)
1401 (setq dt
(append (list 0 0) (nthcdr 2 dt
)))
1402 (apply 'encode-time dt
)))
1403 ((or (equal cmt
"all")
1404 (and (or (not cmt
) (equal cmt
"auto"))
1406 (setq org--msg-extra
"showing entire task time.")
1408 ((or (equal cmt
"repeat")
1409 (and (or (not cmt
) (equal cmt
"auto"))
1411 (setq org--msg-extra
"showing task time since last repeat.")
1414 (org-time-string-to-time lr
)))
1417 (defun org-clock-find-position (find-unclosed)
1418 "Find the location where the next clock line should be inserted.
1419 When FIND-UNCLOSED is non-nil, first check if there is an unclosed clock
1420 line and position cursor in that line."
1421 (org-back-to-heading t
)
1423 (let* ((org-clock-into-drawer (org-clock-into-drawer))
1424 (beg (save-excursion
1425 (beginning-of-line 2)
1426 (or (bolp) (newline))
1428 (end (progn (outline-next-heading) (point)))
1429 (re (concat "^[ \t]*" org-clock-string
))
1431 (drawer (if (stringp org-clock-into-drawer
)
1432 org-clock-into-drawer
"LOGBOOK"))
1433 first last ind-last
)
1435 (when (and find-unclosed
1437 (concat "^[ \t]*" org-clock-string
1438 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1439 " *\\sw+ +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")
1441 (beginning-of-line 1)
1443 (when (eobp) (newline) (setq end
(max (point) end
)))
1444 (when (re-search-forward (concat "^[ \t]*:" drawer
":") end t
)
1445 ;; we seem to have a CLOCK drawer, so go there.
1446 (beginning-of-line 2)
1447 (or org-log-states-order-reversed
1448 (and (re-search-forward org-property-end-re nil t
)
1449 (goto-char (match-beginning 0))))
1451 ;; Lets count the CLOCK lines
1453 (while (re-search-forward re end t
)
1454 (setq first
(or first
(match-beginning 0))
1455 last
(match-beginning 0)
1457 (when (and (integerp org-clock-into-drawer
)
1459 (>= (1+ cnt
) org-clock-into-drawer
))
1460 ;; Wrap current entries into a new drawer
1462 (setq ind-last
(org-get-indentation))
1463 (beginning-of-line 2)
1464 (if (and (>= (org-get-indentation) ind-last
)
1466 (when (and (>= (org-get-indentation) ind-last
)
1468 (let ((struct (org-list-struct)))
1469 (goto-char (org-list-get-bottom-point struct
)))))
1471 (beginning-of-line 0)
1472 (org-indent-line-to ind-last
)
1474 (insert ":" drawer
":\n")
1475 (beginning-of-line 0)
1478 (beginning-of-line 2)
1479 (or org-log-states-order-reversed
1480 (and (re-search-forward org-property-end-re nil t
)
1481 (goto-char (match-beginning 0))))
1485 (while (and (looking-at (concat "[ \t]*" org-keyword-time-regexp
))
1486 (not (equal (match-string 1) org-clock-string
)))
1487 ;; Planning info, skip to after it
1488 (beginning-of-line 2)
1489 (or (bolp) (newline)))
1490 (when (or (eq org-clock-into-drawer t
)
1491 (stringp org-clock-into-drawer
)
1492 (and (integerp org-clock-into-drawer
)
1493 (< org-clock-into-drawer
2)))
1494 (insert ":" drawer
":\n:END:\n")
1495 (beginning-of-line -
1)
1498 (beginning-of-line 2)
1501 (or org-log-states-order-reversed
1502 (and (re-search-forward org-property-end-re nil t
)
1503 (goto-char (match-beginning 0))))))))
1506 (defun org-clock-out (&optional switch-to-state fail-quietly at-time
)
1507 "Stop the currently running clock.
1508 Throw an error if there is no running clock and FAIL-QUIETLY is nil.
1509 With a universal prefix, prompt for a state to switch the clocked out task
1510 to, overriding the existing value of `org-clock-out-switch-to-state'."
1513 (when (not (org-clocking-p))
1514 (setq global-mode-string
1515 (delq 'org-mode-line-string global-mode-string
))
1516 (setq frame-title-format org-frame-title-format-backup
)
1517 (force-mode-line-update)
1518 (if fail-quietly
(throw 'exit t
) (user-error "No active clock")))
1519 (let ((org-clock-out-switch-to-state
1521 (completing-read "Switch to state: "
1522 (with-current-buffer
1523 (marker-buffer org-clock-marker
)
1524 org-todo-keywords-1
)
1526 org-clock-out-switch-to-state
))
1527 (now (org-current-time org-clock-rounding-minutes
))
1529 (setq org-clock-out-time now
)
1530 (save-excursion ; Do not replace this with `with-current-buffer'.
1531 (org-no-warnings (set-buffer (org-clocking-buffer)))
1534 (goto-char org-clock-marker
)
1535 (beginning-of-line 1)
1536 (if (and (looking-at (concat "[ \t]*" org-keyword-time-regexp
))
1537 (equal (match-string 1) org-clock-string
))
1538 (setq ts
(match-string 2))
1539 (if fail-quietly
(throw 'exit nil
) (error "Clock start time is gone")))
1540 (goto-char (match-end 0))
1541 (delete-region (point) (point-at-eol))
1543 (setq te
(org-insert-time-stamp (or at-time now
) 'with-hm
'inactive
))
1544 (setq s
(- (org-float-time (apply 'encode-time
(org-parse-time-string te
)))
1545 (org-float-time (apply 'encode-time
(org-parse-time-string ts
))))
1546 h
(floor (/ s
3600))
1550 (insert " => " (format "%2d:%02d" h m
))
1551 (when (setq remove
(and org-clock-out-remove-zero-time-clocks
1553 (beginning-of-line 1)
1554 (delete-region (point) (point-at-eol))
1555 (and (looking-at "\n") (> (point-max) (1+ (point)))
1557 (move-marker org-clock-marker nil
)
1558 (move-marker org-clock-hd-marker nil
)
1559 (when org-log-note-clock-out
1560 (org-add-log-setup 'clock-out nil nil nil nil
1561 (concat "# Task: " (org-get-heading t
) "\n\n")))
1562 (when org-clock-mode-line-timer
1563 (cancel-timer org-clock-mode-line-timer
)
1564 (setq org-clock-mode-line-timer nil
))
1565 (when org-clock-idle-timer
1566 (cancel-timer org-clock-idle-timer
)
1567 (setq org-clock-idle-timer nil
))
1568 (setq global-mode-string
1569 (delq 'org-mode-line-string global-mode-string
))
1570 (setq frame-title-format org-frame-title-format-backup
)
1571 (when org-clock-out-switch-to-state
1573 (org-back-to-heading t
)
1574 (let ((org-inhibit-logging t
)
1575 (org-clock-out-when-done nil
))
1577 ((functionp org-clock-out-switch-to-state
)
1578 (looking-at org-complex-heading-regexp
)
1579 (let ((newstate (funcall org-clock-out-switch-to-state
1581 (if newstate
(org-todo newstate
))))
1582 ((and org-clock-out-switch-to-state
1583 (not (looking-at (concat org-outline-regexp
"[ \t]*"
1584 org-clock-out-switch-to-state
1586 (org-todo org-clock-out-switch-to-state
))))))
1587 (force-mode-line-update)
1588 (message (concat "Clock stopped at %s after "
1589 (org-minutes-to-clocksum-string (+ (* 60 h
) m
)) "%s")
1590 te
(if remove
" => LINE REMOVED" ""))
1591 (let ((h org-clock-out-hook
))
1592 ;; If a closing note needs to be stored in the drawer
1593 ;; where clocks are stored, let's temporarily disable
1594 ;; `org-clock-remove-empty-clock-drawer'
1595 (if (and (equal org-clock-into-drawer org-log-into-drawer
)
1596 (eq org-log-done
'note
)
1597 org-clock-out-when-done
)
1598 (setq h
(delq 'org-clock-remove-empty-clock-drawer h
)))
1599 (mapc (lambda (f) (funcall f
)) h
))
1600 (unless (org-clocking-p)
1601 (setq org-clock-current-task nil
)))))))
1603 (add-hook 'org-clock-out-hook
'org-clock-remove-empty-clock-drawer
)
1605 (defun org-clock-remove-empty-clock-drawer nil
1606 "Remove empty clock drawer in the current subtree."
1607 (let* ((olid (or (org-entry-get (point) "LOG_INTO_DRAWER")
1608 org-log-into-drawer
))
1609 (clock-drawer (if (eq t olid
) "LOGBOOK" olid
))
1610 (end (save-excursion (org-end-of-subtree t t
))))
1613 (org-back-to-heading t
)
1614 (while (and (< (point) end
)
1615 (search-forward clock-drawer end t
))
1616 (goto-char (match-beginning 0))
1617 (org-remove-empty-drawer-at (point))
1618 (forward-line 1))))))
1620 (defun org-clock-timestamps-up (&optional n
)
1621 "Increase CLOCK timestamps at cursor.
1622 Optional argument N tells to change by that many units."
1624 (org-clock-timestamps-change 'up n
))
1626 (defun org-clock-timestamps-down (&optional n
)
1627 "Increase CLOCK timestamps at cursor.
1628 Optional argument N tells to change by that many units."
1630 (org-clock-timestamps-change 'down n
))
1632 (defun org-clock-timestamps-change (updown &optional n
)
1633 "Change CLOCK timestamps synchronously at cursor.
1634 UPDOWN tells whether to change 'up or 'down.
1635 Optional argument N tells to change by that many units."
1636 (setq org-ts-what nil
)
1637 (when (org-at-timestamp-p t
)
1638 (let ((tschange (if (eq updown
'up
) 'org-timestamp-up
1639 'org-timestamp-down
))
1640 ts1 begts1 ts2 begts2 updatets1 tdiff
)
1642 (move-beginning-of-line 1)
1643 (re-search-forward org-ts-regexp3 nil t
)
1644 (setq ts1
(match-string 0) begts1
(match-beginning 0))
1645 (when (re-search-forward org-ts-regexp3 nil t
)
1646 (setq ts2
(match-string 0) begts2
(match-beginning 0))))
1647 ;; Are we on the second timestamp?
1648 (if (<= begts2
(point)) (setq updatets1 t
))
1650 ;; fall back on org-timestamp-up if there is only one
1651 (funcall tschange n
)
1652 ;; setq this so that (boundp 'org-ts-what is non-nil)
1653 (funcall tschange n
)
1654 (let ((ts (if updatets1 ts2 ts1
))
1655 (begts (if updatets1 begts1 begts2
)))
1658 (org-time-string-to-time org-last-changed-timestamp
)
1659 (org-time-string-to-time ts
)))
1662 (org-timestamp-change
1663 (round (/ (org-float-time tdiff
)
1664 (cond ((eq org-ts-what
'minute
) 60)
1665 ((eq org-ts-what
'hour
) 3600)
1666 ((eq org-ts-what
'day
) (* 24 3600))
1667 ((eq org-ts-what
'month
) (* 24 3600 31))
1668 ((eq org-ts-what
'year
) (* 24 3600 365.2)))))
1669 org-ts-what
'updown
)))))))
1672 (defun org-clock-cancel ()
1673 "Cancel the running clock by removing the start timestamp."
1675 (when (not (org-clocking-p))
1676 (setq global-mode-string
1677 (delq 'org-mode-line-string global-mode-string
))
1678 (setq frame-title-format org-frame-title-format-backup
)
1679 (force-mode-line-update)
1680 (error "No active clock"))
1681 (save-excursion ; Do not replace this with `with-current-buffer'.
1682 (org-no-warnings (set-buffer (org-clocking-buffer)))
1683 (goto-char org-clock-marker
)
1684 (if (org-looking-back (concat "^[ \t]*" org-clock-string
".*"))
1685 (progn (delete-region (1- (point-at-bol)) (point-at-eol))
1686 (org-remove-empty-drawer-at (point)))
1687 (message "Clock gone, cancel the timer anyway")
1689 (move-marker org-clock-marker nil
)
1690 (move-marker org-clock-hd-marker nil
)
1691 (setq global-mode-string
1692 (delq 'org-mode-line-string global-mode-string
))
1693 (setq frame-title-format org-frame-title-format-backup
)
1694 (force-mode-line-update)
1695 (message "Clock canceled")
1696 (run-hooks 'org-clock-cancel-hook
))
1699 (defun org-clock-goto (&optional select
)
1700 "Go to the currently clocked-in entry, or to the most recently clocked one.
1701 With prefix arg SELECT, offer recently clocked tasks for selection."
1706 (or (org-clock-select-task "Select task to go to: ")
1707 (error "No task selected")))
1708 ((org-clocking-p) org-clock-marker
)
1709 ((and org-clock-goto-may-find-recent-task
1710 (car org-clock-history
)
1711 (marker-buffer (car org-clock-history
)))
1713 (car org-clock-history
))
1714 (t (error "No active or recent clock task")))))
1715 (org-pop-to-buffer-same-window (marker-buffer m
))
1716 (if (or (< m
(point-min)) (> m
(point-max))) (widen))
1719 (org-back-to-heading t
)
1720 (org-cycle-hide-drawers 'children
)
1721 (recenter org-clock-goto-before-context
)
1724 (message "No running clock, this is the most recently clocked task"))
1725 (run-hooks 'org-clock-goto-hook
)))
1727 (defvar org-clock-file-total-minutes nil
1728 "Holds the file total time in minutes, after a call to `org-clock-sum'.")
1729 (make-variable-buffer-local 'org-clock-file-total-minutes
)
1731 (defun org-clock-sum-today (&optional headline-filter
)
1732 "Sum the times for each subtree for today."
1733 (let ((range (org-clock-special-range 'today
)))
1734 (org-clock-sum (car range
) (cadr range
)
1735 headline-filter
:org-clock-minutes-today
)))
1737 (defun org-clock-sum-custom (&optional headline-filter range propname
)
1738 "Sum the times for each subtree for today."
1739 (let ((r (or (and (symbolp range
) (org-clock-special-range range
))
1740 (org-clock-special-range
1741 (intern (completing-read
1743 '("today" "yesterday" "thisweek" "lastweek"
1744 "thismonth" "lastmonth" "thisyear" "lastyear"
1747 (org-clock-sum (car r
) (cadr r
)
1748 headline-filter
(or propname
:org-clock-minutes-custom
))))
1751 (defun org-clock-sum (&optional tstart tend headline-filter propname
)
1752 "Sum the times for each subtree.
1753 Puts the resulting times in minutes as a text property on each headline.
1754 TSTART and TEND can mark a time range to be considered.
1755 HEADLINE-FILTER is a zero-arg function that, if specified, is called for
1756 each headline in the time range with point at the headline. Headlines for
1757 which HEADLINE-FILTER returns nil are excluded from the clock summation.
1758 PROPNAME lets you set a custom text property instead of :org-clock-minutes."
1759 (org-with-silent-modifications
1760 (let* ((re (concat "^\\(\\*+\\)[ \t]\\|^[ \t]*"
1762 "[ \t]*\\(?:\\(\\[.*?\\]\\)-+\\(\\[.*?\\]\\)\\|=>[ \t]+\\([0-9]+\\):\\([0-9]+\\)\\)"))
1764 (ltimes (make-vector lmax
0))
1769 (if (stringp tstart
) (setq tstart
(org-time-string-to-seconds tstart
)))
1770 (if (stringp tend
) (setq tend
(org-time-string-to-seconds tend
)))
1771 (if (consp tstart
) (setq tstart
(org-float-time tstart
)))
1772 (if (consp tend
) (setq tend
(org-float-time tend
)))
1773 (remove-text-properties (point-min) (point-max)
1774 `(,(or propname
:org-clock-minutes
) t
1775 :org-clock-force-headline-inclusion t
))
1777 (goto-char (point-max))
1778 (while (re-search-backward re nil t
)
1782 (setq ts
(match-string 2)
1785 (apply 'encode-time
(org-parse-time-string ts
)))
1787 (apply 'encode-time
(org-parse-time-string te
)))
1788 ts
(if tstart
(max ts tstart
) ts
)
1789 te
(if tend
(min te tend
) te
)
1791 t1
(if (> dt
0) (+ t1
(floor (/ dt
60))) t1
)))
1794 (setq t1
(+ t1
(string-to-number (match-string 5))
1795 (* 60 (string-to-number (match-string 4))))))
1797 ;; Add the currently clocking item time to the total
1798 (when (and org-clock-report-include-clocking-task
1799 (equal (org-clocking-buffer) (current-buffer))
1800 (equal (marker-position org-clock-hd-marker
) (point))
1803 (>= (org-float-time org-clock-start-time
) tstart
)
1804 (<= (org-float-time org-clock-start-time
) tend
))
1805 (let ((time (floor (- (org-float-time)
1806 (org-float-time org-clock-start-time
)) 60)))
1807 (setq t1
(+ t1 time
))))
1808 (let* ((headline-forced
1809 (get-text-property (point)
1810 :org-clock-force-headline-inclusion
))
1812 (or (null headline-filter
)
1814 (save-match-data (funcall headline-filter
))))))
1815 (setq level
(- (match-end 1) (match-beginning 1)))
1816 (when (>= level lmax
)
1817 (setq ltimes
(vconcat ltimes
(make-vector lmax
0)) lmax
(* 2 lmax
)))
1818 (when (or (> t1
0) (> (aref ltimes level
) 0))
1819 (when (or headline-included headline-forced
)
1820 (if headline-included
1821 (loop for l from
0 to level do
1822 (aset ltimes l
(+ (aref ltimes l
) t1
))))
1823 (setq time
(aref ltimes level
))
1824 (goto-char (match-beginning 0))
1825 (put-text-property (point) (point-at-eol)
1826 (or propname
:org-clock-minutes
) time
)
1831 (> (funcall outline-level
) 1)
1832 (outline-up-heading 1 t
)
1834 (point) (point-at-eol)
1835 :org-clock-force-headline-inclusion t
))))))
1837 (loop for l from level to
(1- lmax
) do
1838 (aset ltimes l
0)))))))
1839 (setq org-clock-file-total-minutes
(aref ltimes
0))))))
1841 (defun org-clock-sum-current-item (&optional tstart
)
1842 "Return time, clocked on current item in total."
1845 (org-narrow-to-subtree)
1846 (org-clock-sum tstart
)
1847 org-clock-file-total-minutes
)))
1850 (defun org-clock-display (&optional arg
)
1851 "Show subtree times in the entire buffer.
1853 With one universal prefix argument, show the total time for
1854 today. With two universal prefix arguments, show the total time
1855 for a custom range, entered at the prompt. With three universal
1856 prefix arguments, show the total time in the echo area.
1858 Use \\[org-clock-remove-overlays] to remove the subtree times."
1860 (org-clock-remove-overlays)
1861 (let* ((todayp (equal arg
'(4)))
1862 (customp (member arg
'((16) today yesterday
1863 thisweek lastweek thismonth
1864 lastmonth thisyear lastyear
1866 (prop (cond ((not arg
) :org-clock-minutes-default
)
1867 (todayp :org-clock-minutes-today
)
1868 (customp :org-clock-minutes-custom
)
1869 (t :org-clock-minutes
)))
1871 (cond ((not arg
) (org-clock-sum-custom
1872 nil org-clock-display-default-range prop
))
1873 (todayp (org-clock-sum-today))
1874 (customp (org-clock-sum-custom nil arg
))
1875 (t (org-clock-sum)))
1876 (unless (eq arg
'(64))
1878 (goto-char (point-min))
1879 (while (or (and (equal (setq p
(point)) (point-min))
1880 (get-text-property p prop
))
1881 (setq p
(next-single-property-change
1884 (when (setq time
(get-text-property p prop
))
1885 (org-clock-put-overlay time
)))
1886 (setq h
(/ org-clock-file-total-minutes
60)
1887 m
(- org-clock-file-total-minutes
(* 60 h
)))
1888 ;; Arrange to remove the overlays upon next change.
1889 (when org-remove-highlights-with-change
1890 (org-add-hook 'before-change-functions
'org-clock-remove-overlays
1892 (message (concat (format "Total file time%s: "
1893 (cond (todayp " for today")
1894 (customp " (custom)")
1896 (org-minutes-to-clocksum-string
1897 org-clock-file-total-minutes
)
1898 " (%d hours and %d minutes)")
1901 (defvar org-clock-overlays nil
)
1902 (make-variable-buffer-local 'org-clock-overlays
)
1904 (defun org-clock-put-overlay (time)
1905 "Put an overlays on the current line, displaying TIME.
1906 This creates a new overlay and stores it in `org-clock-overlays', so that it
1907 will be easy to remove."
1910 (when (looking-at org-complex-heading-regexp
)
1911 (goto-char (match-beginning 4)))
1912 (setq ov
(make-overlay (point) (point-at-eol))
1913 tx
(concat (buffer-substring-no-properties (point) (match-end 4))
1916 (max 0 (- (- 60 (current-column))
1917 (- (match-end 4) (match-beginning 4))
1918 (length (org-get-at-bol 'line-prefix
)))) ?·
)
1921 (format " %9s " (org-minutes-to-clocksum-string time
))
1922 '(face org-clock-overlay
))
1924 (if (not (featurep 'xemacs
))
1925 (overlay-put ov
'display tx
)
1926 (overlay-put ov
'invisible t
)
1927 (overlay-put ov
'end-glyph
(make-glyph tx
)))
1928 (push ov org-clock-overlays
)))
1931 (defun org-clock-remove-overlays (&optional beg end noremove
)
1932 "Remove the occur highlights from the buffer.
1933 BEG and END are ignored. If NOREMOVE is nil, remove this function
1934 from the `before-change-functions' in the current buffer."
1936 (unless org-inhibit-highlight-removal
1937 (mapc 'delete-overlay org-clock-overlays
)
1938 (setq org-clock-overlays nil
)
1940 (remove-hook 'before-change-functions
1941 'org-clock-remove-overlays
'local
))))
1943 (defvar org-state
) ;; dynamically scoped into this function
1944 (defun org-clock-out-if-current ()
1945 "Clock out if the current entry contains the running clock.
1946 This is used to stop the clock after a TODO entry is marked DONE,
1947 and is only done if the variable `org-clock-out-when-done' is not nil."
1948 (when (and (org-clocking-p)
1949 org-clock-out-when-done
1950 (marker-buffer org-clock-marker
)
1951 (or (and (eq t org-clock-out-when-done
)
1952 (member org-state org-done-keywords
))
1953 (and (listp org-clock-out-when-done
)
1954 (member org-state org-clock-out-when-done
)))
1955 (equal (or (buffer-base-buffer (org-clocking-buffer))
1956 (org-clocking-buffer))
1957 (or (buffer-base-buffer (current-buffer))
1959 (< (point) org-clock-marker
)
1960 (> (save-excursion (outline-next-heading) (point))
1962 ;; Clock out, but don't accept a logging message for this.
1963 (let ((org-log-note-clock-out nil
)
1964 (org-clock-out-switch-to-state nil
))
1967 (add-hook 'org-after-todo-state-change-hook
1968 'org-clock-out-if-current
)
1971 (defun org-clock-get-clocktable (&rest props
)
1972 "Get a formatted clocktable with parameters according to PROPS.
1973 The table is created in a temporary buffer, fully formatted and
1974 fontified, and then returned."
1976 (setq props
(plist-put props
:name
"clocktable"))
1977 (unless (plist-member props
:maxlevel
)
1978 (setq props
(plist-put props
:maxlevel
2)))
1979 (unless (plist-member props
:scope
)
1980 (setq props
(plist-put props
:scope
'agenda
)))
1983 (org-create-dblock props
)
1987 (buffer-substring (point) (progn
1988 (re-search-forward "^[ \t]*#\\+END" nil t
)
1992 (defun org-clock-report (&optional arg
)
1993 "Create a table containing a report about clocked time.
1994 If the cursor is inside an existing clocktable block, then the table
1995 will be updated. If not, a new clocktable will be inserted. The scope
1996 of the new clock will be subtree when called from within a subtree, and
1999 When called with a prefix argument, move to the first clock table in the
2000 buffer and update it."
2002 (org-clock-remove-overlays)
2004 (org-find-dblock "clocktable")
2006 (if (org-in-clocktable-p)
2007 (goto-char (org-in-clocktable-p))
2008 (let ((props (if (ignore-errors
2009 (save-excursion (org-back-to-heading)))
2010 (list :name
"clocktable" :scope
'subtree
)
2011 (list :name
"clocktable"))))
2013 (org-combine-plists org-clock-clocktable-default-properties props
))))
2014 (org-update-dblock))
2016 (defun org-day-of-week (day month year
)
2017 "Returns the day of the week as an integer."
2021 (format "%d-%02d-%02dT00:00:00" year month day
)))))
2023 (defun org-quarter-to-date (quarter year
)
2024 "Get the date (week day year) of the first day of a given quarter."
2028 (setq startday
(org-day-of-week 1 1 year
))
2031 (list 52 7 (- year
1)))
2033 (list 52 6 (- year
1)))
2035 (list 1 startday year
))
2037 (list 53 startday
(- year
1)))
2041 (setq startday
(org-day-of-week 1 4 year
))
2044 (list 13 startday year
))
2046 (list 14 startday year
))
2048 (list 13 startday year
))
2052 (setq startday
(org-day-of-week 1 7 year
))
2055 (list 26 startday year
))
2057 (list 27 startday year
))
2059 (list 26 startday year
))
2063 (setq startday
(org-day-of-week 1 10 year
))
2066 (list 39 startday year
))
2068 (list 40 startday year
))
2070 (list 39 startday year
)))))))
2072 (defun org-clock-special-range (key &optional time as-strings wstart mstart
)
2073 "Return two times bordering a special time range.
2074 Key is a symbol specifying the range and can be one of `today', `yesterday',
2075 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
2076 By default, a week starts Monday 0:00 and ends Sunday 24:00.
2077 The range is determined relative to TIME, which defaults to current time.
2078 The return value is a cons cell with two internal times like the ones
2079 returned by `current time' or `encode-time'.
2080 If AS-STRINGS is non-nil, the returned times will be formatted strings.
2081 If WSTART is non-nil, use this number to specify the starting day of a
2083 If MSTART is non-nil, use this number to specify the starting day of a
2084 month (1 is the first day of the month).
2085 If you can combine both, the month starting day will have priority."
2086 (if (integerp key
) (setq key
(intern (number-to-string key
))))
2087 (let* ((tm (decode-time (or time
(current-time))))
2088 (s 0) (m (nth 1 tm
)) (h (nth 2 tm
))
2089 (d (nth 3 tm
)) (month (nth 4 tm
)) (y (nth 5 tm
))
2093 (skey (symbol-name key
))
2095 (q (cond ((>= (nth 4 tm
) 10) 4)
2096 ((>= (nth 4 tm
) 7) 3)
2097 ((>= (nth 4 tm
) 4) 2)
2098 ((>= (nth 4 tm
) 1) 1)))
2099 s1 m1 h1 d1 month1 y1 diff ts te fm txt w date
2100 interval tmp shiftedy shiftedm shiftedq
)
2102 ((string-match "^[0-9]+$" skey
)
2103 (setq y
(string-to-number skey
) m
1 d
1 key
'year
))
2104 ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)$" skey
)
2105 (setq y
(string-to-number (match-string 1 skey
))
2106 month
(string-to-number (match-string 2 skey
))
2108 ((string-match "^\\([0-9]+\\)-[wW]\\([0-9]\\{1,2\\}\\)$" skey
)
2110 (setq y
(string-to-number (match-string 1 skey
))
2111 w
(string-to-number (match-string 2 skey
)))
2112 (setq date
(calendar-gregorian-from-absolute
2113 (calendar-absolute-from-iso (list w
1 y
))))
2114 (setq d
(nth 1 date
) month
(car date
) y
(nth 2 date
)
2117 ((string-match "^\\([0-9]+\\)-[qQ]\\([1-4]\\)$" skey
)
2119 (setq y
(string-to-number (match-string 1 skey
)))
2120 (setq q
(string-to-number (match-string 2 skey
)))
2121 (setq date
(calendar-gregorian-from-absolute
2122 (calendar-absolute-from-iso (org-quarter-to-date q y
))))
2123 (setq d
(nth 1 date
) month
(car date
) y
(nth 2 date
)
2126 ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)-\\([0-9]\\{1,2\\}\\)$" skey
)
2127 (setq y
(string-to-number (match-string 1 skey
))
2128 month
(string-to-number (match-string 2 skey
))
2129 d
(string-to-number (match-string 3 skey
))
2131 ((string-match "\\([-+][0-9]+\\)$" skey
)
2132 (setq shift
(string-to-number (match-string 1 skey
))
2133 key
(intern (substring skey
0 (match-beginning 1))))
2134 (if (and (memq key
'(quarter thisq
)) (> shift
0))
2135 (error "Looking forward with quarters isn't implemented"))))
2138 (cond ((eq key
'yesterday
) (setq key
'today shift -
1))
2139 ((eq key
'lastweek
) (setq key
'week shift -
1))
2140 ((eq key
'lastmonth
) (setq key
'month shift -
1))
2141 ((eq key
'lastyear
) (setq key
'year shift -
1))
2142 ((eq key
'lastq
) (setq key
'quarter shift -
1))))
2144 ((memq key
'(day today
))
2145 (setq d
(+ d shift
) h
0 m
0 h1
24 m1
0))
2146 ((memq key
'(week thisweek
))
2147 (setq diff
(+ (* -
7 shift
) (if (= dow
0) (- 7 ws
) (- dow ws
)))
2148 m
0 h
0 d
(- d diff
) d1
(+ 7 d
)))
2149 ((memq key
'(month thismonth
))
2150 (setq d
(or ms
1) h
0 m
0 d1
(or ms
1)
2151 month
(+ month shift
) month1
(1+ month
) h1
0 m1
0))
2152 ((memq key
'(quarter thisq
))
2153 ;; Compute if this shift remains in this year. If not, compute
2154 ;; how many years and quarters we have to shift (via floor*) and
2155 ;; compute the shifted years, months and quarters.
2157 ((< (+ (- q
1) shift
) 0) ; shift not in this year
2158 (setq interval
(* -
1 (+ (- q
1) shift
)))
2159 ;; Set tmp to ((years to shift) (quarters to shift)).
2160 (setq tmp
(org-floor* interval
4))
2161 ;; Due to the use of floor, 0 quarters actually means 4.
2162 (if (= 0 (nth 1 tmp
))
2163 (setq shiftedy
(- y
(nth 0 tmp
))
2166 (setq shiftedy
(- y
(+ 1 (nth 0 tmp
)))
2167 shiftedm
(- 13 (* 3 (nth 1 tmp
)))
2168 shiftedq
(- 5 (nth 1 tmp
))))
2169 (setq d
1 h
0 m
0 d1
1 month shiftedm month1
(+ 3 shiftedm
) h1
0 m1
0 y shiftedy
))
2170 ((> (+ q shift
) 0) ; shift is within this year
2171 (setq shiftedq
(+ q shift
))
2173 (setq d
1 h
0 m
0 d1
1 month
(+ 1 (* 3 (- (+ q shift
) 1)))
2174 month1
(+ 4 (* 3 (- (+ q shift
) 1))) h1
0 m1
0))))
2175 ((memq key
'(year thisyear
))
2176 (setq m
0 h
0 d
1 month
1 y
(+ y shift
) y1
(1+ y
)))
2177 ((eq key
'interactive
) nil
)
2178 (t (user-error "No such time block %s" key
)))
2179 (setq ts
(encode-time s m h d month y
)
2180 te
(encode-time (or s1 s
) (or m1 m
) (or h1 h
)
2181 (or d1 d
) (or month1 month
) (or y1 y
)))
2182 (setq fm
(cdr org-time-stamp-formats
))
2184 ((memq key
'(day today
))
2185 (setq txt
(format-time-string "%A, %B %d, %Y" ts
)))
2186 ((memq key
'(week thisweek
))
2187 (setq txt
(format-time-string "week %G-W%V" ts
)))
2188 ((memq key
'(month thismonth
))
2189 (setq txt
(format-time-string "%B %Y" ts
)))
2190 ((memq key
'(year thisyear
))
2191 (setq txt
(format-time-string "the year %Y" ts
)))
2192 ((memq key
'(quarter thisq
))
2193 (setq txt
(concat (org-count-quarter shiftedq
)
2194 " quarter of " (number-to-string shiftedy
)))))
2196 (list (format-time-string fm ts
) (format-time-string fm te
) txt
)
2197 (if (eq key
'interactive
)
2198 (list (org-read-date nil t nil
"Range start? ")
2199 (org-read-date nil t nil
"Range end? ")
2200 "(Range interactively set)")
2201 (list ts te txt
)))))
2203 (defun org-count-quarter (n)
2211 (defun org-clocktable-shift (dir n
)
2212 "Try to shift the :block date of the clocktable at point.
2213 Point must be in the #+BEGIN: line of a clocktable, or this function
2214 will throw an error.
2215 DIR is a direction, a symbol `left', `right', `up', or `down'.
2216 Both `left' and `down' shift the block toward the past, `up' and `right'
2217 push it toward the future.
2218 N is the number of shift steps to take. The size of the step depends on
2219 the currently selected interval size."
2220 (setq n
(prefix-numeric-value n
))
2221 (and (memq dir
'(left down
)) (setq n
(- n
)))
2223 (goto-char (point-at-bol))
2224 (if (not (looking-at "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>.*?:block[ \t]+\\(\\S-+\\)"))
2225 (error "Line needs a :block definition before this command works")
2226 (let* ((b (match-beginning 1)) (e (match-end 1))
2227 (s (match-string 1))
2228 block shift ins y mw d date wp m
)
2230 ((equal s
"yesterday") (setq s
"today-1"))
2231 ((equal s
"lastweek") (setq s
"thisweek-1"))
2232 ((equal s
"lastmonth") (setq s
"thismonth-1"))
2233 ((equal s
"lastyear") (setq s
"thisyear-1"))
2234 ((equal s
"lastq") (setq s
"thisq-1")))
2237 ((string-match "^\\(today\\|thisweek\\|thismonth\\|thisyear\\|thisq\\)\\([-+][0-9]+\\)?$" s
)
2238 (setq block
(match-string 1 s
)
2239 shift
(if (match-end 2)
2240 (string-to-number (match-string 2 s
))
2242 (setq shift
(+ shift n
))
2243 (setq ins
(if (= shift
0) block
(format "%s%+d" block shift
))))
2244 ((string-match "\\([0-9]+\\)\\(-\\([wWqQ]?\\)\\([0-9]\\{1,2\\}\\)\\(-\\([0-9]\\{1,2\\}\\)\\)?\\)?" s
)
2245 ;; 1 1 2 3 3 4 4 5 6 6 5 2
2246 (setq y
(string-to-number (match-string 1 s
))
2247 wp
(and (match-end 3) (match-string 3 s
))
2248 mw
(and (match-end 4) (string-to-number (match-string 4 s
)))
2249 d
(and (match-end 6) (string-to-number (match-string 6 s
))))
2251 (d (setq ins
(format-time-string
2253 (encode-time 0 0 0 (+ d n
) m y
))))
2254 ((and wp
(string-match "w\\|W" wp
) mw
(> (length wp
) 0))
2256 (setq date
(calendar-gregorian-from-absolute
2257 (calendar-absolute-from-iso (list (+ mw n
) 1 y
))))
2258 (setq ins
(format-time-string
2260 (encode-time 0 0 0 (nth 1 date
) (car date
) (nth 2 date
)))))
2261 ((and wp
(string-match "q\\|Q" wp
) mw
(> (length wp
) 0))
2263 ; if the 4th + 1 quarter is requested we flip to the 1st quarter of the next year
2268 ; if the 1st - 1 quarter is requested we flip to the 4th quarter of the previous year
2273 (setq date
(calendar-gregorian-from-absolute
2274 (calendar-absolute-from-iso (org-quarter-to-date (+ mw n
) y
))))
2275 (setq ins
(format-time-string
2276 (concat (number-to-string y
) "-Q" (number-to-string (+ mw n
)))
2277 (encode-time 0 0 0 (nth 1 date
) (car date
) (nth 2 date
)))))
2279 (setq ins
(format-time-string
2281 (encode-time 0 0 0 1 (+ mw n
) y
))))
2283 (setq ins
(number-to-string (+ y n
))))))
2284 (t (error "Cannot shift clocktable block")))
2288 (delete-region (point) (+ (point) (- e b
)))
2289 (beginning-of-line 1)
2294 (defun org-dblock-write:clocktable
(params)
2295 "Write the standard clocktable."
2296 (setq params
(org-combine-plists org-clocktable-defaults params
))
2298 (let* ((scope (plist-get params
:scope
))
2299 (block (plist-get params
:block
))
2300 (ts (plist-get params
:tstart
))
2301 (te (plist-get params
:tend
))
2302 (link (plist-get params
:link
))
2303 (maxlevel (or (plist-get params
:maxlevel
) 3))
2304 (ws (plist-get params
:wstart
))
2305 (ms (plist-get params
:mstart
))
2306 (step (plist-get params
:step
))
2307 (timestamp (plist-get params
:timestamp
))
2308 (formatter (or (plist-get params
:formatter
)
2309 org-clock-clocktable-formatter
2310 'org-clocktable-write-default
))
2311 cc range-text ipos pos one-file-with-archives
2312 scope-is-list tbls level
)
2313 ;; Check if we need to do steps
2315 ;; Get the range text for the header
2316 (setq cc
(org-clock-special-range block nil t ws ms
)
2317 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2319 ;; Write many tables, in steps
2320 (unless (or block
(and ts te
))
2321 (error "Clocktable `:step' can only be used with `:block' or `:tstart,:end'"))
2322 (org-clocktable-steps params
)
2325 (setq ipos
(point)) ; remember the insertion position
2327 ;; Get the right scope
2330 ((and scope
(listp scope
) (symbolp (car scope
)))
2331 (setq scope
(eval scope
)))
2333 (setq scope
(org-agenda-files t
)))
2334 ((eq scope
'agenda-with-archives
)
2335 (setq scope
(org-agenda-files t
))
2336 (setq scope
(org-add-archive-files scope
)))
2337 ((eq scope
'file-with-archives
)
2338 (setq scope
(org-add-archive-files (list (buffer-file-name)))
2339 one-file-with-archives t
)))
2340 (setq scope-is-list
(and scope
(listp scope
)))
2342 ;; we collect from several files
2343 (let* ((files scope
)
2345 (org-agenda-prepare-buffers files
)
2346 (while (setq file
(pop files
))
2347 (with-current-buffer (find-buffer-visiting file
)
2350 (push (org-clock-get-table-data file params
) tbls
))))))
2351 ;; Just from the current file
2353 ;; get the right range into the restriction
2354 (org-agenda-prepare-buffers (list (buffer-file-name)))
2356 ((not scope
)) ; use the restriction as it is now
2357 ((eq scope
'file
) (widen))
2358 ((eq scope
'subtree
) (org-narrow-to-subtree))
2360 (while (org-up-heading-safe))
2361 (org-narrow-to-subtree))
2362 ((and (symbolp scope
) (string-match "^tree\\([0-9]+\\)$"
2363 (symbol-name scope
)))
2364 (setq level
(string-to-number (match-string 1 (symbol-name scope
))))
2366 (while (org-up-heading-safe)
2367 (looking-at org-outline-regexp
)
2368 (if (<= (org-reduced-level (funcall outline-level
)) level
)
2369 (throw 'exit nil
))))
2370 (org-narrow-to-subtree)))
2371 ;; do the table, with no file name.
2372 (push (org-clock-get-table-data nil params
) tbls
)))
2374 ;; OK, at this point we tbls as a list of tables, one per file
2375 (setq tbls
(nreverse tbls
))
2377 (setq params
(plist-put params
:multifile scope-is-list
))
2378 (setq params
(plist-put params
:one-file-with-archives
2379 one-file-with-archives
))
2381 (funcall formatter ipos tbls params
))))
2383 (defun org-clocktable-write-default (ipos tables params
)
2384 "Write out a clock table at position IPOS in the current buffer.
2385 TABLES is a list of tables with clocking data as produced by
2386 `org-clock-get-table-data'. PARAMS is the parameter property list obtained
2387 from the dynamic block definition."
2388 ;; This function looks quite complicated, mainly because there are a
2389 ;; lot of options which can add or remove columns. I have massively
2390 ;; commented this function, the I hope it is understandable. If
2391 ;; someone wants to write their own special formatter, this maybe
2392 ;; much easier because there can be a fixed format with a
2393 ;; well-defined number of columns...
2394 (let* ((hlchars '((1 .
"*") (2 .
"/")))
2395 (lwords (assoc (or (plist-get params
:lang
)
2396 (org-bound-and-true-p org-export-default-language
)
2398 org-clock-clocktable-language-setup
))
2399 (multifile (plist-get params
:multifile
))
2400 (block (plist-get params
:block
))
2401 (sort (plist-get params
:sort
))
2402 (ts (plist-get params
:tstart
))
2403 (te (plist-get params
:tend
))
2404 (header (plist-get params
:header
))
2405 (narrow (plist-get params
:narrow
))
2406 (ws (or (plist-get params
:wstart
) 1))
2407 (ms (or (plist-get params
:mstart
) 1))
2408 (link (plist-get params
:link
))
2409 (maxlevel (or (plist-get params
:maxlevel
) 3))
2410 (emph (plist-get params
:emphasize
))
2411 (level-p (plist-get params
:level
))
2412 (org-time-clocksum-use-effort-durations
2413 (plist-get params
:effort-durations
))
2414 (timestamp (plist-get params
:timestamp
))
2415 (properties (plist-get params
:properties
))
2416 (ntcol (max 1 (or (plist-get params
:tcolumns
) 100)))
2417 (rm-file-column (plist-get params
:one-file-with-archives
))
2418 (indent (plist-get params
:indent
))
2419 (case-fold-search t
)
2420 range-text total-time tbl level hlc formula pcol
2421 file-time entries entry headline
2422 recalc content narrow-cut-p tcol
)
2424 ;; Implement abbreviations
2425 (when (plist-get params
:compact
)
2426 (setq level nil indent t narrow
(or narrow
'40!) ntcol
1))
2428 ;; Some consistency test for parameters
2429 (unless (integerp ntcol
)
2430 (setq params
(plist-put params
:tcolumns
(setq ntcol
100))))
2432 (when (and narrow
(integerp narrow
) link
)
2433 ;; We cannot have both integer narrow and link
2435 "Using hard narrowing in clocktable to allow for links")
2436 (setq narrow
(intern (format "%d!" narrow
))))
2441 ((and (symbolp narrow
)
2442 (string-match "\\`[0-9]+!\\'" (symbol-name narrow
)))
2443 (setq narrow-cut-p t
2444 narrow
(string-to-number (substring (symbol-name narrow
)
2447 (error "Invalid value %s of :narrow property in clock table"
2451 ;; Get the range text for the header
2452 (setq range-text
(nth 2 (org-clock-special-range block nil t ws ms
))))
2454 ;; Compute the total time
2455 (setq total-time
(apply '+ (mapcar 'cadr tables
)))
2457 ;; Now we need to output this tsuff
2460 ;; Insert the text *before* the actual table
2461 (insert-before-markers
2463 ;; Format the standard header
2468 (format-time-string (cdr org-time-stamp-formats
))
2471 (if block
(concat ", for " range-text
".") "")
2474 ;; Insert the narrowing line
2475 (when (and narrow
(integerp narrow
) (not narrow-cut-p
))
2476 (insert-before-markers
2477 "|" ; table line starter
2478 (if multifile
"|" "") ; file column, maybe
2479 (if level-p
"|" "") ; level column, maybe
2480 (if timestamp
"|" "") ; timestamp column, maybe
2481 (if properties
(make-string (length properties
) ?|
) "") ;properties columns, maybe
2482 (format "<%d>| |\n" narrow
))) ; headline and time columns
2484 ;; Insert the table header line
2485 (insert-before-markers
2486 "|" ; table line starter
2487 (if multifile
(concat (nth 1 lwords
) "|") "") ; file column, maybe
2488 (if level-p
(concat (nth 2 lwords
) "|") "") ; level column, maybe
2489 (if timestamp
(concat (nth 3 lwords
) "|") "") ; timestamp column, maybe
2490 (if properties
(concat (mapconcat 'identity properties
"|") "|") "") ;properties columns, maybe
2491 (concat (nth 4 lwords
) "|"
2492 (nth 5 lwords
) "|\n")) ; headline and time columns
2494 ;; Insert the total time in the table
2495 (insert-before-markers
2497 "|" ; table line starter
2498 (if multifile
(concat "| " (nth 6 lwords
) " ") "")
2499 ; file column, maybe
2500 (if level-p
"|" "") ; level column, maybe
2501 (if timestamp
"|" "") ; timestamp column, maybe
2502 (if properties
(make-string (length properties
) ?|
) "") ; properties columns, maybe
2503 (concat (format org-clock-total-time-cell-format
(nth 7 lwords
)) "| ") ; instead of a headline
2504 (format org-clock-total-time-cell-format
2505 (org-minutes-to-clocksum-string (or total-time
0))) ; the time
2508 ;; Now iterate over the tables and insert the data
2509 ;; but only if any time has been collected
2510 (when (and total-time
(> total-time
0))
2512 (while (setq tbl
(pop tables
))
2513 ;; now tbl is the table resulting from one file.
2514 (setq file-time
(nth 1 tbl
))
2515 (when (or (and file-time
(> file-time
0))
2516 (not (plist-get params
:fileskip0
)))
2517 (insert-before-markers "|-\n") ; a hline because a new file starts
2518 ;; First the file time, if we have multiple files
2520 ;; Summarize the time collected from this file
2521 (insert-before-markers
2522 (format (concat "| %s %s | %s%s"
2523 (format org-clock-file-time-cell-format
(nth 8 lwords
))
2525 (file-name-nondirectory (car tbl
))
2526 (if level-p
"| " "") ; level column, maybe
2527 (if timestamp
"| " "") ; timestamp column, maybe
2528 (if properties
(make-string (length properties
) ?|
) "") ;properties columns, maybe
2529 (org-minutes-to-clocksum-string (nth 1 tbl
))))) ; the time
2531 ;; Get the list of node entries and iterate over it
2532 (setq entries
(nth 2 tbl
))
2533 (while (setq entry
(pop entries
))
2534 (setq level
(car entry
)
2535 headline
(nth 1 entry
)
2536 hlc
(if emph
(or (cdr (assoc level hlchars
)) "") ""))
2538 (if (and (string-match (concat "\\`" org-bracket-link-regexp
2543 (format "[[%s][%s]]"
2544 (match-string 1 headline
)
2545 (org-shorten-string (match-string 3 headline
)
2547 (setq headline
(org-shorten-string headline narrow
))))
2548 (insert-before-markers
2549 "|" ; start the table line
2550 (if multifile
"|" "") ; free space for file name column?
2551 (if level-p
(format "%d|" (car entry
)) "") ; level, maybe
2552 (if timestamp
(concat (nth 2 entry
) "|") "") ; timestamp, maybe
2556 (lambda (p) (or (cdr (assoc p
(nth 4 entry
))) ""))
2557 properties
"|") "|") "") ;properties columns, maybe
2558 (if indent
(org-clocktable-indent-string level
) "") ; indentation
2559 hlc headline hlc
"|" ; headline
2560 (make-string (min (1- ntcol
) (or (- level
1))) ?|
)
2561 ; empty fields for higher levels
2562 hlc
(org-minutes-to-clocksum-string (nth 3 entry
)) hlc
; time
2565 ;; When exporting subtrees or regions the region might be
2566 ;; activated, so let's disable ̀delete-active-region'
2567 (let ((delete-active-region nil
)) (backward-delete-char 1))
2568 (if (setq formula
(plist-get params
:formula
))
2571 ;; compute the column where the % numbers need to go
2576 (min maxlevel
(or ntcol
100))))
2577 ;; compute the column where the total time is
2581 (if timestamp
1 0)))
2584 "\n#+TBLFM: $%d='(org-clock-time%% @%d$%d $%d..$%d);%%.1f"
2585 pcol
; the column where the % numbers should go
2586 (if (and narrow
(not narrow-cut-p
)) 3 2) ; row of the total time
2587 tcol
; column of the total time
2588 tcol
(1- pcol
) ; range of columns where times can be found
2592 (insert "\n#+TBLFM: " formula
)
2594 (t (error "Invalid formula in clocktable")))
2595 ;; Should we rescue an old formula?
2596 (when (stringp (setq content
(plist-get params
:content
)))
2597 (when (string-match "^\\([ \t]*#\\+tblfm:.*\\)" content
)
2599 (insert "\n" (match-string 1 (plist-get params
:content
)))
2600 (beginning-of-line 0))))
2601 ;; Back to beginning, align the table, recalculate if necessary
2603 (skip-chars-forward "^|")
2605 (when org-hide-emphasis-markers
2606 ;; we need to align a second time
2610 (org-table-goto-line 3)
2611 (org-table-goto-column (car sort
))
2612 (org-table-sort-lines nil
(cdr sort
))))
2616 (if (and narrow
(not narrow-cut-p
)) (beginning-of-line 2))
2617 (org-table-goto-column pcol nil
'force
)
2619 (org-table-recalculate 'all
))
2620 (when rm-file-column
2621 ;; The file column is actually not wanted
2623 (org-table-delete-column))
2626 (defun org-clocktable-indent-string (level)
2629 (dotimes (k (1- level
) str
)
2630 (setq str
(concat "\\emsp" str
))))))
2632 (defun org-clocktable-steps (params)
2633 "Step through the range to make a number of clock tables."
2634 (let* ((p1 (copy-sequence params
))
2635 (ts (plist-get p1
:tstart
))
2636 (te (plist-get p1
:tend
))
2637 (ws (plist-get p1
:wstart
))
2638 (ms (plist-get p1
:mstart
))
2639 (step0 (plist-get p1
:step
))
2640 (step (cdr (assoc step0
'((day .
86400) (week .
604800)))))
2641 (stepskip0 (plist-get p1
:stepskip0
))
2642 (block (plist-get p1
:block
))
2643 cc range-text step-time tsb
)
2645 (setq cc
(org-clock-special-range block nil t ws ms
)
2646 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2649 ;; If ts is a number, it's an absolute day number from org-agenda.
2650 (destructuring-bind (month day year
) (calendar-gregorian-from-absolute ts
)
2651 (setq ts
(org-float-time (encode-time 0 0 0 day month year
)))))
2653 (setq ts
(org-float-time
2654 (apply 'encode-time
(org-parse-time-string ts
))))))
2658 (destructuring-bind (month day year
) (calendar-gregorian-from-absolute te
)
2659 (setq te
(org-float-time (encode-time 0 0 0 day month year
)))))
2661 (setq te
(org-float-time
2662 (apply 'encode-time
(org-parse-time-string te
))))))
2664 (if (eq step0
'week
)
2665 (- ts
(* 86400 (- (nth 6 (decode-time (seconds-to-time ts
))) ws
)))
2667 (setq p1
(plist-put p1
:header
""))
2668 (setq p1
(plist-put p1
:step nil
))
2669 (setq p1
(plist-put p1
:block nil
))
2671 (or (bolp) (insert "\n"))
2672 (setq p1
(plist-put p1
:tstart
(format-time-string
2673 (org-time-stamp-format nil t
)
2674 (seconds-to-time (max tsb ts
)))))
2675 (setq p1
(plist-put p1
:tend
(format-time-string
2676 (org-time-stamp-format nil t
)
2677 (seconds-to-time (min te
(setq tsb
(+ tsb step
)))))))
2678 (insert "\n" (if (eq step0
'day
) "Daily report: "
2679 "Weekly report starting on: ")
2680 (plist-get p1
:tstart
) "\n")
2681 (setq step-time
(org-dblock-write:clocktable p1
))
2682 (re-search-forward "^[ \t]*#\\+END:")
2683 (when (and (equal step-time
0) stepskip0
)
2684 ;; Remove the empty table
2685 (delete-region (point-at-bol)
2687 (re-search-backward "^\\(Daily\\|Weekly\\) report"
2692 (defun org-clock-get-table-data (file params
)
2693 "Get the clocktable data for file FILE, with parameters PARAMS.
2694 FILE is only for identification - this function assumes that
2695 the correct buffer is current, and that the wanted restriction is
2697 The return value will be a list with the file name and the total
2698 file time (in minutes) as 1st and 2nd elements. The third element
2699 of this list will be a list of headline entries. Each entry has the
2700 following structure:
2702 (LEVEL HEADLINE TIMESTAMP TIME)
2704 LEVEL: The level of the headline, as an integer. This will be
2705 the reduced leve, so 1,2,3,... even if only odd levels
2707 HEADLINE: The text of the headline. Depending on PARAMS, this may
2708 already be formatted like a link.
2709 TIMESTAMP: If PARAMS require it, this will be a time stamp found in the
2710 entry, any of SCHEDULED, DEADLINE, NORMAL, or first inactive,
2712 TIME: The sum of all time spend in this tree, in minutes. This time
2713 will of cause be restricted to the time block and tags match
2714 specified in PARAMS."
2715 (let* ((maxlevel (or (plist-get params
:maxlevel
) 3))
2716 (timestamp (plist-get params
:timestamp
))
2717 (ts (plist-get params
:tstart
))
2718 (te (plist-get params
:tend
))
2719 (ws (plist-get params
:wstart
))
2720 (ms (plist-get params
:mstart
))
2721 (block (plist-get params
:block
))
2722 (link (plist-get params
:link
))
2723 (tags (plist-get params
:tags
))
2724 (properties (plist-get params
:properties
))
2725 (inherit-property-p (plist-get params
:inherit-props
))
2727 (matcher (if tags
(cdr (org-make-tags-matcher tags
))))
2728 cc range-text st p time level hdl props tsp tbl
)
2730 (setq org-clock-file-total-minutes nil
)
2732 (setq cc
(org-clock-special-range block nil t ws ms
)
2733 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2734 (when (integerp ts
) (setq ts
(calendar-gregorian-from-absolute ts
)))
2735 (when (integerp te
) (setq te
(calendar-gregorian-from-absolute te
)))
2736 (when (and ts
(listp ts
))
2737 (setq ts
(format "%4d-%02d-%02d" (nth 2 ts
) (car ts
) (nth 1 ts
))))
2738 (when (and te
(listp te
))
2739 (setq te
(format "%4d-%02d-%02d" (nth 2 te
) (car te
) (nth 1 te
))))
2740 ;; Now the times are strings we can parse.
2741 (if ts
(setq ts
(org-float-time
2742 (seconds-to-time (org-matcher-time ts
)))))
2743 (if te
(setq te
(org-float-time
2744 (seconds-to-time (org-matcher-time te
)))))
2746 (org-clock-sum ts te
2747 (unless (null matcher
)
2749 (let* ((tags-list (org-get-tags-at))
2750 (org-scanner-tags tags-list
)
2751 (org-trust-scanner-tags t
))
2753 (goto-char (point-min))
2755 (while (or (and (bobp) (prog1 st
(setq st nil
))
2756 (get-text-property (point) :org-clock-minutes
)
2757 (setq p
(point-min)))
2758 (setq p
(next-single-property-change
2759 (point) :org-clock-minutes
)))
2761 (when (setq time
(get-text-property p
:org-clock-minutes
))
2763 (beginning-of-line 1)
2764 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@#%:]+:\\)?[ \t]*$"))
2765 (setq level
(org-reduced-level
2766 (- (match-end 1) (match-beginning 1))))
2767 (<= level maxlevel
))
2768 (setq hdl
(if (not link
)
2770 (org-make-link-string
2771 (format "file:%s::%s"
2775 (org-make-org-heading-search-string
2776 (replace-regexp-in-string
2777 org-bracket-link-regexp
2778 (lambda (m) (or (match-string 3 m
)
2779 (match-string 1 m
)))
2780 (match-string 2)))))
2782 (setq props
(org-entry-properties (point)))
2783 (or (cdr (assoc "SCHEDULED" props
))
2784 (cdr (assoc "DEADLINE" props
))
2785 (cdr (assoc "TIMESTAMP" props
))
2786 (cdr (assoc "TIMESTAMP_IA" props
))))
2787 props
(when properties
2791 (when (org-entry-get (point) p inherit-property-p
)
2792 (cons p
(org-entry-get (point) p inherit-property-p
))))
2794 (when (> time
0) (push (list level hdl tsp time props
) tbl
))))))
2795 (setq tbl
(nreverse tbl
))
2796 (list file org-clock-file-total-minutes tbl
))))
2798 (defun org-clock-time%
(total &rest strings
)
2799 "Compute a time fraction in percent.
2800 TOTAL s a time string like 10:21 specifying the total times.
2801 STRINGS is a list of strings that should be checked for a time.
2802 The first string that does have a time will be used.
2803 This function is made for clock tables."
2804 (let ((re "\\([0-9]+\\):\\([0-9]+\\)")
2808 (if (not (string-match re total
))
2810 (setq tot
(+ (string-to-number (match-string 2 total
))
2811 (* 60 (string-to-number (match-string 1 total
)))))
2812 (if (= tot
0.
) (throw 'exit
0.
)))
2813 (while (setq s
(pop strings
))
2814 (if (string-match "\\([0-9]+\\):\\([0-9]+\\)" s
)
2816 (/ (* 100.0 (+ (string-to-number (match-string 2 s
))
2817 (* 60 (string-to-number
2818 (match-string 1 s
)))))
2822 ;; Saving and loading the clock
2824 (defvar org-clock-loaded nil
2825 "Was the clock file loaded?")
2828 (defun org-clock-update-time-maybe ()
2829 "If this is a CLOCK line, update it and return t.
2830 Otherwise, return nil."
2833 (beginning-of-line 1)
2834 (skip-chars-forward " \t")
2835 (when (looking-at org-clock-string
)
2836 (let ((re (concat "[ \t]*" org-clock-string
2837 " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
2838 "\\([ \t]*=>.*\\)?\\)?"))
2841 ((not (looking-at re
))
2843 ((not (match-end 2))
2844 (when (and (equal (marker-buffer org-clock-marker
) (current-buffer))
2845 (> org-clock-marker
(point))
2846 (<= org-clock-marker
(point-at-eol)))
2847 ;; The clock is running here
2848 (setq org-clock-start-time
2850 (org-parse-time-string (match-string 1))))
2851 (org-clock-update-mode-line)))
2853 (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
2855 (setq ts
(match-string 1)
2856 te
(match-string 3))
2857 (setq s
(- (org-float-time
2858 (apply 'encode-time
(org-parse-time-string te
)))
2860 (apply 'encode-time
(org-parse-time-string ts
))))
2863 h
(floor (/ s
3600))
2867 (insert " => " (format (if neg
"-%d:%02d" "%2d:%02d") h m
))
2870 (defun org-clock-save ()
2871 "Persist various clock-related data to disk.
2872 The details of what will be saved are regulated by the variable
2873 `org-clock-persist'."
2874 (when (and org-clock-persist
2875 (or org-clock-loaded
2876 org-clock-has-been-used
2877 (not (file-exists-p org-clock-persist-file
))))
2879 (with-current-buffer (find-file (expand-file-name org-clock-persist-file
))
2881 (delete-region (point-min) (point-max))
2883 (insert (format ";; org-persist.el - %s at %s\n"
2884 system-name
(format-time-string
2885 (cdr org-time-stamp-formats
))))
2886 (if (and (memq org-clock-persist
'(t clock
))
2887 (setq b
(org-clocking-buffer))
2888 (setq b
(or (buffer-base-buffer b
) b
))
2890 (buffer-file-name b
)
2891 (or (not org-clock-persist-query-save
)
2892 (y-or-n-p (concat "Save current clock ("
2893 org-clock-heading
") "))))
2894 (insert "(setq resume-clock '(\""
2895 (buffer-file-name (org-clocking-buffer))
2896 "\" . " (int-to-string (marker-position org-clock-marker
))
2898 ;; Store clocked task history. Tasks are stored reversed to make
2900 (when (and (memq org-clock-persist
'(t history
))
2903 "(setq stored-clock-history '("
2906 (when (and (setq b
(marker-buffer m
))
2907 (setq b
(or (buffer-base-buffer b
) b
))
2909 (buffer-file-name b
))
2910 (concat "(\"" (buffer-file-name b
)
2911 "\" . " (int-to-string (marker-position m
))
2913 (reverse org-clock-history
) " ") "))\n"))
2915 (kill-buffer (current-buffer)))))))
2917 (defun org-clock-load ()
2918 "Load clock-related data from disk, maybe resuming a stored clock."
2919 (when (and org-clock-persist
(not org-clock-loaded
))
2920 (let ((filename (expand-file-name org-clock-persist-file
))
2921 (org-clock-in-resume 'auto-restart
)
2922 resume-clock stored-clock-history
)
2923 (if (not (file-readable-p filename
))
2924 (message "Not restoring clock data; %s not found"
2925 org-clock-persist-file
)
2926 (message "%s" "Restoring clock data")
2927 (setq org-clock-loaded t
)
2928 (load-file filename
)
2930 (when stored-clock-history
2931 (save-window-excursion
2932 (mapc (lambda (task)
2933 (if (file-exists-p (car task
))
2934 (org-clock-history-push (cdr task
)
2935 (find-file (car task
)))))
2936 stored-clock-history
)))
2938 (when (and resume-clock org-clock-persist
2939 (file-exists-p (car resume-clock
))
2940 (or (not org-clock-persist-query-resume
)
2944 (with-current-buffer (find-file (car resume-clock
))
2946 (goto-char (cdr resume-clock
))
2947 (org-back-to-heading t
)
2948 (and (looking-at org-complex-heading-regexp
)
2951 (when (file-exists-p (car resume-clock
))
2952 (with-current-buffer (find-file (car resume-clock
))
2953 (goto-char (cdr resume-clock
))
2954 (let ((org-clock-auto-clock-resolution nil
))
2956 (if (outline-invisible-p)
2957 (org-show-context))))))))))
2959 ;; Suggested bindings
2960 (org-defkey org-mode-map
"\C-c\C-x\C-e" 'org-clock-modify-effort-estimate
)
2962 (provide 'org-clock
)
2965 ;; generated-autoload-file: "org-loaddefs.el"
2968 ;;; org-clock.el ends here
