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
   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: 6.32trans
  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 (eval-when-compile
  33   (require 'cl)
  34   (require 'calendar))
  35
  36 (declare-function calendar-absolute-from-iso    "cal-iso"    (&optional date))
  37 (defvar org-time-stamp-formats)
  38
  39 (defgroup org-clock nil
  40   "Options concerning clocking working time in Org-mode."
  41   :tag "Org Clock"
  42   :group 'org-progress)
  43
  44 (defcustom org-clock-into-drawer org-log-into-drawer
  45   "Should clocking info be wrapped into a drawer?
  46 When t, clocking info will always be inserted into a :LOGBOOK: drawer.
  47 If necessary, the drawer will be created.
  48 When nil, the drawer will not be created, but used when present.
  49 When an integer and the number of clocking entries in an item
  50 reaches or exceeds this number, a drawer will be created.
  51 When a string, it names the drawer to be used.
  52
  53 The default for this variable is the value of `org-log-into-drawer',
  54 which see."
  55   :group 'org-todo
  56   :group 'org-clock
  57   :type '(choice
  58           (const :tag "Always" t)
  59           (const :tag "Only when drawer exists" nil)
  60           (integer :tag "When at least N clock entries")
  61           (const :tag "Into LOGBOOK drawer" "LOGBOOK")
  62           (string :tag "Into Drawer named...")))
  63
  64 (defcustom org-clock-out-when-done t
  65   "When non-nil, clock will be stopped when the clocked entry is marked DONE.
  66 A nil value means, clock will keep running until stopped explicitly with
  67 `C-c C-x C-o', or until the clock is started in a different item."
  68   :group 'org-clock
  69   :type 'boolean)
  70
  71 (defcustom org-clock-out-remove-zero-time-clocks nil
  72   "Non-nil means, remove the clock line when the resulting time is zero."
  73   :group 'org-clock
  74   :type 'boolean)
  75
  76 (defcustom org-clock-in-switch-to-state nil
  77   "Set task to a special todo state while clocking it.
  78 The value should be the state to which the entry should be
  79 switched. If the value is a function, it must take one
  80 parameter (the current TODO state of the item) and return the
  81 state to switch it to."
  82   :group 'org-clock
  83   :group 'org-todo
  84   :type '(choice
  85           (const :tag "Don't force a state" nil)
  86           (string :tag "State")
  87           (symbol :tag "Function")))
  88
  89 (defcustom org-clock-out-switch-to-state nil
  90   "Set task to a special todo state after clocking out.
  91 The value should be the state to which the entry should be
  92 switched. If the value is a function, it must take one
  93 parameter (the current TODO state of the item) and return the
  94 state to switch it to."
  95   :group 'org-clock
  96   :group 'org-todo
  97   :type '(choice
  98           (const :tag "Don't force a state" nil)
  99           (string :tag "State")
 100           (symbol :tag "Function")))
 101
 102 (defcustom org-clock-history-length 5
 103   "Number of clock tasks to remember in history."
 104   :group 'org-clock
 105   :type 'integer)
 106
 107 (defcustom org-clock-goto-may-find-recent-task t
 108   "Non-nil means, `org-clock-goto' can go to recent task if no active clock."
 109   :group 'org-clock
 110   :type 'boolean)
 111
 112 (defcustom org-clock-heading-function nil
 113   "When non-nil, should be a function to create `org-clock-heading'.
 114 This is the string shown in the mode line when a clock is running.
 115 The function is called with point at the beginning of the headline."
 116   :group 'org-clock
 117   :type 'function)
 118
 119 (defcustom org-clock-string-limit 0
 120   "Maximum length of clock strings in the modeline. 0 means no limit."
 121   :group 'org-clock
 122   :type 'integer)
 123
 124 (defcustom org-clock-in-resume nil
 125   "If non-nil, resume clock when clocking into task with open clock.
 126 When clocking into a task with a clock entry which has not been closed,
 127 the clock can be resumed from that point."
 128   :group 'org-clock
 129   :type 'boolean)
 130
 131 (defcustom org-clock-persist nil
 132   "When non-nil, save the running clock when emacs is closed.
 133 The clock is resumed when emacs restarts.
 134 When this is t, both the running clock, and the entire clock
 135 history are saved.  When this is the symbol `clock', only the
 136 running clock is saved.
 137
 138 When Emacs restarts with saved clock information, the file containing the
 139 running clock as well as all files mentioned in the clock history will
 140 be visited.
 141 All this depends on running `org-clock-persistence-insinuate' in .emacs"
 142   :group 'org-clock
 143   :type '(choice
 144           (const :tag "Just the running clock" clock)
 145           (const :tag "Just the history" history)
 146           (const :tag "Clock and history" t)
 147           (const :tag "No persistence" nil)))
 148
 149 (defcustom org-clock-persist-file (convert-standard-filename
 150                                    "~/.emacs.d/org-clock-save.el")
 151   "File to save clock data to."
 152   :group 'org-clock
 153   :type 'string)
 154
 155 (defcustom org-clock-persist-query-save nil
 156   "When non-nil, ask before saving the current clock on exit."
 157   :group 'org-clock
 158   :type 'boolean)
 159
 160 (defcustom org-clock-persist-query-resume t
 161   "When non-nil, ask before resuming any stored clock during load."
 162   :group 'org-clock
 163   :type 'boolean)
 164
 165 (defcustom org-clock-sound nil
 166   "Sound that will used for notifications.
 167 Possible values:
 168
 169 nil        no sound played.
 170 t          standard Emacs beep
 171 file name  play this sound file.  If not possible, fall back to beep"
 172   :group 'org-clock
 173   :type '(choice
 174           (const :tag "No sound" nil)
 175           (const :tag "Standard beep" t)
 176           (file :tag "Play sound file")))
 177
 178 (defcustom org-clock-modeline-total 'auto
 179   "Default setting for the time included for the modeline clock.
 180 This can be overruled locally using the CLOCK_MODELINE_TOTAL property.
 181 Allowed values are:
 182
 183 current  Only the time in the current instance of the clock
 184 today    All time clocked inot this task today
 185 repeat   All time clocked into this task since last repeat
 186 all      All time ever recorded for this task
 187 auto     Automatically, either `all', or `repeat' for repeating tasks"
 188   :group 'org-clock
 189   :type '(choice
 190           (const :tag "Current clock" current)
 191           (const :tag "Today's task time" today)
 192           (const :tag "Since last repeat" repeat)
 193           (const :tag "All task time" all)
 194           (const :tag "Automatically, `all' or since `repeat'" auto)))
 195
 196 (defcustom org-show-notification-handler nil
 197   "Function or program to send notification with.
 198 The function or program will be called with the notification
 199 string as argument."
 200   :group 'org-clock
 201   :type '(choice
 202           (string :tag "Program")
 203           (function :tag "Function")))
 204
 205 (defcustom org-clock-clocktable-default-properties '(:maxlevel 2 :scope file)
 206   "Default properties for new clocktables."
 207   :group 'org-clock
 208   :type 'plist)
 209
 210 (defcustom org-clock-idle-time nil
 211   "When non-nil, resolve open clocks if the user is idle more than X minutes."
 212   :group 'org-clock
 213   :type '(choice
 214           (const :tag "Never" nil)
 215           (integer :tag "After N minutes")))
 216
 217 (defcustom org-clock-auto-clock-resolution 'when-no-clock-is-running
 218   "When to automatically resolve open clocks found in Org buffers."
 219   :group 'org-clock
 220   :type '(choice
 221           (const :tag "Never" nil)
 222           (const :tag "Always" t)
 223           (const :tag "When no clock is running" when-no-clock-is-running)))
 224
 225 (defvar org-clock-in-prepare-hook nil
 226   "Hook run when preparing the clock.
 227 This hook is run before anything happens to the task that
 228 you want to clock in.  For example, you can use this hook
 229 to add an effort property.")
 230 (defvar org-clock-in-hook nil
 231   "Hook run when starting the clock.")
 232 (defvar org-clock-out-hook nil
 233   "Hook run when stopping the current clock.")
 234
 235 (defvar org-clock-cancel-hook nil
 236   "Hook run when cancelling the current clock.")
 237 (defvar org-clock-goto-hook nil
 238   "Hook run when selecting the currently clocked-in entry.")
 239 (defvar org-clock-has-been-used nil
 240   "Has the clock been used during the current Emacs session?")
 241
 242 ;;; The clock for measuring work time.
 243
 244 (defvar org-mode-line-string "")
 245 (put 'org-mode-line-string 'risky-local-variable t)
 246
 247 (defvar org-clock-mode-line-timer nil)
 248 (defvar org-clock-idle-timer nil)
 249 (defvar org-clock-heading "")
 250 (defvar org-clock-heading-for-remember "")
 251 (defvar org-clock-start-time "")
 252
 253 (defvar org-clock-left-over-time nil
 254   "If non-nil, user cancelled a clock; this is when leftover time started.")
 255
 256 (defvar org-clock-effort ""
 257   "Effort estimate of the currently clocking task")
 258
 259 (defvar org-clock-total-time nil
 260   "Holds total time, spent previously on currently clocked item.
 261 This does not include the time in the currently running clock.")
 262
 263 (defvar org-clock-history nil
 264   "List of marker pointing to recent clocked tasks.")
 265
 266 (defvar org-clock-default-task (make-marker)
 267   "Marker pointing to the default task that should clock time.
 268 The clock can be made to switch to this task after clocking out
 269 of a different task.")
 270
 271 (defvar org-clock-interrupted-task (make-marker)
 272   "Marker pointing to the task that has been interrupted by the current clock.")
 273
 274 (defvar org-clock-mode-line-map (make-sparse-keymap))
 275 (define-key org-clock-mode-line-map [mode-line mouse-2] 'org-clock-goto)
 276 (define-key org-clock-mode-line-map [mode-line mouse-1] 'org-clock-menu)
 277
 278 (defun org-clock-menu ()
 279   (interactive)
 280   (popup-menu
 281    '("Clock"
 282      ["Clock out" org-clock-out t]
 283      ["Change effort estimate" org-clock-modify-effort-estimate t]
 284      ["Go to clock entry" org-clock-goto t]
 285      ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"])))
 286
 287 (defun org-clock-history-push (&optional pos buffer)
 288   "Push a marker to the clock history."
 289   (setq org-clock-history-length (max 1 (min 35 org-clock-history-length)))
 290   (let ((m (move-marker (make-marker) (or pos (point)) buffer)) n l)
 291     (while (setq n (member m org-clock-history))
 292       (move-marker (car n) nil))
 293     (setq org-clock-history
 294           (delq nil
 295                 (mapcar (lambda (x) (if (marker-buffer x) x nil))
 296                         org-clock-history)))
 297     (when (>= (setq l (length org-clock-history)) org-clock-history-length)
 298       (setq org-clock-history
 299             (nreverse
 300              (nthcdr (- l org-clock-history-length -1)
 301                      (nreverse org-clock-history)))))
 302     (push m org-clock-history)))
 303
 304 (defun org-clock-save-markers-for-cut-and-paste (beg end)
 305   "Save relative positions of markers in region."
 306   (org-check-and-save-marker org-clock-marker beg end)
 307   (org-check-and-save-marker org-clock-hd-marker beg end)
 308   (org-check-and-save-marker org-clock-default-task beg end)
 309   (org-check-and-save-marker org-clock-interrupted-task beg end)
 310   (mapc (lambda (m) (org-check-and-save-marker m beg end))
 311         org-clock-history))
 312
 313 (defun org-clock-select-task (&optional prompt)
 314   "Select a task that recently was associated with clocking."
 315   (interactive)
 316   (let (sel-list rpl (i 0) s)
 317     (save-window-excursion
 318       (org-switch-to-buffer-other-window
 319        (get-buffer-create "*Clock Task Select*"))
 320       (erase-buffer)
 321       (when (marker-buffer org-clock-default-task)
 322         (insert (org-add-props "Default Task\n" nil 'face 'bold))
 323         (setq s (org-clock-insert-selection-line ?d org-clock-default-task))
 324         (push s sel-list))
 325       (when (marker-buffer org-clock-interrupted-task)
 326         (insert (org-add-props "The task interrupted by starting the last one\n" nil 'face 'bold))
 327         (setq s (org-clock-insert-selection-line ?i org-clock-interrupted-task))
 328         (push s sel-list))
 329       (when (marker-buffer org-clock-marker)
 330         (insert (org-add-props "Current Clocking Task\n" nil 'face 'bold))
 331         (setq s (org-clock-insert-selection-line ?c org-clock-marker))
 332         (push s sel-list))
 333       (insert (org-add-props "Recent Tasks\n" nil 'face 'bold))
 334       (mapc
 335        (lambda (m)
 336          (when (marker-buffer m)
 337            (setq i (1+ i)
 338                  s (org-clock-insert-selection-line
 339                     (if (< i 10)
 340                         (+ i ?0)
 341                       (+ i (- ?A 10))) m))
 342            (push s sel-list)))
 343        org-clock-history)
 344       (org-fit-window-to-buffer)
 345       (message (or prompt "Select task for clocking:"))
 346       (setq rpl (read-char-exclusive))
 347       (cond
 348        ((eq rpl ?q) nil)
 349        ((eq rpl ?x) nil)
 350        ((assoc rpl sel-list) (cdr (assoc rpl sel-list)))
 351        (t (error "Invalid task choice %c" rpl))))))
 352
 353 (defun org-clock-insert-selection-line (i marker)
 354   "Insert a line for the clock selection menu.
 355 And return a cons cell with the selection character integer and the marker
 356 pointing to it."
 357   (when (marker-buffer marker)
 358     (let (file cat task heading prefix)
 359       (with-current-buffer (org-base-buffer (marker-buffer marker))
 360         (save-excursion
 361           (save-restriction
 362             (widen)
 363             (goto-char marker)
 364             (setq file (buffer-file-name (marker-buffer marker))
 365                   cat (or (org-get-category)
 366                           (progn (org-refresh-category-properties)
 367                                  (org-get-category)))
 368                   heading (org-get-heading 'notags)
 369                   prefix (save-excursion
 370                            (org-back-to-heading t)
 371                            (looking-at "\\*+ ")
 372                            (match-string 0))
 373                   task (substring
 374                         (org-fontify-like-in-org-mode
 375                          (concat prefix heading)
 376                          org-odd-levels-only)
 377                         (length prefix))))))
 378       (when (and cat task)
 379         (insert (format "[%c] %-15s %s\n" i cat task))
 380         (cons i marker)))))
 381
 382 (defun org-clock-get-clock-string ()
 383   "Form a clock-string, that will be show in the mode line.
 384 If an effort estimate was defined for current item, use
 385 01:30/01:50 format (clocked/estimated).
 386 If not, show simply the clocked time like 01:50."
 387   (let* ((clocked-time (org-clock-get-clocked-time))
 388          (h (floor clocked-time 60))
 389          (m (- clocked-time (* 60 h))))
 390     (if (and org-clock-effort)
 391         (let* ((effort-in-minutes (org-hh:mm-string-to-minutes org-clock-effort))
 392                (effort-h (floor effort-in-minutes 60))
 393                (effort-m (- effort-in-minutes (* effort-h 60))))
 394           (format (concat "-[" org-time-clocksum-format "/" org-time-clocksum-format " (%s)]")
 395                   h m effort-h effort-m  org-clock-heading))
 396       (format (concat "-[" org-time-clocksum-format " (%s)]")
 397               h m org-clock-heading))))
 398
 399 (defun org-clock-update-mode-line ()
 400   (setq org-mode-line-string
 401         (org-propertize
 402          (let ((clock-string (org-clock-get-clock-string))
 403                (help-text "Org-mode clock is running.\nmouse-1 shows a menu\nmouse-2 will jump to task"))
 404            (if (and (> org-clock-string-limit 0)
 405                     (> (length clock-string) org-clock-string-limit))
 406                (org-propertize (substring clock-string 0 org-clock-string-limit)
 407                                'help-echo (concat help-text ": " org-clock-heading))
 408              (org-propertize clock-string 'help-echo help-text)))
 409          'local-map org-clock-mode-line-map
 410          'mouse-face (if (featurep 'xemacs) 'highlight 'mode-line-highlight)
 411          'face 'org-mode-line-clock))
 412   (if org-clock-effort (org-clock-notify-once-if-expired))
 413   (force-mode-line-update))
 414
 415 (defun org-clock-get-clocked-time ()
 416   "Get the clocked time for the current item in minutes.
 417 The time returned includes the time spent on this task in
 418 previous clocking intervals."
 419   (let ((currently-clocked-time
 420          (floor (- (org-float-time)
 421                    (org-float-time org-clock-start-time)) 60)))
 422     (+ currently-clocked-time (or org-clock-total-time 0))))
 423
 424 (defun org-clock-modify-effort-estimate (&optional value)
 425  "Add to or set the effort estimate of the item currently being clocked.
 426 VALUE can be a number of minutes, or a string with forat hh:mm or mm.
 427 WHen the strig starts with a + or a - sign, the current value of the effort
 428 property will be changed by that amount.
 429 This will update the \"Effort\" property of currently clocked item, and
 430 the mode line."
 431  (interactive)
 432  (when (org-clock-is-active)
 433    (let ((current org-clock-effort) sign)
 434      (unless value
 435        ;; Prompt user for a value or a change
 436        (setq value
 437              (read-string
 438               (format "Set effort (hh:mm or mm%s): "
 439                       (if current
 440                           (format ", prefix + to add to %s" org-clock-effort)
 441                         "")))))
 442      (when (stringp value)
 443        ;; A string.  See if it is a delta
 444        (setq sign (string-to-char value))
 445        (if (member sign '(?- ?+))
 446            (setq current (org-hh:mm-string-to-minutes (substring current 1)))
 447          (setq current 0))
 448        (setq value (org-hh:mm-string-to-minutes value))
 449        (if (equal ?- sign)
 450            (setq value (- current value))
 451          (if (equal ?+ sign) (setq value (+ current value)))))
 452      (setq value (max 0 value)
 453            org-clock-effort (org-minutes-to-hh:mm-string value))
 454      (org-entry-put org-clock-marker "Effort" org-clock-effort)
 455      (org-clock-update-mode-line)
 456      (message "Effort is now %s" org-clock-effort))))
 457
 458 (defvar org-clock-notification-was-shown nil
 459   "Shows if we have shown notification already.")
 460
 461 (defun org-clock-notify-once-if-expired ()
 462   "Show notification if we spent more time than we estimated before.
 463 Notification is shown only once."
 464   (when (marker-buffer org-clock-marker)
 465     (let ((effort-in-minutes (org-hh:mm-string-to-minutes org-clock-effort))
 466           (clocked-time (org-clock-get-clocked-time)))
 467       (if (>= clocked-time effort-in-minutes)
 468           (unless org-clock-notification-was-shown
 469             (setq org-clock-notification-was-shown t)
 470             (org-notify
 471              (format "Task '%s' should be finished by now. (%s)"
 472                      org-clock-heading org-clock-effort) t))
 473         (setq org-clock-notification-was-shown nil)))))
 474
 475 (defun org-notify (notification &optional play-sound)
 476   "Send a NOTIFICATION and maybe PLAY-SOUND."
 477   (org-show-notification notification)
 478   (if play-sound (org-clock-play-sound)))
 479
 480 (defun org-show-notification (notification)
 481   "Show notification.
 482 Use `org-show-notification-handler' if defined,
 483 use libnotify if available, or fall back on a message."
 484   (cond ((functionp org-show-notification-handler)
 485          (funcall org-show-notification-handler notification))
 486         ((stringp org-show-notification-handler)
 487          (start-process "emacs-timer-notification" nil
 488                         org-show-notification-handler notification))
 489         ((org-program-exists "notify-send")
 490          (start-process "emacs-timer-notification" nil
 491                         "notify-send" notification))
 492         ;; Maybe the handler will send a message, so only use message as
 493         ;; a fall back option
 494         (t (message notification))))
 495
 496 (defun org-clock-play-sound ()
 497   "Play sound as configured by `org-clock-sound'.
 498 Use alsa's aplay tool if available."
 499   (cond
 500    ((not org-clock-sound))
 501    ((eq org-clock-sound t) (beep t) (beep t))
 502    ((stringp org-clock-sound)
 503     (if (file-exists-p org-clock-sound)
 504         (if (org-program-exists "aplay")
 505             (start-process "org-clock-play-notification" nil
 506                            "aplay" org-clock-sound)
 507           (condition-case nil
 508               (play-sound-file org-clock-sound)
 509             (error (beep t) (beep t))))))))
 510
 511 (defun org-program-exists (program-name)
 512   "Checks whenever we can locate program and launch it."
 513   (if (eq system-type 'gnu/linux)
 514       (= 0 (call-process "which" nil nil nil program-name))))
 515
 516 (defvar org-clock-mode-line-entry nil
 517   "Information for the modeline about the running clock.")
 518
 519 (defun org-find-open-clocks (file)
 520   "Search through the given file and find all open clocks."
 521   (let ((buf (or (get-file-buffer file)
 522                  (find-file-noselect file)))
 523         clocks)
 524     (with-current-buffer buf
 525       (save-excursion
 526         (goto-char (point-min))
 527         (while (re-search-forward "CLOCK: \\(\\[.*?\\]\\)$" nil t)
 528           (push (cons (copy-marker (1- (match-end 1)) t)
 529                       (org-time-string-to-time (match-string 1))) clocks))))
 530     clocks))
 531
 532 (defsubst org-is-active-clock (clock)
 533   "Return t if CLOCK is the currently active clock."
 534   (and (org-clock-is-active)
 535        (= org-clock-marker (car clock))))
 536
 537 (defmacro org-with-clock-position (clock &rest forms)
 538   "Evaluate FORMS with CLOCK as the current active clock."
 539   `(with-current-buffer (marker-buffer (car ,clock))
 540      (save-excursion
 541        (save-restriction
 542          (widen)
 543          (goto-char (car ,clock))
 544          (beginning-of-line)
 545          ,@forms))))
 546
 547 (put 'org-with-clock-position 'lisp-indent-function 1)
 548
 549 (defmacro org-with-clock (clock &rest forms)
 550   "Evaluate FORMS with CLOCK as the current active clock.
 551 This macro also protects the current active clock from being altered."
 552   `(org-with-clock-position ,clock
 553      (let ((org-clock-start-time (cdr ,clock))
 554            (org-clock-total-time)
 555            (org-clock-history)
 556            (org-clock-effort)
 557            (org-clock-marker (car ,clock))
 558            (org-clock-hd-marker (save-excursion
 559                                   (outline-back-to-heading t)
 560                                   (point-marker))))
 561        ,@forms)))
 562
 563 (put 'org-with-clock 'lisp-indent-function 1)
 564
 565 (defsubst org-clock-clock-in (clock &optional resume)
 566   "Clock in to the clock located by CLOCK.
 567 If necessary, clock-out of the currently active clock."
 568   (org-with-clock-position clock
 569     (let ((org-clock-in-resume (or resume org-clock-in-resume)))
 570       (org-clock-in))))
 571
 572 (defsubst org-clock-clock-out (clock &optional fail-quietly at-time)
 573   "Clock out of the clock located by CLOCK."
 574   (let ((temp (copy-marker (car clock)
 575                            (marker-insertion-type (car clock)))))
 576     (if (org-is-active-clock clock)
 577         (org-clock-out fail-quietly at-time)
 578       (org-with-clock clock
 579         (org-clock-out fail-quietly at-time)))
 580     (setcar clock temp)))
 581
 582 (defsubst org-clock-clock-cancel (clock)
 583   "Cancel the clock located by CLOCK."
 584   (let ((temp (copy-marker (car clock)
 585                            (marker-insertion-type (car clock)))))
 586     (if (org-is-active-clock clock)
 587         (org-clock-cancel)
 588       (org-with-clock clock
 589         (org-clock-cancel)))
 590     (setcar clock temp)))
 591
 592 (defvar org-clock-clocking-in nil)
 593 (defvar org-clock-resolving-clocks nil)
 594 (defvar org-clock-resolving-clocks-due-to-idleness nil)
 595
 596 (defun org-clock-resolve-clock (clock resolve-to &optional close-p
 597                                       restart-p fail-quietly)
 598   "Resolve `CLOCK' given the time `RESOLVE-TO', and the present.
 599 `CLOCK' is a cons cell of the form (MARKER START-TIME).
 600 This routine can do one of many things:
 601
 602   if `RESOLVE-TO' is nil
 603     if `CLOSE-P' is non-nil, give an error
 604     if this clock is the active clock, cancel it
 605     else delete the clock line (as if it never happened)
 606     if `RESTART-P' is non-nil, start a new clock
 607
 608   else if `RESOLVE-TO' is the symbol `now'
 609     if `RESTART-P' is non-nil, give an error
 610     if `CLOSE-P' is non-nil, clock out the entry and
 611        if this clock is the active clock, stop it
 612     else if this clock is the active clock, do nothing
 613     else if there is no active clock, resume this clock
 614     else ask to cancel the active clock, and if so,
 615          resume this clock after cancelling it
 616
 617   else if `RESOLVE-TO' is some date in the future
 618     give an error about `RESOLVE-TO' being invalid
 619
 620   else if `RESOLVE-TO' is some date in the past
 621     if `RESTART-P' is non-nil, give an error
 622     if `CLOSE-P' is non-nil, enter a closing time and
 623        if this clock is the active clock, stop it
 624     else if this clock is the active clock, enter a
 625        closing time, stop the current clock, then
 626        start a new clock for the same item
 627     else just enter a closing time for this clock
 628        and then start a new clock for the same item"
 629   (let ((org-clock-resolving-clocks t))
 630     (cond
 631      ((null resolve-to)
 632       (org-clock-clock-cancel clock)
 633       (if (and restart-p (not org-clock-clocking-in))
 634           (org-clock-clock-in clock)))
 635
 636      ((eq resolve-to 'now)
 637       (if restart-p
 638           (error "RESTART-P is not valid here"))
 639       (if (or close-p org-clock-clocking-in)
 640           (org-clock-clock-out clock fail-quietly)
 641         (unless (org-is-active-clock clock)
 642           (org-clock-clock-in clock t))))
 643
 644      ((not (time-less-p resolve-to (current-time)))
 645       (error "RESOLVE-TO must refer to a time in the past"))
 646
 647      (t
 648       (if restart-p
 649           (error "RESTART-P is not valid here"))
 650       (org-clock-clock-out clock fail-quietly resolve-to)
 651       (unless org-clock-clocking-in
 652         (if close-p
 653             (setq org-clock-left-over-time resolve-to)
 654           (org-clock-clock-in clock)))))))
 655
 656 (defun org-clock-resolve (clock &optional prompt-fn last-valid fail-quietly)
 657   "Resolve an open org-mode clock.
 658 An open clock was found, with `dangling' possibly being non-nil.
 659 If this function was invoked with a prefix argument, non-dangling
 660 open clocks are ignored.  The given clock requires some sort of
 661 user intervention to resolve it, either because a clock was left
 662 dangling or due to an idle timeout.  The clock resolution can
 663 either be:
 664
 665   (a) deleted, the user doesn't care about the clock
 666   (b) restarted from the current time (if no other clock is open)
 667   (c) closed, giving the clock X minutes
 668   (d) closed and then restarted
 669   (e) resumed, as if the user had never left
 670
 671 The format of clock is (CONS MARKER START-TIME), where MARKER
 672 identifies the buffer and position the clock is open at (and
 673 thus, the heading it's under), and START-TIME is when the clock
 674 was started."
 675   (assert clock)
 676   (let* ((ch
 677           (save-window-excursion
 678             (save-excursion
 679               (unless org-clock-resolving-clocks-due-to-idleness
 680                 (org-with-clock clock
 681                   (org-clock-goto))
 682                 (with-current-buffer (marker-buffer (car clock))
 683                   (goto-char (car clock))
 684                   (if org-clock-into-drawer
 685                       (ignore-errors
 686                         (outline-flag-region (save-excursion
 687                                                (outline-back-to-heading t)
 688                                                (search-forward ":LOGBOOK:")
 689                                                (goto-char (match-beginning 0)))
 690                                              (save-excursion
 691                                                (outline-back-to-heading t)
 692                                                (search-forward ":LOGBOOK:")
 693                                                (search-forward ":END:")
 694                                                (goto-char (match-end 0)))
 695                                              nil)))))
 696               (let (char-pressed)
 697                 (while (null char-pressed)
 698                   (setq char-pressed
 699                         (read-char (concat (funcall prompt-fn clock)
 700                                            " [(kK)eep (sS)ubtract (C)ancel]? ")
 701                                    nil 45)))
 702                 char-pressed))))
 703          (default (floor (/ (org-float-time
 704                              (time-subtract (current-time) last-valid)) 60)))
 705          (keep (and (memq ch '(?k ?K))
 706                     (read-number "Keep how many minutes? " default)))
 707          (subtractp (memq ch '(?s ?S)))
 708          (barely-started-p (< (- (org-float-time last-valid)
 709                                  (org-float-time (cdr clock))) 45))
 710          (start-over (and subtractp barely-started-p)))
 711     (if (or (null ch)
 712             (not (memq ch '(?k ?K ?s ?S ?C))))
 713         (message "")
 714       (org-clock-resolve-clock
 715        clock (cond
 716               ((or (eq ch ?C)
 717                    ;; If the time on the clock was less than a minute before
 718                    ;; the user went away, and they've ask to subtract all the
 719                    ;; time...
 720                    start-over)
 721                nil)
 722               (subtractp
 723                last-valid)
 724               ((= keep default)
 725                'now)
 726               (t
 727                (time-add last-valid (seconds-to-time (* 60 keep)))))
 728        (memq ch '(?K ?S))
 729        (and start-over
 730             (not (memq ch '(?K ?S ?C))))
 731        fail-quietly))))
 732
 733 (defun org-resolve-clocks (&optional also-non-dangling-p prompt-fn last-valid)
 734   "Resolve all currently open org-mode clocks.
 735 If `also-non-dangling-p' is non-nil, also ask to resolve
 736 non-dangling (i.e., currently open and valid) clocks."
 737   (interactive "P")
 738   (unless org-clock-resolving-clocks
 739     (let ((org-clock-resolving-clocks t))
 740       (dolist (file (org-files-list))
 741         (let ((clocks (org-find-open-clocks file)))
 742           (dolist (clock clocks)
 743             (let ((dangling (or (not (org-clock-is-active))
 744                                 (/= (car clock) org-clock-marker))))
 745               (unless (and (not dangling) (not also-non-dangling-p))
 746                 (org-clock-resolve
 747                  clock
 748                  (or prompt-fn
 749                      (function
 750                       (lambda (clock)
 751                         (format
 752                          "Dangling clock started %d mins ago"
 753                          (floor
 754                           (/ (- (org-float-time (current-time))
 755                                 (org-float-time (cdr clock))) 60))))))
 756                  (or last-valid
 757                      (cdr clock)))))))))))
 758
 759 (defun org-emacs-idle-seconds ()
 760   "Return the current Emacs idle time in seconds, or nil if not idle."
 761   (let ((idle-time (current-idle-time)))
 762     (if idle-time
 763         (org-float-time idle-time)
 764       0)))
 765
 766 (defun org-mac-idle-seconds ()
 767   "Return the current Mac idle time in seconds"
 768   (string-to-number (shell-command-to-string "ioreg -c IOHIDSystem | perl -ane 'if (/Idle/) {$idle=(pop @F)/1000000000; print $idle; last}'")))
 769
 770 (defun org-x11-idle-seconds ()
 771   "Return the current X11 idle time in seconds"
 772   (/ (string-to-number (shell-command-to-string "x11idle")) 1000))
 773
 774 (defun org-user-idle-seconds ()
 775   "Return the number of seconds the user has been idle for.
 776 This routine returns a floating point number."
 777   (if (or (eq system-type 'darwin) (eq window-system 'x))
 778       (let ((emacs-idle (org-emacs-idle-seconds)))
 779         ;; If Emacs has been idle for longer than the user's
 780         ;; `org-clock-idle-time' value, check whether the whole system has
 781         ;; really been idle for that long.
 782         (if (> emacs-idle (* 60 org-clock-idle-time))
 783             (min emacs-idle (if (eq system-type 'darwin)
 784                                 (org-mac-idle-seconds)
 785                               (org-x11-idle-seconds)))
 786           emacs-idle))
 787     (org-emacs-idle-seconds)))
 788
 789 (defvar org-clock-user-idle-seconds)
 790
 791 (defun org-resolve-clocks-if-idle ()
 792   "Resolve all currently open org-mode clocks.
 793 This is performed after `org-clock-idle-time' minutes, to check
 794 if the user really wants to stay clocked in after being idle for
 795 so long."
 796   (when (and org-clock-idle-time (not org-clock-resolving-clocks)
 797              org-clock-marker)
 798     (let ((org-clock-user-idle-start (current-time))
 799           (org-clock-user-idle-seconds (org-user-idle-seconds))
 800           (org-clock-resolving-clocks-due-to-idleness t))
 801       (if (> org-clock-user-idle-seconds (* 60 org-clock-idle-time))
 802           (org-clock-resolve
 803            (cons org-clock-marker
 804                  org-clock-start-time)
 805            (function
 806             (lambda (clock)
 807               (format "Clocked in & idle for %d mins"
 808                       (/ (time-to-seconds
 809                           (time-subtract (current-time)
 810                                          org-clock-user-idle-start)) 60))))
 811            (time-subtract (current-time)
 812                           (seconds-to-time org-clock-user-idle-seconds)))))))
 813
 814 (defun org-clock-in (&optional select)
 815   "Start the clock on the current item.
 816 If necessary, clock-out of the currently active clock.
 817 With prefix arg SELECT, offer a list of recently clocked tasks to
 818 clock into.  When SELECT is `C-u C-u', clock into the current task and mark
 819 is as the default task, a special task that will always be offered in
 820 the clocking selection, associated with the letter `d'."
 821   (interactive "P")
 822   (setq org-clock-notification-was-shown nil)
 823   (catch 'abort
 824     (let ((interrupting (and (not org-clock-resolving-clocks-due-to-idleness)
 825                              (marker-buffer org-clock-marker)))
 826           ts selected-task target-pos (msg-extra "")
 827           (left-over (and (not org-clock-resolving-clocks)
 828                           org-clock-left-over-time)))
 829       (when (and org-clock-auto-clock-resolution
 830                  (or (not interrupting)
 831                      (eq t org-clock-auto-clock-resolution))
 832                  (not org-clock-clocking-in)
 833                  (not org-clock-resolving-clocks))
 834         (setq org-clock-left-over-time nil)
 835         (let ((org-clock-clocking-in t))
 836           (org-resolve-clocks)))        ; check if any clocks are dangling
 837       (when (equal select '(4))
 838         (setq selected-task (org-clock-select-task "Clock-in on task: "))
 839         (if selected-task
 840             (setq selected-task (copy-marker selected-task))
 841           (error "Abort")))
 842       (when interrupting
 843         ;; We are interrupting the clocking of a different task.
 844         ;; Save a marker to this task, so that we can go back.
 845         (move-marker org-clock-interrupted-task
 846                      (marker-position org-clock-marker)
 847                      (marker-buffer org-clock-marker))
 848         (org-clock-out t))
 849
 850       (when (equal select '(16))
 851         ;; Mark as default clocking task
 852         (org-clock-mark-default-task))
 853
 854       ;; Clock in at which position?
 855       (setq target-pos
 856             (if (and (eobp) (not (org-on-heading-p)))
 857                 (point-at-bol 0)
 858               (point)))
 859       (run-hooks 'org-clock-in-prepare-hook)
 860       (save-excursion
 861         (when (and selected-task (marker-buffer selected-task))
 862           ;; There is a selected task, move to the correct buffer
 863           ;; and set the new target position.
 864           (set-buffer (org-base-buffer (marker-buffer selected-task)))
 865           (setq target-pos (marker-position selected-task))
 866           (move-marker selected-task nil))
 867         (save-excursion
 868           (save-restriction
 869             (widen)
 870             (goto-char target-pos)
 871             (org-back-to-heading t)
 872             (or interrupting (move-marker org-clock-interrupted-task nil))
 873             (org-clock-history-push)
 874             (cond ((functionp org-clock-in-switch-to-state)
 875                    (looking-at org-complex-heading-regexp)
 876                    (let ((newstate (funcall org-clock-in-switch-to-state
 877                                             (match-string 2))))
 878                      (if newstate (org-todo newstate))))
 879                   ((and org-clock-in-switch-to-state
 880                         (not (looking-at (concat outline-regexp "[ \t]*"
 881                                                  org-clock-in-switch-to-state
 882                                                  "\\>"))))
 883                    (org-todo org-clock-in-switch-to-state)))
 884             (setq org-clock-heading-for-remember
 885                   (and (looking-at org-complex-heading-regexp)
 886                        (match-end 4)
 887                        (org-trim (buffer-substring (match-end 1)
 888                                                    (match-end 4)))))
 889             (setq org-clock-heading
 890                   (cond ((and org-clock-heading-function
 891                               (functionp org-clock-heading-function))
 892                          (funcall org-clock-heading-function))
 893                         ((looking-at org-complex-heading-regexp)
 894                          (match-string 4))
 895                         (t "???")))
 896             (setq org-clock-heading (org-propertize org-clock-heading
 897                                                     'face nil))
 898             (org-clock-find-position org-clock-in-resume)
 899             (cond
 900              ((and org-clock-in-resume
 901                    (looking-at
 902                     (concat "^[ \t]* " org-clock-string
 903                             " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
 904                             " +\\sw+\.? +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")))
 905               (message "Matched %s" (match-string 1))
 906               (setq ts (concat "[" (match-string 1) "]"))
 907               (goto-char (match-end 1))
 908               (setq org-clock-start-time
 909                     (apply 'encode-time
 910                            (org-parse-time-string (match-string 1))))
 911               (setq org-clock-effort (org-get-effort))
 912               (setq org-clock-total-time (org-clock-sum-current-item
 913                                           (org-clock-get-sum-start))))
 914              ((eq org-clock-in-resume 'auto-restart)
 915               ;; called from org-clock-load during startup,
 916               ;; do not interrupt, but warn!
 917               (message "Cannot restart clock because task does not contain unfinished clock")
 918               (ding)
 919               (sit-for 2)
 920               (throw 'abort nil))
 921              (t
 922               (insert-before-markers "\n")
 923               (backward-char 1)
 924               (org-indent-line-function)
 925               (when (and (save-excursion
 926                            (end-of-line 0)
 927                            (org-in-item-p)))
 928                 (beginning-of-line 1)
 929                 (org-indent-line-to (- (org-get-indentation) 2)))
 930               (insert org-clock-string " ")
 931               (setq org-clock-effort (org-get-effort))
 932               (setq org-clock-total-time (org-clock-sum-current-item
 933                                           (org-clock-get-sum-start)))
 934               (setq org-clock-start-time
 935                     (or (and left-over
 936                              (y-or-n-p
 937                               (format
 938                                "You stopped another clock %d mins ago; start this one from then? "
 939                                (/ (- (org-float-time (current-time))
 940                                      (org-float-time left-over)) 60)))
 941                              left-over)
 942                         (current-time)))
 943               (setq ts (org-insert-time-stamp org-clock-start-time
 944                                               'with-hm 'inactive))))
 945             (move-marker org-clock-marker (point) (buffer-base-buffer))
 946             (move-marker org-clock-hd-marker
 947                          (save-excursion (org-back-to-heading t) (point))
 948                          (buffer-base-buffer))
 949             (setq org-clock-has-been-used t)
 950             (or global-mode-string (setq global-mode-string '("")))
 951             (or (memq 'org-mode-line-string global-mode-string)
 952                 (setq global-mode-string
 953                       (append global-mode-string '(org-mode-line-string))))
 954             (org-clock-update-mode-line)
 955             (when org-clock-mode-line-timer
 956               (cancel-timer org-clock-mode-line-timer)
 957               (setq org-clock-mode-line-timer nil))
 958             (setq org-clock-mode-line-timer
 959                   (run-with-timer 60 60 'org-clock-update-mode-line))
 960             (when org-clock-idle-timer
 961               (cancel-timer org-clock-idle-timer)
 962               (setq org-clock-idle-timer nil))
 963             (setq org-clock-idle-timer
 964                   (run-with-timer 60 60 'org-resolve-clocks-if-idle))
 965             (message "Clock starts at %s - %s" ts msg-extra)
 966             (run-hooks 'org-clock-in-hook)))))))
 967
 968 (defun org-clock-mark-default-task ()
 969   "Mark current task as default task."
 970   (interactive)
 971   (save-excursion
 972     (org-back-to-heading t)
 973     (move-marker org-clock-default-task (point))))
 974
 975 (defvar msg-extra)
 976 (defun org-clock-get-sum-start ()
 977   "Return the time from which clock times should be counted.
 978 This is for the currently running clock as it is displayed
 979 in the mode line.  This function looks at the properties
 980 LAST_REPEAT and in particular CLOCK_MODELINE_TOTAL and the
 981 corresponding variable `org-clock-modeline-total' and then
 982 decides which time to use."
 983   (let ((cmt (or (org-entry-get nil "CLOCK_MODELINE_TOTAL")
 984                  (symbol-name org-clock-modeline-total)))
 985         (lr (org-entry-get nil "LAST_REPEAT")))
 986     (cond
 987      ((equal cmt "current")
 988       (setq msg-extra "showing time in current clock instance")
 989       (current-time))
 990      ((equal cmt "today")
 991       (setq msg-extra "showing today's task time.")
 992       (let* ((dt (decode-time (current-time))))
 993         (setq dt (append (list 0 0 0) (nthcdr 3 dt)))
 994         (if org-extend-today-until
 995             (setf (nth 2 dt) org-extend-today-until))
 996         (apply 'encode-time dt)))
 997      ((or (equal cmt "all")
 998           (and (or (not cmt) (equal cmt "auto"))
 999                (not lr)))
1000       (setq msg-extra "showing entire task time.")
1001       nil)
1002      ((or (equal cmt "repeat")
1003           (and (or (not cmt) (equal cmt "auto"))
1004                lr))
1005       (setq msg-extra "showing task time since last repeat.")
1006       (if (not lr)
1007           nil
1008         (org-time-string-to-time lr)))
1009      (t nil))))
1010
1011 (defun org-clock-find-position (find-unclosed)
1012   "Find the location where the next clock line should be inserted.
1013 When FIND-UNCLOSED is non-nil, first check if there is an unclosed clock
1014 line and position cursor in that line."
1015   (org-back-to-heading t)
1016   (catch 'exit
1017     (let ((beg (save-excursion
1018                  (beginning-of-line 2)
1019                  (or (bolp) (newline))
1020                  (point)))
1021           (end (progn (outline-next-heading) (point)))
1022           (re (concat "^[ \t]*" org-clock-string))
1023           (cnt 0)
1024           (drawer (if (stringp org-clock-into-drawer)
1025                       org-clock-into-drawer "LOGBOOK"))
1026           first last ind-last)
1027       (goto-char beg)
1028       (when (and find-unclosed
1029                  (re-search-forward
1030                   (concat "^[ \t]* " org-clock-string
1031                           " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}"
1032                           " +\\sw+ +[012][0-9]:[0-5][0-9]\\)\\][ \t]*$")
1033                   end t))
1034         (beginning-of-line 1)
1035         (throw 'exit t))
1036       (when (eobp) (newline) (setq end (max (point) end)))
1037       (when (re-search-forward (concat "^[ \t]*:" drawer ":") end t)
1038         ;; we seem to have a CLOCK drawer, so go there.
1039         (beginning-of-line 2)
1040         (or org-log-states-order-reversed
1041             (and (re-search-forward org-property-end-re nil t)
1042                  (goto-char (match-beginning 0))))
1043         (throw 'exit t))
1044       ;; Lets count the CLOCK lines
1045       (goto-char beg)
1046       (while (re-search-forward re end t)
1047         (setq first (or first (match-beginning 0))
1048               last (match-beginning 0)
1049               cnt (1+ cnt)))
1050       (when (and (integerp org-clock-into-drawer)
1051                  last
1052                  (>= (1+ cnt) org-clock-into-drawer))
1053         ;; Wrap current entries into a new drawer
1054         (goto-char last)
1055         (setq ind-last (org-get-indentation))
1056         (beginning-of-line 2)
1057         (if (and (>= (org-get-indentation) ind-last)
1058                  (org-at-item-p))
1059             (org-end-of-item))
1060         (insert ":END:\n")
1061         (beginning-of-line 0)
1062         (org-indent-line-to ind-last)
1063         (goto-char first)
1064         (insert ":" drawer ":\n")
1065         (beginning-of-line 0)
1066         (org-indent-line-function)
1067         (org-flag-drawer t)
1068         (beginning-of-line 2)
1069         (or org-log-states-order-reversed
1070             (and (re-search-forward org-property-end-re nil t)
1071                  (goto-char (match-beginning 0))))
1072         (throw 'exit nil))
1073
1074       (goto-char beg)
1075       (while (and (looking-at (concat "[ \t]*" org-keyword-time-regexp))
1076                   (not (equal (match-string 1) org-clock-string)))
1077         ;; Planning info, skip to after it
1078         (beginning-of-line 2)
1079         (or (bolp) (newline)))
1080       (when (or (eq org-clock-into-drawer t)
1081                 (stringp org-clock-into-drawer)
1082                 (and (integerp org-clock-into-drawer)
1083                      (< org-clock-into-drawer 2)))
1084         (insert ":" drawer ":\n:END:\n")
1085         (beginning-of-line -1)
1086         (org-indent-line-function)
1087         (org-flag-drawer t)
1088         (beginning-of-line 2)
1089         (org-indent-line-function)
1090         (beginning-of-line)
1091         (or org-log-states-order-reversed
1092             (and (re-search-forward org-property-end-re nil t)
1093                  (goto-char (match-beginning 0))))))))
1094
1095 (defun org-clock-out (&optional fail-quietly at-time)
1096   "Stop the currently running clock.
1097 If there is no running clock, throw an error, unless FAIL-QUIETLY is set."
1098   (interactive)
1099   (catch 'exit
1100     (if (not (marker-buffer org-clock-marker))
1101         (if fail-quietly (throw 'exit t) (error "No active clock")))
1102     (let (ts te s h m remove)
1103       (save-excursion
1104         (set-buffer (marker-buffer org-clock-marker))
1105         (save-restriction
1106           (widen)
1107           (goto-char org-clock-marker)
1108           (beginning-of-line 1)
1109           (if (and (looking-at (concat "[ \t]*" org-keyword-time-regexp))
1110                    (equal (match-string 1) org-clock-string))
1111               (setq ts (match-string 2))
1112             (if fail-quietly (throw 'exit nil) (error "Clock start time is gone")))
1113           (goto-char (match-end 0))
1114           (delete-region (point) (point-at-eol))
1115           (insert "--")
1116           (setq te (org-insert-time-stamp (or at-time (current-time))
1117                                           'with-hm 'inactive))
1118           (setq s (- (org-float-time (apply 'encode-time (org-parse-time-string te)))
1119                      (org-float-time (apply 'encode-time (org-parse-time-string ts))))
1120                 h (floor (/ s 3600))
1121                 s (- s (* 3600 h))
1122                 m (floor (/ s 60))
1123                 s (- s (* 60 s)))
1124           (insert " => " (format "%2d:%02d" h m))
1125           (when (setq remove (and org-clock-out-remove-zero-time-clocks
1126                                   (= (+ h m) 0)))
1127             (beginning-of-line 1)
1128             (delete-region (point) (point-at-eol))
1129             (and (looking-at "\n") (> (point-max) (1+ (point)))
1130                  (delete-char 1)))
1131           (move-marker org-clock-marker nil)
1132           (move-marker org-clock-hd-marker nil)
1133           (when org-log-note-clock-out
1134             (org-add-log-setup 'clock-out nil nil nil nil
1135                                (concat "# Task: " (org-get-heading t) "\n\n")))
1136           (when org-clock-mode-line-timer
1137             (cancel-timer org-clock-mode-line-timer)
1138             (setq org-clock-mode-line-timer nil))
1139           (when org-clock-idle-timer
1140             (cancel-timer org-clock-idle-timer)
1141             (setq org-clock-idle-timer nil))
1142           (setq global-mode-string
1143                 (delq 'org-mode-line-string global-mode-string))
1144           (when org-clock-out-switch-to-state
1145             (save-excursion
1146               (org-back-to-heading t)
1147               (let ((org-inhibit-logging t))
1148                 (cond
1149                  ((functionp org-clock-out-switch-to-state)
1150                   (looking-at org-complex-heading-regexp)
1151                   (let ((newstate (funcall org-clock-out-switch-to-state
1152                                            (match-string 2))))
1153                     (if newstate (org-todo newstate))))
1154                  ((and org-clock-out-switch-to-state
1155                        (not (looking-at (concat outline-regexp "[ \t]*"
1156                                                 org-clock-out-switch-to-state
1157                                                 "\\>"))))
1158                   (org-todo org-clock-out-switch-to-state))))))
1159           (force-mode-line-update)
1160           (message (concat "Clock stopped at %s after HH:MM = " org-time-clocksum-format "%s") te h m
1161                    (if remove " => LINE REMOVED" ""))
1162           (run-hooks 'org-clock-out-hook))))))
1163
1164 (defun org-clock-cancel ()
1165   "Cancel the running clock be removing the start timestamp."
1166   (interactive)
1167   (if (not (marker-buffer org-clock-marker))
1168       (error "No active clock"))
1169   (save-excursion
1170     (set-buffer (marker-buffer org-clock-marker))
1171     (goto-char org-clock-marker)
1172     (delete-region (1- (point-at-bol)) (point-at-eol))
1173     ;; Just in case, remove any empty LOGBOOK left over
1174     (org-remove-empty-drawer-at "LOGBOOK" (point)))
1175   (move-marker org-clock-marker nil)
1176   (move-marker org-clock-hd-marker nil)
1177   (setq global-mode-string
1178         (delq 'org-mode-line-string global-mode-string))
1179   (force-mode-line-update)
1180   (message "Clock canceled")
1181   (run-hooks 'org-clock-cancel-hook))
1182
1183 (defun org-clock-goto (&optional select)
1184   "Go to the currently clocked-in entry, or to the most recently clocked one.
1185 With prefix arg SELECT, offer recently clocked tasks for selection."
1186   (interactive "@P")
1187   (let* ((recent nil)
1188          (m (cond
1189              (select
1190               (or (org-clock-select-task "Select task to go to: ")
1191                   (error "No task selected")))
1192              ((marker-buffer org-clock-marker) org-clock-marker)
1193              ((and org-clock-goto-may-find-recent-task
1194                    (car org-clock-history)
1195                    (marker-buffer (car org-clock-history)))
1196               (setq recent t)
1197               (car org-clock-history))
1198              (t (error "No active or recent clock task")))))
1199     (switch-to-buffer (marker-buffer m))
1200     (if (or (< m (point-min)) (> m (point-max))) (widen))
1201     (goto-char m)
1202     (org-show-entry)
1203     (org-back-to-heading t)
1204     (org-cycle-hide-drawers 'children)
1205     (recenter)
1206     (if recent
1207         (message "No running clock, this is the most recently clocked task"))
1208     (run-hooks 'org-clock-goto-hook)))
1209
1210 (defvar org-clock-file-total-minutes nil
1211   "Holds the file total time in minutes, after a call to `org-clock-sum'.")
1212 (make-variable-buffer-local 'org-clock-file-total-minutes)
1213
1214 (defun org-clock-sum (&optional tstart tend)
1215   "Sum the times for each subtree.
1216 Puts the resulting times in minutes as a text property on each headline.
1217 TSTART and TEND can mark a time range to be considered."
1218   (interactive)
1219   (let* ((bmp (buffer-modified-p))
1220          (re (concat "^\\(\\*+\\)[ \t]\\|^[ \t]*"
1221                      org-clock-string
1222                      "[ \t]*\\(?:\\(\\[.*?\\]\\)-+\\(\\[.*?\\]\\)\\|=>[ \t]+\\([0-9]+\\):\\([0-9]+\\)\\)"))
1223          (lmax 30)
1224          (ltimes (make-vector lmax 0))
1225          (t1 0)
1226          (level 0)
1227          ts te dt
1228          time)
1229     (if (stringp tstart) (setq tstart (org-time-string-to-seconds tstart)))
1230     (if (stringp tend) (setq tend (org-time-string-to-seconds tend)))
1231     (if (consp tstart) (setq tstart (org-float-time tstart)))
1232     (if (consp tend) (setq tend (org-float-time tend)))
1233     (remove-text-properties (point-min) (point-max) '(:org-clock-minutes t))
1234     (save-excursion
1235       (goto-char (point-max))
1236       (while (re-search-backward re nil t)
1237         (cond
1238          ((match-end 2)
1239           ;; Two time stamps
1240           (setq ts (match-string 2)
1241                 te (match-string 3)
1242                 ts (org-float-time
1243                     (apply 'encode-time (org-parse-time-string ts)))
1244                 te (org-float-time
1245                     (apply 'encode-time (org-parse-time-string te)))
1246                 ts (if tstart (max ts tstart) ts)
1247                 te (if tend (min te tend) te)
1248                 dt (- te ts)
1249                 t1 (if (> dt 0) (+ t1 (floor (/ dt 60))) t1)))
1250          ((match-end 4)
1251           ;; A naked time
1252           (setq t1 (+ t1 (string-to-number (match-string 5))
1253                       (* 60 (string-to-number (match-string 4))))))
1254          (t ;; A headline
1255           (setq level (- (match-end 1) (match-beginning 1)))
1256           (when (or (> t1 0) (> (aref ltimes level) 0))
1257             (loop for l from 0 to level do
1258                   (aset ltimes l (+ (aref ltimes l) t1)))
1259             (setq t1 0 time (aref ltimes level))
1260             (loop for l from level to (1- lmax) do
1261                   (aset ltimes l 0))
1262             (goto-char (match-beginning 0))
1263             (put-text-property (point) (point-at-eol) :org-clock-minutes time)))))
1264       (setq org-clock-file-total-minutes (aref ltimes 0)))
1265     (set-buffer-modified-p bmp)))
1266
1267 (defun org-clock-sum-current-item (&optional tstart)
1268   "Returns time, clocked on current item in total"
1269   (save-excursion
1270     (save-restriction
1271       (org-narrow-to-subtree)
1272       (org-clock-sum tstart)
1273       org-clock-file-total-minutes)))
1274
1275 (defun org-clock-display (&optional total-only)
1276   "Show subtree times in the entire buffer.
1277 If TOTAL-ONLY is non-nil, only show the total time for the entire file
1278 in the echo area."
1279   (interactive)
1280   (org-clock-remove-overlays)
1281   (let (time h m p)
1282     (org-clock-sum)
1283     (unless total-only
1284       (save-excursion
1285         (goto-char (point-min))
1286         (while (or (and (equal (setq p (point)) (point-min))
1287                         (get-text-property p :org-clock-minutes))
1288                    (setq p (next-single-property-change
1289                             (point) :org-clock-minutes)))
1290           (goto-char p)
1291           (when (setq time (get-text-property p :org-clock-minutes))
1292             (org-clock-put-overlay time (funcall outline-level))))
1293         (setq h (/ org-clock-file-total-minutes 60)
1294               m (- org-clock-file-total-minutes (* 60 h)))
1295         ;; Arrange to remove the overlays upon next change.
1296         (when org-remove-highlights-with-change
1297           (org-add-hook 'before-change-functions 'org-clock-remove-overlays
1298                         nil 'local))))
1299     (if org-time-clocksum-use-fractional
1300         (message (concat "Total file time: " org-time-clocksum-fractional-format
1301                          " (%d hours and %d minutes)")
1302                  (/ (+ (* h 60.0) m) 60.0) h m)
1303       (message (concat "Total file time: " org-time-clocksum-format
1304                        " (%d hours and %d minutes)") h m h m))))
1305
1306 (defvar org-clock-overlays nil)
1307 (make-variable-buffer-local 'org-clock-overlays)
1308
1309 (defun org-clock-put-overlay (time &optional level)
1310   "Put an overlays on the current line, displaying TIME.
1311 If LEVEL is given, prefix time with a corresponding number of stars.
1312 This creates a new overlay and stores it in `org-clock-overlays', so that it
1313 will be easy to remove."
1314   (let* ((c 60) (h (floor (/ time 60))) (m (- time (* 60 h)))
1315          (l (if level (org-get-valid-level level 0) 0))
1316          (fmt (concat "%s " (if org-time-clocksum-use-fractional
1317                                 org-time-clocksum-fractional-format
1318                               org-time-clocksum-format) "%s"))
1319          (off 0)
1320          ov tx)
1321     (org-move-to-column c)
1322     (unless (eolp) (skip-chars-backward "^ \t"))
1323     (skip-chars-backward " \t")
1324     (setq ov (org-make-overlay (1- (point)) (point-at-eol))
1325           tx (concat (buffer-substring (1- (point)) (point))
1326                      (make-string (+ off (max 0 (- c (current-column)))) ?.)
1327                      (org-add-props (if org-time-clocksum-use-fractional
1328                                         (format fmt
1329                                                 (make-string l ?*)
1330                                                 (/ (+ (* h 60.0) m) 60.0)
1331                                                 (make-string (- 16 l) ?\ ))
1332                                       (format fmt
1333                                               (make-string l ?*) h m
1334                                               (make-string (- 16 l) ?\ )))
1335                          (list 'face 'org-clock-overlay))
1336                      ""))
1337     (if (not (featurep 'xemacs))
1338         (org-overlay-put ov 'display tx)
1339       (org-overlay-put ov 'invisible t)
1340       (org-overlay-put ov 'end-glyph (make-glyph tx)))
1341     (push ov org-clock-overlays)))
1342
1343 (defun org-clock-remove-overlays (&optional beg end noremove)
1344   "Remove the occur highlights from the buffer.
1345 BEG and END are ignored.  If NOREMOVE is nil, remove this function
1346 from the `before-change-functions' in the current buffer."
1347   (interactive)
1348   (unless org-inhibit-highlight-removal
1349     (mapc 'org-delete-overlay org-clock-overlays)
1350     (setq org-clock-overlays nil)
1351     (unless noremove
1352       (remove-hook 'before-change-functions
1353                    'org-clock-remove-overlays 'local))))
1354
1355 (defvar state) ;; dynamically scoped into this function
1356 (defun org-clock-out-if-current ()
1357   "Clock out if the current entry contains the running clock.
1358 This is used to stop the clock after a TODO entry is marked DONE,
1359 and is only done if the variable `org-clock-out-when-done' is not nil."
1360   (when (and org-clock-out-when-done
1361              (member state org-done-keywords)
1362              (equal (or (buffer-base-buffer (marker-buffer org-clock-marker))
1363                         (marker-buffer org-clock-marker))
1364                     (or (buffer-base-buffer (current-buffer))
1365                         (current-buffer)))
1366              (< (point) org-clock-marker)
1367              (> (save-excursion (outline-next-heading) (point))
1368                 org-clock-marker))
1369     ;; Clock out, but don't accept a logging message for this.
1370     (let ((org-log-note-clock-out nil))
1371       (org-clock-out))))
1372
1373 (add-hook 'org-after-todo-state-change-hook
1374           'org-clock-out-if-current)
1375
1376 ;;;###autoload
1377 (defun org-get-clocktable (&rest props)
1378   "Get a formatted clocktable with parameters according to PROPS.
1379 The table is created in a temporary buffer, fully formatted and
1380 fontified, and then returned."
1381   ;; Set the defaults
1382   (setq props (plist-put props :name "clocktable"))
1383   (unless (plist-member props :maxlevel)
1384     (setq props (plist-put props :maxlevel 2)))
1385   (unless (plist-member props :scope)
1386     (setq props (plist-put props :scope 'agenda)))
1387   (with-temp-buffer
1388     (org-mode)
1389     (org-create-dblock props)
1390     (org-update-dblock)
1391     (font-lock-fontify-buffer)
1392     (forward-line 2)
1393     (buffer-substring (point) (progn
1394                                 (re-search-forward "^#\\+END" nil t)
1395                                 (point-at-bol)))))
1396
1397 (defun org-clock-report (&optional arg)
1398   "Create a table containing a report about clocked time.
1399 If the cursor is inside an existing clocktable block, then the table
1400 will be updated.  If not, a new clocktable will be inserted.
1401 When called with a prefix argument, move to the first clock table in the
1402 buffer and update it."
1403   (interactive "P")
1404   (org-clock-remove-overlays)
1405   (when arg
1406     (org-find-dblock "clocktable")
1407     (org-show-entry))
1408   (if (org-in-clocktable-p)
1409       (goto-char (org-in-clocktable-p))
1410     (org-create-dblock (append (list :name "clocktable")
1411                                org-clock-clocktable-default-properties)))
1412   (org-update-dblock))
1413
1414 (defun org-in-clocktable-p ()
1415   "Check if the cursor is in a clocktable."
1416   (let ((pos (point)) start)
1417     (save-excursion
1418       (end-of-line 1)
1419       (and (re-search-backward "^#\\+BEGIN:[ \t]+clocktable" nil t)
1420            (setq start (match-beginning 0))
1421            (re-search-forward "^#\\+END:.*" nil t)
1422            (>= (match-end 0) pos)
1423            start))))
1424
1425 (defun org-clock-special-range (key &optional time as-strings)
1426   "Return two times bordering a special time range.
1427 Key is a symbol specifying the range and can be one of `today', `yesterday',
1428 `thisweek', `lastweek', `thismonth', `lastmonth', `thisyear', `lastyear'.
1429 A week starts Monday 0:00 and ends Sunday 24:00.
1430 The range is determined relative to TIME.  TIME defaults to the current time.
1431 The return value is a cons cell with two internal times like the ones
1432 returned by `current time' or `encode-time'. if AS-STRINGS is non-nil,
1433 the returned times will be formatted strings."
1434   (if (integerp key) (setq key (intern (number-to-string key))))
1435   (let* ((tm (decode-time (or time (current-time))))
1436          (s 0) (m (nth 1 tm)) (h (nth 2 tm))
1437          (d (nth 3 tm)) (month (nth 4 tm)) (y (nth 5 tm))
1438          (dow (nth 6 tm))
1439          (skey (symbol-name key))
1440          (shift 0)
1441          s1 m1 h1 d1 month1 y1 diff ts te fm txt w date)
1442     (cond
1443      ((string-match "^[0-9]+$" skey)
1444       (setq y (string-to-number skey) m 1 d 1 key 'year))
1445      ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)$" skey)
1446       (setq y (string-to-number (match-string 1 skey))
1447             month (string-to-number (match-string 2 skey))
1448             d 1 key 'month))
1449      ((string-match "^\\([0-9]+\\)-[wW]\\([0-9]\\{1,2\\}\\)$" skey)
1450       (require 'cal-iso)
1451       (setq y (string-to-number (match-string 1 skey))
1452             w (string-to-number (match-string 2 skey)))
1453       (setq date (calendar-gregorian-from-absolute
1454                   (calendar-absolute-from-iso (list w 1 y))))
1455       (setq d (nth 1 date) month (car date) y (nth 2 date)
1456             dow 1
1457             key 'week))
1458      ((string-match "^\\([0-9]+\\)-\\([0-9]\\{1,2\\}\\)-\\([0-9]\\{1,2\\}\\)$" skey)
1459       (setq y (string-to-number (match-string 1 skey))
1460             month (string-to-number (match-string 2 skey))
1461             d (string-to-number (match-string 3 skey))
1462             key 'day))
1463      ((string-match "\\([-+][0-9]+\\)$" skey)
1464       (setq shift (string-to-number (match-string 1 skey))
1465             key (intern (substring skey 0 (match-beginning 1))))))
1466     (when (= shift 0)
1467       (cond ((eq key 'yesterday) (setq key 'today shift -1))
1468             ((eq key 'lastweek)  (setq key 'week  shift -1))
1469             ((eq key 'lastmonth) (setq key 'month shift -1))
1470             ((eq key 'lastyear)  (setq key 'year  shift -1))))
1471     (cond
1472      ((memq key '(day today))
1473       (setq d (+ d shift) h 0 m 0 h1 24 m1 0))
1474      ((memq key '(week thisweek))
1475       (setq diff (+ (* -7 shift) (if (= dow 0) 6 (1- dow)))
1476             m 0 h 0 d (- d diff) d1 (+ 7 d)))
1477      ((memq key '(month thismonth))
1478       (setq d 1 h 0 m 0 d1 1 month (+ month shift) month1 (1+ month) h1 0 m1 0))
1479      ((memq key '(year thisyear))
1480       (setq m 0 h 0 d 1 month 1 y (+ y shift) y1 (1+ y)))
1481      (t (error "No such time block %s" key)))
1482     (setq ts (encode-time s m h d month y)
1483           te (encode-time (or s1 s) (or m1 m) (or h1 h)
1484                           (or d1 d) (or month1 month) (or y1 y)))
1485     (setq fm (cdr org-time-stamp-formats))
1486     (cond
1487      ((memq key '(day today))
1488       (setq txt (format-time-string "%A, %B %d, %Y" ts)))
1489      ((memq key '(week thisweek))
1490       (setq txt (format-time-string "week %G-W%V" ts)))
1491      ((memq key '(month thismonth))
1492       (setq txt (format-time-string "%B %Y" ts)))
1493      ((memq key '(year thisyear))
1494       (setq txt (format-time-string "the year %Y" ts))))
1495     (if as-strings
1496         (list (format-time-string fm ts) (format-time-string fm te) txt)
1497       (list ts te txt))))
1498
1499 (defun org-clocktable-shift (dir n)
1500   "Try to shift the :block date of the clocktable at point.
1501 Point must be in the #+BEGIN: line of a clocktable, or this function
1502 will throw an error.
1503 DIR is a direction, a symbol `left', `right', `up', or `down'.
1504 Both `left' and `down' shift the block toward the past, `up' and `right'
1505 push it toward the future.
1506 N is the number of shift steps to take.  The size of the step depends on
1507 the currently selected interval size."
1508   (setq n (prefix-numeric-value n))
1509   (and (memq dir '(left down)) (setq n (- n)))
1510   (save-excursion
1511     (goto-char (point-at-bol))
1512     (if (not (looking-at "#\\+BEGIN: clocktable\\>.*?:block[ \t]+\\(\\S-+\\)"))
1513         (error "Line needs a :block definition before this command works")
1514       (let* ((b (match-beginning 1)) (e (match-end 1))
1515              (s (match-string 1))
1516              block shift ins y mw d date wp m)
1517         (cond
1518          ((equal s "yesterday") (setq s "today-1"))
1519          ((equal s "lastweek") (setq s "thisweek-1"))
1520          ((equal s "lastmonth") (setq s "thismonth-1"))
1521          ((equal s "lastyear") (setq s "thisyear-1")))
1522         (cond
1523          ((string-match "^\\(today\\|thisweek\\|thismonth\\|thisyear\\)\\([-+][0-9]+\\)?$" s)
1524           (setq block (match-string 1 s)
1525                 shift (if (match-end 2)
1526                           (string-to-number (match-string 2 s))
1527                         0))
1528           (setq shift (+ shift n))
1529           (setq ins (if (= shift 0) block (format "%s%+d" block shift))))
1530          ((string-match "\\([0-9]+\\)\\(-\\([wW]?\\)\\([0-9]\\{1,2\\}\\)\\(-\\([0-9]\\{1,2\\}\\)\\)?\\)?" s)
1531           ;;               1        1  2   3       3  4                4  5   6                6  5   2
1532           (setq y (string-to-number (match-string 1 s))
1533                 wp (and (match-end 3) (match-string 3 s))
1534                 mw (and (match-end 4) (string-to-number (match-string 4 s)))
1535                 d (and (match-end 6) (string-to-number (match-string 6 s))))
1536           (cond
1537            (d (setq ins (format-time-string
1538                          "%Y-%m-%d"
1539                          (encode-time 0 0 0 (+ d n) m y))))
1540            ((and wp mw (> (length wp) 0))
1541             (require 'cal-iso)
1542             (setq date (calendar-gregorian-from-absolute (calendar-absolute-from-iso (list (+ mw n) 1 y))))
1543             (setq ins (format-time-string
1544                        "%G-W%V"
1545                        (encode-time 0 0 0 (nth 1 date) (car date) (nth 2 date)))))
1546            (mw
1547             (setq ins (format-time-string
1548                        "%Y-%m"
1549                        (encode-time 0 0 0 1 (+ mw n) y))))
1550            (y
1551             (setq ins (number-to-string (+ y n))))))
1552          (t (error "Cannot shift clocktable block")))
1553         (when ins
1554           (goto-char b)
1555           (insert ins)
1556           (delete-region (point) (+ (point) (- e b)))
1557           (beginning-of-line 1)
1558           (org-update-dblock)
1559           t)))))
1560
1561 (defun org-dblock-write:clocktable (params)
1562   "Write the standard clocktable."
1563   (catch 'exit
1564     (let* ((hlchars '((1 . "*") (2 . "/")))
1565            (ins (make-marker))
1566            (total-time nil)
1567            (scope (plist-get params :scope))
1568            (tostring (plist-get  params :tostring))
1569            (multifile (plist-get  params :multifile))
1570            (header (plist-get  params :header))
1571            (maxlevel (or (plist-get params :maxlevel) 3))
1572            (step (plist-get params :step))
1573            (emph (plist-get params :emphasize))
1574            (timestamp (plist-get params :timestamp))
1575            (ts (plist-get params :tstart))
1576            (te (plist-get params :tend))
1577            (block (plist-get params :block))
1578            (link (plist-get params :link))
1579            ipos time p level hlc hdl tsp props content recalc formula pcol
1580            cc beg end pos tbl tbl1 range-text rm-file-column scope-is-list st)
1581       (setq org-clock-file-total-minutes nil)
1582       (when step
1583         (unless (or block (and ts te))
1584           (error "Clocktable `:step' can only be used with `:block' or `:tstart,:end'"))
1585         (org-clocktable-steps params)
1586         (throw 'exit nil))
1587       (when block
1588         (setq cc (org-clock-special-range block nil t)
1589               ts (car cc) te (nth 1 cc) range-text (nth 2 cc)))
1590       (when (integerp ts) (setq ts (calendar-gregorian-from-absolute ts)))
1591       (when (integerp te) (setq te (calendar-gregorian-from-absolute te)))
1592       (when (and ts (listp ts))
1593         (setq ts (format "%4d-%02d-%02d" (nth 2 ts) (car ts) (nth 1 ts))))
1594       (when (and te (listp te))
1595         (setq te (format "%4d-%02d-%02d" (nth 2 te) (car te) (nth 1 te))))
1596       ;; Now the times are strings we can parse.
1597       (if ts (setq ts (org-float-time
1598                        (apply 'encode-time (org-parse-time-string ts)))))
1599       (if te (setq te (org-float-time
1600                        (apply 'encode-time (org-parse-time-string te)))))
1601       (move-marker ins (point))
1602       (setq ipos (point))
1603
1604       ;; Get the right scope
1605       (setq pos (point))
1606       (cond
1607        ((and scope (listp scope) (symbolp (car scope)))
1608         (setq scope (eval scope)))
1609        ((eq scope 'agenda)
1610         (setq scope (org-agenda-files t)))
1611        ((eq scope 'agenda-with-archives)
1612         (setq scope (org-agenda-files t))
1613         (setq scope (org-add-archive-files scope)))
1614        ((eq scope 'file-with-archives)
1615         (setq scope (org-add-archive-files (list (buffer-file-name)))
1616               rm-file-column t)))
1617       (setq scope-is-list (and scope (listp scope)))
1618       (save-restriction
1619         (cond
1620          ((not scope))
1621          ((eq scope 'file) (widen))
1622          ((eq scope 'subtree) (org-narrow-to-subtree))
1623          ((eq scope 'tree)
1624           (while (org-up-heading-safe))
1625           (org-narrow-to-subtree))
1626          ((and (symbolp scope) (string-match "^tree\\([0-9]+\\)$"
1627                                              (symbol-name scope)))
1628           (setq level (string-to-number (match-string 1 (symbol-name scope))))
1629           (catch 'exit
1630             (while (org-up-heading-safe)
1631               (looking-at outline-regexp)
1632               (if (<= (org-reduced-level (funcall outline-level)) level)
1633                   (throw 'exit nil))))
1634           (org-narrow-to-subtree))
1635          (scope-is-list
1636           (let* ((files scope)
1637                  (scope 'agenda)
1638                  (p1 (copy-sequence params))
1639                  file)
1640             (setq p1 (plist-put p1 :tostring t))
1641             (setq p1 (plist-put p1 :multifile t))
1642             (setq p1 (plist-put p1 :scope 'file))
1643             (org-prepare-agenda-buffers files)
1644             (while (setq file (pop files))
1645               (with-current-buffer (find-buffer-visiting file)
1646                 (setq tbl1 (org-dblock-write:clocktable p1))
1647                 (when tbl1
1648                   (push (org-clocktable-add-file
1649                          file
1650                          (concat "| |*File time*|*"
1651                                  (org-minutes-to-hh:mm-string
1652                                   org-clock-file-total-minutes)
1653                                  "*|\n"
1654                                  tbl1)) tbl)
1655                   (setq total-time (+ (or total-time 0)
1656                                       org-clock-file-total-minutes))))))))
1657         (goto-char pos)
1658
1659         (unless scope-is-list
1660           (org-clock-sum ts te)
1661           (goto-char (point-min))
1662           (setq st t)
1663           (while (or (and (bobp) (prog1 st (setq st nil))
1664                           (get-text-property (point) :org-clock-minutes)
1665                           (setq p (point-min)))
1666                      (setq p (next-single-property-change (point) :org-clock-minutes)))
1667             (goto-char p)
1668             (when (setq time (get-text-property p :org-clock-minutes))
1669               (save-excursion
1670                 (beginning-of-line 1)
1671                 (when (and (looking-at (org-re "\\(\\*+\\)[ \t]+\\(.*?\\)\\([ \t]+:[[:alnum:]_@:]+:\\)?[ \t]*$"))
1672                            (setq level (org-reduced-level
1673                                         (- (match-end 1) (match-beginning 1))))
1674                            (<= level maxlevel))
1675                   (setq hlc (if emph (or (cdr (assoc level hlchars)) "") "")
1676                         hdl (if (not link)
1677                                 (match-string 2)
1678                               (org-make-link-string
1679                                (format "file:%s::%s"
1680                                        (buffer-file-name)
1681                                        (save-match-data
1682                                          (org-make-org-heading-search-string
1683                                           (match-string 2))))
1684                                (match-string 2)))
1685                         tsp (when timestamp
1686                               (setq props (org-entry-properties (point)))
1687                               (or (cdr (assoc "SCHEDULED" props))
1688                                   (cdr (assoc "TIMESTAMP" props))
1689                                   (cdr (assoc "DEADLINE" props))
1690                                   (cdr (assoc "TIMESTAMP_IA" props)))))
1691                   (if (and (not multifile) (= level 1)) (push "|-" tbl))
1692                   (push (concat
1693                          "| " (int-to-string level) "|"
1694                          (if timestamp (concat tsp "|") "")
1695                          hlc hdl hlc " |"
1696                          (make-string (1- level) ?|)
1697                          hlc (org-minutes-to-hh:mm-string time) hlc
1698                          " |") tbl))))))
1699         (setq tbl (nreverse tbl))
1700         (if tostring
1701             (if tbl (mapconcat 'identity tbl "\n") nil)
1702           (goto-char ins)
1703           (insert-before-markers
1704            (or header
1705                (concat
1706                 "Clock summary at ["
1707                 (substring
1708                  (format-time-string (cdr org-time-stamp-formats))
1709                  1 -1)
1710                 "]"
1711                 (if block (concat ", for " range-text ".") "")
1712                 "\n\n"))
1713            (if scope-is-list "|File" "")
1714            "|L|" (if timestamp "Timestamp|" "") "Headline|Time|\n")
1715           (setq total-time (or total-time org-clock-file-total-minutes))
1716           (insert-before-markers
1717            "|-\n|"
1718            (if scope-is-list "|" "")
1719            (if timestamp "|Timestamp|" "|")
1720            "*Total time*| *"
1721            (org-minutes-to-hh:mm-string (or total-time 0))
1722            "*|\n|-\n")
1723           (setq tbl (delq nil tbl))
1724           (if (and (stringp (car tbl)) (> (length (car tbl)) 1)
1725                    (equal (substring (car tbl) 0 2) "|-"))
1726               (pop tbl))
1727           (insert-before-markers (mapconcat
1728                                   'identity (delq nil tbl)
1729                                   (if scope-is-list "\n|-\n" "\n")))
1730           (backward-delete-char 1)
1731           (if (setq formula (plist-get params :formula))
1732               (cond
1733                ((eq formula '%)
1734                 (setq pcol (+ (if scope-is-list 1 0) maxlevel 3))
1735                 (insert
1736                  (format
1737                   "\n#+TBLFM: $%d='(org-clock-time%% @%d$%d $%d..$%d);%%.1f"
1738                   pcol
1739                   2
1740                   (+ 3 (if scope-is-list 1 0))
1741                   (+ (if scope-is-list 1 0) 3)
1742                   (1- pcol)))
1743                 (setq recalc t))
1744                ((stringp formula)
1745                 (insert "\n#+TBLFM: " formula)
1746                 (setq recalc t))
1747                (t (error "invalid formula in clocktable")))
1748             ;; Should we rescue an old formula?
1749             (when (stringp (setq content (plist-get params :content)))
1750               (when (string-match "^\\([ \t]*#\\+TBLFM:.*\\)" content)
1751                 (setq recalc t)
1752                 (insert "\n" (match-string 1 (plist-get params :content)))
1753                 (beginning-of-line 0))))
1754           (goto-char ipos)
1755           (skip-chars-forward "^|")
1756           (org-table-align)
1757           (when recalc
1758             (if (eq formula '%)
1759                 (save-excursion (org-table-goto-column pcol nil 'force)
1760                                 (insert "%")))
1761             (org-table-recalculate 'all))
1762           (when rm-file-column
1763             (forward-char 1)
1764             (org-table-delete-column)))))))
1765
1766 (defun org-clocktable-steps (params)
1767   (let* ((p1 (copy-sequence params))
1768          (ts (plist-get p1 :tstart))
1769          (te (plist-get p1 :tend))
1770          (step0 (plist-get p1 :step))
1771          (step (cdr (assoc step0 '((day . 86400) (week . 604800)))))
1772          (block (plist-get p1 :block))
1773          cc range-text)
1774     (when block
1775       (setq cc (org-clock-special-range block nil t)
1776             ts (car cc) te (nth 1 cc) range-text (nth 2 cc)))
1777     (if ts (setq ts (org-float-time
1778                      (apply 'encode-time (org-parse-time-string ts)))))
1779     (if te (setq te (org-float-time
1780                      (apply 'encode-time (org-parse-time-string te)))))
1781     (setq p1 (plist-put p1 :header ""))
1782     (setq p1 (plist-put p1 :step nil))
1783     (setq p1 (plist-put p1 :block nil))
1784     (while (< ts te)
1785       (or (bolp) (insert "\n"))
1786       (setq p1 (plist-put p1 :tstart (format-time-string
1787                                       (org-time-stamp-format nil t)
1788                                       (seconds-to-time ts))))
1789       (setq p1 (plist-put p1 :tend (format-time-string
1790                                     (org-time-stamp-format nil t)
1791                                     (seconds-to-time (setq ts (+ ts step))))))
1792       (insert "\n" (if (eq step0 'day) "Daily report: " "Weekly report starting on: ")
1793               (plist-get p1 :tstart) "\n")
1794       (org-dblock-write:clocktable p1)
1795       (re-search-forward "#\\+END:")
1796       (end-of-line 0))))
1797
1798 (defun org-clocktable-add-file (file table)
1799   (if table
1800       (let ((lines (org-split-string table "\n"))
1801             (ff (file-name-nondirectory file)))
1802         (mapconcat 'identity
1803                    (mapcar (lambda (x)
1804                              (if (string-match org-table-dataline-regexp x)
1805                                  (concat "|" ff x)
1806                                x))
1807                            lines)
1808                    "\n"))))
1809
1810 (defun org-clock-time% (total &rest strings)
1811   "Compute a time fraction in percent.
1812 TOTAL s a time string like 10:21 specifying the total times.
1813 STRINGS is a list of strings that should be checked for a time.
1814 The first string that does have a time will be used.
1815 This function is made for clock tables."
1816   (let ((re "\\([0-9]+\\):\\([0-9]+\\)")
1817         tot s)
1818     (save-match-data
1819       (catch 'exit
1820         (if (not (string-match re total))
1821             (throw 'exit 0.)
1822           (setq tot (+ (string-to-number (match-string 2 total))
1823                        (* 60 (string-to-number (match-string 1 total)))))
1824           (if (= tot 0.) (throw 'exit 0.)))
1825         (while (setq s (pop strings))
1826           (if (string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
1827               (throw 'exit
1828                      (/ (* 100.0 (+ (string-to-number (match-string 2 s))
1829                                     (* 60 (string-to-number (match-string 1 s)))))
1830                         tot))))
1831         0))))
1832
1833 (defvar org-clock-loaded nil
1834   "Was the clock file loaded?")
1835
1836 (defun org-clock-save ()
1837   "Persist various clock-related data to disk.
1838 The details of what will be saved are regulated by the variable
1839 `org-clock-persist'."
1840   (when (and org-clock-persist
1841              (or org-clock-loaded
1842                  org-clock-has-been-used
1843                  (not (file-exists-p org-clock-persist-file))))
1844     (let (b)
1845       (with-current-buffer (find-file (expand-file-name org-clock-persist-file))
1846         (progn
1847           (delete-region (point-min) (point-max))
1848           ;;Store clock
1849           (insert (format ";; org-persist.el - %s at %s\n"
1850                           system-name (format-time-string
1851                                        (cdr org-time-stamp-formats))))
1852           (if (and (memq org-clock-persist '(t clock))
1853                    (setq b (marker-buffer org-clock-marker))
1854                    (setq b (or (buffer-base-buffer b) b))
1855                    (buffer-live-p b)
1856                    (buffer-file-name b)
1857                    (or (not org-clock-persist-query-save)
1858                        (y-or-n-p (concat "Save current clock ("
1859                                          (substring-no-properties org-clock-heading)
1860                                          ") "))))
1861               (insert "(setq resume-clock '(\""
1862                       (buffer-file-name (marker-buffer org-clock-marker))
1863                       "\" . " (int-to-string (marker-position org-clock-marker))
1864                       "))\n"))
1865           ;; Store clocked task history. Tasks are stored reversed to make
1866           ;; reading simpler
1867           (when (and (memq org-clock-persist '(t history))
1868                      org-clock-history)
1869             (insert
1870              "(setq stored-clock-history '("
1871              (mapconcat
1872               (lambda (m)
1873                 (when (and (setq b (marker-buffer m))
1874                            (setq b (or (buffer-base-buffer b) b))
1875                            (buffer-live-p b)
1876                            (buffer-file-name b))
1877                   (concat "(\"" (buffer-file-name b)
1878                           "\" . " (int-to-string (marker-position m))
1879                           ")")))
1880               (reverse org-clock-history) " ") "))\n"))
1881           (save-buffer)
1882           (kill-buffer (current-buffer)))))))
1883
1884 (defun org-clock-load ()
1885   "Load clock-related data from disk, maybe resuming a stored clock."
1886   (when (and org-clock-persist (not org-clock-loaded))
1887     (let ((filename (expand-file-name org-clock-persist-file))
1888           (org-clock-in-resume 'auto-restart)
1889           resume-clock stored-clock-history)
1890       (if (not (file-readable-p filename))
1891           (message "Not restoring clock data; %s not found"
1892                    org-clock-persist-file)
1893         (message "%s" "Restoring clock data")
1894         (setq org-clock-loaded t)
1895         (load-file filename)
1896         ;; load history
1897         (when stored-clock-history
1898           (save-window-excursion
1899             (mapc (lambda (task)
1900                     (if (file-exists-p (car task))
1901                         (org-clock-history-push (cdr task)
1902                                                 (find-file (car task)))))
1903                   stored-clock-history)))
1904         ;; resume clock
1905         (when (and resume-clock org-clock-persist
1906                    (file-exists-p (car resume-clock))
1907                    (or (not org-clock-persist-query-resume)
1908                        (y-or-n-p
1909                         (concat
1910                          "Resume clock ("
1911                          (with-current-buffer (find-file (car resume-clock))
1912                            (save-excursion
1913                              (goto-char (cdr resume-clock))
1914                              (org-back-to-heading t)
1915                              (and (looking-at org-complex-heading-regexp)
1916                                   (match-string 4))))
1917                          ") "))))
1918           (when (file-exists-p (car resume-clock))
1919             (with-current-buffer (find-file (car resume-clock))
1920               (goto-char (cdr resume-clock))
1921               (let ((org-clock-auto-clock-resolution nil))
1922                 (org-clock-in)
1923                 (if (org-invisible-p)
1924                     (org-show-context))))))))))
1925
1926 ;;;###autoload
1927 (defun org-clock-persistence-insinuate ()
1928   "Set up hooks for clock persistence"
1929   (add-hook 'org-mode-hook 'org-clock-load)
1930   (add-hook 'kill-emacs-hook 'org-clock-save))
1931
1932 ;; Suggested bindings
1933 (org-defkey org-mode-map "\C-c\C-x\C-e" 'org-clock-modify-effort-estimate)
1934
1935 (provide 'org-clock)
1936
1937 ;; arch-tag: 7b42c5d4-9b36-48be-97c0-66a869daed4c
1938
1939 ;;; org-clock.el ends here