TheRock/compiler/amd-llvm/clang-tools-extra/clang-tidy/readability/IdentifierLengthCheck.h

//===----------------------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_IDENTIFIERLENGTHCHECK_H
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_IDENTIFIERLENGTHCHECK_H

#include "../ClangTidyCheck.h"
#include "llvm/Support/Regex.h"

namespace clang::tidy::readability {

/// Warns about identifiers names whose length is too short.
///
/// For the user-facing documentation see:
/// https://clang.llvm.org/extra/clang-tidy/checks/readability/identifier-length.html
class IdentifierLengthCheck : public ClangTidyCheck {
public:
  IdentifierLengthCheck(StringRef Name, ClangTidyContext *Context);
  void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
  void registerMatchers(ast_matchers::MatchFinder *Finder) override;
  void check(const ast_matchers::MatchFinder::MatchResult &Result) override;

private:
  const unsigned MinimumVariableNameLength;
  const unsigned MinimumBindingNameLength;
  const unsigned MinimumLoopCounterNameLength;
  const unsigned MinimumExceptionNameLength;
  const unsigned MinimumParameterNameLength;

  StringRef IgnoredVariableNamesInput;
  llvm::Regex IgnoredVariableNames;

  StringRef IgnoredBindingNamesInput;
  llvm::Regex IgnoredBindingNames;

  StringRef IgnoredLoopCounterNamesInput;
  llvm::Regex IgnoredLoopCounterNames;

  StringRef IgnoredExceptionVariableNamesInput;
  llvm::Regex IgnoredExceptionVariableNames;

  StringRef IgnoredParameterNamesInput;
  llvm::Regex IgnoredParameterNames;

  const unsigned LineCountThreshold;
};

} // namespace clang::tidy::readability

#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_READABILITY_IDENTIFIERLENGTHCHECK_H