.clang-tidy

# All disabled checks have to come with an explanatory comment that states why they were disabled!
#
# bugprone-easily-swappable-parameters:
#  Not always easily fixable, modern IDEs with parameter chips/hints help avoid this problem
#
# modernize-use-trailing-return-type:
#  Purely stylistic, makes function signature longer
#
# readability-identifier-length:
#  Things like std::ostream os; nlohmann::json j; are popular. Reviewer can decide on those cases
#
# readability-implicit-bool-conversion:
#  Makes packet-parsing (bool field that occupies a byte or bitfield) annoying
#
# hicpp-special-member-functions:
#  Alias for cppcoreguidelines-special-member-functions, which is enabled. If both are enabled,
#  the CheckOptions below have to be specified twice.
#
# hicpp-braces-around-statements:
#  Alias for readability-braces-around-statements, which is enabled. If both are enabled,
#  the CheckOptions below have to be specified twice.
#
# hicpp-signed-bitwise:
#  This rule is buggy and flags bitwise operators on bools.
Checks: "
  *,
  -abseil-*,
  -altera-*,
  -android-*,
  -darwin-*,
  -fuchsia-*,
  -linuxkernel-*,
  -llvmlibc-*,
  -mpi-*,
  -objc-*,
  -zircon-*,
  -bugprone-easily-swappable-parameters,
  -modernize-use-trailing-return-type,
  -readability-identifier-length,
  -readability-implicit-bool-conversion,
  -hicpp-special-member-functions,
  -hicpp-braces-around-statements,
  -hicpp-signed-bitwise"

# WarningsAsErrors have been taken from:
# https://github.com/autowarefoundation/autoware/blob/3591106/.clang-tidy-ci
WarningsAsErrors: "
  bugprone-dangling-handle,
  bugprone-fold-init-type,
  bugprone-inaccurate-erase,
  bugprone-incorrect-roundings,
  bugprone-misplaced-widening-cast,
  bugprone-sizeof-container,
  bugprone-sizeof-expression,
  bugprone-string-constructor,
  bugprone-suspicious-enum-usage,
  bugprone-suspicious-memset-usage,
  bugprone-suspicious-missing-comma,
  bugprone-suspicious-semicolon,
  bugprone-swapped-arguments,
  bugprone-unchecked-optional-access,
  bugprone-unused-raii,
  bugprone-use-after-move,
  bugprone-assert-side-effect,
  bugprone-bad-signal-to-kill-thread,
  bugprone-copy-constructor-init,
  bugprone-dynamic-static-initializers,
  bugprone-exception-escape,
  bugprone-integer-division,
  bugprone-macro-parentheses,
  bugprone-macro-repeated-side-effects,
  bugprone-misplaced-operator-in-strlen-in-alloc,
  bugprone-move-forwarding-reference,
  bugprone-multiple-statement-macro,
  bugprone-not-null-terminated-result,
  bugprone-parent-virtual-call,
  bugprone-posix-return,
  bugprone-signed-char-misuse,
  bugprone-string-literal-with-embedded-nul,
  bugprone-suspicious-string-compare,
  bugprone-terminating-continue,
  bugprone-throw-keyword-missing,
  bugprone-too-small-loop-variable,
  bugprone-undefined-memory-manipulation,
  bugprone-undelegated-constructor,
  bugprone-unhandled-self-assignment,
  bugprone-unused-return-value,
  bugprone-virtual-near-miss,
  cppcoreguidelines-slicing,
  cppcoreguidelines-special-member-functions,
  cppcoreguidelines-pro-bounds-constant-array-index,
  cppcoreguidelines-virtual-class-destructor,
  cppcoreguidelines-init-variables,
  cppcoreguidelines-narrowing-conversions,
  google-build-explicit-make-pair,
  google-build-namespaces,
  google-explicit-constructor,
  misc-non-copyable-objects,
  misc-throw-by-value-catch-by-reference,
  misc-definitions-in-headers,
  misc-new-delete-overloads,
  misc-redundant-expression,
  misc-unconventional-assign-operator,
  misc-uniqueptr-reset-release,
  performance-inefficient-algorithm,
  performance-move-const-arg,
  performance-move-constructor-init,
  performance-noexcept-move-constructor,
  readability-simplify-boolean-expr"

HeaderFilterRegex: ^(?!\/usr)(?!\/opt)

FormatStyle: file

CheckOptions:
  - key: readability-identifier-naming.NamespaceCase
    value: lower_case
  - key: readability-identifier-naming.ClassCase
    value: CamelCase
  - key: readability-identifier-naming.PrivateMemberSuffix
    value: _
  - key: readability-identifier-naming.StructCase
    value: CamelCase
  - key: readability-identifier-naming.FunctionCase
    value: lower_case
  - key: readability-identifier-naming.VariableCase
    value: lower_case
  - key: readability-identifier-naming.GlobalConstantCase
    value: lower_case
  - key: readability-identifier-naming.GlobalConstantPrefix
    value: g_
  - key: readability-identifier-naming.ConstexprVariableCase
    value: lower_case
  - key: cppcoreguidelines-special-member-functions.AllowSoleDefaultDtor
    value: true
    # Structs (e.g. sensor config) with functions like to_json() would otherwise be flagged as warnings
  - key: misc-non-private-member-variables-in-classes.IgnoreClassesWithAllMemberVariablesBeingPublic
    value: true
    # Reduce boilerplate for things like guard clauses
  - key: readability-braces-around-statements.ShortStatementLines
    value: 2 # The definition is confusing, but everything >= 2 is flagged as a warning
    # Macros like RCLCPP_INFO contribute large amounts to cognitive complexity, even if the
    # containing function is simple.
  - key: readability-function-cognitive-complexity.IgnoreMacros
    value: true