File: parse_c_type.rst

package info (click to toggle)
python-cffi 2.0.0~b1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,796 kB
  • sloc: python: 28,456; ansic: 15,272; asm: 116; makefile: 97; sh: 14
file content (72 lines) | stat: -rw-r--r-- 2,309 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
==================================================
CPython C extension module produced by recompile()
==================================================

Global variable::

  _cffi_opcode_t _cffi_types[];

Every ``_cffi_types`` entry is initially an odd integer. At runtime, it
is fixed to be a ``CTypeDescrObject *`` when the odd integer is
interpreted and turned into a real ``<ctype>`` object.

The generated C functions are listed in ``_cffi_globals``, a sorted array
of entries which get turned lazily into real ``<builtin function
objects>``. Each entry in this array has an index in the ``_cffi_types``
array, which describe the function type (``OP_FUNCTION`` opcode, see
below). We turn the odd integers describing argument and return types
into real CTypeDescrObjects at the point where the entry is turned
into a real builtin function object.

The odd integers are "opcodes" that contain a type info in the lowest
byte. The remaining high bytes of the integer is an "arg" that depends
on the type info:

OP_PRIMITIVE
    the arg tells which primitive type it is (an index in some list)

OP_POINTER
    the arg is the index of the item type in the ``_cffi_types`` array.

OP_ARRAY
    the arg is the index of the item type in the ``_cffi_types`` array.
    followed by another opcode that contains (uintptr_t)length_of_array.

OP_OPEN_ARRAY
    for syntax like "int[]". same as OP_ARRAY but without the length

OP_STRUCT_UNION
    the arg is the index of the struct/union in ``_cffi_structs_unions``

OP_ENUM
    the arg is the index of the enum in ``_cffi_enums``

OP_TYPENAME
    the arg is the index of the typename in ``_cffi_typenames``

OP_FUNCTION
    the arg is the index of the result type in ``_cffi_types``.
    followed by other opcodes for the arguments.
    terminated by ``OP_FUNCTION_END``.

OP_FUNCTION_END
    the arg's lowest bit is set if there is a "..." argument.

OP_NOOP
    simple indirection: the arg is the index to look further in

There are other opcodes, used not inside ``_cffi_types`` but in other
individual ``type_op`` fields. Most importantly, these are used
on ``_cffi_globals`` entries:

OP_CPYTHON_BLTN_*
    declare a function

OP_CONSTANT
    declare a non-integral constant

OP_CONSTANT_INT
    declare an int constant

OP_GLOBAL_VAR
    declare a global var