eccLib.c File Reference

Main library file. More...

#include <stdlib.h>
#include <Python.h>
#include "classes/FastaBuff.h"
#include "classes/FastaReader.h"
#include "classes/GtfDict.h"
#include "classes/GtfDictView.h"
#include "classes/GtfList.h"
#include "classes/GtfReader.h"
#include "formats/fasta.h"
#include "functions.h"

Include dependency graph for eccLib.c:

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.

Functions
static int	initObject (PyObject *module, PyTypeObject *type, const char *objName)
	small convenience function that instantiates the object within module
static Py_hash_t	PyHashString (const char *str, size_t len)
	Hashes a string.
int	main (int argc, char *argv[])
	Main function that initializes the Python interpreter and imports the eccLib module.

Variables
static PyMethodDef	eccLibMethods []
static struct PyModuleDef	eccLibModule

Detailed Description

Main library file.

This file initializes all the features according to the Python ABI.

Macro Definition Documentation

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.

Function Documentation

initObject()

static int initObject ( PyObject *  module, PyTypeObject *  type, const char *  objName  )

inlinestatic

small convenience function that instantiates the object within module

Parameters

module	the module to which the object should be added to
type	the type of the object that should be added
objName	the name of the object

Returns

-1 on error

main()

int main	(	int	argc,
		char *	argv[]
	)

Main function that initializes the Python interpreter and imports the eccLib module.

Parameters

argc	the number of arguments
argv	the arguments

Returns

0 on success

PyHashString()

static Py_hash_t PyHashString ( const char *  str, size_t  len  )

inlinestatic

Hashes a string.

Parameters

str	the string to hash
len	the length of the string

Returns

the hash

Variable Documentation

eccLibMethods

PyMethodDef eccLibMethods[]

static

Initial value:

= {
    {"parseFASTA", (PyCFunction)parseFasta, METH_KEYWORDS | METH_VARARGS,
     parseFASTAdoc},
    {"parseGTF", (PyCFunction)parseGTF, METH_KEYWORDS | METH_VARARGS,
     parseGTFdoc},
    {NULL} 
}

eccLibModule

struct PyModuleDef eccLibModule

static

Initial value:

= {
    PyModuleDef_HEAD_INIT,
    "eccLib",  
    moduledoc, 
    -1,
    eccLibMethods,
    .m_slots = NULL}