Export back-ends: Apply changes to back-end structure
[org-mode/org-tableheadings.git] / lisp / org-clock.el
blob8ac215eae69e7040cbbd98abfebdcb259e6e9f1f
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
8 ;;
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 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;; Commentary:
27 ;; This file contains the time clocking code for Org-mode
29 ;;; Code:
31 (eval-when-compile
32 (require 'cl))
33 (require 'org)
35 (declare-function calendar-absolute-from-iso "cal-iso" (&optional date))
36 (declare-function notifications-notify "notifications" (&rest params))
37 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
38 (declare-function org-refresh-properties "org" (dprop tprop))
39 (defvar org-time-stamp-formats)
40 (defvar org-ts-what)
41 (defvar org-frame-title-format-backup frame-title-format)
43 (defgroup org-clock nil
44 "Options concerning clocking working time in Org-mode."
45 :tag "Org Clock"
46 :group 'org-progress)
48 (defcustom org-clock-into-drawer org-log-into-drawer
49 "Should clocking info be wrapped into a drawer?
50 When t, clocking info will always be inserted into a :LOGBOOK: drawer.
51 If necessary, the drawer will be created.
52 When nil, the drawer will not be created, but used when present.
53 When an integer and the number of clocking entries in an item
54 reaches or exceeds this number, a drawer will be created.
55 When a string, it names the drawer to be used.
57 The default for this variable is the value of `org-log-into-drawer',
58 which see."
59 :group 'org-todo
60 :group 'org-clock
61 :type '(choice
62 (const :tag "Always" t)
63 (const :tag "Only when drawer exists" nil)
64 (integer :tag "When at least N clock entries")
65 (const :tag "Into LOGBOOK drawer" "LOGBOOK")
66 (string :tag "Into Drawer named...")))
68 (defun org-clock-into-drawer ()
69 "Return the value of `org-clock-into-drawer', but let properties overrule.
70 If the current entry has or inherits a CLOCK_INTO_DRAWER
71 property, it will be used instead of the default value; otherwise
72 if the current entry has or inherits a LOG_INTO_DRAWER property,
73 it will be used instead of the default value.
74 The default is the value of the customizable variable `org-clock-into-drawer',
75 which see."
76 (let ((p (org-entry-get nil "CLOCK_INTO_DRAWER" 'inherit))
77 (q (org-entry-get nil "LOG_INTO_DRAWER" 'inherit)))
78 (cond
79 ((or (not (or p q)) (equal p "nil") (equal q "nil")) org-clock-into-drawer)
80 ((or (equal p "t") (equal q "t")) "LOGBOOK")
81 ((not p) q)
82 (t p))))
84 (defcustom org-clock-out-when-done t
85 "When non-nil, clock will be stopped when the clocked entry is marked DONE.
86 DONE here means any DONE-like state.
87 A nil value means clock will keep running until stopped explicitly with
88 `C-c C-x C-o', or until the clock is started in a different item.
89 Instead of t, this can also be a list of TODO states that should trigger
90 clocking out."
91 :group 'org-clock
92 :type '(choice
93 (const :tag "No" nil)
94 (const :tag "Yes, when done" t)
95 (repeat :tag "State list"
96 (string :tag "TODO keyword"))))
98 (defcustom org-clock-rounding-minutes 0
99 "Rounding minutes when clocking in or out.
100 The default value is 0 so that no rounding is done.
101 When set to a non-integer value, use the car of
102 `org-time-stamp-rounding-minutes', like for setting a time-stamp.
104 E.g. if `org-clock-rounding-minutes' is set to 5, time is 14:47
105 and you clock in: then the clock starts at 14:45. If you clock
106 out within the next 5 minutes, the clock line will be removed;
107 if you clock out 8 minutes after your clocked in, the clock
108 out time will be 14:50."
109 :group 'org-clock
110 :version "24.4"
111 :package-version '(Org . "8.0")
112 :type '(choice
113 (integer :tag "Minutes (0 for no rounding)")
114 (symbol :tag "Use `org-time-stamp-rounding-minutes'" 'same-as-time-stamp)))
116 (defcustom org-clock-out-remove-zero-time-clocks nil
117 "Non-nil means remove the clock line when the resulting time is zero."
118 :group 'org-clock
119 :type 'boolean)
121 (defcustom org-clock-in-switch-to-state nil
122 "Set task to a special todo state while clocking it.
123 The value should be the state to which the entry should be
124 switched. If the value is a function, it must take one
125 parameter (the current TODO state of the item) and return the
126 state to switch it to."
127 :group 'org-clock
128 :group 'org-todo
129 :type '(choice
130 (const :tag "Don't force a state" nil)
131 (string :tag "State")
132 (symbol :tag "Function")))
134 (defcustom org-clock-out-switch-to-state nil
135 "Set task to a special todo state after clocking out.
136 The value should be the state to which the entry should be
137 switched. If the value is a function, it must take one
138 parameter (the current TODO state of the item) and return the
139 state to switch it to."
140 :group 'org-clock
141 :group 'org-todo
142 :type '(choice
143 (const :tag "Don't force a state" nil)
144 (string :tag "State")
145 (symbol :tag "Function")))
147 (defcustom org-clock-history-length 5
148 "Number of clock tasks to remember in history."
149 :group 'org-clock
150 :type 'integer)
152 (defcustom org-clock-goto-may-find-recent-task t
153 "Non-nil means `org-clock-goto' can go to recent task if no active clock."
154 :group 'org-clock
155 :type 'boolean)
157 (defcustom org-clock-heading-function nil
158 "When non-nil, should be a function to create `org-clock-heading'.
159 This is the string shown in the mode line when a clock is running.
160 The function is called with point at the beginning of the headline."
161 :group 'org-clock
162 :type '(choice (const nil) (function)))
164 (defcustom org-clock-string-limit 0
165 "Maximum length of clock strings in the mode line. 0 means no limit."
166 :group 'org-clock
167 :type 'integer)
169 (defcustom org-clock-in-resume nil
170 "If non-nil, resume clock when clocking into task with open clock.
171 When clocking into a task with a clock entry which has not been closed,
172 the clock can be resumed from that point."
173 :group 'org-clock
174 :type 'boolean)
176 (defcustom org-clock-persist nil
177 "When non-nil, save the running clock when Emacs is closed.
178 The clock is resumed when Emacs restarts.
179 When this is t, both the running clock, and the entire clock
180 history are saved. When this is the symbol `clock', only the
181 running clock is saved. When this is the symbol `history', only
182 the clock history is saved.
184 When Emacs restarts with saved clock information, the file containing
185 the running clock as well as all files mentioned in the clock history
186 will be visited.
188 All this depends on running `org-clock-persistence-insinuate' in your
189 Emacs initialization file."
190 :group 'org-clock
191 :type '(choice
192 (const :tag "Just the running clock" clock)
193 (const :tag "Just the history" history)
194 (const :tag "Clock and history" t)
195 (const :tag "No persistence" nil)))
197 (defcustom org-clock-persist-file (convert-standard-filename
198 (concat user-emacs-directory "org-clock-save.el"))
199 "File to save clock data to."
200 :group 'org-clock
201 :type 'string)
203 (defcustom org-clock-persist-query-save nil
204 "When non-nil, ask before saving the current clock on exit."
205 :group 'org-clock
206 :type 'boolean)
208 (defcustom org-clock-persist-query-resume t
209 "When non-nil, ask before resuming any stored clock during load."
210 :group 'org-clock
211 :type 'boolean)
213 (defcustom org-clock-sound nil
214 "Sound to use for notifications.
215 Possible values are:
217 nil No sound played
218 t Standard Emacs beep
219 file name Play this sound file, fall back to beep"
220 :group 'org-clock
221 :type '(choice
222 (const :tag "No sound" nil)
223 (const :tag "Standard beep" t)
224 (file :tag "Play sound file")))
226 (define-obsolete-variable-alias 'org-clock-modeline-total
227 'org-clock-mode-line-total "24.3")
229 (defcustom org-clock-mode-line-total 'auto
230 "Default setting for the time included for the mode line clock.
231 This can be overruled locally using the CLOCK_MODELINE_TOTAL property.
232 Allowed values are:
234 current Only the time in the current instance of the clock
235 today All time clocked into this task today
236 repeat All time clocked into this task since last repeat
237 all All time ever recorded for this task
238 auto Automatically, either `all', or `repeat' for repeating tasks"
239 :group 'org-clock
240 :type '(choice
241 (const :tag "Current clock" current)
242 (const :tag "Today's task time" today)
243 (const :tag "Since last repeat" repeat)
244 (const :tag "All task time" all)
245 (const :tag "Automatically, `all' or since `repeat'" auto)))
247 (org-defvaralias 'org-task-overrun-text 'org-clock-task-overrun-text)
248 (defcustom org-clock-task-overrun-text nil
249 "Extra mode line text to indicate that the clock is overrun.
250 The can be nil to indicate that instead of adding text, the clock time
251 should get a different face (`org-mode-line-clock-overrun').
252 When this is a string, it is prepended to the clock string as an indication,
253 also using the face `org-mode-line-clock-overrun'."
254 :group 'org-clock
255 :version "24.1"
256 :type '(choice
257 (const :tag "Just mark the time string" nil)
258 (string :tag "Text to prepend")))
260 (defcustom org-show-notification-handler nil
261 "Function or program to send notification with.
262 The function or program will be called with the notification
263 string as argument."
264 :group 'org-clock
265 :type '(choice
266 (const nil)
267 (string :tag "Program")
268 (function :tag "Function")))
270 (defgroup org-clocktable nil
271 "Options concerning the clock table in Org-mode."
272 :tag "Org Clock Table"
273 :group 'org-clock)
275 (defcustom org-clocktable-defaults
276 (list
277 :maxlevel 2
278 :lang (or (org-bound-and-true-p org-export-default-language) "en")
279 :scope 'file
280 :block nil
281 :wstart 1
282 :mstart 1
283 :tstart nil
284 :tend nil
285 :step nil
286 :stepskip0 nil
287 :fileskip0 nil
288 :tags nil
289 :emphasize nil
290 :link nil
291 :narrow '40!
292 :indent t
293 :formula nil
294 :timestamp nil
295 :level nil
296 :tcolumns nil
297 :formatter nil)
298 "Default properties for clock tables."
299 :group 'org-clock
300 :version "24.1"
301 :type 'plist)
303 (defcustom org-clock-clocktable-formatter 'org-clocktable-write-default
304 "Function to turn clocking data into a table.
305 For more information, see `org-clocktable-write-default'."
306 :group 'org-clocktable
307 :version "24.1"
308 :type 'function)
310 ;; FIXME: translate es and nl last string "Clock summary at"
311 (defcustom org-clock-clocktable-language-setup
312 '(("en" "File" "L" "Timestamp" "Headline" "Time" "ALL" "Total time" "File time" "Clock summary at")
313 ("es" "Archivo" "N" "Fecha y hora" "Tarea" "Tiempo" "TODO" "Tiempo total" "Tiempo archivo" "Clock summary at")
314 ("fr" "Fichier" "N" "Horodatage" "En-tête" "Durée" "TOUT" "Durée totale" "Durée fichier" "Horodatage sommaire à")
315 ("nl" "Bestand" "N" "Tijdstip" "Hoofding" "Duur" "ALLES" "Totale duur" "Bestandstijd" "Clock summary at"))
316 "Terms used in clocktable, translated to different languages."
317 :group 'org-clocktable
318 :version "24.1"
319 :type 'alist)
321 (defcustom org-clock-clocktable-default-properties '(:maxlevel 2 :scope file)
322 "Default properties for new clocktables.
323 These will be inserted into the BEGIN line, to make it easy for users to
324 play with them."
325 :group 'org-clocktable
326 :type 'plist)
328 (defcustom org-clock-idle-time nil
329 "When non-nil, resolve open clocks if the user is idle more than X minutes."
330 :group 'org-clock
331 :type '(choice
332 (const :tag "Never" nil)
333 (integer :tag "After N minutes")))
335 (defcustom org-clock-auto-clock-resolution 'when-no-clock-is-running
336 "When to automatically resolve open clocks found in Org buffers."
337 :group 'org-clock
338 :type '(choice
339 (const :tag "Never" nil)
340 (const :tag "Always" t)
341 (const :tag "When no clock is running" when-no-clock-is-running)))
343 (defcustom org-clock-report-include-clocking-task nil
344 "When non-nil, include the current clocking task time in clock reports."
345 :group 'org-clock
346 :version "24.1"
347 :type 'boolean)
349 (defcustom org-clock-resolve-expert nil
350 "Non-nil means do not show the splash buffer with the clock resolver."
351 :group 'org-clock
352 :version "24.1"
353 :type 'boolean)
355 (defcustom org-clock-continuously nil
356 "Non-nil means to start clocking from the last clock-out time, if any."
357 :type 'boolean
358 :version "24.1"
359 :group 'org-clock)
361 (defcustom org-clock-total-time-cell-format "*%s*"
362 "Format string for the total time cells."
363 :group 'org-clock
364 :version "24.1"
365 :type 'boolean)
367 (defcustom org-clock-file-time-cell-format "*%s*"
368 "Format string for the file time cells."
369 :group 'org-clock
370 :version "24.1"
371 :type 'boolean)
373 (defcustom org-clock-clocked-in-display 'mode-line
374 "When clocked in for a task, org-mode can display the current
375 task and accumulated time in the mode line and/or frame title.
376 Allowed values are:
378 both displays in both mode line and frame title
379 mode-line displays only in mode line (default)
380 frame-title displays only in frame title
381 nil current clock is not displayed"
382 :group 'org-clock
383 :type '(choice
384 (const :tag "Mode line" mode-line)
385 (const :tag "Frame title" frame-title)
386 (const :tag "Both" both)
387 (const :tag "None" nil)))
389 (defcustom org-clock-frame-title-format '(t org-mode-line-string)
390 "The value for `frame-title-format' when clocking in.
392 When `org-clock-clocked-in-display' is set to 'frame-title
393 or 'both, clocking in will replace `frame-title-format' with
394 this value. Clocking out will restore `frame-title-format'.
396 `org-frame-title-string' is a format string using the same
397 specifications than `frame-title-format', which see."
398 :version "24.1"
399 :group 'org-clock
400 :type 'sexp)
402 (defcustom org-clock-x11idle-program-name "x11idle"
403 "Name of the program which prints X11 idle time in milliseconds.
405 You can find x11idle.c in the contrib/scripts directory of the
406 Org git distribution. Or, you can do:
408 sudo apt-get install xprintidle
410 if you are using Debian."
411 :group 'org-clock
412 :version "24.4"
413 :package-version '(Org . "8.0")
414 :type 'string)
416 (defvar org-clock-in-prepare-hook nil
417 "Hook run when preparing the clock.
418 This hook is run before anything happens to the task that
419 you want to clock in. For example, you can use this hook
420 to add an effort property.")
421 (defvar org-clock-in-hook nil
422 "Hook run when starting the clock.")
423 (defvar org-clock-out-hook nil
424 "Hook run when stopping the current clock.")
426 (defvar org-clock-cancel-hook nil
427 "Hook run when cancelling the current clock.")
428 (defvar org-clock-goto-hook nil
429 "Hook run when selecting the currently clocked-in entry.")
430 (defvar org-clock-has-been-used nil
431 "Has the clock been used during the current Emacs session?")
433 ;;; The clock for measuring work time.
435 (defvar org-mode-line-string "")
436 (put 'org-mode-line-string 'risky-local-variable t)
438 (defvar org-clock-mode-line-timer nil)
439 (defvar org-clock-idle-timer nil)
440 (defvar org-clock-heading) ; defined in org.el
441 (defvar org-clock-start-time "")
443 (defvar org-clock-leftover-time nil
444 "If non-nil, user cancelled a clock; this is when leftover time started.")
446 (defvar org-clock-effort ""
447 "Effort estimate of the currently clocking task.")
449 (defvar org-clock-total-time nil
450 "Holds total time, spent previously on currently clocked item.
451 This does not include the time in the currently running clock.")
453 (defvar org-clock-history nil
454 "List of marker pointing to recent clocked tasks.")
456 (defvar org-clock-default-task (make-marker)
457 "Marker pointing to the default task that should clock time.
458 The clock can be made to switch to this task after clocking out
459 of a different task.")
461 (defvar org-clock-interrupted-task (make-marker)
462 "Marker pointing to the task that has been interrupted by the current clock.")
464 (defvar org-clock-mode-line-map (make-sparse-keymap))
465 (define-key org-clock-mode-line-map [mode-line mouse-2] 'org-clock-goto)
466 (define-key org-clock-mode-line-map [mode-line mouse-1] 'org-clock-menu)
468 (defun org-clock-menu ()
469 (interactive)
470 (popup-menu
471 '("Clock"
472 ["Clock out" org-clock-out t]
473 ["Change effort estimate" org-clock-modify-effort-estimate t]
474 ["Go to clock entry" org-clock-goto t]
475 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"])))
477 (defun org-clock-history-push (&optional pos buffer)
478 "Push a marker to the clock history."
479 (setq org-clock-history-length (max 1 (min 35 org-clock-history-length)))
480 (let ((m (move-marker (make-marker)
481 (or pos (point)) (org-base-buffer
482 (or buffer (current-buffer)))))
483 n l)
484 (while (setq n (member m org-clock-history))
485 (move-marker (car n) nil))
486 (setq org-clock-history
487 (delq nil
488 (mapcar (lambda (x) (if (marker-buffer x) x nil))
489 org-clock-history)))
490 (when (>= (setq l (length org-clock-history)) org-clock-history-length)
491 (setq org-clock-history
492 (nreverse
493 (nthcdr (- l org-clock-history-length -1)
494 (nreverse org-clock-history)))))
495 (push m org-clock-history)))
497 (defun org-clock-save-markers-for-cut-and-paste (beg end)
498 "Save relative positions of markers in region."
499 (org-check-and-save-marker org-clock-marker beg end)
500 (org-check-and-save-marker org-clock-hd-marker beg end)
501 (org-check-and-save-marker org-clock-default-task beg end)
502 (org-check-and-save-marker org-clock-interrupted-task beg end)
503 (mapc (lambda (m) (org-check-and-save-marker m beg end))
504 org-clock-history))
506 (defun org-clocking-buffer ()
507 "Return the clocking buffer if we are currently clocking a task or nil."
508 (marker-buffer org-clock-marker))
510 (defun org-clocking-p ()
511 "Return t when clocking a task."
512 (not (equal (org-clocking-buffer) nil)))
514 (defvar org-clock-before-select-task-hook nil
515 "Hook called in task selection just before prompting the user.")
517 (defun org-clock-select-task (&optional prompt)
518 "Select a task that was recently associated with clocking."
519 (interactive)
520 (let (och chl sel-list rpl (i 0) s)
521 ;; Remove successive dups from the clock history to consider
522 (mapc (lambda (c) (if (not (equal c (car och))) (push c och)))
523 org-clock-history)
524 (setq och (reverse och) chl (length och))
525 (if (zerop chl)
526 (user-error "No recent clock")
527 (save-window-excursion
528 (org-switch-to-buffer-other-window
529 (get-buffer-create "*Clock Task Select*"))
530 (erase-buffer)
531 (when (marker-buffer org-clock-default-task)
532 (insert (org-add-props "Default Task\n" nil 'face 'bold))
533 (setq s (org-clock-insert-selection-line ?d org-clock-default-task))
534 (push s sel-list))
535 (when (marker-buffer org-clock-interrupted-task)
536 (insert (org-add-props "The task interrupted by starting the last one\n" nil 'face 'bold))
537 (setq s (org-clock-insert-selection-line ?i org-clock-interrupted-task))
538 (push s sel-list))
539 (when (org-clocking-p)
540 (insert (org-add-props "Current Clocking Task\n" nil 'face 'bold))
541 (setq s (org-clock-insert-selection-line ?c org-clock-marker))
542 (push s sel-list))
543 (insert (org-add-props "Recent Tasks\n" nil 'face 'bold))
544 (mapc
545 (lambda (m)
546 (when (marker-buffer m)
547 (setq i (1+ i)
548 s (org-clock-insert-selection-line
549 (if (< i 10)
550 (+ i ?0)
551 (+ i (- ?A 10))) m))
552 (if (fboundp 'int-to-char) (setf (car s) (int-to-char (car s))))
553 (push s sel-list)))
554 och)
555 (run-hooks 'org-clock-before-select-task-hook)
556 (goto-char (point-min))
557 ;; Set min-height relatively to circumvent a possible but in
558 ;; `fit-window-to-buffer'
559 (fit-window-to-buffer nil nil (if (< chl 10) chl (+ 5 chl)))
560 (message (or prompt "Select task for clocking:"))
561 (setq cursor-type nil rpl (read-char-exclusive))
562 (cond
563 ((eq rpl ?q) nil)
564 ((eq rpl ?x) nil)
565 ((assoc rpl sel-list) (cdr (assoc rpl sel-list)))
566 (t (user-error "Invalid task choice %c" rpl)))))))
568 (defun org-clock-insert-selection-line (i marker)
569 "Insert a line for the clock selection menu.
570 And return a cons cell with the selection character integer and the marker
571 pointing to it."
572 (when (marker-buffer marker)
573 (let (file cat task heading prefix)
574 (with-current-buffer (org-base-buffer (marker-buffer marker))
575 (save-excursion
576 (save-restriction
577 (widen)
578 (ignore-errors
579 (goto-char marker)
580 (setq file (buffer-file-name (marker-buffer marker))
581 cat (org-get-category)
582 heading (org-get-heading 'notags)
583 prefix (save-excursion
584 (org-back-to-heading t)
585 (looking-at org-outline-regexp)
586 (match-string 0))
587 task (substring
588 (org-fontify-like-in-org-mode
589 (concat prefix heading)
590 org-odd-levels-only)
591 (length prefix)))))))
592 (when (and cat task)
593 (insert (format "[%c] %-12s %s\n" i cat task))
594 (cons i marker)))))
596 (defvar org-clock-task-overrun nil
597 "Internal flag indicating if the clock has overrun the planned time.")
598 (defvar org-clock-update-period 60
599 "Number of seconds between mode line clock string updates.")
601 (defun org-clock-get-clock-string ()
602 "Form a clock-string, that will be shown in the mode line.
603 If an effort estimate was defined for the current item, use
604 01:30/01:50 format (clocked/estimated).
605 If not, show simply the clocked time like 01:50."
606 (let ((clocked-time (org-clock-get-clocked-time)))
607 (if org-clock-effort
608 (let* ((effort-in-minutes
609 (org-duration-string-to-minutes org-clock-effort))
610 (work-done-str
611 (org-propertize
612 (org-minutes-to-clocksum-string clocked-time)
613 'face (if (and org-clock-task-overrun (not org-clock-task-overrun-text))
614 'org-mode-line-clock-overrun 'org-mode-line-clock)))
615 (effort-str (org-minutes-to-clocksum-string effort-in-minutes))
616 (clockstr (org-propertize
617 (concat " [%s/" effort-str
618 "] (" (replace-regexp-in-string "%" "%%" org-clock-heading) ")")
619 'face 'org-mode-line-clock)))
620 (format clockstr work-done-str))
621 (org-propertize (concat "[" (org-minutes-to-clocksum-string clocked-time)
622 (format " (%s)" org-clock-heading) "]")
623 'face 'org-mode-line-clock))))
625 (defun org-clock-get-last-clock-out-time ()
626 "Get the last clock-out time for the current subtree."
627 (save-excursion
628 (let ((end (save-excursion (org-end-of-subtree))))
629 (when (re-search-forward (concat org-clock-string
630 ".*\\]--\\(\\[[^]]+\\]\\)") end t)
631 (org-time-string-to-time (match-string 1))))))
633 (defun org-clock-update-mode-line ()
634 (if org-clock-effort
635 (org-clock-notify-once-if-expired)
636 (setq org-clock-task-overrun nil))
637 (setq org-mode-line-string
638 (org-propertize
639 (let ((clock-string (org-clock-get-clock-string))
640 (help-text "Org-mode clock is running.\nmouse-1 shows a menu\nmouse-2 will jump to task"))
641 (if (and (> org-clock-string-limit 0)
642 (> (length clock-string) org-clock-string-limit))
643 (org-propertize
644 (substring clock-string 0 org-clock-string-limit)
645 'help-echo (concat help-text ": " org-clock-heading))
646 (org-propertize clock-string 'help-echo help-text)))
647 'local-map org-clock-mode-line-map
648 'mouse-face (if (featurep 'xemacs) 'highlight 'mode-line-highlight)))
649 (if (and org-clock-task-overrun org-clock-task-overrun-text)
650 (setq org-mode-line-string
651 (concat (org-propertize
652 org-clock-task-overrun-text
653 'face 'org-mode-line-clock-overrun) org-mode-line-string)))
654 (force-mode-line-update))
656 (defun org-clock-get-clocked-time ()
657 "Get the clocked time for the current item in minutes.
658 The time returned includes the time spent on this task in
659 previous clocking intervals."
660 (let ((currently-clocked-time
661 (floor (- (org-float-time)
662 (org-float-time org-clock-start-time)) 60)))
663 (+ currently-clocked-time (or org-clock-total-time 0))))
665 (defun org-clock-modify-effort-estimate (&optional value)
666 "Add to or set the effort estimate of the item currently being clocked.
667 VALUE can be a number of minutes, or a string with format hh:mm or mm.
668 When the string starts with a + or a - sign, the current value of the effort
669 property will be changed by that amount. If the effort value is expressed
670 as an `org-effort-durations' (e.g. \"3h\"), the modificied value will be
671 converted to a hh:mm duration.
673 This command will update the \"Effort\" property of the currently
674 clocked item, and the value displayed in the mode line."
675 (interactive)
676 (if (org-clock-is-active)
677 (let ((current org-clock-effort) sign)
678 (unless value
679 ;; Prompt user for a value or a change
680 (setq value
681 (read-string
682 (format "Set effort (hh:mm or mm%s): "
683 (if current
684 (format ", prefix + to add to %s" org-clock-effort)
685 "")))))
686 (when (stringp value)
687 ;; A string. See if it is a delta
688 (setq sign (string-to-char value))
689 (if (member sign '(?- ?+))
690 (setq current (org-duration-string-to-minutes current)
691 value (substring value 1))
692 (setq current 0))
693 (setq value (org-duration-string-to-minutes value))
694 (if (equal ?- sign)
695 (setq value (- current value))
696 (if (equal ?+ sign) (setq value (+ current value)))))
697 (setq value (max 0 value)
698 org-clock-effort (org-minutes-to-clocksum-string value))
699 (org-entry-put org-clock-marker "Effort" org-clock-effort)
700 (org-clock-update-mode-line)
701 (message "Effort is now %s" org-clock-effort))
702 (message "Clock is not currently active")))
704 (defvar org-clock-notification-was-shown nil
705 "Shows if we have shown notification already.")
707 (defun org-clock-notify-once-if-expired ()
708 "Show notification if we spent more time than we estimated before.
709 Notification is shown only once."
710 (when (org-clocking-p)
711 (let ((effort-in-minutes (org-duration-string-to-minutes org-clock-effort))
712 (clocked-time (org-clock-get-clocked-time)))
713 (if (setq org-clock-task-overrun
714 (if (or (null effort-in-minutes) (zerop effort-in-minutes))
716 (>= clocked-time effort-in-minutes)))
717 (unless org-clock-notification-was-shown
718 (setq org-clock-notification-was-shown t)
719 (org-notify
720 (format "Task '%s' should be finished by now. (%s)"
721 org-clock-heading org-clock-effort) t))
722 (setq org-clock-notification-was-shown nil)))))
724 (defun org-notify (notification &optional play-sound)
725 "Send a NOTIFICATION and maybe PLAY-SOUND.
726 If PLAY-SOUND is non-nil, it overrides `org-clock-sound'."
727 (org-show-notification notification)
728 (if play-sound (org-clock-play-sound play-sound)))
730 (defun org-show-notification (notification)
731 "Show notification.
732 Use `org-show-notification-handler' if defined,
733 use libnotify if available, or fall back on a message."
734 (cond ((functionp org-show-notification-handler)
735 (funcall org-show-notification-handler notification))
736 ((stringp org-show-notification-handler)
737 (start-process "emacs-timer-notification" nil
738 org-show-notification-handler notification))
739 ((fboundp 'notifications-notify)
740 (notifications-notify
741 :title "Org-mode message"
742 :body notification
743 ;; FIXME how to link to the Org icon?
744 ;; :app-icon "~/.emacs.d/icons/mail.png"
745 :urgency 'low))
746 ((executable-find "notify-send")
747 (start-process "emacs-timer-notification" nil
748 "notify-send" notification))
749 ;; Maybe the handler will send a message, so only use message as
750 ;; a fall back option
751 (t (message "%s" notification))))
753 (defun org-clock-play-sound (&optional clock-sound)
754 "Play sound as configured by `org-clock-sound'.
755 Use alsa's aplay tool if available.
756 If CLOCK-SOUND is non-nil, it overrides `org-clock-sound'."
757 (let ((org-clock-sound (or clock-sound org-clock-sound)))
758 (cond
759 ((not org-clock-sound))
760 ((eq org-clock-sound t) (beep t) (beep t))
761 ((stringp org-clock-sound)
762 (let ((file (expand-file-name org-clock-sound)))
763 (if (file-exists-p file)
764 (if (executable-find "aplay")
765 (start-process "org-clock-play-notification" nil
766 "aplay" file)
767 (condition-case nil
768 (play-sound-file file)
769 (error (beep t) (beep t))))))))))
771 (defvar org-clock-mode-line-entry nil
772 "Information for the mode line about the running clock.")
774 (defun org-find-open-clocks (file)
775 "Search through the given file and find all open clocks."
776 (let ((buf (or (get-file-buffer file)
777 (find-file-noselect file)))
778 clocks)
779 (with-current-buffer buf
780 (save-excursion
781 (goto-char (point-min))
782 (while (re-search-forward "CLOCK: \\(\\[.*?\\]\\)$" nil t)
783 (push (cons (copy-marker (match-end 1) t)
784 (org-time-string-to-time (match-string 1))) clocks))))
785 clocks))
787 (defsubst org-is-active-clock (clock)
788 "Return t if CLOCK is the currently active clock."
789 (and (org-clock-is-active)
790 (= org-clock-marker (car clock))))
792 (defmacro org-with-clock-position (clock &rest forms)
793 "Evaluate FORMS with CLOCK as the current active clock."
794 `(with-current-buffer (marker-buffer (car ,clock))
795 (save-excursion
796 (save-restriction
797 (widen)
798 (goto-char (car ,clock))
799 (beginning-of-line)
800 ,@forms))))
801 (def-edebug-spec org-with-clock-position (form body))
802 (put 'org-with-clock-position 'lisp-indent-function 1)
804 (defmacro org-with-clock (clock &rest forms)
805 "Evaluate FORMS with CLOCK as the current active clock.
806 This macro also protects the current active clock from being altered."
807 `(org-with-clock-position ,clock
808 (let ((org-clock-start-time (cdr ,clock))
809 (org-clock-total-time)
810 (org-clock-history)
811 (org-clock-effort)
812 (org-clock-marker (car ,clock))
813 (org-clock-hd-marker (save-excursion
814 (outline-back-to-heading t)
815 (point-marker))))
816 ,@forms)))
817 (def-edebug-spec org-with-clock (form body))
818 (put 'org-with-clock 'lisp-indent-function 1)
820 (defsubst org-clock-clock-in (clock &optional resume start-time)
821 "Clock in to the clock located by CLOCK.
822 If necessary, clock-out of the currently active clock."
823 (org-with-clock-position clock
824 (let ((org-clock-in-resume (or resume org-clock-in-resume)))
825 (org-clock-in nil start-time))))
827 (defsubst org-clock-clock-out (clock &optional fail-quietly at-time)
828 "Clock out of the clock located by CLOCK."
829 (let ((temp (copy-marker (car clock)
830 (marker-insertion-type (car clock)))))
831 (if (org-is-active-clock clock)
832 (org-clock-out nil fail-quietly at-time)
833 (org-with-clock clock
834 (org-clock-out nil fail-quietly at-time)))
835 (setcar clock temp)))
837 (defsubst org-clock-clock-cancel (clock)
838 "Cancel the clock located by CLOCK."
839 (let ((temp (copy-marker (car clock)
840 (marker-insertion-type (car clock)))))
841 (if (org-is-active-clock clock)
842 (org-clock-cancel)
843 (org-with-clock clock
844 (org-clock-cancel)))
845 (setcar clock temp)))
847 (defvar org-clock-clocking-in nil)
848 (defvar org-clock-resolving-clocks nil)
849 (defvar org-clock-resolving-clocks-due-to-idleness nil)
851 (defun org-clock-resolve-clock (clock resolve-to clock-out-time
852 &optional close-p restart-p fail-quietly)
853 "Resolve `CLOCK' given the time `RESOLVE-TO', and the present.
854 `CLOCK' is a cons cell of the form (MARKER START-TIME)."
855 (let ((org-clock-resolving-clocks t))
856 (cond
857 ((null resolve-to)
858 (org-clock-clock-cancel clock)
859 (if (and restart-p (not org-clock-clocking-in))
860 (org-clock-clock-in clock)))
862 ((eq resolve-to 'now)
863 (if restart-p
864 (error "RESTART-P is not valid here"))
865 (if (or close-p org-clock-clocking-in)
866 (org-clock-clock-out clock fail-quietly)
867 (unless (org-is-active-clock clock)
868 (org-clock-clock-in clock t))))
870 ((not (time-less-p resolve-to (current-time)))
871 (error "RESOLVE-TO must refer to a time in the past"))
874 (if restart-p
875 (error "RESTART-P is not valid here"))
876 (org-clock-clock-out clock fail-quietly (or clock-out-time
877 resolve-to))
878 (unless org-clock-clocking-in
879 (if close-p
880 (setq org-clock-leftover-time (and (null clock-out-time)
881 resolve-to))
882 (org-clock-clock-in clock nil (and clock-out-time
883 resolve-to))))))))
885 (defun org-clock-jump-to-current-clock (&optional effective-clock)
886 (interactive)
887 (let ((org-clock-into-drawer (org-clock-into-drawer))
888 (clock (or effective-clock (cons org-clock-marker
889 org-clock-start-time))))
890 (unless (marker-buffer (car clock))
891 (error "No clock is currently running"))
892 (org-with-clock clock (org-clock-goto))
893 (with-current-buffer (marker-buffer (car clock))
894 (goto-char (car clock))
895 (if org-clock-into-drawer
896 (let ((logbook
897 (if (stringp org-clock-into-drawer)
898 (concat ":" org-clock-into-drawer ":")
899 ":LOGBOOK:")))
900 (ignore-errors
901 (outline-flag-region
902 (save-excursion
903 (outline-back-to-heading t)
904 (search-forward logbook)
905 (goto-char (match-beginning 0)))
906 (save-excursion
907 (outline-back-to-heading t)
908 (search-forward logbook)
909 (search-forward ":END:")
910 (goto-char (match-end 0)))
911 nil)))))))
913 (defun org-clock-resolve (clock &optional prompt-fn last-valid fail-quietly)
914 "Resolve an open org-mode clock.
915 An open clock was found, with `dangling' possibly being non-nil.
916 If this function was invoked with a prefix argument, non-dangling
917 open clocks are ignored. The given clock requires some sort of
918 user intervention to resolve it, either because a clock was left
919 dangling or due to an idle timeout. The clock resolution can
920 either be:
922 (a) deleted, the user doesn't care about the clock
923 (b) restarted from the current time (if no other clock is open)
924 (c) closed, giving the clock X minutes
925 (d) closed and then restarted
926 (e) resumed, as if the user had never left
928 The format of clock is (CONS MARKER START-TIME), where MARKER
929 identifies the buffer and position the clock is open at (and
930 thus, the heading it's under), and START-TIME is when the clock
931 was started."
932 (assert clock)
933 (let* ((ch
934 (save-window-excursion
935 (save-excursion
936 (unless org-clock-resolving-clocks-due-to-idleness
937 (org-clock-jump-to-current-clock clock))
938 (unless org-clock-resolve-expert
939 (with-output-to-temp-buffer "*Org Clock*"
940 (princ "Select a Clock Resolution Command:
942 i/q Ignore this question; the same as keeping all the idle time.
944 k/K Keep X minutes of the idle time (default is all). If this
945 amount is less than the default, you will be clocked out
946 that many minutes after the time that idling began, and then
947 clocked back in at the present time.
949 g/G Indicate that you \"got back\" X minutes ago. This is quite
950 different from 'k': it clocks you out from the beginning of
951 the idle period and clock you back in X minutes ago.
953 s/S Subtract the idle time from the current clock. This is the
954 same as keeping 0 minutes.
956 C Cancel the open timer altogether. It will be as though you
957 never clocked in.
959 j/J Jump to the current clock, to make manual adjustments.
961 For all these options, using uppercase makes your final state
962 to be CLOCKED OUT.")))
963 (org-fit-window-to-buffer (get-buffer-window "*Org Clock*"))
964 (let (char-pressed)
965 (when (featurep 'xemacs)
966 (message (concat (funcall prompt-fn clock)
967 " [jkKgGsScCiq]? "))
968 (setq char-pressed (read-char-exclusive)))
969 (while (or (null char-pressed)
970 (and (not (memq char-pressed
971 '(?k ?K ?g ?G ?s ?S ?C
972 ?j ?J ?i ?q)))
973 (or (ding) t)))
974 (setq char-pressed
975 (read-char (concat (funcall prompt-fn clock)
976 " [jkKgGSscCiq]? ")
977 nil 45)))
978 (and (not (memq char-pressed '(?i ?q))) char-pressed)))))
979 (default
980 (floor (/ (org-float-time
981 (time-subtract (current-time) last-valid)) 60)))
982 (keep
983 (and (memq ch '(?k ?K))
984 (read-number "Keep how many minutes? " default)))
985 (gotback
986 (and (memq ch '(?g ?G))
987 (read-number "Got back how many minutes ago? " default)))
988 (subtractp (memq ch '(?s ?S)))
989 (barely-started-p (< (- (org-float-time last-valid)
990 (org-float-time (cdr clock))) 45))
991 (start-over (and subtractp barely-started-p)))
992 (cond
993 ((memq ch '(?j ?J))
994 (if (eq ch ?J)
995 (org-clock-resolve-clock clock 'now nil t nil fail-quietly))
996 (org-clock-jump-to-current-clock clock))
997 ((or (null ch)
998 (not (memq ch '(?k ?K ?g ?G ?s ?S ?C))))
999 (message ""))
1001 (org-clock-resolve-clock
1002 clock (cond
1003 ((or (eq ch ?C)
1004 ;; If the time on the clock was less than a minute before
1005 ;; the user went away, and they've ask to subtract all the
1006 ;; time...
1007 start-over)
1008 nil)
1009 ((or subtractp
1010 (and gotback (= gotback 0)))
1011 last-valid)
1012 ((or (and keep (= keep default))
1013 (and gotback (= gotback default)))
1014 'now)
1015 (keep
1016 (time-add last-valid (seconds-to-time (* 60 keep))))
1017 (gotback
1018 (time-subtract (current-time)
1019 (seconds-to-time (* 60 gotback))))
1021 (error "Unexpected, please report this as a bug")))
1022 (and gotback last-valid)
1023 (memq ch '(?K ?G ?S))
1024 (and start-over
1025 (not (memq ch '(?K ?G ?S ?C))))
1026 fail-quietly)))))
1028 ;;;###autoload
1029 (defun org-resolve-clocks (&optional only-dangling-p prompt-fn last-valid)
1030 "Resolve all currently open org-mode clocks.
1031 If `only-dangling-p' is non-nil, only ask to resolve dangling
1032 \(i.e., not currently open and valid) clocks."
1033 (interactive "P")
1034 (unless org-clock-resolving-clocks
1035 (let ((org-clock-resolving-clocks t))
1036 (dolist (file (org-files-list))
1037 (let ((clocks (org-find-open-clocks file)))
1038 (dolist (clock clocks)
1039 (let ((dangling (or (not (org-clock-is-active))
1040 (/= (car clock) org-clock-marker))))
1041 (if (or (not only-dangling-p) dangling)
1042 (org-clock-resolve
1043 clock
1044 (or prompt-fn
1045 (function
1046 (lambda (clock)
1047 (format
1048 "Dangling clock started %d mins ago"
1049 (floor
1050 (/ (- (org-float-time (current-time))
1051 (org-float-time (cdr clock))) 60))))))
1052 (or last-valid
1053 (cdr clock)))))))))))
1055 (defun org-emacs-idle-seconds ()
1056 "Return the current Emacs idle time in seconds, or nil if not idle."
1057 (let ((idle-time (current-idle-time)))
1058 (if idle-time
1059 (org-float-time idle-time)
1060 0)))
1062 (defun org-mac-idle-seconds ()
1063 "Return the current Mac idle time in seconds."
1064 (string-to-number (shell-command-to-string "ioreg -c IOHIDSystem | perl -ane 'if (/Idle/) {$idle=(pop @F)/1000000000; print $idle; last}'")))
1066 (defvar org-x11idle-exists-p
1067 ;; Check that x11idle exists
1068 (and (eq window-system 'x)
1069 (eq (call-process-shell-command "command" nil nil nil "-v" org-clock-x11idle-program-name) 0)
1070 ;; Check that x11idle can retrieve the idle time
1071 (eq (call-process-shell-command org-clock-x11idle-program-name nil nil nil) 0)))
1073 (defun org-x11-idle-seconds ()
1074 "Return the current X11 idle time in seconds."
1075 (/ (string-to-number (shell-command-to-string org-clock-x11idle-program-name)) 1000))
1077 (defun org-user-idle-seconds ()
1078 "Return the number of seconds the user has been idle for.
1079 This routine returns a floating point number."
1080 (cond
1081 ((eq system-type 'darwin)
1082 (org-mac-idle-seconds))
1083 ((and (eq window-system 'x) org-x11idle-exists-p)
1084 (org-x11-idle-seconds))
1086 (org-emacs-idle-seconds))))
1088 (defvar org-clock-user-idle-seconds)
1090 (defun org-resolve-clocks-if-idle ()
1091 "Resolve all currently open org-mode clocks.
1092 This is performed after `org-clock-idle-time' minutes, to check
1093 if the user really wants to stay clocked in after being idle for
1094 so long."
1095 (when (and org-clock-idle-time (not org-clock-resolving-clocks)
1096 org-clock-marker (marker-buffer org-clock-marker))
1097 (let* ((org-clock-user-idle-seconds (org-user-idle-seconds))
1098 (org-clock-user-idle-start
1099 (time-subtract (current-time)
1100 (seconds-to-time org-clock-user-idle-seconds)))
1101 (org-clock-resolving-clocks-due-to-idleness t))
1102 (if (> org-clock-user-idle-seconds (* 60 org-clock-idle-time))
1103 (org-clock-resolve
1104 (cons org-clock-marker
1105 org-clock-start-time)
1106 (function
1107 (lambda (clock)
1108 (format "Clocked in & idle for %.1f mins"
1109 (/ (org-float-time
1110 (time-subtract (current-time)
1111 org-clock-user-idle-start))
1112 60.0))))
1113 org-clock-user-idle-start)))))
1115 (defvar org-clock-current-task nil "Task currently clocked in.")
1116 (defvar org-clock-out-time nil) ; store the time of the last clock-out
1118 ;;;###autoload
1119 (defun org-clock-in (&optional select start-time)
1120 "Start the clock on the current item.
1121 If necessary, clock-out of the currently active clock.
1122 With a prefix argument SELECT (\\[universal-argument]), offer a list of recently clocked
1123 tasks to clock into. When SELECT is \\[universal-argument] \\[universal-argument], clock into the current task
1124 and mark it as the default task, a special task that will always be offered
1125 in the clocking selection, associated with the letter `d'.
1126 When SELECT is \\[universal-argument] \\[universal-argument] \\[universal-argument], \
1127 clock in by using the last clock-out
1128 time as the start time \(see `org-clock-continuously' to
1129 make this the default behavior.)"
1130 (interactive "P")
1131 (setq org-clock-notification-was-shown nil)
1132 (org-refresh-properties org-effort-property 'org-effort)
1133 (catch 'abort
1134 (let ((interrupting (and (not org-clock-resolving-clocks-due-to-idleness)
1135 (org-clocking-p)))
1136 ts selected-task target-pos (msg-extra "")
1137 (leftover (and (not org-clock-resolving-clocks)
1138 org-clock-leftover-time)))
1140 (when (and org-clock-auto-clock-resolution
1141 (or (not interrupting)
1142 (eq t org-clock-auto-clock-resolution))
1143 (not org-clock-clocking-in)
1144 (not org-clock-resolving-clocks))
1145 (setq org-clock-leftover-time nil)
1146 (let ((org-clock-clocking-in t))
1147 (org-resolve-clocks))) ; check if any clocks are dangling
1149 (when (equal select '(64))
1150 ;; Set start-time to `org-clock-out-time'
1151 (let ((org-clock-continuously t))
1152 (org-clock-in nil org-clock-out-time)))
1154 (when (equal select '(4))
1155 (setq selected-task (org-clock-select-task "Clock-in on task: "))
1156 (if selected-task
1157 (setq selected-task (copy-marker selected-task))
1158 (error "Abort")))
1160 (when (equal select '(16))
1161 ;; Mark as default clocking task
1162 (org-clock-mark-default-task))
1164 (when interrupting
1165 ;; We are interrupting the clocking of a different task.
1166 ;; Save a marker to this task, so that we can go back.
1167 ;; First check if we are trying to clock into the same task!
1168 (when (save-excursion
1169 (unless selected-task
1170 (org-back-to-heading t))
1171 (and (equal (marker-buffer org-clock-hd-marker)
1172 (if selected-task
1173 (marker-buffer selected-task)
1174 (current-buffer)))
1175 (= (marker-position org-clock-hd-marker)
1176 (if selected-task
1177 (marker-position selected-task)
1178 (point)))
1179 (equal org-clock-current-task (nth 4 (org-heading-components)))))
1180 (message "Clock continues in \"%s\"" org-clock-heading)
1181 (throw 'abort nil))
1182 (move-marker org-clock-interrupted-task
1183 (marker-position org-clock-marker)
1184 (marker-buffer org-clock-marker))
1185 (let ((org-clock-clocking-in t))
1186 (org-clock-out nil t)))
1188 ;; Clock in at which position?
1189 (setq target-pos
1190 (if (and (eobp) (not (org-at-heading-p)))
1191 (point-at-bol 0)
1192 (point)))
1193 (save-excursion
1194 (when (and selected-task (marker-buffer selected-task))
1195 ;; There is a selected task, move to the correct buffer
1196 ;; and set the new target position.
1197 (set-buffer (org-base-buffer (marker-buffer selected-task)))
1198 (setq target-pos (marker-position selected-task))
1199 (move-marker selected-task nil))
1200 (save-excursion
1201 (save-restriction
1202 (widen)
1203 (goto-char target-pos)
1204 (org-back-to-heading t)
1205 (or interrupting (move-marker org-clock-interrupted-task nil))
1206 (run-hooks 'org-clock-in-prepare-hook)
1207 (org-clock-history-push)
1208 (setq org-clock-current-task (nth 4 (org-heading-components)))
1209 (cond ((functionp org-clock-in-switch-to-state)
1210 (looking-at org-complex-heading-regexp)
1211 (let ((newstate (funcall org-clock-in-switch-to-state
1212 (match-string 2))))
1213 (if newstate (org-todo newstate))))
1214 ((and org-clock-in-switch-to-state
1215 (not (looking-at (concat org-outline-regexp "[ \t]*"
1216 org-clock-in-switch-to-state
1217 "\\>"))))
1218 (org-todo org-clock-in-switch-to-state)))
1219 (setq org-clock-heading
1220 (cond ((and org-clock-heading-function
1221 (functionp org-clock-heading-function))
1222 (funcall org-clock-heading-function))
1223 ((nth 4 (org-heading-components))
1224 (replace-regexp-in-string
1225 "\\[\\[.*?\\]\\[\\(.*?\\)\\]\\]" "\\1"
1226 (match-string-no-properties 4)))
1227 (t "???")))
1228 (org-clock-find-position org-clock-in-resume)
1229 (cond
1230 ((and org-clock-in-resume
1231 (looking-at
1232 (concat "^[ \t]*" org-clock-string
1233 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1234 " *\\sw+\.? +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
1235 (message "Matched %s" (match-string 1))
1236 (setq ts (concat "[" (match-string 1) "]"))
1237 (goto-char (match-end 1))
1238 (setq org-clock-start-time
1239 (apply 'encode-time
1240 (org-parse-time-string (match-string 1))))
1241 (setq org-clock-effort (org-entry-get (point) org-effort-property))
1242 (setq org-clock-total-time (org-clock-sum-current-item
1243 (org-clock-get-sum-start))))
1244 ((eq org-clock-in-resume 'auto-restart)
1245 ;; called from org-clock-load during startup,
1246 ;; do not interrupt, but warn!
1247 (message "Cannot restart clock because task does not contain unfinished clock")
1248 (ding)
1249 (sit-for 2)
1250 (throw 'abort nil))
1252 (insert-before-markers "\n")
1253 (backward-char 1)
1254 (org-indent-line)
1255 (when (and (save-excursion
1256 (end-of-line 0)
1257 (org-in-item-p)))
1258 (beginning-of-line 1)
1259 (org-indent-line-to (- (org-get-indentation) 2)))
1260 (insert org-clock-string " ")
1261 (setq org-clock-effort (org-entry-get (point) org-effort-property))
1262 (setq org-clock-total-time (org-clock-sum-current-item
1263 (org-clock-get-sum-start)))
1264 (setq org-clock-start-time
1265 (or (and org-clock-continuously org-clock-out-time)
1266 (and leftover
1267 (y-or-n-p
1268 (format
1269 "You stopped another clock %d mins ago; start this one from then? "
1270 (/ (- (org-float-time
1271 (org-current-time org-clock-rounding-minutes t))
1272 (org-float-time leftover)) 60)))
1273 leftover)
1274 start-time
1275 (org-current-time org-clock-rounding-minutes t)))
1276 (setq ts (org-insert-time-stamp org-clock-start-time
1277 'with-hm 'inactive))))
1278 (move-marker org-clock-marker (point) (buffer-base-buffer))
1279 (move-marker org-clock-hd-marker
1280 (save-excursion (org-back-to-heading t) (point))
1281 (buffer-base-buffer))
1282 (setq org-clock-has-been-used t)
1283 ;; add to mode line
1284 (when (or (eq org-clock-clocked-in-display 'mode-line)
1285 (eq org-clock-clocked-in-display 'both))
1286 (or global-mode-string (setq global-mode-string '("")))
1287 (or (memq 'org-mode-line-string global-mode-string)
1288 (setq global-mode-string
1289 (append global-mode-string '(org-mode-line-string)))))
1290 ;; add to frame title
1291 (when (or (eq org-clock-clocked-in-display 'frame-title)
1292 (eq org-clock-clocked-in-display 'both))
1293 (setq frame-title-format org-clock-frame-title-format))
1294 (org-clock-update-mode-line)
1295 (when org-clock-mode-line-timer
1296 (cancel-timer org-clock-mode-line-timer)
1297 (setq org-clock-mode-line-timer nil))
1298 (when org-clock-clocked-in-display
1299 (setq org-clock-mode-line-timer
1300 (run-with-timer org-clock-update-period
1301 org-clock-update-period
1302 'org-clock-update-mode-line)))
1303 (when org-clock-idle-timer
1304 (cancel-timer org-clock-idle-timer)
1305 (setq org-clock-idle-timer nil))
1306 (setq org-clock-idle-timer
1307 (run-with-timer 60 60 'org-resolve-clocks-if-idle))
1308 (message "Clock starts at %s - %s" ts msg-extra)
1309 (run-hooks 'org-clock-in-hook)))))))
1311 ;;;###autoload
1312 (defun org-clock-in-last (&optional arg)
1313 "Clock in the last closed clocked item.
1314 When already clocking in, send an warning.
1315 With a universal prefix argument, select the task you want to
1316 clock in from the last clocked in tasks.
1317 With two universal prefix arguments, start clocking using the
1318 last clock-out time, if any.
1319 With three universal prefix arguments, interactively prompt
1320 for a todo state to switch to, overriding the existing value
1321 `org-clock-in-switch-to-state'."
1322 (interactive "P")
1323 (if (equal arg '(4))
1324 (org-clock-in (org-clock-select-task))
1325 (let ((start-time (if (or org-clock-continuously (equal arg '(16)))
1326 (or org-clock-out-time
1327 (org-current-time org-clock-rounding-minutes t))
1328 (org-current-time org-clock-rounding-minutes t))))
1329 (if (null org-clock-history)
1330 (message "No last clock")
1331 (let ((org-clock-in-switch-to-state
1332 (if (and (not org-clock-current-task) (equal arg '(64)))
1333 (completing-read "Switch to state: "
1334 (and org-clock-history
1335 (with-current-buffer
1336 (marker-buffer (car org-clock-history))
1337 org-todo-keywords-1)))
1338 org-clock-in-switch-to-state))
1339 (already-clocking org-clock-current-task))
1340 (org-clock-clock-in (list (car org-clock-history)) nil start-time)
1341 (or already-clocking
1342 ;; Don't display a message if we are already clocking in
1343 (message "Clocking back: %s (in %s)"
1344 org-clock-current-task
1345 (buffer-name (marker-buffer org-clock-marker)))))))))
1347 (defun org-clock-mark-default-task ()
1348 "Mark current task as default task."
1349 (interactive)
1350 (save-excursion
1351 (org-back-to-heading t)
1352 (move-marker org-clock-default-task (point))))
1354 (defvar msg-extra)
1355 (defun org-clock-get-sum-start ()
1356 "Return the time from which clock times should be counted.
1357 This is for the currently running clock as it is displayed
1358 in the mode line. This function looks at the properties
1359 LAST_REPEAT and in particular CLOCK_MODELINE_TOTAL and the
1360 corresponding variable `org-clock-mode-line-total' and then
1361 decides which time to use."
1362 (let ((cmt (or (org-entry-get nil "CLOCK_MODELINE_TOTAL")
1363 (symbol-name org-clock-mode-line-total)))
1364 (lr (org-entry-get nil "LAST_REPEAT")))
1365 (cond
1366 ((equal cmt "current")
1367 (setq msg-extra "showing time in current clock instance")
1368 (current-time))
1369 ((equal cmt "today")
1370 (setq msg-extra "showing today's task time.")
1371 (let* ((dt (decode-time (current-time))))
1372 (setq dt (append (list 0 0 0) (nthcdr 3 dt)))
1373 (if org-extend-today-until
1374 (setf (nth 2 dt) org-extend-today-until))
1375 (apply 'encode-time dt)))
1376 ((or (equal cmt "all")
1377 (and (or (not cmt) (equal cmt "auto"))
1378 (not lr)))
1379 (setq msg-extra "showing entire task time.")
1380 nil)
1381 ((or (equal cmt "repeat")
1382 (and (or (not cmt) (equal cmt "auto"))
1383 lr))
1384 (setq msg-extra "showing task time since last repeat.")
1385 (if (not lr)
1387 (org-time-string-to-time lr)))
1388 (t nil))))
1390 (defun org-clock-find-position (find-unclosed)
1391 "Find the location where the next clock line should be inserted.
1392 When FIND-UNCLOSED is non-nil, first check if there is an unclosed clock
1393 line and position cursor in that line."
1394 (org-back-to-heading t)
1395 (catch 'exit
1396 (let* ((org-clock-into-drawer (org-clock-into-drawer))
1397 (beg (save-excursion
1398 (beginning-of-line 2)
1399 (or (bolp) (newline))
1400 (point)))
1401 (end (progn (outline-next-heading) (point)))
1402 (re (concat "^[ \t]*" org-clock-string))
1403 (cnt 0)
1404 (drawer (if (stringp org-clock-into-drawer)
1405 org-clock-into-drawer "LOGBOOK"))
1406 first last ind-last)
1407 (goto-char beg)
1408 (when (and find-unclosed
1409 (re-search-forward
1410 (concat "^[ \t]*" org-clock-string
1411 " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1412 " *\\sw+ +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")
1413 end t))
1414 (beginning-of-line 1)
1415 (throw 'exit t))
1416 (when (eobp) (newline) (setq end (max (point) end)))
1417 (when (re-search-forward (concat "^[ \t]*:" drawer ":") end t)
1418 ;; we seem to have a CLOCK drawer, so go there.
1419 (beginning-of-line 2)
1420 (or org-log-states-order-reversed
1421 (and (re-search-forward org-property-end-re nil t)
1422 (goto-char (match-beginning 0))))
1423 (throw 'exit t))
1424 ;; Lets count the CLOCK lines
1425 (goto-char beg)
1426 (while (re-search-forward re end t)
1427 (setq first (or first (match-beginning 0))
1428 last (match-beginning 0)
1429 cnt (1+ cnt)))
1430 (when (and (integerp org-clock-into-drawer)
1431 last
1432 (>= (1+ cnt) org-clock-into-drawer))
1433 ;; Wrap current entries into a new drawer
1434 (goto-char last)
1435 (setq ind-last (org-get-indentation))
1436 (beginning-of-line 2)
1437 (if (and (>= (org-get-indentation) ind-last)
1438 (org-at-item-p))
1439 (when (and (>= (org-get-indentation) ind-last)
1440 (org-at-item-p))
1441 (let ((struct (org-list-struct)))
1442 (goto-char (org-list-get-bottom-point struct)))))
1443 (insert ":END:\n")
1444 (beginning-of-line 0)
1445 (org-indent-line-to ind-last)
1446 (goto-char first)
1447 (insert ":" drawer ":\n")
1448 (beginning-of-line 0)
1449 (org-indent-line)
1450 (org-flag-drawer t)
1451 (beginning-of-line 2)
1452 (or org-log-states-order-reversed
1453 (and (re-search-forward org-property-end-re nil t)
1454 (goto-char (match-beginning 0))))
1455 (throw 'exit nil))
1457 (goto-char beg)
1458 (while (and (looking-at (concat "[ \t]*" org-keyword-time-regexp))
1459 (not (equal (match-string 1) org-clock-string)))
1460 ;; Planning info, skip to after it
1461 (beginning-of-line 2)
1462 (or (bolp) (newline)))
1463 (when (or (eq org-clock-into-drawer t)
1464 (stringp org-clock-into-drawer)
1465 (and (integerp org-clock-into-drawer)
1466 (< org-clock-into-drawer 2)))
1467 (insert ":" drawer ":\n:END:\n")
1468 (beginning-of-line -1)
1469 (org-indent-line)
1470 (org-flag-drawer t)
1471 (beginning-of-line 2)
1472 (org-indent-line)
1473 (beginning-of-line)
1474 (or org-log-states-order-reversed
1475 (and (re-search-forward org-property-end-re nil t)
1476 (goto-char (match-beginning 0))))))))
1478 ;;;###autoload
1479 (defun org-clock-out (&optional switch-to-state fail-quietly at-time)
1480 "Stop the currently running clock.
1481 Throw an error if there is no running clock and FAIL-QUIETLY is nil.
1482 With a universal prefix, prompt for a state to switch the clocked out task
1483 to, overriding the existing value of `org-clock-out-switch-to-state'."
1484 (interactive "P")
1485 (catch 'exit
1486 (when (not (org-clocking-p))
1487 (setq global-mode-string
1488 (delq 'org-mode-line-string global-mode-string))
1489 (setq frame-title-format org-frame-title-format-backup)
1490 (force-mode-line-update)
1491 (if fail-quietly (throw 'exit t) (user-error "No active clock")))
1492 (let ((org-clock-out-switch-to-state
1493 (if switch-to-state
1494 (completing-read "Switch to state: "
1495 (with-current-buffer
1496 (marker-buffer org-clock-marker)
1497 org-todo-keywords-1)
1498 nil t "DONE")
1499 org-clock-out-switch-to-state))
1500 (now (org-current-time org-clock-rounding-minutes))
1501 ts te s h m remove)
1502 (setq org-clock-out-time now)
1503 (save-excursion ; Do not replace this with `with-current-buffer'.
1504 (org-no-warnings (set-buffer (org-clocking-buffer)))
1505 (save-restriction
1506 (widen)
1507 (goto-char org-clock-marker)
1508 (beginning-of-line 1)
1509 (if (and (looking-at (concat "[ \t]*" org-keyword-time-regexp))
1510 (equal (match-string 1) org-clock-string))
1511 (setq ts (match-string 2))
1512 (if fail-quietly (throw 'exit nil) (error "Clock start time is gone")))
1513 (goto-char (match-end 0))
1514 (delete-region (point) (point-at-eol))
1515 (insert "--")
1516 (setq te (org-insert-time-stamp (or at-time now) 'with-hm 'inactive))
1517 (setq s (- (org-float-time (apply 'encode-time (org-parse-time-string te)))
1518 (org-float-time (apply 'encode-time (org-parse-time-string ts))))
1519 h (floor (/ s 3600))
1520 s (- s (* 3600 h))
1521 m (floor (/ s 60))
1522 s (- s (* 60 s)))
1523 (insert " => " (format "%2d:%02d" h m))
1524 (when (setq remove (and org-clock-out-remove-zero-time-clocks
1525 (= (+ h m) 0)))
1526 (beginning-of-line 1)
1527 (delete-region (point) (point-at-eol))
1528 (and (looking-at "\n") (> (point-max) (1+ (point)))
1529 (delete-char 1)))
1530 (move-marker org-clock-marker nil)
1531 (move-marker org-clock-hd-marker nil)
1532 (when org-log-note-clock-out
1533 (org-add-log-setup 'clock-out nil nil nil nil
1534 (concat "# Task: " (org-get-heading t) "\n\n")))
1535 (when org-clock-mode-line-timer
1536 (cancel-timer org-clock-mode-line-timer)
1537 (setq org-clock-mode-line-timer nil))
1538 (when org-clock-idle-timer
1539 (cancel-timer org-clock-idle-timer)
1540 (setq org-clock-idle-timer nil))
1541 (setq global-mode-string
1542 (delq 'org-mode-line-string global-mode-string))
1543 (setq frame-title-format org-frame-title-format-backup)
1544 (when org-clock-out-switch-to-state
1545 (save-excursion
1546 (org-back-to-heading t)
1547 (let ((org-inhibit-logging t)
1548 (org-clock-out-when-done nil))
1549 (cond
1550 ((functionp org-clock-out-switch-to-state)
1551 (looking-at org-complex-heading-regexp)
1552 (let ((newstate (funcall org-clock-out-switch-to-state
1553 (match-string 2))))
1554 (if newstate (org-todo newstate))))
1555 ((and org-clock-out-switch-to-state
1556 (not (looking-at (concat org-outline-regexp "[ \t]*"
1557 org-clock-out-switch-to-state
1558 "\\>"))))
1559 (org-todo org-clock-out-switch-to-state))))))
1560 (force-mode-line-update)
1561 (message (concat "Clock stopped at %s after "
1562 (org-minutes-to-clocksum-string (+ (* 60 h) m)) "%s")
1563 te (if remove " => LINE REMOVED" ""))
1564 (let ((h org-clock-out-hook))
1565 ;; If a closing note needs to be stored in the drawer
1566 ;; where clocks are stored, let's temporarily disable
1567 ;; `org-clock-remove-empty-clock-drawer'
1568 (if (and (equal org-clock-into-drawer org-log-into-drawer)
1569 (eq org-log-done 'note)
1570 org-clock-out-when-done)
1571 (setq h (delq 'org-clock-remove-empty-clock-drawer h)))
1572 (mapc (lambda (f) (funcall f)) h))
1573 (unless (org-clocking-p)
1574 (setq org-clock-current-task nil)))))))
1576 (add-hook 'org-clock-out-hook 'org-clock-remove-empty-clock-drawer)
1578 (defun org-clock-remove-empty-clock-drawer nil
1579 "Remove empty clock drawer in the current subtree."
1580 (let* ((olid (or (org-entry-get (point) "LOG_INTO_DRAWER")
1581 org-log-into-drawer))
1582 (clock-drawer (if (eq t olid) "LOGBOOK" olid))
1583 (end (save-excursion (org-end-of-subtree t t))))
1584 (when clock-drawer
1585 (save-excursion
1586 (org-back-to-heading t)
1587 (while (and (< (point) end)
1588 (search-forward clock-drawer end t))
1589 (goto-char (match-beginning 0))
1590 (org-remove-empty-drawer-at clock-drawer (point))
1591 (forward-line 1))))))
1593 (defun org-clock-timestamps-up (&optional n)
1594 "Increase CLOCK timestamps at cursor.
1595 Optional argument N tells to change by that many units."
1596 (interactive "P")
1597 (org-clock-timestamps-change 'up n))
1599 (defun org-clock-timestamps-down (&optional n)
1600 "Increase CLOCK timestamps at cursor.
1601 Optional argument N tells to change by that many units."
1602 (interactive "P")
1603 (org-clock-timestamps-change 'down n))
1605 (defun org-clock-timestamps-change (updown &optional n)
1606 "Change CLOCK timestamps synchronously at cursor.
1607 UPDOWN tells whether to change 'up or 'down.
1608 Optional argument N tells to change by that many units."
1609 (setq org-ts-what nil)
1610 (when (org-at-timestamp-p t)
1611 (let ((tschange (if (eq updown 'up) 'org-timestamp-up
1612 'org-timestamp-down))
1613 ts1 begts1 ts2 begts2 updatets1 tdiff)
1614 (save-excursion
1615 (move-beginning-of-line 1)
1616 (re-search-forward org-ts-regexp3 nil t)
1617 (setq ts1 (match-string 0) begts1 (match-beginning 0))
1618 (when (re-search-forward org-ts-regexp3 nil t)
1619 (setq ts2 (match-string 0) begts2 (match-beginning 0))))
1620 ;; Are we on the second timestamp?
1621 (if (<= begts2 (point)) (setq updatets1 t))
1622 (if (not ts2)
1623 ;; fall back on org-timestamp-up if there is only one
1624 (funcall tschange n)
1625 ;; setq this so that (boundp 'org-ts-what is non-nil)
1626 (funcall tschange n)
1627 (let ((ts (if updatets1 ts2 ts1))
1628 (begts (if updatets1 begts1 begts2)))
1629 (setq tdiff
1630 (subtract-time
1631 (org-time-string-to-time org-last-changed-timestamp)
1632 (org-time-string-to-time ts)))
1633 (save-excursion
1634 (goto-char begts)
1635 (org-timestamp-change
1636 (round (/ (org-float-time tdiff)
1637 (cond ((eq org-ts-what 'minute) 60)
1638 ((eq org-ts-what 'hour) 3600)
1639 ((eq org-ts-what 'day) (* 24 3600))
1640 ((eq org-ts-what 'month) (* 24 3600 31))
1641 ((eq org-ts-what 'year) (* 24 3600 365.2)))))
1642 org-ts-what 'updown)))))))
1644 ;;;###autoload
1645 (defun org-clock-cancel ()
1646 "Cancel the running clock by removing the start timestamp."
1647 (interactive)
1648 (when (not (org-clocking-p))
1649 (setq global-mode-string
1650 (delq 'org-mode-line-string global-mode-string))
1651 (setq frame-title-format org-frame-title-format-backup)
1652 (force-mode-line-update)
1653 (error "No active clock"))
1654 (save-excursion ; Do not replace this with `with-current-buffer'.
1655 (org-no-warnings (set-buffer (org-clocking-buffer)))
1656 (goto-char org-clock-marker)
1657 (if (org-looking-back (concat "^[ \t]*" org-clock-string ".*"))
1658 (progn (delete-region (1- (point-at-bol)) (point-at-eol))
1659 (org-remove-empty-drawer-at "LOGBOOK" (point)))
1660 (message "Clock gone, cancel the timer anyway")
1661 (sit-for 2)))
1662 (move-marker org-clock-marker nil)
1663 (move-marker org-clock-hd-marker nil)
1664 (setq global-mode-string
1665 (delq 'org-mode-line-string global-mode-string))
1666 (setq frame-title-format org-frame-title-format-backup)
1667 (force-mode-line-update)
1668 (message "Clock canceled")
1669 (run-hooks 'org-clock-cancel-hook))
1671 ;;;###autoload
1672 (defun org-clock-goto (&optional select)
1673 "Go to the currently clocked-in entry, or to the most recently clocked one.
1674 With prefix arg SELECT, offer recently clocked tasks for selection."
1675 (interactive "@P")
1676 (let* ((recent nil)
1677 (m (cond
1678 (select
1679 (or (org-clock-select-task "Select task to go to: ")
1680 (error "No task selected")))
1681 ((org-clocking-p) org-clock-marker)
1682 ((and org-clock-goto-may-find-recent-task
1683 (car org-clock-history)
1684 (marker-buffer (car org-clock-history)))
1685 (setq recent t)
1686 (car org-clock-history))
1687 (t (error "No active or recent clock task")))))
1688 (org-pop-to-buffer-same-window (marker-buffer m))
1689 (if (or (< m (point-min)) (> m (point-max))) (widen))
1690 (goto-char m)
1691 (org-show-entry)
1692 (org-back-to-heading t)
1693 (org-cycle-hide-drawers 'children)
1694 (recenter)
1695 (org-reveal)
1696 (if recent
1697 (message "No running clock, this is the most recently clocked task"))
1698 (run-hooks 'org-clock-goto-hook)))
1700 (defvar org-clock-file-total-minutes nil
1701 "Holds the file total time in minutes, after a call to `org-clock-sum'.")
1702 (make-variable-buffer-local 'org-clock-file-total-minutes)
1704 (defun org-clock-sum-today (&optional headline-filter)
1705 "Sum the times for each subtree for today."
1706 (interactive)
1707 (let ((range (org-clock-special-range 'today)))
1708 (org-clock-sum (car range) (cadr range) nil :org-clock-minutes-today)))
1710 ;;;###autoload
1711 (defun org-clock-sum (&optional tstart tend headline-filter propname)
1712 "Sum the times for each subtree.
1713 Puts the resulting times in minutes as a text property on each headline.
1714 TSTART and TEND can mark a time range to be considered.
1715 HEADLINE-FILTER is a zero-arg function that, if specified, is called for
1716 each headline in the time range with point at the headline. Headlines for
1717 which HEADLINE-FILTER returns nil are excluded from the clock summation.
1718 PROPNAME lets you set a custom text property instead of :org-clock-minutes."
1719 (interactive)
1720 (org-with-silent-modifications
1721 (let* ((re (concat "^\\(\\*+\\)[ \t]\\|^[ \t]*"
1722 org-clock-string
1723 "[ \t]*\\(?:\\(\\[.*?\\]\\)-+\\(\\[.*?\\]\\)\\|=>[ \t]+\\([0-9]+\\):\\([0-9]+\\)\\)"))
1724 (lmax 30)
1725 (ltimes (make-vector lmax 0))
1726 (t1 0)
1727 (level 0)
1728 ts te dt
1729 time)
1730 (if (stringp tstart) (setq tstart (org-time-string-to-seconds tstart)))
1731 (if (stringp tend) (setq tend (org-time-string-to-seconds tend)))
1732 (if (consp tstart) (setq tstart (org-float-time tstart)))
1733 (if (consp tend) (setq tend (org-float-time tend)))
1734 (remove-text-properties (point-min) (point-max)
1735 `(,(or propname :org-clock-minutes) t
1736 :org-clock-force-headline-inclusion t))
1737 (save-excursion
1738 (goto-char (point-max))
1739 (while (re-search-backward re nil t)
1740 (cond
1741 ((match-end 2)
1742 ;; Two time stamps
1743 (setq ts (match-string 2)
1744 te (match-string 3)
1745 ts (org-float-time
1746 (apply 'encode-time (org-parse-time-string ts)))
1747 te (org-float-time
1748 (apply 'encode-time (org-parse-time-string te)))
1749 ts (if tstart (max ts tstart) ts)
1750 te (if tend (min te tend) te)
1751 dt (- te ts)
1752 t1 (if (> dt 0) (+ t1 (floor (/ dt 60))) t1)))
1753 ((match-end 4)
1754 ;; A naked time
1755 (setq t1 (+ t1 (string-to-number (match-string 5))
1756 (* 60 (string-to-number (match-string 4))))))
1757 (t ;; A headline
1758 ;; Add the currently clocking item time to the total
1759 (when (and org-clock-report-include-clocking-task
1760 (equal (org-clocking-buffer) (current-buffer))
1761 (equal (marker-position org-clock-hd-marker) (point))
1762 tstart
1763 tend
1764 (>= (org-float-time org-clock-start-time) tstart)
1765 (<= (org-float-time org-clock-start-time) tend))
1766 (let ((time (floor (- (org-float-time)
1767 (org-float-time org-clock-start-time)) 60)))
1768 (setq t1 (+ t1 time))))
1769 (let* ((headline-forced
1770 (get-text-property (point)
1771 :org-clock-force-headline-inclusion))
1772 (headline-included
1773 (or (null headline-filter)
1774 (save-excursion
1775 (save-match-data (funcall headline-filter))))))
1776 (setq level (- (match-end 1) (match-beginning 1)))
1777 (when (or (> t1 0) (> (aref ltimes level) 0))
1778 (when (or headline-included headline-forced)
1779 (if headline-included
1780 (loop for l from 0 to level do
1781 (aset ltimes l (+ (aref ltimes l) t1))))
1782 (setq time (aref ltimes level))
1783 (goto-char (match-beginning 0))
1784 (put-text-property (point) (point-at-eol)
1785 (or propname :org-clock-minutes) time)
1786 (if headline-filter
1787 (save-excursion
1788 (save-match-data
1789 (while
1790 (> (funcall outline-level) 1)
1791 (outline-up-heading 1 t)
1792 (put-text-property
1793 (point) (point-at-eol)
1794 :org-clock-force-headline-inclusion t))))))
1795 (setq t1 0)
1796 (loop for l from level to (1- lmax) do
1797 (aset ltimes l 0)))))))
1798 (setq org-clock-file-total-minutes (aref ltimes 0))))))
1800 (defun org-clock-sum-current-item (&optional tstart)
1801 "Return time, clocked on current item in total."
1802 (save-excursion
1803 (save-restriction
1804 (org-narrow-to-subtree)
1805 (org-clock-sum tstart)
1806 org-clock-file-total-minutes)))
1808 ;;;###autoload
1809 (defun org-clock-display (&optional total-only)
1810 "Show subtree times in the entire buffer.
1811 If TOTAL-ONLY is non-nil, only show the total time for the entire file
1812 in the echo area.
1814 Use \\[org-clock-remove-overlays] to remove the subtree times."
1815 (interactive)
1816 (org-clock-remove-overlays)
1817 (let (time h m p)
1818 (org-clock-sum)
1819 (unless total-only
1820 (save-excursion
1821 (goto-char (point-min))
1822 (while (or (and (equal (setq p (point)) (point-min))
1823 (get-text-property p :org-clock-minutes))
1824 (setq p (next-single-property-change
1825 (point) :org-clock-minutes)))
1826 (goto-char p)
1827 (when (setq time (get-text-property p :org-clock-minutes))
1828 (org-clock-put-overlay time (funcall outline-level))))
1829 (setq h (/ org-clock-file-total-minutes 60)
1830 m (- org-clock-file-total-minutes (* 60 h)))
1831 ;; Arrange to remove the overlays upon next change.
1832 (when org-remove-highlights-with-change
1833 (org-add-hook 'before-change-functions 'org-clock-remove-overlays
1834 nil 'local))))
1835 (message (concat "Total file time: "
1836 (org-minutes-to-clocksum-string org-clock-file-total-minutes)
1837 " (%d hours and %d minutes)") h m)))
1839 (defvar org-clock-overlays nil)
1840 (make-variable-buffer-local 'org-clock-overlays)
1842 (defun org-clock-put-overlay (time &optional level)
1843 "Put an overlays on the current line, displaying TIME.
1844 If LEVEL is given, prefix time with a corresponding number of stars.
1845 This creates a new overlay and stores it in `org-clock-overlays', so that it
1846 will be easy to remove."
1847 (let* ((c 60) (h (floor (/ time 60))) (m (- time (* 60 h)))
1848 (l (if level (org-get-valid-level level 0) 0))
1849 (off 0)
1850 ov tx)
1851 (org-move-to-column c)
1852 (unless (eolp) (skip-chars-backward "^ \t"))
1853 (skip-chars-backward " \t")
1854 (setq ov (make-overlay (point-at-bol) (point-at-eol))
1855 tx (concat (buffer-substring (point-at-bol) (point))
1856 (make-string (+ off (max 0 (- c (current-column)))) ?.)
1857 (org-add-props (concat (make-string l ?*) " "
1858 (org-minutes-to-clocksum-string time)
1859 (make-string (- 16 l) ?\ ))
1860 (list 'face 'org-clock-overlay))
1861 ""))
1862 (if (not (featurep 'xemacs))
1863 (overlay-put ov 'display tx)
1864 (overlay-put ov 'invisible t)
1865 (overlay-put ov 'end-glyph (make-glyph tx)))
1866 (push ov org-clock-overlays)))
1868 (defun org-clock-remove-overlays (&optional beg end noremove)
1869 "Remove the occur highlights from the buffer.
1870 BEG and END are ignored. If NOREMOVE is nil, remove this function
1871 from the `before-change-functions' in the current buffer."
1872 (interactive)
1873 (unless org-inhibit-highlight-removal
1874 (mapc 'delete-overlay org-clock-overlays)
1875 (setq org-clock-overlays nil)
1876 (unless noremove
1877 (remove-hook 'before-change-functions
1878 'org-clock-remove-overlays 'local))))
1880 (defvar org-state) ;; dynamically scoped into this function
1881 (defun org-clock-out-if-current ()
1882 "Clock out if the current entry contains the running clock.
1883 This is used to stop the clock after a TODO entry is marked DONE,
1884 and is only done if the variable `org-clock-out-when-done' is not nil."
1885 (when (and (org-clocking-p)
1886 org-clock-out-when-done
1887 (marker-buffer org-clock-marker)
1888 (or (and (eq t org-clock-out-when-done)
1889 (member org-state org-done-keywords))
1890 (and (listp org-clock-out-when-done)
1891 (member org-state org-clock-out-when-done)))
1892 (equal (or (buffer-base-buffer (org-clocking-buffer))
1893 (org-clocking-buffer))
1894 (or (buffer-base-buffer (current-buffer))
1895 (current-buffer)))
1896 (< (point) org-clock-marker)
1897 (> (save-excursion (outline-next-heading) (point))
1898 org-clock-marker))
1899 ;; Clock out, but don't accept a logging message for this.
1900 (let ((org-log-note-clock-out nil)
1901 (org-clock-out-switch-to-state nil))
1902 (org-clock-out))))
1904 (add-hook 'org-after-todo-state-change-hook
1905 'org-clock-out-if-current)
1907 ;;;###autoload
1908 (defun org-clock-get-clocktable (&rest props)
1909 "Get a formatted clocktable with parameters according to PROPS.
1910 The table is created in a temporary buffer, fully formatted and
1911 fontified, and then returned."
1912 ;; Set the defaults
1913 (setq props (plist-put props :name "clocktable"))
1914 (unless (plist-member props :maxlevel)
1915 (setq props (plist-put props :maxlevel 2)))
1916 (unless (plist-member props :scope)
1917 (setq props (plist-put props :scope 'agenda)))
1918 (with-temp-buffer
1919 (org-mode)
1920 (org-create-dblock props)
1921 (org-update-dblock)
1922 (font-lock-fontify-buffer)
1923 (forward-line 2)
1924 (buffer-substring (point) (progn
1925 (re-search-forward "^[ \t]*#\\+END" nil t)
1926 (point-at-bol)))))
1928 ;;;###autoload
1929 (defun org-clock-report (&optional arg)
1930 "Create a table containing a report about clocked time.
1931 If the cursor is inside an existing clocktable block, then the table
1932 will be updated. If not, a new clocktable will be inserted. The scope
1933 of the new clock will be subtree when called from within a subtree, and
1934 file elsewhere.
1936 When called with a prefix argument, move to the first clock table in the
1937 buffer and update it."
1938 (interactive "P")
1939 (org-clock-remove-overlays)
1940 (when arg
1941 (org-find-dblock "clocktable")
1942 (org-show-entry))
1943 (if (org-in-clocktable-p)
1944 (goto-char (org-in-clocktable-p))
1945 (let ((props (if (ignore-errors
1946 (save-excursion (org-back-to-heading)))
1947 (list :name "clocktable" :scope 'subtree)
1948 (list :name "clocktable"))))
1949 (org-create-dblock
1950 (org-combine-plists org-clock-clocktable-default-properties props))))
1951 (org-update-dblock))
1953 (defun org-day-of-week (day month year)
1954 "Returns the day of the week as an integer."
1955 (nth 6
1956 (decode-time
1957 (date-to-time
1958 (format "%d-%02d-%02dT00:00:00" year month day)))))
1960 (defun org-quarter-to-date (quarter year)
1961 "Get the date (week day year) of the first day of a given quarter."
1962 (let (startday)
1963 (cond
1964 ((= quarter 1)
1965 (setq startday (org-day-of-week 1 1 year))
1966 (cond
1967 ((= startday 0)
1968 (list 52 7 (- year 1)))
1969 ((= startday 6)
1970 (list 52 6 (- year 1)))
1971 ((<= startday 4)
1972 (list 1 startday year))
1973 ((> startday 4)
1974 (list 53 startday (- year 1)))
1977 ((= quarter 2)
1978 (setq startday (org-day-of-week 1 4 year))
1979 (cond
1980 ((= startday 0)
1981 (list 13 startday year))
1982 ((< startday 4)
1983 (list 14 startday year))
1984 ((>= startday 4)
1985 (list 13 startday year))
1988 ((= quarter 3)
1989 (setq startday (org-day-of-week 1 7 year))
1990 (cond
1991 ((= startday 0)
1992 (list 26 startday year))
1993 ((< startday 4)
1994 (list 27 startday year))
1995 ((>= startday 4)
1996 (list 26 startday year))
1999 ((= quarter 4)
2000 (setq startday (org-day-of-week 1 10 year))
2001 (cond
2002 ((= startday 0)
2003 (list 39 startday year))
2004 ((<= startday 4)
2005 (list 40 startday year))
2006 ((> startday 4)
2007 (list 39 startday year)))))))
2009 (defun org-clock-special-range (key &optional time as-strings wstart mstart)
2010 "Return two times bordering a special time range.
2011 Key is a symbol specifying the range and can be one of `today', `yesterday',
2012 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
2013 By default, a week starts Monday 0:00 and ends Sunday 24:00.
2014 The range is determined relative to TIME, which defaults to current time.
2015 The return value is a cons cell with two internal times like the ones
2016 returned by `current time' or `encode-time'.
2017 If AS-STRINGS is non-nil, the returned times will be formatted strings.
2018 If WSTART is non-nil, use this number to specify the starting day of a
2019 week (monday is 1).
2020 If MSTART is non-nil, use this number to specify the starting day of a
2021 month (1 is the first day of the month).
2022 If you can combine both, the month starting day will have priority."
2023 (if (integerp key) (setq key (intern (number-to-string key))))
2024 (let* ((tm (decode-time (or time (current-time))))
2025 (s 0) (m (nth 1 tm)) (h (nth 2 tm))
2026 (d (nth 3 tm)) (month (nth 4 tm)) (y (nth 5 tm))
2027 (dow (nth 6 tm))
2028 (ws (or wstart 1))
2029 (ms (or mstart 1))
2030 (skey (symbol-name key))
2031 (shift 0)
2032 (q (cond ((>= (nth 4 tm) 10) 4)
2033 ((>= (nth 4 tm) 7) 3)
2034 ((>= (nth 4 tm) 4) 2)
2035 ((>= (nth 4 tm) 1) 1)))
2036 s1 m1 h1 d1 month1 y1 diff ts te fm txt w date
2037 interval tmp shiftedy shiftedm shiftedq)
2038 (cond
2039 ((string-match "^[0-9]+$" skey)
2040 (setq y (string-to-number skey) m 1 d 1 key 'year))
2041 ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)$" skey)
2042 (setq y (string-to-number (match-string 1 skey))
2043 month (string-to-number (match-string 2 skey))
2044 d 1 key 'month))
2045 ((string-match "^\\([0-9]+\\)-[wW]\\([0-9]\\{1,2\\}\\)$" skey)
2046 (require 'cal-iso)
2047 (setq y (string-to-number (match-string 1 skey))
2048 w (string-to-number (match-string 2 skey)))
2049 (setq date (calendar-gregorian-from-absolute
2050 (calendar-absolute-from-iso (list w 1 y))))
2051 (setq d (nth 1 date) month (car date) y (nth 2 date)
2052 dow 1
2053 key 'week))
2054 ((string-match "^\\([0-9]+\\)-[qQ]\\([1-4]\\)$" skey)
2055 (require 'cal-iso)
2056 (setq y (string-to-number (match-string 1 skey)))
2057 (setq q (string-to-number (match-string 2 skey)))
2058 (setq date (calendar-gregorian-from-absolute
2059 (calendar-absolute-from-iso (org-quarter-to-date q y))))
2060 (setq d (nth 1 date) month (car date) y (nth 2 date)
2061 dow 1
2062 key 'quarter))
2063 ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)-\\([0-9]\\{1,2\\}\\)$" skey)
2064 (setq y (string-to-number (match-string 1 skey))
2065 month (string-to-number (match-string 2 skey))
2066 d (string-to-number (match-string 3 skey))
2067 key 'day))
2068 ((string-match "\\([-+][0-9]+\\)$" skey)
2069 (setq shift (string-to-number (match-string 1 skey))
2070 key (intern (substring skey 0 (match-beginning 1))))
2071 (if (and (memq key '(quarter thisq)) (> shift 0))
2072 (error "Looking forward with quarters isn't implemented"))))
2074 (when (= shift 0)
2075 (cond ((eq key 'yesterday) (setq key 'today shift -1))
2076 ((eq key 'lastweek) (setq key 'week shift -1))
2077 ((eq key 'lastmonth) (setq key 'month shift -1))
2078 ((eq key 'lastyear) (setq key 'year shift -1))
2079 ((eq key 'lastq) (setq key 'quarter shift -1))))
2080 (cond
2081 ((memq key '(day today))
2082 (setq d (+ d shift) h 0 m 0 h1 24 m1 0))
2083 ((memq key '(week thisweek))
2084 (setq diff (+ (* -7 shift) (if (= dow 0) (- 7 ws) (- dow ws)))
2085 m 0 h 0 d (- d diff) d1 (+ 7 d)))
2086 ((memq key '(month thismonth))
2087 (setq d (or ms 1) h 0 m 0 d1 (or ms 1)
2088 month (+ month shift) month1 (1+ month) h1 0 m1 0))
2089 ((memq key '(quarter thisq))
2090 ;; Compute if this shift remains in this year. If not, compute
2091 ;; how many years and quarters we have to shift (via floor*) and
2092 ;; compute the shifted years, months and quarters.
2093 (cond
2094 ((< (+ (- q 1) shift) 0) ; shift not in this year
2095 (setq interval (* -1 (+ (- q 1) shift)))
2096 ;; Set tmp to ((years to shift) (quarters to shift)).
2097 (setq tmp (org-floor* interval 4))
2098 ;; Due to the use of floor, 0 quarters actually means 4.
2099 (if (= 0 (nth 1 tmp))
2100 (setq shiftedy (- y (nth 0 tmp))
2101 shiftedm 1
2102 shiftedq 1)
2103 (setq shiftedy (- y (+ 1 (nth 0 tmp)))
2104 shiftedm (- 13 (* 3 (nth 1 tmp)))
2105 shiftedq (- 5 (nth 1 tmp))))
2106 (setq d 1 h 0 m 0 d1 1 month shiftedm month1 (+ 3 shiftedm) h1 0 m1 0 y shiftedy))
2107 ((> (+ q shift) 0) ; shift is within this year
2108 (setq shiftedq (+ q shift))
2109 (setq shiftedy y)
2110 (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))))
2111 ((memq key '(year thisyear))
2112 (setq m 0 h 0 d 1 month 1 y (+ y shift) y1 (1+ y)))
2113 (t (error "No such time block %s" key)))
2114 (setq ts (encode-time s m h d month y)
2115 te (encode-time (or s1 s) (or m1 m) (or h1 h)
2116 (or d1 d) (or month1 month) (or y1 y)))
2117 (setq fm (cdr org-time-stamp-formats))
2118 (cond
2119 ((memq key '(day today))
2120 (setq txt (format-time-string "%A, %B %d, %Y" ts)))
2121 ((memq key '(week thisweek))
2122 (setq txt (format-time-string "week %G-W%V" ts)))
2123 ((memq key '(month thismonth))
2124 (setq txt (format-time-string "%B %Y" ts)))
2125 ((memq key '(year thisyear))
2126 (setq txt (format-time-string "the year %Y" ts)))
2127 ((memq key '(quarter thisq))
2128 (setq txt (concat (org-count-quarter shiftedq) " quarter of " (number-to-string shiftedy)))))
2129 (if as-strings
2130 (list (format-time-string fm ts) (format-time-string fm te) txt)
2131 (list ts te txt))))
2133 (defun org-count-quarter (n)
2134 (cond
2135 ((= n 1) "1st")
2136 ((= n 2) "2nd")
2137 ((= n 3) "3rd")
2138 ((= n 4) "4th")))
2140 (defun org-clocktable-shift (dir n)
2141 "Try to shift the :block date of the clocktable at point.
2142 Point must be in the #+BEGIN: line of a clocktable, or this function
2143 will throw an error.
2144 DIR is a direction, a symbol `left', `right', `up', or `down'.
2145 Both `left' and `down' shift the block toward the past, `up' and `right'
2146 push it toward the future.
2147 N is the number of shift steps to take. The size of the step depends on
2148 the currently selected interval size."
2149 (setq n (prefix-numeric-value n))
2150 (and (memq dir '(left down)) (setq n (- n)))
2151 (save-excursion
2152 (goto-char (point-at-bol))
2153 (if (not (looking-at "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>.*?:block[ \t]+\\(\\S-+\\)"))
2154 (error "Line needs a :block definition before this command works")
2155 (let* ((b (match-beginning 1)) (e (match-end 1))
2156 (s (match-string 1))
2157 block shift ins y mw d date wp m)
2158 (cond
2159 ((equal s "yesterday") (setq s "today-1"))
2160 ((equal s "lastweek") (setq s "thisweek-1"))
2161 ((equal s "lastmonth") (setq s "thismonth-1"))
2162 ((equal s "lastyear") (setq s "thisyear-1"))
2163 ((equal s "lastq") (setq s "thisq-1")))
2165 (cond
2166 ((string-match "^\\(today\\|thisweek\\|thismonth\\|thisyear\\|thisq\\)\\([-+][0-9]+\\)?$" s)
2167 (setq block (match-string 1 s)
2168 shift (if (match-end 2)
2169 (string-to-number (match-string 2 s))
2171 (setq shift (+ shift n))
2172 (setq ins (if (= shift 0) block (format "%s%+d" block shift))))
2173 ((string-match "\\([0-9]+\\)\\(-\\([wWqQ]?\\)\\([0-9]\\{1,2\\}\\)\\(-\\([0-9]\\{1,2\\}\\)\\)?\\)?" s)
2174 ;; 1 1 2 3 3 4 4 5 6 6 5 2
2175 (setq y (string-to-number (match-string 1 s))
2176 wp (and (match-end 3) (match-string 3 s))
2177 mw (and (match-end 4) (string-to-number (match-string 4 s)))
2178 d (and (match-end 6) (string-to-number (match-string 6 s))))
2179 (cond
2180 (d (setq ins (format-time-string
2181 "%Y-%m-%d"
2182 (encode-time 0 0 0 (+ d n) m y))))
2183 ((and wp (string-match "w\\|W" wp) mw (> (length wp) 0))
2184 (require 'cal-iso)
2185 (setq date (calendar-gregorian-from-absolute
2186 (calendar-absolute-from-iso (list (+ mw n) 1 y))))
2187 (setq ins (format-time-string
2188 "%G-W%V"
2189 (encode-time 0 0 0 (nth 1 date) (car date) (nth 2 date)))))
2190 ((and wp (string-match "q\\|Q" wp) mw (> (length wp) 0))
2191 (require 'cal-iso)
2192 ; if the 4th + 1 quarter is requested we flip to the 1st quarter of the next year
2193 (if (> (+ mw n) 4)
2194 (setq mw 0
2195 y (+ 1 y))
2197 ; if the 1st - 1 quarter is requested we flip to the 4th quarter of the previous year
2198 (if (= (+ mw n) 0)
2199 (setq mw 5
2200 y (- y 1))
2202 (setq date (calendar-gregorian-from-absolute
2203 (calendar-absolute-from-iso (org-quarter-to-date (+ mw n) y))))
2204 (setq ins (format-time-string
2205 (concat (number-to-string y) "-Q" (number-to-string (+ mw n)))
2206 (encode-time 0 0 0 (nth 1 date) (car date) (nth 2 date)))))
2208 (setq ins (format-time-string
2209 "%Y-%m"
2210 (encode-time 0 0 0 1 (+ mw n) y))))
2212 (setq ins (number-to-string (+ y n))))))
2213 (t (error "Cannot shift clocktable block")))
2214 (when ins
2215 (goto-char b)
2216 (insert ins)
2217 (delete-region (point) (+ (point) (- e b)))
2218 (beginning-of-line 1)
2219 (org-update-dblock)
2220 t)))))
2222 ;;;###autoload
2223 (defun org-dblock-write:clocktable (params)
2224 "Write the standard clocktable."
2225 (setq params (org-combine-plists org-clocktable-defaults params))
2226 (catch 'exit
2227 (let* ((scope (plist-get params :scope))
2228 (block (plist-get params :block))
2229 (ts (plist-get params :tstart))
2230 (te (plist-get params :tend))
2231 (link (plist-get params :link))
2232 (maxlevel (or (plist-get params :maxlevel) 3))
2233 (ws (plist-get params :wstart))
2234 (ms (plist-get params :mstart))
2235 (step (plist-get params :step))
2236 (timestamp (plist-get params :timestamp))
2237 (formatter (or (plist-get params :formatter)
2238 org-clock-clocktable-formatter
2239 'org-clocktable-write-default))
2240 cc range-text ipos pos one-file-with-archives
2241 scope-is-list tbls level)
2242 ;; Check if we need to do steps
2243 (when block
2244 ;; Get the range text for the header
2245 (setq cc (org-clock-special-range block nil t ws ms)
2246 ts (car cc) te (nth 1 cc) range-text (nth 2 cc)))
2247 (when step
2248 ;; Write many tables, in steps
2249 (unless (or block (and ts te))
2250 (error "Clocktable `:step' can only be used with `:block' or `:tstart,:end'"))
2251 (org-clocktable-steps params)
2252 (throw 'exit nil))
2254 (setq ipos (point)) ; remember the insertion position
2256 ;; Get the right scope
2257 (setq pos (point))
2258 (cond
2259 ((and scope (listp scope) (symbolp (car scope)))
2260 (setq scope (eval scope)))
2261 ((eq scope 'agenda)
2262 (setq scope (org-agenda-files t)))
2263 ((eq scope 'agenda-with-archives)
2264 (setq scope (org-agenda-files t))
2265 (setq scope (org-add-archive-files scope)))
2266 ((eq scope 'file-with-archives)
2267 (setq scope (org-add-archive-files (list (buffer-file-name)))
2268 one-file-with-archives t)))
2269 (setq scope-is-list (and scope (listp scope)))
2270 (if scope-is-list
2271 ;; we collect from several files
2272 (let* ((files scope)
2273 file)
2274 (org-agenda-prepare-buffers files)
2275 (while (setq file (pop files))
2276 (with-current-buffer (find-buffer-visiting file)
2277 (save-excursion
2278 (save-restriction
2279 (push (org-clock-get-table-data file params) tbls))))))
2280 ;; Just from the current file
2281 (save-restriction
2282 ;; get the right range into the restriction
2283 (org-agenda-prepare-buffers (list (buffer-file-name)))
2284 (cond
2285 ((not scope)) ; use the restriction as it is now
2286 ((eq scope 'file) (widen))
2287 ((eq scope 'subtree) (org-narrow-to-subtree))
2288 ((eq scope 'tree)
2289 (while (org-up-heading-safe))
2290 (org-narrow-to-subtree))
2291 ((and (symbolp scope) (string-match "^tree\\([0-9]+\\)$"
2292 (symbol-name scope)))
2293 (setq level (string-to-number (match-string 1 (symbol-name scope))))
2294 (catch 'exit
2295 (while (org-up-heading-safe)
2296 (looking-at org-outline-regexp)
2297 (if (<= (org-reduced-level (funcall outline-level)) level)
2298 (throw 'exit nil))))
2299 (org-narrow-to-subtree)))
2300 ;; do the table, with no file name.
2301 (push (org-clock-get-table-data nil params) tbls)))
2303 ;; OK, at this point we tbls as a list of tables, one per file
2304 (setq tbls (nreverse tbls))
2306 (setq params (plist-put params :multifile scope-is-list))
2307 (setq params (plist-put params :one-file-with-archives
2308 one-file-with-archives))
2310 (funcall formatter ipos tbls params))))
2312 (defun org-clocktable-write-default (ipos tables params)
2313 "Write out a clock table at position IPOS in the current buffer.
2314 TABLES is a list of tables with clocking data as produced by
2315 `org-clock-get-table-data'. PARAMS is the parameter property list obtained
2316 from the dynamic block definition."
2317 ;; This function looks quite complicated, mainly because there are a
2318 ;; lot of options which can add or remove columns. I have massively
2319 ;; commented this function, the I hope it is understandable. If
2320 ;; someone wants to write their own special formatter, this maybe
2321 ;; much easier because there can be a fixed format with a
2322 ;; well-defined number of columns...
2323 (let* ((hlchars '((1 . "*") (2 . "/")))
2324 (lwords (assoc (or (plist-get params :lang)
2325 (org-bound-and-true-p org-export-default-language)
2326 "en")
2327 org-clock-clocktable-language-setup))
2328 (multifile (plist-get params :multifile))
2329 (block (plist-get params :block))
2330 (ts (plist-get params :tstart))
2331 (te (plist-get params :tend))
2332 (header (plist-get params :header))
2333 (narrow (plist-get params :narrow))
2334 (ws (or (plist-get params :wstart) 1))
2335 (ms (or (plist-get params :mstart) 1))
2336 (link (plist-get params :link))
2337 (maxlevel (or (plist-get params :maxlevel) 3))
2338 (emph (plist-get params :emphasize))
2339 (level-p (plist-get params :level))
2340 (org-time-clocksum-use-effort-durations
2341 (plist-get params :effort-durations))
2342 (timestamp (plist-get params :timestamp))
2343 (properties (plist-get params :properties))
2344 (ntcol (max 1 (or (plist-get params :tcolumns) 100)))
2345 (rm-file-column (plist-get params :one-file-with-archives))
2346 (indent (plist-get params :indent))
2347 (case-fold-search t)
2348 range-text total-time tbl level hlc formula pcol
2349 file-time entries entry headline
2350 recalc content narrow-cut-p tcol)
2352 ;; Implement abbreviations
2353 (when (plist-get params :compact)
2354 (setq level nil indent t narrow (or narrow '40!) ntcol 1))
2356 ;; Some consistency test for parameters
2357 (unless (integerp ntcol)
2358 (setq params (plist-put params :tcolumns (setq ntcol 100))))
2360 (when (and narrow (integerp narrow) link)
2361 ;; We cannot have both integer narrow and link
2362 (message
2363 "Using hard narrowing in clocktable to allow for links")
2364 (setq narrow (intern (format "%d!" narrow))))
2366 (when narrow
2367 (cond
2368 ((integerp narrow))
2369 ((and (symbolp narrow)
2370 (string-match "\\`[0-9]+!\\'" (symbol-name narrow)))
2371 (setq narrow-cut-p t
2372 narrow (string-to-number (substring (symbol-name narrow)
2373 0 -1))))
2375 (error "Invalid value %s of :narrow property in clock table"
2376 narrow))))
2378 (when block
2379 ;; Get the range text for the header
2380 (setq range-text (nth 2 (org-clock-special-range block nil t ws ms))))
2382 ;; Compute the total time
2383 (setq total-time (apply '+ (mapcar 'cadr tables)))
2385 ;; Now we need to output this tsuff
2386 (goto-char ipos)
2388 ;; Insert the text *before* the actual table
2389 (insert-before-markers
2390 (or header
2391 ;; Format the standard header
2392 (concat
2393 "#+CAPTION: "
2394 (nth 9 lwords) " ["
2395 (substring
2396 (format-time-string (cdr org-time-stamp-formats))
2397 1 -1)
2399 (if block (concat ", for " range-text ".") "")
2400 "\n")))
2402 ;; Insert the narrowing line
2403 (when (and narrow (integerp narrow) (not narrow-cut-p))
2404 (insert-before-markers
2405 "|" ; table line starter
2406 (if multifile "|" "") ; file column, maybe
2407 (if level-p "|" "") ; level column, maybe
2408 (if timestamp "|" "") ; timestamp column, maybe
2409 (if properties (make-string (length properties) ?|) "") ;properties columns, maybe
2410 (format "<%d>| |\n" narrow))) ; headline and time columns
2412 ;; Insert the table header line
2413 (insert-before-markers
2414 "|" ; table line starter
2415 (if multifile (concat (nth 1 lwords) "|") "") ; file column, maybe
2416 (if level-p (concat (nth 2 lwords) "|") "") ; level column, maybe
2417 (if timestamp (concat (nth 3 lwords) "|") "") ; timestamp column, maybe
2418 (if properties (concat (mapconcat 'identity properties "|") "|") "") ;properties columns, maybe
2419 (concat (nth 4 lwords) "|"
2420 (nth 5 lwords) "|\n")) ; headline and time columns
2422 ;; Insert the total time in the table
2423 (insert-before-markers
2424 "|-\n" ; a hline
2425 "|" ; table line starter
2426 (if multifile (concat "| " (nth 6 lwords) " ") "")
2427 ; file column, maybe
2428 (if level-p "|" "") ; level column, maybe
2429 (if timestamp "|" "") ; timestamp column, maybe
2430 (if properties (make-string (length properties) ?|) "") ; properties columns, maybe
2431 (concat (format org-clock-total-time-cell-format (nth 7 lwords)) "| ") ; instead of a headline
2432 (format org-clock-total-time-cell-format
2433 (org-minutes-to-clocksum-string (or total-time 0))) ; the time
2434 "|\n") ; close line
2436 ;; Now iterate over the tables and insert the data
2437 ;; but only if any time has been collected
2438 (when (and total-time (> total-time 0))
2440 (while (setq tbl (pop tables))
2441 ;; now tbl is the table resulting from one file.
2442 (setq file-time (nth 1 tbl))
2443 (when (or (and file-time (> file-time 0))
2444 (not (plist-get params :fileskip0)))
2445 (insert-before-markers "|-\n") ; a hline because a new file starts
2446 ;; First the file time, if we have multiple files
2447 (when multifile
2448 ;; Summarize the time collected from this file
2449 (insert-before-markers
2450 (format (concat "| %s %s | %s%s"
2451 (format org-clock-file-time-cell-format (nth 8 lwords))
2452 " | *%s*|\n")
2453 (file-name-nondirectory (car tbl))
2454 (if level-p "| " "") ; level column, maybe
2455 (if timestamp "| " "") ; timestamp column, maybe
2456 (if properties (make-string (length properties) ?|) "") ;properties columns, maybe
2457 (org-minutes-to-clocksum-string (nth 1 tbl))))) ; the time
2459 ;; Get the list of node entries and iterate over it
2460 (setq entries (nth 2 tbl))
2461 (while (setq entry (pop entries))
2462 (setq level (car entry)
2463 headline (nth 1 entry)
2464 hlc (if emph (or (cdr (assoc level hlchars)) "") ""))
2465 (when narrow-cut-p
2466 (if (and (string-match (concat "\\`" org-bracket-link-regexp
2467 "\\'")
2468 headline)
2469 (match-end 3))
2470 (setq headline
2471 (format "[[%s][%s]]"
2472 (match-string 1 headline)
2473 (org-shorten-string (match-string 3 headline)
2474 narrow)))
2475 (setq headline (org-shorten-string headline narrow))))
2476 (insert-before-markers
2477 "|" ; start the table line
2478 (if multifile "|" "") ; free space for file name column?
2479 (if level-p (format "%d|" (car entry)) "") ; level, maybe
2480 (if timestamp (concat (nth 2 entry) "|") "") ; timestamp, maybe
2481 (if properties
2482 (concat
2483 (mapconcat
2484 (lambda (p) (or (cdr (assoc p (nth 4 entry))) ""))
2485 properties "|") "|") "") ;properties columns, maybe
2486 (if indent (org-clocktable-indent-string level) "") ; indentation
2487 hlc headline hlc "|" ; headline
2488 (make-string (min (1- ntcol) (or (- level 1))) ?|)
2489 ; empty fields for higher levels
2490 hlc (org-minutes-to-clocksum-string (nth 3 entry)) hlc ; time
2491 "|\n" ; close line
2492 )))))
2493 ;; When exporting subtrees or regions the region might be
2494 ;; activated, so let's disable ̀delete-active-region'
2495 (let ((delete-active-region nil)) (backward-delete-char 1))
2496 (if (setq formula (plist-get params :formula))
2497 (cond
2498 ((eq formula '%)
2499 ;; compute the column where the % numbers need to go
2500 (setq pcol (+ 2
2501 (if multifile 1 0)
2502 (if level-p 1 0)
2503 (if timestamp 1 0)
2504 (min maxlevel (or ntcol 100))))
2505 ;; compute the column where the total time is
2506 (setq tcol (+ 2
2507 (if multifile 1 0)
2508 (if level-p 1 0)
2509 (if timestamp 1 0)))
2510 (insert
2511 (format
2512 "\n#+TBLFM: $%d='(org-clock-time%% @%d$%d $%d..$%d);%%.1f"
2513 pcol ; the column where the % numbers should go
2514 (if (and narrow (not narrow-cut-p)) 3 2) ; row of the total time
2515 tcol ; column of the total time
2516 tcol (1- pcol) ; range of columns where times can be found
2518 (setq recalc t))
2519 ((stringp formula)
2520 (insert "\n#+TBLFM: " formula)
2521 (setq recalc t))
2522 (t (error "Invalid formula in clocktable")))
2523 ;; Should we rescue an old formula?
2524 (when (stringp (setq content (plist-get params :content)))
2525 (when (string-match "^\\([ \t]*#\\+tblfm:.*\\)" content)
2526 (setq recalc t)
2527 (insert "\n" (match-string 1 (plist-get params :content)))
2528 (beginning-of-line 0))))
2529 ;; Back to beginning, align the table, recalculate if necessary
2530 (goto-char ipos)
2531 (skip-chars-forward "^|")
2532 (org-table-align)
2533 (when org-hide-emphasis-markers
2534 ;; we need to align a second time
2535 (org-table-align))
2536 (when recalc
2537 (if (eq formula '%)
2538 (save-excursion
2539 (if (and narrow (not narrow-cut-p)) (beginning-of-line 2))
2540 (org-table-goto-column pcol nil 'force)
2541 (insert "%")))
2542 (org-table-recalculate 'all))
2543 (when rm-file-column
2544 ;; The file column is actually not wanted
2545 (forward-char 1)
2546 (org-table-delete-column))
2547 total-time))
2549 (defun org-clocktable-indent-string (level)
2550 (if (= level 1)
2552 (let ((str "\\__"))
2553 (while (> level 2)
2554 (setq level (1- level)
2555 str (concat str "___")))
2556 (concat str " "))))
2558 (defun org-clocktable-steps (params)
2559 "Step through the range to make a number of clock tables."
2560 (let* ((p1 (copy-sequence params))
2561 (ts (plist-get p1 :tstart))
2562 (te (plist-get p1 :tend))
2563 (ws (plist-get p1 :wstart))
2564 (ms (plist-get p1 :mstart))
2565 (step0 (plist-get p1 :step))
2566 (step (cdr (assoc step0 '((day . 86400) (week . 604800)))))
2567 (stepskip0 (plist-get p1 :stepskip0))
2568 (block (plist-get p1 :block))
2569 cc range-text step-time tsb)
2570 (when block
2571 (setq cc (org-clock-special-range block nil t ws ms)
2572 ts (car cc) te (nth 1 cc) range-text (nth 2 cc)))
2573 (cond
2574 ((numberp ts)
2575 ;; If ts is a number, it's an absolute day number from org-agenda.
2576 (destructuring-bind (month day year) (calendar-gregorian-from-absolute ts)
2577 (setq ts (org-float-time (encode-time 0 0 0 day month year)))))
2579 (setq ts (org-float-time
2580 (apply 'encode-time (org-parse-time-string ts))))))
2581 (cond
2582 ((numberp te)
2583 ;; Likewise for te.
2584 (destructuring-bind (month day year) (calendar-gregorian-from-absolute te)
2585 (setq te (org-float-time (encode-time 0 0 0 day month year)))))
2587 (setq te (org-float-time
2588 (apply 'encode-time (org-parse-time-string te))))))
2589 (setq tsb
2590 (if (eq step0 'week)
2591 (- ts (* 86400 (- (nth 6 (decode-time (seconds-to-time ts))) ws)))
2592 ts))
2593 (setq p1 (plist-put p1 :header ""))
2594 (setq p1 (plist-put p1 :step nil))
2595 (setq p1 (plist-put p1 :block nil))
2596 (while (< tsb te)
2597 (or (bolp) (insert "\n"))
2598 (setq p1 (plist-put p1 :tstart (format-time-string
2599 (org-time-stamp-format nil t)
2600 (seconds-to-time (max tsb ts)))))
2601 (setq p1 (plist-put p1 :tend (format-time-string
2602 (org-time-stamp-format nil t)
2603 (seconds-to-time (min te (setq tsb (+ tsb step)))))))
2604 (insert "\n" (if (eq step0 'day) "Daily report: "
2605 "Weekly report starting on: ")
2606 (plist-get p1 :tstart) "\n")
2607 (setq step-time (org-dblock-write:clocktable p1))
2608 (re-search-forward "^[ \t]*#\\+END:")
2609 (when (and (equal step-time 0) stepskip0)
2610 ;; Remove the empty table
2611 (delete-region (point-at-bol)
2612 (save-excursion
2613 (re-search-backward "^\\(Daily\\|Weekly\\) report"
2614 nil t)
2615 (point))))
2616 (end-of-line 0))))
2618 (defun org-clock-get-table-data (file params)
2619 "Get the clocktable data for file FILE, with parameters PARAMS.
2620 FILE is only for identification - this function assumes that
2621 the correct buffer is current, and that the wanted restriction is
2622 in place.
2623 The return value will be a list with the file name and the total
2624 file time (in minutes) as 1st and 2nd elements. The third element
2625 of this list will be a list of headline entries. Each entry has the
2626 following structure:
2628 (LEVEL HEADLINE TIMESTAMP TIME)
2630 LEVEL: The level of the headline, as an integer. This will be
2631 the reduced leve, so 1,2,3,... even if only odd levels
2632 are being used.
2633 HEADLINE: The text of the headline. Depending on PARAMS, this may
2634 already be formatted like a link.
2635 TIMESTAMP: If PARAMS require it, this will be a time stamp found in the
2636 entry, any of SCHEDULED, DEADLINE, NORMAL, or first inactive,
2637 in this sequence.
2638 TIME: The sum of all time spend in this tree, in minutes. This time
2639 will of cause be restricted to the time block and tags match
2640 specified in PARAMS."
2641 (let* ((maxlevel (or (plist-get params :maxlevel) 3))
2642 (timestamp (plist-get params :timestamp))
2643 (ts (plist-get params :tstart))
2644 (te (plist-get params :tend))
2645 (ws (plist-get params :wstart))
2646 (ms (plist-get params :mstart))
2647 (block (plist-get params :block))
2648 (link (plist-get params :link))
2649 (tags (plist-get params :tags))
2650 (properties (plist-get params :properties))
2651 (inherit-property-p (plist-get params :inherit-props))
2652 todo-only
2653 (matcher (if tags (cdr (org-make-tags-matcher tags))))
2654 cc range-text st p time level hdl props tsp tbl)
2656 (setq org-clock-file-total-minutes nil)
2657 (when block
2658 (setq cc (org-clock-special-range block nil t ws ms)
2659 ts (car cc) te (nth 1 cc) range-text (nth 2 cc)))
2660 (when (integerp ts) (setq ts (calendar-gregorian-from-absolute ts)))
2661 (when (integerp te) (setq te (calendar-gregorian-from-absolute te)))
2662 (when (and ts (listp ts))
2663 (setq ts (format "%4d-%02d-%02d" (nth 2 ts) (car ts) (nth 1 ts))))
2664 (when (and te (listp te))
2665 (setq te (format "%4d-%02d-%02d" (nth 2 te) (car te) (nth 1 te))))
2666 ;; Now the times are strings we can parse.
2667 (if ts (setq ts (org-float-time
2668 (seconds-to-time (org-matcher-time ts)))))
2669 (if te (setq te (org-float-time
2670 (seconds-to-time (org-matcher-time te)))))
2671 (save-excursion
2672 (org-clock-sum ts te
2673 (unless (null matcher)
2674 (lambda ()
2675 (let* ((tags-list (org-get-tags-at))
2676 (org-scanner-tags tags-list)
2677 (org-trust-scanner-tags t))
2678 (eval matcher)))))
2679 (goto-char (point-min))
2680 (setq st t)
2681 (while (or (and (bobp) (prog1 st (setq st nil))
2682 (get-text-property (point) :org-clock-minutes)
2683 (setq p (point-min)))
2684 (setq p (next-single-property-change
2685 (point) :org-clock-minutes)))
2686 (goto-char p)
2687 (when (setq time (get-text-property p :org-clock-minutes))
2688 (save-excursion
2689 (beginning-of-line 1)
2690 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@#%:]+:\\)?[ \t]*$"))
2691 (setq level (org-reduced-level
2692 (- (match-end 1) (match-beginning 1))))
2693 (<= level maxlevel))
2694 (setq hdl (if (not link)
2695 (match-string 2)
2696 (org-make-link-string
2697 (format "file:%s::%s"
2698 (buffer-file-name)
2699 (save-match-data
2700 (org-make-org-heading-search-string
2701 (match-string 2))))
2702 (match-string 2)))
2703 tsp (when timestamp
2704 (setq props (org-entry-properties (point)))
2705 (or (cdr (assoc "SCHEDULED" props))
2706 (cdr (assoc "DEADLINE" props))
2707 (cdr (assoc "TIMESTAMP" props))
2708 (cdr (assoc "TIMESTAMP_IA" props))))
2709 props (when properties
2710 (remove nil
2711 (mapcar
2712 (lambda (p)
2713 (when (org-entry-get (point) p inherit-property-p)
2714 (cons p (org-entry-get (point) p inherit-property-p))))
2715 properties))))
2716 (when (> time 0) (push (list level hdl tsp time props) tbl))))))
2717 (setq tbl (nreverse tbl))
2718 (list file org-clock-file-total-minutes tbl))))
2720 (defun org-clock-time% (total &rest strings)
2721 "Compute a time fraction in percent.
2722 TOTAL s a time string like 10:21 specifying the total times.
2723 STRINGS is a list of strings that should be checked for a time.
2724 The first string that does have a time will be used.
2725 This function is made for clock tables."
2726 (let ((re "\\([0-9]+\\):\\([0-9]+\\)")
2727 tot s)
2728 (save-match-data
2729 (catch 'exit
2730 (if (not (string-match re total))
2731 (throw 'exit 0.)
2732 (setq tot (+ (string-to-number (match-string 2 total))
2733 (* 60 (string-to-number (match-string 1 total)))))
2734 (if (= tot 0.) (throw 'exit 0.)))
2735 (while (setq s (pop strings))
2736 (if (string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
2737 (throw 'exit
2738 (/ (* 100.0 (+ (string-to-number (match-string 2 s))
2739 (* 60 (string-to-number
2740 (match-string 1 s)))))
2741 tot))))
2742 0))))
2744 ;; Saving and loading the clock
2746 (defvar org-clock-loaded nil
2747 "Was the clock file loaded?")
2749 (defun org-clock-update-time-maybe ()
2750 "If this is a CLOCK line, update it and return t.
2751 Otherwise, return nil."
2752 (interactive)
2753 (save-excursion
2754 (beginning-of-line 1)
2755 (skip-chars-forward " \t")
2756 (when (looking-at org-clock-string)
2757 (let ((re (concat "[ \t]*" org-clock-string
2758 " *[[<]\\([^]>]+\\)[]>]\\(-+[[<]\\([^]>]+\\)[]>]"
2759 "\\([ \t]*=>.*\\)?\\)?"))
2760 ts te h m s neg)
2761 (cond
2762 ((not (looking-at re))
2763 nil)
2764 ((not (match-end 2))
2765 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
2766 (> org-clock-marker (point))
2767 (<= org-clock-marker (point-at-eol)))
2768 ;; The clock is running here
2769 (setq org-clock-start-time
2770 (apply 'encode-time
2771 (org-parse-time-string (match-string 1))))
2772 (org-clock-update-mode-line)))
2774 (and (match-end 4) (delete-region (match-beginning 4) (match-end 4)))
2775 (end-of-line 1)
2776 (setq ts (match-string 1)
2777 te (match-string 3))
2778 (setq s (- (org-float-time
2779 (apply 'encode-time (org-parse-time-string te)))
2780 (org-float-time
2781 (apply 'encode-time (org-parse-time-string ts))))
2782 neg (< s 0)
2783 s (abs s)
2784 h (floor (/ s 3600))
2785 s (- s (* 3600 h))
2786 m (floor (/ s 60))
2787 s (- s (* 60 s)))
2788 (insert " => " (format (if neg "-%d:%02d" "%2d:%02d") h m))
2789 t))))))
2791 (defun org-clock-save ()
2792 "Persist various clock-related data to disk.
2793 The details of what will be saved are regulated by the variable
2794 `org-clock-persist'."
2795 (when (and org-clock-persist
2796 (or org-clock-loaded
2797 org-clock-has-been-used
2798 (not (file-exists-p org-clock-persist-file))))
2799 (let (b)
2800 (with-current-buffer (find-file (expand-file-name org-clock-persist-file))
2801 (progn
2802 (delete-region (point-min) (point-max))
2803 ;;Store clock
2804 (insert (format ";; org-persist.el - %s at %s\n"
2805 system-name (format-time-string
2806 (cdr org-time-stamp-formats))))
2807 (if (and (memq org-clock-persist '(t clock))
2808 (setq b (org-clocking-buffer))
2809 (setq b (or (buffer-base-buffer b) b))
2810 (buffer-live-p b)
2811 (buffer-file-name b)
2812 (or (not org-clock-persist-query-save)
2813 (y-or-n-p (concat "Save current clock ("
2814 org-clock-heading ") "))))
2815 (insert "(setq resume-clock '(\""
2816 (buffer-file-name (org-clocking-buffer))
2817 "\" . " (int-to-string (marker-position org-clock-marker))
2818 "))\n"))
2819 ;; Store clocked task history. Tasks are stored reversed to make
2820 ;; reading simpler
2821 (when (and (memq org-clock-persist '(t history))
2822 org-clock-history)
2823 (insert
2824 "(setq stored-clock-history '("
2825 (mapconcat
2826 (lambda (m)
2827 (when (and (setq b (marker-buffer m))
2828 (setq b (or (buffer-base-buffer b) b))
2829 (buffer-live-p b)
2830 (buffer-file-name b))
2831 (concat "(\"" (buffer-file-name b)
2832 "\" . " (int-to-string (marker-position m))
2833 ")")))
2834 (reverse org-clock-history) " ") "))\n"))
2835 (save-buffer)
2836 (kill-buffer (current-buffer)))))))
2838 (defun org-clock-load ()
2839 "Load clock-related data from disk, maybe resuming a stored clock."
2840 (when (and org-clock-persist (not org-clock-loaded))
2841 (let ((filename (expand-file-name org-clock-persist-file))
2842 (org-clock-in-resume 'auto-restart)
2843 resume-clock stored-clock-history)
2844 (if (not (file-readable-p filename))
2845 (message "Not restoring clock data; %s not found"
2846 org-clock-persist-file)
2847 (message "%s" "Restoring clock data")
2848 (setq org-clock-loaded t)
2849 (load-file filename)
2850 ;; load history
2851 (when stored-clock-history
2852 (save-window-excursion
2853 (mapc (lambda (task)
2854 (if (file-exists-p (car task))
2855 (org-clock-history-push (cdr task)
2856 (find-file (car task)))))
2857 stored-clock-history)))
2858 ;; resume clock
2859 (when (and resume-clock org-clock-persist
2860 (file-exists-p (car resume-clock))
2861 (or (not org-clock-persist-query-resume)
2862 (y-or-n-p
2863 (concat
2864 "Resume clock ("
2865 (with-current-buffer (find-file (car resume-clock))
2866 (save-excursion
2867 (goto-char (cdr resume-clock))
2868 (org-back-to-heading t)
2869 (and (looking-at org-complex-heading-regexp)
2870 (match-string 4))))
2871 ") "))))
2872 (when (file-exists-p (car resume-clock))
2873 (with-current-buffer (find-file (car resume-clock))
2874 (goto-char (cdr resume-clock))
2875 (let ((org-clock-auto-clock-resolution nil))
2876 (org-clock-in)
2877 (if (outline-invisible-p)
2878 (org-show-context))))))))))
2880 ;; Suggested bindings
2881 (org-defkey org-mode-map "\C-c\C-x\C-e" 'org-clock-modify-effort-estimate)
2883 (provide 'org-clock)
2885 ;; Local variables:
2886 ;; generated-autoload-file: "org-loaddefs.el"
2887 ;; End:
2889 ;;; org-clock.el ends here