• SSYRSSParserClass is "done" now.

Author: jerrykrinock

SSYRSSParser.h

@@ -6,9 +6,9 @@ extern NSString* const SSYRSSParserErrorDomain ;
 /*!
  @brief    A class for parsing RSS feeds
  
- @detail   I made this as a pretty much drop-in replacement for Brent Simmons'
- 'RSS' class which he published in year 2002, and which was based on the
- now-deprecated CFXMLParser.  This class is based on NSXMLParser instead.
+ @detail   I made this to replace Brent Simmons' 'RSS' class which he published
+ in year 2002, and which was based on the now-deprecated CFXMLParser.  This
+ class is based on NSXMLParser instead.
  */
 @interface SSYRSSParser : NSObject <NSXMLParserDelegate> {
     NSData* m_data ;
@@ -23,13 +23,37 @@ extern NSString* const SSYRSSParserErrorDomain ;
 
 /*!
  @brief    Designated initializer for SSYRSS class
- 
- @detail   Synchronously parses .
  */
-- (SSYRSSParser*)initWithData:(NSData*)data
-                      error_p:(NSError**)error ;
+- (SSYRSSParser*)initWithData:(NSData*)data ;
+
+/*!
+ @brief    Synchronously parses the data
+ @details  You must invoke this method prior to -headerItems, -newsItems or
+ -version in order for the latter methods to give expected results.
+ @param    error_p  If result is NO, upon return, will point to an NSError
+ explaining the problem.
+ @result   YES if data was successfully parsed; otherwise NO
+ */
+- (BOOL)parseError_p:(NSError**)error ;
+
+/*!
+ @brief    Returns the element keys and values parsed from the header of the
+ receiver's data
+ @details  Will return nil if -parseError_p: has not run successfully.
+ */
 - (NSMutableDictionary*)headerItems ;
+
+/*!
+ @brief    Returns the news items parsed from the receiver's data.  Each item is
+ a dictionary containing the item's element keys and values.
+ @details  Will return nil if -parseError_p: has not run successfully.
+ */
 - (NSMutableArray*)newsItems ;
+
+/*!
+ @brief    Returns the version parsed from the RSS (not the version of the XML)
+ @details  Will return nil if -parseError_p: has not run successfully.
+ */
 - (NSString*)version ;
 
 @end
@@ -77,17 +101,25 @@ extern NSString* const SSYRSSParserErrorDomain ;
 
 + (void)test {
     NSError* error ;
-    SSYRSSParser* parser = [[SSYRSSParser alloc] initWithData:[self testData]
-                                                      error_p:&error] ;
-    printf("*** Parsed version: %s\n", [[[parser version] description] UTF8String]) ;
-    printf("*** Parsed header items:\n%s\n", [[[parser headerItems] description] UTF8String]) ;
-    printf("*** Parsed news items:\n%s\n", [[[parser newsItems] description] UTF8String]) ;
+    SSYRSSParser* parser = [[SSYRSSParser alloc] initWithData:[self testData]] ;
+    BOOL ok = [parser parseError_p:&error] ;
+    NSString* judgment = ok ? @"succeeded" : @"failed" ;
+    printf("*** Parser %s with error: %s\n",
+           [judgment UTF8String],
+           [[error description] UTF8String]) ;
+    printf("*** Parsed version: %s\n",
+           [[[parser version] description] UTF8String]) ;
+    printf("*** Parsed header items:\n%s\n",
+           [[[parser headerItems] description] UTF8String]) ;
+    printf("*** Parsed news items:\n%s\n",
+           [[[parser newsItems] description] UTF8String]) ;
     [parser release] ;
 }
 
 #if 0
 ***** Expected result from +test : *****
 ********************************************************************************
+*** Parser succeeded with error: (null)
 *** Parsed version: 2.02
 *** Parsed header items:
 {

SSYRSSParser.m

@@ -29,8 +29,7 @@ @implementation SSYRSSParser
 @synthesize currentElementValue = m_currentElementValue ;
 @synthesize currentItem = m_currentItem ;
 
-- (SSYRSSParser*)initWithData:(NSData*)data
-                      error_p:(NSError**)error_p {
+- (SSYRSSParser*)initWithData:(NSData*)data {
     if (data) {
         self = [super init] ;
 
@@ -58,26 +57,30 @@ - (SSYRSSParser*)initWithData:(NSData*)data
             object = [[NSMutableDictionary alloc] init] ;
             [self setCurrentItem:object] ;
             [object release] ;
-            
-            NSXMLParser* parser = [[NSXMLParser alloc] initWithData:data] ;
-            [parser setDelegate:self] ;
-            [parser setShouldResolveExternalEntities:YES] ;
-            [parser parse] ;
-            [parser release] ;
-            
-            if ([self error]) {
-                [self release] ;
-                self = nil ;
-                if (error_p) {
-                    *error_p = [self error] ;
-                }
-            }
         }
     }
 
     return self ;
 }
 
+- (BOOL)parseError_p:(NSError**)error_p {
+    BOOL ok = YES ;
+    NSXMLParser* parser = [[NSXMLParser alloc] initWithData:[self data]] ;
+    [parser setDelegate:self] ;
+    [parser setShouldResolveExternalEntities:YES] ;
+    [parser parse] ;
+    [parser release] ;
+    
+    if ([self error]) {
+        ok = NO ;
+        if (error_p) {
+            *error_p = [self error] ;
+        }
+    }
+    
+    return ok ;
+}
+
 - (void) dealloc {
     [m_data release] ;
     [m_error release] ;