CBLView+Internal.h

//
//  CBLView+Internal.h
//  CouchbaseLite
//
//  Created by Jens Alfke on 12/8/11.
//  Copyright (c) 2011-2013 Couchbase, Inc. All rights reserved.
//

#import <Foundation/Foundation.h>
#import "CBLDatabase+Internal.h"
#import "CBLView.h"
#import "CBLQuery.h"
#import "CBL_ViewStorage.h"
@class CBForestMapReduceIndex;


extern NSString* const kCBLViewChangeNotification;

typedef enum {
    kCBLViewCollationUnicode,
    kCBLViewCollationRaw,
    kCBLViewCollationASCII
} CBLViewCollation;


BOOL CBLQueryRowValueIsEntireDoc(id value);


@interface CBLView () <CBL_ViewStorageDelegate>
{
    @private
    CBLDatabase* __weak _weakDB;
    id<CBL_ViewStorage> _storage;
    NSString* _name;
}

- (instancetype) initWithDatabase: (CBLDatabase*)db name: (NSString*)name create: (BOOL)create;

- (void) close;

/** Current total rows in the view. The index will not be updated when accessing this property. */
@property (readonly) NSUInteger currentTotalRows;

/** The map block alredy registered with the view. Unlike the public .mapBlock property, this
    will not look for a design document or compile a function therein. */
@property (readonly) CBLMapBlock registeredMapBlock;

@property (readonly) SequenceNumber lastSequenceChangedAt;

@property (readonly) id<CBL_ViewStorage> storage;

@property (nonatomic) CBLViewCollation collation;

@property (readonly) NSArray* viewsInGroup;

@property (nonatomic) BOOL isDesignDoc;

/** Updates the view's index (incrementally) if necessary.
    If the index is updated, the other views in the viewGroup will be updated as a bonus.
    @return  200 if updated, 304 if already up-to-date, else an error code */
- (CBLStatus) _updateIndex;

/** Updates the view's index (incrementally) if necessary. No other groups will be updated.
    @return  200 if updated, 304 if already up-to-date, else an error code */
- (CBLStatus) updateIndexAlone;

- (CBLStatus) updateIndexes: (NSArray*)views;

#if DEBUG  // for unit tests only
- (void) forgetMapBlock;
#endif

@end


@interface CBLView (Querying)

/** Queries the view. Does NOT first update the index. */
- (CBLQueryEnumerator*) _queryWithOptions: (CBLQueryOptions*)options
                                   status: (CBLStatus*)outStatus;

@end


@interface CBLQueryEnumerator ()
- (instancetype) initWithSequenceNumber: (SequenceNumber)sequenceNumber
                                   rows: (NSArray*)rows;
- (instancetype) initWithDatabase: (CBLDatabase*)database
                             view: (CBLView*)view
                   sequenceNumber: (SequenceNumber)sequenceNumber
                             rows: (NSArray*)rows;
- (void) setDatabase: (CBLDatabase*)database
                view: (CBLView*)view;
- (CBLQueryRow*) generateNextRow;
- (void) sortUsingDescriptors: (NSArray*)sortDescriptors
                         skip: (NSUInteger)skip
                        limit: (NSUInteger)limit;
@end


@interface CBLQueryRow ()
- (void) moveToDatabase: (CBLDatabase*)database view: (CBLView*)view;
- (void) _clearDatabase;
@end