haiku/headers/private/shared/AutoLocker.h

/*
 * Copyright 2005-2007, Ingo Weinhold, bonefish@users.sf.net.
 * All rights reserved. Distributed under the terms of the MIT License.
 */
#ifndef _AUTO_LOCKER_H
#define _AUTO_LOCKER_H


#include <stddef.h>


namespace BPrivate {

// AutoLockerStandardLocking
template<typename Lockable>
class AutoLockerStandardLocking {
public:
	inline bool Lock(Lockable* lockable)
	{
		return lockable->Lock();
	}

	inline void Unlock(Lockable* lockable)
	{
		lockable->Unlock();
	}
};

// AutoLockerHandlerLocking
template<typename Lockable>
class AutoLockerHandlerLocking {
public:
	inline bool Lock(Lockable* lockable)
	{
		return lockable->LockLooper();
	}

	inline void Unlock(Lockable* lockable)
	{
		lockable->UnlockLooper();
	}
};

// AutoLockerReadLocking
template<typename Lockable>
class AutoLockerReadLocking {
public:
	inline bool Lock(Lockable* lockable)
	{
		return lockable->ReadLock();
	}

	inline void Unlock(Lockable* lockable)
	{
		lockable->ReadUnlock();
	}
};

// AutoLockerWriteLocking
template<typename Lockable>
class AutoLockerWriteLocking {
public:
	inline bool Lock(Lockable* lockable)
	{
		return lockable->WriteLock();
	}

	inline void Unlock(Lockable* lockable)
	{
		lockable->WriteUnlock();
	}
};

// AutoLocker
template<typename Lockable,
		 typename Locking = AutoLockerStandardLocking<Lockable> >
class AutoLocker {
private:
	typedef AutoLocker<Lockable, Locking>	ThisClass;
public:
	inline AutoLocker()
		:
		fLockable(NULL),
		fLocked(false)
	{
	}

	inline AutoLocker(const Locking& locking)
		:
		fLockable(NULL),
		fLocking(locking),
		fLocked(false)
	{
	}

	inline AutoLocker(Lockable* lockable, bool alreadyLocked = false,
		bool lockIfNotLocked = true)
		:
		fLockable(lockable),
		fLocked(fLockable && alreadyLocked)
	{
		if (!alreadyLocked && lockIfNotLocked)
			Lock();
	}

	inline AutoLocker(Lockable& lockable, bool alreadyLocked = false,
		bool lockIfNotLocked = true)
		:
		fLockable(&lockable),
		fLocked(fLockable && alreadyLocked)
	{
		if (!alreadyLocked && lockIfNotLocked)
			Lock();
	}

	inline ~AutoLocker()
	{
		Unlock();
	}

	inline void SetTo(Lockable* lockable, bool alreadyLocked,
		bool lockIfNotLocked = true)
	{
		Unlock();
		fLockable = lockable;
		fLocked = (lockable && alreadyLocked);
		if (!alreadyLocked && lockIfNotLocked)
			Lock();
	}

	inline void SetTo(Lockable& lockable, bool alreadyLocked,
		bool lockIfNotLocked = true)
	{
		SetTo(&lockable, alreadyLocked, lockIfNotLocked);
	}

	inline void Unset()
	{
		Unlock();
		Detach();
	}

	inline bool Lock()
	{
		if (fLockable && !fLocked)
			fLocked = fLocking.Lock(fLockable);
		return fLocked;
	}

	inline void Unlock()
	{
		if (fLockable && fLocked) {
			fLocking.Unlock(fLockable);
			fLocked = false;
		}
	}

	inline Lockable* Get()
	{
		return fLockable;
	}

	inline Lockable* Detach()
	{
		Lockable* res = fLockable;
		fLockable = NULL;
		fLocked = false;
		return res;
	}

	inline AutoLocker<Lockable, Locking>& operator=(Lockable* lockable)
	{
		SetTo(lockable);
		return *this;
	}

	inline AutoLocker<Lockable, Locking>& operator=(Lockable& lockable)
	{
		SetTo(&lockable);
		return *this;
	}

	inline bool IsLocked() const	{ return fLocked; }

	inline operator bool() const	{ return fLocked; }

protected:
	Lockable*	fLockable;
	Locking		fLocking;
	bool		fLocked;
};


}	// namespace BPrivate

using ::BPrivate::AutoLocker;
using ::BPrivate::AutoLockerHandlerLocking;
using ::BPrivate::AutoLockerReadLocking;
using ::BPrivate::AutoLockerWriteLocking;

#endif	// _AUTO_LOCKER_H