148
edits
Jsctypes/api: Difference between revisions
Jump to navigation
Jump to search
→Properties of types
| Line 101: | Line 101: | ||
:For primitive types this is just the name of the corresponding C/C++ type. | :For primitive types this is just the name of the corresponding C/C++ type. | ||
:For struct types and opaque pointer types, this is simply the string that was passed to the constructor. For other pointer | :For struct types and opaque pointer types, this is simply the string that was passed to the constructor. For other function, pointer, and array types this should try to generate valid C/C++ type expressions, which isn't exactly trivial. | ||
:''(Open issue: This conflicts with the usual meaning of .name for functions, and types are callable like functions.)'' | :''(Open issue: This conflicts with the usual meaning of .name for functions, and types are callable like functions.)'' | ||
| Line 115: | Line 115: | ||
FILE.name | FILE.name | ||
===> "FILE *" | ===> "FILE *" | ||
const fn_t = new ctypes.FunctionType(ctypes.stdcall, ctypes.int, [ ctypes.voidptr_t, ctypes.voidptr_t ]); | |||
fn_t.name | |||
===> "int (__stdcall *)(void*, void*)" | |||
const struct_tm = new ctypes.StructType("tm", [{tm_sec: ctypes.int}, ...]); | const struct_tm = new ctypes.StructType("tm", [{tm_sec: ctypes.int}, ...]); | ||
| Line 162: | Line 166: | ||
:'''<code>''t''.targetType</code>''' - Read-only. The pointed-to type, or <code>null</code> if ''t'' is an opaque pointer type. | :'''<code>''t''.targetType</code>''' - Read-only. The pointed-to type, or <code>null</code> if ''t'' is an opaque pointer type. | ||
Function types also have: | |||
:'''<code>''t''.abi</code>''' - Read-only. The ABI of the function; one of the ''ctypes'' ABI objects. | |||
:'''<code>''t''.returnType</code>''' - Read-only. The return type. | |||
:'''<code>''t''.argTypes</code>''' - Read-only. A sealed array of argument types. | |||
Struct types also have: | Struct types also have: | ||
| Line 183: | Line 195: | ||
:Every <code>CType</code> has a read-only, permanent <code>.prototype</code> property. The type-constructors <code>ctypes.{C,Pointer,Struct,Array}Type</code> each have a read-only, permanent <code>.prototype</code> property as well. | :Every <code>CType</code> has a read-only, permanent <code>.prototype</code> property. The type-constructors <code>ctypes.{C,Pointer,Struct,Array}Type</code> each have a read-only, permanent <code>.prototype</code> property as well. | ||
:Types have a hierarchy of prototype objects. The prototype of <code>ctypes.CType.prototype</code> is <code>Function.prototype</code>. The prototype of <code>ctypes.{Array,Struct,Pointer}Type.prototype</code> and of all the builtin types except <code>ctypes.voidptr_t</code> is <code>ctypes.CType.prototype</code>. The prototype of an array type is <code>ctypes.ArrayType.prototype</code>. The prototype of a struct type is <code>ctypes.StructType.prototype</code>. The prototype of a pointer type is <code>ctypes.PointerType.prototype</code>. | :Types have a hierarchy of prototype objects. The prototype of <code>ctypes.CType.prototype</code> is <code>Function.prototype</code>. The prototype of <code>ctypes.{Array,Struct,Pointer,Function}Type.prototype</code> and of all the builtin types except <code>ctypes.voidptr_t</code> is <code>ctypes.CType.prototype</code>. The prototype of an array type is <code>ctypes.ArrayType.prototype</code>. The prototype of a struct type is <code>ctypes.StructType.prototype</code>. The prototype of a pointer type is <code>ctypes.PointerType.prototype</code>. The prototype of a function type is <code>ctypes.FunctionType.prototype</code>. | ||
:Every <code>CType</code> ''t'' has <code>''t''.prototype.constructor === ''t''</code>; that is, its <code>.prototype</code> has a read-only, permanent, own <code>.constructor</code> property that refers to the type. The same is true of the | :Every <code>CType</code> ''t'' has <code>''t''.prototype.constructor === ''t''</code>; that is, its <code>.prototype</code> has a read-only, permanent, own <code>.constructor</code> property that refers to the type. The same is true of the five type constructors <code>ctypes.{C,Array,Struct,Pointer,Function}Type</code>. | ||
== Calling types == | == Calling types == | ||