aboutsummaryrefslogtreecommitdiff
path: root/pw_sync/public/pw_sync/internal/borrowable_storage.h
blob: 0705ed56028a80b57860ebac59704cd1bb541bac (plain)
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
// Copyright 2022 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
#pragma once

#include <tuple>

namespace pw::sync::internal {

// BorrowableStorage stores an object and associated lock. Both objects are
// constructed in-place.
template <typename ObjectType, typename Lock>
class BorrowableStorage {
 protected:
  // Construct the object in-place using a list of arguments.
  template <typename... Args>
  constexpr explicit BorrowableStorage(std::in_place_t, Args&&... args)
      : object_{std::forward<Args>(args)...}, lock_{} {}

  // Construct the object and lock in-place using the provided parameters.
  template <typename... ObjectArgs, typename... LockArgs>
  constexpr BorrowableStorage(std::tuple<ObjectArgs...>&& object_args,
                              std::tuple<LockArgs...>&& lock_args)
      : object_{std::make_from_tuple<ObjectType>(
            std::forward<std::tuple<ObjectArgs...>>(object_args))},
        lock_{std::make_from_tuple<Lock>(
            std::forward<std::tuple<LockArgs...>>(lock_args))} {}

  // Construct the object and lock in-place using the provided factories.
  template <typename ObjectConstructor,
            typename LockConstructor,
            typename = std::enable_if_t<
                std::is_invocable_r_v<ObjectType&&, ObjectConstructor>>,
            typename = std::enable_if_t<
                std::is_invocable_r_v<Lock&&, LockConstructor>>>
  constexpr BorrowableStorage(const ObjectConstructor& object_ctor,
                              const LockConstructor& lock_ctor)
      : object_{object_ctor()}, lock_{lock_ctor()} {}

  template <typename ObjectConstructor,
            typename LockConstructor,
            typename = std::enable_if_t<
                std::is_invocable_r_v<ObjectType&&, ObjectConstructor>>,
            typename = std::enable_if_t<
                std::is_invocable_r_v<Lock&&, LockConstructor>>>
  constexpr BorrowableStorage(ObjectConstructor& object_ctor,
                              const LockConstructor& lock_ctor)
      : object_{object_ctor()}, lock_{lock_ctor()} {}

  template <typename ObjectConstructor,
            typename LockConstructor,
            typename = std::enable_if_t<
                std::is_invocable_r_v<ObjectType&&, ObjectConstructor>>,
            typename = std::enable_if_t<
                std::is_invocable_r_v<Lock&&, LockConstructor>>>
  constexpr BorrowableStorage(const ObjectConstructor& object_ctor,
                              LockConstructor& lock_ctor)
      : object_{object_ctor()}, lock_{lock_ctor()} {}

  template <typename ObjectConstructor,
            typename LockConstructor,
            typename = std::enable_if_t<
                std::is_invocable_r_v<ObjectType&&, ObjectConstructor>>,
            typename = std::enable_if_t<
                std::is_invocable_r_v<Lock&&, LockConstructor>>>
  constexpr BorrowableStorage(ObjectConstructor& object_ctor,
                              LockConstructor& lock_ctor)
      : object_{object_ctor()}, lock_{lock_ctor()} {}

  ObjectType object_;
  Lock lock_;
};

template <typename T>
T DefaultConstruct() {
  return T();
}

}  // namespace pw::sync::internal