From: Christopher Allan Webber Date: Sun, 29 Nov 2015 16:32:04 +0000 (-0600) Subject: Renaming `eightsync' to `8sync' everywhere in the code X-Git-Tag: v0.1.0~38 X-Git-Url: https://jxself.org/git/?p=8sync.git;a=commitdiff_plain;h=9bb036f18457a6c2d24343e21e6950f9df5043e7 Renaming `eightsync' to `8sync' everywhere in the code * eightsync/agenda.scm, 8sync/agenda.scm: Renamed * eightsync/repl.scm, 8sync/repl.scm: Renamed * eightsync/systems/irc.scm, 8sync/systems/irc.scm: Renamed * demos/ircbot.scm: Changed module import to 8sync * tests/test-agenda.scm: Changed module import to 8sync * Makefile.am: Updated to reference new file naming --- diff --git a/8sync/agenda.scm b/8sync/agenda.scm new file mode 100644 index 0000000..c2614ef --- /dev/null +++ b/8sync/agenda.scm @@ -0,0 +1,799 @@ +;;; 8sync --- Asynchronous programming for Guile +;;; Copyright (C) 2015 Christopher Allan Webber +;;; +;;; This file is part of 8sync. +;;; +;;; 8sync is free software: you can redistribute it and/or modify it +;;; under the terms of the GNU Lesser General Public License as +;;; published by the Free Software Foundation, either version 3 of the +;;; License, or (at your option) any later version. +;;; +;;; 8sync is distributed in the hope that it will be useful, +;;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;;; GNU Lesser General Public License for more details. +;;; +;;; You should have received a copy of the GNU Lesser General Public +;;; License along with 8sync. If not, see . + +(define-module (8sync agenda) + #:use-module (srfi srfi-1) + #:use-module (srfi srfi-9) + #:use-module (srfi srfi-9 gnu) + #:use-module (ice-9 q) + #:use-module (ice-9 match) + #:use-module (ice-9 receive) + #:export ( + make-agenda agenda? + agenda-queue agenda-prompt-tag + agenda-read-port-map agenda-write-port-map agenda-except-port-map + agenda-schedule + + make-async-prompt-tag + + list->q make-q* + + + make-time-segment time-segment? + time-segment-time time-segment-queue + + time< time= time<= time-delta+ + time-minus time-plus + + + make-time-delta tdelta time-delta? + time-delta-sec time-delta-usec + + + make-schedule schedule? + schedule-add! schedule-empty? + schedule-segments + schedule-soonest-time + + schedule-segments-split schedule-extract-until! + add-segments-contents-to-queue! + + %8sync + + + make-run-request run-request? + run-request-proc run-request-when + + + make-port-request port-request port-request? + port-request-port + port-request-read port-request-write port-request-except + + run-it wrap wrap-apply run run-at run-delay + + %port-request %run %run-at %run-delay + + catch-8sync catch-%8sync + + ;; used for introspecting the error, but a method for making + ;; is not exposed + wrapped-exception? + wrapped-exception-key wrapped-exception-args + wrapped-exception-stacks + + print-error-and-continue + + %current-agenda + start-agenda agenda-run-once)) + +;; @@: Using immutable agendas here, so wouldn't it make sense to +;; replace this queue stuff with using pfds based immutable queues? + + +;;; Agenda definition +;;; ================= + +;;; The agenda consists of: +;;; - a queue of immediate items to handle +;;; - sheduled future events to be added to a future queue +;;; - a tag by which running processes can escape for some asynchronous +;;; operation (from which they can be returned later) +;;; - a mapping of ports to various handler procedures +;;; +;;; The goal, eventually, is for this all to be immutable and functional. +;;; However, we aren't there yet. Some tricky things: +;;; - The schedule needs to be immutable, yet reasonably efficient. +;;; - Need to use immutable queues (ijp's pfds library?) +;;; - Modeling reading from ports as something repeatable, +;;; and with reasonable separation from functional components? + +(define-immutable-record-type + (make-agenda-intern queue prompt-tag + read-port-map write-port-map except-port-map + schedule time catch-handler pre-unwind-handler) + agenda? + (queue agenda-queue) + (prompt-tag agenda-prompt-tag) + (read-port-map agenda-read-port-map) + (write-port-map agenda-write-port-map) + (except-port-map agenda-except-port-map) + (schedule agenda-schedule) + (time agenda-time) + (catch-handler agenda-catch-handler) + (pre-unwind-handler agenda-pre-unwind-handler)) + +(define (make-async-prompt-tag) + "Make an async prompt tag for an agenda. + +Generally done automatically for the user through (make-agenda)." + (make-prompt-tag "prompt")) + +(define* (make-agenda #:key + (queue (make-q)) + (prompt (make-prompt-tag)) + (read-port-map (make-hash-table)) + (write-port-map (make-hash-table)) + (except-port-map (make-hash-table)) + (schedule (make-schedule)) + (time (gettimeofday)) + (catch-handler #f) + (pre-unwind-handler #f)) + ;; TODO: document arguments + "Make a fresh agenda." + (make-agenda-intern queue prompt + read-port-map write-port-map except-port-map + schedule time + catch-handler pre-unwind-handler)) + +(define (current-agenda-prompt) + "Get the prompt for the current agenda; signal an error if there isn't one." + (let ((current-agenda (%current-agenda))) + (if (not current-agenda) + (throw + 'no-current-agenda + "Can't get current agenda prompt if there's no current agenda!") + (agenda-prompt-tag current-agenda)))) + +;; helper for making queues for an agenda +(define (list->q lst) + "Makes a queue composed of LST items" + (let ((q (make-q))) + (for-each + (lambda (x) + (enq! q x)) + lst) + q)) + +(define (make-q* . args) + "Makes a queue and populates it with this invocation's ARGS" + (list->q args)) + + +;;; Schedule +;;; ======== + +;;; This is where we handle timed events for the future + +;; This section totally borrows from the ideas in SICP +;; <3 <3 <3 + +;; NOTE: time is a cons of (seconds . microseconds) + +(define-record-type + (make-time-segment-intern time queue) + time-segment? + (time time-segment-time) + (queue time-segment-queue)) + +;; @@: This seems to be the same as srfi-18's seconds->time procedure? +;; Maybe double check and switch to that? (Thanks amz3!) + +(define (time-from-float-or-fraction time) + "Produce a (sec . usec) pair from TIME, a float or fraction" + (let* ((mixed-whole (floor time)) + (mixed-rest (- time mixed-whole)) ; float or fraction component + (sec mixed-whole) + (usec (floor (* 1000000 mixed-rest)))) + (cons (inexact->exact sec) (inexact->exact usec)))) + +(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) + ;; time was just an integer (just the second) + ((? integer? _) (cons time 0)) + ((or (? rational? _) (? inexact? _)) + (time-from-float-or-fraction time)) + (_ (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) + "Check if TIME1 is less than TIME2" + (cond ((< (car time1) + (car time2)) + #t) + ((and (= (car time1) + (car time2)) + (< (cdr time1) + (cdr time2))) + #t) + (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) + "Check if TIME1 is less than or equal to TIME2" + (or (time< time1 time2) + (time= time1 time2))) + + +(define-record-type + (make-time-delta-intern sec usec) + time-delta? + (sec time-delta-sec) + (usec time-delta-usec)) + +(define* (make-time-delta time) + "Make a of SEC seconds and USEC microseconds. + +This is used primarily so the agenda can recognize RUN-REQUEST objects +which are meant to delay computation" + (match (time-segment-right-format time) + ((sec . usec) + (make-time-delta-intern sec usec)))) + +(define tdelta make-time-delta) + +(define (time-carry-correct time) + "Corrects/handles time microsecond carry. +Will produce (0 . 0) instead of a negative number, if needed." + (cond ((>= (cdr time) 1000000) + (cons + (+ (car time) 1) + (- (cdr time) 1000000))) + ((< (cdr time) 0) + (if (= (car time) 0) + '(0 0) + (cons + (- (car time) 1) + (+ (cdr time) 1000000)))) + (else time))) + +(define (time-delta+ time time-delta) + "Increment a TIME by the value of TIME-DELTA" + (time-carry-correct + (cons (+ (car time) (time-delta-sec time-delta)) + (+ (cdr time) (time-delta-usec time-delta))))) + +(define (time-minus time1 time2) + "Subtract TIME2 from TIME1" + (time-carry-correct + (cons (- (car time1) (car time2)) + (- (cdr time1) (cdr time2))))) + +(define (time-plus time1 time2) + "Add TIME1 and TIME2" + (time-carry-correct + (cons (+ (car time1) (car time2)) + (+ (cdr time1) (cdr time2))))) + + +(define-record-type + (make-schedule-intern segments) + schedule? + (segments schedule-segments set-schedule-segments!)) + +(define* (make-schedule #:optional segments) + "Make a schedule, optionally pre-composed of SEGMENTS" + (make-schedule-intern (or segments '()))) + +(define (schedule-soonest-time schedule) + "Return a cons of (sec . usec) for next time segement, or #f if none" + (let ((segments (schedule-segments schedule))) + (if (eq? segments '()) + #f + (time-segment-time (car segments))))) + +;; TODO: This code is reasonably easy to read but it +;; mutates AND is worst case of O(n) in both space and time :( +;; but at least it'll be reasonably easy to refactor to +;; a more functional setup? +(define (schedule-add! schedule time proc) + "Mutate SCHEDULE, adding PROC at an appropriate time segment for TIME" + (let ((time (time-segment-right-format time))) + (define (new-time-segment) + (let ((new-segment + (make-time-segment time))) + (enq! (time-segment-queue new-segment) proc) + new-segment)) + (define (loop segments) + (define (segment-equals-time? segment) + (time= time (time-segment-time segment))) + + (define (segment-more-than-time? segment) + (time< time (time-segment-time segment))) + + ;; We could switch this out to be more mutate'y + ;; and avoid the O(n) of space... is that over-optimizing? + (match segments + ;; If we're at the end of the list, time to make a new + ;; segment... + ('() (cons (new-time-segment) '())) + ;; If the segment's time is exactly our time, good news + ;; everyone! Let's append our stuff to its queue + (((? segment-equals-time? first) rest ...) + (enq! (time-segment-queue first) proc) + segments) + ;; If the first segment is more than our time, + ;; ours belongs before this one, so add it and + ;; start consing our way back + (((? segment-more-than-time? first) rest ...) + (cons (new-time-segment) segments)) + ;; Otherwise, build up recursive result + ((first rest ... ) + (cons first (loop rest))))) + (set-schedule-segments! + schedule + (loop (schedule-segments schedule))))) + +(define (schedule-empty? schedule) + "Check if the SCHEDULE is currently empty" + (eq? (schedule-segments schedule) '())) + +(define (schedule-segments-split schedule time) + "Does a multiple value return of time segments before/at and after TIME" + (let ((time (time-segment-right-format time))) + (define (segment-is-now? segment) + (time= (time-segment-time segment) time)) + (define (segment-is-before-now? segment) + (time< (time-segment-time segment) time)) + + (let loop ((segments-before '()) + (segments-left (schedule-segments schedule))) + (match segments-left + ;; end of the line, return + ('() + (values (reverse segments-before) '())) + + ;; It's right now, so time to stop, but include this one in before + ;; but otherwise return + (((? segment-is-now? first) rest ...) + (values (reverse (cons first segments-before)) rest)) + + ;; This is prior or at now, so add it and keep going + (((? segment-is-before-now? first) rest ...) + (loop (cons first segments-before) rest)) + + ;; Otherwise it's past now, just return what we have + (segments-after + (values segments-before segments-after)))))) + +(define (schedule-extract-until! schedule time) + "Extract all segments until TIME from SCHEDULE, and pop old segments off" + (receive (segments-before segments-after) + (schedule-segments-split schedule time) + (set-schedule-segments! schedule segments-after) + segments-before)) + +(define (add-segments-contents-to-queue! segments queue) + (for-each + (lambda (segment) + (let ((seg-queue (time-segment-queue segment))) + (while (not (q-empty? seg-queue)) + (enq! queue (deq! seg-queue))))) + segments)) + + + +;;; Request to run stuff +;;; ==================== + +(define-record-type + (make-run-request proc when) + run-request? + (proc run-request-proc) + (when run-request-when)) + +(define* (run-it proc #:optional when) + "Make a request to run PROC (possibly at WHEN)" + (make-run-request proc when)) + +(define-syntax-rule (wrap body ...) + "Wrap contents in a procedure" + (lambda () + body ...)) + +(define-syntax-rule (wrap-apply body) + "Wrap possibly multi-value function in a procedure, applies all arguments" + (lambda args + (apply body args))) + + +;; @@: Do we really want `body ...' here? +;; what about just `body'? +(define-syntax-rule (run body ...) + "Run everything in BODY but wrap in a convenient procedure" + (make-run-request (wrap body ...) #f)) + +(define-syntax-rule (run-at body ... when) + "Run BODY at WHEN" + (make-run-request (wrap body ...) when)) + +;; @@: Is it okay to overload the term "delay" like this? +;; Would `run-in' be better? +(define-syntax-rule (run-delay body ... delay-time) + "Run BODY at DELAY-TIME time from now" + (make-run-request (wrap body ...) (tdelta delay-time))) + + +;; A request to set up a port with at least one of read, write, except +;; handling processes + +(define-record-type + (make-port-request-intern port read write except) + port-request? + (port port-request-port) + (read port-request-read) + (write port-request-write) + (except port-request-except)) + +(define* (make-port-request port #:key read write except) + (if (not (or read write except)) + (throw 'no-port-handler-given "No port handler given.\n")) + (make-port-request-intern port read write except)) + +(define port-request make-port-request) + + + +;;; Asynchronous escape to run things +;;; ================================= + +(define-syntax-rule (%8sync async-request) + "Run BODY asynchronously at a prompt, passing args to make-future. + +Runs things asynchronously (8synchronously?)" + (propagate-%async-exceptions + (abort-to-prompt (current-agenda-prompt) + async-request))) + +;; Async port request and run-request meta-requests +(define (make-async-request proc) + "Wrap PROC in an async-request + +The purpose of this is to make sure that users don't accidentally +return the wrong thing via (%8sync) and trip themselves up." + (cons '*async-request* proc)) + +(define (setup-async-request resume-kont async-request) + "Complete an async request for agenda-run-once's continuation handling" + (match async-request + (('*async-request* . async-setup-proc) + (async-setup-proc resume-kont)) + ;; TODO: deliver more helpful errors depending on what the user + ;; returned + (_ (throw 'invalid-async-request + "Invalid request passed back via an (%8sync) procedure." + async-request)))) + +(define-record-type + (make-wrapped-exception key args stacks) + wrapped-exception? + (key wrapped-exception-key) + (args wrapped-exception-args) + (stacks wrapped-exception-stacks)) + +(define-syntax-rule (propagate-%async-exceptions body) + (let ((body-result body)) + (if (wrapped-exception? body-result) + (throw '8sync-caught-error + (wrapped-exception-key body-result) + (wrapped-exception-args body-result) + (wrapped-exception-stacks body-result)) + body-result))) + +(define-syntax-rule (%run body ...) + (%run-at body ... #f)) + +(define-syntax-rule (%run-at body ... when) + ;; Send an asynchronous request to apply a continuation to the + ;; following function, then handle that as a request to the agenda + (make-async-request + (lambda (kont) + ;; We're making a run request + (make-run-request + ;; Wrapping the following execution to run... + (wrap + ;; Once we get the result from the inner part, we'll resume + ;; this continuation, but first + ;; @@: Is this running immediately, or queueing the result + ;; after evaluation for the next agenda tick? It looks + ;; like evaluating immediately. Is that what we want? + (kont + ;; Any unhandled errors are caught + (let ((exception-stack #f)) + (catch #t + ;; Run the actual code the user requested + (lambda () + body ...) + ;; If something bad happened and we didn't catch it, + ;; we'll wrap it up in such a way that the continuation + ;; can address it + (lambda (key . args) + (cond + ((eq? key '8sync-caught-error) + (match args + ((orig-key orig-args orig-stacks) + (make-wrapped-exception + orig-key orig-args + (cons exception-stack orig-stacks))))) + (else + (make-wrapped-exception key args + (list exception-stack))))) + (lambda _ + (set! exception-stack (make-stack #t 1 0))))))) + when)))) + +(define-syntax-rule (%run-delay body ... delay-time) + (%run-at body ... (tdelta delay-time))) + +(define-syntax-rule (%port-request add-this-port port-request-args ...) + (make-async-request + (lambda (kont) + (list (make-port-request port-request-args ...) + (make-run-request kont))))) + +;; TODO +(define-syntax-rule (%run-with-return return body ...) + (make-async-request + (lambda (kont) + (let ((return kont)) + (lambda () + body ...))))) + +(define-syntax-rule (catch-8sync exp (handler-key handler) ...) + (catch '8sync-caught-error + (lambda () + exp) + (lambda (_ orig-key orig-args orig-stacks) + (cond + ((or (eq? handler-key #t) + (eq? orig-key handler-key)) + (apply handler orig-stacks orig-args)) ... + (else (raise '8sync-caught-error + orig-key orig-args orig-stacks)))))) + +;; Alias...? +(define-syntax-rule (catch-%8sync rest ...) + (catch-8sync rest ...)) + + + +;;; Execution of agenda, and current agenda +;;; ======================================= + +(define %current-agenda (make-parameter #f)) + +(define (update-agenda-from-select! agenda) + "Potentially (select) on ports specified in agenda, adding items to queue" + (define (hash-keys hash) + (hash-map->list (lambda (k v) k) hash)) + (define (get-wait-time) + ;; TODO: we need to figure this out based on whether there's anything + ;; in the queue, and if not, how long till the next scheduled item + (let ((soonest-time (schedule-soonest-time (agenda-schedule agenda)))) + (cond + ((not (q-empty? (agenda-queue agenda))) + (cons 0 0)) + (soonest-time ; ie, the agenda is non-empty + (let* ((current-time (agenda-time agenda))) + (if (time<= soonest-time current-time) + ;; Well there's something due so let's select + ;; (this avoids a (possible?) race condition chance) + (cons 0 0) + (time-minus soonest-time current-time)))) + (else + (cons #f #f))))) + (define (do-select) + ;; TODO: support usecond wait time too + (match (get-wait-time) + ((sec . usec) + (catch 'system-error + (lambda () + (select (hash-keys (agenda-read-port-map agenda)) + (hash-keys (agenda-write-port-map agenda)) + (hash-keys (agenda-except-port-map agenda)) + sec usec)) + (lambda (key . rest-args) + (match rest-args + ((_ _ _ (EINTR)) + '(() () ())) + (_ (error "Unhandled error in select!" key rest-args)))))))) + (define (get-procs-to-run) + (define (ports->procs ports port-map) + (lambda (initial-procs) + (fold + (lambda (port prev) + (cons (lambda () + ((hash-ref port-map port) port)) + prev)) + initial-procs + ports))) + (match (do-select) + ((read-ports write-ports except-ports) + ;; @@: Come on, we can do better than append ;P + ((compose (ports->procs + read-ports + (agenda-read-port-map agenda)) + (ports->procs + write-ports + (agenda-write-port-map agenda)) + (ports->procs + except-ports + (agenda-except-port-map agenda))) + '())))) + (define (update-agenda) + (let ((procs-to-run (get-procs-to-run)) + (q (agenda-queue agenda))) + (for-each + (lambda (proc) + (enq! q proc)) + procs-to-run)) + agenda) + (define (ports-to-select?) + (define (has-items? selector) + ;; @@: O(n) + ;; ... we could use hash-for-each and a continuation to jump + ;; out with a #t at first indication of an item + (not (= (hash-count (const #t) + (selector agenda)) + 0))) + (or (has-items? agenda-read-port-map) + (has-items? agenda-write-port-map) + (has-items? agenda-except-port-map))) + + (if (ports-to-select?) + (update-agenda) + agenda)) + +(define (agenda-handle-port-request! agenda port-request) + "Update an agenda for a port-request" + (define (handle-selector request-selector port-map-selector) + (if (request-selector port-request) + (hash-set! (port-map-selector agenda) + (port-request-port port-request) + (request-selector port-request)))) + (handle-selector port-request-read agenda-read-port-map) + (handle-selector port-request-write agenda-write-port-map) + (handle-selector port-request-except agenda-except-port-map)) + + +(define* (start-agenda agenda + #:key stop-condition + (get-time gettimeofday) + (handle-ports update-agenda-from-select!)) + ;; TODO: Document fields + "Start up the AGENDA" + (let loop ((agenda agenda)) + (let ((agenda + ;; @@: Hm, maybe here would be a great place to handle + ;; select'ing on ports. + ;; We could compose over agenda-run-once and agenda-read-ports + (agenda-run-once agenda))) + (if (and stop-condition (stop-condition agenda)) + 'done + (let* ((agenda + ;; We have to update the time after ports handled, too + ;; because it may have changed after a select + (set-field + (handle-ports + ;; Adjust the agenda's time just in time + ;; We do this here rather than in agenda-run-once to make + ;; agenda-run-once's behavior fairly predictable + (set-field agenda (agenda-time) (get-time))) + (agenda-time) (get-time)))) + ;; Update the agenda's current queue based on + ;; currently applicable time segments + (add-segments-contents-to-queue! + (schedule-extract-until! (agenda-schedule agenda) (agenda-time agenda)) + (agenda-queue agenda)) + (loop agenda)))))) + +(define (print-error-and-continue key . args) + "Frequently used as pre-unwind-handler for agenda" + (cond + ((eq? key '8sync-caught-error) + (match args + ((orig-key orig-args stacks) + (display "\n*** Caught async exception. ***\n") + (format (current-error-port) + "* Original key '~s and arguments: ~s *\n" + orig-key orig-args) + (display "* Caught stacks below (ending with original) *\n\n") + (for-each + (lambda (s) + (display-backtrace s (current-error-port)) + (newline (current-error-port))) + stacks)))) + (else + (format (current-error-port) + "\n*** Caught exception with key '~s and arguments: ~s ***\n" + key args) + (display-backtrace (make-stack #t 1 0) + (current-error-port)) + (newline (current-error-port))))) + +(define-syntax-rule (maybe-catch-all (catch-handler pre-unwind-handler) + body ...) + (if (or catch-handler pre-unwind-handler) + (catch + #t + (lambda () + body ...) + (or catch-handler (lambda _ #f)) + (or pre-unwind-handler (lambda _ #f))) + (begin body ...))) + +(define (agenda-run-once agenda) + "Run once through the agenda, and produce a new agenda +based on the results" + (define (call-proc proc) + (call-with-prompt + (agenda-prompt-tag agenda) + (lambda () + (parameterize ((%current-agenda agenda)) + (maybe-catch-all + ((agenda-catch-handler agenda) + (agenda-pre-unwind-handler agenda)) + (proc)))) + (lambda (kont async-request) + (setup-async-request kont async-request)))) + + (let ((queue (agenda-queue agenda)) + (next-queue (make-q))) + (while (not (q-empty? queue)) + (let* ((proc (q-pop! queue)) + (proc-result (call-proc proc)) + (enqueue + (lambda (run-request) + (define (schedule-at! time proc) + (schedule-add! (agenda-schedule agenda) time proc)) + (let ((request-time (run-request-when run-request))) + (match request-time + ((? time-delta? time-delta) + (let ((time (time-delta+ (agenda-time agenda) + time-delta))) + (schedule-at! time (run-request-proc run-request)))) + ((? integer? sec) + (let ((time (cons sec 0))) + (schedule-at! time (run-request-proc run-request)))) + (((? integer? sec) . (? integer? usec)) + (schedule-at! request-time (run-request-proc run-request))) + (#f + (enq! next-queue (run-request-proc run-request)))))))) + (define (handle-individual result) + (match result + ((? run-request? new-proc) + (enqueue new-proc)) + ((? port-request? port-request) + (agenda-handle-port-request! agenda port-request)) + ;; do nothing + (_ #f))) + ;; @@: We might support delay-wrapped procedures here + (match proc-result + ((results ...) + (for-each handle-individual results)) + (one-result (handle-individual one-result))))) + ;; TODO: Alternately, we could return the next-queue + ;; along with changes to be added to the schedule here? + ;; Return new agenda, with next queue set + (set-field agenda (agenda-queue) next-queue))) diff --git a/8sync/repl.scm b/8sync/repl.scm new file mode 100644 index 0000000..bc68138 --- /dev/null +++ b/8sync/repl.scm @@ -0,0 +1,39 @@ +;;; 8sync --- Asynchronous programming for Guile +;;; Copyright (C) 2015 Christopher Allan Webber +;;; +;;; This file is part of 8sync. +;;; +;;; 8sync is free software: you can redistribute it and/or modify it +;;; under the terms of the GNU Lesser General Public License as +;;; published by the Free Software Foundation, either version 3 of the +;;; License, or (at your option) any later version. +;;; +;;; 8sync is distributed in the hope that it will be useful, +;;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;;; GNU Lesser General Public License for more details. +;;; +;;; You should have received a copy of the GNU Lesser General Public +;;; License along with 8sync. If not, see . + +(define-module (8sync repl) + #:use-module (ice-9 q) + #:use-module (8sync agenda) + #:use-module (system repl coop-server) + #:export (make-coop-server-handler + spawn-and-queue-repl-server!)) + +(define (make-coop-server-handler coop-server) + (define (run-self) + (poll-coop-repl-server coop-server) + ;; queue ourselves again + (run-delay (run-self) (/ 1 30))) + run-self) + +(define* (spawn-and-queue-repl-server! agenda #:optional port) + (let ((coop-server + (if port + (spawn-coop-repl-server port) + (spawn-coop-repl-server)))) + (enq! (agenda-queue agenda) + (make-coop-server-handler coop-server)))) diff --git a/8sync/systems/irc.scm b/8sync/systems/irc.scm new file mode 100755 index 0000000..7ab9316 --- /dev/null +++ b/8sync/systems/irc.scm @@ -0,0 +1,316 @@ +#!/usr/bin/guile \ +-e main -s +!# + +;;; 8sync --- Asynchronous programming for Guile +;;; Copyright (C) 2015 Christopher Allan Webber +;;; +;;; This file is part of 8sync. +;;; +;;; 8sync is free software: you can redistribute it and/or modify it +;;; under the terms of the GNU Lesser General Public License as +;;; published by the Free Software Foundation, either version 3 of the +;;; License, or (at your option) any later version. +;;; +;;; 8sync is distributed in the hope that it will be useful, +;;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;;; GNU Lesser General Public License for more details. +;;; +;;; You should have received a copy of the GNU Lesser General Public +;;; License along with 8sync. If not, see . + +(define-module (8sync systems irc) + #:use-module (8sync repl) + #:use-module (8sync agenda) + #:use-module (srfi srfi-9) + #:use-module (ice-9 getopt-long) + #:use-module (ice-9 format) + #:use-module (ice-9 receive) + #:use-module (ice-9 q) + #:use-module (ice-9 match) + #:export (;; The only things you definitely need if writing a bot + make-irc-bot-cli + irc-format irc-display irc-send-message irc-send-formatted + + ;; Useful things if you're making something more complicated + irc-line + irc-eol + + default-irc-port + + startswith-colon? + + + make-irc-line irc-line? + irc-line-prefix irc-line-command irc-line-params + + parse-line + irc-line-username + + condense-privmsg-line + echo-back-message + + make-handle-line make-basic-irc-handler + queue-and-start-irc-agenda!)) + + +;;; Network stuff +;;; ============= + +(define default-irc-port 6665) + +(define* (irc-socket-setup hostname #:optional (inet-port default-irc-port)) + (let ((s (socket PF_INET SOCK_STREAM 0)) + (ip-address (inet-ntoa (car (hostent:addr-list (gethost hostname)))))) + (connect s AF_INET + (inet-pton AF_INET ip-address) + inet-port) + s)) + +(define (install-socket socket handler) + (display "Installing socket...\n") ; debugging :) + (make-port-request socket #:read handler)) + +(define irc-eol "\r\n") + +(define (irc-line line) + (string-concatenate (list line irc-eol))) + +(define-syntax-rule (irc-format dest format-string rest ...) + (let ((line (string-concatenate + (list (format #f format-string rest ...) + irc-eol)))) + (match dest + (#f line) + (#t (display line)) + (else + (display line dest))))) + +(define* (irc-display line #:optional dest) + (if dest + (display (irc-line line) dest) + (display (irc-line dest)))) + +(define (irc-send-message socket channel message) + (irc-format socket "PRIVMSG ~a :~a" channel message)) + +(define-syntax-rule (irc-send-formatted socket channel format-string + args ...) + (irc-format socket "PRIVMSG ~a :~a" channel + (format #f format-string args ...))) + +(define* (handle-login socket username + #:key + (hostname "*") + (servername "*") + (realname username) + (channels '())) + (irc-format socket "USER ~a ~a ~a :~a" + username hostname servername realname) + (irc-format socket "NICK ~a" username) + (for-each + (lambda (channel) + (irc-format socket "JOIN ~a" channel)) + channels)) + +(define (startswith-colon? str) + (and (> (string-length str) 0) + (eq? (string-ref str 0) + #\:))) + +(define-record-type + (make-irc-line prefix command params) + irc-line? + (prefix irc-line-prefix) + (command irc-line-command) + (params irc-line-params)) + + +(define (parse-line line) + (define (parse-params pre-params) + ;; This is stupid and imperative but I can't wrap my brain around + ;; the right way to do it in a functional way :\ + (let ((param-list '()) + (currently-building '())) + (for-each + (lambda (param-item) + (cond + ((startswith-colon? param-item) + (if (not (eq? currently-building '())) + (set! param-list + (cons + (reverse currently-building) + param-list))) + (set! currently-building (list param-item))) + (else + (set! currently-building (cons param-item currently-building))))) + pre-params) + ;; We're still building something, so tack that on there + (if (not (eq? currently-building '())) + (set! param-list + (cons (reverse currently-building) param-list))) + ;; return the reverse of the param list + (reverse param-list))) + + (match (string-split line #\space) + (((? startswith-colon? prefix) + command + pre-params ...) + (make-irc-line prefix command + (parse-params pre-params))) + ((command pre-params ...) + (make-irc-line #f command + (parse-params pre-params))))) + +(define (strip-colon-if-necessary string) + (if (and (> (string-length string) 0) + (string-ref string 0)) + (substring/copy string 1) + string)) + +;; @@: Not sure if this works in all cases, like what about in a non-privmsg one? +(define (irc-line-username irc-line) + (let* ((prefix-name (strip-colon-if-necessary (irc-line-prefix irc-line))) + (exclaim-index (string-index prefix-name #\!))) + (if exclaim-index + (substring/copy prefix-name 0 exclaim-index) + prefix-name))) + +(define (condense-privmsg-line line) + "Condense message line and do multiple value return of + (channel message is-action)" + (define (strip-last-char string) + (substring/copy string 0 (- (string-length string) 1))) + (let* ((channel-name (caar line)) + (rest-params (apply append (cdr line)))) + (match rest-params + (((or "\x01ACTION" ":\x01ACTION") middle-words ... (= strip-last-char last-word)) + (values channel-name + (string-join + (append middle-words (list last-word)) + " ") + #t)) + (((= strip-colon-if-necessary first-word) rest-message ...) + (values channel-name + (string-join (cons first-word rest-message) " ") + #f))))) + +(define (echo-back-message socket my-name speaker + channel-name message is-action) + (if is-action + (format #t "~a emoted ~s in channel ~a\n" + speaker message channel-name) + (format #t "~a said ~s in channel ~a\n" + speaker message channel-name))) + +(define default-handle-privmsg echo-back-message) + +(define* (make-handle-line #:key + (handle-privmsg default-handle-privmsg)) + (define (handle-line socket line my-username) + (let ((parsed-line (parse-line line))) + (match (irc-line-command parsed-line) + ("PING" + (irc-display "PONG" socket)) + ("PRIVMSG" + (receive (channel-name message is-action) + (condense-privmsg-line (irc-line-params parsed-line)) + (let ((username (irc-line-username parsed-line))) + (handle-privmsg socket my-username username + channel-name message is-action)))) + (_ + (display line) + (newline))))) + handle-line) + +(define (make-basic-irc-handler handle-line username) + (let ((buffer '())) + (define (reset-buffer) + (set! buffer '())) + (define (should-read-char socket) + (and (char-ready? socket) (not (eof-object? (peek-char socket))))) + (define (irc-handler socket) + (while (should-read-char socket) + (set! buffer (cons (read-char socket) buffer)) + (match buffer + ((#\newline #\return (? char? line-chars) ...) + (let ((ready-line (list->string (reverse line-chars)))) + ;; reset buffer + (set! buffer '()) + ;; run it + (%8sync (%run (handle-line + socket + ready-line + username))))) + (_ #f)))) + irc-handler)) + +(define default-line-handler (make-handle-line)) + +(define* (queue-and-start-irc-agenda! agenda socket #:key + (username "syncbot") + (inet-port default-irc-port) + (line-handler default-line-handler) + (channels '())) + (dynamic-wind + (lambda () #f) + (lambda () + (enq! (agenda-queue agenda) + (wrap (install-socket + socket + (make-basic-irc-handler + line-handler + username)))) + (enq! (agenda-queue agenda) (wrap (handle-login socket username + #:channels channels))) + (start-agenda agenda)) + (lambda () + (display "Cleaning up...\n") + (close socket)))) + + + +;;; CLI +;;; === + +(define option-spec + `((server (single-char #\s) (required? #t) (value #t)) + (port (single-char #\p) + (value #t) + (predicate + ,(lambda (s) + (if (string->number s) #t #f)))) + (username (single-char #\u) (required? #t) (value #t)) + (channels (value #t)) + (listen))) + +(define* (make-irc-bot-cli #:optional + (line-handler default-line-handler) + (print-and-continue-on-error #t)) + (define (main args) + (let* ((options (getopt-long args option-spec)) + (hostname (option-ref options 'server #f)) + (port (or (option-ref options 'port #f) + default-irc-port)) + (username (option-ref options 'username #f)) + (listen (option-ref options 'listen #f)) + (channels (option-ref options 'channels "")) + (agenda (if print-and-continue-on-error + (make-agenda #:pre-unwind-handler print-error-and-continue) + (make-agenda)))) + (display `((server ,hostname) (port ,port) (username ,username) + (listen ,listen) (channels-split ,(string-split channels #\space)))) + (newline) + (if listen + (spawn-and-queue-repl-server! agenda)) + (queue-and-start-irc-agenda! + agenda + (irc-socket-setup hostname port) + #:inet-port port + #:username username + #:channels (string-split channels #\space) + #:line-handler line-handler))) + main) + +(define main (make-irc-bot-cli)) diff --git a/Makefile.am b/Makefile.am index 01d913c..f6c0131 100644 --- a/Makefile.am +++ b/Makefile.am @@ -45,9 +45,9 @@ moddir=$(prefix)/share/guile/site/2.0 godir=$(libdir)/guile/2.0/ccache SOURCES = \ - eightsync/agenda.scm \ - eightsync/repl.scm \ - eightsync/systems/irc.scm + 8sync/agenda.scm \ + 8sync/repl.scm \ + 8sync/systems/irc.scm TESTS = \ diff --git a/demos/ircbot.scm b/demos/ircbot.scm index a72ae40..49b241f 100755 --- a/demos/ircbot.scm +++ b/demos/ircbot.scm @@ -20,8 +20,8 @@ ;;; You should have received a copy of the GNU Lesser General Public ;;; License along with 8sync. If not, see . -(use-modules (eightsync systems irc) - (eightsync agenda) +(use-modules (8sync systems irc) + (8sync agenda) (ice-9 match)) (define (handle-message socket my-name speaker diff --git a/eightsync/agenda.scm b/eightsync/agenda.scm deleted file mode 100644 index 5a2aea2..0000000 --- a/eightsync/agenda.scm +++ /dev/null @@ -1,799 +0,0 @@ -;;; 8sync --- Asynchronous programming for Guile -;;; Copyright (C) 2015 Christopher Allan Webber -;;; -;;; This file is part of 8sync. -;;; -;;; 8sync is free software: you can redistribute it and/or modify it -;;; under the terms of the GNU Lesser General Public License as -;;; published by the Free Software Foundation, either version 3 of the -;;; License, or (at your option) any later version. -;;; -;;; 8sync is distributed in the hope that it will be useful, -;;; but WITHOUT ANY WARRANTY; without even the implied warranty of -;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -;;; GNU Lesser General Public License for more details. -;;; -;;; You should have received a copy of the GNU Lesser General Public -;;; License along with 8sync. If not, see . - -(define-module (eightsync agenda) - #:use-module (srfi srfi-1) - #:use-module (srfi srfi-9) - #:use-module (srfi srfi-9 gnu) - #:use-module (ice-9 q) - #:use-module (ice-9 match) - #:use-module (ice-9 receive) - #:export ( - make-agenda agenda? - agenda-queue agenda-prompt-tag - agenda-read-port-map agenda-write-port-map agenda-except-port-map - agenda-schedule - - make-async-prompt-tag - - list->q make-q* - - - make-time-segment time-segment? - time-segment-time time-segment-queue - - time< time= time<= time-delta+ - time-minus time-plus - - - make-time-delta tdelta time-delta? - time-delta-sec time-delta-usec - - - make-schedule schedule? - schedule-add! schedule-empty? - schedule-segments - schedule-soonest-time - - schedule-segments-split schedule-extract-until! - add-segments-contents-to-queue! - - %8sync - - - make-run-request run-request? - run-request-proc run-request-when - - - make-port-request port-request port-request? - port-request-port - port-request-read port-request-write port-request-except - - run-it wrap wrap-apply run run-at run-delay - - %port-request %run %run-at %run-delay - - catch-8sync catch-%8sync - - ;; used for introspecting the error, but a method for making - ;; is not exposed - wrapped-exception? - wrapped-exception-key wrapped-exception-args - wrapped-exception-stacks - - print-error-and-continue - - %current-agenda - start-agenda agenda-run-once)) - -;; @@: Using immutable agendas here, so wouldn't it make sense to -;; replace this queue stuff with using pfds based immutable queues? - - -;;; Agenda definition -;;; ================= - -;;; The agenda consists of: -;;; - a queue of immediate items to handle -;;; - sheduled future events to be added to a future queue -;;; - a tag by which running processes can escape for some asynchronous -;;; operation (from which they can be returned later) -;;; - a mapping of ports to various handler procedures -;;; -;;; The goal, eventually, is for this all to be immutable and functional. -;;; However, we aren't there yet. Some tricky things: -;;; - The schedule needs to be immutable, yet reasonably efficient. -;;; - Need to use immutable queues (ijp's pfds library?) -;;; - Modeling reading from ports as something repeatable, -;;; and with reasonable separation from functional components? - -(define-immutable-record-type - (make-agenda-intern queue prompt-tag - read-port-map write-port-map except-port-map - schedule time catch-handler pre-unwind-handler) - agenda? - (queue agenda-queue) - (prompt-tag agenda-prompt-tag) - (read-port-map agenda-read-port-map) - (write-port-map agenda-write-port-map) - (except-port-map agenda-except-port-map) - (schedule agenda-schedule) - (time agenda-time) - (catch-handler agenda-catch-handler) - (pre-unwind-handler agenda-pre-unwind-handler)) - -(define (make-async-prompt-tag) - "Make an async prompt tag for an agenda. - -Generally done automatically for the user through (make-agenda)." - (make-prompt-tag "prompt")) - -(define* (make-agenda #:key - (queue (make-q)) - (prompt (make-prompt-tag)) - (read-port-map (make-hash-table)) - (write-port-map (make-hash-table)) - (except-port-map (make-hash-table)) - (schedule (make-schedule)) - (time (gettimeofday)) - (catch-handler #f) - (pre-unwind-handler #f)) - ;; TODO: document arguments - "Make a fresh agenda." - (make-agenda-intern queue prompt - read-port-map write-port-map except-port-map - schedule time - catch-handler pre-unwind-handler)) - -(define (current-agenda-prompt) - "Get the prompt for the current agenda; signal an error if there isn't one." - (let ((current-agenda (%current-agenda))) - (if (not current-agenda) - (throw - 'no-current-agenda - "Can't get current agenda prompt if there's no current agenda!") - (agenda-prompt-tag current-agenda)))) - -;; helper for making queues for an agenda -(define (list->q lst) - "Makes a queue composed of LST items" - (let ((q (make-q))) - (for-each - (lambda (x) - (enq! q x)) - lst) - q)) - -(define (make-q* . args) - "Makes a queue and populates it with this invocation's ARGS" - (list->q args)) - - -;;; Schedule -;;; ======== - -;;; This is where we handle timed events for the future - -;; This section totally borrows from the ideas in SICP -;; <3 <3 <3 - -;; NOTE: time is a cons of (seconds . microseconds) - -(define-record-type - (make-time-segment-intern time queue) - time-segment? - (time time-segment-time) - (queue time-segment-queue)) - -;; @@: This seems to be the same as srfi-18's seconds->time procedure? -;; Maybe double check and switch to that? (Thanks amz3!) - -(define (time-from-float-or-fraction time) - "Produce a (sec . usec) pair from TIME, a float or fraction" - (let* ((mixed-whole (floor time)) - (mixed-rest (- time mixed-whole)) ; float or fraction component - (sec mixed-whole) - (usec (floor (* 1000000 mixed-rest)))) - (cons (inexact->exact sec) (inexact->exact usec)))) - -(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) - ;; time was just an integer (just the second) - ((? integer? _) (cons time 0)) - ((or (? rational? _) (? inexact? _)) - (time-from-float-or-fraction time)) - (_ (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) - "Check if TIME1 is less than TIME2" - (cond ((< (car time1) - (car time2)) - #t) - ((and (= (car time1) - (car time2)) - (< (cdr time1) - (cdr time2))) - #t) - (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) - "Check if TIME1 is less than or equal to TIME2" - (or (time< time1 time2) - (time= time1 time2))) - - -(define-record-type - (make-time-delta-intern sec usec) - time-delta? - (sec time-delta-sec) - (usec time-delta-usec)) - -(define* (make-time-delta time) - "Make a of SEC seconds and USEC microseconds. - -This is used primarily so the agenda can recognize RUN-REQUEST objects -which are meant to delay computation" - (match (time-segment-right-format time) - ((sec . usec) - (make-time-delta-intern sec usec)))) - -(define tdelta make-time-delta) - -(define (time-carry-correct time) - "Corrects/handles time microsecond carry. -Will produce (0 . 0) instead of a negative number, if needed." - (cond ((>= (cdr time) 1000000) - (cons - (+ (car time) 1) - (- (cdr time) 1000000))) - ((< (cdr time) 0) - (if (= (car time) 0) - '(0 0) - (cons - (- (car time) 1) - (+ (cdr time) 1000000)))) - (else time))) - -(define (time-delta+ time time-delta) - "Increment a TIME by the value of TIME-DELTA" - (time-carry-correct - (cons (+ (car time) (time-delta-sec time-delta)) - (+ (cdr time) (time-delta-usec time-delta))))) - -(define (time-minus time1 time2) - "Subtract TIME2 from TIME1" - (time-carry-correct - (cons (- (car time1) (car time2)) - (- (cdr time1) (cdr time2))))) - -(define (time-plus time1 time2) - "Add TIME1 and TIME2" - (time-carry-correct - (cons (+ (car time1) (car time2)) - (+ (cdr time1) (cdr time2))))) - - -(define-record-type - (make-schedule-intern segments) - schedule? - (segments schedule-segments set-schedule-segments!)) - -(define* (make-schedule #:optional segments) - "Make a schedule, optionally pre-composed of SEGMENTS" - (make-schedule-intern (or segments '()))) - -(define (schedule-soonest-time schedule) - "Return a cons of (sec . usec) for next time segement, or #f if none" - (let ((segments (schedule-segments schedule))) - (if (eq? segments '()) - #f - (time-segment-time (car segments))))) - -;; TODO: This code is reasonably easy to read but it -;; mutates AND is worst case of O(n) in both space and time :( -;; but at least it'll be reasonably easy to refactor to -;; a more functional setup? -(define (schedule-add! schedule time proc) - "Mutate SCHEDULE, adding PROC at an appropriate time segment for TIME" - (let ((time (time-segment-right-format time))) - (define (new-time-segment) - (let ((new-segment - (make-time-segment time))) - (enq! (time-segment-queue new-segment) proc) - new-segment)) - (define (loop segments) - (define (segment-equals-time? segment) - (time= time (time-segment-time segment))) - - (define (segment-more-than-time? segment) - (time< time (time-segment-time segment))) - - ;; We could switch this out to be more mutate'y - ;; and avoid the O(n) of space... is that over-optimizing? - (match segments - ;; If we're at the end of the list, time to make a new - ;; segment... - ('() (cons (new-time-segment) '())) - ;; If the segment's time is exactly our time, good news - ;; everyone! Let's append our stuff to its queue - (((? segment-equals-time? first) rest ...) - (enq! (time-segment-queue first) proc) - segments) - ;; If the first segment is more than our time, - ;; ours belongs before this one, so add it and - ;; start consing our way back - (((? segment-more-than-time? first) rest ...) - (cons (new-time-segment) segments)) - ;; Otherwise, build up recursive result - ((first rest ... ) - (cons first (loop rest))))) - (set-schedule-segments! - schedule - (loop (schedule-segments schedule))))) - -(define (schedule-empty? schedule) - "Check if the SCHEDULE is currently empty" - (eq? (schedule-segments schedule) '())) - -(define (schedule-segments-split schedule time) - "Does a multiple value return of time segments before/at and after TIME" - (let ((time (time-segment-right-format time))) - (define (segment-is-now? segment) - (time= (time-segment-time segment) time)) - (define (segment-is-before-now? segment) - (time< (time-segment-time segment) time)) - - (let loop ((segments-before '()) - (segments-left (schedule-segments schedule))) - (match segments-left - ;; end of the line, return - ('() - (values (reverse segments-before) '())) - - ;; It's right now, so time to stop, but include this one in before - ;; but otherwise return - (((? segment-is-now? first) rest ...) - (values (reverse (cons first segments-before)) rest)) - - ;; This is prior or at now, so add it and keep going - (((? segment-is-before-now? first) rest ...) - (loop (cons first segments-before) rest)) - - ;; Otherwise it's past now, just return what we have - (segments-after - (values segments-before segments-after)))))) - -(define (schedule-extract-until! schedule time) - "Extract all segments until TIME from SCHEDULE, and pop old segments off" - (receive (segments-before segments-after) - (schedule-segments-split schedule time) - (set-schedule-segments! schedule segments-after) - segments-before)) - -(define (add-segments-contents-to-queue! segments queue) - (for-each - (lambda (segment) - (let ((seg-queue (time-segment-queue segment))) - (while (not (q-empty? seg-queue)) - (enq! queue (deq! seg-queue))))) - segments)) - - - -;;; Request to run stuff -;;; ==================== - -(define-record-type - (make-run-request proc when) - run-request? - (proc run-request-proc) - (when run-request-when)) - -(define* (run-it proc #:optional when) - "Make a request to run PROC (possibly at WHEN)" - (make-run-request proc when)) - -(define-syntax-rule (wrap body ...) - "Wrap contents in a procedure" - (lambda () - body ...)) - -(define-syntax-rule (wrap-apply body) - "Wrap possibly multi-value function in a procedure, applies all arguments" - (lambda args - (apply body args))) - - -;; @@: Do we really want `body ...' here? -;; what about just `body'? -(define-syntax-rule (run body ...) - "Run everything in BODY but wrap in a convenient procedure" - (make-run-request (wrap body ...) #f)) - -(define-syntax-rule (run-at body ... when) - "Run BODY at WHEN" - (make-run-request (wrap body ...) when)) - -;; @@: Is it okay to overload the term "delay" like this? -;; Would `run-in' be better? -(define-syntax-rule (run-delay body ... delay-time) - "Run BODY at DELAY-TIME time from now" - (make-run-request (wrap body ...) (tdelta delay-time))) - - -;; A request to set up a port with at least one of read, write, except -;; handling processes - -(define-record-type - (make-port-request-intern port read write except) - port-request? - (port port-request-port) - (read port-request-read) - (write port-request-write) - (except port-request-except)) - -(define* (make-port-request port #:key read write except) - (if (not (or read write except)) - (throw 'no-port-handler-given "No port handler given.\n")) - (make-port-request-intern port read write except)) - -(define port-request make-port-request) - - - -;;; Asynchronous escape to run things -;;; ================================= - -(define-syntax-rule (%8sync async-request) - "Run BODY asynchronously at a prompt, passing args to make-future. - -Runs things asynchronously (8synchronously?)" - (propagate-%async-exceptions - (abort-to-prompt (current-agenda-prompt) - async-request))) - -;; Async port request and run-request meta-requests -(define (make-async-request proc) - "Wrap PROC in an async-request - -The purpose of this is to make sure that users don't accidentally -return the wrong thing via (%8sync) and trip themselves up." - (cons '*async-request* proc)) - -(define (setup-async-request resume-kont async-request) - "Complete an async request for agenda-run-once's continuation handling" - (match async-request - (('*async-request* . async-setup-proc) - (async-setup-proc resume-kont)) - ;; TODO: deliver more helpful errors depending on what the user - ;; returned - (_ (throw 'invalid-async-request - "Invalid request passed back via an (%8sync) procedure." - async-request)))) - -(define-record-type - (make-wrapped-exception key args stacks) - wrapped-exception? - (key wrapped-exception-key) - (args wrapped-exception-args) - (stacks wrapped-exception-stacks)) - -(define-syntax-rule (propagate-%async-exceptions body) - (let ((body-result body)) - (if (wrapped-exception? body-result) - (throw '8sync-caught-error - (wrapped-exception-key body-result) - (wrapped-exception-args body-result) - (wrapped-exception-stacks body-result)) - body-result))) - -(define-syntax-rule (%run body ...) - (%run-at body ... #f)) - -(define-syntax-rule (%run-at body ... when) - ;; Send an asynchronous request to apply a continuation to the - ;; following function, then handle that as a request to the agenda - (make-async-request - (lambda (kont) - ;; We're making a run request - (make-run-request - ;; Wrapping the following execution to run... - (wrap - ;; Once we get the result from the inner part, we'll resume - ;; this continuation, but first - ;; @@: Is this running immediately, or queueing the result - ;; after evaluation for the next agenda tick? It looks - ;; like evaluating immediately. Is that what we want? - (kont - ;; Any unhandled errors are caught - (let ((exception-stack #f)) - (catch #t - ;; Run the actual code the user requested - (lambda () - body ...) - ;; If something bad happened and we didn't catch it, - ;; we'll wrap it up in such a way that the continuation - ;; can address it - (lambda (key . args) - (cond - ((eq? key '8sync-caught-error) - (match args - ((orig-key orig-args orig-stacks) - (make-wrapped-exception - orig-key orig-args - (cons exception-stack orig-stacks))))) - (else - (make-wrapped-exception key args - (list exception-stack))))) - (lambda _ - (set! exception-stack (make-stack #t 1 0))))))) - when)))) - -(define-syntax-rule (%run-delay body ... delay-time) - (%run-at body ... (tdelta delay-time))) - -(define-syntax-rule (%port-request add-this-port port-request-args ...) - (make-async-request - (lambda (kont) - (list (make-port-request port-request-args ...) - (make-run-request kont))))) - -;; TODO -(define-syntax-rule (%run-with-return return body ...) - (make-async-request - (lambda (kont) - (let ((return kont)) - (lambda () - body ...))))) - -(define-syntax-rule (catch-8sync exp (handler-key handler) ...) - (catch '8sync-caught-error - (lambda () - exp) - (lambda (_ orig-key orig-args orig-stacks) - (cond - ((or (eq? handler-key #t) - (eq? orig-key handler-key)) - (apply handler orig-stacks orig-args)) ... - (else (raise '8sync-caught-error - orig-key orig-args orig-stacks)))))) - -;; Alias...? -(define-syntax-rule (catch-%8sync rest ...) - (catch-8sync rest ...)) - - - -;;; Execution of agenda, and current agenda -;;; ======================================= - -(define %current-agenda (make-parameter #f)) - -(define (update-agenda-from-select! agenda) - "Potentially (select) on ports specified in agenda, adding items to queue" - (define (hash-keys hash) - (hash-map->list (lambda (k v) k) hash)) - (define (get-wait-time) - ;; TODO: we need to figure this out based on whether there's anything - ;; in the queue, and if not, how long till the next scheduled item - (let ((soonest-time (schedule-soonest-time (agenda-schedule agenda)))) - (cond - ((not (q-empty? (agenda-queue agenda))) - (cons 0 0)) - (soonest-time ; ie, the agenda is non-empty - (let* ((current-time (agenda-time agenda))) - (if (time<= soonest-time current-time) - ;; Well there's something due so let's select - ;; (this avoids a (possible?) race condition chance) - (cons 0 0) - (time-minus soonest-time current-time)))) - (else - (cons #f #f))))) - (define (do-select) - ;; TODO: support usecond wait time too - (match (get-wait-time) - ((sec . usec) - (catch 'system-error - (lambda () - (select (hash-keys (agenda-read-port-map agenda)) - (hash-keys (agenda-write-port-map agenda)) - (hash-keys (agenda-except-port-map agenda)) - sec usec)) - (lambda (key . rest-args) - (match rest-args - ((_ _ _ (EINTR)) - '(() () ())) - (_ (error "Unhandled error in select!" key rest-args)))))))) - (define (get-procs-to-run) - (define (ports->procs ports port-map) - (lambda (initial-procs) - (fold - (lambda (port prev) - (cons (lambda () - ((hash-ref port-map port) port)) - prev)) - initial-procs - ports))) - (match (do-select) - ((read-ports write-ports except-ports) - ;; @@: Come on, we can do better than append ;P - ((compose (ports->procs - read-ports - (agenda-read-port-map agenda)) - (ports->procs - write-ports - (agenda-write-port-map agenda)) - (ports->procs - except-ports - (agenda-except-port-map agenda))) - '())))) - (define (update-agenda) - (let ((procs-to-run (get-procs-to-run)) - (q (agenda-queue agenda))) - (for-each - (lambda (proc) - (enq! q proc)) - procs-to-run)) - agenda) - (define (ports-to-select?) - (define (has-items? selector) - ;; @@: O(n) - ;; ... we could use hash-for-each and a continuation to jump - ;; out with a #t at first indication of an item - (not (= (hash-count (const #t) - (selector agenda)) - 0))) - (or (has-items? agenda-read-port-map) - (has-items? agenda-write-port-map) - (has-items? agenda-except-port-map))) - - (if (ports-to-select?) - (update-agenda) - agenda)) - -(define (agenda-handle-port-request! agenda port-request) - "Update an agenda for a port-request" - (define (handle-selector request-selector port-map-selector) - (if (request-selector port-request) - (hash-set! (port-map-selector agenda) - (port-request-port port-request) - (request-selector port-request)))) - (handle-selector port-request-read agenda-read-port-map) - (handle-selector port-request-write agenda-write-port-map) - (handle-selector port-request-except agenda-except-port-map)) - - -(define* (start-agenda agenda - #:key stop-condition - (get-time gettimeofday) - (handle-ports update-agenda-from-select!)) - ;; TODO: Document fields - "Start up the AGENDA" - (let loop ((agenda agenda)) - (let ((agenda - ;; @@: Hm, maybe here would be a great place to handle - ;; select'ing on ports. - ;; We could compose over agenda-run-once and agenda-read-ports - (agenda-run-once agenda))) - (if (and stop-condition (stop-condition agenda)) - 'done - (let* ((agenda - ;; We have to update the time after ports handled, too - ;; because it may have changed after a select - (set-field - (handle-ports - ;; Adjust the agenda's time just in time - ;; We do this here rather than in agenda-run-once to make - ;; agenda-run-once's behavior fairly predictable - (set-field agenda (agenda-time) (get-time))) - (agenda-time) (get-time)))) - ;; Update the agenda's current queue based on - ;; currently applicable time segments - (add-segments-contents-to-queue! - (schedule-extract-until! (agenda-schedule agenda) (agenda-time agenda)) - (agenda-queue agenda)) - (loop agenda)))))) - -(define (print-error-and-continue key . args) - "Frequently used as pre-unwind-handler for agenda" - (cond - ((eq? key '8sync-caught-error) - (match args - ((orig-key orig-args stacks) - (display "\n*** Caught async exception. ***\n") - (format (current-error-port) - "* Original key '~s and arguments: ~s *\n" - orig-key orig-args) - (display "* Caught stacks below (ending with original) *\n\n") - (for-each - (lambda (s) - (display-backtrace s (current-error-port)) - (newline (current-error-port))) - stacks)))) - (else - (format (current-error-port) - "\n*** Caught exception with key '~s and arguments: ~s ***\n" - key args) - (display-backtrace (make-stack #t 1 0) - (current-error-port)) - (newline (current-error-port))))) - -(define-syntax-rule (maybe-catch-all (catch-handler pre-unwind-handler) - body ...) - (if (or catch-handler pre-unwind-handler) - (catch - #t - (lambda () - body ...) - (or catch-handler (lambda _ #f)) - (or pre-unwind-handler (lambda _ #f))) - (begin body ...))) - -(define (agenda-run-once agenda) - "Run once through the agenda, and produce a new agenda -based on the results" - (define (call-proc proc) - (call-with-prompt - (agenda-prompt-tag agenda) - (lambda () - (parameterize ((%current-agenda agenda)) - (maybe-catch-all - ((agenda-catch-handler agenda) - (agenda-pre-unwind-handler agenda)) - (proc)))) - (lambda (kont async-request) - (setup-async-request kont async-request)))) - - (let ((queue (agenda-queue agenda)) - (next-queue (make-q))) - (while (not (q-empty? queue)) - (let* ((proc (q-pop! queue)) - (proc-result (call-proc proc)) - (enqueue - (lambda (run-request) - (define (schedule-at! time proc) - (schedule-add! (agenda-schedule agenda) time proc)) - (let ((request-time (run-request-when run-request))) - (match request-time - ((? time-delta? time-delta) - (let ((time (time-delta+ (agenda-time agenda) - time-delta))) - (schedule-at! time (run-request-proc run-request)))) - ((? integer? sec) - (let ((time (cons sec 0))) - (schedule-at! time (run-request-proc run-request)))) - (((? integer? sec) . (? integer? usec)) - (schedule-at! request-time (run-request-proc run-request))) - (#f - (enq! next-queue (run-request-proc run-request)))))))) - (define (handle-individual result) - (match result - ((? run-request? new-proc) - (enqueue new-proc)) - ((? port-request? port-request) - (agenda-handle-port-request! agenda port-request)) - ;; do nothing - (_ #f))) - ;; @@: We might support delay-wrapped procedures here - (match proc-result - ((results ...) - (for-each handle-individual results)) - (one-result (handle-individual one-result))))) - ;; TODO: Alternately, we could return the next-queue - ;; along with changes to be added to the schedule here? - ;; Return new agenda, with next queue set - (set-field agenda (agenda-queue) next-queue))) diff --git a/eightsync/repl.scm b/eightsync/repl.scm deleted file mode 100644 index 37b843f..0000000 --- a/eightsync/repl.scm +++ /dev/null @@ -1,39 +0,0 @@ -;;; 8sync --- Asynchronous programming for Guile -;;; Copyright (C) 2015 Christopher Allan Webber -;;; -;;; This file is part of 8sync. -;;; -;;; 8sync is free software: you can redistribute it and/or modify it -;;; under the terms of the GNU Lesser General Public License as -;;; published by the Free Software Foundation, either version 3 of the -;;; License, or (at your option) any later version. -;;; -;;; 8sync is distributed in the hope that it will be useful, -;;; but WITHOUT ANY WARRANTY; without even the implied warranty of -;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -;;; GNU Lesser General Public License for more details. -;;; -;;; You should have received a copy of the GNU Lesser General Public -;;; License along with 8sync. If not, see . - -(define-module (eightsync repl) - #:use-module (ice-9 q) - #:use-module (eightsync agenda) - #:use-module (system repl coop-server) - #:export (make-coop-server-handler - spawn-and-queue-repl-server!)) - -(define (make-coop-server-handler coop-server) - (define (run-self) - (poll-coop-repl-server coop-server) - ;; queue ourselves again - (run-delay (run-self) (/ 1 30))) - run-self) - -(define* (spawn-and-queue-repl-server! agenda #:optional port) - (let ((coop-server - (if port - (spawn-coop-repl-server port) - (spawn-coop-repl-server)))) - (enq! (agenda-queue agenda) - (make-coop-server-handler coop-server)))) diff --git a/eightsync/systems/irc.scm b/eightsync/systems/irc.scm deleted file mode 100755 index c872b46..0000000 --- a/eightsync/systems/irc.scm +++ /dev/null @@ -1,316 +0,0 @@ -#!/usr/bin/guile \ --e main -s -!# - -;;; 8sync --- Asynchronous programming for Guile -;;; Copyright (C) 2015 Christopher Allan Webber -;;; -;;; This file is part of 8sync. -;;; -;;; 8sync is free software: you can redistribute it and/or modify it -;;; under the terms of the GNU Lesser General Public License as -;;; published by the Free Software Foundation, either version 3 of the -;;; License, or (at your option) any later version. -;;; -;;; 8sync is distributed in the hope that it will be useful, -;;; but WITHOUT ANY WARRANTY; without even the implied warranty of -;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -;;; GNU Lesser General Public License for more details. -;;; -;;; You should have received a copy of the GNU Lesser General Public -;;; License along with 8sync. If not, see . - -(define-module (eightsync systems irc) - #:use-module (eightsync repl) - #:use-module (eightsync agenda) - #:use-module (srfi srfi-9) - #:use-module (ice-9 getopt-long) - #:use-module (ice-9 format) - #:use-module (ice-9 receive) - #:use-module (ice-9 q) - #:use-module (ice-9 match) - #:export (;; The only things you definitely need if writing a bot - make-irc-bot-cli - irc-format irc-display irc-send-message irc-send-formatted - - ;; Useful things if you're making something more complicated - irc-line - irc-eol - - default-irc-port - - startswith-colon? - - - make-irc-line irc-line? - irc-line-prefix irc-line-command irc-line-params - - parse-line - irc-line-username - - condense-privmsg-line - echo-back-message - - make-handle-line make-basic-irc-handler - queue-and-start-irc-agenda!)) - - -;;; Network stuff -;;; ============= - -(define default-irc-port 6665) - -(define* (irc-socket-setup hostname #:optional (inet-port default-irc-port)) - (let ((s (socket PF_INET SOCK_STREAM 0)) - (ip-address (inet-ntoa (car (hostent:addr-list (gethost hostname)))))) - (connect s AF_INET - (inet-pton AF_INET ip-address) - inet-port) - s)) - -(define (install-socket socket handler) - (display "Installing socket...\n") ; debugging :) - (make-port-request socket #:read handler)) - -(define irc-eol "\r\n") - -(define (irc-line line) - (string-concatenate (list line irc-eol))) - -(define-syntax-rule (irc-format dest format-string rest ...) - (let ((line (string-concatenate - (list (format #f format-string rest ...) - irc-eol)))) - (match dest - (#f line) - (#t (display line)) - (else - (display line dest))))) - -(define* (irc-display line #:optional dest) - (if dest - (display (irc-line line) dest) - (display (irc-line dest)))) - -(define (irc-send-message socket channel message) - (irc-format socket "PRIVMSG ~a :~a" channel message)) - -(define-syntax-rule (irc-send-formatted socket channel format-string - args ...) - (irc-format socket "PRIVMSG ~a :~a" channel - (format #f format-string args ...))) - -(define* (handle-login socket username - #:key - (hostname "*") - (servername "*") - (realname username) - (channels '())) - (irc-format socket "USER ~a ~a ~a :~a" - username hostname servername realname) - (irc-format socket "NICK ~a" username) - (for-each - (lambda (channel) - (irc-format socket "JOIN ~a" channel)) - channels)) - -(define (startswith-colon? str) - (and (> (string-length str) 0) - (eq? (string-ref str 0) - #\:))) - -(define-record-type - (make-irc-line prefix command params) - irc-line? - (prefix irc-line-prefix) - (command irc-line-command) - (params irc-line-params)) - - -(define (parse-line line) - (define (parse-params pre-params) - ;; This is stupid and imperative but I can't wrap my brain around - ;; the right way to do it in a functional way :\ - (let ((param-list '()) - (currently-building '())) - (for-each - (lambda (param-item) - (cond - ((startswith-colon? param-item) - (if (not (eq? currently-building '())) - (set! param-list - (cons - (reverse currently-building) - param-list))) - (set! currently-building (list param-item))) - (else - (set! currently-building (cons param-item currently-building))))) - pre-params) - ;; We're still building something, so tack that on there - (if (not (eq? currently-building '())) - (set! param-list - (cons (reverse currently-building) param-list))) - ;; return the reverse of the param list - (reverse param-list))) - - (match (string-split line #\space) - (((? startswith-colon? prefix) - command - pre-params ...) - (make-irc-line prefix command - (parse-params pre-params))) - ((command pre-params ...) - (make-irc-line #f command - (parse-params pre-params))))) - -(define (strip-colon-if-necessary string) - (if (and (> (string-length string) 0) - (string-ref string 0)) - (substring/copy string 1) - string)) - -;; @@: Not sure if this works in all cases, like what about in a non-privmsg one? -(define (irc-line-username irc-line) - (let* ((prefix-name (strip-colon-if-necessary (irc-line-prefix irc-line))) - (exclaim-index (string-index prefix-name #\!))) - (if exclaim-index - (substring/copy prefix-name 0 exclaim-index) - prefix-name))) - -(define (condense-privmsg-line line) - "Condense message line and do multiple value return of - (channel message is-action)" - (define (strip-last-char string) - (substring/copy string 0 (- (string-length string) 1))) - (let* ((channel-name (caar line)) - (rest-params (apply append (cdr line)))) - (match rest-params - (((or "\x01ACTION" ":\x01ACTION") middle-words ... (= strip-last-char last-word)) - (values channel-name - (string-join - (append middle-words (list last-word)) - " ") - #t)) - (((= strip-colon-if-necessary first-word) rest-message ...) - (values channel-name - (string-join (cons first-word rest-message) " ") - #f))))) - -(define (echo-back-message socket my-name speaker - channel-name message is-action) - (if is-action - (format #t "~a emoted ~s in channel ~a\n" - speaker message channel-name) - (format #t "~a said ~s in channel ~a\n" - speaker message channel-name))) - -(define default-handle-privmsg echo-back-message) - -(define* (make-handle-line #:key - (handle-privmsg default-handle-privmsg)) - (define (handle-line socket line my-username) - (let ((parsed-line (parse-line line))) - (match (irc-line-command parsed-line) - ("PING" - (irc-display "PONG" socket)) - ("PRIVMSG" - (receive (channel-name message is-action) - (condense-privmsg-line (irc-line-params parsed-line)) - (let ((username (irc-line-username parsed-line))) - (handle-privmsg socket my-username username - channel-name message is-action)))) - (_ - (display line) - (newline))))) - handle-line) - -(define (make-basic-irc-handler handle-line username) - (let ((buffer '())) - (define (reset-buffer) - (set! buffer '())) - (define (should-read-char socket) - (and (char-ready? socket) (not (eof-object? (peek-char socket))))) - (define (irc-handler socket) - (while (should-read-char socket) - (set! buffer (cons (read-char socket) buffer)) - (match buffer - ((#\newline #\return (? char? line-chars) ...) - (let ((ready-line (list->string (reverse line-chars)))) - ;; reset buffer - (set! buffer '()) - ;; run it - (%8sync (%run (handle-line - socket - ready-line - username))))) - (_ #f)))) - irc-handler)) - -(define default-line-handler (make-handle-line)) - -(define* (queue-and-start-irc-agenda! agenda socket #:key - (username "syncbot") - (inet-port default-irc-port) - (line-handler default-line-handler) - (channels '())) - (dynamic-wind - (lambda () #f) - (lambda () - (enq! (agenda-queue agenda) - (wrap (install-socket - socket - (make-basic-irc-handler - line-handler - username)))) - (enq! (agenda-queue agenda) (wrap (handle-login socket username - #:channels channels))) - (start-agenda agenda)) - (lambda () - (display "Cleaning up...\n") - (close socket)))) - - - -;;; CLI -;;; === - -(define option-spec - `((server (single-char #\s) (required? #t) (value #t)) - (port (single-char #\p) - (value #t) - (predicate - ,(lambda (s) - (if (string->number s) #t #f)))) - (username (single-char #\u) (required? #t) (value #t)) - (channels (value #t)) - (listen))) - -(define* (make-irc-bot-cli #:optional - (line-handler default-line-handler) - (print-and-continue-on-error #t)) - (define (main args) - (let* ((options (getopt-long args option-spec)) - (hostname (option-ref options 'server #f)) - (port (or (option-ref options 'port #f) - default-irc-port)) - (username (option-ref options 'username #f)) - (listen (option-ref options 'listen #f)) - (channels (option-ref options 'channels "")) - (agenda (if print-and-continue-on-error - (make-agenda #:pre-unwind-handler print-error-and-continue) - (make-agenda)))) - (display `((server ,hostname) (port ,port) (username ,username) - (listen ,listen) (channels-split ,(string-split channels #\space)))) - (newline) - (if listen - (spawn-and-queue-repl-server! agenda)) - (queue-and-start-irc-agenda! - agenda - (irc-socket-setup hostname port) - #:inet-port port - #:username username - #:channels (string-split channels #\space) - #:line-handler line-handler))) - main) - -(define main (make-irc-bot-cli)) diff --git a/tests/test-agenda.scm b/tests/test-agenda.scm index 3011a86..f6a57c1 100644 --- a/tests/test-agenda.scm +++ b/tests/test-agenda.scm @@ -24,7 +24,7 @@ #:use-module (srfi srfi-64) #:use-module (ice-9 q) #:use-module (ice-9 receive) - #:use-module (eightsync agenda) + #:use-module (8sync agenda) #:use-module (tests utils)) (test-begin "test-agenda") @@ -262,7 +262,7 @@ (define (test-%run-and-friends async-request expected-when) (let* ((fake-kont (speak-it)) - (run-request ((@@ (eightsync agenda) setup-async-request) + (run-request ((@@ (8sync agenda) setup-async-request) fake-kont async-request))) (test-equal (car async-request) '*async-request*) (test-equal (run-request-when run-request) expected-when)