OFXMLParser.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 "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
  foundProcessingInstructions: (OFString *)pi;

-    (void)parser: (OFXMLParser *)parser
  didStartElement: (OFString *)name
       prefix: (nullable OFString *)prefix
    namespace: (nullable OFString *)ns
       attributes: (nullable OFArray OF_GENERIC(OFXMLAttribute *) *)attributes;

-  (void)parser: (OFXMLParser *)parser
  didEndElement: (OFString *)name
     prefix: (nullable OFString *)prefix
      namespace: (nullable OFString *)ns;

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

@interface OFXMLParser: OFObject <OFStringXMLUnescapingDelegate>
{
    id <OFXMLParserDelegate> _Nullable _delegate;
    enum of_xml_parser_state {
        OF_XMLPARSER_IN_BYTE_ORDER_MARK,
        OF_XMLPARSER_OUTSIDE_TAG,
        OF_XMLPARSER_TAG_OPENED,
        OF_XMLPARSER_IN_PROCESSING_INSTRUCTIONS,
        OF_XMLPARSER_IN_TAG_NAME,
        OF_XMLPARSER_IN_CLOSE_TAG_NAME,
        OF_XMLPARSER_IN_TAG,
        OF_XMLPARSER_IN_ATTRIBUTE_NAME,
        OF_XMLPARSER_EXPECT_ATTRIBUTE_EQUAL_SIGN,
        OF_XMLPARSER_EXPECT_ATTRIBUTE_DELIMITER,
        OF_XMLPARSER_IN_ATTRIBUTE_VALUE,
        OF_XMLPARSER_EXPECT_TAG_CLOSE,
        OF_XMLPARSER_EXPECT_SPACE_OR_TAG_CLOSE,
        OF_XMLPARSER_IN_EXCLAMATIONMARK,
        OF_XMLPARSER_IN_CDATA_OPENING,
        OF_XMLPARSER_IN_CDATA,
        OF_XMLPARSER_IN_COMMENT_OPENING,
        OF_XMLPARSER_IN_COMMENT_1,
        OF_XMLPARSER_IN_COMMENT_2,
        OF_XMLPARSER_IN_DOCTYPE,
        OF_XMLPARSER_NUM_STATES
    } _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;
    of_string_encoding_t _encoding;
    size_t _depthLimit;
}

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

@property (nonatomic) size_t depthLimit;

+ (instancetype)parser;

- (void)parseBuffer: (const char *)buffer
         length: (size_t)length;

- (void)parseString: (OFString *)string;

- (void)parseStream: (OFStream *)stream;

#ifdef OF_HAVE_FILES

- (void)parseFile: (OFString *)path;
#endif

- (size_t)lineNumber;

- (bool)hasFinishedParsing;
@end

OF_ASSUME_NONNULL_END