src/OFXMLParser.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011
 *   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 OFStream;

#if defined(OF_HAVE_PROPERTIES) && defined(OF_HAVE_BLOCKS)
typedef void (^of_xml_parser_processing_instructions_block_t)(
    OFXMLParser *parser, OFString *pi);
typedef void (^of_xml_parser_element_start_block_t)(OFXMLParser *parser,
    OFString *name, OFString *prefix, OFString *ns, OFArray *attrs);
typedef void (^of_xml_parser_element_end_block_t)(OFXMLParser *parser,
    OFString *name, OFString *prefix, OFString *ns);
typedef void (^of_xml_parser_string_block_t)(OFXMLParser *parser,
    OFString *string);
typedef OFString* (^of_xml_parser_unknown_entity_block_t)(OFXMLParser *parser,
    OFString *entity);
#endif

#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*)attrs;

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

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

- (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;
        OFMutableString *cache;
        OFString *name;
        OFString *prefix;
        OFMutableArray *namespaces;
        OFMutableArray *attrs;
        OFString *attrName;
        OFString *attrPrefix;
        char delim;
        OFMutableArray *previous;
#if defined(OF_HAVE_PROPERTIES) && defined(OF_HAVE_BLOCKS)
        of_xml_parser_processing_instructions_block_t
            processingInstructionsHandler;
        of_xml_parser_element_start_block_t elementStartHandler;
        of_xml_parser_element_end_block_t elementEndHandler;
        of_xml_parser_string_block_t charactersHandler;
        of_xml_parser_string_block_t CDATAHandler;
        of_xml_parser_string_block_t commentHandler;
        of_xml_parser_unknown_entity_block_t unknownEntityHandler;
#endif
        size_t level;
        BOOL acceptProlog;
        size_t lineNumber;
        BOOL lastCarriageReturn;
        BOOL finishedParsing;
}

#ifdef OF_HAVE_PROPERTIES
@property (retain) id <OFXMLParserDelegate> delegate;
# ifdef OF_HAVE_BLOCKS
@property (copy) of_xml_parser_processing_instructions_block_t
    processingInstructionsHandler;
@property (copy) of_xml_parser_element_start_block_t elementStartHandler;
@property (copy) of_xml_parser_element_end_block_t elementEndHandler;
@property (copy) of_xml_parser_string_block_t charactersHandler;
@property (copy) of_xml_parser_string_block_t CDATAHandler;
@property (copy) of_xml_parser_string_block_t commentHandler;
@property (copy) of_xml_parser_unknown_entity_block_t unknownEntityHandler;
# endif
#endif

+ parser;

- (id <OFXMLParserDelegate>)delegate;

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

#if defined(OF_HAVE_PROPERTIES) && defined(OF_HAVE_BLOCKS)

- (of_xml_parser_processing_instructions_block_t)processingInstructionsHandler;

- (void)setProcessingInstructionsHandler:
    (of_xml_parser_processing_instructions_block_t)block;

- (of_xml_parser_element_start_block_t)elementStartHandler;

- (void)setElementStartHandler: (of_xml_parser_element_start_block_t)block;

- (of_xml_parser_element_end_block_t)elementEndHandler;

- (void)setElementEndHandler: (of_xml_parser_element_end_block_t)block;

- (of_xml_parser_string_block_t)charactersHandler;

- (void)setCharactersHandler: (of_xml_parser_string_block_t)block;

- (of_xml_parser_string_block_t)CDATAHandler;

- (void)setCDATAHandler: (of_xml_parser_string_block_t)block;

- (of_xml_parser_string_block_t)commentHandler;

- (void)setCommentHandler: (of_xml_parser_string_block_t)block;

- (of_xml_parser_unknown_entity_block_t)unknownEntityHandler;

- (void)setUnknownEntityHandler: (of_xml_parser_unknown_entity_block_t)block;
#endif

- (void)parseBuffer: (const char*)buf
           withSize: (size_t)size;

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

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

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

- (size_t)lineNumber;

- (BOOL)finishedParsing;
@end

@interface OFObject (OFXMLParserDelegate) <OFXMLParserDelegate>
@end