bfcc68bdff87e6c6f5c3aa7e983aedbe57c7dc61
[WebKit-https.git] / Source / WTF / wtf / Locker.h
1 /*
2  * Copyright (C) 2008, 2013 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 #ifndef Locker_h
29 #define Locker_h
30
31 #include <wtf/Noncopyable.h>
32
33 namespace WTF {
34
35 template <typename T> class Locker {
36     WTF_MAKE_NONCOPYABLE(Locker);
37 public:
38     explicit Locker(T& lockable) : m_lockable(&lockable) { lock(); }
39     explicit Locker(T* lockable) : m_lockable(lockable) { lock(); }
40
41     enum NoLockingNecessaryTag { NoLockingNecessary };
42     // You should be wary of using this constructor. It's only applicable
43     // in places where there is a locking protocol for a particular object
44     // but it's not necessary to engage in that protocol yet. For example,
45     // this often happens when an object is newly allocated and it can not
46     // be accessed concurrently.
47     explicit Locker(NoLockingNecessaryTag) : m_lockable(nullptr) { }
48
49     ~Locker()
50     {
51         if (m_lockable)
52             m_lockable->unlock();
53     }
54     
55     void unlockEarly()
56     {
57         m_lockable->unlock();
58         m_lockable = 0;
59     }
60 private:
61     void lock()
62     {
63         if (m_lockable)
64             m_lockable->lock();
65     }
66     
67     T* m_lockable;
68 };
69
70 }
71
72 using WTF::Locker;
73
74 #endif