Line data    Source code

       1              : /*
       2              :  *
       3              :  *    Copyright (c) 2025 Project CHIP Authors
       4              :  *
       5              :  *    Licensed under the Apache License, Version 2.0 (the "License");
       6              :  *    you may not use this file except in compliance with the License.
       7              :  *    You may obtain a copy of the License at
       8              :  *
       9              :  *        http://www.apache.org/licenses/LICENSE-2.0
      10              :  *
      11              :  *    Unless required by applicable law or agreed to in writing, software
      12              :  *    distributed under the License is distributed on an "AS IS" BASIS,
      13              :  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      14              :  *    See the License for the specific language governing permissions and
      15              :  *    limitations under the License.
      16              :  */
      17              : 
      18              : /**
      19              :  *    @file
      20              :  *          Contains a standard RAII class which calls Release on dtor.
      21              :  */
      22              : 
      23              : #pragma once
      24              : 
      25              : #include <stddef.h>
      26              : 
      27              : namespace chip {
      28              : 
      29              : /// RAII class for iterators that guarantees that Release() will be called
      30              : /// on the underlying type.  This is effectively a simple unique_ptr, except
      31              : /// calling Release instead of delete
      32              : template <typename Releasable>
      33              : class AutoRelease
      34              : {
      35              : public:
      36            7 :     AutoRelease(Releasable * releasable) : mReleasable(releasable) {}
      37            7 :     ~AutoRelease() { Release(); }
      38              : 
      39              :     // Not copyable or movable
      40              :     AutoRelease(const AutoRelease &)             = delete;
      41              :     AutoRelease(const AutoRelease &&)            = delete;
      42              :     AutoRelease & operator=(const AutoRelease &) = delete;
      43              : 
      44            8 :     inline Releasable * operator->() { return mReleasable; }
      45              :     inline const Releasable * operator->() const { return mReleasable; }
      46              : 
      47            7 :     inline bool IsNull() const { return mReleasable == nullptr; }
      48              : 
      49           14 :     void Release()
      50              :     {
      51           14 :         VerifyOrReturn(mReleasable != nullptr);
      52            7 :         mReleasable->Release();
      53            7 :         mReleasable = nullptr;
      54              :     }
      55              : 
      56              : private:
      57              :     Releasable * mReleasable = nullptr;
      58              : };
      59              : 
      60              : } // namespace chip