include/IEvent.h

Go to the documentation of this file.

/******************************************************************************
 * Protocce Engine                                                            *
 * Part of the Crown and Cutlass Project                                      *
 * http://www.crownandcutlass.com                                             *
 * Copyright (c) 2004 - 2008 David Thulson and Collin Sanford                 *
 * All rights reserved.                                                       *
 *                                                                            *
 * Redistribution and use in source and binary forms, with or without         *
 * modification, are permitted provided that the following conditions         *
 * are met:                                                                   *
 * 1. Redistributions of source code must retain the above copyright          *
 *    notice, this list of conditions and the following disclaimer.           *
 * 2. Redistributions in binary form must reproduce the above copyright       *
 *    notice, this list of conditions and the following disclaimer in the     *
 *    documentation and/or other materials provided with the distribution.    *
 * 3. The names of the authors may not be used to endorse or promote products *
 *    derived from this software without specific prior written permission.   *
 *                                                                            *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR       *
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES  *
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.    *
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,           *
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT   *
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,  *
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY      *
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT        *
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF   *
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.          *
 *                                                                            *
 ******************************************************************************/

// Base Event class

#ifndef _PCCE_IEVENT_H_
#define _PCCE_IEVENT_H_

#include <string>
#include <boost/algorithm/string/case_conv.hpp>
#include "EventSystem.h"
#include "stringutil.h"
#include "IEventFwd.h"

namespace pcce {


  class IEvent {
  public:

    virtual const std::string vGetEventName() const = 0;


    virtual const tHashValue vGetEventType() = 0;

    virtual ~IEvent() {};
  };


  template<class T> class EventType: public IEvent {
  private:
    static tHashValue sHash;
  public:

    static const tHashValue sGetEventType() {
      if (sHash == 0) {
        pcce::tHashValue hash;
        std::string s = boost::to_lower_copy(T::sGetEventName());
        PCCE_CHECK(!s.empty(), "Invalid event name");
        hash = HashString(s);
        PCCE_CHECK(
          EventSystemSingleton::Get()->RegisterEventType(hash),
          "Event type duplicated (\"" + s + "\")");
        sHash = hash;
      }
      return sHash;
    }
    const std::string vGetEventName() const {
      return T::sGetEventName();
    }
    const tHashValue vGetEventType() {
      return sGetEventType();
    }
  };

  template<class T> tHashValue EventType<T>::sHash = 0;
  

  #define PCCE_EVENT_CLASS(name) class name: public pcce::EventType< name > 

}

#endif

---