X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Fref.sgml;h=827ac079f6e3e39f5102540b8a8964bc3d1c2c59;hb=de11286b135675af1ef6f93af709bf8755158201;hp=732204a47c7f6de8fd3eb8c686a1592333db5681;hpb=f73eb94e15649aba5fcfbe3a900aa72f31f46a96;p=uffi.git diff --git a/doc/ref.sgml b/doc/ref.sgml index 732204a..827ac07 100644 --- a/doc/ref.sgml +++ b/doc/ref.sgml @@ -96,8 +96,12 @@ dereferenced :char pointer returns an character. pointer returns an character. - :byte - Unsigned 8-bits. A + :byte - Signed 8-bits. A dereferenced :byte pointer returns an integer. + + + :unsigned-byte - Unsigned 8-bits. A +dereferenced :unsigned-byte pointer returns an integer. :short - Signed 16-bits. @@ -884,8 +888,8 @@ can be freed. size - An optional size parameter. If specified, allocates and returns an -array of type that is size members long. + An optional size parameter that is evaluated. If specified, allocates and returns an +array of type that is size members long. This parameter is evaluated. @@ -1046,6 +1050,61 @@ much better with static allocation. + + + size-of-foreign-type + Returns the number of data bytes used by a foreign object type. + + Macro + + + Syntax + + size-of-foreign-type ftype + + + + Arguments and Values + + + ftype + + A foreign type specifier. This parameter is evaluated. + + + + + + + Description + + Returns the number of data bytes used by a foreign object type. This does not include any Lisp storage overhead. + + + + Examples + + +(size-of-foreign-object :unsigned-byte) +=> 1 +(size-of-foreign-object 'my-100-byte-vector-type) +=> 100 + + + + + Side Effects + None. + + Affected by + None. + + + Exceptional Situations + None. + + + pointer-address @@ -2028,6 +2087,91 @@ a session. + + + find-foreign-library + Finds a foreign library file. + + Function + + + Syntax + + find-foreign-library names directories & drive-letters types => path + + + + Arguments and Values + + + names + + A string or list of strings containing the base name of the library file. + + + + + directories + + A string or list of strings containing the directory the library file. + + + + + drive-letters + + A string or list of strings containing the drive letters for the library file. + + + + + types + + A string or list of strings containing the file type of the library file. Default +is &nil;. If &nil;, will use a default type based on the currently running implementation. + + + + + path + + A path containing the path found, or &nil; if the library file was not found. + + + + + + + Description + Finds a foreign library by searching through a number of possible locations. Returns +the path of the first found file. + + + + Examples + +(find-foreign-library '("libmysqlclient" "libmysql") + '("/opt/mysql/lib/mysql/" "/usr/local/lib/" "/usr/lib/" "/mysql/lib/opt/") + :types '("so" "dll") + :drive-letters '("C" "D" "E")) +=> #P"D:\\mysql\\lib\\opt\\libmysql.dll" + + + + Side Effects + None. + + + + Affected by + None. + + + Exceptional Situations + None. + + +