X-Git-Url: http://repo.macrolet.net/gitweb/?a=blobdiff_plain;ds=sidebyside;f=glib%2Fgobject.generating.lisp;h=203578487d7edcc6ef6ddb21001ad0cf304b285a;hb=bcc0750a3031ca5bfb5d1084f56e60e1ab991973;hp=15ce217acd6a61d1e2b029599e4ba90dc0b2d002;hpb=5da489e94abf996d701f5a135ed6a7038827afe4;p=cl-gtk2.git diff --git a/glib/gobject.generating.lisp b/glib/gobject.generating.lisp index 15ce217..2035784 100644 --- a/glib/gobject.generating.lisp +++ b/glib/gobject.generating.lisp @@ -1,15 +1,16 @@ (in-package :gobject) -(defvar *lisp-name-package* (find-package :gobject)) +(defvar *lisp-name-package* nil + "For internal use (used by class definitions generator). Specifies the package in which symbols are interned.") (defvar *strip-prefix* "") (defvar *lisp-name-exceptions* nil) (defvar *generation-exclusions* nil) (defvar *known-interfaces* (make-hash-table :test 'equal)) (defvar *additional-properties* nil) +(defvar *generated-types* nil) (defun name->supplied-p (name) - (intern (format nil "~A-SUPPLIED-P" (symbol-name name)) - *lisp-name-package*)) + (make-symbol (format nil "~A-SUPPLIED-P" (symbol-name name)))) (defstruct property name accessor-name readable writable) @@ -36,13 +37,6 @@ :reader ',(cffi-property-reader object) :writer ',(cffi-property-writer object))) -(defun parse-accessor (spec) - (ecase (first spec) - (:cffi (destructuring-bind (&key reader writer) (rest spec) - (make-cffi-property-accessor :reader reader :writer writer))) - (:gobject (destructuring-bind (property-name) (rest spec) - (make-gobject-property-accessor :property-name property-name))))) - (defun parse-gobject-property (spec) (destructuring-bind (name accessor-name gname type readable writable) spec (make-gobject-property :name name @@ -94,42 +88,43 @@ (lispify-name property-name)) *lisp-name-package*)) -(defgeneric property->reader (property)) -(defgeneric property->writer (property)) +(defgeneric property->reader (class property)) +(defgeneric property->writer (class property)) -(defmethod property->reader ((property gobject-property)) +(defmethod property->reader (class (property gobject-property)) (with-slots (accessor-name type gname) property - `(defun ,accessor-name (object) + `(defmethod ,accessor-name ((object ,class)) (g-object-call-get-property object ,gname ,type)))) -(defmethod property->reader ((property cffi-property)) +(defmethod property->reader (class (property cffi-property)) (with-slots (accessor-name type reader) property - `(defun ,accessor-name (object) - (foreign-funcall ,reader g-object object ,type)))) + (etypecase reader + (string `(defmethod ,accessor-name ((object ,class)) + (foreign-funcall ,reader g-object object ,type))) + (symbol `(defmethod ,accessor-name ((object ,class)) + (funcall ',reader object)))))) -(defmethod property->writer ((property gobject-property)) +(defmethod property->writer (class (property gobject-property)) (with-slots (accessor-name type gname) property - `(defun (setf ,accessor-name) (new-value object) - (g-object-call-set-property object ,gname new-value ,type)))) - -(defmethod property->writer ((property cffi-property)) - (with-slots (accessor-name type writer) property - `(defun (setf ,accessor-name) (new-value object) - (foreign-funcall ,writer g-object object ,type new-value :void)))) - -(defun property->writer (property) - (let ((name (nth 1 property)) - (prop-name (nth 2 property)) - (prop-type (nth 3 property))) - `(defun (setf ,name) (new-value object) - (g-object-call-set-property object ,prop-name new-value ,prop-type) + `(defmethod (setf ,accessor-name) (new-value (object ,class)) + (g-object-call-set-property object ,gname new-value ,type) new-value))) -(defun property->accessors (property export) +(defmethod property->writer (class (property cffi-property)) + (with-slots (accessor-name type writer) property + (etypecase writer + (string `(defmethod (setf ,accessor-name) (new-value (object ,class)) + (foreign-funcall ,writer g-object object ,type new-value :void) + new-value)) + (symbol `(defmethod (setf ,accessor-name) (new-value (object ,class)) + (funcall ',writer object new-value) + new-value))))) + +(defun property->accessors (class property export) (append (when (property-readable property) - (list (property->reader property))) + (list (property->reader class property))) (when (property-writable property) - (list (property->writer property))) + (list (property->writer class property))) (when export (list `(export ',(property-accessor-name property) (find-package ,(package-name (symbol-package (property-accessor-name property))))))))) @@ -142,9 +137,28 @@ (defun type-initializer-call (type-initializer) (etypecase type-initializer - (string `(foreign-funcall ,type-initializer g-type)) + (string `(if (foreign-symbol-pointer ,type-initializer) + (foreign-funcall-pointer + (foreign-symbol-pointer ,type-initializer) () + g-type) + (warn "Type initializer '~A' is not available" ,type-initializer))) (symbol `(funcall ',type-initializer)))) +(defun meta-property->slot (class-name property) + `(,(property-name property) + :allocation ,(if (gobject-property-p property) :gobject-property :gobject-fn) + :g-property-type ,(if (gobject-property-p property) (gobject-property-type property) (cffi-property-type property)) + :accessor ,(intern (format nil "~A-~A" (symbol-name class-name) (property-name property)) (symbol-package class-name)) + ,@(when (if (gobject-property-p property) + t + (not (null (cffi-property-writer property)))) + `(:initarg + ,(intern (string-upcase (property-name property)) (find-package :keyword)))) + ,@(if (gobject-property-p property) + `(:g-property-name ,(gobject-property-gname property)) + `(:g-getter ,(cffi-property-reader property) + :g-setter ,(cffi-property-writer property))))) + (defmacro define-g-object-class (g-type-name name (&key (superclass 'g-object) (export t) @@ -152,52 +166,38 @@ type-initializer) (&rest properties)) (setf properties (mapcar #'parse-property properties)) - (let* ((superclass-properties (get superclass 'properties)) - (combined-properties (append superclass-properties properties))) - `(progn - (defclass ,name (,superclass ,@(mapcar #'interface->lisp-class-name interfaces)) ()) - (register-object-type ,g-type-name ',name) + `(progn + (defclass ,name (,@(when (and superclass (not (eq superclass 'g-object))) (list superclass)) ,@(mapcar #'interface->lisp-class-name interfaces)) + (,@(mapcar (lambda (property) (meta-property->slot name property)) properties)) + (:metaclass gobject-class) + (:g-type-name . ,g-type-name) ,@(when type-initializer - (list (type-initializer-call type-initializer))) - ,@(when export - (list `(export ',name (find-package ,(package-name (symbol-package name)))))) - (defmethod initialize-instance :before - ((object ,name) &key pointer - ,@(remove nil (mapcar #'property->method-arg - combined-properties))) - (unless (or pointer (and (slot-boundp object 'pointer) - (not (null-pointer-p (pointer object))))) - (let (arg-names arg-values arg-types) - ,@(mapcar #'gobject-property->arg-push (remove-if-not #'gobject-property-p combined-properties)) - (setf (pointer object) - (g-object-call-constructor ,g-type-name - arg-names - arg-values - arg-types) - (g-object-has-reference object) t) - ,@(mapcar #'cffi-property->initarg (remove-if-not #'cffi-property-p combined-properties))))) - ,@(loop - for property in properties - append (property->accessors property export)) - - (eval-when (:compile-toplevel :load-toplevel :execute) - (setf (get ',name 'superclass) ',superclass - (get ',name 'properties) ',combined-properties))))) - -(defmacro define-g-interface (g-name name (&key (export t) type-initializer) &body properties) + (list `(:g-type-initializer . ,type-initializer)))) + ,@(when export + (cons `(export ',name (find-package ,(package-name (symbol-package name)))) + (mapcar (lambda (property) + `(export ',(intern (format nil "~A-~A" (symbol-name name) (property-name property)) (symbol-package name)) + (find-package ,(package-name (symbol-package name))))) + properties))))) + +(defmacro define-g-interface (g-type-name name (&key (export t) type-initializer) &body properties) (setf properties (mapcar #'parse-property properties)) `(progn - (defclass ,name () ()) + (defclass ,name () + (,@(mapcar (lambda (property) (meta-property->slot name property)) properties)) + (:metaclass gobject-class) + (:g-type-name . ,g-type-name) + (:g-interface-p . t) + ,@(when type-initializer + (list `(:g-type-initializer . ,type-initializer)))) ,@(when export - (list `(export ',name (find-package ,(package-name (symbol-package name)))))) - ,@(when type-initializer - (list (type-initializer-call type-initializer))) - ,@(loop - for property in properties - append (property->accessors property export)) + (cons `(export ',name (find-package ,(package-name (symbol-package name)))) + (mapcar (lambda (property) + `(export ',(intern (format nil "~A-~A" (symbol-name name) (property-name property)) (symbol-package name)) + (find-package ,(package-name (symbol-package name))))) + properties))) (eval-when (:compile-toplevel :load-toplevel :execute) - (setf (get ',name 'properties) ',properties) - (setf (gethash ,g-name *known-interfaces*) ',name)))) + (setf (gethash ,g-type-name *known-interfaces*) ',name)))) (defun starts-with (name prefix) (and prefix (> (length name) (length prefix)) (string= (subseq name 0 (length prefix)) prefix))) @@ -240,8 +240,15 @@ (write-char (char-downcase c) stream)) (write-string "_get_type" stream))) -(defun get-g-class-definition (type) - (let* ((g-type (ensure-g-type type)) +(defun get-g-class-definition (type &optional lisp-name-package) + (when (and (stringp type) (zerop (g-type-numeric type))) + (let ((type-init-name (probable-type-init-name type))) + (when (foreign-symbol-pointer type-init-name) + (foreign-funcall-pointer (foreign-symbol-pointer type-init-name) () :int)))) + (when *generated-types* + (setf (gethash (g-type-string type) *generated-types*) t)) + (let* ((*lisp-name-package* (or lisp-name-package *lisp-name-package* *package*)) + (g-type (ensure-g-type type)) (g-name (g-type-name g-type)) (name (g-name->name g-name)) (superclass-g-type (g-type-parent g-type)) @@ -250,14 +257,12 @@ (properties (class-properties g-type)) (type-init-name (probable-type-init-name g-name)) (own-properties - (remove-if-not (lambda (property) - (= g-type - (g-class-property-definition-owner-type property))) - properties))) + (sort (copy-list (remove g-type properties :key #'g-class-property-definition-owner-type :test-not #'g-type=)) + #'string< :key #'g-class-property-definition-name))) `(define-g-object-class ,g-name ,name (:superclass ,superclass-name :export t - :interfaces (,@(mapcar #'g-type-name interfaces)) + :interfaces (,@(sort (mapcar #'g-type-name interfaces) 'string<)) ,@(when (and (foreign-symbol-pointer type-init-name) (not (null-pointer-p (foreign-symbol-pointer type-init-name)))) `(:type-initializer ,type-init-name))) @@ -266,26 +271,37 @@ own-properties) ,@(cdr (find g-name *additional-properties* :key 'car :test 'string=)))))) -(defun get-g-interface-definition (interface) - (let* ((type (ensure-g-type interface)) +(defun get-g-interface-definition (interface &optional lisp-name-package) + (when (and (stringp interface) (zerop (g-type-numeric interface))) + (let ((type-init-name (probable-type-init-name interface))) + (when (foreign-symbol-pointer type-init-name) + (foreign-funcall-pointer (foreign-symbol-pointer type-init-name) () :int)))) + (when *generated-types* + (setf (gethash (g-type-string interface) *generated-types*) t)) + (let* ((*lisp-name-package* (or lisp-name-package *lisp-name-package* *package*)) + (type (ensure-g-type interface)) (g-name (g-type-name type)) (name (g-name->name g-name)) - (properties (interface-properties type)) + (properties (sort (copy-list (interface-properties type)) + #'string< :key #'g-class-property-definition-name)) (probable-type-initializer (probable-type-init-name g-name))) `(define-g-interface ,g-name ,name (:export t ,@(when (foreign-symbol-pointer probable-type-initializer) `(:type-initializer ,probable-type-initializer))) - ,@(mapcar (lambda (property) - (property->property-definition name property)) - properties)))) + ,@(append (mapcar (lambda (property) + (property->property-definition name property)) + properties) + (cdr (find g-name *additional-properties* :key 'car :test 'string=)))))) (defun get-g-class-definitions-for-root-1 (type) - (unless (member (ensure-g-type type) *generation-exclusions* :test '=) - (cons (get-g-class-definition type) - (reduce #'append - (mapcar #'get-g-class-definitions-for-root-1 - (g-type-children type)))))) + (unless (member type *generation-exclusions* :test 'g-type=) + (iter (when (first-iteration-p) + (unless (and *generated-types* + (gethash (g-type-string type) *generated-types*)) + (appending (list (get-g-class-definition type))))) + (for child-type in (sort (copy-list (g-type-children type)) #'string< :key #'g-type-string)) + (appending (get-g-class-definitions-for-root-1 child-type))))) (defun get-g-class-definitions-for-root (type) (setf type (ensure-g-type type)) @@ -296,25 +312,26 @@ (defun class-or-interface-properties (type) (setf type (ensure-g-type type)) (cond - ((= (g-type-fundamental type) +g-type-object+) (class-properties type)) - ((= (g-type-fundamental type) +g-type-interface+) (interface-properties type)))) + ((g-type= (g-type-fundamental type) +g-type-object+) (class-properties type)) + ((g-type= (g-type-fundamental type) +g-type-interface+) (interface-properties type)))) (defun get-shallow-referenced-types (type) (setf type (ensure-g-type type)) (remove-duplicates (sort (loop for property in (class-or-interface-properties type) - when (= type (g-class-property-definition-owner-type property)) + when (g-type= type (g-class-property-definition-owner-type property)) collect (g-class-property-definition-type property)) - #'<) + #'string< + :key #'g-type-string) :test 'equal)) (defun get-referenced-types-1 (type) (setf type (ensure-g-type type)) (loop - for property-type in (get-shallow-referenced-types type) - do (pushnew property-type *referenced-types* :test '=)) + for property-type in (sort (copy-list (get-shallow-referenced-types type)) #'string> :key #'g-type-string) + do (pushnew property-type *referenced-types* :test 'g-type=)) (loop - for type in (g-type-children type) + for type in (sort (copy-list (g-type-children type)) #'string< :key #'g-type-string) do (get-referenced-types-1 type))) (defun get-referenced-types (root-type) @@ -335,14 +352,29 @@ (equal (g-type-fundamental (ensure-g-type type)) fund-type)) types)) -(defmacro define-g-enum (g-name name (&key (export t) type-initializer) &body values) +(defmacro define-g-enum (g-name name (&key (export t) type-initializer) &body values) + "Defines a GEnum type for enumeration. Generates corresponding CFFI definition. + +Example: +@begin{pre} +\(define-g-enum \"GdkGrabStatus\" grab-status () :success :already-grabbed :invalid-time :not-viewable :frozen) +\(define-g-enum \"GdkExtensionMode\" gdk-extension-mode (:export t :type-initializer \"gdk_extension_mode_get_type\") + (:none 0) (:all 1) (:cursor 2)) +@end{pre} +@arg[g-name]{a string. Specifies the GEnum name} +@arg[name]{a symbol. Names the enumeration type.} +@arg[export]{a boolean. If true, @code{name} will be exported.} +@arg[type-initializer]{a @code{NIL} or a string or a function designator. + +If non-@code{NIL}, specifies the function that initializes the type: string specifies a C function that returns the GType value and function designator specifies the Lisp function.} +@arg[values]{values for enum. Each value is a keyword or a list @code{(keyword integer-value)}. @code{keyword} corresponds to Lisp value of enumeration, and @code{integer-value} is an C integer for enumeration item. If @code{integer-value} is not specified, it is generated automatically (see CFFI manual)}" `(progn (defcenum ,name ,@values) (register-enum-type ,g-name ',name) ,@(when export (list `(export ',name (find-package ,(package-name (symbol-package name)))))) ,@(when type-initializer - (list (type-initializer-call type-initializer))))) + (list `(at-init () ,(type-initializer-call type-initializer)))))) (defun enum-value->definition (enum-value) (let ((value-name (intern (lispify-name (enum-item-nick enum-value)) @@ -350,8 +382,15 @@ (numeric-value (enum-item-value enum-value))) `(,value-name ,numeric-value))) -(defun get-g-enum-definition (type) - (let* ((g-type (ensure-g-type type)) +(defun get-g-enum-definition (type &optional lisp-name-package) + (when (and (stringp type) (zerop (g-type-numeric type))) + (let ((type-init-name (probable-type-init-name type))) + (when (foreign-symbol-pointer type-init-name) + (foreign-funcall-pointer (foreign-symbol-pointer type-init-name) () :int)))) + (when *generated-types* + (setf (gethash (g-type-string type) *generated-types*) t)) + (let* ((*lisp-name-package* (or lisp-name-package *lisp-name-package* *package*)) + (g-type (ensure-g-type type)) (g-name (g-type-name g-type)) (name (g-name->name g-name)) (items (get-enum-items g-type)) @@ -364,13 +403,29 @@ ,@(mapcar #'enum-value->definition items)))) (defmacro define-g-flags (g-name name (&key (export t) type-initializer) &body values) + "Defines a GFlags type for enumeration that can combine its values. Generates corresponding CFFI definition. Values of this type are lists of keywords that are combined. + +Example: +@begin{pre} +\(define-g-flags \"GdkWindowState\" window-state () + (:withdrawn 1) + (:iconified 2) (:maximized 4) (:sticky 8) (:fullscreen 16) + (:above 32) (:below 64)) +@end{pre} +@arg[g-name]{a string. Specifies the GEnum name} +@arg[name]{a symbol. Names the enumeration type.} +@arg[export]{a boolean. If true, @code{name} will be exported.} +@arg[type-initializer]{a @code{NIL} or a string or a function designator. + +If non-@code{NIL}, specifies the function that initializes the type: string specifies a C function that returns the GType value and function designator specifies the Lisp function.} +@arg[values]{values for flags. Each value is a keyword or a list @code{(keyword integer-value)}. @code{keyword} corresponds to Lisp value of a flag, and @code{integer-value} is an C integer for flag. If @code{integer-value} is not specified, it is generated automatically (see CFFI manual)}" `(progn (defbitfield ,name ,@values) - (register-enum-type ,g-name ',name) + (register-flags-type ,g-name ',name) ,@(when export (list `(export ',name (find-package ,(package-name (symbol-package name)))))) ,@(when type-initializer - (list (type-initializer-call type-initializer))))) + (list `(at-init () ,(type-initializer-call type-initializer)))))) (defun flags-value->definition (flags-value) (let ((value-name (intern (lispify-name (flags-item-nick flags-value)) @@ -378,8 +433,15 @@ (numeric-value (flags-item-value flags-value))) `(,value-name ,numeric-value))) -(defun get-g-flags-definition (type) - (let* ((g-type (ensure-g-type type)) +(defun get-g-flags-definition (type &optional lisp-name-package) + (when (and (stringp type) (zerop (g-type-numeric type))) + (let ((type-init-name (probable-type-init-name type))) + (when (foreign-symbol-pointer type-init-name) + (foreign-funcall-pointer (foreign-symbol-pointer type-init-name) () :int)))) + (when *generated-types* + (setf (gethash (g-type-string type) *generated-types*) t)) + (let* ((*lisp-name-package* (or lisp-name-package *lisp-name-package* *package*)) + (g-type (ensure-g-type type)) (g-name (g-type-name g-type)) (name (g-name->name g-name)) (items (get-flags-items g-type)) @@ -391,6 +453,23 @@ probable-type-initializer))) ,@(mapcar #'flags-value->definition items)))) +(defun maybe-call-type-init (type) + (when (and (stringp type) (zerop (g-type-numeric type))) + (let ((type-init-name (probable-type-init-name type))) + (when (foreign-symbol-pointer type-init-name) + (foreign-funcall-pointer (foreign-symbol-pointer type-init-name) () :int))))) + +(defun get-g-type-definition (type &optional lisp-name-package) + (maybe-call-type-init type) + (cond + ((g-type-is-a type +g-type-enum+) (get-g-enum-definition type lisp-name-package)) + ((g-type-is-a type +g-type-flags+) (get-g-flags-definition type lisp-name-package)) + ((g-type-is-a type +g-type-interface+) (get-g-interface-definition type lisp-name-package)) + ((g-type-is-a type +g-type-object+) (get-g-class-definition type lisp-name-package)) + (t (error "Do not know how to automatically generate type definition for ~A type ~A" + (g-type-string (g-type-fundamental type)) + (or (g-type-string type) type))))) + (defun generate-types-hierarchy-to-file (file root-type &key include-referenced prefix package exceptions prologue interfaces enums flags objects exclusions additional-properties) (if (not (streamp file)) (with-open-file (stream file :direction :output :if-exists :supersede) @@ -413,6 +492,7 @@ (*lisp-name-exceptions* exceptions) (*print-case* :downcase) (*additional-properties* additional-properties) + (*generated-types* (make-hash-table :test 'equalp)) (referenced-types (and include-referenced (filter-types-by-prefix (get-referenced-types root-type) @@ -426,24 +506,24 @@ for interface in interfaces do (loop for referenced-type in (get-shallow-referenced-types interface) - do (pushnew referenced-type referenced-types :test 'equal))) + do (pushnew referenced-type referenced-types :test 'g-type=))) (loop for object in objects do (loop for referenced-type in (get-shallow-referenced-types object) - do (pushnew referenced-type referenced-types :test 'equal))) + do (pushnew referenced-type referenced-types :test 'g-type=))) (loop for enum-type in (filter-types-by-fund-type referenced-types "GEnum") for def = (get-g-enum-definition enum-type) - unless (member (ensure-g-type enum-type) exclusions :test '=) + unless (member enum-type exclusions :test 'g-type=) do (format file "~S~%~%" def)) (loop for flags-type in (filter-types-by-fund-type referenced-types "GFlags") for def = (get-g-flags-definition flags-type) - unless (member (ensure-g-type flags-type) exclusions :test '=) + unless (member flags-type exclusions :test 'g-type=) do (format file "~S~%~%" def))) (loop with auto-enums = (and include-referenced @@ -451,7 +531,7 @@ referenced-types "GEnum")) for enum in enums for def = (get-g-enum-definition enum) - unless (find (ensure-g-type enum) auto-enums :test 'equal) + unless (find enum auto-enums :test 'g-type=) do (format file "~S~%~%" def)) (loop with auto-flags = (and include-referenced @@ -459,7 +539,7 @@ referenced-types "GFlags")) for flags-type in flags for def = (get-g-flags-definition flags-type) - unless (find (ensure-g-type flags-type) auto-flags :test 'equal) + unless (find flags-type auto-flags :test 'g-type=) do (format file "~S~%~%" def)) (loop for interface in interfaces @@ -468,7 +548,7 @@ (loop for def in (get-g-class-definitions-for-root root-type) do (format file "~S~%~%" def)) - (loop - for object in objects - for def = (get-g-class-definition object) - do (format file "~S~%~%" def))))) \ No newline at end of file + (iter (for object in objects) + (unless (gethash (g-type-string object) *generated-types*) + (for def = (get-g-class-definition object)) + (format file "~S~%~%" def)))))) \ No newline at end of file