GC constraint solving should be parallel
[WebKit-https.git] / Source / WTF / wtf / ScopedLambda.h
1 /*
2  * Copyright (C) 2015-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. ``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 #ifndef ScopedLambda_h
27 #define ScopedLambda_h
28
29 namespace WTF {
30
31 // You can use ScopedLambda to efficiently pass lambdas without allocating memory or requiring
32 // template specialization of the callee. The callee should be declared as:
33 //
34 // void foo(const ScopedLambda<MyThings* (int, Stuff&)>&);
35 //
36 // The caller just does:
37 //
38 // void foo(scopedLambda<MyThings* (int, Stuff&)>([&] (int x, Stuff& y) -> MyThings* { blah }));
39 //
40 // Note that this relies on foo() not escaping the lambda. The lambda is only valid while foo() is
41 // on the stack - hence the name ScopedLambda.
42
43 template<typename FunctionType> class ScopedLambda;
44 template<typename ResultType, typename... ArgumentTypes>
45 class ScopedLambda<ResultType (ArgumentTypes...)> {
46 public:
47     ScopedLambda(ResultType (*impl)(void* arg, ArgumentTypes...) = nullptr, void* arg = nullptr)
48         : m_impl(impl)
49         , m_arg(arg)
50     {
51     }
52
53     template<typename... PassedArgumentTypes>
54     ResultType operator()(PassedArgumentTypes&&... arguments) const
55     {
56         return m_impl(m_arg, std::forward<PassedArgumentTypes>(arguments)...);
57     }
58
59 private:
60     ResultType (*m_impl)(void* arg, ArgumentTypes...);
61     void *m_arg;
62 };
63
64 template<typename FunctionType, typename Functor> class ScopedLambdaFunctor;
65 template<typename ResultType, typename... ArgumentTypes, typename Functor>
66 class ScopedLambdaFunctor<ResultType (ArgumentTypes...), Functor> : public ScopedLambda<ResultType (ArgumentTypes...)> {
67 public:
68     template<typename PassedFunctor>
69     ScopedLambdaFunctor(PassedFunctor&& functor)
70         : ScopedLambda<ResultType (ArgumentTypes...)>(implFunction, this)
71         , m_functor(std::forward<PassedFunctor>(functor))
72     {
73     }
74     
75     // We need to make sure that copying and moving ScopedLambdaFunctor results in a ScopedLambdaFunctor
76     // whose ScopedLambda supertype still points to this rather than other.
77     ScopedLambdaFunctor(const ScopedLambdaFunctor& other)
78         : ScopedLambda<ResultType (ArgumentTypes...)>(implFunction, this)
79         , m_functor(other.m_functor)
80     {
81     }
82
83     ScopedLambdaFunctor(ScopedLambdaFunctor&& other)
84         : ScopedLambda<ResultType (ArgumentTypes...)>(implFunction, this)
85         , m_functor(WTFMove(other.m_functor))
86     {
87     }
88     
89     ScopedLambdaFunctor& operator=(const ScopedLambdaFunctor& other)
90     {
91         m_functor = other.m_functor;
92         return *this;
93     }
94     
95     ScopedLambdaFunctor& operator=(ScopedLambdaFunctor&& other)
96     {
97         m_functor = WTFMove(other.m_functor);
98         return *this;
99     }
100
101 private:
102     static ResultType implFunction(void* argument, ArgumentTypes... arguments)
103     {
104         return static_cast<ScopedLambdaFunctor*>(argument)->m_functor(arguments...);
105     }
106
107     Functor m_functor;
108 };
109
110 // Can't simply rely on perfect forwarding because then the ScopedLambdaFunctor would point to the functor
111 // by const reference. This would be surprising in situations like:
112 //
113 // auto scopedLambda = scopedLambda<Foo(Bar)>([&] (Bar) -> Foo { ... });
114 //
115 // We expected scopedLambda to be valid for its entire lifetime, but if it computed the lambda by reference
116 // then it would be immediately invalid.
117 template<typename FunctionType, typename Functor>
118 ScopedLambdaFunctor<FunctionType, Functor> scopedLambda(const Functor& functor)
119 {
120     return ScopedLambdaFunctor<FunctionType, Functor>(functor);
121 }
122
123 template<typename FunctionType, typename Functor>
124 ScopedLambdaFunctor<FunctionType, Functor> scopedLambda(Functor&& functor)
125 {
126     return ScopedLambdaFunctor<FunctionType, Functor>(WTFMove(functor));
127 }
128
129 template<typename FunctionType, typename Functor> class ScopedLambdaRefFunctor;
130 template<typename ResultType, typename... ArgumentTypes, typename Functor>
131 class ScopedLambdaRefFunctor<ResultType (ArgumentTypes...), Functor> : public ScopedLambda<ResultType (ArgumentTypes...)> {
132 public:
133     ScopedLambdaRefFunctor(const Functor& functor)
134         : ScopedLambda<ResultType (ArgumentTypes...)>(implFunction, this)
135         , m_functor(&functor)
136     {
137     }
138     
139     // We need to make sure that copying and moving ScopedLambdaRefFunctor results in a
140     // ScopedLambdaRefFunctor whose ScopedLambda supertype still points to this rather than
141     // other.
142     ScopedLambdaRefFunctor(const ScopedLambdaRefFunctor& other)
143         : ScopedLambda<ResultType (ArgumentTypes...)>(implFunction, this)
144         , m_functor(other.m_functor)
145     {
146     }
147
148     ScopedLambdaRefFunctor(ScopedLambdaRefFunctor&& other)
149         : ScopedLambda<ResultType (ArgumentTypes...)>(implFunction, this)
150         , m_functor(other.m_functor)
151     {
152     }
153     
154     ScopedLambdaRefFunctor& operator=(const ScopedLambdaRefFunctor& other)
155     {
156         m_functor = other.m_functor;
157         return *this;
158     }
159     
160     ScopedLambdaRefFunctor& operator=(ScopedLambdaRefFunctor&& other)
161     {
162         m_functor = other.m_functor;
163         return *this;
164     }
165
166 private:
167     static ResultType implFunction(void* argument, ArgumentTypes... arguments)
168     {
169         return (*static_cast<ScopedLambdaRefFunctor*>(argument)->m_functor)(arguments...);
170     }
171
172     const Functor* m_functor;
173 };
174
175 // This is for when you already refer to a functor by reference, and you know its lifetime is
176 // good. This just creates a ScopedLambda that points to your functor.
177 //
178 // Note that this is always wrong:
179 //
180 // auto ref = scopedLambdaRef([...] (...) {...});
181 //
182 // Because the scopedLambdaRef will refer to the lambda by reference, and the lambda will die after the
183 // semicolon. Use scopedLambda() in that case.
184 template<typename FunctionType, typename Functor>
185 ScopedLambdaRefFunctor<FunctionType, Functor> scopedLambdaRef(const Functor& functor)
186 {
187     return ScopedLambdaRefFunctor<FunctionType, Functor>(functor);
188 }
189
190 } // namespace WTF
191
192 using WTF::ScopedLambda;
193 using WTF::scopedLambda;
194 using WTF::scopedLambdaRef;
195
196 #endif // ScopedLambda_h
197