15#include "ns3/command-line.h"
16#include "ns3/config.h"
17#include "ns3/global-value.h"
19#include "ns3/node-container.h"
20#include "ns3/object-vector.h"
21#include "ns3/object.h"
22#include "ns3/pointer.h"
23#include "ns3/simple-channel.h"
24#include "ns3/string.h"
25#include "ns3/system-path.h"
106std::map<std::string, ns3::TypeId::AttributeInformation>
109 std::map<std::string, ns3::TypeId::AttributeInformation> index;
113 index[info.
name] = info;
124std::map<std::string, ns3::TypeId::TraceSourceInformation>
127 std::map<std::string, ns3::TypeId::TraceSourceInformation> index;
131 index[info.
name] = info;
143BoldWithId(
const std::string
id,
const std::string displayText)
147 return displayText +
" ";
163 return displayText +
" ";
175SpanWithId(
const std::string
id,
const std::string displayText)
179 return displayText +
" ";
209 commentStart =
"===============================================================\n";
212 file =
"File: introspected-doxygen.txt";
330 void Print(std::ostream& os)
const;
337 std::vector<std::string>
Get(
TypeId tid)
const;
370 std::vector<std::pair<TypeId, std::string>>
m_output;
422 os << item.first.GetName() <<
" -> " << item.second << std::endl;
430 std::ostringstream oss;
459std::vector<std::string>
463 std::vector<std::string> paths;
466 if (item.first == tid)
468 paths.push_back(item.second);
493 std::sort(t.begin(), t.end());
494 t.erase(std::unique(t.begin(), t.end()), t.end());
497std::vector<std::string>
526 if (ptrChecker !=
nullptr)
528 TypeId pointee = ptrChecker->GetPointeeTypeId();
532 if (objectTypeId == pointee)
549 const auto vectorChecker =
551 if (vectorChecker !=
nullptr)
553 TypeId item = vectorChecker->GetItemTypeId();
567 std::string childName =
"$" + child.
GetName();
577 if (item.first == tid || item.second == tid)
580 if (item.first == tid)
584 if (item.second == tid)
588 std::string name =
"$" + other.
GetName();
608 static bool mapped =
false;
662typedef std::map<std::string, int32_t>
NameMap;
677 static bool mapped =
false;
702 std::transform(
name.begin(),
name.end(),
name.begin(), ::toupper);
710 for (
const auto& item : noTids)
731 static bool mapped =
false;
738 for (
const auto& item : nameMap)
751 groups[group].insert(tid);
795 os <<
SpanWithId(
"config-paths",
"Introspection did not find any typical Config paths")
800 os <<
HeadingWithId(
"config-paths",
"Config Paths") << std::endl;
802 os << tid.
GetName() <<
" is accessible through the following paths"
803 <<
" with Config::Set and Config::Connect:" << std::endl;
805 for (
const auto& path : paths)
830 for (
const auto& [
name, info] : index)
835 << info.checker->GetValueTypeName() <<
listLineStop << std::endl;
837 std::string underType;
838 if (info.checker->HasUnderlyingTypeInformation())
842 std::string valType = info.checker->GetValueTypeName();
843 underType = info.checker->GetUnderlyingTypeInformation();
844 bool handled =
false;
845 if ((valType !=
"ns3::EnumValue") && (underType !=
"std::string"))
848 if (valType ==
"ns3::PointerValue")
850 const auto ptrChecker =
852 if (ptrChecker !=
nullptr)
855 <<
"< " <<
reference << ptrChecker->GetPointeeTypeId().GetName() <<
">";
859 else if (valType ==
"ns3::ObjectPtrContainerValue")
861 const auto ptrChecker =
863 if (ptrChecker !=
nullptr)
866 <<
"< " <<
reference << ptrChecker->GetItemTypeId().GetName() <<
">";
872 auto match = [&uType = std::as_const(underType)](
const std::string& s) {
873 return uType.rfind(s, 0) == 0;
876 if (match(
"bool") || match(
"double") || match(
"int8_t") || match(
"uint8_t") ||
877 match(
"int16_t") || match(
"uint16_t") || match(
"int32_t") ||
878 match(
"uint32_t") || match(
"int64_t") || match(
"uint64_t"))
892 std::string value = info.initialValue->SerializeToString(info.checker);
893 if (underType ==
"std::string" && value.empty())
900 bool moreFlags{
false};
906 std::string msg) ->
void {
907 if (myInfo.flags & flag && hasFunc)
946 os <<
HeadingWithId(
"attributes",
"Attributes") << std::endl;
980 for (
const auto& [
name, info] : index)
990 os <<
"Callback signature: " << info.callback << std::endl;
1015 os <<
SpanWithId(
"trace-sources",
"No TraceSources are defined for this type") <<
breakBoth
1020 os <<
HeadingWithId(
"trace-sources",
"TraceSources") << std::endl;
1051 std::size_t arch = (
sizeof(
void*) * CHAR_BIT);
1053 os <<
BoldWithId(
"size",
"Size") <<
"of this type is " << tid.
GetSize() <<
" bytes (on a "
1054 << arch <<
"-bit architecture)." <<
breakBoth << std::endl;
1108 for (
const auto& item : nameMap)
1111 if (item.second < 0)
1134 os <<
commentStart <<
page <<
"TypeIdList All ns3::TypeId's\n" << std::endl;
1135 os <<
"This is a list of all" <<
reference <<
"ns3::TypeId's.\n"
1136 <<
"For more information see the" <<
reference <<
"ns3::TypeId "
1137 <<
"section of this API documentation and the" <<
referenceNo <<
"TypeId section "
1138 <<
"in the Configuration and " <<
referenceNo <<
"Attributes chapter of the Manual.\n"
1146 for (
const auto& item : nameMap)
1149 if (item.second < 0)
1176 os <<
commentStart <<
page <<
"AttributeList All Attributes\n" << std::endl;
1177 os <<
"This is a list of all" <<
reference <<
"attributes classes. "
1178 <<
"For more information see the" <<
reference <<
"attributes "
1179 <<
"section of this API documentation and the Attributes sections "
1180 <<
"in the Tutorial and Manual.\n"
1186 for (
const auto& item : nameMap)
1189 if (item.second < 0)
1205 for (
const auto& [
name, info] : index)
1225 os <<
commentStart <<
page <<
"GlobalValueList All GlobalValues\n" << std::endl;
1226 os <<
"This is a list of all" <<
reference <<
"ns3::GlobalValue instances.\n"
1227 <<
"See ns3::GlobalValue for how to set these." << std::endl;
1233 (*i)->GetValue(val);
1236 << (*i)->GetHelp() <<
". Default value: " << val.
Get() <<
"." <<
listLineStop
1253 os <<
commentStart <<
page <<
"GroupsList All Object Groups\n" << std::endl;
1254 os <<
"This is a list of all Object Groups.\n"
1255 <<
"Objects are added to groups by " <<
hrefStart <<
"ns3::TypeId::SetGroupName()" <<
hrefMid
1256 <<
"ns3::TypeId::SetGroupName" <<
hrefStop <<
"\n"
1261 for (
const auto& g : groups)
1266 for (
const auto& tid : g.second)
1285 os <<
commentStart <<
page <<
"LogComponentList All LogComponents\n" << std::endl;
1286 os <<
"This is a list of all" <<
reference <<
"ns3::LogComponent instances.\n" << std::endl;
1294 std::size_t widthL = std::string(
"Log Component").size();
1295 std::size_t widthR = std::string(
"file").size();
1296 for (
const auto& it : (*logs))
1298 widthL = std::max(widthL, it.first.size());
1299 std::string
file = it.second->File();
1302 while (
file.find(
"../") == 0)
1306 widthR = std::max(widthR,
file.size());
1308 const std::string tLeft(
"| ");
1309 const std::string tMid(
" | ");
1310 const std::string tRight(
" |");
1313 os << tLeft << std::setw(widthL) << std::left <<
"Log Component" << tMid << std::setw(widthR)
1314 << std::left <<
"File" << tRight << std::endl;
1315 os << tLeft <<
":" << std::string(widthL - 1,
'-') << tMid <<
":"
1316 << std::string(widthR - 1,
'-') << tRight << std::endl;
1318 for (
const auto& it : (*logs))
1320 std::string
file = it.second->File();
1323 while (
file.find(
"../") == 0)
1328 os << tLeft << std::setw(widthL) << std::left << it.first << tMid << std::setw(widthR)
1329 <<
file << tRight << std::endl;
1331 os << std::right << std::endl;
1347 os <<
commentStart <<
page <<
"TraceSourceList All TraceSources\n" << std::endl;
1348 os <<
"This is a list of all" <<
reference <<
"tracing sources. "
1349 <<
"For more information see the " <<
reference <<
"tracing "
1350 <<
"section of this API documentation and the Tracing sections "
1351 <<
"in the Tutorial and Manual.\n"
1358 for (
const auto& item : nameMap)
1361 if (item.second < 0)
1378 for (
const auto& [
name, info] : index)
1410 std::string section =
"attribute_" +
name;
1416 <<
"AttributeValue implementation for " <<
name <<
"\n";
1437 const std::string&
name,
1438 const std::string& type,
1439 const std::string& header)
1446 std::string valClass =
name +
"Value";
1447 std::string qualClass =
" ns3::" + valClass;
1450 os <<
classStart << qualClass <<
" \"" << header <<
"\"" << std::endl;
1451 os <<
"AttributeValue implementation for " <<
name <<
"." << std::endl;
1452 os <<
seeAlso <<
"AttributeValue" << std::endl;
1458 os <<
"(const " << type <<
" & value)\n"
1460 <<
argument <<
"[in] value The " <<
name <<
" value to use.\n";
1470 <<
"Access the " <<
name <<
" value as type " <<
codeWord <<
"T.\n"
1477 if (type !=
"Callback")
1481 <<
"Set the value.\n"
1482 <<
argument <<
"[in] value The value to adopt.\n"
1488 <<
"The stored " <<
name <<
" instance.\n"
1506 std::string make =
"ns3::Make" +
name +
"Accessor ";
1511 << make <<
"(T1 a1)\n"
1512 <<
copyDoc <<
"ns3::MakeAccessorHelper(T1)\n"
1513 <<
seeAlso <<
"AttributeAccessor\n"
1519 << make <<
"(T1 a1, T2 a2)\n"
1520 <<
copyDoc <<
"ns3::MakeAccessorHelper(T1,T2)\n"
1521 <<
seeAlso <<
"AttributeAccessor\n"
1539 std::string make =
"ns3::Make" +
name +
"Checker ";
1545 <<
" \"" << header <<
"\"" << std::endl;
1546 os <<
"AttributeChecker implementation for " <<
name <<
"Value." << std::endl;
1547 os <<
seeAlso <<
"AttributeChecker" << std::endl;
1554 <<
returns <<
"The AttributeChecker.\n"
1555 <<
seeAlso <<
"AttributeChecker\n"
1601 {
"Address",
"Address",
true,
"address.h" },
1602 {
"Box",
"Box",
true,
"box.h" },
1603 {
"DataRate",
"DataRate",
true,
"data-rate.h" },
1604 {
"Length",
"Length",
true,
"length.h" },
1605 {
"Ipv4Address",
"Ipv4Address",
true,
"ipv4-address.h" },
1606 {
"Ipv4Mask",
"Ipv4Mask",
true,
"ipv4-address.h" },
1607 {
"Ipv6Address",
"Ipv6Address",
true,
"ipv6-address.h" },
1608 {
"Ipv6Prefix",
"Ipv6Prefix",
true,
"ipv6-address.h" },
1609 {
"Mac16Address",
"Mac16Address",
true,
"mac16-address.h" },
1610 {
"Mac48Address",
"Mac48Address",
true,
"mac48-address.h" },
1611 {
"Mac64Address",
"Mac64Address",
true,
"mac64-address.h" },
1612 {
"ObjectFactory",
"ObjectFactory",
true,
"object-factory.h" },
1613 {
"Priomap",
"Priomap",
true,
"prio-queue-disc.h" },
1614 {
"QueueSize",
"QueueSize",
true,
"queue-size.h" },
1615 {
"Rectangle",
"Rectangle",
true,
"rectangle.h" },
1616 {
"Ssid",
"Ssid",
true,
"ssid.h" },
1617 {
"TypeId",
"TypeId",
true,
"type-id.h" },
1618 {
"UanModesList",
"UanModesList",
true,
"uan-tx-mode.h" },
1619 {
"ValueClassTest",
"ValueClassTest",
false,
"attribute-test-suite.cc" },
1620 {
"Vector2D",
"Vector2D",
true,
"vector.h" },
1621 {
"Vector3D",
"Vector3D",
true,
"vector.h" },
1622 {
"Waypoint",
"Waypoint",
true,
"waypoint.h" },
1623 {
"WifiMode",
"WifiMode",
true,
"wifi-mode.h" },
1626 {
"Boolean",
"bool",
false,
"boolean.h" },
1627 {
"Callback",
"CallbackBase",
true,
"callback.h" },
1628 {
"Double",
"double",
false,
"double.h" },
1629 {
"Enum",
"T",
false,
"enum.h" },
1630 {
"Integer",
"int64_t",
false,
"integer.h" },
1631 {
"String",
"std::string",
false,
"string.h" },
1632 {
"Time",
"Time",
true,
"nstime.h" },
1633 {
"Uinteger",
"uint64_t",
false,
"uinteger.h" },
1634 {
"",
"",
false,
"last placeholder" }
1639 while (!attributes[i].m_name.empty())
1660main(
int argc,
char* argv[])
1667 cmd.Usage(
"Generate documentation for all ns-3 registered types, "
1668 "trace sources, attributes and global variables.");
1669 cmd.AddValue(
"output-text",
"format output as plain text",
outputText);
1670 cmd.AddValue(
"TypeId",
"Print docs for just the given TypeId", typeId);
1671 cmd.Parse(argc, argv);
1673 if (!typeId.empty())
1683 auto fqTypeId =
"ns3::" + typeId;
1687 std::cout <<
"\nFound fully qualified name " << fqTypeId <<
"\n\n";
1697 std::cerr <<
"Invalid TypeId name: " << typeId <<
"\n" << std::endl;
1709 std::cout << std::endl;
1712 <<
"Doxygen docs generated from the TypeId database.\n"
1713 <<
note <<
"This file is automatically generated by " <<
codeWord
1714 <<
"print-introspected-doxygen.cc. Do not edit this file! "
1715 <<
"Edit that file instead.\n"
Parse command-line arguments.
static Iterator Begin()
The Begin iterator.
static Iterator End()
The End iterator.
static ComponentList * GetComponentList()
Get the list of LogComponents.
std::unordered_map< std::string, LogComponent * > ComponentList
LogComponent name map.
keep track of a set of node pointers.
void Create(uint32_t n)
Create n nodes and append pointers to them to the end of this NodeContainer.
static TypeId GetTypeId()
Register this type.
AttributeChecker implementation for ObjectPtrContainerValue.
AttributeChecker implementation for PointerValue.
Smart pointer class similar to boost::intrusive_ptr.
Hold variables of type string.
a unique identifier for an interface.
bool IsChildOf(TypeId other) const
Check if this TypeId is a child of another.
std::size_t GetTraceSourceN() const
Get the number of Trace sources.
bool MustHideFromDocumentation() const
Check if this TypeId should not be listed in documentation.
AttributeFlag
Flags describing when a given attribute can be read or written.
@ ATTR_GET
The attribute can be read.
@ ATTR_SET
The attribute can be written.
@ ATTR_CONSTRUCT
The attribute can be written at construction-time.
TypeId::TraceSourceInformation GetTraceSource(std::size_t i) const
Get the trace source by index.
std::string GetGroupName() const
Get the group name.
static uint16_t GetRegisteredN()
Get the number of registered TypeIds.
std::size_t GetAttributeN() const
Get the number of attributes.
TypeId GetParent() const
Get the parent of this TypeId.
static TypeId GetRegistered(uint16_t i)
Get a TypeId by index.
std::size_t GetSize() const
Get the size of this object.
TypeId::AttributeInformation GetAttribute(std::size_t i) const
Get Attribute information by index.
static bool LookupByNameFailSafe(std::string name, TypeId *tid)
Get a TypeId by name.
SupportLevel
The level of support or deprecation for attributes or trace sources.
std::string GetName() const
Get the name.
#define NS_ASSERT_MSG(condition, message)
At runtime, in debugging builds, if this condition is not true, the program prints the message to out...
Ptr< Object > GetRootNamespaceObject(uint32_t i)
std::size_t GetRootNamespaceObjectN()
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
#define NS_LOG_FUNCTION_NOARGS()
Output the name of the function.
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
Ptr< T > CreateObject(Args &&... args)
Create an object by type, with varying number of constructor parameters.
std::string headingWithIdMid
middle of section heading with id (h3)
std::string functionStart
start of a method/function
std::string hrefStop
end of a link
std::string spanWithIdStop
end of span with id
std::string referenceNo
block automatic references
std::string anchor
Markup tokens.
std::string argument
function argument
std::string functionStop
end of a method/function
std::string headingStart
start of section heading (h3)
std::string headingStop
end of section heading (h3)
std::string copyDoc
copy (or refer) to docs elsewhere
std::string headingWithIdStop
end of section heading with id (h3)
std::string HeadingWithId(const std::string id, const std::string displayText)
Generate heading (h3) markup with id if not generating text only.
std::string breakBoth
linebreak
std::string listLineStart
start unordered list item
std::map< std::string, ns3::TypeId::TraceSourceInformation > SortedTraceSourceInfo(const TypeId tid)
Alphabetize the TraceSourceInformation for a TypeId by the TraceSource name.
std::string templateArgument
template argument
std::string returns
the return value
std::string spanWithIdStart
start of span with id
std::string breakHtmlOnly
linebreak for html output only
std::string templArgExplicit
template argument required
std::string hrefStart
start of a link
std::string subSectionStart
start a new subsection
std::string hrefMid
middle part of a link
std::string commentStart
start of code comment
std::string headingWithIdStart
start of section heading with id (h3)
std::map< std::string, ns3::TypeId::AttributeInformation > SortedAttributeInfo(const TypeId tid)
Alphabetize the AttributeInformation for a TypeId by the Attribute name.
bool outputText
Are we generating text or Doxygen?
std::string page
start a separate page
std::string seeAlso
Reference to other docs.
std::string commentStop
end of code comment
std::string indentHtmlOnly
small indent
std::string codeWord
format next word as source code
std::string note
start a note section
std::string listLineStop
end unordered list item
std::string listStop
end unordered list
std::string classStop
end of a class
std::string breakTextOnly
linebreak for text output only
std::string SpanWithId(const std::string id, const std::string displayText)
Generate span (span) HTML markup with id if not generating text only.
std::string brief
brief tag
std::string reference
reference tag
std::string flagSpanStop
end of Attribute flag value
std::string boldWithIdMid
middle of bold span with id
std::string boldWithIdStop
end of bold span with id
std::string BoldWithId(const std::string id, const std::string displayText)
Generate bold (b) HTML markup with id if not generating text only.
std::string boldWithIdStart
start of bold with id
std::string spanWithIdMid
middle of span with id
std::string variable
variable or class member
std::string boldStart
start of bold span
std::string boldStop
end of bold span
std::string classStart
start of a class
std::string sectionStart
start of a section or group
std::string listStart
start unordered list
std::string flagSpanStart
start of Attribute flag value
std::string templArgDeduced
template argument deduced from function
Every class exported by the ns3 library is enclosed in the ns3 namespace.
U * PeekPointer(const Ptr< U > &p)
StaticInformation GetTypicalAggregations()
Register aggregation relationships that are not automatically detected by this introspection program.
void PrintTraceSourcesTid(std::ostream &os, const TypeId tid)
Print direct Trace sources for this TypeId.
std::set< TypeId > GroupList_t
List of TypeIds for a group.
std::map< std::string, int32_t > NameMap
Map from TypeId name to tid.
void PrintMakeAccessors(std::ostream &os, const std::string &name)
Print the AttributeValue MakeAccessor documentation for a class.
void PrintAllTraceSources(std::ostream &os)
Print the list of all Trace sources.
void PrintAllLogComponents(std::ostream &os)
Print the list of all LogComponents.
void PrintAttributeHelper(std::ostream &os, const AttributeDescriptor &attr)
Print documentation corresponding to use of the ATTRIBUTE_HELPER_HEADER macro or ATTRIBUTE_VALUE_DEFI...
void PrintTypeIdBlock(std::ostream &os, const TypeId tid)
Print the doxy block for a single TypeId.
void PrintTypeIdBlocks(std::ostream &os)
Print the doxy block for each TypeId.
std::map< std::string, GroupList_t > GroupsList_t
Collection of group names with associated TypeIds.
void PrintAllAttributes(std::ostream &os)
Print the list of all Attributes.
void PrintAttributeValueWithName(std::ostream &os, const std::string &name, const std::string &type, const std::string &header)
Print the AttributeValue documentation for a class.
GroupsList_t GetGroupsList()
Get a sorted list of TypeId groups.
void PrintSupportLevel(std::ostream &os, TypeId::SupportLevel supportLevel, std::string supportMsg)
Print the support level for an Attribute or TraceSource.
void PrintSize(std::ostream &os, const TypeId tid)
Print the size of the type represented by this tid.
void Uniquefy(T t)
Helper to keep only the unique items in a container.
void PrintAttributeImplementations(std::ostream &os)
Print documentation for Attribute implementations.
NameMap GetNameMap()
Create a map from the class names to their index in the vector of TypeId's so that the names will end...
void PrintTraceSources(std::ostream &os, const TypeId tid)
Print the Trace sources block for tid, including Trace sources declared in base classes.
void SetMarkup()
Initialize the markup strings, for either doxygen or text.
NameMap::const_iterator NameMapIterator
NameMap iterator.
void PrintConfigPaths(std::ostream &os, const TypeId tid)
Print config paths.
void PrintAllTypeIds(std::ostream &os)
Print the list of all TypeIds.
void PrintAttributes(std::ostream &os, const TypeId tid)
Print the Attributes block for tid, including Attributes declared in base classes.
void PrintAllGroups(std::ostream &os)
Print the list of all groups.
void PrintAllGlobals(std::ostream &os)
Print the list of all global variables.
void PrintMakeChecker(std::ostream &os, const std::string &name, const std::string &header)
Print the AttributeValue MakeChecker documentation for a class.
void PrintAttributeValueSection(std::ostream &os, const std::string &name, const bool seeBase=true)
Print the section definition for an AttributeValue.
void PrintAttributesTid(std::ostream &os, const TypeId tid)
Print direct Attributes for this TypeId.
Descriptor for an AttributeValue.
const std::string m_header
The header file name.
const std::string m_type
The name of the underlying type.
const std::string m_name
The base name of the resulting AttributeValue type.
const bool m_seeBase
Print a "see also" pointing to the base class.