Functions
Tuple[str, bool, List[str]]	check_formatting_file (str filename, bool fix, bool verbose, str clang_format_path)
	CHECK STYLE FUNCTIONS. More...

Tuple[bool, str, List[str]]	check_include_prefixes_line (str line, str filename, int line_number)

Tuple[str, bool, List[str]]	check_manually_file (str filename, bool fix, bool verbose, bool respect_clang_format_guards, Callable[[str, str, int], Tuple[bool, str, List[str]]] check_style_line_function)

bool	check_style_clang_format (List[str] paths, bool enable_check_include_prefixes, bool enable_check_formatting, bool enable_check_whitespace, bool enable_check_tabs, bool fix, bool verbose, int n_jobs=1)
	CHECK STYLE MAIN FUNCTIONS. More...

bool	check_style_files (str style_check_str, Callable[..., Tuple[str, bool, List[str]]] check_style_file_function, List[str] filenames, bool fix, bool verbose, int n_jobs, **kwargs)

Tuple[bool, str, List[str]]	check_tabs_line (str line, str filename, int line_number)

Tuple[bool, str, List[str]]	check_whitespace_line (str line, str filename, int line_number)

str	find_clang_format_path ()

Tuple[List[str], List[str], List[str], List[str]]	find_files_to_check_style (List[str] paths)

bool	should_analyze_directory (str dirpath)
	AUXILIARY FUNCTIONS. More...

bool	should_analyze_file (str path, List[str] files_to_check, List[str] file_extensions_to_check)

Variables
	action

bool	all_checks_successful

	args = parser.parse_args()

string	CLANG_FORMAT_GUARD_OFF = "// clang-format off"

string	CLANG_FORMAT_GUARD_ON = "// clang-format on"

list	CLANG_FORMAT_VERSIONS
	PARAMETERS. More...

	default

list	DIRECTORIES_TO_SKIP

list	FILE_EXTENSIONS_TO_CHECK_FORMATTING

list	FILE_EXTENSIONS_TO_CHECK_INCLUDE_PREFIXES = FILE_EXTENSIONS_TO_CHECK_FORMATTING

list	FILE_EXTENSIONS_TO_CHECK_TABS

list	FILE_EXTENSIONS_TO_CHECK_WHITESPACE

list	FILES_TO_CHECK_WHITESPACE

list	FILES_TO_SKIP

	help

	nargs

	parser
	MAIN. More...

int	TAB_SIZE = 4

	type

Function Documentation

◆ check_formatting_file()

Tuple[str, bool, List[str]] check-style-clang-format.check_formatting_file	(	str	filename,
		bool	fix,
		bool	verbose,
		str	clang_format_path
	)

CHECK STYLE FUNCTIONS.

Check / fix the coding style of a file with clang-format.

@param filename Name of the file to be checked.
@param fix Whether to fix (True) or just check (False) the style of the file (True).
@param verbose Show the lines that are not compliant with the style.
@param clang_format_path Path to clang-format.
@return Tuple [Filename,
               Whether the file is compliant with the style (before the check),
               Verbose information].

Definition at line 443 of file check-style-clang-format.py.

◆ check_include_prefixes_line()

Tuple[bool, str, List[str]] check-style-clang-format.check_include_prefixes_line	(	str	line,
		str	filename,
		int	line_number
	)

Check / fix #include headers from the same module with the "ns3/" prefix in a line.

@param line The line to check.
@param filename Name of the file to be checked.
@param line_number The number of the line checked.
@return Tuple [Whether the line is compliant with the style (before the check),
               Fixed line,
               Verbose information].

Definition at line 566 of file check-style-clang-format.py.

◆ check_manually_file()

Tuple[str, bool, List[str]] check-style-clang-format.check_manually_file	(	str	filename,
		bool	fix,
		bool	verbose,
		bool	respect_clang_format_guards,
		Callable[[str, str, int], Tuple[bool, str, List[str]]]	check_style_line_function
	)

Check / fix a file manually using a function to check / fix each line.

@param filename Name of the file to be checked.
@param fix Whether to fix (True) or just check (False) the style of the file (True).
@param verbose Show the lines that are not compliant with the style.
@param respect_clang_format_guards Whether to respect clang-format guards.
@param check_style_line_function Function used to check each line.
@return Tuple [Filename,
               Whether the file is compliant with the style (before the check),
               Verbose information].

Definition at line 501 of file check-style-clang-format.py.

◆ check_style_clang_format()

bool check-style-clang-format.check_style_clang_format	(	List[str]	paths,
		bool	enable_check_include_prefixes,
		bool	enable_check_formatting,
		bool	enable_check_whitespace,
		bool	enable_check_tabs,
		bool	fix,
		bool	verbose,
		int	n_jobs = `1`
	)

CHECK STYLE MAIN FUNCTIONS.

Check / fix the coding style of a list of files.

@param paths List of paths to the files to check.
@param enable_check_include_prefixes Whether to enable checking #include headers from the same module with the "ns3/" prefix.
@param enable_check_formatting Whether to enable checking code formatting.
@param enable_check_whitespace Whether to enable checking trailing whitespace.
@param enable_check_tabs Whether to enable checking tabs.
@param fix Whether to fix (True) or just check (False) the file.
@param verbose Show the lines that are not compliant with the style.
@param n_jobs Number of parallel jobs.
@return Whether all files are compliant with all enabled style checks.

Definition at line 276 of file check-style-clang-format.py.

References check_style_files(), find_clang_format_path(), and find_files_to_check_style().

Here is the call graph for this function:

◆ check_style_files()

bool check-style-clang-format.check_style_files	(	str	style_check_str,
		Callable[..., Tuple[str, bool, List[str]]]	check_style_file_function,
		List[str]	filenames,
		bool	fix,
		bool	verbose,
		int	n_jobs,
		**	kwargs
	)

Check / fix style of a list of files.

@param style_check_str Description of the check to be performed.
@param check_style_file_function Function used to check the file.
@param filename Name of the file to be checked.
@param fix Whether to fix (True) or just check (False) the file (True).
@param verbose Show the lines that are not compliant with the style.
@param n_jobs Number of parallel jobs.
@param kwargs Additional keyword arguments to the check_style_file_function.
@return Whether all files are compliant with the style.

Definition at line 375 of file check-style-clang-format.py.

Referenced by check_style_clang_format().

Here is the caller graph for this function:

◆ check_tabs_line()

Tuple[bool, str, List[str]] check-style-clang-format.check_tabs_line	(	str	line,
		str	filename,
		int	line_number
	)

Check / fix tabs in a line.

@param line The line to check.
@param filename Name of the file to be checked.
@param line_number The number of the line checked.
@return Tuple [Whether the line is compliant with the style (before the check),
               Fixed line,
               Verbose information].

Definition at line 650 of file check-style-clang-format.py.

◆ check_whitespace_line()

Tuple[bool, str, List[str]] check-style-clang-format.check_whitespace_line	(	str	line,
		str	filename,
		int	line_number
	)

Check / fix whitespace in a line.

@param line The line to check.
@param filename Name of the file to be checked.
@param line_number The number of the line checked.
@return Tuple [Whether the line is compliant with the style (before the check),
               Fixed line,
               Verbose information].

Definition at line 617 of file check-style-clang-format.py.

◆ find_clang_format_path()

str check-style-clang-format.find_clang_format_path ( )

Find the path to one of the supported versions of clang-format.
If no supported version of clang-format is found, raise an exception.

@return Path to clang-format.

Definition at line 234 of file check-style-clang-format.py.

Referenced by check_style_clang_format().

Here is the caller graph for this function:

◆ find_files_to_check_style()

Tuple[List[str], List[str], List[str], List[str]] check-style-clang-format.find_files_to_check_style ( List[str] paths )

Find all files to be checked in a given list of paths.

@param paths List of paths to the files to check.
@return Tuple [List of files to check include prefixes,
               List of files to check formatting,
               List of files to check trailing whitespace,
               List of files to check tabs].

Definition at line 173 of file check-style-clang-format.py.

References should_analyze_directory(), and should_analyze_file().

Referenced by check_style_clang_format().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ should_analyze_directory()

bool check-style-clang-format.should_analyze_directory ( str dirpath )

AUXILIARY FUNCTIONS.

Check whether a directory should be analyzed.

@param dirpath Directory path.
@return Whether the directory should be analyzed.

Definition at line 134 of file check-style-clang-format.py.

Referenced by find_files_to_check_style().

Here is the caller graph for this function:

◆ should_analyze_file()

bool check-style-clang-format.should_analyze_file	(	str	path,
		List[str]	files_to_check,
		List[str]	file_extensions_to_check
	)

Check whether a file should be analyzed.

@param path Path to the file.
@param files_to_check List of files that shall be checked.
@param file_extensions_to_check List of file extensions that shall be checked.
@return Whether the file should be analyzed.

Definition at line 149 of file check-style-clang-format.py.

Referenced by find_files_to_check_style().

Here is the caller graph for this function:

Variable Documentation

◆ action

check-style-clang-format.action

Definition at line 703 of file check-style-clang-format.py.

Referenced by ns3::dot11s::HwmpProtocolMac.GetWifiActionHeader(), ns3.load_clicked_attribute(), ns3.load_clicked_default(), ns3::EmlsrManager.NotifyMgtFrameReceived(), ns3.operator<<(), ns3::ApWifiMac.Receive(), ns3::StaWifiMac.Receive(), ns3.save_clicked_attribute(), ns3.save_clicked_default(), ns3::QKDApp014.ScheduleAction(), ns3::QKDKeyManagerSystemApplication.ScheduleCheckAssociation(), ns3::HtFrameExchangeManager.SendAddBaRequest(), ns3::HtFrameExchangeManager.SendAddBaResponse(), ns3::HtFrameExchangeManager.SendDelbaFrame(), ns3::EhtFrameExchangeManager.SendEmlOmn(), ns3::dot11s::PeerManagementProtocolMac.SendPeerLinkManagementFrame(), ns3::WifiActionHeader.SetAction(), ns3::CsParameters.SetClassifierDscAction(), EmlOmnExchangeTest.Transmit(), EmlsrDlTxopTest.Transmit(), EmlsrLinkSwitchTest.Transmit(), ns3::EmlsrManager.TxDropped(), EmlOmnExchangeTest.TxDropped(), ns3::ApWifiMac.TxOk(), ns3::EmlsrManager.TxOk(), and EmlOmnExchangeTest.TxOk().

◆ all_checks_successful

bool check-style-clang-format.all_checks_successful

Initial value:

 =  check_style_clang_format(
             paths=args.paths,
             enable_check_include_prefixes=(not args.no_include_prefixes),
             enable_check_formatting=(not args.no_formatting),
             enable_check_whitespace=(not args.no_whitespace),
             enable_check_tabs=(not args.no_tabs),
             fix=args.fix,
             verbose=args.verbose,
             n_jobs=args.jobs,
         )

Definition at line 757 of file check-style-clang-format.py.

◆ args

check-style-clang-format.args = parser.parse_args()

Definition at line 754 of file check-style-clang-format.py.

Referenced by MpiTestSuite.MpiTestSuite(), ns3::NodeContainer.NodeContainer(), ns3::ObjectFactory.ObjectFactory(), ns3::NodeContainer.Add(), ns3::TrafficControlHelper.AddChildQueueDisc(), ns3::TrafficControlHelper.AddChildQueueDiscs(), ns3::TrafficControlHelper.AddInternalQueues(), ns3::TrafficControlHelper.AddPacketFilter(), ns3::SpectrumChannelHelper.AddPropagationLoss(), ns3::YansWifiChannelHelper.AddPropagationLoss(), ns3::TrafficControlHelper.AddQueueDiscClasses(), ns3::SpectrumChannelHelper.AddSpectrumPropagationLoss(), ns3::WifiHelper.ConfigEhtOptions(), ns3::WifiHelper.ConfigHeOptions(), ns3::WifiHelper.ConfigHtOptions(), ns3::WifiHelper.ConfigVhtOptions(), nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >.create(), ns3.Create(), ns3.CreateObject(), ns3.CreateObjectWithAttributes(), nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >.emplace(), nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >.emplace_back(), ns3::CommandLine.HandleHardOptions(), ns3::DesMetrics.Initialize(), nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >.insert_iterator(), ns3.MakeEnumChecker(), ns3::WifiPhyStateHelper.NotifyListeners(), ns3::TracedCallback< Ts >.operator()(), ns3.operator<<(), ns3::CommandLine.Parse(), ns3::Simulator.Schedule(), ns3::Simulator.ScheduleDestroy(), ns3::Simulator.ScheduleNow(), ns3::Simulator.ScheduleWithContext(), ns3::TupleValue< Args >.Set(), ns3::ObjectFactory.Set(), ns3::WifiTxTimer.Set(), ns3::WifiMacHelper.SetAckManager(), ns3::AdhocAlohaNoackIdealPhyHelper.SetAntenna(), ns3::SpectrumAnalyzerHelper.SetAntenna(), ns3::WaveformGeneratorHelper.SetAntenna(), ns3::TrickleTimer.SetArguments(), ns3::Watchdog.SetArguments(), ns3::Timer.SetArguments(), ns3::WifiMacHelper.SetAssocManager(), ns3::SimpleNetDeviceHelper.SetChannel(), ns3::SpectrumChannelHelper.SetChannel(), ns3::WifiMacHelper.SetEmlsrManager(), ns3::WifiPhyHelper.SetErrorRateModel(), ns3::WifiPhyHelper.SetFrameCaptureModel(), ns3::WifiPhyHelper.SetInterferenceHelper(), ns3::UanHelper.SetMac(), ns3::WifiMacHelper.SetMacQueueScheduler(), ns3::MeshHelper.SetMacType(), ns3::GroupMobilityHelper.SetMemberMobilityModel(), ns3::GroupMobilityHelper.SetMemberPositionAllocator(), ns3::MobilityHelper.SetMobilityModel(), ns3::WifiMacHelper.SetMultiUserScheduler(), ns3::WifiHelper.SetObssPdAlgorithm(), ns3::SpectrumPhyHelper.SetPhy(), ns3::UanHelper.SetPhy(), ns3::MobilityHelper.SetPositionAllocator(), ns3::WifiPhyHelper.SetPreambleDetectionModel(), ns3::SpectrumChannelHelper.SetPropagationDelay(), ns3::YansWifiChannelHelper.SetPropagationDelay(), ns3::WifiMacHelper.SetProtectionManager(), ns3::CsmaHelper.SetQueue(), ns3::SimpleNetDeviceHelper.SetQueue(), ns3::PointToPointHelper.SetQueue(), ns3::TrafficControlHelper.SetQueueLimits(), ns3::GroupMobilityHelper.SetReferenceMobilityModel(), ns3::GroupMobilityHelper.SetReferencePositionAllocator(), ns3::WifiHelper.SetRemoteStationManager(), ns3::MeshHelper.SetRemoteStationManager(), ns3::TrafficControlHelper.SetRootQueueDisc(), ns3::MeshHelper.SetStackInstaller(), ns3::UanHelper.SetTransducer(), ns3::WifiRadioEnergyModelHelper.SetTxCurrentModel(), ns3::WifiMacHelper.SetType(), ns3::HeaderSerializationTestCase.TestHeaderSerialization(), LengthTestCase.TestTryParseReturnsTrue(), ns3::WifiTxTimer.Timeout(), and ns3::DesMetrics.TraceWithContext().

◆ CLANG_FORMAT_GUARD_OFF

string check-style-clang-format.CLANG_FORMAT_GUARD_OFF = "// clang-format off"

Definition at line 58 of file check-style-clang-format.py.

◆ CLANG_FORMAT_GUARD_ON

string check-style-clang-format.CLANG_FORMAT_GUARD_ON = "// clang-format on"

Definition at line 57 of file check-style-clang-format.py.

◆ CLANG_FORMAT_VERSIONS

list check-style-clang-format.CLANG_FORMAT_VERSIONS

Initial value:

PARAMETERS.

Definition at line 50 of file check-style-clang-format.py.

◆ default

check-style-clang-format.default

Definition at line 750 of file check-style-clang-format.py.

◆ DIRECTORIES_TO_SKIP

list check-style-clang-format.DIRECTORIES_TO_SKIP

Initial value:

 =  [
     "__pycache__",
     ".git",
     "bindings",
     "build",
     "cmake-cache",
     "testpy-output",
 ]

Definition at line 60 of file check-style-clang-format.py.

◆ FILE_EXTENSIONS_TO_CHECK_FORMATTING

list check-style-clang-format.FILE_EXTENSIONS_TO_CHECK_FORMATTING

Initial value:

 =  [
     ".c",
     ".cc",
     ".h",
 ]

Definition at line 75 of file check-style-clang-format.py.

◆ FILE_EXTENSIONS_TO_CHECK_INCLUDE_PREFIXES

list check-style-clang-format.FILE_EXTENSIONS_TO_CHECK_INCLUDE_PREFIXES = FILE_EXTENSIONS_TO_CHECK_FORMATTING

Definition at line 81 of file check-style-clang-format.py.

◆ FILE_EXTENSIONS_TO_CHECK_TABS

list check-style-clang-format.FILE_EXTENSIONS_TO_CHECK_TABS

Initial value:

 =  [
     ".c",
     ".cc",
     ".h",
     ".md",
     ".py",
     ".rst",
     ".sh",
     ".yml",
 ]

Definition at line 118 of file check-style-clang-format.py.

◆ FILE_EXTENSIONS_TO_CHECK_WHITESPACE

list check-style-clang-format.FILE_EXTENSIONS_TO_CHECK_WHITESPACE

Initial value:

 =  [
     ".c",
     ".cc",
     ".click",
     ".cmake",
     ".conf",
     ".css",
     ".dot",
     ".gnuplot",
     ".gp",
     ".h",
     ".html",
     ".js",
     ".json",
     ".m",
     ".md",
     ".mob",
     ".ns_params",
     ".ns_movements",
     ".params",
     ".pl",
     ".plt",
     ".py",
     ".rst",
     ".seqdiag",
     ".sh",
     ".txt",
     ".yml",
 ]

Definition at line 83 of file check-style-clang-format.py.

◆ FILES_TO_CHECK_WHITESPACE

list check-style-clang-format.FILES_TO_CHECK_WHITESPACE

Initial value:

 =  [
     "Makefile",
     "ns3",
 ]

Definition at line 113 of file check-style-clang-format.py.

◆ FILES_TO_SKIP

list check-style-clang-format.FILES_TO_SKIP

Initial value:

 =  [
     "valgrind.h",
 ]

Definition at line 71 of file check-style-clang-format.py.

◆ help

check-style-clang-format.help

Definition at line 706 of file check-style-clang-format.py.

Referenced by ns3::GlobalValue.GlobalValue(), ns3::TypeId.AddAttribute(), ns3::IidManager.AddAttribute(), ns3::CommandLine.AddNonOption(), ns3::TypeId.AddTraceSource(), ns3::IidManager.AddTraceSource(), and ns3::CommandLine.AddValue().

◆ nargs

check-style-clang-format.nargs

Definition at line 705 of file check-style-clang-format.py.

◆ parser

check-style-clang-format.parser

Initial value:

 =  argparse.ArgumentParser(
         description="Check and apply the ns-3 coding style recursively to all files in the given PATHs. "
         "The script checks the formatting of the file with clang-format. "
         'Additionally, it checks #include headers from the same module with the "ns3/" prefix, '
         "the presence of trailing whitespace and tabs. "
         'Formatting, local #include "ns3/" prefixes and tabs checks respect clang-format guards. '
         'When used in "check mode" (default), the script checks if all files are well '
         "formatted and do not have trailing whitespace nor tabs. "
         "If it detects non-formatted files, they will be printed and this process exits with a "
         'non-zero code. When used in "fix mode", this script automatically fixes the files.'
     )

MAIN.

Definition at line 689 of file check-style-clang-format.py.

Referenced by ns3::QKDKeyManagerSystemApplication.PacketReceived(), ns3::QKDSDNController.PacketReceived(), ns3::QKDApp004.PacketReceivedFromKMS(), ns3::QKDApp014.PacketReceivedFromKMS(), ns3::QKDKeyManagerSystemApplication.PacketReceivedKMSs(), ns3::QKDKeyManagerSystemApplication.PacketReceivedSDN(), ns3::QKDApp004.SignalingPacketReceivedFromApp(), and ns3::QKDApp014.SignalingPacketReceivedFromApp().

◆ TAB_SIZE

int check-style-clang-format.TAB_SIZE = 4

Definition at line 128 of file check-style-clang-format.py.

◆ type

check-style-clang-format.type

Definition at line 704 of file check-style-clang-format.py.

Functions

Variables

Function Documentation

◆ check_formatting_file()

◆ check_include_prefixes_line()

◆ check_manually_file()

◆ check_style_clang_format()

◆ check_style_files()

◆ check_tabs_line()

◆ check_whitespace_line()

◆ find_clang_format_path()

◆ find_files_to_check_style()

◆ should_analyze_directory()

◆ should_analyze_file()

Variable Documentation

◆ action

◆ all_checks_successful

◆ args

◆ CLANG_FORMAT_GUARD_OFF

◆ CLANG_FORMAT_GUARD_ON

◆ CLANG_FORMAT_VERSIONS

◆ default

◆ DIRECTORIES_TO_SKIP

◆ FILE_EXTENSIONS_TO_CHECK_FORMATTING

◆ FILE_EXTENSIONS_TO_CHECK_INCLUDE_PREFIXES

◆ FILE_EXTENSIONS_TO_CHECK_TABS

◆ FILE_EXTENSIONS_TO_CHECK_WHITESPACE

◆ FILES_TO_CHECK_WHITESPACE

◆ FILES_TO_SKIP

◆ help

◆ nargs

◆ parser

◆ TAB_SIZE

◆ type