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