summaryrefslogtreecommitdiffstats
path: root/axiom/src/xpath/xpath_internals_iterators.h
blob: 67d06c46d4b7b3ed85a53a57c0d24e8b613d7f70 (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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef AXIOM_XPATH_INTERNALS_ITERATORS_H
#define AXIOM_XPATH_INTERNALS_ITERATORS_H

#include <axiom_xpath.h>

#ifdef __cplusplus
extern "C"
{
#endif

    /**
     * @defgroup axiom_xpath_iterators iterators
     * @ingroup axiom_xpath
     * @{
     */


#ifdef AXIOM_XPATH_DEBUG
#define AXIOM_XPATH_ITERATOR_INITIALIZE { \
 if(!context->node) { \
  printf("Context node NULL; cannot evaluate self or descendent axis.\n"); \
  return AXIOM_XPATH_EVALUATION_ERROR; } \
 node_test_op = AXIOM_XPATH_OPR_GET(op_node_test); \
 if(!node_test_op) { \
  printf("Node test not present.\n"); \
  return AXIOM_XPATH_EVALUATION_ERROR; } \
 context_node = context->node; \
}
#else
#define AXIOM_XPATH_ITERATOR_INITIALIZE { \
 if(!context->node) { \
  return AXIOM_XPATH_EVALUATION_ERROR; } \
 node_test_op = AXIOM_XPATH_OPR_GET(op_node_test); \
 if(!node_test_op) { \
  return AXIOM_XPATH_EVALUATION_ERROR; } \
 context_node = context->node; \
}
#endif

    /**
      * Iterate through children
      *
      * @param context XPath context
      * @param op_node_test Reference to the node test operation
      *        in the parsed expression
      * @param op_next Reference to the next step in the location path,
      *        in the parsed expression
      * @param op_predicate Reference to the first predicate in the
      *        parsed expression
      * @return Number of nodes added to the stack
      */
    int axiom_xpath_child_iterator(
        axiom_xpath_context_t *context,
        int op_node_test,
        int op_next,
        int op_predicate);

    /**
      * Iterate through descendents
      *
      * @param context XPath context
      * @param op_node_test Reference to the node test operation
      *        in the parsed expression
      * @param op_next Reference to the next step in the location path,
      *        in the parsed expression
      * @param op_predicate Reference to the first predicate in the
      *        parsed expression
      * @return Number of nodes added to the stack
      */
    int axiom_xpath_descendant_iterator(
        axiom_xpath_context_t *context,
        int op_node_test,
        int op_next,
        int op_predicate);

    /**
      * Iterate through parent node. (Only one node)
      *
      * @param context XPath context
      * @param op_node_test Reference to the node test operation
      *        in the parsed expression
      * @param op_next Reference to the next step in the location path,
      *        in the parsed expression
      * @param op_predicate Reference to the first predicate in the
      *        parsed expression
      * @return Number of nodes added to the stack
      */
    int axiom_xpath_parent_iterator(
        axiom_xpath_context_t *context,
        int op_node_test,
        int op_next,
        int op_predicate);

    /**
      * Iterate through ancestors
      *
      * @param context XPath context
      * @param op_node_test Reference to the node test operation
      *        in the parsed expression
      * @param op_next Reference to the next step in the location path,
      *        in the parsed expression
      * @param op_predicate Reference to the first predicate in the
      *        parsed expression
      * @return Number of nodes added to the stack
      */
    int axiom_xpath_ancestor_iterator(
        axiom_xpath_context_t *context,
        int op_node_test,
        int op_next,
        int op_predicate);

    /**
      * Iterate through siblings following the context node
      *
      * @param context XPath context
      * @param op_node_test Reference to the node test operation
      *        in the parsed expression
      * @param op_next Reference to the next step in the location path,
      *        in the parsed expression
      * @param op_predicate Reference to the first predicate in the
      *        parsed expression
      * @return Number of nodes added to the stack
      */
    int axiom_xpath_following_sibling_iterator(
        axiom_xpath_context_t *context,
        int op_node_test,
        int op_next,
        int op_predicate);

    /**
      * Iterate through sibling preceding the context node
      *
      * @param context XPath context
      * @param op_node_test Reference to the node test operation
      *        in the parsed expression
      * @param op_next Reference to the next step in the location path,
      *        in the parsed expression
      * @param op_predicate Reference to the first predicate in the
      *        parsed expression
      * @return Number of nodes added to the stack
      */
    int axiom_xpath_preceding_sibling_iterator(
        axiom_xpath_context_t *context,
        int op_node_test,
        int op_next,
        int op_predicate);

    /**
      * Iterate through all nodes following the context node
      *
      * @param context XPath context
      * @param op_node_test Reference to the node test operation
      *        in the parsed expression
      * @param op_next Reference to the next step in the location path,
      *        in the parsed expression
      * @param op_predicate Reference to the first predicate in the
      *        parsed expression
      * @return Number of nodes added to the stack
      */
    int axiom_xpath_following_iterator(
        axiom_xpath_context_t *context,
        int op_node_test,
        int op_next,
        int op_predicate);

    /**
      * Iterate through all nodes preceding the context node
      *
      * @param context XPath context
      * @param op_node_test Reference to the node test operation
      *        in the parsed expression
      * @param op_next Reference to the next step in the location path,
      *        in the parsed expression
      * @param op_predicate Reference to the first predicate in the
      *        parsed expression
      * @return Number of nodes added to the stack
      */
    int axiom_xpath_preceding_iterator(
        axiom_xpath_context_t *context,
        int op_node_test,
        int op_next,
        int op_predicate);

    /**
      * Iterate through attributes
      *
      * @param context XPath context
      * @param op_node_test Reference to the node test operation
      *        in the parsed expression
      * @param op_next Reference to the next step in the location path,
      *        in the parsed expression
      * @param op_predicate Reference to the first predicate in the
      *        parsed expression
      * @return Number of nodes added to the stack
      */
    int axiom_xpath_attribute_iterator(
        axiom_xpath_context_t *context,
        int op_node_test,
        int op_next,
        int op_predicate);

    /**
      * Iterate through namespaces defined in the context node
      *
      * @param context XPath context
      * @param op_node_test Reference to the node test operation
      *        in the parsed expression
      * @param op_next Reference to the next step in the location path,
      *        in the parsed expression
      * @param op_predicate Reference to the first predicate in the
      *        parsed expression
      * @return Number of nodes added to the stack
      */
    int axiom_xpath_namespace_iterator(
        axiom_xpath_context_t *context,
        int op_node_test,
        int op_next,
        int op_predicate);

    /**
      * Iterate through self node (Only one node)
      *
      * @param context XPath context
      * @param op_node_test Reference to the node test operation
      *        in the parsed expression
      * @param op_next Reference to the next step in the location path,
      *        in the parsed expression
      * @param op_predicate Reference to the first predicate in the
      *        parsed expression
      * @return Number of nodes added to the stack
      */
    int axiom_xpath_self_iterator(
        axiom_xpath_context_t *context,
        int op_node_test,
        int op_next,
        int op_predicate);

    /**
      * Iterate through descendents and context node
      *
      * @param context XPath context
      * @param op_node_test Reference to the node test operation
      *        in the parsed expression
      * @param op_next Reference to the next step in the location path,
      *        in the parsed expression
      * @param op_predicate Reference to the first predicate in the
      *        parsed expression
      * @return Number of nodes added to the stack
      */
    int axiom_xpath_descendant_self_iterator(
        axiom_xpath_context_t *context,
        int op_node_test,
        int op_next,
        int op_predicate);

    /**
      * Iterate through ancestors and context node
      *
      * @param context XPath context
      * @param op_node_test Reference to the node test operation
      *        in the parsed expression
      * @param op_next Reference to the next step in the location path,
      *        in the parsed expression
      * @param op_predicate Reference to the first predicate in the
      *        parsed expression
      * @return Number of nodes added to the stack
      */
    int axiom_xpath_ancestor_self_iterator(
        axiom_xpath_context_t *context,
        int op_node_test,
        int op_next,
        int op_predicate);

    /** @} */

#ifdef __cplusplus
}
#endif

#endif