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

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

Tuple[bool, str, List[str]]	check_licenses_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, Dict[str, bool] checks_enabled, bool fix, bool verbose, int n_jobs=1)
	CHECK STYLE MAIN FUNCTIONS.

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 ()

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

bool	should_analyze_directory (str dirpath)
	AUXILIARY FUNCTIONS.

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()

list	CHECKS

list	CLANG_FORMAT_VERSIONS
	PARAMETERS.

	default

list	DIRECTORIES_TO_SKIP

dict	FILE_EXTENSIONS_TO_CHECK = {c: [] for c in CHECKS}

dict	FILES_TO_CHECK = {c: [] for c in CHECKS}

list	FILES_TO_SKIP

list	FORMAT_GUARD_OFF

list	FORMAT_GUARD_ON

	help

	nargs

	parser

	sep

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.
@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 454 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 576 of file check-style-clang-format.py.

◆ check_licenses_line()

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

Check / fix SPDX licenses rather than GPL text 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 695 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.
@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 512 of file check-style-clang-format.py.

◆ check_style_clang_format()

bool check-style-clang-format.check_style_clang_format	(	List[str]	paths,
		Dict[str, bool]	checks_enabled,
		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 checks_enabled Dictionary of checks indicating whether to enable each of them.
@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 294 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 386 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 660 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 627 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 248 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()

Dict[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 Dictionary of checks and corresponding list of files to check.
        Example: {
            "formatting": list_of_files_to_check_formatting,
            ...,
        }

Definition at line 200 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 163 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 176 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 775 of file check-style-clang-format.py.

◆ all_checks_successful

bool check-style-clang-format.all_checks_successful

Initial value:

=  check_style_clang_format(
            paths=args.paths,
            checks_enabled={
                "include_prefixes": not args.no_include_prefixes,
                "whitespace": not args.no_whitespace,
                "tabs": not args.no_tabs,
                "license": not args.no_licenses,
                "formatting": not args.no_formatting,
            },
            fix=args.fix,
            verbose=args.verbose,
            n_jobs=args.jobs,
        )

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

◆ args

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

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

◆ CHECKS

list check-style-clang-format.CHECKS

Initial value:

=  [
    "include_prefixes",
    "whitespace",
    "tabs",
    "license",
    "formatting",
]

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

◆ CLANG_FORMAT_VERSIONS

list check-style-clang-format.CLANG_FORMAT_VERSIONS

Initial value:

PARAMETERS.

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

◆ default

check-style-clang-format.default

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

◆ DIRECTORIES_TO_SKIP

list check-style-clang-format.DIRECTORIES_TO_SKIP

Initial value:

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

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

◆ FILE_EXTENSIONS_TO_CHECK

dict check-style-clang-format.FILE_EXTENSIONS_TO_CHECK = {c: [] for c in CHECKS}

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

◆ FILES_TO_CHECK

dict check-style-clang-format.FILES_TO_CHECK = {c: [] for c in CHECKS}

Definition at line 86 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 72 of file check-style-clang-format.py.

◆ FORMAT_GUARD_OFF

list check-style-clang-format.FORMAT_GUARD_OFF

Initial value:

=  [
    "// clang-format off",
    "# cmake-format: off",
    "# fmt: off",
]

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

◆ FORMAT_GUARD_ON

list check-style-clang-format.FORMAT_GUARD_ON

Initial value:

=  [
    "// clang-format on",
    "# cmake-format: on",
    "# fmt: on",
]

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

◆ help

check-style-clang-format.help

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

◆ nargs

check-style-clang-format.nargs

Definition at line 777 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 files using clang-format and"
        " other coding style rules manually (see script arguments). "
        "All checks respect clang-format guards, except trailing whitespace, which is always checked. "
        'When used in "check mode" (default), the script runs all checks in all files. '
        "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 and exits with 0 code.'
    )

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

◆ sep

check-style-clang-format.sep

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

◆ TAB_SIZE

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

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

◆ type

check-style-clang-format.type

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

Functions

Variables

Function Documentation

◆ check_formatting_file()

◆ check_include_prefixes_line()

◆ check_licenses_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

◆ CHECKS

◆ CLANG_FORMAT_VERSIONS

◆ default

◆ DIRECTORIES_TO_SKIP

◆ FILE_EXTENSIONS_TO_CHECK

◆ FILES_TO_CHECK

◆ FILES_TO_SKIP

◆ FORMAT_GUARD_OFF

◆ FORMAT_GUARD_ON

◆ help

◆ nargs

◆ parser

◆ sep

◆ TAB_SIZE

◆ type