1 ;;; org-clock.el --- The time clocking code for Org-mode
3 ;; Copyright (C) 2004-2012 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 (defvar org-time-stamp-formats
)
40 (defvar org-frame-title-format-backup frame-title-format
)
42 (defgroup org-clock nil
43 "Options concerning clocking working time in Org-mode."
47 (defcustom org-clock-into-drawer org-log-into-drawer
48 "Should clocking info be wrapped into a drawer?
49 When t, clocking info will always be inserted into a :LOGBOOK: drawer.
50 If necessary, the drawer will be created.
51 When nil, the drawer will not be created, but used when present.
52 When an integer and the number of clocking entries in an item
53 reaches or exceeds this number, a drawer will be created.
54 When a string, it names the drawer to be used.
56 The default for this variable is the value of `org-log-into-drawer',
61 (const :tag
"Always" t
)
62 (const :tag
"Only when drawer exists" nil
)
63 (integer :tag
"When at least N clock entries")
64 (const :tag
"Into LOGBOOK drawer" "LOGBOOK")
65 (string :tag
"Into Drawer named...")))
67 (defun org-clock-into-drawer ()
68 "Return the value of `org-clock-into-drawer', but let properties overrule.
69 If the current entry has or inherits a CLOCK_INTO_DRAWER
70 property, it will be used instead of the default value; otherwise
71 if the current entry has or inherits a LOG_INTO_DRAWER property,
72 it will be used instead of the default value.
73 The default is the value of the customizable variable `org-clock-into-drawer',
75 (let ((p (org-entry-get nil
"CLOCK_INTO_DRAWER" 'inherit
))
76 (q (org-entry-get nil
"LOG_INTO_DRAWER" 'inherit
)))
78 ((or (not (or p q
)) (equal p
"nil") (equal q
"nil")) org-clock-into-drawer
)
79 ((or (equal p
"t") (equal q
"t")) "LOGBOOK")
83 (defcustom org-clock-out-when-done t
84 "When non-nil, clock will be stopped when the clocked entry is marked DONE.
85 DONE here means any DONE-like state.
86 A nil value means clock will keep running until stopped explicitly with
87 `C-c C-x C-o', or until the clock is started in a different item.
88 Instead of t, this can also be a list of TODO states that should trigger
93 (const :tag
"Yes, when done" t
)
94 (repeat :tag
"State list"
95 (string :tag
"TODO keyword"))))
97 (defcustom org-clock-out-remove-zero-time-clocks nil
98 "Non-nil means remove the clock line when the resulting time is zero."
102 (defcustom org-clock-in-switch-to-state nil
103 "Set task to a special todo state while clocking it.
104 The value should be the state to which the entry should be
105 switched. If the value is a function, it must take one
106 parameter (the current TODO state of the item) and return the
107 state to switch it to."
111 (const :tag
"Don't force a state" nil
)
112 (string :tag
"State")
113 (symbol :tag
"Function")))
115 (defcustom org-clock-out-switch-to-state nil
116 "Set task to a special todo state after clocking out.
117 The value should be the state to which the entry should be
118 switched. If the value is a function, it must take one
119 parameter (the current TODO state of the item) and return the
120 state to switch it to."
124 (const :tag
"Don't force a state" nil
)
125 (string :tag
"State")
126 (symbol :tag
"Function")))
128 (defcustom org-clock-history-length
5
129 "Number of clock tasks to remember in history."
133 (defcustom org-clock-goto-may-find-recent-task t
134 "Non-nil means `org-clock-goto' can go to recent task if no active clock."
138 (defcustom org-clock-heading-function nil
139 "When non-nil, should be a function to create `org-clock-heading'.
140 This is the string shown in the mode line when a clock is running.
141 The function is called with point at the beginning of the headline."
145 (defcustom org-clock-string-limit
0
146 "Maximum length of clock strings in the mode line. 0 means no limit."
150 (defcustom org-clock-in-resume nil
151 "If non-nil, resume clock when clocking into task with open clock.
152 When clocking into a task with a clock entry which has not been closed,
153 the clock can be resumed from that point."
157 (defcustom org-clock-persist nil
158 "When non-nil, save the running clock when Emacs is closed.
159 The clock is resumed when Emacs restarts.
160 When this is t, both the running clock, and the entire clock
161 history are saved. When this is the symbol `clock', only the
162 running clock is saved.
164 When Emacs restarts with saved clock information, the file containing the
165 running clock as well as all files mentioned in the clock history will
167 All this depends on running `org-clock-persistence-insinuate' in .emacs"
170 (const :tag
"Just the running clock" clock
)
171 (const :tag
"Just the history" history
)
172 (const :tag
"Clock and history" t
)
173 (const :tag
"No persistence" nil
)))
175 (defcustom org-clock-persist-file
(convert-standard-filename
176 "~/.emacs.d/org-clock-save.el")
177 "File to save clock data to."
181 (defcustom org-clock-persist-query-save nil
182 "When non-nil, ask before saving the current clock on exit."
186 (defcustom org-clock-persist-query-resume t
187 "When non-nil, ask before resuming any stored clock during load."
191 (defcustom org-clock-sound nil
192 "Sound to use for notifications.
196 t Standard Emacs beep
197 file name Play this sound file, fall back to beep"
200 (const :tag
"No sound" nil
)
201 (const :tag
"Standard beep" t
)
202 (file :tag
"Play sound file")))
204 (define-obsolete-variable-alias 'org-clock-modeline-total
205 'org-clock-mode-line-total
"24.3")
207 (defcustom org-clock-mode-line-total
'auto
208 "Default setting for the time included for the mode line clock.
209 This can be overruled locally using the CLOCK_MODELINE_TOTAL property.
212 current Only the time in the current instance of the clock
213 today All time clocked into this task today
214 repeat All time clocked into this task since last repeat
215 all All time ever recorded for this task
216 auto Automatically, either `all', or `repeat' for repeating tasks"
219 (const :tag
"Current clock" current
)
220 (const :tag
"Today's task time" today
)
221 (const :tag
"Since last repeat" repeat
)
222 (const :tag
"All task time" all
)
223 (const :tag
"Automatically, `all' or since `repeat'" auto
)))
225 (defvaralias 'org-task-overrun-text
'org-clock-task-overrun-text
)
226 (defcustom org-clock-task-overrun-text nil
227 "Extra mode line text to indicate that the clock is overrun.
228 The can be nil to indicate that instead of adding text, the clock time
229 should get a different face (`org-mode-line-clock-overrun').
230 When this is a string, it is prepended to the clock string as an indication,
231 also using the face `org-mode-line-clock-overrun'."
235 (const :tag
"Just mark the time string" nil
)
236 (string :tag
"Text to prepend")))
238 (defcustom org-show-notification-handler nil
239 "Function or program to send notification with.
240 The function or program will be called with the notification
244 (string :tag
"Program")
245 (function :tag
"Function")))
247 (defgroup org-clocktable nil
248 "Options concerning the clock table in Org-mode."
249 :tag
"Org Clock Table"
252 (defcustom org-clocktable-defaults
255 :lang org-export-default-language
273 "Default properties for clock tables."
278 (defcustom org-clock-clocktable-formatter
'org-clocktable-write-default
279 "Function to turn clocking data into a table.
280 For more information, see `org-clocktable-write-default'."
281 :group
'org-clocktable
285 ;; FIXME: translate es and nl last string "Clock summary at"
286 (defcustom org-clock-clocktable-language-setup
287 '(("en" "File" "L" "Timestamp" "Headline" "Time" "ALL" "Total time" "File time" "Clock summary at")
288 ("es" "Archivo" "N" "Fecha y hora" "Tarea" "Tiempo" "TODO" "Tiempo total" "Tiempo archivo" "Clock summary at")
289 ("fr" "Fichier" "N" "Horodatage" "En-tête" "Durée" "TOUT" "Durée totale" "Durée fichier" "Horodatage sommaire à ")
290 ("nl" "Bestand" "N" "Tijdstip" "Hoofding" "Duur" "ALLES" "Totale duur" "Bestandstijd" "Clock summary at"))
291 "Terms used in clocktable, translated to different languages."
292 :group
'org-clocktable
296 (defcustom org-clock-clocktable-default-properties
'(:maxlevel
2 :scope file
)
297 "Default properties for new clocktables.
298 These will be inserted into the BEGIN line, to make it easy for users to
300 :group
'org-clocktable
303 (defcustom org-clock-idle-time nil
304 "When non-nil, resolve open clocks if the user is idle more than X minutes."
307 (const :tag
"Never" nil
)
308 (integer :tag
"After N minutes")))
310 (defcustom org-clock-auto-clock-resolution
'when-no-clock-is-running
311 "When to automatically resolve open clocks found in Org buffers."
314 (const :tag
"Never" nil
)
315 (const :tag
"Always" t
)
316 (const :tag
"When no clock is running" when-no-clock-is-running
)))
318 (defcustom org-clock-report-include-clocking-task nil
319 "When non-nil, include the current clocking task time in clock reports."
324 (defcustom org-clock-resolve-expert nil
325 "Non-nil means do not show the splash buffer with the clock resolver."
330 (defcustom org-clock-continuously nil
331 "Non-nil means to start clocking from the last clock-out time, if any."
336 (defcustom org-clock-total-time-cell-format
"*%s*"
337 "Format string for the total time cells."
342 (defcustom org-clock-file-time-cell-format
"*%s*"
343 "Format string for the file time cells."
348 (defcustom org-clock-clocked-in-display
'mode-line
349 "When clocked in for a task, org-mode can display the current
350 task and accumulated time in the mode line and/or frame title.
353 both displays in both mode line and frame title
354 mode-line displays only in mode line (default)
355 frame-title displays only in frame title
356 nil current clock is not displayed"
359 (const :tag
"Mode line" mode-line
)
360 (const :tag
"Frame title" frame-title
)
361 (const :tag
"Both" both
)
362 (const :tag
"None" nil
)))
364 (defcustom org-clock-frame-title-format
'(t org-mode-line-string
)
365 "The value for `frame-title-format' when clocking in.
367 When `org-clock-clocked-in-display' is set to 'frame-title
368 or 'both, clocking in will replace `frame-title-format' with
369 this value. Clocking out will restore `frame-title-format'.
371 `org-frame-title-string' is a format string using the same
372 specifications than `frame-title-format', which see."
377 (defvar org-clock-in-prepare-hook nil
378 "Hook run when preparing the clock.
379 This hook is run before anything happens to the task that
380 you want to clock in. For example, you can use this hook
381 to add an effort property.")
382 (defvar org-clock-in-hook nil
383 "Hook run when starting the clock.")
384 (defvar org-clock-out-hook nil
385 "Hook run when stopping the current clock.")
387 (defvar org-clock-cancel-hook nil
388 "Hook run when cancelling the current clock.")
389 (defvar org-clock-goto-hook nil
390 "Hook run when selecting the currently clocked-in entry.")
391 (defvar org-clock-has-been-used nil
392 "Has the clock been used during the current Emacs session?")
394 ;;; The clock for measuring work time.
396 (defvar org-mode-line-string
"")
397 (put 'org-mode-line-string
'risky-local-variable t
)
399 (defvar org-clock-mode-line-timer nil
)
400 (defvar org-clock-idle-timer nil
)
401 (defvar org-clock-heading
) ; defined in org.el
402 (defvar org-clock-heading-for-remember
"")
403 (defvar org-clock-start-time
"")
405 (defvar org-clock-leftover-time nil
406 "If non-nil, user cancelled a clock; this is when leftover time started.")
408 (defvar org-clock-effort
""
409 "Effort estimate of the currently clocking task.")
411 (defvar org-clock-total-time nil
412 "Holds total time, spent previously on currently clocked item.
413 This does not include the time in the currently running clock.")
415 (defvar org-clock-history nil
416 "List of marker pointing to recent clocked tasks.")
418 (defvar org-clock-default-task
(make-marker)
419 "Marker pointing to the default task that should clock time.
420 The clock can be made to switch to this task after clocking out
421 of a different task.")
423 (defvar org-clock-interrupted-task
(make-marker)
424 "Marker pointing to the task that has been interrupted by the current clock.")
426 (defvar org-clock-mode-line-map
(make-sparse-keymap))
427 (define-key org-clock-mode-line-map
[mode-line mouse-2
] 'org-clock-goto
)
428 (define-key org-clock-mode-line-map
[mode-line mouse-1
] 'org-clock-menu
)
430 (defun org-clock-menu ()
434 ["Clock out" org-clock-out t
]
435 ["Change effort estimate" org-clock-modify-effort-estimate t
]
436 ["Go to clock entry" org-clock-goto t
]
437 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t
:keys
"C-u C-c C-x C-i"])))
439 (defun org-clock-history-push (&optional pos buffer
)
440 "Push a marker to the clock history."
441 (setq org-clock-history-length
(max 1 (min 35 org-clock-history-length
)))
442 (let ((m (move-marker (make-marker)
443 (or pos
(point)) (org-base-buffer
444 (or buffer
(current-buffer)))))
446 (while (setq n
(member m org-clock-history
))
447 (move-marker (car n
) nil
))
448 (setq org-clock-history
450 (mapcar (lambda (x) (if (marker-buffer x
) x nil
))
452 (when (>= (setq l
(length org-clock-history
)) org-clock-history-length
)
453 (setq org-clock-history
455 (nthcdr (- l org-clock-history-length -
1)
456 (nreverse org-clock-history
)))))
457 (push m org-clock-history
)))
459 (defun org-clock-save-markers-for-cut-and-paste (beg end
)
460 "Save relative positions of markers in region."
461 (org-check-and-save-marker org-clock-marker beg end
)
462 (org-check-and-save-marker org-clock-hd-marker beg end
)
463 (org-check-and-save-marker org-clock-default-task beg end
)
464 (org-check-and-save-marker org-clock-interrupted-task beg end
)
465 (mapc (lambda (m) (org-check-and-save-marker m beg end
))
468 (defun org-clocking-buffer ()
469 "Return the clocking buffer if we are currently clocking a task or nil."
470 (marker-buffer org-clock-marker
))
472 (defun org-clocking-p ()
473 "Return t when clocking a task."
474 (not (equal (org-clocking-buffer) nil
)))
476 (defvar org-clock-before-select-task-hook nil
477 "Hook called in task selection just before prompting the user.")
479 (defun org-clock-select-task (&optional prompt
)
480 "Select a task that recently was associated with clocking."
482 (let (sel-list rpl
(i 0) s
)
483 (save-window-excursion
484 (org-switch-to-buffer-other-window
485 (get-buffer-create "*Clock Task Select*"))
487 (when (marker-buffer org-clock-default-task
)
488 (insert (org-add-props "Default Task\n" nil
'face
'bold
))
489 (setq s
(org-clock-insert-selection-line ?d org-clock-default-task
))
491 (when (marker-buffer org-clock-interrupted-task
)
492 (insert (org-add-props "The task interrupted by starting the last one\n" nil
'face
'bold
))
493 (setq s
(org-clock-insert-selection-line ?i org-clock-interrupted-task
))
495 (when (org-clocking-p)
496 (insert (org-add-props "Current Clocking Task\n" nil
'face
'bold
))
497 (setq s
(org-clock-insert-selection-line ?c org-clock-marker
))
499 (insert (org-add-props "Recent Tasks\n" nil
'face
'bold
))
502 (when (marker-buffer m
)
504 s
(org-clock-insert-selection-line
508 (if (fboundp 'int-to-char
) (setf (car s
) (int-to-char (car s
))))
511 (run-hooks 'org-clock-before-select-task-hook
)
512 (org-fit-window-to-buffer)
513 (message (or prompt
"Select task for clocking:"))
514 (setq rpl
(read-char-exclusive))
518 ((assoc rpl sel-list
) (cdr (assoc rpl sel-list
)))
519 (t (error "Invalid task choice %c" rpl
))))))
521 (defun org-clock-insert-selection-line (i marker
)
522 "Insert a line for the clock selection menu.
523 And return a cons cell with the selection character integer and the marker
525 (when (marker-buffer marker
)
526 (let (file cat task heading prefix
)
527 (with-current-buffer (org-base-buffer (marker-buffer marker
))
533 (setq file
(buffer-file-name (marker-buffer marker
))
534 cat
(org-get-category)
535 heading
(org-get-heading 'notags
)
536 prefix
(save-excursion
537 (org-back-to-heading t
)
538 (looking-at org-outline-regexp
)
541 (org-fontify-like-in-org-mode
542 (concat prefix heading
)
544 (length prefix
)))))))
546 (insert (format "[%c] %-15s %s\n" i cat task
))
549 (defvar org-clock-task-overrun nil
550 "Internal flag indicating if the clock has overrun the planned time.")
551 (defvar org-clock-update-period
60
552 "Number of seconds between mode line clock string updates.")
554 (defun org-clock-get-clock-string ()
555 "Form a clock-string, that will be shown in the mode line.
556 If an effort estimate was defined for the current item, use
557 01:30/01:50 format (clocked/estimated).
558 If not, show simply the clocked time like 01:50."
559 (let ((clocked-time (org-clock-get-clocked-time)))
561 (let* ((effort-in-minutes
562 (org-duration-string-to-minutes org-clock-effort
))
565 (org-minutes-to-clocksum-string clocked-time
)
566 'face
(if (and org-clock-task-overrun
(not org-clock-task-overrun-text
))
567 'org-mode-line-clock-overrun
'org-mode-line-clock
)))
568 (effort-str (org-minutes-to-clocksum-string effort-in-minutes
))
569 (clockstr (org-propertize
570 (concat " [%s/" effort-str
571 "] (" (replace-regexp-in-string "%" "%%" org-clock-heading
) ")")
572 'face
'org-mode-line-clock
)))
573 (format clockstr work-done-str
))
574 (org-propertize (concat "[" (org-minutes-to-clocksum-string clocked-time
)
575 (format " (%s)" org-clock-heading
) "]")
576 'face
'org-mode-line-clock
))))
578 (defun org-clock-get-last-clock-out-time ()
579 "Get the last clock-out time for the current subtree."
581 (let ((end (save-excursion (org-end-of-subtree))))
582 (when (re-search-forward (concat org-clock-string
583 ".*\\]--\\(\\[[^]]+\\]\\)") end t
)
584 (org-time-string-to-time (match-string 1))))))
586 (defun org-clock-update-mode-line ()
588 (org-clock-notify-once-if-expired)
589 (setq org-clock-task-overrun nil
))
590 (setq org-mode-line-string
592 (let ((clock-string (org-clock-get-clock-string))
593 (help-text "Org-mode clock is running.\nmouse-1 shows a menu\nmouse-2 will jump to task"))
594 (if (and (> org-clock-string-limit
0)
595 (> (length clock-string
) org-clock-string-limit
))
597 (substring clock-string
0 org-clock-string-limit
)
598 'help-echo
(concat help-text
": " org-clock-heading
))
599 (org-propertize clock-string
'help-echo help-text
)))
600 'local-map org-clock-mode-line-map
601 'mouse-face
(if (featurep 'xemacs
) 'highlight
'mode-line-highlight
)))
602 (if (and org-clock-task-overrun org-clock-task-overrun-text
)
603 (setq org-mode-line-string
604 (concat (org-propertize
605 org-clock-task-overrun-text
606 'face
'org-mode-line-clock-overrun
) org-mode-line-string
)))
607 (force-mode-line-update))
609 (defun org-clock-get-clocked-time ()
610 "Get the clocked time for the current item in minutes.
611 The time returned includes the time spent on this task in
612 previous clocking intervals."
613 (let ((currently-clocked-time
614 (floor (- (org-float-time)
615 (org-float-time org-clock-start-time
)) 60)))
616 (+ currently-clocked-time
(or org-clock-total-time
0))))
618 (defun org-clock-modify-effort-estimate (&optional value
)
619 "Add to or set the effort estimate of the item currently being clocked.
620 VALUE can be a number of minutes, or a string with format hh:mm or mm.
621 When the string starts with a + or a - sign, the current value of the effort
622 property will be changed by that amount.
623 This will update the \"Effort\" property of currently clocked item, and
626 (if (org-clock-is-active)
627 (let ((current org-clock-effort
) sign
)
629 ;; Prompt user for a value or a change
632 (format "Set effort (hh:mm or mm%s): "
634 (format ", prefix + to add to %s" org-clock-effort
)
636 (when (stringp value
)
637 ;; A string. See if it is a delta
638 (setq sign
(string-to-char value
))
639 (if (member sign
'(?- ?
+))
640 (setq current
(org-duration-string-to-minutes current
)
641 value
(substring value
1))
643 (setq value
(org-duration-string-to-minutes value
))
645 (setq value
(- current value
))
646 (if (equal ?
+ sign
) (setq value
(+ current value
)))))
647 (setq value
(max 0 value
)
648 org-clock-effort
(org-minutes-to-clocksum-string value
))
649 (org-entry-put org-clock-marker
"Effort" org-clock-effort
)
650 (org-clock-update-mode-line)
651 (message "Effort is now %s" org-clock-effort
))
652 (message "Clock is not currently active")))
654 (defvar org-clock-notification-was-shown nil
655 "Shows if we have shown notification already.")
657 (defun org-clock-notify-once-if-expired ()
658 "Show notification if we spent more time than we estimated before.
659 Notification is shown only once."
660 (when (org-clocking-p)
661 (let ((effort-in-minutes (org-duration-string-to-minutes org-clock-effort
))
662 (clocked-time (org-clock-get-clocked-time)))
663 (if (setq org-clock-task-overrun
664 (if (or (null effort-in-minutes
) (zerop effort-in-minutes
))
666 (>= clocked-time effort-in-minutes
)))
667 (unless org-clock-notification-was-shown
668 (setq org-clock-notification-was-shown t
)
670 (format "Task '%s' should be finished by now. (%s)"
671 org-clock-heading org-clock-effort
) t
))
672 (setq org-clock-notification-was-shown nil
)))))
674 (defun org-notify (notification &optional play-sound
)
675 "Send a NOTIFICATION and maybe PLAY-SOUND.
676 If PLAY-SOUND is non-nil, it overrides `org-clock-sound'."
677 (org-show-notification notification
)
678 (if play-sound
(org-clock-play-sound play-sound
)))
680 (defun org-show-notification (notification)
682 Use `org-show-notification-handler' if defined,
683 use libnotify if available, or fall back on a message."
684 (cond ((functionp org-show-notification-handler
)
685 (funcall org-show-notification-handler notification
))
686 ((stringp org-show-notification-handler
)
687 (start-process "emacs-timer-notification" nil
688 org-show-notification-handler notification
))
689 ((fboundp 'notifications-notify
)
690 (notifications-notify
691 :title
"Org-mode message"
693 ;; FIXME how to link to the Org icon?
694 ;; :app-icon "~/.emacs.d/icons/mail.png"
696 ((executable-find "notify-send")
697 (start-process "emacs-timer-notification" nil
698 "notify-send" notification
))
699 ;; Maybe the handler will send a message, so only use message as
700 ;; a fall back option
701 (t (message "%s" notification
))))
703 (defun org-clock-play-sound (&optional clock-sound
)
704 "Play sound as configured by `org-clock-sound'.
705 Use alsa's aplay tool if available.
706 If CLOCK-SOUND is non-nil, it overrides `org-clock-sound'."
707 (let ((org-clock-sound (or clock-sound org-clock-sound
)))
709 ((not org-clock-sound
))
710 ((eq org-clock-sound t
) (beep t
) (beep t
))
711 ((stringp org-clock-sound
)
712 (let ((file (expand-file-name org-clock-sound
)))
713 (if (file-exists-p file
)
714 (if (executable-find "aplay")
715 (start-process "org-clock-play-notification" nil
718 (play-sound-file file
)
719 (error (beep t
) (beep t
))))))))))
721 (defvar org-clock-mode-line-entry nil
722 "Information for the mode line about the running clock.")
724 (defun org-find-open-clocks (file)
725 "Search through the given file and find all open clocks."
726 (let ((buf (or (get-file-buffer file
)
727 (find-file-noselect file
)))
729 (with-current-buffer buf
731 (goto-char (point-min))
732 (while (re-search-forward "CLOCK: \\(\\[.*?\\]\\)$" nil t
)
733 (push (cons (copy-marker (match-end 1) t
)
734 (org-time-string-to-time (match-string 1))) clocks
))))
737 (defsubst org-is-active-clock
(clock)
738 "Return t if CLOCK is the currently active clock."
739 (and (org-clock-is-active)
740 (= org-clock-marker
(car clock
))))
742 (defmacro org-with-clock-position
(clock &rest forms
)
743 "Evaluate FORMS with CLOCK as the current active clock."
744 `(with-current-buffer (marker-buffer (car ,clock
))
748 (goto-char (car ,clock
))
751 (def-edebug-spec org-with-clock-position
(form body
))
752 (put 'org-with-clock-position
'lisp-indent-function
1)
754 (defmacro org-with-clock
(clock &rest forms
)
755 "Evaluate FORMS with CLOCK as the current active clock.
756 This macro also protects the current active clock from being altered."
757 `(org-with-clock-position ,clock
758 (let ((org-clock-start-time (cdr ,clock
))
759 (org-clock-total-time)
762 (org-clock-marker (car ,clock
))
763 (org-clock-hd-marker (save-excursion
764 (outline-back-to-heading t
)
767 (def-edebug-spec org-with-clock
(form body
))
768 (put 'org-with-clock
'lisp-indent-function
1)
770 (defsubst org-clock-clock-in
(clock &optional resume start-time
)
771 "Clock in to the clock located by CLOCK.
772 If necessary, clock-out of the currently active clock."
773 (org-with-clock-position clock
774 (let ((org-clock-in-resume (or resume org-clock-in-resume
)))
775 (org-clock-in nil start-time
))))
777 (defsubst org-clock-clock-out
(clock &optional fail-quietly at-time
)
778 "Clock out of the clock located by CLOCK."
779 (let ((temp (copy-marker (car clock
)
780 (marker-insertion-type (car clock
)))))
781 (if (org-is-active-clock clock
)
782 (org-clock-out nil fail-quietly at-time
)
783 (org-with-clock clock
784 (org-clock-out nil fail-quietly at-time
)))
785 (setcar clock temp
)))
787 (defsubst org-clock-clock-cancel
(clock)
788 "Cancel the clock located by CLOCK."
789 (let ((temp (copy-marker (car clock
)
790 (marker-insertion-type (car clock
)))))
791 (if (org-is-active-clock clock
)
793 (org-with-clock clock
795 (setcar clock temp
)))
797 (defvar org-clock-clocking-in nil
)
798 (defvar org-clock-resolving-clocks nil
)
799 (defvar org-clock-resolving-clocks-due-to-idleness nil
)
801 (defun org-clock-resolve-clock (clock resolve-to clock-out-time
802 &optional close-p restart-p fail-quietly
)
803 "Resolve `CLOCK' given the time `RESOLVE-TO', and the present.
804 `CLOCK' is a cons cell of the form (MARKER START-TIME)."
805 (let ((org-clock-resolving-clocks t
))
808 (org-clock-clock-cancel clock
)
809 (if (and restart-p
(not org-clock-clocking-in
))
810 (org-clock-clock-in clock
)))
812 ((eq resolve-to
'now
)
814 (error "RESTART-P is not valid here"))
815 (if (or close-p org-clock-clocking-in
)
816 (org-clock-clock-out clock fail-quietly
)
817 (unless (org-is-active-clock clock
)
818 (org-clock-clock-in clock t
))))
820 ((not (time-less-p resolve-to
(current-time)))
821 (error "RESOLVE-TO must refer to a time in the past"))
825 (error "RESTART-P is not valid here"))
826 (org-clock-clock-out clock fail-quietly
(or clock-out-time
828 (unless org-clock-clocking-in
830 (setq org-clock-leftover-time
(and (null clock-out-time
)
832 (org-clock-clock-in clock nil
(and clock-out-time
835 (defun org-clock-jump-to-current-clock (&optional effective-clock
)
837 (let ((org-clock-into-drawer (org-clock-into-drawer))
838 (clock (or effective-clock
(cons org-clock-marker
839 org-clock-start-time
))))
840 (unless (marker-buffer (car clock
))
841 (error "No clock is currently running"))
842 (org-with-clock clock
(org-clock-goto))
843 (with-current-buffer (marker-buffer (car clock
))
844 (goto-char (car clock
))
845 (if org-clock-into-drawer
847 (if (stringp org-clock-into-drawer
)
848 (concat ":" org-clock-into-drawer
":")
853 (outline-back-to-heading t
)
854 (search-forward logbook
)
855 (goto-char (match-beginning 0)))
857 (outline-back-to-heading t
)
858 (search-forward logbook
)
859 (search-forward ":END:")
860 (goto-char (match-end 0)))
863 (defun org-clock-resolve (clock &optional prompt-fn last-valid fail-quietly
)
864 "Resolve an open org-mode clock.
865 An open clock was found, with `dangling' possibly being non-nil.
866 If this function was invoked with a prefix argument, non-dangling
867 open clocks are ignored. The given clock requires some sort of
868 user intervention to resolve it, either because a clock was left
869 dangling or due to an idle timeout. The clock resolution can
872 (a) deleted, the user doesn't care about the clock
873 (b) restarted from the current time (if no other clock is open)
874 (c) closed, giving the clock X minutes
875 (d) closed and then restarted
876 (e) resumed, as if the user had never left
878 The format of clock is (CONS MARKER START-TIME), where MARKER
879 identifies the buffer and position the clock is open at (and
880 thus, the heading it's under), and START-TIME is when the clock
884 (save-window-excursion
886 (unless org-clock-resolving-clocks-due-to-idleness
887 (org-clock-jump-to-current-clock clock
))
888 (unless org-clock-resolve-expert
889 (with-output-to-temp-buffer "*Org Clock*"
890 (princ "Select a Clock Resolution Command:
892 i/q/C-g Ignore this question; the same as keeping all the idle time.
894 k/K Keep X minutes of the idle time (default is all). If this
895 amount is less than the default, you will be clocked out
896 that many minutes after the time that idling began, and then
897 clocked back in at the present time.
898 g/G Indicate that you \"got back\" X minutes ago. This is quite
899 different from 'k': it clocks you out from the beginning of
900 the idle period and clock you back in X minutes ago.
901 s/S Subtract the idle time from the current clock. This is the
902 same as keeping 0 minutes.
903 C Cancel the open timer altogether. It will be as though you
905 j/J Jump to the current clock, to make manual adjustments.
907 For all these options, using uppercase makes your final state
908 to be CLOCKED OUT.")))
909 (org-fit-window-to-buffer (get-buffer-window "*Org Clock*"))
911 (when (featurep 'xemacs
)
912 (message (concat (funcall prompt-fn clock
)
914 (setq char-pressed
(read-char-exclusive)))
915 (while (or (null char-pressed
)
916 (and (not (memq char-pressed
917 '(?k ?K ?g ?G ?s ?S ?C
921 (read-char (concat (funcall prompt-fn clock
)
924 (and (not (memq char-pressed
'(?i ?q
))) char-pressed
)))))
926 (floor (/ (org-float-time
927 (time-subtract (current-time) last-valid
)) 60)))
929 (and (memq ch
'(?k ?K
))
930 (read-number "Keep how many minutes? " default
)))
932 (and (memq ch
'(?g ?G
))
933 (read-number "Got back how many minutes ago? " default
)))
934 (subtractp (memq ch
'(?s ?S
)))
935 (barely-started-p (< (- (org-float-time last-valid
)
936 (org-float-time (cdr clock
))) 45))
937 (start-over (and subtractp barely-started-p
)))
941 (org-clock-resolve-clock clock
'now nil t nil fail-quietly
))
942 (org-clock-jump-to-current-clock clock
))
944 (not (memq ch
'(?k ?K ?g ?G ?s ?S ?C
))))
947 (org-clock-resolve-clock
950 ;; If the time on the clock was less than a minute before
951 ;; the user went away, and they've ask to subtract all the
956 (and gotback
(= gotback
0)))
958 ((or (and keep
(= keep default
))
959 (and gotback
(= gotback default
)))
962 (time-add last-valid
(seconds-to-time (* 60 keep
))))
964 (time-subtract (current-time)
965 (seconds-to-time (* 60 gotback
))))
967 (error "Unexpected, please report this as a bug")))
968 (and gotback last-valid
)
969 (memq ch
'(?K ?G ?S
))
971 (not (memq ch
'(?K ?G ?S ?C
))))
975 (defun org-resolve-clocks (&optional only-dangling-p prompt-fn last-valid
)
976 "Resolve all currently open org-mode clocks.
977 If `only-dangling-p' is non-nil, only ask to resolve dangling
978 \(i.e., not currently open and valid) clocks."
980 (unless org-clock-resolving-clocks
981 (let ((org-clock-resolving-clocks t
))
982 (dolist (file (org-files-list))
983 (let ((clocks (org-find-open-clocks file
)))
984 (dolist (clock clocks
)
985 (let ((dangling (or (not (org-clock-is-active))
986 (/= (car clock
) org-clock-marker
))))
987 (if (or (not only-dangling-p
) dangling
)
994 "Dangling clock started %d mins ago"
996 (/ (- (org-float-time (current-time))
997 (org-float-time (cdr clock
))) 60))))))
999 (cdr clock
)))))))))))
1001 (defun org-emacs-idle-seconds ()
1002 "Return the current Emacs idle time in seconds, or nil if not idle."
1003 (let ((idle-time (current-idle-time)))
1005 (org-float-time idle-time
)
1008 (defun org-mac-idle-seconds ()
1009 "Return the current Mac idle time in seconds."
1010 (string-to-number (shell-command-to-string "ioreg -c IOHIDSystem | perl -ane 'if (/Idle/) {$idle=(pop @F)/1000000000; print $idle; last}'")))
1012 (defvar org-x11idle-exists-p
1013 ;; Check that x11idle exists
1014 (and (eq window-system
'x
)
1015 (eq (call-process-shell-command "command" nil nil nil
"-v" "x11idle") 0)
1016 ;; Check that x11idle can retrieve the idle time
1017 (eq (call-process-shell-command "x11idle" nil nil nil
) 0)))
1019 (defun org-x11-idle-seconds ()
1020 "Return the current X11 idle time in seconds."
1021 (/ (string-to-number (shell-command-to-string "x11idle")) 1000))
1023 (defun org-user-idle-seconds ()
1024 "Return the number of seconds the user has been idle for.
1025 This routine returns a floating point number."
1027 ((eq system-type
'darwin
)
1028 (org-mac-idle-seconds))
1029 ((and (eq window-system
'x
) org-x11idle-exists-p
)
1030 (org-x11-idle-seconds))
1032 (org-emacs-idle-seconds))))
1034 (defvar org-clock-user-idle-seconds
)
1036 (defun org-resolve-clocks-if-idle ()
1037 "Resolve all currently open org-mode clocks.
1038 This is performed after `org-clock-idle-time' minutes, to check
1039 if the user really wants to stay clocked in after being idle for
1041 (when (and org-clock-idle-time
(not org-clock-resolving-clocks
)
1043 (let* ((org-clock-user-idle-seconds (org-user-idle-seconds))
1044 (org-clock-user-idle-start
1045 (time-subtract (current-time)
1046 (seconds-to-time org-clock-user-idle-seconds
)))
1047 (org-clock-resolving-clocks-due-to-idleness t
))
1048 (if (> org-clock-user-idle-seconds
(* 60 org-clock-idle-time
))
1050 (cons org-clock-marker
1051 org-clock-start-time
)
1054 (format "Clocked in & idle for %.1f mins"
1056 (time-subtract (current-time)
1057 org-clock-user-idle-start
))
1059 org-clock-user-idle-start
)))))
1061 (defvar org-clock-current-task nil
1062 "Task currently clocked in.")
1063 (defun org-clock-set-current ()
1064 "Set `org-clock-current-task' to the task currently clocked in."
1065 (setq org-clock-current-task
(nth 4 (org-heading-components))))
1067 (defun org-clock-delete-current ()
1068 "Reset `org-clock-current-task' to nil."
1069 (setq org-clock-current-task nil
))
1071 (defvar org-clock-out-time nil
) ; store the time of the last clock-out
1074 (defun org-clock-in (&optional select start-time
)
1075 "Start the clock on the current item.
1076 If necessary, clock-out of the currently active clock.
1077 With a prefix argument SELECT (\\[universal-argument]), offer a list of recently clocked
1078 tasks to clock into. When SELECT is \\[universal-argument] \\[universal-argument], clock into the current task
1079 and mark it as the default task, a special task that will always be offered
1080 in the clocking selection, associated with the letter `d'.
1081 When SELECT is \\[universal-argument] \\[universal-argument] \\[universal-argument], \
1082 clock in by using the last clock-out
1083 time as the start time \(see `org-clock-continuously' to
1084 make this the default behavior.)"
1086 (setq org-clock-notification-was-shown nil
)
1088 (let ((interrupting (and (not org-clock-resolving-clocks-due-to-idleness
)
1090 ts selected-task target-pos
(msg-extra "")
1091 (leftover (and (not org-clock-resolving-clocks
)
1092 org-clock-leftover-time
)))
1094 (when (and org-clock-auto-clock-resolution
1095 (or (not interrupting
)
1096 (eq t org-clock-auto-clock-resolution
))
1097 (not org-clock-clocking-in
)
1098 (not org-clock-resolving-clocks
))
1099 (setq org-clock-leftover-time nil
)
1100 (let ((org-clock-clocking-in t
))
1101 (org-resolve-clocks))) ; check if any clocks are dangling
1103 (when (equal select
'(64))
1104 ;; Set start-time to `org-clock-out-time'
1105 (let ((org-clock-continuously t
))
1106 (org-clock-in nil org-clock-out-time
)))
1108 (when (equal select
'(4))
1109 (setq selected-task
(org-clock-select-task "Clock-in on task: "))
1111 (setq selected-task
(copy-marker selected-task
))
1114 (when (equal select
'(16))
1115 ;; Mark as default clocking task
1116 (org-clock-mark-default-task))
1119 ;; We are interrupting the clocking of a different task.
1120 ;; Save a marker to this task, so that we can go back.
1121 ;; First check if we are trying to clock into the same task!
1122 (when (save-excursion
1123 (unless selected-task
1124 (org-back-to-heading t
))
1125 (and (equal (marker-buffer org-clock-hd-marker
)
1127 (marker-buffer selected-task
)
1129 (= (marker-position org-clock-hd-marker
)
1131 (marker-position selected-task
)
1133 (equal org-clock-current-task
(nth 4 (org-heading-components)))))
1134 (message "Clock continues in \"%s\"" org-clock-heading
)
1136 (move-marker org-clock-interrupted-task
1137 (marker-position org-clock-marker
)
1138 (marker-buffer org-clock-marker
))
1139 (let ((org-clock-clocking-in t
))
1140 (org-clock-out nil t
)))
1142 ;; Clock in at which position?
1144 (if (and (eobp) (not (org-at-heading-p)))
1148 (when (and selected-task
(marker-buffer selected-task
))
1149 ;; There is a selected task, move to the correct buffer
1150 ;; and set the new target position.
1151 (set-buffer (org-base-buffer (marker-buffer selected-task
)))
1152 (setq target-pos
(marker-position selected-task
))
1153 (move-marker selected-task nil
))
1157 (goto-char target-pos
)
1158 (org-back-to-heading t
)
1159 (or interrupting
(move-marker org-clock-interrupted-task nil
))
1161 (forward-char) ;; make sure the marker is not at the
1162 ;; beginning of the heading, since the
1163 ;; user is liking to insert stuff here
1165 (run-hooks 'org-clock-in-prepare-hook
)
1166 (org-clock-history-push))
1167 (org-clock-set-current)
1168 (cond ((functionp org-clock-in-switch-to-state
)
1169 (looking-at org-complex-heading-regexp
)
1170 (let ((newstate (funcall org-clock-in-switch-to-state
1172 (if newstate
(org-todo newstate
))))
1173 ((and org-clock-in-switch-to-state
1174 (not (looking-at (concat org-outline-regexp
"[ \t]*"
1175 org-clock-in-switch-to-state
1177 (org-todo org-clock-in-switch-to-state
)))
1178 (setq org-clock-heading-for-remember
1179 (and (looking-at org-complex-heading-regexp
)
1181 (org-trim (buffer-substring (match-end 1)
1183 (setq org-clock-heading
1184 (cond ((and org-clock-heading-function
1185 (functionp org-clock-heading-function
))
1186 (funcall org-clock-heading-function
))
1187 ((and (looking-at org-complex-heading-regexp
)
1189 (replace-regexp-in-string
1190 "\\[\\[.*?\\]\\[\\(.*?\\)\\]\\]" "\\1"
1193 (setq org-clock-heading
(org-propertize org-clock-heading
1195 (org-clock-find-position org-clock-in-resume
)
1197 ((and org-clock-in-resume
1199 (concat "^[ \t]*" org-clock-string
1200 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1201 " *\\sw+\.? +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
1202 (message "Matched %s" (match-string 1))
1203 (setq ts
(concat "[" (match-string 1) "]"))
1204 (goto-char (match-end 1))
1205 (setq org-clock-start-time
1207 (org-parse-time-string (match-string 1))))
1208 (setq org-clock-effort
(org-get-effort))
1209 (setq org-clock-total-time
(org-clock-sum-current-item
1210 (org-clock-get-sum-start))))
1211 ((eq org-clock-in-resume
'auto-restart
)
1212 ;; called from org-clock-load during startup,
1213 ;; do not interrupt, but warn!
1214 (message "Cannot restart clock because task does not contain unfinished clock")
1219 (insert-before-markers "\n")
1222 (when (and (save-excursion
1225 (beginning-of-line 1)
1226 (org-indent-line-to (- (org-get-indentation) 2)))
1227 (insert org-clock-string
" ")
1228 (setq org-clock-effort
(org-get-effort))
1229 (setq org-clock-total-time
(org-clock-sum-current-item
1230 (org-clock-get-sum-start)))
1231 (setq org-clock-start-time
1232 (or (and org-clock-continuously org-clock-out-time
)
1236 "You stopped another clock %d mins ago; start this one from then? "
1237 (/ (- (org-float-time (current-time))
1238 (org-float-time leftover
)) 60)))
1242 (setq ts
(org-insert-time-stamp org-clock-start-time
1243 'with-hm
'inactive
))))
1244 (move-marker org-clock-marker
(point) (buffer-base-buffer))
1245 (move-marker org-clock-hd-marker
1246 (save-excursion (org-back-to-heading t
) (point))
1247 (buffer-base-buffer))
1248 (setq org-clock-has-been-used t
)
1250 (when (or (eq org-clock-clocked-in-display
'mode-line
)
1251 (eq org-clock-clocked-in-display
'both
))
1252 (or global-mode-string
(setq global-mode-string
'("")))
1253 (or (memq 'org-mode-line-string global-mode-string
)
1254 (setq global-mode-string
1255 (append global-mode-string
'(org-mode-line-string)))))
1256 ;; add to frame title
1257 (when (or (eq org-clock-clocked-in-display
'frame-title
)
1258 (eq org-clock-clocked-in-display
'both
))
1259 (setq frame-title-format org-clock-frame-title-format
))
1260 (org-clock-update-mode-line)
1261 (when org-clock-mode-line-timer
1262 (cancel-timer org-clock-mode-line-timer
)
1263 (setq org-clock-mode-line-timer nil
))
1264 (when org-clock-clocked-in-display
1265 (setq org-clock-mode-line-timer
1266 (run-with-timer org-clock-update-period
1267 org-clock-update-period
1268 'org-clock-update-mode-line
)))
1269 (when org-clock-idle-timer
1270 (cancel-timer org-clock-idle-timer
)
1271 (setq org-clock-idle-timer nil
))
1272 (setq org-clock-idle-timer
1273 (run-with-timer 60 60 'org-resolve-clocks-if-idle
))
1274 (message "Clock starts at %s - %s" ts msg-extra
)
1275 (run-hooks 'org-clock-in-hook
)))))))
1278 (defun org-clock-in-last (&optional arg
)
1279 "Clock in the last closed clocked item.
1280 When already clocking in, send an warning.
1281 With a universal prefix argument, select the task you want to
1282 clock in from the last clocked in tasks.
1283 With two universal prefix arguments, start clocking using the
1284 last clock-out time, if any.
1285 With three universal prefix arguments, interactively prompt
1286 for a todo state to switch to, overriding the existing value
1287 `org-clock-in-switch-to-state'."
1289 (if (equal arg
'(4))
1290 (org-clock-in (org-clock-select-task))
1291 (let ((start-time (if (or org-clock-continuously
(equal arg
'(16)))
1292 (or org-clock-out-time
(current-time))
1294 (if (null org-clock-history
)
1295 (message "No last clock")
1296 (let ((org-clock-in-switch-to-state
1297 (if (and (not org-clock-current-task
) (equal arg
'(64)))
1298 (completing-read "Switch to state: "
1299 (and org-clock-history
1300 (with-current-buffer
1301 (marker-buffer (car org-clock-history
))
1302 org-todo-keywords-1
)))
1303 org-clock-in-switch-to-state
))
1304 (already-clocking org-clock-current-task
))
1305 (org-clock-clock-in (list (car org-clock-history
)) nil start-time
)
1306 (or already-clocking
1307 ;; Don't display a message if we are already clocking in
1308 (message "Clocking back: %s (in %s)"
1309 org-clock-current-task
1310 (buffer-name (marker-buffer org-clock-marker
)))))))))
1312 (defun org-clock-mark-default-task ()
1313 "Mark current task as default task."
1316 (org-back-to-heading t
)
1317 (move-marker org-clock-default-task
(point))))
1320 (defun org-clock-get-sum-start ()
1321 "Return the time from which clock times should be counted.
1322 This is for the currently running clock as it is displayed
1323 in the mode line. This function looks at the properties
1324 LAST_REPEAT and in particular CLOCK_MODELINE_TOTAL and the
1325 corresponding variable `org-clock-mode-line-total' and then
1326 decides which time to use."
1327 (let ((cmt (or (org-entry-get nil
"CLOCK_MODELINE_TOTAL")
1328 (symbol-name org-clock-mode-line-total
)))
1329 (lr (org-entry-get nil
"LAST_REPEAT")))
1331 ((equal cmt
"current")
1332 (setq msg-extra
"showing time in current clock instance")
1334 ((equal cmt
"today")
1335 (setq msg-extra
"showing today's task time.")
1336 (let* ((dt (decode-time (current-time))))
1337 (setq dt
(append (list 0 0 0) (nthcdr 3 dt
)))
1338 (if org-extend-today-until
1339 (setf (nth 2 dt
) org-extend-today-until
))
1340 (apply 'encode-time dt
)))
1341 ((or (equal cmt
"all")
1342 (and (or (not cmt
) (equal cmt
"auto"))
1344 (setq msg-extra
"showing entire task time.")
1346 ((or (equal cmt
"repeat")
1347 (and (or (not cmt
) (equal cmt
"auto"))
1349 (setq msg-extra
"showing task time since last repeat.")
1352 (org-time-string-to-time lr
)))
1355 (defun org-clock-find-position (find-unclosed)
1356 "Find the location where the next clock line should be inserted.
1357 When FIND-UNCLOSED is non-nil, first check if there is an unclosed clock
1358 line and position cursor in that line."
1359 (org-back-to-heading t
)
1361 (let* ((org-clock-into-drawer (org-clock-into-drawer))
1362 (beg (save-excursion
1363 (beginning-of-line 2)
1364 (or (bolp) (newline))
1366 (end (progn (outline-next-heading) (point)))
1367 (re (concat "^[ \t]*" org-clock-string
))
1369 (drawer (if (stringp org-clock-into-drawer
)
1370 org-clock-into-drawer
"LOGBOOK"))
1371 first last ind-last
)
1373 (when (and find-unclosed
1375 (concat "^[ \t]*" org-clock-string
1376 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1377 " *\\sw+ +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")
1379 (beginning-of-line 1)
1381 (when (eobp) (newline) (setq end
(max (point) end
)))
1382 (when (re-search-forward (concat "^[ \t]*:" drawer
":") end t
)
1383 ;; we seem to have a CLOCK drawer, so go there.
1384 (beginning-of-line 2)
1385 (or org-log-states-order-reversed
1386 (and (re-search-forward org-property-end-re nil t
)
1387 (goto-char (match-beginning 0))))
1389 ;; Lets count the CLOCK lines
1391 (while (re-search-forward re end t
)
1392 (setq first
(or first
(match-beginning 0))
1393 last
(match-beginning 0)
1395 (when (and (integerp org-clock-into-drawer
)
1397 (>= (1+ cnt
) org-clock-into-drawer
))
1398 ;; Wrap current entries into a new drawer
1400 (setq ind-last
(org-get-indentation))
1401 (beginning-of-line 2)
1402 (if (and (>= (org-get-indentation) ind-last
)
1404 (when (and (>= (org-get-indentation) ind-last
)
1406 (let ((struct (org-list-struct)))
1407 (goto-char (org-list-get-bottom-point struct
)))))
1409 (beginning-of-line 0)
1410 (org-indent-line-to ind-last
)
1412 (insert ":" drawer
":\n")
1413 (beginning-of-line 0)
1416 (beginning-of-line 2)
1417 (or org-log-states-order-reversed
1418 (and (re-search-forward org-property-end-re nil t
)
1419 (goto-char (match-beginning 0))))
1423 (while (and (looking-at (concat "[ \t]*" org-keyword-time-regexp
))
1424 (not (equal (match-string 1) org-clock-string
)))
1425 ;; Planning info, skip to after it
1426 (beginning-of-line 2)
1427 (or (bolp) (newline)))
1428 (when (or (eq org-clock-into-drawer t
)
1429 (stringp org-clock-into-drawer
)
1430 (and (integerp org-clock-into-drawer
)
1431 (< org-clock-into-drawer
2)))
1432 (insert ":" drawer
":\n:END:\n")
1433 (beginning-of-line -
1)
1436 (beginning-of-line 2)
1439 (or org-log-states-order-reversed
1440 (and (re-search-forward org-property-end-re nil t
)
1441 (goto-char (match-beginning 0))))))))
1444 (defun org-clock-out (&optional switch-to-state fail-quietly at-time
)
1445 "Stop the currently running clock.
1446 Throw an error if there is no running clock and FAIL-QUIETLY is nil.
1447 With a universal prefix, prompt for a state to switch the clocked out task
1448 to, overriding the existing value of `org-clock-out-switch-to-state'."
1451 (when (not (org-clocking-p))
1452 (setq global-mode-string
1453 (delq 'org-mode-line-string global-mode-string
))
1454 (setq frame-title-format org-frame-title-format-backup
)
1455 (force-mode-line-update)
1456 (if fail-quietly
(throw 'exit t
) (user-error "No active clock")))
1457 (let ((org-clock-out-switch-to-state
1459 (completing-read "Switch to state: "
1460 (with-current-buffer
1461 (marker-buffer org-clock-marker
)
1462 org-todo-keywords-1
)
1464 org-clock-out-switch-to-state
))
1465 (now (current-time))
1467 (setq org-clock-out-time now
)
1468 (save-excursion ; Do not replace this with `with-current-buffer'.
1469 (org-no-warnings (set-buffer (org-clocking-buffer)))
1472 (goto-char org-clock-marker
)
1473 (beginning-of-line 1)
1474 (if (and (looking-at (concat "[ \t]*" org-keyword-time-regexp
))
1475 (equal (match-string 1) org-clock-string
))
1476 (setq ts
(match-string 2))
1477 (if fail-quietly
(throw 'exit nil
) (error "Clock start time is gone")))
1478 (goto-char (match-end 0))
1479 (delete-region (point) (point-at-eol))
1481 (setq te
(org-insert-time-stamp (or at-time now
) 'with-hm
'inactive
))
1482 (setq s
(- (org-float-time (apply 'encode-time
(org-parse-time-string te
)))
1483 (org-float-time (apply 'encode-time
(org-parse-time-string ts
))))
1484 h
(floor (/ s
3600))
1488 (insert " => " (format "%2d:%02d" h m
))
1489 (when (setq remove
(and org-clock-out-remove-zero-time-clocks
1491 (beginning-of-line 1)
1492 (delete-region (point) (point-at-eol))
1493 (and (looking-at "\n") (> (point-max) (1+ (point)))
1495 (move-marker org-clock-marker nil
)
1496 (move-marker org-clock-hd-marker nil
)
1497 (when org-log-note-clock-out
1498 (org-add-log-setup 'clock-out nil nil nil nil
1499 (concat "# Task: " (org-get-heading t
) "\n\n")))
1500 (when org-clock-mode-line-timer
1501 (cancel-timer org-clock-mode-line-timer
)
1502 (setq org-clock-mode-line-timer nil
))
1503 (when org-clock-idle-timer
1504 (cancel-timer org-clock-idle-timer
)
1505 (setq org-clock-idle-timer nil
))
1506 (setq global-mode-string
1507 (delq 'org-mode-line-string global-mode-string
))
1508 (setq frame-title-format org-frame-title-format-backup
)
1509 (when org-clock-out-switch-to-state
1511 (org-back-to-heading t
)
1512 (let ((org-inhibit-logging t
)
1513 (org-clock-out-when-done nil
))
1515 ((functionp org-clock-out-switch-to-state
)
1516 (looking-at org-complex-heading-regexp
)
1517 (let ((newstate (funcall org-clock-out-switch-to-state
1519 (if newstate
(org-todo newstate
))))
1520 ((and org-clock-out-switch-to-state
1521 (not (looking-at (concat org-outline-regexp
"[ \t]*"
1522 org-clock-out-switch-to-state
1524 (org-todo org-clock-out-switch-to-state
))))))
1525 (force-mode-line-update)
1526 (message (concat "Clock stopped at %s after "
1527 (org-minutes-to-clocksum-string (+ (* 60 h
) m
)) "%s")
1528 te
(if remove
" => LINE REMOVED" ""))
1529 (run-hooks 'org-clock-out-hook
)
1530 (unless (org-clocking-p)
1531 (org-clock-delete-current)))))))
1533 (add-hook 'org-clock-out-hook
'org-clock-remove-empty-clock-drawer
)
1535 (defun org-clock-remove-empty-clock-drawer nil
1536 "Remove empty clock drawer in the current subtree."
1537 (let* ((olid (or (org-entry-get (point) "LOG_INTO_DRAWER")
1538 org-log-into-drawer
))
1539 (clock-drawer (if (eq t olid
) "LOGBOOK" olid
))
1540 (end (save-excursion (org-end-of-subtree t t
))))
1543 (org-back-to-heading t
)
1544 (while (and (< (point) end
)
1545 (search-forward clock-drawer end t
))
1546 (goto-char (match-beginning 0))
1547 (org-remove-empty-drawer-at clock-drawer
(point))
1548 (forward-line 1))))))
1550 (defun org-at-clock-log-p nil
1551 "Is the cursor on the clock log line?"
1553 (move-beginning-of-line 1)
1554 (looking-at "^[ \t]*CLOCK:")))
1556 (defun org-clock-timestamps-up (&optional n
)
1557 "Increase CLOCK timestamps at cursor.
1558 Optional argument N tells to change by that many units."
1560 (org-clock-timestamps-change 'up n
))
1562 (defun org-clock-timestamps-down (&optional n
)
1563 "Increase CLOCK timestamps at cursor.
1564 Optional argument N tells to change by that many units."
1566 (org-clock-timestamps-change 'down n
))
1568 (defun org-clock-timestamps-change (updown &optional n
)
1569 "Change CLOCK timestamps synchronously at cursor.
1570 UPDOWN tells whether to change 'up or 'down.
1571 Optional argument N tells to change by that many units."
1572 (setq org-ts-what nil
)
1573 (when (org-at-timestamp-p t
)
1574 (let ((tschange (if (eq updown
'up
) 'org-timestamp-up
1575 'org-timestamp-down
))
1576 ts1 begts1 ts2 begts2 updatets1 tdiff
)
1578 (move-beginning-of-line 1)
1579 (re-search-forward org-ts-regexp3 nil t
)
1580 (setq ts1
(match-string 0) begts1
(match-beginning 0))
1581 (when (re-search-forward org-ts-regexp3 nil t
)
1582 (setq ts2
(match-string 0) begts2
(match-beginning 0))))
1583 ;; Are we on the second timestamp?
1584 (if (<= begts2
(point)) (setq updatets1 t
))
1586 ;; fall back on org-timestamp-up if there is only one
1587 (funcall tschange n
)
1588 ;; setq this so that (boundp 'org-ts-what is non-nil)
1589 (funcall tschange n
)
1590 (let ((ts (if updatets1 ts2 ts1
))
1591 (begts (if updatets1 begts1 begts2
)))
1594 (org-time-string-to-time org-last-changed-timestamp
)
1595 (org-time-string-to-time ts
)))
1598 (org-timestamp-change
1599 (round (/ (org-float-time tdiff
)
1600 (cond ((eq org-ts-what
'minute
) 60)
1601 ((eq org-ts-what
'hour
) 3600)
1602 ((eq org-ts-what
'day
) (* 24 3600))
1603 ((eq org-ts-what
'month
) (* 24 3600 31))
1604 ((eq org-ts-what
'year
) (* 24 3600 365.2)))))
1605 org-ts-what
'updown
)))))))
1608 (defun org-clock-cancel ()
1609 "Cancel the running clock by removing the start timestamp."
1611 (when (not (org-clocking-p))
1612 (setq global-mode-string
1613 (delq 'org-mode-line-string global-mode-string
))
1614 (setq frame-title-format org-frame-title-format-backup
)
1615 (force-mode-line-update)
1616 (error "No active clock"))
1617 (save-excursion ; Do not replace this with `with-current-buffer'.
1618 (org-no-warnings (set-buffer (org-clocking-buffer)))
1619 (goto-char org-clock-marker
)
1620 (if (org-looking-back (concat "^[ \t]*" org-clock-string
".*"))
1621 (progn (delete-region (1- (point-at-bol)) (point-at-eol))
1622 (org-remove-empty-drawer-at "LOGBOOK" (point)))
1623 (message "Clock gone, cancel the timer anyway")
1625 (move-marker org-clock-marker nil
)
1626 (move-marker org-clock-hd-marker nil
)
1627 (setq global-mode-string
1628 (delq 'org-mode-line-string global-mode-string
))
1629 (setq frame-title-format org-frame-title-format-backup
)
1630 (force-mode-line-update)
1631 (message "Clock canceled")
1632 (run-hooks 'org-clock-cancel-hook
))
1635 (defun org-clock-goto (&optional select
)
1636 "Go to the currently clocked-in entry, or to the most recently clocked one.
1637 With prefix arg SELECT, offer recently clocked tasks for selection."
1642 (or (org-clock-select-task "Select task to go to: ")
1643 (error "No task selected")))
1644 ((org-clocking-p) org-clock-marker
)
1645 ((and org-clock-goto-may-find-recent-task
1646 (car org-clock-history
)
1647 (marker-buffer (car org-clock-history
)))
1649 (car org-clock-history
))
1650 (t (error "No active or recent clock task")))))
1651 (org-pop-to-buffer-same-window (marker-buffer m
))
1652 (if (or (< m
(point-min)) (> m
(point-max))) (widen))
1655 (org-back-to-heading t
)
1656 (org-cycle-hide-drawers 'children
)
1660 (message "No running clock, this is the most recently clocked task"))
1661 (run-hooks 'org-clock-goto-hook
)))
1663 (defvar org-clock-file-total-minutes nil
1664 "Holds the file total time in minutes, after a call to `org-clock-sum'.")
1665 (make-variable-buffer-local 'org-clock-file-total-minutes
)
1667 (defun org-clock-sum-today (&optional headline-filter
)
1668 "Sum the times for each subtree for today."
1670 (let ((range (org-clock-special-range 'today
)))
1671 (org-clock-sum (car range
) (cadr range
) nil
:org-clock-minutes-today
)))
1674 (defun org-clock-sum (&optional tstart tend headline-filter propname
)
1675 "Sum the times for each subtree.
1676 Puts the resulting times in minutes as a text property on each headline.
1677 TSTART and TEND can mark a time range to be considered.
1678 HEADLINE-FILTER is a zero-arg function that, if specified, is called for
1679 each headline in the time range with point at the headline. Headlines for
1680 which HEADLINE-FILTER returns nil are excluded from the clock summation.
1681 PROPNAME lets you set a custom text property instead of :org-clock-minutes."
1683 (let* ((bmp (buffer-modified-p))
1684 (re (concat "^\\(\\*+\\)[ \t]\\|^[ \t]*"
1686 "[ \t]*\\(?:\\(\\[.*?\\]\\)-+\\(\\[.*?\\]\\)\\|=>[ \t]+\\([0-9]+\\):\\([0-9]+\\)\\)"))
1688 (ltimes (make-vector lmax
0))
1693 (if (stringp tstart
) (setq tstart
(org-time-string-to-seconds tstart
)))
1694 (if (stringp tend
) (setq tend
(org-time-string-to-seconds tend
)))
1695 (if (consp tstart
) (setq tstart
(org-float-time tstart
)))
1696 (if (consp tend
) (setq tend
(org-float-time tend
)))
1697 (remove-text-properties (point-min) (point-max)
1698 `(,(or propname
:org-clock-minutes
) t
1699 :org-clock-force-headline-inclusion t
))
1701 (goto-char (point-max))
1702 (while (re-search-backward re nil t
)
1706 (setq ts
(match-string 2)
1709 (apply 'encode-time
(org-parse-time-string ts
)))
1711 (apply 'encode-time
(org-parse-time-string te
)))
1712 ts
(if tstart
(max ts tstart
) ts
)
1713 te
(if tend
(min te tend
) te
)
1715 t1
(if (> dt
0) (+ t1
(floor (/ dt
60))) t1
)))
1718 (setq t1
(+ t1
(string-to-number (match-string 5))
1719 (* 60 (string-to-number (match-string 4))))))
1721 ;; Add the currently clocking item time to the total
1722 (when (and org-clock-report-include-clocking-task
1723 (equal (org-clocking-buffer) (current-buffer))
1724 (equal (marker-position org-clock-hd-marker
) (point))
1727 (>= (org-float-time org-clock-start-time
) tstart
)
1728 (<= (org-float-time org-clock-start-time
) tend
))
1729 (let ((time (floor (- (org-float-time)
1730 (org-float-time org-clock-start-time
)) 60)))
1731 (setq t1
(+ t1 time
))))
1732 (let* ((headline-forced
1733 (get-text-property (point)
1734 :org-clock-force-headline-inclusion
))
1736 (or (null headline-filter
)
1738 (save-match-data (funcall headline-filter
))))))
1739 (setq level
(- (match-end 1) (match-beginning 1)))
1740 (when (or (> t1
0) (> (aref ltimes level
) 0))
1741 (when (or headline-included headline-forced
)
1742 (if headline-included
1743 (loop for l from
0 to level do
1744 (aset ltimes l
(+ (aref ltimes l
) t1
))))
1745 (setq time
(aref ltimes level
))
1746 (goto-char (match-beginning 0))
1747 (put-text-property (point) (point-at-eol)
1748 (or propname
:org-clock-minutes
) time
)
1753 (> (funcall outline-level
) 1)
1754 (outline-up-heading 1 t
)
1756 (point) (point-at-eol)
1757 :org-clock-force-headline-inclusion t
))))))
1759 (loop for l from level to
(1- lmax
) do
1760 (aset ltimes l
0)))))))
1761 (setq org-clock-file-total-minutes
(aref ltimes
0)))
1762 (set-buffer-modified-p bmp
)))
1764 (defun org-clock-sum-current-item (&optional tstart
)
1765 "Return time, clocked on current item in total."
1768 (org-narrow-to-subtree)
1769 (org-clock-sum tstart
)
1770 org-clock-file-total-minutes
)))
1773 (defun org-clock-display (&optional total-only
)
1774 "Show subtree times in the entire buffer.
1775 If TOTAL-ONLY is non-nil, only show the total time for the entire file
1778 Use \\[org-clock-remove-overlays] to remove the subtree times."
1780 (org-clock-remove-overlays)
1785 (goto-char (point-min))
1786 (while (or (and (equal (setq p
(point)) (point-min))
1787 (get-text-property p
:org-clock-minutes
))
1788 (setq p
(next-single-property-change
1789 (point) :org-clock-minutes
)))
1791 (when (setq time
(get-text-property p
:org-clock-minutes
))
1792 (org-clock-put-overlay time
(funcall outline-level
))))
1793 (setq h
(/ org-clock-file-total-minutes
60)
1794 m
(- org-clock-file-total-minutes
(* 60 h
)))
1795 ;; Arrange to remove the overlays upon next change.
1796 (when org-remove-highlights-with-change
1797 (org-add-hook 'before-change-functions
'org-clock-remove-overlays
1799 (message (concat "Total file time: "
1800 (org-minutes-to-clocksum-string org-clock-file-total-minutes
)
1801 " (%d hours and %d minutes)") h m
)))
1803 (defvar org-clock-overlays nil
)
1804 (make-variable-buffer-local 'org-clock-overlays
)
1806 (defun org-clock-put-overlay (time &optional level
)
1807 "Put an overlays on the current line, displaying TIME.
1808 If LEVEL is given, prefix time with a corresponding number of stars.
1809 This creates a new overlay and stores it in `org-clock-overlays', so that it
1810 will be easy to remove."
1811 (let* ((c 60) (h (floor (/ time
60))) (m (- time
(* 60 h
)))
1812 (l (if level
(org-get-valid-level level
0) 0))
1815 (org-move-to-column c
)
1816 (unless (eolp) (skip-chars-backward "^ \t"))
1817 (skip-chars-backward " \t")
1818 (setq ov
(make-overlay (point-at-bol) (point-at-eol))
1819 tx
(concat (buffer-substring (point-at-bol) (point))
1820 (make-string (+ off
(max 0 (- c
(current-column)))) ?.
)
1821 (org-add-props (concat (make-string l ?
*) " "
1822 (org-minutes-to-clocksum-string time
)
1823 (make-string (- 16 l
) ?\
))
1824 (list 'face
'org-clock-overlay
))
1826 (if (not (featurep 'xemacs
))
1827 (overlay-put ov
'display tx
)
1828 (overlay-put ov
'invisible t
)
1829 (overlay-put ov
'end-glyph
(make-glyph tx
)))
1830 (push ov org-clock-overlays
)))
1832 (defun org-clock-remove-overlays (&optional beg end noremove
)
1833 "Remove the occur highlights from the buffer.
1834 BEG and END are ignored. If NOREMOVE is nil, remove this function
1835 from the `before-change-functions' in the current buffer."
1837 (unless org-inhibit-highlight-removal
1838 (mapc 'delete-overlay org-clock-overlays
)
1839 (setq org-clock-overlays nil
)
1841 (remove-hook 'before-change-functions
1842 'org-clock-remove-overlays
'local
))))
1844 (defvar org-state
) ;; dynamically scoped into this function
1845 (defun org-clock-out-if-current ()
1846 "Clock out if the current entry contains the running clock.
1847 This is used to stop the clock after a TODO entry is marked DONE,
1848 and is only done if the variable `org-clock-out-when-done' is not nil."
1849 (when (and (org-clocking-p)
1850 org-clock-out-when-done
1851 (marker-buffer org-clock-marker
)
1852 (or (and (eq t org-clock-out-when-done
)
1853 (member org-state org-done-keywords
))
1854 (and (listp org-clock-out-when-done
)
1855 (member org-state org-clock-out-when-done
)))
1856 (equal (or (buffer-base-buffer (org-clocking-buffer))
1857 (org-clocking-buffer))
1858 (or (buffer-base-buffer (current-buffer))
1860 (< (point) org-clock-marker
)
1861 (> (save-excursion (outline-next-heading) (point))
1863 ;; Clock out, but don't accept a logging message for this.
1864 (let ((org-log-note-clock-out nil
)
1865 (org-clock-out-switch-to-state nil
))
1868 (add-hook 'org-after-todo-state-change-hook
1869 'org-clock-out-if-current
)
1872 (defun org-clock-get-clocktable (&rest props
)
1873 "Get a formatted clocktable with parameters according to PROPS.
1874 The table is created in a temporary buffer, fully formatted and
1875 fontified, and then returned."
1877 (setq props
(plist-put props
:name
"clocktable"))
1878 (unless (plist-member props
:maxlevel
)
1879 (setq props
(plist-put props
:maxlevel
2)))
1880 (unless (plist-member props
:scope
)
1881 (setq props
(plist-put props
:scope
'agenda
)))
1884 (org-create-dblock props
)
1886 (font-lock-fontify-buffer)
1888 (buffer-substring (point) (progn
1889 (re-search-forward "^[ \t]*#\\+END" nil t
)
1893 (defun org-clock-report (&optional arg
)
1894 "Create a table containing a report about clocked time.
1895 If the cursor is inside an existing clocktable block, then the table
1896 will be updated. If not, a new clocktable will be inserted. The scope
1897 of the new clock will be subtree when called from within a subtree, and
1900 When called with a prefix argument, move to the first clock table in the
1901 buffer and update it."
1903 (org-clock-remove-overlays)
1905 (org-find-dblock "clocktable")
1907 (if (org-in-clocktable-p)
1908 (goto-char (org-in-clocktable-p))
1909 (let ((props (if (ignore-errors
1910 (save-excursion (org-back-to-heading)))
1911 (list :name
"clocktable" :scope
'subtree
)
1912 (list :name
"clocktable"))))
1914 (org-combine-plists org-clock-clocktable-default-properties props
))))
1915 (org-update-dblock))
1917 (defun org-day-of-week (day month year
)
1918 "Returns the day of the week as an integer."
1922 (format "%d-%02d-%02dT00:00:00" year month day
)))))
1924 (defun org-quarter-to-date (quarter year
)
1925 "Get the date (week day year) of the first day of a given quarter."
1929 (setq startday
(org-day-of-week 1 1 year
))
1932 (list 52 7 (- year
1)))
1934 (list 52 6 (- year
1)))
1936 (list 1 startday year
))
1938 (list 53 startday
(- year
1)))
1942 (setq startday
(org-day-of-week 1 4 year
))
1945 (list 13 startday year
))
1947 (list 14 startday year
))
1949 (list 13 startday year
))
1953 (setq startday
(org-day-of-week 1 7 year
))
1956 (list 26 startday year
))
1958 (list 27 startday year
))
1960 (list 26 startday year
))
1964 (setq startday
(org-day-of-week 1 10 year
))
1967 (list 39 startday year
))
1969 (list 40 startday year
))
1971 (list 39 startday year
)))))))
1973 (defun org-clock-special-range (key &optional time as-strings
)
1974 "Return two times bordering a special time range.
1975 Key is a symbol specifying the range and can be one of `today', `yesterday',
1976 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
1977 A week starts Monday 0:00 and ends Sunday 24:00.
1978 The range is determined relative to TIME. TIME defaults to the current time.
1979 The return value is a cons cell with two internal times like the ones
1980 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
1981 the returned times will be formatted strings."
1982 (if (integerp key
) (setq key
(intern (number-to-string key
))))
1983 (let* ((tm (decode-time (or time
(current-time))))
1984 (s 0) (m (nth 1 tm
)) (h (nth 2 tm
))
1985 (d (nth 3 tm
)) (month (nth 4 tm
)) (y (nth 5 tm
))
1987 (skey (symbol-name key
))
1989 (q (cond ((>= (nth 4 tm
) 10) 4)
1990 ((>= (nth 4 tm
) 7) 3)
1991 ((>= (nth 4 tm
) 4) 2)
1992 ((>= (nth 4 tm
) 1) 1)))
1993 s1 m1 h1 d1 month1 y1 diff ts te fm txt w date
1994 interval tmp shiftedy shiftedm shiftedq
)
1996 ((string-match "^[0-9]+$" skey
)
1997 (setq y
(string-to-number skey
) m
1 d
1 key
'year
))
1998 ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)$" skey
)
1999 (setq y
(string-to-number (match-string 1 skey
))
2000 month
(string-to-number (match-string 2 skey
))
2002 ((string-match "^\\([0-9]+\\)-[wW]\\([0-9]\\{1,2\\}\\)$" skey
)
2004 (setq y
(string-to-number (match-string 1 skey
))
2005 w
(string-to-number (match-string 2 skey
)))
2006 (setq date
(calendar-gregorian-from-absolute
2007 (calendar-absolute-from-iso (list w
1 y
))))
2008 (setq d
(nth 1 date
) month
(car date
) y
(nth 2 date
)
2011 ((string-match "^\\([0-9]+\\)-[qQ]\\([1-4]\\)$" skey
)
2013 (setq y
(string-to-number (match-string 1 skey
)))
2014 (setq q
(string-to-number (match-string 2 skey
)))
2015 (setq date
(calendar-gregorian-from-absolute
2016 (calendar-absolute-from-iso (org-quarter-to-date q y
))))
2017 (setq d
(nth 1 date
) month
(car date
) y
(nth 2 date
)
2020 ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)-\\([0-9]\\{1,2\\}\\)$" skey
)
2021 (setq y
(string-to-number (match-string 1 skey
))
2022 month
(string-to-number (match-string 2 skey
))
2023 d
(string-to-number (match-string 3 skey
))
2025 ((string-match "\\([-+][0-9]+\\)$" skey
)
2026 (setq shift
(string-to-number (match-string 1 skey
))
2027 key
(intern (substring skey
0 (match-beginning 1))))
2028 (if (and (memq key
'(quarter thisq
)) (> shift
0))
2029 (error "Looking forward with quarters isn't implemented"))))
2032 (cond ((eq key
'yesterday
) (setq key
'today shift -
1))
2033 ((eq key
'lastweek
) (setq key
'week shift -
1))
2034 ((eq key
'lastmonth
) (setq key
'month shift -
1))
2035 ((eq key
'lastyear
) (setq key
'year shift -
1))
2036 ((eq key
'lastq
) (setq key
'quarter shift -
1))))
2038 ((memq key
'(day today
))
2039 (setq d
(+ d shift
) h
0 m
0 h1
24 m1
0))
2040 ((memq key
'(week thisweek
))
2041 (setq diff
(+ (* -
7 shift
) (if (= dow
0) 6 (1- dow
)))
2042 m
0 h
0 d
(- d diff
) d1
(+ 7 d
)))
2043 ((memq key
'(month thismonth
))
2044 (setq d
1 h
0 m
0 d1
1 month
(+ month shift
) month1
(1+ month
) h1
0 m1
0))
2045 ((memq key
'(quarter thisq
))
2046 ; compute if this shift remains in this year
2047 ; if not, compute how many years and quarters we have to shift (via floor*)
2048 ; and compute the shifted years, months and quarters
2050 ((< (+ (- q
1) shift
) 0) ; shift not in this year
2051 (setq interval
(* -
1 (+ (- q
1) shift
)))
2052 ; set tmp to ((years to shift) (quarters to shift))
2053 (setq tmp
(org-floor* interval
4))
2054 ; due to the use of floor, 0 quarters actually means 4
2055 (if (= 0 (nth 1 tmp
))
2056 (setq shiftedy
(- y
(nth 0 tmp
))
2059 (setq shiftedy
(- y
(+ 1 (nth 0 tmp
)))
2060 shiftedm
(- 13 (* 3 (nth 1 tmp
)))
2061 shiftedq
(- 5 (nth 1 tmp
))))
2062 (setq d
1 h
0 m
0 d1
1 month shiftedm month1
(+ 3 shiftedm
) h1
0 m1
0 y shiftedy
))
2063 ((> (+ q shift
) 0) ; shift is within this year
2064 (setq shiftedq
(+ q shift
))
2066 (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))))
2067 ((memq key
'(year thisyear
))
2068 (setq m
0 h
0 d
1 month
1 y
(+ y shift
) y1
(1+ y
)))
2069 (t (error "No such time block %s" key
)))
2070 (setq ts
(encode-time s m h d month y
)
2071 te
(encode-time (or s1 s
) (or m1 m
) (or h1 h
)
2072 (or d1 d
) (or month1 month
) (or y1 y
)))
2073 (setq fm
(cdr org-time-stamp-formats
))
2075 ((memq key
'(day today
))
2076 (setq txt
(format-time-string "%A, %B %d, %Y" ts
)))
2077 ((memq key
'(week thisweek
))
2078 (setq txt
(format-time-string "week %G-W%V" ts
)))
2079 ((memq key
'(month thismonth
))
2080 (setq txt
(format-time-string "%B %Y" ts
)))
2081 ((memq key
'(year thisyear
))
2082 (setq txt
(format-time-string "the year %Y" ts
)))
2083 ((memq key
'(quarter thisq
))
2084 (setq txt
(concat (org-count-quarter shiftedq
) " quarter of " (number-to-string shiftedy
))))
2087 (list (format-time-string fm ts
) (format-time-string fm te
) txt
)
2090 (defun org-count-quarter (n)
2097 (defun org-clocktable-shift (dir n
)
2098 "Try to shift the :block date of the clocktable at point.
2099 Point must be in the #+BEGIN: line of a clocktable, or this function
2100 will throw an error.
2101 DIR is a direction, a symbol `left', `right', `up', or `down'.
2102 Both `left' and `down' shift the block toward the past, `up' and `right'
2103 push it toward the future.
2104 N is the number of shift steps to take. The size of the step depends on
2105 the currently selected interval size."
2106 (setq n
(prefix-numeric-value n
))
2107 (and (memq dir
'(left down
)) (setq n
(- n
)))
2109 (goto-char (point-at-bol))
2110 (if (not (looking-at "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>.*?:block[ \t]+\\(\\S-+\\)"))
2111 (error "Line needs a :block definition before this command works")
2112 (let* ((b (match-beginning 1)) (e (match-end 1))
2113 (s (match-string 1))
2114 block shift ins y mw d date wp m
)
2116 ((equal s
"yesterday") (setq s
"today-1"))
2117 ((equal s
"lastweek") (setq s
"thisweek-1"))
2118 ((equal s
"lastmonth") (setq s
"thismonth-1"))
2119 ((equal s
"lastyear") (setq s
"thisyear-1"))
2120 ((equal s
"lastq") (setq s
"thisq-1")))
2123 ((string-match "^\\(today\\|thisweek\\|thismonth\\|thisyear\\|thisq\\)\\([-+][0-9]+\\)?$" s
)
2124 (setq block
(match-string 1 s
)
2125 shift
(if (match-end 2)
2126 (string-to-number (match-string 2 s
))
2128 (setq shift
(+ shift n
))
2129 (setq ins
(if (= shift
0) block
(format "%s%+d" block shift
))))
2130 ((string-match "\\([0-9]+\\)\\(-\\([wWqQ]?\\)\\([0-9]\\{1,2\\}\\)\\(-\\([0-9]\\{1,2\\}\\)\\)?\\)?" s
)
2131 ;; 1 1 2 3 3 4 4 5 6 6 5 2
2132 (setq y
(string-to-number (match-string 1 s
))
2133 wp
(and (match-end 3) (match-string 3 s
))
2134 mw
(and (match-end 4) (string-to-number (match-string 4 s
)))
2135 d
(and (match-end 6) (string-to-number (match-string 6 s
))))
2137 (d (setq ins
(format-time-string
2139 (encode-time 0 0 0 (+ d n
) m y
))))
2140 ((and wp
(string-match "w\\|W" wp
) mw
(> (length wp
) 0))
2142 (setq date
(calendar-gregorian-from-absolute
2143 (calendar-absolute-from-iso (list (+ mw n
) 1 y
))))
2144 (setq ins
(format-time-string
2146 (encode-time 0 0 0 (nth 1 date
) (car date
) (nth 2 date
)))))
2147 ((and wp
(string-match "q\\|Q" wp
) mw
(> (length wp
) 0))
2149 ; if the 4th + 1 quarter is requested we flip to the 1st quarter of the next year
2154 ; if the 1st - 1 quarter is requested we flip to the 4th quarter of the previous year
2159 (setq date
(calendar-gregorian-from-absolute
2160 (calendar-absolute-from-iso (org-quarter-to-date (+ mw n
) y
))))
2161 (setq ins
(format-time-string
2162 (concat (number-to-string y
) "-Q" (number-to-string (+ mw n
)))
2163 (encode-time 0 0 0 (nth 1 date
) (car date
) (nth 2 date
)))))
2165 (setq ins
(format-time-string
2167 (encode-time 0 0 0 1 (+ mw n
) y
))))
2169 (setq ins
(number-to-string (+ y n
))))))
2170 (t (error "Cannot shift clocktable block")))
2174 (delete-region (point) (+ (point) (- e b
)))
2175 (beginning-of-line 1)
2180 (defun org-dblock-write:clocktable
(params)
2181 "Write the standard clocktable."
2182 (setq params
(org-combine-plists org-clocktable-defaults params
))
2184 (let* ((scope (plist-get params
:scope
))
2185 (block (plist-get params
:block
))
2186 (ts (plist-get params
:tstart
))
2187 (te (plist-get params
:tend
))
2188 (link (plist-get params
:link
))
2189 (maxlevel (or (plist-get params
:maxlevel
) 3))
2190 (step (plist-get params
:step
))
2191 (timestamp (plist-get params
:timestamp
))
2192 (formatter (or (plist-get params
:formatter
)
2193 org-clock-clocktable-formatter
2194 'org-clocktable-write-default
))
2195 cc range-text ipos pos one-file-with-archives
2196 scope-is-list tbls level
)
2197 ;; Check if we need to do steps
2199 ;; Get the range text for the header
2200 (setq cc
(org-clock-special-range block nil t
)
2201 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2203 ;; Write many tables, in steps
2204 (unless (or block
(and ts te
))
2205 (error "Clocktable `:step' can only be used with `:block' or `:tstart,:end'"))
2206 (org-clocktable-steps params
)
2209 (setq ipos
(point)) ; remember the insertion position
2211 ;; Get the right scope
2214 ((and scope
(listp scope
) (symbolp (car scope
)))
2215 (setq scope
(eval scope
)))
2217 (setq scope
(org-agenda-files t
)))
2218 ((eq scope
'agenda-with-archives
)
2219 (setq scope
(org-agenda-files t
))
2220 (setq scope
(org-add-archive-files scope
)))
2221 ((eq scope
'file-with-archives
)
2222 (setq scope
(org-add-archive-files (list (buffer-file-name)))
2223 one-file-with-archives t
)))
2224 (setq scope-is-list
(and scope
(listp scope
)))
2226 ;; we collect from several files
2227 (let* ((files scope
)
2229 (org-agenda-prepare-buffers files
)
2230 (while (setq file
(pop files
))
2231 (with-current-buffer (find-buffer-visiting file
)
2234 (push (org-clock-get-table-data file params
) tbls
))))))
2235 ;; Just from the current file
2237 ;; get the right range into the restriction
2238 (org-agenda-prepare-buffers (list (buffer-file-name)))
2240 ((not scope
)) ; use the restriction as it is now
2241 ((eq scope
'file
) (widen))
2242 ((eq scope
'subtree
) (org-narrow-to-subtree))
2244 (while (org-up-heading-safe))
2245 (org-narrow-to-subtree))
2246 ((and (symbolp scope
) (string-match "^tree\\([0-9]+\\)$"
2247 (symbol-name scope
)))
2248 (setq level
(string-to-number (match-string 1 (symbol-name scope
))))
2250 (while (org-up-heading-safe)
2251 (looking-at org-outline-regexp
)
2252 (if (<= (org-reduced-level (funcall outline-level
)) level
)
2253 (throw 'exit nil
))))
2254 (org-narrow-to-subtree)))
2255 ;; do the table, with no file name.
2256 (push (org-clock-get-table-data nil params
) tbls
)))
2258 ;; OK, at this point we tbls as a list of tables, one per file
2259 (setq tbls
(nreverse tbls
))
2261 (setq params
(plist-put params
:multifile scope-is-list
))
2262 (setq params
(plist-put params
:one-file-with-archives
2263 one-file-with-archives
))
2265 (funcall formatter ipos tbls params
))))
2267 (defun org-clocktable-write-default (ipos tables params
)
2268 "Write out a clock table at position IPOS in the current buffer.
2269 TABLES is a list of tables with clocking data as produced by
2270 `org-clock-get-table-data'. PARAMS is the parameter property list obtained
2271 from the dynamic block definition."
2272 ;; This function looks quite complicated, mainly because there are a
2273 ;; lot of options which can add or remove columns. I have massively
2274 ;; commented this function, the I hope it is understandable. If
2275 ;; someone wants to write their own special formatter, this maybe
2276 ;; much easier because there can be a fixed format with a
2277 ;; well-defined number of columns...
2278 (let* ((hlchars '((1 .
"*") (2 .
"/")))
2279 (lwords (assoc (or (plist-get params
:lang
)
2280 org-export-default-language
)
2281 org-clock-clocktable-language-setup
))
2282 (multifile (plist-get params
:multifile
))
2283 (block (plist-get params
:block
))
2284 (ts (plist-get params
:tstart
))
2285 (te (plist-get params
:tend
))
2286 (header (plist-get params
:header
))
2287 (narrow (plist-get params
:narrow
))
2288 (link (plist-get params
:link
))
2289 (maxlevel (or (plist-get params
:maxlevel
) 3))
2290 (emph (plist-get params
:emphasize
))
2291 (level-p (plist-get params
:level
))
2292 (timestamp (plist-get params
:timestamp
))
2293 (properties (plist-get params
:properties
))
2294 (ntcol (max 1 (or (plist-get params
:tcolumns
) 100)))
2295 (rm-file-column (plist-get params
:one-file-with-archives
))
2296 (indent (plist-get params
:indent
))
2297 (case-fold-search t
)
2298 range-text total-time tbl level hlc formula pcol
2299 file-time entries entry headline
2300 recalc content narrow-cut-p tcol
)
2302 ;; Implement abbreviations
2303 (when (plist-get params
:compact
)
2304 (setq level nil indent t narrow
(or narrow
'40!) ntcol
1))
2306 ;; Some consistency test for parameters
2307 (unless (integerp ntcol
)
2308 (setq params
(plist-put params
:tcolumns
(setq ntcol
100))))
2310 (when (and narrow
(integerp narrow
) link
)
2311 ;; We cannot have both integer narrow and link
2313 "Using hard narrowing in clocktable to allow for links")
2314 (setq narrow
(intern (format "%d!" narrow
))))
2319 ((and (symbolp narrow
)
2320 (string-match "\\`[0-9]+!\\'" (symbol-name narrow
)))
2321 (setq narrow-cut-p t
2322 narrow
(string-to-number (substring (symbol-name narrow
)
2325 (error "Invalid value %s of :narrow property in clock table"
2329 ;; Get the range text for the header
2330 (setq range-text
(nth 2 (org-clock-special-range block nil t
))))
2332 ;; Compute the total time
2333 (setq total-time
(apply '+ (mapcar 'cadr tables
)))
2335 ;; Now we need to output this tsuff
2338 ;; Insert the text *before* the actual table
2339 (insert-before-markers
2341 ;; Format the standard header
2346 (format-time-string (cdr org-time-stamp-formats
))
2349 (if block
(concat ", for " range-text
".") "")
2352 ;; Insert the narrowing line
2353 (when (and narrow
(integerp narrow
) (not narrow-cut-p
))
2354 (insert-before-markers
2355 "|" ; table line starter
2356 (if multifile
"|" "") ; file column, maybe
2357 (if level-p
"|" "") ; level column, maybe
2358 (if timestamp
"|" "") ; timestamp column, maybe
2359 (if properties
(make-string (length properties
) ?|
) "") ;properties columns, maybe
2360 (format "<%d>| |\n" narrow
))) ; headline and time columns
2362 ;; Insert the table header line
2363 (insert-before-markers
2364 "|" ; table line starter
2365 (if multifile
(concat (nth 1 lwords
) "|") "") ; file column, maybe
2366 (if level-p
(concat (nth 2 lwords
) "|") "") ; level column, maybe
2367 (if timestamp
(concat (nth 3 lwords
) "|") "") ; timestamp column, maybe
2368 (if properties
(concat (mapconcat 'identity properties
"|") "|") "") ;properties columns, maybe
2369 (concat (nth 4 lwords
) "|"
2370 (nth 5 lwords
) "|\n")) ; headline and time columns
2372 ;; Insert the total time in the table
2373 (insert-before-markers
2375 "|" ; table line starter
2376 (if multifile
(concat "| " (nth 6 lwords
) " ") "")
2377 ; file column, maybe
2378 (if level-p
"|" "") ; level column, maybe
2379 (if timestamp
"|" "") ; timestamp column, maybe
2380 (if properties
(make-string (length properties
) ?|
) "") ; properties columns, maybe
2381 (concat (format org-clock-total-time-cell-format
(nth 7 lwords
)) "| ") ; instead of a headline
2382 (format org-clock-total-time-cell-format
2383 (org-minutes-to-clocksum-string (or total-time
0))) ; the time
2386 ;; Now iterate over the tables and insert the data
2387 ;; but only if any time has been collected
2388 (when (and total-time
(> total-time
0))
2390 (while (setq tbl
(pop tables
))
2391 ;; now tbl is the table resulting from one file.
2392 (setq file-time
(nth 1 tbl
))
2393 (when (or (and file-time
(> file-time
0))
2394 (not (plist-get params
:fileskip0
)))
2395 (insert-before-markers "|-\n") ; a hline because a new file starts
2396 ;; First the file time, if we have multiple files
2398 ;; Summarize the time collected from this file
2399 (insert-before-markers
2400 (format (concat "| %s %s | %s%s"
2401 (format org-clock-file-time-cell-format
(nth 8 lwords
))
2403 (file-name-nondirectory (car tbl
))
2404 (if level-p
"| " "") ; level column, maybe
2405 (if timestamp
"| " "") ; timestamp column, maybe
2406 (if properties
(make-string (length properties
) ?|
) "") ;properties columns, maybe
2407 (org-minutes-to-clocksum-string (nth 1 tbl
))))) ; the time
2409 ;; Get the list of node entries and iterate over it
2410 (setq entries
(nth 2 tbl
))
2411 (while (setq entry
(pop entries
))
2412 (setq level
(car entry
)
2413 headline
(nth 1 entry
)
2414 hlc
(if emph
(or (cdr (assoc level hlchars
)) "") ""))
2416 (if (and (string-match (concat "\\`" org-bracket-link-regexp
2421 (format "[[%s][%s]]"
2422 (match-string 1 headline
)
2423 (org-shorten-string (match-string 3 headline
)
2425 (setq headline
(org-shorten-string headline narrow
))))
2426 (insert-before-markers
2427 "|" ; start the table line
2428 (if multifile
"|" "") ; free space for file name column?
2429 (if level-p
(format "%d|" (car entry
)) "") ; level, maybe
2430 (if timestamp
(concat (nth 2 entry
) "|") "") ; timestamp, maybe
2434 (lambda (p) (or (cdr (assoc p
(nth 4 entry
))) ""))
2435 properties
"|") "|") "") ;properties columns, maybe
2436 (if indent
(org-clocktable-indent-string level
) "") ; indentation
2437 hlc headline hlc
"|" ; headline
2438 (make-string (min (1- ntcol
) (or (- level
1))) ?|
)
2439 ; empty fields for higher levels
2440 hlc
(org-minutes-to-clocksum-string (nth 3 entry
)) hlc
; time
2443 ;; When exporting subtrees or regions the region might be
2444 ;; activated, so let's disable ̀delete-active-region'
2445 (let ((delete-active-region nil
)) (backward-delete-char 1))
2446 (if (setq formula
(plist-get params
:formula
))
2449 ;; compute the column where the % numbers need to go
2454 (min maxlevel
(or ntcol
100))))
2455 ;; compute the column where the total time is
2459 (if timestamp
1 0)))
2462 "\n#+TBLFM: $%d='(org-clock-time%% @%d$%d $%d..$%d);%%.1f"
2463 pcol
; the column where the % numbers should go
2464 (if (and narrow
(not narrow-cut-p
)) 3 2) ; row of the total time
2465 tcol
; column of the total time
2466 tcol
(1- pcol
) ; range of columns where times can be found
2470 (insert "\n#+TBLFM: " formula
)
2472 (t (error "Invalid formula in clocktable")))
2473 ;; Should we rescue an old formula?
2474 (when (stringp (setq content
(plist-get params
:content
)))
2475 (when (string-match "^\\([ \t]*#\\+tblfm:.*\\)" content
)
2477 (insert "\n" (match-string 1 (plist-get params
:content
)))
2478 (beginning-of-line 0))))
2479 ;; Back to beginning, align the table, recalculate if necessary
2481 (skip-chars-forward "^|")
2483 (when org-hide-emphasis-markers
2484 ;; we need to align a second time
2489 (if (and narrow
(not narrow-cut-p
)) (beginning-of-line 2))
2490 (org-table-goto-column pcol nil
'force
)
2492 (org-table-recalculate 'all
))
2493 (when rm-file-column
2494 ;; The file column is actually not wanted
2496 (org-table-delete-column))
2499 (defun org-clocktable-indent-string (level)
2504 (setq level
(1- level
)
2505 str
(concat str
"___")))
2508 (defun org-clocktable-steps (params)
2509 "Step through the range to make a number of clock tables."
2510 (let* ((p1 (copy-sequence params
))
2511 (ts (plist-get p1
:tstart
))
2512 (te (plist-get p1
:tend
))
2513 (step0 (plist-get p1
:step
))
2514 (step (cdr (assoc step0
'((day .
86400) (week .
604800)))))
2515 (stepskip0 (plist-get p1
:stepskip0
))
2516 (block (plist-get p1
:block
))
2517 cc range-text step-time
)
2519 (setq cc
(org-clock-special-range block nil t
)
2520 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2523 ;; If ts is a number, it's an absolute day number from org-agenda.
2524 (destructuring-bind (month day year
) (calendar-gregorian-from-absolute ts
)
2525 (setq ts
(org-float-time (encode-time 0 0 0 day month year
)))))
2527 (setq ts
(org-float-time
2528 (apply 'encode-time
(org-parse-time-string ts
))))))
2532 (destructuring-bind (month day year
) (calendar-gregorian-from-absolute te
)
2533 (setq te
(org-float-time (encode-time 0 0 0 day month year
)))))
2535 (setq te
(org-float-time
2536 (apply 'encode-time
(org-parse-time-string te
))))))
2537 (setq p1
(plist-put p1
:header
""))
2538 (setq p1
(plist-put p1
:step nil
))
2539 (setq p1
(plist-put p1
:block nil
))
2541 (or (bolp) (insert "\n"))
2542 (setq p1
(plist-put p1
:tstart
(format-time-string
2543 (org-time-stamp-format nil t
)
2544 (seconds-to-time ts
))))
2545 (setq p1
(plist-put p1
:tend
(format-time-string
2546 (org-time-stamp-format nil t
)
2547 (seconds-to-time (setq ts
(+ ts step
))))))
2548 (insert "\n" (if (eq step0
'day
) "Daily report: "
2549 "Weekly report starting on: ")
2550 (plist-get p1
:tstart
) "\n")
2551 (setq step-time
(org-dblock-write:clocktable p1
))
2552 (re-search-forward "^[ \t]*#\\+END:")
2553 (when (and (equal step-time
0) stepskip0
)
2554 ;; Remove the empty table
2555 (delete-region (point-at-bol)
2557 (re-search-backward "^\\(Daily\\|Weekly\\) report"
2562 (defun org-clock-get-table-data (file params
)
2563 "Get the clocktable data for file FILE, with parameters PARAMS.
2564 FILE is only for identification - this function assumes that
2565 the correct buffer is current, and that the wanted restriction is
2567 The return value will be a list with the file name and the total
2568 file time (in minutes) as 1st and 2nd elements. The third element
2569 of this list will be a list of headline entries. Each entry has the
2570 following structure:
2572 (LEVEL HEADLINE TIMESTAMP TIME)
2574 LEVEL: The level of the headline, as an integer. This will be
2575 the reduced leve, so 1,2,3,... even if only odd levels
2577 HEADLINE: The text of the headline. Depending on PARAMS, this may
2578 already be formatted like a link.
2579 TIMESTAMP: If PARAMS require it, this will be a time stamp found in the
2580 entry, any of SCHEDULED, DEADLINE, NORMAL, or first inactive,
2582 TIME: The sum of all time spend in this tree, in minutes. This time
2583 will of cause be restricted to the time block and tags match
2584 specified in PARAMS."
2585 (let* ((maxlevel (or (plist-get params
:maxlevel
) 3))
2586 (timestamp (plist-get params
:timestamp
))
2587 (ts (plist-get params
:tstart
))
2588 (te (plist-get params
:tend
))
2589 (block (plist-get params
:block
))
2590 (link (plist-get params
:link
))
2591 (tags (plist-get params
:tags
))
2592 (properties (plist-get params
:properties
))
2593 (inherit-property-p (plist-get params
:inherit-props
))
2595 (matcher (if tags
(cdr (org-make-tags-matcher tags
))))
2596 cc range-text st p time level hdl props tsp tbl
)
2598 (setq org-clock-file-total-minutes nil
)
2600 (setq cc
(org-clock-special-range block nil t
)
2601 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2602 (when (integerp ts
) (setq ts
(calendar-gregorian-from-absolute ts
)))
2603 (when (integerp te
) (setq te
(calendar-gregorian-from-absolute te
)))
2604 (when (and ts
(listp ts
))
2605 (setq ts
(format "%4d-%02d-%02d" (nth 2 ts
) (car ts
) (nth 1 ts
))))
2606 (when (and te
(listp te
))
2607 (setq te
(format "%4d-%02d-%02d" (nth 2 te
) (car te
) (nth 1 te
))))
2608 ;; Now the times are strings we can parse.
2609 (if ts
(setq ts
(org-float-time
2610 (seconds-to-time (org-matcher-time ts
)))))
2611 (if te
(setq te
(org-float-time
2612 (seconds-to-time (org-matcher-time te
)))))
2614 (org-clock-sum ts te
2615 (unless (null matcher
)
2617 (let* ((tags-list (org-get-tags-at))
2618 (org-scanner-tags tags-list
)
2619 (org-trust-scanner-tags t
))
2621 (goto-char (point-min))
2623 (while (or (and (bobp) (prog1 st
(setq st nil
))
2624 (get-text-property (point) :org-clock-minutes
)
2625 (setq p
(point-min)))
2626 (setq p
(next-single-property-change
2627 (point) :org-clock-minutes
)))
2629 (when (setq time
(get-text-property p
:org-clock-minutes
))
2631 (beginning-of-line 1)
2632 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@#%:]+:\\)?[ \t]*$"))
2633 (setq level
(org-reduced-level
2634 (- (match-end 1) (match-beginning 1))))
2635 (<= level maxlevel
))
2636 (setq hdl
(if (not link
)
2638 (org-make-link-string
2639 (format "file:%s::%s"
2642 (org-make-org-heading-search-string
2646 (setq props
(org-entry-properties (point)))
2647 (or (cdr (assoc "SCHEDULED" props
))
2648 (cdr (assoc "DEADLINE" props
))
2649 (cdr (assoc "TIMESTAMP" props
))
2650 (cdr (assoc "TIMESTAMP_IA" props
))))
2651 props
(when properties
2655 (when (org-entry-get (point) p inherit-property-p
)
2656 (cons p
(org-entry-get (point) p inherit-property-p
))))
2658 (when (> time
0) (push (list level hdl tsp time props
) tbl
))))))
2659 (setq tbl
(nreverse tbl
))
2660 (list file org-clock-file-total-minutes tbl
))))
2662 (defun org-clock-time%
(total &rest strings
)
2663 "Compute a time fraction in percent.
2664 TOTAL s a time string like 10:21 specifying the total times.
2665 STRINGS is a list of strings that should be checked for a time.
2666 The first string that does have a time will be used.
2667 This function is made for clock tables."
2668 (let ((re "\\([0-9]+\\):\\([0-9]+\\)")
2672 (if (not (string-match re total
))
2674 (setq tot
(+ (string-to-number (match-string 2 total
))
2675 (* 60 (string-to-number (match-string 1 total
)))))
2676 (if (= tot
0.
) (throw 'exit
0.
)))
2677 (while (setq s
(pop strings
))
2678 (if (string-match "\\([0-9]+\\):\\([0-9]+\\)" s
)
2680 (/ (* 100.0 (+ (string-to-number (match-string 2 s
))
2681 (* 60 (string-to-number
2682 (match-string 1 s
)))))
2686 ;; Saving and loading the clock
2688 (defvar org-clock-loaded nil
2689 "Was the clock file loaded?")
2691 (defun org-clock-update-time-maybe ()
2692 "If this is a CLOCK line, update it and return t.
2693 Otherwise, return nil."
2696 (beginning-of-line 1)
2697 (skip-chars-forward " \t")
2698 (when (looking-at org-clock-string
)
2699 (let ((re (concat "[ \t]*" org-clock-string
2700 " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
2701 "\\([ \t]*=>.*\\)?\\)?"))
2704 ((not (looking-at re
))
2706 ((not (match-end 2))
2707 (when (and (equal (marker-buffer org-clock-marker
) (current-buffer))
2708 (> org-clock-marker
(point))
2709 (<= org-clock-marker
(point-at-eol)))
2710 ;; The clock is running here
2711 (setq org-clock-start-time
2713 (org-parse-time-string (match-string 1))))
2714 (org-clock-update-mode-line)))
2716 (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
2718 (setq ts
(match-string 1)
2719 te
(match-string 3))
2720 (setq s
(- (org-float-time
2721 (apply 'encode-time
(org-parse-time-string te
)))
2723 (apply 'encode-time
(org-parse-time-string ts
))))
2726 h
(floor (/ s
3600))
2730 (insert " => " (format (if neg
"-%d:%02d" "%2d:%02d") h m
))
2733 (defun org-clock-save ()
2734 "Persist various clock-related data to disk.
2735 The details of what will be saved are regulated by the variable
2736 `org-clock-persist'."
2737 (when (and org-clock-persist
2738 (or org-clock-loaded
2739 org-clock-has-been-used
2740 (not (file-exists-p org-clock-persist-file
))))
2742 (with-current-buffer (find-file (expand-file-name org-clock-persist-file
))
2744 (delete-region (point-min) (point-max))
2746 (insert (format ";; org-persist.el - %s at %s\n"
2747 system-name
(format-time-string
2748 (cdr org-time-stamp-formats
))))
2749 (if (and (memq org-clock-persist
'(t clock
))
2750 (setq b
(org-clocking-buffer))
2751 (setq b
(or (buffer-base-buffer b
) b
))
2753 (buffer-file-name b
)
2754 (or (not org-clock-persist-query-save
)
2755 (y-or-n-p (concat "Save current clock ("
2756 (substring-no-properties
2759 (insert "(setq resume-clock '(\""
2760 (buffer-file-name (org-clocking-buffer))
2761 "\" . " (int-to-string (marker-position org-clock-marker
))
2763 ;; Store clocked task history. Tasks are stored reversed to make
2765 (when (and (memq org-clock-persist
'(t history
))
2768 "(setq stored-clock-history '("
2771 (when (and (setq b
(marker-buffer m
))
2772 (setq b
(or (buffer-base-buffer b
) b
))
2774 (buffer-file-name b
))
2775 (concat "(\"" (buffer-file-name b
)
2776 "\" . " (int-to-string (marker-position m
))
2778 (reverse org-clock-history
) " ") "))\n"))
2780 (kill-buffer (current-buffer)))))))
2782 (defun org-clock-load ()
2783 "Load clock-related data from disk, maybe resuming a stored clock."
2784 (when (and org-clock-persist
(not org-clock-loaded
))
2785 (let ((filename (expand-file-name org-clock-persist-file
))
2786 (org-clock-in-resume 'auto-restart
)
2787 resume-clock stored-clock-history
)
2788 (if (not (file-readable-p filename
))
2789 (message "Not restoring clock data; %s not found"
2790 org-clock-persist-file
)
2791 (message "%s" "Restoring clock data")
2792 (setq org-clock-loaded t
)
2793 (load-file filename
)
2795 (when stored-clock-history
2796 (save-window-excursion
2797 (mapc (lambda (task)
2798 (if (file-exists-p (car task
))
2799 (org-clock-history-push (cdr task
)
2800 (find-file (car task
)))))
2801 stored-clock-history
)))
2803 (when (and resume-clock org-clock-persist
2804 (file-exists-p (car resume-clock
))
2805 (or (not org-clock-persist-query-resume
)
2809 (with-current-buffer (find-file (car resume-clock
))
2811 (goto-char (cdr resume-clock
))
2812 (org-back-to-heading t
)
2813 (and (looking-at org-complex-heading-regexp
)
2816 (when (file-exists-p (car resume-clock
))
2817 (with-current-buffer (find-file (car resume-clock
))
2818 (goto-char (cdr resume-clock
))
2819 (let ((org-clock-auto-clock-resolution nil
))
2821 (if (outline-invisible-p)
2822 (org-show-context))))))))))
2824 ;; Suggested bindings
2825 (org-defkey org-mode-map
"\C-c\C-x\C-e" 'org-clock-modify-effort-estimate
)
2827 (provide 'org-clock
)
2830 ;; generated-autoload-file: "org-loaddefs.el"
2833 ;;; org-clock.el ends here
