/usr/include/xercesc/sax2/Attributes.hpp is in libxerces-c-dev 3.1.1-5.1+deb8u4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 | /*
* 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.
*/
/*
* $Id: Attributes.hpp 932887 2010-04-11 13:04:59Z borisk $
*/
#if !defined(XERCESC_INCLUDE_GUARD_ATTRIBUTES_HPP)
#define XERCESC_INCLUDE_GUARD_ATTRIBUTES_HPP
#include <xercesc/util/XercesDefs.hpp>
XERCES_CPP_NAMESPACE_BEGIN
/**
* Interface for an element's attribute specifications.
*
* The SAX2 parser implements this interface and passes an instance
* to the SAX2 application as the last argument of each startElement
* event.
*
* The instance provided will return valid results only during the
* scope of the startElement invocation (to save it for future
* use, the application must make a copy: the AttributesImpl
* helper class provides a convenient constructor for doing so).
*
* An Attributes includes only attributes that have been
* specified or defaulted: \#IMPLIED attributes will not be included.
*
* There are two ways for the SAX application to obtain information
* from the Attributes. First, it can iterate through the entire
* list:
*
* <code>
* public void startElement (String uri, String localpart, String qName, Attributes atts) {<br>
* for (XMLSize_t i = 0; i < atts.getLength(); i++) {<br>
* String Qname = atts.getQName(i);<br>
* String URI = atts.getURI(i)<br>
* String local = atts.GetLocalName(i)<br>
* String type = atts.getType(i);<br>
* String value = atts.getValue(i);<br>
* [...]<br>
* }<br>
* }
* </code>
*
* (Note that the result of getLength() will be zero if there
* are no attributes.)
*
* As an alternative, the application can request the value or
* type of specific attributes:
*
* <code>
* public void startElement (String uri, String localpart, String qName, Attributes atts) {<br>
* String identifier = atts.getValue("id");<br>
* String label = atts.getValue("label");<br>
* [...]<br>
* }
* </code>
*
* The AttributesImpl helper class provides a convenience
* implementation for use by parser or application writers.
*
* @see Sax2DocumentHandler#startElement
* @see AttributesImpl#AttributesImpl
*/
class SAX2_EXPORT Attributes
{
public:
// -----------------------------------------------------------------------
// Constructors and Destructor
// -----------------------------------------------------------------------
/** @name Constructors and Destructor */
//@{
/** Default constructor */
Attributes()
{
}
/** Destructor */
virtual ~Attributes()
{
}
//@}
/** @name The virtual attribute list interface */
//@{
/**
* Return the number of attributes in this list.
*
* The SAX parser may provide attributes in any
* arbitrary order, regardless of the order in which they were
* declared or specified. The number of attributes may be
* zero.
*
* @return The number of attributes in the list.
*/
virtual XMLSize_t getLength() const = 0;
/**
* Return the namespace URI of an attribute in this list (by position).
*
* The QNames must be unique: the SAX parser shall not include the
* same attribute twice. Attributes without values (those declared
* \#IMPLIED without a value specified in the start tag) will be
* omitted from the list.
*
* @param index The index of the attribute in the list (starting at 0).
* @return The URI of the indexed attribute, or null
* if the index is out of range.
* @see #getLength
*/
virtual const XMLCh* getURI(const XMLSize_t index) const = 0;
/**
* Return the local name of an attribute in this list (by position).
*
* The QNames must be unique: the SAX parser shall not include the
* same attribute twice. Attributes without values (those declared
* \#IMPLIED without a value specified in the start tag) will be
* omitted from the list.
*
* @param index The index of the attribute in the list (starting at 0).
* @return The local name of the indexed attribute, or null
* if the index is out of range.
* @see #getLength
*/
virtual const XMLCh* getLocalName(const XMLSize_t index) const = 0;
/**
* Return the qName of an attribute in this list (by position).
*
* The QNames must be unique: the SAX parser shall not include the
* same attribute twice. Attributes without values (those declared
* \#IMPLIED without a value specified in the start tag) will be
* omitted from the list.
*
* @param index The index of the attribute in the list (starting at 0).
* @return The qName of the indexed attribute, or null
* if the index is out of range.
* @see #getLength
*/
virtual const XMLCh* getQName(const XMLSize_t index) const = 0;
/**
* Return the type of an attribute in the list (by position).
*
* The attribute type is one of the strings "CDATA", "ID",
* "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES",
* or "NOTATION" (always in upper case).
*
* If the parser has not read a declaration for the attribute,
* or if the parser does not report attribute types, then it must
* return the value "CDATA" as stated in the XML 1.0 Recommendation
* (clause 3.3.3, "Attribute-Value Normalization").
*
* For an enumerated attribute that is not a notation, the
* parser will report the type as "NMTOKEN".
*
* @param index The index of the attribute in the list (starting at 0).
* @return The attribute type as a string, or
* null if the index is out of range.
* @see #getLength
* @see #getType
*/
virtual const XMLCh* getType(const XMLSize_t index) const = 0;
/**
* Return the value of an attribute in the list (by position).
*
* If the attribute value is a list of tokens (IDREFS,
* ENTITIES, or NMTOKENS), the tokens will be concatenated
* into a single string separated by whitespace.
*
* @param index The index of the attribute in the list (starting at 0).
* @return The attribute value as a string, or
* null if the index is out of range.
* @see #getLength
* @see #getValue
*/
virtual const XMLCh* getValue(const XMLSize_t index) const = 0;
////////////////////////////////////////////////////////////////////
// Name-based query.
////////////////////////////////////////////////////////////////////
/**
* Look up the index of an attribute by Namespace name. Non-standard
* extension.
*
* @param uri The Namespace URI, or the empty string if
* the name has no Namespace URI.
* @param localPart The attribute's local name.
* @param index Reference to the variable where the index will be stored.
* @return true if the attribute is found and false otherwise.
*/
virtual bool getIndex(const XMLCh* const uri,
const XMLCh* const localPart,
XMLSize_t& index) const = 0 ;
/**
* Look up the index of an attribute by Namespace name.
*
* @param uri The Namespace URI, or the empty string if
* the name has no Namespace URI.
* @param localPart The attribute's local name.
* @return The index of the attribute, or -1 if it does not
* appear in the list.
*/
virtual int getIndex(const XMLCh* const uri,
const XMLCh* const localPart ) const = 0 ;
/**
* Look up the index of an attribute by XML 1.0 qualified name.
* Non-standard extension.
*
* @param qName The qualified (prefixed) name.
* @param index Reference to the variable where the index will be stored.
* @return true if the attribute is found and false otherwise.
*/
virtual bool getIndex(const XMLCh* const qName,
XMLSize_t& index) const = 0 ;
/**
* Look up the index of an attribute by XML 1.0 qualified name.
*
* @param qName The qualified (prefixed) name.
* @return The index of the attribute, or -1 if it does not
* appear in the list.
*/
virtual int getIndex(const XMLCh* const qName ) const = 0 ;
/**
* Look up an attribute's type by Namespace name.
*
* <p>See #getType for a description of the possible types.</p>
*
* @param uri The Namespace URI, or the empty String if the
* name has no Namespace URI.
* @param localPart The local name of the attribute.
* @return The attribute type as a string, or null if the
* attribute is not in the list or if Namespace
* processing is not being performed.
*/
virtual const XMLCh* getType(const XMLCh* const uri,
const XMLCh* const localPart ) const = 0 ;
/**
* Look up an attribute's type by XML 1.0 qualified name.
*
* <p>See #getType for a description of the possible types.</p>
*
* @param qName The XML 1.0 qualified name.
* @return The attribute type as a string, or null if the
* attribute is not in the list or if qualified names
* are not available.
*/
virtual const XMLCh* getType(const XMLCh* const qName) const = 0;
/**
* Look up an attribute's value by Namespace name.
*
* <p>See #getValue for a description of the possible values.</p>
*
* @param uri The Namespace URI, or the empty String if the
* name has no Namespace URI.
* @param localPart The local name of the attribute.
* @return The attribute value as a string, or null if the
* attribute is not in the list.
*/
virtual const XMLCh* getValue(const XMLCh* const uri, const XMLCh* const localPart ) const = 0 ;
/**
* Look up an attribute's value by XML 1.0 qualified name.
*
* <p>See #getValue for a description of the possible values.</p>
*
* @param qName The XML 1.0 qualified name.
* @return The attribute value as a string, or null if the
* attribute is not in the list or if qualified names
* are not available.
*/
virtual const XMLCh* getValue(const XMLCh* const qName) const = 0;
//@}
private :
/* Constructors and operators */
/* Copy constructor */
Attributes(const Attributes&);
/* Assignment operator */
Attributes& operator=(const Attributes&);
};
XERCES_CPP_NAMESPACE_END
#endif
|