scummvm/common/mutex.h

75 lines
1.7 KiB
C++

/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* 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 (at your option) 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef COMMON_MUTEX_H
#define COMMON_MUTEX_H
#include "common/scummsys.h"
#include "common/system.h"
namespace Common {
class Mutex;
/**
* An pseudo-opaque mutex type. See OSystem::createMutex etc. for more details.
*/
typedef OSystem::MutexRef MutexRef;
/**
* Auxillary class to (un)lock a mutex on the stack.
*/
class StackLock {
MutexRef _mutex;
const char *_mutexName;
void lock();
void unlock();
public:
explicit StackLock(MutexRef mutex, const char *mutexName = nullptr);
explicit StackLock(const Mutex &mutex, const char *mutexName = nullptr);
~StackLock();
};
/**
* Wrapper class around the OSystem mutex functions.
*/
class Mutex {
friend class StackLock;
MutexRef _mutex;
public:
Mutex();
~Mutex();
void lock();
void unlock();
};
} // End of namespace Common
#endif