summaryrefslogtreecommitdiff
path: root/core/pkg/tbox.pkg/inc/tbox/xml/reader.h
blob: 1f6dd84f25b62df760ee2a719b212c274001ff12 (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
/*!The Treasure Box Library
 * 
 * TBox 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.
 * 
 * TBox 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 TBox; 
 * If not, see <a href="http://www.gnu.org/licenses/"> http://www.gnu.org/licenses/</a>
 * 
 * Copyright (C) 2009 - 2015, ruki All rights reserved.
 *
 * @author      ruki
 * @file        reader.h
 * @ingroup     xml
 *
 */
#ifndef TB_XML_READER_H
#define TB_XML_READER_H

/* //////////////////////////////////////////////////////////////////////////////////////
 * includes
 */
#include "prefix.h"
#include "node.h"

/* //////////////////////////////////////////////////////////////////////////////////////
 * extern
 */
__tb_extern_c_enter__

/* //////////////////////////////////////////////////////////////////////////////////////
 * types
 */

/// the xml reader event type for iterator
typedef enum __tb_xml_reader_event_t
{
    TB_XML_READER_EVENT_NONE                    = 0
,   TB_XML_READER_EVENT_DOCUMENT_TYPE           = 1
,   TB_XML_READER_EVENT_DOCUMENT                = 2
,   TB_XML_READER_EVENT_ELEMENT_BEG             = 3
,   TB_XML_READER_EVENT_ELEMENT_END             = 4
,   TB_XML_READER_EVENT_ELEMENT_EMPTY           = 5
,   TB_XML_READER_EVENT_COMMENT                 = 6
,   TB_XML_READER_EVENT_TEXT                    = 7
,   TB_XML_READER_EVENT_CDATA                   = 8

}tb_xml_reader_event_t;

/// the xml reader ref type
typedef struct{}*       tb_xml_reader_ref_t;

/* //////////////////////////////////////////////////////////////////////////////////////
 * interfaces
 */

/*! init the xml reader
 *
 * @return              the reader 
 */
tb_xml_reader_ref_t     tb_xml_reader_init(tb_noarg_t);

/*! exit the xml reader
 *
 * @param reader        the xml reader
 */
tb_void_t               tb_xml_reader_exit(tb_xml_reader_ref_t reader);

/*! open the xml reader
 *
 * @param reader        the xml reader
 * @param stream        the stream, will open it if be not opened
 * @param bowner        the xml reader is owner of the stream?
 *
 * @return              tb_true or tb_false
 */
tb_bool_t               tb_xml_reader_open(tb_xml_reader_ref_t reader, tb_stream_ref_t stream, tb_bool_t bowner);

/*! clos the xml reader
 *
 * @param reader        the xml reader
 */
tb_void_t               tb_xml_reader_clos(tb_xml_reader_ref_t reader);

/*! the next iterator for the xml reader
 *
 * @param reader        the xml reader
 * @return              the iterator event 
 *
 * @code
 *
    // init reader
    tb_xml_reader_ref_t reader = tb_xml_reader_init();
    if (reader)
    {
        // open reader
        if (tb_xml_reader_open(reader, tb_stream_init_from_url(argv[1]), tb_true))
        {
            // goto
            tb_bool_t ok = tb_true;
            if (argv[2]) ok = tb_xml_reader_goto(reader, argv[2]);

            // walk
            tb_size_t event = TB_XML_READER_EVENT_NONE;
            while (ok && (event = tb_xml_reader_next(reader)))
            {
                switch (event)
                {
                case TB_XML_READER_EVENT_DOCUMENT: 
                    {
                        tb_printf("<?xml version = \"%s\" encoding = \"%s\" ?>\n"
                            , tb_xml_reader_version(reader), tb_xml_reader_charset(reader));
                    }
                    break;
                case TB_XML_READER_EVENT_DOCUMENT_TYPE: 
                    {
                        tb_printf("<!DOCTYPE>\n");
                    }
                    break;
                case TB_XML_READER_EVENT_ELEMENT_EMPTY: 
                    {
                        tb_char_t const*    name = tb_xml_reader_element(reader);
                        tb_xml_node_ref_t   attr = tb_xml_reader_attributes(reader);
                        tb_size_t           t = tb_xml_reader_level(reader);
                        while (t--) tb_printf("\t");
                        if (!attr) tb_printf("<%s/>\n", name);
                        else
                        {
                            tb_printf("<%s", name);
                            for (; attr; attr = attr->next)
                                tb_printf(" %s = \"%s\"", tb_string_cstr(&attr->name), tb_string_cstr(&attr->data));
                            tb_printf("/>\n");
                        }
                    }
                    break;
                case TB_XML_READER_EVENT_ELEMENT_BEG: 
                    {
                        tb_char_t const*    name = tb_xml_reader_element(reader);
                        tb_xml_node_ref_t   attr = tb_xml_reader_attributes(reader);    
                        tb_size_t           t = tb_xml_reader_level(reader) - 1;
                        while (t--) tb_printf("\t");
                        if (!attr) tb_printf("<%s>\n", name);
                        else
                        {
                            tb_printf("<%s", name);
                            for (; attr; attr = attr->next)
                                tb_printf(" %s = \"%s\"", tb_string_cstr(&attr->name), tb_string_cstr(&attr->data));
                            tb_printf(">\n");
                        }
                    }
                    break;
                case TB_XML_READER_EVENT_ELEMENT_END: 
                    {
                        tb_size_t t = tb_xml_reader_level(reader);
                        while (t--) tb_printf("\t");
                        tb_printf("</%s>\n", tb_xml_reader_element(reader));
                    }
                    break;
                case TB_XML_READER_EVENT_TEXT: 
                    {
                        tb_size_t t = tb_xml_reader_level(reader);
                        while (t--) tb_printf("\t");
                        tb_printf("%s", tb_xml_reader_text(reader));
                        tb_printf("\n");
                    }
                    break;
                case TB_XML_READER_EVENT_CDATA: 
                    {
                        tb_size_t t = tb_xml_reader_level(reader);
                        while (t--) tb_printf("\t");
                        tb_printf("<![CDATA[%s]]>", tb_xml_reader_cdata(reader));
                        tb_printf("\n");
                    }
                    break;
                case TB_XML_READER_EVENT_COMMENT: 
                    {
                        tb_size_t t = tb_xml_reader_level(reader);
                        while (t--) tb_printf("\t");
                        tb_printf("<!--%s-->", tb_xml_reader_comment(reader));
                        tb_printf("\n");
                    }
                    break;
                default:
                    break;
                }
            }
        }

        // exit reader
        tb_xml_reader_exit(reader);
    }
    
 * @endcode
 */
tb_size_t               tb_xml_reader_next(tb_xml_reader_ref_t reader);

/*! the xml stream
 *
 * @param reader        the xml reader
 * @return              the xml stream
 */
tb_stream_ref_t         tb_xml_reader_stream(tb_xml_reader_ref_t reader);

/*! the xml level
 *
 * @param reader        the xml reader
 * @return              the xml level for tab spaces
 */
tb_size_t               tb_xml_reader_level(tb_xml_reader_ref_t reader);

/*! seek to the given node for xml, .e.g /root/node/item
 *
 * @param reader        the reader handle
 * @param path          the xml path
 * @return              tb_true or tb_false
 *
 * @note the stream will be reseted
 */
tb_bool_t               tb_xml_reader_goto(tb_xml_reader_ref_t reader, tb_char_t const* path);

/*! load the xml 
 *
 * @param reader        the xml reader
 * @return              the xml root node
 */
tb_xml_node_ref_t       tb_xml_reader_load(tb_xml_reader_ref_t reader);

/*! the xml version
 *
 * @param reader        the xml reader
 * @return              the xml version
 */
tb_char_t const*        tb_xml_reader_version(tb_xml_reader_ref_t reader);

/*! the xml charset
 *
 * @param reader        the xml reader
 * @return              the xml charset
 */
tb_char_t const*        tb_xml_reader_charset(tb_xml_reader_ref_t reader);

/*! the current xml element name
 *
 * @param reader        the xml reader
 * @return              the current xml element name
 */
tb_char_t const*        tb_xml_reader_element(tb_xml_reader_ref_t reader);

/*! the current xml node text
 *
 * @param reader        the xml reader
 * @return              the current xml node text
 */
tb_char_t const*        tb_xml_reader_text(tb_xml_reader_ref_t reader);

/*! the current xml node cdata
 *
 * @param reader        the xml reader
 * @return              the current xml node cdata
 */
tb_char_t const*        tb_xml_reader_cdata(tb_xml_reader_ref_t reader);

/*! the current xml node comment
 *
 * @param reader        the xml reader
 * @return              the current xml node comment
 */
tb_char_t const*        tb_xml_reader_comment(tb_xml_reader_ref_t reader);

/*! the xml document type
 *
 * @param reader        the xml reader
 * @return              the xml document type
 */
tb_char_t const*        tb_xml_reader_doctype(tb_xml_reader_ref_t reader);

/*! the current xml node attributes
 *
 * @param reader        the xml reader
 * @return              the current xml node attributes
 */
tb_xml_node_ref_t       tb_xml_reader_attributes(tb_xml_reader_ref_t reader);

/* //////////////////////////////////////////////////////////////////////////////////////
 * extern
 */
__tb_extern_c_leave__

#endif