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

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

gc finalization: define-foreign-type for DBusMessage sets finalizer in retconvert lambda

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