F5/unison
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Doxygen] Include the size of registered types in the long description for the class.

Browse Source
This commit is contained in:
Peter D. Barnes, Jr.
2014-10-08 13:52:14 -07:00
parent 06777c4102
commit 792c339edc
4 changed files with 101 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
src/core/model/object-base.h
View File

@@ -35,14 +35,15 @@
* If the class is in a namespace, then the macro call should also be
* in the namespace.
*/
#define NS_OBJECT_ENSURE_REGISTERED(type) \
static struct X ## type ## RegistrationClass \
{ \
X ## type ## RegistrationClass () { \
ns3::TypeId tid = type::GetTypeId (); \
tid.GetParent (); \
} \
} x_ ## type ## RegistrationVariable
#define NS_OBJECT_ENSURE_REGISTERED(type) \
static struct Object ## type ## RegistrationClass \
{ \
Object ## type ## RegistrationClass () { \
ns3::TypeId tid = type::GetTypeId (); \
tid.SetSize (sizeof (type)); \
tid.GetParent (); \
} \
} Object ## type ## RegistrationVariable
namespace ns3 {

31
src/core/model/type-id.cc
View File

@@ -74,6 +74,7 @@ public:
uint16_t AllocateUid (std::string name);
void SetParent (uint16_t uid, uint16_t parent);
void SetGroupName (uint16_t uid, std::string groupName);
void SetSize (uint16_t uid, std::size_t size);
void AddConstructor (uint16_t uid, Callback<ObjectBase *> callback);
void HideFromDocumentation (uint16_t uid);
uint16_t GetUid (std::string name) const;
@@ -82,6 +83,7 @@ public:
TypeId::hash_t GetHash (uint16_t uid) const;
uint16_t GetParent (uint16_t uid) const;
std::string GetGroupName (uint16_t uid) const;
std::size_t GetSize (uint16_t uid) const;
Callback<ObjectBase *> GetConstructor (uint16_t uid) const;
bool HasConstructor (uint16_t uid) const;
uint32_t GetRegisteredN (void) const;
@@ -117,6 +119,7 @@ private:
TypeId::hash_t hash;
uint16_t parent;
std::string groupName;
std::size_t size;
bool hasConstructor;
Callback<ObjectBase *> constructor;
bool mustHideFromDocumentation;
@@ -248,6 +251,13 @@ IidManager::SetGroupName (uint16_t uid, std::string groupName)
information->groupName = groupName;
}
void
IidManager::SetSize (uint16_t uid, std::size_t size)
{
NS_LOG_FUNCTION (this << uid << size);
struct IidInformation *information = LookupInformation (uid);
information->size = size;
}
void
IidManager::HideFromDocumentation (uint16_t uid)
{
NS_LOG_FUNCTION (this << uid);
@@ -323,6 +333,13 @@ IidManager::GetGroupName (uint16_t uid) const
struct IidInformation *information = LookupInformation (uid);
return information->groupName;
}
std::size_t
IidManager::GetSize (uint16_t uid) const
{
NS_LOG_FUNCTION (this << uid);
struct IidInformation *information = LookupInformation (uid);
return information->size;
}
Callback<ObjectBase *>
IidManager::GetConstructor (uint16_t uid) const
@@ -623,6 +640,13 @@ TypeId::SetGroupName (std::string groupName)
Singleton<IidManager>::Get ()->SetGroupName (m_tid, groupName);
return *this;
}
TypeId
TypeId::SetSize (std::size_t size)
{
NS_LOG_FUNCTION (this << size);
Singleton<IidManager>::Get ()->SetSize (m_tid, size);
return *this;
}
TypeId
TypeId::GetParent (void) const
{
@@ -670,6 +694,13 @@ TypeId::GetHash (void) const
hash_t hash = Singleton<IidManager>::Get ()->GetHash (m_tid);
return hash;
}
std::size_t
TypeId::GetSize (void) const
{
NS_LOG_FUNCTION (this);
std::size_t size = Singleton<IidManager>::Get ()->GetSize (m_tid);
return size;
}
bool
TypeId::HasConstructor (void) const

18
src/core/model/type-id.h
View File

@@ -168,6 +168,11 @@ public:
*/
hash_t GetHash (void) const;
/**
* \returns the size of this interface.
*/
std::size_t GetSize (void) const;
/**
* \returns true if this TypeId has a constructor
*/
@@ -240,6 +245,19 @@ public:
*/
TypeId SetGroupName (std::string groupName);
/**
* Set the size of this type, based on the \p sizeof operator.
*
* Call this way:
* \code
* SetSize (sizeof (<typename>));
* \endcode
*
* \param size The size of the object, in bytes.
* \returns this TypeId instance.
*/
TypeId SetSize (std::size_t size);
/**
* \returns this TypeId instance
*

45
utils/print-introspected-doxygen.cc
View File

@@ -76,6 +76,7 @@ namespace
void
SetMarkup (bool outputText)
{
NS_LOG_FUNCTION (outputText);
if (outputText)
{
anchor = "";
@@ -146,6 +147,7 @@ SetMarkup (bool outputText)
void
PrintAttributesTid (std::ostream &os, const TypeId tid)
{
NS_LOG_FUNCTION (tid);
os << listStart << std::endl;
for (uint32_t j = 0; j < tid.GetAttributeN (); j++)
{
@@ -250,6 +252,7 @@ PrintAttributesTid (std::ostream &os, const TypeId tid)
void
PrintAttributes (std::ostream & os, const TypeId tid)
{
NS_LOG_FUNCTION (tid);
if (tid.GetAttributeN () == 0)
{
os << "No Attributes are defined for this type."
@@ -295,6 +298,7 @@ PrintAttributes (std::ostream & os, const TypeId tid)
void
PrintTraceSourcesTid (std::ostream & os, const TypeId tid)
{
NS_LOG_FUNCTION (tid);
os << listStart << std::endl;
for (uint32_t i = 0; i < tid.GetTraceSourceN (); ++i)
{
@@ -325,6 +329,7 @@ PrintTraceSourcesTid (std::ostream & os, const TypeId tid)
void
PrintTraceSources (std::ostream & os, const TypeId tid)
{
NS_LOG_FUNCTION (tid);
if (tid.GetTraceSourceN () == 0)
{
os << "No TraceSources are defined for this type."
@@ -356,6 +361,25 @@ PrintTraceSources (std::ostream & os, const TypeId tid)
} // PrintTraceSources ()
/**
* Print the size of the type represented by this tid.
*
* \param [in,out] os The output stream.
* \param [in] tid The TypeId to print.
*/
void PrintSize (std::ostream & os, const TypeId tid)
{
NS_LOG_FUNCTION (tid);
NS_ASSERT_MSG (CHAR_BIT != 0, "CHAR_BIT is zero");
std::size_t arch = (sizeof (void *) * CHAR_BIT);
os << boldStart << "Size" << boldStop
<< " of this type is " << tid.GetSize ()
<< " bytes (on a " << arch << "-bit architecture)."
<< std::endl;
}
/**
* Print the list of all Trace sources.
@@ -365,6 +389,7 @@ PrintTraceSources (std::ostream & os, const TypeId tid)
void
PrintAllTraceSources (std::ostream & os)
{
NS_LOG_FUNCTION_NOARGS ();
os << commentStart << page << "TraceSourceList All TraceSources\n"
<< std::endl;
@@ -400,10 +425,11 @@ PrintAllTraceSources (std::ostream & os)
* Print the list of all Attributes.
*
* \param [in,out] os The output stream.
p */
*/
void
PrintAllAttributes (std::ostream & os)
{
NS_LOG_FUNCTION_NOARGS ();
os << commentStart << page << "AttributeList All Attributes\n"
<< std::endl;
@@ -443,6 +469,7 @@ PrintAllAttributes (std::ostream & os)
void
PrintAllGlobals (std::ostream & os)
{
NS_LOG_FUNCTION_NOARGS ();
os << commentStart << page << "GlobalValueList All GlobalValues\n"
<< std::endl;
@@ -478,6 +505,7 @@ PrintAllGlobals (std::ostream & os)
void
PrintAllLogComponents (std::ostream & os)
{
NS_LOG_FUNCTION_NOARGS ();
os << commentStart << page << "LogComponentList All LogComponents\n"
<< std::endl;
@@ -586,6 +614,7 @@ private:
void
StaticInformation::RecordAggregationInfo (std::string a, std::string b)
{
NS_LOG_FUNCTION (this << a << b);
m_aggregates.push_back (std::make_pair (TypeId::LookupByName (a), TypeId::LookupByName (b)));
}
@@ -593,6 +622,7 @@ StaticInformation::RecordAggregationInfo (std::string a, std::string b)
void
StaticInformation::Print (void) const
{
NS_LOG_FUNCTION (this);
for (std::vector<std::pair<TypeId,std::string> >::const_iterator i = m_output.begin (); i != m_output.end (); ++i)
{
std::pair<TypeId,std::string> item = *i;
@@ -604,6 +634,7 @@ StaticInformation::Print (void) const
std::string
StaticInformation::GetCurrentPath (void) const
{
NS_LOG_FUNCTION (this);
std::ostringstream oss;
for (std::vector<std::string>::const_iterator i = m_currentPath.begin (); i != m_currentPath.end (); ++i)
{
@@ -617,6 +648,7 @@ StaticInformation::GetCurrentPath (void) const
void
StaticInformation::RecordOutput (TypeId tid)
{
NS_LOG_FUNCTION (this << tid);
m_output.push_back (std::make_pair (tid, GetCurrentPath ()));
}
@@ -624,6 +656,7 @@ StaticInformation::RecordOutput (TypeId tid)
bool
StaticInformation::HasAlreadyBeenProcessed (TypeId tid) const
{
NS_LOG_FUNCTION (this << tid);
for (uint32_t i = 0; i < m_alreadyProcessed.size (); ++i)
{
if (m_alreadyProcessed[i] == tid)
@@ -638,6 +671,7 @@ StaticInformation::HasAlreadyBeenProcessed (TypeId tid) const
std::vector<std::string>
StaticInformation::Get (TypeId tid) const
{
NS_LOG_FUNCTION (this << tid);
std::vector<std::string> paths;
for (uint32_t i = 0; i < m_output.size (); ++i)
{
@@ -654,6 +688,7 @@ StaticInformation::Get (TypeId tid) const
void
StaticInformation::Gather (TypeId tid)
{
NS_LOG_FUNCTION (this << tid);
DoGather (tid);
std::sort (m_output.begin (), m_output.end ());
@@ -664,7 +699,7 @@ StaticInformation::Gather (TypeId tid)
void
StaticInformation::DoGather (TypeId tid)
{
NS_LOG_FUNCTION (this);
NS_LOG_FUNCTION (this << tid);
if (HasAlreadyBeenProcessed (tid))
{
return;
@@ -768,6 +803,7 @@ StaticInformation::DoGather (TypeId tid)
void
StaticInformation::find_and_replace( std::string &source, const std::string find, std::string replace )
{
NS_LOG_FUNCTION (this << source << find << replace);
size_t j;
j = source.find (find);
while (j != std::string::npos )
@@ -781,6 +817,7 @@ StaticInformation::find_and_replace( std::string &source, const std::string find
StaticInformation
GetTypicalAggregations ()
{
NS_LOG_FUNCTION_NOARGS ();
// The below statements register typical aggregation relationships
// in ns-3 programs, that otherwise aren't picked up automatically
// by the creation of the above node. To manually list other common
@@ -827,6 +864,7 @@ typedef NameMap::const_iterator NameMapIterator;
NameMap
GetNameMap (void)
{
NS_LOG_FUNCTION_NOARGS ();
NameMap nameMap;
for (uint32_t i = 0; i < TypeId::GetRegisteredN (); i++)
@@ -856,6 +894,7 @@ void
PrintConfigPaths (std::ostream & os, const StaticInformation & info,
const TypeId tid)
{
NS_LOG_FUNCTION (tid);
std::vector<std::string> paths = info.Get (tid);
// Config --------------
@@ -893,6 +932,7 @@ PrintConfigPaths (std::ostream & os, const StaticInformation & info,
int main (int argc, char *argv[])
{
NS_LOG_FUNCTION_NOARGS ();
bool outputText = false;
CommandLine cmd;
@@ -944,6 +984,7 @@ int main (int argc, char *argv[])
PrintConfigPaths (std::cout, info, tid);
PrintAttributes (std::cout, tid);
PrintTraceSources (std::cout, tid);
PrintSize (std::cout, tid);
std::cout << commentStop << std::endl;
} // class documentation