genobject.h 891 Bytes
Newer Older
1 2 3 4 5 6 7 8 9

/* Generator object interface */

#ifndef Py_GENOBJECT_H
#define Py_GENOBJECT_H
#ifdef __cplusplus
extern "C" {
#endif

10 11
struct _frame; /* Avoid including frameobject.h */

12 13 14 15
typedef struct {
	PyObject_HEAD
	/* The gi_ prefix is intended to remind of generator-iterator. */

16
	/* Note: gi_frame can be NULL if the generator is "finished" */
17
	struct _frame *gi_frame;
18 19 20

	/* True if generator is being executed. */
	int gi_running;
21 22 23
    
	/* The code object backing the generator */
	PyObject *gi_code;
24 25 26 27 28 29 30 31

	/* List of weak reference. */
	PyObject *gi_weakreflist;
} PyGenObject;

PyAPI_DATA(PyTypeObject) PyGen_Type;

#define PyGen_Check(op) PyObject_TypeCheck(op, &PyGen_Type)
32
#define PyGen_CheckExact(op) (Py_TYPE(op) == &PyGen_Type)
33

34
PyAPI_FUNC(PyObject *) PyGen_New(struct _frame *);
35
PyAPI_FUNC(int) PyGen_NeedsFinalizing(PyGenObject *);
36 37 38 39 40

#ifdef __cplusplus
}
#endif
#endif /* !Py_GENOBJECT_H */