Blame view

include/scopeguard.h 3.29 KB
b5d9e433   Peter M. Groen   Fixed License Hea...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
  /* ****************************************************************************
   * Copyright 2019 Open Systems Development BV                                 *
   *                                                                            *
   * Permission is hereby granted, free of charge, to any person obtaining a    *
   * copy of this software and associated documentation files (the "Software"), *
   * to deal in the Software without restriction, including without limitation  *
   * the rights to use, copy, modify, merge, publish, distribute, sublicense,   *
   * and/or sell copies of the Software, and to permit persons to whom the      *
   * Software is furnished to do so, subject to the following conditions:       *
   *                                                                            *
   * The above copyright notice and this permission notice shall be included in *
   * all copies or substantial portions of the Software.                        *
   *                                                                            *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *
   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,   *
   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL    *
   * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING    *
   * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER        *
   * DEALINGS IN THE SOFTWARE.                                                  *
   * ***************************************************************************/
51becbde   Peter M. Groen   Committed the ent...
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
  #ifndef OSDEV_COMPONENTS_MQTT_SCOPEGUARD_H
  #define OSDEV_COMPONENTS_MQTT_SCOPEGUARD_H
  
  // std
  #include <functional>
  
  #include "macrodefs.h"
  #include "utils.h"
  
  #define OSDEV_COMPONENTS_SCOPEGUARD(variableName, ...)                                                            \
      osdev::components::mqtt::ScopeGuard OSDEV_COMPONENTS_COMBINE(Scope__Guard__##variableName##__, __LINE__)(__VA_ARGS__); \
      osdev::components::mqtt::apply_unused_parameters(OSDEV_COMPONENTS_COMBINE(Scope__Guard__##variableName##__, __LINE__));
  
  namespace osdev {
  namespace components {
  namespace mqtt {
  
fd7403ce   Peter M. Groen   Removed noexcept ...
39
  using CleanUpFunction = std::function<void()>;
51becbde   Peter M. Groen   Committed the ent...
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
  
  /**
   * @brief Ensures that a cleanup function is called at the end of the current scope.
   */
  class ScopeGuard
  {
  public:
      /**
       * @brief Constructs an empty scopeguard.
       * The scopeguard can be set by moving another ScopeGuard into this one.
       */
      ScopeGuard();
  
      /**
       * @brief Constructs a RAII instance that will call cleanupFunc in it's destructor.
       * @param cleanupFunc The cleanup function to call at the end of the current scope.
       * This cleanup function must not throw exceptions. If it does, the behavior is undefined.
       */
      ScopeGuard(const CleanUpFunction& cleanupFunc);
  
      // Movable, not copyable
      ScopeGuard(const ScopeGuard&) = delete;
      ScopeGuard& operator=(const ScopeGuard&) = delete;
      ScopeGuard(ScopeGuard&&) = default;
      ScopeGuard& operator=(ScopeGuard&&) = default;
  
      ~ScopeGuard() noexcept;
  
  private:
      CleanUpFunction m_cleanupFunc;
  };
  
  }       // End namespace mqtt
  }       // End namespace components
  }       // End namespace osdev
  
  #endif  // OSDEV_COMPONENTS_MQTT_SCOPEGUARD_H