blob: df1d78206691496ddce73f41c7fc740934eecf7e (
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
|
/**
* @file enumerator.h
*
* @brief Interface of enumerator_t.
*
*/
/*
* Copyright (C) 2007 Martin Willi
* Hochschule fuer Technik Rapperswil
*
* This program 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. See <http://www.fsf.org/copyleft/gpl.txt>.
*
* This program 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.
*/
#ifndef ENUMERATOR_H_
#define ENUMERATOR_H_
#include <library.h>
typedef struct enumerator_t enumerator_t;
/**
* @brief Enumerate is simpler, but more flexible than iterator.
*/
struct enumerator_t {
/**
* @brief Enumerate collection.
*
* The enumerate function takes a variable argument list containing
* pointers where the enumerated values get written.
*
* @param ... variable list of enumerated items, implementation dependant
* @return TRUE if pointers returned
*/
bool (*enumerate)(enumerator_t *this, ...);
/**
* @brief Destroy a enumerator instance.
*/
void (*destroy)(enumerator_t *this);
};
/**
* @brief Create an enumerator which enumerates over nothing
*/
enumerator_t* enumerator_create_empty();
#endif /* ENUMERATOR_H_ */
|
