blob: 81450802c86d66c693eaecdb9536fd53da6d583e [file] [log] [blame]
//===--- MacroUsageCheck.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 "../ClangTidyCheck.h"
#include "clang/Lex/MacroInfo.h"
#include <string>
namespace clang {
class MacroDirective;
namespace tidy {
namespace cppcoreguidelines {
/// Find macro usage that is considered problematic because better language
/// constructs exist for the task.
/// For the user-facing documentation see:
class MacroUsageCheck : public ClangTidyCheck {
MacroUsageCheck(StringRef Name, ClangTidyContext *Context)
: ClangTidyCheck(Name, Context),
AllowedRegexp(Options.get("AllowedRegexp", "^DEBUG_*")),
CheckCapsOnly(Options.get("CheckCapsOnly", false)),
IgnoreCommandLineMacros(Options.get("IgnoreCommandLineMacros", true)) {}
bool isLanguageVersionSupported(const LangOptions &LangOpts) const override {
return LangOpts.CPlusPlus11;
void storeOptions(ClangTidyOptions::OptionMap &Opts) override;
void registerPPCallbacks(const SourceManager &SM, Preprocessor *PP,
Preprocessor *ModuleExpanderPP) override;
void warnMacro(const MacroDirective *MD, StringRef MacroName);
void warnNaming(const MacroDirective *MD, StringRef MacroName);
/// A regular expression that defines how allowed macros must look like.
std::string AllowedRegexp;
/// Control if only the check shall only test on CAPS_ONLY macros.
bool CheckCapsOnly;
/// Should the macros without a valid location be diagnosed?
bool IgnoreCommandLineMacros;
} // namespace cppcoreguidelines
} // namespace tidy
} // namespace clang