BGE Clean-up: New EXP prefix for the BGE Expression module

The expression module now uses an EXP prefix and it follows a
distribution similar to blender.

Additionally the hash function in EXP_HashedPtr.h was simplified and the
files EXP_C-Api.h &.EXP_C-Api.cpp were deleted because were unused.

Reviewers: campbellbarton, moguri, sybren, hg1

Projects: #game_engine

Differential Revision: https://developer.blender.org/D1221

1 files changed, 149 insertions, 0 deletions

diff --git a/source/gameengine/Expressions/EXP_Expression.h b/source/gameengine/Expressions/EXP_Expression.h
new file mode 100644
index 00000000000..66a6e9476ff
--- /dev/null
+++ b/source/gameengine/Expressions/EXP_Expression.h
@@ -0,0 +1,149 @@
+/*
+ * Expression.h: interface for the CExpression class.
+ * Copyright (c) 1996-2000 Erwin Coumans <coockie@acm.org>
+ *
+ * Permission to use, copy, modify, distribute and sell this software
+ * and its documentation for any purpose is hereby granted without fee,
+ * provided that the above copyright notice appear in all copies and
+ * that both that copyright notice and this permission notice appear
+ * in supporting documentation.  Erwin Coumans makes no
+ * representations about the suitability of this software for any
+ * purpose.  It is provided "as is" without express or implied warranty.
+ *
+ */
+
+/** \file EXP_Expression.h
+ *  \ingroup expressions
+ */
+
+#ifndef __EXP_EXPRESSION_H__
+#define __EXP_EXPRESSION_H__
+
+#include "EXP_Value.h"
+
+//extern int gRefCountExpr; // only for debugging purposes (detect mem.leaks)
+
+
+#define PLUGIN_DECLARE_SERIAL_EXPRESSION(class_name, base_class_name)          \
+public:                                                                        \
+	virtual base_class_name * Copy() {                                         \
+		return new class_name;                                                 \
+	}                                                                          \
+	virtual bool EdSerialize(CompressorArchive& arch,                          \
+	                         class CFactoryManager* facmgr,                    \
+	                         bool bIsStoring);                                 \
+	virtual bool EdIdSerialize(CompressorArchive& arch,                        \
+	                           class CFactoryManager* facmgr,                  \
+	                           bool bIsStoring)                                \
+	{                                                                          \
+		if (bIsStoring)                                                        \
+		{                                                                      \
+			unsigned char exprID = GetExpressionID();                          \
+			arch << exprID;                                                    \
+		}                                                                      \
+		return true;                                                           \
+	}                                                                          \
+
+
+
+class CExpression;
+
+
+// for undo/redo system the deletion in the expressiontree can be restored by replacing broken links 'inplace'
+class CBrokenLinkInfo
+{
+	public:
+		CBrokenLinkInfo(CExpression** pmemexpr,CExpression* expr)
+			:m_pmemExpr(pmemexpr),
+			m_pExpr(expr)
+		 { 
+			assertd(pmemexpr);
+			m_bRestored=false;
+		};
+
+		virtual ~CBrokenLinkInfo();
+		void RestoreLink();
+		void BreakLink();
+		
+		
+	// members vars
+	private:
+	CExpression** m_pmemExpr;
+	CExpression* m_pExpr;
+	bool		m_bRestored;
+	
+	
+#ifdef WITH_CXX_GUARDEDALLOC
+	MEM_CXX_CLASS_ALLOC_FUNCS("GE:CBrokenLinkInfo")
+#endif
+};
+
+
+
+
+
+
+
+
+class CExpression  
+{
+public:
+	enum {
+			COPERATOR1EXPRESSIONID = 1,
+			COPERATOR2EXPRESSIONID = 2,
+			CCONSTEXPRESSIONID = 3,
+			CIFEXPRESSIONID = 4,
+			COPERATORVAREXPRESSIONID = 5,
+			CIDENTIFIEREXPRESSIONID = 6
+	};
+
+
+protected:
+	virtual				~CExpression() = 0;			//pure virtual
+public:
+	virtual bool MergeExpression(CExpression* otherexpr) = 0;
+	CExpression();
+
+	
+	virtual				CValue* Calculate() = 0;	//pure virtual
+	virtual	unsigned char GetExpressionID() = 0;
+	//virtual bool		IsInside(float x,float y,float z,bool bBorderInclude=true) = 0;		//pure virtual
+	virtual bool		NeedsRecalculated() = 0; // another pure one
+	virtual CExpression * CheckLink(std::vector<CBrokenLinkInfo*>& brokenlinks) =0; // another pure one
+	virtual void				ClearModified() = 0; // another pure one
+	//virtual CExpression * Copy() =0;
+	virtual void		BroadcastOperators(VALUE_OPERATOR op) =0;
+
+	virtual CExpression * AddRef() { // please leave multiline, for debugger !!!
+
+#ifdef DEBUG
+		//gRefCountExpr++;
+		assertd(m_refcount < 255);
+#endif
+		m_refcount++; 
+		return this;
+	};
+	virtual CExpression* Release(CExpression* complicatedtrick=NULL) { 
+#ifdef DEBUG
+		//gRefCountExpr--;
+#endif
+		if (--m_refcount < 1) 
+		{
+			delete this;
+		} //else
+		//	return this;
+		return complicatedtrick;
+	};
+	
+
+protected:
+
+	int m_refcount;
+
+
+#ifdef WITH_CXX_GUARDEDALLOC
+	MEM_CXX_CLASS_ALLOC_FUNCS("GE:CExpression")
+#endif
+};
+
+#endif  /* __EXP_EXPRESSION_H__ */