Include/code.h

   1 /* Definitions for bytecode */
   2
   3 #ifndef Py_CODE_H
   4 #define Py_CODE_H
   5 #ifdef __cplusplus
   6 extern "C" {
   7 #endif
   8
   9 /* Bytecode object */
  10 typedef struct {
  11     PyObject_HEAD
  12     int co_argcount;            /* #arguments, except *args */
  13     int co_nlocals;             /* #local variables */
  14     int co_stacksize;           /* #entries needed for evaluation stack */
  15     int co_flags;               /* CO_..., see below */
  16     PyObject *co_code;          /* instruction opcodes */
  17     PyObject *co_consts;        /* list (constants used) */
  18     PyObject *co_names;         /* list of strings (names used) */
  19     PyObject *co_varnames;      /* tuple of strings (local variable names) */
  20     PyObject *co_freevars;      /* tuple of strings (free variable names) */
  21     PyObject *co_cellvars;      /* tuple of strings (cell variable names) */
  22     /* The rest doesn't count for hash/cmp */
  23     PyObject *co_filename;      /* string (where it was loaded from) */
  24     PyObject *co_name;          /* string (name, for reference) */
  25     int co_firstlineno;         /* first source line number */
  26     PyObject *co_lnotab;        /* string (encoding addr<->lineno mapping) */
  27 } PyCodeObject;
  28
  29 /* Masks for co_flags above */
  30 #define CO_OPTIMIZED    0x0001
  31 #define CO_NEWLOCALS    0x0002
  32 #define CO_VARARGS      0x0004
  33 #define CO_VARKEYWORDS  0x0008
  34 #define CO_NESTED       0x0010
  35 #define CO_GENERATOR    0x0020
  36 /* The CO_NOFREE flag is set if there are no free or cell variables.
  37    This information is redundant, but it allows a single flag test
  38    to determine whether there is any extra work to be done when the
  39    call frame it setup.
  40 */
  41 #define CO_NOFREE       0x0040
  42 /* XXX Temporary hack.  Until generators are a permanent part of the
  43    language, we need a way for a code object to record that generators
  44    were *possible* when it was compiled.  This is so code dynamically
  45    compiled *by* a code object knows whether to allow yield stmts.  In
  46    effect, this passes on the "from __future__ import generators" state
  47    in effect when the code block was compiled. */
  48 #define CO_GENERATOR_ALLOWED    0x1000 /* no longer used in an essential way */
  49 #define CO_FUTURE_DIVISION      0x2000
  50
  51 #define CO_MAXBLOCKS 20 /* Max static block nesting within a function */
  52
  53 PyAPI_DATA(PyTypeObject) PyCode_Type;
  54
  55 #define PyCode_Check(op) ((op)->ob_type == &PyCode_Type)
  56 #define PyCode_GetNumFree(op) (PyTuple_GET_SIZE((op)->co_freevars))
  57
  58 /* Public interface */
  59 PyAPI_FUNC(PyCodeObject *) PyCode_New(
  60         int, int, int, int, PyObject *, PyObject *, PyObject *, PyObject *,
  61         PyObject *, PyObject *, PyObject *, PyObject *, int, PyObject *);
  62         /* same as struct above */
  63 PyAPI_FUNC(int) PyCode_Addr2Line(PyCodeObject *, int);
  64
  65 /* for internal use only */
  66 #define _PyCode_GETCODEPTR(co, pp) \
  67         ((*(co)->co_code->ob_type->tp_as_buffer->bf_getreadbuffer) \
  68          ((co)->co_code, 0, (void **)(pp)))
  69
  70 #ifdef __cplusplus
  71 }
  72 #endif
  73 #endif /* !Py_CODE_H */