OFXMLParser.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012
 *   Jonathan Schleifer <js@webkeks.org>
 *
 * 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"

@class OFXMLParser;
@class OFArray;
@class OFMutableArray;
@class OFDataArray;
@class OFStream;

#ifndef OF_XML_PARSER_M
@protocol OFXMLParserDelegate <OFObject>
#else
@protocol OFXMLParserDelegate
#endif
#ifdef OF_HAVE_OPTIONAL_PROTOCOLS
@optional
#endif

-        (void)parser: (OFXMLParser*)parser
  foundProcessingInstructions: (OFString*)pi;

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

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

-    (void)parser: (OFXMLParser*)parser
  foundCharacters: (OFString*)characters;

- (void)parser: (OFXMLParser*)parser
    foundCDATA: (OFString*)CDATA;

- (void)parser: (OFXMLParser*)parser
  foundComment: (OFString*)comment;

-   (OFString*)parser: (OFXMLParser*)parser
  foundUnknownEntityNamed: (OFString*)entity;
@end

@interface OFXMLParser: OFObject <OFStringXMLUnescapingDelegate>
{
    id <OFXMLParserDelegate> delegate;
    enum {
        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_ATTR_NAME,
        OF_XMLPARSER_EXPECT_DELIM,
        OF_XMLPARSER_IN_ATTR_VALUE,
        OF_XMLPARSER_EXPECT_CLOSE,
        OF_XMLPARSER_EXPECT_SPACE_OR_CLOSE,
        OF_XMLPARSER_IN_EXCLAMATIONMARK,
        OF_XMLPARSER_IN_CDATA_OPENING,
        OF_XMLPARSER_IN_CDATA_1,
        OF_XMLPARSER_IN_CDATA_2,
        OF_XMLPARSER_IN_COMMENT_OPENING,
        OF_XMLPARSER_IN_COMMENT_1,
        OF_XMLPARSER_IN_COMMENT_2,
        OF_XMLPARSER_IN_DOCTYPE,
        OF_XMLPARSER_NUM_STATES
    } state;
    OFDataArray *cache;
    OFString *name;
    OFString *prefix;
    OFMutableArray *namespaces;
    OFMutableArray *attributes;
    OFString *attributeName;
    OFString *attributePrefix;
    char delimiter;
    OFMutableArray *previous;
    size_t level;
    BOOL acceptProlog;
    size_t lineNumber;
    BOOL lastCarriageReturn;
    BOOL finishedParsing;
    of_string_encoding_t encoding;
}

#ifdef OF_HAVE_PROPERTIES
@property (assign) id <OFXMLParserDelegate> delegate;
#endif

+ (instancetype)parser;

- (id <OFXMLParserDelegate>)delegate;

- (void)setDelegate: (id <OFXMLParserDelegate>)delegate;

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

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

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

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

- (size_t)lineNumber;

- (BOOL)finishedParsing;
@end

@interface OFObject (OFXMLParserDelegate) <OFXMLParserDelegate>
@end