/*
* Copyright (c) 2008, 2009, 2010, 2011
* 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 "OFObject.h"
#import "OFSerialization.h"
#import "OFXMLAttribute.h"
@class OFString;
@class OFArray;
@class OFMutableString;
@class OFMutableArray;
@class OFMutableDictionary;
/**
* \brief A class which stores an XML element.
*/
@interface OFXMLElement: OFObject <OFCopying, OFSerialization>
{
OFString *name;
OFString *ns;
OFString *defaultNamespace;
OFMutableArray *attributes;
OFMutableDictionary *namespaces;
OFMutableArray *children;
OFString *characters;
OFString *CDATA;
OFString *comment;
}
#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 characters.
*
* \param characters The characters the element represents
* \return A new autoreleased OFXMLElement consisting of the specified
* characters
*/
+ elementWithCharacters: (OFString*)characters;
/**
* \brief Creates a new element with the specified CDATA.
*
* \param CDATA The CDATA the element represents
* \return A new autoreleased OFXMLElement consisting of the specified CDATA
*/
+ elementWithCDATA: (OFString*)CDATA;
/**
* \brief Creates a new element with the specified comment.
*
* \param comment The comment the element represents
* \return A new autoreleased OFXMLElement consisting of the specified comment
*/
+ elementWithComment: (OFString*)comment;
/**
* \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
* characters.
*
* \param characters The characters the element represents
* \return An initialized OFXMLElement consisting of the specified characters
*/
- initWithCharacters: (OFString*)characters;
/**
* \brief Initializes an already allocated OFXMLElement with the specified
* CDATA.
*
* \param CDATA The CDATA the element represents
* \return An initialized OFXMLElement consisting of the specified CDATA
*/
- initWithCDATA: (OFString*)CDATA;
/**
* \brief Initializes an already allocated OFXMLElement with the specified
* comment.
*
* \param comment The comment the element represents
* \return An initialized OFXMLElement consisting of the specified comment
*/
- initWithComment: (OFString*)comment;
/**
* \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 with all children of the element.
*
* \return An array 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 Returns a string with the string value of all children concatenated.
*
* \return A string with the string value of all children concatenated
*/
- (OFString*)stringValue;
/**
* \brief Returns an integer with the decimal value of all children
* concatenated.
*
* \return An integer with the decimal value of all children concatenated
*/
- (intmax_t)decimalValue;
/**
* \brief Returns an integer with the hexadecimal value of all children
* concatenated.
*
* \return An integer with the hexadecimal value of all children concatenated
*/
- (uintmax_t)hexadecimalValue;
/**
* \brief Returns a float with the float value of all children concatenated.
*
* \return A float with the float value of all children concatenated
*/
- (float)floatValue;
/**
* \brief Returns a double with the double value of all children concatenated.
*
* \return A double with the double value of all children concatenated
*/
- (double)doubleValue;
/**
* \brief Returns an OFString representing the OFXMLElement as an XML string.
*
* \return An OFString representing the OFXMLElement as an XML string
*/
- (OFString*)XMLString;
/**
* \brief Returns an OFString representing the OFXMLElement as an XML string
* with indentation.
*
* \param indentation The indentation for the XML string
* \return An OFString representing the OFXMLElement as an XML string with
* indentation
*/
- (OFString*)XMLStringWithIndentation: (unsigned int)indentation;
/**
* \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 Another OFXMLElement which is added as a child
*/
- (void)addChild: (OFXMLElement*)child;
/**
* \brief Removes the first child that is equal to the specified OFXMLElement.
*
* \param child The child to remove from the OFXMLElement
*/
- (void)removeChild: (OFXMLElement*)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"