深入理解 Clang-Tidy 的窄整形转换警告（Narrowing Conversion）及其配置方法

在 C++ 编程中，窄整形转换（Narrowing Conversion）是指将一个较大范围的类型转换为较小范围的类型。这种转换可能会导致数据丢失、溢出或不可预见的行为，因此，在开发中通常需要警惕这些转换。在本篇博客中，我们将深入探讨 Clang-Tidy 中的窄整形转换警告（cppcoreguidelines-narrowing-conversions），并通过配置让它更符合实际需求，避免潜在的类型转换错误。

我们将假设在一个 64 位系统 上工作，这意味着 size_t 和 ptrdiff_t 是 8 字节类型，而 int 和 short 是 4 字节和 2 字节类型。在这个基础上，我们会讨论如何配置 Clang-Tidy，以及如何理解和排除某些类型转换。

什么是窄整形转换（Narrowing Conversion）？

窄整形转换是指将一个较大范围的数据类型转换为一个较小范围的数据类型，可能导致数据丢失或溢出。常见的转换包括将 int 转换为 short 或将 size_t 转换为 int。如果目标类型的范围比源类型小，则可能丢失数据，尤其是在数值超出目标类型的表示范围时。

例子 1：窄整形转换

假设我们在 64 位系统中工作，size_t 和 ptrdiff_t 是 8 字节类型，而 int 和 short 是 4 字节和 2 字节类型。如果将一个大范围的类型转换为较小范围的类型，就可能发生溢出或数据丢失。

size_t largeValue = 1234567890123456;  // 8 字节
int smallValue = largeValue;  // 转换为 4 字节的 int，可能会丢失数据

在这个例子中，largeValue 的值大于 int 所能表示的最大值（通常是 2^31 - 1，对于 4 字节的 int），因此会发生数据丢失。Clang-Tidy 会提示这是一个窄整形转换。

例子 2：合法的窄整形转换

int smallValue = 100;
short smallerValue = smallValue;  // 合法转换，因为数据在 short 类型的范围内（-32768 到 32767）

在这个例子中，smallValue 的值 100 在 short 类型的表示范围内，因此这个转换是安全的，Clang-Tidy 不会发出警告。

Clang-Tidy 的 cppcoreguidelines-narrowing-conversions 规则

Clang-Tidy 是一个 C++ 静态分析工具，它帮助开发者在代码中发现潜在的问题，增强代码质量。cppcoreguidelines-narrowing-conversions 规则用于检查窄整形转换，警告开发者在进行类型转换时可能会丢失数据。

触发警告的例子

int largeValue = 1234567890123456;  // 一个大整数
short smallValue = largeValue;  // Clang-Tidy 会警告：窄整形转换，数据会丢失

在上述代码中，largeValue 是一个 int 类型的大整数，而 smallValue 是 short 类型。int 和 short 类型的范围差异可能导致数据丢失，因此 Clang-Tidy 会发出警告。

如何配置 clang-tidy 规则来忽略某些转换？

有时，开发者知道某些类型转换在特定的场景下是安全的，或者转换本身不会导致问题。这时，我们可以通过配置 .clang-tidy 文件来忽略某些窄整形转换警告。具体来说，我们可以通过配置 cppcoreguidelines-narrowing-conversions.IgnoreConversionFromTypes 来忽略来自特定类型的转换。

配置 IgnoreConversionFromTypes

我们可以通过以下配置来忽略某些类型的窄整形转换警告：

{ key: cppcoreguidelines-narrowing-conversions.IgnoreConversionFromTypes, value: size_t;ptrdiff_t;size_type;difference_type }

在这个配置中，我们指示 Clang-Tidy 忽略来自 size_t、ptrdiff_t、size_type 和 difference_type 类型的窄整形转换警告。

为什么要忽略这些类型的转换？

这些类型在 64 位系统中通常是 8 字节类型（例如，size_t 和 ptrdiff_t），它们可以表示很大的数值，通常在转换为较小范围的类型时不会导致溢出。因此，开发者可能认为在这些类型之间的转换是安全的。
• size_t 和 ptrdiff_t：这些类型通常用于表示内存大小和指针差值，转换时需要考虑目标类型的范围，但在 64 位系统中，它们是 8 字节类型，因此转换为 int 之类的 4 字节类型可能会发生溢出。
• size_type 和 difference_type：这些类型常用于 STL 容器，它们通常与 size_t 和 ptrdiff_t 类型一致，因此转换时的风险类似。

实际示例：为什么你的代码没有触发警告？

假设你的代码没有触发警告，原因可能是你的项目配置了忽略某些类型的窄整形转换。

size_t largeValue = 1234567890123456;
int smallValue = largeValue;  // 在 Clang-Tidy 忽略 size_t 转换的配置下，不会发出警告

在这个例子中，size_t 是 8 字节类型，转换为 int 时可能会丢失数据，但由于 size_t 类型的转换被忽略，Clang-Tidy 不会报告警告。

例子 2：

ptrdiff_t ptrDiff = 1000000000;
short smallDiff = ptrDiff;  // 可能触发警告，因为 ptrdiff_t 是 8 字节，short 是 2 字节

在这个例子中，ptrdiff_t 是 8 字节，而 short 是 2 字节，转换可能会导致数据丢失。如果 ptrdiff_t 转换被忽略，则 Clang-Tidy 不会警告。

例子 3：

size_type size = 100;
int index = size;  // 如果忽略了 size_type 转换，Clang-Tidy 不会警告

在这个例子中，size_type 是 size_t 的别名，通常是 8 字节。如果配置文件忽略了 size_type 的转换，则 Clang-Tidy 不会警告即使数据超出了 int 的范围。

如何强制 Clang-Tidy 报告所有窄整形转换？

如果你希望 Clang-Tidy 强制报告所有窄整形转换，可以通过配置文件删除或禁用忽略选项：

Checks: 'cppcoreguidelines-narrowing-conversions'
WarningsAsErrors: '*'

此配置会确保所有的窄整形转换都会触发警告，并且这些警告将被视为错误。

总结

在本篇博客中，我们探讨了如何使用 Clang-Tidy 来检测和处理窄整形转换的警告。我们解释了如何通过配置 cppcoreguidelines-narrowing-conversions 来忽略某些类型之间的转换，确保开发过程中不遗漏潜在的类型问题。如果你希望避免潜在的类型溢出问题，可以根据实际情况调整这些配置，从而增强代码的安全性和稳定性。

通过合理的配置，你不仅可以让 Clang-Tidy 更好地适应你的项目需求，还可以理解为什么某些代码不会触发警告。如果你有更复杂的转换需求，建议继续深入研究和配置 Clang-Tidy，确保代码质量。