Common: Move the Event class to a separate file, and add tests for it. Fix includes everywhere to match this.

Source/Core/AudioCommon/AOSoundStream.h

@@ -5,7 +5,9 @@
 #pragma once
 
 #include "AudioCommon/SoundStream.h"
-#include "Common/Thread.h"
+#include "Common/Event.h"
+#include "Common/StdMutex.h"
+#include "Common/StdThread.h"
 
 #if defined(HAVE_AO) && HAVE_AO
 #include <ao/ao.h>

Source/Core/AudioCommon/DSoundStream.cpp

@@ -9,6 +9,8 @@
 
 #include "AudioCommon/AudioCommon.h"
 #include "AudioCommon/DSoundStream.h"
+#include "Common/StdThread.h"
+#include "Common/Thread.h"
 
 bool DSound::CreateBuffer()
 {

Source/Core/AudioCommon/DSoundStream.h

@@ -5,7 +5,8 @@
 #pragma once
 
 #include "AudioCommon/SoundStream.h"
-#include "Common/Thread.h"
+#include "Common/Event.h"
+#include "Common/StdThread.h"
 
 #ifdef _WIN32
 #include <Windows.h>

Source/Core/AudioCommon/OpenALStream.cpp

@@ -5,6 +5,8 @@
 #include "AudioCommon/aldlist.h"
 #include "AudioCommon/DPL2Decoder.h"
 #include "AudioCommon/OpenALStream.h"
+#include "Common/StdThread.h"
+#include "Common/Thread.h"
 
 #if defined HAVE_OPENAL && HAVE_OPENAL
 

Source/Core/AudioCommon/OpenALStream.h

@@ -5,7 +5,8 @@
 #pragma once
 
 #include "AudioCommon/SoundStream.h"
-#include "Common/Thread.h"
+#include "Common/Event.h"
+#include "Common/StdThread.h"
 #include "Core/Core.h"
 #include "Core/HW/AudioInterface.h"
 #include "Core/HW/SystemTimers.h"

Source/Core/AudioCommon/OpenSLESStream.h

@@ -5,7 +5,8 @@
 #pragma once
 
 #include "AudioCommon/SoundStream.h"
-#include "Common/Thread.h"
+#include "Common/Event.h"
+#include "Common/StdThread.h"
 
 class OpenSLESStream final : public SoundStream
 {

Source/Core/AudioCommon/XAudio2Stream.cpp

@@ -5,6 +5,7 @@
 #include <xaudio2.h>
 #include "AudioCommon/AudioCommon.h"
 #include "AudioCommon/XAudio2Stream.h"
+#include "Common/Event.h"
 
 #ifndef XAUDIO2_DLL
 #error You are building this module against the wrong version of DirectX. You probably need to remove DXSDK_DIR from your include path.

Source/Core/AudioCommon/XAudio2Stream.h

@@ -11,7 +11,7 @@
 #include <memory>
 
 #include "AudioCommon/SoundStream.h"
-#include "Common/Thread.h"
+#include "Common/Event.h"
 
 #ifdef _WIN32
 

Source/Core/AudioCommon/XAudio2_7Stream.cpp

@@ -9,6 +9,7 @@
 
 #include "AudioCommon/AudioCommon.h"
 #include "AudioCommon/XAudio2_7Stream.h"
+#include "Common/Event.h"
 
 #ifdef HAVE_DXSDK
 #include <dxsdkver.h>

Source/Core/AudioCommon/XAudio2_7Stream.h

@@ -14,7 +14,7 @@
 
 #include <memory>
 #include "AudioCommon/SoundStream.h"
-#include "Common/Thread.h"
+#include "Common/Event.h"
 
 #ifdef _WIN32
 

Source/Core/Common/Event.h

@@ -0,0 +1,59 @@
+// Copyright 2014 Dolphin Emulator Project
+// Licensed under GPLv2
+// Refer to the license.txt file included.
+
+// Multithreaded event class. This allows waiting in a thread for an event to
+// be triggered in another thread. While waiting, the CPU will be available for
+// other tasks.
+// * Set(): triggers the event and wakes up the waiting thread.
+// * Wait(): waits for the event to be triggered.
+// * Reset(): tries to reset the event before the waiting thread sees it was
+//            triggered. Usually a bad idea.
+
+#pragma once
+
+#include "Common/StdConditionVariable.h"
+#include "Common/StdMutex.h"
+
+namespace Common {
+
+class Event
+{
+public:
+	Event()
+		: is_set(false)
+	{}
+
+	void Set()
+	{
+		std::lock_guard<std::mutex> lk(m_mutex);
+		if (!is_set)
+		{
+			is_set = true;
+			m_condvar.notify_one();
+		}
+	}
+
+	void Wait()
+	{
+		std::unique_lock<std::mutex> lk(m_mutex);
+		m_condvar.wait(lk, [&]{ return is_set; });
+		is_set = false;
+	}
+
+	void Reset()
+	{
+		std::unique_lock<std::mutex> lk(m_mutex);
+		// no other action required, since wait loops on
+		// the predicate and any lingering signal will get
+		// cleared on the first iteration
+		is_set = false;
+	}
+
+private:
+	volatile bool is_set;
+	std::condition_variable m_condvar;
+	std::mutex m_mutex;
+};
+
+}  // namespace Common

Source/Core/Common/Thread.h

@@ -32,45 +32,6 @@ int CurrentThreadId();
 void SetThreadAffinity(std::thread::native_handle_type thread, u32 mask);
 void SetCurrentThreadAffinity(u32 mask);
 
-class Event
-{
-public:
-	Event()
-		: is_set(false)
-	{}
-
-	void Set()
-	{
-		std::lock_guard<std::mutex> lk(m_mutex);
-		if (!is_set)
-		{
-			is_set = true;
-			m_condvar.notify_one();
-		}
-	}
-
-	void Wait()
-	{
-		std::unique_lock<std::mutex> lk(m_mutex);
-		m_condvar.wait(lk, [&]{ return is_set; });
-		is_set = false;
-	}
-
-	void Reset()
-	{
-		std::unique_lock<std::mutex> lk(m_mutex);
-		// no other action required, since wait loops on
-		// the predicate and any lingering signal will get
-		// cleared on the first iteration
-		is_set = false;
-	}
-
-private:
-	volatile bool is_set;
-	std::condition_variable m_condvar;
-	std::mutex m_mutex;
-};
-
 // TODO: doesn't work on windows with (count > 2)
 class Barrier
 {

Source/Core/Core/DSP/DSPCore.cpp

@@ -24,10 +24,10 @@
    ====================================================================*/
 
 #include "Common/Common.h"
+#include "Common/Event.h"
 #include "Common/FileUtil.h"
 #include "Common/Hash.h"
 #include "Common/MemoryUtil.h"
-#include "Common/Thread.h"
 
 #include "Core/DSP/DSPAnalyzer.h"
 #include "Core/DSP/DSPCore.h"

Source/Core/Core/HW/CPU.cpp

@@ -5,7 +5,8 @@
 #include "AudioCommon/AudioCommon.h"
 
 #include "Common/Common.h"
-#include "Common/Thread.h"
+#include "Common/Event.h"
+#include "Common/StdMutex.h"
 
 #include "Core/Core.h"
 #include "Core/DSPEmulator.h"

Source/Core/Core/HW/DSPLLE/DSPLLE.cpp

@@ -7,9 +7,11 @@
 #include "Common/Common.h"
 #include "Common/CommonPaths.h"
 #include "Common/CPUDetect.h"
+#include "Common/Event.h"
 #include "Common/IniFile.h"
 #include "Common/LogManager.h"
-#include "Common/Thread.h"
+#include "Common/StdMutex.h"
+#include "Common/StdThread.h"
 
 #include "Core/ConfigManager.h"
 #include "Core/Core.h"

Source/Core/Core/State.cpp

@@ -5,8 +5,10 @@
 #include <lzo/lzo1x.h>
 
 #include "Common/Common.h"
+#include "Common/Event.h"
+#include "Common/StdMutex.h"
+#include "Common/StdThread.h"
 #include "Common/StringUtil.h"
-#include "Common/Thread.h"
 #include "Common/Timer.h"
 
 #include "Core/ConfigManager.h"

Source/Core/DolphinWX/Debugger/CodeWindow.h

@@ -14,7 +14,7 @@
 #include <wx/windowid.h>
 
 #include "Common/CommonTypes.h"
-#include "Common/Thread.h"
+#include "Common/Event.h"
 #include "DolphinWX/Globals.h"
 
 class CFrame;

Source/Core/DolphinWX/Frame.h

@@ -22,7 +22,7 @@
 #include <wx/windowid.h>
 
 #include "Common/CommonTypes.h"
-#include "Common/Thread.h"
+#include "Common/Event.h"
 #include "DolphinWX/Globals.h"
 #include "InputCommon/GCPadStatus.h"
 

Source/Core/DolphinWX/MainAndroid.cpp

@@ -27,9 +27,9 @@
 #include "Common/Common.h"
 #include "Common/CommonPaths.h"
 #include "Common/CPUDetect.h"
+#include "Common/Event.h"
 #include "Common/FileUtil.h"
 #include "Common/LogManager.h"
-#include "Common/Thread.h"
 #include "Core/BootManager.h"
 #include "Core/ConfigManager.h"
 #include "Core/Core.h"

Source/Core/DolphinWX/MainNoGUI.cpp

@@ -10,8 +10,8 @@
 #include <string>
 
 #include "Common/Common.h"
+#include "Common/Event.h"
 #include "Common/LogManager.h"
-#include "Common/Thread.h"
 
 #include "Core/BootManager.h"
 #include "Core/ConfigManager.h"

Source/UnitTests/Common/CMakeLists.txt

@@ -1,5 +1,6 @@
 add_dolphin_test(BitFieldTest BitFieldTest.cpp common)
 add_dolphin_test(CommonFuncsTest CommonFuncsTest.cpp common)
+add_dolphin_test(EventTest EventTest.cpp common)
 add_dolphin_test(FifoQueueTest FifoQueueTest.cpp common)
 add_dolphin_test(FixedSizeQueueTest FixedSizeQueueTest.cpp common)
 add_dolphin_test(FlagTest FlagTest.cpp common)

Source/UnitTests/Common/EventTest.cpp

@@ -0,0 +1,42 @@
+// Copyright 2014 Dolphin Emulator Project
+// Licensed under GPLv2
+// Refer to the license.txt file included.
+
+#include <gtest/gtest.h>
+#include <thread>
+
+#include "Common/Event.h"
+
+using Common::Event;
+
+TEST(Event, MultiThreaded)
+{
+	Event has_sent, can_send;
+	int shared_obj;
+	const int ITERATIONS_COUNT = 100000;
+
+	auto sender = [&]() {
+		for (int i = 0; i < ITERATIONS_COUNT; ++i)
+		{
+			can_send.Wait();
+			shared_obj = i;
+			has_sent.Set();
+		}
+	};
+
+	auto receiver = [&]() {
+		for (int i = 0; i < ITERATIONS_COUNT; ++i) {
+			has_sent.Wait();
+			EXPECT_EQ(i, shared_obj);
+			can_send.Set();
+		}
+	};
+
+	std::thread sender_thread(sender);
+	std::thread receiver_thread(receiver);
+
+	can_send.Set();
+
+	sender_thread.join();
+	receiver_thread.join();
+}