blob: c26534461b2c3ffe34a41a94564949d1b7b67b6d (
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
|
/* 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_ROOM_H__
#define __EIOTAS_ROOM_H__
#include "eiotas_iota.h"
#include <eina_hash.h>
/**
* @typedef Eiotas_Room
* Type for a Room, which holds other child @ref Eiotas_Iota.
*/
typedef struct _Eiotas_Room Eiotas_Room;
/**
* @struct _Eiotas_Room
* Struct for a Room, which holds other child @ref Eiotas_Iota.
*/
struct _Eiotas_Room {
Eiotas_Iota iota; /**< @ref Eiotas_Iota structural info */
Eina_Hash *links; /**< TODO */
Eina_Hash *children; /**< stringshared values optimized hash table holding @ref Eiotas_Iota */
};
/**
* @defgroup Eiotas_Room Eiotas_Room
*
* A Eiota_Room may hold children @ref Eiotas_Room or @ref Eiotas_Door (@ref Eiotas_Board).
*
* @{
*/
/**
* @brief Free allocated resources.
*
* @param room The @ref Eiotas_Room to free.
*
* This function will free all it's child @ref Eiotas_Iota.
*/
void eiotas_room_free(Eiotas_Room *room);
/**
* @brief Print iota information using EINA_LOG_DBG.
*
* @param name The name of this @ref Eiotas_Iota.
* @param parent The direct hierarchical parent @ref Eiotas_Room.
*
* @return the new @ref Eiotas_Room, @c NULL on failure
*
* This function will register the new room as a child of it's parent @ref Eiotas_Room.
*/
EAPI Eiotas_Room* eiotas_room_add(const char* name, Eiotas_Room *parent);
/**
* @}
*/
#endif // __EIOTAS_ROOM_H__
|
