RSSFeed.h

/*  -*-objc-*-
 *
 *  GNUstep RSS Kit
 *  Copyright (C) 2006 Guenther Noack
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2 as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#import <objc/objc.h>
#import <Foundation/Foundation.h>

@class RSSFeed;


#import "RSSArticle.h"

enum RSSFeedError
  {
    RSSFeedErrorNoError = 0,         
    RSSFeedErrorNoFetcherError,      
    RSSFeedErrorMalformedURL,        
    RSSFeedErrorDomainNotKnown,      
    RSSFeedErrorServerNotReachable,  
    RSSFeedErrorDocumentNotPresent,  
    RSSFeedErrorMalformedRSS         
  };

enum RSSFeedStatus
  {
    RSSFeedIsFetching,
    RSSFeedIsIdle
  };

@protocol RSSFeedDelegate;

@interface RSSFeed : NSObject <NSCoding>
{
@protected
  NSDate*           lastRetrieval;
  BOOL              clearFeedBeforeFetching;
  NSArray*          articles;
  enum RSSFeedError lastError;
  NSString*         feedName;
  NSURL*            feedURL;
  Class             articleClass;
  
  enum RSSFeedStatus status;
  NSRecursiveLock*  lock;
  
  id<RSSFeedDelegate> _delegate;
}


+feed;
+feedWithURL: (NSURL*) aURL;

-init;

-initWithURL: (NSURL*) aURL;


-(NSString*) description;

// ----------------------------------------------------------------------
// The RSSFeed's delegate
// ----------------------------------------------------------------------

-(void)setDelegate: (id<RSSFeedDelegate>)aDelegate;
-(id<RSSFeedDelegate>)delegate;

// ----------------------------------------------------------------------
// NSCoding methods
// ----------------------------------------------------------------------

-(id)initWithCoder: (NSCoder*)coder;
-(void)encodeWithCoder: (NSCoder*)coder;


// ----------------------------------------------------------------------
// Status access
// ----------------------------------------------------------------------

- (enum RSSFeedStatus) status;


// ----------------------------------------------------------------------
// Access to the articles
// ----------------------------------------------------------------------

- (RSSArticle*) articleAtIndex: (int) index;

- (unsigned int) count;

- (NSEnumerator*) articleEnumerator;

- (void) removeArticle: (RSSArticle*) article;



// ----------------------------------------------------------------------
// Access to the preferences
// ----------------------------------------------------------------------

- (NSString*) feedName;

- (NSURL*) feedURL;



// --------------------------------------------------------------------
// Equality and hash codes
// --------------------------------------------------------------------
- (unsigned) hash;
- (BOOL) isEqual: (id)anObject;


// --------------------------------------------------------------------
// Accessor and Mutator for the automatic clearing
// --------------------------------------------------------------------

- (void) setAutoClear: (BOOL) autoClear;


- (BOOL) autoClear;


- (void) clearArticles;



// ------------------------------------------------------------------
// Extensions that make subclassing RSSFeed and RSSArticle easier.
// ------------------------------------------------------------------

-(void) setArticleClass:(Class)aClass;

-(Class) articleClass;


// ------------------------------------------------------------------
// Dirtyness, now implemented via the date of last retrieval
// ------------------------------------------------------------------

-(NSDate*) lastRetrieval;


-(void) newArticleFound: (RSSArticle*) anArticle;

@end



/*
 * FIXME: Hide this interface in some other header file
 * so that programmers don't get confused.
 */

@interface RSSFeed (Private)

-(BOOL) _submitArticles: (NSArray*) newArticles;

@end


@protocol RSSFeedDelegate <NSObject>

- (void) feed: (RSSFeed*) aFeed
 addedArticle: (RSSArticle*) anArticle;

@end

---