lin
2025-07-31 065ea569db06206874bbfa18eb25ff6121aec09b
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
// Copyright 2016 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
package config
 
import (
   "android/soong/android"
   "strings"
)
 
func init() {
   // Most Android source files are not clang-tidy clean yet.
   // Global tidy checks include only google*, performance*,
   // and misc-macro-parentheses, but not google-readability*
   // or google-runtime-references.
   pctx.VariableFunc("TidyDefaultGlobalChecks", func(ctx android.PackageVarContext) string {
       if override := ctx.Config().Getenv("DEFAULT_GLOBAL_TIDY_CHECKS"); override != "" {
           return override
       }
       return strings.Join([]string{
           "-*",
           "clang-diagnostic-unused-command-line-argument",
           "google*",
           "misc-macro-parentheses",
           "performance*",
           "-google-readability*",
           "-google-runtime-references",
       }, ",")
   })
 
   // There are too many clang-tidy warnings in external and vendor projects.
   // Enable only some google checks for these projects.
   pctx.VariableFunc("TidyExternalVendorChecks", func(ctx android.PackageVarContext) string {
       if override := ctx.Config().Getenv("DEFAULT_EXTERNAL_VENDOR_TIDY_CHECKS"); override != "" {
           return override
       }
       return strings.Join([]string{
           "-*",
           "clang-diagnostic-unused-command-line-argument",
           "google*",
           "-google-build-using-namespace",
           "-google-default-arguments",
           "-google-explicit-constructor",
           "-google-readability*",
           "-google-runtime-int",
           "-google-runtime-references",
       }, ",")
   })
 
   // Give warnings to header files only in selected directories.
   // Do not give warnings to external or vendor header files, which contain too
   // many warnings.
   pctx.VariableFunc("TidyDefaultHeaderDirs", func(ctx android.PackageVarContext) string {
       if override := ctx.Config().Getenv("DEFAULT_TIDY_HEADER_DIRS"); override != "" {
           return override
       }
       return strings.Join([]string{
           "art/",
           "bionic/",
           "bootable/",
           "build/",
           "cts/",
           "dalvik/",
           "developers/",
           "development/",
           "frameworks/",
           "libcore/",
           "libnativehelper/",
           "system/",
       }, "|")
   })
 
   // Use WTIH_TIDY_FLAGS to pass extra global default clang-tidy flags.
   pctx.VariableFunc("TidyWithTidyFlags", func(ctx android.PackageVarContext) string {
       return ctx.Config().Getenv("WITH_TIDY_FLAGS")
   })
}
 
type PathBasedTidyCheck struct {
   PathPrefix string
   Checks     string
}
 
const tidyDefault = "${config.TidyDefaultGlobalChecks}"
const tidyExternalVendor = "${config.TidyExternalVendorChecks}"
 
// This is a map of local path prefixes to the set of default clang-tidy checks
// to be used.
// The last matched local_path_prefix should be the most specific to be used.
var DefaultLocalTidyChecks = []PathBasedTidyCheck{
   {"external/", tidyExternalVendor},
   {"external/google", tidyDefault},
   {"external/webrtc", tidyDefault},
   {"frameworks/compile/mclinker/", tidyExternalVendor},
   {"hardware/qcom", tidyExternalVendor},
   {"vendor/", tidyExternalVendor},
   {"vendor/google", tidyDefault},
   {"vendor/google_devices", tidyExternalVendor},
}
 
var reversedDefaultLocalTidyChecks = reverseTidyChecks(DefaultLocalTidyChecks)
 
func reverseTidyChecks(in []PathBasedTidyCheck) []PathBasedTidyCheck {
   ret := make([]PathBasedTidyCheck, len(in))
   for i, check := range in {
       ret[len(in)-i-1] = check
   }
   return ret
}
 
func TidyChecksForDir(dir string) string {
   for _, pathCheck := range reversedDefaultLocalTidyChecks {
       if strings.HasPrefix(dir, pathCheck.PathPrefix) {
           return pathCheck.Checks
       }
   }
   return tidyDefault
}