diff options
Diffstat (limited to 'src/include/eiotas_iota.h')
-rw-r--r-- | src/include/eiotas_iota.h | 96 |
1 files changed, 0 insertions, 96 deletions
diff --git a/src/include/eiotas_iota.h b/src/include/eiotas_iota.h deleted file mode 100644 index 36ce1cc..0000000 --- a/src/include/eiotas_iota.h +++ /dev/null @@ -1,96 +0,0 @@ -/* EIOTAS - * Copyright (C) 2012 Jérémy Zurcher - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library 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 - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; - * if not, see <http://www.gnu.org/licenses/>. - */ - -#ifndef __EIOTAS_IOTA_H__ -#define __EIOTAS_IOTA_H__ - -#include <eina_stringshare.h> - -/** - * @enum _Eiotas_Type - * List of available Eiotas_Iota - */ -typedef enum _Eiotas_Type -{ - EIOTAS_TYPE_SPIN=0, - EIOTAS_TYPE_ROOM, - EIOTAS_TYPE_DOOR, - EIOTAS_TYPE_BOARD, - EIOTAS_TYPE_COUNT -} Eiotas_Type; - -/** - * @typedef Eiotas_Iota - * Type for structural and hierachical info - */ -typedef struct _Eiotas_Iota Eiotas_Iota; - -/** - * @struct _Eiotas_Iota - * Struct for structural and hierachical info. - */ -struct _Eiotas_Iota { - Eiotas_Type type; /**< type of the iota */ - Eiotas_Iota *spin; /**< top level iota which is a @ref Eiotas_Spin */ - Eiotas_Iota *parent; /**< direct parent in the hierarchy */ - Eina_Stringshare *name; /**< iota's name */ - Eina_Stringshare *path; /**< full path to this @ref Eiotas_Iota */ -}; - -/** - * @defgroup Eiotas_Iota Eiotas_Iota - * - * This is the structural info stored in each @ref Eiotas_Room, @ref Eiotas_Door, @ref Eiotas_Board - * - * @{ - */ - -/** - * @brief Print iota information using EINA_LOG_DBG. - * - * @param iota The @ref Eiotas_Iota to show. - */ -EAPI void eiotas_iota_show(Eiotas_Iota *iota); - -/** - * @brief Free allocated resources. - * - * @param iota The @ref Eiotas_Iota to free. - * - */ -void eiotas_iota_free(Eiotas_Iota *iota); - -/** - * @brief Require a @ref Eiotas_Particle from the free list. - * - * @see eiotas_spin_require_particle - */ -#define eiotas_iota_require_particle(_iota) eiotas_spin_require_particle((Eiotas_Spin*)(_iota)->spin) - -/** - * @brief Release a particle. - * - * @see eiotas_spin_release_particle - */ -#define eiotas_iota_release_particle(_iota,_particle) eiotas_spin_release_particle((Eiotas_Spin*)(_iota)->spin,_particle) - -/** - * @} - */ - -#endif // __EIOTAS_IOTA_H__ |