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
|
#!/usr/bin/env vpython3
# Copyright 2023 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Given a .build_config.json file, generates an Eclipse JDT project that can
be used with the "Language Support for Java™ by Red Hat" Visual Studio Code
extension. See //docs/vscode.md for details.
"""
import argparse
import logging
import json
import os
import sys
import xml.etree.ElementTree
sys.path.append(os.path.join(os.path.dirname(__file__), 'gyp'))
from util import build_utils
sys.path.append(os.path.join(os.path.dirname(__file__), os.pardir))
import gn_helpers
def _WithoutSuffix(string, suffix):
if not string.endswith(suffix):
raise ValueError(f'{string!r} does not end with {suffix!r}')
return string[:-len(suffix)]
def _GetJavaRoot(path):
# The authoritative way to determine the Java root for a given source file is
# to parse the source code and extract the package and class names, but let's
# keep things simple and use some heuristics to try to guess the Java root
# from the file path instead.
while True:
dirname, basename = os.path.split(path)
if not basename:
raise RuntimeError(f'Unable to determine the Java root for {path!r}')
if basename in ('java', 'src'):
return path
if basename in ('javax', 'org', 'com'):
return dirname
path = dirname
def _ProcessSourceFile(output_dir, source_file_path, source_dirs):
source_file_path = os.path.normpath(os.path.join(output_dir,
source_file_path))
java_root = _GetJavaRoot(source_file_path)
logging.debug('Extracted java root `%s` from source file path `%s`',
java_root, source_file_path)
source_dirs.add(java_root)
def _ProcessSourcesFile(output_dir, sources_file_path, source_dirs):
for source_file_path in build_utils.ReadSourcesList(
os.path.join(output_dir, sources_file_path)):
_ProcessSourceFile(output_dir, source_file_path, source_dirs)
def _ProcessBuildConfigFile(output_dir, build_config_path, source_dirs, libs,
already_processed_build_config_files,
android_sdk_build_tools_version):
if build_config_path in already_processed_build_config_files:
return
already_processed_build_config_files.add(build_config_path)
logging.info('Processing build config: %s', build_config_path)
params_json = build_config_path.replace('.build_config.json', '.params.json')
with open(os.path.join(output_dir, params_json)) as f:
build_config = json.load(f)
with open(os.path.join(output_dir, build_config_path)) as f:
build_config.update(json.load(f))
target_sources_file = build_config.get('target_sources_file')
if target_sources_file is not None:
_ProcessSourcesFile(output_dir, target_sources_file, source_dirs)
else:
unprocessed_jar_path = build_config.get('unprocessed_jar_path')
if unprocessed_jar_path is not None:
lib_path = os.path.normpath(os.path.join(output_dir,
unprocessed_jar_path))
logging.debug('Found lib `%s', lib_path)
libs.add(lib_path)
input_srcjars = os.path.join(output_dir,
_WithoutSuffix(build_config_path, '.build_config.json'),
'generated_java', 'input_srcjars')
if os.path.exists(input_srcjars):
source_dirs.add(input_srcjars)
android = build_config.get('android')
if android is not None:
# This works around an issue where the language server complains about
# `java.lang.invoke.LambdaMetafactory` not being found. The normal Android
# build process is fine with this class being missing because d8 removes
# references to LambdaMetafactory from the bytecode - see:
# https://jakewharton.com/androids-java-8-support/#native-lambdas
# When JDT builds the code, d8 doesn't run, so the references are still
# there. Fortunately, the Android SDK provides a convenience JAR to fill
# that gap in:
# //third_party/android_sdk/public/build-tools/*/core-lambda-stubs.jar
libs.add(
os.path.normpath(
os.path.join(
output_dir,
os.path.dirname(build_config['android']['sdk_jars'][0]),
os.pardir, os.pardir, 'build-tools',
android_sdk_build_tools_version, 'core-lambda-stubs.jar')))
for dep_config in build_config.get('deps_configs', []):
_ProcessBuildConfigFile(output_dir, dep_config, source_dirs, libs,
already_processed_build_config_files,
android_sdk_build_tools_version)
def _GenerateClasspathEntry(kind, path):
classpathentry = xml.etree.ElementTree.Element('classpathentry')
classpathentry.set('kind', kind)
classpathentry.set('path', path)
return classpathentry
def _GenerateProject(source_dirs, libs, output_dir):
classpath = xml.etree.ElementTree.Element('classpath')
for source_dir in sorted(source_dirs):
classpath.append(_GenerateClasspathEntry('src', source_dir))
for lib in sorted(libs):
classpath.append(_GenerateClasspathEntry('lib', lib))
classpath.append(
_GenerateClasspathEntry('output', os.path.join(output_dir, 'jdt_output')))
xml.etree.ElementTree.ElementTree(classpath).write(
'.classpath', encoding='unicode')
print('Generated .classpath', file=sys.stderr)
with open('.project', 'w') as f:
f.write("""<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>chromium</name>
<buildSpec>
<buildCommand>
<name>org.eclipse.jdt.core.javabuilder</name>
<arguments />
</buildCommand>
</buildSpec>
<natures><nature>org.eclipse.jdt.core.javanature</nature></natures>
</projectDescription>
""")
print('Generated .project', file=sys.stderr)
# Tell the Eclipse compiler not to use java.lang.invoke.StringConcatFactory
# in the generated bytecodes as the class is unavailable in Android.
os.makedirs('.settings', exist_ok=True)
with open('.settings/org.eclipse.jdt.core.prefs', 'w') as f:
f.write("""eclipse.preferences.version=1
org.eclipse.jdt.core.compiler.codegen.useStringConcatFactory=disabled
""")
print('Generated .settings', file=sys.stderr)
def _ParseArguments(argv):
parser = argparse.ArgumentParser(
description=
'Given Chromium Java build config files, generates an Eclipse JDT '
'project that can be used with the "Language Support for Java™ by '
'Red Hat" Visual Studio Code extension. See //docs/vscode.md '
'for details.')
parser.add_argument(
'--output-dir',
required=True,
help='Relative path to the output directory, e.g. "out/Debug"')
parser.add_argument(
'--build-config',
action='append',
required=True,
help='Path to the .build_config.json file to use as input, relative to '
'`--output-dir`. May be repeated.')
return parser.parse_args(argv)
def main(argv):
build_utils.InitLogging('GENERATE_VSCODE_CLASSPATH_DEBUG')
assert os.path.exists('.gn'), 'This script must be run from the src directory'
args = _ParseArguments(argv)
output_dir = args.output_dir
build_vars = gn_helpers.ReadBuildVars(output_dir)
source_dirs = set()
libs = set()
already_processed_build_config_files = set()
for build_config_path in args.build_config:
_ProcessBuildConfigFile(output_dir, build_config_path, source_dirs, libs,
already_processed_build_config_files,
build_vars['android_sdk_build_tools_version'])
logging.info('Done processing %d build config files',
len(already_processed_build_config_files))
_GenerateProject(source_dirs, libs, output_dir)
if __name__ == '__main__':
sys.exit(main(sys.argv[1:]))
|
