Add a new project for recording and playing back editing commands in editable web...
[WebKit-https.git] / Tools / EditingHistory / EditingHistory / TestUtil.h
1 /*
2  * Copyright (C) 2016 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #import <Foundation/Foundation.h>
29
30 // Some named key codes, mainly for convenience.
31 enum KeyCodeType {
32     KeyCodeTypeDeleteBackward = 0x33,
33     KeyCodeTypeLeftArrow = 0x7B,
34     KeyCodeTypeRightArrow = 0x7C
35 };
36
37 /**
38  * Return YES when the condition is done and the program should stop spinning.
39  */
40 typedef BOOL (^ConditionBlock)();
41 #define CONDITION_BLOCK(expr) ^BOOL() { return expr; }
42
43 /**
44  * Spins a runloop until the given condition block evaluates to YES. If the given timeout interval has elapsed, and the condition is still unsatisfied,
45  * stop spinning and return NO. Otherwise, return YES.
46  */
47 BOOL waitUntilWithTimeout(ConditionBlock, NSTimeInterval);
48 BOOL waitUntil(ConditionBlock);