blob: 36ce1cc92d00d98090456f1568531c8467ad7412 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
/* 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__
|
