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
|
# Copyright 2015 MongoDB Inc.
#
# 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.
import json
import SCons
import itertools
# Implements the ability for SCons to emit a compilation database for the MongoDB project. See
# http://clang.llvm.org/docs/JSONCompilationDatabase.html for details on what a compilation
# database is, and why you might want one. The only user visible entry point here is
# 'env.CompilationDatabase'. This method takes an optional 'target' to name the file that
# should hold the compilation database, otherwise, the file defaults to compile_commands.json,
# which is the name that most clang tools search for by default.
# TODO: Is there a better way to do this than this global? Right now this exists so that the
# emitter we add can record all of the things it emits, so that the scanner for the top level
# compilation database can access the complete list, and also so that the writer has easy
# access to write all of the files. But it seems clunky. How can the emitter and the scanner
# communicate more gracefully?
__COMPILATION_DB_ENTRIES=[]
# We make no effort to avoid rebuilding the entries. Someday, perhaps we could and even
# integrate with the cache, but there doesn't seem to be much call for it.
class __CompilationDbNode(SCons.Node.Node):
def __init__(self):
SCons.Node.Node.__init__(self)
self.Decider(changed_since_last_build_node)
def changed_since_last_build_node(node, target, prev_ni):
return True
def makeEmitCompilationDbEntry(comstr):
user_action = SCons.Action.Action(comstr)
def EmitCompilationDbEntry(target, source, env):
dbtarget = __CompilationDbNode()
entry = env.__COMPILATIONDB_Entry(
target=dbtarget,
source=[],
__COMPILATIONDB_UTARGET=target,
__COMPILATIONDB_USOURCE=source,
__COMPILATIONDB_UACTION=user_action,
__COMPILATIONDB_ENV=env)
# TODO: Technically, these next two lines should not be required: it should be fine to
# cache the entries. However, they don't seem to update properly. Since they are quick
# to re-generate disable caching and sidestep this problem.
env.AlwaysBuild(entry)
env.NoCache(entry)
__COMPILATION_DB_ENTRIES.append(dbtarget)
return target, source
return EmitCompilationDbEntry
def CompilationDbEntryAction(target, source, env, **kw):
command = env['__COMPILATIONDB_UACTION'].strfunction(
target=env['__COMPILATIONDB_UTARGET'],
source=env['__COMPILATIONDB_USOURCE'],
env=env['__COMPILATIONDB_ENV'],)
entry = {
"directory": env.Dir('#').abspath,
"command": command,
"file": str(env['__COMPILATIONDB_USOURCE'][0])
}
setattr(target[0], '__COMPILATION_DB_ENTRY', entry)
def WriteCompilationDb(target, source, env):
entries = []
for s in __COMPILATION_DB_ENTRIES:
entries.append(getattr(s, '__COMPILATION_DB_ENTRY'))
with open(str(target[0]), 'w') as target_file:
json.dump(entries, target_file,
sort_keys=True,
indent=4,
separators=(',', ': '))
def ScanCompilationDb(node, env, path):
return __COMPILATION_DB_ENTRIES
def generate(env, **kwargs):
static_obj, shared_obj = SCons.Tool.createObjBuilders(env)
# TODO: Is there a way to obtain the configured suffixes for C and C++
# from the existing obj builders? Seems unfortunate to re-iterate them.
CSuffixes = ['.c']
CXXSuffixes = ['.cc', '.cxx', '.cpp']
env['COMPILATIONDB_COMSTR'] = kwargs.get(
'COMPILATIONDB_COMSTR', 'Building compilation database $TARGET')
components_by_suffix = itertools.chain(
itertools.product(CSuffixes, [
(static_obj, SCons.Defaults.StaticObjectEmitter, '$CCCOM'),
(shared_obj, SCons.Defaults.SharedObjectEmitter, '$SHCCCOM'),
]),
itertools.product(CXXSuffixes, [
(static_obj, SCons.Defaults.StaticObjectEmitter, '$CXXCOM'),
(shared_obj, SCons.Defaults.SharedObjectEmitter, '$SHCXXCOM'),
]),
)
for entry in components_by_suffix:
suffix = entry[0]
builder, base_emitter, command = entry[1]
builder.add_emitter(
suffix, SCons.Builder.ListEmitter(
[
makeEmitCompilationDbEntry(command),
base_emitter,
]
))
env['BUILDERS']['__COMPILATIONDB_Entry'] = SCons.Builder.Builder(
action=SCons.Action.Action(CompilationDbEntryAction, None),
)
env['BUILDERS']['__COMPILATIONDB_Database'] = SCons.Builder.Builder(
action=SCons.Action.Action(WriteCompilationDb, "$COMPILATIONDB_COMSTR"),
target_scanner=SCons.Scanner.Scanner(
function=ScanCompilationDb,
node_class=None)
)
def CompilationDatabase(env, target):
result = env.__COMPILATIONDB_Database(
target=target,
source=[])
env.AlwaysBuild(result)
env.NoCache(result)
return result
env.AddMethod(CompilationDatabase, 'CompilationDatabase')
def exists(env):
return True
|
