Coin: document.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

document.h
1#ifndef COIN_XMLDOCUMENT_H
2#define COIN_XMLDOCUMENT_H
3
4/**************************************************************************\
5 * Copyright (c) Kongsberg Oil & Gas Technologies AS
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * Neither the name of the copyright holder nor the names of its
20 * contributors may be used to endorse or promote products derived from
21 * this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34\**************************************************************************/
35
36#include <Inventor/C/XML/types.h>
37
38/* ********************************************************************** */
39
40#ifdef __cplusplus
41extern "C" {
42#endif /* __cplusplus */
43
44/* basic construction */
45COIN_DLL_API cc_xml_doc * cc_xml_doc_new(void);
46COIN_DLL_API void cc_xml_doc_delete_x(cc_xml_doc * doc);
47
48/* parser configuration */
49COIN_DLL_API void cc_xml_doc_set_filter_cb_x(cc_xml_doc * doc, cc_xml_filter_cb * cb, void * userdata);
50COIN_DLL_API void cc_xml_doc_get_filter_cb(const cc_xml_doc * doc, cc_xml_filter_cb *& cb, void *& userdata);
51
52/* document io */
53COIN_DLL_API SbBool cc_xml_doc_read_file_x(cc_xml_doc * doc, const char * path);
54COIN_DLL_API SbBool cc_xml_doc_read_buffer_x(cc_xml_doc * doc, const char * buffer, size_t buflen);
55
56COIN_DLL_API SbBool cc_xml_doc_parse_buffer_partial_x(cc_xml_doc * doc, const char * buffer, size_t buflen);
57COIN_DLL_API SbBool cc_xml_doc_parse_buffer_partial_done_x(cc_xml_doc * doc, const char * buffer, size_t buflen);
58
59COIN_DLL_API SbBool cc_xml_doc_write_to_buffer(const cc_xml_doc * doc, char *& buffer, size_t & bytes);
60COIN_DLL_API SbBool cc_xml_doc_write_to_file(const cc_xml_doc * doc, const char * path);
61
62COIN_DLL_API cc_xml_path * cc_xml_doc_diff(const cc_xml_doc * doc, const cc_xml_doc * other);
63
64/* document attributes */
65COIN_DLL_API void cc_xml_doc_set_filename_x(cc_xml_doc * doc, const char * path);
66COIN_DLL_API const char * cc_xml_doc_get_filename(const cc_xml_doc * doc);
67
68/* misc... */
69
70COIN_DLL_API cc_xml_elt * cc_xml_doc_get_root(const cc_xml_doc * doc);
71COIN_DLL_API void cc_xml_doc_set_current_x(cc_xml_doc * doc, cc_xml_elt * elt);
72COIN_DLL_API cc_xml_elt * cc_xml_doc_get_current(const cc_xml_doc * doc);
73COIN_DLL_API void cc_xml_doc_strip_whitespace_x(cc_xml_doc * doc);
74
75COIN_DLL_API void cc_xml_doc_set_root_x(cc_xml_doc * doc, cc_xml_elt * root);
76
77COIN_DLL_API const cc_xml_elt * cc_xml_doc_find_element(const cc_xml_doc * doc, cc_xml_path * path);
78COIN_DLL_API const cc_xml_elt * cc_xml_doc_find_next_element(const cc_xml_doc * doc, cc_xml_elt * elt, cc_xml_path * path);
79COIN_DLL_API cc_xml_elt * cc_xml_doc_create_element_x(cc_xml_doc * doc, cc_xml_path * path);
80
81
82#ifdef __cplusplus
83} /* extern "C" */
84#endif /* __cplusplus */
85
86#endif /* !COIN_XML_DOCUMENT_H */