Mercurial > emacs
view lisp/org/org-timer.el @ 106508:8c836ea59444
* net/tramp.el (tramp-handle-insert-directory): Suppress error messages.
author | Michael Albinus <michael.albinus@gmx.de> |
---|---|
date | Wed, 09 Dec 2009 10:23:00 +0000 |
parents | 83924fb4f59c |
children | 1d1d5d9bd884 |
line wrap: on
line source
;;; org-timer.el --- The relative timer code for Org-mode ;; Copyright (C) 2008, 2009 Free Software Foundation, Inc. ;; Author: Carsten Dominik <carsten at orgmode dot org> ;; Keywords: outlines, hypermedia, calendar, wp ;; Homepage: http://orgmode.org ;; Version: 6.33x ;; ;; This file is part of GNU Emacs. ;; ;; GNU Emacs is free software: you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation, either version 3 of the License, or ;; (at your option) any later version. ;; GNU Emacs is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; ;;; Commentary: ;; This file contains the relative timer code for Org-mode (require 'org) (declare-function org-show-notification "org-clock" (parameters)) (declare-function org-agenda-error "org-agenda" ()) (defvar org-timer-start-time nil "t=0 for the running timer.") (defvar org-timer-pause-time nil "Time when the timer was paused.") (defconst org-timer-re "\\([-+]?[0-9]+\\):\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)" "Regular expression used to match timer stamps.") (defcustom org-timer-format "%s " "The format to insert the time of the timer. This format must contain one instance of \"%s\" which will be replaced by the value of the relative timer." :group 'org-time :type 'string) ;;;###autoload (defun org-timer-start (&optional offset) "Set the starting time for the relative timer to now. When called with prefix argument OFFSET, prompt the user for an offset time, with the default taken from a timer stamp at point, if any. If OFFSET is a string or an integer, it is directly taken to be the offset without user interaction. When called with a double prefix arg, all timer strings in the active region will be shifted by a specific amount. You will be prompted for the amount, with the default to make the first timer string in the region 0:00:00." (interactive "P") (if (equal offset '(16)) (call-interactively 'org-timer-change-times-in-region) (let (delta def s) (if (not offset) (setq org-timer-start-time (current-time)) (cond ((integerp offset) (setq delta offset)) ((stringp offset) (setq delta (org-timer-hms-to-secs offset))) (t (setq def (if (org-in-regexp org-timer-re) (match-string 0) "0:00:00") s (read-string (format "Restart timer with offset [%s]: " def))) (unless (string-match "\\S-" s) (setq s def)) (setq delta (org-timer-hms-to-secs (org-timer-fix-incomplete s))))) (setq org-timer-start-time (seconds-to-time (- (org-float-time) (org-timer-hms-to-secs s))))) (org-timer-set-mode-line 'on) (message "Timer start time set to %s, current value is %s" (format-time-string "%T" org-timer-start-time) (org-timer-secs-to-hms (or delta 0)))))) (defun org-timer-pause-or-continue (&optional stop) "Pause or continue the relative timer. With prefix arg, stop it entirely." (interactive "P") (cond (stop (org-timer-stop)) ((not org-timer-start-time) (error "No timer is running")) (org-timer-pause-time ;; timer is paused, continue (setq org-timer-start-time (seconds-to-time (- (org-float-time) (- (org-float-time org-timer-pause-time) (org-float-time org-timer-start-time)))) org-timer-pause-time nil) (org-timer-set-mode-line 'on) (message "Timer continues at %s" (org-timer-value-string))) (t ;; pause timer (setq org-timer-pause-time (current-time)) (org-timer-set-mode-line 'pause) (message "Timer paused at %s" (org-timer-value-string))))) (defun org-timer-stop () "Stop the relative timer." (interactive) (setq org-timer-start-time nil org-timer-pause-time nil) (org-timer-set-mode-line 'off)) ;;;###autoload (defun org-timer (&optional restart) "Insert a H:MM:SS string from the timer into the buffer. The first time this command is used, the timer is started. When used with a `C-u' prefix, force restarting the timer. When used with a double prefix arg `C-u C-u', change all the timer string in the region by a fixed amount. This can be used to recalibrate a timer that was not started at the correct moment." (interactive "P") (if (equal restart '(4)) (org-timer-start)) (or org-timer-start-time (org-timer-start)) (insert (org-timer-value-string))) (defun org-timer-value-string () (format org-timer-format (org-timer-secs-to-hms (floor (org-timer-seconds))))) (defun org-timer-seconds () (- (org-float-time (or org-timer-pause-time (current-time))) (org-float-time org-timer-start-time))) ;;;###autoload (defun org-timer-change-times-in-region (beg end delta) "Change all h:mm:ss time in region by a DELTA." (interactive "r\nsEnter time difference like \"-1:08:26\". Default is first time to zero: ") (let ((re "[-+]?[0-9]+:[0-9]\\{2\\}:[0-9]\\{2\\}") p) (unless (string-match "\\S-" delta) (save-excursion (goto-char beg) (when (re-search-forward re end t) (setq delta (match-string 0)) (if (equal (string-to-char delta) ?-) (setq delta (substring delta 1)) (setq delta (concat "-" delta)))))) (setq delta (org-timer-hms-to-secs (org-timer-fix-incomplete delta))) (when (= delta 0) (error "No change")) (save-excursion (goto-char end) (while (re-search-backward re beg t) (setq p (point)) (replace-match (save-match-data (org-timer-secs-to-hms (+ (org-timer-hms-to-secs (match-string 0)) delta))) t t) (goto-char p))))) ;;;###autoload (defun org-timer-item (&optional arg) "Insert a description-type item with the current timer value." (interactive "P") (let ((ind 0)) (save-excursion (skip-chars-backward " \n\t") (condition-case nil (progn (org-beginning-of-item) (setq ind (org-get-indentation))) (error nil))) (or (bolp) (newline)) (org-indent-line-to ind) (insert "- ") (org-timer (if arg '(4))) (insert ":: "))) (defun org-timer-fix-incomplete (hms) "If hms is a H:MM:SS string with missing hour or hour and minute, fix it." (if (string-match "\\(?:\\([0-9]+:\\)?\\([0-9]+:\\)\\)?\\([0-9]+\\)" hms) (replace-match (format "%d:%02d:%02d" (if (match-end 1) (string-to-number (match-string 1 hms)) 0) (if (match-end 2) (string-to-number (match-string 2 hms)) 0) (string-to-number (match-string 3 hms))) t t hms) (error "Cannot parse HMS string \"%s\"" hms))) (defun org-timer-hms-to-secs (hms) "Convert h:mm:ss string to an integer time. If the string starts with a minus sign, the integer will be negative." (if (not (string-match "\\([-+]?[0-9]+\\):\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)" hms)) 0 (let* ((h (string-to-number (match-string 1 hms))) (m (string-to-number (match-string 2 hms))) (s (string-to-number (match-string 3 hms))) (sign (equal (substring (match-string 1 hms) 0 1) "-"))) (setq h (abs h)) (* (if sign -1 1) (+ s (* 60 (+ m (* 60 h)))))))) (defun org-timer-secs-to-hms (s) "Convert integer S into h:mm:ss. If the integer is negative, the string will start with \"-\"." (let (sign m h) (setq sign (if (< s 0) "-" "") s (abs s) m (/ s 60) s (- s (* 60 m)) h (/ m 60) m (- m (* 60 h))) (format "%s%d:%02d:%02d" sign h m s))) (defvar org-timer-mode-line-timer nil) (defvar org-timer-mode-line-string nil) (defun org-timer-set-mode-line (value) "Set the mode-line display of the relative timer. VALUE can be `on', `off', or `pause'." (or global-mode-string (setq global-mode-string '(""))) (or (memq 'org-timer-mode-line-string global-mode-string) (setq global-mode-string (append global-mode-string '(org-timer-mode-line-string)))) (cond ((equal value 'off) (when org-timer-mode-line-timer (cancel-timer org-timer-mode-line-timer) (setq org-timer-mode-line-timer nil)) (setq global-mode-string (delq 'org-timer-mode-line-string global-mode-string)) (force-mode-line-update)) ((equal value 'pause) (when org-timer-mode-line-timer (cancel-timer org-timer-mode-line-timer) (setq org-timer-mode-line-timer nil))) ((equal value 'on) (or global-mode-string (setq global-mode-string '(""))) (or (memq 'org-timer-mode-line-string global-mode-string) (setq global-mode-string (append global-mode-string '(org-timer-mode-line-string)))) (org-timer-update-mode-line) (when org-timer-mode-line-timer (cancel-timer org-timer-mode-line-timer)) (setq org-timer-mode-line-timer (run-with-timer 1 1 'org-timer-update-mode-line))))) (defun org-timer-update-mode-line () "Update the timer time in the mode line." (if org-timer-pause-time nil (setq org-timer-mode-line-string (concat " <" (substring (org-timer-value-string) 0 -1) ">")) (force-mode-line-update))) (defvar org-timer-timer1 nil) (defvar org-timer-timer2 nil) (defvar org-timer-timer3 nil) (defvar org-timer-last-timer nil) (defun org-timer-cancel-timers () "Reset all timers." (interactive) (mapc (lambda(timer) (when (eval timer) (cancel-timer timer) (setq timer nil))) '(org-timer-timer1 org-timer-timer2 org-timer-timer3)) (message "All timers reset")) (defun org-timer-show-remaining-time () "Display the remaining time before the timer ends." (interactive) (require 'time) (if (and (not org-timer-timer1) (not org-timer-timer2) (not org-timer-timer3)) (message "No timer set") (let* ((rtime (decode-time (time-subtract (timer--time org-timer-last-timer) (current-time)))) (rsecs (nth 0 rtime)) (rmins (nth 1 rtime))) (message "%d minutes %d seconds left before next time out" rmins rsecs)))) ;;;###autoload (defun org-timer-set-timer (minutes) "Set a timer." (interactive "sTime out in (min)? ") (if (not (string-match "[0-9]+" minutes)) (org-timer-show-remaining-time) (let* ((mins (string-to-number (match-string 0 minutes))) (secs (* mins 60)) (hl (cond ((string-match "Org Agenda" (buffer-name)) (let* ((marker (or (get-text-property (point) 'org-marker) (org-agenda-error))) (hdmarker (or (get-text-property (point) 'org-hd-marker) marker)) (pos (marker-position marker))) (with-current-buffer (marker-buffer marker) (widen) (goto-char pos) (org-show-entry) (org-get-heading)))) ((eq major-mode 'org-mode) (org-get-heading)) (t (error "Not in an Org buffer")))) timer-set) (mapcar (lambda(timer) (when (not (or (eval timer) timer-set)) (setq timer-set t) (setq org-timer-last-timer (run-with-timer secs nil 'org-notify (format "%s: time out" hl) t)) (set timer org-timer-last-timer))) '(org-timer-timer1 org-timer-timer2 org-timer-timer3))))) (provide 'org-timer) ;; arch-tag: 97538f8c-3871-4509-8f23-1e7b3ff3d107 ;;; org-timer.el ends here