[babeltrace.git] / tools / format-cpp

#!/bin/bash
#
# SPDX-License-Identifier: GPL-2.0-only
#
# Copyright (C) 2020-2023 Philippe Proulx <pproulx@efficios.com>

expected_formatter_major_version=15

# Runs the formatter, returning 1 if it's not the expected version.
#
# Argument 1:
#     Starting directory.
#
# Remaining arguments:
#     Formatter command.
format_cpp() {
	local root_dir=$1

	shift

	local formatter=("$@")
	local version

	if ! version=$("${formatter[@]}" --version); then
		echo "Cannot execute \`${formatter[*]} --version\`." >&2
		return 1
	fi

	if [[ "$version" != *"clang-format version $expected_formatter_major_version"* ]]; then
		{
			echo "Expecting clang-format $expected_formatter_major_version."
			echo
			echo Got:
			echo
			echo "$version"
		} >& 2

		return 1
	fi

	# Using xargs(1) to fail as soon as the formatter fails (`-exec`
	# won't stop if its subprocess fails).
	#
	# We want an absolute starting directory because find(1) excludes
	# files in specific subdirectories.
	find "$(realpath "$root_dir")" \( -name '*.cpp' -o -name '*.hpp' \) \
		! -path '*/src/cpp-common/optional.hpp' \
		! -path '*/src/cpp-common/string_view.hpp' \
		! -path '*/src/cpp-common/nlohmann/json.hpp' \
		-print0 | xargs -P"$(nproc)" -n1 -t -0 "${formatter[@]}"
}

# Choose formatter
if [[ -n "$FORMATTER" ]]; then
	# Try using environment-provided formatter
	read -ra formatter <<< "$FORMATTER"
elif command -v clang-format-$expected_formatter_major_version &> /dev/null; then
	# Try using the expected version of clang-format
	formatter=("clang-format-$expected_formatter_major_version" -i)
else
	# Try using `clang-format` as is
	formatter=(clang-format -i)
fi

# Choose root directory
if (($# == 1)); then
	root_dir=$1

	if [[ ! -d "$root_dir" ]]; then
		echo "\`$root_dir\`: expecting an existing directory." >& 2
		exit 1
	fi
else
	# Default: root of the project, processing all C++ files
	root_dir="$(dirname "${BASH_SOURCE[0]}")/.."
fi

# Try to format files
format_cpp "$root_dir" "${formatter[@]}"
Commit	Line	Data
	1	#!/bin/bash
	2	#
	3	# SPDX-License-Identifier: GPL-2.0-only
	4	#
	5	# Copyright (C) 2020-2023 Philippe Proulx <pproulx@efficios.com>
	6
	7	expected_formatter_major_version=15
	8
	9	# Runs the formatter, returning 1 if it's not the expected version.
	10	#
	11	# Argument 1:
	12	# Starting directory.
	13	#
	14	# Remaining arguments:
	15	# Formatter command.
	16	format_cpp() {
	17	local root_dir=$1
	18
	19	shift
	20
	21	local formatter=("$@")
	22	local version
	23
	24	if ! version=$("${formatter[@]}" --version); then
	25	echo "Cannot execute \`${formatter[*]} --version\`." >&2
	26	return 1
	27	fi
	28
	29	if [[ "$version" != "clang-format version $expected_formatter_major_version" ]]; then
	30	{
	31	echo "Expecting clang-format $expected_formatter_major_version."
	32	echo
	33	echo Got:
	34	echo
	35	echo "$version"
	36	} >& 2
	37
	38	return 1
	39	fi
	40
	41	# Using xargs(1) to fail as soon as the formatter fails (`-exec`
	42	# won't stop if its subprocess fails).
	43	#
	44	# We want an absolute starting directory because find(1) excludes
	45	# files in specific subdirectories.
	46	find "$(realpath "$root_dir")" \( -name '.cpp' -o -name '.hpp' \) \
	47	! -path '*/src/cpp-common/optional.hpp' \
	48	! -path '*/src/cpp-common/string_view.hpp' \
	49	! -path '*/src/cpp-common/nlohmann/json.hpp' \
	50	-print0 \| xargs -P"$(nproc)" -n1 -t -0 "${formatter[@]}"
	51	}
	52
	53	# Choose formatter
	54	if [[ -n "$FORMATTER" ]]; then
	55	# Try using environment-provided formatter
	56	read -ra formatter <<< "$FORMATTER"
	57	elif command -v clang-format-$expected_formatter_major_version &> /dev/null; then
	58	# Try using the expected version of clang-format
	59	formatter=("clang-format-$expected_formatter_major_version" -i)
	60	else
	61	# Try using `clang-format` as is
	62	formatter=(clang-format -i)
	63	fi
	64
	65	# Choose root directory
	66	if (($# == 1)); then
	67	root_dir=$1
	68
	69	if [[ ! -d "$root_dir" ]]; then
	70	echo "\`$root_dir\`: expecting an existing directory." >& 2
	71	exit 1
	72	fi
	73	else
	74	# Default: root of the project, processing all C++ files
	75	root_dir="$(dirname "${BASH_SOURCE[0]}")/.."
	76	fi
	77
	78	# Try to format files
	79	format_cpp "$root_dir" "${formatter[@]}"