-
Notifications
You must be signed in to change notification settings - Fork 0
/
pkgdb_to_bzl.py
328 lines (291 loc) · 11.4 KB
/
pkgdb_to_bzl.py
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
#!/usr/bin/env python3
#
# Convert a package database to a .bzl file loadable from a BUILD
# description.
#
# Arguments:;
# REPO_NAME: the name of the external repository in which the database is stored.
# TOP_DIR: The path to GHC's $topdir, i.e. the lib/ folder of any installation.
from __future__ import unicode_literals
import glob
import os
import sys
import textwrap
import types
import json
#import package_configuration
#!/usr/bin/env python3
import collections
import types
def unfold_fields(lines):
"""Unfold fields that were split over multiple lines.
Returns:
A list of strings. Each string represents one field (a name/value pair
separated by a colon).
>>> unfold_fields("foo \n bar \n baz \nbiz \nboz ")
['foo bar baz ', 'biz ', 'boz ']
"""
fields = []
for line in lines:
if line.startswith(" "):
fields[-1] += line
elif line.strip():
fields.append(line)
return fields
PackageConfiguration = collections.namedtuple("PackageConfiguration", [
"name",
"version",
"id",
"include_dirs",
"library_dirs",
"dynamic_library_dirs",
"hs_libraries",
"depends",
"ld_options",
"extra_libraries",
"haddock_interfaces",
"haddock_html",
])
def parse_package_configuration(lines):
"""Parses a single package configuration.
Returns:
An instance of `PackageConfiguration`.
"""
pkg = types.SimpleNamespace(
include_dirs = [],
library_dirs = [],
dynamic_library_dirs = [],
depends = [],
hs_libraries = [],
ld_options = [],
extra_libraries = [],
haddock_interfaces = [],
haddock_html = None,
)
for field in unfold_fields(lines):
key, value = field.split(":", 1)
value = value.strip()
if key == "name":
pkg.name = value
elif key == "version":
pkg.version = value
elif key == "id":
pkg.id = value
elif key == "include-dirs":
pkg.include_dirs += value.split()
elif key == "library-dirs":
pkg.library_dirs += value.split()
elif key == "dynamic-library-dirs":
pkg.dynamic_library_dirs += value.split()
elif key == "hs-libraries":
pkg.hs_libraries += value.split()
elif key == "depends":
pkg.depends += value.split()
elif key == "ld-options":
pkg.ld_options += [opt.strip('"') for opt in value.split()]
elif key == "extra-libraries":
pkg.extra_libraries += value.split()
elif key == "haddock-interfaces":
pkg.haddock_interfaces += value.split()
elif key == "haddock-html":
pkg.haddock_html = value
return PackageConfiguration(**pkg.__dict__)
def split_records(lines):
"""Iterator over lists of lines separated by `---`.
Skips empty records.
"""
separator = "---"
record = []
for line in lines:
if line.rstrip() == separator:
yield record
record = []
else:
record.append(line)
if record:
yield record
def parse_package_database_dump(lines):
"""Parse the output of ghc-pkg dump.
Assumes that records are separated by `---`.
Returns:
Iterable of `PackageConfiguration`.
"""
return (
parse_package_configuration(record)
for record in split_records(lines)
)
if len(sys.argv) == 3:
repo_dir = "external/" + sys.argv[1]
topdir = sys.argv[2]
else:
sys.exit("Usage: pkgdb_to_bzl.py <REPO_NAME> <TOPDIR>")
def path_to_label(path, pkgroot):
"""Substitute one pkgroot for another relative one to obtain a label."""
if path.find("${pkgroot}") != -1:
return os.path.normpath(path.strip("\"").replace("${pkgroot}", topdir)).replace('\\', '/')
topdir_relative_path = path.replace(pkgroot, "$topdir")
if topdir_relative_path.find("$topdir") != -1:
return os.path.normpath(topdir_relative_path.replace("$topdir", topdir)).replace('\\', '/')
def hs_library_pattern(name, mode = "static", profiling = False):
"""Convert hs-libraries entry to glob patterns.
Args:
name: The library name. E.g. HSrts or Cffi.
mode: The linking mode. Either "static" or "dynamic".
profiling: Look for profiling mode libraries.
Returns:
List of globbing patterns for the library file.
"""
# The RTS configuration suffix.
# See https://gitlab.haskell.org/ghc/ghc/wikis/commentary/rts/config#rts-configurations
configs = ["_p"] if profiling else [""]
# Special case HSrts or Cffi - include both libXYZ and libXYZ_thr.
if name == "HSrts" or name == "Cffi":
configs = [
prefix + config
for config in configs
for prefix in ["", "_thr"]
]
# Special case libCffi - dynamic lib has no configs and is called libffi.
if name == "Cffi" and mode == "dynamic":
libname = "ffi"
configs = [""]
else:
libname = name
libnames = [libname + config for config in configs]
# Special case libCffi - dynamic lib has no version suffix.
if mode == "dynamic" and name != "Cffi":
libnames = [libname + "-ghc*" for libname in libnames]
if mode == "dynamic":
exts = ["so", "so.*", "dylib", "dll"]
else:
exts = ["a"]
return [
"lib{}.{}".format(libname, ext)
for libname in libnames
for ext in exts
]
output = []
# Accumulate package id to package name mappings.
pkg_id_map = []
for conf in sorted(glob.glob(os.path.join(topdir, "package.conf.d", "*.conf"))):
with open(conf, 'r') as f:
pkg = parse_package_configuration(f)
# pkgroot is not part of .conf files. It's a computed value. It is
# defined to be the directory enclosing the package database
# directory.
pkgroot = os.path.dirname(os.path.dirname(os.path.realpath(conf)))
pkg_id_map.append((pkg.name, pkg.id))
# Haddock handling
# Haddock files may be packaged inside your ghc distribution (as
# it is the case for ghc_bindist) or elsewhere if you pull GHC
# from something such as nixpkgs which split ghc from its
# documentation
# For each path in haddock_html and haddock_interfaces, we will
# first try to convert it to a path in the current WORKSPACE. if
# this does not work, we generate a path in the workspace and
# output a SYMLINK information for the parent process
# first, try to get a path within the package
# We check if the file exists because cabal will unconditionally
# generate the database entry even if no haddock was generated.
haddock_html = None
if pkg.haddock_html:
haddock_html = path_to_label(pkg.haddock_html, pkgroot)
if not haddock_html:
haddock_html = os.path.join("haddock", "html", pkg.name)
output.append("#SYMLINK: {} {}".format(pkg.haddock_html, haddock_html))
# If there is many interfaces, we give them a number
interface_id = 0
haddock_interfaces = []
for interface_path in pkg.haddock_interfaces:
interface = path_to_label(interface_path, pkgroot)
if not interface:
interface = os.path.join(
"haddock",
"interfaces",
pkg.name + "_" + str(interface_id) + ".haddock",
)
output.append("#SYMLINK: {} {}".format(interface_path, interface))
interface_id += 1
haddock_interfaces.append(interface)
output += [
# We substitute globs instead of actual paths because the
# libraries could be anywhere in the various library dirs, in
# static or shared form, or neither.
textwrap.dedent("""\
haskell_import(
name = "{name}",
id = "{id}",
deps = {deps},
hdrs = {hdrs},
includes = {includes},
linkopts = {linkopts},
shared_libraries = {shared_libraries},
static_libraries = {static_libraries},
static_profiling_libraries = {static_profiling_libraries},
version = "{version}",
visibility = ["//visibility:public"],
haddock_interfaces = {haddock_interfaces},
haddock_html = {haddock_html},
)
""".format(
name = pkg.name,
id = pkg.id,
version = pkg.version,
hdrs = "glob({}, allow_empty = True)".format([
path_to_label("{}/**/*.h".format(include_dir), pkgroot)
for include_dir in pkg.include_dirs
if path_to_label(include_dir, pkgroot)
]),
includes = [
"/".join([repo_dir, path_to_label(include_dir, pkgroot)])
for include_dir in pkg.include_dirs
if path_to_label(include_dir, pkgroot)
],
static_libraries = "glob({}, allow_empty = True)".format([
path_to_label("{}/{}".format(library_dir, pattern), pkgroot)
for hs_library in pkg.hs_libraries
for pattern in hs_library_pattern(hs_library, mode = "static", profiling = False)
for library_dir in pkg.library_dirs
if path_to_label(library_dir, pkgroot)
]),
static_profiling_libraries = "glob({}, allow_empty = True)".format([
path_to_label("{}/{}".format(library_dir, pattern), pkgroot)
for hs_library in pkg.hs_libraries
for pattern in hs_library_pattern(hs_library, mode = "static", profiling = True)
for library_dir in pkg.library_dirs
if path_to_label(library_dir, pkgroot)
]),
shared_libraries = "glob({}, allow_empty = True)".format([
path_to_label("{}/{}".format(dynamic_library_dir, pattern), pkgroot)
for hs_library in pkg.hs_libraries
for pattern in hs_library_pattern(hs_library, mode = "dynamic", profiling = False)
for dynamic_library_dir in pkg.dynamic_library_dirs + pkg.library_dirs
if path_to_label(dynamic_library_dir, pkgroot)
]),
haddock_html = repr(haddock_html),
haddock_interfaces = repr(haddock_interfaces),
deps = pkg.depends,
linkopts = pkg.ld_options + [
"-L{}".format(library_dir)
for library_dir in pkg.dynamic_library_dirs + pkg.library_dirs
if not path_to_label(library_dir, pkgroot)
] + [
"-l{}".format(extra_library)
for extra_library in pkg.extra_libraries
],
)
)
]
pkg_id_map.sort()
for pkg_name, pkg_id in pkg_id_map:
if pkg_id != pkg_name:
output += ["""alias(name = '{}', actual = '{}')""".format(pkg_id, pkg_name)]
# The _ahc_impl function recovers this toolchain_libraries variable and assumes it is defined on a single line.
toolchain_libraries = textwrap.dedent("{pkgs}".format(pkgs = [pkg_name for pkg_name, _ in pkg_id_map])
)
output.append("toolchain_libraries = {}".format(toolchain_libraries))
result = {
"file_content": "\n".join(output),
"toolchain_libraries": toolchain_libraries,
}
print(json.dumps(result))