OFXMLElement.h

/*
 * Copyright (c) 2008-2026 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */

#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 OFStream;
@class OFString;
@class OFXMLAttribute;

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

@property (copy, nonatomic) OFString *name;

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

@property OF_NULLABLE_PROPERTY (readonly, nonatomic)
    OFArray OF_GENERIC(OFXMLAttribute *) *attributes;

@property OF_NULLABLE_PROPERTY (nonatomic, copy)
    OFArray OF_GENERIC(OFXMLNode *) *children;

@property (readonly, nonatomic) OFArray OF_GENERIC(OFXMLElement *) *elements;

+ (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;

+ (instancetype)elementWithStream: (OFStream *)stream;

- (instancetype)init OF_UNAVAILABLE;

- (instancetype)initWithName: (OFString *)name;

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

- (instancetype)initWithName: (OFString *)name
           namespace: (nullable OFString *)nameSpace
    OF_DESIGNATED_INITIALIZER;

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

- (instancetype)initWithElement: (OFXMLElement *)element;

- (instancetype)initWithXMLString: (OFString *)string;

- (instancetype)initWithStream: (OFStream *)stream;

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

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

- (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)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 *) *)
    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;

- (OFString *)XMLStringWithIndentation: (unsigned int)indentation;

- (OFString *)XMLStringWithDefaultNamespace: (OFString *)defaultNS
                indentation: (unsigned int)indentation;
@end

OF_ASSUME_NONNULL_END