UPBGE: Implement std::vector remove and add utilities.

Two functions are added to replace frequently used behaviour:
remove if an element is found in a list, or add if an element is
not present in a list. The functions CM_ListRemoveIfFound
and CM_ListAddIfNotFound assume these goal, they are defined in
new file CM_List.h.

Author: panzergame

source/gameengine/Common/CM_List.h

@@ -0,0 +1,53 @@
+/*
+ * ***** BEGIN GPL LICENSE BLOCK *****
+ *
+ * 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.
+ *
+ * Contributor(s): Tristan Porteries.
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
+
+/** \file CM_List.h
+ *  \ingroup common
+ */
+
+#ifndef __CM_LIST_H__
+#define __CM_LIST_H__
+
+#include <algorithm>
+
+template <class Item, class List>
+inline bool CM_ListRemoveIfFound(List& list, const Item& item)
+{
+	const typename List::iterator it = std::find(list.begin(), list.end(), item);
+	if (it != list.end()) {
+		list.erase(it);
+		return true;
+	}
+	return false;
+}
+
+template <class Item, class List>
+inline bool CM_ListAddIfNotFound(List& list, const Item& item)
+{
+	if (std::find(list.begin(), list.end(), item) == list.end()) {
+		list.push_back(item);
+		return true;
+	}
+	return false;
+}
+
+#endif  // __CM_LIST_H__

source/gameengine/Common/CMakeLists.txt

@@ -44,6 +44,7 @@ set(SRC
 	CM_Thread.cpp
 
 	CM_Format.h
+	CM_List.h
 	CM_Message.h
 	CM_RefCount.h
 	CM_Thread.h

source/gameengine/Expressions/intern/BaseListValue.cpp

@@ -64,11 +64,7 @@ EXP_Value *EXP_BaseListValue::FindValue(const std::string& name) const
 
 bool EXP_BaseListValue::SearchValue(EXP_Value *val) const
 {
-	const VectorTypeConstIterator it = std::find(m_pValueArray.begin(), m_pValueArray.end(), val);
-	if (it != m_pValueArray.end()) {
-		return true;
-	}
-	return false;
+	return (std::find(m_pValueArray.begin(), m_pValueArray.end(), val) != m_pValueArray.end());
 }
 
 void EXP_BaseListValue::Add(EXP_Value *value)

source/gameengine/GameLogic/SCA_EventManager.cpp

@@ -33,6 +33,7 @@
 #include "SCA_EventManager.h"
 #include "SCA_ISensor.h"
 
+#include "CM_List.h"
 
 SCA_EventManager::SCA_EventManager(SCA_LogicManager* logicmgr, EVENT_MANAGER_TYPE mgrtype)
 	:m_logicmgr(logicmgr),
@@ -50,23 +51,12 @@ SCA_EventManager::~SCA_EventManager()
 
 bool SCA_EventManager::RegisterSensor(class SCA_ISensor* sensor)
 {
-	if (std::find(m_sensors.begin(), m_sensors.end(), sensor) == m_sensors.end()) {
-		m_sensors.push_back(sensor);
-		return true;
-	}
-
-	return false;
+	return CM_ListAddIfNotFound(m_sensors, sensor);
 }
 
 bool SCA_EventManager::RemoveSensor(class SCA_ISensor* sensor)
 {
-	std::vector<SCA_ISensor *>::iterator it = std::find(m_sensors.begin(), m_sensors.end(), sensor);
-	if (it != m_sensors.end()) {
-		m_sensors.erase(it);
-		return true;
-	}
-
-	return false;
+	return CM_ListRemoveIfFound(m_sensors, sensor);
 }
 
 void SCA_EventManager::NextFrame(double curtime, double fixedtime)

source/gameengine/GameLogic/SCA_IActuator.cpp

@@ -31,9 +31,9 @@
 
 
 #include "SCA_IActuator.h"
-#include "CM_Message.h"
 
-#include <algorithm>
+#include "CM_Message.h"
+#include "CM_List.h"
 
 SCA_IActuator::SCA_IActuator(SCA_IObject *gameobj, KX_ACTUATOR_TYPE type) :
 	SCA_ILogicBrick(gameobj),
@@ -153,11 +153,7 @@ void SCA_IActuator::LinkToController(SCA_IController *controller)
 
 void SCA_IActuator::UnlinkController(SCA_IController *controller)
 {
-	std::vector<SCA_IController *>::iterator it = std::find(m_linkedcontrollers.begin(), m_linkedcontrollers.end(), controller);
-	if (it != m_linkedcontrollers.end()) {
-		m_linkedcontrollers.erase(it);
-	}
-	else {
+	if (!CM_ListRemoveIfFound(m_linkedcontrollers, controller)) {
 		CM_LogicBrickWarning(this, "Missing link from actuator " << m_gameobj->GetName() << ":"
 			<< GetName() << " to controller " << controller->GetParent()->GetName() << ":" << controller->GetName());
 	}

source/gameengine/GameLogic/SCA_IController.cpp

@@ -35,6 +35,7 @@
 #include "EXP_ListWrapper.h"
 
 #include "CM_Message.h"
+#include "CM_List.h"
 
 #include <algorithm>
 
@@ -91,9 +92,7 @@ void SCA_IController::LinkToActuator(SCA_IActuator *actua)
 
 void SCA_IController::UnlinkActuator(SCA_IActuator *actua)
 {
-	std::vector<SCA_IActuator *>::iterator it = std::find(m_linkedactuators.begin(), m_linkedactuators.end(), actua);
-	if (it != m_linkedactuators.end()) {
-		m_linkedactuators.erase(it);
+	if (CM_ListRemoveIfFound(m_linkedactuators, actua)) {
 		if (IsActive()) {
 			actua->DecLink();
 		}
@@ -114,9 +113,7 @@ void SCA_IController::LinkToSensor(SCA_ISensor *sensor)
 
 void SCA_IController::UnlinkSensor(SCA_ISensor *sensor)
 {
-	std::vector<SCA_ISensor *>::iterator it = std::find(m_linkedsensors.begin(), m_linkedsensors.end(), sensor);
-	if (it != m_linkedsensors.end()) {
-		m_linkedsensors.erase(it);
+	if (CM_ListRemoveIfFound(m_linkedsensors, sensor)) {
 		if (IsActive()) {
 			sensor->DecLink();
 		}

source/gameengine/GameLogic/SCA_ISensor.cpp

@@ -39,6 +39,7 @@
 #include "SCA_PythonController.h"
 
 #include "CM_Message.h"
+#include "CM_List.h"
 
 void SCA_ISensor::ReParent(SCA_IObject *parent)
 {
@@ -218,11 +219,7 @@ void SCA_ISensor::LinkToController(SCA_IController *controller)
 
 void SCA_ISensor::UnlinkController(SCA_IController *controller)
 {
-	std::vector<SCA_IController *>::iterator it = std::find(m_linkedcontrollers.begin(), m_linkedcontrollers.end(), controller);
-	if (it != m_linkedcontrollers.end()) {
-		m_linkedcontrollers.erase(it);
-	}
-	else {
+	if (!CM_ListRemoveIfFound(m_linkedcontrollers, controller)) {
 		CM_LogicBrickWarning(this, "missing link from sensor " << m_gameobj->GetName() << ":" << GetName()
 			<< " to controller " << controller->GetParent()->GetName() << ":" << controller->GetName());
 	}

source/gameengine/GameLogic/SCA_PythonController.cpp

@@ -135,14 +135,7 @@ void SCA_PythonController::SetScriptName(const std::string& name)
 
 bool SCA_PythonController::IsTriggered(class SCA_ISensor* sensor)
 {
-	if (std::find(m_triggeredSensors.begin(), m_triggeredSensors.end(), sensor) != 
-		m_triggeredSensors.end())
-	{
-		return true;
-	}
-	else {
-		return false;
-	}
+	return (std::find(m_triggeredSensors.begin(), m_triggeredSensors.end(), sensor) != m_triggeredSensors.end());
 }
 
 #ifdef WITH_PYTHON

source/gameengine/GameLogic/SCA_TimeEventManager.cpp

@@ -40,6 +40,8 @@
 #include "SCA_LogicManager.h"
 #include "EXP_FloatValue.h"
 
+#include "CM_List.h"
+
 SCA_TimeEventManager::SCA_TimeEventManager(SCA_LogicManager* logicmgr)
 : SCA_EventManager(nullptr, TIME_EVENTMGR)
 {
@@ -100,10 +102,7 @@ void SCA_TimeEventManager::AddTimeProperty(EXP_Value* timeval)
 
 void SCA_TimeEventManager::RemoveTimeProperty(EXP_Value* timeval)
 {
-	std::vector<EXP_Value *>::iterator it = std::find(m_timevalues.begin(), m_timevalues.end(), timeval);
-	if (it != m_timevalues.end()) {
-		m_timevalues.erase(it);
-	}
+	CM_ListRemoveIfFound(m_timevalues, timeval);
 }
 
 std::vector<EXP_Value*> SCA_TimeEventManager::GetTimeValues()

source/gameengine/Ketsji/KX_PythonComponentManager.cpp

@@ -2,6 +2,8 @@
 #include "KX_PythonComponent.h"
 #include "KX_GameObject.h"
 
+#include "CM_List.h"
+
 KX_PythonComponentManager::KX_PythonComponentManager()
 {
 }
@@ -18,10 +20,7 @@ void KX_PythonComponentManager::RegisterObject(KX_GameObject *gameobj)
 
 void KX_PythonComponentManager::UnregisterObject(KX_GameObject *gameobj)
 {
-	std::vector<KX_GameObject *>::iterator it = std::find(m_objects.begin(), m_objects.end(), gameobj);
-	if (it != m_objects.end()) {
-		m_objects.erase(it);
-	}
+	CM_ListRemoveIfFound(m_objects, gameobj);
 }
 
 void KX_PythonComponentManager::UpdateComponents()