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     void *co_zombieframe;     /* for optimization only (see frameobject.c) */
  28 } PyCodeObject;
  29
  30 /* Masks for co_flags above */
  31 #define CO_OPTIMIZED    0x0001
  32 #define CO_NEWLOCALS    0x0002
  33 #define CO_VARARGS      0x0004
  34 #define CO_VARKEYWORDS  0x0008
  35 #define CO_NESTED       0x0010
  36 #define CO_GENERATOR    0x0020
  37 /* The CO_NOFREE flag is set if there are no free or cell variables.
  38    This information is redundant, but it allows a single flag test
  39    to determine whether there is any extra work to be done when the
  40    call frame it setup.
  41 */
  42 #define CO_NOFREE       0x0040
  43
  44 #if 0
  45 /* This is no longer used.  Stopped defining in 2.5, do not re-use. */
  46 #define CO_GENERATOR_ALLOWED    0x1000
  47 #endif
  48 #define CO_FUTURE_DIVISION      0x2000
  49 #define CO_FUTURE_ABSOLUTE_IMPORT 0x4000 /* do absolute imports by default */
  50 #define CO_FUTURE_WITH_STATEMENT  0x8000
  51
  52 /* This should be defined if a future statement modifies the syntax.
  53    For example, when a keyword is added.
  54 */
  55 #if 0
  56 #define PY_PARSER_REQUIRES_FUTURE_KEYWORD
  57 #endif
  58
  59 #define CO_MAXBLOCKS 20 /* Max static block nesting within a function */
  60
  61 PyAPI_DATA(PyTypeObject) PyCode_Type;
  62
  63 #define PyCode_Check(op) ((op)->ob_type == &PyCode_Type)
  64 #define PyCode_GetNumFree(op) (PyTuple_GET_SIZE((op)->co_freevars))
  65
  66 /* Public interface */
  67 PyAPI_FUNC(PyCodeObject *) PyCode_New(
  68         int, int, int, int, PyObject *, PyObject *, PyObject *, PyObject *,
  69         PyObject *, PyObject *, PyObject *, PyObject *, int, PyObject *);
  70         /* same as struct above */
  71 PyAPI_FUNC(int) PyCode_Addr2Line(PyCodeObject *, int);
  72
  73 /* for internal use only */
  74 #define _PyCode_GETCODEPTR(co, pp) \
  75         ((*(co)->co_code->ob_type->tp_as_buffer->bf_getreadbuffer) \
  76          ((co)->co_code, 0, (void **)(pp)))
  77
  78 typedef struct _addr_pair {
  79         int ap_lower;
  80         int ap_upper;
  81 } PyAddrPair;
  82
  83 /* Check whether lasti (an instruction offset) falls outside bounds
  84    and whether it is a line number that should be traced.  Returns
  85    a line number if it should be traced or -1 if the line should not.
  86
  87    If lasti is not within bounds, updates bounds.
  88 */
  89
  90 PyAPI_FUNC(int) PyCode_CheckLineNumber(PyCodeObject* co,
  91                                        int lasti, PyAddrPair *bounds);
  92
  93 PyAPI_FUNC(PyObject*) PyCode_Optimize(PyObject *code, PyObject* consts,
  94                                       PyObject *names, PyObject *lineno_obj);
  95
  96 #ifdef __cplusplus
  97 }
  98 #endif
  99 #endif /* !Py_CODE_H */