X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Fref.sgml;h=aaf1feac499abe4fde3a6c841017de27e7a7328e;hb=bf5c7e7c36474375604bcbcedea8794a68dd1784;hp=2935dcf7346c47a21c6a160b2c1819f54df683ad;hpb=c7b9e795a73b25b3c81ecb1c8c69b8f0f944a064;p=uffi.git diff --git a/doc/ref.sgml b/doc/ref.sgml index 2935dcf..aaf1fea 100644 --- a/doc/ref.sgml +++ b/doc/ref.sgml @@ -27,34 +27,16 @@ - - uffi-declare - - This is used wherever a declare - expression can be placed. For example: - - - -(let ((my-structure (uffi:allocate-foreign-object 'a-struct))) - (uffi:uffi-declare a-struct my-structure)) - - - - - - slot-type + + def-type - This is used inside of defclass and - defstruct expressions to set the type - for a field. Because the type identifier is not evaluated in - &cl;, the expression must be backquoted for effect. For - example: - + This is used wherever a &cl; deftype + expression can be placed. Used to declare types to +the compiler for optimization. Currently, on &cmucl; takes advantage +of this. -(eval - `(defclass a-class () - ((char-ptr :type ,(uffi:slot-type (* :char)))))) +(uffi:def-type my-struct-def my-struct-foreign-type) @@ -471,7 +453,9 @@ a session. Examples - (load-foreign-library #p"/usr/lib/libmysqlclient.so" "mysql" '("c")) + (load-foreign-library #p"/usr/lib/libmysqlclient.so" + :module "mysql" + :supporting-libraries '("c")) => T