OFXMLElementBuilder.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 "OFObject.h"
#import "OFXMLParser.h"
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFMutableArray OF_GENERIC(ObjectType);
@class OFXMLElement;
@class OFXMLElementBuilder;

@protocol OFXMLElementBuilderDelegate <OFObject>
- (void)elementBuilder: (OFXMLElementBuilder *)builder
       didBuildElement: (OFXMLElement *)element;
 
@optional
- (void)elementBuilder: (OFXMLElementBuilder *)builder
    didBuildOrphanNode: (OFXMLNode *)node;

- (void)elementBuilder: (OFXMLElementBuilder *)builder
  didNotExpectCloseTag: (OFString *)name
        prefix: (nullable OFString *)prefix
         namespace: (nullable OFString *)nameSpace;

- (OFString *)elementBuilder: (OFXMLElementBuilder *)builder
     foundUnknownEntityNamed: (OFString *)entity;
@end

@interface OFXMLElementBuilder: OFObject <OFXMLParserDelegate>
{
    OFMutableArray OF_GENERIC(OFXMLElement *) *_stack;
    id <OFXMLElementBuilderDelegate> _Nullable _delegate;
    OF_RESERVE_IVARS(OFXMLElementBuilder, 4)
}

@property OF_NULLABLE_PROPERTY (assign, nonatomic)
    id <OFXMLElementBuilderDelegate> delegate;

+ (instancetype)builder;
@end
 
OF_ASSUME_NONNULL_END