InjectedEventHandlerComponent.h

Go to the documentation of this file.

/*! \file InjectedEventHandlerComponent.h
  \brief  The InjectedEventHandlerComponent interface.

  \par Copyright Information

  Copyright (c) 2012 The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBLITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/

#ifndef _EVENT_EMITTING_COMPONENT_H_
#define _EVENT_EMITTING_COMPONENT_H_

#include "component_base.h"

namespace disti
{
class InjectedObjectEvent : public ObjectEvent
{
public:
    InjectedObjectEvent(DisplayObject* initiator, 
                            const char * initiatorName, 
                            const char * name,
                            const char * data = NULL) :
    ObjectEvent(initiator, name, data)
    {
        _initiatorName = initiatorName;
    }

    const char * InitiatorName()
    {       
        return _initiatorName.c_str();
    }

    void InitiatorName(const char * name)
    {
        _initiatorName = name;
    }

    bool Matches(const char * initiatorName, const char * eventName)
    {
        if (strcmp(this->InitiatorName(), initiatorName) == 0 &&
            strcmp(this->EventName(), eventName) == 0 )
        {
            return true;
        }

        return false;
    }

private:
    std::string _initiatorName;
};

class InjectedEventHandlerComponent : public ComponentBase
{
public:
    /** Default constructor
      */
    InjectedEventHandlerComponent(int generateInstance = FALSE) : ComponentBase(generateInstance)
    {
        _eventAtt = new char[1];
        _eventAtt[0] = '\0';
    }

    /** Default destructor
      */
    ~InjectedEventHandlerComponent()
    {
        if (_eventAtt != NULL) delete [] _eventAtt;
    }

    /** override for the SetAvailableAttributes function that includes the behavior of
     *  of ComponentBase plus adds routing for the InjectedEventHandler attribute
     */
    virtual void SetAvailableAttributes(unsigned int availableAttributes)
    {
        static AttributeName MetaEventAttribute("InjectedEventHandler");
        // For now we only allow one call
        if(_attributesAdded)
        {   return; }

        ComponentBase::SetAvailableAttributes(availableAttributes);

        typedef void (InjectedEventHandlerComponent::*void_method_void)(void);

        CallbackMethodCallerTemplate<InjectedEventHandlerComponent> updateEventAttrCb(
            (void_method_void)&disti::InjectedEventHandlerComponent::UpdateEventAttr
            , this);

        Attributes().Add( new DistiAttributeString(&updateEventAttrCb,MetaEventAttribute, &_eventAtt)); 
    }

    /*  This function gets called whenever the InjectedEventHandler is modified.  It takes care
     *  of converting the incoming data into an InjectedObjectEvent instance
     */
    void UpdateEventAttr()
    {
        
        std::string eventAtt(_eventAtt);

        std::string::size_type split = eventAtt.find_first_of("|", 0);

        // get the originator name
        std::string originator = eventAtt.substr(0, ((split >= eventAtt.size())?eventAtt.size()-1:split)  );

        // get the rest of the string
        std::string tempStr = (( (split+1) >= eventAtt.size() || split >= eventAtt.size() )?"":eventAtt.substr(split+1));
        split = tempStr.find_first_of("|", 0);

        // now split the name and data parts
        std::string name = tempStr.substr(0, ((split >= tempStr.size())?tempStr.size()-1:split)  );
        std::string data = (( (split+1) >= tempStr.size() || split >= tempStr.size() )?"":tempStr.substr(split+1));

        printf("we got an updated eventAttr value\n  originator: [%s]\n  name: [%s]\n  data: [%s]\n\n", originator.c_str(), name.c_str(), data.c_str());

        InjectedObjectEvent temp(this, originator.c_str(), name.c_str(), data.c_str());     

        HandleInjectedEvent(&temp);     
    }

    /** This function gets called when a new InjectedObjectEvent is ready for consumption and it must
     *  be implemented by the child class
     */
    virtual void HandleInjectedEvent(InjectedObjectEvent * ev) = 0;


private:
    char * _eventAtt;
};
}

#endif  // _EVENT_EMITTING_COMPONENT_H_