summaryrefslogtreecommitdiff
path: root/modules/xml/src/cpp/XMLAttr.hxx
blob: 37cbbec9d176194065a7c38607817446834f013c (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
/*
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2012 - Scilab Enterprises - Calixte DENIZET
 *
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at
 * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
 *
 */

#ifndef __XMLATTR_HXX__
#define __XMLATTR_HXX__

#include <string>
#include "dynlib_xml_scilab.h"
#include "xml.h"

namespace org_modules_xml
{
class XMLElement;
class XMLObject;

class XML_SCILAB_IMPEXP XMLAttr : public XMLObject
{
    const XMLElement & elem;

public:
    /**
     * Default constructor
     * @param elem the element which has this attributes
     */
    XMLAttr(const XMLElement & elem);

    ~XMLAttr();

    void *getRealXMLPointer() const;

    /**
     * Get the number of attributes
     * @return the attributes number
     */
    int getSize() const;

    /**
     * Gets the attribute value with the given index.
     * @param index the attribute index
     * @return the attribute value
     */
    const char *getAttributeValue(int index) const;

    /**
     * Gets the attribute value.
     * @param name the attribute name
     * @return the attribute value
     */
    const char *getAttributeValue(const char *name) const;

    /**
     * Gets the attribute value with a prefix namespace.
     * @param prefix the namespace prefix or the namespace itself
     * @param name the attribute name
     * @return the attribute value
     */
    const char *getAttributeValue(const char *prefix, const char *name) const;

    /**
     * Sets the attribute value.
     * @param name the attribute name
     * @param value the attribute value
     */
    void setAttributeValue(const char *name, const char *value) const;

    /**
     * Sets the attribute value.
     * @param node the node where to set the attributes
     * @param name the attribute name
     * @param value the attribute value
     */
    static void setAttributeValue(xmlNode * node, const char *name, const char *value);

    /**
     * Sets the attribute value.
     * @param name the attribute names
     * @param value the attribute values
     * @param size the number of names
     */
    void setAttributeValue(const char **name, const char **value, int size) const;

    /**
     * Sets the attribute value.
     * @param node the node where to set the attributes
     * @param name the attribute names
     * @param value the attribute values
     * @param size the number of names
     */
    static void setAttributeValue(xmlNode * node, const char **name, const char **value, int size);

    /**
     * Sets the attribute value at the given index.
     * @param index the attribute index
     * @param value the attribute value
     */
    void setAttributeValue(int index, const char *value) const;

    /**
     * Sets the attribute value at the given index.
     * @param node the node where to set the attributes
     * @param index the attribute index
     * @param value the attribute value
     */
    static void setAttributeValue(xmlNode * node, int index, const char *value);

    /**
     * Sets the attribute value with a prefix namespace.
     * @param prefix the namespace prefix or the namespace itself
     * @param name the attribute name
     * @param value the attribute value
     */
    void setAttributeValue(const char *prefix, const char *name, const char *value) const;

    /**
     * Sets the attribute value with a prefix namespace.
     * @param node the node where to set the attributes
     * @param prefix the namespace prefix or the namespace itself
     * @param name the attribute name
     * @param value the attribute value
     */
    static void setAttributeValue(xmlNode * node, const char *prefix, const char *name, const char *value);

    /**
     * Sets the attribute value with a prefix namespace.
     * @param prefix the namespace prefix or the namespace itself
     * @param name the attribute names
     * @param value the attribute values
     * @param size the number of names
     */
    void setAttributeValue(const char **prefix, const char **name, const char **value, int size) const;

    /**
     * Sets the attribute value with a prefix namespace.
     * @param node the node where to set the attributes
     * @param prefix the namespace prefix or the namespace itself
     * @param name the attribute names
     * @param value the attribute values
     * @param size the number of names
     */
    static void setAttributeValue(xmlNode * node, const char **prefix, const char **name, const char **value, int size);

    /**
     * @return the names of the attributes
     */
    const char ** getNames() const;

    /**
     * Gets the element associated with this object
     * @return the associated object
     */
    const XMLElement & getElement() const
    {
        return elem;
    }

    const XMLObject *getXMLObjectParent() const;
    const std::string toString() const;

    /**
     * Get the number of attributes
     * @return the attributes number
     */
    static int getSize(xmlAttr * attr);
};
}

#endif