objective-c/runtime.lisp
in-package#:luv.objective-c
eval-when
:compile-toplevel:load-toplevel:execute
cffi:define-foreign-libraryobjective-c-runtime-library
:darwin
:or"libobjc.A.dylib""libobjc.dylib"
cffi:define-foreign-libraryfoundation-framework
:darwin
:framework"Foundation"
cffi:use-foreign-libraryobjective-c-runtime-library
cffi:use-foreign-libraryfoundation-framework
defmacrowith-objective-c-native-environment#+sbcl`
&bodybody
Run body with the floating-point environment expected by Apple frameworks.
sb-int:with-float-traps-masked
#-sbcl
`(progn ,@body):invalid:divide-by-zero:overflow:underflow:inexact
,@bodycffi:defcfun
"objc_getClass"%objc-get-class:libraryobjective-c-runtime-library
:pointername:string
cffi:defcfun
"sel_registerName"%sel-register-name:libraryobjective-c-runtime-library
:pointername:string
cffi:defcfun
"object_getClassName"%object-get-class-name:libraryobjective-c-runtime-library
:pointerobject:pointer
define-conditionobjective-c-message-error
message:initarg:message:readerobjective-c-exception-message
receiver:initarg:receiver:readerobjective-c-exception-receiver
selector:initarg:selector:readerobjective-c-exception-selector
name:initarg:name:readerobjective-c-exception-name
reason:initarg:reason:readerobjective-c-exception-reason
call-stack:initarg:call-stack:readerobjective-c-exception-call-stack
define-conditionobjective-c-exception
define-conditionobjective-c-bridge-error
:report
lambda
conditionstream
formatstream"Objective-C bridge rejected ~A: ~A"
objective-c-exception-selectorcondition
:documentation
The native boundary could not perform a declared Objective-C message.
define-conditionunknown-objective-c-class
name:initarg:name:readerunknown-objective-c-class-name
:report
lambda
conditionstream
formatstream"Objective-C class ~S is not registered."
unknown-objective-c-class-namecondition
define-conditionreleased-objective-c-object
object:initarg:object:readerreleased-objective-c-object-object
:report
lambda
conditionstream
formatstream"Objective-C object ~S has already been released."
released-objective-c-object-objectcondition
define-conditionobjective-c-ownership-error
object:initarg:object:readerobjective-c-ownership-error-object
:report
lambda
conditionstream
formatstream"Objective-C object ~S does not own a retain to consume."
objective-c-ownership-error-objectcondition
defclassobjective-c-receiver
:documentation
Something that can receive an Objective-C message.
defclassobjective-c-class
name:initarg:name:readerobjective-c-class-name
pointer:initarg:pointer:reader%objective-c-class-pointer
:documentation
A borrowed Objective-C runtime Class identity.
defclassobjective-c-object
pointer:initarg:pointer:reader%objective-c-object-pointer
class-name:initarg:class-name:readerobjective-c-object-class-name
protocol-name:initarg:protocol-name:initformnil:readerobjective-c-object-protocol-name
ownership:initarg:ownership:readerobjective-c-object-ownership
released-p:initformnil:accessorobjective-c-object-released-p
:documentation
One native Objective-C pointer and exactly one owned or borrowed claim.
defmethodprint-object
classobjective-c-class
streamprint-unreadable-object
classstream:typet:identitynil
formatstream"~A 0x~X"
objective-c-class-nameclass
cffi:pointer-address
%objective-c-class-pointerclass
defmethodprint-object
objectobjective-c-object
streamprint-unreadable-object
objectstream:typet:identitynil
formatstream"~A~@[ as ~A~] ~A~:[~; released~] 0x~X"
objective-c-object-class-nameobject
objective-c-object-protocol-nameobject
objective-c-object-ownershipobject
objective-c-object-released-pobject
cffi:pointer-address
%objective-c-object-pointerobject
defgenericobjective-c-pointer
receiver
:documentation
Return receiver's live native pointer for one ABI crossing.
defmethodobjective-c-pointer
receiverobjective-c-class
%objective-c-class-pointerreceiver
defmethodobjective-c-pointer
objectobjective-c-object
when
objective-c-object-released-pobject
%objective-c-object-pointerobject
defmethodobjective-c-pointer
nothingnull
cffi:null-pointer
defunfind-objective-c-class
name
Return the registered Objective-C class name as a borrowed receiver.
let
pointer
%objc-get-classname
when
cffi:null-pointer-ppointer
defunobjective-c-runtime-class-name
pointer
let
name
%object-get-class-namepointer
if
cffi:null-pointer-pname
"<unknown>"cffi:foreign-string-to-lispname
defunwrap-objective-c-object
pointer&key
ownership:borrowed
protocol-nameWrap pointer with one explicit :OWNED or :BORROWED claim; NIL represents nil.
when
cffi:null-pointer-ppointer
unless
memberownership'
:owned:borrowed
error"Unknown Objective-C ownership ~S."ownership
make-instance'objective-c-object:pointerpointer:class-name:protocol-nameprotocol-name:ownershipownership
defunobjective-c-object=
leftright
Whether left and right wrap the same native Objective-C identity.
defstructobjective-c-message-definitionnameselectorselector-pointerresult-typeresult-ownershipresult-class-nameconsumes-receiver-parguments
defvar*objective-c-message-definitions*
make-hash-table:test#'eq
defstruct
objective-c-trace
:constructor%make-objective-c-trace
:conc-name%objective-c-trace-
started-at0.0d0
next-sequence0
events
#+sb-threadmake-array0:adjustablet:fill-pointer0
lock
sb-thread:make-mutex:name"luv Objective-C trace"
defvar*objective-c-trace*nil"The current opt-in Objective-C trace, or NIL on the ordinary direct path."
defmacrowith-objective-c-trace-lock#+sb-thread`
trace
&bodybodysb-thread:with-mutex,@body
#-sb-thread
`(progn ,@body)%objective-c-trace-lock,trace
defunmake-objective-c-trace
%make-objective-c-trace:started-at
defunobjective-c-trace-events
trace
defunsnapshot-objective-c-value
value&optional
depth0
cond
list:objective-c-class:name
objective-c-class-namevalue
:pointercffi:pointer-address
%objective-c-class-pointervalue
list:objective-c-object:class
objective-c-object-class-namevalue
:protocolobjective-c-object-protocol-namevalue
:ownershipobjective-c-object-ownershipvalue
:releasedobjective-c-object-released-pvalue
:pointercffi:pointer-address
%objective-c-object-pointervalue
cffi:pointerpvalue
list:pointer
cffi:pointer-addressvalue
value
stringpvalue
copy-seqvalue
list:object
type-ofvalue
conspvalue
vectorpvalue
t
list:object
type-ofvalue
handler-case
princ-to-stringvalue
error"<unprintable>"
eval-when
:compile-toplevel:load-toplevel:execute
defunvalidate-objective-c-message-declaration
nameresult-typeownershipconsumes-receiver-parguments
when
error"Objective-C object result ~S must declare :OWNERSHIP."name
when
error"Non-object Objective-C result ~S cannot declare :OWNERSHIP."name
unless
memberownership'
nil:owned:borrowed
error"Unknown Objective-C result ownership ~S in ~S."ownershipname
dolist
argumentarguments
when
error"Consuming Objective-C message ~S cannot also return an object."name
defunregister-objective-c-message-definition
defunobjective-c-argument-form
nametype
defunobjective-c-message-description
name
Return the selector, ABI, and ownership metadata for one declared message.
let
list:selector
objective-c-message-definition-selectordefinition
:result-typeobjective-c-message-definition-result-typedefinition
:result-ownershipobjective-c-message-definition-result-ownershipdefinition
:result-classobjective-c-message-definition-result-class-namedefinition
:consumes-receiverobjective-c-message-definition-consumes-receiver-pdefinition
:argument-typesobjective-c-message-definition-argumentsdefinition
defunobjective-c-message-event-description
event
Return one opt-in trace event with its declared ABI metadata.
append
objective-c-message-description
objective-c-message-event-nameevent
list:status
objective-c-message-event-statusevent
:argumentsobjective-c-message-event-argumentsevent
:valuesobjective-c-message-event-valuesevent
:conditionobjective-c-message-event-conditionevent
defvar*objective-c-exception-policy*:unchecked
How declared messages cross the native boundary: :CATCH or :UNCHECKED.
:UNCHECKED calls objc_msgSend directly and is the ordinary path. :CATCH uses the native NSInvocation exception bridge for an explicit diagnostic scope.
defmacrowith-unchecked-objective-c-messages`
&bodybody
Send declared messages in body directly, without catching NSException.
let,@body
*objective-c-exception-policy*:unchecked
defmacrowith-objective-c-exception-handling`
&bodybody
Catch NSException in body, even inside an unchecked dynamic context.
let,@body
defmacrowith-objective-c-trace`
trace
&bodybodyRun body with declared sends recorded as backend-local trace events.
let*,@body
,trace
*objective-c-trace*,trace
defvar*objective-c-message-send-pointer*
cffi:foreign-symbol-pointer"objc_msgSend":library'objective-c-runtime-library
The stable libobjc dispatch entry, resolved once when this runtime loads.
Resolving this symbol for every declared message used to put dlsym on the per-frame path hundreds of times. #WEE1DX
defgenericcheck-consumable-objective-c-receiver
receiver
:documentation
Validate that receiver owns the retain a message consumes.
defmethodcheck-consumable-objective-c-receiver
receiverobjective-c-object
unless
eq
objective-c-object-ownershipreceiver
:ownedobjective-c-pointerreceiver
defuntranslate-objective-c-result
valuedefinition
if
wrap-objective-c-objectvalue:ownership
valueobjective-c-message-definition-result-ownershipdefinition
:protocol-nameobjective-c-message-definition-result-class-namedefinition
defuncall-with-objective-c-message-trace
let*
started-at
event
make-objective-c-message-event:sequence
with-objective-c-trace-lock
:timestamp:thread:nametrace
prog1
%objective-c-trace-next-sequencetrace
incf
%objective-c-trace-next-sequencetrace
objective-c-message-definition-namedefinition
:arguments:status:signaledhandler-bind
error
lambda
condition
setf
objective-c-message-event-conditionevent
list:type
type-ofcondition
:messagehandler-case
princ-to-stringcondition
error"<unprintable condition>"
unwind-protect
let
results
multiple-value-list
funcallfunction
setf
objective-c-message-event-statusevent
:returnedobjective-c-message-event-valuesevent
values-listresults
setf
objective-c-message-event-durationevent
with-objective-c-trace-lock
trace
vector-push-extendevent
%objective-c-trace-eventstrace
eval-when
:compile-toplevel:load-toplevel:execute
defuncaught-objective-c-message-send-form
let
labels
call-form
resultresult-size
ifarguments`
cffi:with-foreign-objects,@
`call-with-objective-c-exception-boundary,definition,receiver,result,result-size,argument-array,argument-size-array,
lengtharguments
call-with-objective-c-exception-boundary,definition,receiver,result,result-size
cffi:null-pointer
cffi:null-pointer
0result-form
if
eqresult-type:void
`progn,
call-form'
nilcffi:null-pointer
0let`
foreign-result-type
objective-c-foreign-typeresult-type
cffi:with-foreign-object
,result-storage',foreign-result-type
,call-formresult-storage`
cffi:foreign-type-size',foreign-result-type
cffi:mem-ref,result-storage',foreign-result-type
argument-forms
remaining-argumentsremaining-storages
ifremaining-arguments
destructuring-bindremaining-arguments`
result-form
argument-formsargumentsargument-storages
defununchecked-objective-c-message-send-form`
cffi:foreign-funcall-pointer*objective-c-message-send-pointer*:pointer
objective-c-pointer,receiver
:pointerobjective-c-message-definition-selector-pointer,definition
,@loopfor
,argument-nameargument-type
inargumentsappendlist
objective-c-foreign-typeargument-type
objective-c-argument-formargument-nameargument-type
objective-c-foreign-typeresult-type
defmacrodefine-objective-c-message
Define name as an inspectable, ABI-typed class and message-sending function.
validate-objective-c-message-declarationnameresult-typeownershipconsumes-receiverarguments
let`
argument-names
mapcar#'firstarguments
definition-name
intern
formatnil"*~A-DEFINITION*"name
symbol-packagename
progn
defparameter,definition-name
register-objective-c-message-definition',name,selector',result-type',ownership,class,consumes-receiver',arguments
defun,name
',namereceiver,@argument-names
,whenconsumes-receiver'
flet
send
let,
result
with-objective-c-native-environment
ecase*objective-c-exception-policy*
:catch,
caught-objective-c-message-send-formdefinition-name'receiverresult-typearguments
:unchecked,
unchecked-objective-c-message-send-formdefinition-name'receiverresult-typearguments
whenconsumes-receiver'
setf
objective-c-object-released-preceiver
tif*objective-c-trace*
call-with-objective-c-message-trace*objective-c-trace*,definition-name
list
#'sendlist'receiverreceiver
,@loopforargument-nameinargument-namescollect`
list',argument-name,argument-name
send
defmacro with-objective-c-native-environment
(&body body)define-arithmetic-operator or
Logical disjunction of tests and raw truth values.
define-condition objective-c-bridge-error
The native boundary could not perform a declared Objective-C message.
defclass objective-c-receiver
Something that can receive an Objective-C message.
defclass objective-c-class
A borrowed Objective-C runtime Class identity.
defclass objective-c-object
One native Objective-C pointer and exactly one owned or borrowed claim.
defmethod print-object
((call tool-call) stream)defun objective-c-runtime-class-name
(pointer)defun wrap-objective-c-object
(pointer &key (ownership :borrowed) protocol-name)defun objective-c-object=
(left right)define-arithmetic-operator and
Logical conjunction of tests and raw truth values.
define-arithmetic-operator =
Test whether two compatible scalars are equal.
defvar *objective-c-trace*
The current opt-in Objective-C trace, or NIL on the ordinary direct path.
define-arithmetic-operator /
Division of two represented quantities.
defmacro with-objective-c-trace-lock
((trace) &body body)define-arithmetic-operator <
Test whether one compatible scalar is less than another.
defun snapshot-objective-c-value
(value &optional (depth 0))define-arithmetic-operator >=
Test whether one compatible scalar is at least another.
define-style type
Headings, paragraphs, figures and their IDs, mentions, marks.
define-arithmetic-operator not
Logical negation of one test or raw truth value.
defclass definition
One top-level defining form of a source file.
defvar *objective-c-exception-policy*
How declared messages cross the native boundary: :CATCH or :UNCHECKED. :UNCHECKED calls objc_msgSend directly and is the ordinary path. :CATCH uses the native NSInvocation exception bridge for an explicit diagnostic scope.
defmacro with-unchecked-objective-c-messages
(() &body body)defmacro with-objective-c-exception-handling
(() &body body)defmacro with-objective-c-trace
((trace) &body body)defvar *objective-c-message-send-pointer*
The stable libobjc dispatch entry, resolved once when this runtime loads. Resolving this symbol for every declared message used to put dlsym on the per-frame path hundreds of times. #WEE1DX
defgeneric check-consumable-objective-c-receiver
(receiver)Validate that RECEIVER owns the retain a message consumes.
defun translate-objective-c-result
(value definition)defun call-with-objective-c-message-trace
(trace definition arguments function)define-arithmetic-operator -
Subtraction or unary negation.
defun call-with-objective-c-exception-boundary
(definition receiver result result-size arguments argument-sizes argument-count)defmacro define-objective-c-message
(name (selector result-type &key ownership class consumes-receiver)
&body arguments)DONE Resolve the Objective-C dispatch entry once
Intent: keep direct objc_msgSend direct by removing dynamic symbol lookup from every declared message. Evidence: – SBCL call profiling counted 160,400 calls to objective-c-message-send-pointer, CFFI's symbol lookup, and SBCL's dynamic foreign-symbol resolver across 200 steady luvcraft frames: exactly 802 resolutions…
A small declared Objective-C foreign object system.
Classes and objects preserve native identity at the Lisp boundary. A message declaration is a class of invocations whose metaclass owns the selector, exact ABI, and ownership convention. INVOKE dispatches on both the runtime and that message class; tracing composes as an invoker mixin.