Locks.h

/*
╔══════════════════════════════════════════════════════════════════════════════╗
║                       SIMPLY POWERFUL TOOLKIT (SPTK)                         ║
╟──────────────────────────────────────────────────────────────────────────────╢
║  copyright            © 1999-2022 Alexey Parshin. All rights reserved.       ║
║  email                alexeyp@gmail.com                                      ║
╚══════════════════════════════════════════════════════════════════════════════╝
┌──────────────────────────────────────────────────────────────────────────────┐
│   This library is free software; you can redistribute it and/or modify it    │
│   under the terms of the GNU Library General Public License as published by  │
│   the Free Software Foundation; either version 2 of the License, or (at your │
│   option) any later version.                                                 │
│                                                                              │
│   This library 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 Library   │
│   General Public License for more details.                                   │
│                                                                              │
│   You should have received a copy of the GNU Library General Public License  │
│   along with this library; if not, write to the Free Software Foundation,    │
│   Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.               │
│                                                                              │
│   Please report all bugs and problems to alexeyp@gmail.com.                  │
└──────────────────────────────────────────────────────────────────────────────┘
*/
 
#pragma once
 
#include <sptk5/Exception.h>
#include <sptk5/sptk.h>
 
#include <mutex>
#include <shared_mutex>
 
namespace sptk {
 
using SharedMutex = std::shared_timed_mutex;
using ReadLockType = std::shared_lock<SharedMutex>;
using WriteLockType = std::unique_lock<SharedMutex>;
 
class SP_EXPORT UniqueLockInt
{
public:
    explicit UniqueLockInt(SharedMutex& mutex);
 
    UniqueLockInt(const UniqueLockInt&) = delete;
 
    UniqueLockInt(SharedMutex& mutex, std::chrono::milliseconds timeout, const char* file, size_t line);
 
    virtual ~UniqueLockInt()
    {
        if (locked)
        {
            mutex.unlock();
        }
    }
 
private:
    SharedMutex& mutex; 
    bool locked {true}; 
};
 
class SP_EXPORT SharedLockInt
{
public:
    explicit SharedLockInt(SharedMutex& mutex);
 
    SharedLockInt(SharedMutex& mutex, std::chrono::milliseconds timeout, const char* file, size_t line);
 
    SharedLockInt(const SharedLockInt&) = delete;
 
    virtual ~SharedLockInt()
    {
        if (locked)
#if USE_SHARED_MUTEX
            mutex.unlock_shared();
#else
        {
            mutex.unlock();
        }
#endif
    }
 
private:
    SharedMutex& mutex; 
    bool locked {true}; 
};
 
class CopyLockInt
{
    WriteLockType destinationLock; 
    ReadLockType sourceLock;       
 
 
public:
    CopyLockInt(SharedMutex& destinationMutex, SharedMutex& sourceMutex);
};
 
class CompareLockInt
{
    ReadLockType lock1; 
    ReadLockType lock2; 
 
public:
    CompareLockInt(SharedMutex& lock1, SharedMutex& lock2);
};
 
#define UniqueLock(amutex) sptk::UniqueLockInt lock(amutex)
#define TimedUniqueLock(amutex, timeout) sptk::UniqueLockInt lock(amutex, timeout, __FILE__, __LINE__)
#define SharedLock(amutex) sptk::SharedLockInt lock(amutex)
#define TimedSharedLock(amutex, timeout) sptk::SharedLockInt lock(amutex, timeout, __FILE__, __LINE__)
#define CompareLock(mutex1, mutex2) sptk::CompareLockInt lock(mutex1, mutex2)
#define CopyLock(destinationMutex, sourceMutex) sptk::CopyLockInt lock(destinationMutex, sourceMutex)
 
} // namespace sptk