OFXMLParser.h

/*
 * Copyright (c) 2008-2024 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 "OFString.h"
#import "OFXMLAttribute.h"
 
OF_ASSUME_NONNULL_BEGIN
 
@class OFArray OF_GENERIC(ObjectType);
@class OFMutableData;
@class OFMutableArray OF_GENERIC(ObjectType);
@class OFMutableDictionary OF_GENERIC(KeyType, ObjectType);
@class OFStream;
@class OFXMLParser;
 
@protocol OFXMLParserDelegate <OFObject>
@optional
-             (void)parser: (OFXMLParser *)parser
  foundProcessingInstructionWithTarget: (OFString *)target
                  text: (nullable OFString *)text;
 
-    (void)parser: (OFXMLParser *)parser
  didStartElement: (OFString *)name
       prefix: (nullable OFString *)prefix
    namespace: (nullable OFString *)nameSpace
       attributes: (nullable OFArray OF_GENERIC(OFXMLAttribute *) *)attributes;
 
-  (void)parser: (OFXMLParser *)parser
  didEndElement: (OFString *)name
     prefix: (nullable OFString *)prefix
      namespace: (nullable OFString *)nameSpace;
 
- (void)parser: (OFXMLParser *)parser foundCharacters: (OFString *)characters;
 
- (void)parser: (OFXMLParser *)parser foundCDATA: (OFString *)CDATA;
 
- (void)parser: (OFXMLParser *)parser foundComment: (OFString *)comment;
 
- (nullable OFString *)parser: (OFXMLParser *)parser
      foundUnknownEntityNamed: (OFString *)entity;
@end
 
OF_SUBCLASSING_RESTRICTED
@interface OFXMLParser: OFObject
{
    id <OFXMLParserDelegate> _Nullable _delegate;
    uint_least8_t _state;
    size_t _i, _last;
    const char *_Nullable _data;
    OFMutableData *_buffer;
    OFString *_Nullable _name, *_Nullable _prefix;
    OFMutableArray
        OF_GENERIC(OFMutableDictionary OF_GENERIC(OFString *, OFString *) *)
        *_namespaces;
    OFMutableArray OF_GENERIC(OFXMLAttribute *) *_attributes;
    OFString *_Nullable _attributeName, *_Nullable _attributePrefix;
    char _delimiter;
    OFMutableArray OF_GENERIC(OFString *) *_previous;
    size_t _level;
    bool _acceptProlog;
    size_t _lineNumber;
    bool _lastCarriageReturn, _finishedParsing;
    OFStringEncoding _encoding;
    size_t _depthLimit;
}
 
@property OF_NULLABLE_PROPERTY (assign, nonatomic)
    id <OFXMLParserDelegate> delegate;
 
@property (readonly, nonatomic) size_t lineNumber;
 
@property (readonly, nonatomic, getter=hasFinishedParsing) bool finishedParsing;
 
@property (nonatomic) size_t depthLimit;
 
+ (instancetype)parser;
 
- (void)parseBuffer: (const char *)buffer length: (size_t)length;
 
- (void)parseString: (OFString *)string;
 
- (void)parseStream: (OFStream *)stream;
@end
 
OF_ASSUME_NONNULL_END