blob: dc1206b5901b2b4e93b08210c4f78f3f05e814ed [file] [log] [blame]
//===--- ReservedIdentifierCheck.h - clang-tidy -----------------*- C++ -*-===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#include "../utils/RenamerClangTidyCheck.h"
#include "llvm/ADT/Optional.h"
#include <string>
#include <vector>
namespace clang {
namespace tidy {
namespace bugprone {
/// Checks for usages of identifiers reserved for use by the implementation.
/// The C and C++ standards both reserve the following names for such use:
/// * identifiers that begin with an underscore followed by an uppercase letter;
/// * identifiers in the global namespace that begin with an underscore.
/// The C standard additionally reserves names beginning with a double
/// underscore, while the C++ standard strengthens this to reserve names with a
/// double underscore occurring anywhere.
/// For the user-facing documentation see:
class ReservedIdentifierCheck final : public RenamerClangTidyCheck {
const bool Invert;
const std::vector<std::string> AllowedIdentifiers;
ReservedIdentifierCheck(StringRef Name, ClangTidyContext *Context);
void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
getDeclFailureInfo(const NamedDecl *Decl,
const SourceManager &SM) const override;
getMacroFailureInfo(const Token &MacroNameTok,
const SourceManager &SM) const override;
DiagInfo getDiagInfo(const NamingCheckId &ID,
const NamingCheckFailure &Failure) const override;
} // namespace bugprone
} // namespace tidy
} // namespace clang