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-element-property
"org-element" (property element
))
39 (declare-function org-element-type
"org-element" (element))
40 (declare-function org-table-goto-line
"org-table" (n))
41 (defvar org-time-stamp-formats
)
43 (defvar org-frame-title-format-backup frame-title-format
)
45 (defgroup org-clock nil
46 "Options concerning clocking working time in Org-mode."
50 (defcustom org-clock-into-drawer org-log-into-drawer
51 "Should clocking info be wrapped into a drawer?
52 When t, clocking info will always be inserted into a :LOGBOOK: drawer.
53 If necessary, the drawer will be created.
54 When nil, the drawer will not be created, but used when present.
55 When an integer and the number of clocking entries in an item
56 reaches or exceeds this number, a drawer will be created.
57 When a string, it names the drawer to be used.
59 The default for this variable is the value of `org-log-into-drawer',
64 (const :tag
"Always" t
)
65 (const :tag
"Only when drawer exists" nil
)
66 (integer :tag
"When at least N clock entries")
67 (const :tag
"Into LOGBOOK drawer" "LOGBOOK")
68 (string :tag
"Into Drawer named...")))
70 (defun org-clock-into-drawer ()
71 "Return the value of `org-clock-into-drawer', but let properties overrule.
72 If the current entry has or inherits a CLOCK_INTO_DRAWER
73 property, it will be used instead of the default value; otherwise
74 if the current entry has or inherits a LOG_INTO_DRAWER property,
75 it will be used instead of the default value.
76 The default is the value of the customizable variable `org-clock-into-drawer',
78 (let ((p (org-entry-get nil
"CLOCK_INTO_DRAWER" 'inherit t
))
79 (q (org-entry-get nil
"LOG_INTO_DRAWER" 'inherit t
)))
80 (cond ((equal p
"nil") nil
)
86 (t org-clock-into-drawer
))))
88 (defcustom org-clock-out-when-done t
89 "When non-nil, clock will be stopped when the clocked entry is marked DONE.
90 DONE here means any DONE-like state.
91 A nil value means clock will keep running until stopped explicitly with
92 `C-c C-x C-o', or until the clock is started in a different item.
93 Instead of t, this can also be a list of TODO states that should trigger
98 (const :tag
"Yes, when done" t
)
99 (repeat :tag
"State list"
100 (string :tag
"TODO keyword"))))
102 (defcustom org-clock-rounding-minutes
0
103 "Rounding minutes when clocking in or out.
104 The default value is 0 so that no rounding is done.
105 When set to a non-integer value, use the car of
106 `org-time-stamp-rounding-minutes', like for setting a time-stamp.
108 E.g. if `org-clock-rounding-minutes' is set to 5, time is 14:47
109 and you clock in: then the clock starts at 14:45. If you clock
110 out within the next 5 minutes, the clock line will be removed;
111 if you clock out 8 minutes after your clocked in, the clock
112 out time will be 14:50."
115 :package-version
'(Org .
"8.0")
117 (integer :tag
"Minutes (0 for no rounding)")
118 (symbol :tag
"Use `org-time-stamp-rounding-minutes'" 'same-as-time-stamp
)))
120 (defcustom org-clock-out-remove-zero-time-clocks nil
121 "Non-nil means remove the clock line when the resulting time is zero."
125 (defcustom org-clock-in-switch-to-state nil
126 "Set task to a special todo state while clocking it.
127 The value should be the state to which the entry should be
128 switched. If the value is a function, it must take one
129 parameter (the current TODO state of the item) and return the
130 state to switch it to."
134 (const :tag
"Don't force a state" nil
)
135 (string :tag
"State")
136 (symbol :tag
"Function")))
138 (defcustom org-clock-out-switch-to-state nil
139 "Set task to a special todo state after clocking out.
140 The value should be the state to which the entry should be
141 switched. If the value is a function, it must take one
142 parameter (the current TODO state of the item) and return the
143 state to switch it to."
147 (const :tag
"Don't force a state" nil
)
148 (string :tag
"State")
149 (symbol :tag
"Function")))
151 (defcustom org-clock-history-length
5
152 "Number of clock tasks to remember in history."
156 (defcustom org-clock-goto-may-find-recent-task t
157 "Non-nil means `org-clock-goto' can go to recent task if no active clock."
161 (defcustom org-clock-heading-function nil
162 "When non-nil, should be a function to create `org-clock-heading'.
163 This is the string shown in the mode line when a clock is running.
164 The function is called with point at the beginning of the headline."
166 :type
'(choice (const nil
) (function)))
168 (defcustom org-clock-string-limit
0
169 "Maximum length of clock strings in the mode line. 0 means no limit."
173 (defcustom org-clock-in-resume nil
174 "If non-nil, resume clock when clocking into task with open clock.
175 When clocking into a task with a clock entry which has not been closed,
176 the clock can be resumed from that point."
180 (defcustom org-clock-persist nil
181 "When non-nil, save the running clock when Emacs is closed.
182 The clock is resumed when Emacs restarts.
183 When this is t, both the running clock, and the entire clock
184 history are saved. When this is the symbol `clock', only the
185 running clock is saved. When this is the symbol `history', only
186 the clock history is saved.
188 When Emacs restarts with saved clock information, the file containing
189 the running clock as well as all files mentioned in the clock history
192 All this depends on running `org-clock-persistence-insinuate' in your
193 Emacs initialization file."
196 (const :tag
"Just the running clock" clock
)
197 (const :tag
"Just the history" history
)
198 (const :tag
"Clock and history" t
)
199 (const :tag
"No persistence" nil
)))
201 (defcustom org-clock-persist-file
(convert-standard-filename
202 (concat user-emacs-directory
"org-clock-save.el"))
203 "File to save clock data to."
207 (defcustom org-clock-persist-query-save nil
208 "When non-nil, ask before saving the current clock on exit."
212 (defcustom org-clock-persist-query-resume t
213 "When non-nil, ask before resuming any stored clock during load."
217 (defcustom org-clock-sound nil
218 "Sound to use for notifications.
222 t Standard Emacs beep
223 file name Play this sound file, fall back to beep"
226 (const :tag
"No sound" nil
)
227 (const :tag
"Standard beep" t
)
228 (file :tag
"Play sound file")))
230 (define-obsolete-variable-alias 'org-clock-modeline-total
231 'org-clock-mode-line-total
"24.3")
233 (defcustom org-clock-mode-line-total
'auto
234 "Default setting for the time included for the mode line clock.
235 This can be overruled locally using the CLOCK_MODELINE_TOTAL property.
238 current Only the time in the current instance of the clock
239 today All time clocked into this task today
240 repeat All time clocked into this task since last repeat
241 all All time ever recorded for this task
242 auto Automatically, either `all', or `repeat' for repeating tasks"
245 (const :tag
"Current clock" current
)
246 (const :tag
"Today's task time" today
)
247 (const :tag
"Since last repeat" repeat
)
248 (const :tag
"All task time" all
)
249 (const :tag
"Automatically, `all' or since `repeat'" auto
)))
251 (org-defvaralias 'org-task-overrun-text
'org-clock-task-overrun-text
)
252 (defcustom org-clock-task-overrun-text nil
253 "Extra mode line text to indicate that the clock is overrun.
254 The can be nil to indicate that instead of adding text, the clock time
255 should get a different face (`org-mode-line-clock-overrun').
256 When this is a string, it is prepended to the clock string as an indication,
257 also using the face `org-mode-line-clock-overrun'."
261 (const :tag
"Just mark the time string" nil
)
262 (string :tag
"Text to prepend")))
264 (defcustom org-show-notification-handler nil
265 "Function or program to send notification with.
266 The function or program will be called with the notification
271 (string :tag
"Program")
272 (function :tag
"Function")))
274 (defgroup org-clocktable nil
275 "Options concerning the clock table in Org-mode."
276 :tag
"Org Clock Table"
279 (defcustom org-clocktable-defaults
282 :lang
(or (org-bound-and-true-p org-export-default-language
) "en")
302 "Default properties for clock tables."
307 (defcustom org-clock-clocktable-formatter
'org-clocktable-write-default
308 "Function to turn clocking data into a table.
309 For more information, see `org-clocktable-write-default'."
310 :group
'org-clocktable
314 ;; FIXME: translate es and nl last string "Clock summary at"
315 (defcustom org-clock-clocktable-language-setup
316 '(("en" "File" "L" "Timestamp" "Headline" "Time" "ALL" "Total time" "File time" "Clock summary at")
317 ("es" "Archivo" "N" "Fecha y hora" "Tarea" "Tiempo" "TODO" "Tiempo total" "Tiempo archivo" "Clock summary at")
318 ("fr" "Fichier" "N" "Horodatage" "En-tête" "Durée" "TOUT" "Durée totale" "Durée fichier" "Horodatage sommaire à ")
319 ("nl" "Bestand" "N" "Tijdstip" "Hoofding" "Duur" "ALLES" "Totale duur" "Bestandstijd" "Clock summary at"))
320 "Terms used in clocktable, translated to different languages."
321 :group
'org-clocktable
325 (defcustom org-clock-clocktable-default-properties
'(:maxlevel
2 :scope file
)
326 "Default properties for new clocktables.
327 These will be inserted into the BEGIN line, to make it easy for users to
329 :group
'org-clocktable
332 (defcustom org-clock-idle-time nil
333 "When non-nil, resolve open clocks if the user is idle more than X minutes."
336 (const :tag
"Never" nil
)
337 (integer :tag
"After N minutes")))
339 (defcustom org-clock-auto-clock-resolution
'when-no-clock-is-running
340 "When to automatically resolve open clocks found in Org buffers."
343 (const :tag
"Never" nil
)
344 (const :tag
"Always" t
)
345 (const :tag
"When no clock is running" when-no-clock-is-running
)))
347 (defcustom org-clock-report-include-clocking-task nil
348 "When non-nil, include the current clocking task time in clock reports."
353 (defcustom org-clock-resolve-expert nil
354 "Non-nil means do not show the splash buffer with the clock resolver."
359 (defcustom org-clock-continuously nil
360 "Non-nil means to start clocking from the last clock-out time, if any."
365 (defcustom org-clock-total-time-cell-format
"*%s*"
366 "Format string for the total time cells."
371 (defcustom org-clock-file-time-cell-format
"*%s*"
372 "Format string for the file time cells."
377 (defcustom org-clock-clocked-in-display
'mode-line
378 "When clocked in for a task, org-mode can display the current
379 task and accumulated time in the mode line and/or frame title.
382 both displays in both mode line and frame title
383 mode-line displays only in mode line (default)
384 frame-title displays only in frame title
385 nil current clock is not displayed"
388 (const :tag
"Mode line" mode-line
)
389 (const :tag
"Frame title" frame-title
)
390 (const :tag
"Both" both
)
391 (const :tag
"None" nil
)))
393 (defcustom org-clock-frame-title-format
'(t org-mode-line-string
)
394 "The value for `frame-title-format' when clocking in.
396 When `org-clock-clocked-in-display' is set to 'frame-title
397 or 'both, clocking in will replace `frame-title-format' with
398 this value. Clocking out will restore `frame-title-format'.
400 `org-frame-title-string' is a format string using the same
401 specifications than `frame-title-format', which see."
406 (defcustom org-clock-x11idle-program-name
"x11idle"
407 "Name of the program which prints X11 idle time in milliseconds.
409 You can find x11idle.c in the contrib/scripts directory of the
410 Org git distribution. Or, you can do:
412 sudo apt-get install xprintidle
414 if you are using Debian."
417 :package-version
'(Org .
"8.0")
420 (defcustom org-clock-goto-before-context
2
421 "Number of lines of context to display before currently clocked-in entry.
422 This applies when using `org-clock-goto'."
426 (defcustom org-clock-display-default-range
'thisyear
427 "Default range when displaying clocks with `org-clock-display'."
429 :type
'(choice (const today
)
437 (const :tag
"Select range interactively" interactive
)))
439 (defvar org-clock-in-prepare-hook nil
440 "Hook run when preparing the clock.
441 This hook is run before anything happens to the task that
442 you want to clock in. For example, you can use this hook
443 to add an effort property.")
444 (defvar org-clock-in-hook nil
445 "Hook run when starting the clock.")
446 (defvar org-clock-out-hook nil
447 "Hook run when stopping the current clock.")
449 (defvar org-clock-cancel-hook nil
450 "Hook run when canceling the current clock.")
451 (defvar org-clock-goto-hook nil
452 "Hook run when selecting the currently clocked-in entry.")
453 (defvar org-clock-has-been-used nil
454 "Has the clock been used during the current Emacs session?")
456 ;;; The clock for measuring work time.
458 (defvar org-mode-line-string
"")
459 (put 'org-mode-line-string
'risky-local-variable t
)
461 (defvar org-clock-mode-line-timer nil
)
462 (defvar org-clock-idle-timer nil
)
463 (defvar org-clock-heading
) ; defined in org.el
464 (defvar org-clock-start-time
"")
466 (defvar org-clock-leftover-time nil
467 "If non-nil, user canceled a clock; this is when leftover time started.")
469 (defvar org-clock-effort
""
470 "Effort estimate of the currently clocking task.")
472 (defvar org-clock-total-time nil
473 "Holds total time, spent previously on currently clocked item.
474 This does not include the time in the currently running clock.")
476 (defvar org-clock-history nil
477 "List of marker pointing to recent clocked tasks.")
479 (defvar org-clock-default-task
(make-marker)
480 "Marker pointing to the default task that should clock time.
481 The clock can be made to switch to this task after clocking out
482 of a different task.")
484 (defvar org-clock-interrupted-task
(make-marker)
485 "Marker pointing to the task that has been interrupted by the current clock.")
487 (defvar org-clock-mode-line-map
(make-sparse-keymap))
488 (define-key org-clock-mode-line-map
[mode-line mouse-2
] 'org-clock-goto
)
489 (define-key org-clock-mode-line-map
[mode-line mouse-1
] 'org-clock-menu
)
491 (defun org-clock-menu ()
495 ["Clock out" org-clock-out t
]
496 ["Change effort estimate" org-clock-modify-effort-estimate t
]
497 ["Go to clock entry" org-clock-goto t
]
498 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t
:keys
"C-u C-c C-x C-i"])))
500 (defun org-clock-history-push (&optional pos buffer
)
501 "Push a marker to the clock history."
502 (setq org-clock-history-length
(max 1 (min 35 org-clock-history-length
)))
503 (let ((m (move-marker (make-marker)
504 (or pos
(point)) (org-base-buffer
505 (or buffer
(current-buffer)))))
507 (while (setq n
(member m org-clock-history
))
508 (move-marker (car n
) nil
))
509 (setq org-clock-history
511 (mapcar (lambda (x) (if (marker-buffer x
) x nil
))
513 (when (>= (setq l
(length org-clock-history
)) org-clock-history-length
)
514 (setq org-clock-history
516 (nthcdr (- l org-clock-history-length -
1)
517 (nreverse org-clock-history
)))))
518 (push m org-clock-history
)))
520 (defun org-clock-save-markers-for-cut-and-paste (beg end
)
521 "Save relative positions of markers in region."
522 (org-check-and-save-marker org-clock-marker beg end
)
523 (org-check-and-save-marker org-clock-hd-marker beg end
)
524 (org-check-and-save-marker org-clock-default-task beg end
)
525 (org-check-and-save-marker org-clock-interrupted-task beg end
)
526 (mapc (lambda (m) (org-check-and-save-marker m beg end
))
529 (defun org-clocking-buffer ()
530 "Return the clocking buffer if we are currently clocking a task or nil."
531 (marker-buffer org-clock-marker
))
533 (defun org-clocking-p ()
534 "Return t when clocking a task."
535 (not (equal (org-clocking-buffer) nil
)))
537 (defvar org-clock-before-select-task-hook nil
538 "Hook called in task selection just before prompting the user.")
540 (defun org-clock-select-task (&optional prompt
)
541 "Select a task that was recently associated with clocking."
543 (let (och chl sel-list rpl
(i 0) s
)
544 ;; Remove successive dups from the clock history to consider
545 (mapc (lambda (c) (if (not (equal c
(car och
))) (push c och
)))
547 (setq och
(reverse och
) chl
(length och
))
549 (user-error "No recent clock")
550 (save-window-excursion
551 (org-switch-to-buffer-other-window
552 (get-buffer-create "*Clock Task Select*"))
554 (when (marker-buffer org-clock-default-task
)
555 (insert (org-add-props "Default Task\n" nil
'face
'bold
))
556 (setq s
(org-clock-insert-selection-line ?d org-clock-default-task
))
558 (when (marker-buffer org-clock-interrupted-task
)
559 (insert (org-add-props "The task interrupted by starting the last one\n" nil
'face
'bold
))
560 (setq s
(org-clock-insert-selection-line ?i org-clock-interrupted-task
))
562 (when (org-clocking-p)
563 (insert (org-add-props "Current Clocking Task\n" nil
'face
'bold
))
564 (setq s
(org-clock-insert-selection-line ?c org-clock-marker
))
566 (insert (org-add-props "Recent Tasks\n" nil
'face
'bold
))
569 (when (marker-buffer m
)
571 s
(org-clock-insert-selection-line
575 (if (fboundp 'int-to-char
) (setf (car s
) (int-to-char (car s
))))
578 (run-hooks 'org-clock-before-select-task-hook
)
579 (goto-char (point-min))
580 ;; Set min-height relatively to circumvent a possible but in
581 ;; `fit-window-to-buffer'
582 (fit-window-to-buffer nil nil
(if (< chl
10) chl
(+ 5 chl
)))
583 (message (or prompt
"Select task for clocking:"))
584 (setq cursor-type nil rpl
(read-char-exclusive))
589 ((assoc rpl sel-list
) (cdr (assoc rpl sel-list
)))
590 (t (user-error "Invalid task choice %c" rpl
)))))))
592 (defun org-clock-insert-selection-line (i marker
)
593 "Insert a line for the clock selection menu.
594 And return a cons cell with the selection character integer and the marker
596 (when (marker-buffer marker
)
597 (let (file cat task heading prefix
)
598 (with-current-buffer (org-base-buffer (marker-buffer marker
))
604 (setq file
(buffer-file-name (marker-buffer marker
))
605 cat
(org-get-category)
606 heading
(org-get-heading 'notags
)
607 prefix
(save-excursion
608 (org-back-to-heading t
)
609 (looking-at org-outline-regexp
)
612 (org-fontify-like-in-org-mode
613 (concat prefix heading
)
615 (length prefix
)))))))
617 (insert (format "[%c] %-12s %s\n" i cat task
))
620 (defvar org-clock-task-overrun nil
621 "Internal flag indicating if the clock has overrun the planned time.")
622 (defvar org-clock-update-period
60
623 "Number of seconds between mode line clock string updates.")
625 (defun org-clock-get-clock-string ()
626 "Form a clock-string, that will be shown in the mode line.
627 If an effort estimate was defined for the current item, use
628 01:30/01:50 format (clocked/estimated).
629 If not, show simply the clocked time like 01:50."
630 (let ((clocked-time (org-clock-get-clocked-time)))
632 (let* ((effort-in-minutes
633 (org-duration-string-to-minutes org-clock-effort
))
636 (org-minutes-to-clocksum-string clocked-time
)
637 'face
(if (and org-clock-task-overrun
(not org-clock-task-overrun-text
))
638 'org-mode-line-clock-overrun
'org-mode-line-clock
)))
639 (effort-str (org-minutes-to-clocksum-string effort-in-minutes
))
640 (clockstr (org-propertize
641 (concat " [%s/" effort-str
642 "] (" (replace-regexp-in-string "%" "%%" org-clock-heading
) ")")
643 'face
'org-mode-line-clock
)))
644 (format clockstr work-done-str
))
645 (org-propertize (concat "[" (org-minutes-to-clocksum-string clocked-time
)
646 (format " (%s)" org-clock-heading
) "]")
647 'face
'org-mode-line-clock
))))
649 (defun org-clock-get-last-clock-out-time ()
650 "Get the last clock-out time for the current subtree."
652 (let ((end (save-excursion (org-end-of-subtree))))
653 (when (re-search-forward (concat org-clock-string
654 ".*\\]--\\(\\[[^]]+\\]\\)") end t
)
655 (org-time-string-to-time (match-string 1))))))
657 (defun org-clock-update-mode-line ()
659 (org-clock-notify-once-if-expired)
660 (setq org-clock-task-overrun nil
))
661 (setq org-mode-line-string
663 (let ((clock-string (org-clock-get-clock-string))
664 (help-text "Org-mode clock is running.\nmouse-1 shows a menu\nmouse-2 will jump to task"))
665 (if (and (> org-clock-string-limit
0)
666 (> (length clock-string
) org-clock-string-limit
))
668 (substring clock-string
0 org-clock-string-limit
)
669 'help-echo
(concat help-text
": " org-clock-heading
))
670 (org-propertize clock-string
'help-echo help-text
)))
671 'local-map org-clock-mode-line-map
672 'mouse-face
(if (featurep 'xemacs
) 'highlight
'mode-line-highlight
)))
673 (if (and org-clock-task-overrun org-clock-task-overrun-text
)
674 (setq org-mode-line-string
675 (concat (org-propertize
676 org-clock-task-overrun-text
677 'face
'org-mode-line-clock-overrun
) org-mode-line-string
)))
678 (force-mode-line-update))
680 (defun org-clock-get-clocked-time ()
681 "Get the clocked time for the current item in minutes.
682 The time returned includes the time spent on this task in
683 previous clocking intervals."
684 (let ((currently-clocked-time
685 (floor (- (org-float-time)
686 (org-float-time org-clock-start-time
)) 60)))
687 (+ currently-clocked-time
(or org-clock-total-time
0))))
689 (defun org-clock-modify-effort-estimate (&optional value
)
690 "Add to or set the effort estimate of the item currently being clocked.
691 VALUE can be a number of minutes, or a string with format hh:mm or mm.
692 When the string starts with a + or a - sign, the current value of the effort
693 property will be changed by that amount. If the effort value is expressed
694 as an `org-effort-durations' (e.g. \"3h\"), the modified value will be
695 converted to a hh:mm duration.
697 This command will update the \"Effort\" property of the currently
698 clocked item, and the value displayed in the mode line."
700 (if (org-clock-is-active)
701 (let ((current org-clock-effort
) sign
)
703 ;; Prompt user for a value or a change
706 (format "Set effort (hh:mm or mm%s): "
708 (format ", prefix + to add to %s" org-clock-effort
)
710 (when (stringp value
)
711 ;; A string. See if it is a delta
712 (setq sign
(string-to-char value
))
713 (if (member sign
'(?- ?
+))
714 (setq current
(org-duration-string-to-minutes current
)
715 value
(substring value
1))
717 (setq value
(org-duration-string-to-minutes value
))
719 (setq value
(- current value
))
720 (if (equal ?
+ sign
) (setq value
(+ current value
)))))
721 (setq value
(max 0 value
)
722 org-clock-effort
(org-minutes-to-clocksum-string value
))
723 (org-entry-put org-clock-marker
"Effort" org-clock-effort
)
724 (org-clock-update-mode-line)
725 (message "Effort is now %s" org-clock-effort
))
726 (message "Clock is not currently active")))
728 (defvar org-clock-notification-was-shown nil
729 "Shows if we have shown notification already.")
731 (defun org-clock-notify-once-if-expired ()
732 "Show notification if we spent more time than we estimated before.
733 Notification is shown only once."
734 (when (org-clocking-p)
735 (let ((effort-in-minutes (org-duration-string-to-minutes org-clock-effort
))
736 (clocked-time (org-clock-get-clocked-time)))
737 (if (setq org-clock-task-overrun
738 (if (or (null effort-in-minutes
) (zerop effort-in-minutes
))
740 (>= clocked-time effort-in-minutes
)))
741 (unless org-clock-notification-was-shown
742 (setq org-clock-notification-was-shown t
)
744 (format "Task '%s' should be finished by now. (%s)"
745 org-clock-heading org-clock-effort
) org-clock-sound
))
746 (setq org-clock-notification-was-shown nil
)))))
748 (defun org-notify (notification &optional play-sound
)
749 "Send a NOTIFICATION and maybe PLAY-SOUND.
750 If PLAY-SOUND is non-nil, it overrides `org-clock-sound'."
751 (org-show-notification notification
)
752 (if play-sound
(org-clock-play-sound play-sound
)))
754 (defun org-show-notification (notification)
756 Use `org-show-notification-handler' if defined,
757 use libnotify if available, or fall back on a message."
758 (cond ((functionp org-show-notification-handler
)
759 (funcall org-show-notification-handler notification
))
760 ((stringp org-show-notification-handler
)
761 (start-process "emacs-timer-notification" nil
762 org-show-notification-handler notification
))
763 ((fboundp 'notifications-notify
)
764 (notifications-notify
765 :title
"Org-mode message"
767 ;; FIXME how to link to the Org icon?
768 ;; :app-icon "~/.emacs.d/icons/mail.png"
770 ((executable-find "notify-send")
771 (start-process "emacs-timer-notification" nil
772 "notify-send" notification
))
773 ;; Maybe the handler will send a message, so only use message as
774 ;; a fall back option
775 (t (message "%s" notification
))))
777 (defun org-clock-play-sound (&optional clock-sound
)
778 "Play sound as configured by `org-clock-sound'.
779 Use alsa's aplay tool if available.
780 If CLOCK-SOUND is non-nil, it overrides `org-clock-sound'."
781 (let ((org-clock-sound (or clock-sound org-clock-sound
)))
783 ((not org-clock-sound
))
784 ((eq org-clock-sound t
) (beep t
) (beep t
))
785 ((stringp org-clock-sound
)
786 (let ((file (expand-file-name org-clock-sound
)))
787 (if (file-exists-p file
)
788 (if (executable-find "aplay")
789 (start-process "org-clock-play-notification" nil
792 (play-sound-file file
)
793 (error (beep t
) (beep t
))))))))))
795 (defvar org-clock-mode-line-entry nil
796 "Information for the mode line about the running clock.")
798 (defun org-find-open-clocks (file)
799 "Search through the given file and find all open clocks."
800 (let ((buf (or (get-file-buffer file
)
801 (find-file-noselect file
)))
802 (org-clock-re (concat org-clock-string
" \\(\\[.*?\\]\\)$"))
804 (with-current-buffer buf
806 (goto-char (point-min))
807 (while (re-search-forward org-clock-re nil t
)
808 (push (cons (copy-marker (match-end 1) t
)
809 (org-time-string-to-time (match-string 1))) clocks
))))
812 (defsubst org-is-active-clock
(clock)
813 "Return t if CLOCK is the currently active clock."
814 (and (org-clock-is-active)
815 (= org-clock-marker
(car clock
))))
817 (defmacro org-with-clock-position
(clock &rest forms
)
818 "Evaluate FORMS with CLOCK as the current active clock."
819 `(with-current-buffer (marker-buffer (car ,clock
))
823 (goto-char (car ,clock
))
826 (def-edebug-spec org-with-clock-position
(form body
))
827 (put 'org-with-clock-position
'lisp-indent-function
1)
829 (defmacro org-with-clock
(clock &rest forms
)
830 "Evaluate FORMS with CLOCK as the current active clock.
831 This macro also protects the current active clock from being altered."
832 `(org-with-clock-position ,clock
833 (let ((org-clock-start-time (cdr ,clock
))
834 (org-clock-total-time)
837 (org-clock-marker (car ,clock
))
838 (org-clock-hd-marker (save-excursion
839 (outline-back-to-heading t
)
842 (def-edebug-spec org-with-clock
(form body
))
843 (put 'org-with-clock
'lisp-indent-function
1)
845 (defsubst org-clock-clock-in
(clock &optional resume start-time
)
846 "Clock in to the clock located by CLOCK.
847 If necessary, clock-out of the currently active clock."
848 (org-with-clock-position clock
849 (let ((org-clock-in-resume (or resume org-clock-in-resume
)))
850 (org-clock-in nil start-time
))))
852 (defsubst org-clock-clock-out
(clock &optional fail-quietly at-time
)
853 "Clock out of the clock located by CLOCK."
854 (let ((temp (copy-marker (car clock
)
855 (marker-insertion-type (car clock
)))))
856 (if (org-is-active-clock clock
)
857 (org-clock-out nil fail-quietly at-time
)
858 (org-with-clock clock
859 (org-clock-out nil fail-quietly at-time
)))
860 (setcar clock temp
)))
862 (defsubst org-clock-clock-cancel
(clock)
863 "Cancel the clock located by CLOCK."
864 (let ((temp (copy-marker (car clock
)
865 (marker-insertion-type (car clock
)))))
866 (if (org-is-active-clock clock
)
868 (org-with-clock clock
870 (setcar clock temp
)))
872 (defvar org-clock-clocking-in nil
)
873 (defvar org-clock-resolving-clocks nil
)
874 (defvar org-clock-resolving-clocks-due-to-idleness nil
)
876 (defun org-clock-resolve-clock (clock resolve-to clock-out-time
877 &optional close-p restart-p fail-quietly
)
878 "Resolve `CLOCK' given the time `RESOLVE-TO', and the present.
879 `CLOCK' is a cons cell of the form (MARKER START-TIME)."
880 (let ((org-clock-resolving-clocks t
))
883 (org-clock-clock-cancel clock
)
884 (if (and restart-p
(not org-clock-clocking-in
))
885 (org-clock-clock-in clock
)))
887 ((eq resolve-to
'now
)
889 (error "RESTART-P is not valid here"))
890 (if (or close-p org-clock-clocking-in
)
891 (org-clock-clock-out clock fail-quietly
)
892 (unless (org-is-active-clock clock
)
893 (org-clock-clock-in clock t
))))
895 ((not (time-less-p resolve-to
(current-time)))
896 (error "RESOLVE-TO must refer to a time in the past"))
900 (error "RESTART-P is not valid here"))
901 (org-clock-clock-out clock fail-quietly
(or clock-out-time
903 (unless org-clock-clocking-in
905 (setq org-clock-leftover-time
(and (null clock-out-time
)
907 (org-clock-clock-in clock nil
(and clock-out-time
910 (defun org-clock-jump-to-current-clock (&optional effective-clock
)
912 (let ((org-clock-into-drawer (org-clock-into-drawer))
913 (clock (or effective-clock
(cons org-clock-marker
914 org-clock-start-time
))))
915 (unless (marker-buffer (car clock
))
916 (error "No clock is currently running"))
917 (org-with-clock clock
(org-clock-goto))
918 (with-current-buffer (marker-buffer (car clock
))
919 (goto-char (car clock
))
920 (if org-clock-into-drawer
922 (if (stringp org-clock-into-drawer
)
923 (concat ":" org-clock-into-drawer
":")
928 (outline-back-to-heading t
)
929 (search-forward logbook
)
930 (goto-char (match-beginning 0)))
932 (outline-back-to-heading t
)
933 (search-forward logbook
)
934 (search-forward ":END:")
935 (goto-char (match-end 0)))
938 (defun org-clock-resolve (clock &optional prompt-fn last-valid fail-quietly
)
939 "Resolve an open org-mode clock.
940 An open clock was found, with `dangling' possibly being non-nil.
941 If this function was invoked with a prefix argument, non-dangling
942 open clocks are ignored. The given clock requires some sort of
943 user intervention to resolve it, either because a clock was left
944 dangling or due to an idle timeout. The clock resolution can
947 (a) deleted, the user doesn't care about the clock
948 (b) restarted from the current time (if no other clock is open)
949 (c) closed, giving the clock X minutes
950 (d) closed and then restarted
951 (e) resumed, as if the user had never left
953 The format of clock is (CONS MARKER START-TIME), where MARKER
954 identifies the buffer and position the clock is open at (and
955 thus, the heading it's under), and START-TIME is when the clock
959 (save-window-excursion
961 (unless org-clock-resolving-clocks-due-to-idleness
962 (org-clock-jump-to-current-clock clock
))
963 (unless org-clock-resolve-expert
964 (with-output-to-temp-buffer "*Org Clock*"
965 (princ "Select a Clock Resolution Command:
967 i/q Ignore this question; the same as keeping all the idle time.
969 k/K Keep X minutes of the idle time (default is all). If this
970 amount is less than the default, you will be clocked out
971 that many minutes after the time that idling began, and then
972 clocked back in at the present time.
974 g/G Indicate that you \"got back\" X minutes ago. This is quite
975 different from 'k': it clocks you out from the beginning of
976 the idle period and clock you back in X minutes ago.
978 s/S Subtract the idle time from the current clock. This is the
979 same as keeping 0 minutes.
981 C Cancel the open timer altogether. It will be as though you
984 j/J Jump to the current clock, to make manual adjustments.
986 For all these options, using uppercase makes your final state
987 to be CLOCKED OUT.")))
988 (org-fit-window-to-buffer (get-buffer-window "*Org Clock*"))
990 (when (featurep 'xemacs
)
991 (message (concat (funcall prompt-fn clock
)
993 (setq char-pressed
(read-char-exclusive)))
994 (while (or (null char-pressed
)
995 (and (not (memq char-pressed
996 '(?k ?K ?g ?G ?s ?S ?C
1000 (read-char (concat (funcall prompt-fn clock
)
1003 (and (not (memq char-pressed
'(?i ?q
))) char-pressed
)))))
1005 (floor (/ (org-float-time
1006 (time-subtract (current-time) last-valid
)) 60)))
1008 (and (memq ch
'(?k ?K
))
1009 (read-number "Keep how many minutes? " default
)))
1011 (and (memq ch
'(?g ?G
))
1012 (read-number "Got back how many minutes ago? " default
)))
1013 (subtractp (memq ch
'(?s ?S
)))
1014 (barely-started-p (< (- (org-float-time last-valid
)
1015 (org-float-time (cdr clock
))) 45))
1016 (start-over (and subtractp barely-started-p
)))
1020 (org-clock-resolve-clock clock
'now nil t nil fail-quietly
))
1021 (org-clock-jump-to-current-clock clock
))
1023 (not (memq ch
'(?k ?K ?g ?G ?s ?S ?C
))))
1026 (org-clock-resolve-clock
1029 ;; If the time on the clock was less than a minute before
1030 ;; the user went away, and they've ask to subtract all the
1035 (and gotback
(= gotback
0)))
1037 ((or (and keep
(= keep default
))
1038 (and gotback
(= gotback default
)))
1041 (time-add last-valid
(seconds-to-time (* 60 keep
))))
1043 (time-subtract (current-time)
1044 (seconds-to-time (* 60 gotback
))))
1046 (error "Unexpected, please report this as a bug")))
1047 (and gotback last-valid
)
1048 (memq ch
'(?K ?G ?S
))
1050 (not (memq ch
'(?K ?G ?S ?C
))))
1054 (defun org-resolve-clocks (&optional only-dangling-p prompt-fn last-valid
)
1055 "Resolve all currently open org-mode clocks.
1056 If `only-dangling-p' is non-nil, only ask to resolve dangling
1057 \(i.e., not currently open and valid) clocks."
1059 (unless org-clock-resolving-clocks
1060 (let ((org-clock-resolving-clocks t
))
1061 (dolist (file (org-files-list))
1062 (let ((clocks (org-find-open-clocks file
)))
1063 (dolist (clock clocks
)
1064 (let ((dangling (or (not (org-clock-is-active))
1065 (/= (car clock
) org-clock-marker
))))
1066 (if (or (not only-dangling-p
) dangling
)
1073 "Dangling clock started %d mins ago"
1075 (/ (- (org-float-time (current-time))
1076 (org-float-time (cdr clock
))) 60))))))
1078 (cdr clock
)))))))))))
1080 (defun org-emacs-idle-seconds ()
1081 "Return the current Emacs idle time in seconds, or nil if not idle."
1082 (let ((idle-time (current-idle-time)))
1084 (org-float-time idle-time
)
1087 (defun org-mac-idle-seconds ()
1088 "Return the current Mac idle time in seconds."
1089 (string-to-number (shell-command-to-string "ioreg -c IOHIDSystem | perl -ane 'if (/Idle/) {$idle=(pop @F)/1000000000; print $idle; last}'")))
1091 (defvar org-x11idle-exists-p
1092 ;; Check that x11idle exists
1093 (and (eq window-system
'x
)
1094 (eq (call-process-shell-command "command" nil nil nil
"-v" org-clock-x11idle-program-name
) 0)
1095 ;; Check that x11idle can retrieve the idle time
1096 (eq (call-process-shell-command org-clock-x11idle-program-name nil nil nil
) 0)))
1098 (defun org-x11-idle-seconds ()
1099 "Return the current X11 idle time in seconds."
1100 (/ (string-to-number (shell-command-to-string org-clock-x11idle-program-name
)) 1000))
1102 (defun org-user-idle-seconds ()
1103 "Return the number of seconds the user has been idle for.
1104 This routine returns a floating point number."
1106 ((eq system-type
'darwin
)
1107 (org-mac-idle-seconds))
1108 ((and (eq window-system
'x
) org-x11idle-exists-p
)
1109 (org-x11-idle-seconds))
1111 (org-emacs-idle-seconds))))
1113 (defvar org-clock-user-idle-seconds
)
1115 (defun org-resolve-clocks-if-idle ()
1116 "Resolve all currently open org-mode clocks.
1117 This is performed after `org-clock-idle-time' minutes, to check
1118 if the user really wants to stay clocked in after being idle for
1120 (when (and org-clock-idle-time
(not org-clock-resolving-clocks
)
1121 org-clock-marker
(marker-buffer org-clock-marker
))
1122 (let* ((org-clock-user-idle-seconds (org-user-idle-seconds))
1123 (org-clock-user-idle-start
1124 (time-subtract (current-time)
1125 (seconds-to-time org-clock-user-idle-seconds
)))
1126 (org-clock-resolving-clocks-due-to-idleness t
))
1127 (if (> org-clock-user-idle-seconds
(* 60 org-clock-idle-time
))
1129 (cons org-clock-marker
1130 org-clock-start-time
)
1133 (format "Clocked in & idle for %.1f mins"
1135 (time-subtract (current-time)
1136 org-clock-user-idle-start
))
1138 org-clock-user-idle-start
)))))
1140 (defvar org-clock-current-task nil
"Task currently clocked in.")
1141 (defvar org-clock-out-time nil
) ; store the time of the last clock-out
1142 (defvar org--msg-extra
)
1145 (defun org-clock-in (&optional select start-time
)
1146 "Start the clock on the current item.
1147 If necessary, clock-out of the currently active clock.
1148 With a prefix argument SELECT (\\[universal-argument]), offer a list of recently clocked
1149 tasks to clock into. When SELECT is \\[universal-argument] \\[universal-argument], clock into the current task
1150 and mark it as the default task, a special task that will always be offered
1151 in the clocking selection, associated with the letter `d'.
1152 When SELECT is \\[universal-argument] \\[universal-argument] \\[universal-argument], \
1153 clock in by using the last clock-out
1154 time as the start time \(see `org-clock-continuously' to
1155 make this the default behavior.)"
1157 (setq org-clock-notification-was-shown nil
)
1158 (org-refresh-properties
1159 org-effort-property
'((effort . identity
)
1160 (effort-minutes . org-duration-string-to-minutes
)))
1162 (let ((interrupting (and (not org-clock-resolving-clocks-due-to-idleness
)
1164 ts selected-task target-pos
(org--msg-extra "")
1165 (leftover (and (not org-clock-resolving-clocks
)
1166 org-clock-leftover-time
)))
1168 (when (and org-clock-auto-clock-resolution
1169 (or (not interrupting
)
1170 (eq t org-clock-auto-clock-resolution
))
1171 (not org-clock-clocking-in
)
1172 (not org-clock-resolving-clocks
))
1173 (setq org-clock-leftover-time nil
)
1174 (let ((org-clock-clocking-in t
))
1175 (org-resolve-clocks))) ; check if any clocks are dangling
1177 (when (equal select
'(64))
1178 ;; Set start-time to `org-clock-out-time'
1179 (let ((org-clock-continuously t
))
1180 (org-clock-in nil org-clock-out-time
)))
1182 (when (equal select
'(4))
1183 (setq selected-task
(org-clock-select-task "Clock-in on task: "))
1185 (setq selected-task
(copy-marker selected-task
))
1188 (when (equal select
'(16))
1189 ;; Mark as default clocking task
1190 (org-clock-mark-default-task))
1193 ;; We are interrupting the clocking of a different task.
1194 ;; Save a marker to this task, so that we can go back.
1195 ;; First check if we are trying to clock into the same task!
1196 (when (save-excursion
1197 (unless selected-task
1198 (org-back-to-heading t
))
1199 (and (equal (marker-buffer org-clock-hd-marker
)
1201 (marker-buffer selected-task
)
1203 (= (marker-position org-clock-hd-marker
)
1205 (marker-position selected-task
)
1207 (equal org-clock-current-task
(nth 4 (org-heading-components)))))
1208 (message "Clock continues in \"%s\"" org-clock-heading
)
1210 (move-marker org-clock-interrupted-task
1211 (marker-position org-clock-marker
)
1212 (marker-buffer org-clock-marker
))
1213 (let ((org-clock-clocking-in t
))
1214 (org-clock-out nil t
)))
1216 ;; Clock in at which position?
1218 (if (and (eobp) (not (org-at-heading-p)))
1222 (when (and selected-task
(marker-buffer selected-task
))
1223 ;; There is a selected task, move to the correct buffer
1224 ;; and set the new target position.
1225 (set-buffer (org-base-buffer (marker-buffer selected-task
)))
1226 (setq target-pos
(marker-position selected-task
))
1227 (move-marker selected-task nil
))
1231 (goto-char target-pos
)
1232 (org-back-to-heading t
)
1233 (or interrupting
(move-marker org-clock-interrupted-task nil
))
1234 (run-hooks 'org-clock-in-prepare-hook
)
1235 (org-clock-history-push)
1236 (setq org-clock-current-task
(nth 4 (org-heading-components)))
1237 (cond ((functionp org-clock-in-switch-to-state
)
1238 (looking-at org-complex-heading-regexp
)
1239 (let ((newstate (funcall org-clock-in-switch-to-state
1241 (if newstate
(org-todo newstate
))))
1242 ((and org-clock-in-switch-to-state
1243 (not (looking-at (concat org-outline-regexp
"[ \t]*"
1244 org-clock-in-switch-to-state
1246 (org-todo org-clock-in-switch-to-state
)))
1247 (setq org-clock-heading
1248 (cond ((and org-clock-heading-function
1249 (functionp org-clock-heading-function
))
1250 (funcall org-clock-heading-function
))
1251 ((nth 4 (org-heading-components))
1252 (replace-regexp-in-string
1253 "\\[\\[.*?\\]\\[\\(.*?\\)\\]\\]" "\\1"
1254 (match-string-no-properties 4)))
1256 (org-clock-find-position org-clock-in-resume
)
1258 ((and org-clock-in-resume
1260 (concat "^[ \t]*" org-clock-string
1261 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1262 " *\\sw+\.? +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
1263 (message "Matched %s" (match-string 1))
1264 (setq ts
(concat "[" (match-string 1) "]"))
1265 (goto-char (match-end 1))
1266 (setq org-clock-start-time
1268 (org-parse-time-string (match-string 1))))
1269 (setq org-clock-effort
(org-entry-get (point) org-effort-property
))
1270 (setq org-clock-total-time
(org-clock-sum-current-item
1271 (org-clock-get-sum-start))))
1272 ((eq org-clock-in-resume
'auto-restart
)
1273 ;; called from org-clock-load during startup,
1274 ;; do not interrupt, but warn!
1275 (message "Cannot restart clock because task does not contain unfinished clock")
1280 (insert-before-markers "\n")
1283 (when (and (save-excursion
1286 (beginning-of-line 1)
1287 (org-indent-line-to (- (org-get-indentation) 2)))
1288 (insert org-clock-string
" ")
1289 (setq org-clock-effort
(org-entry-get (point) org-effort-property
))
1290 (setq org-clock-total-time
(org-clock-sum-current-item
1291 (org-clock-get-sum-start)))
1292 (setq org-clock-start-time
1293 (or (and org-clock-continuously org-clock-out-time
)
1297 "You stopped another clock %d mins ago; start this one from then? "
1298 (/ (- (org-float-time
1299 (org-current-time org-clock-rounding-minutes t
))
1300 (org-float-time leftover
)) 60)))
1303 (org-current-time org-clock-rounding-minutes t
)))
1304 (setq ts
(org-insert-time-stamp org-clock-start-time
1305 'with-hm
'inactive
))))
1306 (move-marker org-clock-marker
(point) (buffer-base-buffer))
1307 (move-marker org-clock-hd-marker
1308 (save-excursion (org-back-to-heading t
) (point))
1309 (buffer-base-buffer))
1310 (setq org-clock-has-been-used t
)
1312 (when (or (eq org-clock-clocked-in-display
'mode-line
)
1313 (eq org-clock-clocked-in-display
'both
))
1314 (or global-mode-string
(setq global-mode-string
'("")))
1315 (or (memq 'org-mode-line-string global-mode-string
)
1316 (setq global-mode-string
1317 (append global-mode-string
'(org-mode-line-string)))))
1318 ;; add to frame title
1319 (when (or (eq org-clock-clocked-in-display
'frame-title
)
1320 (eq org-clock-clocked-in-display
'both
))
1321 (setq frame-title-format org-clock-frame-title-format
))
1322 (org-clock-update-mode-line)
1323 (when org-clock-mode-line-timer
1324 (cancel-timer org-clock-mode-line-timer
)
1325 (setq org-clock-mode-line-timer nil
))
1326 (when org-clock-clocked-in-display
1327 (setq org-clock-mode-line-timer
1328 (run-with-timer org-clock-update-period
1329 org-clock-update-period
1330 'org-clock-update-mode-line
)))
1331 (when org-clock-idle-timer
1332 (cancel-timer org-clock-idle-timer
)
1333 (setq org-clock-idle-timer nil
))
1334 (setq org-clock-idle-timer
1335 (run-with-timer 60 60 'org-resolve-clocks-if-idle
))
1336 (message "Clock starts at %s - %s" ts org--msg-extra
)
1337 (run-hooks 'org-clock-in-hook
)))))))
1340 (defun org-clock-in-last (&optional arg
)
1341 "Clock in the last closed clocked item.
1342 When already clocking in, send an warning.
1343 With a universal prefix argument, select the task you want to
1344 clock in from the last clocked in tasks.
1345 With two universal prefix arguments, start clocking using the
1346 last clock-out time, if any.
1347 With three universal prefix arguments, interactively prompt
1348 for a todo state to switch to, overriding the existing value
1349 `org-clock-in-switch-to-state'."
1351 (if (equal arg
'(4))
1352 (org-clock-in (org-clock-select-task))
1353 (let ((start-time (if (or org-clock-continuously
(equal arg
'(16)))
1354 (or org-clock-out-time
1355 (org-current-time org-clock-rounding-minutes t
))
1356 (org-current-time org-clock-rounding-minutes t
))))
1357 (if (null org-clock-history
)
1358 (message "No last clock")
1359 (let ((org-clock-in-switch-to-state
1360 (if (and (not org-clock-current-task
) (equal arg
'(64)))
1361 (completing-read "Switch to state: "
1362 (and org-clock-history
1363 (with-current-buffer
1364 (marker-buffer (car org-clock-history
))
1365 org-todo-keywords-1
)))
1366 org-clock-in-switch-to-state
))
1367 (already-clocking org-clock-current-task
))
1368 (org-clock-clock-in (list (car org-clock-history
)) nil start-time
)
1369 (or already-clocking
1370 ;; Don't display a message if we are already clocking in
1371 (message "Clocking back: %s (in %s)"
1372 org-clock-current-task
1373 (buffer-name (marker-buffer org-clock-marker
)))))))))
1375 (defun org-clock-mark-default-task ()
1376 "Mark current task as default task."
1379 (org-back-to-heading t
)
1380 (move-marker org-clock-default-task
(point))))
1382 (defun org-clock-get-sum-start ()
1383 "Return the time from which clock times should be counted.
1384 This is for the currently running clock as it is displayed
1385 in the mode line. This function looks at the properties
1386 LAST_REPEAT and in particular CLOCK_MODELINE_TOTAL and the
1387 corresponding variable `org-clock-mode-line-total' and then
1388 decides which time to use."
1389 (let ((cmt (or (org-entry-get nil
"CLOCK_MODELINE_TOTAL")
1390 (symbol-name org-clock-mode-line-total
)))
1391 (lr (org-entry-get nil
"LAST_REPEAT")))
1393 ((equal cmt
"current")
1394 (setq org--msg-extra
"showing time in current clock instance")
1396 ((equal cmt
"today")
1397 (setq org--msg-extra
"showing today's task time.")
1398 (let* ((dt (decode-time (current-time)))
1401 (if (< hour org-extend-today-until
) (setf (nth 3 dt
) (1- day
)))
1402 (setf (nth 2 dt
) org-extend-today-until
)
1403 (setq dt
(append (list 0 0) (nthcdr 2 dt
)))
1404 (apply 'encode-time dt
)))
1405 ((or (equal cmt
"all")
1406 (and (or (not cmt
) (equal cmt
"auto"))
1408 (setq org--msg-extra
"showing entire task time.")
1410 ((or (equal cmt
"repeat")
1411 (and (or (not cmt
) (equal cmt
"auto"))
1413 (setq org--msg-extra
"showing task time since last repeat.")
1416 (org-time-string-to-time lr
)))
1419 (defun org-clock-find-position (find-unclosed)
1420 "Find the location where the next clock line should be inserted.
1421 When FIND-UNCLOSED is non-nil, first check if there is an unclosed clock
1422 line and position cursor in that line."
1423 (org-back-to-heading t
)
1425 (let* ((beg (line-beginning-position 2))
1426 (end (save-excursion (outline-next-heading) (point)))
1427 (org-clock-into-drawer (org-clock-into-drawer))
1429 ((not org-clock-into-drawer
) nil
)
1430 ((stringp org-clock-into-drawer
) org-clock-into-drawer
)
1432 ;; Look for a running clock if FIND-UNCLOSED in non-nil.
1434 (let ((open-clock-re
1437 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1438 " *\\sw+ +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
1439 (while (re-search-forward open-clock-re end t
)
1440 (let ((element (org-element-at-point)))
1441 (when (and (eq (org-element-type element
) 'clock
)
1442 (eq (org-element-property :status element
) 'running
))
1444 (throw 'exit t
))))))
1445 ;; Look for an existing clock drawer.
1448 (let ((drawer-re (concat "^[ \t]*:" drawer
":[ \t]*$")))
1449 (while (re-search-forward drawer-re end t
)
1450 (let ((element (org-element-at-point)))
1451 (when (eq (org-element-type element
) 'drawer
)
1452 (let ((cend (org-element-property :contents-end element
)))
1453 (if (and (not org-log-states-order-reversed
) cend
)
1456 (throw 'exit t
)))))))
1458 (let ((clock-re (concat "^[ \t]*" org-clock-string
))
1459 (count 0) positions first
)
1460 ;; Count the CLOCK lines and store their positions.
1462 (while (re-search-forward clock-re end t
)
1463 (let ((element (org-element-at-point)))
1464 (when (eq (org-element-type element
) 'clock
)
1465 (setq positions
(cons (line-beginning-position) positions
)
1466 count
(1+ count
))))))
1469 ;; Skip planning line and property drawer, if any.
1470 (when (org-looking-at-p org-planning-line-re
) (forward-line))
1471 (when (looking-at org-property-drawer-re
)
1472 (goto-char (match-end 0))
1474 (unless (bolp) (insert "\n"))
1475 ;; Create a new drawer if necessary.
1476 (when org-clock-into-drawer
1477 (let ((beg (point)))
1478 (insert ":" drawer
":\n:END:\n")
1479 (org-indent-region beg
(point))
1483 ;; When a clock drawer needs to be created because of the
1484 ;; number of clock items, collect all clocks in the section
1485 ;; and wrap them within the drawer.
1486 ((and (wholenump org-clock-into-drawer
)
1487 (>= (1+ count
) org-clock-into-drawer
))
1488 ;; Skip planning line and property drawer, if any.
1489 (when (org-looking-at-p org-planning-line-re
) (forward-line))
1490 (when (looking-at org-property-drawer-re
)
1491 (goto-char (match-end 0))
1493 (let ((beg (point)))
1499 (org-trim (delete-and-extract-region
1500 (save-excursion (skip-chars-backward " \r\t\n")
1501 (line-beginning-position 2))
1502 (line-beginning-position 2)))))
1505 (let ((end (point-marker)))
1507 (save-excursion (insert ":" drawer
":\n"))
1509 (org-indent-region (point) end
)
1511 (unless org-log-states-order-reversed
1513 (beginning-of-line -
1))
1514 (set-marker end nil
))))
1515 (org-log-states-order-reversed (goto-char (car (last positions
))))
1516 (t (goto-char (car positions
))))))))
1519 (defun org-clock-out (&optional switch-to-state fail-quietly at-time
)
1520 "Stop the currently running clock.
1521 Throw an error if there is no running clock and FAIL-QUIETLY is nil.
1522 With a universal prefix, prompt for a state to switch the clocked out task
1523 to, overriding the existing value of `org-clock-out-switch-to-state'."
1526 (when (not (org-clocking-p))
1527 (setq global-mode-string
1528 (delq 'org-mode-line-string global-mode-string
))
1529 (setq frame-title-format org-frame-title-format-backup
)
1530 (force-mode-line-update)
1531 (if fail-quietly
(throw 'exit t
) (user-error "No active clock")))
1532 (let ((org-clock-out-switch-to-state
1534 (completing-read "Switch to state: "
1535 (with-current-buffer
1536 (marker-buffer org-clock-marker
)
1537 org-todo-keywords-1
)
1539 org-clock-out-switch-to-state
))
1540 (now (org-current-time org-clock-rounding-minutes
))
1542 (setq org-clock-out-time now
)
1543 (save-excursion ; Do not replace this with `with-current-buffer'.
1544 (org-no-warnings (set-buffer (org-clocking-buffer)))
1547 (goto-char org-clock-marker
)
1548 (beginning-of-line 1)
1549 (if (and (looking-at (concat "[ \t]*" org-keyword-time-regexp
))
1550 (equal (match-string 1) org-clock-string
))
1551 (setq ts
(match-string 2))
1552 (if fail-quietly
(throw 'exit nil
) (error "Clock start time is gone")))
1553 (goto-char (match-end 0))
1554 (delete-region (point) (point-at-eol))
1556 (setq te
(org-insert-time-stamp (or at-time now
) 'with-hm
'inactive
))
1557 (setq s
(- (org-float-time (apply 'encode-time
(org-parse-time-string te
)))
1558 (org-float-time (apply 'encode-time
(org-parse-time-string ts
))))
1559 h
(floor (/ s
3600))
1563 (insert " => " (format "%2d:%02d" h m
))
1564 (when (setq remove
(and org-clock-out-remove-zero-time-clocks
1566 (beginning-of-line 1)
1567 (delete-region (point) (point-at-eol))
1568 (and (looking-at "\n") (> (point-max) (1+ (point)))
1570 (move-marker org-clock-marker nil
)
1571 (move-marker org-clock-hd-marker nil
)
1572 (when org-log-note-clock-out
1573 (org-add-log-setup 'clock-out nil nil nil nil
1574 (concat "# Task: " (org-get-heading t
) "\n\n")))
1575 (when org-clock-mode-line-timer
1576 (cancel-timer org-clock-mode-line-timer
)
1577 (setq org-clock-mode-line-timer nil
))
1578 (when org-clock-idle-timer
1579 (cancel-timer org-clock-idle-timer
)
1580 (setq org-clock-idle-timer nil
))
1581 (setq global-mode-string
1582 (delq 'org-mode-line-string global-mode-string
))
1583 (setq frame-title-format org-frame-title-format-backup
)
1584 (when org-clock-out-switch-to-state
1586 (org-back-to-heading t
)
1587 (let ((org-inhibit-logging t
)
1588 (org-clock-out-when-done nil
))
1590 ((functionp org-clock-out-switch-to-state
)
1591 (looking-at org-complex-heading-regexp
)
1592 (let ((newstate (funcall org-clock-out-switch-to-state
1594 (if newstate
(org-todo newstate
))))
1595 ((and org-clock-out-switch-to-state
1596 (not (looking-at (concat org-outline-regexp
"[ \t]*"
1597 org-clock-out-switch-to-state
1599 (org-todo org-clock-out-switch-to-state
))))))
1600 (force-mode-line-update)
1601 (message (concat "Clock stopped at %s after "
1602 (org-minutes-to-clocksum-string (+ (* 60 h
) m
)) "%s")
1603 te
(if remove
" => LINE REMOVED" ""))
1604 (let ((h org-clock-out-hook
))
1605 ;; If a closing note needs to be stored in the drawer
1606 ;; where clocks are stored, let's temporarily disable
1607 ;; `org-clock-remove-empty-clock-drawer'
1608 (if (and (equal org-clock-into-drawer org-log-into-drawer
)
1609 (eq org-log-done
'note
)
1610 org-clock-out-when-done
)
1611 (setq h
(delq 'org-clock-remove-empty-clock-drawer h
)))
1612 (mapc (lambda (f) (funcall f
)) h
))
1613 (unless (org-clocking-p)
1614 (setq org-clock-current-task nil
)))))))
1616 (add-hook 'org-clock-out-hook
'org-clock-remove-empty-clock-drawer
)
1618 (defun org-clock-remove-empty-clock-drawer nil
1619 "Remove empty clock drawer in the current subtree."
1620 (let* ((olid (or (org-entry-get (point) "LOG_INTO_DRAWER")
1621 org-log-into-drawer
))
1622 (clock-drawer (if (eq t olid
) "LOGBOOK" olid
))
1623 (end (save-excursion (org-end-of-subtree t t
))))
1626 (org-back-to-heading t
)
1627 (while (and (< (point) end
)
1628 (search-forward clock-drawer end t
))
1629 (goto-char (match-beginning 0))
1630 (org-remove-empty-drawer-at (point))
1631 (forward-line 1))))))
1633 (defun org-clock-timestamps-up (&optional n
)
1634 "Increase CLOCK timestamps at cursor.
1635 Optional argument N tells to change by that many units."
1637 (org-clock-timestamps-change 'up n
))
1639 (defun org-clock-timestamps-down (&optional n
)
1640 "Increase CLOCK timestamps at cursor.
1641 Optional argument N tells to change by that many units."
1643 (org-clock-timestamps-change 'down n
))
1645 (defun org-clock-timestamps-change (updown &optional n
)
1646 "Change CLOCK timestamps synchronously at cursor.
1647 UPDOWN tells whether to change 'up or 'down.
1648 Optional argument N tells to change by that many units."
1649 (setq org-ts-what nil
)
1650 (when (org-at-timestamp-p t
)
1651 (let ((tschange (if (eq updown
'up
) 'org-timestamp-up
1652 'org-timestamp-down
))
1653 ts1 begts1 ts2 begts2 updatets1 tdiff
)
1655 (move-beginning-of-line 1)
1656 (re-search-forward org-ts-regexp3 nil t
)
1657 (setq ts1
(match-string 0) begts1
(match-beginning 0))
1658 (when (re-search-forward org-ts-regexp3 nil t
)
1659 (setq ts2
(match-string 0) begts2
(match-beginning 0))))
1660 ;; Are we on the second timestamp?
1661 (if (<= begts2
(point)) (setq updatets1 t
))
1663 ;; fall back on org-timestamp-up if there is only one
1664 (funcall tschange n
)
1665 ;; setq this so that (boundp 'org-ts-what is non-nil)
1666 (funcall tschange n
)
1667 (let ((ts (if updatets1 ts2 ts1
))
1668 (begts (if updatets1 begts1 begts2
)))
1671 (org-time-string-to-time org-last-changed-timestamp
)
1672 (org-time-string-to-time ts
)))
1675 (org-timestamp-change
1676 (round (/ (org-float-time tdiff
)
1677 (cond ((eq org-ts-what
'minute
) 60)
1678 ((eq org-ts-what
'hour
) 3600)
1679 ((eq org-ts-what
'day
) (* 24 3600))
1680 ((eq org-ts-what
'month
) (* 24 3600 31))
1681 ((eq org-ts-what
'year
) (* 24 3600 365.2)))))
1682 org-ts-what
'updown
)))))))
1685 (defun org-clock-cancel ()
1686 "Cancel the running clock by removing the start timestamp."
1688 (when (not (org-clocking-p))
1689 (setq global-mode-string
1690 (delq 'org-mode-line-string global-mode-string
))
1691 (setq frame-title-format org-frame-title-format-backup
)
1692 (force-mode-line-update)
1693 (error "No active clock"))
1694 (save-excursion ; Do not replace this with `with-current-buffer'.
1695 (org-no-warnings (set-buffer (org-clocking-buffer)))
1696 (goto-char org-clock-marker
)
1697 (if (org-looking-back (concat "^[ \t]*" org-clock-string
".*"))
1698 (progn (delete-region (1- (point-at-bol)) (point-at-eol))
1699 (org-remove-empty-drawer-at (point)))
1700 (message "Clock gone, cancel the timer anyway")
1702 (move-marker org-clock-marker nil
)
1703 (move-marker org-clock-hd-marker nil
)
1704 (setq global-mode-string
1705 (delq 'org-mode-line-string global-mode-string
))
1706 (setq frame-title-format org-frame-title-format-backup
)
1707 (force-mode-line-update)
1708 (message "Clock canceled")
1709 (run-hooks 'org-clock-cancel-hook
))
1712 (defun org-clock-goto (&optional select
)
1713 "Go to the currently clocked-in entry, or to the most recently clocked one.
1714 With prefix arg SELECT, offer recently clocked tasks for selection."
1719 (or (org-clock-select-task "Select task to go to: ")
1720 (error "No task selected")))
1721 ((org-clocking-p) org-clock-marker
)
1722 ((and org-clock-goto-may-find-recent-task
1723 (car org-clock-history
)
1724 (marker-buffer (car org-clock-history
)))
1726 (car org-clock-history
))
1727 (t (error "No active or recent clock task")))))
1728 (org-pop-to-buffer-same-window (marker-buffer m
))
1729 (if (or (< m
(point-min)) (> m
(point-max))) (widen))
1732 (org-back-to-heading t
)
1733 (org-cycle-hide-drawers 'children
)
1734 (recenter org-clock-goto-before-context
)
1737 (message "No running clock, this is the most recently clocked task"))
1738 (run-hooks 'org-clock-goto-hook
)))
1740 (defvar org-clock-file-total-minutes nil
1741 "Holds the file total time in minutes, after a call to `org-clock-sum'.")
1742 (make-variable-buffer-local 'org-clock-file-total-minutes
)
1744 (defun org-clock-sum-today (&optional headline-filter
)
1745 "Sum the times for each subtree for today."
1746 (let ((range (org-clock-special-range 'today
)))
1747 (org-clock-sum (car range
) (cadr range
)
1748 headline-filter
:org-clock-minutes-today
)))
1750 (defun org-clock-sum-custom (&optional headline-filter range propname
)
1751 "Sum the times for each subtree for today."
1752 (let ((r (or (and (symbolp range
) (org-clock-special-range range
))
1753 (org-clock-special-range
1754 (intern (completing-read
1756 '("today" "yesterday" "thisweek" "lastweek"
1757 "thismonth" "lastmonth" "thisyear" "lastyear"
1760 (org-clock-sum (car r
) (cadr r
)
1761 headline-filter
(or propname
:org-clock-minutes-custom
))))
1764 (defun org-clock-sum (&optional tstart tend headline-filter propname
)
1765 "Sum the times for each subtree.
1766 Puts the resulting times in minutes as a text property on each headline.
1767 TSTART and TEND can mark a time range to be considered.
1768 HEADLINE-FILTER is a zero-arg function that, if specified, is called for
1769 each headline in the time range with point at the headline. Headlines for
1770 which HEADLINE-FILTER returns nil are excluded from the clock summation.
1771 PROPNAME lets you set a custom text property instead of :org-clock-minutes."
1772 (org-with-silent-modifications
1773 (let* ((re (concat "^\\(\\*+\\)[ \t]\\|^[ \t]*"
1775 "[ \t]*\\(?:\\(\\[.*?\\]\\)-+\\(\\[.*?\\]\\)\\|=>[ \t]+\\([0-9]+\\):\\([0-9]+\\)\\)"))
1777 (ltimes (make-vector lmax
0))
1782 (if (stringp tstart
) (setq tstart
(org-time-string-to-seconds tstart
)))
1783 (if (stringp tend
) (setq tend
(org-time-string-to-seconds tend
)))
1784 (if (consp tstart
) (setq tstart
(org-float-time tstart
)))
1785 (if (consp tend
) (setq tend
(org-float-time tend
)))
1786 (remove-text-properties (point-min) (point-max)
1787 `(,(or propname
:org-clock-minutes
) t
1788 :org-clock-force-headline-inclusion t
))
1790 (goto-char (point-max))
1791 (while (re-search-backward re nil t
)
1795 (setq ts
(match-string 2)
1798 (apply 'encode-time
(org-parse-time-string ts
)))
1800 (apply 'encode-time
(org-parse-time-string te
)))
1801 ts
(if tstart
(max ts tstart
) ts
)
1802 te
(if tend
(min te tend
) te
)
1804 t1
(if (> dt
0) (+ t1
(floor (/ dt
60))) t1
)))
1807 (setq t1
(+ t1
(string-to-number (match-string 5))
1808 (* 60 (string-to-number (match-string 4))))))
1810 ;; Add the currently clocking item time to the total
1811 (when (and org-clock-report-include-clocking-task
1812 (equal (org-clocking-buffer) (current-buffer))
1813 (equal (marker-position org-clock-hd-marker
) (point))
1816 (>= (org-float-time org-clock-start-time
) tstart
)
1817 (<= (org-float-time org-clock-start-time
) tend
))
1818 (let ((time (floor (- (org-float-time)
1819 (org-float-time org-clock-start-time
)) 60)))
1820 (setq t1
(+ t1 time
))))
1821 (let* ((headline-forced
1822 (get-text-property (point)
1823 :org-clock-force-headline-inclusion
))
1825 (or (null headline-filter
)
1827 (save-match-data (funcall headline-filter
))))))
1828 (setq level
(- (match-end 1) (match-beginning 1)))
1829 (when (>= level lmax
)
1830 (setq ltimes
(vconcat ltimes
(make-vector lmax
0)) lmax
(* 2 lmax
)))
1831 (when (or (> t1
0) (> (aref ltimes level
) 0))
1832 (when (or headline-included headline-forced
)
1833 (if headline-included
1834 (loop for l from
0 to level do
1835 (aset ltimes l
(+ (aref ltimes l
) t1
))))
1836 (setq time
(aref ltimes level
))
1837 (goto-char (match-beginning 0))
1838 (put-text-property (point) (point-at-eol)
1839 (or propname
:org-clock-minutes
) time
)
1844 (> (funcall outline-level
) 1)
1845 (outline-up-heading 1 t
)
1847 (point) (point-at-eol)
1848 :org-clock-force-headline-inclusion t
))))))
1850 (loop for l from level to
(1- lmax
) do
1851 (aset ltimes l
0)))))))
1852 (setq org-clock-file-total-minutes
(aref ltimes
0))))))
1854 (defun org-clock-sum-current-item (&optional tstart
)
1855 "Return time, clocked on current item in total."
1858 (org-narrow-to-subtree)
1859 (org-clock-sum tstart
)
1860 org-clock-file-total-minutes
)))
1863 (defun org-clock-display (&optional arg
)
1864 "Show subtree times in the entire buffer.
1866 With one universal prefix argument, show the total time for
1867 today. With two universal prefix arguments, show the total time
1868 for a custom range, entered at the prompt. With three universal
1869 prefix arguments, show the total time in the echo area.
1871 Use \\[org-clock-remove-overlays] to remove the subtree times."
1873 (org-clock-remove-overlays)
1874 (let* ((todayp (equal arg
'(4)))
1875 (customp (member arg
'((16) today yesterday
1876 thisweek lastweek thismonth
1877 lastmonth thisyear lastyear
1879 (prop (cond ((not arg
) :org-clock-minutes-default
)
1880 (todayp :org-clock-minutes-today
)
1881 (customp :org-clock-minutes-custom
)
1882 (t :org-clock-minutes
)))
1884 (cond ((not arg
) (org-clock-sum-custom
1885 nil org-clock-display-default-range prop
))
1886 (todayp (org-clock-sum-today))
1887 (customp (org-clock-sum-custom nil arg
))
1888 (t (org-clock-sum)))
1889 (unless (eq arg
'(64))
1891 (goto-char (point-min))
1892 (while (or (and (equal (setq p
(point)) (point-min))
1893 (get-text-property p prop
))
1894 (setq p
(next-single-property-change
1897 (when (setq time
(get-text-property p prop
))
1898 (org-clock-put-overlay time
)))
1899 (setq h
(/ org-clock-file-total-minutes
60)
1900 m
(- org-clock-file-total-minutes
(* 60 h
)))
1901 ;; Arrange to remove the overlays upon next change.
1902 (when org-remove-highlights-with-change
1903 (org-add-hook 'before-change-functions
'org-clock-remove-overlays
1905 (message (concat (format "Total file time%s: "
1906 (cond (todayp " for today")
1907 (customp " (custom)")
1909 (org-minutes-to-clocksum-string
1910 org-clock-file-total-minutes
)
1911 " (%d hours and %d minutes)")
1914 (defvar org-clock-overlays nil
)
1915 (make-variable-buffer-local 'org-clock-overlays
)
1917 (defun org-clock-put-overlay (time)
1918 "Put an overlays on the current line, displaying TIME.
1919 This creates a new overlay and stores it in `org-clock-overlays', so that it
1920 will be easy to remove."
1923 (when (looking-at org-complex-heading-regexp
)
1924 (goto-char (match-beginning 4)))
1925 (setq ov
(make-overlay (point) (point-at-eol))
1926 tx
(concat (buffer-substring-no-properties (point) (match-end 4))
1929 (max 0 (- (- 60 (current-column))
1930 (- (match-end 4) (match-beginning 4))
1931 (length (org-get-at-bol 'line-prefix
)))) ?·
)
1934 (format " %9s " (org-minutes-to-clocksum-string time
))
1935 '(face org-clock-overlay
))
1937 (if (not (featurep 'xemacs
))
1938 (overlay-put ov
'display tx
)
1939 (overlay-put ov
'invisible t
)
1940 (overlay-put ov
'end-glyph
(make-glyph tx
)))
1941 (push ov org-clock-overlays
)))
1944 (defun org-clock-remove-overlays (&optional beg end noremove
)
1945 "Remove the occur highlights from the buffer.
1946 BEG and END are ignored. If NOREMOVE is nil, remove this function
1947 from the `before-change-functions' in the current buffer."
1949 (unless org-inhibit-highlight-removal
1950 (mapc 'delete-overlay org-clock-overlays
)
1951 (setq org-clock-overlays nil
)
1953 (remove-hook 'before-change-functions
1954 'org-clock-remove-overlays
'local
))))
1956 (defvar org-state
) ;; dynamically scoped into this function
1957 (defun org-clock-out-if-current ()
1958 "Clock out if the current entry contains the running clock.
1959 This is used to stop the clock after a TODO entry is marked DONE,
1960 and is only done if the variable `org-clock-out-when-done' is not nil."
1961 (when (and (org-clocking-p)
1962 org-clock-out-when-done
1963 (marker-buffer org-clock-marker
)
1964 (or (and (eq t org-clock-out-when-done
)
1965 (member org-state org-done-keywords
))
1966 (and (listp org-clock-out-when-done
)
1967 (member org-state org-clock-out-when-done
)))
1968 (equal (or (buffer-base-buffer (org-clocking-buffer))
1969 (org-clocking-buffer))
1970 (or (buffer-base-buffer (current-buffer))
1972 (< (point) org-clock-marker
)
1973 (> (save-excursion (outline-next-heading) (point))
1975 ;; Clock out, but don't accept a logging message for this.
1976 (let ((org-log-note-clock-out nil
)
1977 (org-clock-out-switch-to-state nil
))
1980 (add-hook 'org-after-todo-state-change-hook
1981 'org-clock-out-if-current
)
1984 (defun org-clock-get-clocktable (&rest props
)
1985 "Get a formatted clocktable with parameters according to PROPS.
1986 The table is created in a temporary buffer, fully formatted and
1987 fontified, and then returned."
1989 (setq props
(plist-put props
:name
"clocktable"))
1990 (unless (plist-member props
:maxlevel
)
1991 (setq props
(plist-put props
:maxlevel
2)))
1992 (unless (plist-member props
:scope
)
1993 (setq props
(plist-put props
:scope
'agenda
)))
1996 (org-create-dblock props
)
2000 (buffer-substring (point) (progn
2001 (re-search-forward "^[ \t]*#\\+END" nil t
)
2005 (defun org-clock-report (&optional arg
)
2006 "Create a table containing a report about clocked time.
2007 If the cursor is inside an existing clocktable block, then the table
2008 will be updated. If not, a new clocktable will be inserted. The scope
2009 of the new clock will be subtree when called from within a subtree, and
2012 When called with a prefix argument, move to the first clock table in the
2013 buffer and update it."
2015 (org-clock-remove-overlays)
2017 (org-find-dblock "clocktable")
2019 (if (org-in-clocktable-p)
2020 (goto-char (org-in-clocktable-p))
2021 (let ((props (if (ignore-errors
2022 (save-excursion (org-back-to-heading)))
2023 (list :name
"clocktable" :scope
'subtree
)
2024 (list :name
"clocktable"))))
2026 (org-combine-plists org-clock-clocktable-default-properties props
))))
2027 (org-update-dblock))
2029 (defun org-day-of-week (day month year
)
2030 "Returns the day of the week as an integer."
2034 (format "%d-%02d-%02dT00:00:00" year month day
)))))
2036 (defun org-quarter-to-date (quarter year
)
2037 "Get the date (week day year) of the first day of a given quarter."
2041 (setq startday
(org-day-of-week 1 1 year
))
2044 (list 52 7 (- year
1)))
2046 (list 52 6 (- year
1)))
2048 (list 1 startday year
))
2050 (list 53 startday
(- year
1)))
2054 (setq startday
(org-day-of-week 1 4 year
))
2057 (list 13 startday year
))
2059 (list 14 startday year
))
2061 (list 13 startday year
))
2065 (setq startday
(org-day-of-week 1 7 year
))
2068 (list 26 startday year
))
2070 (list 27 startday year
))
2072 (list 26 startday year
))
2076 (setq startday
(org-day-of-week 1 10 year
))
2079 (list 39 startday year
))
2081 (list 40 startday year
))
2083 (list 39 startday year
)))))))
2085 (defun org-clock-special-range (key &optional time as-strings wstart mstart
)
2086 "Return two times bordering a special time range.
2087 Key is a symbol specifying the range and can be one of `today', `yesterday',
2088 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
2089 By default, a week starts Monday 0:00 and ends Sunday 24:00.
2090 The range is determined relative to TIME, which defaults to current time.
2091 The return value is a cons cell with two internal times like the ones
2092 returned by `current time' or `encode-time'.
2093 If AS-STRINGS is non-nil, the returned times will be formatted strings.
2094 If WSTART is non-nil, use this number to specify the starting day of a
2096 If MSTART is non-nil, use this number to specify the starting day of a
2097 month (1 is the first day of the month).
2098 If you can combine both, the month starting day will have priority."
2099 (if (integerp key
) (setq key
(intern (number-to-string key
))))
2100 (let* ((tm (decode-time (or time
(current-time))))
2101 (s 0) (m (nth 1 tm
)) (h (nth 2 tm
))
2102 (d (nth 3 tm
)) (month (nth 4 tm
)) (y (nth 5 tm
))
2106 (skey (symbol-name key
))
2108 (q (cond ((>= (nth 4 tm
) 10) 4)
2109 ((>= (nth 4 tm
) 7) 3)
2110 ((>= (nth 4 tm
) 4) 2)
2111 ((>= (nth 4 tm
) 1) 1)))
2112 s1 m1 h1 d1 month1 y1 diff ts te fm txt w date
2113 interval tmp shiftedy shiftedm shiftedq
)
2115 ((string-match "^[0-9]+$" skey
)
2116 (setq y
(string-to-number skey
) m
1 d
1 key
'year
))
2117 ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)$" skey
)
2118 (setq y
(string-to-number (match-string 1 skey
))
2119 month
(string-to-number (match-string 2 skey
))
2121 ((string-match "^\\([0-9]+\\)-[wW]\\([0-9]\\{1,2\\}\\)$" skey
)
2123 (setq y
(string-to-number (match-string 1 skey
))
2124 w
(string-to-number (match-string 2 skey
)))
2125 (setq date
(calendar-gregorian-from-absolute
2126 (calendar-absolute-from-iso (list w
1 y
))))
2127 (setq d
(nth 1 date
) month
(car date
) y
(nth 2 date
)
2130 ((string-match "^\\([0-9]+\\)-[qQ]\\([1-4]\\)$" skey
)
2132 (setq y
(string-to-number (match-string 1 skey
)))
2133 (setq q
(string-to-number (match-string 2 skey
)))
2134 (setq date
(calendar-gregorian-from-absolute
2135 (calendar-absolute-from-iso (org-quarter-to-date q y
))))
2136 (setq d
(nth 1 date
) month
(car date
) y
(nth 2 date
)
2139 ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)-\\([0-9]\\{1,2\\}\\)$" skey
)
2140 (setq y
(string-to-number (match-string 1 skey
))
2141 month
(string-to-number (match-string 2 skey
))
2142 d
(string-to-number (match-string 3 skey
))
2144 ((string-match "\\([-+][0-9]+\\)$" skey
)
2145 (setq shift
(string-to-number (match-string 1 skey
))
2146 key
(intern (substring skey
0 (match-beginning 1))))
2147 (if (and (memq key
'(quarter thisq
)) (> shift
0))
2148 (error "Looking forward with quarters isn't implemented"))))
2151 (cond ((eq key
'yesterday
) (setq key
'today shift -
1))
2152 ((eq key
'lastweek
) (setq key
'week shift -
1))
2153 ((eq key
'lastmonth
) (setq key
'month shift -
1))
2154 ((eq key
'lastyear
) (setq key
'year shift -
1))
2155 ((eq key
'lastq
) (setq key
'quarter shift -
1))))
2157 ((memq key
'(day today
))
2158 (setq d
(+ d shift
) h
0 m
0 h1
24 m1
0))
2159 ((memq key
'(week thisweek
))
2160 (setq diff
(+ (* -
7 shift
) (if (= dow
0) (- 7 ws
) (- dow ws
)))
2161 m
0 h
0 d
(- d diff
) d1
(+ 7 d
)))
2162 ((memq key
'(month thismonth
))
2163 (setq d
(or ms
1) h
0 m
0 d1
(or ms
1)
2164 month
(+ month shift
) month1
(1+ month
) h1
0 m1
0))
2165 ((memq key
'(quarter thisq
))
2166 ;; Compute if this shift remains in this year. If not, compute
2167 ;; how many years and quarters we have to shift (via floor*) and
2168 ;; compute the shifted years, months and quarters.
2170 ((< (+ (- q
1) shift
) 0) ; shift not in this year
2171 (setq interval
(* -
1 (+ (- q
1) shift
)))
2172 ;; Set tmp to ((years to shift) (quarters to shift)).
2173 (setq tmp
(org-floor* interval
4))
2174 ;; Due to the use of floor, 0 quarters actually means 4.
2175 (if (= 0 (nth 1 tmp
))
2176 (setq shiftedy
(- y
(nth 0 tmp
))
2179 (setq shiftedy
(- y
(+ 1 (nth 0 tmp
)))
2180 shiftedm
(- 13 (* 3 (nth 1 tmp
)))
2181 shiftedq
(- 5 (nth 1 tmp
))))
2182 (setq d
1 h
0 m
0 d1
1 month shiftedm month1
(+ 3 shiftedm
) h1
0 m1
0 y shiftedy
))
2183 ((> (+ q shift
) 0) ; shift is within this year
2184 (setq shiftedq
(+ q shift
))
2186 (setq d
1 h
0 m
0 d1
1 month
(+ 1 (* 3 (- (+ q shift
) 1)))
2187 month1
(+ 4 (* 3 (- (+ q shift
) 1))) h1
0 m1
0))))
2188 ((memq key
'(year thisyear
))
2189 (setq m
0 h
0 d
1 month
1 y
(+ y shift
) y1
(1+ y
)))
2190 ((eq key
'interactive
) nil
)
2191 (t (user-error "No such time block %s" key
)))
2192 (setq ts
(encode-time s m h d month y
)
2193 te
(encode-time (or s1 s
) (or m1 m
) (or h1 h
)
2194 (or d1 d
) (or month1 month
) (or y1 y
)))
2195 (setq fm
(cdr org-time-stamp-formats
))
2197 ((memq key
'(day today
))
2198 (setq txt
(format-time-string "%A, %B %d, %Y" ts
)))
2199 ((memq key
'(week thisweek
))
2200 (setq txt
(format-time-string "week %G-W%V" ts
)))
2201 ((memq key
'(month thismonth
))
2202 (setq txt
(format-time-string "%B %Y" ts
)))
2203 ((memq key
'(year thisyear
))
2204 (setq txt
(format-time-string "the year %Y" ts
)))
2205 ((memq key
'(quarter thisq
))
2206 (setq txt
(concat (org-count-quarter shiftedq
)
2207 " quarter of " (number-to-string shiftedy
)))))
2209 (list (format-time-string fm ts
) (format-time-string fm te
) txt
)
2210 (if (eq key
'interactive
)
2211 (list (org-read-date nil t nil
"Range start? ")
2212 (org-read-date nil t nil
"Range end? ")
2213 "(Range interactively set)")
2214 (list ts te txt
)))))
2216 (defun org-count-quarter (n)
2224 (defun org-clocktable-shift (dir n
)
2225 "Try to shift the :block date of the clocktable at point.
2226 Point must be in the #+BEGIN: line of a clocktable, or this function
2227 will throw an error.
2228 DIR is a direction, a symbol `left', `right', `up', or `down'.
2229 Both `left' and `down' shift the block toward the past, `up' and `right'
2230 push it toward the future.
2231 N is the number of shift steps to take. The size of the step depends on
2232 the currently selected interval size."
2233 (setq n
(prefix-numeric-value n
))
2234 (and (memq dir
'(left down
)) (setq n
(- n
)))
2236 (goto-char (point-at-bol))
2237 (if (not (looking-at "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>.*?:block[ \t]+\\(\\S-+\\)"))
2238 (error "Line needs a :block definition before this command works")
2239 (let* ((b (match-beginning 1)) (e (match-end 1))
2240 (s (match-string 1))
2241 block shift ins y mw d date wp m
)
2243 ((equal s
"yesterday") (setq s
"today-1"))
2244 ((equal s
"lastweek") (setq s
"thisweek-1"))
2245 ((equal s
"lastmonth") (setq s
"thismonth-1"))
2246 ((equal s
"lastyear") (setq s
"thisyear-1"))
2247 ((equal s
"lastq") (setq s
"thisq-1")))
2250 ((string-match "^\\(today\\|thisweek\\|thismonth\\|thisyear\\|thisq\\)\\([-+][0-9]+\\)?$" s
)
2251 (setq block
(match-string 1 s
)
2252 shift
(if (match-end 2)
2253 (string-to-number (match-string 2 s
))
2255 (setq shift
(+ shift n
))
2256 (setq ins
(if (= shift
0) block
(format "%s%+d" block shift
))))
2257 ((string-match "\\([0-9]+\\)\\(-\\([wWqQ]?\\)\\([0-9]\\{1,2\\}\\)\\(-\\([0-9]\\{1,2\\}\\)\\)?\\)?" s
)
2258 ;; 1 1 2 3 3 4 4 5 6 6 5 2
2259 (setq y
(string-to-number (match-string 1 s
))
2260 wp
(and (match-end 3) (match-string 3 s
))
2261 mw
(and (match-end 4) (string-to-number (match-string 4 s
)))
2262 d
(and (match-end 6) (string-to-number (match-string 6 s
))))
2264 (d (setq ins
(format-time-string
2266 (encode-time 0 0 0 (+ d n
) m y
))))
2267 ((and wp
(string-match "w\\|W" wp
) mw
(> (length wp
) 0))
2269 (setq date
(calendar-gregorian-from-absolute
2270 (calendar-absolute-from-iso (list (+ mw n
) 1 y
))))
2271 (setq ins
(format-time-string
2273 (encode-time 0 0 0 (nth 1 date
) (car date
) (nth 2 date
)))))
2274 ((and wp
(string-match "q\\|Q" wp
) mw
(> (length wp
) 0))
2276 ; if the 4th + 1 quarter is requested we flip to the 1st quarter of the next year
2281 ; if the 1st - 1 quarter is requested we flip to the 4th quarter of the previous year
2286 (setq date
(calendar-gregorian-from-absolute
2287 (calendar-absolute-from-iso (org-quarter-to-date (+ mw n
) y
))))
2288 (setq ins
(format-time-string
2289 (concat (number-to-string y
) "-Q" (number-to-string (+ mw n
)))
2290 (encode-time 0 0 0 (nth 1 date
) (car date
) (nth 2 date
)))))
2292 (setq ins
(format-time-string
2294 (encode-time 0 0 0 1 (+ mw n
) y
))))
2296 (setq ins
(number-to-string (+ y n
))))))
2297 (t (error "Cannot shift clocktable block")))
2301 (delete-region (point) (+ (point) (- e b
)))
2302 (beginning-of-line 1)
2307 (defun org-dblock-write:clocktable
(params)
2308 "Write the standard clocktable."
2309 (setq params
(org-combine-plists org-clocktable-defaults params
))
2311 (let* ((scope (plist-get params
:scope
))
2312 (block (plist-get params
:block
))
2313 (ts (plist-get params
:tstart
))
2314 (te (plist-get params
:tend
))
2315 (link (plist-get params
:link
))
2316 (maxlevel (or (plist-get params
:maxlevel
) 3))
2317 (ws (plist-get params
:wstart
))
2318 (ms (plist-get params
:mstart
))
2319 (step (plist-get params
:step
))
2320 (timestamp (plist-get params
:timestamp
))
2321 (formatter (or (plist-get params
:formatter
)
2322 org-clock-clocktable-formatter
2323 'org-clocktable-write-default
))
2324 cc range-text ipos pos one-file-with-archives
2325 scope-is-list tbls level
)
2326 ;; Check if we need to do steps
2328 ;; Get the range text for the header
2329 (setq cc
(org-clock-special-range block nil t ws ms
)
2330 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2332 ;; Write many tables, in steps
2333 (unless (or block
(and ts te
))
2334 (error "Clocktable `:step' can only be used with `:block' or `:tstart,:end'"))
2335 (org-clocktable-steps params
)
2338 (setq ipos
(point)) ; remember the insertion position
2340 ;; Get the right scope
2343 ((and scope
(listp scope
) (symbolp (car scope
)))
2344 (setq scope
(eval scope
)))
2346 (setq scope
(org-agenda-files t
)))
2347 ((eq scope
'agenda-with-archives
)
2348 (setq scope
(org-agenda-files t
))
2349 (setq scope
(org-add-archive-files scope
)))
2350 ((eq scope
'file-with-archives
)
2351 (setq scope
(org-add-archive-files (list (buffer-file-name)))
2352 one-file-with-archives t
)))
2353 (setq scope-is-list
(and scope
(listp scope
)))
2355 ;; we collect from several files
2356 (let* ((files scope
)
2358 (org-agenda-prepare-buffers files
)
2359 (while (setq file
(pop files
))
2360 (with-current-buffer (find-buffer-visiting file
)
2363 (push (org-clock-get-table-data file params
) tbls
))))))
2364 ;; Just from the current file
2366 ;; get the right range into the restriction
2367 (org-agenda-prepare-buffers (list (buffer-file-name)))
2369 ((not scope
)) ; use the restriction as it is now
2370 ((eq scope
'file
) (widen))
2371 ((eq scope
'subtree
) (org-narrow-to-subtree))
2373 (while (org-up-heading-safe))
2374 (org-narrow-to-subtree))
2375 ((and (symbolp scope
) (string-match "^tree\\([0-9]+\\)$"
2376 (symbol-name scope
)))
2377 (setq level
(string-to-number (match-string 1 (symbol-name scope
))))
2379 (while (org-up-heading-safe)
2380 (looking-at org-outline-regexp
)
2381 (if (<= (org-reduced-level (funcall outline-level
)) level
)
2382 (throw 'exit nil
))))
2383 (org-narrow-to-subtree)))
2384 ;; do the table, with no file name.
2385 (push (org-clock-get-table-data nil params
) tbls
)))
2387 ;; OK, at this point we tbls as a list of tables, one per file
2388 (setq tbls
(nreverse tbls
))
2390 (setq params
(plist-put params
:multifile scope-is-list
))
2391 (setq params
(plist-put params
:one-file-with-archives
2392 one-file-with-archives
))
2394 (funcall formatter ipos tbls params
))))
2396 (defun org-clocktable-write-default (ipos tables params
)
2397 "Write out a clock table at position IPOS in the current buffer.
2398 TABLES is a list of tables with clocking data as produced by
2399 `org-clock-get-table-data'. PARAMS is the parameter property list obtained
2400 from the dynamic block definition."
2401 ;; This function looks quite complicated, mainly because there are a
2402 ;; lot of options which can add or remove columns. I have massively
2403 ;; commented this function, the I hope it is understandable. If
2404 ;; someone wants to write their own special formatter, this maybe
2405 ;; much easier because there can be a fixed format with a
2406 ;; well-defined number of columns...
2407 (let* ((hlchars '((1 .
"*") (2 .
"/")))
2408 (lwords (assoc (or (plist-get params
:lang
)
2409 (org-bound-and-true-p org-export-default-language
)
2411 org-clock-clocktable-language-setup
))
2412 (multifile (plist-get params
:multifile
))
2413 (block (plist-get params
:block
))
2414 (sort (plist-get params
:sort
))
2415 (ts (plist-get params
:tstart
))
2416 (te (plist-get params
:tend
))
2417 (header (plist-get params
:header
))
2418 (narrow (plist-get params
:narrow
))
2419 (ws (or (plist-get params
:wstart
) 1))
2420 (ms (or (plist-get params
:mstart
) 1))
2421 (link (plist-get params
:link
))
2422 (maxlevel (or (plist-get params
:maxlevel
) 3))
2423 (emph (plist-get params
:emphasize
))
2424 (level-p (plist-get params
:level
))
2425 (org-time-clocksum-use-effort-durations
2426 (plist-get params
:effort-durations
))
2427 (timestamp (plist-get params
:timestamp
))
2428 (properties (plist-get params
:properties
))
2429 (ntcol (max 1 (or (plist-get params
:tcolumns
) 100)))
2430 (rm-file-column (plist-get params
:one-file-with-archives
))
2431 (indent (plist-get params
:indent
))
2432 (case-fold-search t
)
2433 range-text total-time tbl level hlc formula pcol
2434 file-time entries entry headline
2435 recalc content narrow-cut-p tcol
)
2437 ;; Implement abbreviations
2438 (when (plist-get params
:compact
)
2439 (setq level nil indent t narrow
(or narrow
'40!) ntcol
1))
2441 ;; Some consistency test for parameters
2442 (unless (integerp ntcol
)
2443 (setq params
(plist-put params
:tcolumns
(setq ntcol
100))))
2445 (when (and narrow
(integerp narrow
) link
)
2446 ;; We cannot have both integer narrow and link
2448 "Using hard narrowing in clocktable to allow for links")
2449 (setq narrow
(intern (format "%d!" narrow
))))
2454 ((and (symbolp narrow
)
2455 (string-match "\\`[0-9]+!\\'" (symbol-name narrow
)))
2456 (setq narrow-cut-p t
2457 narrow
(string-to-number (substring (symbol-name narrow
)
2460 (error "Invalid value %s of :narrow property in clock table"
2464 ;; Get the range text for the header
2465 (setq range-text
(nth 2 (org-clock-special-range block nil t ws ms
))))
2467 ;; Compute the total time
2468 (setq total-time
(apply '+ (mapcar 'cadr tables
)))
2470 ;; Now we need to output this tsuff
2473 ;; Insert the text *before* the actual table
2474 (insert-before-markers
2476 ;; Format the standard header
2481 (format-time-string (cdr org-time-stamp-formats
))
2484 (if block
(concat ", for " range-text
".") "")
2487 ;; Insert the narrowing line
2488 (when (and narrow
(integerp narrow
) (not narrow-cut-p
))
2489 (insert-before-markers
2490 "|" ; table line starter
2491 (if multifile
"|" "") ; file column, maybe
2492 (if level-p
"|" "") ; level column, maybe
2493 (if timestamp
"|" "") ; timestamp column, maybe
2494 (if properties
(make-string (length properties
) ?|
) "") ;properties columns, maybe
2495 (format "<%d>| |\n" narrow
))) ; headline and time columns
2497 ;; Insert the table header line
2498 (insert-before-markers
2499 "|" ; table line starter
2500 (if multifile
(concat (nth 1 lwords
) "|") "") ; file column, maybe
2501 (if level-p
(concat (nth 2 lwords
) "|") "") ; level column, maybe
2502 (if timestamp
(concat (nth 3 lwords
) "|") "") ; timestamp column, maybe
2503 (if properties
(concat (mapconcat 'identity properties
"|") "|") "") ;properties columns, maybe
2504 (concat (nth 4 lwords
) "|"
2505 (nth 5 lwords
) "|\n")) ; headline and time columns
2507 ;; Insert the total time in the table
2508 (insert-before-markers
2510 "|" ; table line starter
2511 (if multifile
(concat "| " (nth 6 lwords
) " ") "")
2512 ; file column, maybe
2513 (if level-p
"|" "") ; level column, maybe
2514 (if timestamp
"|" "") ; timestamp column, maybe
2515 (if properties
(make-string (length properties
) ?|
) "") ; properties columns, maybe
2516 (concat (format org-clock-total-time-cell-format
(nth 7 lwords
)) "| ") ; instead of a headline
2517 (format org-clock-total-time-cell-format
2518 (org-minutes-to-clocksum-string (or total-time
0))) ; the time
2521 ;; Now iterate over the tables and insert the data
2522 ;; but only if any time has been collected
2523 (when (and total-time
(> total-time
0))
2525 (while (setq tbl
(pop tables
))
2526 ;; now tbl is the table resulting from one file.
2527 (setq file-time
(nth 1 tbl
))
2528 (when (or (and file-time
(> file-time
0))
2529 (not (plist-get params
:fileskip0
)))
2530 (insert-before-markers "|-\n") ; a hline because a new file starts
2531 ;; First the file time, if we have multiple files
2533 ;; Summarize the time collected from this file
2534 (insert-before-markers
2535 (format (concat "| %s %s | %s%s"
2536 (format org-clock-file-time-cell-format
(nth 8 lwords
))
2538 (file-name-nondirectory (car tbl
))
2539 (if level-p
"| " "") ; level column, maybe
2540 (if timestamp
"| " "") ; timestamp column, maybe
2541 (if properties
(make-string (length properties
) ?|
) "") ;properties columns, maybe
2542 (org-minutes-to-clocksum-string (nth 1 tbl
))))) ; the time
2544 ;; Get the list of node entries and iterate over it
2545 (setq entries
(nth 2 tbl
))
2546 (while (setq entry
(pop entries
))
2547 (setq level
(car entry
)
2548 headline
(nth 1 entry
)
2549 hlc
(if emph
(or (cdr (assoc level hlchars
)) "") ""))
2551 (if (and (string-match (concat "\\`" org-bracket-link-regexp
2556 (format "[[%s][%s]]"
2557 (match-string 1 headline
)
2558 (org-shorten-string (match-string 3 headline
)
2560 (setq headline
(org-shorten-string headline narrow
))))
2561 (insert-before-markers
2562 "|" ; start the table line
2563 (if multifile
"|" "") ; free space for file name column?
2564 (if level-p
(format "%d|" (car entry
)) "") ; level, maybe
2565 (if timestamp
(concat (nth 2 entry
) "|") "") ; timestamp, maybe
2569 (lambda (p) (or (cdr (assoc p
(nth 4 entry
))) ""))
2570 properties
"|") "|") "") ;properties columns, maybe
2571 (if indent
(org-clocktable-indent-string level
) "") ; indentation
2572 hlc headline hlc
"|" ; headline
2573 (make-string (min (1- ntcol
) (or (- level
1))) ?|
)
2574 ; empty fields for higher levels
2575 hlc
(org-minutes-to-clocksum-string (nth 3 entry
)) hlc
; time
2578 ;; When exporting subtrees or regions the region might be
2579 ;; activated, so let's disable ̀delete-active-region'
2580 (let ((delete-active-region nil
)) (backward-delete-char 1))
2581 (if (setq formula
(plist-get params
:formula
))
2584 ;; compute the column where the % numbers need to go
2589 (min maxlevel
(or ntcol
100))))
2590 ;; compute the column where the total time is
2594 (if timestamp
1 0)))
2597 "\n#+TBLFM: $%d='(org-clock-time%% @%d$%d $%d..$%d);%%.1f"
2598 pcol
; the column where the % numbers should go
2599 (if (and narrow
(not narrow-cut-p
)) 3 2) ; row of the total time
2600 tcol
; column of the total time
2601 tcol
(1- pcol
) ; range of columns where times can be found
2605 (insert "\n#+TBLFM: " formula
)
2607 (t (error "Invalid formula in clocktable")))
2608 ;; Should we rescue an old formula?
2609 (when (stringp (setq content
(plist-get params
:content
)))
2610 (when (string-match "^\\([ \t]*#\\+tblfm:.*\\)" content
)
2612 (insert "\n" (match-string 1 (plist-get params
:content
)))
2613 (beginning-of-line 0))))
2614 ;; Back to beginning, align the table, recalculate if necessary
2616 (skip-chars-forward "^|")
2618 (when org-hide-emphasis-markers
2619 ;; we need to align a second time
2623 (org-table-goto-line 3)
2624 (org-table-goto-column (car sort
))
2625 (org-table-sort-lines nil
(cdr sort
))))
2629 (if (and narrow
(not narrow-cut-p
)) (beginning-of-line 2))
2630 (org-table-goto-column pcol nil
'force
)
2632 (org-table-recalculate 'all
))
2633 (when rm-file-column
2634 ;; The file column is actually not wanted
2636 (org-table-delete-column))
2639 (defun org-clocktable-indent-string (level)
2642 (dotimes (k (1- level
) str
)
2643 (setq str
(concat "\\emsp" str
))))))
2645 (defun org-clocktable-steps (params)
2646 "Step through the range to make a number of clock tables."
2647 (let* ((p1 (copy-sequence params
))
2648 (ts (plist-get p1
:tstart
))
2649 (te (plist-get p1
:tend
))
2650 (ws (plist-get p1
:wstart
))
2651 (ms (plist-get p1
:mstart
))
2652 (step0 (plist-get p1
:step
))
2653 (step (cdr (assoc step0
'((day .
86400) (week .
604800)))))
2654 (stepskip0 (plist-get p1
:stepskip0
))
2655 (block (plist-get p1
:block
))
2656 cc range-text step-time tsb
)
2658 (setq cc
(org-clock-special-range block nil t ws ms
)
2659 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2662 ;; If ts is a number, it's an absolute day number from org-agenda.
2663 (destructuring-bind (month day year
) (calendar-gregorian-from-absolute ts
)
2664 (setq ts
(org-float-time (encode-time 0 0 0 day month year
)))))
2666 (setq ts
(org-float-time
2667 (apply 'encode-time
(org-parse-time-string ts
))))))
2671 (destructuring-bind (month day year
) (calendar-gregorian-from-absolute te
)
2672 (setq te
(org-float-time (encode-time 0 0 0 day month year
)))))
2674 (setq te
(org-float-time
2675 (apply 'encode-time
(org-parse-time-string te
))))))
2677 (if (eq step0
'week
)
2678 (- ts
(* 86400 (- (nth 6 (decode-time (seconds-to-time ts
))) ws
)))
2680 (setq p1
(plist-put p1
:header
""))
2681 (setq p1
(plist-put p1
:step nil
))
2682 (setq p1
(plist-put p1
:block nil
))
2684 (or (bolp) (insert "\n"))
2685 (setq p1
(plist-put p1
:tstart
(format-time-string
2686 (org-time-stamp-format nil t
)
2687 (seconds-to-time (max tsb ts
)))))
2688 (setq p1
(plist-put p1
:tend
(format-time-string
2689 (org-time-stamp-format nil t
)
2690 (seconds-to-time (min te
(setq tsb
(+ tsb step
)))))))
2691 (insert "\n" (if (eq step0
'day
) "Daily report: "
2692 "Weekly report starting on: ")
2693 (plist-get p1
:tstart
) "\n")
2694 (setq step-time
(org-dblock-write:clocktable p1
))
2695 (re-search-forward "^[ \t]*#\\+END:")
2696 (when (and (equal step-time
0) stepskip0
)
2697 ;; Remove the empty table
2698 (delete-region (point-at-bol)
2700 (re-search-backward "^\\(Daily\\|Weekly\\) report"
2705 (defun org-clock-get-table-data (file params
)
2706 "Get the clocktable data for file FILE, with parameters PARAMS.
2707 FILE is only for identification - this function assumes that
2708 the correct buffer is current, and that the wanted restriction is
2710 The return value will be a list with the file name and the total
2711 file time (in minutes) as 1st and 2nd elements. The third element
2712 of this list will be a list of headline entries. Each entry has the
2713 following structure:
2715 (LEVEL HEADLINE TIMESTAMP TIME)
2717 LEVEL: The level of the headline, as an integer. This will be
2718 the reduced leve, so 1,2,3,... even if only odd levels
2720 HEADLINE: The text of the headline. Depending on PARAMS, this may
2721 already be formatted like a link.
2722 TIMESTAMP: If PARAMS require it, this will be a time stamp found in the
2723 entry, any of SCHEDULED, DEADLINE, NORMAL, or first inactive,
2725 TIME: The sum of all time spend in this tree, in minutes. This time
2726 will of cause be restricted to the time block and tags match
2727 specified in PARAMS."
2728 (let* ((maxlevel (or (plist-get params
:maxlevel
) 3))
2729 (timestamp (plist-get params
:timestamp
))
2730 (ts (plist-get params
:tstart
))
2731 (te (plist-get params
:tend
))
2732 (ws (plist-get params
:wstart
))
2733 (ms (plist-get params
:mstart
))
2734 (block (plist-get params
:block
))
2735 (link (plist-get params
:link
))
2736 (tags (plist-get params
:tags
))
2737 (properties (plist-get params
:properties
))
2738 (inherit-property-p (plist-get params
:inherit-props
))
2740 (matcher (if tags
(cdr (org-make-tags-matcher tags
))))
2741 cc range-text st p time level hdl props tsp tbl
)
2743 (setq org-clock-file-total-minutes nil
)
2745 (setq cc
(org-clock-special-range block nil t ws ms
)
2746 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2747 (when (integerp ts
) (setq ts
(calendar-gregorian-from-absolute ts
)))
2748 (when (integerp te
) (setq te
(calendar-gregorian-from-absolute te
)))
2749 (when (and ts
(listp ts
))
2750 (setq ts
(format "%4d-%02d-%02d" (nth 2 ts
) (car ts
) (nth 1 ts
))))
2751 (when (and te
(listp te
))
2752 (setq te
(format "%4d-%02d-%02d" (nth 2 te
) (car te
) (nth 1 te
))))
2753 ;; Now the times are strings we can parse.
2754 (if ts
(setq ts
(org-float-time
2755 (seconds-to-time (org-matcher-time ts
)))))
2756 (if te
(setq te
(org-float-time
2757 (seconds-to-time (org-matcher-time te
)))))
2759 (org-clock-sum ts te
2760 (unless (null matcher
)
2762 (let* ((tags-list (org-get-tags-at))
2763 (org-scanner-tags tags-list
)
2764 (org-trust-scanner-tags t
))
2766 (goto-char (point-min))
2768 (while (or (and (bobp) (prog1 st
(setq st nil
))
2769 (get-text-property (point) :org-clock-minutes
)
2770 (setq p
(point-min)))
2771 (setq p
(next-single-property-change
2772 (point) :org-clock-minutes
)))
2774 (when (setq time
(get-text-property p
:org-clock-minutes
))
2776 (beginning-of-line 1)
2777 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@#%:]+:\\)?[ \t]*$"))
2778 (setq level
(org-reduced-level
2779 (- (match-end 1) (match-beginning 1))))
2780 (<= level maxlevel
))
2781 (setq hdl
(if (not link
)
2783 (org-make-link-string
2784 (format "file:%s::%s"
2788 (org-make-org-heading-search-string
2789 (replace-regexp-in-string
2790 org-bracket-link-regexp
2791 (lambda (m) (or (match-string 3 m
)
2792 (match-string 1 m
)))
2793 (match-string 2)))))
2795 (setq props
(org-entry-properties (point)))
2796 (or (cdr (assoc "SCHEDULED" props
))
2797 (cdr (assoc "DEADLINE" props
))
2798 (cdr (assoc "TIMESTAMP" props
))
2799 (cdr (assoc "TIMESTAMP_IA" props
))))
2800 props
(when properties
2804 (when (org-entry-get (point) p inherit-property-p
)
2805 (cons p
(org-entry-get (point) p inherit-property-p
))))
2807 (when (> time
0) (push (list level hdl tsp time props
) tbl
))))))
2808 (setq tbl
(nreverse tbl
))
2809 (list file org-clock-file-total-minutes tbl
))))
2811 (defun org-clock-time%
(total &rest strings
)
2812 "Compute a time fraction in percent.
2813 TOTAL s a time string like 10:21 specifying the total times.
2814 STRINGS is a list of strings that should be checked for a time.
2815 The first string that does have a time will be used.
2816 This function is made for clock tables."
2817 (let ((re "\\([0-9]+\\):\\([0-9]+\\)")
2821 (if (not (string-match re total
))
2823 (setq tot
(+ (string-to-number (match-string 2 total
))
2824 (* 60 (string-to-number (match-string 1 total
)))))
2825 (if (= tot
0.
) (throw 'exit
0.
)))
2826 (while (setq s
(pop strings
))
2827 (if (string-match "\\([0-9]+\\):\\([0-9]+\\)" s
)
2829 (/ (* 100.0 (+ (string-to-number (match-string 2 s
))
2830 (* 60 (string-to-number
2831 (match-string 1 s
)))))
2835 ;; Saving and loading the clock
2837 (defvar org-clock-loaded nil
2838 "Was the clock file loaded?")
2841 (defun org-clock-update-time-maybe ()
2842 "If this is a CLOCK line, update it and return t.
2843 Otherwise, return nil."
2846 (beginning-of-line 1)
2847 (skip-chars-forward " \t")
2848 (when (looking-at org-clock-string
)
2849 (let ((re (concat "[ \t]*" org-clock-string
2850 " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
2851 "\\([ \t]*=>.*\\)?\\)?"))
2854 ((not (looking-at re
))
2856 ((not (match-end 2))
2857 (when (and (equal (marker-buffer org-clock-marker
) (current-buffer))
2858 (> org-clock-marker
(point))
2859 (<= org-clock-marker
(point-at-eol)))
2860 ;; The clock is running here
2861 (setq org-clock-start-time
2863 (org-parse-time-string (match-string 1))))
2864 (org-clock-update-mode-line)))
2866 (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
2868 (setq ts
(match-string 1)
2869 te
(match-string 3))
2870 (setq s
(- (org-float-time
2871 (apply 'encode-time
(org-parse-time-string te
)))
2873 (apply 'encode-time
(org-parse-time-string ts
))))
2876 h
(floor (/ s
3600))
2880 (insert " => " (format (if neg
"-%d:%02d" "%2d:%02d") h m
))
2883 (defun org-clock-save ()
2884 "Persist various clock-related data to disk.
2885 The details of what will be saved are regulated by the variable
2886 `org-clock-persist'."
2887 (when (and org-clock-persist
2888 (or org-clock-loaded
2889 org-clock-has-been-used
2890 (not (file-exists-p org-clock-persist-file
))))
2892 (with-current-buffer (find-file (expand-file-name org-clock-persist-file
))
2894 (delete-region (point-min) (point-max))
2896 (insert (format ";; org-persist.el - %s at %s\n"
2897 system-name
(format-time-string
2898 (cdr org-time-stamp-formats
))))
2899 (if (and (memq org-clock-persist
'(t clock
))
2900 (setq b
(org-clocking-buffer))
2901 (setq b
(or (buffer-base-buffer b
) b
))
2903 (buffer-file-name b
)
2904 (or (not org-clock-persist-query-save
)
2905 (y-or-n-p (concat "Save current clock ("
2906 org-clock-heading
") "))))
2907 (insert "(setq resume-clock '(\""
2908 (buffer-file-name (org-clocking-buffer))
2909 "\" . " (int-to-string (marker-position org-clock-marker
))
2911 ;; Store clocked task history. Tasks are stored reversed to make
2913 (when (and (memq org-clock-persist
'(t history
))
2916 "(setq stored-clock-history '("
2919 (when (and (setq b
(marker-buffer m
))
2920 (setq b
(or (buffer-base-buffer b
) b
))
2922 (buffer-file-name b
))
2923 (concat "(\"" (buffer-file-name b
)
2924 "\" . " (int-to-string (marker-position m
))
2926 (reverse org-clock-history
) " ") "))\n"))
2928 (kill-buffer (current-buffer)))))))
2930 (defun org-clock-load ()
2931 "Load clock-related data from disk, maybe resuming a stored clock."
2932 (when (and org-clock-persist
(not org-clock-loaded
))
2933 (let ((filename (expand-file-name org-clock-persist-file
))
2934 (org-clock-in-resume 'auto-restart
)
2935 resume-clock stored-clock-history
)
2936 (if (not (file-readable-p filename
))
2937 (message "Not restoring clock data; %s not found"
2938 org-clock-persist-file
)
2939 (message "%s" "Restoring clock data")
2940 (setq org-clock-loaded t
)
2941 (load-file filename
)
2943 (when stored-clock-history
2944 (save-window-excursion
2945 (mapc (lambda (task)
2946 (if (file-exists-p (car task
))
2947 (org-clock-history-push (cdr task
)
2948 (find-file (car task
)))))
2949 stored-clock-history
)))
2951 (when (and resume-clock org-clock-persist
2952 (file-exists-p (car resume-clock
))
2953 (or (not org-clock-persist-query-resume
)
2957 (with-current-buffer (find-file (car resume-clock
))
2959 (goto-char (cdr resume-clock
))
2960 (org-back-to-heading t
)
2961 (and (looking-at org-complex-heading-regexp
)
2964 (when (file-exists-p (car resume-clock
))
2965 (with-current-buffer (find-file (car resume-clock
))
2966 (goto-char (cdr resume-clock
))
2967 (let ((org-clock-auto-clock-resolution nil
))
2969 (if (outline-invisible-p)
2970 (org-show-context))))))))))
2972 ;; Suggested bindings
2973 (org-defkey org-mode-map
"\C-c\C-x\C-e" 'org-clock-modify-effort-estimate
)
2975 (provide 'org-clock
)
2978 ;; generated-autoload-file: "org-loaddefs.el"
2981 ;;; org-clock.el ends here
