GtfDict.h File Reference

Defines the GtfDict object interface. More...

#include <Python.h>
#include "../hashmap_ext.h"

Include dependency graph for GtfDict.h:

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

Go to the source code of this file.

Data Structures
struct	GtfDict
	A dict that holds GTF data. More...

Macros
#define	GtfDict_check(o)   PyType_IsSubtype(Py_TYPE(o), &GtfDictType)
	Checks if the object can be interpreted as a GtfDict.

Functions
int	GtfDict_containsValue (GtfDict *self, PyObject *other)
	Internal function for checking if the other dict is contained within self. Linked as contains and contains()
char *	GtfDictToGTF (GtfDict *self, size_t *len)
	Generates a valid GTF line based on the GtfDict.
PyObject *	GtfDict_keys (GtfDict *restrict self)
	GtfDict.keys()
PyObject *	GtfDict_getitem (GtfDict *restrict self, PyObject *restrict key)
	A custom getitem that also checks the core attributes.

Variables
PyTypeObject	GtfDictType
	The Python type definition for the GtfDict object.

Detailed Description

Defines the GtfDict object interface.

Macro Definition Documentation

GtfDict_check

#define GtfDict_check

(

o

)

PyType_IsSubtype(Py_TYPE(o), &GtfDictType)

Checks if the object can be interpreted as a GtfDict.

Parameters

o	the object to check

Returns

true if the object can be interpreted as a GtfDict, false otherwise

Function Documentation

GtfDict_containsValue()

int GtfDict_containsValue	(	GtfDict *	self,
		PyObject *	other
	)

Internal function for checking if the other dict is contained within self. Linked as contains and contains()

Parameters

self
other	the other object that might be contained

Returns

C bool describing

See also

GtfDict_contains

GtfDictToGTF()

char * GtfDictToGTF	(	GtfDict *	self,
		size_t *	len
	)

Generates a valid GTF line based on the GtfDict.

Parameters

self
len	NULL or pointer to result length output

Returns

valid GTF line string

See also

GtfDict_str