*.pyx: Add some rather laconic docstrings.

[mLib-python] / atom.h

/* -*-c-*-
 *
 * Atom stuff
 *
 * (c) 2005 Straylight/Edgeware
 */

/*----- Licensing notice --------------------------------------------------*
 *
 * This file is part of the Python interface to mLib.
 *
 * mLib/Python is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * mLib/Python is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with mLib/Python; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef ATOM_H
#define ATOM_H

#ifdef __cplusplus
  extern "C" {
#endif

/*----- Header files ------------------------------------------------------*/

#include <Python.h>

#include <mLib/atom.h>
#include <mLib/assoc.h>

/*----- Data structures ---------------------------------------------------*/

typedef struct atom_pyobj {
  PyObject_HEAD
  atom *a;
} atom_pyobj;
#define ATOM_PYCHECK(obj) PyObject_TypeCheck(obj, &atom_pytype)
#define ATOM_A(obj) (((atom_pyobj *)(obj))->a)

extern PyTypeObject atom_pytype;

/*----- Functions provided ------------------------------------------------*/

extern PyObject *atom_pywrap(atom *);
extern PyObject *atom_pyintern(PyObject *);
extern void atom_pysetup(void);

/*----- That's all, folks -------------------------------------------------*/

#ifdef __cplusplus
  }
#endif

#endif