Skip to content

Commit

Permalink
Merge pull request #476 from leapmotion/ref-snoop
Browse files Browse the repository at this point in the history 
Preparatory refactor of Snoop to AddSnooper
  • Loading branch information
@vdods
vdods committed Mar 30, 2015
2 parents 852a916 + 816c014 commit 4618bf4
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 35 deletions.
70 changes: 54 additions & 16 deletions autowiring/CoreContext.h
View file
Expand Up @@ -981,13 +981,20 @@ class CoreContext:
/// <param name="pRecipient">The recipient of the event</param>
void FilterFiringException(const JunctionBoxBase* pProxy, CoreObject* pRecipient);

/// <seealso cref="Snoop">Identical to RemoveSnooper</seealso>
void DEPRECATED(Snoop(const CoreObjectDescriptor& traits), "Use AddSnooper instead") { return AddSnooper(traits); }
template<class T>
void DEPRECATED(Snoop(const std::shared_ptr<T>& pSnooper), "Use AddSnooper instead");
template<class T>
void DEPRECATED(Snoop(const Autowired<T>& snooper), "Use AddSnooper instead");

/// <summary>
/// Runtime version of Snoop
/// Runtime version of AddSnooper
/// </summary>
void Snoop(const CoreObjectDescriptor& traits);
void AddSnooper(const CoreObjectDescriptor& traits);

/// <summary>
/// Registers the specified event receiver to receive messages broadcast within this context.
/// Registers the specified event receiver to receive messages from this context
/// </summary>
/// <remarks>
/// This enables the passed event receiver to snoop events that are broadcast from a
Expand All @@ -998,45 +1005,52 @@ class CoreContext:
/// broadcast in THIS context will be forwarded to the snooper.
/// </remarks>
template<class T>
void Snoop(const std::shared_ptr<T>& pSnooper) {
Snoop(CoreObjectDescriptor(pSnooper, (T*)nullptr));
void AddSnooper(const std::shared_ptr<T>& pSnooper) {
AddSnooper(CoreObjectDescriptor(pSnooper, (T*)nullptr));
}

/// <summary>
/// Resolution overload
/// </summary>
template<class T>
void Snoop(const Autowired<T>& snooper) {
Snoop(
void AddSnooper(const Autowired<T>& snooper) {
AddSnooper(
CoreObjectDescriptor(
static_cast<const std::shared_ptr<T>&>(snooper),
(T*)nullptr
)
);
}

/// <seealso cref="RemoveSnooper">Identical to RemoveSnooper</seealso>
void DEPRECATED(Unsnoop(const CoreObjectDescriptor& traits), "Use RemoveSnooper instead") { return RemoveSnooper(traits); }
template<class T>
void DEPRECATED(Unsnoop(const std::shared_ptr<T>& pSnooper), "Use RemoveSnooper instead");
template<class T>
void DEPRECATED(Unsnoop(const Autowired<T>& snooper), "Use RemoveSnooper instead");

/// <summary>
/// Runtime version of Unsnoop
/// Runtime version of RemoveSnooper
/// </summary>
void Unsnoop(const CoreObjectDescriptor& traits);
void RemoveSnooper(const CoreObjectDescriptor& traits);

/// <summary>
/// Unregisters an event receiver previously registered to receive snooped events
/// Unregisters a snooper previously registered to receive snooped events
/// </summary>
/// <remarks>
/// It is an error to call this method without a prior call to Snoop
/// It is an error to call this method without a prior call to AddSnooper
/// </remarks>
template<class T>
void Unsnoop(const std::shared_ptr<T>& pSnooper) {
Unsnoop(CoreObjectDescriptor(pSnooper, (T*)nullptr));
void RemoveSnooper(const std::shared_ptr<T>& pSnooper) {
RemoveSnooper(CoreObjectDescriptor(pSnooper, (T*)nullptr));
}

/// <summary>
/// Resolution overload
/// Resolution overload of RemoveSnooper
/// </summary>
template<class T>
void Unsnoop(const Autowired<T>& snooper) {
Unsnoop(
void RemoveSnooper(const Autowired<T>& snooper) {
RemoveSnooper(
CoreObjectDescriptor(
static_cast<const std::shared_ptr<T>&>(snooper),
(T*)nullptr
Expand Down Expand Up @@ -1272,6 +1286,30 @@ void CoreContext::AutoRequireMicroBolt(void) {
Inject<MicroBolt<T, Sigil...>>();
}

template<class T>
void CoreContext::Snoop(const std::shared_ptr<T>& pSnooper)
{
return AddSnooper(pSnooper);
}

template<class T>
void CoreContext::Snoop(const Autowired<T>& snooper)
{
return AddSnooper(snooper);
}

template<class T>
void CoreContext::Unsnoop(const std::shared_ptr<T>& pSnooper)
{
return RemoveSnooper(pSnooper);
}

template<class T>
void CoreContext::Unsnoop(const Autowired<T>& snooper)
{
return RemoveSnooper(snooper);
}

template<class T>
class CoreContext::AutoFactory
{
Expand Down
4 changes: 2 additions & 2 deletions src/autowiring/CoreContext.cpp
View file
Expand Up @@ -1019,7 +1019,7 @@ void CoreContext::FilterFiringException(const JunctionBoxBase* pProxy, CoreObjec
}
}

void CoreContext::Snoop(const CoreObjectDescriptor& traits) {
void CoreContext::AddSnooper(const CoreObjectDescriptor& traits) {
// Add to collections of snoopers
InsertSnooper(traits.value);

Expand All @@ -1032,7 +1032,7 @@ void CoreContext::Snoop(const CoreObjectDescriptor& traits) {
AddPacketSubscriber(traits.subscriber);
}

void CoreContext::Unsnoop(const CoreObjectDescriptor& traits) {
void CoreContext::RemoveSnooper(const CoreObjectDescriptor& traits) {
RemoveSnooper(traits.value);

// Cleanup if its an EventReceiver
Expand Down
34 changes: 17 additions & 17 deletions src/autowiring/test/SnoopTest.cpp
View file
Expand Up @@ -59,7 +59,7 @@ class RemovesSelf:
virtual void ZeroArgs(void){
counter++;
AutoCurrentContext ctxt;
ctxt->Unsnoop(GetSelf<RemovesSelf>());
ctxt->RemoveSnooper(GetSelf<RemovesSelf>());
}
public:
RemovesSelf():
Expand All @@ -83,7 +83,7 @@ TEST_F(SnoopTest, VerifySimpleSnoop) {
AutoRequired<ChildMember> childMember;

// Snoop
child->Snoop(parentMember);
child->AddSnooper(parentMember);

// Now fire an event from the child:
AutoFired<UpBroadcastListener> firer;
Expand Down Expand Up @@ -111,8 +111,8 @@ TEST_F(SnoopTest, VerifyUnsnoop) {
AutoRequired<ChildMember> childMember;

// Snoop, unsnoop:
snoopy->Snoop(parentMember);
snoopy->Unsnoop(parentMember);
snoopy->AddSnooper(parentMember);
snoopy->RemoveSnooper(parentMember);
snoopy->Initiate();

// Fire one event:
Expand All @@ -136,7 +136,7 @@ TEST_F(SnoopTest, AmbiguousReciept) {

{
AutoCreateContext subCtxt;
subCtxt->Snoop(parent);
subCtxt->AddSnooper(parent);
subCtxt->Initiate();

// Verify that simple firing _here_ causes transmission as expected:
Expand Down Expand Up @@ -178,7 +178,7 @@ TEST_F(SnoopTest, AvoidDoubleReciept) {
childMember = child->Inject<ChildMember>();

// Snoop
child->Snoop(parentMember);
child->AddSnooper(parentMember);
}

// Now fire an event from the parent:
Expand All @@ -193,7 +193,7 @@ TEST_F(SnoopTest, AvoidDoubleReciept) {
// Test sibling context
AutoRequired<SiblingMember> sibMember(sibCtxt);
AutoRequired<SiblingMember> alsoInParent;
child->Snoop(sibMember);
child->AddSnooper(sibMember);

firer(&UpBroadcastListener::SimpleCall)();

Expand All @@ -203,7 +203,7 @@ TEST_F(SnoopTest, AvoidDoubleReciept) {
ASSERT_EQ(1, sibMember->m_callCount) << "Sibling context member didn't receive message";

// Make sure unsnoop cleans up everything
child->Unsnoop(sibMember);
child->RemoveSnooper(sibMember);
firer(&UpBroadcastListener::SimpleCall)();

ASSERT_EQ(3, childMember->m_callCount) << "Message not received by another member of the same context";
Expand Down Expand Up @@ -236,8 +236,8 @@ TEST_F(SnoopTest, MultiSnoop) {
member->m_callCount = 0;

// Snoop both. Invocation in an uninitialized context should not cause any handlers to be raised.
ctxt1->Snoop(member);
ctxt2->Snoop(member);
ctxt1->AddSnooper(member);
ctxt2->AddSnooper(member);
base->Invoke(&UpBroadcastListener::SimpleCall)();
ctxt1->Invoke(&UpBroadcastListener::SimpleCall)();
ctxt2->Invoke(&UpBroadcastListener::SimpleCall)();
Expand All @@ -248,7 +248,7 @@ TEST_F(SnoopTest, MultiSnoop) {
member2->m_callCount = 0;

// Unsnoop one
ctxt2->Unsnoop(member);
ctxt2->RemoveSnooper(member);
base->Invoke(&UpBroadcastListener::SimpleCall)();
ctxt1->Invoke(&UpBroadcastListener::SimpleCall)();
ctxt2->Invoke(&UpBroadcastListener::SimpleCall)();
Expand All @@ -265,7 +265,7 @@ TEST_F(SnoopTest, AntiCyclicRemoval) {
CurrentContextPusher pshr(snoopy);
snoopy->Initiate();

snoopy->Snoop(removeself);
snoopy->AddSnooper(removeself);

ASSERT_EQ(0, removeself->counter);

Expand All @@ -289,7 +289,7 @@ TEST_F(SnoopTest, SimplePackets) {
// Add filter to tracking
AutoRequired<FilterA> filter(Tracking);
AutoRequired<FilterF> detachedFilter(Tracking);
Pipeline->Snoop(filter);
Pipeline->AddSnooper(filter);
ASSERT_FALSE(!!filter->m_called) << "Filter called prematurely";
ASSERT_FALSE(detachedFilter->m_called) << "Filter called prematurely";

Expand All @@ -308,7 +308,7 @@ TEST_F(SnoopTest, SimplePackets) {
//reset
filter->m_called = false;

Pipeline->Unsnoop(filter);
Pipeline->RemoveSnooper(filter);
auto packet2 = factory->NewPacket();
packet2->Decorate(Decoration<0>());
packet2->Decorate(Decoration<1>());
Expand All @@ -321,7 +321,7 @@ TEST_F(SnoopTest, CanSnoopAutowired) {

// Now autowire what we injected and verify we can snoop this directly
Autowired<SimpleObject> so;
ctxt->Snoop(so);
ctxt->AddSnooper(so);
}

TEST_F(SnoopTest, RuntimeSnoopCall) {
Expand All @@ -332,7 +332,7 @@ TEST_F(SnoopTest, RuntimeSnoopCall) {
CoreObjectDescriptor traits(x);

// Try to snoop and verify that the snooped member gets an event:
ctxt->Snoop(x);
ctxt->AddSnooper(x);

AutoFired<UpBroadcastListener> ubl;
ubl(&UpBroadcastListener::SimpleCall)();
Expand All @@ -341,7 +341,7 @@ TEST_F(SnoopTest, RuntimeSnoopCall) {
ASSERT_EQ(1UL, x->m_callCount) << "Call count to a child member was incorrect";

// And the alternative variant next:
ctxt->Unsnoop(x);
ctxt->RemoveSnooper(x);
ubl(&UpBroadcastListener::SimpleCall)();
ASSERT_EQ(1UL, x->m_callCount) << "Snoop method was invoked after the related type was removed";
}

0 comments on commit 4618bf4

Please sign in to comment.