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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
// Copyright 2019 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
package main
import (
"encoding/json"
"fmt"
"io/ioutil"
"os"
"path/filepath"
"strings"
)
type useTidyMode int
const (
tidyModeNone useTidyMode = iota
tidyModeAll
tidyModeTricium
)
func processClangTidyFlags(builder *commandBuilder) (cSrcFile string, mode useTidyMode) {
withTidy, _ := builder.env.getenv("WITH_TIDY")
if withTidy == "" {
return "", tidyModeNone
}
srcFileSuffixes := []string{
".c",
".cc",
".cpp",
".C",
".cxx",
".c++",
}
cSrcFile = ""
srcSuffix := ""
lastArg := ""
for _, arg := range builder.args {
if lastArg != "-o" {
for _, suffix := range srcFileSuffixes {
if strings.HasSuffix(arg.value, suffix) {
srcSuffix = suffix
cSrcFile = arg.value
break
}
}
}
lastArg = arg.value
}
if cSrcFile == "" {
return "", tidyModeNone
}
if withTidy == "tricium" {
// Files generated from protobufs can result in _many_ clang-tidy complaints, and aren't
// worth linting in general. Don't.
if strings.HasSuffix(cSrcFile, ".pb"+srcSuffix) {
mode = tidyModeNone
} else {
mode = tidyModeTricium
}
} else {
mode = tidyModeAll
}
return cSrcFile, mode
}
func calcClangTidyInvocation(env env, clangCmd *command, cSrcFile string, tidyFlags ...string) (*command, error) {
resourceDir, err := getClangResourceDir(env, clangCmd.Path)
if err != nil {
return nil, err
}
clangTidyPath := filepath.Join(filepath.Dir(clangCmd.Path), "clang-tidy")
args := append([]string{}, tidyFlags...)
args = append(args, cSrcFile, "--", "-resource-dir="+resourceDir)
args = append(args, clangCmd.Args...)
return &command{
Path: clangTidyPath,
Args: args,
EnvUpdates: clangCmd.EnvUpdates,
}, nil
}
func runClangTidyForTricium(env env, clangCmd *command, cSrcFile, fixesDir string) error {
if err := os.MkdirAll(fixesDir, 0777); err != nil {
return fmt.Errorf("creating fixes directory at %q: %v", fixesDir, err)
}
f, err := ioutil.TempFile(fixesDir, "lints-")
if err != nil {
return fmt.Errorf("making tempfile for tidy: %v", err)
}
f.Close()
// `f` is an 'anchor'; it ensures we won't create a similarly-named file in the future.
// Hence, we can't delete it.
fixesFilePath := f.Name() + ".yaml"
fixesMetadataPath := f.Name() + ".json"
// FIXME(gbiv): Remove `-checks=*` when testing is complete; we should defer to .clang-tidy
// files, which are both more expressive and more approachable than `-checks=*`.
clangTidyCmd, err := calcClangTidyInvocation(env, clangCmd, cSrcFile, "-checks=*", "--export-fixes="+fixesFilePath)
if err != nil {
return fmt.Errorf("calculating tidy invocation: %v", err)
}
stdstreams := &strings.Builder{}
// Note: We pass nil as stdin as we checked before that the compiler
// was invoked with a source file argument.
exitCode, err := wrapSubprocessErrorWithSourceLoc(clangTidyCmd,
env.run(clangTidyCmd, nil, stdstreams, stdstreams))
if err != nil {
return err
}
type metadata struct {
Args []string `json:"args"`
Executable string `json:"executable"`
ExitCode int `json:"exit_code"`
LintTarget string `json:"lint_target"`
Stdstreams string `json:"stdstreams"`
Wd string `json:"wd"`
}
f, err = os.Create(fixesMetadataPath)
if err != nil {
return fmt.Errorf("creating fixes metadata: %v", err)
}
meta := &metadata{
Args: clangTidyCmd.Args,
Executable: clangTidyCmd.Path,
ExitCode: exitCode,
LintTarget: cSrcFile,
Stdstreams: stdstreams.String(),
Wd: env.getwd(),
}
if err := json.NewEncoder(f).Encode(meta); err != nil {
return fmt.Errorf("writing fixes metadata: %v", err)
}
if err := f.Close(); err != nil {
return fmt.Errorf("finalizing fixes metadata: %v", err)
}
return nil
}
func runClangTidy(env env, clangCmd *command, cSrcFile string) error {
clangTidyCmd, err := calcClangTidyInvocation(env, clangCmd, cSrcFile, "-checks="+
strings.Join([]string{
"*",
"-bugprone-narrowing-conversions",
"-cppcoreguidelines-*",
"-fuchsia-*",
"-google-readability*",
"-google-runtime-references",
"-hicpp-*",
"-llvm-*",
"-misc-non-private-member-variables-in-classes",
"-misc-unused-parameters",
"-modernize-*",
"-readability-*",
}, ","))
if err != nil {
return fmt.Errorf("calculating clang-tidy invocation: %v", err)
}
// Note: We pass nil as stdin as we checked before that the compiler
// was invoked with a source file argument.
exitCode, err := wrapSubprocessErrorWithSourceLoc(clangTidyCmd,
env.run(clangTidyCmd, nil, env.stdout(), env.stderr()))
if err == nil && exitCode != 0 {
// Note: We continue on purpose when clang-tidy fails
// to maintain compatibility with the previous wrapper.
fmt.Fprint(env.stderr(), "clang-tidy failed")
}
return err
}
func hasAtLeastOneSuffix(s string, suffixes []string) bool {
for _, suffix := range suffixes {
if strings.HasSuffix(s, suffix) {
return true
}
}
return false
}
|
