File indexing completed on 2024-05-12 15:58:21

 /*
  *  SPDX-FileCopyrightText: 2015 Dmitry Kazakov <dimula73@gmail.com>
  *
  *  SPDX-License-Identifier: GPL-2.0-or-later
  */
 
 #ifndef __KIS_IMAGE_BARRIER_LOCKER_H
 #define __KIS_IMAGE_BARRIER_LOCKER_H
 
 #include <mutex>
 
 template <typename ImagePointer>
 struct PointerPolicyAlwaysPresent
 {
     typedef ImagePointer ImagePointerType;
     static inline void barrierLock(ImagePointer image) {
         image->barrierLock();
     }
 
     static inline void unlock(ImagePointer image) {
         image->unlock();
     }
 };
 
 template <typename ImagePointer>
 struct PointerPolicyAllowNull
 {
     typedef ImagePointer ImagePointerType;
 
     static inline void barrierLock(ImagePointer image) {
         if (image) {
             image->barrierLock();
         }
     }
 
     static inline void unlock(ImagePointer image) {
         if (image) {
             image->unlock();
         }
     }
 };
 
 /**
  * A simple class that implements std::lock_guard concept for locking KisImage.
  * It barrier-locks the image during construction and unlocks it on destruction.
  *
  * \p PointerPolicy defines how the image pointer is handled
  */
 
 template <class PointerPolicy>
 class KisImageBarrierLockerImpl {
 public:
     typedef typename PointerPolicy::ImagePointerType ImagePointer;
 public:
     inline KisImageBarrierLockerImpl(ImagePointer image)
         : m_image(image)
     {
         PointerPolicy::barrierLock(m_image);
     }
 
     inline KisImageBarrierLockerImpl(ImagePointer image, std::adopt_lock_t)
         : m_image(image)
     {
     }
 
     inline ~KisImageBarrierLockerImpl() {
         PointerPolicy::unlock(m_image);
     }
 
 private:
     KisImageBarrierLockerImpl(const KisImageBarrierLockerImpl<PointerPolicy> &rhs);
     ImagePointer m_image;
 };
 
 // Lock guard for the image passed as KisImageSP pointer. Pointer cannot be null.
 typedef KisImageBarrierLockerImpl<PointerPolicyAlwaysPresent<KisImageSP>> KisImageBarrierLocker;
 
 // Lock guard for the image passed as a raw KisImage* pointer. Pointer cannot be null.
 typedef KisImageBarrierLockerImpl<PointerPolicyAlwaysPresent<KisImage*>> KisImageBarrierLockerRaw;
 
 // Lock guard for the image passed as KisImageSP pointer that *can* be null.
 typedef KisImageBarrierLockerImpl<PointerPolicyAllowNull<KisImageSP>> KisImageBarrierLockerAllowNull;
 
 #endif /* __KIS_IMAGE_BARRIER_LOCKER_H */