Mercurial > emacs
annotate lisp/calendar/timeclock.el @ 34636:d5f4808ddf54
*** empty log message ***
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Sat, 16 Dec 2000 17:46:59 +0000 |
parents | e21feeab77fb |
children | 9dc1ae87ded3 |
rev | line source |
---|---|
30781 | 1 ;;; timeclock.el --- mode for keeping track of how much you work |
2 | |
3 ;; Copyright (C) 1999, 2000 Free Software Foundation, Inc. | |
4 | |
5 ;; Author: John Wiegley <johnw@gnu.org> | |
6 ;; Created: 25 Mar 1999 | |
33020 | 7 ;; Version: 2.3 |
30781 | 8 ;; Keywords: calendar data |
9 | |
10 ;; This file is part of GNU Emacs. | |
11 | |
12 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
13 ;; it under the terms of the GNU General Public License as published by | |
14 ;; the Free Software Foundation; either version 2, or (at your option) | |
15 ;; any later version. | |
16 | |
17 ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 ;; GNU General Public License for more details. | |
21 | |
22 ;; You should have received a copy of the GNU General Public License | |
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
25 ;; Boston, MA 02111-1307, USA. | |
26 | |
27 ;;; Commentary: | |
28 | |
29 ;; This mode is for keeping track of time intervals. You can use it | |
30 ;; for whatever purpose you like, but the typical scenario is to keep | |
31 ;; track of how much time you spend working on certain projects. | |
32 ;; | |
33 ;; Use `timeclock-in' when you start on a project, and `timeclock-out' | |
34 ;; when you're done. Once you've collected some data, you can use | |
35 ;; `timeclock-workday-remaining' to see how much time is left to be | |
36 ;; worked today (assuming a typical average of 8 hours a day), and | |
37 ;; `timeclock-when-to-leave' which will calculate when you're free. | |
38 | |
39 ;; You'll probably want to bind the timeclock commands to some handy | |
40 ;; keystrokes. At the moment, C-x t is unused in Emacs 20: | |
41 ;; | |
42 ;; (require 'timeclock) | |
43 ;; | |
44 ;; (define-key ctl-x-map "ti" 'timeclock-in) | |
45 ;; (define-key ctl-x-map "to" 'timeclock-out) | |
46 ;; (define-key ctl-x-map "tc" 'timeclock-change) | |
47 ;; (define-key ctl-x-map "tr" 'timeclock-reread-log) | |
48 ;; (define-key ctl-x-map "tu" 'timeclock-update-modeline) | |
49 ;; (define-key ctl-x-map "tw" 'timeclock-when-to-leave-string) | |
50 | |
51 ;; If you want Emacs to display the amount of time "left" to your | |
52 ;; workday in the modeline, you can either set the value of | |
53 ;; `timeclock-modeline-display' to t using M-x customize, or you | |
54 ;; can add this code to your .emacs file: | |
55 ;; | |
56 ;; (require 'timeclock) | |
57 ;; (timeclock-modeline-display) | |
58 ;; | |
59 ;; To cancel this modeline display at any time, just call | |
60 ;; `timeclock-modeline-display' again. | |
61 | |
62 ;; You may also want Emacs to ask you before exiting, if you are | |
63 ;; current working on a project. This can be done either by setting | |
64 ;; `timeclock-ask-before-exiting' to t using M-x customize (this is | |
65 ;; the default), or by adding the following to your .emacs file: | |
66 ;; | |
67 ;; (add-hook 'kill-emacs-hook 'timeclock-query-out) | |
68 | |
69 ;; NOTE: If you change your .timelog file without using timeclock's | |
70 ;; functions, or if you change the value of any of timeclock's | |
71 ;; customizable variables, you should run the command | |
72 ;; `timeclock-reread-log'. This will recompute any discrepancies in | |
73 ;; your average working time, and will make sure that the various | |
74 ;; display functions return the correct value. | |
75 | |
76 ;;; History: | |
77 | |
78 ;;; Code: | |
79 | |
80 (defgroup timeclock nil | |
81 "Keeping track time of the time that gets spent." | |
82 :group 'data) | |
83 | |
84 ;;; User Variables: | |
85 | |
30795
5b4027fef808
(timeclock-file): Run .timelog through convert-standard-filename.
Eli Zaretskii <eliz@gnu.org>
parents:
30781
diff
changeset
|
86 (defcustom timeclock-file (convert-standard-filename "~/.timelog") |
30781 | 87 "*The file used to store timeclock data in." |
88 :type 'file | |
89 :group 'timeclock) | |
90 | |
91 (defcustom timeclock-workday (* 8 60 60) | |
92 "*The length of a work period." | |
93 :type 'integer | |
94 :group 'timeclock) | |
95 | |
96 (defcustom timeclock-relative t | |
97 "*When reporting time, make it relative to `timeclock-workday'? | |
98 For example, if the length of a normal workday is eight hours, and you | |
99 work four hours on Monday, then the amount of time \"remaining\" on | |
100 Tuesday is twelve hours -- relative to an averaged work period of | |
101 eight hours -- or eight hours, non-relative. So relative time takes | |
102 into account any discrepancy of time under-worked or overworked on | |
103 previous days." | |
104 :type 'boolean | |
105 :group 'timeclock) | |
106 | |
107 (defcustom timeclock-get-project-function 'timeclock-ask-for-project | |
108 "*The function used to determine the name of the current project. | |
109 When clocking in, and no project is specified, this function will be | |
110 called to determine what the current project to be worked on is. | |
111 If this variable is nil, no questions will be asked." | |
112 :type 'function | |
113 :group 'timeclock) | |
114 | |
115 (defcustom timeclock-get-reason-function 'timeclock-ask-for-reason | |
116 "*A function used to determine the reason for clocking out. | |
117 When clocking out, and no reason is specified, this function will be | |
118 called to determine what the reason is. | |
119 If this variable is nil, no questions will be asked." | |
120 :type 'function | |
121 :group 'timeclock) | |
122 | |
123 (defcustom timeclock-get-workday-function nil | |
124 "*A function used to determine the length of today's workday. | |
125 The first time that a user clocks in each day, this function will be | |
126 called to determine what the length of the current workday is. If | |
127 nil, or equal to `timeclock-workday', nothing special will be done. | |
128 If it is a quantity different from `timeclock-workday', however, a | |
129 record will be output to the timelog file to note the fact that that | |
130 day has a different length from the norm." | |
131 :type 'function | |
132 :group 'timeclock) | |
133 | |
134 (defcustom timeclock-ask-before-exiting t | |
135 "*If non-nil, ask if the user wants to clock out before exiting Emacs." | |
136 :set (lambda (symbol value) | |
137 (if value | |
138 (add-hook 'kill-emacs-hook 'timeclock-query-out) | |
139 (remove-hook 'kill-emacs-hook 'timeclock-query-out)) | |
140 (setq timeclock-ask-before-exiting value)) | |
141 :type 'boolean | |
142 :group 'timeclock) | |
143 | |
144 (defvar timeclock-update-timer nil | |
145 "The timer used to update `timeclock-mode-string'.") | |
146 | |
147 (defcustom timeclock-use-display-time t | |
148 "*If non-nil, use `display-time-hook' for doing modeline updates. | |
149 The advantage to this is that it means one less timer has to be set | |
150 running amok in Emacs' process space. The disadvantage is that it | |
151 requires you to have `display-time' running. If you don't want to use | |
152 `display-time', but still want the modeline to show how much time is | |
153 left, set this variable to nil. You will need to restart Emacs (or | |
154 toggle the value of `timeclock-modeline-display') for the change to | |
155 take effect." | |
156 :set (lambda (symbol value) | |
157 (let ((currently-displaying | |
158 (and (boundp 'timeclock-modeline-display) | |
159 timeclock-modeline-display))) | |
160 ;; if we're changing to the state that | |
161 ;; `timeclock-modeline-display' is already using, don't | |
162 ;; bother toggling it. This happens on the initial loading | |
163 ;; of timeclock.el. | |
164 (if (and currently-displaying | |
165 (or (and value | |
166 (boundp 'display-time-hook) | |
167 (memq 'timeclock-update-modeline | |
168 display-time-hook)) | |
169 (and (not value) | |
170 timeclock-update-timer))) | |
171 (setq currently-displaying nil)) | |
172 (and currently-displaying | |
173 (set-variable timeclock-modeline-display nil)) | |
174 (setq timeclock-use-display-time value) | |
175 (and currently-displaying | |
176 (set-variable timeclock-modeline-display t)) | |
177 timeclock-use-display-time)) | |
178 :type 'boolean | |
179 :group 'timeclock | |
180 :require 'time) | |
181 | |
182 (defcustom timeclock-first-in-hook nil | |
183 "*A hook run for the first \"in\" event each day. | |
184 Note that this hook is run before recording any events. Thus the | |
185 value of `timeclock-hours-today', `timeclock-last-event' and the | |
186 return value of function `timeclock-last-period' are relative previous | |
187 to today." | |
188 :type 'hook | |
189 :group 'timeclock) | |
190 | |
191 (defcustom timeclock-load-hook nil | |
192 "*Hook that gets run after timeclock has been loaded." | |
193 :type 'hook | |
194 :group 'timeclock) | |
195 | |
196 (defcustom timeclock-in-hook nil | |
197 "*A hook run every time an \"in\" event is recorded." | |
198 :type 'hook | |
199 :group 'timeclock) | |
200 | |
201 (defcustom timeclock-day-over-hook nil | |
202 "*A hook that is run when the workday has been completed. | |
203 This hook is only run if the current time remaining is being display | |
204 in the modeline. See the variable `timeclock-modeline-display'." | |
205 :type 'hook | |
206 :group 'timeclock) | |
207 | |
208 (defcustom timeclock-out-hook nil | |
209 "*A hook run every time an \"out\" event is recorded." | |
210 :type 'hook | |
211 :group 'timeclock) | |
212 | |
213 (defcustom timeclock-done-hook nil | |
214 "*A hook run every time a project is marked as completed." | |
215 :type 'hook | |
216 :group 'timeclock) | |
217 | |
218 (defcustom timeclock-event-hook nil | |
219 "*A hook run every time any event is recorded." | |
220 :type 'hook | |
221 :group 'timeclock) | |
222 | |
223 (defvar timeclock-last-event nil | |
224 "A list containing the last event that was recorded. | |
33020 | 225 The format of this list is (CODE TIME PROJECT).") |
30781 | 226 |
227 (defvar timeclock-last-event-workday nil | |
228 "The number of seconds in the workday of `timeclock-last-event'.") | |
229 | |
230 ;;; Internal Variables: | |
231 | |
232 (defvar timeclock-discrepancy nil | |
233 "A variable containing the time discrepancy before the last event. | |
234 Normally, timeclock assumes that you intend to work for | |
235 `timeclock-workday' seconds every day. Any days in which you work | |
236 more or less than this amount is considered either a positive or | |
237 negative discrepancy. If you work in such a manner that the | |
238 discrepancy is always brought back to zero, then you will by | |
239 definition have worked an average amount equal to `timeclock-workday' | |
240 each day.") | |
241 | |
242 (defvar timeclock-elapsed nil | |
243 "A variable containing the time elapsed for complete periods today. | |
244 This value is not accurate enough to be useful by itself. Rather, | |
245 call `timeclock-workday-elapsed', to determine how much time has been | |
246 worked so far today. Also, if `timeclock-relative' is nil, this value | |
247 will be the same as `timeclock-discrepancy'.") | |
248 | |
249 (defvar timeclock-last-period nil | |
250 "Integer representing the number of seconds in the last period. | |
251 Note that you shouldn't access this value, but should use the function | |
252 `timeclock-last-period' instead.") | |
253 | |
254 (defvar timeclock-mode-string nil | |
255 "The timeclock string (optionally) displayed in the modeline.") | |
256 | |
257 (defvar timeclock-day-over nil | |
258 "The date of the last day when notified \"day over\" for.") | |
259 | |
260 ;;; User Functions: | |
261 | |
262 ;;;###autoload | |
263 (defun timeclock-modeline-display (&optional arg) | |
264 "Toggle display of the amount of time left today in the modeline. | |
265 If `timeclock-use-display-time' is non-nil, the modeline will be | |
266 updated whenever the time display is updated. Otherwise, the | |
267 timeclock will use its own sixty second timer to do its updating. | |
268 With prefix ARG, turn modeline display on if and only if ARG is | |
269 positive. Returns the new status of timeclock modeline display | |
270 \(non-nil means on)." | |
271 (interactive "P") | |
272 (let ((on-p (if arg | |
273 (> (prefix-numeric-value arg) 0) | |
274 (not timeclock-modeline-display)))) | |
275 (if on-p | |
276 (let ((list-entry (memq 'global-mode-string | |
277 mode-line-format))) | |
278 (unless (memq 'timeclock-mode-string mode-line-format) | |
279 (setcdr list-entry | |
280 (cons 'timeclock-mode-string | |
281 (cdr list-entry)))) | |
282 (unless (memq 'timeclock-update-modeline timeclock-event-hook) | |
283 (add-hook 'timeclock-event-hook 'timeclock-update-modeline)) | |
284 (when timeclock-update-timer | |
285 (cancel-timer timeclock-update-timer) | |
286 (setq timeclock-update-timer nil)) | |
287 (if (boundp 'display-time-hook) | |
288 (remove-hook 'display-time-hook 'timeclock-update-modeline)) | |
289 (if timeclock-use-display-time | |
290 (add-hook 'display-time-hook 'timeclock-update-modeline) | |
291 (setq timeclock-update-timer | |
292 (run-at-time nil 60 'timeclock-update-modeline)))) | |
293 (setq mode-line-format | |
294 (delq 'timeclock-mode-string mode-line-format)) | |
295 (remove-hook 'timeclock-event-hook 'timeclock-update-modeline) | |
296 (if (boundp 'display-time-hook) | |
297 (remove-hook 'display-time-hook | |
298 'timeclock-update-modeline)) | |
299 (when timeclock-update-timer | |
300 (cancel-timer timeclock-update-timer) | |
301 (setq timeclock-update-timer nil))) | |
302 (force-mode-line-update) | |
303 on-p)) | |
304 | |
305 ;; This has to be here so that the function definition of | |
306 ;; `timeclock-modeline-display' is known to the "set" function. | |
307 (defcustom timeclock-modeline-display nil | |
308 "Toggle modeline display of time remaining. | |
309 You must modify via \\[customize] for this variable to have an effect." | |
310 :set (lambda (symbol value) | |
311 (setq timeclock-modeline-display | |
312 (timeclock-modeline-display (or value 0)))) | |
313 :type 'boolean | |
314 :group 'timeclock | |
315 :require 'timeclock) | |
316 | |
317 ;;;###autoload | |
318 (defun timeclock-in (&optional arg project find-project) | |
319 "Clock in, recording the current time moment in the timelog. | |
320 With a numeric prefix ARG, record the fact that today has only that | |
321 many hours in it to be worked. If arg is a non-numeric prefix arg | |
322 \(non-nil, but not a number), 0 is assumed (working on a holiday or | |
323 weekend). *If not called interactively, ARG should be the number of | |
324 _seconds_ worked today*. This feature only has effect the first time | |
325 this function is called within a day. | |
326 | |
327 PROJECT as the project being clocked into. If PROJECT is nil, and | |
328 FIND-PROJECT is non-nil -- or the user calls `timeclock-in' | |
329 interactively -- call the function `timeclock-get-project-function' to | |
330 discover the name of the project." | |
331 (interactive | |
332 (list (and current-prefix-arg | |
333 (if (numberp current-prefix-arg) | |
334 (* current-prefix-arg 60 60) | |
335 0)))) | |
336 (if (equal (car timeclock-last-event) "i") | |
337 (error "You've already clocked in!") | |
338 (unless timeclock-last-event | |
339 (timeclock-reread-log)) | |
340 (unless (equal (timeclock-time-to-date | |
341 (cadr timeclock-last-event)) | |
342 (timeclock-time-to-date (current-time))) | |
343 (let ((workday (or (and (numberp arg) arg) | |
344 (and arg 0) | |
345 (and timeclock-get-workday-function | |
346 (funcall timeclock-get-workday-function)) | |
347 timeclock-workday))) | |
348 (run-hooks 'timeclock-first-in-hook) | |
349 ;; settle the discrepancy for the new day | |
350 (setq timeclock-discrepancy | |
351 (- timeclock-discrepancy workday)) | |
352 (if (not (= workday timeclock-workday)) | |
353 (timeclock-log "h" (and (numberp arg) | |
354 (number-to-string arg)))))) | |
355 (timeclock-log "i" (or project | |
356 (and timeclock-get-project-function | |
357 (or find-project (interactive-p)) | |
358 (funcall timeclock-get-project-function)))) | |
359 (run-hooks 'timeclock-in-hook))) | |
360 | |
361 ;;;###autoload | |
362 (defun timeclock-out (&optional arg reason find-reason) | |
363 "Clock out, recording the current time moment in the timelog. | |
364 If a prefix ARG is given, the user has completed the project that was | |
365 begun during the last time segment. | |
366 | |
367 REASON is the user's reason for clocking out. If REASON is nil, and | |
368 FIND-REASON is non-nil -- or the user calls `timeclock-out' | |
369 interactively -- call the function `timeclock-get-reason-function' to | |
370 discover the reason." | |
371 (interactive "P") | |
372 (if (equal (downcase (car timeclock-last-event)) "o") | |
373 (error "You've already clocked out!") | |
374 (timeclock-log | |
375 (if arg "O" "o") | |
376 (or reason | |
377 (and timeclock-get-reason-function | |
378 (or find-reason (interactive-p)) | |
379 (funcall timeclock-get-reason-function)))) | |
380 (run-hooks 'timeclock-out-hook) | |
381 (if arg | |
382 (run-hooks 'timeclock-done-hook)))) | |
383 | |
384 ;;;###autoload | |
385 (defun timeclock-status-string (&optional show-seconds today-only) | |
386 "Report the overall timeclock status at the present moment." | |
387 (interactive "P") | |
388 (let* ((remainder (timeclock-workday-remaining)) | |
389 (last-in (equal (car timeclock-last-event) "i")) | |
390 status) | |
391 (setq status | |
392 (format "Currently %s since %s (%s), %s %s, leave at %s" | |
393 (if last-in "IN" "OUT") | |
394 (if show-seconds | |
395 (format-time-string "%-I:%M:%S %p" | |
396 (nth 1 timeclock-last-event)) | |
397 (format-time-string "%-I:%M %p" | |
398 (nth 1 timeclock-last-event))) | |
399 (or (nth 2 timeclock-last-event) | |
400 (if last-in "**UNKNOWN**" "workday over")) | |
401 (timeclock-seconds-to-string remainder show-seconds t) | |
402 (if (> remainder 0) | |
403 "remaining" "over") | |
404 (timeclock-when-to-leave-string show-seconds today-only))) | |
405 (if (interactive-p) | |
406 (message status) | |
407 status))) | |
408 | |
409 ;;;###autoload | |
410 (defun timeclock-change (&optional arg project) | |
411 "Change to working on a different project, by clocking in then out. | |
412 With a prefix ARG, consider the previous project as having been | |
413 finished at the time of changeover. PROJECT is the name of the last | |
414 project you were working on." | |
415 (interactive "P") | |
416 (timeclock-out arg) | |
417 (timeclock-in nil project (interactive-p))) | |
418 | |
419 ;;;###autoload | |
420 (defun timeclock-query-out () | |
421 "Ask the user before clocking out. | |
422 This is a useful function for adding to `kill-emacs-hook'." | |
423 (if (and (equal (car timeclock-last-event) "i") | |
424 (y-or-n-p "You're currently clocking time, clock out? ")) | |
425 (timeclock-out))) | |
426 | |
427 ;;;###autoload | |
428 (defun timeclock-reread-log () | |
429 "Re-read the timeclock, to account for external changes. | |
430 Returns the new value of `timeclock-discrepancy'." | |
431 (interactive) | |
432 (setq timeclock-discrepancy nil) | |
433 (timeclock-find-discrep) | |
434 (if timeclock-modeline-display | |
435 (timeclock-update-modeline)) | |
436 timeclock-discrepancy) | |
437 | |
438 (defun timeclock-seconds-to-string (seconds &optional show-seconds | |
439 reverse-leader) | |
440 "Convert SECONDS into a compact time string. | |
441 If SHOW-SECONDS is non-nil, make the resolution of the return string | |
442 include the second count. If REVERSE-LEADER is non-nil, it means to | |
443 output a \"+\" if the time value is negative, rather than a \"-\". | |
444 This is used when negative time values have an inverted meaning (such | |
445 as with time remaining, where negative time really means overtime)." | |
446 (if show-seconds | |
447 (format "%s%d:%02d:%02d" | |
448 (if (< seconds 0) (if reverse-leader "+" "-") "") | |
449 (truncate (/ (abs seconds) 60 60)) | |
450 (% (truncate (/ (abs seconds) 60)) 60) | |
451 (% (truncate (abs seconds)) 60)) | |
452 (format "%s%d:%02d" | |
453 (if (< seconds 0) (if reverse-leader "+" "-") "") | |
454 (truncate (/ (abs seconds) 60 60)) | |
455 (% (truncate (/ (abs seconds) 60)) 60)))) | |
456 | |
33020 | 457 (defsubst timeclock-workday-remaining (&optional today-only) |
30781 | 458 "Return a the number of seconds until the workday is complete. |
459 The amount returned is relative to the value of `timeclock-workday'. | |
460 If TODAY-ONLY is non-nil, the value returned will be relative only to | |
461 the time worked today, and not to past time. This argument only makes | |
462 a difference if `timeclock-relative' is non-nil." | |
463 (- (timeclock-find-discrep today-only))) | |
464 | |
33020 | 465 (defsubst timeclock-currently-in-p () |
30781 | 466 "Return non-nil if the user is currently clocked in." |
467 (equal (car timeclock-last-event) "i")) | |
468 | |
469 ;;;###autoload | |
470 (defun timeclock-workday-remaining-string (&optional show-seconds | |
471 today-only) | |
472 "Return a string representing the amount of time left today. | |
473 Display second resolution if SHOW-SECONDS is non-nil. If TODAY-ONLY | |
474 is non-nil, the display will be relative only to time worked today. | |
475 See `timeclock-relative' for more information about the meaning of | |
476 \"relative to today\"." | |
477 (interactive) | |
478 (let ((string (timeclock-seconds-to-string | |
479 (timeclock-workday-remaining today-only) | |
480 show-seconds t))) | |
481 (if (interactive-p) | |
482 (message string) | |
483 string))) | |
484 | |
33020 | 485 (defsubst timeclock-workday-elapsed (&optional relative) |
30781 | 486 "Return a the number of seconds worked so far today. |
487 If RELATIVE is non-nil, the amount returned will be relative to past | |
488 time worked. The default is to return only the time that has elapsed | |
489 so far today." | |
490 (+ timeclock-workday | |
491 (timeclock-find-discrep (not relative)))) | |
492 | |
493 ;;;###autoload | |
494 (defun timeclock-workday-elapsed-string (&optional show-seconds | |
495 relative) | |
496 "Return a string representing the amount of time worked today. | |
497 Display seconds resolution if SHOW-SECONDS is non-nil. If RELATIVE is | |
498 non-nil, the amount returned will be relative to past time worked." | |
499 (interactive) | |
500 (let ((string (timeclock-seconds-to-string | |
501 (timeclock-workday-elapsed relative) | |
502 show-seconds))) | |
503 (if (interactive-p) | |
504 (message string) | |
505 string))) | |
506 | |
33020 | 507 (defsubst timeclock-when-to-leave (&optional today-only) |
30781 | 508 "Return a time value representing at when the workday ends today. |
509 If TODAY-ONLY is non-nil, the value returned will be relative only to | |
510 the time worked today, and not to past time. This argument only makes | |
511 a difference if `timeclock-relative' is non-nil." | |
512 (timeclock-seconds-to-time | |
513 (- (timeclock-time-to-seconds (current-time)) | |
514 (timeclock-find-discrep today-only)))) | |
515 | |
516 ;;;###autoload | |
517 (defun timeclock-when-to-leave-string (&optional show-seconds | |
518 today-only) | |
519 "Return a string representing at what time the workday ends today. | |
520 This string is relative to the value of `timeclock-workday'. If | |
521 NO-MESSAGE is non-nil, no messages will be displayed in the | |
522 minibuffer. If SHOW-SECONDS is non-nil, the value printed/returned | |
523 will include seconds. If TODAY-ONLY is non-nil, the value returned | |
524 will be relative only to the time worked today, and not to past time. | |
525 This argument only makes a difference if `timeclock-relative' is | |
526 non-nil." | |
527 (interactive) | |
528 (let* ((then (timeclock-when-to-leave today-only)) | |
529 (string | |
530 (if show-seconds | |
531 (format-time-string "%-I:%M:%S %p" then) | |
532 (format-time-string "%-I:%M %p" then)))) | |
533 (if (interactive-p) | |
534 (message string) | |
535 string))) | |
536 | |
537 ;;; Internal Functions: | |
538 | |
539 (defvar timeclock-project-list nil) | |
540 (defvar timeclock-last-project nil) | |
541 | |
542 (defun timeclock-ask-for-project () | |
543 "Ask the user for the project they are clocking into." | |
544 (completing-read (format "Clock into which project (default \"%s\"): " | |
545 (or timeclock-last-project | |
546 (car timeclock-project-list))) | |
547 (mapcar 'list timeclock-project-list) | |
548 nil nil nil nil (or timeclock-last-project | |
549 (car timeclock-project-list)))) | |
550 | |
551 (defvar timeclock-reason-list nil) | |
552 | |
553 (defun timeclock-ask-for-reason () | |
554 "Ask the user for the reason they are clocking out." | |
555 (completing-read "Reason for clocking out: " | |
556 (mapcar 'list timeclock-reason-list))) | |
557 | |
558 (defun timeclock-update-modeline () | |
559 "Update the `timeclock-mode-string' displayed in the modeline." | |
560 (interactive) | |
561 (let* ((remainder (timeclock-workday-remaining)) | |
562 (last-in (equal (car timeclock-last-event) "i"))) | |
563 (when (and (< remainder 0) | |
564 (not (and timeclock-day-over | |
565 (equal timeclock-day-over | |
566 (timeclock-time-to-date | |
567 (current-time)))))) | |
568 (setq timeclock-day-over | |
569 (timeclock-time-to-date (current-time))) | |
570 (run-hooks 'timeclock-day-over-hook)) | |
571 (setq timeclock-mode-string | |
572 (format " %c%s%c" | |
573 (if last-in ?< ?[) | |
574 (timeclock-seconds-to-string remainder nil t) | |
575 (if last-in ?> ?]))))) | |
576 | |
577 (defun timeclock-log (code &optional project) | |
578 "Log the event CODE to the timeclock log, at the time of call. | |
579 If PROJECT is a string, it represents the project which the event is | |
33020 | 580 being logged for. Normally only \"in\" events specify a project." |
581 (with-current-buffer (find-file-noselect timeclock-file) | |
30781 | 582 (goto-char (point-max)) |
583 (if (not (bolp)) | |
584 (insert "\n")) | |
585 (let ((now (current-time))) | |
586 (insert code " " | |
587 (format-time-string "%Y/%m/%d %H:%M:%S" now) | |
588 (or (and project | |
589 (stringp project) | |
590 (> (length project) 0) | |
591 (concat " " project)) | |
592 "") | |
593 "\n") | |
594 (if (equal (downcase code) "o") | |
595 (setq timeclock-last-period | |
596 (- (timeclock-time-to-seconds now) | |
597 (timeclock-time-to-seconds | |
598 (cadr timeclock-last-event))) | |
599 timeclock-discrepancy | |
600 (+ timeclock-discrepancy | |
601 timeclock-last-period))) | |
602 (setq timeclock-last-event (list code now project))) | |
603 (save-buffer) | |
33020 | 604 (run-hooks 'timeclock-event-hook) |
605 (kill-buffer (current-buffer)))) | |
30781 | 606 |
33020 | 607 (defvar timeclock-moment-regexp |
608 (concat "\\([bhioO]\\)\\s-+" | |
609 "\\([0-9]+\\)/\\([0-9]+\\)/\\([0-9]+\\)\\s-+" | |
610 "\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\)[ \t]*" "\\([^\n]*\\)")) | |
611 | |
612 (defsubst timeclock-read-moment () | |
30781 | 613 "Read the moment under point from the timelog." |
33020 | 614 (if (looking-at timeclock-moment-regexp) |
615 (let ((code (match-string 1)) | |
616 (year (string-to-number (match-string 2))) | |
617 (mon (string-to-number (match-string 3))) | |
618 (mday (string-to-number (match-string 4))) | |
619 (hour (string-to-number (match-string 5))) | |
620 (min (string-to-number (match-string 6))) | |
621 (sec (string-to-number (match-string 7))) | |
622 (project (match-string 8))) | |
623 (list code (encode-time sec min hour mday mon year) project)))) | |
30781 | 624 |
33020 | 625 (defsubst timeclock-time-to-seconds (time) |
30781 | 626 "Convert TIME to a floating point number." |
627 (+ (* (car time) 65536.0) | |
628 (cadr time) | |
629 (/ (or (car (cdr (cdr time))) 0) 1000000.0))) | |
630 | |
33020 | 631 (defsubst timeclock-seconds-to-time (seconds) |
30781 | 632 "Convert SECONDS (a floating point number) to an Emacs time structure." |
633 (list (floor seconds 65536) | |
634 (floor (mod seconds 65536)) | |
635 (floor (* (- seconds (ffloor seconds)) 1000000)))) | |
636 | |
33020 | 637 (defsubst timeclock-time-to-date (time) |
30781 | 638 "Convert the TIME value to a textual date string." |
639 (format-time-string "%Y/%m/%d" time)) | |
640 | |
641 (defun timeclock-last-period (&optional moment) | |
642 "Return the value of the last event period. | |
643 If the last event was a clock-in, the period will be open ended, and | |
644 growing every second. Otherwise, it is a fixed amount which has been | |
645 recorded to disk. If MOMENT is non-nil, use that as the current time. | |
646 This is only provided for coherency when used by | |
647 `timeclock-discrepancy'." | |
648 (if (equal (car timeclock-last-event) "i") | |
649 (- (timeclock-time-to-seconds (or moment (current-time))) | |
650 (timeclock-time-to-seconds | |
651 (cadr timeclock-last-event))) | |
652 timeclock-last-period)) | |
653 | |
33020 | 654 (defsubst timeclock-entry-length (entry) |
655 (- (timeclock-time-to-seconds (cadr entry)) | |
656 (timeclock-time-to-seconds (car entry)))) | |
657 | |
658 (defsubst timeclock-entry-begin (entry) | |
659 (car entry)) | |
660 | |
661 (defsubst timeclock-entry-end (entry) | |
662 (cadr entry)) | |
663 | |
664 (defsubst timeclock-entry-project (entry) | |
665 (nth 2 entry)) | |
666 | |
667 (defsubst timeclock-entry-comment (entry) | |
668 (nth 3 entry)) | |
669 | |
670 | |
671 (defsubst timeclock-entry-list-length (entry-list) | |
672 (let ((length 0)) | |
673 (while entry-list | |
674 (setq length (+ length (timeclock-entry-length (car entry-list)))) | |
675 (setq entry-list (cdr entry-list))) | |
676 length)) | |
677 | |
678 (defsubst timeclock-entry-list-begin (entry-list) | |
679 (timeclock-entry-begin (car entry-list))) | |
680 | |
681 (defsubst timeclock-entry-list-end (entry-list) | |
682 (timeclock-entry-end (car (last entry-list)))) | |
683 | |
684 (defsubst timeclock-entry-list-span (entry-list) | |
685 (- (timeclock-time-to-seconds (timeclock-entry-list-end entry-list)) | |
686 (timeclock-time-to-seconds (timeclock-entry-list-begin entry-list)))) | |
687 | |
688 (defsubst timeclock-entry-list-break (entry-list) | |
689 (- (timeclock-entry-list-span entry-list) | |
690 (timeclock-entry-list-length entry-list))) | |
691 | |
692 (defsubst timeclock-entry-list-projects (entry-list) | |
693 (let (projects) | |
694 (while entry-list | |
695 (let ((project (timeclock-entry-project (car entry-list)))) | |
696 (if projects | |
697 (add-to-list 'projects project) | |
698 (setq projects (list project)))) | |
699 (setq entry-list (cdr entry-list))) | |
700 projects)) | |
701 | |
702 | |
703 (defsubst timeclock-day-required (day) | |
704 (car day)) | |
705 | |
706 (defsubst timeclock-day-length (day) | |
707 (timeclock-entry-list-length (cdr day))) | |
708 | |
709 (defsubst timeclock-day-debt (day) | |
710 (- (timeclock-day-required day) | |
711 (timeclock-day-length day))) | |
712 | |
713 (defsubst timeclock-day-begin (day) | |
714 (timeclock-entry-list-begin (cdr day))) | |
715 | |
716 (defsubst timeclock-day-end (day) | |
717 (timeclock-entry-list-end (cdr day))) | |
718 | |
719 (defsubst timeclock-day-span (day) | |
720 (timeclock-entry-list-span (cdr day))) | |
721 | |
722 (defsubst timeclock-day-break (day) | |
723 (timeclock-entry-list-break (cdr day))) | |
724 | |
725 (defsubst timeclock-day-projects (day) | |
726 (timeclock-entry-list-projects (cdr day))) | |
727 | |
728 (defmacro timeclock-day-list-template (func) | |
729 `(let ((length 0)) | |
730 (while day-list | |
731 (setq length (+ length (,(eval func) (car day-list)))) | |
732 (setq day-list (cdr day-list))) | |
733 length)) | |
734 | |
735 (defun timeclock-day-list-required (day-list) | |
736 (timeclock-day-list-template 'timeclock-day-required)) | |
737 | |
738 (defun timeclock-day-list-length (day-list) | |
739 (timeclock-day-list-template 'timeclock-day-length)) | |
740 | |
741 (defun timeclock-day-list-debt (day-list) | |
742 (timeclock-day-list-template 'timeclock-day-debt)) | |
743 | |
744 (defsubst timeclock-day-list-begin (day-list) | |
745 (timeclock-day-begin (car day-list))) | |
746 | |
747 (defsubst timeclock-day-list-end (day-list) | |
748 (timeclock-day-end (car (last day-list)))) | |
749 | |
750 (defun timeclock-day-list-span (day-list) | |
751 (timeclock-day-list-template 'timeclock-day-span)) | |
752 | |
753 (defun timeclock-day-list-break (day-list) | |
754 (timeclock-day-list-template 'timeclock-day-break)) | |
755 | |
756 (defun timeclock-day-list-projects (day-list) | |
757 (let (projects) | |
758 (while day-list | |
759 (let ((projs (timeclock-day-projects (car day-list)))) | |
760 (while projs | |
761 (if projects | |
762 (add-to-list 'projects (car projs)) | |
763 (setq projects (list (car projs)))) | |
764 (setq projs (cdr projs)))) | |
765 (setq day-list (cdr day-list))) | |
766 projects)) | |
767 | |
768 | |
769 (defsubst timeclock-current-debt (&optional log-data) | |
770 (nth 0 (or log-data (timeclock-log-data)))) | |
771 | |
772 (defsubst timeclock-day-alist (&optional log-data) | |
773 (nth 1 (or log-data (timeclock-log-data)))) | |
774 | |
775 (defun timeclock-day-list (&optional log-data) | |
776 (let ((alist (timeclock-day-alist log-data)) | |
777 day-list) | |
778 (while alist | |
779 (setq day-list (cons (cdar alist) day-list) | |
780 alist (cdr alist))) | |
781 day-list)) | |
782 | |
783 (defsubst timeclock-project-alist (&optional log-data) | |
784 (nth 2 (or log-data (timeclock-log-data)))) | |
785 | |
786 | |
787 (defun timeclock-log-data (&optional recent-only filename) | |
788 "Return the contents of the timelog file, in a useful format. | |
789 A timelog contains data in the form of a single entry per line. | |
790 Each entry has the form: | |
791 | |
792 CODE YYYY/MM/DD HH:MM:SS [COMMENT] | |
793 | |
794 CODE is one of: b, h, i, o or O. COMMENT is optional when the code is | |
795 i, o or O. The meanings of the codes are: | |
796 | |
797 b Set the current time balance, or \"time debt\". Useful when | |
798 archiving old log data, when a debt must be carried forward. | |
799 The COMMENT here is the number of seconds of debt. | |
800 | |
801 h Set the required working time for the given day. This must | |
802 be the first entry for that day. The COMMENT in this case is | |
803 the number of hours that must be worked. Floating point | |
804 amounts are allowed. | |
805 | |
806 i Clock in. The COMMENT in this case should be the name of the | |
807 project worked on. | |
808 | |
809 o Clock out. COMMENT is unnecessary, but can be used to provide | |
810 a description of how the period went, for example. | |
811 | |
812 O Final clock out. Whatever project was being worked on, it is | |
813 now finished. Useful for creating summary reports. | |
814 | |
815 When this function is called, it will return a data structure with the | |
816 following format: | |
817 | |
818 (DEBT ENTRIES-BY-DAY ENTRIES-BY-PROJECT) | |
819 | |
820 DEBT is a floating point number representing the number of seconds | |
821 \"owed\" before any work was done. For a new file (one without a 'b' | |
822 entry), this is always zero. | |
823 | |
824 The two entries lists have similar formats. They are both alists, | |
825 where the CAR is the index, and the CDR is a list of time entries. | |
826 For ENTRIES-BY-DAY, the CAR is a textual date string, of the form | |
827 YYYY/MM/DD. For ENTRIES-BY-PROJECT, it is the name of the project | |
828 worked on, or t for the default project. | |
829 | |
830 The CDR for ENTRIES-BY-DAY is slightly different than for | |
831 ENTRIES-BY-PROJECT. It has the following form: | |
832 | |
833 (DAY-LENGTH TIME-ENTRIES...) | |
834 | |
835 For ENTRIES-BY-PROJECT, there is no DAY-LENGTH member. It is simply a | |
836 list of TIME-ENTRIES. Note that if DAY-LENGTH is nil, it means | |
837 whatever is the default should be used. | |
838 | |
839 A TIME-ENTRY is a recorded time interval. It has the following format | |
840 \(although generally one does not have to manipulate these entries | |
841 directly; see below): | |
842 | |
843 (BEGIN-TIME END-TIME PROJECT [COMMENT] [FINAL-P]) | |
844 | |
845 Anyway, suffice it to say there are a lot of structures. Typically | |
846 the user is expected to manipulate to the day(s) or project(s) that he | |
847 or she wants, at which point the following helper functions may be | |
848 used: | |
849 | |
850 timeclock-day-required | |
851 timeclock-day-length | |
852 timeclock-day-debt | |
853 timeclock-day-begin | |
854 timeclock-day-end | |
855 timeclock-day-span | |
856 timeclock-day-break | |
857 timeclock-day-projects | |
858 | |
859 timeclock-day-list-required | |
860 timeclock-day-list-length | |
861 timeclock-day-list-debt | |
862 timeclock-day-list-begin | |
863 timeclock-day-list-end | |
864 timeclock-day-list-span | |
865 timeclock-day-list-break | |
866 timeclock-day-list-projects | |
867 | |
868 timeclock-entry-length | |
869 timeclock-entry-begin | |
870 timeclock-entry-end | |
871 timeclock-entry-project | |
872 timeclock-entry-comment | |
873 | |
874 timeclock-entry-list-length | |
875 timeclock-entry-list-begin | |
876 timeclock-entry-list-end | |
877 timeclock-entry-list-span | |
878 timeclock-entry-list-break | |
879 timeclock-entry-list-projects | |
880 | |
881 A few comments should make the use of the above functions obvious: | |
882 | |
883 `required' is the amount of time that must be spent during a day, or | |
884 sequence of days, in order to have no debt. | |
885 | |
886 `length' is the actual amount of time that was spent. | |
887 | |
888 `debt' is the difference between required time and length. A | |
889 negative debt signifies overtime. | |
890 | |
891 `begin' is the earliest moment at which work began. | |
892 | |
893 `end' is the final moment work was done. | |
894 | |
895 `span' is the difference between begin and end. | |
896 | |
897 `break' is the difference between span and length. | |
898 | |
899 `project' is the project that was worked on, and `projects' is a | |
900 list of all the projects that were worked on during a given period. | |
901 | |
902 `comment', where it applies, could mean anything. | |
903 | |
904 There are a few more functions available, for locating day and entry | |
905 lists: | |
906 | |
907 timeclock-day-alist LOG-DATA | |
908 timeclock-project-alist LOG-DATA | |
909 timeclock-current-debt LOG-DATA | |
910 | |
911 See the documentation for the given function if more info is needed." | |
912 (let* ((log-data (list 0.0 nil nil)) | |
913 (now (current-time)) | |
914 (todays-date (timeclock-time-to-date now)) | |
915 last-date-limited last-date-seconds last-date | |
916 (line 0) last beg day entry) | |
917 (with-temp-buffer | |
918 (insert-file-contents (or filename timeclock-file)) | |
919 (when recent-only | |
920 (goto-char (point-max)) | |
921 (unless (re-search-backward "^b\\s-+" nil t) | |
922 (goto-char (point-min)))) | |
923 (while (or (setq event (timeclock-read-moment)) | |
924 (and beg (not last) | |
925 (setq last t event (list "o" now)))) | |
926 (setq line (1+ line)) | |
927 (cond ((equal (car event) "b") | |
928 (setcar log-data (string-to-number (nth 2 event)))) | |
929 ((equal (car event) "h") | |
930 (setq last-date-limited (timeclock-time-to-date (cadr event)) | |
931 last-date-seconds (* (string-to-number (nth 2 event)) | |
932 3600.0))) | |
933 ((equal (car event) "i") | |
934 (if beg | |
935 (error "Error in format of timelog file, line %d" line) | |
936 (setq beg t)) | |
937 (setq entry (list (cadr event) nil | |
938 (and (> (length (nth 2 event)) 0) | |
939 (nth 2 event)))) | |
940 (let ((date (timeclock-time-to-date (cadr event)))) | |
941 (if (and last-date | |
942 (not (equal date last-date))) | |
943 (setcar (cdr log-data) | |
944 (cons (cons last-date day) | |
945 (cadr log-data))) | |
946 (setq day (list (and last-date-limited | |
947 last-date-seconds)))) | |
948 (setq last-date date | |
949 last-date-limited nil))) | |
950 ((equal (downcase (car event)) "o") | |
951 (if (not beg) | |
952 (error "Error in format of timelog file, line %d" line) | |
953 (setq beg nil)) | |
954 (setcar (cdr entry) (cadr event)) | |
955 (let ((desc (and (> (length (nth 2 event)) 0) | |
956 (nth 2 event)))) | |
957 (if desc | |
958 (nconc entry (list (nth 2 event)))) | |
959 (if (equal (car event) "O") | |
960 (nconc entry (if desc | |
961 (list t) | |
962 (list nil t)))) | |
963 (nconc day (list entry)) | |
964 (setq desc (nth 2 entry)) | |
965 (let ((proj (assoc desc (nth 2 log-data)))) | |
966 (if (not proj) | |
967 (setcar (cddr log-data) | |
968 (cons (cons desc (list entry)) | |
969 (car (cddr log-data)))) | |
970 (nconc (cdr proj) (list entry))))))) | |
971 (forward-line)) | |
972 (if day | |
973 (setcar (cdr log-data) | |
974 (cons (cons last-date day) | |
975 (cadr log-data)))) | |
976 log-data))) | |
977 | |
30781 | 978 (defun timeclock-find-discrep (&optional today-only) |
979 "Find overall discrepancy from `timeclock-workday' (in seconds). | |
980 If TODAY-ONLY is non-nil, the discrepancy will be not be relative, and | |
981 will correspond only to the amount of time elapsed today. This is | |
982 identical to what would be return if `timeclock-relative' were nil." | |
33020 | 983 ;; This is not implemented in terms of the functions above, because |
984 ;; it's a bit wasteful to read all of that data in, just to throw | |
985 ;; away more than 90% of the information afterwards. | |
986 (let* ((now (current-time)) | |
30781 | 987 (todays-date (timeclock-time-to-date now)) |
33020 | 988 (first t) (accum 0) |
989 event beg last-date avg | |
990 last-date-limited last-date-seconds) | |
30781 | 991 (unless timeclock-discrepancy |
992 (setq timeclock-project-list nil | |
993 timeclock-last-project nil | |
33020 | 994 timeclock-reason-list nil |
995 timeclock-elapsed 0) | |
996 (with-temp-buffer | |
997 (insert-file-contents timeclock-file) | |
998 (goto-char (point-max)) | |
999 (unless (re-search-backward "^b\\s-+" nil t) | |
1000 (goto-char (point-min))) | |
30781 | 1001 (while (setq event (timeclock-read-moment)) |
33020 | 1002 (cond ((equal (car event) "b") |
1003 (setq accum (string-to-number (nth 2 event)))) | |
1004 ((equal (car event) "h") | |
30781 | 1005 (setq last-date-limited |
1006 (timeclock-time-to-date (cadr event)) | |
1007 last-date-seconds | |
33020 | 1008 (* (string-to-number (nth 2 event)) 3600.0))) |
30781 | 1009 ((equal (car event) "i") |
1010 (when (and (nth 2 event) | |
1011 (> (length (nth 2 event)) 0)) | |
1012 (add-to-list 'timeclock-project-list (nth 2 event)) | |
1013 (setq timeclock-last-project (nth 2 event))) | |
1014 (let ((date (timeclock-time-to-date (cadr event)))) | |
33020 | 1015 (if (and timeclock-relative |
1016 (if last-date | |
1017 (not (equal date last-date)) | |
1018 first)) | |
30781 | 1019 (setq first nil |
1020 accum (- accum | |
1021 (if last-date-limited | |
1022 last-date-seconds | |
33020 | 1023 timeclock-workday)))) |
30781 | 1024 (setq last-date date |
1025 last-date-limited nil) | |
1026 (if beg | |
1027 (error "Error in format of timelog file!") | |
1028 (setq beg (timeclock-time-to-seconds (cadr event)))))) | |
1029 ((equal (downcase (car event)) "o") | |
1030 (if (and (nth 2 event) | |
1031 (> (length (nth 2 event)) 0)) | |
1032 (add-to-list 'timeclock-reason-list (nth 2 event))) | |
1033 (if (or timeclock-relative | |
1034 (equal last-date todays-date)) | |
1035 (if (not beg) | |
1036 (error "Error in format of timelog file!") | |
1037 (setq timeclock-last-period | |
33020 | 1038 (- (timeclock-time-to-seconds (cadr event)) beg) |
30781 | 1039 accum (+ timeclock-last-period accum) |
1040 beg nil))) | |
1041 (if (equal last-date todays-date) | |
1042 (setq timeclock-elapsed | |
1043 (+ timeclock-last-period timeclock-elapsed))))) | |
1044 (setq timeclock-last-event event | |
1045 timeclock-last-event-workday | |
1046 (if (equal (timeclock-time-to-date now) | |
1047 last-date-limited) | |
1048 last-date-seconds | |
1049 timeclock-workday)) | |
1050 (forward-line)) | |
1051 (setq timeclock-discrepancy accum))) | |
1052 (setq accum (if today-only | |
1053 timeclock-elapsed | |
1054 timeclock-discrepancy)) | |
1055 (if timeclock-last-event | |
1056 (if (equal (car timeclock-last-event) "i") | |
1057 (setq accum (+ accum (timeclock-last-period now))) | |
1058 (if (not (equal (timeclock-time-to-date | |
1059 (cadr timeclock-last-event)) | |
1060 (timeclock-time-to-date now))) | |
1061 (setq accum (- accum timeclock-last-event-workday))))) | |
1062 (setq accum | |
1063 (- accum | |
1064 (if (and timeclock-last-event | |
1065 (equal (timeclock-time-to-date | |
1066 (cadr timeclock-last-event)) | |
1067 (timeclock-time-to-date now))) | |
1068 timeclock-last-event-workday | |
1069 timeclock-workday))))) | |
1070 | |
1071 (provide 'timeclock) | |
1072 | |
1073 (run-hooks 'timeclock-load-hook) | |
1074 | |
1075 ;; make sure we know the list of reasons, projects, and have computed | |
1076 ;; the last event and current discrepancy. | |
1077 (if (file-readable-p timeclock-file) | |
1078 (timeclock-reread-log)) | |
1079 | |
1080 ;;; timeclock.el ends here |