source: project/release/4/dbus/trunk/dbus.scm @ 31085

Last change on this file since 31085 was 31085, checked in by ecloud, 6 years ago

default-signal-handler is a parameter taking a single-arg function to handle warnings

Preformatting the warnings is nice but maybe the individual args are more useful.

File size: 35.1 KB
Line 
1;;;; dbus.scm
2
3(module dbus (make-context
4                send
5                call
6                make-method-proxy
7                register-signal-handler
8                register-method
9                enable-polling-thread!
10                poll-for-message
11                discover-services
12                discover-api-xml
13                dbus-service
14                session-bus
15                system-bus
16                starter-bus
17                known-bus-count
18                bus-name
19                ; register-path ; disabled for now due to https://bugs.call-cc.org/ticket/850
20                unsupported-type?
21                unsupported-type-signature
22                default-signal-handler
23
24                make-variant
25                variant?
26                variant-data
27                auto-unbox-variants
28
29                make-struct
30                struct?
31                struct-ref
32                struct-set!
33                auto-unbox-structs
34                vector->struct
35                struct->vector
36
37                string->object-path
38                object-path?
39                object-path->string
40                auto-unbox-object-paths
41        )
42        (import scheme chicken extras
43                (except foreign foreign-declare)
44                foreigners
45                easyffi
46                miscmacros)
47        (use srfi-18)
48
49#>
50        #include <dbus/dbus.h>
51        #include <stdbool.h>
52        #include <stdint.h>
53        #include <fcntl.h>
54        #include <unistd.h>
55
56        static DBusError err;
57<#
58
59;; A disjoint type to represent any kind of dbus data type
60;; which this egg so far does not support.  The signature
61;; is the ASCII string to represent that type on-the-wire.
62(define-record-type unsupported-type
63        (make-unsupported-type signature)
64        unsupported-type?
65        (signature unsupported-type-signature))
66(define-record-printer (unsupported-type d out)
67        (fprintf out "#<unsupported-type ~s>" (unsupported-type-signature d)))
68
69;; Object path is a string which is a dbus path
70(define-record-type object-path
71        (string->object-path str)
72        object-path?
73        (str object-path->string))
74(define-record-printer (object-path d out)
75        (fprintf out "#<object-path ~s>" (object-path->string d)))
76(define auto-unbox-object-paths (make-parameter #f))
77
78;; Scheme is a dynamically typed language, so fundamentally we don't
79;; have a use for the "variant" concept; but since dbus has a variant type,
80;; we need a way of representing one when preparing a message for marshalling.
81(define-record-type variant
82        (make-variant #!optional data)
83        variant?
84        (data variant-data))
85(define-record-printer (variant v out)
86        (fprintf out "#,(variant ~S)" (variant-data v)))
87;; If unboxing is turned on, when a "call"ed dbus service method
88;; returns a variant, it will look as if it was not packaged in a variant at all.
89;; By default this feature is turned off, in the interest of having a
90;; representation that is the same as you will need to build when
91;; you want to send (marshall) a dbus message.  But probably
92;; you want to turn it on for convenience, if you don't care to know
93;; about this low-level detail.
94(define auto-unbox-variants (make-parameter #f))
95
96;; A DBus struct is represented as a vector, but it's tagged for marshalling
97;; record definition as just a wrapped vector
98(define-record-type struct
99        (vector->struct data)
100        struct?
101        (data struct->vector))
102;; now a realistic constructor
103(define (make-struct . fields) (vector->struct (list->vector fields)))
104;; and realistic accessors
105(define (struct-ref struct idx) (vector-ref (struct->vector struct) idx))
106(define (struct-set! struct idx val) (vector-set! (struct->vector struct) idx val))
107;; pretty-printing
108(define-record-printer (struct v out)
109        (fprintf out "#,(struct ~S)" (struct->vector v)))
110;; If unboxing is turned on, when a "call"ed dbus service method
111;; returns a struct, it will look like a vector instead.  This is
112;; convenient if you know what to expect, but otherwise you will
113;; have some difficulty to distinguish a struct from an array.
114;; By default this feature is turned off, in the interest of having a
115;; representation that is the same as you will need to build when
116;; you want to send (marshall) a dbus message.
117(define auto-unbox-structs (make-parameter #f))
118
119; Would want to do this:
120; (define-foreign-enum (bus (enum "DBusBusType"))
121        ; (session-bus DBUS_BUS_SESSION)
122        ; (system-bus DBUS_BUS_SYSTEM)
123        ; (starter-bus DBUS_BUS_STARTER) )
124; but because that enum is typedef'd, chicken has a problem with it.
125
126(define-foreign-type bus int) ; really "DBusBusType"
127(define session-bus (foreign-value DBUS_BUS_SESSION int))
128(define system-bus (foreign-value DBUS_BUS_SYSTEM int))
129(define starter-bus (foreign-value DBUS_BUS_STARTER int))
130(define dbus-service (foreign-value DBUS_SERVICE_DBUS c-string))
131(define known-bus-count (+ 1 (max session-bus system-bus starter-bus)))
132(define (bus-name bus)
133        (cond
134                [(eq? bus session-bus) (format "session bus (~a)" session-bus)]
135                [(eq? bus system-bus) (format "system bus (~a)" system-bus)]
136                [else (format "bus ~a" (car bus))]))
137
138(define-foreign-type handler-result int) ; really "DBusHandlerResult"
139(define result-handled (foreign-value DBUS_HANDLER_RESULT_HANDLED int))
140(define result-not-yet-handled (foreign-value DBUS_HANDLER_RESULT_NOT_YET_HANDLED int))
141(define result-need-memory (foreign-value DBUS_HANDLER_RESULT_NEED_MEMORY int))
142
143(define name-flag-allow-replacement (foreign-value DBUS_NAME_FLAG_ALLOW_REPLACEMENT int))
144(define name-flag-replace-existing (foreign-value DBUS_NAME_FLAG_REPLACE_EXISTING int))
145(define name-flag-do-not-queue (foreign-value DBUS_NAME_FLAG_DO_NOT_QUEUE int))
146
147;; DBus simple data types
148(define type-invalid (foreign-value DBUS_TYPE_INVALID int))
149(define type-byte  (foreign-value DBUS_TYPE_BYTE int))
150(define type-boolean  (foreign-value DBUS_TYPE_BOOLEAN int))
151(define type-int16  (foreign-value DBUS_TYPE_INT16 int))
152(define type-uint16  (foreign-value DBUS_TYPE_UINT16 int))
153(define type-fixnum (foreign-value DBUS_TYPE_INT32 int))
154(define type-int32  (foreign-value DBUS_TYPE_INT32 int))
155(define type-uint32  (foreign-value DBUS_TYPE_UINT32 int))
156(define type-int64  (foreign-value DBUS_TYPE_INT64 int))
157(define type-uint64  (foreign-value DBUS_TYPE_UINT64 int))
158(define type-double  (foreign-value DBUS_TYPE_DOUBLE int))
159(define type-flonum  (foreign-value DBUS_TYPE_DOUBLE int))
160(define type-string  (foreign-value DBUS_TYPE_STRING int))
161(define type-object-path  (foreign-value DBUS_TYPE_OBJECT_PATH int))
162(define type-signature  (foreign-value DBUS_TYPE_SIGNATURE int))
163(define type-array (foreign-value DBUS_TYPE_ARRAY int))
164(define type-dict-entry  (foreign-value DBUS_TYPE_DICT_ENTRY int))
165(define type-dict-entry-begin  (foreign-value DBUS_DICT_ENTRY_BEGIN_CHAR int))
166(define type-dict-entry-end  (foreign-value DBUS_DICT_ENTRY_END_CHAR int))
167(define type-variant (foreign-value DBUS_TYPE_VARIANT int))
168(define type-struct (foreign-value DBUS_TYPE_STRUCT int))
169(define type-struct-begin  (foreign-value DBUS_STRUCT_BEGIN_CHAR int))
170(define type-struct-end  (foreign-value DBUS_STRUCT_END_CHAR int))
171
172(define make-context)
173(define send)
174(define make-method-proxy)
175(define call)
176(define flush)
177(define poll-for-message)
178(define register-signal-handler)
179(define register-method)
180(define register-path)
181(define enable-polling-thread!)
182
183(define add-match)
184(define request-name)
185
186(define find-callback)
187
188(define default-signal-handler (make-parameter #f))
189
190(define-foreign-type error-ptr c-pointer) ;; DBusError*
191(define-foreign-type connection-ptr c-pointer)  ;; DBusConnection*
192(define-foreign-type message-ptr c-pointer)     ;; DBusMessage*
193(define-foreign-type uint-ptr c-pointer)        ;; dbus_uint32_t*
194(define-foreign-type message-iter-ptr c-pointer)        ;; DBusMessageIter*
195(define-foreign-type vtable-ptr c-pointer)      ;; DBusObjectPathVTable*
196
197(define (discover-services #!key (bus session-bus))
198        (let* ([ctxt (make-context
199                                        bus: bus
200                                        service: 'org.freedesktop.DBus
201                                        interface: 'org.freedesktop.DBus
202                                        path: '/org/freedesktop/DBus)]
203                        [services (call ctxt "ListNames")])
204                (and (pair? services) (vector? (car services)) (vector->list (car services)))))
205
206(define discover-api-xml)
207
208(define-external (C_msg_cb (bus bus) (message-ptr msg)) bool
209        (let* ([cb (find-callback bus msg)][found (procedure? cb)])
210                ; (printf "got a message: ~s on bus ~a and found callback ~s~%" msg bus cb)
211                (when found
212                        (cb msg))
213                found
214        ))
215
216(let ([connections '()] ;; an alist mapping bus to DBusConnection ptrs
217                [error (foreign-value "&err" c-pointer)]
218                ;; indices in a "context" vector
219                [context-idx-ID 0]
220                [context-idx-bus 1]
221                [context-idx-service 2]
222                [context-idx-path 3]
223                [context-idx-interface 4]
224                [context-count 0]
225                [default-polling-interval 0.01]
226                [polling-interval (make-vector known-bus-count 0.01)]
227                [polling-enabled (make-vector known-bus-count #t)]
228                [polling-threads (make-vector known-bus-count #f)]
229                ;; will become an assoc tree:
230                ;; bus
231                ;;   path
232                ;;     service (unless it's a signal callback)
233                ;;       interface
234                ;;         method
235                ;;           callback-fn
236                [callbacks-table `((,system-bus . #f) (,session-bus . #f))]
237                [iterm (gensym 'terminiter)] )
238
239    (define (any->string arg)
240                (if (string? arg)
241                        arg
242                        (if (eq? (void) arg)
243                          ""
244                          (format "~a" arg))))
245
246        (define (symbol?->string arg)
247                (if (symbol? arg)
248                        (symbol->string arg)
249                        arg))
250
251        (define (string?->symbol arg)
252                (if (string? arg)
253                        (string->symbol arg)
254                        arg))
255
256        (define (ascii->string a) (string (integer->char a)))
257
258        (define (vector-for-each fn v)
259                (let ([len (vector-length v)])
260                        (let loop ([i 0])
261                                (when (< i len)
262                                        (fn i (vector-ref v i))
263                                        (loop (+ 1 i))))))
264
265        ;; If the assq-list has the given key, replace its value.
266        ;; Else add the key-value pair.
267        (define (asset! alist key val)
268                (let ([pr (assq key alist)])
269                        (if pr
270                                (set-cdr! pr val)
271                                (if (null? (cdar alist))
272                                        (set-car! alist (cons key val))
273                                        (begin
274                                                (set-cdr! alist (cons (car alist) (cdr alist)))
275                                                (set-car! alist (cons key val))) ))))
276
277        ;; The "tree" version of assq: drills down into an assq-tree
278        ;; as directed by the sequence of keys, and returns the value found.
279        ;; #f means not found (so it is not useful to store #f in such a tree).
280        (define (tassq tree . keys)
281                (let ([key-list (if (pair? (car keys)) (car keys) keys)])
282                        (let loop ([rem-keys key-list][subtree tree])
283                                (cond
284                                        [(null? rem-keys)       subtree]
285                                        [(not subtree) #f]
286                                        [else (loop (cdr rem-keys)
287                                                (let ([pr (assq (car rem-keys) subtree)])
288                                                        (and (pair? pr) (cdr pr))))]))))
289
290        ;; The "tree" version of asset!: drills down into an assq-tree
291        ;; as directed by the sequence of keys, making new branches as necessary,
292        ;; and sets the given value as a leaf at that point in the tree.
293        ;; return value is undefined
294        (define (tasset! tree val . keys)
295                (let ([key-list (if (pair? (car keys)) (car keys) keys)])
296                        (let loop ([rem-keys (cdr key-list)]
297                                                [subtree (tassq tree (car key-list))]
298                                                [prev-key (car key-list)]
299                                                [prev-subtree tree])
300; (printf "rem-keys ~s subtree ~s prev-key ~s prev-subtree ~s~%" rem-keys subtree prev-key prev-subtree)
301                                (when (and (not subtree) (pair? rem-keys))
302                                        (set! subtree (list (cons (car rem-keys) #f)))
303; (printf "   creating subtree ~s within ~s~%" subtree prev-subtree)
304                                        (asset! prev-subtree prev-key subtree)
305; (pretty-print prev-subtree)
306                                )
307                                (if (null? rem-keys)
308                                        (asset! prev-subtree prev-key val)
309                                        (loop
310                                                (cdr rem-keys)
311                                                (let ([pr (assq (car rem-keys) subtree)])
312                                                        (unless (pair? pr)
313                                                                (set! pr (cons (car rem-keys) #f))
314                                                                (set-cdr! subtree (cons (car subtree) (cdr subtree)))
315                                                                (set-car! subtree pr) )
316                                                        (cdr pr))
317                                                (car rem-keys)
318                                                subtree )))))
319
320        (define (next-context-ID) (set! context-count (+ 1 context-count)) context-count)
321
322        (define (get-conn bus-type)
323                (let ([conn (assq bus-type connections)])
324                        (if (pair? conn)
325                                (set! conn (cdr conn))
326                                (begin
327                                        (set! conn ((foreign-lambda connection-ptr "dbus_bus_get" bus error-ptr)
328                                                bus-type error) )
329                                        (when conn
330                                                (set! connections (cons (cons bus-type conn) connections)))))
331                        conn))
332
333        (define (conn-or-abort bus-type)
334                (or (get-conn bus-type)
335                        (abort (format "unable to connect to bus ~s~%" bus-type))))
336
337        (define (exists-or-abort datum err-str)
338                (or datum
339                        (abort err-str)))
340
341        ;; params: path interface name
342        ;; todo: garbage-collect this
343        (define make-signal (foreign-lambda message-ptr "dbus_message_new_signal"
344                c-string c-string c-string))
345
346        ;; params: service path interface method-name
347        ;; todo: garbage-collect this
348        (define make-message (foreign-lambda message-ptr "dbus_message_new_method_call"
349                c-string c-string c-string c-string))
350
351        (define make-error
352                (foreign-lambda* (c-pointer (struct "DBusError")) ()
353                 "DBusError err;
354                  dbus_error_init(&err);
355                  C_return(&err);"))
356
357        (define free-error!
358                (foreign-lambda* void (((c-pointer (struct "DBusError")) err))
359                        "dbus_error_free(err);"))
360
361        (define (raise-dbus-error location err)
362                (let ((err-name
363                        ((foreign-lambda* c-string (((c-pointer (struct "DBusError")) err))
364                                          "C_return(err->name);")
365                         err))
366                      (err-message
367                       ((foreign-lambda* c-string (((c-pointer (struct "DBusError")) err))
368                                         "C_return(err->message);")
369                        err)))
370                  (free-error! err)
371                  (signal
372                   (make-composite-condition
373                    (make-property-condition 'dbus-call)
374                    (make-property-condition
375                     'exn
376                     'location location
377                     'message (string-append "(" err-name "): " err-message))))))
378
379        ;; todo: garbage-collect this
380        (define make-iter-append
381                (foreign-lambda* message-iter-ptr ((message-ptr msg))
382                        "DBusMessageIter* iter = malloc(sizeof(DBusMessageIter));
383                        dbus_message_iter_init_append (msg, iter);
384                        C_return (iter);"))
385
386        (define iter-append-basic-string
387                (foreign-lambda* bool ((message-iter-ptr iter) (c-string v))
388                        "C_return (dbus_message_iter_append_basic(iter, DBUS_TYPE_STRING, &v));"))
389
390        (define iter-append-basic-object-path
391                (foreign-lambda* bool ((message-iter-ptr iter) (c-string v))
392                        "C_return (dbus_message_iter_append_basic(iter, DBUS_TYPE_OBJECT_PATH, &v));"))
393
394        (define iter-append-basic-bool
395                (foreign-lambda* bool ((message-iter-ptr iter) (bool v))
396                        "C_return (dbus_message_iter_append_basic(iter, DBUS_TYPE_BOOLEAN, &v));"))
397
398        (define iter-append-basic-int
399                (foreign-lambda* bool ((message-iter-ptr iter) (int v))
400                        "C_return (dbus_message_iter_append_basic(iter, DBUS_TYPE_INT32, &v));"))
401
402        (define iter-append-basic-double
403                (foreign-lambda* bool ((message-iter-ptr iter) (double v))
404                        "C_return (dbus_message_iter_append_basic(iter, DBUS_TYPE_DOUBLE, &v));"))
405
406        (define iter-append-basic-byte
407                (foreign-lambda* bool ((message-iter-ptr iter) (int v))
408                        "C_return (dbus_message_iter_append_basic(iter, DBUS_TYPE_BYTE, &v));"))
409
410        (define iter-append-basic-int16
411                (foreign-lambda* bool ((message-iter-ptr iter) (int v))
412                        "C_return (dbus_message_iter_append_basic(iter, DBUS_TYPE_INT16, &v));"))
413
414        (define iter-append-basic-uint32
415                (foreign-lambda* bool ((message-iter-ptr iter) (unsigned-integer32 v))
416                        "C_return (dbus_message_iter_append_basic(iter, DBUS_TYPE_UINT32, &v));"))
417
418        (define iter-append-basic-uint16
419                (foreign-lambda* bool ((message-iter-ptr iter) (unsigned-short v))
420                        "C_return (dbus_message_iter_append_basic(iter, DBUS_TYPE_UINT16, &v));"))
421
422        (define iter-append-basic-int64
423                (foreign-lambda* bool ((message-iter-ptr iter) (integer64 v))
424                        "C_return (dbus_message_iter_append_basic(iter, DBUS_TYPE_INT64, &v));"))
425
426        (define iter-append-basic-uint64
427                (foreign-lambda* bool ((message-iter-ptr iter) (integer64 v))
428                        "C_return (dbus_message_iter_append_basic(iter, DBUS_TYPE_UINT64, &v));"))
429
430        (define (value-signature val)
431; (printf "value-signature ~s~%" val)
432                (cond
433                        [(string? val) (ascii->string type-string)]
434                        [(object-path? val) (ascii->string type-object-path)]
435                        [(fixnum? val) (ascii->string type-fixnum)]
436                        [(flonum? val) (ascii->string type-flonum)]
437                        [(boolean? val) (ascii->string type-boolean)]
438                        [(variant? val) (ascii->string type-variant)]
439                        [(struct? val) (format "~a~a~a" (ascii->string type-struct-begin)
440                                (apply string-append (map value-signature (vector->list (struct->vector val)))) (ascii->string type-struct-end))]
441                        [(vector? val) (format "~a~a" (ascii->string type-array) (value-signature (vector-ref val 0)))]
442                        ; [(variant? val) (value-signature (variant-data val))]
443                        [(pair? val)
444                                (if (list? val)
445                                        "unsupported" ;; todo
446                                        (format "~a~a~a~a" (integer->char type-dict-entry-begin)
447                                                (value-signature (car val)) (value-signature (cdr val))(integer->char type-dict-entry-end))
448                                )]
449                ))
450
451        (define (iter-append-basic-variant iter val)
452; (printf "iter-append-basic-variant ~s~%" val)
453                (let ([signature (value-signature val)])
454; (printf "iter-append-basic-variant: sig ~s~%" signature)
455                        (let ([container ((foreign-lambda* message-iter-ptr ((message-iter-ptr iter) (c-string signature))
456                                        "DBusMessageIter* container = malloc(sizeof(DBusMessageIter));
457                                        dbus_message_iter_open_container(iter, DBUS_TYPE_VARIANT, signature, container);
458                                        C_return(container);") iter signature)])
459                                (iter-append-basic container val)
460                                ((foreign-lambda* bool ((message-iter-ptr iter)(message-iter-ptr container))
461                                        "bool ret = dbus_message_iter_close_container(iter, container);
462                                        free(container);
463                                        C_return(ret);") iter container) ) ))
464
465        (define (iter-append-basic-struct iter val)
466; (printf "iter-append-basic-struct ~s~%" val)
467                (let ([container ((foreign-lambda* message-iter-ptr ((message-iter-ptr iter))
468                                "DBusMessageIter* container = malloc(sizeof(DBusMessageIter));
469                                dbus_message_iter_open_container(iter, DBUS_TYPE_STRUCT, NULL, container);
470                                C_return(container);") iter)])
471                        (vector-for-each (lambda (i field) (iter-append-basic container field)) val)
472                        ((foreign-lambda* bool ((message-iter-ptr iter)(message-iter-ptr container))
473                                "bool ret = dbus_message_iter_close_container(iter, container);
474                                free(container);
475                                C_return (ret);") iter container) ) )
476
477        (define (iter-append-dict-entry iter pair)
478; (printf "iter-append-dict-entry ~s : ~s~%" (car pair)(cdr pair))
479                (let ([signature (value-signature pair)])
480                        (let ([container ((foreign-lambda* message-iter-ptr ((message-iter-ptr iter) (c-string signature))
481                                        "DBusMessageIter* container = malloc(sizeof(DBusMessageIter));
482                                        dbus_message_iter_open_container(iter, DBUS_TYPE_DICT_ENTRY, NULL, container);
483                                        C_return(container);") iter signature)])
484                                (iter-append-basic container (car pair))
485                                (iter-append-basic container (cdr pair))
486                                ((foreign-lambda* bool ((message-iter-ptr iter)(message-iter-ptr container))
487                                        "bool ret = dbus_message_iter_close_container(iter, container);
488                                        free(container);
489                                        C_return(ret);") iter container) ) ))
490
491        ;; The first element of the vector determines the signature, so all elements must have the same signature.
492        (define (iter-append-uniform-array iter vec)
493; (printf "iter-append-uniform-array ~s~%" vec)
494                (if (> (vector-length vec) 0)
495                        ; (let ([signature (format "~a~a" (ascii->string type-array) (value-signature (vector-ref vec 0)))])
496                        (let ([signature (value-signature (vector-ref vec 0))])
497; (printf "value signature ~s~%" signature)
498                                (let ([container ((foreign-lambda* message-iter-ptr ((message-iter-ptr iter) (c-string signature))
499                                                "DBusMessageIter* container = malloc(sizeof(DBusMessageIter));
500                                                dbus_message_iter_open_container(iter, DBUS_TYPE_ARRAY, signature, container);
501                                                C_return(container);") iter signature)])
502                                        (vector-for-each (lambda (i val)
503; (printf "iter-append array element ~s ~s~%" i val)
504                                                (iter-append-basic container val) ) vec)
505                                        ((foreign-lambda* bool ((message-iter-ptr iter)(message-iter-ptr container))
506                                                "bool ret = dbus_message_iter_close_container(iter, container);
507                                                free(container);
508                                                C_return(ret);") iter container) ) )
509                        ;; else todo: append empty array
510                        ))
511
512        ;; TODO: iter-append-basic-object-path
513
514        ;; val would usually be a single value, but
515        ;; could be a pair of the form (type-x . value)
516        ;; in which case we will attempt to convert the value to that type for sending.
517        (define (iter-append-basic iter val)
518; (printf "iter-append-basic ~s ~s~%"   iter val)
519                (cond
520                        [(fixnum? val) (iter-append-basic-int iter val)]
521                        [(flonum? val) (iter-append-basic-double iter val)]
522                        [(boolean? val) (iter-append-basic-bool iter val)]
523                        [(variant? val) (iter-append-basic-variant iter (variant-data val))]
524                        [(struct? val) (iter-append-basic-struct iter (struct->vector val))]
525                        [(vector? val) (iter-append-uniform-array iter val)]
526                        [(and (pair? val) (not (list? val))) (iter-append-dict-entry iter val)]
527                        [(object-path? val) (iter-append-basic-object-path iter (object-path->string val))]
528                        [else (iter-append-basic-string iter (any->string val))] ))
529
530        (define free-iter (foreign-lambda* void ((message-iter-ptr i)) "free(i);"))
531
532        (define (iter-cond iter)
533                (let ([type ((foreign-lambda int "dbus_message_iter_get_arg_type"
534                                                message-iter-ptr) iter)] )
535                        ; (printf "iter-cond type ~s~%" type)
536                        (cond
537                                [(eq? type type-string)
538                                        ((foreign-lambda* c-string ((message-iter-ptr iter))
539                                                "char* ret = NULL;
540                                                dbus_message_iter_get_basic(iter, &ret);
541                                                C_return (ret);") iter)]
542                                [(eq? type type-object-path)
543                                        (let ([str ((foreign-lambda* c-string ((message-iter-ptr iter))
544                                                "char* ret = NULL;
545                                                dbus_message_iter_get_basic(iter, &ret);
546                                                C_return (ret);") iter)])
547                                                (if (auto-unbox-object-paths)
548                                                        str
549                                                        (string->object-path str)))]
550                                [(eq? type type-boolean)
551                                        ((foreign-lambda* bool ((message-iter-ptr iter))
552                                                "bool ret;
553                                                dbus_message_iter_get_basic(iter, &ret);
554                                                return (ret);") iter)]
555                                [(memq type `(,type-int32 ,type-byte
556                                                                ,type-int16 ))
557                                        ((foreign-lambda* int ((message-iter-ptr iter))
558                                                "int ret = 0;
559                                                dbus_message_iter_get_basic(iter, &ret);
560                                                C_return (ret);") iter)]
561                                [(memq type `(,type-uint32 ,type-uint16))
562                                        ((foreign-lambda* unsigned-int ((message-iter-ptr iter))
563                                                "unsigned int ret = 0;
564                                                dbus_message_iter_get_basic(iter, &ret);
565                                                C_return (ret);") iter)]
566                                [(memq type `(,type-flonum ,type-uint64))
567                                        ;; todo don't put 64-bit int into a flonum if there's another way
568                                        ((foreign-lambda* double ((message-iter-ptr iter))
569                                                "double ret;
570                                                dbus_message_iter_get_basic(iter, &ret);
571                                                C_return (ret);") iter)]
572                                [(eq? type type-int64)
573                                        ((foreign-lambda* integer64 ((message-iter-ptr iter))
574                                                "int64_t ret = 0;
575                                                dbus_message_iter_get_basic(iter, &ret);
576                                                C_return (ret);") iter)]
577                                [(eq? type type-array)
578                                        (let ([v  (iter->vector (make-sub-iter iter))])
579                                                (when (and (vector? v) (eq? 1 (vector-length v)) (unsupported-type? (vector-ref v 0)))
580                                                        (set! v (make-vector 0)))
581                                                v)]
582                                [(eq? type type-dict-entry)
583                                        (iter->pair (make-sub-iter iter))]
584                                [(eq? type type-struct)
585                                        (let ([v (iter->vector (make-sub-iter iter))])
586                                                (if (auto-unbox-structs) v (vector->struct v)))]
587                                [(eq? type type-variant)
588                                        (if (auto-unbox-variants)
589                                                ((make-sub-iter iter))
590                                                (make-variant ((make-sub-iter iter))))]
591
592                                ;; todo: unsupported so far (not understood well enough):
593                                ;;      type-object-path and type-signature
594
595                                ;; so far the DBus "invalid" type is treated the same as unsupported.
596                                ;; Maybe need a distinction though...
597                                ; [(eq? type type-invalid) ...]
598                                [else (make-unsupported-type (integer->char type))] )))
599
600        (define (make-sub-iter iter)
601                (let* ([sub ((foreign-lambda* message-iter-ptr ((message-iter-ptr iter))
602                                "DBusMessageIter* i = malloc(sizeof(DBusMessageIter));
603                                dbus_message_iter_recurse(iter, i);
604                                C_return (i);") iter) ]
605                                [has-next sub]
606                                )
607                        (lambda ()
608                                (if has-next
609                                        (let ([ret (iter-cond sub)])
610                                                (set! has-next ((foreign-lambda bool
611                                                        "dbus_message_iter_next" message-iter-ptr) sub))
612                                                ret     )
613                                        (begin
614                                                (free-iter sub)
615                                                iterm)
616                                ))))
617
618        ;; iterator for reading parameters from a message
619        ;; returns a lambda which provides one param at a time, terminating with (void)
620        (define (make-iter msg)
621                (let* ([iter ((foreign-lambda* message-iter-ptr ((message-ptr msg))
622                                "DBusMessageIter* i = malloc(sizeof(DBusMessageIter));
623                                if (!dbus_message_iter_init (msg, i))
624                                        i = (DBusMessageIter*)0;        // Message has no parameters
625                                C_return (i);") msg) ]
626                                [has-next iter]
627                                )
628                        (lambda ()
629                                (if has-next
630                                        (let ([ret (iter-cond iter)])
631                                                (set! has-next ((foreign-lambda bool
632                                                        "dbus_message_iter_next" message-iter-ptr) iter))
633                                                ret     )
634                                        (begin
635                                                (free-iter iter)
636                                                iterm) ))))
637
638        ;; todo maybe: rewrite to avoid the reverse
639        (define (iter->list iter)
640                (let loop ([retval '()])
641                        (let ([next (iter)])
642                                (if (eq? next iterm)
643                                        (reverse retval)
644                                        (loop (cons next retval))))))
645
646        (define (iter->pair iter)
647                (cons (iter) (iter)))
648
649        (define (iter->vector iter)
650                (let ([l (iter->list iter)])
651                        (list->vector l)))
652
653        (define msg-path
654                (foreign-lambda c-string "dbus_message_get_path" message-ptr))
655
656        (define msg-interface
657                (foreign-lambda c-string "dbus_message_get_interface" message-ptr))
658
659        (define msg-member
660                (foreign-lambda c-string "dbus_message_get_member" message-ptr))
661
662        (define msg-error-name
663                (foreign-lambda c-string "dbus_message_get_error_name" message-ptr))
664
665        (define msg-service
666                (foreign-lambda c-string "dbus_message_get_destination" message-ptr))
667
668        (set! find-callback (lambda (bus msg)
669                (let ([path (string?->symbol (msg-path msg))]
670                                [iface (string?->symbol (msg-interface msg))]
671                                [mber (string?->symbol (msg-member msg))]
672                                [svc (string?->symbol (msg-service msg))]
673                                )
674                        ; (printf "   svc ~s~%" svc)
675                        ; (printf "   path ~s~%" path)
676                        ; (printf "   iface ~s~%" iface)
677                        ; (printf "   mber ~s~%" mber)
678                        ;; The service name is not included as part of the signal, so svc will be #f.
679                        ;; In that case the callback is registered under bus/path/iface/signal-name.
680                        (let ([ret (and svc
681                                                (tassq callbacks-table bus path svc iface mber))])
682                                (unless ret (set! ret
683                                                (tassq callbacks-table bus path iface mber) ))
684                                (unless ret
685                                        (when (default-signal-handler)
686                                                ((default-signal-handler) (format "failed to find callback for ~a ~a ~a ~a on ~a" path svc iface mber (bus-name bus)))))
687                                ret
688                        ))))
689
690        (set! make-context (lambda (#!key (bus session-bus) service interface (path "/"))
691                (vector (next-context-ID) bus (string?->symbol service)
692                        (string?->symbol path) (string?->symbol interface)) ))
693
694        (define send-impl
695                (foreign-lambda int "dbus_connection_send" connection-ptr message-ptr uint-ptr))
696
697        (set! send (lambda (context name . params)
698                (let* ([service (symbol?->string (vector-ref context context-idx-service))]
699                                [msg (make-signal
700                                                        (symbol?->string (vector-ref context context-idx-path))
701                                                        (symbol?->string (vector-ref context context-idx-interface))
702                                                        name)]
703                                [iter (make-iter-append msg)] )
704                        (let ([conn (conn-or-abort (vector-ref context context-idx-bus))])
705                                ; (exists-or-abort conn (format "no connection to bus ~s~%" (vector-ref context context-idx-bus)))
706                                (for-each (lambda (parm)
707                                        (iter-append-basic iter parm))  params)
708                                (send-impl conn msg #f)
709                                (free-iter iter)
710                                ; ((foreign-lambda void "dbus_connection_flush" connection-ptr) conn)
711                        ))))
712
713        (set! call (lambda (context name . params)
714                (let* ([service (symbol->string (vector-ref context context-idx-service))]
715                                [msg (make-message service
716                                                        (symbol->string (vector-ref context context-idx-path))
717                                                        (symbol->string (vector-ref context context-idx-interface))
718                                                        name)]
719                                [iter (make-iter-append msg)] )
720                        (let ([conn (conn-or-abort (vector-ref context context-idx-bus))])
721                                ; (exists-or-abort conn (format "no connection to bus ~s~%" (vector-ref context context-idx-bus)))
722                                (for-each (lambda (parm)
723                                        (iter-append-basic iter parm))  params)
724                                (free-iter iter)
725                                (let* ([err (make-error)]
726                                                [reply-msg ((foreign-lambda* message-ptr ((connection-ptr conn) (message-ptr msg)
727                                                                        ((c-pointer (struct "DBusError")) err))
728                                                        ;; todo: timeout comes from where?  (make-parameter) maybe
729                                                        "DBusMessage *reply;
730                                                        reply = dbus_connection_send_with_reply_and_block(conn, msg, 5000, err);
731                                                        dbus_message_unref(msg);
732                                                        C_return(reply);") conn msg err) ])
733                                        (if reply-msg
734                                                        (let* ([reply-iter (make-iter reply-msg)]
735                                                                                 [reply-args (iter->list reply-iter)] )
736                                                                reply-args)
737                                                        (raise-dbus-error 'call err)))))))
738
739
740        (set! make-method-proxy (lambda (context name)
741                (let ([service (symbol->string (vector-ref context context-idx-service))]
742                                [conn (conn-or-abort (vector-ref context context-idx-bus))] )
743                                ; (exists-or-abort conn (format "no connection to bus ~s~%" (vector-ref context context-idx-bus)))
744                                (lambda params
745                                        (let* ([msg (make-message service
746                                                                        (symbol->string (vector-ref context context-idx-path))
747                                                                        (symbol->string (vector-ref context context-idx-interface))
748                                                                        name)]
749                                                        [iter (make-iter-append msg)] )
750                                                (for-each (lambda (parm)
751                                                        (iter-append-basic iter parm))  params)
752                                                (free-iter iter)
753                                                ;; TODO: pull this out into a helper function
754                                                (and-let* ([reply-msg ((foreign-lambda* message-ptr ((connection-ptr conn) (message-ptr msg))
755                                                                        ;; idealistic code here; todo: error checking
756                                                                        "DBusPendingCall* pending;
757                                                                        dbus_connection_send_with_reply(conn, msg, &pending, -1);
758                                                                        dbus_connection_flush(conn);
759                                                                        dbus_message_unref(msg);
760                                                                        dbus_pending_call_block(pending);
761                                                                        msg = dbus_pending_call_steal_reply(pending);
762                                                                        C_return(msg);") conn msg) ]
763                                                                [reply-iter (make-iter reply-msg)]
764                                                                [reply-args (iter->list reply-iter)] )
765                                                        reply-args))))))
766
767        (define-foreign-record-type (vtable "struct DBusObjectPathVTable")
768                (constructor: make-vtable-impl)
769                (destructor: free-vtable)
770                (c-pointer unregister_function vtable-unregister_function vtable-unregister_function-set!)
771                (c-pointer message_function vtable-message_function vtable-message_function-set!)
772                (c-pointer dbus_internal_pad1 vtable-dbus_internal_pad1)
773                (c-pointer dbus_internal_pad2 vtable-dbus_internal_pad2)
774                (c-pointer dbus_internal_pad3 vtable-dbus_internal_pad3)
775                (c-pointer dbus_internal_pad4 vtable-dbus_internal_pad4))
776
777        (define (make-vtable cb unreg-cb)
778                (let ()
779                        (define (fn conn msg user-data)
780                                ; (printf "fixin' to call ~a with ~a, ~a, ~a~%" cb conn msg user-data)
781                                (let ([ret (cb conn msg user-data)])
782                                        ;; TODO: return ret as the result
783                                        result-handled ))
784                        (let ([ret (make-vtable-impl)])
785                                (vtable-message_function-set! ret fn)
786                                (vtable-unregister_function-set! ret unreg-cb)
787                                ret) ))
788
789        ; (set! add-match-self (lambda ()
790                ; ((foreign-safe-lambda void "dbus_bus_add_match" connection-ptr c-string error-ptr)
791                        ; (get-conn (vector-ref context context-idx-bus)) rule #f) ))
792
793        (set! read-write (lambda (conn timeout)
794                (let ()
795                        ((foreign-safe-lambda bool "dbus_connection_read_write" connection-ptr int)
796                                conn timeout))))
797
798        (set! request-name (lambda (context)
799                (let ([service-name (symbol?->string (vector-ref context context-idx-service))])
800                        (conn-or-abort (vector-ref context context-idx-bus))
801                        (when service-name
802                                ((foreign-safe-lambda void "dbus_bus_request_name" connection-ptr c-string int error-ptr)
803                                        (get-conn (vector-ref context context-idx-bus))
804                                        service-name
805                                        name-flag-replace-existing #f) ))))
806
807        (set! add-match (lambda (context)
808                ;; TODO is it always type signal?  We are using this for methods too.
809                (let ([rule (format "type='signal', interface='~s'" (vector-ref context context-idx-interface))])
810                        (conn-or-abort (vector-ref context context-idx-bus))
811                        ((foreign-safe-lambda void "dbus_bus_add_match" connection-ptr c-string error-ptr)
812                                (get-conn (vector-ref context context-idx-bus)) rule #f) )))
813
814        ;; return #t if it received a message, #f if not
815        (set! poll-for-message (lambda (#!key (bus session-bus) (timeout 0))
816                (let ([conn (conn-or-abort bus)])
817                        ; (exists-or-abort conn (format "no connection to bus ~s~%" (vector-ref context context-idx-bus)))
818                        ((foreign-safe-lambda* bool
819                                ((connection-ptr conn) (bus bus) (int timeout))
820                                "DBusMessage* msg = NULL;
821                                dbus_connection_read_write(conn, timeout);
822                                msg = dbus_connection_pop_message(conn);
823                                if (msg)
824                                {
825                                        //printf(\"rcv: %s\\n\", dbus_message_get_interface(msg));
826                                        C_msg_cb(bus, msg);
827                                        dbus_message_unref(msg);
828                                        C_return(true);         // yes there was a message
829                                }
830                                C_return (false);               // we polled, we came back empty-handed
831                                ") conn bus timeout)
832                )))
833
834        ;; TODO: one polling thread is necessary for each connection
835        (define (start-polling! bus interval)
836                (vector-set! polling-interval bus interval)
837                ; (pretty-print callbacks-table)
838                (when (vector-ref polling-enabled bus)
839                        (unless (vector-ref polling-threads bus)
840                                (vector-set! polling-threads bus (thread-start! (lambda ()
841                                        (let loop ()
842                                                ; (printf "polling~%")
843                                                (poll-for-message bus: bus timeout: 0)
844                                                (thread-sleep! (vector-ref polling-interval bus))
845                                                (when (vector-ref polling-enabled bus) (loop)))))))))
846
847        (set! enable-polling-thread! (lambda (#!key (bus session-bus) (enable #t) (interval default-polling-interval))
848                (vector-set! polling-enabled bus enable)
849                (if enable
850                        (start-polling! bus interval)
851                        (let ([th (vector-ref polling-threads bus)])
852                                (when th (thread-join! th))))))
853
854        ;; Wraps a user-provided callback so as to pass it the
855        ;; received dbus message's parameters, and return a dbus response
856        ;; with the parameter(s) returned from the callback.
857        ;; msg-cb is the user-provided one.
858        (define (method-wrapper conn msg-cb)
859                (lambda (msg)
860                        (let ([args (iter->list (make-iter msg))]
861                                        [response ((foreign-lambda message-ptr
862                                                        "dbus_message_new_method_return" message-ptr) msg)])
863                                (let ([ret (apply msg-cb args)]
864                                                [iter (make-iter-append response)] )
865                                        (if (pair? ret)
866                                                (for-each (lambda (parm)
867                                                        ; (printf "appending return parameter ~s~%" parm)
868                                                        (iter-append-basic iter parm))  ret)
869                                                (iter-append-basic iter ret))
870                                        ;; send response
871                                        (send-impl conn response #f)
872                                        (free-iter iter)
873                                        ))))
874
875        (define (handler-wrapper conn msg-cb)
876                (lambda (msg)
877                        (let ([args (iter->list (make-iter msg))])
878                                (apply msg-cb args)     )))
879
880        ;; msg-cb: the handler implementation.  Its return value is ignored.
881        (set! register-signal-handler (lambda (context name msg-cb)
882                (request-name context)
883                (add-match context)
884                (tasset! callbacks-table
885                        (handler-wrapper (conn-or-abort (vector-ref context context-idx-bus)) msg-cb)
886                        (vector-ref context context-idx-bus)
887                        (vector-ref context context-idx-path)
888                        (vector-ref context context-idx-interface)
889                        (string?->symbol name))
890                (start-polling! (vector-ref context context-idx-bus) default-polling-interval)
891        ))
892
893        ;; msg-cb: the method implementation.  Its return value is sent back as the response.
894        (set! register-method (lambda (context name msg-cb)
895                (request-name context)
896                ; (add-match context)   doesn't seem to be necessary
897                (tasset! callbacks-table
898                        (method-wrapper (conn-or-abort (vector-ref context context-idx-bus)) msg-cb)
899                        (vector-ref context context-idx-bus)
900                        (vector-ref context context-idx-path)
901                        (vector-ref context context-idx-service)
902                        (vector-ref context context-idx-interface)
903                        (string?->symbol name))
904                (start-polling! (vector-ref context context-idx-bus) default-polling-interval)
905        ))
906
907        ; dbus_bool_t dbus_connection_register_object_path   (DBusConnection              *connection,
908                                                                                                                ; const char                  *path,
909                                                                                                                ; const DBusObjectPathVTable  *vtable,
910                                                                                                                ; void                        *user_data);
911        (set! register-path (lambda (bus path fn unreg-fn)
912                ; (let ([unreg-fn (lambda (parm . rest) #f)])
913                ((foreign-safe-lambda bool "dbus_connection_register_object_path"
914                                connection-ptr c-string vtable-ptr c-pointer)
915                        (conn-or-abort bus)
916                        (symbol?->string path)
917                        (make-vtable fn unreg-fn) #f)))
918
919        (set! discover-api-xml (lambda (ctxt)
920                (let ([ctxt (list->vector (vector->list ctxt))])        ;; todo: efficiency?
921                        (vector-set! ctxt context-idx-interface 'org.freedesktop.DBus.Introspectable)
922                        (let ([xml (call ctxt "Introspect")])
923                                (and (pair? xml) (car xml))))))
924
925)) ;; end module
Note: See TracBrowser for help on using the repository browser.