Commit | Line | Data |
---|---|---|
90cbf47e GM |
1 | ;;; timeclock.el --- mode for keeping track of how much you work |
2 | ||
ab422c4d | 3 | ;; Copyright (C) 1999-2013 Free Software Foundation, Inc. |
90cbf47e GM |
4 | |
5 | ;; Author: John Wiegley <johnw@gnu.org> | |
6 | ;; Created: 25 Mar 1999 | |
7e285b36 | 7 | ;; Version: 2.6.1 |
90cbf47e | 8 | ;; Keywords: calendar data |
90cbf47e GM |
9 | |
10 | ;; This file is part of GNU Emacs. | |
11 | ||
2ed66575 | 12 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
90cbf47e | 13 | ;; it under the terms of the GNU General Public License as published by |
2ed66575 GM |
14 | ;; the Free Software Foundation, either version 3 of the License, or |
15 | ;; (at your option) any later version. | |
90cbf47e GM |
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 | |
2ed66575 | 23 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
90cbf47e GM |
24 | |
25 | ;;; Commentary: | |
26 | ||
27 | ;; This mode is for keeping track of time intervals. You can use it | |
28 | ;; for whatever purpose you like, but the typical scenario is to keep | |
29 | ;; track of how much time you spend working on certain projects. | |
30 | ;; | |
31 | ;; Use `timeclock-in' when you start on a project, and `timeclock-out' | |
32 | ;; when you're done. Once you've collected some data, you can use | |
33 | ;; `timeclock-workday-remaining' to see how much time is left to be | |
145570df GM |
34 | ;; worked today (where `timeclock-workday' specifies the length of the |
35 | ;; working day), and `timeclock-when-to-leave' to calculate when you're free. | |
90cbf47e GM |
36 | |
37 | ;; You'll probably want to bind the timeclock commands to some handy | |
145570df | 38 | ;; keystrokes. At the moment, C-x t is unused: |
90cbf47e GM |
39 | ;; |
40 | ;; (require 'timeclock) | |
41 | ;; | |
42 | ;; (define-key ctl-x-map "ti" 'timeclock-in) | |
43 | ;; (define-key ctl-x-map "to" 'timeclock-out) | |
44 | ;; (define-key ctl-x-map "tc" 'timeclock-change) | |
45 | ;; (define-key ctl-x-map "tr" 'timeclock-reread-log) | |
37269466 | 46 | ;; (define-key ctl-x-map "tu" 'timeclock-update-mode-line) |
90cbf47e GM |
47 | ;; (define-key ctl-x-map "tw" 'timeclock-when-to-leave-string) |
48 | ||
49 | ;; If you want Emacs to display the amount of time "left" to your | |
37269466 CY |
50 | ;; workday in the mode-line, you can either set the value of |
51 | ;; `timeclock-mode-line-display' to t using M-x customize, or you can | |
865fe16f | 52 | ;; add this code to your init file: |
90cbf47e GM |
53 | ;; |
54 | ;; (require 'timeclock) | |
37269466 | 55 | ;; (timeclock-mode-line-display) |
90cbf47e | 56 | ;; |
37269466 CY |
57 | ;; To cancel this mode line display at any time, just call |
58 | ;; `timeclock-mode-line-display' again. | |
90cbf47e GM |
59 | |
60 | ;; You may also want Emacs to ask you before exiting, if you are | |
a9dfccd6 | 61 | ;; currently working on a project. This can be done either by setting |
90cbf47e | 62 | ;; `timeclock-ask-before-exiting' to t using M-x customize (this is |
865fe16f | 63 | ;; the default), or by adding the following to your init file: |
90cbf47e | 64 | ;; |
9d1137ce | 65 | ;; (add-hook 'kill-emacs-query-functions 'timeclock-query-out) |
90cbf47e GM |
66 | |
67 | ;; NOTE: If you change your .timelog file without using timeclock's | |
68 | ;; functions, or if you change the value of any of timeclock's | |
69 | ;; customizable variables, you should run the command | |
70 | ;; `timeclock-reread-log'. This will recompute any discrepancies in | |
71 | ;; your average working time, and will make sure that the various | |
72 | ;; display functions return the correct value. | |
73 | ||
74 | ;;; History: | |
75 | ||
76 | ;;; Code: | |
77 | ||
78 | (defgroup timeclock nil | |
6a8cf883 | 79 | "Keeping track of the time that gets spent." |
90cbf47e GM |
80 | :group 'data) |
81 | ||
82 | ;;; User Variables: | |
83 | ||
e437b491 | 84 | (defcustom timeclock-file (convert-standard-filename "~/.timelog") |
08f7d912 | 85 | "The file used to store timeclock data in." |
90cbf47e GM |
86 | :type 'file |
87 | :group 'timeclock) | |
88 | ||
89 | (defcustom timeclock-workday (* 8 60 60) | |
fc250015 | 90 | "The length of a work period in seconds." |
90cbf47e GM |
91 | :type 'integer |
92 | :group 'timeclock) | |
93 | ||
94 | (defcustom timeclock-relative t | |
08f7d912 | 95 | "Whether to make reported time relative to `timeclock-workday'. |
90cbf47e GM |
96 | For example, if the length of a normal workday is eight hours, and you |
97 | work four hours on Monday, then the amount of time \"remaining\" on | |
98 | Tuesday is twelve hours -- relative to an averaged work period of | |
99 | eight hours -- or eight hours, non-relative. So relative time takes | |
145570df | 100 | into account any discrepancy of time under-worked or over-worked on |
37269466 | 101 | previous days. This only affects the timeclock mode line display." |
90cbf47e GM |
102 | :type 'boolean |
103 | :group 'timeclock) | |
104 | ||
105 | (defcustom timeclock-get-project-function 'timeclock-ask-for-project | |
08f7d912 | 106 | "The function used to determine the name of the current project. |
90cbf47e | 107 | When clocking in, and no project is specified, this function will be |
a9dfccd6 | 108 | called to determine what is the current project to be worked on. |
90cbf47e GM |
109 | If this variable is nil, no questions will be asked." |
110 | :type 'function | |
111 | :group 'timeclock) | |
112 | ||
113 | (defcustom timeclock-get-reason-function 'timeclock-ask-for-reason | |
08f7d912 | 114 | "A function used to determine the reason for clocking out. |
90cbf47e | 115 | When clocking out, and no reason is specified, this function will be |
a9dfccd6 | 116 | called to determine what is the reason. |
90cbf47e GM |
117 | If this variable is nil, no questions will be asked." |
118 | :type 'function | |
119 | :group 'timeclock) | |
120 | ||
121 | (defcustom timeclock-get-workday-function nil | |
08f7d912 | 122 | "A function used to determine the length of today's workday. |
90cbf47e | 123 | The first time that a user clocks in each day, this function will be |
a9dfccd6 | 124 | called to determine what is the length of the current workday. If |
a3dd6af2 | 125 | the return value is nil, or equal to `timeclock-workday', nothing special |
a1506d29 | 126 | will be done. If it is a quantity different from `timeclock-workday', |
a3dd6af2 | 127 | however, a record will be output to the timelog file to note the fact that |
a9dfccd6 | 128 | that day has a length that is different from the norm." |
a3dd6af2 | 129 | :type '(choice (const nil) function) |
90cbf47e GM |
130 | :group 'timeclock) |
131 | ||
132 | (defcustom timeclock-ask-before-exiting t | |
08f7d912 | 133 | "If non-nil, ask if the user wants to clock out before exiting Emacs. |
a9dfccd6 | 134 | This variable only has effect if set with \\[customize]." |
90cbf47e GM |
135 | :set (lambda (symbol value) |
136 | (if value | |
9d1137ce GM |
137 | (add-hook 'kill-emacs-query-functions 'timeclock-query-out) |
138 | (remove-hook 'kill-emacs-query-functions 'timeclock-query-out)) | |
90cbf47e GM |
139 | (setq timeclock-ask-before-exiting value)) |
140 | :type 'boolean | |
141 | :group 'timeclock) | |
142 | ||
143 | (defvar timeclock-update-timer nil | |
144 | "The timer used to update `timeclock-mode-string'.") | |
145 | ||
b9c3a97d GM |
146 | ;; For byte-compiler. |
147 | (defvar display-time-hook) | |
37269466 | 148 | (defvar timeclock-mode-line-display) |
b9c3a97d | 149 | |
90cbf47e | 150 | (defcustom timeclock-use-display-time t |
37269466 | 151 | "If non-nil, use `display-time-hook' for doing mode line updates. |
a9dfccd6 | 152 | The advantage of this is that one less timer has to be set running |
44e97401 | 153 | amok in Emacs's process space. The disadvantage is that it requires |
a9dfccd6 | 154 | you to have `display-time' running. If you don't want to use |
37269466 | 155 | `display-time', but still want the mode line to show how much time is |
145570df | 156 | left, set this variable to nil. Changing the value of this variable |
37269466 CY |
157 | while timeclock information is being displayed in the mode line has no |
158 | effect. You should call the function `timeclock-mode-line-display' with | |
145570df | 159 | a positive argument to force an update." |
90cbf47e GM |
160 | :set (lambda (symbol value) |
161 | (let ((currently-displaying | |
37269466 CY |
162 | (and (boundp 'timeclock-mode-line-display) |
163 | timeclock-mode-line-display))) | |
90cbf47e | 164 | ;; if we're changing to the state that |
37269466 | 165 | ;; `timeclock-mode-line-display' is already using, don't |
90cbf47e GM |
166 | ;; bother toggling it. This happens on the initial loading |
167 | ;; of timeclock.el. | |
168 | (if (and currently-displaying | |
169 | (or (and value | |
170 | (boundp 'display-time-hook) | |
37269466 | 171 | (memq 'timeclock-update-mode-line |
90cbf47e GM |
172 | display-time-hook)) |
173 | (and (not value) | |
174 | timeclock-update-timer))) | |
175 | (setq currently-displaying nil)) | |
176 | (and currently-displaying | |
37269466 | 177 | (set-variable 'timeclock-mode-line-display nil)) |
90cbf47e GM |
178 | (setq timeclock-use-display-time value) |
179 | (and currently-displaying | |
37269466 | 180 | (set-variable 'timeclock-mode-line-display t)) |
90cbf47e GM |
181 | timeclock-use-display-time)) |
182 | :type 'boolean | |
183 | :group 'timeclock | |
184 | :require 'time) | |
185 | ||
186 | (defcustom timeclock-first-in-hook nil | |
08f7d912 | 187 | "A hook run for the first \"in\" event each day. |
90cbf47e GM |
188 | Note that this hook is run before recording any events. Thus the |
189 | value of `timeclock-hours-today', `timeclock-last-event' and the | |
190 | return value of function `timeclock-last-period' are relative previous | |
191 | to today." | |
192 | :type 'hook | |
193 | :group 'timeclock) | |
194 | ||
195 | (defcustom timeclock-load-hook nil | |
08f7d912 | 196 | "Hook that gets run after timeclock has been loaded." |
90cbf47e GM |
197 | :type 'hook |
198 | :group 'timeclock) | |
199 | ||
200 | (defcustom timeclock-in-hook nil | |
08f7d912 | 201 | "A hook run every time an \"in\" event is recorded." |
90cbf47e GM |
202 | :type 'hook |
203 | :group 'timeclock) | |
204 | ||
205 | (defcustom timeclock-day-over-hook nil | |
08f7d912 | 206 | "A hook that is run when the workday has been completed. |
4ee3e788 | 207 | This hook is only run if the current time remaining is being displayed |
37269466 | 208 | in the mode line. See the variable `timeclock-mode-line-display'." |
90cbf47e GM |
209 | :type 'hook |
210 | :group 'timeclock) | |
211 | ||
212 | (defcustom timeclock-out-hook nil | |
08f7d912 | 213 | "A hook run every time an \"out\" event is recorded." |
90cbf47e GM |
214 | :type 'hook |
215 | :group 'timeclock) | |
216 | ||
217 | (defcustom timeclock-done-hook nil | |
08f7d912 | 218 | "A hook run every time a project is marked as completed." |
90cbf47e GM |
219 | :type 'hook |
220 | :group 'timeclock) | |
221 | ||
222 | (defcustom timeclock-event-hook nil | |
08f7d912 | 223 | "A hook run every time any event is recorded." |
90cbf47e GM |
224 | :type 'hook |
225 | :group 'timeclock) | |
226 | ||
227 | (defvar timeclock-last-event nil | |
228 | "A list containing the last event that was recorded. | |
dace60cf | 229 | The format of this list is (CODE TIME PROJECT).") |
90cbf47e GM |
230 | |
231 | (defvar timeclock-last-event-workday nil | |
232 | "The number of seconds in the workday of `timeclock-last-event'.") | |
233 | ||
234 | ;;; Internal Variables: | |
235 | ||
236 | (defvar timeclock-discrepancy nil | |
237 | "A variable containing the time discrepancy before the last event. | |
238 | Normally, timeclock assumes that you intend to work for | |
239 | `timeclock-workday' seconds every day. Any days in which you work | |
240 | more or less than this amount is considered either a positive or | |
a9dfccd6 | 241 | a negative discrepancy. If you work in such a manner that the |
90cbf47e GM |
242 | discrepancy is always brought back to zero, then you will by |
243 | definition have worked an average amount equal to `timeclock-workday' | |
244 | each day.") | |
245 | ||
246 | (defvar timeclock-elapsed nil | |
247 | "A variable containing the time elapsed for complete periods today. | |
248 | This value is not accurate enough to be useful by itself. Rather, | |
249 | call `timeclock-workday-elapsed', to determine how much time has been | |
250 | worked so far today. Also, if `timeclock-relative' is nil, this value | |
43f5aea1 JW |
251 | will be the same as `timeclock-discrepancy'.") |
252 | ||
253 | (defvar timeclock-use-elapsed nil | |
37269466 | 254 | "Non-nil if the mode line should display time elapsed, not remaining.") |
90cbf47e GM |
255 | |
256 | (defvar timeclock-last-period nil | |
257 | "Integer representing the number of seconds in the last period. | |
a9dfccd6 EZ |
258 | Note that you shouldn't access this value, but instead should use the |
259 | function `timeclock-last-period'.") | |
90cbf47e GM |
260 | |
261 | (defvar timeclock-mode-string nil | |
37269466 | 262 | "The timeclock string (optionally) displayed in the mode line. |
9d1137ce | 263 | The time is bracketed by <> if you are clocked in, otherwise by [].") |
90cbf47e GM |
264 | |
265 | (defvar timeclock-day-over nil | |
266 | "The date of the last day when notified \"day over\" for.") | |
267 | ||
268 | ;;; User Functions: | |
269 | ||
37269466 | 270 | (define-obsolete-function-alias 'timeclock-modeline-display |
2a1e2476 | 271 | 'timeclock-mode-line-display "24.3") |
37269466 | 272 | |
90cbf47e | 273 | ;;;###autoload |
37269466 CY |
274 | (defun timeclock-mode-line-display (&optional arg) |
275 | "Toggle display of the amount of time left today in the mode line. | |
9d1137ce | 276 | If `timeclock-use-display-time' is non-nil (the default), then |
37269466 | 277 | the function `display-time-mode' must be active, and the mode line |
9d1137ce GM |
278 | will be updated whenever the time display is updated. Otherwise, |
279 | the timeclock will use its own sixty second timer to do its | |
37269466 CY |
280 | updating. With prefix ARG, turn mode line display on if and only |
281 | if ARG is positive. Returns the new status of timeclock mode line | |
9d1137ce | 282 | display (non-nil means on)." |
90cbf47e | 283 | (interactive "P") |
9d1137ce GM |
284 | ;; cf display-time-mode. |
285 | (setq timeclock-mode-string "") | |
286 | (or global-mode-string (setq global-mode-string '(""))) | |
90cbf47e GM |
287 | (let ((on-p (if arg |
288 | (> (prefix-numeric-value arg) 0) | |
37269466 | 289 | (not timeclock-mode-line-display)))) |
90cbf47e | 290 | (if on-p |
9d1137ce GM |
291 | (progn |
292 | (or (memq 'timeclock-mode-string global-mode-string) | |
293 | (setq global-mode-string | |
294 | (append global-mode-string '(timeclock-mode-string)))) | |
37269466 | 295 | (add-hook 'timeclock-event-hook 'timeclock-update-mode-line) |
90cbf47e GM |
296 | (when timeclock-update-timer |
297 | (cancel-timer timeclock-update-timer) | |
298 | (setq timeclock-update-timer nil)) | |
299 | (if (boundp 'display-time-hook) | |
37269466 | 300 | (remove-hook 'display-time-hook 'timeclock-update-mode-line)) |
90cbf47e | 301 | (if timeclock-use-display-time |
9d1137ce GM |
302 | (progn |
303 | ;; Update immediately so there is a visible change | |
304 | ;; on calling this function. | |
37269466 CY |
305 | (if display-time-mode |
306 | (timeclock-update-mode-line) | |
7e285b36 CY |
307 | (message "Activate `display-time-mode' or turn off \ |
308 | `timeclock-use-display-time' to see timeclock information")) | |
37269466 | 309 | (add-hook 'display-time-hook 'timeclock-update-mode-line)) |
90cbf47e | 310 | (setq timeclock-update-timer |
37269466 | 311 | (run-at-time nil 60 'timeclock-update-mode-line)))) |
4ee3e788 | 312 | (setq global-mode-string |
9d1137ce | 313 | (delq 'timeclock-mode-string global-mode-string)) |
37269466 | 314 | (remove-hook 'timeclock-event-hook 'timeclock-update-mode-line) |
90cbf47e GM |
315 | (if (boundp 'display-time-hook) |
316 | (remove-hook 'display-time-hook | |
37269466 | 317 | 'timeclock-update-mode-line)) |
90cbf47e GM |
318 | (when timeclock-update-timer |
319 | (cancel-timer timeclock-update-timer) | |
320 | (setq timeclock-update-timer nil))) | |
321 | (force-mode-line-update) | |
37269466 | 322 | (setq timeclock-mode-line-display on-p))) |
90cbf47e | 323 | |
ef35abb4 GM |
324 | (define-obsolete-variable-alias 'timeclock-modeline-display |
325 | 'timeclock-mode-line-display "24.3") | |
326 | ||
90cbf47e | 327 | ;; This has to be here so that the function definition of |
37269466 CY |
328 | ;; `timeclock-mode-line-display' is known to the "set" function. |
329 | (defcustom timeclock-mode-line-display nil | |
330 | "Toggle mode line display of time remaining. | |
90cbf47e GM |
331 | You must modify via \\[customize] for this variable to have an effect." |
332 | :set (lambda (symbol value) | |
37269466 CY |
333 | (setq timeclock-mode-line-display |
334 | (timeclock-mode-line-display (or value 0)))) | |
90cbf47e GM |
335 | :type 'boolean |
336 | :group 'timeclock | |
337 | :require 'timeclock) | |
338 | ||
b9c3a97d GM |
339 | (defsubst timeclock-time-to-date (time) |
340 | "Convert the TIME value to a textual date string." | |
341 | (format-time-string "%Y/%m/%d" time)) | |
342 | ||
90cbf47e GM |
343 | ;;;###autoload |
344 | (defun timeclock-in (&optional arg project find-project) | |
345 | "Clock in, recording the current time moment in the timelog. | |
346 | With a numeric prefix ARG, record the fact that today has only that | |
fc250015 | 347 | many hours in it to be worked. If ARG is a non-numeric prefix argument |
90cbf47e GM |
348 | \(non-nil, but not a number), 0 is assumed (working on a holiday or |
349 | weekend). *If not called interactively, ARG should be the number of | |
350 | _seconds_ worked today*. This feature only has effect the first time | |
351 | this function is called within a day. | |
352 | ||
a9dfccd6 | 353 | PROJECT is the project being clocked into. If PROJECT is nil, and |
90cbf47e GM |
354 | FIND-PROJECT is non-nil -- or the user calls `timeclock-in' |
355 | interactively -- call the function `timeclock-get-project-function' to | |
356 | discover the name of the project." | |
357 | (interactive | |
358 | (list (and current-prefix-arg | |
359 | (if (numberp current-prefix-arg) | |
360 | (* current-prefix-arg 60 60) | |
361 | 0)))) | |
362 | (if (equal (car timeclock-last-event) "i") | |
363 | (error "You've already clocked in!") | |
364 | (unless timeclock-last-event | |
365 | (timeclock-reread-log)) | |
4105dd52 GM |
366 | ;; Either no log file, or day has rolled over. |
367 | (unless (and timeclock-last-event | |
368 | (equal (timeclock-time-to-date | |
369 | (cadr timeclock-last-event)) | |
370 | (timeclock-time-to-date (current-time)))) | |
90cbf47e GM |
371 | (let ((workday (or (and (numberp arg) arg) |
372 | (and arg 0) | |
373 | (and timeclock-get-workday-function | |
374 | (funcall timeclock-get-workday-function)) | |
375 | timeclock-workday))) | |
376 | (run-hooks 'timeclock-first-in-hook) | |
377 | ;; settle the discrepancy for the new day | |
378 | (setq timeclock-discrepancy | |
4105dd52 | 379 | (- (or timeclock-discrepancy 0) workday)) |
90cbf47e | 380 | (if (not (= workday timeclock-workday)) |
9adcbb0c RS |
381 | (timeclock-log "h" (number-to-string |
382 | (/ workday (if (zerop (% workday (* 60 60))) | |
383 | 60 60.0) 60)))))) | |
90cbf47e GM |
384 | (timeclock-log "i" (or project |
385 | (and timeclock-get-project-function | |
32226619 JB |
386 | (or find-project |
387 | (called-interactively-p 'interactive)) | |
90cbf47e GM |
388 | (funcall timeclock-get-project-function)))) |
389 | (run-hooks 'timeclock-in-hook))) | |
390 | ||
391 | ;;;###autoload | |
392 | (defun timeclock-out (&optional arg reason find-reason) | |
393 | "Clock out, recording the current time moment in the timelog. | |
394 | If a prefix ARG is given, the user has completed the project that was | |
395 | begun during the last time segment. | |
396 | ||
397 | REASON is the user's reason for clocking out. If REASON is nil, and | |
398 | FIND-REASON is non-nil -- or the user calls `timeclock-out' | |
399 | interactively -- call the function `timeclock-get-reason-function' to | |
400 | discover the reason." | |
401 | (interactive "P") | |
9ca8a5a0 EZ |
402 | (or timeclock-last-event |
403 | (error "You haven't clocked in!")) | |
90cbf47e GM |
404 | (if (equal (downcase (car timeclock-last-event)) "o") |
405 | (error "You've already clocked out!") | |
406 | (timeclock-log | |
407 | (if arg "O" "o") | |
408 | (or reason | |
409 | (and timeclock-get-reason-function | |
32226619 | 410 | (or find-reason (called-interactively-p 'interactive)) |
90cbf47e GM |
411 | (funcall timeclock-get-reason-function)))) |
412 | (run-hooks 'timeclock-out-hook) | |
413 | (if arg | |
414 | (run-hooks 'timeclock-done-hook)))) | |
415 | ||
c5e87d10 | 416 | ;; Should today-only be removed in favor of timeclock-relative? - gm |
b9c3a97d GM |
417 | (defsubst timeclock-workday-remaining (&optional today-only) |
418 | "Return the number of seconds until the workday is complete. | |
419 | The amount returned is relative to the value of `timeclock-workday'. | |
420 | If TODAY-ONLY is non-nil, the value returned will be relative only to | |
4ee3e788 | 421 | the time worked today, and not to past time." |
b9c3a97d GM |
422 | (let ((discrep (timeclock-find-discrep))) |
423 | (if discrep | |
4ee3e788 GM |
424 | (- (if today-only (cadr discrep) |
425 | (car discrep))) | |
b9c3a97d GM |
426 | 0.0))) |
427 | ||
90cbf47e GM |
428 | ;;;###autoload |
429 | (defun timeclock-status-string (&optional show-seconds today-only) | |
4ee3e788 GM |
430 | "Report the overall timeclock status at the present moment. |
431 | If SHOW-SECONDS is non-nil, display second resolution. | |
432 | If TODAY-ONLY is non-nil, the display will be relative only to time | |
433 | worked today, ignoring the time worked on previous days." | |
90cbf47e | 434 | (interactive "P") |
43f5aea1 JW |
435 | (let ((remainder (timeclock-workday-remaining |
436 | (or today-only | |
437 | (not timeclock-relative)))) | |
b9c3a97d GM |
438 | (last-in (equal (car timeclock-last-event) "i")) |
439 | status) | |
90cbf47e GM |
440 | (setq status |
441 | (format "Currently %s since %s (%s), %s %s, leave at %s" | |
442 | (if last-in "IN" "OUT") | |
443 | (if show-seconds | |
444 | (format-time-string "%-I:%M:%S %p" | |
445 | (nth 1 timeclock-last-event)) | |
446 | (format-time-string "%-I:%M %p" | |
447 | (nth 1 timeclock-last-event))) | |
448 | (or (nth 2 timeclock-last-event) | |
449 | (if last-in "**UNKNOWN**" "workday over")) | |
450 | (timeclock-seconds-to-string remainder show-seconds t) | |
451 | (if (> remainder 0) | |
452 | "remaining" "over") | |
453 | (timeclock-when-to-leave-string show-seconds today-only))) | |
32226619 | 454 | (if (called-interactively-p 'interactive) |
80070cca | 455 | (message "%s" status) |
90cbf47e GM |
456 | status))) |
457 | ||
458 | ;;;###autoload | |
459 | (defun timeclock-change (&optional arg project) | |
a9dfccd6 EZ |
460 | "Change to working on a different project. |
461 | This clocks out of the current project, then clocks in on a new one. | |
462 | With a prefix ARG, consider the previous project as finished at the | |
463 | time of changeover. PROJECT is the name of the last project you were | |
464 | working on." | |
90cbf47e GM |
465 | (interactive "P") |
466 | (timeclock-out arg) | |
32226619 | 467 | (timeclock-in nil project (called-interactively-p 'interactive))) |
90cbf47e GM |
468 | |
469 | ;;;###autoload | |
470 | (defun timeclock-query-out () | |
a9dfccd6 | 471 | "Ask the user whether to clock out. |
9d1137ce | 472 | This is a useful function for adding to `kill-emacs-query-functions'." |
b9c3a97d GM |
473 | (and (equal (car timeclock-last-event) "i") |
474 | (y-or-n-p "You're currently clocking time, clock out? ") | |
475 | (timeclock-out)) | |
476 | ;; Unconditionally return t for `kill-emacs-query-functions'. | |
477 | t) | |
90cbf47e GM |
478 | |
479 | ;;;###autoload | |
480 | (defun timeclock-reread-log () | |
481 | "Re-read the timeclock, to account for external changes. | |
482 | Returns the new value of `timeclock-discrepancy'." | |
483 | (interactive) | |
484 | (setq timeclock-discrepancy nil) | |
485 | (timeclock-find-discrep) | |
37269466 CY |
486 | (if (and timeclock-discrepancy timeclock-mode-line-display) |
487 | (timeclock-update-mode-line)) | |
90cbf47e GM |
488 | timeclock-discrepancy) |
489 | ||
490 | (defun timeclock-seconds-to-string (seconds &optional show-seconds | |
491 | reverse-leader) | |
492 | "Convert SECONDS into a compact time string. | |
493 | If SHOW-SECONDS is non-nil, make the resolution of the return string | |
494 | include the second count. If REVERSE-LEADER is non-nil, it means to | |
495 | output a \"+\" if the time value is negative, rather than a \"-\". | |
496 | This is used when negative time values have an inverted meaning (such | |
497 | as with time remaining, where negative time really means overtime)." | |
498 | (if show-seconds | |
499 | (format "%s%d:%02d:%02d" | |
500 | (if (< seconds 0) (if reverse-leader "+" "-") "") | |
501 | (truncate (/ (abs seconds) 60 60)) | |
502 | (% (truncate (/ (abs seconds) 60)) 60) | |
503 | (% (truncate (abs seconds)) 60)) | |
504 | (format "%s%d:%02d" | |
505 | (if (< seconds 0) (if reverse-leader "+" "-") "") | |
506 | (truncate (/ (abs seconds) 60 60)) | |
507 | (% (truncate (/ (abs seconds) 60)) 60)))) | |
508 | ||
dace60cf | 509 | (defsubst timeclock-currently-in-p () |
90cbf47e GM |
510 | "Return non-nil if the user is currently clocked in." |
511 | (equal (car timeclock-last-event) "i")) | |
512 | ||
513 | ;;;###autoload | |
514 | (defun timeclock-workday-remaining-string (&optional show-seconds | |
515 | today-only) | |
516 | "Return a string representing the amount of time left today. | |
517 | Display second resolution if SHOW-SECONDS is non-nil. If TODAY-ONLY | |
518 | is non-nil, the display will be relative only to time worked today. | |
519 | See `timeclock-relative' for more information about the meaning of | |
520 | \"relative to today\"." | |
521 | (interactive) | |
522 | (let ((string (timeclock-seconds-to-string | |
523 | (timeclock-workday-remaining today-only) | |
524 | show-seconds t))) | |
32226619 | 525 | (if (called-interactively-p 'interactive) |
80070cca | 526 | (message "%s" string) |
90cbf47e GM |
527 | string))) |
528 | ||
1c8c9fb8 | 529 | (defsubst timeclock-workday-elapsed () |
69a04106 | 530 | "Return the number of seconds worked so far today. |
90cbf47e GM |
531 | If RELATIVE is non-nil, the amount returned will be relative to past |
532 | time worked. The default is to return only the time that has elapsed | |
533 | so far today." | |
1c8c9fb8 JW |
534 | (let ((discrep (timeclock-find-discrep))) |
535 | (if discrep | |
536 | (nth 2 discrep) | |
537 | 0.0))) | |
90cbf47e GM |
538 | |
539 | ;;;###autoload | |
1c8c9fb8 | 540 | (defun timeclock-workday-elapsed-string (&optional show-seconds) |
90cbf47e GM |
541 | "Return a string representing the amount of time worked today. |
542 | Display seconds resolution if SHOW-SECONDS is non-nil. If RELATIVE is | |
543 | non-nil, the amount returned will be relative to past time worked." | |
544 | (interactive) | |
1c8c9fb8 JW |
545 | (let ((string (timeclock-seconds-to-string (timeclock-workday-elapsed) |
546 | show-seconds))) | |
32226619 | 547 | (if (called-interactively-p 'interactive) |
80070cca | 548 | (message "%s" string) |
90cbf47e GM |
549 | string))) |
550 | ||
6f0d4bb6 GM |
551 | (defalias 'timeclock-time-to-seconds (if (fboundp 'float-time) 'float-time |
552 | 'time-to-seconds)) | |
b9c3a97d | 553 | |
5777162a | 554 | (defalias 'timeclock-seconds-to-time 'seconds-to-time) |
b9c3a97d | 555 | |
c5e87d10 | 556 | ;; Should today-only be removed in favor of timeclock-relative? - gm |
dace60cf | 557 | (defsubst timeclock-when-to-leave (&optional today-only) |
a9dfccd6 | 558 | "Return a time value representing the end of today's workday. |
90cbf47e | 559 | If TODAY-ONLY is non-nil, the value returned will be relative only to |
4ee3e788 | 560 | the time worked today, and not to past time." |
90cbf47e GM |
561 | (timeclock-seconds-to-time |
562 | (- (timeclock-time-to-seconds (current-time)) | |
1c8c9fb8 JW |
563 | (let ((discrep (timeclock-find-discrep))) |
564 | (if discrep | |
565 | (if today-only | |
566 | (cadr discrep) | |
567 | (car discrep)) | |
568 | 0.0))))) | |
90cbf47e GM |
569 | |
570 | ;;;###autoload | |
571 | (defun timeclock-when-to-leave-string (&optional show-seconds | |
572 | today-only) | |
a9dfccd6 | 573 | "Return a string representing the end of today's workday. |
90cbf47e | 574 | This string is relative to the value of `timeclock-workday'. If |
4ee3e788 GM |
575 | SHOW-SECONDS is non-nil, the value printed/returned will include |
576 | seconds. If TODAY-ONLY is non-nil, the value returned will be | |
577 | relative only to the time worked today, and not to past time." | |
c5e87d10 | 578 | ;; Should today-only be removed in favor of timeclock-relative? - gm |
90cbf47e GM |
579 | (interactive) |
580 | (let* ((then (timeclock-when-to-leave today-only)) | |
581 | (string | |
582 | (if show-seconds | |
583 | (format-time-string "%-I:%M:%S %p" then) | |
584 | (format-time-string "%-I:%M %p" then)))) | |
32226619 | 585 | (if (called-interactively-p 'interactive) |
80070cca | 586 | (message "%s" string) |
90cbf47e GM |
587 | string))) |
588 | ||
7e285b36 CY |
589 | (defun timeclock-make-hours-explicit (old-default) |
590 | "Specify all workday lengths in `timeclock-file'. | |
591 | OLD-DEFAULT hours are set for every day that has no number indicated." | |
592 | (interactive "P") | |
593 | (if old-default (setq old-default (prefix-numeric-value old-default)) | |
fc250015 | 594 | (error "`timelog-make-hours-explicit' requires an explicit argument")) |
7e285b36 CY |
595 | (let ((extant-timelog (find-buffer-visiting timeclock-file)) |
596 | current-date) | |
597 | (with-current-buffer (find-file-noselect timeclock-file t) | |
598 | (unwind-protect | |
599 | (save-excursion | |
600 | (save-restriction | |
601 | (widen) | |
602 | (goto-char (point-min)) | |
603 | (while (progn (skip-chars-forward "\n") (not (eobp))) | |
604 | ;; This is just a variant of `timeclock-moment-regexp'. | |
605 | (unless (looking-at | |
606 | (concat "^\\([bhioO]\\) \\([0-9]+/[0-9]+/[0-9]+\\) " | |
607 | "\\([0-9]+:[0-9]+:[0-9]+\\)")) | |
608 | (error "Can't parse `%s'" timeclock-file)) | |
609 | (let ((this-date (match-string 2))) | |
610 | (unless (or (and current-date | |
611 | (string= this-date current-date)) | |
612 | (string= (match-string 1) "h")) | |
613 | (insert (format "h %s %s %s\n" (match-string 2) | |
614 | (match-string 3) old-default))) | |
615 | (if (string-match "^[ih]" (match-string 1)) ; ignore logouts | |
616 | (setq current-date this-date))) | |
617 | (forward-line)) | |
618 | (save-buffer))) | |
619 | (unless extant-timelog (kill-buffer (current-buffer))))))) | |
620 | ||
90cbf47e GM |
621 | ;;; Internal Functions: |
622 | ||
623 | (defvar timeclock-project-list nil) | |
624 | (defvar timeclock-last-project nil) | |
625 | ||
978bd3ea | 626 | (defun timeclock-completing-read (prompt alist &optional default) |
fc250015 GM |
627 | "A version of `completing-read' that works on both Emacs and XEmacs. |
628 | PROMPT, ALIST and DEFAULT are used for the PROMPT, COLLECTION and DEF | |
629 | arguments of `completing-read'." | |
978bd3ea JW |
630 | (if (featurep 'xemacs) |
631 | (let ((str (completing-read prompt alist))) | |
55dfee43 | 632 | (if (or (null str) (zerop (length str))) |
978bd3ea JW |
633 | default |
634 | str)) | |
635 | (completing-read prompt alist nil nil nil nil default))) | |
636 | ||
90cbf47e GM |
637 | (defun timeclock-ask-for-project () |
638 | "Ask the user for the project they are clocking into." | |
978bd3ea | 639 | (timeclock-completing-read |
5b76833f | 640 | (format "Clock into which project (default %s): " |
978bd3ea JW |
641 | (or timeclock-last-project |
642 | (car timeclock-project-list))) | |
643 | (mapcar 'list timeclock-project-list) | |
644 | (or timeclock-last-project | |
645 | (car timeclock-project-list)))) | |
90cbf47e GM |
646 | |
647 | (defvar timeclock-reason-list nil) | |
648 | ||
649 | (defun timeclock-ask-for-reason () | |
650 | "Ask the user for the reason they are clocking out." | |
978bd3ea JW |
651 | (timeclock-completing-read "Reason for clocking out: " |
652 | (mapcar 'list timeclock-reason-list))) | |
90cbf47e | 653 | |
37269466 | 654 | (define-obsolete-function-alias 'timeclock-update-modeline |
2a1e2476 | 655 | 'timeclock-update-mode-line "24.3") |
37269466 CY |
656 | |
657 | (defun timeclock-update-mode-line () | |
658 | "Update the `timeclock-mode-string' displayed in the mode line. | |
4ee3e788 GM |
659 | The value of `timeclock-relative' affects the display as described in |
660 | that variable's documentation." | |
90cbf47e | 661 | (interactive) |
43f5aea1 JW |
662 | (let ((remainder |
663 | (if timeclock-use-elapsed | |
664 | (timeclock-workday-elapsed) | |
665 | (timeclock-workday-remaining (not timeclock-relative)))) | |
9d1137ce | 666 | (last-in (equal (car timeclock-last-event) "i"))) |
90cbf47e GM |
667 | (when (and (< remainder 0) |
668 | (not (and timeclock-day-over | |
669 | (equal timeclock-day-over | |
670 | (timeclock-time-to-date | |
671 | (current-time)))))) | |
672 | (setq timeclock-day-over | |
673 | (timeclock-time-to-date (current-time))) | |
674 | (run-hooks 'timeclock-day-over-hook)) | |
675 | (setq timeclock-mode-string | |
9d1137ce GM |
676 | (propertize |
677 | (format " %c%s%c " | |
678 | (if last-in ?< ?[) | |
679 | (timeclock-seconds-to-string remainder nil t) | |
680 | (if last-in ?> ?])) | |
681 | 'help-echo "timeclock: time remaining")))) | |
682 | ||
683 | (put 'timeclock-mode-string 'risky-local-variable t) | |
90cbf47e GM |
684 | |
685 | (defun timeclock-log (code &optional project) | |
686 | "Log the event CODE to the timeclock log, at the time of call. | |
687 | If PROJECT is a string, it represents the project which the event is | |
dace60cf | 688 | being logged for. Normally only \"in\" events specify a project." |
9adcbb0c | 689 | (let ((extant-timelog (find-buffer-visiting timeclock-file))) |
7e285b36 | 690 | (with-current-buffer (find-file-noselect timeclock-file t) |
9adcbb0c RS |
691 | (save-excursion |
692 | (save-restriction | |
693 | (widen) | |
694 | (goto-char (point-max)) | |
695 | (if (not (bolp)) | |
696 | (insert "\n")) | |
697 | (let ((now (current-time))) | |
698 | (insert code " " | |
699 | (format-time-string "%Y/%m/%d %H:%M:%S" now) | |
7e285b36 | 700 | (or (and (stringp project) |
9adcbb0c RS |
701 | (> (length project) 0) |
702 | (concat " " project)) | |
703 | "") | |
704 | "\n") | |
705 | (if (equal (downcase code) "o") | |
706 | (setq timeclock-last-period | |
707 | (- (timeclock-time-to-seconds now) | |
708 | (timeclock-time-to-seconds | |
709 | (cadr timeclock-last-event))) | |
710 | timeclock-discrepancy | |
711 | (+ timeclock-discrepancy | |
712 | timeclock-last-period))) | |
713 | (setq timeclock-last-event (list code now project))))) | |
714 | (save-buffer) | |
7e285b36 CY |
715 | (unless extant-timelog (kill-buffer (current-buffer))))) |
716 | (run-hooks 'timeclock-event-hook)) | |
90cbf47e | 717 | |
dace60cf JW |
718 | (defvar timeclock-moment-regexp |
719 | (concat "\\([bhioO]\\)\\s-+" | |
720 | "\\([0-9]+\\)/\\([0-9]+\\)/\\([0-9]+\\)\\s-+" | |
721 | "\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\)[ \t]*" "\\([^\n]*\\)")) | |
722 | ||
723 | (defsubst timeclock-read-moment () | |
90cbf47e | 724 | "Read the moment under point from the timelog." |
dace60cf JW |
725 | (if (looking-at timeclock-moment-regexp) |
726 | (let ((code (match-string 1)) | |
727 | (year (string-to-number (match-string 2))) | |
728 | (mon (string-to-number (match-string 3))) | |
729 | (mday (string-to-number (match-string 4))) | |
730 | (hour (string-to-number (match-string 5))) | |
731 | (min (string-to-number (match-string 6))) | |
732 | (sec (string-to-number (match-string 7))) | |
733 | (project (match-string 8))) | |
734 | (list code (encode-time sec min hour mday mon year) project)))) | |
735 | ||
90cbf47e GM |
736 | (defun timeclock-last-period (&optional moment) |
737 | "Return the value of the last event period. | |
738 | If the last event was a clock-in, the period will be open ended, and | |
739 | growing every second. Otherwise, it is a fixed amount which has been | |
740 | recorded to disk. If MOMENT is non-nil, use that as the current time. | |
741 | This is only provided for coherency when used by | |
742 | `timeclock-discrepancy'." | |
743 | (if (equal (car timeclock-last-event) "i") | |
744 | (- (timeclock-time-to-seconds (or moment (current-time))) | |
745 | (timeclock-time-to-seconds | |
746 | (cadr timeclock-last-event))) | |
747 | timeclock-last-period)) | |
748 | ||
dace60cf | 749 | (defsubst timeclock-entry-length (entry) |
fc250015 | 750 | "Return the length of ENTRY in seconds." |
dace60cf JW |
751 | (- (timeclock-time-to-seconds (cadr entry)) |
752 | (timeclock-time-to-seconds (car entry)))) | |
753 | ||
754 | (defsubst timeclock-entry-begin (entry) | |
fc250015 | 755 | "Return the start time of ENTRY." |
dace60cf JW |
756 | (car entry)) |
757 | ||
758 | (defsubst timeclock-entry-end (entry) | |
fc250015 | 759 | "Return the end time of ENTRY." |
dace60cf JW |
760 | (cadr entry)) |
761 | ||
762 | (defsubst timeclock-entry-project (entry) | |
fc250015 | 763 | "Return the project of ENTRY." |
dace60cf JW |
764 | (nth 2 entry)) |
765 | ||
766 | (defsubst timeclock-entry-comment (entry) | |
fc250015 | 767 | "Return the comment of ENTRY." |
dace60cf JW |
768 | (nth 3 entry)) |
769 | ||
dace60cf | 770 | (defsubst timeclock-entry-list-length (entry-list) |
fc250015 | 771 | "Return the total length of ENTRY-LIST in seconds." |
dace60cf | 772 | (let ((length 0)) |
fc250015 GM |
773 | (dolist (entry entry-list) |
774 | (setq length (+ length (timeclock-entry-length entry)))) | |
dace60cf JW |
775 | length)) |
776 | ||
777 | (defsubst timeclock-entry-list-begin (entry-list) | |
fc250015 | 778 | "Return the start time of the first element of ENTRY-LIST." |
dace60cf JW |
779 | (timeclock-entry-begin (car entry-list))) |
780 | ||
781 | (defsubst timeclock-entry-list-end (entry-list) | |
fc250015 | 782 | "Return the end time of the last element of ENTRY-LIST." |
dace60cf JW |
783 | (timeclock-entry-end (car (last entry-list)))) |
784 | ||
785 | (defsubst timeclock-entry-list-span (entry-list) | |
fc250015 | 786 | "Return the total time in seconds spanned by ENTRY-LIST." |
dace60cf JW |
787 | (- (timeclock-time-to-seconds (timeclock-entry-list-end entry-list)) |
788 | (timeclock-time-to-seconds (timeclock-entry-list-begin entry-list)))) | |
789 | ||
790 | (defsubst timeclock-entry-list-break (entry-list) | |
fc250015 | 791 | "Return the total break time (span - length) in ENTRY-LIST." |
dace60cf JW |
792 | (- (timeclock-entry-list-span entry-list) |
793 | (timeclock-entry-list-length entry-list))) | |
794 | ||
795 | (defsubst timeclock-entry-list-projects (entry-list) | |
fc250015 GM |
796 | "Return a list of all the projects in ENTRY-LIST." |
797 | (let (projects proj) | |
798 | (dolist (entry entry-list) | |
799 | (setq proj (timeclock-entry-project entry)) | |
800 | (if projects | |
801 | (add-to-list 'projects proj) | |
802 | (setq projects (list proj)))) | |
dace60cf JW |
803 | projects)) |
804 | ||
dace60cf | 805 | (defsubst timeclock-day-required (day) |
fc250015 | 806 | "Return the required length of DAY in seconds, default `timeclock-workday'." |
3dc630b9 | 807 | (or (car day) timeclock-workday)) |
dace60cf JW |
808 | |
809 | (defsubst timeclock-day-length (day) | |
fc250015 | 810 | "Return the actual length of DAY in seconds." |
dace60cf JW |
811 | (timeclock-entry-list-length (cdr day))) |
812 | ||
813 | (defsubst timeclock-day-debt (day) | |
fc250015 | 814 | "Return the debt (required - actual) associated with DAY, in seconds." |
dace60cf JW |
815 | (- (timeclock-day-required day) |
816 | (timeclock-day-length day))) | |
817 | ||
818 | (defsubst timeclock-day-begin (day) | |
fc250015 | 819 | "Return the start time of DAY." |
dace60cf JW |
820 | (timeclock-entry-list-begin (cdr day))) |
821 | ||
822 | (defsubst timeclock-day-end (day) | |
fc250015 | 823 | "Return the end time of DAY." |
dace60cf JW |
824 | (timeclock-entry-list-end (cdr day))) |
825 | ||
826 | (defsubst timeclock-day-span (day) | |
fc250015 | 827 | "Return the span of DAY." |
dace60cf JW |
828 | (timeclock-entry-list-span (cdr day))) |
829 | ||
830 | (defsubst timeclock-day-break (day) | |
fc250015 | 831 | "Return the total break time of DAY." |
dace60cf JW |
832 | (timeclock-entry-list-break (cdr day))) |
833 | ||
834 | (defsubst timeclock-day-projects (day) | |
fc250015 | 835 | "Return a list of all the projects in DAY." |
1661df02 | 836 | (timeclock-entry-list-projects (cddr day))) |
dace60cf JW |
837 | |
838 | (defmacro timeclock-day-list-template (func) | |
fc250015 | 839 | "Template for summing the result of FUNC on each element of DAY-LIST." |
dace60cf JW |
840 | `(let ((length 0)) |
841 | (while day-list | |
55dfee43 GM |
842 | (setq length (+ length (,(eval func) (car day-list))) |
843 | day-list (cdr day-list))) | |
dace60cf JW |
844 | length)) |
845 | ||
846 | (defun timeclock-day-list-required (day-list) | |
fc250015 | 847 | "Return total required length of DAY-LIST, in seconds." |
dace60cf JW |
848 | (timeclock-day-list-template 'timeclock-day-required)) |
849 | ||
850 | (defun timeclock-day-list-length (day-list) | |
fc250015 | 851 | "Return actual length of DAY-LIST, in seconds." |
dace60cf JW |
852 | (timeclock-day-list-template 'timeclock-day-length)) |
853 | ||
854 | (defun timeclock-day-list-debt (day-list) | |
fc250015 | 855 | "Return total debt (required - actual) of DAY-LIST." |
dace60cf JW |
856 | (timeclock-day-list-template 'timeclock-day-debt)) |
857 | ||
858 | (defsubst timeclock-day-list-begin (day-list) | |
fc250015 | 859 | "Return the start time of DAY-LIST." |
dace60cf JW |
860 | (timeclock-day-begin (car day-list))) |
861 | ||
862 | (defsubst timeclock-day-list-end (day-list) | |
fc250015 | 863 | "Return the end time of DAY-LIST." |
dace60cf JW |
864 | (timeclock-day-end (car (last day-list)))) |
865 | ||
866 | (defun timeclock-day-list-span (day-list) | |
fc250015 | 867 | "Return the span of DAY-LIST." |
dace60cf JW |
868 | (timeclock-day-list-template 'timeclock-day-span)) |
869 | ||
870 | (defun timeclock-day-list-break (day-list) | |
fc250015 | 871 | "Return the total break of DAY-LIST." |
dace60cf JW |
872 | (timeclock-day-list-template 'timeclock-day-break)) |
873 | ||
874 | (defun timeclock-day-list-projects (day-list) | |
fc250015 | 875 | "Return a list of all the projects in DAY-LIST." |
dace60cf | 876 | (let (projects) |
fc250015 GM |
877 | (dolist (day day-list) |
878 | (dolist (proj (timeclock-day-projects day)) | |
879 | (if projects | |
880 | (add-to-list 'projects proj) | |
881 | (setq projects (list proj))))) | |
dace60cf JW |
882 | projects)) |
883 | ||
dace60cf | 884 | (defsubst timeclock-current-debt (&optional log-data) |
fc250015 | 885 | "Return the seconds debt from LOG-DATA, default `timeclock-log-data'." |
dace60cf JW |
886 | (nth 0 (or log-data (timeclock-log-data)))) |
887 | ||
888 | (defsubst timeclock-day-alist (&optional log-data) | |
fc250015 | 889 | "Return the date alist from LOG-DATA, default `timeclock-log-data'." |
dace60cf JW |
890 | (nth 1 (or log-data (timeclock-log-data)))) |
891 | ||
892 | (defun timeclock-day-list (&optional log-data) | |
fc250015 GM |
893 | "Return a list of the cdrs of the date alist from LOG-DATA." |
894 | (let (day-list) | |
895 | (dolist (date-list (timeclock-day-alist log-data)) | |
896 | (setq day-list (cons (cdr date-list) day-list))) | |
dace60cf JW |
897 | day-list)) |
898 | ||
899 | (defsubst timeclock-project-alist (&optional log-data) | |
fc250015 | 900 | "Return the project alist from LOG-DATA, default `timeclock-log-data'." |
dace60cf JW |
901 | (nth 2 (or log-data (timeclock-log-data)))) |
902 | ||
dace60cf JW |
903 | (defun timeclock-log-data (&optional recent-only filename) |
904 | "Return the contents of the timelog file, in a useful format. | |
4ee3e788 GM |
905 | If the optional argument RECENT-ONLY is non-nil, only show the contents |
906 | from the last point where the time debt (see below) was set. | |
907 | If the optional argument FILENAME is non-nil, it is used instead of | |
908 | the file specified by `timeclock-file.' | |
909 | ||
dace60cf JW |
910 | A timelog contains data in the form of a single entry per line. |
911 | Each entry has the form: | |
912 | ||
913 | CODE YYYY/MM/DD HH:MM:SS [COMMENT] | |
914 | ||
915 | CODE is one of: b, h, i, o or O. COMMENT is optional when the code is | |
916 | i, o or O. The meanings of the codes are: | |
917 | ||
918 | b Set the current time balance, or \"time debt\". Useful when | |
919 | archiving old log data, when a debt must be carried forward. | |
920 | The COMMENT here is the number of seconds of debt. | |
921 | ||
922 | h Set the required working time for the given day. This must | |
923 | be the first entry for that day. The COMMENT in this case is | |
a9dfccd6 EZ |
924 | the number of hours in this workday. Floating point amounts |
925 | are allowed. | |
dace60cf JW |
926 | |
927 | i Clock in. The COMMENT in this case should be the name of the | |
928 | project worked on. | |
929 | ||
930 | o Clock out. COMMENT is unnecessary, but can be used to provide | |
931 | a description of how the period went, for example. | |
932 | ||
933 | O Final clock out. Whatever project was being worked on, it is | |
934 | now finished. Useful for creating summary reports. | |
935 | ||
936 | When this function is called, it will return a data structure with the | |
937 | following format: | |
938 | ||
939 | (DEBT ENTRIES-BY-DAY ENTRIES-BY-PROJECT) | |
940 | ||
941 | DEBT is a floating point number representing the number of seconds | |
942 | \"owed\" before any work was done. For a new file (one without a 'b' | |
943 | entry), this is always zero. | |
944 | ||
945 | The two entries lists have similar formats. They are both alists, | |
946 | where the CAR is the index, and the CDR is a list of time entries. | |
947 | For ENTRIES-BY-DAY, the CAR is a textual date string, of the form | |
948 | YYYY/MM/DD. For ENTRIES-BY-PROJECT, it is the name of the project | |
949 | worked on, or t for the default project. | |
950 | ||
951 | The CDR for ENTRIES-BY-DAY is slightly different than for | |
952 | ENTRIES-BY-PROJECT. It has the following form: | |
953 | ||
954 | (DAY-LENGTH TIME-ENTRIES...) | |
955 | ||
956 | For ENTRIES-BY-PROJECT, there is no DAY-LENGTH member. It is simply a | |
957 | list of TIME-ENTRIES. Note that if DAY-LENGTH is nil, it means | |
958 | whatever is the default should be used. | |
959 | ||
960 | A TIME-ENTRY is a recorded time interval. It has the following format | |
961 | \(although generally one does not have to manipulate these entries | |
962 | directly; see below): | |
963 | ||
964 | (BEGIN-TIME END-TIME PROJECT [COMMENT] [FINAL-P]) | |
965 | ||
966 | Anyway, suffice it to say there are a lot of structures. Typically | |
967 | the user is expected to manipulate to the day(s) or project(s) that he | |
968 | or she wants, at which point the following helper functions may be | |
969 | used: | |
970 | ||
971 | timeclock-day-required | |
972 | timeclock-day-length | |
973 | timeclock-day-debt | |
974 | timeclock-day-begin | |
975 | timeclock-day-end | |
976 | timeclock-day-span | |
977 | timeclock-day-break | |
978 | timeclock-day-projects | |
979 | ||
980 | timeclock-day-list-required | |
981 | timeclock-day-list-length | |
982 | timeclock-day-list-debt | |
983 | timeclock-day-list-begin | |
984 | timeclock-day-list-end | |
985 | timeclock-day-list-span | |
986 | timeclock-day-list-break | |
987 | timeclock-day-list-projects | |
988 | ||
989 | timeclock-entry-length | |
990 | timeclock-entry-begin | |
991 | timeclock-entry-end | |
992 | timeclock-entry-project | |
993 | timeclock-entry-comment | |
994 | ||
995 | timeclock-entry-list-length | |
996 | timeclock-entry-list-begin | |
997 | timeclock-entry-list-end | |
998 | timeclock-entry-list-span | |
999 | timeclock-entry-list-break | |
1000 | timeclock-entry-list-projects | |
1001 | ||
1002 | A few comments should make the use of the above functions obvious: | |
1003 | ||
1004 | `required' is the amount of time that must be spent during a day, or | |
1005 | sequence of days, in order to have no debt. | |
1006 | ||
1007 | `length' is the actual amount of time that was spent. | |
1008 | ||
1009 | `debt' is the difference between required time and length. A | |
1010 | negative debt signifies overtime. | |
1011 | ||
1012 | `begin' is the earliest moment at which work began. | |
1013 | ||
1014 | `end' is the final moment work was done. | |
1015 | ||
1016 | `span' is the difference between begin and end. | |
1017 | ||
1018 | `break' is the difference between span and length. | |
1019 | ||
1020 | `project' is the project that was worked on, and `projects' is a | |
1021 | list of all the projects that were worked on during a given period. | |
1022 | ||
1023 | `comment', where it applies, could mean anything. | |
1024 | ||
1025 | There are a few more functions available, for locating day and entry | |
1026 | lists: | |
1027 | ||
1028 | timeclock-day-alist LOG-DATA | |
1029 | timeclock-project-alist LOG-DATA | |
1030 | timeclock-current-debt LOG-DATA | |
1031 | ||
1032 | See the documentation for the given function if more info is needed." | |
a3961c3e GM |
1033 | (let ((log-data (list 0.0 nil nil)) |
1034 | (now (current-time)) | |
1035 | last-date-limited last-date-seconds last-date | |
1036 | (line 0) last beg day entry event) | |
dace60cf JW |
1037 | (with-temp-buffer |
1038 | (insert-file-contents (or filename timeclock-file)) | |
1039 | (when recent-only | |
1040 | (goto-char (point-max)) | |
1041 | (unless (re-search-backward "^b\\s-+" nil t) | |
1042 | (goto-char (point-min)))) | |
1043 | (while (or (setq event (timeclock-read-moment)) | |
1044 | (and beg (not last) | |
1045 | (setq last t event (list "o" now)))) | |
1046 | (setq line (1+ line)) | |
1047 | (cond ((equal (car event) "b") | |
1048 | (setcar log-data (string-to-number (nth 2 event)))) | |
1049 | ((equal (car event) "h") | |
1050 | (setq last-date-limited (timeclock-time-to-date (cadr event)) | |
1051 | last-date-seconds (* (string-to-number (nth 2 event)) | |
1052 | 3600.0))) | |
1053 | ((equal (car event) "i") | |
1054 | (if beg | |
1055 | (error "Error in format of timelog file, line %d" line) | |
1056 | (setq beg t)) | |
1057 | (setq entry (list (cadr event) nil | |
1058 | (and (> (length (nth 2 event)) 0) | |
1059 | (nth 2 event)))) | |
1060 | (let ((date (timeclock-time-to-date (cadr event)))) | |
1061 | (if (and last-date | |
1062 | (not (equal date last-date))) | |
9329ea14 JW |
1063 | (progn |
1064 | (setcar (cdr log-data) | |
1065 | (cons (cons last-date day) | |
1066 | (cadr log-data))) | |
1067 | (setq day (list (and last-date-limited | |
1068 | last-date-seconds)))) | |
1069 | (unless day | |
1070 | (setq day (list (and last-date-limited | |
1071 | last-date-seconds))))) | |
dace60cf JW |
1072 | (setq last-date date |
1073 | last-date-limited nil))) | |
1074 | ((equal (downcase (car event)) "o") | |
1075 | (if (not beg) | |
1076 | (error "Error in format of timelog file, line %d" line) | |
1077 | (setq beg nil)) | |
1078 | (setcar (cdr entry) (cadr event)) | |
1079 | (let ((desc (and (> (length (nth 2 event)) 0) | |
1080 | (nth 2 event)))) | |
1081 | (if desc | |
1082 | (nconc entry (list (nth 2 event)))) | |
1083 | (if (equal (car event) "O") | |
1084 | (nconc entry (if desc | |
1085 | (list t) | |
1086 | (list nil t)))) | |
1087 | (nconc day (list entry)) | |
1088 | (setq desc (nth 2 entry)) | |
1089 | (let ((proj (assoc desc (nth 2 log-data)))) | |
9329ea14 | 1090 | (if (null proj) |
dace60cf JW |
1091 | (setcar (cddr log-data) |
1092 | (cons (cons desc (list entry)) | |
55dfee43 | 1093 | (nth 2 log-data))) |
dace60cf JW |
1094 | (nconc (cdr proj) (list entry))))))) |
1095 | (forward-line)) | |
1096 | (if day | |
1097 | (setcar (cdr log-data) | |
1098 | (cons (cons last-date day) | |
1099 | (cadr log-data)))) | |
1100 | log-data))) | |
1101 | ||
1c8c9fb8 | 1102 | (defun timeclock-find-discrep () |
4ee3e788 GM |
1103 | "Calculate time discrepancies, in seconds. |
1104 | The result is a three element list, containing the total time | |
1105 | discrepancy, today's discrepancy, and the time worked today." | |
dace60cf JW |
1106 | ;; This is not implemented in terms of the functions above, because |
1107 | ;; it's a bit wasteful to read all of that data in, just to throw | |
1108 | ;; away more than 90% of the information afterwards. | |
3dc630b9 JW |
1109 | ;; |
1110 | ;; If it were implemented using those functions, it would look | |
1111 | ;; something like this: | |
1112 | ;; (let ((days (timeclock-day-alist (timeclock-log-data))) | |
1113 | ;; (total 0.0)) | |
1114 | ;; (while days | |
1115 | ;; (setq total (+ total (- (timeclock-day-length (cdar days)) | |
1116 | ;; (timeclock-day-required (cdar days)))) | |
1117 | ;; days (cdr days))) | |
1118 | ;; total) | |
1119 | (let* ((now (current-time)) | |
1120 | (todays-date (timeclock-time-to-date now)) | |
4bd0908b | 1121 | (first t) (accum 0) (elapsed 0) |
a3961c3e | 1122 | event beg last-date |
3dc630b9 JW |
1123 | last-date-limited last-date-seconds) |
1124 | (unless timeclock-discrepancy | |
1125 | (when (file-readable-p timeclock-file) | |
9329ea14 JW |
1126 | (setq timeclock-project-list nil |
1127 | timeclock-last-project nil | |
1128 | timeclock-reason-list nil | |
1129 | timeclock-elapsed 0) | |
1130 | (with-temp-buffer | |
1131 | (insert-file-contents timeclock-file) | |
1132 | (goto-char (point-max)) | |
1133 | (unless (re-search-backward "^b\\s-+" nil t) | |
1134 | (goto-char (point-min))) | |
1135 | (while (setq event (timeclock-read-moment)) | |
1136 | (cond ((equal (car event) "b") | |
1137 | (setq accum (string-to-number (nth 2 event)))) | |
1138 | ((equal (car event) "h") | |
1139 | (setq last-date-limited | |
1140 | (timeclock-time-to-date (cadr event)) | |
1141 | last-date-seconds | |
1142 | (* (string-to-number (nth 2 event)) 3600.0))) | |
1143 | ((equal (car event) "i") | |
1144 | (when (and (nth 2 event) | |
1145 | (> (length (nth 2 event)) 0)) | |
1146 | (add-to-list 'timeclock-project-list (nth 2 event)) | |
1147 | (setq timeclock-last-project (nth 2 event))) | |
1148 | (let ((date (timeclock-time-to-date (cadr event)))) | |
1c8c9fb8 JW |
1149 | (if (if last-date |
1150 | (not (equal date last-date)) | |
1151 | first) | |
9329ea14 | 1152 | (setq first nil |
1c8c9fb8 JW |
1153 | accum (- accum (if last-date-limited |
1154 | last-date-seconds | |
1155 | timeclock-workday)))) | |
9329ea14 JW |
1156 | (setq last-date date |
1157 | last-date-limited nil) | |
1158 | (if beg | |
90cbf47e | 1159 | (error "Error in format of timelog file!") |
9329ea14 JW |
1160 | (setq beg (timeclock-time-to-seconds (cadr event)))))) |
1161 | ((equal (downcase (car event)) "o") | |
1162 | (if (and (nth 2 event) | |
1163 | (> (length (nth 2 event)) 0)) | |
1164 | (add-to-list 'timeclock-reason-list (nth 2 event))) | |
1c8c9fb8 JW |
1165 | (if (not beg) |
1166 | (error "Error in format of timelog file!") | |
1167 | (setq timeclock-last-period | |
1168 | (- (timeclock-time-to-seconds (cadr event)) beg) | |
1169 | accum (+ timeclock-last-period accum) | |
1170 | beg nil)) | |
9329ea14 JW |
1171 | (if (equal last-date todays-date) |
1172 | (setq timeclock-elapsed | |
1173 | (+ timeclock-last-period timeclock-elapsed))))) | |
1174 | (setq timeclock-last-event event | |
1175 | timeclock-last-event-workday | |
3dc630b9 | 1176 | (if (equal (timeclock-time-to-date now) last-date-limited) |
9329ea14 JW |
1177 | last-date-seconds |
1178 | timeclock-workday)) | |
1179 | (forward-line)) | |
3dc630b9 | 1180 | (setq timeclock-discrepancy accum)))) |
3b774a0c JW |
1181 | (unless timeclock-last-event-workday |
1182 | (setq timeclock-last-event-workday timeclock-workday)) | |
9d1137ce | 1183 | (setq accum (or timeclock-discrepancy 0) |
8c9245e2 | 1184 | elapsed (or timeclock-elapsed elapsed)) |
3dc630b9 JW |
1185 | (if timeclock-last-event |
1186 | (if (equal (car timeclock-last-event) "i") | |
1c8c9fb8 JW |
1187 | (let ((last-period (timeclock-last-period now))) |
1188 | (setq accum (+ accum last-period) | |
1189 | elapsed (+ elapsed last-period))) | |
3dc630b9 JW |
1190 | (if (not (equal (timeclock-time-to-date |
1191 | (cadr timeclock-last-event)) | |
1192 | (timeclock-time-to-date now))) | |
1193 | (setq accum (- accum timeclock-last-event-workday))))) | |
1c8c9fb8 JW |
1194 | (list accum (- elapsed timeclock-last-event-workday) |
1195 | elapsed))) | |
9329ea14 JW |
1196 | |
1197 | ;;; A reporting function that uses timeclock-log-data | |
1198 | ||
9329ea14 | 1199 | (defun timeclock-day-base (&optional time) |
4ee3e788 GM |
1200 | "Given a time within a day, return 0:0:0 within that day. |
1201 | If optional argument TIME is non-nil, use that instead of the current time." | |
9329ea14 JW |
1202 | (let ((decoded (decode-time (or time (current-time))))) |
1203 | (setcar (nthcdr 0 decoded) 0) | |
1204 | (setcar (nthcdr 1 decoded) 0) | |
1205 | (setcar (nthcdr 2 decoded) 0) | |
1206 | (apply 'encode-time decoded))) | |
1207 | ||
7e285b36 CY |
1208 | (defun timeclock-mean (l) |
1209 | "Compute the arithmetic mean of the values in the list L." | |
9329ea14 JW |
1210 | (let ((total 0) |
1211 | (count 0)) | |
55dfee43 GM |
1212 | (dolist (thisl l) |
1213 | (setq total (+ total thisl) | |
1214 | count (1+ count))) | |
1215 | (if (zerop count) | |
1216 | 0 | |
1217 | (/ total count)))) | |
9329ea14 JW |
1218 | |
1219 | (defun timeclock-generate-report (&optional html-p) | |
4ee3e788 GM |
1220 | "Generate a summary report based on the current timelog file. |
1221 | By default, the report is in plain text, but if the optional argument | |
a9dfccd6 | 1222 | HTML-P is non-nil, HTML markup is added." |
7e285b36 | 1223 | (interactive "P") |
9329ea14 JW |
1224 | (let ((log (timeclock-log-data)) |
1225 | (today (timeclock-day-base))) | |
1226 | (if html-p (insert "<p>")) | |
1227 | (insert "Currently ") | |
1228 | (let ((project (nth 2 timeclock-last-event)) | |
1229 | (begin (nth 1 timeclock-last-event)) | |
1230 | done) | |
1231 | (if (timeclock-currently-in-p) | |
1232 | (insert "IN") | |
55dfee43 | 1233 | (if (zerop (length project)) |
9329ea14 JW |
1234 | (progn (insert "Done Working Today") |
1235 | (setq done t)) | |
1236 | (insert "OUT"))) | |
1237 | (unless done | |
1238 | (insert " since " (format-time-string "%Y/%m/%d %-I:%M %p" begin)) | |
1239 | (if html-p | |
1240 | (insert "<br>\n<b>") | |
1241 | (insert "\n*")) | |
1242 | (if (timeclock-currently-in-p) | |
1243 | (insert "Working on ")) | |
1244 | (if html-p | |
40e7276a | 1245 | (insert project "</b><br>\n") |
9329ea14 JW |
1246 | (insert project "*\n")) |
1247 | (let ((proj-data (cdr (assoc project (timeclock-project-alist log)))) | |
1248 | (two-weeks-ago (timeclock-seconds-to-time | |
1249 | (- (timeclock-time-to-seconds today) | |
1250 | (* 2 7 24 60 60)))) | |
1251 | two-week-len today-len) | |
1252 | (while proj-data | |
1c226f2b | 1253 | (if (not (time-less-p |
9329ea14 JW |
1254 | (timeclock-entry-begin (car proj-data)) today)) |
1255 | (setq today-len (timeclock-entry-list-length proj-data) | |
1256 | proj-data nil) | |
1257 | (if (and (null two-week-len) | |
1c226f2b | 1258 | (not (time-less-p |
9329ea14 JW |
1259 | (timeclock-entry-begin (car proj-data)) |
1260 | two-weeks-ago))) | |
1261 | (setq two-week-len (timeclock-entry-list-length proj-data))) | |
1262 | (setq proj-data (cdr proj-data)))) | |
1263 | (if (null two-week-len) | |
1264 | (setq two-week-len today-len)) | |
1265 | (if html-p (insert "<p>")) | |
3dc630b9 JW |
1266 | (if today-len |
1267 | (insert "\nTime spent on this task today: " | |
1268 | (timeclock-seconds-to-string today-len) | |
1269 | ". In the last two weeks: " | |
1270 | (timeclock-seconds-to-string two-week-len)) | |
1271 | (if two-week-len | |
1272 | (insert "\nTime spent on this task in the last two weeks: " | |
1273 | (timeclock-seconds-to-string two-week-len)))) | |
9329ea14 JW |
1274 | (if html-p (insert "<br>")) |
1275 | (insert "\n" | |
1276 | (timeclock-seconds-to-string (timeclock-workday-elapsed)) | |
1277 | " worked today, " | |
1278 | (timeclock-seconds-to-string (timeclock-workday-remaining)) | |
1279 | " remaining, done at " | |
1280 | (timeclock-when-to-leave-string) "\n"))) | |
1281 | (if html-p (insert "<p>")) | |
1282 | (insert "\nThere have been " | |
1283 | (number-to-string | |
1284 | (length (timeclock-day-alist log))) | |
1285 | " days of activity, starting " | |
1286 | (caar (last (timeclock-day-alist log)))) | |
1287 | (if html-p (insert "</p>")) | |
1288 | (when html-p | |
1289 | (insert "<p> | |
1290 | <table> | |
1291 | <td width=\"25\"><br></td><td> | |
1292 | <table border=1 cellpadding=3> | |
1293 | <tr><th><i>Statistics</i></th> | |
1294 | <th>Entire</th> | |
1295 | <th>-30 days</th> | |
1296 | <th>-3 mons</th> | |
1297 | <th>-6 mons</th> | |
1298 | <th>-1 year</th> | |
1299 | </tr>") | |
1300 | (let* ((day-list (timeclock-day-list)) | |
1301 | (thirty-days-ago (timeclock-seconds-to-time | |
1302 | (- (timeclock-time-to-seconds today) | |
1303 | (* 30 24 60 60)))) | |
1304 | (three-months-ago (timeclock-seconds-to-time | |
1305 | (- (timeclock-time-to-seconds today) | |
1306 | (* 90 24 60 60)))) | |
1307 | (six-months-ago (timeclock-seconds-to-time | |
1308 | (- (timeclock-time-to-seconds today) | |
1309 | (* 180 24 60 60)))) | |
1310 | (one-year-ago (timeclock-seconds-to-time | |
1311 | (- (timeclock-time-to-seconds today) | |
1312 | (* 365 24 60 60)))) | |
1313 | (time-in (vector (list t) (list t) (list t) (list t) (list t))) | |
1314 | (time-out (vector (list t) (list t) (list t) (list t) (list t))) | |
1315 | (breaks (vector (list t) (list t) (list t) (list t) (list t))) | |
1316 | (workday (vector (list t) (list t) (list t) (list t) (list t))) | |
1317 | (lengths (vector '(0 0) thirty-days-ago three-months-ago | |
1318 | six-months-ago one-year-ago))) | |
1319 | ;; collect statistics from complete timelog | |
55dfee43 | 1320 | (dolist (day day-list) |
9329ea14 JW |
1321 | (let ((i 0) (l 5)) |
1322 | (while (< i l) | |
1c226f2b | 1323 | (unless (time-less-p |
55dfee43 | 1324 | (timeclock-day-begin day) |
9329ea14 JW |
1325 | (aref lengths i)) |
1326 | (let ((base (timeclock-time-to-seconds | |
1327 | (timeclock-day-base | |
55dfee43 | 1328 | (timeclock-day-begin day))))) |
9329ea14 JW |
1329 | (nconc (aref time-in i) |
1330 | (list (- (timeclock-time-to-seconds | |
55dfee43 | 1331 | (timeclock-day-begin day)) |
9329ea14 | 1332 | base))) |
55dfee43 GM |
1333 | (let ((span (timeclock-day-span day)) |
1334 | (len (timeclock-day-length day)) | |
1335 | (req (timeclock-day-required day))) | |
9329ea14 JW |
1336 | ;; If the day's actual work length is less than |
1337 | ;; 70% of its span, then likely the exit time | |
1338 | ;; and break amount are not worthwhile adding to | |
1339 | ;; the statistic | |
1340 | (when (and (> span 0) | |
1341 | (> (/ (float len) (float span)) 0.70)) | |
1342 | (nconc (aref time-out i) | |
1343 | (list (- (timeclock-time-to-seconds | |
55dfee43 | 1344 | (timeclock-day-end day)) |
9329ea14 JW |
1345 | base))) |
1346 | (nconc (aref breaks i) (list (- span len)))) | |
1347 | (if req | |
1348 | (setq len (+ len (- timeclock-workday req)))) | |
1349 | (nconc (aref workday i) (list len))))) | |
55dfee43 | 1350 | (setq i (1+ i))))) |
9329ea14 JW |
1351 | ;; average statistics |
1352 | (let ((i 0) (l 5)) | |
1353 | (while (< i l) | |
7e285b36 CY |
1354 | (aset time-in i (timeclock-mean (cdr (aref time-in i)))) |
1355 | (aset time-out i (timeclock-mean (cdr (aref time-out i)))) | |
1356 | (aset breaks i (timeclock-mean (cdr (aref breaks i)))) | |
1357 | (aset workday i (timeclock-mean (cdr (aref workday i)))) | |
9329ea14 JW |
1358 | (setq i (1+ i)))) |
1359 | ;; Output the HTML table | |
1360 | (insert "<tr>\n") | |
1361 | (insert "<td align=\"center\">Time in</td>\n") | |
1362 | (let ((i 0) (l 5)) | |
1363 | (while (< i l) | |
1364 | (insert "<td align=\"right\">" | |
1365 | (timeclock-seconds-to-string (aref time-in i)) | |
1366 | "</td>\n") | |
1367 | (setq i (1+ i)))) | |
1368 | (insert "</tr>\n") | |
3dc630b9 | 1369 | |
9329ea14 JW |
1370 | (insert "<tr>\n") |
1371 | (insert "<td align=\"center\">Time out</td>\n") | |
1372 | (let ((i 0) (l 5)) | |
1373 | (while (< i l) | |
1374 | (insert "<td align=\"right\">" | |
1375 | (timeclock-seconds-to-string (aref time-out i)) | |
1376 | "</td>\n") | |
1377 | (setq i (1+ i)))) | |
1378 | (insert "</tr>\n") | |
3dc630b9 | 1379 | |
9329ea14 JW |
1380 | (insert "<tr>\n") |
1381 | (insert "<td align=\"center\">Break</td>\n") | |
1382 | (let ((i 0) (l 5)) | |
1383 | (while (< i l) | |
1384 | (insert "<td align=\"right\">" | |
1385 | (timeclock-seconds-to-string (aref breaks i)) | |
1386 | "</td>\n") | |
1387 | (setq i (1+ i)))) | |
1388 | (insert "</tr>\n") | |
3dc630b9 | 1389 | |
9329ea14 JW |
1390 | (insert "<tr>\n") |
1391 | (insert "<td align=\"center\">Workday</td>\n") | |
1392 | (let ((i 0) (l 5)) | |
1393 | (while (< i l) | |
1394 | (insert "<td align=\"right\">" | |
1395 | (timeclock-seconds-to-string (aref workday i)) | |
1396 | "</td>\n") | |
1397 | (setq i (1+ i)))) | |
1398 | (insert "</tr>\n")) | |
1399 | (insert "<tfoot> | |
1400 | <td colspan=\"6\" align=\"center\"> | |
1401 | <i>These are approximate figures</i></td> | |
1402 | </tfoot> | |
1403 | </table> | |
1404 | </td></table>"))))) | |
1405 | ||
1406 | ;;; A helpful little function | |
1407 | ||
1408 | (defun timeclock-visit-timelog () | |
4ee3e788 | 1409 | "Open the file named by `timeclock-file' in another window." |
9329ea14 JW |
1410 | (interactive) |
1411 | (find-file-other-window timeclock-file)) | |
90cbf47e GM |
1412 | |
1413 | (provide 'timeclock) | |
1414 | ||
1415 | (run-hooks 'timeclock-load-hook) | |
1416 | ||
1417 | ;; make sure we know the list of reasons, projects, and have computed | |
1418 | ;; the last event and current discrepancy. | |
1419 | (if (file-readable-p timeclock-file) | |
1420 | (timeclock-reread-log)) | |
1421 | ||
1422 | ;;; timeclock.el ends here |