Tools/EditingHistory/EditingHistory/TestUtil.h

/*
 * Copyright (C) 2016 Apple 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:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS 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 APPLE INC. OR ITS 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.
 */

#pragma once

#import <Foundation/Foundation.h>

// Some named key codes, mainly for convenience.
enum KeyCodeType {
    KeyCodeTypeDeleteBackward = 0x33,
    KeyCodeTypeLeftArrow = 0x7B,
    KeyCodeTypeRightArrow = 0x7C
};

/**
 * Return YES when the condition is done and the program should stop spinning.
 */
typedef BOOL (^ConditionBlock)();
#define CONDITION_BLOCK(expr) ^BOOL() { return expr; }

/**
 * Spins a runloop until the given condition block evaluates to YES. If the given timeout interval has elapsed, and the condition is still unsatisfied,
 * stop spinning and return NO. Otherwise, return YES.
 */
BOOL waitUntilWithTimeout(ConditionBlock, NSTimeInterval);
BOOL waitUntil(ConditionBlock);