1 ;; Common Lisp bindings for GTK+ v2.x
2 ;; Copyright 2000-2006 Espen S. Johnsen <espen@users.sf.net>
4 ;; Permission is hereby granted, free of charge, to any person obtaining
5 ;; a copy of this software and associated documentation files (the
6 ;; "Software"), to deal in the Software without restriction, including
7 ;; without limitation the rights to use, copy, modify, merge, publish,
8 ;; distribute, sublicense, and/or sell copies of the Software, and to
9 ;; permit persons to whom the Software is furnished to do so, subject to
10 ;; the following conditions:
12 ;; The above copyright notice and this permission notice shall be
13 ;; included in all copies or substantial portions of the Software.
15 ;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 ;; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 ;; MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18 ;; IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
19 ;; CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
20 ;; TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
21 ;; SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23 ;; $Id: gdk.lisp,v 1.34 2007/04/06 14:19:08 espen Exp $
30 (defbinding (gdk-init "gdk_parse_args") () nil
31 "Initializes the library without opening the display."
40 (defmethod print-object ((display display) stream)
41 (if (and (proxy-valid-p display) (slot-boundp display 'name))
42 (print-unreadable-object (display stream :type t :identity nil)
43 (format stream "~S at 0x~X"
44 (display-name display) (pointer-address (foreign-location display))))
47 (defbinding %display-open () display
48 (display-name (or null string)))
50 (defun display-open (&optional display-name)
52 (%display-open display-name)
53 (error "Opening display failed: ~A" display-name))))
54 (unless (display-get-default)
55 (display-set-default display))
58 (defbinding %display-get-n-screens () int
61 (defbinding %display-get-screen () screen
65 (defun display-screens (&optional (display (display-get-default)))
67 for i from 0 below (%display-get-n-screens display)
68 collect (%display-get-screen display i)))
70 (defbinding display-get-default-screen
71 (&optional (display (display-get-default))) screen
74 (defbinding display-beep (&optional (display (display-get-default))) nil
77 (defbinding display-sync (&optional (display (display-get-default))) nil
80 (defbinding display-flush (&optional (display (display-get-default))) nil
83 (defbinding display-close (&optional (display (display-get-default))) nil
86 (defbinding display-get-event
87 (&optional (display (display-get-default))) event
90 (defbinding display-peek-event
91 (&optional (display (display-get-default))) event
94 (defbinding display-put-event
95 (event &optional (display (display-get-default))) event
99 (defbinding (display-connection-number "clg_gdk_connection_number")
100 (&optional (display (display-get-default))) int
103 (defun find-display (name)
104 (find name (list-displays) :key #'display-name :test #'string=))
106 (defun ensure-display (display)
108 (null (display-get-default))
112 (find display (list-displays) :key #'display-name :test #'string=)
113 (display-open display)))))
118 (defbinding display-get-default () display)
120 (defbinding (display-set-default "gdk_display_manager_set_default_display")
122 ((display-manager) display-manager)
125 (defbinding (list-displays "gdk_display_manager_list_displays") ()
126 (gslist (static display))
127 ((display-manager) display-manager))
129 ;; The only purpose of exporting this is to make it possible for
130 ;; applications to connect to the display-opened signal
131 (defbinding (display-manager "gdk_display_manager_get") () display-manager)
133 (defbinding display-get-core-pointer
134 (&optional (display (display-get-default))) device
138 ;;; Primitive graphics structures (points, rectangles and regions)
140 (defbinding %rectangle-intersect () boolean
145 (defun rectangle-intersect (src1 src2 &optional (dest (make-instance 'rectangle)))
146 "Calculates the intersection of two rectangles. It is allowed for DEST to be the same as either SRC1 or SRC2. DEST is returned if the to rectangles intersect, otherwise NIL"
147 (when (%rectangle-intersect src1 src2 dest)
150 (defbinding rectangle-union (src1 src2 &optional (dest (make-instance 'rectangle))) nil
151 "Calculates the union of two rectangles. The union of rectangles SRC1 and SRC2 is the smallest rectangle which includes both SRC1 and SRC2 within it. It is allowed for DEST to be the same as either SRC1 or SRC2."
154 (dest rectangle :in/return))
156 (defun ensure-rectangle (rectangle)
158 (rectangle rectangle)
159 (vector (make-instance 'rectangle
160 :x (aref rectangle 0) :y (aref rectangle 1)
161 :width (aref rectangle 2) :height (aref rectangle 3)))))
164 (defbinding %region-new () pointer)
166 (defbinding %region-polygon () pointer
167 (points (vector (inlined point)))
169 (fill-rule fill-rule))
171 (defbinding %region-rectangle () pointer
172 (rectangle rectangle))
174 (defbinding %region-copy () pointer
177 (defbinding %region-destroy () nil
180 (defmethod allocate-foreign ((region region) &key rectangle polygon fill-rule)
181 (declare (ignore initargs))
183 ((and rectangle polygon)
184 (error "Only one of the keyword arguments :RECTANGLE and :POLYGON can be specified"))
185 (rectangle (%region-rectangle (ensure-rectangle rectangle)))
186 (polygon (%region-polygon polygon (length polygon) fill-rule))
189 (defun ensure-region (region)
192 ((or rectangle vector)
193 (make-instance 'region :rectangle (ensure-rectangle region)))))
195 (defbinding region-get-clipbox (region &optional (rectangle (make-instance 'rectangle))) nil
197 (rectangle rectangle :in/return))
199 (defbinding %region-get-rectangles () nil
201 (rectangles pointer :out)
202 (n-rectangles int :out))
204 (defun region-get-rectangles (region)
205 "Obtains the area covered by the region as a list of rectangles."
206 (multiple-value-bind (location length) (%region-get-rectangles region)
208 (map-c-vector 'list #'identity location 'point length :get)
209 (deallocate-memory location))))
211 (defbinding region-empty-p () boolean
214 (defbinding region-equal-p () boolean
218 (defbinding region-point-in-p () boolean
223 (defbinding region-rect-in (region rectangle) overlap-type
225 ((ensure-rectangle rectangle) rectangle))
227 (defbinding region-offset () nil
232 (defbinding region-shrink () nil
237 (defbinding region-intersect (source1 source2) nil
239 ((ensure-region source2) region))
241 (defbinding region-union (source1 source2) nil
243 ((ensure-region source2) region))
245 (defbinding region-subtract (source1 source2) nil
247 ((ensure-region source2) region))
249 (defbinding region-xor (source1 source2) nil
251 ((ensure-region source2) region))
256 (defbinding (events-pending-p "gdk_events_pending") () boolean)
258 (defbinding event-get () event)
260 (defbinding event-peek () event)
262 (defbinding event-get-graphics-expose () event
265 (defbinding event-put () event
268 ;(defbinding event-handler-set () ...)
270 (defbinding set-show-events () nil
271 (show-events boolean))
273 (defbinding get-show-events () boolean)
276 ;;; Miscellaneous functions
278 (defbinding screen-width () int
281 (defbinding screen-height () int
284 (defbinding screen-width-mm () int
287 (defbinding screen-height-mm () int
291 (defbinding pointer-grab
292 (window &key owner-events events confine-to cursor time) grab-status
294 (owner-events boolean)
296 (confine-to (or null window))
297 (cursor (or null cursor))
298 ((or time 0) (unsigned 32)))
300 (defbinding (pointer-ungrab "gdk_display_pointer_ungrab")
301 (&optional time (display (display-get-default))) nil
303 ((or time 0) (unsigned 32)))
305 (defbinding (pointer-is-grabbed-p "gdk_display_pointer_is_grabbed")
306 (&optional (display (display-get-default))) boolean
309 (defbinding keyboard-grab (window &key owner-events time) grab-status
311 (owner-events boolean)
312 ((or time 0) (unsigned 32)))
314 (defbinding (keyboard-ungrab "gdk_display_keyboard_ungrab")
315 (&optional time (display (display-get-default))) nil
317 ((or time 0) (unsigned 32)))
321 (defbinding atom-intern (atom-name &optional only-if-exists) atom
322 ((string atom-name) string)
323 (only-if-exists boolean))
325 (defbinding atom-name () string
332 (defbinding visual-get-best-depth () int)
334 (defbinding visual-get-best-type () visual-type)
336 (defbinding visual-get-system () visual)
339 (defbinding (%visual-get-best-with-nothing "gdk_visual_get_best") () visual)
341 (defbinding %visual-get-best-with-depth () visual
344 (defbinding %visual-get-best-with-type () visual
347 (defbinding %visual-get-best-with-both () visual
351 (defun visual-get-best (&key depth type)
353 ((and depth type) (%visual-get-best-with-both depth type))
354 (depth (%visual-get-best-with-depth depth))
355 (type (%visual-get-best-with-type type))
356 (t (%visual-get-best-with-nothing))))
358 ;(defbinding query-depths ..)
360 ;(defbinding query-visual-types ..)
362 (defbinding list-visuals () (glist visual))
367 (defbinding window-destroy () nil
370 (defbinding window-at-pointer () window
374 (defbinding window-show () nil
377 (defbinding window-show-unraised () nil
380 (defbinding window-hide () nil
383 (defbinding window-is-visible-p () boolean
386 (defbinding window-is-viewable-p () boolean
389 (defbinding window-withdraw () nil
392 (defbinding window-iconify () nil
395 (defbinding window-deiconify () nil
398 (defbinding window-stick () nil
401 (defbinding window-unstick () nil
404 (defbinding window-maximize () nil
407 (defbinding window-unmaximize () nil
410 (defbinding window-fullscreen () nil
413 (defbinding window-unfullscreen () nil
416 (defbinding window-set-keep-above () nil
420 (defbinding window-set-keep-below () nil
424 (defbinding window-move () nil
429 (defbinding window-resize () nil
434 (defbinding window-move-resize () nil
441 (defbinding window-scroll () nil
446 (defbinding window-reparent () nil
452 (defbinding window-clear () nil
455 (defbinding %window-clear-area () nil
457 (x int) (y int) (width int) (height int))
459 (defbinding %window-clear-area-e () nil
461 (x int) (y int) (width int) (height int))
463 (defun window-clear-area (window x y width height &optional expose)
465 (%window-clear-area-e window x y width height)
466 (%window-clear-area window x y width height)))
468 (defbinding window-raise () nil
471 (defbinding window-lower () nil
474 (defbinding window-focus () nil
476 (timestamp unsigned-int))
478 (defbinding window-register-dnd () nil
481 (defbinding window-begin-resize-drag () nil
487 (timestamp unsigned-int))
489 (defbinding window-begin-move-drag () nil
494 (timestamp unsigned-int))
496 ;; Probably not needed
497 ;; (defbinding window-constrain-size () nil ..
499 (defbinding window-begin-paint-region (window region) nil
501 ((ensure-region region) region))
503 (defbinding window-end-paint () nil
506 (defmacro with-window-paint ((window region) &body body)
508 (window-begin-paint-region ,window ,region)
511 (window-end-paint ,window))))
513 ;; TODO: create wrapper function and use gdk_window_invalidate_maybe_recurse
514 ;; if last arg is a function
515 (defbinding window-invalidate-region (window region invalidate-children-p) nil
517 ((ensure-region region) region)
518 (invalidate-children-p boolean))
520 (defbinding window-get-update-area () region
523 (defbinding window-freeze-updates () nil
526 (defbinding window-thaw-updates () nil
529 (defbinding window-process-all-updates () nil)
531 (defbinding window-process-updates () nil
533 (update-children-p boolean))
535 (defbinding window-set-debug-updates () nil
538 (defbinding window-enable-synchronized-configure () nil
541 (defbinding window-configure-finished () nil
544 ;; Deprecated, use gobject user data mechanism
545 (defbinding window-set-user-data () nil
549 (defbinding window-set-override-redirect () nil
551 (override-redirect-p boolean))
553 (defbinding window-set-accept-focus () nil
555 (accept-focus-p boolean))
557 (defbinding window-set-focus-on-map () nil
559 (focus-on-map-p boolean))
562 ; (defbinding window-add-filter () nil
563 ; (defbinding window-remove-filter () nil
565 ;; New code should use window-shape-combine
566 (defbinding window-shape-combine-mask () nil
572 (defbinding %window-shape-combine-region () nil
574 (region (or null region))
578 (defun window-shape-combine (window shape offset-x offset-y)
580 (nil (%window-shape-combine-region window nil 0 0)
581 (region (%window-shape-combine-region window shape offset-x offset-y))
582 (bitmask (window-shape-combine-mask window shape offset-x offset-y)))))
584 (defbinding window-set-child-shapes () nil
587 (defbinding window-merge-child-shapes () nil
590 #?(pkg-exists-p "gtk+-2.0" :atleast-version "2.10.0")
592 (defbinding %window-input-shape-combine-mask () nil
598 (defbinding %window-input-shape-combine-region () nil
600 (region (or null region))
604 (defun window-input-shape-combine (window shape x y)
606 (nil (%window-input-shape-combine-region window nil 0 0)
607 (region (%window-input-shape-combine-region window shape x y))
608 (bitmask (%window-input-shape-combine-mask window shape x y)))))
610 (defbinding window-set-child-input-shapes () nil
613 (defbinding window-merge-child-input-shapes () nil
616 (defbinding window-set-static-gravities () boolean
618 (use-static-p boolean))
620 (defbinding window-set-title () nil
624 (defbinding window-set-background () nil
628 (defbinding window-set-back-pixmap (window pixmap &optional parent-relative-p) nil
630 (pixmap (or null pixmap))
631 (parent-relative-p boolean))
633 (defbinding window-set-cursor () nil
635 (cursor (or null cursor)))
637 (defbinding window-get-geometry () nil
645 ;(defbinding window-set-geometry-hints () nil
647 (defbinding window-set-icon-list () nil
649 (icons (glist pixbufs)))
651 (defbinding window-set-skip-taskbar-hint () nil
653 (skip-taskbar-p boolean))
655 (defbinding window-set-skip-pager-hint () nil
657 (skip-pager-p boolean))
659 #?(pkg-exists-p "gtk+-2.0" :atleast-version "2.8.0")
660 (defbinding window-set-urgency-hint () nil
664 (defbinding window-get-position () nil
669 (defbinding window-get-root-origin () nil
674 (defbinding window-get-frame-extents (window &optional (extents (make-instance 'rect))) nil
676 (extents rectangle :in/return))
678 (defbinding window-get-origin () nil ; this may not work as
679 (window window) ; an int is actually returned
683 (defbinding window-get-pointer () window
687 (mask modifier-type :out))
689 ;(defbinding window-set-icon () nil
691 (defbinding window-set-icon-name () nil
695 (defbinding window-set-transient-for () nil
699 (defbinding window-set-role () nil
703 (defbinding %window-get-decorations () boolean
705 (decorations wm-decoration :out))
707 (defun %window-decorations-getter (window)
708 (nth-value 1 (%window-get-decorations window)))
710 (defun %window-decorations-boundp (window)
711 (%window-get-decorations window))
713 (defbinding %window-get-toplevels () (glist window))
715 (defun window-get-toplevels (&optional screen)
717 (error "Not implemented")
718 (%window-get-toplevels)))
720 (defbinding %get-default-root-window () window)
722 (defun get-root-window (&optional display)
724 (error "Not implemented")
725 (%get-default-root-window)))
733 (defbinding drag-status () nil
734 (context drag-context)
736 (time (unsigned 32)))
745 (defbinding rgb-init () nil)
752 (defmethod allocate-foreign ((cursor cursor) &key source mask fg bg
753 (x 0) (y 0) (display (display-get-default)))
755 (keyword (%cursor-new-for-display display source))
756 (pixbuf (%cursor-new-from-pixbuf display source x y))
757 (pixmap (%cursor-new-from-pixmap source mask
758 (or fg (ensure-color #(0.0 0.0 0.0)))
759 (or bg (ensure-color #(1.0 1.0 1.0))) x y))
760 (pathname (%cursor-new-from-pixbuf display (pixbuf-load source) x y))))
762 (defun ensure-cursor (cursor &rest args)
763 (if (typep cursor 'cursor)
765 (apply #'make-instance 'cursor :source cursor args)))
767 (defbinding %cursor-new-for-display () pointer
769 (cursor-type cursor-type))
771 (defbinding %cursor-new-from-pixmap () pointer
778 (defbinding %cursor-new-from-pixbuf () pointer
783 (defbinding %cursor-ref () pointer
786 (defbinding %cursor-unref () nil
792 (defbinding %pixmap-new () pointer
793 (window (or null window))
798 (defmethod allocate-foreign ((pximap pixmap) &key width height depth window)
799 (%pixmap-new window width height depth))
801 (defun pixmap-new (width height depth &key window)
802 (warn "PIXMAP-NEW is deprecated, use (make-instance 'pixmap ...) instead")
803 (make-instance 'pixmap :width width :height height :depth depth :window window))
805 (defbinding %pixmap-colormap-create-from-xpm () pixmap
806 (window (or null window))
807 (colormap (or null colormap))
809 (color (or null color))
812 (defbinding %pixmap-colormap-create-from-xpm-d () pixmap
813 (window (or null window))
814 (colormap (or null colormap))
816 (color (or null color))
817 (data (vector string)))
819 ;; Deprecated, use pixbufs instead
820 (defun pixmap-create (source &key color window colormap)
822 (if (not (or window colormap))
825 (multiple-value-bind (pixmap mask)
827 ((or string pathname)
828 (%pixmap-colormap-create-from-xpm window colormap color source))
830 (%pixmap-colormap-create-from-xpm-d window colormap color source)))
831 (values pixmap mask))))
836 (defbinding colormap-get-system () colormap)
838 (defbinding %color-copy () pointer
841 (defmethod allocate-foreign ((color color) &rest initargs)
842 (declare (ignore color initargs))
843 ;; Color structs are allocated as memory chunks by gdk, and since
844 ;; there is no gdk_color_new we have to use this hack to get a new
846 (with-memory (location #.(foreign-size (find-class 'color)))
847 (%color-copy location)))
849 (defun %scale-value (value)
852 (float (truncate (* value 65535)))))
854 (defmethod initialize-instance ((color color) &key (red 0.0) (green 0.0) (blue 0.0))
856 (with-slots ((%red red) (%green green) (%blue blue)) color
858 %red (%scale-value red)
859 %green (%scale-value green)
860 %blue (%scale-value blue))))
862 (defbinding %color-parse () boolean
864 (color color :in/return))
866 (defun color-parse (spec &optional (color (make-instance 'color)))
867 (multiple-value-bind (succeeded-p color) (%color-parse spec color)
870 (error "Parsing color specification ~S failed." spec))))
872 (defun ensure-color (color)
876 (string (color-parse color))
878 (make-instance 'color
879 :red (svref color 0) :green (svref color 1) :blue (svref color 2)))))
883 ;;; Drawable -- all the draw- functions are deprecated and will be
884 ;;; removed, use cairo for drawing instead.
886 (defbinding drawable-get-size () nil
891 (defbinding (drawable-width "gdk_drawable_get_size") () nil
896 (defbinding (drawable-height "gdk_drawable_get_size") () nil
901 ;; (defbinding drawable-get-clip-region () region
902 ;; (drawable drawable))
904 ;; (defbinding drawable-get-visible-region () region
905 ;; (drawable drawable))
907 (defbinding draw-point () nil
908 (drawable drawable) (gc gc)
911 (defbinding %draw-points () nil
912 (drawable drawable) (gc gc)
916 (defbinding draw-line () nil
917 (drawable drawable) (gc gc)
921 (defbinding draw-pixbuf
922 (drawable gc pixbuf src-x src-y dest-x dest-y &optional
923 width height (dither :none) (x-dither 0) (y-dither 0)) nil
924 (drawable drawable) (gc (or null gc))
926 (src-x int) (src-y int)
927 (dest-x int) (dest-y int)
928 ((or width -1) int) ((or height -1) int)
930 (x-dither int) (y-dither int))
932 (defbinding draw-rectangle () nil
933 (drawable drawable) (gc gc)
936 (width int) (height int))
938 (defbinding draw-arc () nil
939 (drawable drawable) (gc gc)
942 (width int) (height int)
943 (angle1 int) (angle2 int))
945 (defbinding %draw-layout () nil
946 (drawable drawable) (gc gc)
949 (layout pango:layout))
951 (defbinding %draw-layout-with-colors () nil
952 (drawable drawable) (gc gc)
955 (layout pango:layout)
956 (foreground (or null color))
957 (background (or null color)))
959 (defun draw-layout (drawable gc font x y layout &optional foreground background)
960 (if (or foreground background)
961 (%draw-layout-with-colors drawable gc font x y layout foreground background)
962 (%draw-layout drawable gc font x y layout)))
964 (defbinding draw-drawable
965 (drawable gc src src-x src-y dest-x dest-y &optional width height) nil
966 (drawable drawable) (gc gc)
968 (src-x int) (src-y int)
969 (dest-x int) (dest-y int)
970 ((or width -1) int) ((or height -1) int))
972 (defbinding draw-image
973 (drawable gc image src-x src-y dest-x dest-y &optional width height) nil
974 (drawable drawable) (gc gc)
976 (src-x int) (src-y int)
977 (dest-x int) (dest-y int)
978 ((or width -1) int) ((or height -1) int))
980 (defbinding drawable-get-image () image
983 (width int) (height int))
985 (defbinding drawable-copy-to-image
986 (drawable src-x src-y width height &optional image dest-x dest-y) image
988 (image (or null image))
989 (src-x int) (src-y int)
990 ((if image dest-x 0) int)
991 ((if image dest-y 0) int)
992 (width int) (height int))
997 (defbinding keyval-name () string
998 (keyval unsigned-int))
1000 (defbinding %keyval-from-name () unsigned-int
1003 (defun keyval-from-name (name)
1004 "Returns the keysym value for the given key name or NIL if it is not a valid name."
1005 (let ((keyval (%keyval-from-name name)))
1006 (unless (zerop keyval)
1009 (defbinding keyval-to-upper () unsigned-int
1010 (keyval unsigned-int))
1012 (defbinding keyval-to-lower () unsigned-int
1013 (keyval unsigned-int))
1015 (defbinding (keyval-is-upper-p "gdk_keyval_is_upper") () boolean
1016 (keyval unsigned-int))
1018 (defbinding (keyval-is-lower-p "gdk_keyval_is_lower") () boolean
1019 (keyval unsigned-int))
1021 ;;; Cairo interaction
1023 #?(pkg-exists-p "gtk+-2.0" :atleast-version "2.8.0")
1025 (defbinding cairo-create () cairo:context
1026 (drawable drawable))
1028 (defmacro with-cairo-context ((cr drawable) &body body)
1029 `(let ((,cr (cairo-create ,drawable)))
1032 (invalidate-instance ,cr t))))
1034 (defbinding cairo-set-source-color () nil
1038 (defbinding cairo-set-source-pixbuf () nil
1044 (defbinding cairo-rectangle () nil
1046 (rectangle rectangle))
1048 ;; (defbinding cairo-region () nil
1049 ;; (cr cairo:context)
1055 ;;; Multi-threading support
1059 (defvar *global-lock* (sb-thread:make-mutex :name "global GDK lock"))
1060 (let ((recursive-level 0))
1061 (defun threads-enter ()
1062 (if (eq (sb-thread:mutex-value *global-lock*) sb-thread:*current-thread*)
1063 (incf recursive-level)
1064 (sb-thread:get-mutex *global-lock*)))
1066 (defun threads-leave (&optional flush-p)
1068 ((zerop recursive-level)
1071 (sb-thread:release-mutex *global-lock*))
1072 (t (decf recursive-level)))))
1074 (define-callback %enter-fn nil ()
1077 (define-callback %leave-fn nil ()
1080 (defbinding threads-set-lock-functions (&optional) nil
1081 (%enter-fn callback)
1082 (%leave-fn callback))
1084 (defmacro with-global-lock (&body body)
1089 (threads-leave t)))))