Annotate nullability

Source/Core/HCAssertThat.h

@@ -5,6 +5,8 @@
 
 @protocol HCMatcher;
 
+NS_ASSUME_NONNULL_BEGIN
+
 /*!
  * @header
  * Assertion macros for using matchers in testing frameworks.
@@ -38,7 +40,7 @@ FOUNDATION_EXPORT void HC_assertThatWithLocation(id testCase, id actual, id <HCM
 #endif
 
 
-typedef id (^HCFutureValue)();
+typedef _Nonnull id (^HCFutureValue)();
 
 FOUNDATION_EXPORT void HC_assertWithTimeoutAndLocation(id testCase, NSTimeInterval timeout,
         HCFutureValue actualBlock, id <HCMatcher> matcher,
@@ -90,3 +92,5 @@ FOUNDATION_EXPORT void HC_assertWithTimeoutAndLocation(id testCase, NSTimeInterv
  * @discussion Helper function to let you describe mismatches the way <tt>assertThat</tt> does.
  */
 FOUNDATION_EXPORT NSString *HCDescribeMismatch(id <HCMatcher> matcher, id actual);
+
+NS_ASSUME_NONNULL_END

Source/Core/HCBaseDescription.h

@@ -5,6 +5,8 @@
 #import <OCHamcrest/HCDescription.h>
 
 
+NS_ASSUME_NONNULL_BEGIN
+
 /*!
  * @abstract Base class for all HCDescription implementations.
  */
@@ -23,3 +25,5 @@
 - (void)append:(NSString *)str;
 
 @end
+
+NS_ASSUME_NONNULL_END

Source/Core/HCBaseDescription.m

@@ -14,7 +14,7 @@ @implementation HCBaseDescription
     return self;
 }
 
-- (id <HCDescription>)appendDescriptionOf:(id)value
+- (id <HCDescription>)appendDescriptionOf:(nullable id)value
 {
     if (value == nil)
         [self append:@"nil"];

Source/Core/HCBaseMatcher.h

@@ -7,6 +7,8 @@
 #define HC_ABSTRACT_METHOD [self subclassResponsibility:_cmd]
 
 
+NS_ASSUME_NONNULL_BEGIN
+
 /*!
  * @abstract Base class for all HCMatcher implementations.
  * @discussion Simple matchers can just subclass HCBaseMatcher and implement <code>-matches:</code>
@@ -19,3 +21,5 @@
 - (void)subclassResponsibility:(SEL)command;
 
 @end
+
+NS_ASSUME_NONNULL_END

Source/Core/HCBaseMatcher.m

@@ -13,21 +13,21 @@ - (NSString *)description
     return [HCStringDescription stringFrom:self];
 }
 
-- (BOOL)matches:(id)item
+- (BOOL)matches:(nullable id)item
 {
     HC_ABSTRACT_METHOD;
     return NO;
 }
 
-- (BOOL)matches:(id)item describingMismatchTo:(id <HCDescription>)mismatchDescription
+- (BOOL)matches:(nullable id)item describingMismatchTo:(id <HCDescription>)mismatchDescription
 {
     BOOL matchResult = [self matches:item];
     if (!matchResult)
         [self describeMismatchOf:item to:mismatchDescription];
     return matchResult;
 }
 
-- (void)describeMismatchOf:(id)item to:(id <HCDescription>)mismatchDescription
+- (void)describeMismatchOf:(nullable id)item to:(nullable id <HCDescription>)mismatchDescription
 {
     [[mismatchDescription appendText:@"was "] appendDescriptionOf:item];
 }

Source/Core/HCDescription.h

@@ -4,6 +4,8 @@
 #import <Foundation/Foundation.h>
 
 
+NS_ASSUME_NONNULL_BEGIN
+
 /*!
  * @abstract A description of an HCMatcher.
  * @discussion An HCMatcher will describe itself to a description which can later be used for reporting.
@@ -21,7 +23,7 @@
  * @discussion If the value implements the HCSelfDescribing protocol, then it will be used.
  * @return <code>self</code>, for chaining.
  */
-- (id <HCDescription>)appendDescriptionOf:(id)value;
+- (id <HCDescription>)appendDescriptionOf:(nullable id)value;
 
 /*!
  * @abstract Appends a list of objects to the description.
@@ -33,3 +35,5 @@
                             end:(NSString *)end;
 
 @end
+
+NS_ASSUME_NONNULL_END

Source/Core/HCDiagnosingMatcher.h

@@ -4,6 +4,8 @@
 #import <OCHamcrest/HCBaseMatcher.h>
 
 
+NS_ASSUME_NONNULL_BEGIN
+
 /*!
  * @abstract Base class for matchers that generate mismatch descriptions during the matching.
  * @discussion Some matching algorithms have several "no match" paths. It helps to make the mismatch
@@ -13,3 +15,5 @@
 */
 @interface HCDiagnosingMatcher : HCBaseMatcher
 @end
+
+NS_ASSUME_NONNULL_END

Source/Core/HCDiagnosingMatcher.m

@@ -6,18 +6,18 @@
 
 @implementation HCDiagnosingMatcher
 
-- (BOOL)matches:(id)item
+- (BOOL)matches:(nullable id)item
 {
     return [self matches:item describingMismatchTo:nil];
 }
 
-- (BOOL)matches:(id)item describingMismatchTo:(id <HCDescription>)mismatchDescription
+- (BOOL)matches:(nullable id)item describingMismatchTo:(id <HCDescription>)mismatchDescription
 {
     HC_ABSTRACT_METHOD;
     return NO;
 }
 
-- (void)describeMismatchOf:(id)item to:(id <HCDescription>)mismatchDescription
+- (void)describeMismatchOf:(nullable id)item to:(nullable id <HCDescription>)mismatchDescription
 {
     [self matches:item describingMismatchTo:mismatchDescription];
 }

Source/Core/HCMatcher.h

@@ -4,6 +4,8 @@
 #import "HCSelfDescribing.h"
 
 
+NS_ASSUME_NONNULL_BEGIN
+
 /*!
  * @abstract A matcher over acceptable values.
  * @discussion A matcher is able to describe itself to give feedback when it fails.
@@ -19,15 +21,15 @@
  * @param item  The object against which the matcher is evaluated.
  * @return <code>YES</code> if item matches, otherwise <code>NO</code>.
  */
-- (BOOL)matches:(id)item;
+- (BOOL)matches:(nullable id)item;
 
 /*!
  * @abstract Evaluates the matcher for argument item.
  * @param item The object against which the matcher is evaluated.
  * @param mismatchDescription The description to be built or appended to if item does not match.
  * @return <code>YES</code> if item matches, otherwise <code>NO</code>.
  */
-- (BOOL)matches:(id)item describingMismatchTo:(id <HCDescription>)mismatchDescription;
+- (BOOL)matches:(nullable id)item describingMismatchTo:(nullable id <HCDescription>)mismatchDescription;
 
 /*!
  * @abstract Generates a description of why the matcher has not accepted the item.
@@ -38,6 +40,8 @@
  *
  * This method assumes that <code>matches:item</code> is false, but will not check this.
  */
-- (void)describeMismatchOf:(id)item to:(id <HCDescription>)mismatchDescription;
+- (void)describeMismatchOf:(nullable id)item to:(nullable id <HCDescription>)mismatchDescription;
 
 @end
+
+NS_ASSUME_NONNULL_END

Source/Core/HCSelfDescribing.h

@@ -6,6 +6,8 @@
 #import "HCDescription.h"   // Convenience header
 
 
+NS_ASSUME_NONNULL_BEGIN
+
 /*!
  * @abstract The ability of an object to describe itself.
  */
@@ -20,3 +22,5 @@
 - (void)describeTo:(id <HCDescription>)description;
 
 @end
+
+NS_ASSUME_NONNULL_END

Source/Core/HCStringDescription.h

@@ -6,6 +6,8 @@
 @protocol HCSelfDescribing;
 
 
+NS_ASSUME_NONNULL_BEGIN
+
 /*!
  * @abstract An HCDescription that is stored as a string.
  */
@@ -32,3 +34,5 @@
 - (instancetype)init NS_DESIGNATED_INITIALIZER;
 
 @end
+
+NS_ASSUME_NONNULL_END

Source/Core/Helpers/HCCollect.h

@@ -8,6 +8,8 @@
 @protocol HCMatcher;
 
 
+NS_ASSUME_NONNULL_BEGIN
+
 /*!
  * @abstract Returns an array of values from a variable-length comma-separated list terminated
  * by <code>nil</code>.
@@ -20,3 +22,5 @@ FOUNDATION_EXPORT NSArray * HCCollectItems(id item, va_list args);
  * matchers.
  */
 FOUNDATION_EXPORT NSArray<id <HCMatcher>> * HCWrapIntoMatchers(NSArray *items);
+
+NS_ASSUME_NONNULL_END

Source/Core/Helpers/HCInvocationMatcher.h

@@ -4,6 +4,8 @@
 #import <OCHamcrest/HCBaseMatcher.h>
 
 
+NS_ASSUME_NONNULL_BEGIN
+
 /*!
  * @abstract Supporting class for matching a feature of an object.
  * @discussion Tests whether the result of passing the specified invocation to the value satisfies
@@ -39,3 +41,5 @@
 - (NSString *)stringFromSelector;
 
 @end
+
+NS_ASSUME_NONNULL_END

Source/Core/Helpers/HCInvocationMatcher.m

@@ -17,7 +17,7 @@ - (instancetype)initWithInvocation:(NSInvocation *)anInvocation matching:(id <HC
     return self;
 }
 
-- (BOOL)matches:(id)item
+- (BOOL)matches:(nullable id)item
 {
     if ([self invocationNotSupportedForItem:item])
         return NO;
@@ -38,7 +38,7 @@ - (id)invokeOn:(id)item
     return result;
 }
 
-- (void)describeMismatchOf:(id)item to:(id <HCDescription>)mismatchDescription
+- (void)describeMismatchOf:(nullable id)item to:(nullable id <HCDescription>)mismatchDescription
 {
     if ([self invocationNotSupportedForItem:item])
         [super describeMismatchOf:item to:mismatchDescription];

Source/Core/Helpers/HCRequireNonNilObject.h

@@ -4,7 +4,11 @@
 #import <Foundation/Foundation.h>
 
 
+NS_ASSUME_NONNULL_BEGIN
+
 /*!
  * @abstract Throws an NSException if <em>obj</em> is <code>nil</code>.
 */
 FOUNDATION_EXPORT void HCRequireNonNilObject(id obj);
+
+NS_ASSUME_NONNULL_END

Source/Core/Helpers/HCRunloopRunner.h

@@ -4,6 +4,8 @@
 #import <Foundation/Foundation.h>
 
 
+NS_ASSUME_NONNULL_BEGIN
+
 /*!
  * @abstract Runs runloop until fulfilled, or timeout is reached.
  * @discussion Based on http://bou.io/CTTRunLoopRunUntil.html
@@ -15,3 +17,5 @@
 - (void)runUntilFulfilledOrTimeout:(CFTimeInterval)timeout;
 
 @end
+
+NS_ASSUME_NONNULL_END

Source/Core/Helpers/HCWrapInMatcher.h

@@ -6,8 +6,12 @@
 @protocol HCMatcher;
 
 
+NS_ASSUME_NONNULL_BEGIN
+
 /*!
  * @abstract Wraps argument in a matcher, if necessary.
  * @return The argument as-is if it is already a matcher, otherwise wrapped in an <em>equalTo</em> matcher.
  */
-FOUNDATION_EXPORT id <HCMatcher> HCWrapInMatcher(id matcherOrValue);
+FOUNDATION_EXPORT id <HCMatcher> HCWrapInMatcher(_Nullable id matcherOrValue);
+
+NS_ASSUME_NONNULL_END

Source/Core/Helpers/HCWrapInMatcher.m

@@ -6,11 +6,8 @@
 #import "HCIsEqual.h"
 
 
-id <HCMatcher> HCWrapInMatcher(id matcherOrValue)
+id <HCMatcher> HCWrapInMatcher(_Nullable id matcherOrValue)
 {
-    if (!matcherOrValue)
-        return nil;
-
     if ([matcherOrValue conformsToProtocol:@protocol(HCMatcher)])
         return matcherOrValue;
     return HC_equalTo(matcherOrValue);

Source/Core/Helpers/NSInvocation+OCHamcrest.h

@@ -4,10 +4,14 @@
 #import <Foundation/Foundation.h>
 
 
+NS_ASSUME_NONNULL_BEGIN
+
 @interface NSInvocation (OCHamcrest)
 
 + (NSInvocation *)och_invocationWithTarget:(id)target selector:(SEL)selector;
 + (NSInvocation *)och_invocationOnObjectOfType:(Class)aClass selector:(SEL)selector;
 - (id)och_invoke;
 
 @end
+
+NS_ASSUME_NONNULL_END

Source/Core/Helpers/ReturnValueGetters/HCBoolReturnGetter.h

@@ -4,9 +4,13 @@
 #import "HCReturnValueGetter.h"
 
 
+NS_ASSUME_NONNULL_BEGIN
+
 @interface HCBoolReturnGetter : HCReturnValueGetter
 
-- (instancetype)initWithSuccessor:(HCReturnValueGetter *)successor NS_DESIGNATED_INITIALIZER;
-- (instancetype)initWithType:(char const *)handlerType successor:(HCReturnValueGetter *)successor NS_UNAVAILABLE;
+- (instancetype)initWithSuccessor:(nullable HCReturnValueGetter *)successor NS_DESIGNATED_INITIALIZER;
+- (instancetype)initWithType:(char const *)handlerType successor:(nullable HCReturnValueGetter *)successor NS_UNAVAILABLE;
 
 @end
+
+NS_ASSUME_NONNULL_END

Source/Core/Helpers/ReturnValueGetters/HCBoolReturnGetter.m

@@ -6,7 +6,7 @@
 
 @implementation HCBoolReturnGetter
 
-- (instancetype)initWithSuccessor:(HCReturnValueGetter *)successor
+- (instancetype)initWithSuccessor:(nullable HCReturnValueGetter *)successor
 {
     self = [super initWithType:@encode(BOOL) successor:successor];
     return self;

Source/Core/Helpers/ReturnValueGetters/HCCharReturnGetter.h

@@ -4,9 +4,13 @@
 #import "HCReturnValueGetter.h"
 
 
+NS_ASSUME_NONNULL_BEGIN
+
 @interface HCCharReturnGetter : HCReturnValueGetter
 
-- (instancetype)initWithSuccessor:(HCReturnValueGetter *)successor NS_DESIGNATED_INITIALIZER;
-- (instancetype)initWithType:(char const *)handlerType successor:(HCReturnValueGetter *)successor NS_UNAVAILABLE;
+- (instancetype)initWithSuccessor:(nullable HCReturnValueGetter *)successor NS_DESIGNATED_INITIALIZER;
+- (instancetype)initWithType:(char const *)handlerType successor:(nullable HCReturnValueGetter *)successor NS_UNAVAILABLE;
 
 @end
+
+NS_ASSUME_NONNULL_END

Source/Core/Helpers/ReturnValueGetters/HCCharReturnGetter.m

@@ -6,7 +6,7 @@
 
 @implementation HCCharReturnGetter
 
-- (instancetype)initWithSuccessor:(HCReturnValueGetter *)successor
+- (instancetype)initWithSuccessor:(nullable HCReturnValueGetter *)successor
 {
     self = [super initWithType:@encode(char) successor:successor];
     return self;

Source/Core/Helpers/ReturnValueGetters/HCDoubleReturnGetter.h

@@ -4,9 +4,13 @@
 #import "HCReturnValueGetter.h"
 
 
+NS_ASSUME_NONNULL_BEGIN
+
 @interface HCDoubleReturnGetter : HCReturnValueGetter
 
-- (instancetype)initWithSuccessor:(HCReturnValueGetter *)successor NS_DESIGNATED_INITIALIZER;
-- (instancetype)initWithType:(char const *)handlerType successor:(HCReturnValueGetter *)successor NS_UNAVAILABLE;
+- (instancetype)initWithSuccessor:(nullable HCReturnValueGetter *)successor NS_DESIGNATED_INITIALIZER;
+- (instancetype)initWithType:(char const *)handlerType successor:(nullable HCReturnValueGetter *)successor NS_UNAVAILABLE;
 
 @end
+
+NS_ASSUME_NONNULL_END