//
//  OCHamcrest - HCIsDictionaryContainingEntries.h
//  Copyright 2013 hamcrest.org. See LICENSE.txt
//
//  Created by: Jon Reid, http://qualitycoding.org/
//  Docs: http://hamcrest.github.com/OCHamcrest/
//  Source: https://github.com/hamcrest/OCHamcrest
//

#import <OCHamcrestIOS/HCBaseMatcher.h>


@interface HCIsDictionaryContainingEntries : HCBaseMatcher
{
    NSArray *keys;
    NSArray *valueMatchers;
}

+ (instancetype)isDictionaryContainingKeys:(NSArray *)theKeys
                             valueMatchers:(NSArray *)theValueMatchers;

- (instancetype)initWithKeys:(NSArray *)theKeys
               valueMatchers:(NSArray *)theValueMatchers;

@end


OBJC_EXPORT id<HCMatcher> HC_hasEntries(id keysAndValueMatch, ...) NS_REQUIRES_NIL_TERMINATION;

/**
    hasEntries(firstKey, valueMatcher, ...) -
    Matches if dictionary contains entries satisfying a list of alternating keys and their value
    matchers.
    
    @param firstKey  A key (not a matcher) to look up.
    @param valueMatcher,...  The matcher to satisfy for the value, or an expected value for @ref equalTo matching.
    
    Note that the keys must be actual keys, not matchers. Any value argument that is not a matcher
    is implicitly wrapped in an @ref equalTo matcher to check for equality. The list must end with
    @c nil.

    Examples:
    @li @ref hasEntries(@"first", equalTo(@"Jon"), @"last", equalTo(@"Reid"), nil)
    @li @ref hasEntries(@"first", @"Jon", @"last", @"Reid", nil)
    
    (In the event of a name clash, don't \#define @c HC_SHORTHAND and use the synonym
    @c HC_hasEntry instead.)

    @ingroup collection_matchers
 */
#ifdef HC_SHORTHAND
    #define hasEntries HC_hasEntries
#endif