X-Git-Url: https://git.distorted.org.uk/~mdw/sod/blobdiff_plain/b426ab51d0598242a4c2b57d563341db66d71f7b..d5fdd49e70b734b791eb907706f92da5775e2a8b:/src/class-utilities.lisp diff --git a/src/class-utilities.lisp b/src/class-utilities.lisp index f00bc64..a26afd2 100644 --- a/src/class-utilities.lisp +++ b/src/class-utilities.lisp @@ -7,7 +7,7 @@ ;;;----- Licensing notice --------------------------------------------------- ;;; -;;; This file is part of the Sensble Object Design, an object system for C. +;;; This file is part of the Sensible Object Design, an object system for C. ;;; ;;; SOD is free software; you can redistribute it and/or modify ;;; it under the terms of the GNU General Public License as published by @@ -66,6 +66,91 @@ message-name #'sod-message-name)))) ;;;-------------------------------------------------------------------------- +;;; Describing class inheritance paths in diagnostics. + +(export 'inheritance-path-reporter-state) +(defclass inheritance-path-reporter-state () + ((%class :type sod-class :initarg :class) + (paths :type list :initarg :paths) + (seen :type hash-table :initform (make-hash-table)))) + +(export 'make-inheritance-path-reporter-state) +(defun make-inheritance-path-reporter-state (class) + (make-instance 'inheritance-path-reporter-state :class class)) + +(export 'report-inheritance-path) +(defun report-inheritance-path (state super) + "Issue informational messages showing how CLASS inherits from SUPER." + (with-slots (paths (class %class) include-boundary seen) state + (unless (slot-boundp state 'paths) + (setf paths (distinguished-point-shortest-paths + class + (lambda (c) + (mapcar (lambda (super) (cons super 1)) + (sod-class-direct-superclasses c)))))) + (dolist (hop (mapcon (lambda (subpath) + (let ((super (car subpath)) + (sub (and (cdr subpath) + (cadr subpath)))) + (if (or (not sub) (gethash super seen)) + nil + (progn + (setf (gethash super seen) t) + (list (cons super sub)))))) + (cdr (find super paths :key #'cadr)))) + (let ((super (car hop)) + (sub (cdr hop))) + (info-with-location sub + "Class `~A' is a direct superclass ~ + of `~A', defined here" + super sub))))) + +;;;-------------------------------------------------------------------------- +;;; Metaclass inference. + +(export 'select-minimal-class-property) +(defun select-minimal-class-property (supers key order default what + &key (present (lambda (x) + (format nil "`~A'" x))) + allow-empty) + "Return the minimal partially-ordered key from the SUPERS. + + KEY is a function of one argument which returns some interesting property + of a class. The keys are assumed to be partially ordered by ORDER, a + function of two arguments which returns non-nil if its first argument + precedes its second. If there is a unique minimal key then return it; + otherwise report a useful error and pick some candidate in an arbitrary + way; the DEFAULT may be chosen if no better choices are available. If + ALLOW-EMPTY is non-nil, then no error is reported if there are no SUPERS, + and the DEFAULT choice is returned immediately. + + In an error message, the keys are described as WHAT, which should be a + noun phrase; keys are filtered through PRESENT, a function of one + argument, before presentation. + + The function returns two values: the chosen value, and a flag which is + non-nil if it was chosen without errors." + + (let ((candidates (partial-order-minima (mapcar key supers) order))) + (cond ((and (null candidates) allow-empty) + (values default t)) + ((and candidates (null (cdr candidates))) + (values (car candidates) t)) + (t + (cerror* "No obvious choice for implicit ~A: ~ + ~{~#[root classes must specify explicitly~:;~ + candidates are ~ + ~#[~;~A~;~A and ~A~:;~@{~A, ~#[~;and ~A~]~}~]~]~:}" + what (mapcar present candidates)) + (dolist (candidate candidates) + (let ((super (find candidate supers :key key))) + (info-with-location super + "Direct superclass `~A' defined here ~ + has ~A ~A" + super what (funcall present candidate)))) + (values (if candidates (car candidates) default) nil))))) + +;;;-------------------------------------------------------------------------- ;;; Miscellaneous useful functions. (export 'sod-subclass-p) @@ -88,11 +173,12 @@ * all of whose characters are alphanumeric or underscores * and which doesn't contain two consecutive underscores." - (and (stringp name) - (plusp (length name)) - (alpha-char-p (char name 0)) - (every (lambda (ch) (or (alphanumericp ch) (char= ch #\_))) name) - (not (search "__" name)))) + (or (typep name 'temporary-variable) + (and (stringp name) + (plusp (length name)) + (alpha-char-p (char name 0)) + (every (lambda (ch) (or (alphanumericp ch) (char= ch #\_))) name) + (not (search "__" name))))) (export 'find-root-superclass) (defun find-root-superclass (class) @@ -127,10 +213,15 @@ (sod-class-chains super))) supers))) (list class)))) - (cond ((null roots) (error "Class ~A has no root class!" class)) - ((cdr roots) (error "Class ~A has multiple root classes ~ - ~{~A~#[~; and ~;, ~]~}" - class roots)) + (cond ((null roots) + (error "Class ~A has no root class!" class)) + ((cdr roots) + (cerror* "Class ~A has multiple root classes ~ + ~{~#[~;~A~;~A and ~A~:; ~@{~A, ~#[~;and ~A~]~}~]~}" + class roots) + (let ((state (make-inheritance-path-reporter-state class))) + (dolist (root roots) + (report-inheritance-path state root)))) (t (car roots))))) (export 'find-root-metaclass) @@ -161,7 +252,7 @@ (every (lambda (message-arg method-arg) (if (eq message-arg :ellipsis) (c-type-equal-p (argument-type method-arg) - (c-type va-list)) + c-type-va-list) (c-type-equal-p (argument-type message-arg) (argument-type method-arg)))) message-args method-args))) @@ -189,6 +280,10 @@ (defun vtmsgs-struct-tag (class super) (format nil "~A__vtmsgs_~A" class (sod-class-nickname super))) +(export 'vtable-union-tag) +(defun vtable-union-tag (class chain-head) + (format nil "~A__vtu_~A" class (sod-class-nickname chain-head))) + (export 'vtable-struct-tag) (defun vtable-struct-tag (class chain-head) (format nil "~A__vt_~A" class (sod-class-nickname chain-head)))