Replace CallClosureTask::create(bind()) with createCrossThreadTask()

Source/core/dom/CrossThreadTask.h

 /*
  * Copyright (C) 2009-2010 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 460 matching lines @@
     return CrossThreadTask8<typename CrossThreadCopier<P1>::Type, MP1, typename CrossThreadCopier<P2>::Type, MP2, typename CrossThreadCopier<P3>::Type, MP3,
     typename CrossThreadCopier<P4>::Type, MP4, typename CrossThreadCopier<P5>::Type, MP5, typename CrossThreadCopier<P6>::Type, MP6,
     typename CrossThreadCopier<P7>::Type, MP7, typename CrossThreadCopier<P8>::Type, MP8>::create(
                                                        method,
                                                        CrossThreadCopier<P1>::copy(parameter1), CrossThreadCopier<P2>::copy(parameter2),
                                                        CrossThreadCopier<P3>::copy(parameter3), CrossThreadCopier<P4>::copy(parameter4),
                                                        CrossThreadCopier<P5>::copy(parameter5), CrossThreadCopier<P6>::copy(parameter6),
                                                        CrossThreadCopier<P7>::copy(parameter7), CrossThreadCopier<P8>::copy(parameter8));
 }
 
+// createCallClosureTask(...) is similar to but safer than

[tkent, 2014/07/10 03:36:14]

I'd like to name this createCrossThreadTask.
This actually creates CallClosureTask, but IMO CallClosureTask is an
implementation detail and should hide it from users.
The purpose of this function is same as the existing createCrossThreadTask, and
this should have the same name.

[hiroshige, 2014/07/10 04:39:56]

The name createCrossThreadTask seems good, but doesn't exist in the current
code.
Did you mean createCallbackTask? For me, renaming createCallClosureTask to
createCallbackTask might be confusing, because createCallbackTask differs in
that its argument 'method' takes ExecutionContext* argument.

I'd like to give better names (and refactor the functionality if needed) to the
following similar but different functions:
1. createCallbackTask(method,args) (existing)
    - Cross-thread: Yes
    - Support for member functions: No
    - method(context,args) is called in performTask(ExecutionContext* context)
2. createCallClosureTask(method,args) (newly-added)
    - Cross-thread: Yes
    - Support for member functions: Yes
    - method(args) is called in performTask(ExecutionContext*)
3. same-thread version of createCallClosureTask(method,args) (not yet added, not
used in this CL but can be used in future refactoring)
    - Cross-thread: No
    - Support for member functions: Yes
    - method(args) is called in performTask(ExecutionContext*)

A candidate is (I'm not confident though):
1. createCallbackTask or createCrossThreadCallbackTask
2. createCrossThreadTask
3. createSameThreadTask

Any suggestions are welcome.

[tyoshino (SeeGerritForStatus), 2014/07/10 04:50:04]

Yes we can also rename 1 later to align naming convention.

Can we give the same name to 1 and 2 technically? It looks createCrossThreadTask
makes sense for both.

[tkent, 2014/07/10 05:06:23]

I'm sorry, I meant createCallbackTask.

Smaller patch is better.  Should this CL be merged to a branch? So I recommend:
1. Add createCrossThreadTask for closures in this CL
2. The next CL renames existing createCallbackTask to createCrossThreadTask.
3. Another CL adds create(Same|Single)ThreadTask.

[hiroshige, 2014/07/10 07:16:31]

Probably yes.

I renamed createCallClosureTask to createCrossThreadTask.
I'll submit separate CLs later.

+// CallClosureTask::create(bind(...)) for cross-thread task posting.
+// postTask(CallClosureTask::create(bind(...))) is not thread-safe
+// due to temporary objects, see http://crbug.com/390851 for details.
+//
+// createCallClosureTask copies its arguments into Closure
+// by CrossThreadCopier, rather than copy constructors.
+// This means it creates deep copy of each argument if necessary.
+//
+// To pass things that cannot be copied by CrossThreadCopier
+// (e.g. pointers), use AllowCrossThreadAccess() explicitly.
+//
+// If the first argument of createCallClosureTask
+// is a pointer to a member function in class C,
+// then the second argument of createCallClosureTask
+// is a raw pointer (C*) or a weak pointer (const WeakPtr<C>&) to C.
+// createCallClosureTask does not use CrossThreadCopier for the pointer,
+// assuming the user of createCallClosureTask knows that the pointer
+// can be accessed from the target thread.
+
+// Templates for member function of class C + raw pointer (C*)
+// which do not use CrossThreadCopier for the raw pointer (a1)
+template<typename R, typename C>

[tkent, 2014/07/10 03:36:14]

Is R necessary?  it's always void, right?

[hiroshige, 2014/07/10 04:39:56]

Right, because CallClosureTask::create require Closure as its argument.
I'll replace R with void.

[hiroshige, 2014/07/10 07:16:32]

Done.

+PassOwnPtr<ExecutionContextTask> createCallClosureTask(R (C::*function)(), C* a1)
+{
+    return CallClosureTask::create(bind(function,
+        a1));
+}
+
+template<typename R, typename C, typename P2, typename A2>
+PassOwnPtr<ExecutionContextTask> createCallClosureTask(R (C::*function)(P2), C* a1, const A2& a2)
+{
+    return CallClosureTask::create(bind(function,
+        a1,
+        CrossThreadCopier<A2>::copy(a2)));
+}
+
+template<typename R, typename C, typename P2, typename A2, typename P3, typename A3>
+PassOwnPtr<ExecutionContextTask> createCallClosureTask(R (C::*function)(P2, P3), C* a1, const A2& a2, const A3& a3)
+{
+    return CallClosureTask::create(bind(function,
+        a1,
+        CrossThreadCopier<A2>::copy(a2),
+        CrossThreadCopier<A3>::copy(a3)));
+}
+
+template<typename R, typename C, typename P2, typename A2, typename P3, typename A3, typename P4, typename A4>
+PassOwnPtr<ExecutionContextTask> createCallClosureTask(R (C::*function)(P2, P3, P4), C* a1, const A2& a2, const A3& a3, const A4& a4)
+{
+    return CallClosureTask::create(bind(function,
+        a1,
+        CrossThreadCopier<A2>::copy(a2),
+        CrossThreadCopier<A3>::copy(a3),
+        CrossThreadCopier<A4>::copy(a4)));
+}
+
+template<typename R, typename C, typename P2, typename A2, typename P3, typename A3, typename P4, typename A4, typename P5, typename A5>
+PassOwnPtr<ExecutionContextTask> createCallClosureTask(R (C::*function)(P2, P3, P4, P5), C* a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5)
+{
+    return CallClosureTask::create(bind(function,
+        a1,
+        CrossThreadCopier<A2>::copy(a2),
+        CrossThreadCopier<A3>::copy(a3),
+        CrossThreadCopier<A4>::copy(a4),
+        CrossThreadCopier<A5>::copy(a5)));
+}
+
+template<typename R, typename C, typename P2, typename A2, typename P3, typename A3, typename P4, typename A4, typename P5, typename A5, typename P6, typename A6>
+PassOwnPtr<ExecutionContextTask> createCallClosureTask(R (C::*function)(P2, P3, P4, P5, P6), C* a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5, const A6& a6)
+{
+    return CallClosureTask::create(bind(function,
+        a1,
+        CrossThreadCopier<A2>::copy(a2),
+        CrossThreadCopier<A3>::copy(a3),
+        CrossThreadCopier<A4>::copy(a4),
+        CrossThreadCopier<A5>::copy(a5),
+        CrossThreadCopier<A6>::copy(a6)));
+}
+
+// Templates for member function of class C + weak pointer (const WeakPtr<C>&)
+// which do not use CrossThreadCopier for the weak pointer (a1)
+template<typename R, typename C>
+PassOwnPtr<ExecutionContextTask> createCallClosureTask(R (C::*function)(), const WeakPtr<C>& a1)
+{
+    return CallClosureTask::create(bind(function,
+        a1));
+}
+
+template<typename R, typename C, typename P2, typename A2>
+PassOwnPtr<ExecutionContextTask> createCallClosureTask(R (C::*function)(P2), const WeakPtr<C>& a1, const A2& a2)
+{
+    return CallClosureTask::create(bind(function,
+        a1,
+        CrossThreadCopier<A2>::copy(a2)));
+}
+
+template<typename R, typename C, typename P2, typename A2, typename P3, typename A3>
+PassOwnPtr<ExecutionContextTask> createCallClosureTask(R (C::*function)(P2, P3), const WeakPtr<C>& a1, const A2& a2, const A3& a3)
+{
+    return CallClosureTask::create(bind(function,
+        a1,
+        CrossThreadCopier<A2>::copy(a2),
+        CrossThreadCopier<A3>::copy(a3)));
+}
+
+template<typename R, typename C, typename P2, typename A2, typename P3, typename A3, typename P4, typename A4>
+PassOwnPtr<ExecutionContextTask> createCallClosureTask(R (C::*function)(P2, P3, P4), const WeakPtr<C>& a1, const A2& a2, const A3& a3, const A4& a4)
+{
+    return CallClosureTask::create(bind(function,
+        a1,
+        CrossThreadCopier<A2>::copy(a2),
+        CrossThreadCopier<A3>::copy(a3),
+        CrossThreadCopier<A4>::copy(a4)));
+}
+
+template<typename R, typename C, typename P2, typename A2, typename P3, typename A3, typename P4, typename A4, typename P5, typename A5>
+PassOwnPtr<ExecutionContextTask> createCallClosureTask(R (C::*function)(P2, P3, P4, P5), const WeakPtr<C>& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5)
+{
+    return CallClosureTask::create(bind(function,
+        a1,
+        CrossThreadCopier<A2>::copy(a2),
+        CrossThreadCopier<A3>::copy(a3),
+        CrossThreadCopier<A4>::copy(a4),
+        CrossThreadCopier<A5>::copy(a5)));
+}
+
+template<typename R, typename C, typename P2, typename A2, typename P3, typename A3, typename P4, typename A4, typename P5, typename A5, typename P6, typename A6>
+PassOwnPtr<ExecutionContextTask> createCallClosureTask(R (C::*function)(P2, P3, P4, P5, P6), const WeakPtr<C>& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5, const A6& a6)
+{
+    return CallClosureTask::create(bind(function,
+        a1,
+        CrossThreadCopier<A2>::copy(a2),
+        CrossThreadCopier<A3>::copy(a3),
+        CrossThreadCopier<A4>::copy(a4),
+        CrossThreadCopier<A5>::copy(a5),
+        CrossThreadCopier<A6>::copy(a6)));
+}
+
+// Other cases; use CrossThreadCopier for all arguments
+template<typename FunctionType>
+PassOwnPtr<ExecutionContextTask> createCallClosureTask(FunctionType function)
+{
+    return CallClosureTask::create(bind(function));
+}
+
+template<typename FunctionType, typename A1>
+PassOwnPtr<ExecutionContextTask> createCallClosureTask(FunctionType function, const A1& a1)
+{
+    return CallClosureTask::create(bind(function,
+        CrossThreadCopier<A1>::copy(a1)));
+}
+
+template<typename FunctionType, typename A1, typename A2>
+PassOwnPtr<ExecutionContextTask> createCallClosureTask(FunctionType function, const A1& a1, const A2& a2)
+{
+    return CallClosureTask::create(bind(function,
+        CrossThreadCopier<A1>::copy(a1),
+        CrossThreadCopier<A2>::copy(a2)));
+}
+
+template<typename FunctionType, typename A1, typename A2, typename A3>
+PassOwnPtr<ExecutionContextTask> createCallClosureTask(FunctionType function, const A1& a1, const A2& a2, const A3& a3)
+{
+    return CallClosureTask::create(bind(function,
+        CrossThreadCopier<A1>::copy(a1),
+        CrossThreadCopier<A2>::copy(a2),
+        CrossThreadCopier<A3>::copy(a3)));
+}
+
+template<typename FunctionType, typename A1, typename A2, typename A3, typename A4>
+PassOwnPtr<ExecutionContextTask> createCallClosureTask(FunctionType function, const A1& a1, const A2& a2, const A3& a3, const A4& a4)
+{
+    return CallClosureTask::create(bind(function,
+        CrossThreadCopier<A1>::copy(a1),
+        CrossThreadCopier<A2>::copy(a2),
+        CrossThreadCopier<A3>::copy(a3),
+        CrossThreadCopier<A4>::copy(a4)));
+}
+
+template<typename FunctionType, typename A1, typename A2, typename A3, typename A4, typename A5>
+PassOwnPtr<ExecutionContextTask> createCallClosureTask(FunctionType function, const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5)
+{
+    return CallClosureTask::create(bind(function,
+        CrossThreadCopier<A1>::copy(a1),
+        CrossThreadCopier<A2>::copy(a2),
+        CrossThreadCopier<A3>::copy(a3),
+        CrossThreadCopier<A4>::copy(a4),
+        CrossThreadCopier<A5>::copy(a5)));
+}
+
+template<typename FunctionType, typename A1, typename A2, typename A3, typename A4, typename A5, typename A6>
+PassOwnPtr<ExecutionContextTask> createCallClosureTask(FunctionType function, const A1& a1, const A2& a2, const A3& a3, const A4& a4, const A5& a5, const A6& a6)
+{
+    return CallClosureTask::create(bind(function,
+        CrossThreadCopier<A1>::copy(a1),
+        CrossThreadCopier<A2>::copy(a2),
+        CrossThreadCopier<A3>::copy(a3),
+        CrossThreadCopier<A4>::copy(a4),
+        CrossThreadCopier<A5>::copy(a5),
+        CrossThreadCopier<A6>::copy(a6)));
+}
+
 } // namespace WebCore
 
 #endif // CrossThreadTask_h