projects
/
8sync.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
140ab5b
)
A whole lot of docstrings
author
Christopher Allan Webber
<cwebber@dustycloud.org>
Fri, 20 Nov 2015 16:59:29 +0000
(10:59 -0600)
committer
Christopher Allan Webber
<cwebber@dustycloud.org>
Fri, 20 Nov 2015 16:59:29 +0000
(10:59 -0600)
loopy.scm
patch
|
blob
|
history
diff --git
a/loopy.scm
b/loopy.scm
index 7b43ba6d6dbe6274786779d7b7fd9f7cb7bc0ef0..cc1ee7889bcfdcb1a253b0ec0049c84a3a730890 100644
(file)
--- a/
loopy.scm
+++ b/
loopy.scm
@@
-110,6
+110,11
@@
(queue time-segment-queue))
(define (time-segment-right-format time)
(queue time-segment-queue))
(define (time-segment-right-format time)
+ "Ensure TIME is in the right format.
+
+The right format means (second . microsecond).
+If an integer, will convert appropriately."
+ ;; TODO: add floating point / rational number support.
(match time
;; time is already a cons of second and microsecnd
(((? integer? s) . (? integer? u)) time)
(match time
;; time is already a cons of second and microsecnd
(((? integer? s) . (? integer? u)) time)
@@
-118,9
+123,14
@@
(_ (throw 'invalid-time "Invalid time" time))))
(define* (make-time-segment time #:optional (queue (make-q)))
(_ (throw 'invalid-time "Invalid time" time))))
(define* (make-time-segment time #:optional (queue (make-q)))
+ "Make a time segment of TIME and QUEUE
+
+No automatic conversion is done, so you might have to
+run (time-segment-right-format) first."
(make-time-segment-intern time queue))
(define (time< time1 time2)
(make-time-segment-intern time queue))
(define (time< time1 time2)
+ "Check if TIME1 is less than TIME2"
(cond ((< (car time1)
(car time2))
#t)
(cond ((< (car time1)
(car time2))
#t)
@@
-132,10
+142,12
@@
(else #f)))
(define (time= time1 time2)
(else #f)))
(define (time= time1 time2)
+ "Check whether TIME1 and TIME2 are equivalent"
(and (= (car time1) (car time2))
(= (cdr time1) (cdr time2))))
(define (time<= time1 time2)
(and (= (car time1) (car time2))
(= (cdr time1) (cdr time2))))
(define (time<= time1 time2)
+ "Check if TIME1 is less than or equal to TIME2"
(or (time< time1 time2)
(time= time1 time2)))
(or (time< time1 time2)
(time= time1 time2)))
@@
-147,6
+159,10
@@
(usec time-delta-usec))
(define* (make-time-delta sec #:optional usec)
(usec time-delta-usec))
(define* (make-time-delta sec #:optional usec)
+ "Make a <time-delta> of SEC seconds and USEC microseconds.
+
+This is used primarily so the agenda can recognize RUN-REQUEST objects
+which are meant "
(make-time-delta-intern sec (or usec 0)))
(define tdelta make-time-delta)
(make-time-delta-intern sec (or usec 0)))
(define tdelta make-time-delta)
@@
-343,6
+359,7
@@
Will produce (0 . 0) instead of a negative number, if needed."
(make-run-request (wrap body ...) when))
(define-syntax-rule (run-delay body ... delay-time)
(make-run-request (wrap body ...) when))
(define-syntax-rule (run-delay body ... delay-time)
+ "Run BODY at DELAY-TIME time from now"
(make-run-request (wrap body ...) (tdelta delay-time)))
(define (delay run-request delay-time)
(make-run-request (wrap body ...) (tdelta delay-time)))
(define (delay run-request delay-time)