/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */

/*

 * Copyright (c) 2007 INRIA, Gustavo Carneiro

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License version 2 as

 * published by the Free Software Foundation;

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 *

 * Authors: Gustavo Carneiro <gjcarneiro@gmail.com>,

 *          Mathieu Lacage <mathieu.lacage@sophia.inria.fr>

 */

#include "object.h"

#include "assert.h"

#include "singleton.h"

#include "uid-manager.h"

#include "trace-resolver.h"

#include "log.h"

#include <vector>

NS_LOG_COMPONENT_DEFINE ("Object");

namespace {

class IidManager : public ns3::UidManager

{};

class IidTree

{

public:

  void SetParent (uint16_t child, const uint16_t *parent);

  uint16_t LookupParent (uint16_t child);

private:

  std::vector<const uint16_t *> m_parents;

};

void 

IidTree::SetParent (uint16_t child, const uint16_t *parent)

{

  m_parents.resize (child+1);

  m_parents[child] = parent;

}

uint16_t 

IidTree::LookupParent (uint16_t child)

{

  NS_ASSERT (child < m_parents.size ());

  return *(m_parents[child]);

}

} // anonymous namespace

namespace ns3 {

class InterfaceIdTraceResolver : public TraceResolver

{

public:

  InterfaceIdTraceResolver (Ptr<const Object> aggregate);

  virtual void Connect (std::string path, CallbackBase const &cb, const TraceContext &context);

  virtual void Disconnect (std::string path, CallbackBase const &cb);

  virtual void CollectSources (std::string path, const TraceContext &context, 

                               SourceCollection *collection);

  virtual void TraceAll (std::ostream &os, const TraceContext &context);

private:

  Ptr<const Object> ParseForInterface (std::string path);

  Ptr<const Object> m_aggregate;

};

InterfaceIdTraceResolver::InterfaceIdTraceResolver (Ptr<const Object> aggregate)

  : m_aggregate (aggregate)

{}

Ptr<const Object>

InterfaceIdTraceResolver::ParseForInterface (std::string path)

{

  std::string element = GetElement (path);

  std::string::size_type dollar_pos = element.find ("$");

  if (dollar_pos != 0)

    {

      return 0;

    }

  std::string interfaceName = element.substr (1, std::string::npos);

  InterfaceId interfaceId = InterfaceId::LookupByName (interfaceName);

  Ptr<Object> interface = m_aggregate->QueryInterface<Object> (interfaceId);

  return interface;

}

void 

InterfaceIdTraceResolver::Connect (std::string path, CallbackBase const &cb, const TraceContext &context)

{

  Ptr<const Object> interface = ParseForInterface (path);

  if (interface != 0)

    {

      interface->GetTraceResolver ()->Connect (GetSubpath (path), cb, context);

    }

}

void 

InterfaceIdTraceResolver::Disconnect (std::string path, CallbackBase const &cb)

{

  Ptr<const Object> interface = ParseForInterface (path);

  if (interface != 0)

    {

      interface->TraceDisconnect (GetSubpath (path), cb);

    }

}

void 

InterfaceIdTraceResolver::CollectSources (std::string path, const TraceContext &context, 

                                          SourceCollection *collection)

{

  m_aggregate->DoCollectSources (path, context, collection);

}

void 

InterfaceIdTraceResolver::TraceAll (std::ostream &os, const TraceContext &context)

{

  m_aggregate->DoTraceAll (os, context);

}

InterfaceId::InterfaceId (uint16_t iid)

  : m_iid (iid)

{}

InterfaceId::~InterfaceId ()

{}

InterfaceId 

InterfaceId::LookupByName (std::string name)

{

  uint32_t uid = Singleton<IidManager>::Get ()->LookupByName (name);

  NS_ASSERT (uid != 0 && uid <= 0xffff);

  return InterfaceId (uid);

}

InterfaceId 

InterfaceId::LookupParent (InterfaceId iid)

{

  return Singleton<IidTree>::Get ()->LookupParent (iid.m_iid);

}

std::string 

InterfaceId::GetName (void) const

{

  std::string name = Singleton<IidManager>::Get ()->LookupByUid (m_iid);

  return name;

}

bool operator == (const InterfaceId &a, const InterfaceId &b)

{

  return a.m_iid == b.m_iid;

}

bool operator != (const InterfaceId &a, const InterfaceId &b)

{

  return a.m_iid != b.m_iid;

}

InterfaceId

MakeInterfaceId (std::string name, const InterfaceId &parent)

{

  uint32_t uid = Singleton<IidManager>::Get ()->Allocate (name);

  NS_ASSERT (uid <= 0xffff);

  InterfaceId iid = uid;

  Singleton<IidTree>::Get ()->SetParent (iid.m_iid, &parent.m_iid);

  return iid;

}

InterfaceId

MakeObjectInterfaceId (void)

{

  InterfaceId iid = Singleton<IidManager>::Get ()->Allocate ("Object");

  Singleton<IidTree>::Get ()->SetParent (iid.m_iid, &iid.m_iid);

  return iid;

}

const InterfaceId Object::iid = MakeObjectInterfaceId ();

Object::Object ()

  : m_count (1),

    m_iid (Object::iid),

    m_disposed (false),

    m_collecting (false),

    m_next (this)

{}

Object::~Object () 

{

  m_next = 0;

}

Ptr<Object>

Object::DoQueryInterface (InterfaceId iid) const

{

  NS_ASSERT (CheckLoose ());

  const Object *currentObject = this;

  do {

    NS_ASSERT (currentObject != 0);

    InterfaceId cur = currentObject->m_iid;

    while (cur != iid && cur != Object::iid)

      {

        cur = InterfaceId::LookupParent (cur);

      }

    if (cur == iid)

      {

        return const_cast<Object *> (currentObject);

      }

    currentObject = currentObject->m_next;

  } while (currentObject != this);

  return 0;

}

void 

Object::Dispose (void)

{

  Object *current = this;

  do {

    NS_ASSERT (current != 0);

    NS_ASSERT (!current->m_disposed);

    current->DoDispose ();

    current->m_disposed = true;

    current = current->m_next;

  } while (current != this);

}

void 

Object::AddInterface (Ptr<Object> o)

{

  NS_ASSERT (!m_disposed);

  NS_ASSERT (!o->m_disposed);

  NS_ASSERT (CheckLoose ());

  NS_ASSERT (o->CheckLoose ());

  Object *other = PeekPointer (o);

  Object *next = m_next;

  m_next = other->m_next;

  other->m_next = next;

  NS_ASSERT (CheckLoose ());

  NS_ASSERT (o->CheckLoose ());

}

void 

Object::TraceConnect (std::string path, const CallbackBase &cb) const

{

  NS_ASSERT (CheckLoose ());

  GetTraceResolver ()->Connect (path, cb, TraceContext ());

}

void 

Object::TraceDisconnect (std::string path, const CallbackBase &cb) const

{

  NS_ASSERT (CheckLoose ());

  GetTraceResolver ()->Disconnect (path, cb);

}

void 

Object::SetInterfaceId (InterfaceId iid)

{

  NS_ASSERT (Check ());

  m_iid = iid;

}

void

Object::DoDispose (void)

{

  NS_ASSERT (!m_disposed);

}

Ptr<TraceResolver>

Object::GetTraceResolver (void) const

{

  NS_ASSERT (CheckLoose ());

  Ptr<InterfaceIdTraceResolver> resolver =

    Create<InterfaceIdTraceResolver> (this);

  return resolver;

}

bool 

Object::Check (void) const

{

  return (m_count > 0);

}

/* In some cases, when an event is scheduled against a subclass of

 * Object, and if no one owns a reference directly to this object, the

 * object is alive, has a refcount of zero and the method ran when the

 * event expires runs against the raw pointer which means that we are

 * manipulating an object with a refcount of zero.  So, instead we

 * check the aggregate reference count.

 */

bool 

Object::CheckLoose (void) const

{

  uint32_t refcount = 0;

  const Object *current = this;

  do

    {

      refcount += current->m_count;

      current = current->m_next;

    }

  while (current != this);

  return (refcount > 0);

}

void

Object::MaybeDelete (void) const

{

  // First, check if any of the attached

  // Object has a non-zero count.

  const Object *current = this;

  do {

    NS_ASSERT (current != 0);

    if (current->m_count != 0)

      {

        return;

      }

    current = current->m_next;

  } while (current != this);

  // all attached objects have a zero count so, 

  // we can delete all attached objects.

  current = this;

  const Object *end = this;

  do {

    NS_ASSERT (current != 0);

    Object *next = current->m_next;

    delete current;

    current = next;

  } while (current != end);

}

void 

Object::DoCollectSources (std::string path, const TraceContext &context, 

                          TraceResolver::SourceCollection *collection) const

{

  const Object *current;

  current = this;

  do {

    if (current->m_collecting)

      {

        return;

      }

    current = current->m_next;

  } while (current != this);

  m_collecting = true;

  current = this->m_next;

  while (current != this)

    {

      NS_ASSERT (current != 0);

      NS_LOG_LOGIC ("collect current=" << current);

      InterfaceId cur = current->m_iid;

      while (cur != Object::iid)

        {

          std::string name = cur.GetName ();

          std::string fullpath = path;

          fullpath.append ("/$");

          fullpath.append (name);

          NS_LOG_LOGIC("collect: " << fullpath);

          current->GetTraceResolver ()->CollectSources (fullpath, context, collection);

          cur = InterfaceId::LookupParent (cur);

        }

      current = current->m_next;

    }

  m_collecting = false;

}

void 

Object::DoTraceAll (std::ostream &os, const TraceContext &context) const

{

  const Object *current;

  current = this;

  do {

    if (current->m_collecting)

      {

        return;

      }

    current = current->m_next;

  } while (current != this);

  m_collecting = true;

  current = this->m_next;

  while (current != this)

    {

      NS_ASSERT (current != 0);

      current->GetTraceResolver ()->TraceAll (os, context);

      current = current->m_next;

    }

  m_collecting = false;

}

} // namespace ns3

#ifdef RUN_SELF_TESTS

#include "test.h"

#include "sv-trace-source.h"

#include "composite-trace-resolver.h"

namespace {

class BaseA : public ns3::Object

{

public:

  static const ns3::InterfaceId iid;

  BaseA ()

  {

    SetInterfaceId (BaseA::iid);

  }

  void BaseGenerateTrace (int16_t v)

  { m_source = v; }

  virtual void Dispose (void) {}

  virtual ns3::Ptr<ns3::TraceResolver> GetTraceResolver (void) const

  {

    ns3::Ptr<ns3::CompositeTraceResolver> resolver = 

      ns3::Create<ns3::CompositeTraceResolver> ();

    resolver->AddSource ("basea-x", ns3::TraceDoc ("test source"), m_source);

    resolver->SetParentResolver (Object::GetTraceResolver ());

    return resolver;

  }

  ns3::SVTraceSource<int16_t> m_source;

};

class DerivedA : public BaseA

{

public:

  static const ns3::InterfaceId iid;

  DerivedA (int v)

  {

    SetInterfaceId (DerivedA::iid);

  }

  void DerivedGenerateTrace (int16_t v)

  { m_sourceDerived = v; }

  virtual void Dispose (void) {

    BaseA::Dispose ();

  }

  virtual ns3::Ptr<ns3::TraceResolver> GetTraceResolver (void) const

  {

    ns3::Ptr<ns3::CompositeTraceResolver> resolver = 

      ns3::Create<ns3::CompositeTraceResolver> ();

    resolver->AddSource ("deriveda-x", ns3::TraceDoc ("test source"), m_sourceDerived);

    resolver->SetParentResolver (BaseA::GetTraceResolver ());

    return resolver;

  }

  ns3::SVTraceSource<int16_t> m_sourceDerived;

};

const ns3::InterfaceId BaseA::iid = 

  ns3::MakeInterfaceId ("BaseA", Object::iid);

const ns3::InterfaceId DerivedA::iid = 

  ns3::MakeInterfaceId ("DerivedA", BaseA::iid);;

class BaseB : public ns3::Object

{

public:

  static const ns3::InterfaceId iid;

  BaseB ()

  {

    SetInterfaceId (BaseB::iid);

  }

  void BaseGenerateTrace (int16_t v)

  { m_source = v; }

  virtual void Dispose (void) {}

  virtual ns3::Ptr<ns3::TraceResolver> GetTraceResolver (void) const

  {

    ns3::Ptr<ns3::CompositeTraceResolver> resolver = 

      ns3::Create<ns3::CompositeTraceResolver> ();

    resolver->AddSource ("baseb-x", ns3::TraceDoc ("test source"), m_source);

    resolver->SetParentResolver (Object::GetTraceResolver ());

    return resolver;

  }

  ns3::SVTraceSource<int16_t> m_source;

};

class DerivedB : public BaseB

{

public:

  static const ns3::InterfaceId iid;

  DerivedB (int v)

  {

    SetInterfaceId (DerivedB::iid);

  }

  void DerivedGenerateTrace (int16_t v)

  { m_sourceDerived = v; }

  virtual void Dispose (void) {

    BaseB::Dispose ();

  }

  virtual ns3::Ptr<ns3::TraceResolver> GetTraceResolver (void) const

  {

    ns3::Ptr<ns3::CompositeTraceResolver> resolver =