/*
    Copyright (c) 2002, bDistributed.com, Inc.
    All rights reserved.

    Redistribution and use in source and binary forms, with or
    without modification, are permitted provided that the following
    conditions are met:

    *   Redistributions of source code must retain the above
        copyright notice, this list of conditions and the following
        disclaimer.
    
    *   Redistributions in binary form must reproduce the above
        copyright notice, this list of conditions and the following
        disclaimer in the documentation and/or other materials
        provided with the distribution.
    
    *   Neither the name of bDistributed.com, Inc. nor the names of
        its contributors may be used to endorse or promote products
        derived from this software without specific prior written
        permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
    CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
    LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
    OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
    OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
    TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
    OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
    OF SUCH DAMAGE.
*/

#import <Foundation/Foundation.h>

// Case-sensitive comparisons; work with any instance of an NSObject subclass

#define BDCompareAscending  @selector(compareAscending:)
#define BDCompareDescending @selector(compareDescending:)

// Case-insensitive comparisons; only work with NSString

#define BDCompareCaseInsensitiveAscending  @selector(compareCaseInsensitiveAscending:)
#define BDCompareCaseInsensitiveDescending @selector(compareCaseInsensitiveDescending:)

// For localized compares -- works on NSString - falls back to compare: if selector doesn't exist

#define BDCompareLocalizedAscending  @selector(compareLocalizedAscending:)
#define BDCompareLocalizedDescending @selector(compareLocalizedDescending:)

#define BDCompareLocalizedCaseInsensitiveAscending  @selector(compareLocalizedCaseInsensitiveAscending:)
#define BDCompareLocalizedCaseInsensitiveDescending @selector(compareLocalizedCaseInsensitiveDescending:)

@interface BDSortOrdering : NSObject <NSCoding>
{
    NSString *_key;
    SEL _selector;

	BOOL nilIsGreater; // usually a nil value means it is less than a non-nil value. This reverses that assumption.
}
@property (nonatomic) int type;
@property (nonatomic) BOOL nilIsGreater;

- (instancetype)init NS_UNAVAILABLE;
- (instancetype)initWithKey:(NSString *)key
         selector:(SEL)selector NS_DESIGNATED_INITIALIZER;


@property (NS_NONATOMIC_IOSONLY, readonly, copy) NSString *key;

@property (NS_NONATOMIC_IOSONLY, readonly) SEL selector;

+ (BDSortOrdering *)sortOrderingWithKey:(NSString *)key
                               selector:(SEL)selector;
+ (BDSortOrdering *)sortOrderingWithKey:(NSString *)key
                               selector:(SEL)selector
						   nilIsGreater:(BOOL)flag;

@property (NS_NONATOMIC_IOSONLY, getter=isAscending, readonly) BOOL ascending;
@property (NS_NONATOMIC_IOSONLY, getter=isCaseInsensitive, readonly) BOOL caseInsensitive;

- (BOOL)isEqualToSortOrdering:(BDSortOrdering *)aSortOrdering;

// NSCoding Protocol

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


@end


@interface NSObject (BDSortOrderingAdditions)
- (NSComparisonResult)compareAscending:(id)object;
- (NSComparisonResult)compareDescending:(id)object;
- (NSComparisonResult)compareCaseInsensitiveAscending:(id)object;
- (NSComparisonResult)compareCaseInsensitiveDescending:(id)object;

- (NSComparisonResult)compareLocalizedAscending:(id)object;
- (NSComparisonResult)compareLocalizedDescending:(id)object;
- (NSComparisonResult)compareLocalizedCaseInsensitiveAscending:(id)object;
- (NSComparisonResult)compareLocalizedCaseInsensitiveDescending:(id)object;



@end


@interface NSArray (BDSortOrderingAdditions)
- (NSArray *)sortedArrayUsingKeyOrderArray:(NSArray *)keyOrderArray;
@end


@interface NSMutableArray (BDSortOrderingAdditions)
- (void)sortUsingKeyOrderArray:(NSArray *)keyOrderArray;
- (NSUInteger)insertObject: (id)object usingKeyOrderArray: (NSArray*)keyOrderArray;
@end
