OFXMLElement.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
 *   Jonathan Schleifer <js@heap.zone>
 *
 * 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"

OF_ASSUME_NONNULL_BEGIN

@class OFArray OF_GENERIC(ObjectType);
@class OFMutableArray OF_GENERIC(ObjectType);
@class OFMutableDictionary OF_GENERIC(KeyType, ObjectType);
@class OFMutableString;
@class OFString;
@class OFXMLAttribute;

@interface OFXMLElement: OFXMLNode
{
    OFString *_name, *_Nullable _namespace, *_Nullable _defaultNamespace;
    OFMutableArray OF_GENERIC(OFXMLAttribute *) *_Nullable _attributes;
    OFMutableDictionary OF_GENERIC(OFString *, OFString *) *_Nullable
        _namespaces;
    OFMutableArray OF_GENERIC(OFXMLNode *) *_Nullable _children;
}

@property (nonatomic, copy) OFString *name;

#ifndef __cplusplus
@property OF_NULLABLE_PROPERTY (nonatomic, copy) OFString *namespace;
#else
@property OF_NULLABLE_PROPERTY (nonatomic, copy,
    getter=namespace, setter=setNamespace:) OFString *namespace_;
#endif

@property OF_NULLABLE_PROPERTY (nonatomic, copy) OFString *defaultNamespace;

+ (instancetype)elementWithName: (OFString *)name;

+ (instancetype)elementWithName: (OFString *)name
            stringValue: (nullable OFString *)stringValue;

+ (instancetype)elementWithName: (OFString *)name
              namespace: (nullable OFString *)namespace_;

+ (instancetype)elementWithName: (OFString *)name
              namespace: (nullable OFString *)namespace_
            stringValue: (nullable OFString *)stringValue;

+ (instancetype)elementWithElement: (OFXMLElement *)element;

+ (instancetype)elementWithXMLString: (OFString *)string;

#ifdef OF_HAVE_FILES

+ (instancetype)elementWithFile: (OFString *)path;
#endif

- init OF_UNAVAILABLE;

- initWithName: (OFString *)name;

- initWithName: (OFString *)name
   stringValue: (nullable OFString *)stringValue;

- initWithName: (OFString *)name
     namespace: (nullable OFString *)namespace_;

- initWithName: (OFString *)name
     namespace: (nullable OFString *)namespace_
   stringValue: (nullable OFString *)stringValue;

- initWithElement: (OFXMLElement *)element;

- initWithXMLString: (OFString *)string;

#ifdef OF_HAVE_FILES

- initWithFile: (OFString *)path;
#endif

- initWithSerialization: (OFXMLElement *)element;

- (void)setPrefix: (OFString *)prefix
     forNamespace: (OFString *)namespace_;

- (void)bindPrefix: (OFString *)prefix
      forNamespace: (OFString *)namespace_;

- (nullable OFArray OF_GENERIC(OFXMLAttribute *) *)attributes;

- (void)addAttribute: (OFXMLAttribute *)attribute;

- (void)addAttributeWithName: (OFString *)name
         stringValue: (OFString *)stringValue;

- (void)addAttributeWithName: (OFString *)name
           namespace: (nullable OFString *)namespace_
         stringValue: (OFString *)stringValue;

- (nullable OFXMLAttribute *)attributeForName: (OFString *)attributeName;

- (nullable OFXMLAttribute *)attributeForName: (OFString *)attributeName
                    namespace: (nullable OFString *)attributeNS;

- (void)removeAttributeForName: (OFString *)attributeName;

- (void)removeAttributeForName: (OFString *)attributeName
             namespace: (nullable OFString *)attributeNS;

- (void)setChildren: (nullable OFArray OF_GENERIC(OFXMLNode *) *)children;

- (nullable OFArray OF_GENERIC(OFXMLNode *) *)children;

- (void)addChild: (OFXMLNode *)child;

- (void)insertChild: (OFXMLNode *)child
        atIndex: (size_t)index;

- (void)insertChildren: (OFArray OF_GENERIC(OFXMLNode *) *)children
           atIndex: (size_t)index;

- (void)removeChild: (OFXMLNode *)child;

- (void)removeChildAtIndex: (size_t)index;
- (void)replaceChild: (OFXMLNode *)child
        withNode: (OFXMLNode *)node;

- (void)replaceChildAtIndex: (size_t)index
           withNode: (OFXMLNode *)node;

- (OFArray OF_GENERIC(OFXMLElement *) *)elements;

- (OFArray OF_GENERIC(OFXMLElement *) *)elementsForNamespace:
    (nullable OFString *)elementNS;

- (nullable OFXMLElement *)elementForName: (OFString *)elementName;

- (OFArray OF_GENERIC(OFXMLElement *) *)elementsForName:
    (OFString *)elementName;

- (nullable OFXMLElement *)elementForName: (OFString *)elementName
                namespace: (nullable OFString *)elementNS;

- (OFArray OF_GENERIC(OFXMLElement *) *)
    elementsForName: (OFString *)elementName
      namespace: (nullable OFString *)elementNS;
@end

OF_ASSUME_NONNULL_END

#import "OFXMLElement+Serialization.h"