/***************************************************************/
/***          Language-dependent structures                    ***/
 /***************************************************************/


#ifndef _PYCHEADER_H
#define _PYCHEADER_H


#include "../psyco.h"
#include <compile.h>
#include <frameobject.h>


/* "Frames": the Python compiler may be interrupted between the
   compilation of two opcodes. Any local data it needs that should
   persist across such interruptions must be stored in the PsycoObject
   driving compilation. The PsycoObject plays the same role as the
   FrameObject in normal interpretation. The usual fields of
   FrameObjects are split into two groups:

   1) in the 'vlocals' array, as 'vinfo_t' structures. This makes
      dynamically-staged variables, that is, whose value may be known
      at compile-time, run-time or virtual-time only. Use the LOC_xxx
      macros to access these variables.

   2) in the 'pr' field whose structure is defined below. For
      compile-time-only data.

   IMPORTANT: the dispatcher only looks at LOC_xxx variables to
   determine if the needed code has already be compiled. If two
   PsycoObjects differ only by their 'pr' field, the code that
   the compiler would emit in each case must be interchangeable
   (but not necessary identical, as different optimizations
   could be done).
*/

#define INDEX_LOC_CONTINUATION  0   /* return address in the stack */
#define INDEX_LOC_GLOBALS       1   /* globals() dict object */
#define INDEX_LOC_INLINING      2   /* for function inlining */
#define INDEX_LOC_LOCALS_PLUS   3   /* start of local variables + stack */

#define LOC_CONTINUATION    (po->vlocals.items[INDEX_LOC_CONTINUATION])
#define LOC_GLOBALS         (po->vlocals.items[INDEX_LOC_GLOBALS])
#define LOC_INLINING        (po->vlocals.items[INDEX_LOC_INLINING])
#define LOC_LOCALS_PLUS     (po->vlocals.items + INDEX_LOC_LOCALS_PLUS)


typedef struct {
  PyCodeObject* co;     /* code object we are compiling */
  int next_instr;       /* next instruction to compile */
  short auto_recursion; /* # levels to auto-compile calls to Python functions */
  char is_inlining;     /* true when compiling a code inlined in a parent */
  unsigned char iblock; /* index in blockstack */
  PyTryBlock blockstack[CO_MAXBLOCKS]; /* for try and loop blocks */
  
  /* fields after 'blockstack' are not saved in a FrozenPsycoObject */
  int stack_base;       /* number of items before the stack in LOC_LOCALS_PLUS */
  int stack_level;      /* see note below */
  PyObject* merge_points;   /* see mergepoints.h */
  vinfo_t* exc;         /* current compile-time (pseudo) exception, see below */
  vinfo_t* val;         /* exception value */
  vinfo_t* tb;          /* traceback object */
  PyObject* f_builtins;
  PyObject* changing_globals;  /* dict of names of globals that are detected to
                                  change */
} pyc_data_t;

#define AUTO_RECURSION_MAX 200
#define AUTO_RECURSION(r)  ((r)>AUTO_RECURSION_MAX ? AUTO_RECURSION_MAX : (r))

/* Note.
   'stack_level' is stored in 'pr'. To do so we must assume that the level
   of the interpreter value stack is always the same when execution reaches
   the same position in the bytecode. This is normally the case in Python,
   with a few exceptions that need to be worked around ('finally:' clauses
   in the original interpreter are invoked with a variable number of objects
   pushed on the stack; the present interpreter always only pushes one,
   grouping objects in a tuple if necessary (remember that tuples are
   abstracted to virtual-time, so this doesn't mean we loose time building
   and deconstructing Python tuples)).

   The same assumption holds for the other fields of pyc_data_t but only
   'stack_level' needs special care.
*/


/* some extra flags recognized by psyco_generic_call(). They tell how the
   Python C function signals errors. They are ignored by the Psyco_METAX()
   macros if a meta-implementation is found, as meta-implementations always
   signal errors by returning either (vinfo_t*)NULL or CC_ERROR. */
#define CfPyErrDontCheck    0x000   /* default: no check */
#define CfPyErrIfNull       0x100   /* a return == 0 (or NULL) means an error */
#define CfPyErrIfNonNull    0x200   /* a return != 0 means an error */
#define CfPyErrIfNeg        0x300   /* a return < 0 means an error */
#define CfPyErrIfMinus1     0x400   /* only -1 means an error */
#define CfPyErrCheck        0x500   /* always check with PyErr_Occurred() */
#define CfPyErrCheckMinus1  0x600   /* use PyErr_Occurred() if return is -1 */
#define CfPyErrCheckNeg     0x700   /* use PyErr_Occurred() if return is < 0 */
#define CfPyErrNotImplemented 0x800 /* test for a Py_NotImplemented result */
#define CfPyErrIterNext     0x900   /* specially for tp_iternext slots */
#define CfPyErrAlways       0xA00   /* always set an exception */

#define CfPyErrMask         0xF00

/* Note: CfPyErrNotImplemented means that the C function may return
   Py_NotImplemented, and this is checked; if true, then Psyco_METAX()
   returns exactly 'psyco_viNotImplemented', and not just a possibly run-time
   vinfo_t* containing Py_NotImplemented. Meta-implementations always return
   exactly 'psyco_viNotImplemented'. */

/* for psyco_generic_call() only */
EXTERNFN vinfo_t* generic_call_check(PsycoObject* po, int flags, vinfo_t* vi);
EXTERNFN vinfo_t* generic_call_ct(int flags, long result);

#endif /* _PYCHEADER_H */