1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
|
/*
Copyright (C) 2005-2007 Feeling Software Inc.
Portions of the code are:
Copyright (C) 2005-2007 Sony Computer Entertainment America
MIT License: http://www.opensource.org/licenses/mit-license.php
*/
/*
This file was taken off the Protect project on 26-09-2005
*/
#ifndef _FU_FUNCTOR_H_
#define _FU_FUNCTOR_H_
/**
A functor with no arguments.
@ingroup FUtils
*/
template<class ReturnType>
class IFunctor0
{
public:
/** Destructor. */
virtual ~IFunctor0() {}
/** Calls the functor.
@return Implementation-dependant. */
virtual ReturnType operator()() const = 0;
/** Checks whether this functor points towards the given member function.
@param object The object which holds the member function.
@param function The member function.
@return Whether this functor points towards the given member function. */
virtual bool Compare(void* object, void* function) const = 0;
/** Returns a copy of this functor */
virtual IFunctor0<ReturnType>* Copy() const = 0;
};
/**
A functor with no arguments.
@ingroup FUtils
*/
template<class Class, class ReturnType>
class FUFunctor0 : public IFunctor0<ReturnType>
{
private:
Class* m_pObject;
ReturnType (Class::*m_pFunction) ();
public:
/** Constructor.
@param object An object.
@param function A member function of this object. */
FUFunctor0(Class* object, ReturnType (Class::*function) ()) { m_pObject = object; m_pFunction = function; }
/** Destructor. */
virtual ~FUFunctor0() {}
/** Calls the functor.
@return Implementation-dependant. */
virtual ReturnType operator()() const
{ return ((*m_pObject).*m_pFunction)(); }
/** Checks whether this functor points towards the given member function.
@param object The object which holds the member function.
@param function The member function.
@return Whether this functor points towards the given member function. */
virtual bool Compare(void* object, void* function) const
{ return object == m_pObject && (size_t)function == *(size_t*)&m_pFunction; }
/** Returns a copy of this functor */
virtual IFunctor0<ReturnType>* Copy() const
{ return new FUFunctor0<Class, ReturnType>(m_pObject, m_pFunction); }
};
/** Shortcut for new FUFunctor0<>.
@param o An object.
@param function A member function. */
template <class ClassName, class ReturnType>
inline FUFunctor0<ClassName, ReturnType>* NewFUFunctor0(ClassName* o, ReturnType (ClassName::*function) ())
{
return new FUFunctor0<ClassName, ReturnType>(o, function);
}
/**
A pseudo-functor with no arguments, specialized for static functions.
@ingroup FUtils
*/
template<class ReturnType>
class FUStaticFunctor0 : public IFunctor0<ReturnType>
{
private:
ReturnType (*m_pFunction) ();
public:
/** Constructor.
@param function A static function. */
FUStaticFunctor0(ReturnType (*function) ()) { m_pFunction = function; }
/** Destructor. */
virtual ~FUStaticFunctor0() {}
/** Calls the functor.
@return Implementation-dependant. */
virtual ReturnType operator()() const
{ return (*m_pFunction)(); }
/** Checks whether this pseudo-functor points towards the given function.
@param UNUSED Unused.
@param function The static function.
@return Whether this pseudo-functor points towards the given function. */
virtual bool Compare(void* UNUSED(object), void* function) const
{ return (size_t)function == *(size_t*)(size_t)&m_pFunction; }
/** Returns a copy of this functor */
virtual IFunctor0<ReturnType>* Copy() const
{ return new FUStaticFunctor0<ReturnType>(m_pFunction); }
};
/**
A functor with one argument.
@ingroup FUtils
*/
template<class Arg1, class ReturnType>
class IFunctor1
{
public:
/** Destructor. */
virtual ~IFunctor1() {}
/** Calls the functor.
@param argument1 A first argument.
@return Implementation-dependant. */
virtual ReturnType operator()(Arg1 argument1) const = 0;
/** Checks whether this functor points towards the given member function.
@param object The object which holds the member function.
@param function The member function.
@return Whether this functor points towards the given member function. */
virtual bool Compare(void* object, void* function) const = 0;
/** Returns a copy of this functor */
virtual IFunctor1<Arg1, ReturnType>* Copy() const = 0;
};
/**
A functor with one arguments.
@ingroup FUtils
*/
template<class Class, class Arg1, class ReturnType>
class FUFunctor1 : public IFunctor1<Arg1, ReturnType>
{
private:
Class* m_pObject;
ReturnType (Class::*m_pFunction) (Arg1);
public:
/** Constructor.
@param object An object.
@param function A member function of this object. */
FUFunctor1(Class* object, ReturnType (Class::*function) (Arg1)) { m_pObject = object; m_pFunction = function; }
/** Destructor. */
virtual ~FUFunctor1() {}
/** Calls the functor.
@param argument1 A first argument.
@return Implementation-dependant. */
virtual ReturnType operator()(Arg1 argument1) const
{ return ((*m_pObject).*m_pFunction)(argument1); }
/** Checks whether this functor points towards the given member function.
@param object The object which holds the member function.
@param function The member function.
@return Whether this functor points towards the given member function. */
virtual bool Compare(void* object, void* function) const
{ return object == m_pObject && (size_t)function == *(size_t*)(size_t)&m_pFunction; }
/** Returns a copy of this functor */
virtual IFunctor1<Arg1, ReturnType>* Copy() const
{ return new FUFunctor1<Class, Arg1, ReturnType>(m_pObject, m_pFunction); }
};
/** Shortcut for new FUFunctor1<>.
@param o An object.
@param function A member function. */
template <class ClassName, class Argument1, class ReturnType>
inline FUFunctor1<ClassName, Argument1, ReturnType>* NewFUFunctor1(ClassName* o, ReturnType (ClassName::*function) (Argument1))
{
return new FUFunctor1<ClassName, Argument1, ReturnType>(o, function);
}
/**
A pseudo-functor with one arguments, specialized for static functions.
@ingroup FUtils
*/
template<class Arg1, class ReturnType>
class FUStaticFunctor1 : public IFunctor1<Arg1, ReturnType>
{
private:
ReturnType (*m_pFunction) (Arg1);
public:
/** Constructor.
@param function A static function. */
FUStaticFunctor1(ReturnType (*function) (Arg1)) { m_pFunction = function; }
/** Destructor. */
virtual ~FUStaticFunctor1() {}
/** Calls the functor.
@param argument1 A first argument.
@return Implementation-dependant. */
virtual ReturnType operator()(Arg1 argument1) const
{ return (*m_pFunction)(argument1); }
/** Checks whether this pseudo-functor points towards the given function.
@param UNUSED Unused.
@param function The static function.
@return Whether this pseudo-functor points towards the given function. */
virtual bool Compare(void* UNUSED(object), void* function) const
{ return (size_t)function == *(size_t*)(size_t)&m_pFunction; }
/** Returns a copy of this functor */
virtual IFunctor1<Arg1, ReturnType>* Copy() const
{ return new FUStaticFunctor1<Arg1, ReturnType>(m_pFunction); }
};
/**
A functor with two arguments.
@ingroup FUtils
*/
template<class Arg1, class Arg2, class ReturnType>
class IFunctor2
{
public:
/** Destructor. */
virtual ~IFunctor2() {}
/** Calls the functor.
@param argument1 A first argument.
@param argument2 A second argument.
@return Implementation-dependant. */
virtual ReturnType operator()(Arg1 argument1, Arg2 argument2) const = 0;
/** Checks whether this functor points towards the given member function.
@param object The object which holds the member function.
@param function The member function.
@return Whether this functor points towards the given member function. */
virtual bool Compare(void* object, void* function) const = 0;
/** Returns a copy of this functor */
virtual IFunctor2<Arg1, Arg2, ReturnType>* Copy() const = 0;
};
/**
A functor with two arguments.
@ingroup FUtils
*/
template<class Class, class Arg1, class Arg2, class ReturnType>
class FUFunctor2 : public IFunctor2<Arg1, Arg2, ReturnType>
{
private:
Class* m_pObject;
ReturnType (Class::*m_pFunction) (Arg1, Arg2);
public:
/** Constructor.
@param object An object.
@param function A member function of this object. */
FUFunctor2(Class* object, ReturnType (Class::*function) (Arg1, Arg2)) { m_pObject = object; m_pFunction = function; }
/** Destructor. */
virtual ~FUFunctor2() {}
/** Calls the functor.
@param argument1 A first argument.
@param argument2 A second argument.
@return Implementation-dependant. */
virtual ReturnType operator()(Arg1 argument1, Arg2 argument2) const
{ return ((*m_pObject).*m_pFunction)(argument1, argument2); }
/** Checks whether this functor points towards the given member function.
@param object The object which holds the member function.
@param function The member function.
@return Whether this functor points towards the given member function. */
virtual bool Compare(void* object, void* function) const
{ return object == m_pObject && (size_t)function == *(size_t*)(size_t)&m_pFunction; }
/** Returns a copy of this functor */
virtual IFunctor2<Arg1, Arg2, ReturnType>* Copy() const
{ return new FUFunctor2<Class, Arg1, Arg2, ReturnType>(m_pObject, m_pFunction); }
};
/** Shortcut for new FUFunctor2<>.
@param o An object.
@param function A member function. */
template <class ClassName, class Argument1, class Argument2, class ReturnType>
inline FUFunctor2<ClassName, Argument1, Argument2, ReturnType>* NewFUFunctor2(ClassName* o, ReturnType (ClassName::*function) (Argument1, Argument2))
{
return new FUFunctor2<ClassName, Argument1, Argument2, ReturnType>(o, function);
}
/**
A pseudo-functor with two arguments, specialized for static functions.
@ingroup FUtils
*/
template<class Arg1, class Arg2, class ReturnType>
class FUStaticFunctor2 : public IFunctor2<Arg1, Arg2, ReturnType>
{
private:
ReturnType (*m_pFunction) (Arg1, Arg2);
public:
/** Constructor.
@param function A static function. */
FUStaticFunctor2(ReturnType (*function) (Arg1, Arg2)) { m_pFunction = function; }
/** Destructor. */
virtual ~FUStaticFunctor2() {}
/** Calls the functor.
@param argument1 A first argument.
@param argument2 A second argument.
@return Implementation-dependant. */
virtual ReturnType operator()(Arg1 argument1, Arg2 argument2) const
{ return (*m_pFunction)(argument1, argument2); }
/** Checks whether this pseudo-functor points towards the given function.
@param UNUSED Unused.
@param function The static function.
@return Whether this pseudo-functor points towards the given function. */
virtual bool Compare(void* UNUSED(object), void* function) const
{ return (size_t)function == *(size_t*)(size_t)&m_pFunction; }
/** Returns a copy of this functor */
virtual IFunctor2<Arg1, Arg2, ReturnType>* Copy() const
{ return new FUStaticFunctor2<Arg1, Arg2, ReturnType>(m_pFunction); }
};
/**
A functor with three arguments.
@ingroup FUtils
*/
template<class Arg1, class Arg2, class Arg3, class ReturnType>
class IFunctor3
{
public:
/** Destructor. */
virtual ~IFunctor3() {}
/** Calls the functor.
@param argument1 A first argument.
@param argument2 A second argument.
@param argument3 A third argument.
@return Implementation-dependant. */
virtual ReturnType operator()(Arg1 argument1, Arg2 argument2, Arg3 argument3) const = 0;
/** Checks whether this functor points towards the given member function.
@param object The object which holds the member function.
@param function The member function.
@return Whether this functor points towards the given member function. */
virtual bool Compare(void* object, void* function) const = 0;
/** Returns a copy of this functor */
virtual IFunctor3<Arg1, Arg2, Arg3, ReturnType>* Copy() const = 0;
};
/**
A functor with three arguments.
@ingroup FUtils
*/
template<class Class, class Arg1, class Arg2, class Arg3, class ReturnType>
class FUFunctor3 : public IFunctor3<Arg1, Arg2, Arg3, ReturnType>
{
private:
Class* m_pObject;
ReturnType (Class::*m_pFunction) (Arg1, Arg2, Arg3);
public:
/** Constructor.
@param object An object.
@param function A member function of this object. */
FUFunctor3(Class* object, ReturnType (Class::*function) (Arg1, Arg2, Arg3)) { m_pObject = object; m_pFunction = function; }
/** Destructor. */
virtual ~FUFunctor3() {}
/** Calls the functor.
@param argument1 A first argument.
@param argument2 A second argument.
@param argument3 A third argument.
@return Implementation-dependant. */
virtual ReturnType operator()(Arg1 argument1, Arg2 argument2, Arg3 argument3) const
{ return ((*m_pObject).*m_pFunction)(argument1, argument2, argument3); }
/** Checks whether this functor points towards the given member function.
@param object The object which holds the member function.
@param function The member function.
@return Whether this functor points towards the given member function. */
virtual bool Compare(void* object, void* function) const
{ return object == m_pObject && (size_t)function == *(size_t*)(size_t)&m_pFunction; }
/** Returns a copy of this functor */
virtual IFunctor3<Arg1, Arg2, Arg3, ReturnType>* Copy() const
{ return new FUFunctor3<Class, Arg1, Arg2, Arg3, ReturnType>(m_pObject, m_pFunction); };
};
/** Shortcut for new FUFunctor2<>.
@param o An object.
@param function A member function. */
template <class ClassName, class Argument1, class Argument2, class Argument3, class ReturnType>
inline FUFunctor3<ClassName, Argument1, Argument2, Argument3, ReturnType>* NewFUFunctor3(ClassName* o, ReturnType (ClassName::*function) (Argument1, Argument2, Argument3))
{
return new FUFunctor3<ClassName, Argument1, Argument2, Argument3, ReturnType>(o, function);
}
/**
A pseudo-functor with three arguments, specialized for static functions.
@ingroup FUtils
*/
template<class Arg1, class Arg2, class Arg3, class ReturnType>
class FUStaticFunctor3 : public IFunctor3<Arg1, Arg2, Arg3, ReturnType>
{
private:
ReturnType (*m_pFunction) (Arg1, Arg2, Arg3);
public:
/** Constructor.
@param function A static function. */
FUStaticFunctor3(ReturnType (*function) (Arg1, Arg2, Arg3)) { m_pFunction = function; }
/** Destructor. */
virtual ~FUStaticFunctor3() {}
/** Calls the functor.
@param argument1 A first argument.
@param argument2 A second argument.
@param argument3 A third argument.
@return Implementation-dependant. */
virtual ReturnType operator()(Arg1 argument1, Arg2 argument2, Arg3 argument3) const
{ return (*m_pFunction)(argument1, argument2, argument3); }
/** Checks whether this pseudo-functor points towards the given function.
@param UNUSED Unused.
@param function The static function.
@return Whether this pseudo-functor points towards the given function. */
virtual bool Compare(void* UNUSED(object), void* function) const
{ return (size_t)function == *(size_t*)(size_t)&m_pFunction; }
/** Returns a copy of this functor */
virtual IFunctor3<Arg1, Arg2, Arg3, ReturnType>* Copy() const
{ return new FUStaticFunctor3<Arg1, Arg2, Arg3, ReturnType>(m_pFunction); };
};
#endif //_FU_FUNCTOR_H_
|