Add DISABLE_CLASS_COPY macro (and use it)

kwolekr · kwolekr · commit c56d7fe0eba7 · 2015-10-27T22:05:08.000-04:00
Use this macro to disallow copying of an object using the assignment
operator or copy constructor.  This catches otherwise silent-but-deadly
mistakes such as "ServerMap map = env-&gt;getMap();" at compile time.

If so desired, it is still possible to copy a class, but it now requires
an explicit call to memcpy or std::copy.
diff --git a/src/basicmacros.h b/src/basicmacros.h
@@ -30,4 +30,12 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 
 #define CONTAINS(c, v) (std::find((c).begin(), (c).end(), (v)) != (c).end())
 
+// To disable copy constructors and assignment operations for some class
+// 'Foobar', add the macro DISABLE_CLASS_COPY(Foobar) as a private member.
+// Note this also disables copying for any classes derived from 'Foobar' as well
+// as classes having a 'Foobar' member.
+#define DISABLE_CLASS_COPY(C) \
+	C(const C &);             \
+	C &operator=(const C &)
+
 #endif
diff --git a/src/client.h b/src/client.h
@@ -682,6 +682,8 @@ class Client : public con::PeerHandler, public InventoryManager, public IGameDef
 	// TODO: Add callback to update these when g_settings changes
 	bool m_cache_smooth_lighting;
 	bool m_cache_enable_shaders;
+
+	DISABLE_CLASS_COPY(Client);
 };
 
 #endif // !CLIENT_HEADER
diff --git a/src/emerge.h b/src/emerge.h
@@ -164,6 +164,8 @@ class EmergeManager {
 	bool popBlockEmergeData(v3s16 pos, BlockEmergeData *bedata);
 
 	friend class EmergeThread;
+
+	DISABLE_CLASS_COPY(EmergeManager);
 };
 
 #endif
diff --git a/src/environment.h b/src/environment.h
@@ -137,6 +137,7 @@ class Environment
 private:
 	Mutex m_time_lock;
 
+	DISABLE_CLASS_COPY(Environment);
 };
 
 /*
diff --git a/src/map.h b/src/map.h
@@ -365,6 +365,8 @@ class Map /*: public NodeContainer*/
 	u32 m_unprocessed_count;
 	u32 m_inc_trending_up_start_time; // milliseconds
 	bool m_queue_size_timer_started;
+
+	DISABLE_CLASS_COPY(Map);
 };
 
 /*
diff --git a/src/mapgen.h b/src/mapgen.h
@@ -182,6 +182,9 @@ class Mapgen {
 
 	virtual void makeChunk(BlockMakeData *data) {}
 	virtual int getGroundLevelAtPoint(v2s16 p) { return 0; }
+
+private:
+	DISABLE_CLASS_COPY(Mapgen);
 };
 
 struct MapgenFactory {
diff --git a/src/objdef.h b/src/objdef.h
@@ -90,6 +90,9 @@ class ObjDefManager {
 	INodeDefManager *m_ndef;
 	std::vector<ObjDef *> m_objects;
 	ObjDefType m_objtype;
+
+private:
+	DISABLE_CLASS_COPY(ObjDefManager);
 };
 
 #endif
diff --git a/src/server.h b/src/server.h
@@ -649,6 +649,8 @@ class Server : public con::PeerHandler, public MapEventReceiver,
 		Particles
 	*/
 	std::vector<u32> m_particlespawner_ids;
+
+	DISABLE_CLASS_COPY(Server);
 };
 
 /*
diff --git a/src/threading/mutex.h b/src/threading/mutex.h
@@ -44,6 +44,7 @@ DEALINGS IN THE SOFTWARE.
 	#include <pthread.h>
 #endif
 
+#include "basicmacros.h"
 
 class Mutex
 {
@@ -59,6 +60,8 @@ class Mutex
 #else // pthread
 	pthread_mutex_t mutex;
 #endif
+
+	DISABLE_CLASS_COPY(Mutex);
 };
 
 #endif  // C++11
diff --git a/src/threading/semaphore.h b/src/threading/semaphore.h
@@ -28,6 +28,7 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 	#include <semaphore.h>
 #endif
 
+#include "basicmacros.h"
 
 class Semaphore {
 public:
@@ -46,6 +47,8 @@ class Semaphore {
 #else
 	sem_t semaphore;
 #endif
+
+	DISABLE_CLASS_COPY(Semaphore);
 };
 
 #endif
diff --git a/src/threading/thread.h b/src/threading/thread.h
@@ -161,6 +161,7 @@ class Thread {
 	std::thread *m_thread_obj;
 #endif
 
+	DISABLE_CLASS_COPY(Thread);
 };
 
 #endif
