eccLib.h File Reference

eccLib module header More...

#include <Python.h>
#include "../formats/gtf.h"

Include dependency graph for eccLib.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	eccLib_state
	The state struct, returned by calling PyModule_GetState on the eccLib module. More...

Macros
#define	REQUIRED_MINOR_VERSION   10
	The minor version of the Python ABI that is required.
#define	REQUIRED_MAJOR_VERSION   3
	The major version of the Python ABI that is required.
#define	GET_ECCLIB_STATE()
	Macro to get the eccLib state from the module state.

Variables
struct PyModuleDef	eccLibModule
	The eccLib module definition.

Detailed Description

eccLib module header

Provides the definitions for the eccLib module, most notably, the state struct and module definition.

Macro Definition Documentation

GET_ECCLIB_STATE

#define GET_ECCLIB_STATE

(

)

Value:

    ((const struct eccLib_state *)PyModule_GetState(                           \
        PyState_FindModule(&eccLibModule)))

Macro to get the eccLib state from the module state.

Returns the internal state of the eccLib module as a const struct eccLib_state pointer.

REQUIRED_MAJOR_VERSION

#define REQUIRED_MAJOR_VERSION   3

The major version of the Python ABI that is required.

Well it's not like we even want to support Python 2, so this is just a sanity check

REQUIRED_MINOR_VERSION

#define REQUIRED_MINOR_VERSION   10

The minor version of the Python ABI that is required.

This used to be, because of Py_SET_TYPE, now we don't use it. Thus we could theoretically support older versions, but I haven't personally tested it.

Variable Documentation

eccLibModule

struct PyModuleDef eccLibModule

extern

The eccLib module definition.

This struct defines the eccLib module, including its name, version, and state initialization function.