mutex.h

Go to the documentation of this file.

/*
 *  The Mana Client
 *  Copyright (C) 2008-2009  The Mana World Development Team
 *  Copyright (C) 2009-2012  The Mana Developers
 *
 *  This file is part of The Mana Client.
 *
 *  This program 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 2 of the License, or
 *  any later version.
 *
 *  This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "log.h"
 
#include <SDL_thread.h>
 
class Mutex
{
public:
    Mutex();
    ~Mutex();
    Mutex(Mutex&&) = delete;        // prevent moving
    Mutex(const Mutex&) = delete;   // prevent copying
    Mutex& operator=(const Mutex&) = delete;
 
    void lock();
    void unlock();
 
private:
    SDL_mutex *mMutex;
};
 
class MutexLocker
{
public:
    MutexLocker(Mutex *mutex);
    MutexLocker(MutexLocker&&);
    MutexLocker(const MutexLocker&) = delete;  // prevent copying
    MutexLocker& operator=(const MutexLocker&) = delete;
    ~MutexLocker();
 
private:
    Mutex *mMutex;
};
 
 
inline Mutex::Mutex()
{
    mMutex = SDL_CreateMutex();
}
 
inline Mutex::~Mutex()
{
    SDL_DestroyMutex(mMutex);
}
 
inline void Mutex::lock()
{
    if (SDL_mutexP(mMutex) == -1)
        Log::info("Mutex locking failed: %s", SDL_GetError());
}
 
inline void Mutex::unlock()
{
    if (SDL_mutexV(mMutex) == -1)
        Log::info("Mutex unlocking failed: %s", SDL_GetError());
}
 
 
inline MutexLocker::MutexLocker(Mutex *mutex):
    mMutex(mutex)
{
    mMutex->lock();
}
 
inline MutexLocker::MutexLocker(MutexLocker&& rhs):
    mMutex(rhs.mMutex)
{
    rhs.mMutex = nullptr;
}
 
inline MutexLocker::~MutexLocker()
{
    if (mMutex)
        mMutex->unlock();
}
 
template <typename T>
class ThreadSafe
{
    class Locked : private MutexLocker
    {
    public:
        Locked(T &data, Mutex &mutex)
            : MutexLocker(&mutex)
            , mData(data)
        {}
 
        Locked(Locked&& rhs) = delete;
        Locked(const Locked&) = delete;
        Locked& operator=(const Locked&) = delete;
        Locked& operator=(Locked&&) = delete;
 
        T &operator*() const { return mData; }
        T *operator->() const { return &mData; }
 
    private:
        T &mData;
    };
 
public:
    ThreadSafe() = default;
    ThreadSafe(const T &data)
        : mData(data)
    {}
 
    Locked lock() { return { mData, mMutex }; }
 
private:
    T mData;
    Mutex mMutex;
};