aboutsummaryrefslogtreecommitdiffstats
path: root/src/core/GpgFunctionObject.h
blob: 391b158552f1a9bb1c505f557064d1ffe62fb2ed (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
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
/**
 * Copyright (C) 2021 Saturneric
 *
 * This file is part of GpgFrontend.
 *
 * GpgFrontend is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * GpgFrontend is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GpgFrontend. If not, see <https://www.gnu.org/licenses/>.
 *
 * The initial version of the source code is inherited from
 * the gpg4usb project, which is under GPL-3.0-or-later.
 *
 * All the source code of GpgFrontend was modified and released by
 * Saturneric<[email protected]> starting on May 12, 2021.
 *
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 */

#ifndef GPGFRONTEND_ZH_CN_TS_FUNCTIONOBJECT_H
#define GPGFRONTEND_ZH_CN_TS_FUNCTIONOBJECT_H

#include <map>
#include <memory>
#include <mutex>
#include <shared_mutex>
#include <stdexcept>
#include <string>

#include "GpgConstants.h"

namespace GpgFrontend {

/**
 * @brief
 *
 * @tparam T
 */
template <typename T>
class SingletonFunctionObject {
 public:
  /**
   * @brief Get the Instance object
   *
   * @param channel
   * @return T&
   */
  static T& GetInstance(
      int channel = GpgFrontend::GPGFRONTEND_DEFAULT_CHANNEL) {
    static_assert(std::is_base_of<SingletonFunctionObject<T>, T>::value,
                  "T not derived from SingletonFunctionObject<T>");

    auto _p_pbj = find_object_in_channel(channel);
    if (_p_pbj == nullptr)
      return *set_object_in_channel(channel, std::make_unique<T>(channel));
    else
      return *_p_pbj;
  }

  /**
   * @brief Create a Instance object
   *
   * @param channel
   * @param factory
   * @return T&
   */
  static T& CreateInstance(int channel,
                           std::function<std::unique_ptr<T>(void)> factory) {
    static_assert(std::is_base_of<SingletonFunctionObject<T>, T>::value,
                  "T not derived from SingletonFunctionObject<T>");

    auto _p_pbj = find_object_in_channel(channel);
    if (_p_pbj == nullptr)
      return *set_object_in_channel(channel, std::move(factory()));
    else
      return *_p_pbj;
  }

  /**
   * @brief Create a Instance object
   *
   * @param channel
   * @param p_obj
   * @return T&
   */
  static T& CreateInstance(int channel, std::unique_ptr<T> p_obj = nullptr) {
    static_assert(std::is_base_of<SingletonFunctionObject<T>, T>::value,
                  "T not derived from SingletonFunctionObject<T>");

    auto _p_pbj = find_object_in_channel(channel);
    if (_p_pbj == nullptr)
      return *set_object_in_channel(channel, std::move(p_obj));
    else
      return *_p_pbj;
  }

  /**
   * @brief
   *
   * @param channel
   * @return T&
   */
  static T& ReleaseChannel(int channel) {
    decltype(_instances_map.end()) _it;
    {
      std::shared_lock lock(_instances_mutex);
      _it = _instances_map.find(channel);
    }
    if (_it != _instances_map.end()) _instances_map.erase(_it);
    DLOG(INFO) << "channel" << channel << "released";
  }

  /**
   * @brief Get the Default Channel object
   *
   * @return int
   */
  static int GetDefaultChannel() { return _default_channel; }

  /**
   * @brief Get the Channel object
   *
   * @return int
   */
  [[nodiscard]] int GetChannel() const { return channel_; }

  /**
   * @brief Construct a new Singleton Function Object object
   *
   */
  SingletonFunctionObject(T&&) = delete;

  /**
   * @brief Construct a new Singleton Function Object object
   *
   */
  SingletonFunctionObject(const T&) = delete;

  /**
   * @brief
   *
   */
  void operator=(const T&) = delete;

 protected:
  /**
   * @brief Construct a new Singleton Function Object object
   *
   */
  SingletonFunctionObject() = default;

  /**
   * @brief Construct a new Singleton Function Object object
   *
   * @param channel
   */
  explicit SingletonFunctionObject(int channel) : channel_(channel) {}

  /**
   * @brief Destroy the Singleton Function Object object
   *
   */
  virtual ~SingletonFunctionObject() = default;

  /**
   * @brief Set the Channel object
   *
   * @param channel
   */
  void SetChannel(int channel) { this->channel_ = channel; }

 private:
  int channel_ = _default_channel;                          ///<
  static int _default_channel;                              ///<
  static std::mutex _instance_mutex;                        ///<
  static std::shared_mutex _instances_mutex;                ///<
  static std::unique_ptr<T> _instance;                      ///<
  static std::map<int, std::unique_ptr<T>> _instances_map;  ///<

  /**
   * @brief
   *
   * @param channel
   * @return T*
   */
  static T* find_object_in_channel(int channel) {
    // read _instances_map
    decltype(_instances_map.end()) _it;
    {
      std::shared_lock lock(_instances_mutex);
      _it = _instances_map.find(channel);
      if (_it == _instances_map.end())
        return nullptr;
      else
        return _it->second.get();
    }
  }

  /**
   * @brief Set the object in channel object
   *
   * @param channel
   * @param p_obj
   * @return T*
   */
  static T* set_object_in_channel(int channel, std::unique_ptr<T> p_obj) {
    {
      if (p_obj == nullptr) p_obj = std::make_unique<T>();
      T* obj = p_obj.get();
      obj->SetChannel(channel);
      {
        std::unique_lock lock(_instances_mutex);
        _instances_map.insert({channel, std::move(p_obj)});
      }
      return obj;
    }
  }
};

template <typename T>
int SingletonFunctionObject<T>::_default_channel =
    GpgFrontend::GPGFRONTEND_DEFAULT_CHANNEL;

template <typename T>
std::mutex SingletonFunctionObject<T>::_instance_mutex;

template <typename T>
std::shared_mutex SingletonFunctionObject<T>::_instances_mutex;

template <typename T>
std::unique_ptr<T> SingletonFunctionObject<T>::_instance = nullptr;

template <typename T>
std::map<int, std::unique_ptr<T>> SingletonFunctionObject<T>::_instances_map;

}  // namespace GpgFrontend

#endif  // GPGFRONTEND_ZH_CN_TS_FUNCTIONOBJECT_H