chiark / gitweb /
Definition of EVENT-MASK moved to gdktypes.lisp and some other minor changes
[clg] / gdk / gdk.lisp
index 497b985f4ba9073aa07a99635c4f1a4e271eed60..c17ab6ad010e82c73c60071fb007826ce9f8b7ca 100644 (file)
@@ -1,21 +1,26 @@
-;; Common Lisp bindings for GTK+ v2.0
-;; Copyright (C) 1999-2001 Espen S. Johnsen <esj@stud.cs.uit.no>
+;; Common Lisp bindings for GTK+ v2.x
+;; Copyright 2000-2006 Espen S. Johnsen <espen@users.sf.net>
 ;;
-;; This library is free software; you can redistribute it and/or
-;; modify it under the terms of the GNU Lesser General Public
-;; License as published by the Free Software Foundation; either
-;; version 2 of the License, or (at your option) any later version.
+;; Permission is hereby granted, free of charge, to any person obtaining
+;; a copy of this software and associated documentation files (the
+;; "Software"), to deal in the Software without restriction, including
+;; without limitation the rights to use, copy, modify, merge, publish,
+;; distribute, sublicense, and/or sell copies of the Software, and to
+;; permit persons to whom the Software is furnished to do so, subject to
+;; the following conditions:
 ;;
-;; This library is distributed in the hope that it will be useful,
-;; but WITHOUT ANY WARRANTY; without even the implied warranty of
-;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-;; Lesser General Public License for more details.
+;; The above copyright notice and this permission notice shall be
+;; included in all copies or substantial portions of the Software.
 ;;
-;; You should have received a copy of the GNU Lesser General Public
-;; License along with this library; if not, write to the Free Software
-;; Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+;; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+;; MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+;; IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+;; CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+;; TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+;; SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-;; $Id: gdk.lisp,v 1.11 2004-11-06 21:39:58 espen Exp $
+;; $Id: gdk.lisp,v 1.28 2006-04-25 22:27:13 espen Exp $
 
 
 (in-package "GDK")
@@ -28,17 +33,8 @@ (defbinding (gdk-init "gdk_parse_args") () nil
   (nil null))
 
 
-;;; Display
-
-(defbinding (display-manager "gdk_display_manager_get") () display-manager)
 
-
-(defbinding (display-set-default "gdk_display_manager_set_default_display")
-    (display) nil
-  ((display-manager) display-manager)
-  (display display))
-
-(defbinding display-get-default () display)
+;;; Display
 
 (defbinding %display-open () display
   (display-name (or null string)))
@@ -49,11 +45,66 @@ (defun display-open (&optional display-name)
       (display-set-default display))
     display))
 
+(defbinding %display-get-n-screens () int
+  (display display))
+
+(defbinding %display-get-screen () screen
+  (display display)
+  (screen-num int))
+
+(defun display-screens (&optional (display (display-get-default)))
+  (loop
+   for i from 0 below (%display-get-n-screens display)
+   collect (%display-get-screen display i)))
+
+(defbinding display-get-default-screen 
+    (&optional (display (display-get-default))) screen
+  (display display))
+
+(defbinding display-beep (&optional (display (display-get-default))) nil
+  (display display))
+
+(defbinding display-sync (&optional (display (display-get-default))) nil
+  (display display))
+
+(defbinding display-flush (&optional (display (display-get-default))) nil
+  (display display))
+
+(defbinding display-close (&optional (display (display-get-default))) nil
+  (display display))
+
+(defbinding display-get-event
+    (&optional (display (display-get-default))) event
+  (display display))
+
+(defbinding display-peek-event
+    (&optional (display (display-get-default))) event
+  (display display))
+
+(defbinding display-put-event
+    (event &optional (display (display-get-default))) event
+  (display display)
+  (event event))
+
 (defbinding (display-connection-number "clg_gdk_connection_number")
     (&optional (display (display-get-default))) int
   (display display))
 
 
+
+;;; Display manager
+
+(defbinding display-get-default () display)
+
+(defbinding (display-manager "gdk_display_manager_get") () display-manager)
+
+(defbinding (display-set-default "gdk_display_manager_set_default_display")
+    (display) nil
+  ((display-manager) display-manager)
+  (display display))
+
+
+
 ;;; Events
 
 (defbinding (events-pending-p "gdk_events_pending") () boolean)
@@ -73,59 +124,53 @@ (defbinding event-put () event
 (defbinding set-show-events () nil
   (show-events boolean))
 
-;;; Misc
-
-(defbinding set-use-xshm () nil
-  (use-xshm boolean))
-
 (defbinding get-show-events () boolean)
 
-(defbinding get-use-xshm () boolean)
-
-(defbinding get-display () string)
-
-; (defbinding time-get () (unsigned 32))
-
-; (defbinding timer-get () (unsigned 32))
 
-; (defbinding timer-set () nil
-;   (milliseconds (unsigned 32)))
+;;; Miscellaneous functions
 
-; (defbinding timer-enable () nil)
-
-; (defbinding timer-disable () nil)
+(defbinding screen-width () int)
+(defbinding screen-height () int)
 
-; input ...
+(defbinding screen-width-mm () int)
+(defbinding screen-height-mm () int)
 
-(defbinding pointer-grab () int
+(defbinding pointer-grab 
+    (window &key owner-events events confine-to cursor time) grab-status
   (window window)
   (owner-events boolean)
-  (event-mask event-mask)
+  (events event-mask)
   (confine-to (or null window))
   (cursor (or null cursor))
-  (time (unsigned 32)))
+  ((or time 0) (unsigned 32)))
 
-(defbinding pointer-ungrab () nil
-  (time (unsigned 32)))
+(defbinding (pointer-ungrab "gdk_display_pointer_ungrab")
+    (&optional time (display (display-get-default))) nil
+  (display display)
+  ((or time 0) (unsigned 32)))
+
+(defbinding (pointer-is-grabbed-p "gdk_display_pointer_is_grabbed") 
+    (&optional (display (display-get-default))) boolean
+  (display display))
 
-(defbinding keyboard-grab () int
+(defbinding keyboard-grab (window &key owner-events time) grab-status
   (window window)
   (owner-events boolean)
-  (time (unsigned 32)))
+  ((or time 0) (unsigned 32)))
 
-(defbinding keyboard-ungrab () nil
-  (time (unsigned 32)))
+(defbinding (keyboard-ungrab "gdk_display_keyboard_ungrab")
+    (&optional time (display (display-get-default))) nil
+  (display display)
+  ((or time 0) (unsigned 32)))
 
-(defbinding (pointer-is-grabbed-p "gdk_pointer_is_grabbed") () boolean)
 
-(defbinding screen-width () int)
-(defbinding screen-height () int)
 
-(defbinding screen-width-mm () int)
-(defbinding screen-height-mm () int)
+(defbinding atom-intern (atom-name &optional only-if-exists) atom
+  ((string atom-name) string)
+  (only-if-exists boolean))
 
-(defbinding flush () nil)
-(defbinding beep () nil)
+(defbinding atom-name () string
+  (atom atom))
 
 
 
@@ -166,26 +211,64 @@ (defbinding list-visuals () (glist visual))
 
 ;;; Windows
 
-; (defbinding window-new ... )
-
 (defbinding window-destroy () nil
   (window window))
 
 
-; (defbinding window-at-pointer () window
-;   (window window)
-;   (x int :in-out)
-;   (y int :in-out))
+(defbinding window-at-pointer () window
+  (x int :out)
+  (y int :out))
 
 (defbinding window-show () nil
   (window window))
 
+(defbinding window-show-unraised () nil
+  (window window))
+
 (defbinding window-hide () nil
   (window window))
 
+(defbinding window-is-visible-p () boolean
+  (window window))
+
+(defbinding window-is-viewable-p () boolean
+  (window window))
+
 (defbinding window-withdraw () nil
   (window window))
 
+(defbinding window-iconify () nil
+  (window window))
+
+(defbinding window-deiconify () nil
+  (window window))
+
+(defbinding window-stick () nil
+  (window window))
+
+(defbinding window-unstick () nil
+  (window window))
+
+(defbinding window-maximize () nil
+  (window window))
+
+(defbinding window-unmaximize () nil
+  (window window))
+
+(defbinding window-fullscreen () nil
+  (window window))
+
+(defbinding window-unfullscreen () nil
+  (window window))
+
+(defbinding window-set-keep-above () nil
+  (window window)
+  (setting boolean))
+
+(defbinding window-set-keep-below () nil
+  (window window)
+  (setting boolean))
+
 (defbinding window-move () nil
   (window window)
   (x int)
@@ -203,6 +286,11 @@ (defbinding window-move-resize () nil
   (width int)
   (height int))
 
+(defbinding window-scroll () nil
+  (window window)
+  (dx int)
+  (dy int))
+
 (defbinding window-reparent () nil
   (window window)
   (new-parent window)
@@ -212,32 +300,18 @@ (defbinding window-reparent () nil
 (defbinding window-clear () nil
   (window window))
 
-(unexport
- '(window-clear-area-no-e window-clear-area-e))
-
-(defbinding (window-clear-area-no-e "gdk_window_clear_area") () nil
+(defbinding %window-clear-area () nil
   (window window)
   (x int) (y int) (width int) (height int))
 
-(defbinding window-clear-area-e () nil
+(defbinding %window-clear-area-e () nil
   (window window)
   (x int) (y int) (width int) (height int))
 
 (defun window-clear-area (window x y width height &optional expose)
   (if expose
-      (window-clear-area-e window x y width height)
-    (window-clear-area-no-e window x y width height)))
-
-; (defbinding window-copy-area () nil
-;   (window window)
-;   (gc gc)
-;   (x int)
-;   (y int)
-;   (source-window window)
-;   (source-x int)
-;   (source-y int)
-;   (width int)
-;   (height int))
+      (%window-clear-area-e window x y width height)
+    (%window-clear-area window x y width height)))
 
 (defbinding window-raise () nil
   (window window))
@@ -245,7 +319,33 @@ (defbinding window-raise () nil
 (defbinding window-lower () nil
   (window window))
 
-; (defbinding window-set-user-data () nil
+(defbinding window-focus () nil
+  (window window)
+  (timestamp unsigned-int))
+
+(defbinding window-register-dnd () nil
+  (window window))
+
+(defbinding window-begin-resize-drag () nil
+  (window window)
+  (edge window-edge)
+  (button int)
+  (root-x int)
+  (root-y int)
+  (timestamp unsigned-int))
+
+(defbinding window-begin-move-drag () nil
+  (window window)
+  (button int)
+  (root-x int)
+  (root-y int)
+  (timestamp unsigned-int))
+
+;;
+
+(defbinding window-set-user-data () nil
+  (window window)
+  (user-data pointer))
 
 (defbinding window-set-override-redirect () nil
   (window window)
@@ -267,11 +367,6 @@ (defbinding window-set-child-shapes () nil
 (defbinding window-merge-child-shapes () nil
   (window window))
 
-(defbinding (window-is-visible-p "gdk_window_is_visible") () boolean
-  (window window))
-
-(defbinding (window-is-viewable-p "gdk_window_is_viewable") () boolean
-  (window window))
 
 (defbinding window-set-static-gravities () boolean
   (window window)
@@ -279,22 +374,9 @@ (defbinding window-set-static-gravities () boolean
 
 ; (defbinding add-client-message-filter ...
 
-
-;;; Drag and Drop
-
-;; Destination side
-
-(defbinding drag-status () nil
-  (context drag-context)
-  (action drag-action)
-  (time (unsigned 32)))
-
-
-
-
 (defbinding window-set-cursor () nil
   (window window)
-  (cursor cursor))
+  (cursor (or null cursor)))
 
 (defbinding window-get-pointer () window
   (window window)
@@ -302,6 +384,13 @@ (defbinding window-get-pointer () window
   (y int :out)
   (mask modifier-type :out))
 
+(defbinding %window-get-toplevels () (glist window))
+
+(defun window-get-toplevels (&optional screen)
+  (if screen
+      (error "Not implemented")
+    (%window-get-toplevels)))
+
 (defbinding %get-default-root-window () window)
 
 (defun get-root-window (&optional display)
@@ -310,6 +399,21 @@ (defun get-root-window (&optional display)
     (%get-default-root-window)))
 
 
+
+;;; Drag and Drop
+
+;; Destination side
+
+(defbinding drag-status () nil
+  (context drag-context)
+  (action drag-action)
+  (time (unsigned 32)))
+
+
+
+
+
+
 ;;
 
 (defbinding rgb-init () nil)
@@ -319,32 +423,43 @@ (defbinding rgb-init () nil)
 
 ;;; Cursor
 
-(defbinding cursor-new () cursor
+(defmethod allocate-foreign ((cursor cursor) &key source mask fg bg 
+                            (x 0) (y 0) (display (display-get-default)))
+  (etypecase source
+    (keyword (%cursor-new-for-display display source))
+    (pixbuf (%cursor-new-from-pixbuf display source x y))
+    (pixmap (%cursor-new-from-pixmap source mask 
+            (or fg (ensure-color #(0.0 0.0 0.0)))
+            (or bg (ensure-color #(1.0 1.0 1.0))) x y))
+    (pathname (%cursor-new-from-pixbuf display (pixbuf-load source) x y))))
+
+(defun ensure-cursor (cursor &rest args)
+  (if (typep cursor 'cursor)
+      cursor
+    (apply #'make-instance 'cursor :type cursor args)))
+
+(defbinding %cursor-new-for-display () pointer
+  (display display)
   (cursor-type cursor-type))
 
-(defbinding cursor-new-from-pixmap () cursor
+(defbinding %cursor-new-from-pixmap () pointer
   (source pixmap)
   (mask bitmap)
   (foreground color)
   (background color)
   (x int) (y int))
 
+(defbinding %cursor-new-from-pixbuf () pointer
+  (display display)
+  (pixbuf pixbuf)
+  (x int) (y int))
+
 (defbinding %cursor-ref () pointer
   (location pointer))
 
 (defbinding %cursor-unref () nil
   (location pointer))
 
-(defmethod reference-foreign ((class (eql (find-class 'cursor))) location)
-  (declare (ignore class))
-  (%cursor-ref location))
-
-(defmethod unreference-foreign ((class (eql (find-class 'cursor))) location)
-  (declare (ignore class))
-  (%cursor-unref location))
-
-
-
 
 ;;; Pixmaps
 
@@ -359,7 +474,7 @@ (defbinding %pixmap-colormap-create-from-xpm () pixmap
   (colormap (or null colormap))
   (mask bitmap :out)
   (color (or null color))
-  (filename string))
+  (filename pathname))
 
 (defbinding %pixmap-colormap-create-from-xpm-d () pixmap
   (window (or null window))
@@ -376,26 +491,32 @@ (defun pixmap-create (source &key color window colormap)
     (multiple-value-bind (pixmap mask)
         (etypecase source
          ((or string pathname)
-          (%pixmap-colormap-create-from-xpm
-           window colormap color (namestring (truename source))))
+          (%pixmap-colormap-create-from-xpm window colormap color  source))
          ((vector string)
           (%pixmap-colormap-create-from-xpm-d window colormap color source)))
-;;       (unreference-instance pixmap)
-;;       (unreference-instance mask)
       (values pixmap mask))))
 
 
 
 ;;; Color
 
+(defbinding %color-copy () pointer
+  (location pointer))
+
+(defmethod allocate-foreign ((color color)  &rest initargs)
+  (declare (ignore color initargs))
+  ;; Color structs are allocated as memory chunks by gdk, and since
+  ;; there is no gdk_color_new we have to use this hack to get a new
+  ;; color chunk
+  (with-memory (location #.(foreign-size (find-class 'color)))
+    (%color-copy location)))
+
 (defun %scale-value (value)
   (etypecase value
     (integer value)
     (float (truncate (* value 65535)))))
 
-(defmethod initialize-instance ((color color) &rest initargs
-                               &key red green blue)
-  (declare (ignore initargs))
+(defmethod initialize-instance ((color color) &key (red 0.0) (green 0.0) (blue 0.0))
   (call-next-method)
   (with-slots ((%red red) (%green green) (%blue blue)) color
     (setf
@@ -403,23 +524,137 @@ (defmethod initialize-instance ((color color) &rest initargs
      %green (%scale-value green)
      %blue (%scale-value blue))))
 
+(defbinding %color-parse () boolean
+  (spec string)
+  (color color :in/return))
+
+(defun color-parse (spec &optional (color (make-instance 'color)))
+  (multiple-value-bind (succeeded-p color) (%color-parse spec color)
+    (if succeeded-p
+       color
+      (error "Parsing color specification ~S failed." spec))))
+
 (defun ensure-color (color)
   (etypecase color
     (null nil)
     (color color)
+    (string (color-parse color))
     (vector
-     (make-instance
-      'color :red (svref color 0) :green (svref color 1)
-      :blue (svref color 2)))))
-       
+     (make-instance 'color 
+      :red (svref color 0) :green (svref color 1) :blue (svref color 2)))))
+
 
   
-;;; Drawing functions
+;;; Drawable -- all the draw- functions are dprecated and will be
+;;; removed, use cairo for drawing instead.
+
+(defbinding drawable-get-size () nil
+  (drawable drawable)
+  (width int :out)
+  (height int :out))
+
+(defbinding (drawable-width "gdk_drawable_get_size") () nil
+  (drawable drawable)
+  (width int :out)
+  (nil null))
+
+(defbinding (drawable-height "gdk_drawable_get_size") () nil
+  (drawable drawable)
+  (nil null)
+  (height int :out))
+
+;; (defbinding drawable-get-clip-region () region
+;;   (drawable drawable))
+
+;; (defbinding drawable-get-visible-region () region
+;;   (drawable drawable))
+
+(defbinding draw-point () nil
+  (drawable drawable) (gc gc) 
+  (x int) (y int))
+
+(defbinding %draw-points () nil
+  (drawable drawable) (gc gc) 
+  (points pointer)
+  (n-points int))
+
+(defbinding draw-line () nil
+  (drawable drawable) (gc gc) 
+  (x1 int) (y1 int)
+  (x2 int) (y2 int))
+
+(defbinding draw-pixbuf
+    (drawable gc pixbuf src-x src-y dest-x dest-y &optional
+     width height (dither :none) (x-dither 0) (y-dither 0)) nil
+  (drawable drawable) (gc (or null gc))
+  (pixbuf pixbuf)
+  (src-x int) (src-y int)
+  (dest-x int) (dest-y int)
+  ((or width -1) int) ((or height -1) int)
+  (dither rgb-dither)
+  (x-dither int) (y-dither int))
 
 (defbinding draw-rectangle () nil
-  (drawable (or window pixmap bitmap))
-  (gc gc) (filled boolean)
-  (x int) (y int) (width int) (height int))
+  (drawable drawable) (gc gc) 
+  (filled boolean)
+  (x int) (y int) 
+  (width int) (height int))
+
+(defbinding draw-arc () nil
+  (drawable drawable) (gc gc) 
+  (filled boolean)
+  (x int) (y int) 
+  (width int) (height int)
+  (angle1 int) (angle2 int))
+
+(defbinding %draw-layout () nil
+  (drawable drawable) (gc gc) 
+  (font pango:font)
+  (x int) (y int)
+  (layout pango:layout))
+
+(defbinding %draw-layout-with-colors () nil
+  (drawable drawable) (gc gc) 
+  (font pango:font)
+  (x int) (y int)
+  (layout pango:layout)
+  (foreground (or null color))
+  (background (or null color)))
+
+(defun draw-layout (drawable gc font x y layout &optional foreground background)
+  (if (or foreground background)
+      (%draw-layout-with-colors drawable gc font x y layout foreground background)
+    (%draw-layout drawable gc font x y layout)))
+
+(defbinding draw-drawable 
+    (drawable gc src src-x src-y dest-x dest-y &optional width height) nil
+  (drawable drawable) (gc gc) 
+  (src drawable)
+  (src-x int) (src-y int)
+  (dest-x int) (dest-y int)
+  ((or width -1) int) ((or height -1) int))
+
+(defbinding draw-image 
+    (drawable gc image src-x src-y dest-x dest-y &optional width height) nil
+  (drawable drawable) (gc gc) 
+  (image image)
+  (src-x int) (src-y int)
+  (dest-x int) (dest-y int)
+  ((or width -1) int) ((or height -1) int))
+
+(defbinding drawable-get-image () image
+  (drawable drawable)
+  (x int) (y int)
+  (width int) (height int))
+
+(defbinding drawable-copy-to-image 
+    (drawable src-x src-y width height &optional image dest-x dest-y) image
+  (drawable drawable)
+  (image (or null image))
+  (src-x int) (src-y int)
+  ((if image dest-x 0) int) 
+  ((if image dest-y 0) int)
+  (width int) (height int))
 
 
 ;;; Key values
@@ -427,13 +662,19 @@ (defbinding draw-rectangle () nil
 (defbinding keyval-name () string
   (keyval unsigned-int))
 
-(defbinding keyval-from-name () unsigned-int
+(defbinding %keyval-from-name () unsigned-int
   (name string))
 
+(defun keyval-from-name (name)
+  "Returns the keysym value for the given key name or NIL if it is not a valid name."
+  (let ((keyval (%keyval-from-name name)))
+    (unless (zerop keyval)
+      keyval)))
+
 (defbinding keyval-to-upper () unsigned-int
   (keyval unsigned-int))
 
-(defbinding keyval-to-lower ()unsigned-int
+(defbinding keyval-to-lower () unsigned-int
   (keyval unsigned-int))
 
 (defbinding (keyval-is-upper-p "gdk_keyval_is_upper") () boolean
@@ -442,3 +683,72 @@ (defbinding (keyval-is-upper-p "gdk_keyval_is_upper") () boolean
 (defbinding (keyval-is-lower-p "gdk_keyval_is_lower") () boolean
   (keyval unsigned-int))
 
+;;; Cairo interaction
+
+#?(pkg-exists-p "gtk+-2.0" :atleast-version "2.8.0")
+(progn
+  (defbinding cairo-create () cairo:context
+    (drawable drawable))
+
+  (defmacro with-cairo-context ((cr drawable) &body body)
+    `(let ((,cr (cairo-create ,drawable)))
+       (unwind-protect
+          (progn ,@body)
+        (invalidate-instance ,cr t))))
+
+  (defbinding cairo-set-source-color () nil
+    (cr cairo:context)
+    (color color))
+
+  (defbinding cairo-set-source-pixbuf () nil
+    (cr cairo:context)
+    (pixbuf pixbuf)
+    (x double-float)
+    (y double-float))
+  (defbinding cairo-rectangle () nil
+    (cr cairo:context)
+    (rectangle rectangle))
+;;   (defbinding cairo-region () nil
+;;     (cr cairo:context)
+;;     (region region))
+)
+
+
+
+;;; Multi-threading support
+
+#+sbcl
+(progn
+  (defvar *global-lock* (sb-thread:make-mutex :name "global GDK lock"))
+  (let ((recursive-level 0))
+    (defun threads-enter ()
+      (if (eq (sb-thread:mutex-value *global-lock*) sb-thread:*current-thread*)
+         (incf recursive-level)
+       (sb-thread:get-mutex *global-lock*)))
+
+    (defun threads-leave (&optional flush-p)
+      (cond
+       ((zerop recursive-level)          
+       (when flush-p
+         (display-flush))
+       (sb-thread:release-mutex *global-lock*))
+       (t (decf recursive-level)))))
+
+  (define-callback %enter-fn nil ()
+    (threads-enter))
+  
+  (define-callback %leave-fn nil ()
+    (threads-leave))
+  
+  (defbinding threads-set-lock-functions (&optional) nil
+    (%enter-fn callback)
+    (%leave-fn callback))
+
+  (defmacro with-global-lock (&body body)
+    `(progn
+       (threads-enter)
+       (unwind-protect
+          ,@body
+        (threads-leave t)))))