All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
utils.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef WORK_UTILS_H
25 #define WORK_UTILS_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/base/work/api.h"
31 #include "pxr/base/work/detachedTask.h"
32 
33 #include <utility>
34 
35 PXR_NAMESPACE_OPEN_SCOPE
36 
37 WORK_API
38 bool Work_ShouldSynchronizeAsyncDestroyCalls();
39 
40 template <class T>
41 struct Work_AsyncMoveDestroyHelper {
42  void operator()() const { /* do nothing */ }
43  T obj;
44 };
45 
46 // Helper for swap-based asynchronous destruction that synthesizes move
47 // construction and assignment using swap.
48 template <class T>
49 struct Work_AsyncSwapDestroyHelper {
50  Work_AsyncSwapDestroyHelper() = default;
51 
52  Work_AsyncSwapDestroyHelper(Work_AsyncSwapDestroyHelper const&) = delete;
53  Work_AsyncSwapDestroyHelper& operator=(
54  Work_AsyncSwapDestroyHelper const&) = delete;
55 
56  Work_AsyncSwapDestroyHelper(Work_AsyncSwapDestroyHelper &&other)
57  : obj()
58  {
59  using std::swap;
60  swap(obj, other.obj);
61  }
62 
63  Work_AsyncSwapDestroyHelper& operator=(
64  Work_AsyncSwapDestroyHelper &&other)
65  {
66  using std::swap;
67  swap(obj, other.obj);
68  return *this;
69  }
70 
71  void operator()() const { /* do nothing */ }
72  T obj;
73 };
74 
82 template <class T>
84 {
85  using std::swap;
86  Work_AsyncSwapDestroyHelper<T> helper;
87  swap(helper.obj, obj);
88  if (!Work_ShouldSynchronizeAsyncDestroyCalls())
89  WorkRunDetachedTask(std::move(helper));
90 }
91 
94 template <class T>
96 {
97  Work_AsyncMoveDestroyHelper<T> helper { std::move(obj) };
98  if (!Work_ShouldSynchronizeAsyncDestroyCalls())
99  WorkRunDetachedTask(std::move(helper));
100 }
101 
102 PXR_NAMESPACE_CLOSE_SCOPE
103 
104 #endif // WORK_UTILS_H
void swap(ArAssetInfo &lhs, ArAssetInfo &rhs)
Definition: assetInfo.h:60
void WorkSwapDestroyAsync(T &obj)
Swap obj with a default-constructed T instance, return and arrange for the swapped-out instance to be...
Definition: utils.h:83
void WorkRunDetachedTask(Fn &&fn)
Invoke fn asynchronously, discard any errors it produces, and provide no way to wait for it to comple...
Definition: detachedTask.h:59
void swap(UsdStageLoadRules &l, UsdStageLoadRules &r)
Swap the contents of rules l and r.
void WorkMoveDestroyAsync(T &obj)
Like WorkSwapDestroyAsync() but instead, move from obj, leaving it in a moved-from state instead of a...
Definition: utils.h:95