lib/sod.h, src/class-{output,utilities}.lisp: Macros for messages.
[sod] / src / class-output.lisp
index b168d89..3345ac3 100644 (file)
@@ -44,6 +44,7 @@
      (class :ichains :start) (class :ichains :end)
      (class :ilayout :start) (class :ilayout :slots) (class :ilayout :end)
      (class :conversions)
+     (class :message-macros)
      (class :object)
      (:classes :end))
 
                     (sod-class-nickname super-head))))
         (terpri stream)))))
 
+  ;; Provide convenience macros for sending the newly defined messages.  (The
+  ;; macros work on all subclasses too.)
+  ;;
+  ;; We need each message's method entry type for this, so we need to dig it
+  ;; out of the vtmsgs structure.  Indeed, the vtmsgs for this class contains
+  ;; entries for precisely the messages we want to make macros for.
+  (when (sod-class-messages class)
+    (sequence-output (stream sequencer)
+      ((class :message-macros)
+       (let* ((vtable (find (sod-class-chain-head class)
+                           (sod-class-vtables class)
+                           :key #'vtable-chain-head))
+             (vtmsgs (find-if (lambda (item)
+                                (and (typep item 'vtmsgs)
+                                     (eql (vtmsgs-class item) class)))
+                              (vtable-body vtable))))
+        (format stream "/* Message invocation macros. */~%")
+        ;;(break)
+        (dolist (entry (vtmsgs-entries vtmsgs))
+          (let* ((type (method-entry-function-type entry))
+                 (args (c-function-arguments type))
+                 (method (method-entry-effective-method entry))
+                 (message (effective-method-message method))
+                 (in-names nil) (out-names nil) (varargsp nil) (me "me"))
+            (do ((args args (cdr args)))
+                ((endp args))
+              (let* ((raw-name (argument-name (car args)))
+                     (name (if (find raw-name
+                                     (list "_vt"
+                                           (sod-class-nickname class)
+                                           (sod-message-name message))
+                                     :test #'string=)
+                               (format nil "sod__a_~A" raw-name)
+                               raw-name)))
+                (cond ((and (cdr args) (eq (cadr args) :ellipsis))
+                       (setf varargsp t)
+                       (unless in-names (setf me "SOD__CAR(__VA_ARGS__)"))
+                       (push (format nil "/*~A*/ ..." name) in-names)
+                       (push "__VA_ARGS__" out-names)
+                       (return))
+                      (t
+                       (push name in-names)
+                       (push name out-names)))))
+            (when varargsp
+              (format stream "#if __STDC_VERSION__ >= 199901~%"))
+            (format stream "#define ~A(~{~A~^, ~}) ~
+                                  ~A->_vt->~A.~A(~{~A~^, ~})~%"
+                    (message-macro-name class message)
+                    (nreverse in-names)
+                    me
+                    (sod-class-nickname class)
+                    (sod-message-name message)
+                    (nreverse out-names))
+            (when varargsp
+              (format stream "#endif~%"))))
+        (terpri stream)))))
+
   ;; Generate vtmsgs structure for all superclasses.
   (hook-output (car (sod-class-vtables class))
                    'vtmsgs
   (with-slots (ilayout vtables methods effective-methods) class
     (hook-output ilayout reason sequencer)
     (dolist (method methods) (hook-output method reason sequencer))
-    (dolist (method effective-methods)
-      (hook-output method reason sequencer))
+    (dolist (method effective-methods) (hook-output method reason sequencer))
     (dolist (vtable vtables) (hook-output vtable reason sequencer))))
 
 ;;;--------------------------------------------------------------------------
         (format stream "};~2%"))))
     (sequence-output (stream sequencer)
       ((class :vtable-externs)
-       (format stream "~@<extern struct ~A ~2I~_~A__vtable_~A;~:>~%"
+       (format stream "~@<extern const struct ~A ~2I~_~A__vtable_~A;~:>~%"
               (vtable-struct-tag chain-tail chain-head)
               class (sod-class-nickname chain-head))))))
 
   (with-slots (entries) vtmsgs
     (dolist (entry entries) (hook-output entry reason sequencer))))
 
-(defmethod hook-output progn ((entry method-entry) reason sequencer)
-  (with-slots (method) entry
-    (hook-output method reason sequencer)))
-
 (defmethod hook-output progn ((entry method-entry)
                              (reason (eql 'vtmsgs))
                              sequencer)
   (let* ((method (method-entry-effective-method entry))
         (message (effective-method-message method))
         (class (effective-method-class method))
-        (type (method-entry-function-type entry))
-        (commented-type (commentify-function-type type)))
+        (function-type (method-entry-function-type entry))
+        (commented-type (commentify-function-type function-type))
+        (pointer-type (make-pointer-type commented-type)))
     (sequence-output (stream sequencer)
       ((class :vtmsgs (sod-message-class message) :slots)
        (pprint-logical-block (stream nil :prefix "  " :suffix ";")
-        (pprint-c-type commented-type stream (sod-message-name message)))
+        (pprint-c-type pointer-type stream (sod-message-name message)))
        (terpri stream)))))
 
 (defmethod hook-output progn ((cptr class-pointer)
       ((class :vtable chain-head :slots)
        (format stream "  const ~A *~:[_class~;~:*_cls_~A~];~%"
               metaclass
-              (if (sod-class-direct-superclasses meta-chain-head)
-                  (sod-class-nickname meta-chain-head)
-                  nil))))))
+              (and (sod-class-direct-superclasses meta-chain-head)
+                   (sod-class-nickname meta-chain-head)))))))
 
 (defmethod hook-output progn ((boff base-offset) (reason (eql :h)) sequencer)
   (with-slots (class chain-head) boff
@@ -360,7 +413,7 @@ const struct ~A ~A__classobj = {~%"
                      sequencer)))
 
 ;;;--------------------------------------------------------------------------
-;;; Direct methods.
+;;; Direct and effective methods.
 
 (defmethod hook-output progn ((method delegating-direct-method)
                              (reason (eql :c))
@@ -420,10 +473,10 @@ const struct ~A ~A__classobj = {~%"
                   (class :vtables :end))
       ((class :vtable chain-head :start)
        (format stream "/* Vtable for ~A chain. */~@
-                      static const struct ~A ~A = {~%"
+                      const struct ~A ~A = {~%"
               chain-head
               (vtable-struct-tag chain-tail chain-head)
-              (vtable-name chain-tail chain-head)))
+              (vtable-name class chain-head)))
       ((class :vtable chain-head :end)
        (format stream "};~2%")))))
 
@@ -436,8 +489,12 @@ const struct ~A ~A__classobj = {~%"
                   (class :vtable chain-head :class-pointer metaclass)
                   (class :vtable chain-head :end))
       ((class :vtable chain-head :class-pointer metaclass)
-       (format stream "  &~A__classobj.~A.~A,~%"
-              (sod-class-metaclass class)
+       (format stream "  /* ~21@A = */ &~A__classobj.~A.~A,~%"
+              (if (sod-class-direct-superclasses meta-chain-head)
+                  (format nil "_cls_~A"
+                          (sod-class-nickname meta-chain-head))
+                  "_class")
+              class
               (sod-class-nickname meta-chain-head)
               (sod-class-nickname metaclass))))))
 
@@ -448,7 +505,8 @@ const struct ~A ~A__classobj = {~%"
                   (class :vtable chain-head :base-offset)
                   (class :vtable chain-head :end))
       ((class :vtable chain-head :base-offset)
-       (format stream "  offsetof(struct ~A, ~A),~%"
+       (format stream "  /* ~21@A = */ offsetof(struct ~A, ~A),~%"
+              "_base"
               (ilayout-struct-tag class)
               (sod-class-nickname chain-head))))))
 
@@ -461,7 +519,8 @@ const struct ~A ~A__classobj = {~%"
                   (class :vtable chain-head :chain-offset target-head)
                   (class :vtable chain-head :end))
       ((class :vtable chain-head :chain-offset target-head)
-       (format stream "  SOD_OFFSETDIFF(struct ~A, ~A, ~A),~%"
+       (format stream "  /* ~21@A = */ SOD_OFFSETDIFF(struct ~A, ~A, ~A),~%"
+              (format nil "_off_~A" (sod-class-nickname target-head))
               (ilayout-struct-tag class)
               (sod-class-nickname chain-head)
               (sod-class-nickname target-head))))))
@@ -489,7 +548,8 @@ const struct ~A ~A__classobj = {~%"
           (super (sod-message-class message)))
       (sequence-output (stream sequencer)
        ((class :vtable chain-head :vtmsgs super :slots)
-        (format stream "    ~A,~%"
+        (format stream "    /* ~19@A = */ ~A,~%"
+                (sod-message-name message)
                 (method-entry-function-name method chain-head)))))))
 
 ;;;--------------------------------------------------------------------------
@@ -549,17 +609,23 @@ const struct ~A ~A__classobj = {~%"
 
 (defgeneric output-class-initializer (slot instance stream)
   (:method ((slot sod-class-effective-slot) (instance sod-class) stream)
-    (let ((func (effective-slot-initializer-function slot)))
+    (let ((func (effective-slot-initializer-function slot))
+         (direct-slot (effective-slot-direct-slot slot)))
       (if func
-         (format stream "        ~A,~%" (funcall func instance))
+         (format stream "        /* ~15@A = */ ~A,~%"
+                 (sod-slot-name direct-slot)
+                 (funcall func instance))
          (call-next-method))))
   (:method ((slot effective-slot) (instance sod-class) stream)
-    (let ((init (find-class-initializer slot instance)))
+    (let ((init (find-class-initializer slot instance))
+         (direct-slot (effective-slot-direct-slot slot)))
       (ecase (sod-initializer-value-kind init)
-       (:simple (format stream "        ~A,~%"
+       (:simple (format stream "        /* ~15@A = */ ~A,~%"
+                        (sod-slot-name direct-slot)
                         (sod-initializer-value-form init)))
-       (:compound (format stream "        ~@<{ ~;~A~; },~:>~%"
-                        (sod-initializer-value-form init)))))))
+       (:compound (format stream "        /* ~15@A = */ ~@<{ ~;~A~; },~:>~%"
+                          (sod-slot-name direct-slot)
+                          (sod-initializer-value-form init)))))))
 
 (defmethod hook-output progn ((slot sod-class-effective-slot)
                              (reason (eql 'class))