Commit ebdb98f2 authored by Paula Toth's avatar Paula Toth
Browse files

[clang-tidy] Move fuchsia-restrict-system-includes to portability module for general use. 

Summary:
Created a general check for restrict-system-includes under portability as recommend in the comments under D75332. I also fleshed out the user facing documentation to show examples for common use-cases such as allow-list, block-list, and wild carding.

Removed fuchsia's check as per phosek sugguestion.

Reviewers: aaron.ballman, phosek, alexfh, hokein, njames93

Reviewed By: phosek

Subscribers: Eugene.Zelenko, mgorny, xazax.hun, phosek, cfe-commits, MaskRay

Tags: #clang-tools-extra, #clang

Differential Revision: https://reviews.llvm.org/D75786
parent 5b0c60c5

clang-tools-extra/clang-tidy/fuchsia/CMakeLists.txt

+0 −1
Original line number Diff line number Diff line
@@ -6,7 +6,6 @@ add_clang_library(clangTidyFuchsiaModule 
  FuchsiaTidyModule.cpp

  MultipleInheritanceCheck.cpp

  OverloadedOperatorCheck.cpp

  RestrictSystemIncludesCheck.cpp

  StaticallyConstructedObjectsCheck.cpp

  TrailingReturnCheck.cpp

  VirtualInheritanceCheck.cpp

clang-tools-extra/clang-tidy/fuchsia/FuchsiaTidyModule.cpp

+0 −3
Original line number Diff line number Diff line
@@ -14,7 +14,6 @@ 
#include "DefaultArgumentsDeclarationsCheck.h"

#include "MultipleInheritanceCheck.h"

#include "OverloadedOperatorCheck.h"

#include "RestrictSystemIncludesCheck.h"

#include "StaticallyConstructedObjectsCheck.h"

#include "TrailingReturnCheck.h"

#include "VirtualInheritanceCheck.h"
@@ -39,8 +38,6 @@ public: 
        "fuchsia-multiple-inheritance");

    CheckFactories.registerCheck<OverloadedOperatorCheck>(

        "fuchsia-overloaded-operator");

    CheckFactories.registerCheck<RestrictSystemIncludesCheck>(

        "fuchsia-restrict-system-includes");

    CheckFactories.registerCheck<StaticallyConstructedObjectsCheck>(

        "fuchsia-statically-constructed-objects");

    CheckFactories.registerCheck<TrailingReturnCheck>(

clang-tools-extra/clang-tidy/portability/CMakeLists.txt

+1 −0
Original line number Diff line number Diff line
@@ -2,6 +2,7 @@ set(LLVM_LINK_COMPONENTS support) 


add_clang_library(clangTidyPortabilityModule

  PortabilityTidyModule.cpp

  RestrictSystemIncludesCheck.cpp

  SIMDIntrinsicsCheck.cpp



  LINK_LIBS

clang-tools-extra/clang-tidy/portability/PortabilityTidyModule.cpp

+3 −0
Original line number Diff line number Diff line
@@ -9,6 +9,7 @@ 
#include "../ClangTidy.h"

#include "../ClangTidyModule.h"

#include "../ClangTidyModuleRegistry.h"

#include "RestrictSystemIncludesCheck.h"

#include "SIMDIntrinsicsCheck.h"



namespace clang {
@@ -18,6 +19,8 @@ namespace portability { 
class PortabilityModule : public ClangTidyModule {

public:

  void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override {

    CheckFactories.registerCheck<RestrictSystemIncludesCheck>(

        "portability-restrict-system-includes");

    CheckFactories.registerCheck<SIMDIntrinsicsCheck>(

        "portability-simd-intrinsics");

  }

clang-tools-extra/clang-tidy/fuchsia/RestrictSystemIncludesCheck.cpp→clang-tools-extra/clang-tidy/portability/RestrictSystemIncludesCheck.cpp

+3 −3
Original line number Diff line number Diff line 
//===--- RestrictSystemIncludesCheck.cpp - clang-tidy----------------------===//

//===--- RestrictSystemIncludesCheck.cpp - clang-tidy ---------------------===//

//

// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.

// See https://llvm.org/LICENSE.txt for license information.
@@ -18,7 +18,7 @@ 


namespace clang {

namespace tidy {

namespace fuchsia {

namespace portability {



class RestrictedIncludesPPCallbacks : public PPCallbacks {

public:
@@ -111,6 +111,6 @@ void RestrictSystemIncludesCheck::storeOptions( 
  Options.store(Opts, "Includes", AllowedIncludes);

}



} // namespace fuchsia

} // namespace portability

} // namespace tidy

} // namespace clang