1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
|
// Copyright (c) 2011 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef PPAPI_UTILITY_COMPLETION_CALLBACK_FACTORY_H_
#define PPAPI_UTILITY_COMPLETION_CALLBACK_FACTORY_H_
#include "ppapi/cpp/completion_callback.h"
#include "ppapi/utility/non_thread_safe_ref_count.h"
namespace pp {
/// CompletionCallbackFactory<T> may be used to create CompletionCallback
/// objects that are bound to member functions.
///
/// If a factory is destroyed, then any pending callbacks will be cancelled
/// preventing any bound member functions from being called. The CancelAll()
/// method allows pending callbacks to be cancelled without destroying the
/// factory.
///
/// <strong>Note: </strong><code>CompletionCallbackFactory<T></code> isn't
/// thread safe, but you can make it more thread-friendly by passing a
/// thread-safe refcounting class as the second template element. However, it
/// only guarantees safety for creating a callback from another thread, the
/// callback itself needs to execute on the same thread as the thread that
/// creates/destroys the factory. With this restriction, it is safe to create
/// the <code>CompletionCallbackFactory</code> on the main thread, create
/// callbacks from any thread and pass them to CallOnMainThread().
///
/// <strong>Example: </strong>
///
/// @code
///
/// class MyHandler {
/// public:
/// // If an compiler warns on following using |this| in the initializer
/// // list, use PP_ALLOW_THIS_IN_INITIALIZER_LIST macro.
/// MyHandler() : factory_(this), offset_(0) {
/// }
///
/// void ProcessFile(const FileRef& file) {
/// CompletionCallback cc = factory_.NewRequiredCallback(
/// &MyHandler::DidOpen);
/// int32_t rv = fio_.Open(file, PP_FileOpenFlag_Read, cc);
/// CHECK(rv == PP_OK_COMPLETIONPENDING);
/// }
///
/// private:
/// CompletionCallback NewCallback() {
/// return factory_.NewCallback(&MyHandler::DidCompleteIO);
/// }
///
/// void DidOpen(int32_t result) {
/// if (result == PP_OK) {
/// // The file is open, and we can begin reading.
/// offset_ = 0;
/// ReadMore();
/// } else {
/// // Failed to open the file with error given by 'result'.
/// }
/// }
///
/// void DidRead(int32_t result) {
/// if (result > 0) {
/// // buf_ now contains 'result' number of bytes from the file.
/// ProcessBytes(buf_, result);
/// offset_ += result;
/// ReadMore();
/// } else {
/// // Done reading (possibly with an error given by 'result').
/// }
/// }
///
/// void ReadMore() {
/// CompletionCallback cc =
/// factory_.NewOptionalCallback(&MyHandler::DidRead);
/// int32_t rv = fio_.Read(offset_, buf_, sizeof(buf_),
/// cc.pp_completion_callback());
/// if (rv != PP_OK_COMPLETIONPENDING)
/// cc.Run(rv);
/// }
///
/// void ProcessBytes(const char* bytes, int32_t length) {
/// // Do work ...
/// }
///
/// pp::CompletionCallbackFactory<MyHandler> factory_;
/// pp::FileIO fio_;
/// char buf_[4096];
/// int64_t offset_;
/// };
///
/// @endcode
///
template <typename T, typename RefCount = NonThreadSafeRefCount>
class CompletionCallbackFactory {
public:
/// This constructor creates a <code>CompletionCallbackFactory</code>
/// bound to an object. If the constructor is called without an argument,
/// the default value of <code>NULL</code> is used. The user then must call
/// Initialize() to initialize the object.
///
/// param[in] object Optional parameter. An object whose member functions
/// are to be bound to CompletionCallbacks created by this
/// <code>CompletionCallbackFactory</code>. The default value of this
/// parameter is <code>NULL</code>.
explicit CompletionCallbackFactory(T* object = NULL)
: object_(object) {
InitBackPointer();
}
/// Destructor.
~CompletionCallbackFactory() {
ResetBackPointer();
}
/// CancelAll() cancels all <code>CompletionCallbacks</code> allocated from
/// this factory.
void CancelAll() {
ResetBackPointer();
InitBackPointer();
}
/// Initialize() binds the <code>CallbackFactory</code> to a particular
/// object. Use this when the object is not available at
/// <code>CallbackFactory</code> creation, and the <code>NULL</code> default
/// is passed to the constructor. The object may only be initialized once,
/// either by the constructor, or by a call to Initialize().
///
/// @param[in] object The object whose member functions are to be bound to
/// the <code>CompletionCallback</code> created by this
/// <code>CompletionCallbackFactory</code>.
void Initialize(T* object) {
PP_DCHECK(object);
PP_DCHECK(!object_); // May only initialize once!
object_ = object;
}
/// GetObject() returns the object that was passed at initialization to
/// Intialize().
///
/// @return the object passed to the constructor or Intialize().
T* GetObject() {
return object_;
}
/// NewCallback allocates a new, single-use <code>CompletionCallback</code>.
/// The <code>CompletionCallback</code> must be run in order for the memory
/// allocated by the methods to be freed.
/// NewCallback() is equivalent to NewRequiredCallback() below.
///
/// @param[in] method The method to be invoked upon completion of the
/// operation.
///
/// @return A <code>CompletionCallback</code>.
template <typename Method>
CompletionCallback NewCallback(Method method) {
PP_DCHECK(object_);
return NewCallbackHelper(Dispatcher0<Method>(method));
}
/// NewRequiredCallback() allocates a new, single-use
/// <code>CompletionCallback</code> that will always run. The
/// <code>CompletionCallback</code> must be run in order for the memory
/// allocated by the methods to be freed.
///
/// @param[in] method The method to be invoked upon completion of the
/// operation.
///
/// @return A <code>CompletionCallback</code>.
template <typename Method>
CompletionCallback NewRequiredCallback(Method method) {
CompletionCallback cc = NewCallback(method);
cc.set_flags(cc.flags() & ~PP_COMPLETIONCALLBACK_FLAG_OPTIONAL);
return cc;
}
/// NewOptionalCallback() allocates a new, single-use
/// <code>CompletionCallback</code> that might not run if the method
/// taking it can complete synchronously. Thus, if after passing the
/// CompletionCallback to a Pepper method, the method does not return
/// PP_OK_COMPLETIONPENDING, then you should manually call the
/// CompletionCallback's Run method, or memory will be leaked.
///
/// @param[in] method The method to be invoked upon completion of the
/// operation.
///
/// @return A <code>CompletionCallback</code>.
template <typename Method>
CompletionCallback NewOptionalCallback(Method method) {
CompletionCallback cc = NewCallback(method);
cc.set_flags(cc.flags() | PP_COMPLETIONCALLBACK_FLAG_OPTIONAL);
return cc;
}
/// NewCallback() allocates a new, single-use <code>CompletionCallback</code>.
/// The <code>CompletionCallback</code> must be run in order for the memory
/// allocated by the methods to be freed.
/// NewCallback() is equivalent to NewRequiredCallback() below.
///
/// @param[in] method The method to be invoked upon completion of the
/// operation. Method should be of type:
/// <code>void (T::*)(int32_t result, const A& a)</code>
///
/// @param[in] a Passed to <code>method</code> when the completion callback
/// runs.
///
/// @return A <code>CompletionCallback</code>.
template <typename Method, typename A>
CompletionCallback NewCallback(Method method, const A& a) {
PP_DCHECK(object_);
return NewCallbackHelper(Dispatcher1<Method, A>(method, a));
}
/// NewRequiredCallback() allocates a new, single-use
/// <code>CompletionCallback</code> that will always run. The
/// <code>CompletionCallback</code> must be run in order for the memory
/// allocated by the methods to be freed.
///
/// @param[in] method The method to be invoked upon completion of the
/// operation. Method should be of type:
/// <code>void (T::*)(int32_t result, const A& a)</code>
///
/// @param[in] a Passed to <code>method</code> when the completion callback
/// runs.
///
/// @return A <code>CompletionCallback</code>.
template <typename Method, typename A>
CompletionCallback NewRequiredCallback(Method method, const A& a) {
CompletionCallback cc = NewCallback(method, a);
cc.set_flags(cc.flags() & ~PP_COMPLETIONCALLBACK_FLAG_OPTIONAL);
return cc;
}
/// NewOptionalCallback() allocates a new, single-use
/// <code>CompletionCallback</code> that might not run if the method
/// taking it can complete synchronously. Thus, if after passing the
/// CompletionCallback to a Pepper method, the method does not return
/// PP_OK_COMPLETIONPENDING, then you should manually call the
/// CompletionCallback's Run method, or memory will be leaked.
///
/// @param[in] method The method to be invoked upon completion of the
/// operation. Method should be of type:
/// <code>void (T::*)(int32_t result, const A& a)</code>
///
/// @param[in] a Passed to <code>method</code> when the completion callback
/// runs.
///
/// @return A <code>CompletionCallback</code>.
template <typename Method, typename A>
CompletionCallback NewOptionalCallback(Method method, const A& a) {
CompletionCallback cc = NewCallback(method, a);
cc.set_flags(cc.flags() | PP_COMPLETIONCALLBACK_FLAG_OPTIONAL);
return cc;
}
/// NewCallback() allocates a new, single-use
/// <code>CompletionCallback</code>.
/// The <code>CompletionCallback</code> must be run in order for the memory
/// allocated by the methods to be freed.
/// NewCallback() is equivalent to NewRequiredCallback() below.
///
/// @param method The method taking the callback. Method should be of type:
/// <code>void (T::*)(int32_t result, const A& a, const B& b)</code>
///
/// @param[in] a Passed to <code>method</code> when the completion callback
/// runs.
///
/// @param[in] b Passed to <code>method</code> when the completion callback
/// runs.
///
/// @return A <code>CompletionCallback</code>.
template <typename Method, typename A, typename B>
CompletionCallback NewCallback(Method method, const A& a, const B& b) {
PP_DCHECK(object_);
return NewCallbackHelper(Dispatcher2<Method, A, B>(method, a, b));
}
/// NewRequiredCallback() allocates a new, single-use
/// <code>CompletionCallback</code> that will always run. The
/// <code>CompletionCallback</code> must be run in order for the memory
/// allocated by the methods to be freed.
///
/// @param method The method taking the callback. Method should be of type:
/// <code>void (T::*)(int32_t result, const A& a, const B& b)</code>
///
/// @param[in] a Passed to <code>method</code> when the completion callback
/// runs.
///
/// @param[in] b Passed to <code>method</code> when the completion callback
/// runs.
///
/// @return A <code>CompletionCallback</code>.
template <typename Method, typename A, typename B>
CompletionCallback NewRequiredCallback(Method method, const A& a,
const B& b) {
CompletionCallback cc = NewCallback(method, a, b);
cc.set_flags(cc.flags() & ~PP_COMPLETIONCALLBACK_FLAG_OPTIONAL);
return cc;
}
/// NewOptionalCallback() allocates a new, single-use
/// <code>CompletionCallback</code> that might not run if the method
/// taking it can complete synchronously. Thus, if after passing the
/// CompletionCallback to a Pepper method, the method does not return
/// PP_OK_COMPLETIONPENDING, then you should manually call the
/// CompletionCallback's Run method, or memory will be leaked.
///
/// @param[in] method The method taking the callback. Method should be of
/// type:
/// <code>void (T::*)(int32_t result, const A& a, const B& b)</code>
///
/// @param[in] a Passed to <code>method</code> when the completion callback
/// runs.
///
/// @param[in] b Passed to <code>method</code> when the completion callback
/// runs.
///
/// @return A <code>CompletionCallback</code>.
template <typename Method, typename A, typename B>
CompletionCallback NewOptionalCallback(Method method, const A& a,
const B& b) {
CompletionCallback cc = NewCallback(method, a, b);
cc.set_flags(cc.flags() | PP_COMPLETIONCALLBACK_FLAG_OPTIONAL);
return cc;
}
/// NewCallback() allocates a new, single-use
/// <code>CompletionCallback</code>.
/// The <code>CompletionCallback</code> must be run in order for the memory
/// allocated by the methods to be freed.
/// NewCallback() is equivalent to NewRequiredCallback() below.
///
/// @param method The method taking the callback. Method should be of type:
/// <code>
/// void (T::*)(int32_t result, const A& a, const B& b, const C& c)
/// </code>
///
/// @param[in] a Passed to <code>method</code> when the completion callback
/// runs.
///
/// @param[in] b Passed to <code>method</code> when the completion callback
/// runs.
///
/// @param[in] c Passed to <code>method</code> when the completion callback
/// runs.
///
/// @return A <code>CompletionCallback</code>.
template <typename Method, typename A, typename B, typename C>
CompletionCallback NewCallback(Method method, const A& a, const B& b,
const C& c) {
PP_DCHECK(object_);
return NewCallbackHelper(Dispatcher3<Method, A, B, C>(method, a, b, c));
}
/// NewRequiredCallback() allocates a new, single-use
/// <code>CompletionCallback</code> that will always run. The
/// <code>CompletionCallback</code> must be run in order for the memory
/// allocated by the methods to be freed.
///
/// @param method The method taking the callback. Method should be of type:
/// <code>
/// void (T::*)(int32_t result, const A& a, const B& b, const C& c)
/// </code>
///
/// @param[in] a Passed to <code>method</code> when the completion callback
/// runs.
///
/// @param[in] b Passed to <code>method</code> when the completion callback
/// runs.
///
/// @param[in] c Passed to <code>method</code> when the completion callback
/// runs.
///
/// @return A <code>CompletionCallback</code>.
template <typename Method, typename A, typename B, typename C>
CompletionCallback NewRequiredCallback(Method method, const A& a,
const B& b, const C& c) {
CompletionCallback cc = NewCallback(method, a, b, c);
cc.set_flags(cc.flags() & ~PP_COMPLETIONCALLBACK_FLAG_OPTIONAL);
return cc;
}
/// NewOptionalCallback() allocates a new, single-use
/// <code>CompletionCallback</code> that might not run if the method
/// taking it can complete synchronously. Thus, if after passing the
/// CompletionCallback to a Pepper method, the method does not return
/// PP_OK_COMPLETIONPENDING, then you should manually call the
/// CompletionCallback's Run method, or memory will be leaked.
///
/// @param[in] method The method taking the callback. Method should be of
/// type:
/// <code>
/// void (T::*)(int32_t result, const A& a, const B& b, const C& c)
/// </code>
///
/// @param[in] a Passed to <code>method</code> when the completion callback
/// runs.
///
/// @param[in] b Passed to <code>method</code> when the completion callback
/// runs.
///
/// @param[in] c Passed to <code>method</code> when the completion callback
/// runs.
///
/// @return A <code>CompletionCallback</code>.
template <typename Method, typename A, typename B, typename C>
CompletionCallback NewOptionalCallback(Method method, const A& a,
const B& b, const C& c) {
CompletionCallback cc = NewCallback(method, a, b, c);
cc.set_flags(cc.flags() | PP_COMPLETIONCALLBACK_FLAG_OPTIONAL);
return cc;
}
private:
class BackPointer {
public:
typedef CompletionCallbackFactory<T, RefCount> FactoryType;
BackPointer(FactoryType* factory)
: factory_(factory) {
}
void AddRef() {
ref_.AddRef();
}
void Release() {
if (ref_.Release() == 0)
delete this;
}
void DropFactory() {
factory_ = NULL;
}
T* GetObject() {
return factory_ ? factory_->GetObject() : NULL;
}
private:
RefCount ref_;
FactoryType* factory_;
};
template <typename Dispatcher>
class CallbackData {
public:
CallbackData(BackPointer* back_pointer, const Dispatcher& dispatcher)
: back_pointer_(back_pointer),
dispatcher_(dispatcher) {
back_pointer_->AddRef();
}
~CallbackData() {
back_pointer_->Release();
}
static void Thunk(void* user_data, int32_t result) {
Self* self = static_cast<Self*>(user_data);
T* object = self->back_pointer_->GetObject();
if (object)
self->dispatcher_(object, result);
delete self;
}
private:
typedef CallbackData<Dispatcher> Self;
BackPointer* back_pointer_;
Dispatcher dispatcher_;
};
template <typename Method>
class Dispatcher0 {
public:
Dispatcher0(Method method) : method_(method) {
}
void operator()(T* object, int32_t result) {
(object->*method_)(result);
}
private:
Method method_;
};
template <typename Method, typename A>
class Dispatcher1 {
public:
Dispatcher1(Method method, const A& a)
: method_(method),
a_(a) {
}
void operator()(T* object, int32_t result) {
(object->*method_)(result, a_);
}
private:
Method method_;
A a_;
};
template <typename Method, typename A, typename B>
class Dispatcher2 {
public:
Dispatcher2(Method method, const A& a, const B& b)
: method_(method),
a_(a),
b_(b) {
}
void operator()(T* object, int32_t result) {
(object->*method_)(result, a_, b_);
}
private:
Method method_;
A a_;
B b_;
};
template <typename Method, typename A, typename B, typename C>
class Dispatcher3 {
public:
Dispatcher3(Method method, const A& a, const B& b, const C& c)
: method_(method),
a_(a),
b_(b),
c_(c) {
}
void operator()(T* object, int32_t result) {
(object->*method_)(result, a_, b_, c_);
}
private:
Method method_;
A a_;
B b_;
C c_;
};
void InitBackPointer() {
back_pointer_ = new BackPointer(this);
back_pointer_->AddRef();
}
void ResetBackPointer() {
back_pointer_->DropFactory();
back_pointer_->Release();
}
template <typename Dispatcher>
CompletionCallback NewCallbackHelper(const Dispatcher& dispatcher) {
PP_DCHECK(object_); // Expects a non-null object!
return CompletionCallback(
&CallbackData<Dispatcher>::Thunk,
new CallbackData<Dispatcher>(back_pointer_, dispatcher));
}
// Disallowed:
CompletionCallbackFactory(const CompletionCallbackFactory&);
CompletionCallbackFactory& operator=(const CompletionCallbackFactory&);
T* object_;
BackPointer* back_pointer_;
};
} // namespace pp
#endif // PPAPI_UTILITY_COMPLETION_CALLBACK_FACTORY_H_
|