Public Member Functions | Static Public Member Functions | Protected Types | Protected Attributes | Properties

OFXMLParser Class Reference

An event-based XML parser. More...

#import <OFXMLParser.h>

Inheritance diagram for OFXMLParser:
OFObject <OFStringXMLUnescapingDelegate> <OFObject> <OFObject>

List of all members.

Public Member Functions

(id< OFXMLParserDelegate >) - delegate
(void) - setDelegate:
(of_xml_parser_processing_instructions_block_t) - processingInstructionsHandler
(void) - setProcessingInstructionsHandler:
(of_xml_parser_element_start_block_t) - elementStartHandler
(void) - setElementStartHandler:
(of_xml_parser_element_end_block_t) - elementEndHandler
(void) - setElementEndHandler:
(of_xml_parser_string_block_t) - charactersHandler
(void) - setCharactersHandler:
(of_xml_parser_string_block_t) - CDATAHandler
(void) - setCDATAHandler:
(of_xml_parser_string_block_t) - commentHandler
(void) - setCommentHandler:
(of_xml_parser_unknown_entity_block_t) - unknownEntityHandler
(void) - setUnknownEntityHandler:
(void) - parseBuffer:withSize:
(void) - parseString:
(void) - parseStream:
(void) - parseFile:
(size_t) - lineNumber
(BOOL) - finishedParsing

Static Public Member Functions

(id) + parser

Protected Types

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
}

Protected Attributes

enum OFXMLParser:: { ... }  state
OFMutableStringcache
OFStringname
OFStringprefix
OFMutableArraynamespaces
OFMutableArrayattrs
OFStringattrName
OFStringattrPrefix
char delim
OFMutableArrayprevious
size_t level
BOOL acceptProlog
size_t lineNumber
BOOL lastCarriageReturn
BOOL finishedParsing

Properties

id< OFXMLParserDelegatedelegate
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

Detailed Description

An event-based XML parser.

OFXMLParser is an event-based XML parser which calls the delegate's callbacks as soon asit finds something, thus suitable for streams as well.


Member Function Documentation

- (of_xml_parser_string_block_t) CDATAHandler  
Returns:
The CDATA handler
- (of_xml_parser_string_block_t) charactersHandler  
Returns:
The characters handler
- (of_xml_parser_string_block_t) commentHandler  
Returns:
The comment handler
- (id <OFXMLParserDelegate>) delegate  
Returns:
The delegate that is used by the XML parser
- (of_xml_parser_element_end_block_t) elementEndHandler  
Returns:
The element end handler
- (of_xml_parser_element_start_block_t) elementStartHandler  
Returns:
The element start handler
- (BOOL) finishedParsing  
Returns:
Whether the XML parser has finished parsing
- (size_t) lineNumber  
Returns:
The current line number
- (void) parseBuffer: (const char*)  buf
withSize: (size_t)  size 

Parses a buffer with the specified size.

Parameters:
buf The buffer to parse
size The size of the buffer
- (void) parseFile: (OFString*)  path  

Parses the specified file.

Parameters:
path The path to the file to parse
+ (id) parser  
Returns:
A new, autoreleased OFXMLParser
- (void) parseStream: (OFStream*)  stream  

Parses the specified stream.

Parameters:
stream The stream to parse
- (void) parseString: (OFString*)  str  

Parses the specified string.

Parameters:
str The string to parse
- (of_xml_parser_processing_instructions_block_t) processingInstructionsHandler  
Returns:
The processing instructions handler
- (void) setCDATAHandler: (of_xml_parser_string_block_t)  block  

Sets the CDATA handler.

Parameters:
block A CDATA handler
- (void) setCharactersHandler: (of_xml_parser_string_block_t)  block  

Sets the characters handler.

Parameters:
block A characters handler
- (void) setCommentHandler: (of_xml_parser_string_block_t)  block  

Sets the comment handler.

Parameters:
block A comment handler
- (void) setDelegate: (id <OFXMLParserDelegate>)  delegate  

Sets the delegate the OFXMLParser should use.

Parameters:
delegate The delegate to use
- (void) setElementEndHandler: (of_xml_parser_element_end_block_t)  block  

Sets the element end handler.

Parameters:
block An element end handler
- (void) setElementStartHandler: (of_xml_parser_element_start_block_t)  block  

Sets the element start handler.

Parameters:
block An element start handler
- (void) setProcessingInstructionsHandler: (of_xml_parser_processing_instructions_block_t)  block  

Sets the processing instructions handler.

Parameters:
block A processing instructions handler
- (void) setUnknownEntityHandler: (of_xml_parser_unknown_entity_block_t)  block  

Sets the unknown entity handler.

Parameters:
block An unknown entity handler
- (of_xml_parser_unknown_entity_block_t) unknownEntityHandler  
Returns:
The unknown entity handler

The documentation for this class was generated from the following files:
 All Classes Functions Variables