1 ;;; org-clock.el --- The time clocking code for Org-mode
3 ;; Copyright (C) 2004-2013 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;; This file contains the time clocking code for Org-mode
35 (declare-function calendar-absolute-from-iso
"cal-iso" (&optional date
))
36 (declare-function notifications-notify
"notifications" (&rest params
))
37 (declare-function org-pop-to-buffer-same-window
"org-compat" (&optional buffer-or-name norecord label
))
38 (declare-function org-refresh-properties
"org" (dprop tprop
))
39 (defvar org-time-stamp-formats
)
41 (defvar org-frame-title-format-backup frame-title-format
)
43 (defgroup org-clock nil
44 "Options concerning clocking working time in Org-mode."
48 (defcustom org-clock-into-drawer org-log-into-drawer
49 "Should clocking info be wrapped into a drawer?
50 When t, clocking info will always be inserted into a :LOGBOOK: drawer.
51 If necessary, the drawer will be created.
52 When nil, the drawer will not be created, but used when present.
53 When an integer and the number of clocking entries in an item
54 reaches or exceeds this number, a drawer will be created.
55 When a string, it names the drawer to be used.
57 The default for this variable is the value of `org-log-into-drawer',
62 (const :tag
"Always" t
)
63 (const :tag
"Only when drawer exists" nil
)
64 (integer :tag
"When at least N clock entries")
65 (const :tag
"Into LOGBOOK drawer" "LOGBOOK")
66 (string :tag
"Into Drawer named...")))
68 (defun org-clock-into-drawer ()
69 "Return the value of `org-clock-into-drawer', but let properties overrule.
70 If the current entry has or inherits a CLOCK_INTO_DRAWER
71 property, it will be used instead of the default value; otherwise
72 if the current entry has or inherits a LOG_INTO_DRAWER property,
73 it will be used instead of the default value.
74 The default is the value of the customizable variable `org-clock-into-drawer',
76 (let ((p (org-entry-get nil
"CLOCK_INTO_DRAWER" 'inherit
))
77 (q (org-entry-get nil
"LOG_INTO_DRAWER" 'inherit
)))
79 ((or (not (or p q
)) (equal p
"nil") (equal q
"nil")) org-clock-into-drawer
)
80 ((or (equal p
"t") (equal q
"t")) "LOGBOOK")
84 (defcustom org-clock-out-when-done t
85 "When non-nil, clock will be stopped when the clocked entry is marked DONE.
86 DONE here means any DONE-like state.
87 A nil value means clock will keep running until stopped explicitly with
88 `C-c C-x C-o', or until the clock is started in a different item.
89 Instead of t, this can also be a list of TODO states that should trigger
94 (const :tag
"Yes, when done" t
)
95 (repeat :tag
"State list"
96 (string :tag
"TODO keyword"))))
98 (defcustom org-clock-rounding-minutes
0
99 "Rounding minutes when clocking in or out.
100 The default value is 0 so that no rounding is done.
101 When set to a non-integer value, use the car of
102 `org-time-stamp-rounding-minutes', like for setting a time-stamp.
104 E.g. if `org-clock-rounding-minutes' is set to 5, time is 14:47
105 and you clock in: then the clock starts at 14:45. If you clock
106 out within the next 5 minutes, the clock line will be removed;
107 if you clock out 8 minutes after your clocked in, the clock
108 out time will be 14:50."
112 (integer :tag
"Minutes (0 for no rounding)")
113 (symbol :tag
"Use `org-time-stamp-rounding-minutes'" 'same-as-time-stamp
)))
115 (defcustom org-clock-out-remove-zero-time-clocks nil
116 "Non-nil means remove the clock line when the resulting time is zero."
120 (defcustom org-clock-in-switch-to-state nil
121 "Set task to a special todo state while clocking it.
122 The value should be the state to which the entry should be
123 switched. If the value is a function, it must take one
124 parameter (the current TODO state of the item) and return the
125 state to switch it to."
129 (const :tag
"Don't force a state" nil
)
130 (string :tag
"State")
131 (symbol :tag
"Function")))
133 (defcustom org-clock-out-switch-to-state nil
134 "Set task to a special todo state after clocking out.
135 The value should be the state to which the entry should be
136 switched. If the value is a function, it must take one
137 parameter (the current TODO state of the item) and return the
138 state to switch it to."
142 (const :tag
"Don't force a state" nil
)
143 (string :tag
"State")
144 (symbol :tag
"Function")))
146 (defcustom org-clock-history-length
5
147 "Number of clock tasks to remember in history."
151 (defcustom org-clock-goto-may-find-recent-task t
152 "Non-nil means `org-clock-goto' can go to recent task if no active clock."
156 (defcustom org-clock-heading-function nil
157 "When non-nil, should be a function to create `org-clock-heading'.
158 This is the string shown in the mode line when a clock is running.
159 The function is called with point at the beginning of the headline."
163 (defcustom org-clock-string-limit
0
164 "Maximum length of clock strings in the mode line. 0 means no limit."
168 (defcustom org-clock-in-resume nil
169 "If non-nil, resume clock when clocking into task with open clock.
170 When clocking into a task with a clock entry which has not been closed,
171 the clock can be resumed from that point."
175 (defcustom org-clock-persist nil
176 "When non-nil, save the running clock when Emacs is closed.
177 The clock is resumed when Emacs restarts.
178 When this is t, both the running clock, and the entire clock
179 history are saved. When this is the symbol `clock', only the
180 running clock is saved. When this is the symbol `history', only
181 the clock history is saved.
183 When Emacs restarts with saved clock information, the file containing
184 the running clock as well as all files mentioned in the clock history
187 All this depends on running `org-clock-persistence-insinuate' in your
188 Emacs initialization file."
191 (const :tag
"Just the running clock" clock
)
192 (const :tag
"Just the history" history
)
193 (const :tag
"Clock and history" t
)
194 (const :tag
"No persistence" nil
)))
196 (defcustom org-clock-persist-file
(convert-standard-filename
197 "~/.emacs.d/org-clock-save.el")
198 "File to save clock data to."
202 (defcustom org-clock-persist-query-save nil
203 "When non-nil, ask before saving the current clock on exit."
207 (defcustom org-clock-persist-query-resume t
208 "When non-nil, ask before resuming any stored clock during load."
212 (defcustom org-clock-sound nil
213 "Sound to use for notifications.
217 t Standard Emacs beep
218 file name Play this sound file, fall back to beep"
221 (const :tag
"No sound" nil
)
222 (const :tag
"Standard beep" t
)
223 (file :tag
"Play sound file")))
225 (org-define-obsolete-variable-alias 'org-clock-modeline-total
226 'org-clock-mode-line-total
"24.3")
228 (defcustom org-clock-mode-line-total
'auto
229 "Default setting for the time included for the mode line clock.
230 This can be overruled locally using the CLOCK_MODELINE_TOTAL property.
233 current Only the time in the current instance of the clock
234 today All time clocked into this task today
235 repeat All time clocked into this task since last repeat
236 all All time ever recorded for this task
237 auto Automatically, either `all', or `repeat' for repeating tasks"
240 (const :tag
"Current clock" current
)
241 (const :tag
"Today's task time" today
)
242 (const :tag
"Since last repeat" repeat
)
243 (const :tag
"All task time" all
)
244 (const :tag
"Automatically, `all' or since `repeat'" auto
)))
246 (defvaralias 'org-task-overrun-text
'org-clock-task-overrun-text
)
247 (defcustom org-clock-task-overrun-text nil
248 "Extra mode line text to indicate that the clock is overrun.
249 The can be nil to indicate that instead of adding text, the clock time
250 should get a different face (`org-mode-line-clock-overrun').
251 When this is a string, it is prepended to the clock string as an indication,
252 also using the face `org-mode-line-clock-overrun'."
256 (const :tag
"Just mark the time string" nil
)
257 (string :tag
"Text to prepend")))
259 (defcustom org-show-notification-handler nil
260 "Function or program to send notification with.
261 The function or program will be called with the notification
265 (string :tag
"Program")
266 (function :tag
"Function")))
268 (defgroup org-clocktable nil
269 "Options concerning the clock table in Org-mode."
270 :tag
"Org Clock Table"
273 (defcustom org-clocktable-defaults
276 :lang org-export-default-language
295 "Default properties for clock tables."
300 (defcustom org-clock-clocktable-formatter
'org-clocktable-write-default
301 "Function to turn clocking data into a table.
302 For more information, see `org-clocktable-write-default'."
303 :group
'org-clocktable
307 ;; FIXME: translate es and nl last string "Clock summary at"
308 (defcustom org-clock-clocktable-language-setup
309 '(("en" "File" "L" "Timestamp" "Headline" "Time" "ALL" "Total time" "File time" "Clock summary at")
310 ("es" "Archivo" "N" "Fecha y hora" "Tarea" "Tiempo" "TODO" "Tiempo total" "Tiempo archivo" "Clock summary at")
311 ("fr" "Fichier" "N" "Horodatage" "En-tête" "Durée" "TOUT" "Durée totale" "Durée fichier" "Horodatage sommaire à ")
312 ("nl" "Bestand" "N" "Tijdstip" "Hoofding" "Duur" "ALLES" "Totale duur" "Bestandstijd" "Clock summary at"))
313 "Terms used in clocktable, translated to different languages."
314 :group
'org-clocktable
318 (defcustom org-clock-clocktable-default-properties
'(:maxlevel
2 :scope file
)
319 "Default properties for new clocktables.
320 These will be inserted into the BEGIN line, to make it easy for users to
322 :group
'org-clocktable
325 (defcustom org-clock-idle-time nil
326 "When non-nil, resolve open clocks if the user is idle more than X minutes."
329 (const :tag
"Never" nil
)
330 (integer :tag
"After N minutes")))
332 (defcustom org-clock-auto-clock-resolution
'when-no-clock-is-running
333 "When to automatically resolve open clocks found in Org buffers."
336 (const :tag
"Never" nil
)
337 (const :tag
"Always" t
)
338 (const :tag
"When no clock is running" when-no-clock-is-running
)))
340 (defcustom org-clock-report-include-clocking-task nil
341 "When non-nil, include the current clocking task time in clock reports."
346 (defcustom org-clock-resolve-expert nil
347 "Non-nil means do not show the splash buffer with the clock resolver."
352 (defcustom org-clock-continuously nil
353 "Non-nil means to start clocking from the last clock-out time, if any."
358 (defcustom org-clock-total-time-cell-format
"*%s*"
359 "Format string for the total time cells."
364 (defcustom org-clock-file-time-cell-format
"*%s*"
365 "Format string for the file time cells."
370 (defcustom org-clock-clocked-in-display
'mode-line
371 "When clocked in for a task, org-mode can display the current
372 task and accumulated time in the mode line and/or frame title.
375 both displays in both mode line and frame title
376 mode-line displays only in mode line (default)
377 frame-title displays only in frame title
378 nil current clock is not displayed"
381 (const :tag
"Mode line" mode-line
)
382 (const :tag
"Frame title" frame-title
)
383 (const :tag
"Both" both
)
384 (const :tag
"None" nil
)))
386 (defcustom org-clock-frame-title-format
'(t org-mode-line-string
)
387 "The value for `frame-title-format' when clocking in.
389 When `org-clock-clocked-in-display' is set to 'frame-title
390 or 'both, clocking in will replace `frame-title-format' with
391 this value. Clocking out will restore `frame-title-format'.
393 `org-frame-title-string' is a format string using the same
394 specifications than `frame-title-format', which see."
399 (defvar org-clock-in-prepare-hook nil
400 "Hook run when preparing the clock.
401 This hook is run before anything happens to the task that
402 you want to clock in. For example, you can use this hook
403 to add an effort property.")
404 (defvar org-clock-in-hook nil
405 "Hook run when starting the clock.")
406 (defvar org-clock-out-hook nil
407 "Hook run when stopping the current clock.")
409 (defvar org-clock-cancel-hook nil
410 "Hook run when cancelling the current clock.")
411 (defvar org-clock-goto-hook nil
412 "Hook run when selecting the currently clocked-in entry.")
413 (defvar org-clock-has-been-used nil
414 "Has the clock been used during the current Emacs session?")
416 ;;; The clock for measuring work time.
418 (defvar org-mode-line-string
"")
419 (put 'org-mode-line-string
'risky-local-variable t
)
421 (defvar org-clock-mode-line-timer nil
)
422 (defvar org-clock-idle-timer nil
)
423 (defvar org-clock-heading
) ; defined in org.el
424 (defvar org-clock-heading-for-remember
"")
425 (defvar org-clock-start-time
"")
427 (defvar org-clock-leftover-time nil
428 "If non-nil, user cancelled a clock; this is when leftover time started.")
430 (defvar org-clock-effort
""
431 "Effort estimate of the currently clocking task.")
433 (defvar org-clock-total-time nil
434 "Holds total time, spent previously on currently clocked item.
435 This does not include the time in the currently running clock.")
437 (defvar org-clock-history nil
438 "List of marker pointing to recent clocked tasks.")
440 (defvar org-clock-default-task
(make-marker)
441 "Marker pointing to the default task that should clock time.
442 The clock can be made to switch to this task after clocking out
443 of a different task.")
445 (defvar org-clock-interrupted-task
(make-marker)
446 "Marker pointing to the task that has been interrupted by the current clock.")
448 (defvar org-clock-mode-line-map
(make-sparse-keymap))
449 (define-key org-clock-mode-line-map
[mode-line mouse-2
] 'org-clock-goto
)
450 (define-key org-clock-mode-line-map
[mode-line mouse-1
] 'org-clock-menu
)
452 (defun org-clock-menu ()
456 ["Clock out" org-clock-out t
]
457 ["Change effort estimate" org-clock-modify-effort-estimate t
]
458 ["Go to clock entry" org-clock-goto t
]
459 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t
:keys
"C-u C-c C-x C-i"])))
461 (defun org-clock-history-push (&optional pos buffer
)
462 "Push a marker to the clock history."
463 (setq org-clock-history-length
(max 1 (min 35 org-clock-history-length
)))
464 (let ((m (move-marker (make-marker)
465 (or pos
(point)) (org-base-buffer
466 (or buffer
(current-buffer)))))
468 (while (setq n
(member m org-clock-history
))
469 (move-marker (car n
) nil
))
470 (setq org-clock-history
472 (mapcar (lambda (x) (if (marker-buffer x
) x nil
))
474 (when (>= (setq l
(length org-clock-history
)) org-clock-history-length
)
475 (setq org-clock-history
477 (nthcdr (- l org-clock-history-length -
1)
478 (nreverse org-clock-history
)))))
479 (push m org-clock-history
)))
481 (defun org-clock-save-markers-for-cut-and-paste (beg end
)
482 "Save relative positions of markers in region."
483 (org-check-and-save-marker org-clock-marker beg end
)
484 (org-check-and-save-marker org-clock-hd-marker beg end
)
485 (org-check-and-save-marker org-clock-default-task beg end
)
486 (org-check-and-save-marker org-clock-interrupted-task beg end
)
487 (mapc (lambda (m) (org-check-and-save-marker m beg end
))
490 (defun org-clocking-buffer ()
491 "Return the clocking buffer if we are currently clocking a task or nil."
492 (marker-buffer org-clock-marker
))
494 (defun org-clocking-p ()
495 "Return t when clocking a task."
496 (not (equal (org-clocking-buffer) nil
)))
498 (defvar org-clock-before-select-task-hook nil
499 "Hook called in task selection just before prompting the user.")
501 (defun org-clock-select-task (&optional prompt
)
502 "Select a task that recently was associated with clocking."
504 (let (sel-list rpl
(i 0) s
)
505 (save-window-excursion
506 (org-switch-to-buffer-other-window
507 (get-buffer-create "*Clock Task Select*"))
509 (when (marker-buffer org-clock-default-task
)
510 (insert (org-add-props "Default Task\n" nil
'face
'bold
))
511 (setq s
(org-clock-insert-selection-line ?d org-clock-default-task
))
513 (when (marker-buffer org-clock-interrupted-task
)
514 (insert (org-add-props "The task interrupted by starting the last one\n" nil
'face
'bold
))
515 (setq s
(org-clock-insert-selection-line ?i org-clock-interrupted-task
))
517 (when (org-clocking-p)
518 (insert (org-add-props "Current Clocking Task\n" nil
'face
'bold
))
519 (setq s
(org-clock-insert-selection-line ?c org-clock-marker
))
521 (insert (org-add-props "Recent Tasks\n" nil
'face
'bold
))
524 (when (marker-buffer m
)
526 s
(org-clock-insert-selection-line
530 (if (fboundp 'int-to-char
) (setf (car s
) (int-to-char (car s
))))
533 (run-hooks 'org-clock-before-select-task-hook
)
534 (org-fit-window-to-buffer)
535 (message (or prompt
"Select task for clocking:"))
536 (setq rpl
(read-char-exclusive))
540 ((assoc rpl sel-list
) (cdr (assoc rpl sel-list
)))
541 (t (error "Invalid task choice %c" rpl
))))))
543 (defun org-clock-insert-selection-line (i marker
)
544 "Insert a line for the clock selection menu.
545 And return a cons cell with the selection character integer and the marker
547 (when (marker-buffer marker
)
548 (let (file cat task heading prefix
)
549 (with-current-buffer (org-base-buffer (marker-buffer marker
))
555 (setq file
(buffer-file-name (marker-buffer marker
))
556 cat
(org-get-category)
557 heading
(org-get-heading 'notags
)
558 prefix
(save-excursion
559 (org-back-to-heading t
)
560 (looking-at org-outline-regexp
)
563 (org-fontify-like-in-org-mode
564 (concat prefix heading
)
566 (length prefix
)))))))
568 (insert (format "[%c] %-15s %s\n" i cat task
))
571 (defvar org-clock-task-overrun nil
572 "Internal flag indicating if the clock has overrun the planned time.")
573 (defvar org-clock-update-period
60
574 "Number of seconds between mode line clock string updates.")
576 (defun org-clock-get-clock-string ()
577 "Form a clock-string, that will be shown in the mode line.
578 If an effort estimate was defined for the current item, use
579 01:30/01:50 format (clocked/estimated).
580 If not, show simply the clocked time like 01:50."
581 (let ((clocked-time (org-clock-get-clocked-time)))
583 (let* ((effort-in-minutes
584 (org-duration-string-to-minutes org-clock-effort
))
587 (org-minutes-to-clocksum-string clocked-time
)
588 'face
(if (and org-clock-task-overrun
(not org-clock-task-overrun-text
))
589 'org-mode-line-clock-overrun
'org-mode-line-clock
)))
590 (effort-str (org-minutes-to-clocksum-string effort-in-minutes
))
591 (clockstr (org-propertize
592 (concat " [%s/" effort-str
593 "] (" (replace-regexp-in-string "%" "%%" org-clock-heading
) ")")
594 'face
'org-mode-line-clock
)))
595 (format clockstr work-done-str
))
596 (org-propertize (concat "[" (org-minutes-to-clocksum-string clocked-time
)
597 (format " (%s)" org-clock-heading
) "]")
598 'face
'org-mode-line-clock
))))
600 (defun org-clock-get-last-clock-out-time ()
601 "Get the last clock-out time for the current subtree."
603 (let ((end (save-excursion (org-end-of-subtree))))
604 (when (re-search-forward (concat org-clock-string
605 ".*\\]--\\(\\[[^]]+\\]\\)") end t
)
606 (org-time-string-to-time (match-string 1))))))
608 (defun org-clock-update-mode-line ()
610 (org-clock-notify-once-if-expired)
611 (setq org-clock-task-overrun nil
))
612 (setq org-mode-line-string
614 (let ((clock-string (org-clock-get-clock-string))
615 (help-text "Org-mode clock is running.\nmouse-1 shows a menu\nmouse-2 will jump to task"))
616 (if (and (> org-clock-string-limit
0)
617 (> (length clock-string
) org-clock-string-limit
))
619 (substring clock-string
0 org-clock-string-limit
)
620 'help-echo
(concat help-text
": " org-clock-heading
))
621 (org-propertize clock-string
'help-echo help-text
)))
622 'local-map org-clock-mode-line-map
623 'mouse-face
(if (featurep 'xemacs
) 'highlight
'mode-line-highlight
)))
624 (if (and org-clock-task-overrun org-clock-task-overrun-text
)
625 (setq org-mode-line-string
626 (concat (org-propertize
627 org-clock-task-overrun-text
628 'face
'org-mode-line-clock-overrun
) org-mode-line-string
)))
629 (force-mode-line-update))
631 (defun org-clock-get-clocked-time ()
632 "Get the clocked time for the current item in minutes.
633 The time returned includes the time spent on this task in
634 previous clocking intervals."
635 (let ((currently-clocked-time
636 (floor (- (org-float-time)
637 (org-float-time org-clock-start-time
)) 60)))
638 (+ currently-clocked-time
(or org-clock-total-time
0))))
640 (defun org-clock-modify-effort-estimate (&optional value
)
641 "Add to or set the effort estimate of the item currently being clocked.
642 VALUE can be a number of minutes, or a string with format hh:mm or mm.
643 When the string starts with a + or a - sign, the current value of the effort
644 property will be changed by that amount.
645 This will update the \"Effort\" property of currently clocked item, and
648 (if (org-clock-is-active)
649 (let ((current org-clock-effort
) sign
)
651 ;; Prompt user for a value or a change
654 (format "Set effort (hh:mm or mm%s): "
656 (format ", prefix + to add to %s" org-clock-effort
)
658 (when (stringp value
)
659 ;; A string. See if it is a delta
660 (setq sign
(string-to-char value
))
661 (if (member sign
'(?- ?
+))
662 (setq current
(org-duration-string-to-minutes current
)
663 value
(substring value
1))
665 (setq value
(org-duration-string-to-minutes value
))
667 (setq value
(- current value
))
668 (if (equal ?
+ sign
) (setq value
(+ current value
)))))
669 (setq value
(max 0 value
)
670 org-clock-effort
(org-minutes-to-clocksum-string value
))
671 (org-entry-put org-clock-marker
"Effort" org-clock-effort
)
672 (org-clock-update-mode-line)
673 (message "Effort is now %s" org-clock-effort
))
674 (message "Clock is not currently active")))
676 (defvar org-clock-notification-was-shown nil
677 "Shows if we have shown notification already.")
679 (defun org-clock-notify-once-if-expired ()
680 "Show notification if we spent more time than we estimated before.
681 Notification is shown only once."
682 (when (org-clocking-p)
683 (let ((effort-in-minutes (org-duration-string-to-minutes org-clock-effort
))
684 (clocked-time (org-clock-get-clocked-time)))
685 (if (setq org-clock-task-overrun
686 (if (or (null effort-in-minutes
) (zerop effort-in-minutes
))
688 (>= clocked-time effort-in-minutes
)))
689 (unless org-clock-notification-was-shown
690 (setq org-clock-notification-was-shown t
)
692 (format "Task '%s' should be finished by now. (%s)"
693 org-clock-heading org-clock-effort
) t
))
694 (setq org-clock-notification-was-shown nil
)))))
696 (defun org-notify (notification &optional play-sound
)
697 "Send a NOTIFICATION and maybe PLAY-SOUND.
698 If PLAY-SOUND is non-nil, it overrides `org-clock-sound'."
699 (org-show-notification notification
)
700 (if play-sound
(org-clock-play-sound play-sound
)))
702 (defun org-show-notification (notification)
704 Use `org-show-notification-handler' if defined,
705 use libnotify if available, or fall back on a message."
706 (cond ((functionp org-show-notification-handler
)
707 (funcall org-show-notification-handler notification
))
708 ((stringp org-show-notification-handler
)
709 (start-process "emacs-timer-notification" nil
710 org-show-notification-handler notification
))
711 ((fboundp 'notifications-notify
)
712 (notifications-notify
713 :title
"Org-mode message"
715 ;; FIXME how to link to the Org icon?
716 ;; :app-icon "~/.emacs.d/icons/mail.png"
718 ((executable-find "notify-send")
719 (start-process "emacs-timer-notification" nil
720 "notify-send" notification
))
721 ;; Maybe the handler will send a message, so only use message as
722 ;; a fall back option
723 (t (message "%s" notification
))))
725 (defun org-clock-play-sound (&optional clock-sound
)
726 "Play sound as configured by `org-clock-sound'.
727 Use alsa's aplay tool if available.
728 If CLOCK-SOUND is non-nil, it overrides `org-clock-sound'."
729 (let ((org-clock-sound (or clock-sound org-clock-sound
)))
731 ((not org-clock-sound
))
732 ((eq org-clock-sound t
) (beep t
) (beep t
))
733 ((stringp org-clock-sound
)
734 (let ((file (expand-file-name org-clock-sound
)))
735 (if (file-exists-p file
)
736 (if (executable-find "aplay")
737 (start-process "org-clock-play-notification" nil
740 (play-sound-file file
)
741 (error (beep t
) (beep t
))))))))))
743 (defvar org-clock-mode-line-entry nil
744 "Information for the mode line about the running clock.")
746 (defun org-find-open-clocks (file)
747 "Search through the given file and find all open clocks."
748 (let ((buf (or (get-file-buffer file
)
749 (find-file-noselect file
)))
751 (with-current-buffer buf
753 (goto-char (point-min))
754 (while (re-search-forward "CLOCK: \\(\\[.*?\\]\\)$" nil t
)
755 (push (cons (copy-marker (match-end 1) t
)
756 (org-time-string-to-time (match-string 1))) clocks
))))
759 (defsubst org-is-active-clock
(clock)
760 "Return t if CLOCK is the currently active clock."
761 (and (org-clock-is-active)
762 (= org-clock-marker
(car clock
))))
764 (defmacro org-with-clock-position
(clock &rest forms
)
765 "Evaluate FORMS with CLOCK as the current active clock."
766 `(with-current-buffer (marker-buffer (car ,clock
))
770 (goto-char (car ,clock
))
773 (def-edebug-spec org-with-clock-position
(form body
))
774 (put 'org-with-clock-position
'lisp-indent-function
1)
776 (defmacro org-with-clock
(clock &rest forms
)
777 "Evaluate FORMS with CLOCK as the current active clock.
778 This macro also protects the current active clock from being altered."
779 `(org-with-clock-position ,clock
780 (let ((org-clock-start-time (cdr ,clock
))
781 (org-clock-total-time)
784 (org-clock-marker (car ,clock
))
785 (org-clock-hd-marker (save-excursion
786 (outline-back-to-heading t
)
789 (def-edebug-spec org-with-clock
(form body
))
790 (put 'org-with-clock
'lisp-indent-function
1)
792 (defsubst org-clock-clock-in
(clock &optional resume start-time
)
793 "Clock in to the clock located by CLOCK.
794 If necessary, clock-out of the currently active clock."
795 (org-with-clock-position clock
796 (let ((org-clock-in-resume (or resume org-clock-in-resume
)))
797 (org-clock-in nil start-time
))))
799 (defsubst org-clock-clock-out
(clock &optional fail-quietly at-time
)
800 "Clock out of the clock located by CLOCK."
801 (let ((temp (copy-marker (car clock
)
802 (marker-insertion-type (car clock
)))))
803 (if (org-is-active-clock clock
)
804 (org-clock-out nil fail-quietly at-time
)
805 (org-with-clock clock
806 (org-clock-out nil fail-quietly at-time
)))
807 (setcar clock temp
)))
809 (defsubst org-clock-clock-cancel
(clock)
810 "Cancel the clock located by CLOCK."
811 (let ((temp (copy-marker (car clock
)
812 (marker-insertion-type (car clock
)))))
813 (if (org-is-active-clock clock
)
815 (org-with-clock clock
817 (setcar clock temp
)))
819 (defvar org-clock-clocking-in nil
)
820 (defvar org-clock-resolving-clocks nil
)
821 (defvar org-clock-resolving-clocks-due-to-idleness nil
)
823 (defun org-clock-resolve-clock (clock resolve-to clock-out-time
824 &optional close-p restart-p fail-quietly
)
825 "Resolve `CLOCK' given the time `RESOLVE-TO', and the present.
826 `CLOCK' is a cons cell of the form (MARKER START-TIME)."
827 (let ((org-clock-resolving-clocks t
))
830 (org-clock-clock-cancel clock
)
831 (if (and restart-p
(not org-clock-clocking-in
))
832 (org-clock-clock-in clock
)))
834 ((eq resolve-to
'now
)
836 (error "RESTART-P is not valid here"))
837 (if (or close-p org-clock-clocking-in
)
838 (org-clock-clock-out clock fail-quietly
)
839 (unless (org-is-active-clock clock
)
840 (org-clock-clock-in clock t
))))
842 ((not (time-less-p resolve-to
(current-time)))
843 (error "RESOLVE-TO must refer to a time in the past"))
847 (error "RESTART-P is not valid here"))
848 (org-clock-clock-out clock fail-quietly
(or clock-out-time
850 (unless org-clock-clocking-in
852 (setq org-clock-leftover-time
(and (null clock-out-time
)
854 (org-clock-clock-in clock nil
(and clock-out-time
857 (defun org-clock-jump-to-current-clock (&optional effective-clock
)
859 (let ((org-clock-into-drawer (org-clock-into-drawer))
860 (clock (or effective-clock
(cons org-clock-marker
861 org-clock-start-time
))))
862 (unless (marker-buffer (car clock
))
863 (error "No clock is currently running"))
864 (org-with-clock clock
(org-clock-goto))
865 (with-current-buffer (marker-buffer (car clock
))
866 (goto-char (car clock
))
867 (if org-clock-into-drawer
869 (if (stringp org-clock-into-drawer
)
870 (concat ":" org-clock-into-drawer
":")
875 (outline-back-to-heading t
)
876 (search-forward logbook
)
877 (goto-char (match-beginning 0)))
879 (outline-back-to-heading t
)
880 (search-forward logbook
)
881 (search-forward ":END:")
882 (goto-char (match-end 0)))
885 (defun org-clock-resolve (clock &optional prompt-fn last-valid fail-quietly
)
886 "Resolve an open org-mode clock.
887 An open clock was found, with `dangling' possibly being non-nil.
888 If this function was invoked with a prefix argument, non-dangling
889 open clocks are ignored. The given clock requires some sort of
890 user intervention to resolve it, either because a clock was left
891 dangling or due to an idle timeout. The clock resolution can
894 (a) deleted, the user doesn't care about the clock
895 (b) restarted from the current time (if no other clock is open)
896 (c) closed, giving the clock X minutes
897 (d) closed and then restarted
898 (e) resumed, as if the user had never left
900 The format of clock is (CONS MARKER START-TIME), where MARKER
901 identifies the buffer and position the clock is open at (and
902 thus, the heading it's under), and START-TIME is when the clock
906 (save-window-excursion
908 (unless org-clock-resolving-clocks-due-to-idleness
909 (org-clock-jump-to-current-clock clock
))
910 (unless org-clock-resolve-expert
911 (with-output-to-temp-buffer "*Org Clock*"
912 (princ "Select a Clock Resolution Command:
914 i/q/C-g Ignore this question; the same as keeping all the idle time.
916 k/K Keep X minutes of the idle time (default is all). If this
917 amount is less than the default, you will be clocked out
918 that many minutes after the time that idling began, and then
919 clocked back in at the present time.
920 g/G Indicate that you \"got back\" X minutes ago. This is quite
921 different from 'k': it clocks you out from the beginning of
922 the idle period and clock you back in X minutes ago.
923 s/S Subtract the idle time from the current clock. This is the
924 same as keeping 0 minutes.
925 C Cancel the open timer altogether. It will be as though you
927 j/J Jump to the current clock, to make manual adjustments.
929 For all these options, using uppercase makes your final state
930 to be CLOCKED OUT.")))
931 (org-fit-window-to-buffer (get-buffer-window "*Org Clock*"))
933 (when (featurep 'xemacs
)
934 (message (concat (funcall prompt-fn clock
)
936 (setq char-pressed
(read-char-exclusive)))
937 (while (or (null char-pressed
)
938 (and (not (memq char-pressed
939 '(?k ?K ?g ?G ?s ?S ?C
943 (read-char (concat (funcall prompt-fn clock
)
946 (and (not (memq char-pressed
'(?i ?q
))) char-pressed
)))))
948 (floor (/ (org-float-time
949 (time-subtract (current-time) last-valid
)) 60)))
951 (and (memq ch
'(?k ?K
))
952 (read-number "Keep how many minutes? " default
)))
954 (and (memq ch
'(?g ?G
))
955 (read-number "Got back how many minutes ago? " default
)))
956 (subtractp (memq ch
'(?s ?S
)))
957 (barely-started-p (< (- (org-float-time last-valid
)
958 (org-float-time (cdr clock
))) 45))
959 (start-over (and subtractp barely-started-p
)))
963 (org-clock-resolve-clock clock
'now nil t nil fail-quietly
))
964 (org-clock-jump-to-current-clock clock
))
966 (not (memq ch
'(?k ?K ?g ?G ?s ?S ?C
))))
969 (org-clock-resolve-clock
972 ;; If the time on the clock was less than a minute before
973 ;; the user went away, and they've ask to subtract all the
978 (and gotback
(= gotback
0)))
980 ((or (and keep
(= keep default
))
981 (and gotback
(= gotback default
)))
984 (time-add last-valid
(seconds-to-time (* 60 keep
))))
986 (time-subtract (current-time)
987 (seconds-to-time (* 60 gotback
))))
989 (error "Unexpected, please report this as a bug")))
990 (and gotback last-valid
)
991 (memq ch
'(?K ?G ?S
))
993 (not (memq ch
'(?K ?G ?S ?C
))))
997 (defun org-resolve-clocks (&optional only-dangling-p prompt-fn last-valid
)
998 "Resolve all currently open org-mode clocks.
999 If `only-dangling-p' is non-nil, only ask to resolve dangling
1000 \(i.e., not currently open and valid) clocks."
1002 (unless org-clock-resolving-clocks
1003 (let ((org-clock-resolving-clocks t
))
1004 (dolist (file (org-files-list))
1005 (let ((clocks (org-find-open-clocks file
)))
1006 (dolist (clock clocks
)
1007 (let ((dangling (or (not (org-clock-is-active))
1008 (/= (car clock
) org-clock-marker
))))
1009 (if (or (not only-dangling-p
) dangling
)
1016 "Dangling clock started %d mins ago"
1018 (/ (- (org-float-time (current-time))
1019 (org-float-time (cdr clock
))) 60))))))
1021 (cdr clock
)))))))))))
1023 (defun org-emacs-idle-seconds ()
1024 "Return the current Emacs idle time in seconds, or nil if not idle."
1025 (let ((idle-time (current-idle-time)))
1027 (org-float-time idle-time
)
1030 (defun org-mac-idle-seconds ()
1031 "Return the current Mac idle time in seconds."
1032 (string-to-number (shell-command-to-string "ioreg -c IOHIDSystem | perl -ane 'if (/Idle/) {$idle=(pop @F)/1000000000; print $idle; last}'")))
1034 (defvar org-x11idle-exists-p
1035 ;; Check that x11idle exists
1036 (and (eq window-system
'x
)
1037 (eq (call-process-shell-command "command" nil nil nil
"-v" "x11idle") 0)
1038 ;; Check that x11idle can retrieve the idle time
1039 (eq (call-process-shell-command "x11idle" nil nil nil
) 0)))
1041 (defun org-x11-idle-seconds ()
1042 "Return the current X11 idle time in seconds."
1043 (/ (string-to-number (shell-command-to-string "x11idle")) 1000))
1045 (defun org-user-idle-seconds ()
1046 "Return the number of seconds the user has been idle for.
1047 This routine returns a floating point number."
1049 ((eq system-type
'darwin
)
1050 (org-mac-idle-seconds))
1051 ((and (eq window-system
'x
) org-x11idle-exists-p
)
1052 (org-x11-idle-seconds))
1054 (org-emacs-idle-seconds))))
1056 (defvar org-clock-user-idle-seconds
)
1058 (defun org-resolve-clocks-if-idle ()
1059 "Resolve all currently open org-mode clocks.
1060 This is performed after `org-clock-idle-time' minutes, to check
1061 if the user really wants to stay clocked in after being idle for
1063 (when (and org-clock-idle-time
(not org-clock-resolving-clocks
)
1065 (let* ((org-clock-user-idle-seconds (org-user-idle-seconds))
1066 (org-clock-user-idle-start
1067 (time-subtract (current-time)
1068 (seconds-to-time org-clock-user-idle-seconds
)))
1069 (org-clock-resolving-clocks-due-to-idleness t
))
1070 (if (> org-clock-user-idle-seconds
(* 60 org-clock-idle-time
))
1072 (cons org-clock-marker
1073 org-clock-start-time
)
1076 (format "Clocked in & idle for %.1f mins"
1078 (time-subtract (current-time)
1079 org-clock-user-idle-start
))
1081 org-clock-user-idle-start
)))))
1083 (defvar org-clock-current-task nil
1084 "Task currently clocked in.")
1085 (defun org-clock-set-current ()
1086 "Set `org-clock-current-task' to the task currently clocked in."
1087 (setq org-clock-current-task
(nth 4 (org-heading-components))))
1089 (defun org-clock-delete-current ()
1090 "Reset `org-clock-current-task' to nil."
1091 (setq org-clock-current-task nil
))
1093 (defvar org-clock-out-time nil
) ; store the time of the last clock-out
1096 (defun org-clock-in (&optional select start-time
)
1097 "Start the clock on the current item.
1098 If necessary, clock-out of the currently active clock.
1099 With a prefix argument SELECT (\\[universal-argument]), offer a list of recently clocked
1100 tasks to clock into. When SELECT is \\[universal-argument] \\[universal-argument], clock into the current task
1101 and mark it as the default task, a special task that will always be offered
1102 in the clocking selection, associated with the letter `d'.
1103 When SELECT is \\[universal-argument] \\[universal-argument] \\[universal-argument], \
1104 clock in by using the last clock-out
1105 time as the start time \(see `org-clock-continuously' to
1106 make this the default behavior.)"
1108 (setq org-clock-notification-was-shown nil
)
1109 (org-refresh-properties org-effort-property
'org-effort
)
1111 (let ((interrupting (and (not org-clock-resolving-clocks-due-to-idleness
)
1113 ts selected-task target-pos
(msg-extra "")
1114 (leftover (and (not org-clock-resolving-clocks
)
1115 org-clock-leftover-time
)))
1117 (when (and org-clock-auto-clock-resolution
1118 (or (not interrupting
)
1119 (eq t org-clock-auto-clock-resolution
))
1120 (not org-clock-clocking-in
)
1121 (not org-clock-resolving-clocks
))
1122 (setq org-clock-leftover-time nil
)
1123 (let ((org-clock-clocking-in t
))
1124 (org-resolve-clocks))) ; check if any clocks are dangling
1126 (when (equal select
'(64))
1127 ;; Set start-time to `org-clock-out-time'
1128 (let ((org-clock-continuously t
))
1129 (org-clock-in nil org-clock-out-time
)))
1131 (when (equal select
'(4))
1132 (setq selected-task
(org-clock-select-task "Clock-in on task: "))
1134 (setq selected-task
(copy-marker selected-task
))
1137 (when (equal select
'(16))
1138 ;; Mark as default clocking task
1139 (org-clock-mark-default-task))
1142 ;; We are interrupting the clocking of a different task.
1143 ;; Save a marker to this task, so that we can go back.
1144 ;; First check if we are trying to clock into the same task!
1145 (when (save-excursion
1146 (unless selected-task
1147 (org-back-to-heading t
))
1148 (and (equal (marker-buffer org-clock-hd-marker
)
1150 (marker-buffer selected-task
)
1152 (= (marker-position org-clock-hd-marker
)
1154 (marker-position selected-task
)
1156 (equal org-clock-current-task
(nth 4 (org-heading-components)))))
1157 (message "Clock continues in \"%s\"" org-clock-heading
)
1159 (move-marker org-clock-interrupted-task
1160 (marker-position org-clock-marker
)
1161 (marker-buffer org-clock-marker
))
1162 (let ((org-clock-clocking-in t
))
1163 (org-clock-out nil t
)))
1165 ;; Clock in at which position?
1167 (if (and (eobp) (not (org-at-heading-p)))
1171 (when (and selected-task
(marker-buffer selected-task
))
1172 ;; There is a selected task, move to the correct buffer
1173 ;; and set the new target position.
1174 (set-buffer (org-base-buffer (marker-buffer selected-task
)))
1175 (setq target-pos
(marker-position selected-task
))
1176 (move-marker selected-task nil
))
1180 (goto-char target-pos
)
1181 (org-back-to-heading t
)
1182 (or interrupting
(move-marker org-clock-interrupted-task nil
))
1184 (forward-char) ;; make sure the marker is not at the
1185 ;; beginning of the heading, since the
1186 ;; user is liking to insert stuff here
1188 (run-hooks 'org-clock-in-prepare-hook
)
1189 (org-clock-history-push))
1190 (org-clock-set-current)
1191 (cond ((functionp org-clock-in-switch-to-state
)
1192 (looking-at org-complex-heading-regexp
)
1193 (let ((newstate (funcall org-clock-in-switch-to-state
1195 (if newstate
(org-todo newstate
))))
1196 ((and org-clock-in-switch-to-state
1197 (not (looking-at (concat org-outline-regexp
"[ \t]*"
1198 org-clock-in-switch-to-state
1200 (org-todo org-clock-in-switch-to-state
)))
1201 (setq org-clock-heading-for-remember
1202 (and (looking-at org-complex-heading-regexp
)
1204 (org-trim (buffer-substring (match-end 1)
1206 (setq org-clock-heading
1207 (cond ((and org-clock-heading-function
1208 (functionp org-clock-heading-function
))
1209 (funcall org-clock-heading-function
))
1210 ((and (looking-at org-complex-heading-regexp
)
1212 (replace-regexp-in-string
1213 "\\[\\[.*?\\]\\[\\(.*?\\)\\]\\]" "\\1"
1216 (setq org-clock-heading
(org-propertize org-clock-heading
1218 (org-clock-find-position org-clock-in-resume
)
1220 ((and org-clock-in-resume
1222 (concat "^[ \t]*" org-clock-string
1223 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1224 " *\\sw+\.? +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
1225 (message "Matched %s" (match-string 1))
1226 (setq ts
(concat "[" (match-string 1) "]"))
1227 (goto-char (match-end 1))
1228 (setq org-clock-start-time
1230 (org-parse-time-string (match-string 1))))
1231 (setq org-clock-effort
(get-text-property (point) 'org-effort
))
1232 (setq org-clock-total-time
(org-clock-sum-current-item
1233 (org-clock-get-sum-start))))
1234 ((eq org-clock-in-resume
'auto-restart
)
1235 ;; called from org-clock-load during startup,
1236 ;; do not interrupt, but warn!
1237 (message "Cannot restart clock because task does not contain unfinished clock")
1242 (insert-before-markers "\n")
1245 (when (and (save-excursion
1248 (beginning-of-line 1)
1249 (org-indent-line-to (- (org-get-indentation) 2)))
1250 (insert org-clock-string
" ")
1251 (setq org-clock-effort
(get-text-property (point) 'org-effort
))
1252 (setq org-clock-total-time
(org-clock-sum-current-item
1253 (org-clock-get-sum-start)))
1254 (setq org-clock-start-time
1255 (or (and org-clock-continuously org-clock-out-time
)
1259 "You stopped another clock %d mins ago; start this one from then? "
1260 (/ (- (org-float-time
1261 (org-current-time org-clock-rounding-minutes
))
1262 (org-float-time leftover
)) 60)))
1265 (org-current-time org-clock-rounding-minutes
)))
1266 (setq ts
(org-insert-time-stamp org-clock-start-time
1267 'with-hm
'inactive
))))
1268 (move-marker org-clock-marker
(point) (buffer-base-buffer))
1269 (move-marker org-clock-hd-marker
1270 (save-excursion (org-back-to-heading t
) (point))
1271 (buffer-base-buffer))
1272 (setq org-clock-has-been-used t
)
1274 (when (or (eq org-clock-clocked-in-display
'mode-line
)
1275 (eq org-clock-clocked-in-display
'both
))
1276 (or global-mode-string
(setq global-mode-string
'("")))
1277 (or (memq 'org-mode-line-string global-mode-string
)
1278 (setq global-mode-string
1279 (append global-mode-string
'(org-mode-line-string)))))
1280 ;; add to frame title
1281 (when (or (eq org-clock-clocked-in-display
'frame-title
)
1282 (eq org-clock-clocked-in-display
'both
))
1283 (setq frame-title-format org-clock-frame-title-format
))
1284 (org-clock-update-mode-line)
1285 (when org-clock-mode-line-timer
1286 (cancel-timer org-clock-mode-line-timer
)
1287 (setq org-clock-mode-line-timer nil
))
1288 (when org-clock-clocked-in-display
1289 (setq org-clock-mode-line-timer
1290 (run-with-timer org-clock-update-period
1291 org-clock-update-period
1292 'org-clock-update-mode-line
)))
1293 (when org-clock-idle-timer
1294 (cancel-timer org-clock-idle-timer
)
1295 (setq org-clock-idle-timer nil
))
1296 (setq org-clock-idle-timer
1297 (run-with-timer 60 60 'org-resolve-clocks-if-idle
))
1298 (message "Clock starts at %s - %s" ts msg-extra
)
1299 (run-hooks 'org-clock-in-hook
)))))))
1302 (defun org-clock-in-last (&optional arg
)
1303 "Clock in the last closed clocked item.
1304 When already clocking in, send an warning.
1305 With a universal prefix argument, select the task you want to
1306 clock in from the last clocked in tasks.
1307 With two universal prefix arguments, start clocking using the
1308 last clock-out time, if any.
1309 With three universal prefix arguments, interactively prompt
1310 for a todo state to switch to, overriding the existing value
1311 `org-clock-in-switch-to-state'."
1313 (if (equal arg
'(4))
1314 (org-clock-in (org-clock-select-task))
1315 (let ((start-time (if (or org-clock-continuously
(equal arg
'(16)))
1316 (or org-clock-out-time
1317 (org-current-time org-clock-rounding-minutes
))
1318 (org-current-time org-clock-rounding-minutes
))))
1319 (if (null org-clock-history
)
1320 (message "No last clock")
1321 (let ((org-clock-in-switch-to-state
1322 (if (and (not org-clock-current-task
) (equal arg
'(64)))
1323 (completing-read "Switch to state: "
1324 (and org-clock-history
1325 (with-current-buffer
1326 (marker-buffer (car org-clock-history
))
1327 org-todo-keywords-1
)))
1328 org-clock-in-switch-to-state
))
1329 (already-clocking org-clock-current-task
))
1330 (org-clock-clock-in (list (car org-clock-history
)) nil start-time
)
1331 (or already-clocking
1332 ;; Don't display a message if we are already clocking in
1333 (message "Clocking back: %s (in %s)"
1334 org-clock-current-task
1335 (buffer-name (marker-buffer org-clock-marker
)))))))))
1337 (defun org-clock-mark-default-task ()
1338 "Mark current task as default task."
1341 (org-back-to-heading t
)
1342 (move-marker org-clock-default-task
(point))))
1345 (defun org-clock-get-sum-start ()
1346 "Return the time from which clock times should be counted.
1347 This is for the currently running clock as it is displayed
1348 in the mode line. This function looks at the properties
1349 LAST_REPEAT and in particular CLOCK_MODELINE_TOTAL and the
1350 corresponding variable `org-clock-mode-line-total' and then
1351 decides which time to use."
1352 (let ((cmt (or (org-entry-get nil
"CLOCK_MODELINE_TOTAL")
1353 (symbol-name org-clock-mode-line-total
)))
1354 (lr (org-entry-get nil
"LAST_REPEAT")))
1356 ((equal cmt
"current")
1357 (setq msg-extra
"showing time in current clock instance")
1359 ((equal cmt
"today")
1360 (setq msg-extra
"showing today's task time.")
1361 (let* ((dt (decode-time (current-time))))
1362 (setq dt
(append (list 0 0 0) (nthcdr 3 dt
)))
1363 (if org-extend-today-until
1364 (setf (nth 2 dt
) org-extend-today-until
))
1365 (apply 'encode-time dt
)))
1366 ((or (equal cmt
"all")
1367 (and (or (not cmt
) (equal cmt
"auto"))
1369 (setq msg-extra
"showing entire task time.")
1371 ((or (equal cmt
"repeat")
1372 (and (or (not cmt
) (equal cmt
"auto"))
1374 (setq msg-extra
"showing task time since last repeat.")
1377 (org-time-string-to-time lr
)))
1380 (defun org-clock-find-position (find-unclosed)
1381 "Find the location where the next clock line should be inserted.
1382 When FIND-UNCLOSED is non-nil, first check if there is an unclosed clock
1383 line and position cursor in that line."
1384 (org-back-to-heading t
)
1386 (let* ((org-clock-into-drawer (org-clock-into-drawer))
1387 (beg (save-excursion
1388 (beginning-of-line 2)
1389 (or (bolp) (newline))
1391 (end (progn (outline-next-heading) (point)))
1392 (re (concat "^[ \t]*" org-clock-string
))
1394 (drawer (if (stringp org-clock-into-drawer
)
1395 org-clock-into-drawer
"LOGBOOK"))
1396 first last ind-last
)
1398 (when (and find-unclosed
1400 (concat "^[ \t]*" org-clock-string
1401 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1402 " *\\sw+ +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")
1404 (beginning-of-line 1)
1406 (when (eobp) (newline) (setq end
(max (point) end
)))
1407 (when (re-search-forward (concat "^[ \t]*:" drawer
":") end t
)
1408 ;; we seem to have a CLOCK drawer, so go there.
1409 (beginning-of-line 2)
1410 (or org-log-states-order-reversed
1411 (and (re-search-forward org-property-end-re nil t
)
1412 (goto-char (match-beginning 0))))
1414 ;; Lets count the CLOCK lines
1416 (while (re-search-forward re end t
)
1417 (setq first
(or first
(match-beginning 0))
1418 last
(match-beginning 0)
1420 (when (and (integerp org-clock-into-drawer
)
1422 (>= (1+ cnt
) org-clock-into-drawer
))
1423 ;; Wrap current entries into a new drawer
1425 (setq ind-last
(org-get-indentation))
1426 (beginning-of-line 2)
1427 (if (and (>= (org-get-indentation) ind-last
)
1429 (when (and (>= (org-get-indentation) ind-last
)
1431 (let ((struct (org-list-struct)))
1432 (goto-char (org-list-get-bottom-point struct
)))))
1434 (beginning-of-line 0)
1435 (org-indent-line-to ind-last
)
1437 (insert ":" drawer
":\n")
1438 (beginning-of-line 0)
1441 (beginning-of-line 2)
1442 (or org-log-states-order-reversed
1443 (and (re-search-forward org-property-end-re nil t
)
1444 (goto-char (match-beginning 0))))
1448 (while (and (looking-at (concat "[ \t]*" org-keyword-time-regexp
))
1449 (not (equal (match-string 1) org-clock-string
)))
1450 ;; Planning info, skip to after it
1451 (beginning-of-line 2)
1452 (or (bolp) (newline)))
1453 (when (or (eq org-clock-into-drawer t
)
1454 (stringp org-clock-into-drawer
)
1455 (and (integerp org-clock-into-drawer
)
1456 (< org-clock-into-drawer
2)))
1457 (insert ":" drawer
":\n:END:\n")
1458 (beginning-of-line -
1)
1461 (beginning-of-line 2)
1464 (or org-log-states-order-reversed
1465 (and (re-search-forward org-property-end-re nil t
)
1466 (goto-char (match-beginning 0))))))))
1469 (defun org-clock-out (&optional switch-to-state fail-quietly at-time
)
1470 "Stop the currently running clock.
1471 Throw an error if there is no running clock and FAIL-QUIETLY is nil.
1472 With a universal prefix, prompt for a state to switch the clocked out task
1473 to, overriding the existing value of `org-clock-out-switch-to-state'."
1476 (when (not (org-clocking-p))
1477 (setq global-mode-string
1478 (delq 'org-mode-line-string global-mode-string
))
1479 (setq frame-title-format org-frame-title-format-backup
)
1480 (force-mode-line-update)
1481 (if fail-quietly
(throw 'exit t
) (user-error "No active clock")))
1482 (let ((org-clock-out-switch-to-state
1484 (completing-read "Switch to state: "
1485 (with-current-buffer
1486 (marker-buffer org-clock-marker
)
1487 org-todo-keywords-1
)
1489 org-clock-out-switch-to-state
))
1490 (now (org-current-time org-clock-rounding-minutes
))
1492 (setq org-clock-out-time now
)
1493 (save-excursion ; Do not replace this with `with-current-buffer'.
1494 (org-no-warnings (set-buffer (org-clocking-buffer)))
1497 (goto-char org-clock-marker
)
1498 (beginning-of-line 1)
1499 (if (and (looking-at (concat "[ \t]*" org-keyword-time-regexp
))
1500 (equal (match-string 1) org-clock-string
))
1501 (setq ts
(match-string 2))
1502 (if fail-quietly
(throw 'exit nil
) (error "Clock start time is gone")))
1503 (goto-char (match-end 0))
1504 (delete-region (point) (point-at-eol))
1506 (setq te
(org-insert-time-stamp (or at-time now
) 'with-hm
'inactive
))
1507 (setq s
(- (org-float-time (apply 'encode-time
(org-parse-time-string te
)))
1508 (org-float-time (apply 'encode-time
(org-parse-time-string ts
))))
1509 h
(floor (/ s
3600))
1513 (insert " => " (format "%2d:%02d" h m
))
1514 (when (setq remove
(and org-clock-out-remove-zero-time-clocks
1516 (beginning-of-line 1)
1517 (delete-region (point) (point-at-eol))
1518 (and (looking-at "\n") (> (point-max) (1+ (point)))
1520 (move-marker org-clock-marker nil
)
1521 (move-marker org-clock-hd-marker nil
)
1522 (when org-log-note-clock-out
1523 (org-add-log-setup 'clock-out nil nil nil nil
1524 (concat "# Task: " (org-get-heading t
) "\n\n")))
1525 (when org-clock-mode-line-timer
1526 (cancel-timer org-clock-mode-line-timer
)
1527 (setq org-clock-mode-line-timer nil
))
1528 (when org-clock-idle-timer
1529 (cancel-timer org-clock-idle-timer
)
1530 (setq org-clock-idle-timer nil
))
1531 (setq global-mode-string
1532 (delq 'org-mode-line-string global-mode-string
))
1533 (setq frame-title-format org-frame-title-format-backup
)
1534 (when org-clock-out-switch-to-state
1536 (org-back-to-heading t
)
1537 (let ((org-inhibit-logging t
)
1538 (org-clock-out-when-done nil
))
1540 ((functionp org-clock-out-switch-to-state
)
1541 (looking-at org-complex-heading-regexp
)
1542 (let ((newstate (funcall org-clock-out-switch-to-state
1544 (if newstate
(org-todo newstate
))))
1545 ((and org-clock-out-switch-to-state
1546 (not (looking-at (concat org-outline-regexp
"[ \t]*"
1547 org-clock-out-switch-to-state
1549 (org-todo org-clock-out-switch-to-state
))))))
1550 (force-mode-line-update)
1551 (message (concat "Clock stopped at %s after "
1552 (org-minutes-to-clocksum-string (+ (* 60 h
) m
)) "%s")
1553 te
(if remove
" => LINE REMOVED" ""))
1554 (run-hooks 'org-clock-out-hook
)
1555 (unless (org-clocking-p)
1556 (org-clock-delete-current)))))))
1558 (add-hook 'org-clock-out-hook
'org-clock-remove-empty-clock-drawer
)
1560 (defun org-clock-remove-empty-clock-drawer nil
1561 "Remove empty clock drawer in the current subtree."
1562 (let* ((olid (or (org-entry-get (point) "LOG_INTO_DRAWER")
1563 org-log-into-drawer
))
1564 (clock-drawer (if (eq t olid
) "LOGBOOK" olid
))
1565 (end (save-excursion (org-end-of-subtree t t
))))
1568 (org-back-to-heading t
)
1569 (while (and (< (point) end
)
1570 (search-forward clock-drawer end t
))
1571 (goto-char (match-beginning 0))
1572 (org-remove-empty-drawer-at clock-drawer
(point))
1573 (forward-line 1))))))
1575 (defun org-at-clock-log-p nil
1576 "Is the cursor on the clock log line?"
1578 (move-beginning-of-line 1)
1579 (looking-at "^[ \t]*CLOCK:")))
1581 (defun org-clock-timestamps-up (&optional n
)
1582 "Increase CLOCK timestamps at cursor.
1583 Optional argument N tells to change by that many units."
1585 (org-clock-timestamps-change 'up n
))
1587 (defun org-clock-timestamps-down (&optional n
)
1588 "Increase CLOCK timestamps at cursor.
1589 Optional argument N tells to change by that many units."
1591 (org-clock-timestamps-change 'down n
))
1593 (defun org-clock-timestamps-change (updown &optional n
)
1594 "Change CLOCK timestamps synchronously at cursor.
1595 UPDOWN tells whether to change 'up or 'down.
1596 Optional argument N tells to change by that many units."
1597 (setq org-ts-what nil
)
1598 (when (org-at-timestamp-p t
)
1599 (let ((tschange (if (eq updown
'up
) 'org-timestamp-up
1600 'org-timestamp-down
))
1601 ts1 begts1 ts2 begts2 updatets1 tdiff
)
1603 (move-beginning-of-line 1)
1604 (re-search-forward org-ts-regexp3 nil t
)
1605 (setq ts1
(match-string 0) begts1
(match-beginning 0))
1606 (when (re-search-forward org-ts-regexp3 nil t
)
1607 (setq ts2
(match-string 0) begts2
(match-beginning 0))))
1608 ;; Are we on the second timestamp?
1609 (if (<= begts2
(point)) (setq updatets1 t
))
1611 ;; fall back on org-timestamp-up if there is only one
1612 (funcall tschange n
)
1613 ;; setq this so that (boundp 'org-ts-what is non-nil)
1614 (funcall tschange n
)
1615 (let ((ts (if updatets1 ts2 ts1
))
1616 (begts (if updatets1 begts1 begts2
)))
1619 (org-time-string-to-time org-last-changed-timestamp
)
1620 (org-time-string-to-time ts
)))
1623 (org-timestamp-change
1624 (round (/ (org-float-time tdiff
)
1625 (cond ((eq org-ts-what
'minute
) 60)
1626 ((eq org-ts-what
'hour
) 3600)
1627 ((eq org-ts-what
'day
) (* 24 3600))
1628 ((eq org-ts-what
'month
) (* 24 3600 31))
1629 ((eq org-ts-what
'year
) (* 24 3600 365.2)))))
1630 org-ts-what
'updown
)))))))
1633 (defun org-clock-cancel ()
1634 "Cancel the running clock by removing the start timestamp."
1636 (when (not (org-clocking-p))
1637 (setq global-mode-string
1638 (delq 'org-mode-line-string global-mode-string
))
1639 (setq frame-title-format org-frame-title-format-backup
)
1640 (force-mode-line-update)
1641 (error "No active clock"))
1642 (save-excursion ; Do not replace this with `with-current-buffer'.
1643 (org-no-warnings (set-buffer (org-clocking-buffer)))
1644 (goto-char org-clock-marker
)
1645 (if (org-looking-back (concat "^[ \t]*" org-clock-string
".*"))
1646 (progn (delete-region (1- (point-at-bol)) (point-at-eol))
1647 (org-remove-empty-drawer-at "LOGBOOK" (point)))
1648 (message "Clock gone, cancel the timer anyway")
1650 (move-marker org-clock-marker nil
)
1651 (move-marker org-clock-hd-marker nil
)
1652 (setq global-mode-string
1653 (delq 'org-mode-line-string global-mode-string
))
1654 (setq frame-title-format org-frame-title-format-backup
)
1655 (force-mode-line-update)
1656 (message "Clock canceled")
1657 (run-hooks 'org-clock-cancel-hook
))
1660 (defun org-clock-goto (&optional select
)
1661 "Go to the currently clocked-in entry, or to the most recently clocked one.
1662 With prefix arg SELECT, offer recently clocked tasks for selection."
1667 (or (org-clock-select-task "Select task to go to: ")
1668 (error "No task selected")))
1669 ((org-clocking-p) org-clock-marker
)
1670 ((and org-clock-goto-may-find-recent-task
1671 (car org-clock-history
)
1672 (marker-buffer (car org-clock-history
)))
1674 (car org-clock-history
))
1675 (t (error "No active or recent clock task")))))
1676 (org-pop-to-buffer-same-window (marker-buffer m
))
1677 (if (or (< m
(point-min)) (> m
(point-max))) (widen))
1680 (org-back-to-heading t
)
1681 (org-cycle-hide-drawers 'children
)
1685 (message "No running clock, this is the most recently clocked task"))
1686 (run-hooks 'org-clock-goto-hook
)))
1688 (defvar org-clock-file-total-minutes nil
1689 "Holds the file total time in minutes, after a call to `org-clock-sum'.")
1690 (make-variable-buffer-local 'org-clock-file-total-minutes
)
1692 (defun org-clock-sum-today (&optional headline-filter
)
1693 "Sum the times for each subtree for today."
1695 (let ((range (org-clock-special-range 'today
)))
1696 (org-clock-sum (car range
) (cadr range
) nil
:org-clock-minutes-today
)))
1699 (defun org-clock-sum (&optional tstart tend headline-filter propname
)
1700 "Sum the times for each subtree.
1701 Puts the resulting times in minutes as a text property on each headline.
1702 TSTART and TEND can mark a time range to be considered.
1703 HEADLINE-FILTER is a zero-arg function that, if specified, is called for
1704 each headline in the time range with point at the headline. Headlines for
1705 which HEADLINE-FILTER returns nil are excluded from the clock summation.
1706 PROPNAME lets you set a custom text property instead of :org-clock-minutes."
1708 (let* ((bmp (buffer-modified-p))
1709 (re (concat "^\\(\\*+\\)[ \t]\\|^[ \t]*"
1711 "[ \t]*\\(?:\\(\\[.*?\\]\\)-+\\(\\[.*?\\]\\)\\|=>[ \t]+\\([0-9]+\\):\\([0-9]+\\)\\)"))
1713 (ltimes (make-vector lmax
0))
1718 (if (stringp tstart
) (setq tstart
(org-time-string-to-seconds tstart
)))
1719 (if (stringp tend
) (setq tend
(org-time-string-to-seconds tend
)))
1720 (if (consp tstart
) (setq tstart
(org-float-time tstart
)))
1721 (if (consp tend
) (setq tend
(org-float-time tend
)))
1722 (remove-text-properties (point-min) (point-max)
1723 `(,(or propname
:org-clock-minutes
) t
1724 :org-clock-force-headline-inclusion t
))
1726 (goto-char (point-max))
1727 (while (re-search-backward re nil t
)
1731 (setq ts
(match-string 2)
1734 (apply 'encode-time
(org-parse-time-string ts
)))
1736 (apply 'encode-time
(org-parse-time-string te
)))
1737 ts
(if tstart
(max ts tstart
) ts
)
1738 te
(if tend
(min te tend
) te
)
1740 t1
(if (> dt
0) (+ t1
(floor (/ dt
60))) t1
)))
1743 (setq t1
(+ t1
(string-to-number (match-string 5))
1744 (* 60 (string-to-number (match-string 4))))))
1746 ;; Add the currently clocking item time to the total
1747 (when (and org-clock-report-include-clocking-task
1748 (equal (org-clocking-buffer) (current-buffer))
1749 (equal (marker-position org-clock-hd-marker
) (point))
1752 (>= (org-float-time org-clock-start-time
) tstart
)
1753 (<= (org-float-time org-clock-start-time
) tend
))
1754 (let ((time (floor (- (org-float-time)
1755 (org-float-time org-clock-start-time
)) 60)))
1756 (setq t1
(+ t1 time
))))
1757 (let* ((headline-forced
1758 (get-text-property (point)
1759 :org-clock-force-headline-inclusion
))
1761 (or (null headline-filter
)
1763 (save-match-data (funcall headline-filter
))))))
1764 (setq level
(- (match-end 1) (match-beginning 1)))
1765 (when (or (> t1
0) (> (aref ltimes level
) 0))
1766 (when (or headline-included headline-forced
)
1767 (if headline-included
1768 (loop for l from
0 to level do
1769 (aset ltimes l
(+ (aref ltimes l
) t1
))))
1770 (setq time
(aref ltimes level
))
1771 (goto-char (match-beginning 0))
1772 (put-text-property (point) (point-at-eol)
1773 (or propname
:org-clock-minutes
) time
)
1778 (> (funcall outline-level
) 1)
1779 (outline-up-heading 1 t
)
1781 (point) (point-at-eol)
1782 :org-clock-force-headline-inclusion t
))))))
1784 (loop for l from level to
(1- lmax
) do
1785 (aset ltimes l
0)))))))
1786 (setq org-clock-file-total-minutes
(aref ltimes
0)))
1787 (set-buffer-modified-p bmp
)))
1789 (defun org-clock-sum-current-item (&optional tstart
)
1790 "Return time, clocked on current item in total."
1793 (org-narrow-to-subtree)
1794 (org-clock-sum tstart
)
1795 org-clock-file-total-minutes
)))
1798 (defun org-clock-display (&optional total-only
)
1799 "Show subtree times in the entire buffer.
1800 If TOTAL-ONLY is non-nil, only show the total time for the entire file
1803 Use \\[org-clock-remove-overlays] to remove the subtree times."
1805 (org-clock-remove-overlays)
1810 (goto-char (point-min))
1811 (while (or (and (equal (setq p
(point)) (point-min))
1812 (get-text-property p
:org-clock-minutes
))
1813 (setq p
(next-single-property-change
1814 (point) :org-clock-minutes
)))
1816 (when (setq time
(get-text-property p
:org-clock-minutes
))
1817 (org-clock-put-overlay time
(funcall outline-level
))))
1818 (setq h
(/ org-clock-file-total-minutes
60)
1819 m
(- org-clock-file-total-minutes
(* 60 h
)))
1820 ;; Arrange to remove the overlays upon next change.
1821 (when org-remove-highlights-with-change
1822 (org-add-hook 'before-change-functions
'org-clock-remove-overlays
1824 (message (concat "Total file time: "
1825 (org-minutes-to-clocksum-string org-clock-file-total-minutes
)
1826 " (%d hours and %d minutes)") h m
)))
1828 (defvar org-clock-overlays nil
)
1829 (make-variable-buffer-local 'org-clock-overlays
)
1831 (defun org-clock-put-overlay (time &optional level
)
1832 "Put an overlays on the current line, displaying TIME.
1833 If LEVEL is given, prefix time with a corresponding number of stars.
1834 This creates a new overlay and stores it in `org-clock-overlays', so that it
1835 will be easy to remove."
1836 (let* ((c 60) (h (floor (/ time
60))) (m (- time
(* 60 h
)))
1837 (l (if level
(org-get-valid-level level
0) 0))
1840 (org-move-to-column c
)
1841 (unless (eolp) (skip-chars-backward "^ \t"))
1842 (skip-chars-backward " \t")
1843 (setq ov
(make-overlay (point-at-bol) (point-at-eol))
1844 tx
(concat (buffer-substring (point-at-bol) (point))
1845 (make-string (+ off
(max 0 (- c
(current-column)))) ?.
)
1846 (org-add-props (concat (make-string l ?
*) " "
1847 (org-minutes-to-clocksum-string time
)
1848 (make-string (- 16 l
) ?\
))
1849 (list 'face
'org-clock-overlay
))
1851 (if (not (featurep 'xemacs
))
1852 (overlay-put ov
'display tx
)
1853 (overlay-put ov
'invisible t
)
1854 (overlay-put ov
'end-glyph
(make-glyph tx
)))
1855 (push ov org-clock-overlays
)))
1857 (defun org-clock-remove-overlays (&optional beg end noremove
)
1858 "Remove the occur highlights from the buffer.
1859 BEG and END are ignored. If NOREMOVE is nil, remove this function
1860 from the `before-change-functions' in the current buffer."
1862 (unless org-inhibit-highlight-removal
1863 (mapc 'delete-overlay org-clock-overlays
)
1864 (setq org-clock-overlays nil
)
1866 (remove-hook 'before-change-functions
1867 'org-clock-remove-overlays
'local
))))
1869 (defvar org-state
) ;; dynamically scoped into this function
1870 (defun org-clock-out-if-current ()
1871 "Clock out if the current entry contains the running clock.
1872 This is used to stop the clock after a TODO entry is marked DONE,
1873 and is only done if the variable `org-clock-out-when-done' is not nil."
1874 (when (and (org-clocking-p)
1875 org-clock-out-when-done
1876 (marker-buffer org-clock-marker
)
1877 (or (and (eq t org-clock-out-when-done
)
1878 (member org-state org-done-keywords
))
1879 (and (listp org-clock-out-when-done
)
1880 (member org-state org-clock-out-when-done
)))
1881 (equal (or (buffer-base-buffer (org-clocking-buffer))
1882 (org-clocking-buffer))
1883 (or (buffer-base-buffer (current-buffer))
1885 (< (point) org-clock-marker
)
1886 (> (save-excursion (outline-next-heading) (point))
1888 ;; Clock out, but don't accept a logging message for this.
1889 (let ((org-log-note-clock-out nil
)
1890 (org-clock-out-switch-to-state nil
))
1893 (add-hook 'org-after-todo-state-change-hook
1894 'org-clock-out-if-current
)
1897 (defun org-clock-get-clocktable (&rest props
)
1898 "Get a formatted clocktable with parameters according to PROPS.
1899 The table is created in a temporary buffer, fully formatted and
1900 fontified, and then returned."
1902 (setq props
(plist-put props
:name
"clocktable"))
1903 (unless (plist-member props
:maxlevel
)
1904 (setq props
(plist-put props
:maxlevel
2)))
1905 (unless (plist-member props
:scope
)
1906 (setq props
(plist-put props
:scope
'agenda
)))
1909 (org-create-dblock props
)
1911 (font-lock-fontify-buffer)
1913 (buffer-substring (point) (progn
1914 (re-search-forward "^[ \t]*#\\+END" nil t
)
1918 (defun org-clock-report (&optional arg
)
1919 "Create a table containing a report about clocked time.
1920 If the cursor is inside an existing clocktable block, then the table
1921 will be updated. If not, a new clocktable will be inserted. The scope
1922 of the new clock will be subtree when called from within a subtree, and
1925 When called with a prefix argument, move to the first clock table in the
1926 buffer and update it."
1928 (org-clock-remove-overlays)
1930 (org-find-dblock "clocktable")
1932 (if (org-in-clocktable-p)
1933 (goto-char (org-in-clocktable-p))
1934 (let ((props (if (ignore-errors
1935 (save-excursion (org-back-to-heading)))
1936 (list :name
"clocktable" :scope
'subtree
)
1937 (list :name
"clocktable"))))
1939 (org-combine-plists org-clock-clocktable-default-properties props
))))
1940 (org-update-dblock))
1942 (defun org-day-of-week (day month year
)
1943 "Returns the day of the week as an integer."
1947 (format "%d-%02d-%02dT00:00:00" year month day
)))))
1949 (defun org-quarter-to-date (quarter year
)
1950 "Get the date (week day year) of the first day of a given quarter."
1954 (setq startday
(org-day-of-week 1 1 year
))
1957 (list 52 7 (- year
1)))
1959 (list 52 6 (- year
1)))
1961 (list 1 startday year
))
1963 (list 53 startday
(- year
1)))
1967 (setq startday
(org-day-of-week 1 4 year
))
1970 (list 13 startday year
))
1972 (list 14 startday year
))
1974 (list 13 startday year
))
1978 (setq startday
(org-day-of-week 1 7 year
))
1981 (list 26 startday year
))
1983 (list 27 startday year
))
1985 (list 26 startday year
))
1989 (setq startday
(org-day-of-week 1 10 year
))
1992 (list 39 startday year
))
1994 (list 40 startday year
))
1996 (list 39 startday year
)))))))
1998 (defun org-clock-special-range (key &optional time as-strings wstart
)
1999 "Return two times bordering a special time range.
2000 Key is a symbol specifying the range and can be one of `today', `yesterday',
2001 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
2002 By default, a week starts Monday 0:00 and ends Sunday 24:00.
2003 The range is determined relative to TIME. TIME defaults to the current time.
2004 The return value is a cons cell with two internal times like the ones
2005 returned by `current time' or `encode-time'. If AS-STRINGS is non-nil,
2006 the returned times will be formatted strings. If WSTART is non-nil,
2007 use this number to specify the starting day of a week (monday is 1)."
2008 (if (integerp key
) (setq key
(intern (number-to-string key
))))
2009 (let* ((tm (decode-time (or time
(current-time))))
2010 (s 0) (m (nth 1 tm
)) (h (nth 2 tm
))
2011 (d (nth 3 tm
)) (month (nth 4 tm
)) (y (nth 5 tm
))
2014 (skey (symbol-name key
))
2016 (q (cond ((>= (nth 4 tm
) 10) 4)
2017 ((>= (nth 4 tm
) 7) 3)
2018 ((>= (nth 4 tm
) 4) 2)
2019 ((>= (nth 4 tm
) 1) 1)))
2020 s1 m1 h1 d1 month1 y1 diff ts te fm txt w date
2021 interval tmp shiftedy shiftedm shiftedq
)
2023 ((string-match "^[0-9]+$" skey
)
2024 (setq y
(string-to-number skey
) m
1 d
1 key
'year
))
2025 ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)$" skey
)
2026 (setq y
(string-to-number (match-string 1 skey
))
2027 month
(string-to-number (match-string 2 skey
))
2029 ((string-match "^\\([0-9]+\\)-[wW]\\([0-9]\\{1,2\\}\\)$" skey
)
2031 (setq y
(string-to-number (match-string 1 skey
))
2032 w
(string-to-number (match-string 2 skey
)))
2033 (setq date
(calendar-gregorian-from-absolute
2034 (calendar-absolute-from-iso (list w
1 y
))))
2035 (setq d
(nth 1 date
) month
(car date
) y
(nth 2 date
)
2038 ((string-match "^\\([0-9]+\\)-[qQ]\\([1-4]\\)$" skey
)
2040 (setq y
(string-to-number (match-string 1 skey
)))
2041 (setq q
(string-to-number (match-string 2 skey
)))
2042 (setq date
(calendar-gregorian-from-absolute
2043 (calendar-absolute-from-iso (org-quarter-to-date q y
))))
2044 (setq d
(nth 1 date
) month
(car date
) y
(nth 2 date
)
2047 ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)-\\([0-9]\\{1,2\\}\\)$" skey
)
2048 (setq y
(string-to-number (match-string 1 skey
))
2049 month
(string-to-number (match-string 2 skey
))
2050 d
(string-to-number (match-string 3 skey
))
2052 ((string-match "\\([-+][0-9]+\\)$" skey
)
2053 (setq shift
(string-to-number (match-string 1 skey
))
2054 key
(intern (substring skey
0 (match-beginning 1))))
2055 (if (and (memq key
'(quarter thisq
)) (> shift
0))
2056 (error "Looking forward with quarters isn't implemented"))))
2059 (cond ((eq key
'yesterday
) (setq key
'today shift -
1))
2060 ((eq key
'lastweek
) (setq key
'week shift -
1))
2061 ((eq key
'lastmonth
) (setq key
'month shift -
1))
2062 ((eq key
'lastyear
) (setq key
'year shift -
1))
2063 ((eq key
'lastq
) (setq key
'quarter shift -
1))))
2065 ((memq key
'(day today
))
2066 (setq d
(+ d shift
) h
0 m
0 h1
24 m1
0))
2067 ((memq key
'(week thisweek
))
2068 (setq diff
(+ (* -
7 shift
) (if (= dow
0) (- 7 ws
) (- dow ws
)))
2069 m
0 h
0 d
(- d diff
) d1
(+ 7 d
)))
2070 ((memq key
'(month thismonth
))
2071 (setq d
1 h
0 m
0 d1
1 month
(+ month shift
) month1
(1+ month
) h1
0 m1
0))
2072 ((memq key
'(quarter thisq
))
2073 ; compute if this shift remains in this year
2074 ; if not, compute how many years and quarters we have to shift (via floor*)
2075 ; and compute the shifted years, months and quarters
2077 ((< (+ (- q
1) shift
) 0) ; shift not in this year
2078 (setq interval
(* -
1 (+ (- q
1) shift
)))
2079 ; set tmp to ((years to shift) (quarters to shift))
2080 (setq tmp
(org-floor* interval
4))
2081 ; due to the use of floor, 0 quarters actually means 4
2082 (if (= 0 (nth 1 tmp
))
2083 (setq shiftedy
(- y
(nth 0 tmp
))
2086 (setq shiftedy
(- y
(+ 1 (nth 0 tmp
)))
2087 shiftedm
(- 13 (* 3 (nth 1 tmp
)))
2088 shiftedq
(- 5 (nth 1 tmp
))))
2089 (setq d
1 h
0 m
0 d1
1 month shiftedm month1
(+ 3 shiftedm
) h1
0 m1
0 y shiftedy
))
2090 ((> (+ q shift
) 0) ; shift is within this year
2091 (setq shiftedq
(+ q shift
))
2093 (setq d
1 h
0 m
0 d1
1 month
(+ 1 (* 3 (- (+ q shift
) 1))) month1
(+ 4 (* 3 (- (+ q shift
) 1))) h1
0 m1
0))))
2094 ((memq key
'(year thisyear
))
2095 (setq m
0 h
0 d
1 month
1 y
(+ y shift
) y1
(1+ y
)))
2096 (t (error "No such time block %s" key
)))
2097 (setq ts
(encode-time s m h d month y
)
2098 te
(encode-time (or s1 s
) (or m1 m
) (or h1 h
)
2099 (or d1 d
) (or month1 month
) (or y1 y
)))
2100 (setq fm
(cdr org-time-stamp-formats
))
2102 ((memq key
'(day today
))
2103 (setq txt
(format-time-string "%A, %B %d, %Y" ts
)))
2104 ((memq key
'(week thisweek
))
2105 (setq txt
(format-time-string "week %G-W%V" ts
)))
2106 ((memq key
'(month thismonth
))
2107 (setq txt
(format-time-string "%B %Y" ts
)))
2108 ((memq key
'(year thisyear
))
2109 (setq txt
(format-time-string "the year %Y" ts
)))
2110 ((memq key
'(quarter thisq
))
2111 (setq txt
(concat (org-count-quarter shiftedq
) " quarter of " (number-to-string shiftedy
))))
2114 (list (format-time-string fm ts
) (format-time-string fm te
) txt
)
2117 (defun org-count-quarter (n)
2124 (defun org-clocktable-shift (dir n
)
2125 "Try to shift the :block date of the clocktable at point.
2126 Point must be in the #+BEGIN: line of a clocktable, or this function
2127 will throw an error.
2128 DIR is a direction, a symbol `left', `right', `up', or `down'.
2129 Both `left' and `down' shift the block toward the past, `up' and `right'
2130 push it toward the future.
2131 N is the number of shift steps to take. The size of the step depends on
2132 the currently selected interval size."
2133 (setq n
(prefix-numeric-value n
))
2134 (and (memq dir
'(left down
)) (setq n
(- n
)))
2136 (goto-char (point-at-bol))
2137 (if (not (looking-at "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>.*?:block[ \t]+\\(\\S-+\\)"))
2138 (error "Line needs a :block definition before this command works")
2139 (let* ((b (match-beginning 1)) (e (match-end 1))
2140 (s (match-string 1))
2141 block shift ins y mw d date wp m
)
2143 ((equal s
"yesterday") (setq s
"today-1"))
2144 ((equal s
"lastweek") (setq s
"thisweek-1"))
2145 ((equal s
"lastmonth") (setq s
"thismonth-1"))
2146 ((equal s
"lastyear") (setq s
"thisyear-1"))
2147 ((equal s
"lastq") (setq s
"thisq-1")))
2150 ((string-match "^\\(today\\|thisweek\\|thismonth\\|thisyear\\|thisq\\)\\([-+][0-9]+\\)?$" s
)
2151 (setq block
(match-string 1 s
)
2152 shift
(if (match-end 2)
2153 (string-to-number (match-string 2 s
))
2155 (setq shift
(+ shift n
))
2156 (setq ins
(if (= shift
0) block
(format "%s%+d" block shift
))))
2157 ((string-match "\\([0-9]+\\)\\(-\\([wWqQ]?\\)\\([0-9]\\{1,2\\}\\)\\(-\\([0-9]\\{1,2\\}\\)\\)?\\)?" s
)
2158 ;; 1 1 2 3 3 4 4 5 6 6 5 2
2159 (setq y
(string-to-number (match-string 1 s
))
2160 wp
(and (match-end 3) (match-string 3 s
))
2161 mw
(and (match-end 4) (string-to-number (match-string 4 s
)))
2162 d
(and (match-end 6) (string-to-number (match-string 6 s
))))
2164 (d (setq ins
(format-time-string
2166 (encode-time 0 0 0 (+ d n
) m y
))))
2167 ((and wp
(string-match "w\\|W" wp
) mw
(> (length wp
) 0))
2169 (setq date
(calendar-gregorian-from-absolute
2170 (calendar-absolute-from-iso (list (+ mw n
) 1 y
))))
2171 (setq ins
(format-time-string
2173 (encode-time 0 0 0 (nth 1 date
) (car date
) (nth 2 date
)))))
2174 ((and wp
(string-match "q\\|Q" wp
) mw
(> (length wp
) 0))
2176 ; if the 4th + 1 quarter is requested we flip to the 1st quarter of the next year
2181 ; if the 1st - 1 quarter is requested we flip to the 4th quarter of the previous year
2186 (setq date
(calendar-gregorian-from-absolute
2187 (calendar-absolute-from-iso (org-quarter-to-date (+ mw n
) y
))))
2188 (setq ins
(format-time-string
2189 (concat (number-to-string y
) "-Q" (number-to-string (+ mw n
)))
2190 (encode-time 0 0 0 (nth 1 date
) (car date
) (nth 2 date
)))))
2192 (setq ins
(format-time-string
2194 (encode-time 0 0 0 1 (+ mw n
) y
))))
2196 (setq ins
(number-to-string (+ y n
))))))
2197 (t (error "Cannot shift clocktable block")))
2201 (delete-region (point) (+ (point) (- e b
)))
2202 (beginning-of-line 1)
2207 (defun org-dblock-write:clocktable
(params)
2208 "Write the standard clocktable."
2209 (setq params
(org-combine-plists org-clocktable-defaults params
))
2211 (let* ((scope (plist-get params
:scope
))
2212 (block (plist-get params
:block
))
2213 (ts (plist-get params
:tstart
))
2214 (te (plist-get params
:tend
))
2215 (link (plist-get params
:link
))
2216 (maxlevel (or (plist-get params
:maxlevel
) 3))
2217 (ws (plist-get params
:wstart
))
2218 (step (plist-get params
:step
))
2219 (timestamp (plist-get params
:timestamp
))
2220 (formatter (or (plist-get params
:formatter
)
2221 org-clock-clocktable-formatter
2222 'org-clocktable-write-default
))
2223 cc range-text ipos pos one-file-with-archives
2224 scope-is-list tbls level
)
2225 ;; Check if we need to do steps
2227 ;; Get the range text for the header
2228 (setq cc
(org-clock-special-range block nil t ws
)
2229 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2231 ;; Write many tables, in steps
2232 (unless (or block
(and ts te
))
2233 (error "Clocktable `:step' can only be used with `:block' or `:tstart,:end'"))
2234 (org-clocktable-steps params
)
2237 (setq ipos
(point)) ; remember the insertion position
2239 ;; Get the right scope
2242 ((and scope
(listp scope
) (symbolp (car scope
)))
2243 (setq scope
(eval scope
)))
2245 (setq scope
(org-agenda-files t
)))
2246 ((eq scope
'agenda-with-archives
)
2247 (setq scope
(org-agenda-files t
))
2248 (setq scope
(org-add-archive-files scope
)))
2249 ((eq scope
'file-with-archives
)
2250 (setq scope
(org-add-archive-files (list (buffer-file-name)))
2251 one-file-with-archives t
)))
2252 (setq scope-is-list
(and scope
(listp scope
)))
2254 ;; we collect from several files
2255 (let* ((files scope
)
2257 (org-agenda-prepare-buffers files
)
2258 (while (setq file
(pop files
))
2259 (with-current-buffer (find-buffer-visiting file
)
2262 (push (org-clock-get-table-data file params
) tbls
))))))
2263 ;; Just from the current file
2265 ;; get the right range into the restriction
2266 (org-agenda-prepare-buffers (list (buffer-file-name)))
2268 ((not scope
)) ; use the restriction as it is now
2269 ((eq scope
'file
) (widen))
2270 ((eq scope
'subtree
) (org-narrow-to-subtree))
2272 (while (org-up-heading-safe))
2273 (org-narrow-to-subtree))
2274 ((and (symbolp scope
) (string-match "^tree\\([0-9]+\\)$"
2275 (symbol-name scope
)))
2276 (setq level
(string-to-number (match-string 1 (symbol-name scope
))))
2278 (while (org-up-heading-safe)
2279 (looking-at org-outline-regexp
)
2280 (if (<= (org-reduced-level (funcall outline-level
)) level
)
2281 (throw 'exit nil
))))
2282 (org-narrow-to-subtree)))
2283 ;; do the table, with no file name.
2284 (push (org-clock-get-table-data nil params
) tbls
)))
2286 ;; OK, at this point we tbls as a list of tables, one per file
2287 (setq tbls
(nreverse tbls
))
2289 (setq params
(plist-put params
:multifile scope-is-list
))
2290 (setq params
(plist-put params
:one-file-with-archives
2291 one-file-with-archives
))
2293 (funcall formatter ipos tbls params
))))
2295 (defun org-clocktable-write-default (ipos tables params
)
2296 "Write out a clock table at position IPOS in the current buffer.
2297 TABLES is a list of tables with clocking data as produced by
2298 `org-clock-get-table-data'. PARAMS is the parameter property list obtained
2299 from the dynamic block definition."
2300 ;; This function looks quite complicated, mainly because there are a
2301 ;; lot of options which can add or remove columns. I have massively
2302 ;; commented this function, the I hope it is understandable. If
2303 ;; someone wants to write their own special formatter, this maybe
2304 ;; much easier because there can be a fixed format with a
2305 ;; well-defined number of columns...
2306 (let* ((hlchars '((1 .
"*") (2 .
"/")))
2307 (lwords (assoc (or (plist-get params
:lang
)
2308 org-export-default-language
)
2309 org-clock-clocktable-language-setup
))
2310 (multifile (plist-get params
:multifile
))
2311 (block (plist-get params
:block
))
2312 (ts (plist-get params
:tstart
))
2313 (te (plist-get params
:tend
))
2314 (header (plist-get params
:header
))
2315 (narrow (plist-get params
:narrow
))
2316 (ws (or (plist-get params
:wstart
) 1))
2317 (link (plist-get params
:link
))
2318 (maxlevel (or (plist-get params
:maxlevel
) 3))
2319 (emph (plist-get params
:emphasize
))
2320 (level-p (plist-get params
:level
))
2321 (org-time-clocksum-use-effort-durations
2322 (plist-get params
:effort-durations
))
2323 (timestamp (plist-get params
:timestamp
))
2324 (properties (plist-get params
:properties
))
2325 (ntcol (max 1 (or (plist-get params
:tcolumns
) 100)))
2326 (rm-file-column (plist-get params
:one-file-with-archives
))
2327 (indent (plist-get params
:indent
))
2328 (case-fold-search t
)
2329 range-text total-time tbl level hlc formula pcol
2330 file-time entries entry headline
2331 recalc content narrow-cut-p tcol
)
2333 ;; Implement abbreviations
2334 (when (plist-get params
:compact
)
2335 (setq level nil indent t narrow
(or narrow
'40!) ntcol
1))
2337 ;; Some consistency test for parameters
2338 (unless (integerp ntcol
)
2339 (setq params
(plist-put params
:tcolumns
(setq ntcol
100))))
2341 (when (and narrow
(integerp narrow
) link
)
2342 ;; We cannot have both integer narrow and link
2344 "Using hard narrowing in clocktable to allow for links")
2345 (setq narrow
(intern (format "%d!" narrow
))))
2350 ((and (symbolp narrow
)
2351 (string-match "\\`[0-9]+!\\'" (symbol-name narrow
)))
2352 (setq narrow-cut-p t
2353 narrow
(string-to-number (substring (symbol-name narrow
)
2356 (error "Invalid value %s of :narrow property in clock table"
2360 ;; Get the range text for the header
2361 (setq range-text
(nth 2 (org-clock-special-range block nil t ws
))))
2363 ;; Compute the total time
2364 (setq total-time
(apply '+ (mapcar 'cadr tables
)))
2366 ;; Now we need to output this tsuff
2369 ;; Insert the text *before* the actual table
2370 (insert-before-markers
2372 ;; Format the standard header
2377 (format-time-string (cdr org-time-stamp-formats
))
2380 (if block
(concat ", for " range-text
".") "")
2383 ;; Insert the narrowing line
2384 (when (and narrow
(integerp narrow
) (not narrow-cut-p
))
2385 (insert-before-markers
2386 "|" ; table line starter
2387 (if multifile
"|" "") ; file column, maybe
2388 (if level-p
"|" "") ; level column, maybe
2389 (if timestamp
"|" "") ; timestamp column, maybe
2390 (if properties
(make-string (length properties
) ?|
) "") ;properties columns, maybe
2391 (format "<%d>| |\n" narrow
))) ; headline and time columns
2393 ;; Insert the table header line
2394 (insert-before-markers
2395 "|" ; table line starter
2396 (if multifile
(concat (nth 1 lwords
) "|") "") ; file column, maybe
2397 (if level-p
(concat (nth 2 lwords
) "|") "") ; level column, maybe
2398 (if timestamp
(concat (nth 3 lwords
) "|") "") ; timestamp column, maybe
2399 (if properties
(concat (mapconcat 'identity properties
"|") "|") "") ;properties columns, maybe
2400 (concat (nth 4 lwords
) "|"
2401 (nth 5 lwords
) "|\n")) ; headline and time columns
2403 ;; Insert the total time in the table
2404 (insert-before-markers
2406 "|" ; table line starter
2407 (if multifile
(concat "| " (nth 6 lwords
) " ") "")
2408 ; file column, maybe
2409 (if level-p
"|" "") ; level column, maybe
2410 (if timestamp
"|" "") ; timestamp column, maybe
2411 (if properties
(make-string (length properties
) ?|
) "") ; properties columns, maybe
2412 (concat (format org-clock-total-time-cell-format
(nth 7 lwords
)) "| ") ; instead of a headline
2413 (format org-clock-total-time-cell-format
2414 (org-minutes-to-clocksum-string (or total-time
0))) ; the time
2417 ;; Now iterate over the tables and insert the data
2418 ;; but only if any time has been collected
2419 (when (and total-time
(> total-time
0))
2421 (while (setq tbl
(pop tables
))
2422 ;; now tbl is the table resulting from one file.
2423 (setq file-time
(nth 1 tbl
))
2424 (when (or (and file-time
(> file-time
0))
2425 (not (plist-get params
:fileskip0
)))
2426 (insert-before-markers "|-\n") ; a hline because a new file starts
2427 ;; First the file time, if we have multiple files
2429 ;; Summarize the time collected from this file
2430 (insert-before-markers
2431 (format (concat "| %s %s | %s%s"
2432 (format org-clock-file-time-cell-format
(nth 8 lwords
))
2434 (file-name-nondirectory (car tbl
))
2435 (if level-p
"| " "") ; level column, maybe
2436 (if timestamp
"| " "") ; timestamp column, maybe
2437 (if properties
(make-string (length properties
) ?|
) "") ;properties columns, maybe
2438 (org-minutes-to-clocksum-string (nth 1 tbl
))))) ; the time
2440 ;; Get the list of node entries and iterate over it
2441 (setq entries
(nth 2 tbl
))
2442 (while (setq entry
(pop entries
))
2443 (setq level
(car entry
)
2444 headline
(nth 1 entry
)
2445 hlc
(if emph
(or (cdr (assoc level hlchars
)) "") ""))
2447 (if (and (string-match (concat "\\`" org-bracket-link-regexp
2452 (format "[[%s][%s]]"
2453 (match-string 1 headline
)
2454 (org-shorten-string (match-string 3 headline
)
2456 (setq headline
(org-shorten-string headline narrow
))))
2457 (insert-before-markers
2458 "|" ; start the table line
2459 (if multifile
"|" "") ; free space for file name column?
2460 (if level-p
(format "%d|" (car entry
)) "") ; level, maybe
2461 (if timestamp
(concat (nth 2 entry
) "|") "") ; timestamp, maybe
2465 (lambda (p) (or (cdr (assoc p
(nth 4 entry
))) ""))
2466 properties
"|") "|") "") ;properties columns, maybe
2467 (if indent
(org-clocktable-indent-string level
) "") ; indentation
2468 hlc headline hlc
"|" ; headline
2469 (make-string (min (1- ntcol
) (or (- level
1))) ?|
)
2470 ; empty fields for higher levels
2471 hlc
(org-minutes-to-clocksum-string (nth 3 entry
)) hlc
; time
2474 ;; When exporting subtrees or regions the region might be
2475 ;; activated, so let's disable ̀delete-active-region'
2476 (let ((delete-active-region nil
)) (backward-delete-char 1))
2477 (if (setq formula
(plist-get params
:formula
))
2480 ;; compute the column where the % numbers need to go
2485 (min maxlevel
(or ntcol
100))))
2486 ;; compute the column where the total time is
2490 (if timestamp
1 0)))
2493 "\n#+TBLFM: $%d='(org-clock-time%% @%d$%d $%d..$%d);%%.1f"
2494 pcol
; the column where the % numbers should go
2495 (if (and narrow
(not narrow-cut-p
)) 3 2) ; row of the total time
2496 tcol
; column of the total time
2497 tcol
(1- pcol
) ; range of columns where times can be found
2501 (insert "\n#+TBLFM: " formula
)
2503 (t (error "Invalid formula in clocktable")))
2504 ;; Should we rescue an old formula?
2505 (when (stringp (setq content
(plist-get params
:content
)))
2506 (when (string-match "^\\([ \t]*#\\+tblfm:.*\\)" content
)
2508 (insert "\n" (match-string 1 (plist-get params
:content
)))
2509 (beginning-of-line 0))))
2510 ;; Back to beginning, align the table, recalculate if necessary
2512 (skip-chars-forward "^|")
2514 (when org-hide-emphasis-markers
2515 ;; we need to align a second time
2520 (if (and narrow
(not narrow-cut-p
)) (beginning-of-line 2))
2521 (org-table-goto-column pcol nil
'force
)
2523 (org-table-recalculate 'all
))
2524 (when rm-file-column
2525 ;; The file column is actually not wanted
2527 (org-table-delete-column))
2530 (defun org-clocktable-indent-string (level)
2535 (setq level
(1- level
)
2536 str
(concat str
"___")))
2539 (defun org-clocktable-steps (params)
2540 "Step through the range to make a number of clock tables."
2541 (let* ((p1 (copy-sequence params
))
2542 (ts (plist-get p1
:tstart
))
2543 (te (plist-get p1
:tend
))
2544 (ws (plist-get p1
:wstart
))
2545 (step0 (plist-get p1
:step
))
2546 (step (cdr (assoc step0
'((day .
86400) (week .
604800)))))
2547 (stepskip0 (plist-get p1
:stepskip0
))
2548 (block (plist-get p1
:block
))
2549 cc range-text step-time
)
2551 (setq cc
(org-clock-special-range block nil t ws
)
2552 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2555 ;; If ts is a number, it's an absolute day number from org-agenda.
2556 (destructuring-bind (month day year
) (calendar-gregorian-from-absolute ts
)
2557 (setq ts
(org-float-time (encode-time 0 0 0 day month year
)))))
2559 (setq ts
(org-float-time
2560 (apply 'encode-time
(org-parse-time-string ts
))))))
2564 (destructuring-bind (month day year
) (calendar-gregorian-from-absolute te
)
2565 (setq te
(org-float-time (encode-time 0 0 0 day month year
)))))
2567 (setq te
(org-float-time
2568 (apply 'encode-time
(org-parse-time-string te
))))))
2569 (setq p1
(plist-put p1
:header
""))
2570 (setq p1
(plist-put p1
:step nil
))
2571 (setq p1
(plist-put p1
:block nil
))
2573 (or (bolp) (insert "\n"))
2574 (setq p1
(plist-put p1
:tstart
(format-time-string
2575 (org-time-stamp-format nil t
)
2576 (seconds-to-time ts
))))
2577 (setq p1
(plist-put p1
:tend
(format-time-string
2578 (org-time-stamp-format nil t
)
2579 (seconds-to-time (setq ts
(+ ts step
))))))
2580 (insert "\n" (if (eq step0
'day
) "Daily report: "
2581 "Weekly report starting on: ")
2582 (plist-get p1
:tstart
) "\n")
2583 (setq step-time
(org-dblock-write:clocktable p1
))
2584 (re-search-forward "^[ \t]*#\\+END:")
2585 (when (and (equal step-time
0) stepskip0
)
2586 ;; Remove the empty table
2587 (delete-region (point-at-bol)
2589 (re-search-backward "^\\(Daily\\|Weekly\\) report"
2594 (defun org-clock-get-table-data (file params
)
2595 "Get the clocktable data for file FILE, with parameters PARAMS.
2596 FILE is only for identification - this function assumes that
2597 the correct buffer is current, and that the wanted restriction is
2599 The return value will be a list with the file name and the total
2600 file time (in minutes) as 1st and 2nd elements. The third element
2601 of this list will be a list of headline entries. Each entry has the
2602 following structure:
2604 (LEVEL HEADLINE TIMESTAMP TIME)
2606 LEVEL: The level of the headline, as an integer. This will be
2607 the reduced leve, so 1,2,3,... even if only odd levels
2609 HEADLINE: The text of the headline. Depending on PARAMS, this may
2610 already be formatted like a link.
2611 TIMESTAMP: If PARAMS require it, this will be a time stamp found in the
2612 entry, any of SCHEDULED, DEADLINE, NORMAL, or first inactive,
2614 TIME: The sum of all time spend in this tree, in minutes. This time
2615 will of cause be restricted to the time block and tags match
2616 specified in PARAMS."
2617 (let* ((maxlevel (or (plist-get params
:maxlevel
) 3))
2618 (timestamp (plist-get params
:timestamp
))
2619 (ts (plist-get params
:tstart
))
2620 (te (plist-get params
:tend
))
2621 (ws (plist-get params
:wstart
))
2622 (block (plist-get params
:block
))
2623 (link (plist-get params
:link
))
2624 (tags (plist-get params
:tags
))
2625 (properties (plist-get params
:properties
))
2626 (inherit-property-p (plist-get params
:inherit-props
))
2628 (matcher (if tags
(cdr (org-make-tags-matcher tags
))))
2629 cc range-text st p time level hdl props tsp tbl
)
2631 (setq org-clock-file-total-minutes nil
)
2633 (setq cc
(org-clock-special-range block nil t ws
)
2634 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2635 (when (integerp ts
) (setq ts
(calendar-gregorian-from-absolute ts
)))
2636 (when (integerp te
) (setq te
(calendar-gregorian-from-absolute te
)))
2637 (when (and ts
(listp ts
))
2638 (setq ts
(format "%4d-%02d-%02d" (nth 2 ts
) (car ts
) (nth 1 ts
))))
2639 (when (and te
(listp te
))
2640 (setq te
(format "%4d-%02d-%02d" (nth 2 te
) (car te
) (nth 1 te
))))
2641 ;; Now the times are strings we can parse.
2642 (if ts
(setq ts
(org-float-time
2643 (seconds-to-time (org-matcher-time ts
)))))
2644 (if te
(setq te
(org-float-time
2645 (seconds-to-time (org-matcher-time te
)))))
2647 (org-clock-sum ts te
2648 (unless (null matcher
)
2650 (let* ((tags-list (org-get-tags-at))
2651 (org-scanner-tags tags-list
)
2652 (org-trust-scanner-tags t
))
2654 (goto-char (point-min))
2656 (while (or (and (bobp) (prog1 st
(setq st nil
))
2657 (get-text-property (point) :org-clock-minutes
)
2658 (setq p
(point-min)))
2659 (setq p
(next-single-property-change
2660 (point) :org-clock-minutes
)))
2662 (when (setq time
(get-text-property p
:org-clock-minutes
))
2664 (beginning-of-line 1)
2665 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@#%:]+:\\)?[ \t]*$"))
2666 (setq level
(org-reduced-level
2667 (- (match-end 1) (match-beginning 1))))
2668 (<= level maxlevel
))
2669 (setq hdl
(if (not link
)
2671 (org-make-link-string
2672 (format "file:%s::%s"
2675 (org-make-org-heading-search-string
2679 (setq props
(org-entry-properties (point)))
2680 (or (cdr (assoc "SCHEDULED" props
))
2681 (cdr (assoc "DEADLINE" props
))
2682 (cdr (assoc "TIMESTAMP" props
))
2683 (cdr (assoc "TIMESTAMP_IA" props
))))
2684 props
(when properties
2688 (when (org-entry-get (point) p inherit-property-p
)
2689 (cons p
(org-entry-get (point) p inherit-property-p
))))
2691 (when (> time
0) (push (list level hdl tsp time props
) tbl
))))))
2692 (setq tbl
(nreverse tbl
))
2693 (list file org-clock-file-total-minutes tbl
))))
2695 (defun org-clock-time%
(total &rest strings
)
2696 "Compute a time fraction in percent.
2697 TOTAL s a time string like 10:21 specifying the total times.
2698 STRINGS is a list of strings that should be checked for a time.
2699 The first string that does have a time will be used.
2700 This function is made for clock tables."
2701 (let ((re "\\([0-9]+\\):\\([0-9]+\\)")
2705 (if (not (string-match re total
))
2707 (setq tot
(+ (string-to-number (match-string 2 total
))
2708 (* 60 (string-to-number (match-string 1 total
)))))
2709 (if (= tot
0.
) (throw 'exit
0.
)))
2710 (while (setq s
(pop strings
))
2711 (if (string-match "\\([0-9]+\\):\\([0-9]+\\)" s
)
2713 (/ (* 100.0 (+ (string-to-number (match-string 2 s
))
2714 (* 60 (string-to-number
2715 (match-string 1 s
)))))
2719 ;; Saving and loading the clock
2721 (defvar org-clock-loaded nil
2722 "Was the clock file loaded?")
2724 (defun org-clock-update-time-maybe ()
2725 "If this is a CLOCK line, update it and return t.
2726 Otherwise, return nil."
2729 (beginning-of-line 1)
2730 (skip-chars-forward " \t")
2731 (when (looking-at org-clock-string
)
2732 (let ((re (concat "[ \t]*" org-clock-string
2733 " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
2734 "\\([ \t]*=>.*\\)?\\)?"))
2737 ((not (looking-at re
))
2739 ((not (match-end 2))
2740 (when (and (equal (marker-buffer org-clock-marker
) (current-buffer))
2741 (> org-clock-marker
(point))
2742 (<= org-clock-marker
(point-at-eol)))
2743 ;; The clock is running here
2744 (setq org-clock-start-time
2746 (org-parse-time-string (match-string 1))))
2747 (org-clock-update-mode-line)))
2749 (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
2751 (setq ts
(match-string 1)
2752 te
(match-string 3))
2753 (setq s
(- (org-float-time
2754 (apply 'encode-time
(org-parse-time-string te
)))
2756 (apply 'encode-time
(org-parse-time-string ts
))))
2759 h
(floor (/ s
3600))
2763 (insert " => " (format (if neg
"-%d:%02d" "%2d:%02d") h m
))
2766 (defun org-clock-save ()
2767 "Persist various clock-related data to disk.
2768 The details of what will be saved are regulated by the variable
2769 `org-clock-persist'."
2770 (when (and org-clock-persist
2771 (or org-clock-loaded
2772 org-clock-has-been-used
2773 (not (file-exists-p org-clock-persist-file
))))
2775 (with-current-buffer (find-file (expand-file-name org-clock-persist-file
))
2777 (delete-region (point-min) (point-max))
2779 (insert (format ";; org-persist.el - %s at %s\n"
2780 system-name
(format-time-string
2781 (cdr org-time-stamp-formats
))))
2782 (if (and (memq org-clock-persist
'(t clock
))
2783 (setq b
(org-clocking-buffer))
2784 (setq b
(or (buffer-base-buffer b
) b
))
2786 (buffer-file-name b
)
2787 (or (not org-clock-persist-query-save
)
2788 (y-or-n-p (concat "Save current clock ("
2789 (substring-no-properties
2792 (insert "(setq resume-clock '(\""
2793 (buffer-file-name (org-clocking-buffer))
2794 "\" . " (int-to-string (marker-position org-clock-marker
))
2796 ;; Store clocked task history. Tasks are stored reversed to make
2798 (when (and (memq org-clock-persist
'(t history
))
2801 "(setq stored-clock-history '("
2804 (when (and (setq b
(marker-buffer m
))
2805 (setq b
(or (buffer-base-buffer b
) b
))
2807 (buffer-file-name b
))
2808 (concat "(\"" (buffer-file-name b
)
2809 "\" . " (int-to-string (marker-position m
))
2811 (reverse org-clock-history
) " ") "))\n"))
2813 (kill-buffer (current-buffer)))))))
2815 (defun org-clock-load ()
2816 "Load clock-related data from disk, maybe resuming a stored clock."
2817 (when (and org-clock-persist
(not org-clock-loaded
))
2818 (let ((filename (expand-file-name org-clock-persist-file
))
2819 (org-clock-in-resume 'auto-restart
)
2820 resume-clock stored-clock-history
)
2821 (if (not (file-readable-p filename
))
2822 (message "Not restoring clock data; %s not found"
2823 org-clock-persist-file
)
2824 (message "%s" "Restoring clock data")
2825 (setq org-clock-loaded t
)
2826 (load-file filename
)
2828 (when stored-clock-history
2829 (save-window-excursion
2830 (mapc (lambda (task)
2831 (if (file-exists-p (car task
))
2832 (org-clock-history-push (cdr task
)
2833 (find-file (car task
)))))
2834 stored-clock-history
)))
2836 (when (and resume-clock org-clock-persist
2837 (file-exists-p (car resume-clock
))
2838 (or (not org-clock-persist-query-resume
)
2842 (with-current-buffer (find-file (car resume-clock
))
2844 (goto-char (cdr resume-clock
))
2845 (org-back-to-heading t
)
2846 (and (looking-at org-complex-heading-regexp
)
2849 (when (file-exists-p (car resume-clock
))
2850 (with-current-buffer (find-file (car resume-clock
))
2851 (goto-char (cdr resume-clock
))
2852 (let ((org-clock-auto-clock-resolution nil
))
2854 (if (outline-invisible-p)
2855 (org-show-context))))))))))
2857 ;; Suggested bindings
2858 (org-defkey org-mode-map
"\C-c\C-x\C-e" 'org-clock-modify-effort-estimate
)
2860 (provide 'org-clock
)
2863 ;; generated-autoload-file: "org-loaddefs.el"
2866 ;;; org-clock.el ends here
