Skip to content
This repository
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 411 lines (365 sloc) 11.326 kb
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 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
/*
* Copyright (c) 2008, 2009, 2010, 2011, 2012
* Jonathan Schleifer <js@webkeks.org>
*
* All rights reserved.
*
* This file is part of ObjFW. It may be distributed under the terms of the
* Q Public License 1.0, which can be found in the file LICENSE.QPL included in
* the packaging of this file.
*
* Alternatively, it may be distributed under the terms of the GNU General
* Public License, either version 2 or 3, which can be found in the file
* LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
* file.
*/

#import "OFXMLNode.h"

@class OFString;
@class OFArray;
@class OFMutableString;
@class OFMutableArray;
@class OFMutableDictionary;
@class OFXMLAttribute;

/**
* \brief A class which stores an XML element.
*/
@interface OFXMLElement: OFXMLNode
{
OFString *name;
OFString *ns;
OFString *defaultNamespace;
OFMutableArray *attributes;
OFMutableDictionary *namespaces;
OFMutableArray *children;
}

#ifdef OF_HAVE_PROPERTIES
@property (copy) OFString *name;
@property (copy, getter=namespace, setter=setNamespace:) OFString *ns;
@property (copy) OFString *defaultNamespace;
@property (readonly, copy) OFArray *attributes;
@property (readonly, copy) OFArray *children;
#endif

/**
* \brief Creates a new XML element with the specified name.
*
* \param name The name for the element
* \return A new autoreleased OFXMLElement with the specified element name
*/
+ elementWithName: (OFString*)name;

/**
* \brief Creates a new XML element with the specified name and string value.
*
* \param name The name for the element
* \param stringValue The value for the element
* \return A new autoreleased OFXMLElement with the specified element name and
* value
*/
+ elementWithName: (OFString*)name
      stringValue: (OFString*)stringValue;

/**
* \brief Creates a new XML element with the specified name and namespace.
*
* \param name The name for the element
* \param ns The namespace for the element
* \return A new autoreleased OFXMLElement with the specified element name and
* namespace
*/
+ elementWithName: (OFString*)name
namespace: (OFString*)ns;

/**
* \brief Creates a new XML element with the specified name, namespace and
* string value.
*
* \param name The name for the element
* \param ns The namespace for the element
* \param stringValue The value for the element
* \return A new autoreleased OFXMLElement with the specified element name,
* namespace and value
*/
+ elementWithName: (OFString*)name
namespace: (OFString*)ns
      stringValue: (OFString*)stringValue;

/**
* \brief Creates a new element with the specified element.
*
* \param element An OFXMLElement to initialize the OFXMLElement with
* \return A new autoreleased OFXMLElement with the contents of the specified
* element
*/
+ elementWithElement: (OFXMLElement*)element;

/**
* \brief Parses the string and returns an OFXMLElement for it.
*
* \param string The string to parse
* \return A new autoreleased OFXMLElement with the contents of the string
*/
+ elementWithXMLString: (OFString*)string;

/**
* \brief Parses the specified file and returns an OFXMLElement for it.
*
* \param path The path to the file
* \return A new autoreleased OFXMLElement with the contents of the specified
* file
*/
+ elementWithFile: (OFString*)path;

/**
* \brief Initializes an already allocated OFXMLElement with the specified name.
*
* \param name The name for the element
* \return An initialized OFXMLElement with the specified element name
*/
- initWithName: (OFString*)name;

/**
* \brief Initializes an already allocated OFXMLElement with the specified name
* and string value.
*
* \param name The name for the element
* \param stringValue The value for the element
* \return An initialized OFXMLElement with the specified element name and
* value
*/
- initWithName: (OFString*)name
   stringValue: (OFString*)stringValue;

/**
* \brief Initializes an already allocated OFXMLElement with the specified name
* and namespace.
*
* \param name The name for the element
* \param ns The namespace for the element
* \return An initialized OFXMLElement with the specified element name and
* namespace
*/
- initWithName: (OFString*)name
     namespace: (OFString*)ns;

/**
* \brief Initializes an already allocated OFXMLElement with the specified name,
* namespace and value.
*
* \param name The name for the element
* \param ns The namespace for the element
* \param stringValue The value for the element
* \return An initialized OFXMLElement with the specified element name,
* namespace and value
*/
- initWithName: (OFString*)name
     namespace: (OFString*)ns
   stringValue: (OFString*)stringValue;

/**
* \brief Initializes an already allocated OFXMLElement with the specified
* element.
*
* \param element An OFXMLElement to initialize the OFXMLElement with
* \return A new autoreleased OFXMLElement with the contents of the specified
* element
*/
- initWithElement: (OFXMLElement*)element;

/**
* \brief Parses the string and initializes an already allocated OFXMLElement
* with it.
*
* \param string The string to parse
* \return An initialized OFXMLElement with the contents of the string
*/
- initWithXMLString: (OFString*)string;

/**
* \brief Parses the specified file and initializes an already allocated
* OFXMLElement with it.
*
* \param path The path to the file
* \return An initialized OFXMLElement with the contents of the specified file
*/
- initWithFile: (OFString*)path;

/**
* \brief Sets the name of the element.
*
* \param name The new name
*/
- (void)setName: (OFString*)name;

/**
* \brief Returns the name of the element.
*
* \return The name of the element
*/
- (OFString*)name;

/**
* \brief Sets the namespace of the element.
*
* \param ns The new namespace
*/
- (void)setNamespace: (OFString*)ns;

/**
* \brief Returns the namespace of the element.
*
* \return The namespace of the element
*/
- (OFString*)namespace;

/**
* \brief Returns an OFArray with the attributes of the element.
*
* \return An OFArray with the attributes of the element
*/
- (OFArray*)attributes;

/**
* \brief Removes all children and adds the children from the specified array.
*
* \param children The new children to add
*/
- (void)setChildren: (OFArray*)children;

/**
* \brief Returns an array of OFXMLNodes with all children of the element.
*
* \return An array of OFXMLNodes with all children of the element
*/
- (OFArray*)children;

/**
* \brief Removes all children and sets the string value to the specified
* string.
*
* \param stringValue The new string value for the element
*/
- (void)setStringValue: (OFString*)stringValue;

/**
* \brief Adds the specified attribute.
*
* If an attribute with the same name and namespace already exists, it is not
* added.
*
* \param attribute The attribute to add
*/
- (void)addAttribute: (OFXMLAttribute*)attribute;

/**
* \brief Adds the specified attribute with the specified string value.
*
* If an attribute with the same name and namespace already exists, it is not
* added.
*
* \param name The name of the attribute
* \param stringValue The value of the attribute
*/
- (void)addAttributeWithName: (OFString*)name
stringValue: (OFString*)stringValue;

/**
* \brief Adds the specified attribute with the specified namespace and string
* value.
*
* If an attribute with the same name and namespace already exists, it is not
* added.
*
* \param name The name of the attribute
* \param ns The namespace of the attribute
* \param stringValue The value of the attribute
*/
- (void)addAttributeWithName: (OFString*)name
namespace: (OFString*)ns
stringValue: (OFString*)stringValue;

/**
* \brief Returns the attribute with the specified name.
*
* \param attributeName The name of the attribute
* \return The attribute with the specified name
*/
- (OFXMLAttribute*)attributeForName: (OFString*)attributeName;

/**
* \brief Returns the attribute with the specified name and namespace.
*
* \param attributeName The name of the attribute
* \param attributeNS The namespace of the attribute
* \return The attribute with the specified name and namespace
*/
- (OFXMLAttribute*)attributeForName: (OFString*)attributeName
namespace: (OFString*)attributeNS;

/**
* \brief Removes the attribute with the specified name.
*
* \param attribteName The name of the attribute
*/
- (void)removeAttributeForName: (OFString*)attributeName;

/**
* \brief Removes the attribute with the specified name and namespace.
*
* \param attributeName The name of the attribute
* \param attributeNS The namespace of the attribute
*/
- (void)removeAttributeForName: (OFString*)attributeName
namespace: (OFString*)attributeNS;

/**
* \brief Sets a prefix for a namespace.
*
* \param prefix The prefix for the namespace
* \param ns The namespace for which the prefix is set
*/
- (void)setPrefix: (OFString*)prefix
     forNamespace: (OFString*)ns;

/**
* \brief Binds a prefix for a namespace.
*
* \param prefix The prefix for the namespace
* \param ns The namespace for which the prefix is bound
*/
- (void)bindPrefix: (OFString*)prefix
      forNamespace: (OFString*)ns;

/**
* \brief Sets the default namespace for the element to be used if there is no
* parent.
*
* \param ns The default namespace for the element
*/
- (void)setDefaultNamespace: (OFString*)ns;

/**
* \brief Adds a child to the OFXMLElement.
*
* \param child An OFXMLNode which is added as a child
*/
- (void)addChild: (OFXMLNode*)child;

/**
* \brief Removes the first child that is equal to the specified OFXMLElement.
*
* \param child The child to remove from the OFXMLElement
*/
- (void)removeChild: (OFXMLNode*)child;

/**
* \brief Returns all children that are elements.
*
* \return All children that are elements
*/
- (OFArray*)elements;

/**
* \brief Returns all children that have the specified namespace.
*
* \return All children that have the specified namespace
*/
- (OFArray*)elementsForNamespace: (OFString*)elementNS;

/**
* \brief Returns the first child element with the specified name.
*
* \param elementName The name of the element
* \return The first child element with the specified name
*/
- (OFXMLElement*)elementForName: (OFString*)elementName;

/**
* \brief Returns the child elements with the specified name.
*
* \param elementName The name of the elements
* \return The child elements with the specified name
*/
- (OFArray*)elementsForName: (OFString*)elementName;

/**
* \brief Returns the first child element with the specified name and namespace.
*
* \param elementName The name of the element
* \param elementNS The namespace of the element
* \return The first child element with the specified name and namespace
*/
- (OFXMLElement*)elementForName: (OFString*)elementName
namespace: (OFString*)elementNS;

/**
* \brief Returns the child elements with the specified name and namespace.
*
* \param elementName The name of the elements
* \param elementNS The namespace of the elements
* \return The child elements with the specified name and namespace
*/
- (OFArray*)elementsForName: (OFString*)elementName
namespace: (OFString*)elementNS;
@end

#import "OFXMLElement+Serialization.h"
Something went wrong with that request. Please try again.