1 /*
2 * Copyright (C) 1997-2004, Michael Jennings
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to
6 * deal in the Software without restriction, including without limitation the
7 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
8 * sell copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies of the Software, its documentation and marketing & publicity
13 * materials, and acknowledgment shall be given in the documentation, materials
14 * and software packages that this Software was used.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
20 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 */
23
24 #ifndef _LIBAST_ITERATOR_IF_H_
25 #define _LIBAST_ITERATOR_IF_H_
26
27 /*
28 * interface goop
29 */
30
31 /* Standard typecast macros.... */
32 #define SPIF_ITERATOR(o) (SPIF_CAST(iterator) (o))
33 #define SPIF_ITERATOR_CLASS(o) (SPIF_CAST(iteratorclass) SPIF_OBJ_CLASS(o))
34
35 /* Name of class variable associated with iterator interface */
36 #define SPIF_ITERATORCLASS_VAR(type) spif_ ## type ## _iteratorclass
37
38 /* Check if an iterator is NULL */
39 #define SPIF_ITERATOR_ISNULL(o) (SPIF_ITERATOR(o) == SPIF_NULL_TYPE(iterator))
40
41 /* Check if an object is an iterator */
42 #define SPIF_OBJ_IS_ITERATOR(o) SPIF_OBJ_IS_TYPE(o, iterator)
43
44 /* Call a method on an instance of an implementation class */
45 #define SPIF_ITERATOR_CALL_METHOD(o, meth) SPIF_ITERATOR_CLASS(o)->meth
46
47 /* Calls to the basic functions. */
48 #define SPIF_ITERATOR_NEW(type) SPIF_ITERATOR((SPIF_CLASS(SPIF_ITERATORCLASS_VAR(type)))->noo())
49 #define SPIF_ITERATOR_INIT(o) SPIF_OBJ_INIT(o)
50 #define SPIF_ITERATOR_DONE(o) SPIF_OBJ_DONE(o)
51 #define SPIF_ITERATOR_DEL(o) SPIF_OBJ_DEL(o)
52 #define SPIF_ITERATOR_SHOW(o, b, i) SPIF_OBJ_SHOW(o, b, i)
53 #define SPIF_ITERATOR_COMP(o1, o2) SPIF_OBJ_COMP(o1, o2)
54 #define SPIF_ITERATOR_DUP(o) SPIF_OBJ_DUP(o)
55 #define SPIF_ITERATOR_TYPE(o) SPIF_OBJ_TYPE(o)
56
57 #define SPIF_ITERATOR_HAS_NEXT(o) SPIF_CAST(bool) ((SPIF_ITERATOR_CALL_METHOD((o), has_next))(o))
58 #define SPIF_ITERATOR_NEXT(o) SPIF_CAST(obj) ((SPIF_ITERATOR_CALL_METHOD((o), next))(o))
59
60 typedef spif_obj_t spif_iterator_t;
61
SPIF_DECL_OBJ(iteratorclass)62 SPIF_DECL_OBJ(iteratorclass) {
63 SPIF_DECL_PARENT_TYPE(class);
64
65 spif_func_t has_next;
66 spif_func_t next;
67 };
68
69 #endif /* _LIBAST_ITERATOR_IF_H_ */
70