urho3d/Engine/Core/Context.cpp

//
// Urho3D Engine
// Copyright (c) 2008-2012 Lasse Öörni
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//

#include "Precompiled.h"
#include "Context.h"

#include "DebugNew.h"

static String noType;

void RemoveNamedAttribute(Map<ShortStringHash, Vector<AttributeInfo> >& attributes, ShortStringHash objectType, const String& name)
{
    Map<ShortStringHash, Vector<AttributeInfo> >::Iterator i = attributes.Find(objectType);
    if (i == attributes.End())
        return;
    
    Vector<AttributeInfo>& infos = i->second_;
    
    for (Vector<AttributeInfo>::Iterator j = infos.Begin(); j != infos.End(); ++j)
    {
        if (j->name_ == name)
        {
            infos.Erase(j);
            break;
        }
    }
    
    // If the vector became empty, erase the object type from the map
    if (infos.Empty())
        attributes.Erase(i);
}

Context::Context() :
    eventHandler_(0)
{
}

Context::~Context()
{
    // Release the subsystems before the event receiver maps are destroyed
    for (Map<ShortStringHash, SharedPtr<Object> >::Iterator i = subsystems_.Begin(); i != subsystems_.End(); ++i)
        i->second_.Reset();
    subsystems_.Clear();
    factories_.Clear();
}

SharedPtr<Object> Context::CreateObject(ShortStringHash objectType)
{
    Map<ShortStringHash, SharedPtr<ObjectFactory> >::ConstIterator i = factories_.Find(objectType);
    if (i != factories_.End())
        return i->second_->CreateObject();
    else
        return SharedPtr<Object>();
}

void Context::RegisterFactory(ObjectFactory* factory)
{
    if (!factory)
        return;
    
    factories_[factory->GetType()] = factory;
}

void Context::RegisterSubsystem(Object* object)
{
    if (!object)
        return;
    
    subsystems_[object->GetType()] = object;
}

void Context::RegisterAttribute(ShortStringHash objectType, const AttributeInfo& attr)
{
    // None or Pointer types can not be supported
    if (attr.type_ == VAR_NONE || attr.type_ == VAR_PTR)
        return;
    
    attributes_[objectType].Push(attr);
    
    if (attr.mode_ & AM_NET)
        networkAttributes_[objectType].Push(attr);
}

void Context::RemoveAttribute(ShortStringHash objectType, const String& name)
{
    RemoveNamedAttribute(attributes_, objectType, name);
    RemoveNamedAttribute(networkAttributes_, objectType, name);
}

void Context::CopyBaseAttributes(ShortStringHash baseType, ShortStringHash derivedType)
{
    const Vector<AttributeInfo>* baseAttributes = GetAttributes(baseType);
    if (baseAttributes)
    {
        for (unsigned i = 0; i < baseAttributes->Size(); ++i)
        {
            const AttributeInfo& attr = baseAttributes->At(i);
            attributes_[derivedType].Push(attr);
            if (attr.mode_ & AM_NET)
                networkAttributes_[derivedType].Push(attr);
        }
    }
}

Object* Context::GetSubsystem(ShortStringHash type) const
{
    Map<ShortStringHash, SharedPtr<Object> >::ConstIterator i = subsystems_.Find(type);
    if (i != subsystems_.End())
        return i->second_;
    else
        return 0;
}

Object* Context::GetEventSender() const
{
    if (!eventSenders_.Empty())
        return eventSenders_.Back();
    else
        return 0;
}

const String& Context::GetTypeName(ShortStringHash type) const
{
    // Search factories to find the hash-to-name mapping
    Map<ShortStringHash, SharedPtr<ObjectFactory> >::ConstIterator i = factories_.Find(type);
    return i != factories_.End() ? i->second_->GetTypeName() : noType;
}


void Context::AddEventReceiver(Object* receiver, StringHash eventType)
{
    PODVector<Object*>& receivers = eventReceivers_[eventType];
    // Check if already registered
    if (receivers.Contains(receiver))
        return;
    
    receivers.Push(receiver);
}

void Context::AddEventReceiver(Object* receiver, Object* sender, StringHash eventType)
{
    PODVector<Object*>& receivers = specificEventReceivers_[MakePair(sender, eventType)];
    if (receivers.Contains(receiver))
        return;
    
    receivers.Push(receiver);
}

void Context::RemoveEventSender(Object* sender)
{
    for (Map<Pair<Object*, StringHash>, PODVector<Object*> >::Iterator i = specificEventReceivers_.Begin();
        i != specificEventReceivers_.End();)
    {
        Map<Pair<Object*, StringHash>, PODVector<Object*> >::Iterator current = i++;
        if (current->first_.first_ == sender)
        {
            PODVector<Object*>& receivers = current->second_;
            for (PODVector<Object*>::Iterator j = receivers.Begin(); j != receivers.End(); ++j)
            {
                if (*j)
                    (*j)->RemoveEventSender(sender);
            }
            specificEventReceivers_.Erase(current);
        }
    }
}

void Context::RemoveEventReceiver(Object* receiver, StringHash eventType)
{
    PODVector<Object*>* group = GetEventReceivers(eventType);
    if (!group)
        return;
    
    PODVector<Object*>::Iterator i = group->Find(receiver);
    if (i != group->End())
    {
        // If no event handling going on, can erase the receiver. Otherwise reset the pointer and clean up later
        if (eventSenders_.Empty())
            group->Erase(i);
        else
        {
            *i = 0;
            dirtyReceivers_.Insert(eventType);
        }
    }
}

void Context::RemoveEventReceiver(Object* receiver, Object* sender, StringHash eventType)
{
    PODVector<Object*>* group = GetEventReceivers(sender, eventType);
    if (!group)
        return;
    
    PODVector<Object*>::Iterator i = group->Find(receiver);
    if (i != group->End())
    {
        if (eventSenders_.Empty())
            group->Erase(i);
        else
        {
            *i = 0;
            dirtySpecificReceivers_.Insert(MakePair(sender, eventType));
        }
        return;
    }
}

void Context::EndSendEvent()
{
    eventSenders_.Pop();
    
    // Clean up dirtied event receiver groups when event handling finishes
    if (eventSenders_.Empty())
    {
        if (!dirtySpecificReceivers_.Empty())
        {
            for (HashSet<Pair<Object*, StringHash> >::Iterator i = dirtySpecificReceivers_.Begin();
                i != dirtySpecificReceivers_.End(); ++i)
            {
                PODVector<Object*>& receivers = specificEventReceivers_[*i];
                for (PODVector<Object*>::Iterator j = receivers.Begin(); j != receivers.End();)
                {
                    if (*j == 0)
                        j = receivers.Erase(j);
                    else
                        ++j;
                }
            }
            dirtySpecificReceivers_.Clear();
        }
        
        if (!dirtyReceivers_.Empty())
        {
            for (HashSet<StringHash>::Iterator i = dirtyReceivers_.Begin(); i != dirtyReceivers_.End(); ++i)
            {
                PODVector<Object*>& receivers = eventReceivers_[*i];
                for (PODVector<Object*>::Iterator j = receivers.Begin(); j != receivers.End();)
                {
                    if (*j == 0)
                        j = receivers.Erase(j);
                    else
                        ++j;
                }
            }
            dirtyReceivers_.Clear();
        }
    }
}