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. 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#ifndef UserActivity_h
27#define UserActivity_h
28
29#include <pal/HysteresisActivity.h>
30
31#if HAVE(NS_ACTIVITY)
32#include <objc/objc.h>
33#include <wtf/RetainPtr.h>
34#include <wtf/RunLoop.h>
35OBJC_CLASS NSString;
36#endif
37
38namespace WebCore {
39
40// The UserActivity type is used to indicate to the operating system that
41// a user initiated or visible action is taking place, and as such that
42// resources should be allocated to the process accordingly.
43class UserActivity : public PAL::HysteresisActivity {
44public:
45 class Impl {
46 public:
47 explicit Impl(const char* description);
48
49 void beginActivity();
50 void endActivity();
51
52#if HAVE(NS_ACTIVITY)
53 private:
54 RetainPtr<id> m_activity;
55 RetainPtr<NSString> m_description;
56#endif
57 };
58
59 WEBCORE_EXPORT explicit UserActivity(const char* description);
60
61private:
62 void hysteresisUpdated(PAL::HysteresisState);
63
64 Impl m_impl;
65};
66
67} // namespace WebCore
68
69using WebCore::UserActivity;
70
71#endif // UserActivity_h
72