ab995cbf56b61ee48d2da67095392f2724faadb1
[WebKit-https.git] / Source / WebKit2 / Platform / spi / ios / AssertionServicesSPI.h
1 /*
2  * Copyright (C) 2014 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #import <Foundation/Foundation.h>
27
28 #if USE(APPLE_INTERNAL_SDK)
29
30 #import <AssertionServices/BKSApplicationStateMonitor.h>
31 #import <AssertionServices/BKSProcessAssertion.h>
32
33 #else
34
35 enum {
36     BKSApplicationStateUnknown                      = 0,
37     BKSApplicationStateTerminated                   = (1 << 0),
38     BKSApplicationStateBackgroundTaskSuspended      = (1 << 1),
39     BKSApplicationStateBackgroundRunning            = (1 << 2),
40     BKSApplicationStateForegroundRunning            = (1 << 3),
41     BKSApplicationStateProcessServer                = (1 << 4),
42     BKSApplicationStateForegroundRunningObscured    = (1 << 5),
43 };
44 typedef uint32_t BKSApplicationState;
45
46 extern NSString * const BKSApplicationStateMostElevatedStateForProcessIDKey;
47 extern NSString * const BKSApplicationStateProcessIDKey;
48
49 typedef void(^BKSApplicationStateChangedHandler)(NSDictionary *userInfo);
50
51 @interface BKSApplicationStateMonitor : NSObject
52
53 @property (nonatomic, copy) BKSApplicationStateChangedHandler handler;
54
55 - (BKSApplicationState)mostElevatedApplicationStateForPID:(pid_t)pid;
56 - (void)invalidate;
57
58 @end
59
60 enum {
61     BKSProcessAssertionNone = 0,
62     BKSProcessAssertionPreventTaskSuspend  = 1 << 0,
63     BKSProcessAssertionPreventTaskThrottleDown = 1 << 1,
64     BKSProcessAssertionAllowIdleSleep = 1 << 2,
65     BKSProcessAssertionWantsForegroundResourcePriority = 1 << 3,
66     BKSProcessAssertionAllowSuspendOnSleep = 1 << 4,
67 };
68 typedef uint32_t BKSProcessAssertionFlags;
69
70 enum {
71     BKSProcessAssertionReasonExtension = 13,
72 };
73 typedef uint32_t BKSProcessAssertionReason;
74
75 typedef void (^BKSProcessAssertionAcquisitionHandler)(BOOL acquired);
76
77 @interface BKSProcessAssertion : NSObject
78 @end
79
80 @interface BKSProcessAssertion (Details)
81 @property (nonatomic, assign) BKSProcessAssertionFlags flags;
82 - (id)initWithPID:(pid_t)pid flags:(BKSProcessAssertionFlags)flags reason:(BKSProcessAssertionReason)reason name:(NSString *)name withHandler:(BKSProcessAssertionAcquisitionHandler)handler;
83 - (void)invalidate;
84 @end
85
86 #endif