CodeGenMacros.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines
#define	FOREACH(iterName, collectionType, collectionName)   collectionType::const_iterator iterName; collectionType::const_iterator __endIter = collectionName.end(); for(iterName = collectionName.begin(); iterName != __endIter; ++iterName)
#define	GET(name, type, value)   type name() const { return value; }
#define	GET_FLAG(name, type, value)   bool name(type checkValue) { return (value|checkValue) > 0; }
#define	GET_NONCONST(name, type, value)   type name() { return value; }
#define	GET_SET(getName, setName, type, val)   INLINE type getName() const { return val; } INLINE void setName(type newValue) { val = newValue; }
#define	INLINE   __inline
#define	SET(name, type, value)   void name(type val) { value = val; }
#define	SET_DECL(name, type)   void name(type val);
#define	SET_FLAG(name, type, value)   void name(type newValue) { value |= newValue; }
#define	UNSET_FLAG(name, type, value)   void name(type newValue) { value &= !newValue; }

---

Define Documentation

#define FOREACH	(		iterName,
			collectionType,
			collectionName
	)		collectionType::const_iterator iterName; collectionType::const_iterator __endIter = collectionName.end(); for(iterName = collectionName.begin(); iterName != __endIter; ++iterName)

This macro defines a for loop using an iterator over a list ListName is the name of the list variable collectionType is the type of collection (EG std::list<Type>) collectionName is the name of the iterator variable created in the code NOTE: this also implicitly declares

Definition at line 70 of file CodeGenMacros.h.

Referenced by CommandInvoker::clearRedo(), CommandInvoker::clearUndo(), CompositeCommand::execute(), CompositeCommand::undo(), CompositeCommand::~CompositeCommand(), and ObjectPool< TimedTask >::~ObjectPool().

#define GET	(		name,
			type,
			value
	)		type name() const { return value; }

This macro defines & implements a generic "get" function that is const Name is the name of the function Type is the type returned by the function Value is the variable retrieved by the function

Definition at line 24 of file CodeGenMacros.h.

#define GET_FLAG	(		name,
			type,
			value
	)		bool name(type checkValue) { return (value|checkValue) > 0; }

Definition at line 61 of file CodeGenMacros.h.

#define GET_NONCONST	(		name,
			type,
			value
	)		type name() { return value; }

This macro defines & implements a generic "get" function This version is NOT marked as const Name is the name of the function Type is the type returned by the function Value is the variable retrieved by the function

Definition at line 33 of file CodeGenMacros.h.

#define GET_SET	(		getName,
			setName,
			type,
			val
	)		INLINE type getName() const { return val; } INLINE void setName(type newValue) { val = newValue; }

Macro declares a generic "get" and "set" function NOTE: The functions are declared with INLINE as it appears above

Definition at line 53 of file CodeGenMacros.h.

#define INLINE   __inline

Declares a function as inline It will be expanded inplace at compile-time to speed up (with a tradeoff in app size)

Definition at line 16 of file CodeGenMacros.h.

#define SET	(		name,
			type,
			value
	)		void name(type val) { value = val; }

This macro defines & implements a generic "set" function Name is the name of the function Type is the type passed in value is the variable set by this function

Definition at line 41 of file CodeGenMacros.h.

#define SET_DECL	(		name,
			type
	)		void name(type val);

Macro declares a generic "set" function NOTE: This only defines the function, it does NOT implement it

Definition at line 47 of file CodeGenMacros.h.

#define SET_FLAG	(		name,
			type,
			value
	)		void name(type newValue) { value |= newValue; }

These macros are intended to work on a member that accumulates flags The member may be an integer, but these were implemented assuming an enum type

Definition at line 59 of file CodeGenMacros.h.

#define UNSET_FLAG	(		name,
			type,
			value
	)		void name(type newValue) { value &= !newValue; }

Definition at line 60 of file CodeGenMacros.h.