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

/*

 * Copyright (c) 2009 University of Washington

 *

 * 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

 */

#include "ns3/test.h"

#include "ns3/object.h"

#include "ns3/boolean.h"

#include "ns3/integer.h"

#include "ns3/uinteger.h"

#include "ns3/enum.h"

#include "ns3/string.h"

#include "ns3/random-variable.h"

#include "ns3/double.h"

#include "ns3/object-vector.h"

#include "ns3/traced-value.h"

#include "ns3/callback.h"

#include "ns3/trace-source-accessor.h"

#include "ns3/pointer.h"

namespace ns3 {

class ValueClassTest 

{

public:

  ValueClassTest () {}

private:

  int m_v;

};

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

{

  return true;

}

std::ostream & operator << (std::ostream &os, ValueClassTest v)

{

  return os;

}

std::istream & operator >> (std::istream &is, ValueClassTest &v)

{

  return is;

}

ATTRIBUTE_HELPER_HEADER (ValueClassTest);

ATTRIBUTE_HELPER_CPP (ValueClassTest);

class Derived : public Object

{

public:

  static TypeId GetTypeId (void) {

    static TypeId tid = TypeId ("ns3::Derived")

      .SetParent<Object> ()

    return tid;

  }

};

class AttributeObjectTest : public Object

{

public:

  enum Test_e {

    TEST_A,

    TEST_B,

    TEST_C

  };

  static TypeId GetTypeId (void) {

    static TypeId tid = TypeId ("ns3::AttributeObjectTest")

      .SetParent<Object> ()

      .HideFromDocumentation ()

      .AddAttribute ("TestBoolName", "help text",

      .AddAttribute ("TestBoolA", "help text",

      .AddAttribute ("TestInt16", "help text",

      .AddAttribute ("TestInt16WithBounds", "help text",

      .AddAttribute ("TestInt16SetGet", "help text",

      .AddAttribute ("TestUint8", "help text",

      .AddAttribute ("TestEnum", "help text",

      .AddAttribute ("TestRandom", "help text",

      .AddAttribute ("TestFloat", "help text",

      .AddAttribute ("TestVector1", "help text",

      .AddAttribute ("TestVector2", "help text",

      .AddAttribute ("IntegerTraceSource1", "help text",

      .AddAttribute ("IntegerTraceSource2", "help text",

      .AddAttribute ("UIntegerTraceSource", "help text",

      .AddAttribute ("DoubleTraceSource", "help text",

      .AddAttribute ("BoolTraceSource", "help text",

                     BooleanValue (false),

      .AddAttribute ("EnumTraceSource", "help text",

                     EnumValue (false),

      .AddAttribute ("ValueClassSource", "help text",

      .AddTraceSource ("Source1", "help test",

      .AddTraceSource ("Source2", "help text",

      .AddTraceSource ("ValueSource", "help text",

      .AddAttribute ("Pointer", "help text",

                     PointerValue (),

                     MakePointerAccessor (&AttributeObjectTest::m_ptr),

                     MakePointerChecker<Derived> ())

      .AddAttribute ("Callback", "help text",

                     CallbackValue (),

                     MakeCallbackAccessor (&AttributeObjectTest::m_cbValue),

                     MakeCallbackChecker ())

    return tid;

  }

  void InvokeCbValue (int8_t a)

  {

    if (!m_cbValue.IsNull ()) {

        m_cbValue (a);

      }

  }

private:

  bool m_boolTestA;

  bool m_boolTest;

  int16_t m_int16;

  int16_t m_int16WithBounds;

  int16_t m_int16SetGet;

  uint8_t m_uint8;

  float m_float;

  enum Test_e m_enum;

  RandomVariable m_random;

  std::vector<Ptr<Derived> > m_vector1;

  std::vector<Ptr<Derived> > m_vector2;

  Callback<void,int8_t> m_cbValue;

  TracedValue<int8_t> m_intSrc1;

  TracedValue<int8_t> m_intSrc2;

  TracedCallback<double, int, float> m_cb;

  TracedValue<ValueClassTest> m_valueSrc;

  Ptr<Derived> m_ptr;

  TracedValue<uint8_t> m_uintSrc;

  TracedValue<enum Test_e> m_enumSrc;

  TracedValue<double> m_doubleSrc;

  TracedValue<bool> m_boolSrc;

};

NS_OBJECT_ENSURE_REGISTERED (AttributeObjectTest);

// ===========================================================================

// Test case template used for generic Attribute Value types -- used to make 

// sure that Attributes work as expected.

// ===========================================================================

template <typename T>

class AttributeTestCase : public TestCase

{

public:

  AttributeTestCase (std::string description);

  virtual ~AttributeTestCase ();

private:

  virtual void DoRun (void);

  bool CheckGetCodePaths (Ptr<Object> p, std::string attributeName, std::string expectedString, T expectedValue);

};

template <typename T>

AttributeTestCase<T>::AttributeTestCase (std::string description)

  : TestCase (description)

{

}

template <typename T>

AttributeTestCase<T>::~AttributeTestCase ()

{

}

template <typename T> bool

AttributeTestCase<T>::CheckGetCodePaths (

  Ptr<Object> p, 

  std::string attributeName,

  std::string expectedString,

  T expectedValue)

{

  StringValue stringValue;

  T actualValue;

  //

  // Get an Attribute value through its StringValue representation.

  //

  bool ok1 = p->GetAttributeFailSafe (attributeName.c_str (), stringValue);

  bool ok2 = stringValue.Get () == expectedString;

  //

  // Get the existing boolean value through its particular type representation.

  //

  bool ok3 = p->GetAttributeFailSafe (attributeName.c_str (), actualValue);

  bool ok4 = expectedValue.Get () == actualValue.Get ();

  return ok1 && ok2 && ok3 && ok4;

}

// ===========================================================================

// The actual Attribute type test cases are specialized for each Attribute type

// ===========================================================================

template <> void

AttributeTestCase<BooleanValue>::DoRun (void)

{

  AttributeList attrs;

  Ptr<AttributeObjectTest> p;

  bool ok;

  //

  // Test setting a boolean via string representation using AttributeList.

  //

  ok = attrs.SetFailSafe ("ns3::AttributeObjectTest::TestBoolName", StringValue ("false"));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Could not SetFailSafe() \"ns3::AttributeObjectTest::TestBoolName\" into AttributeList");

  //

  // Create an object using that attribute list (which should therefore have the

  // boolean from above set to false.

  //

  p = CreateObjectWithAttributes<AttributeObjectTest> (attrs);

  NS_TEST_ASSERT_MSG_NE (p, 0, "Unable to CreateObjectWithAttributes");

  ok = CheckGetCodePaths (p, "TestBoolName", "false", BooleanValue (false));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Attribute not set properly from CreateObjectWithAttributes");

  //

  // Set the default value of the BooleanValue and create an object.  The new

  // default value should stick.

  //

  AttributeList::GetGlobal ()->SetFailSafe ("ns3::AttributeObjectTest::TestBoolName", StringValue ("true"));

  p = CreateObject<AttributeObjectTest> ();

  NS_TEST_ASSERT_MSG_NE (p, 0, "Unable to CreateObject");

  ok = CheckGetCodePaths (p, "TestBoolName", "true", BooleanValue (true));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Attribute not set properly by default value");

  //

  // Set the default value of the BooleanValue the other way and create an object.

  // The new default value should stick.

  //

  AttributeList::GetGlobal ()->SetFailSafe ("ns3::AttributeObjectTest::TestBoolName", StringValue ("false"));

  p = CreateObject<AttributeObjectTest> ();

  NS_TEST_ASSERT_MSG_NE (p, 0, "Unable to CreateObject");

  ok = CheckGetCodePaths (p, "TestBoolName", "false", BooleanValue (false));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Attribute not et properly by default value");

  //

  // Set the BooleanValue Attribute to true via SetAttributeFailSafe path.

  //

  ok = p->SetAttributeFailSafe("TestBoolName", StringValue ("true"));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Could not SetAttributeFailSafe() \"TestBoolName\" to true");

  ok = CheckGetCodePaths (p, "TestBoolName", "true", BooleanValue (true));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Attribute not set properly by SetAttributeFailSafe() via StringValue");

  //

  // Set the BooleanValue to false via SetAttributeFailSafe path.

  //

  ok = p->SetAttributeFailSafe("TestBoolName", StringValue ("false"));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Could not SetAttributeFailSafe() \"TestBoolName\" to false");

  ok = CheckGetCodePaths (p, "TestBoolName", "false", BooleanValue (false));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Attribute not set properly by SetAttributeFailSafe() via StringValue");

  //

  // Create an object using individually provided StringValue Attribute.

  //

  p = CreateObjectWithAttributes<AttributeObjectTest> ("TestBoolName", StringValue ("true"));

  NS_TEST_ASSERT_MSG_NE (p, 0, "Unable to CreateObjectWithAttributes");

  ok = CheckGetCodePaths (p, "TestBoolName", "true", BooleanValue (true));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Attribute not set properly by CreateObjectWithAttributes() with StringValue");

  //

  // Create an object using individually provided BooleanValue Attribute.

  //

  p = CreateObjectWithAttributes<AttributeObjectTest> ("TestBoolName", BooleanValue (false));

  NS_TEST_ASSERT_MSG_NE (p, 0, "Unable to CreateObjectWithAttributes");

  ok = CheckGetCodePaths (p, "TestBoolName", "false", BooleanValue (false));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Attribute not set properly by CreateObjectWithAttributes() with BooleanValue");

  //

  // The previous object-based tests checked access directly.  Now check through

  // setter and getter.  The code here looks the same, but the underlying

  // attribute is declared differently in the object.  First make sure we can set

  // to true.

  //

  ok = p->SetAttributeFailSafe("TestBoolA", StringValue ("true"));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Could not SetAttributeFailSafe() a boolean value to true");

  ok = CheckGetCodePaths (p, "TestBoolA", "true", BooleanValue (true));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Attribute not set properly by SetAttributeFailSafe() (getter/setter) via StringValue");

  //

  // Now Set the BooleanValue to false via the setter.

  //

  ok = p->SetAttributeFailSafe("TestBoolA", StringValue ("false"));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Could not SetAttributeFailSafe() a boolean value to false");

  ok = CheckGetCodePaths (p, "TestBoolA", "false", BooleanValue (false));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Attribute not set properly by SetAttributeFailSafe() (getter/setter) via StringValue");

}

template <> void

AttributeTestCase<IntegerValue>::DoRun (void)

{

  Ptr<AttributeObjectTest> p;

  bool ok;

  p = CreateObject<AttributeObjectTest> ();

  NS_TEST_ASSERT_MSG_NE (p, 0, "Unable to CreateObject");

  //

  // When the object is first created, the Attribute should have the default 

  // value.

  //

  ok = CheckGetCodePaths (p, "TestInt16", "-2", IntegerValue (-2));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Attribute not set properly by default value");

  //

  // Set the Attribute to a negative value through a StringValue.

  //

  ok = p->SetAttributeFailSafe("TestInt16", StringValue ("-5"));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Could not SetAttributeFailSafe() via StringValue to -5");

  ok = CheckGetCodePaths (p, "TestInt16", "-5", IntegerValue (-5));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Attribute not set properly by SetAttributeFailSafe() via StringValue");

  //

  // Set the Attribute to a positive value through a StringValue.

  //

  ok = p->SetAttributeFailSafe("TestInt16", StringValue ("+2"));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Could not SetAttributeFailSafe() via StringValue to +2");

  ok = CheckGetCodePaths (p, "TestInt16", "2", IntegerValue (2));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Attribute not set properly by SetAttributeFailSafe() via StringValue");

  //

  // Set the Attribute to the most negative value of the signed 16-bit range.

  //

  ok = p->SetAttributeFailSafe("TestInt16", StringValue ("-32768"));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Could not SetAttributeFailSafe() via StringValue to -32768");

  ok = CheckGetCodePaths (p, "TestInt16", "-32768", IntegerValue (-32768));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Attribute not set properly by SetAttributeFailSafe() (most negative) via StringValue");

  //

  // Try to set the Attribute past the most negative value of the signed 16-bit

  // range and make sure the underlying attribute is unchanged.

  //

  ok = p->SetAttributeFailSafe("TestInt16", StringValue ("-32769"));

  NS_TEST_ASSERT_MSG_EQ (ok, false, "Unexpectedly could SetAttributeFailSafe() via StringValue to -32769");

  ok = CheckGetCodePaths (p, "TestInt16", "-32768", IntegerValue (-32768));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Error in SetAttributeFailSafe() but value changes");

  //

  // Set the Attribute to the most positive value of the signed 16-bit range.

  //

  ok = p->SetAttributeFailSafe("TestInt16", StringValue ("32767"));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Could not SetAttributeFailSafe() via StringValue to 32767");

  ok = CheckGetCodePaths (p, "TestInt16", "32767", IntegerValue (32767));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Attribute not set properly by SetAttributeFailSafe() (most positive) via StringValue");

  //

  // Try to set the Attribute past the most positive value of the signed 16-bit

  // range and make sure the underlying attribute is unchanged.

  //

  ok = p->SetAttributeFailSafe("TestInt16", StringValue ("32768"));

  NS_TEST_ASSERT_MSG_EQ (ok, false, "Unexpectedly could SetAttributeFailSafe() via StringValue to 32768");

  ok = CheckGetCodePaths (p, "TestInt16", "32767", IntegerValue (32767));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Error in SetAttributeFailSafe() but value changes");

  //

  // Attributes can have limits other than the intrinsic limits of the

  // underlying data types.  These limits are specified in the Object.

  //

  ok = p->SetAttributeFailSafe("TestInt16WithBounds", IntegerValue (10));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Could not SetAttributeFailSafe() via IntegerValue to 10");

  ok = CheckGetCodePaths (p, "TestInt16WithBounds", "10", IntegerValue (10));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Attribute not set properly by SetAttributeFailSafe() (positive limit) via StringValue");

  //

  // Set the Attribute past the positive limit.

  //

  ok = p->SetAttributeFailSafe("TestInt16WithBounds", IntegerValue (11));

  NS_TEST_ASSERT_MSG_EQ (ok, false, "Unexpectedly could SetAttributeFailSafe() via IntegerValue to 11");

  ok = CheckGetCodePaths (p, "TestInt16WithBounds", "10", IntegerValue (10));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Error in SetAttributeFailSafe() but value changes");

  //

  // Set the Attribute at the negative limit.

  //

  ok = p->SetAttributeFailSafe("TestInt16WithBounds", IntegerValue (-5));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Could not SetAttributeFailSafe() via IntegerValue to -5");

  ok = CheckGetCodePaths (p, "TestInt16WithBounds", "-5", IntegerValue (-5));

  NS_TEST_ASSERT_MSG_EQ (ok, true, "Attribute not set properly by SetAttributeFailSafe() (negative limit) via StringValue");

  //

  // Set the Attribute past the negative limit.

  //

  ok = p->SetAttributeFailSafe("TestInt16WithBounds", IntegerValue (-6));

  NS_TEST_ASSERT_MSG_EQ (ok, false, "Unexpectedly could SetAttributeFailSafe() via IntegerValue to -6");