1 ;;; org-clock.el --- The time clocking code for Org-mode
3 ;; Copyright (C) 2004-2013 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27 ;; This file contains the time clocking code for Org-mode
35 (declare-function calendar-absolute-from-iso
"cal-iso" (&optional date
))
36 (declare-function notifications-notify
"notifications" (&rest params
))
37 (declare-function org-pop-to-buffer-same-window
"org-compat" (&optional buffer-or-name norecord label
))
38 (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-rounding-minutes
0
98 "Rounding minutes when clocking in or out.
99 The default value is 0 so that no rounding is done.
100 When set to a non-integer value, use the car of
101 `org-time-stamp-rounding-minutes', like for setting a time-stamp.
103 E.g. if `org-clock-rounding-minutes' is set to 5, time is 14:47
104 and you clock in: then the clock starts at 14:45. If you clock
105 out within the next 5 minutes, the clock line will be removed;
106 if you clock out 8 minutes after your clocked in, the clock
107 out time will be 14:50."
111 (integer :tag
"Minutes (0 for no rounding)")
112 (symbol :tag
"Use `org-time-stamp-rounding-minutes'" 'same-as-time-stamp
)))
114 (defcustom org-clock-out-remove-zero-time-clocks nil
115 "Non-nil means remove the clock line when the resulting time is zero."
119 (defcustom org-clock-in-switch-to-state nil
120 "Set task to a special todo state while clocking it.
121 The value should be the state to which the entry should be
122 switched. If the value is a function, it must take one
123 parameter (the current TODO state of the item) and return the
124 state to switch it to."
128 (const :tag
"Don't force a state" nil
)
129 (string :tag
"State")
130 (symbol :tag
"Function")))
132 (defcustom org-clock-out-switch-to-state nil
133 "Set task to a special todo state after clocking out.
134 The value should be the state to which the entry should be
135 switched. If the value is a function, it must take one
136 parameter (the current TODO state of the item) and return the
137 state to switch it to."
141 (const :tag
"Don't force a state" nil
)
142 (string :tag
"State")
143 (symbol :tag
"Function")))
145 (defcustom org-clock-history-length
5
146 "Number of clock tasks to remember in history."
150 (defcustom org-clock-goto-may-find-recent-task t
151 "Non-nil means `org-clock-goto' can go to recent task if no active clock."
155 (defcustom org-clock-heading-function nil
156 "When non-nil, should be a function to create `org-clock-heading'.
157 This is the string shown in the mode line when a clock is running.
158 The function is called with point at the beginning of the headline."
162 (defcustom org-clock-string-limit
0
163 "Maximum length of clock strings in the mode line. 0 means no limit."
167 (defcustom org-clock-in-resume nil
168 "If non-nil, resume clock when clocking into task with open clock.
169 When clocking into a task with a clock entry which has not been closed,
170 the clock can be resumed from that point."
174 (defcustom org-clock-persist nil
175 "When non-nil, save the running clock when Emacs is closed.
176 The clock is resumed when Emacs restarts.
177 When this is t, both the running clock, and the entire clock
178 history are saved. When this is the symbol `clock', only the
179 running clock is saved. When this is the symbol `history', only
180 the clock history is saved.
182 When Emacs restarts with saved clock information, the file containing
183 the running clock as well as all files mentioned in the clock history
186 All this depends on running `org-clock-persistence-insinuate' in your
187 Emacs initialization file."
190 (const :tag
"Just the running clock" clock
)
191 (const :tag
"Just the history" history
)
192 (const :tag
"Clock and history" t
)
193 (const :tag
"No persistence" nil
)))
195 (defcustom org-clock-persist-file
(convert-standard-filename
196 "~/.emacs.d/org-clock-save.el")
197 "File to save clock data to."
201 (defcustom org-clock-persist-query-save nil
202 "When non-nil, ask before saving the current clock on exit."
206 (defcustom org-clock-persist-query-resume t
207 "When non-nil, ask before resuming any stored clock during load."
211 (defcustom org-clock-sound nil
212 "Sound to use for notifications.
216 t Standard Emacs beep
217 file name Play this sound file, fall back to beep"
220 (const :tag
"No sound" nil
)
221 (const :tag
"Standard beep" t
)
222 (file :tag
"Play sound file")))
224 (define-obsolete-variable-alias 'org-clock-modeline-total
225 'org-clock-mode-line-total
"24.3")
227 (defcustom org-clock-mode-line-total
'auto
228 "Default setting for the time included for the mode line clock.
229 This can be overruled locally using the CLOCK_MODELINE_TOTAL property.
232 current Only the time in the current instance of the clock
233 today All time clocked into this task today
234 repeat All time clocked into this task since last repeat
235 all All time ever recorded for this task
236 auto Automatically, either `all', or `repeat' for repeating tasks"
239 (const :tag
"Current clock" current
)
240 (const :tag
"Today's task time" today
)
241 (const :tag
"Since last repeat" repeat
)
242 (const :tag
"All task time" all
)
243 (const :tag
"Automatically, `all' or since `repeat'" auto
)))
245 (defvaralias 'org-task-overrun-text
'org-clock-task-overrun-text
)
246 (defcustom org-clock-task-overrun-text nil
247 "Extra mode line text to indicate that the clock is overrun.
248 The can be nil to indicate that instead of adding text, the clock time
249 should get a different face (`org-mode-line-clock-overrun').
250 When this is a string, it is prepended to the clock string as an indication,
251 also using the face `org-mode-line-clock-overrun'."
255 (const :tag
"Just mark the time string" nil
)
256 (string :tag
"Text to prepend")))
258 (defcustom org-show-notification-handler nil
259 "Function or program to send notification with.
260 The function or program will be called with the notification
264 (string :tag
"Program")
265 (function :tag
"Function")))
267 (defgroup org-clocktable nil
268 "Options concerning the clock table in Org-mode."
269 :tag
"Org Clock Table"
272 (defcustom org-clocktable-defaults
275 :lang org-export-default-language
294 "Default properties for clock tables."
299 (defcustom org-clock-clocktable-formatter
'org-clocktable-write-default
300 "Function to turn clocking data into a table.
301 For more information, see `org-clocktable-write-default'."
302 :group
'org-clocktable
306 ;; FIXME: translate es and nl last string "Clock summary at"
307 (defcustom org-clock-clocktable-language-setup
308 '(("en" "File" "L" "Timestamp" "Headline" "Time" "ALL" "Total time" "File time" "Clock summary at")
309 ("es" "Archivo" "N" "Fecha y hora" "Tarea" "Tiempo" "TODO" "Tiempo total" "Tiempo archivo" "Clock summary at")
310 ("fr" "Fichier" "N" "Horodatage" "En-tête" "Durée" "TOUT" "Durée totale" "Durée fichier" "Horodatage sommaire à ")
311 ("nl" "Bestand" "N" "Tijdstip" "Hoofding" "Duur" "ALLES" "Totale duur" "Bestandstijd" "Clock summary at"))
312 "Terms used in clocktable, translated to different languages."
313 :group
'org-clocktable
317 (defcustom org-clock-clocktable-default-properties
'(:maxlevel
2 :scope file
)
318 "Default properties for new clocktables.
319 These will be inserted into the BEGIN line, to make it easy for users to
321 :group
'org-clocktable
324 (defcustom org-clock-idle-time nil
325 "When non-nil, resolve open clocks if the user is idle more than X minutes."
328 (const :tag
"Never" nil
)
329 (integer :tag
"After N minutes")))
331 (defcustom org-clock-auto-clock-resolution
'when-no-clock-is-running
332 "When to automatically resolve open clocks found in Org buffers."
335 (const :tag
"Never" nil
)
336 (const :tag
"Always" t
)
337 (const :tag
"When no clock is running" when-no-clock-is-running
)))
339 (defcustom org-clock-report-include-clocking-task nil
340 "When non-nil, include the current clocking task time in clock reports."
345 (defcustom org-clock-resolve-expert nil
346 "Non-nil means do not show the splash buffer with the clock resolver."
351 (defcustom org-clock-continuously nil
352 "Non-nil means to start clocking from the last clock-out time, if any."
357 (defcustom org-clock-total-time-cell-format
"*%s*"
358 "Format string for the total time cells."
363 (defcustom org-clock-file-time-cell-format
"*%s*"
364 "Format string for the file time cells."
369 (defcustom org-clock-clocked-in-display
'mode-line
370 "When clocked in for a task, org-mode can display the current
371 task and accumulated time in the mode line and/or frame title.
374 both displays in both mode line and frame title
375 mode-line displays only in mode line (default)
376 frame-title displays only in frame title
377 nil current clock is not displayed"
380 (const :tag
"Mode line" mode-line
)
381 (const :tag
"Frame title" frame-title
)
382 (const :tag
"Both" both
)
383 (const :tag
"None" nil
)))
385 (defcustom org-clock-frame-title-format
'(t org-mode-line-string
)
386 "The value for `frame-title-format' when clocking in.
388 When `org-clock-clocked-in-display' is set to 'frame-title
389 or 'both, clocking in will replace `frame-title-format' with
390 this value. Clocking out will restore `frame-title-format'.
392 `org-frame-title-string' is a format string using the same
393 specifications than `frame-title-format', which see."
398 (defvar org-clock-in-prepare-hook nil
399 "Hook run when preparing the clock.
400 This hook is run before anything happens to the task that
401 you want to clock in. For example, you can use this hook
402 to add an effort property.")
403 (defvar org-clock-in-hook nil
404 "Hook run when starting the clock.")
405 (defvar org-clock-out-hook nil
406 "Hook run when stopping the current clock.")
408 (defvar org-clock-cancel-hook nil
409 "Hook run when cancelling the current clock.")
410 (defvar org-clock-goto-hook nil
411 "Hook run when selecting the currently clocked-in entry.")
412 (defvar org-clock-has-been-used nil
413 "Has the clock been used during the current Emacs session?")
415 ;;; The clock for measuring work time.
417 (defvar org-mode-line-string
"")
418 (put 'org-mode-line-string
'risky-local-variable t
)
420 (defvar org-clock-mode-line-timer nil
)
421 (defvar org-clock-idle-timer nil
)
422 (defvar org-clock-heading
) ; defined in org.el
423 (defvar org-clock-heading-for-remember
"")
424 (defvar org-clock-start-time
"")
426 (defvar org-clock-leftover-time nil
427 "If non-nil, user cancelled a clock; this is when leftover time started.")
429 (defvar org-clock-effort
""
430 "Effort estimate of the currently clocking task.")
432 (defvar org-clock-total-time nil
433 "Holds total time, spent previously on currently clocked item.
434 This does not include the time in the currently running clock.")
436 (defvar org-clock-history nil
437 "List of marker pointing to recent clocked tasks.")
439 (defvar org-clock-default-task
(make-marker)
440 "Marker pointing to the default task that should clock time.
441 The clock can be made to switch to this task after clocking out
442 of a different task.")
444 (defvar org-clock-interrupted-task
(make-marker)
445 "Marker pointing to the task that has been interrupted by the current clock.")
447 (defvar org-clock-mode-line-map
(make-sparse-keymap))
448 (define-key org-clock-mode-line-map
[mode-line mouse-2
] 'org-clock-goto
)
449 (define-key org-clock-mode-line-map
[mode-line mouse-1
] 'org-clock-menu
)
451 (defun org-clock-menu ()
455 ["Clock out" org-clock-out t
]
456 ["Change effort estimate" org-clock-modify-effort-estimate t
]
457 ["Go to clock entry" org-clock-goto t
]
458 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t
:keys
"C-u C-c C-x C-i"])))
460 (defun org-clock-history-push (&optional pos buffer
)
461 "Push a marker to the clock history."
462 (setq org-clock-history-length
(max 1 (min 35 org-clock-history-length
)))
463 (let ((m (move-marker (make-marker)
464 (or pos
(point)) (org-base-buffer
465 (or buffer
(current-buffer)))))
467 (while (setq n
(member m org-clock-history
))
468 (move-marker (car n
) nil
))
469 (setq org-clock-history
471 (mapcar (lambda (x) (if (marker-buffer x
) x nil
))
473 (when (>= (setq l
(length org-clock-history
)) org-clock-history-length
)
474 (setq org-clock-history
476 (nthcdr (- l org-clock-history-length -
1)
477 (nreverse org-clock-history
)))))
478 (push m org-clock-history
)))
480 (defun org-clock-save-markers-for-cut-and-paste (beg end
)
481 "Save relative positions of markers in region."
482 (org-check-and-save-marker org-clock-marker beg end
)
483 (org-check-and-save-marker org-clock-hd-marker beg end
)
484 (org-check-and-save-marker org-clock-default-task beg end
)
485 (org-check-and-save-marker org-clock-interrupted-task beg end
)
486 (mapc (lambda (m) (org-check-and-save-marker m beg end
))
489 (defun org-clocking-buffer ()
490 "Return the clocking buffer if we are currently clocking a task or nil."
491 (marker-buffer org-clock-marker
))
493 (defun org-clocking-p ()
494 "Return t when clocking a task."
495 (not (equal (org-clocking-buffer) nil
)))
497 (defvar org-clock-before-select-task-hook nil
498 "Hook called in task selection just before prompting the user.")
500 (defun org-clock-select-task (&optional prompt
)
501 "Select a task that recently was associated with clocking."
503 (let (sel-list rpl
(i 0) s
)
504 (save-window-excursion
505 (org-switch-to-buffer-other-window
506 (get-buffer-create "*Clock Task Select*"))
508 (when (marker-buffer org-clock-default-task
)
509 (insert (org-add-props "Default Task\n" nil
'face
'bold
))
510 (setq s
(org-clock-insert-selection-line ?d org-clock-default-task
))
512 (when (marker-buffer org-clock-interrupted-task
)
513 (insert (org-add-props "The task interrupted by starting the last one\n" nil
'face
'bold
))
514 (setq s
(org-clock-insert-selection-line ?i org-clock-interrupted-task
))
516 (when (org-clocking-p)
517 (insert (org-add-props "Current Clocking Task\n" nil
'face
'bold
))
518 (setq s
(org-clock-insert-selection-line ?c org-clock-marker
))
520 (insert (org-add-props "Recent Tasks\n" nil
'face
'bold
))
523 (when (marker-buffer m
)
525 s
(org-clock-insert-selection-line
529 (if (fboundp 'int-to-char
) (setf (car s
) (int-to-char (car s
))))
532 (run-hooks 'org-clock-before-select-task-hook
)
533 (org-fit-window-to-buffer)
534 (message (or prompt
"Select task for clocking:"))
535 (setq rpl
(read-char-exclusive))
539 ((assoc rpl sel-list
) (cdr (assoc rpl sel-list
)))
540 (t (error "Invalid task choice %c" rpl
))))))
542 (defun org-clock-insert-selection-line (i marker
)
543 "Insert a line for the clock selection menu.
544 And return a cons cell with the selection character integer and the marker
546 (when (marker-buffer marker
)
547 (let (file cat task heading prefix
)
548 (with-current-buffer (org-base-buffer (marker-buffer marker
))
554 (setq file
(buffer-file-name (marker-buffer marker
))
555 cat
(org-get-category)
556 heading
(org-get-heading 'notags
)
557 prefix
(save-excursion
558 (org-back-to-heading t
)
559 (looking-at org-outline-regexp
)
562 (org-fontify-like-in-org-mode
563 (concat prefix heading
)
565 (length prefix
)))))))
567 (insert (format "[%c] %-15s %s\n" i cat task
))
570 (defvar org-clock-task-overrun nil
571 "Internal flag indicating if the clock has overrun the planned time.")
572 (defvar org-clock-update-period
60
573 "Number of seconds between mode line clock string updates.")
575 (defun org-clock-get-clock-string ()
576 "Form a clock-string, that will be shown in the mode line.
577 If an effort estimate was defined for the current item, use
578 01:30/01:50 format (clocked/estimated).
579 If not, show simply the clocked time like 01:50."
580 (let ((clocked-time (org-clock-get-clocked-time)))
582 (let* ((effort-in-minutes
583 (org-duration-string-to-minutes org-clock-effort
))
586 (org-minutes-to-clocksum-string clocked-time
)
587 'face
(if (and org-clock-task-overrun
(not org-clock-task-overrun-text
))
588 'org-mode-line-clock-overrun
'org-mode-line-clock
)))
589 (effort-str (org-minutes-to-clocksum-string effort-in-minutes
))
590 (clockstr (org-propertize
591 (concat " [%s/" effort-str
592 "] (" (replace-regexp-in-string "%" "%%" org-clock-heading
) ")")
593 'face
'org-mode-line-clock
)))
594 (format clockstr work-done-str
))
595 (org-propertize (concat "[" (org-minutes-to-clocksum-string clocked-time
)
596 (format " (%s)" org-clock-heading
) "]")
597 'face
'org-mode-line-clock
))))
599 (defun org-clock-get-last-clock-out-time ()
600 "Get the last clock-out time for the current subtree."
602 (let ((end (save-excursion (org-end-of-subtree))))
603 (when (re-search-forward (concat org-clock-string
604 ".*\\]--\\(\\[[^]]+\\]\\)") end t
)
605 (org-time-string-to-time (match-string 1))))))
607 (defun org-clock-update-mode-line ()
609 (org-clock-notify-once-if-expired)
610 (setq org-clock-task-overrun nil
))
611 (setq org-mode-line-string
613 (let ((clock-string (org-clock-get-clock-string))
614 (help-text "Org-mode clock is running.\nmouse-1 shows a menu\nmouse-2 will jump to task"))
615 (if (and (> org-clock-string-limit
0)
616 (> (length clock-string
) org-clock-string-limit
))
618 (substring clock-string
0 org-clock-string-limit
)
619 'help-echo
(concat help-text
": " org-clock-heading
))
620 (org-propertize clock-string
'help-echo help-text
)))
621 'local-map org-clock-mode-line-map
622 'mouse-face
(if (featurep 'xemacs
) 'highlight
'mode-line-highlight
)))
623 (if (and org-clock-task-overrun org-clock-task-overrun-text
)
624 (setq org-mode-line-string
625 (concat (org-propertize
626 org-clock-task-overrun-text
627 'face
'org-mode-line-clock-overrun
) org-mode-line-string
)))
628 (force-mode-line-update))
630 (defun org-clock-get-clocked-time ()
631 "Get the clocked time for the current item in minutes.
632 The time returned includes the time spent on this task in
633 previous clocking intervals."
634 (let ((currently-clocked-time
635 (floor (- (org-float-time)
636 (org-float-time org-clock-start-time
)) 60)))
637 (+ currently-clocked-time
(or org-clock-total-time
0))))
639 (defun org-clock-modify-effort-estimate (&optional value
)
640 "Add to or set the effort estimate of the item currently being clocked.
641 VALUE can be a number of minutes, or a string with format hh:mm or mm.
642 When the string starts with a + or a - sign, the current value of the effort
643 property will be changed by that amount.
644 This will update the \"Effort\" property of currently clocked item, and
647 (if (org-clock-is-active)
648 (let ((current org-clock-effort
) sign
)
650 ;; Prompt user for a value or a change
653 (format "Set effort (hh:mm or mm%s): "
655 (format ", prefix + to add to %s" org-clock-effort
)
657 (when (stringp value
)
658 ;; A string. See if it is a delta
659 (setq sign
(string-to-char value
))
660 (if (member sign
'(?- ?
+))
661 (setq current
(org-duration-string-to-minutes current
)
662 value
(substring value
1))
664 (setq value
(org-duration-string-to-minutes value
))
666 (setq value
(- current value
))
667 (if (equal ?
+ sign
) (setq value
(+ current value
)))))
668 (setq value
(max 0 value
)
669 org-clock-effort
(org-minutes-to-clocksum-string value
))
670 (org-entry-put org-clock-marker
"Effort" org-clock-effort
)
671 (org-clock-update-mode-line)
672 (message "Effort is now %s" org-clock-effort
))
673 (message "Clock is not currently active")))
675 (defvar org-clock-notification-was-shown nil
676 "Shows if we have shown notification already.")
678 (defun org-clock-notify-once-if-expired ()
679 "Show notification if we spent more time than we estimated before.
680 Notification is shown only once."
681 (when (org-clocking-p)
682 (let ((effort-in-minutes (org-duration-string-to-minutes org-clock-effort
))
683 (clocked-time (org-clock-get-clocked-time)))
684 (if (setq org-clock-task-overrun
685 (if (or (null effort-in-minutes
) (zerop effort-in-minutes
))
687 (>= clocked-time effort-in-minutes
)))
688 (unless org-clock-notification-was-shown
689 (setq org-clock-notification-was-shown t
)
691 (format "Task '%s' should be finished by now. (%s)"
692 org-clock-heading org-clock-effort
) t
))
693 (setq org-clock-notification-was-shown nil
)))))
695 (defun org-notify (notification &optional play-sound
)
696 "Send a NOTIFICATION and maybe PLAY-SOUND.
697 If PLAY-SOUND is non-nil, it overrides `org-clock-sound'."
698 (org-show-notification notification
)
699 (if play-sound
(org-clock-play-sound play-sound
)))
701 (defun org-show-notification (notification)
703 Use `org-show-notification-handler' if defined,
704 use libnotify if available, or fall back on a message."
705 (cond ((functionp org-show-notification-handler
)
706 (funcall org-show-notification-handler notification
))
707 ((stringp org-show-notification-handler
)
708 (start-process "emacs-timer-notification" nil
709 org-show-notification-handler notification
))
710 ((fboundp 'notifications-notify
)
711 (notifications-notify
712 :title
"Org-mode message"
714 ;; FIXME how to link to the Org icon?
715 ;; :app-icon "~/.emacs.d/icons/mail.png"
717 ((executable-find "notify-send")
718 (start-process "emacs-timer-notification" nil
719 "notify-send" notification
))
720 ;; Maybe the handler will send a message, so only use message as
721 ;; a fall back option
722 (t (message "%s" notification
))))
724 (defun org-clock-play-sound (&optional clock-sound
)
725 "Play sound as configured by `org-clock-sound'.
726 Use alsa's aplay tool if available.
727 If CLOCK-SOUND is non-nil, it overrides `org-clock-sound'."
728 (let ((org-clock-sound (or clock-sound org-clock-sound
)))
730 ((not org-clock-sound
))
731 ((eq org-clock-sound t
) (beep t
) (beep t
))
732 ((stringp org-clock-sound
)
733 (let ((file (expand-file-name org-clock-sound
)))
734 (if (file-exists-p file
)
735 (if (executable-find "aplay")
736 (start-process "org-clock-play-notification" nil
739 (play-sound-file file
)
740 (error (beep t
) (beep t
))))))))))
742 (defvar org-clock-mode-line-entry nil
743 "Information for the mode line about the running clock.")
745 (defun org-find-open-clocks (file)
746 "Search through the given file and find all open clocks."
747 (let ((buf (or (get-file-buffer file
)
748 (find-file-noselect file
)))
750 (with-current-buffer buf
752 (goto-char (point-min))
753 (while (re-search-forward "CLOCK: \\(\\[.*?\\]\\)$" nil t
)
754 (push (cons (copy-marker (match-end 1) t
)
755 (org-time-string-to-time (match-string 1))) clocks
))))
758 (defsubst org-is-active-clock
(clock)
759 "Return t if CLOCK is the currently active clock."
760 (and (org-clock-is-active)
761 (= org-clock-marker
(car clock
))))
763 (defmacro org-with-clock-position
(clock &rest forms
)
764 "Evaluate FORMS with CLOCK as the current active clock."
765 `(with-current-buffer (marker-buffer (car ,clock
))
769 (goto-char (car ,clock
))
772 (def-edebug-spec org-with-clock-position
(form body
))
773 (put 'org-with-clock-position
'lisp-indent-function
1)
775 (defmacro org-with-clock
(clock &rest forms
)
776 "Evaluate FORMS with CLOCK as the current active clock.
777 This macro also protects the current active clock from being altered."
778 `(org-with-clock-position ,clock
779 (let ((org-clock-start-time (cdr ,clock
))
780 (org-clock-total-time)
783 (org-clock-marker (car ,clock
))
784 (org-clock-hd-marker (save-excursion
785 (outline-back-to-heading t
)
788 (def-edebug-spec org-with-clock
(form body
))
789 (put 'org-with-clock
'lisp-indent-function
1)
791 (defsubst org-clock-clock-in
(clock &optional resume start-time
)
792 "Clock in to the clock located by CLOCK.
793 If necessary, clock-out of the currently active clock."
794 (org-with-clock-position clock
795 (let ((org-clock-in-resume (or resume org-clock-in-resume
)))
796 (org-clock-in nil start-time
))))
798 (defsubst org-clock-clock-out
(clock &optional fail-quietly at-time
)
799 "Clock out of the clock located by CLOCK."
800 (let ((temp (copy-marker (car clock
)
801 (marker-insertion-type (car clock
)))))
802 (if (org-is-active-clock clock
)
803 (org-clock-out nil fail-quietly at-time
)
804 (org-with-clock clock
805 (org-clock-out nil fail-quietly at-time
)))
806 (setcar clock temp
)))
808 (defsubst org-clock-clock-cancel
(clock)
809 "Cancel the clock located by CLOCK."
810 (let ((temp (copy-marker (car clock
)
811 (marker-insertion-type (car clock
)))))
812 (if (org-is-active-clock clock
)
814 (org-with-clock clock
816 (setcar clock temp
)))
818 (defvar org-clock-clocking-in nil
)
819 (defvar org-clock-resolving-clocks nil
)
820 (defvar org-clock-resolving-clocks-due-to-idleness nil
)
822 (defun org-clock-resolve-clock (clock resolve-to clock-out-time
823 &optional close-p restart-p fail-quietly
)
824 "Resolve `CLOCK' given the time `RESOLVE-TO', and the present.
825 `CLOCK' is a cons cell of the form (MARKER START-TIME)."
826 (let ((org-clock-resolving-clocks t
))
829 (org-clock-clock-cancel clock
)
830 (if (and restart-p
(not org-clock-clocking-in
))
831 (org-clock-clock-in clock
)))
833 ((eq resolve-to
'now
)
835 (error "RESTART-P is not valid here"))
836 (if (or close-p org-clock-clocking-in
)
837 (org-clock-clock-out clock fail-quietly
)
838 (unless (org-is-active-clock clock
)
839 (org-clock-clock-in clock t
))))
841 ((not (time-less-p resolve-to
(current-time)))
842 (error "RESOLVE-TO must refer to a time in the past"))
846 (error "RESTART-P is not valid here"))
847 (org-clock-clock-out clock fail-quietly
(or clock-out-time
849 (unless org-clock-clocking-in
851 (setq org-clock-leftover-time
(and (null clock-out-time
)
853 (org-clock-clock-in clock nil
(and clock-out-time
856 (defun org-clock-jump-to-current-clock (&optional effective-clock
)
858 (let ((org-clock-into-drawer (org-clock-into-drawer))
859 (clock (or effective-clock
(cons org-clock-marker
860 org-clock-start-time
))))
861 (unless (marker-buffer (car clock
))
862 (error "No clock is currently running"))
863 (org-with-clock clock
(org-clock-goto))
864 (with-current-buffer (marker-buffer (car clock
))
865 (goto-char (car clock
))
866 (if org-clock-into-drawer
868 (if (stringp org-clock-into-drawer
)
869 (concat ":" org-clock-into-drawer
":")
874 (outline-back-to-heading t
)
875 (search-forward logbook
)
876 (goto-char (match-beginning 0)))
878 (outline-back-to-heading t
)
879 (search-forward logbook
)
880 (search-forward ":END:")
881 (goto-char (match-end 0)))
884 (defun org-clock-resolve (clock &optional prompt-fn last-valid fail-quietly
)
885 "Resolve an open org-mode clock.
886 An open clock was found, with `dangling' possibly being non-nil.
887 If this function was invoked with a prefix argument, non-dangling
888 open clocks are ignored. The given clock requires some sort of
889 user intervention to resolve it, either because a clock was left
890 dangling or due to an idle timeout. The clock resolution can
893 (a) deleted, the user doesn't care about the clock
894 (b) restarted from the current time (if no other clock is open)
895 (c) closed, giving the clock X minutes
896 (d) closed and then restarted
897 (e) resumed, as if the user had never left
899 The format of clock is (CONS MARKER START-TIME), where MARKER
900 identifies the buffer and position the clock is open at (and
901 thus, the heading it's under), and START-TIME is when the clock
905 (save-window-excursion
907 (unless org-clock-resolving-clocks-due-to-idleness
908 (org-clock-jump-to-current-clock clock
))
909 (unless org-clock-resolve-expert
910 (with-output-to-temp-buffer "*Org Clock*"
911 (princ "Select a Clock Resolution Command:
913 i/q/C-g Ignore this question; the same as keeping all the idle time.
915 k/K Keep X minutes of the idle time (default is all). If this
916 amount is less than the default, you will be clocked out
917 that many minutes after the time that idling began, and then
918 clocked back in at the present time.
919 g/G Indicate that you \"got back\" X minutes ago. This is quite
920 different from 'k': it clocks you out from the beginning of
921 the idle period and clock you back in X minutes ago.
922 s/S Subtract the idle time from the current clock. This is the
923 same as keeping 0 minutes.
924 C Cancel the open timer altogether. It will be as though you
926 j/J Jump to the current clock, to make manual adjustments.
928 For all these options, using uppercase makes your final state
929 to be CLOCKED OUT.")))
930 (org-fit-window-to-buffer (get-buffer-window "*Org Clock*"))
932 (when (featurep 'xemacs
)
933 (message (concat (funcall prompt-fn clock
)
935 (setq char-pressed
(read-char-exclusive)))
936 (while (or (null char-pressed
)
937 (and (not (memq char-pressed
938 '(?k ?K ?g ?G ?s ?S ?C
942 (read-char (concat (funcall prompt-fn clock
)
945 (and (not (memq char-pressed
'(?i ?q
))) char-pressed
)))))
947 (floor (/ (org-float-time
948 (time-subtract (current-time) last-valid
)) 60)))
950 (and (memq ch
'(?k ?K
))
951 (read-number "Keep how many minutes? " default
)))
953 (and (memq ch
'(?g ?G
))
954 (read-number "Got back how many minutes ago? " default
)))
955 (subtractp (memq ch
'(?s ?S
)))
956 (barely-started-p (< (- (org-float-time last-valid
)
957 (org-float-time (cdr clock
))) 45))
958 (start-over (and subtractp barely-started-p
)))
962 (org-clock-resolve-clock clock
'now nil t nil fail-quietly
))
963 (org-clock-jump-to-current-clock clock
))
965 (not (memq ch
'(?k ?K ?g ?G ?s ?S ?C
))))
968 (org-clock-resolve-clock
971 ;; If the time on the clock was less than a minute before
972 ;; the user went away, and they've ask to subtract all the
977 (and gotback
(= gotback
0)))
979 ((or (and keep
(= keep default
))
980 (and gotback
(= gotback default
)))
983 (time-add last-valid
(seconds-to-time (* 60 keep
))))
985 (time-subtract (current-time)
986 (seconds-to-time (* 60 gotback
))))
988 (error "Unexpected, please report this as a bug")))
989 (and gotback last-valid
)
990 (memq ch
'(?K ?G ?S
))
992 (not (memq ch
'(?K ?G ?S ?C
))))
996 (defun org-resolve-clocks (&optional only-dangling-p prompt-fn last-valid
)
997 "Resolve all currently open org-mode clocks.
998 If `only-dangling-p' is non-nil, only ask to resolve dangling
999 \(i.e., not currently open and valid) clocks."
1001 (unless org-clock-resolving-clocks
1002 (let ((org-clock-resolving-clocks t
))
1003 (dolist (file (org-files-list))
1004 (let ((clocks (org-find-open-clocks file
)))
1005 (dolist (clock clocks
)
1006 (let ((dangling (or (not (org-clock-is-active))
1007 (/= (car clock
) org-clock-marker
))))
1008 (if (or (not only-dangling-p
) dangling
)
1015 "Dangling clock started %d mins ago"
1017 (/ (- (org-float-time (current-time))
1018 (org-float-time (cdr clock
))) 60))))))
1020 (cdr clock
)))))))))))
1022 (defun org-emacs-idle-seconds ()
1023 "Return the current Emacs idle time in seconds, or nil if not idle."
1024 (let ((idle-time (current-idle-time)))
1026 (org-float-time idle-time
)
1029 (defun org-mac-idle-seconds ()
1030 "Return the current Mac idle time in seconds."
1031 (string-to-number (shell-command-to-string "ioreg -c IOHIDSystem | perl -ane 'if (/Idle/) {$idle=(pop @F)/1000000000; print $idle; last}'")))
1033 (defvar org-x11idle-exists-p
1034 ;; Check that x11idle exists
1035 (and (eq window-system
'x
)
1036 (eq (call-process-shell-command "command" nil nil nil
"-v" "x11idle") 0)
1037 ;; Check that x11idle can retrieve the idle time
1038 (eq (call-process-shell-command "x11idle" nil nil nil
) 0)))
1040 (defun org-x11-idle-seconds ()
1041 "Return the current X11 idle time in seconds."
1042 (/ (string-to-number (shell-command-to-string "x11idle")) 1000))
1044 (defun org-user-idle-seconds ()
1045 "Return the number of seconds the user has been idle for.
1046 This routine returns a floating point number."
1048 ((eq system-type
'darwin
)
1049 (org-mac-idle-seconds))
1050 ((and (eq window-system
'x
) org-x11idle-exists-p
)
1051 (org-x11-idle-seconds))
1053 (org-emacs-idle-seconds))))
1055 (defvar org-clock-user-idle-seconds
)
1057 (defun org-resolve-clocks-if-idle ()
1058 "Resolve all currently open org-mode clocks.
1059 This is performed after `org-clock-idle-time' minutes, to check
1060 if the user really wants to stay clocked in after being idle for
1062 (when (and org-clock-idle-time
(not org-clock-resolving-clocks
)
1064 (let* ((org-clock-user-idle-seconds (org-user-idle-seconds))
1065 (org-clock-user-idle-start
1066 (time-subtract (current-time)
1067 (seconds-to-time org-clock-user-idle-seconds
)))
1068 (org-clock-resolving-clocks-due-to-idleness t
))
1069 (if (> org-clock-user-idle-seconds
(* 60 org-clock-idle-time
))
1071 (cons org-clock-marker
1072 org-clock-start-time
)
1075 (format "Clocked in & idle for %.1f mins"
1077 (time-subtract (current-time)
1078 org-clock-user-idle-start
))
1080 org-clock-user-idle-start
)))))
1082 (defvar org-clock-current-task nil
1083 "Task currently clocked in.")
1084 (defun org-clock-set-current ()
1085 "Set `org-clock-current-task' to the task currently clocked in."
1086 (setq org-clock-current-task
(nth 4 (org-heading-components))))
1088 (defun org-clock-delete-current ()
1089 "Reset `org-clock-current-task' to nil."
1090 (setq org-clock-current-task nil
))
1092 (defvar org-clock-out-time nil
) ; store the time of the last clock-out
1095 (defun org-clock-in (&optional select start-time
)
1096 "Start the clock on the current item.
1097 If necessary, clock-out of the currently active clock.
1098 With a prefix argument SELECT (\\[universal-argument]), offer a list of recently clocked
1099 tasks to clock into. When SELECT is \\[universal-argument] \\[universal-argument], clock into the current task
1100 and mark it as the default task, a special task that will always be offered
1101 in the clocking selection, associated with the letter `d'.
1102 When SELECT is \\[universal-argument] \\[universal-argument] \\[universal-argument], \
1103 clock in by using the last clock-out
1104 time as the start time \(see `org-clock-continuously' to
1105 make this the default behavior.)"
1107 (setq org-clock-notification-was-shown nil
)
1109 (let ((interrupting (and (not org-clock-resolving-clocks-due-to-idleness
)
1111 ts selected-task target-pos
(msg-extra "")
1112 (leftover (and (not org-clock-resolving-clocks
)
1113 org-clock-leftover-time
)))
1115 (when (and org-clock-auto-clock-resolution
1116 (or (not interrupting
)
1117 (eq t org-clock-auto-clock-resolution
))
1118 (not org-clock-clocking-in
)
1119 (not org-clock-resolving-clocks
))
1120 (setq org-clock-leftover-time nil
)
1121 (let ((org-clock-clocking-in t
))
1122 (org-resolve-clocks))) ; check if any clocks are dangling
1124 (when (equal select
'(64))
1125 ;; Set start-time to `org-clock-out-time'
1126 (let ((org-clock-continuously t
))
1127 (org-clock-in nil org-clock-out-time
)))
1129 (when (equal select
'(4))
1130 (setq selected-task
(org-clock-select-task "Clock-in on task: "))
1132 (setq selected-task
(copy-marker selected-task
))
1135 (when (equal select
'(16))
1136 ;; Mark as default clocking task
1137 (org-clock-mark-default-task))
1140 ;; We are interrupting the clocking of a different task.
1141 ;; Save a marker to this task, so that we can go back.
1142 ;; First check if we are trying to clock into the same task!
1143 (when (save-excursion
1144 (unless selected-task
1145 (org-back-to-heading t
))
1146 (and (equal (marker-buffer org-clock-hd-marker
)
1148 (marker-buffer selected-task
)
1150 (= (marker-position org-clock-hd-marker
)
1152 (marker-position selected-task
)
1154 (equal org-clock-current-task
(nth 4 (org-heading-components)))))
1155 (message "Clock continues in \"%s\"" org-clock-heading
)
1157 (move-marker org-clock-interrupted-task
1158 (marker-position org-clock-marker
)
1159 (marker-buffer org-clock-marker
))
1160 (let ((org-clock-clocking-in t
))
1161 (org-clock-out nil t
)))
1163 ;; Clock in at which position?
1165 (if (and (eobp) (not (org-at-heading-p)))
1169 (when (and selected-task
(marker-buffer selected-task
))
1170 ;; There is a selected task, move to the correct buffer
1171 ;; and set the new target position.
1172 (set-buffer (org-base-buffer (marker-buffer selected-task
)))
1173 (setq target-pos
(marker-position selected-task
))
1174 (move-marker selected-task nil
))
1178 (goto-char target-pos
)
1179 (org-back-to-heading t
)
1180 (or interrupting
(move-marker org-clock-interrupted-task nil
))
1182 (forward-char) ;; make sure the marker is not at the
1183 ;; beginning of the heading, since the
1184 ;; user is liking to insert stuff here
1186 (run-hooks 'org-clock-in-prepare-hook
)
1187 (org-clock-history-push))
1188 (org-clock-set-current)
1189 (cond ((functionp org-clock-in-switch-to-state
)
1190 (looking-at org-complex-heading-regexp
)
1191 (let ((newstate (funcall org-clock-in-switch-to-state
1193 (if newstate
(org-todo newstate
))))
1194 ((and org-clock-in-switch-to-state
1195 (not (looking-at (concat org-outline-regexp
"[ \t]*"
1196 org-clock-in-switch-to-state
1198 (org-todo org-clock-in-switch-to-state
)))
1199 (setq org-clock-heading-for-remember
1200 (and (looking-at org-complex-heading-regexp
)
1202 (org-trim (buffer-substring (match-end 1)
1204 (setq org-clock-heading
1205 (cond ((and org-clock-heading-function
1206 (functionp org-clock-heading-function
))
1207 (funcall org-clock-heading-function
))
1208 ((and (looking-at org-complex-heading-regexp
)
1210 (replace-regexp-in-string
1211 "\\[\\[.*?\\]\\[\\(.*?\\)\\]\\]" "\\1"
1214 (setq org-clock-heading
(org-propertize org-clock-heading
1216 (org-clock-find-position org-clock-in-resume
)
1218 ((and org-clock-in-resume
1220 (concat "^[ \t]*" org-clock-string
1221 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1222 " *\\sw+\.? +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
1223 (message "Matched %s" (match-string 1))
1224 (setq ts
(concat "[" (match-string 1) "]"))
1225 (goto-char (match-end 1))
1226 (setq org-clock-start-time
1228 (org-parse-time-string (match-string 1))))
1229 (setq org-clock-effort
(org-get-effort))
1230 (setq org-clock-total-time
(org-clock-sum-current-item
1231 (org-clock-get-sum-start))))
1232 ((eq org-clock-in-resume
'auto-restart
)
1233 ;; called from org-clock-load during startup,
1234 ;; do not interrupt, but warn!
1235 (message "Cannot restart clock because task does not contain unfinished clock")
1240 (insert-before-markers "\n")
1243 (when (and (save-excursion
1246 (beginning-of-line 1)
1247 (org-indent-line-to (- (org-get-indentation) 2)))
1248 (insert org-clock-string
" ")
1249 (setq org-clock-effort
(org-get-effort))
1250 (setq org-clock-total-time
(org-clock-sum-current-item
1251 (org-clock-get-sum-start)))
1252 (setq org-clock-start-time
1253 (or (and org-clock-continuously org-clock-out-time
)
1257 "You stopped another clock %d mins ago; start this one from then? "
1258 (/ (- (org-float-time
1259 (org-current-time org-clock-rounding-minutes
))
1260 (org-float-time leftover
)) 60)))
1263 (org-current-time org-clock-rounding-minutes
)))
1264 (setq ts
(org-insert-time-stamp org-clock-start-time
1265 'with-hm
'inactive
))))
1266 (move-marker org-clock-marker
(point) (buffer-base-buffer))
1267 (move-marker org-clock-hd-marker
1268 (save-excursion (org-back-to-heading t
) (point))
1269 (buffer-base-buffer))
1270 (setq org-clock-has-been-used t
)
1272 (when (or (eq org-clock-clocked-in-display
'mode-line
)
1273 (eq org-clock-clocked-in-display
'both
))
1274 (or global-mode-string
(setq global-mode-string
'("")))
1275 (or (memq 'org-mode-line-string global-mode-string
)
1276 (setq global-mode-string
1277 (append global-mode-string
'(org-mode-line-string)))))
1278 ;; add to frame title
1279 (when (or (eq org-clock-clocked-in-display
'frame-title
)
1280 (eq org-clock-clocked-in-display
'both
))
1281 (setq frame-title-format org-clock-frame-title-format
))
1282 (org-clock-update-mode-line)
1283 (when org-clock-mode-line-timer
1284 (cancel-timer org-clock-mode-line-timer
)
1285 (setq org-clock-mode-line-timer nil
))
1286 (when org-clock-clocked-in-display
1287 (setq org-clock-mode-line-timer
1288 (run-with-timer org-clock-update-period
1289 org-clock-update-period
1290 'org-clock-update-mode-line
)))
1291 (when org-clock-idle-timer
1292 (cancel-timer org-clock-idle-timer
)
1293 (setq org-clock-idle-timer nil
))
1294 (setq org-clock-idle-timer
1295 (run-with-timer 60 60 'org-resolve-clocks-if-idle
))
1296 (message "Clock starts at %s - %s" ts msg-extra
)
1297 (run-hooks 'org-clock-in-hook
)))))))
1300 (defun org-clock-in-last (&optional arg
)
1301 "Clock in the last closed clocked item.
1302 When already clocking in, send an warning.
1303 With a universal prefix argument, select the task you want to
1304 clock in from the last clocked in tasks.
1305 With two universal prefix arguments, start clocking using the
1306 last clock-out time, if any.
1307 With three universal prefix arguments, interactively prompt
1308 for a todo state to switch to, overriding the existing value
1309 `org-clock-in-switch-to-state'."
1311 (if (equal arg
'(4))
1312 (org-clock-in (org-clock-select-task))
1313 (let ((start-time (if (or org-clock-continuously
(equal arg
'(16)))
1314 (or org-clock-out-time
1315 (org-current-time org-clock-rounding-minutes
))
1316 (org-current-time org-clock-rounding-minutes
))))
1317 (if (null org-clock-history
)
1318 (message "No last clock")
1319 (let ((org-clock-in-switch-to-state
1320 (if (and (not org-clock-current-task
) (equal arg
'(64)))
1321 (completing-read "Switch to state: "
1322 (and org-clock-history
1323 (with-current-buffer
1324 (marker-buffer (car org-clock-history
))
1325 org-todo-keywords-1
)))
1326 org-clock-in-switch-to-state
))
1327 (already-clocking org-clock-current-task
))
1328 (org-clock-clock-in (list (car org-clock-history
)) nil start-time
)
1329 (or already-clocking
1330 ;; Don't display a message if we are already clocking in
1331 (message "Clocking back: %s (in %s)"
1332 org-clock-current-task
1333 (buffer-name (marker-buffer org-clock-marker
)))))))))
1335 (defun org-clock-mark-default-task ()
1336 "Mark current task as default task."
1339 (org-back-to-heading t
)
1340 (move-marker org-clock-default-task
(point))))
1343 (defun org-clock-get-sum-start ()
1344 "Return the time from which clock times should be counted.
1345 This is for the currently running clock as it is displayed
1346 in the mode line. This function looks at the properties
1347 LAST_REPEAT and in particular CLOCK_MODELINE_TOTAL and the
1348 corresponding variable `org-clock-mode-line-total' and then
1349 decides which time to use."
1350 (let ((cmt (or (org-entry-get nil
"CLOCK_MODELINE_TOTAL")
1351 (symbol-name org-clock-mode-line-total
)))
1352 (lr (org-entry-get nil
"LAST_REPEAT")))
1354 ((equal cmt
"current")
1355 (setq msg-extra
"showing time in current clock instance")
1357 ((equal cmt
"today")
1358 (setq msg-extra
"showing today's task time.")
1359 (let* ((dt (decode-time (current-time))))
1360 (setq dt
(append (list 0 0 0) (nthcdr 3 dt
)))
1361 (if org-extend-today-until
1362 (setf (nth 2 dt
) org-extend-today-until
))
1363 (apply 'encode-time dt
)))
1364 ((or (equal cmt
"all")
1365 (and (or (not cmt
) (equal cmt
"auto"))
1367 (setq msg-extra
"showing entire task time.")
1369 ((or (equal cmt
"repeat")
1370 (and (or (not cmt
) (equal cmt
"auto"))
1372 (setq msg-extra
"showing task time since last repeat.")
1375 (org-time-string-to-time lr
)))
1378 (defun org-clock-find-position (find-unclosed)
1379 "Find the location where the next clock line should be inserted.
1380 When FIND-UNCLOSED is non-nil, first check if there is an unclosed clock
1381 line and position cursor in that line."
1382 (org-back-to-heading t
)
1384 (let* ((org-clock-into-drawer (org-clock-into-drawer))
1385 (beg (save-excursion
1386 (beginning-of-line 2)
1387 (or (bolp) (newline))
1389 (end (progn (outline-next-heading) (point)))
1390 (re (concat "^[ \t]*" org-clock-string
))
1392 (drawer (if (stringp org-clock-into-drawer
)
1393 org-clock-into-drawer
"LOGBOOK"))
1394 first last ind-last
)
1396 (when (and find-unclosed
1398 (concat "^[ \t]*" org-clock-string
1399 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1400 " *\\sw+ +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")
1402 (beginning-of-line 1)
1404 (when (eobp) (newline) (setq end
(max (point) end
)))
1405 (when (re-search-forward (concat "^[ \t]*:" drawer
":") end t
)
1406 ;; we seem to have a CLOCK drawer, so go there.
1407 (beginning-of-line 2)
1408 (or org-log-states-order-reversed
1409 (and (re-search-forward org-property-end-re nil t
)
1410 (goto-char (match-beginning 0))))
1412 ;; Lets count the CLOCK lines
1414 (while (re-search-forward re end t
)
1415 (setq first
(or first
(match-beginning 0))
1416 last
(match-beginning 0)
1418 (when (and (integerp org-clock-into-drawer
)
1420 (>= (1+ cnt
) org-clock-into-drawer
))
1421 ;; Wrap current entries into a new drawer
1423 (setq ind-last
(org-get-indentation))
1424 (beginning-of-line 2)
1425 (if (and (>= (org-get-indentation) ind-last
)
1427 (when (and (>= (org-get-indentation) ind-last
)
1429 (let ((struct (org-list-struct)))
1430 (goto-char (org-list-get-bottom-point struct
)))))
1432 (beginning-of-line 0)
1433 (org-indent-line-to ind-last
)
1435 (insert ":" drawer
":\n")
1436 (beginning-of-line 0)
1439 (beginning-of-line 2)
1440 (or org-log-states-order-reversed
1441 (and (re-search-forward org-property-end-re nil t
)
1442 (goto-char (match-beginning 0))))
1446 (while (and (looking-at (concat "[ \t]*" org-keyword-time-regexp
))
1447 (not (equal (match-string 1) org-clock-string
)))
1448 ;; Planning info, skip to after it
1449 (beginning-of-line 2)
1450 (or (bolp) (newline)))
1451 (when (or (eq org-clock-into-drawer t
)
1452 (stringp org-clock-into-drawer
)
1453 (and (integerp org-clock-into-drawer
)
1454 (< org-clock-into-drawer
2)))
1455 (insert ":" drawer
":\n:END:\n")
1456 (beginning-of-line -
1)
1459 (beginning-of-line 2)
1462 (or org-log-states-order-reversed
1463 (and (re-search-forward org-property-end-re nil t
)
1464 (goto-char (match-beginning 0))))))))
1467 (defun org-clock-out (&optional switch-to-state fail-quietly at-time
)
1468 "Stop the currently running clock.
1469 Throw an error if there is no running clock and FAIL-QUIETLY is nil.
1470 With a universal prefix, prompt for a state to switch the clocked out task
1471 to, overriding the existing value of `org-clock-out-switch-to-state'."
1474 (when (not (org-clocking-p))
1475 (setq global-mode-string
1476 (delq 'org-mode-line-string global-mode-string
))
1477 (setq frame-title-format org-frame-title-format-backup
)
1478 (force-mode-line-update)
1479 (if fail-quietly
(throw 'exit t
) (user-error "No active clock")))
1480 (let ((org-clock-out-switch-to-state
1482 (completing-read "Switch to state: "
1483 (with-current-buffer
1484 (marker-buffer org-clock-marker
)
1485 org-todo-keywords-1
)
1487 org-clock-out-switch-to-state
))
1488 (now (org-current-time org-clock-rounding-minutes
))
1490 (setq org-clock-out-time now
)
1491 (save-excursion ; Do not replace this with `with-current-buffer'.
1492 (org-no-warnings (set-buffer (org-clocking-buffer)))
1495 (goto-char org-clock-marker
)
1496 (beginning-of-line 1)
1497 (if (and (looking-at (concat "[ \t]*" org-keyword-time-regexp
))
1498 (equal (match-string 1) org-clock-string
))
1499 (setq ts
(match-string 2))
1500 (if fail-quietly
(throw 'exit nil
) (error "Clock start time is gone")))
1501 (goto-char (match-end 0))
1502 (delete-region (point) (point-at-eol))
1504 (setq te
(org-insert-time-stamp (or at-time now
) 'with-hm
'inactive
))
1505 (setq s
(- (org-float-time (apply 'encode-time
(org-parse-time-string te
)))
1506 (org-float-time (apply 'encode-time
(org-parse-time-string ts
))))
1507 h
(floor (/ s
3600))
1511 (insert " => " (format "%2d:%02d" h m
))
1512 (when (setq remove
(and org-clock-out-remove-zero-time-clocks
1514 (beginning-of-line 1)
1515 (delete-region (point) (point-at-eol))
1516 (and (looking-at "\n") (> (point-max) (1+ (point)))
1518 (move-marker org-clock-marker nil
)
1519 (move-marker org-clock-hd-marker nil
)
1520 (when org-log-note-clock-out
1521 (org-add-log-setup 'clock-out nil nil nil nil
1522 (concat "# Task: " (org-get-heading t
) "\n\n")))
1523 (when org-clock-mode-line-timer
1524 (cancel-timer org-clock-mode-line-timer
)
1525 (setq org-clock-mode-line-timer nil
))
1526 (when org-clock-idle-timer
1527 (cancel-timer org-clock-idle-timer
)
1528 (setq org-clock-idle-timer nil
))
1529 (setq global-mode-string
1530 (delq 'org-mode-line-string global-mode-string
))
1531 (setq frame-title-format org-frame-title-format-backup
)
1532 (when org-clock-out-switch-to-state
1534 (org-back-to-heading t
)
1535 (let ((org-inhibit-logging t
)
1536 (org-clock-out-when-done nil
))
1538 ((functionp org-clock-out-switch-to-state
)
1539 (looking-at org-complex-heading-regexp
)
1540 (let ((newstate (funcall org-clock-out-switch-to-state
1542 (if newstate
(org-todo newstate
))))
1543 ((and org-clock-out-switch-to-state
1544 (not (looking-at (concat org-outline-regexp
"[ \t]*"
1545 org-clock-out-switch-to-state
1547 (org-todo org-clock-out-switch-to-state
))))))
1548 (force-mode-line-update)
1549 (message (concat "Clock stopped at %s after "
1550 (org-minutes-to-clocksum-string (+ (* 60 h
) m
)) "%s")
1551 te
(if remove
" => LINE REMOVED" ""))
1552 (run-hooks 'org-clock-out-hook
)
1553 (unless (org-clocking-p)
1554 (org-clock-delete-current)))))))
1556 (add-hook 'org-clock-out-hook
'org-clock-remove-empty-clock-drawer
)
1558 (defun org-clock-remove-empty-clock-drawer nil
1559 "Remove empty clock drawer in the current subtree."
1560 (let* ((olid (or (org-entry-get (point) "LOG_INTO_DRAWER")
1561 org-log-into-drawer
))
1562 (clock-drawer (if (eq t olid
) "LOGBOOK" olid
))
1563 (end (save-excursion (org-end-of-subtree t t
))))
1566 (org-back-to-heading t
)
1567 (while (and (< (point) end
)
1568 (search-forward clock-drawer end t
))
1569 (goto-char (match-beginning 0))
1570 (org-remove-empty-drawer-at clock-drawer
(point))
1571 (forward-line 1))))))
1573 (defun org-at-clock-log-p nil
1574 "Is the cursor on the clock log line?"
1576 (move-beginning-of-line 1)
1577 (looking-at "^[ \t]*CLOCK:")))
1579 (defun org-clock-timestamps-up (&optional n
)
1580 "Increase CLOCK timestamps at cursor.
1581 Optional argument N tells to change by that many units."
1583 (org-clock-timestamps-change 'up n
))
1585 (defun org-clock-timestamps-down (&optional n
)
1586 "Increase CLOCK timestamps at cursor.
1587 Optional argument N tells to change by that many units."
1589 (org-clock-timestamps-change 'down n
))
1591 (defun org-clock-timestamps-change (updown &optional n
)
1592 "Change CLOCK timestamps synchronously at cursor.
1593 UPDOWN tells whether to change 'up or 'down.
1594 Optional argument N tells to change by that many units."
1595 (setq org-ts-what nil
)
1596 (when (org-at-timestamp-p t
)
1597 (let ((tschange (if (eq updown
'up
) 'org-timestamp-up
1598 'org-timestamp-down
))
1599 ts1 begts1 ts2 begts2 updatets1 tdiff
)
1601 (move-beginning-of-line 1)
1602 (re-search-forward org-ts-regexp3 nil t
)
1603 (setq ts1
(match-string 0) begts1
(match-beginning 0))
1604 (when (re-search-forward org-ts-regexp3 nil t
)
1605 (setq ts2
(match-string 0) begts2
(match-beginning 0))))
1606 ;; Are we on the second timestamp?
1607 (if (<= begts2
(point)) (setq updatets1 t
))
1609 ;; fall back on org-timestamp-up if there is only one
1610 (funcall tschange n
)
1611 ;; setq this so that (boundp 'org-ts-what is non-nil)
1612 (funcall tschange n
)
1613 (let ((ts (if updatets1 ts2 ts1
))
1614 (begts (if updatets1 begts1 begts2
)))
1617 (org-time-string-to-time org-last-changed-timestamp
)
1618 (org-time-string-to-time ts
)))
1621 (org-timestamp-change
1622 (round (/ (org-float-time tdiff
)
1623 (cond ((eq org-ts-what
'minute
) 60)
1624 ((eq org-ts-what
'hour
) 3600)
1625 ((eq org-ts-what
'day
) (* 24 3600))
1626 ((eq org-ts-what
'month
) (* 24 3600 31))
1627 ((eq org-ts-what
'year
) (* 24 3600 365.2)))))
1628 org-ts-what
'updown
)))))))
1631 (defun org-clock-cancel ()
1632 "Cancel the running clock by removing the start timestamp."
1634 (when (not (org-clocking-p))
1635 (setq global-mode-string
1636 (delq 'org-mode-line-string global-mode-string
))
1637 (setq frame-title-format org-frame-title-format-backup
)
1638 (force-mode-line-update)
1639 (error "No active clock"))
1640 (save-excursion ; Do not replace this with `with-current-buffer'.
1641 (org-no-warnings (set-buffer (org-clocking-buffer)))
1642 (goto-char org-clock-marker
)
1643 (if (org-looking-back (concat "^[ \t]*" org-clock-string
".*"))
1644 (progn (delete-region (1- (point-at-bol)) (point-at-eol))
1645 (org-remove-empty-drawer-at "LOGBOOK" (point)))
1646 (message "Clock gone, cancel the timer anyway")
1648 (move-marker org-clock-marker nil
)
1649 (move-marker org-clock-hd-marker nil
)
1650 (setq global-mode-string
1651 (delq 'org-mode-line-string global-mode-string
))
1652 (setq frame-title-format org-frame-title-format-backup
)
1653 (force-mode-line-update)
1654 (message "Clock canceled")
1655 (run-hooks 'org-clock-cancel-hook
))
1658 (defun org-clock-goto (&optional select
)
1659 "Go to the currently clocked-in entry, or to the most recently clocked one.
1660 With prefix arg SELECT, offer recently clocked tasks for selection."
1665 (or (org-clock-select-task "Select task to go to: ")
1666 (error "No task selected")))
1667 ((org-clocking-p) org-clock-marker
)
1668 ((and org-clock-goto-may-find-recent-task
1669 (car org-clock-history
)
1670 (marker-buffer (car org-clock-history
)))
1672 (car org-clock-history
))
1673 (t (error "No active or recent clock task")))))
1674 (org-pop-to-buffer-same-window (marker-buffer m
))
1675 (if (or (< m
(point-min)) (> m
(point-max))) (widen))
1678 (org-back-to-heading t
)
1679 (org-cycle-hide-drawers 'children
)
1683 (message "No running clock, this is the most recently clocked task"))
1684 (run-hooks 'org-clock-goto-hook
)))
1686 (defvar org-clock-file-total-minutes nil
1687 "Holds the file total time in minutes, after a call to `org-clock-sum'.")
1688 (make-variable-buffer-local 'org-clock-file-total-minutes
)
1690 (defun org-clock-sum-today (&optional headline-filter
)
1691 "Sum the times for each subtree for today."
1693 (let ((range (org-clock-special-range 'today
)))
1694 (org-clock-sum (car range
) (cadr range
) nil
:org-clock-minutes-today
)))
1697 (defun org-clock-sum (&optional tstart tend headline-filter propname
)
1698 "Sum the times for each subtree.
1699 Puts the resulting times in minutes as a text property on each headline.
1700 TSTART and TEND can mark a time range to be considered.
1701 HEADLINE-FILTER is a zero-arg function that, if specified, is called for
1702 each headline in the time range with point at the headline. Headlines for
1703 which HEADLINE-FILTER returns nil are excluded from the clock summation.
1704 PROPNAME lets you set a custom text property instead of :org-clock-minutes."
1706 (let* ((bmp (buffer-modified-p))
1707 (re (concat "^\\(\\*+\\)[ \t]\\|^[ \t]*"
1709 "[ \t]*\\(?:\\(\\[.*?\\]\\)-+\\(\\[.*?\\]\\)\\|=>[ \t]+\\([0-9]+\\):\\([0-9]+\\)\\)"))
1711 (ltimes (make-vector lmax
0))
1716 (if (stringp tstart
) (setq tstart
(org-time-string-to-seconds tstart
)))
1717 (if (stringp tend
) (setq tend
(org-time-string-to-seconds tend
)))
1718 (if (consp tstart
) (setq tstart
(org-float-time tstart
)))
1719 (if (consp tend
) (setq tend
(org-float-time tend
)))
1720 (remove-text-properties (point-min) (point-max)
1721 `(,(or propname
:org-clock-minutes
) t
1722 :org-clock-force-headline-inclusion t
))
1724 (goto-char (point-max))
1725 (while (re-search-backward re nil t
)
1729 (setq ts
(match-string 2)
1732 (apply 'encode-time
(org-parse-time-string ts
)))
1734 (apply 'encode-time
(org-parse-time-string te
)))
1735 ts
(if tstart
(max ts tstart
) ts
)
1736 te
(if tend
(min te tend
) te
)
1738 t1
(if (> dt
0) (+ t1
(floor (/ dt
60))) t1
)))
1741 (setq t1
(+ t1
(string-to-number (match-string 5))
1742 (* 60 (string-to-number (match-string 4))))))
1744 ;; Add the currently clocking item time to the total
1745 (when (and org-clock-report-include-clocking-task
1746 (equal (org-clocking-buffer) (current-buffer))
1747 (equal (marker-position org-clock-hd-marker
) (point))
1750 (>= (org-float-time org-clock-start-time
) tstart
)
1751 (<= (org-float-time org-clock-start-time
) tend
))
1752 (let ((time (floor (- (org-float-time)
1753 (org-float-time org-clock-start-time
)) 60)))
1754 (setq t1
(+ t1 time
))))
1755 (let* ((headline-forced
1756 (get-text-property (point)
1757 :org-clock-force-headline-inclusion
))
1759 (or (null headline-filter
)
1761 (save-match-data (funcall headline-filter
))))))
1762 (setq level
(- (match-end 1) (match-beginning 1)))
1763 (when (or (> t1
0) (> (aref ltimes level
) 0))
1764 (when (or headline-included headline-forced
)
1765 (if headline-included
1766 (loop for l from
0 to level do
1767 (aset ltimes l
(+ (aref ltimes l
) t1
))))
1768 (setq time
(aref ltimes level
))
1769 (goto-char (match-beginning 0))
1770 (put-text-property (point) (point-at-eol)
1771 (or propname
:org-clock-minutes
) time
)
1776 (> (funcall outline-level
) 1)
1777 (outline-up-heading 1 t
)
1779 (point) (point-at-eol)
1780 :org-clock-force-headline-inclusion t
))))))
1782 (loop for l from level to
(1- lmax
) do
1783 (aset ltimes l
0)))))))
1784 (setq org-clock-file-total-minutes
(aref ltimes
0)))
1785 (set-buffer-modified-p bmp
)))
1787 (defun org-clock-sum-current-item (&optional tstart
)
1788 "Return time, clocked on current item in total."
1791 (org-narrow-to-subtree)
1792 (org-clock-sum tstart
)
1793 org-clock-file-total-minutes
)))
1796 (defun org-clock-display (&optional total-only
)
1797 "Show subtree times in the entire buffer.
1798 If TOTAL-ONLY is non-nil, only show the total time for the entire file
1801 Use \\[org-clock-remove-overlays] to remove the subtree times."
1803 (org-clock-remove-overlays)
1808 (goto-char (point-min))
1809 (while (or (and (equal (setq p
(point)) (point-min))
1810 (get-text-property p
:org-clock-minutes
))
1811 (setq p
(next-single-property-change
1812 (point) :org-clock-minutes
)))
1814 (when (setq time
(get-text-property p
:org-clock-minutes
))
1815 (org-clock-put-overlay time
(funcall outline-level
))))
1816 (setq h
(/ org-clock-file-total-minutes
60)
1817 m
(- org-clock-file-total-minutes
(* 60 h
)))
1818 ;; Arrange to remove the overlays upon next change.
1819 (when org-remove-highlights-with-change
1820 (org-add-hook 'before-change-functions
'org-clock-remove-overlays
1822 (message (concat "Total file time: "
1823 (org-minutes-to-clocksum-string org-clock-file-total-minutes
)
1824 " (%d hours and %d minutes)") h m
)))
1826 (defvar org-clock-overlays nil
)
1827 (make-variable-buffer-local 'org-clock-overlays
)
1829 (defun org-clock-put-overlay (time &optional level
)
1830 "Put an overlays on the current line, displaying TIME.
1831 If LEVEL is given, prefix time with a corresponding number of stars.
1832 This creates a new overlay and stores it in `org-clock-overlays', so that it
1833 will be easy to remove."
1834 (let* ((c 60) (h (floor (/ time
60))) (m (- time
(* 60 h
)))
1835 (l (if level
(org-get-valid-level level
0) 0))
1838 (org-move-to-column c
)
1839 (unless (eolp) (skip-chars-backward "^ \t"))
1840 (skip-chars-backward " \t")
1841 (setq ov
(make-overlay (point-at-bol) (point-at-eol))
1842 tx
(concat (buffer-substring (point-at-bol) (point))
1843 (make-string (+ off
(max 0 (- c
(current-column)))) ?.
)
1844 (org-add-props (concat (make-string l ?
*) " "
1845 (org-minutes-to-clocksum-string time
)
1846 (make-string (- 16 l
) ?\
))
1847 (list 'face
'org-clock-overlay
))
1849 (if (not (featurep 'xemacs
))
1850 (overlay-put ov
'display tx
)
1851 (overlay-put ov
'invisible t
)
1852 (overlay-put ov
'end-glyph
(make-glyph tx
)))
1853 (push ov org-clock-overlays
)))
1855 (defun org-clock-remove-overlays (&optional beg end noremove
)
1856 "Remove the occur highlights from the buffer.
1857 BEG and END are ignored. If NOREMOVE is nil, remove this function
1858 from the `before-change-functions' in the current buffer."
1860 (unless org-inhibit-highlight-removal
1861 (mapc 'delete-overlay org-clock-overlays
)
1862 (setq org-clock-overlays nil
)
1864 (remove-hook 'before-change-functions
1865 'org-clock-remove-overlays
'local
))))
1867 (defvar org-state
) ;; dynamically scoped into this function
1868 (defun org-clock-out-if-current ()
1869 "Clock out if the current entry contains the running clock.
1870 This is used to stop the clock after a TODO entry is marked DONE,
1871 and is only done if the variable `org-clock-out-when-done' is not nil."
1872 (when (and (org-clocking-p)
1873 org-clock-out-when-done
1874 (marker-buffer org-clock-marker
)
1875 (or (and (eq t org-clock-out-when-done
)
1876 (member org-state org-done-keywords
))
1877 (and (listp org-clock-out-when-done
)
1878 (member org-state org-clock-out-when-done
)))
1879 (equal (or (buffer-base-buffer (org-clocking-buffer))
1880 (org-clocking-buffer))
1881 (or (buffer-base-buffer (current-buffer))
1883 (< (point) org-clock-marker
)
1884 (> (save-excursion (outline-next-heading) (point))
1886 ;; Clock out, but don't accept a logging message for this.
1887 (let ((org-log-note-clock-out nil
)
1888 (org-clock-out-switch-to-state nil
))
1891 (add-hook 'org-after-todo-state-change-hook
1892 'org-clock-out-if-current
)
1895 (defun org-clock-get-clocktable (&rest props
)
1896 "Get a formatted clocktable with parameters according to PROPS.
1897 The table is created in a temporary buffer, fully formatted and
1898 fontified, and then returned."
1900 (setq props
(plist-put props
:name
"clocktable"))
1901 (unless (plist-member props
:maxlevel
)
1902 (setq props
(plist-put props
:maxlevel
2)))
1903 (unless (plist-member props
:scope
)
1904 (setq props
(plist-put props
:scope
'agenda
)))
1907 (org-create-dblock props
)
1909 (font-lock-fontify-buffer)
1911 (buffer-substring (point) (progn
1912 (re-search-forward "^[ \t]*#\\+END" nil t
)
1916 (defun org-clock-report (&optional arg
)
1917 "Create a table containing a report about clocked time.
1918 If the cursor is inside an existing clocktable block, then the table
1919 will be updated. If not, a new clocktable will be inserted. The scope
1920 of the new clock will be subtree when called from within a subtree, and
1923 When called with a prefix argument, move to the first clock table in the
1924 buffer and update it."
1926 (org-clock-remove-overlays)
1928 (org-find-dblock "clocktable")
1930 (if (org-in-clocktable-p)
1931 (goto-char (org-in-clocktable-p))
1932 (let ((props (if (ignore-errors
1933 (save-excursion (org-back-to-heading)))
1934 (list :name
"clocktable" :scope
'subtree
)
1935 (list :name
"clocktable"))))
1937 (org-combine-plists org-clock-clocktable-default-properties props
))))
1938 (org-update-dblock))
1940 (defun org-day-of-week (day month year
)
1941 "Returns the day of the week as an integer."
1945 (format "%d-%02d-%02dT00:00:00" year month day
)))))
1947 (defun org-quarter-to-date (quarter year
)
1948 "Get the date (week day year) of the first day of a given quarter."
1952 (setq startday
(org-day-of-week 1 1 year
))
1955 (list 52 7 (- year
1)))
1957 (list 52 6 (- year
1)))
1959 (list 1 startday year
))
1961 (list 53 startday
(- year
1)))
1965 (setq startday
(org-day-of-week 1 4 year
))
1968 (list 13 startday year
))
1970 (list 14 startday year
))
1972 (list 13 startday year
))
1976 (setq startday
(org-day-of-week 1 7 year
))
1979 (list 26 startday year
))
1981 (list 27 startday year
))
1983 (list 26 startday year
))
1987 (setq startday
(org-day-of-week 1 10 year
))
1990 (list 39 startday year
))
1992 (list 40 startday year
))
1994 (list 39 startday year
)))))))
1996 (defun org-clock-special-range (key &optional time as-strings wstart
)
1997 "Return two times bordering a special time range.
1998 Key is a symbol specifying the range and can be one of `today', `yesterday',
1999 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
2000 By default, a week starts Monday 0:00 and ends Sunday 24:00.
2001 The range is determined relative to TIME. TIME defaults to the current time.
2002 The return value is a cons cell with two internal times like the ones
2003 returned by `current time' or `encode-time'. If AS-STRINGS is non-nil,
2004 the returned times will be formatted strings. If WSTART is non-nil,
2005 use this number to specify the starting day of a week (monday is 1)."
2006 (if (integerp key
) (setq key
(intern (number-to-string key
))))
2007 (let* ((tm (decode-time (or time
(current-time))))
2008 (s 0) (m (nth 1 tm
)) (h (nth 2 tm
))
2009 (d (nth 3 tm
)) (month (nth 4 tm
)) (y (nth 5 tm
))
2012 (skey (symbol-name key
))
2014 (q (cond ((>= (nth 4 tm
) 10) 4)
2015 ((>= (nth 4 tm
) 7) 3)
2016 ((>= (nth 4 tm
) 4) 2)
2017 ((>= (nth 4 tm
) 1) 1)))
2018 s1 m1 h1 d1 month1 y1 diff ts te fm txt w date
2019 interval tmp shiftedy shiftedm shiftedq
)
2021 ((string-match "^[0-9]+$" skey
)
2022 (setq y
(string-to-number skey
) m
1 d
1 key
'year
))
2023 ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)$" skey
)
2024 (setq y
(string-to-number (match-string 1 skey
))
2025 month
(string-to-number (match-string 2 skey
))
2027 ((string-match "^\\([0-9]+\\)-[wW]\\([0-9]\\{1,2\\}\\)$" skey
)
2029 (setq y
(string-to-number (match-string 1 skey
))
2030 w
(string-to-number (match-string 2 skey
)))
2031 (setq date
(calendar-gregorian-from-absolute
2032 (calendar-absolute-from-iso (list w
1 y
))))
2033 (setq d
(nth 1 date
) month
(car date
) y
(nth 2 date
)
2036 ((string-match "^\\([0-9]+\\)-[qQ]\\([1-4]\\)$" skey
)
2038 (setq y
(string-to-number (match-string 1 skey
)))
2039 (setq q
(string-to-number (match-string 2 skey
)))
2040 (setq date
(calendar-gregorian-from-absolute
2041 (calendar-absolute-from-iso (org-quarter-to-date q y
))))
2042 (setq d
(nth 1 date
) month
(car date
) y
(nth 2 date
)
2045 ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)-\\([0-9]\\{1,2\\}\\)$" skey
)
2046 (setq y
(string-to-number (match-string 1 skey
))
2047 month
(string-to-number (match-string 2 skey
))
2048 d
(string-to-number (match-string 3 skey
))
2050 ((string-match "\\([-+][0-9]+\\)$" skey
)
2051 (setq shift
(string-to-number (match-string 1 skey
))
2052 key
(intern (substring skey
0 (match-beginning 1))))
2053 (if (and (memq key
'(quarter thisq
)) (> shift
0))
2054 (error "Looking forward with quarters isn't implemented"))))
2057 (cond ((eq key
'yesterday
) (setq key
'today shift -
1))
2058 ((eq key
'lastweek
) (setq key
'week shift -
1))
2059 ((eq key
'lastmonth
) (setq key
'month shift -
1))
2060 ((eq key
'lastyear
) (setq key
'year shift -
1))
2061 ((eq key
'lastq
) (setq key
'quarter shift -
1))))
2063 ((memq key
'(day today
))
2064 (setq d
(+ d shift
) h
0 m
0 h1
24 m1
0))
2065 ((memq key
'(week thisweek
))
2066 (setq diff
(+ (* -
7 shift
) (if (= dow
0) (- 7 ws
) (- dow ws
)))
2067 m
0 h
0 d
(- d diff
) d1
(+ 7 d
)))
2068 ((memq key
'(month thismonth
))
2069 (setq d
1 h
0 m
0 d1
1 month
(+ month shift
) month1
(1+ month
) h1
0 m1
0))
2070 ((memq key
'(quarter thisq
))
2071 ; compute if this shift remains in this year
2072 ; if not, compute how many years and quarters we have to shift (via floor*)
2073 ; and compute the shifted years, months and quarters
2075 ((< (+ (- q
1) shift
) 0) ; shift not in this year
2076 (setq interval
(* -
1 (+ (- q
1) shift
)))
2077 ; set tmp to ((years to shift) (quarters to shift))
2078 (setq tmp
(org-floor* interval
4))
2079 ; due to the use of floor, 0 quarters actually means 4
2080 (if (= 0 (nth 1 tmp
))
2081 (setq shiftedy
(- y
(nth 0 tmp
))
2084 (setq shiftedy
(- y
(+ 1 (nth 0 tmp
)))
2085 shiftedm
(- 13 (* 3 (nth 1 tmp
)))
2086 shiftedq
(- 5 (nth 1 tmp
))))
2087 (setq d
1 h
0 m
0 d1
1 month shiftedm month1
(+ 3 shiftedm
) h1
0 m1
0 y shiftedy
))
2088 ((> (+ q shift
) 0) ; shift is within this year
2089 (setq shiftedq
(+ q shift
))
2091 (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))))
2092 ((memq key
'(year thisyear
))
2093 (setq m
0 h
0 d
1 month
1 y
(+ y shift
) y1
(1+ y
)))
2094 (t (error "No such time block %s" key
)))
2095 (setq ts
(encode-time s m h d month y
)
2096 te
(encode-time (or s1 s
) (or m1 m
) (or h1 h
)
2097 (or d1 d
) (or month1 month
) (or y1 y
)))
2098 (setq fm
(cdr org-time-stamp-formats
))
2100 ((memq key
'(day today
))
2101 (setq txt
(format-time-string "%A, %B %d, %Y" ts
)))
2102 ((memq key
'(week thisweek
))
2103 (setq txt
(format-time-string "week %G-W%V" ts
)))
2104 ((memq key
'(month thismonth
))
2105 (setq txt
(format-time-string "%B %Y" ts
)))
2106 ((memq key
'(year thisyear
))
2107 (setq txt
(format-time-string "the year %Y" ts
)))
2108 ((memq key
'(quarter thisq
))
2109 (setq txt
(concat (org-count-quarter shiftedq
) " quarter of " (number-to-string shiftedy
))))
2112 (list (format-time-string fm ts
) (format-time-string fm te
) txt
)
2115 (defun org-count-quarter (n)
2122 (defun org-clocktable-shift (dir n
)
2123 "Try to shift the :block date of the clocktable at point.
2124 Point must be in the #+BEGIN: line of a clocktable, or this function
2125 will throw an error.
2126 DIR is a direction, a symbol `left', `right', `up', or `down'.
2127 Both `left' and `down' shift the block toward the past, `up' and `right'
2128 push it toward the future.
2129 N is the number of shift steps to take. The size of the step depends on
2130 the currently selected interval size."
2131 (setq n
(prefix-numeric-value n
))
2132 (and (memq dir
'(left down
)) (setq n
(- n
)))
2134 (goto-char (point-at-bol))
2135 (if (not (looking-at "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>.*?:block[ \t]+\\(\\S-+\\)"))
2136 (error "Line needs a :block definition before this command works")
2137 (let* ((b (match-beginning 1)) (e (match-end 1))
2138 (s (match-string 1))
2139 block shift ins y mw d date wp m
)
2141 ((equal s
"yesterday") (setq s
"today-1"))
2142 ((equal s
"lastweek") (setq s
"thisweek-1"))
2143 ((equal s
"lastmonth") (setq s
"thismonth-1"))
2144 ((equal s
"lastyear") (setq s
"thisyear-1"))
2145 ((equal s
"lastq") (setq s
"thisq-1")))
2148 ((string-match "^\\(today\\|thisweek\\|thismonth\\|thisyear\\|thisq\\)\\([-+][0-9]+\\)?$" s
)
2149 (setq block
(match-string 1 s
)
2150 shift
(if (match-end 2)
2151 (string-to-number (match-string 2 s
))
2153 (setq shift
(+ shift n
))
2154 (setq ins
(if (= shift
0) block
(format "%s%+d" block shift
))))
2155 ((string-match "\\([0-9]+\\)\\(-\\([wWqQ]?\\)\\([0-9]\\{1,2\\}\\)\\(-\\([0-9]\\{1,2\\}\\)\\)?\\)?" s
)
2156 ;; 1 1 2 3 3 4 4 5 6 6 5 2
2157 (setq y
(string-to-number (match-string 1 s
))
2158 wp
(and (match-end 3) (match-string 3 s
))
2159 mw
(and (match-end 4) (string-to-number (match-string 4 s
)))
2160 d
(and (match-end 6) (string-to-number (match-string 6 s
))))
2162 (d (setq ins
(format-time-string
2164 (encode-time 0 0 0 (+ d n
) m y
))))
2165 ((and wp
(string-match "w\\|W" wp
) mw
(> (length wp
) 0))
2167 (setq date
(calendar-gregorian-from-absolute
2168 (calendar-absolute-from-iso (list (+ mw n
) 1 y
))))
2169 (setq ins
(format-time-string
2171 (encode-time 0 0 0 (nth 1 date
) (car date
) (nth 2 date
)))))
2172 ((and wp
(string-match "q\\|Q" wp
) mw
(> (length wp
) 0))
2174 ; if the 4th + 1 quarter is requested we flip to the 1st quarter of the next year
2179 ; if the 1st - 1 quarter is requested we flip to the 4th quarter of the previous year
2184 (setq date
(calendar-gregorian-from-absolute
2185 (calendar-absolute-from-iso (org-quarter-to-date (+ mw n
) y
))))
2186 (setq ins
(format-time-string
2187 (concat (number-to-string y
) "-Q" (number-to-string (+ mw n
)))
2188 (encode-time 0 0 0 (nth 1 date
) (car date
) (nth 2 date
)))))
2190 (setq ins
(format-time-string
2192 (encode-time 0 0 0 1 (+ mw n
) y
))))
2194 (setq ins
(number-to-string (+ y n
))))))
2195 (t (error "Cannot shift clocktable block")))
2199 (delete-region (point) (+ (point) (- e b
)))
2200 (beginning-of-line 1)
2205 (defun org-dblock-write:clocktable
(params)
2206 "Write the standard clocktable."
2207 (setq params
(org-combine-plists org-clocktable-defaults params
))
2209 (let* ((scope (plist-get params
:scope
))
2210 (block (plist-get params
:block
))
2211 (ts (plist-get params
:tstart
))
2212 (te (plist-get params
:tend
))
2213 (link (plist-get params
:link
))
2214 (maxlevel (or (plist-get params
:maxlevel
) 3))
2215 (ws (plist-get params
:wstart
))
2216 (step (plist-get params
:step
))
2217 (timestamp (plist-get params
:timestamp
))
2218 (formatter (or (plist-get params
:formatter
)
2219 org-clock-clocktable-formatter
2220 'org-clocktable-write-default
))
2221 cc range-text ipos pos one-file-with-archives
2222 scope-is-list tbls level
)
2223 ;; Check if we need to do steps
2225 ;; Get the range text for the header
2226 (setq cc
(org-clock-special-range block nil t ws
)
2227 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2229 ;; Write many tables, in steps
2230 (unless (or block
(and ts te
))
2231 (error "Clocktable `:step' can only be used with `:block' or `:tstart,:end'"))
2232 (org-clocktable-steps params
)
2235 (setq ipos
(point)) ; remember the insertion position
2237 ;; Get the right scope
2240 ((and scope
(listp scope
) (symbolp (car scope
)))
2241 (setq scope
(eval scope
)))
2243 (setq scope
(org-agenda-files t
)))
2244 ((eq scope
'agenda-with-archives
)
2245 (setq scope
(org-agenda-files t
))
2246 (setq scope
(org-add-archive-files scope
)))
2247 ((eq scope
'file-with-archives
)
2248 (setq scope
(org-add-archive-files (list (buffer-file-name)))
2249 one-file-with-archives t
)))
2250 (setq scope-is-list
(and scope
(listp scope
)))
2252 ;; we collect from several files
2253 (let* ((files scope
)
2255 (org-agenda-prepare-buffers files
)
2256 (while (setq file
(pop files
))
2257 (with-current-buffer (find-buffer-visiting file
)
2260 (push (org-clock-get-table-data file params
) tbls
))))))
2261 ;; Just from the current file
2263 ;; get the right range into the restriction
2264 (org-agenda-prepare-buffers (list (buffer-file-name)))
2266 ((not scope
)) ; use the restriction as it is now
2267 ((eq scope
'file
) (widen))
2268 ((eq scope
'subtree
) (org-narrow-to-subtree))
2270 (while (org-up-heading-safe))
2271 (org-narrow-to-subtree))
2272 ((and (symbolp scope
) (string-match "^tree\\([0-9]+\\)$"
2273 (symbol-name scope
)))
2274 (setq level
(string-to-number (match-string 1 (symbol-name scope
))))
2276 (while (org-up-heading-safe)
2277 (looking-at org-outline-regexp
)
2278 (if (<= (org-reduced-level (funcall outline-level
)) level
)
2279 (throw 'exit nil
))))
2280 (org-narrow-to-subtree)))
2281 ;; do the table, with no file name.
2282 (push (org-clock-get-table-data nil params
) tbls
)))
2284 ;; OK, at this point we tbls as a list of tables, one per file
2285 (setq tbls
(nreverse tbls
))
2287 (setq params
(plist-put params
:multifile scope-is-list
))
2288 (setq params
(plist-put params
:one-file-with-archives
2289 one-file-with-archives
))
2291 (funcall formatter ipos tbls params
))))
2293 (defun org-clocktable-write-default (ipos tables params
)
2294 "Write out a clock table at position IPOS in the current buffer.
2295 TABLES is a list of tables with clocking data as produced by
2296 `org-clock-get-table-data'. PARAMS is the parameter property list obtained
2297 from the dynamic block definition."
2298 ;; This function looks quite complicated, mainly because there are a
2299 ;; lot of options which can add or remove columns. I have massively
2300 ;; commented this function, the I hope it is understandable. If
2301 ;; someone wants to write their own special formatter, this maybe
2302 ;; much easier because there can be a fixed format with a
2303 ;; well-defined number of columns...
2304 (let* ((hlchars '((1 .
"*") (2 .
"/")))
2305 (lwords (assoc (or (plist-get params
:lang
)
2306 org-export-default-language
)
2307 org-clock-clocktable-language-setup
))
2308 (multifile (plist-get params
:multifile
))
2309 (block (plist-get params
:block
))
2310 (ts (plist-get params
:tstart
))
2311 (te (plist-get params
:tend
))
2312 (header (plist-get params
:header
))
2313 (narrow (plist-get params
:narrow
))
2314 (ws (or (plist-get params
:wstart
) 1))
2315 (link (plist-get params
:link
))
2316 (maxlevel (or (plist-get params
:maxlevel
) 3))
2317 (emph (plist-get params
:emphasize
))
2318 (level-p (plist-get params
:level
))
2319 (timestamp (plist-get params
:timestamp
))
2320 (properties (plist-get params
:properties
))
2321 (ntcol (max 1 (or (plist-get params
:tcolumns
) 100)))
2322 (rm-file-column (plist-get params
:one-file-with-archives
))
2323 (indent (plist-get params
:indent
))
2324 (case-fold-search t
)
2325 range-text total-time tbl level hlc formula pcol
2326 file-time entries entry headline
2327 recalc content narrow-cut-p tcol
)
2329 ;; Implement abbreviations
2330 (when (plist-get params
:compact
)
2331 (setq level nil indent t narrow
(or narrow
'40!) ntcol
1))
2333 ;; Some consistency test for parameters
2334 (unless (integerp ntcol
)
2335 (setq params
(plist-put params
:tcolumns
(setq ntcol
100))))
2337 (when (and narrow
(integerp narrow
) link
)
2338 ;; We cannot have both integer narrow and link
2340 "Using hard narrowing in clocktable to allow for links")
2341 (setq narrow
(intern (format "%d!" narrow
))))
2346 ((and (symbolp narrow
)
2347 (string-match "\\`[0-9]+!\\'" (symbol-name narrow
)))
2348 (setq narrow-cut-p t
2349 narrow
(string-to-number (substring (symbol-name narrow
)
2352 (error "Invalid value %s of :narrow property in clock table"
2356 ;; Get the range text for the header
2357 (setq range-text
(nth 2 (org-clock-special-range block nil t ws
))))
2359 ;; Compute the total time
2360 (setq total-time
(apply '+ (mapcar 'cadr tables
)))
2362 ;; Now we need to output this tsuff
2365 ;; Insert the text *before* the actual table
2366 (insert-before-markers
2368 ;; Format the standard header
2373 (format-time-string (cdr org-time-stamp-formats
))
2376 (if block
(concat ", for " range-text
".") "")
2379 ;; Insert the narrowing line
2380 (when (and narrow
(integerp narrow
) (not narrow-cut-p
))
2381 (insert-before-markers
2382 "|" ; table line starter
2383 (if multifile
"|" "") ; file column, maybe
2384 (if level-p
"|" "") ; level column, maybe
2385 (if timestamp
"|" "") ; timestamp column, maybe
2386 (if properties
(make-string (length properties
) ?|
) "") ;properties columns, maybe
2387 (format "<%d>| |\n" narrow
))) ; headline and time columns
2389 ;; Insert the table header line
2390 (insert-before-markers
2391 "|" ; table line starter
2392 (if multifile
(concat (nth 1 lwords
) "|") "") ; file column, maybe
2393 (if level-p
(concat (nth 2 lwords
) "|") "") ; level column, maybe
2394 (if timestamp
(concat (nth 3 lwords
) "|") "") ; timestamp column, maybe
2395 (if properties
(concat (mapconcat 'identity properties
"|") "|") "") ;properties columns, maybe
2396 (concat (nth 4 lwords
) "|"
2397 (nth 5 lwords
) "|\n")) ; headline and time columns
2399 ;; Insert the total time in the table
2400 (insert-before-markers
2402 "|" ; table line starter
2403 (if multifile
(concat "| " (nth 6 lwords
) " ") "")
2404 ; file column, maybe
2405 (if level-p
"|" "") ; level column, maybe
2406 (if timestamp
"|" "") ; timestamp column, maybe
2407 (if properties
(make-string (length properties
) ?|
) "") ; properties columns, maybe
2408 (concat (format org-clock-total-time-cell-format
(nth 7 lwords
)) "| ") ; instead of a headline
2409 (format org-clock-total-time-cell-format
2410 (org-minutes-to-clocksum-string (or total-time
0))) ; the time
2413 ;; Now iterate over the tables and insert the data
2414 ;; but only if any time has been collected
2415 (when (and total-time
(> total-time
0))
2417 (while (setq tbl
(pop tables
))
2418 ;; now tbl is the table resulting from one file.
2419 (setq file-time
(nth 1 tbl
))
2420 (when (or (and file-time
(> file-time
0))
2421 (not (plist-get params
:fileskip0
)))
2422 (insert-before-markers "|-\n") ; a hline because a new file starts
2423 ;; First the file time, if we have multiple files
2425 ;; Summarize the time collected from this file
2426 (insert-before-markers
2427 (format (concat "| %s %s | %s%s"
2428 (format org-clock-file-time-cell-format
(nth 8 lwords
))
2430 (file-name-nondirectory (car tbl
))
2431 (if level-p
"| " "") ; level column, maybe
2432 (if timestamp
"| " "") ; timestamp column, maybe
2433 (if properties
(make-string (length properties
) ?|
) "") ;properties columns, maybe
2434 (org-minutes-to-clocksum-string (nth 1 tbl
))))) ; the time
2436 ;; Get the list of node entries and iterate over it
2437 (setq entries
(nth 2 tbl
))
2438 (while (setq entry
(pop entries
))
2439 (setq level
(car entry
)
2440 headline
(nth 1 entry
)
2441 hlc
(if emph
(or (cdr (assoc level hlchars
)) "") ""))
2443 (if (and (string-match (concat "\\`" org-bracket-link-regexp
2448 (format "[[%s][%s]]"
2449 (match-string 1 headline
)
2450 (org-shorten-string (match-string 3 headline
)
2452 (setq headline
(org-shorten-string headline narrow
))))
2453 (insert-before-markers
2454 "|" ; start the table line
2455 (if multifile
"|" "") ; free space for file name column?
2456 (if level-p
(format "%d|" (car entry
)) "") ; level, maybe
2457 (if timestamp
(concat (nth 2 entry
) "|") "") ; timestamp, maybe
2461 (lambda (p) (or (cdr (assoc p
(nth 4 entry
))) ""))
2462 properties
"|") "|") "") ;properties columns, maybe
2463 (if indent
(org-clocktable-indent-string level
) "") ; indentation
2464 hlc headline hlc
"|" ; headline
2465 (make-string (min (1- ntcol
) (or (- level
1))) ?|
)
2466 ; empty fields for higher levels
2467 hlc
(org-minutes-to-clocksum-string (nth 3 entry
)) hlc
; time
2470 ;; When exporting subtrees or regions the region might be
2471 ;; activated, so let's disable ̀delete-active-region'
2472 (let ((delete-active-region nil
)) (backward-delete-char 1))
2473 (if (setq formula
(plist-get params
:formula
))
2476 ;; compute the column where the % numbers need to go
2481 (min maxlevel
(or ntcol
100))))
2482 ;; compute the column where the total time is
2486 (if timestamp
1 0)))
2489 "\n#+TBLFM: $%d='(org-clock-time%% @%d$%d $%d..$%d);%%.1f"
2490 pcol
; the column where the % numbers should go
2491 (if (and narrow
(not narrow-cut-p
)) 3 2) ; row of the total time
2492 tcol
; column of the total time
2493 tcol
(1- pcol
) ; range of columns where times can be found
2497 (insert "\n#+TBLFM: " formula
)
2499 (t (error "Invalid formula in clocktable")))
2500 ;; Should we rescue an old formula?
2501 (when (stringp (setq content
(plist-get params
:content
)))
2502 (when (string-match "^\\([ \t]*#\\+tblfm:.*\\)" content
)
2504 (insert "\n" (match-string 1 (plist-get params
:content
)))
2505 (beginning-of-line 0))))
2506 ;; Back to beginning, align the table, recalculate if necessary
2508 (skip-chars-forward "^|")
2510 (when org-hide-emphasis-markers
2511 ;; we need to align a second time
2516 (if (and narrow
(not narrow-cut-p
)) (beginning-of-line 2))
2517 (org-table-goto-column pcol nil
'force
)
2519 (org-table-recalculate 'all
))
2520 (when rm-file-column
2521 ;; The file column is actually not wanted
2523 (org-table-delete-column))
2526 (defun org-clocktable-indent-string (level)
2531 (setq level
(1- level
)
2532 str
(concat str
"___")))
2535 (defun org-clocktable-steps (params)
2536 "Step through the range to make a number of clock tables."
2537 (let* ((p1 (copy-sequence params
))
2538 (ts (plist-get p1
:tstart
))
2539 (te (plist-get p1
:tend
))
2540 (ws (plist-get p1
:wstart
))
2541 (step0 (plist-get p1
:step
))
2542 (step (cdr (assoc step0
'((day .
86400) (week .
604800)))))
2543 (stepskip0 (plist-get p1
:stepskip0
))
2544 (block (plist-get p1
:block
))
2545 cc range-text step-time
)
2547 (setq cc
(org-clock-special-range block nil t ws
)
2548 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2551 ;; If ts is a number, it's an absolute day number from org-agenda.
2552 (destructuring-bind (month day year
) (calendar-gregorian-from-absolute ts
)
2553 (setq ts
(org-float-time (encode-time 0 0 0 day month year
)))))
2555 (setq ts
(org-float-time
2556 (apply 'encode-time
(org-parse-time-string ts
))))))
2560 (destructuring-bind (month day year
) (calendar-gregorian-from-absolute te
)
2561 (setq te
(org-float-time (encode-time 0 0 0 day month year
)))))
2563 (setq te
(org-float-time
2564 (apply 'encode-time
(org-parse-time-string te
))))))
2565 (setq p1
(plist-put p1
:header
""))
2566 (setq p1
(plist-put p1
:step nil
))
2567 (setq p1
(plist-put p1
:block nil
))
2569 (or (bolp) (insert "\n"))
2570 (setq p1
(plist-put p1
:tstart
(format-time-string
2571 (org-time-stamp-format nil t
)
2572 (seconds-to-time ts
))))
2573 (setq p1
(plist-put p1
:tend
(format-time-string
2574 (org-time-stamp-format nil t
)
2575 (seconds-to-time (setq ts
(+ ts step
))))))
2576 (insert "\n" (if (eq step0
'day
) "Daily report: "
2577 "Weekly report starting on: ")
2578 (plist-get p1
:tstart
) "\n")
2579 (setq step-time
(org-dblock-write:clocktable p1
))
2580 (re-search-forward "^[ \t]*#\\+END:")
2581 (when (and (equal step-time
0) stepskip0
)
2582 ;; Remove the empty table
2583 (delete-region (point-at-bol)
2585 (re-search-backward "^\\(Daily\\|Weekly\\) report"
2590 (defun org-clock-get-table-data (file params
)
2591 "Get the clocktable data for file FILE, with parameters PARAMS.
2592 FILE is only for identification - this function assumes that
2593 the correct buffer is current, and that the wanted restriction is
2595 The return value will be a list with the file name and the total
2596 file time (in minutes) as 1st and 2nd elements. The third element
2597 of this list will be a list of headline entries. Each entry has the
2598 following structure:
2600 (LEVEL HEADLINE TIMESTAMP TIME)
2602 LEVEL: The level of the headline, as an integer. This will be
2603 the reduced leve, so 1,2,3,... even if only odd levels
2605 HEADLINE: The text of the headline. Depending on PARAMS, this may
2606 already be formatted like a link.
2607 TIMESTAMP: If PARAMS require it, this will be a time stamp found in the
2608 entry, any of SCHEDULED, DEADLINE, NORMAL, or first inactive,
2610 TIME: The sum of all time spend in this tree, in minutes. This time
2611 will of cause be restricted to the time block and tags match
2612 specified in PARAMS."
2613 (let* ((maxlevel (or (plist-get params
:maxlevel
) 3))
2614 (timestamp (plist-get params
:timestamp
))
2615 (ts (plist-get params
:tstart
))
2616 (te (plist-get params
:tend
))
2617 (ws (plist-get params
:wstart
))
2618 (block (plist-get params
:block
))
2619 (link (plist-get params
:link
))
2620 (tags (plist-get params
:tags
))
2621 (properties (plist-get params
:properties
))
2622 (inherit-property-p (plist-get params
:inherit-props
))
2624 (matcher (if tags
(cdr (org-make-tags-matcher tags
))))
2625 cc range-text st p time level hdl props tsp tbl
)
2627 (setq org-clock-file-total-minutes nil
)
2629 (setq cc
(org-clock-special-range block nil t ws
)
2630 ts
(car cc
) te
(nth 1 cc
) range-text
(nth 2 cc
)))
2631 (when (integerp ts
) (setq ts
(calendar-gregorian-from-absolute ts
)))
2632 (when (integerp te
) (setq te
(calendar-gregorian-from-absolute te
)))
2633 (when (and ts
(listp ts
))
2634 (setq ts
(format "%4d-%02d-%02d" (nth 2 ts
) (car ts
) (nth 1 ts
))))
2635 (when (and te
(listp te
))
2636 (setq te
(format "%4d-%02d-%02d" (nth 2 te
) (car te
) (nth 1 te
))))
2637 ;; Now the times are strings we can parse.
2638 (if ts
(setq ts
(org-float-time
2639 (seconds-to-time (org-matcher-time ts
)))))
2640 (if te
(setq te
(org-float-time
2641 (seconds-to-time (org-matcher-time te
)))))
2643 (org-clock-sum ts te
2644 (unless (null matcher
)
2646 (let* ((tags-list (org-get-tags-at))
2647 (org-scanner-tags tags-list
)
2648 (org-trust-scanner-tags t
))
2650 (goto-char (point-min))
2652 (while (or (and (bobp) (prog1 st
(setq st nil
))
2653 (get-text-property (point) :org-clock-minutes
)
2654 (setq p
(point-min)))
2655 (setq p
(next-single-property-change
2656 (point) :org-clock-minutes
)))
2658 (when (setq time
(get-text-property p
:org-clock-minutes
))
2660 (beginning-of-line 1)
2661 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@#%:]+:\\)?[ \t]*$"))
2662 (setq level
(org-reduced-level
2663 (- (match-end 1) (match-beginning 1))))
2664 (<= level maxlevel
))
2665 (setq hdl
(if (not link
)
2667 (org-make-link-string
2668 (format "file:%s::%s"
2671 (org-make-org-heading-search-string
2675 (setq props
(org-entry-properties (point)))
2676 (or (cdr (assoc "SCHEDULED" props
))
2677 (cdr (assoc "DEADLINE" props
))
2678 (cdr (assoc "TIMESTAMP" props
))
2679 (cdr (assoc "TIMESTAMP_IA" props
))))
2680 props
(when properties
2684 (when (org-entry-get (point) p inherit-property-p
)
2685 (cons p
(org-entry-get (point) p inherit-property-p
))))
2687 (when (> time
0) (push (list level hdl tsp time props
) tbl
))))))
2688 (setq tbl
(nreverse tbl
))
2689 (list file org-clock-file-total-minutes tbl
))))
2691 (defun org-clock-time%
(total &rest strings
)
2692 "Compute a time fraction in percent.
2693 TOTAL s a time string like 10:21 specifying the total times.
2694 STRINGS is a list of strings that should be checked for a time.
2695 The first string that does have a time will be used.
2696 This function is made for clock tables."
2697 (let ((re "\\([0-9]+\\):\\([0-9]+\\)")
2701 (if (not (string-match re total
))
2703 (setq tot
(+ (string-to-number (match-string 2 total
))
2704 (* 60 (string-to-number (match-string 1 total
)))))
2705 (if (= tot
0.
) (throw 'exit
0.
)))
2706 (while (setq s
(pop strings
))
2707 (if (string-match "\\([0-9]+\\):\\([0-9]+\\)" s
)
2709 (/ (* 100.0 (+ (string-to-number (match-string 2 s
))
2710 (* 60 (string-to-number
2711 (match-string 1 s
)))))
2715 ;; Saving and loading the clock
2717 (defvar org-clock-loaded nil
2718 "Was the clock file loaded?")
2720 (defun org-clock-update-time-maybe ()
2721 "If this is a CLOCK line, update it and return t.
2722 Otherwise, return nil."
2725 (beginning-of-line 1)
2726 (skip-chars-forward " \t")
2727 (when (looking-at org-clock-string
)
2728 (let ((re (concat "[ \t]*" org-clock-string
2729 " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
2730 "\\([ \t]*=>.*\\)?\\)?"))
2733 ((not (looking-at re
))
2735 ((not (match-end 2))
2736 (when (and (equal (marker-buffer org-clock-marker
) (current-buffer))
2737 (> org-clock-marker
(point))
2738 (<= org-clock-marker
(point-at-eol)))
2739 ;; The clock is running here
2740 (setq org-clock-start-time
2742 (org-parse-time-string (match-string 1))))
2743 (org-clock-update-mode-line)))
2745 (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
2747 (setq ts
(match-string 1)
2748 te
(match-string 3))
2749 (setq s
(- (org-float-time
2750 (apply 'encode-time
(org-parse-time-string te
)))
2752 (apply 'encode-time
(org-parse-time-string ts
))))
2755 h
(floor (/ s
3600))
2759 (insert " => " (format (if neg
"-%d:%02d" "%2d:%02d") h m
))
2762 (defun org-clock-save ()
2763 "Persist various clock-related data to disk.
2764 The details of what will be saved are regulated by the variable
2765 `org-clock-persist'."
2766 (when (and org-clock-persist
2767 (or org-clock-loaded
2768 org-clock-has-been-used
2769 (not (file-exists-p org-clock-persist-file
))))
2771 (with-current-buffer (find-file (expand-file-name org-clock-persist-file
))
2773 (delete-region (point-min) (point-max))
2775 (insert (format ";; org-persist.el - %s at %s\n"
2776 system-name
(format-time-string
2777 (cdr org-time-stamp-formats
))))
2778 (if (and (memq org-clock-persist
'(t clock
))
2779 (setq b
(org-clocking-buffer))
2780 (setq b
(or (buffer-base-buffer b
) b
))
2782 (buffer-file-name b
)
2783 (or (not org-clock-persist-query-save
)
2784 (y-or-n-p (concat "Save current clock ("
2785 (substring-no-properties
2788 (insert "(setq resume-clock '(\""
2789 (buffer-file-name (org-clocking-buffer))
2790 "\" . " (int-to-string (marker-position org-clock-marker
))
2792 ;; Store clocked task history. Tasks are stored reversed to make
2794 (when (and (memq org-clock-persist
'(t history
))
2797 "(setq stored-clock-history '("
2800 (when (and (setq b
(marker-buffer m
))
2801 (setq b
(or (buffer-base-buffer b
) b
))
2803 (buffer-file-name b
))
2804 (concat "(\"" (buffer-file-name b
)
2805 "\" . " (int-to-string (marker-position m
))
2807 (reverse org-clock-history
) " ") "))\n"))
2809 (kill-buffer (current-buffer)))))))
2811 (defun org-clock-load ()
2812 "Load clock-related data from disk, maybe resuming a stored clock."
2813 (when (and org-clock-persist
(not org-clock-loaded
))
2814 (let ((filename (expand-file-name org-clock-persist-file
))
2815 (org-clock-in-resume 'auto-restart
)
2816 resume-clock stored-clock-history
)
2817 (if (not (file-readable-p filename
))
2818 (message "Not restoring clock data; %s not found"
2819 org-clock-persist-file
)
2820 (message "%s" "Restoring clock data")
2821 (setq org-clock-loaded t
)
2822 (load-file filename
)
2824 (when stored-clock-history
2825 (save-window-excursion
2826 (mapc (lambda (task)
2827 (if (file-exists-p (car task
))
2828 (org-clock-history-push (cdr task
)
2829 (find-file (car task
)))))
2830 stored-clock-history
)))
2832 (when (and resume-clock org-clock-persist
2833 (file-exists-p (car resume-clock
))
2834 (or (not org-clock-persist-query-resume
)
2838 (with-current-buffer (find-file (car resume-clock
))
2840 (goto-char (cdr resume-clock
))
2841 (org-back-to-heading t
)
2842 (and (looking-at org-complex-heading-regexp
)
2845 (when (file-exists-p (car resume-clock
))
2846 (with-current-buffer (find-file (car resume-clock
))
2847 (goto-char (cdr resume-clock
))
2848 (let ((org-clock-auto-clock-resolution nil
))
2850 (if (outline-invisible-p)
2851 (org-show-context))))))))))
2853 ;; Suggested bindings
2854 (org-defkey org-mode-map
"\C-c\C-x\C-e" 'org-clock-modify-effort-estimate
)
2856 (provide 'org-clock
)
2859 ;; generated-autoload-file: "org-loaddefs.el"
2862 ;;; org-clock.el ends here
