Skip to content
Navigation Menu
{{ message }}
forked from bazelbuild/rules_java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathjava_info.bzl
More file actions
1037 lines (962 loc) · 46.3 KB
/
Copy pathjava_info.bzl
File metadata and controls
1037 lines (962 loc) · 46.3 KB
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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright 2023 The Bazel Authors. 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.
"""
Definition of JavaInfo and JavaPluginInfo provider.
"""
load("@rules_cc//cc/common:cc_info.bzl", "CcInfo")
load("//java/common:java_semantics.bzl", "semantics")
load(":native.bzl", "get_internal_java_common")
# copybara: default visibility
_JavaOutputInfo = provider(
doc = "The outputs of Java compilation.",
fields = {
"class_jar": "(File) A classes jar file.",
"compile_jar": "(File) An interface jar file.",
"header_compilation_jar": "(File) An header compilation jar file.",
"ijar": "Deprecated: Please use compile_jar.",
"compile_jdeps": "(File) Compile time dependencies information (deps.proto file).",
"generated_class_jar": "(File) A jar containing classes generated via annotation processing.",
"generated_source_jar": "(File) The source jar created as a result of annotation processing.",
"native_headers_jar": "(File) A jar of CC header files supporting native method implementation.",
"manifest_proto": "(File) The manifest protobuf file of the manifest generated from JavaBuilder.",
"jdeps": "(File) The jdeps protobuf file of the manifest generated from JavaBuilder.",
"source_jars": "(depset[File]) A depset of sources archive files.",
"source_jar": "Deprecated: Please use source_jars instead.",
},
)
_ModuleFlagsInfo = provider(
doc = "Provider for the runtime classpath contributions of a Java binary.",
fields = {
"add_exports": "(depset[str]) Add-Exports configuration.",
"add_opens": "(depset[str]) Add-Opens configuration.",
},
)
_EMPTY_MODULE_FLAGS_INFO = _ModuleFlagsInfo(add_exports = depset(), add_opens = depset())
def _create_module_flags_info(*, add_exports, add_opens):
if add_exports or add_opens:
return _ModuleFlagsInfo(add_exports = add_exports, add_opens = add_opens)
return _EMPTY_MODULE_FLAGS_INFO
_JavaRuleOutputJarsInfo = provider(
doc = "Deprecated: use java_info.java_outputs. Information about outputs of a Java rule.",
fields = {
"jdeps": "Deprecated: Use java_info.java_outputs.",
"native_headers": "Deprecated: Use java_info.java_outputs[i].jdeps.",
"jars": "Deprecated: Use java_info.java_outputs[i].native_headers_jar.",
},
)
_JavaGenJarsInfo = provider(
doc = "Deprecated: Information about jars that are a result of annotation processing for a Java rule.",
fields = {
"enabled": "Deprecated. Returns true if annotation processing was applied on this target.",
"class_jar": "Deprecated: Please use JavaInfo.java_outputs.generated_class_jar instead.",
"source_jar": "Deprecated: Please use JavaInfo.java_outputs.generated_source_jar instead.",
"transitive_class_jars": "Deprecated. A transitive set of class file jars from annotation " +
"processing of this rule and its dependencies.",
"transitive_source_jars": "Deprecated. A transitive set of source archives from annotation " +
"processing of this rule and its dependencies.",
"processor_classpath": "Deprecated: Please use JavaInfo.plugins instead.",
"processor_classnames": "Deprecated: Please use JavaInfo.plugins instead.",
},
)
JavaCompilationInfo = provider(
doc = "Compilation information in Java rules, for perusal of aspects and tools.",
fields = {
"boot_classpath": "Boot classpath for this Java target.",
"javac_options": """Depset of options to the java compiler. To get the
exact list of options passed to javac in the correct order, use the
tokenize_javacopts utility in rules_java""",
"compilation_classpath": "Compilation classpath for this Java target.",
"runtime_classpath": "Run-time classpath for this Java target.",
},
)
def merge(
providers,
# private to @_builtins:
merge_java_outputs = True,
merge_source_jars = True):
"""Merges the given providers into a single JavaInfo.
Args:
providers: ([JavaInfo]) The list of providers to merge.
merge_java_outputs: (bool)
merge_source_jars: (bool)
Returns:
(JavaInfo) The merged JavaInfo
"""
_validate_provider_list(providers, "providers", JavaInfo)
plugin_info = merge_plugin_info_without_outputs(providers)
source_jars = [] # [File]
transitive_source_jars = [] # [depset[File]]
java_outputs = [] # [_JavaOutputInfo]
runtime_output_jars = [] # [File]
transitive_runtime_jars = [] # [depset[File]]
transitive_compile_time_jars = [] # [depset[File]]
compile_jars = [] # [depset[File]]
header_compilation_direct_deps = [] # [depset[File]]
full_compile_jars = [] # [depset[File]]
_transitive_full_compile_time_jars = [] # [depset[File]]
_compile_time_java_dependencies = [] # [depset[File]]
add_exports = [] # [depset[str]]
add_opens = [] # [depset[str]]
_neverlink = False
_constraints = [] # [str]
for p in providers:
if merge_source_jars:
source_jars.extend(p.source_jars)
transitive_source_jars.append(p.transitive_source_jars)
if merge_java_outputs:
java_outputs.extend(p.java_outputs)
runtime_output_jars.extend(p.runtime_output_jars)
transitive_runtime_jars.append(p.transitive_runtime_jars)
transitive_compile_time_jars.append(p.transitive_compile_time_jars)
compile_jars.append(p.compile_jars)
header_compilation_direct_deps.append(p.header_compilation_direct_deps)
full_compile_jars.append(p.full_compile_jars)
_transitive_full_compile_time_jars.append(p._transitive_full_compile_time_jars)
_compile_time_java_dependencies.append(p._compile_time_java_dependencies)
add_exports.append(p.module_flags_info.add_exports)
add_opens.append(p.module_flags_info.add_opens)
_neverlink = _neverlink or p._neverlink
_constraints.extend(p._constraints)
transitive_runtime_jars = depset(order = "preorder", transitive = transitive_runtime_jars)
transitive_compile_time_jars = depset(order = "preorder", transitive = transitive_compile_time_jars)
# java_outputs is a list so we uniquify to avoid https://github.com/bazelbuild/bazel/issues/17170
java_outputs = depset(java_outputs).to_list()
result = {
"transitive_runtime_jars": transitive_runtime_jars,
"transitive_compile_time_jars": transitive_compile_time_jars,
"compile_jars": depset(order = "preorder", transitive = compile_jars),
"header_compilation_direct_deps": depset(order = "preorder", transitive = header_compilation_direct_deps),
"full_compile_jars": depset(order = "preorder", transitive = full_compile_jars),
"_transitive_full_compile_time_jars": depset(order = "preorder", transitive = _transitive_full_compile_time_jars),
"_compile_time_java_dependencies": depset(order = "preorder", transitive = _compile_time_java_dependencies),
# runtime_output_jars is a list so we uniquify to avoid https://github.com/bazelbuild/bazel/issues/17170
"runtime_output_jars": depset(runtime_output_jars).to_list(),
# source_jars is a list so we uniquify to avoid https://github.com/bazelbuild/bazel/issues/17170
"source_jars": depset(source_jars).to_list(),
"transitive_source_jars": depset(transitive = transitive_source_jars),
"java_outputs": java_outputs,
"outputs": _JavaRuleOutputJarsInfo(jars = java_outputs, jdeps = None, native_headers = None),
"module_flags_info": _create_module_flags_info(
add_exports = depset(transitive = add_exports),
add_opens = depset(transitive = add_opens),
),
"plugins": plugin_info.plugins,
"api_generating_plugins": plugin_info.api_generating_plugins,
"_neverlink": bool(_neverlink),
"_constraints": depset(_constraints).to_list(),
"annotation_processing": None,
"compilation_info": None,
}
if get_internal_java_common().google_legacy_api_enabled():
cc_info = semantics.minimize_cc_info(semantics.merge_cc_infos(cc_infos = [p.cc_link_params_info for p in providers]))
result.update(
cc_link_params_info = cc_info,
transitive_native_libraries =
cc_info._legacy_transitive_native_libraries if hasattr(cc_info, "_legacy_transitive_native_libraries") else cc_info.transitive_native_libraries(),
)
else:
result.update(
transitive_native_libraries = depset(
order = "topological",
transitive = [p.transitive_native_libraries for p in providers],
),
)
return _new_javainfo(**result)
def to_java_binary_info(java_info, compilation_info):
"""Get a copy of the given JavaInfo with minimal info returned by a java_binary
Args:
java_info: (JavaInfo) A JavaInfo provider instance
compilation_info: (JavaCompilationInfo)
Returns:
(JavaInfo) A JavaInfo instance representing a java_binary target
"""
result = {
"transitive_runtime_jars": depset(),
"transitive_compile_time_jars": depset(),
"compile_jars": depset(),
"header_compilation_direct_deps": depset(),
"full_compile_jars": depset(),
"_transitive_full_compile_time_jars": depset(),
"_compile_time_java_dependencies": depset(),
"runtime_output_jars": [],
"plugins": _EMPTY_PLUGIN_DATA,
"api_generating_plugins": _EMPTY_PLUGIN_DATA,
"module_flags_info": _EMPTY_MODULE_FLAGS_INFO,
"_neverlink": False,
"_constraints": [],
"annotation_processing": java_info.annotation_processing,
"transitive_native_libraries": java_info.transitive_native_libraries,
"source_jars": java_info.source_jars,
"transitive_source_jars": java_info.transitive_source_jars,
}
if hasattr(java_info, "cc_link_params_info"):
result.update(cc_link_params_info = java_info.cc_link_params_info)
result["compilation_info"] = compilation_info
java_outputs = [
_JavaOutputInfo(
compile_jar = None,
header_compilation_jar = None,
ijar = None, # deprecated
compile_jdeps = None,
class_jar = output.class_jar,
generated_class_jar = output.generated_class_jar,
generated_source_jar = output.generated_source_jar,
native_headers_jar = output.native_headers_jar,
manifest_proto = output.manifest_proto,
jdeps = output.jdeps,
source_jars = output.source_jars,
source_jar = output.source_jar, # deprecated
)
for output in java_info.java_outputs
]
all_jdeps = [output.jdeps for output in java_info.java_outputs if output.jdeps]
all_native_headers = [output.native_headers_jar for output in java_info.java_outputs if output.native_headers_jar]
result.update(
java_outputs = java_outputs,
outputs = _JavaRuleOutputJarsInfo(
jars = java_outputs,
jdeps = all_jdeps[0] if len(all_jdeps) == 1 else None,
native_headers = all_native_headers[0] if len(all_native_headers) == 1 else None,
),
)
# so that translation into native JavaInfo does not add JavaCompilationArgsProvider
result.update(_is_binary = True)
return _new_javainfo(**result)
def to_implicit_exportable(java_info, neverlink = False):
result = {
"transitive_runtime_jars": depset() if neverlink else java_info.transitive_runtime_jars,
"transitive_compile_time_jars": java_info.transitive_compile_time_jars,
"compile_jars": java_info.compile_jars,
"header_compilation_direct_deps": java_info.header_compilation_direct_deps,
"full_compile_jars": java_info.full_compile_jars,
"_transitive_full_compile_time_jars": java_info._transitive_full_compile_time_jars,
"_compile_time_java_dependencies": java_info._compile_time_java_dependencies,
"_neverlink": neverlink,
# unset defaults
"source_jars": [],
"outputs": _JavaRuleOutputJarsInfo(jars = [], jdeps = None, native_headers = None),
"annotation_processing": None,
"runtime_output_jars": [],
"transitive_source_jars": depset(),
"transitive_native_libraries": depset(),
"cc_link_params_info": CcInfo(),
"module_flags_info": _EMPTY_MODULE_FLAGS_INFO,
"plugins": _EMPTY_PLUGIN_DATA,
"api_generating_plugins": _EMPTY_PLUGIN_DATA,
"java_outputs": [],
"compilation_info": None,
"_constraints": [],
"_is_binary": getattr(java_info, "_is_binary", False),
}
return _new_javainfo(**result)
def _to_mutable_dict(java_info):
return {
key: getattr(java_info, key)
for key in dir(java_info)
if key not in ["to_json", "to_proto"]
}
def add_constraints(java_info, constraints = []):
"""Returns a copy of the given JavaInfo with the given constraints added.
Args:
java_info: (JavaInfo) The JavaInfo to enhance
constraints: ([str]) Constraints to add
Returns:
(JavaInfo)
"""
result = _to_mutable_dict(java_info)
old_constraints = java_info._constraints if java_info._constraints else []
result.update(
_constraints = depset(constraints + old_constraints).to_list(),
)
return _new_javainfo(**result)
def make_non_strict(java_info):
"""Returns a new JavaInfo instance whose direct-jars part is the union of both the direct and indirect jars of the given Java provider.
Args:
java_info: (JavaInfo) The java info to make non-strict.
Returns:
(JavaInfo)
"""
result = _to_mutable_dict(java_info)
result.update(
compile_jars = java_info.transitive_compile_time_jars,
full_compile_jars = java_info._transitive_full_compile_time_jars,
header_compilation_direct_deps = java_info.transitive_compile_time_jars,
)
# Omit jdeps, which aren't available transitively and aren't useful for reduced classpath
# pruning for non-strict targets: the direct classpath and transitive classpath are the same,
# so there's nothing to prune, and reading jdeps at compile-time isn't free.
result.update(
_compile_time_java_dependencies = depset(),
)
return _new_javainfo(**result)
def add_module_flags(java_info, add_exports = [], add_opens = []):
"""Returns a new JavaInfo instance with the additional add_exports/add_opens
Args:
java_info: (JavaInfo) The java info to enhance.
add_exports: ([str]) The <module>/<package>s given access to.
add_opens: ([str]) The <module>/<package>s given reflective access to.
Returns:
(JavaInfo)
"""
if not add_exports and not add_opens:
return java_info
result = _to_mutable_dict(java_info)
result.update(
module_flags_info = _create_module_flags_info(
add_exports = depset(add_exports, transitive = [java_info.module_flags_info.add_exports]),
add_opens = depset(add_opens, transitive = [java_info.module_flags_info.add_opens]),
),
)
return _new_javainfo(**result)
def set_annotation_processing(
java_info,
enabled = False,
processor_classnames = [],
processor_classpath = None,
class_jar = None,
source_jar = None):
"""Returns a copy of the given JavaInfo with the given annotation_processing info.
Args:
java_info: (JavaInfo) The JavaInfo to enhance.
enabled: (bool) Whether the rule uses annotation processing.
processor_classnames: ([str]) Class names of annotation processors applied.
processor_classpath: (depset[File]) Class names of annotation processors applied.
class_jar: (File) Optional. Jar that is the result of annotation processing.
source_jar: (File) Optional. Source archive resulting from annotation processing.
Returns:
(JavaInfo)
"""
gen_jars_info = java_info.annotation_processing
if gen_jars_info:
# Existing Jars would be a problem b/c we can't remove them from transitiveXxx sets
if gen_jars_info.class_jar and gen_jars_info.class_jar != class_jar:
fail("Existing gen_class_jar:", gen_jars_info.class_jar)
if gen_jars_info.source_jar and gen_jars_info.source_jar != source_jar:
fail("Existing gen_source_jar:", gen_jars_info.class_jar)
transitive_class_jars = depset([class_jar] if class_jar else [], transitive = [gen_jars_info.transitive_class_jars])
transitive_source_jars = depset([source_jar] if source_jar else [], transitive = [gen_jars_info.transitive_source_jars])
else:
transitive_class_jars = depset([class_jar] if class_jar else [])
transitive_source_jars = depset([source_jar] if source_jar else [])
result = _to_mutable_dict(java_info)
result.update(
annotation_processing = _JavaGenJarsInfo(
enabled = enabled,
class_jar = class_jar,
source_jar = source_jar,
processor_classnames = processor_classnames,
processor_classpath = processor_classpath if processor_classpath else depset(),
transitive_class_jars = transitive_class_jars,
transitive_source_jars = transitive_source_jars,
),
)
return _new_javainfo(**result)
def java_info_for_compilation(
output_jar,
compile_jar,
source_jar,
generated_class_jar,
generated_source_jar,
plugin_info,
deps,
runtime_deps,
exports,
exported_plugins,
compile_jdeps,
jdeps,
native_headers_jar,
manifest_proto,
native_libraries,
neverlink,
add_exports,
add_opens,
direct_runtime_jars,
compilation_info,
header_compilation_jar):
"""Creates a JavaInfo instance represiting the result of java compilation.
Args:
output_jar: (File) The jar that was created as a result of a compilation.
compile_jar: (File) A jar that is the compile-time dependency in lieu of `output_jar`.
header_compilation_jar: (File) A jar that is used for header compilation in lieu of
compile_jar or output_jar.
source_jar: (File) The source jar that was used to create the output jar.
generated_class_jar: (File) A jar file containing class files compiled from sources
generated during annotation processing.
generated_source_jar: (File) The source jar that was created as a result of annotation
processing.
plugin_info: (JavaPluginInfo) Information about annotation processing.
deps: ([JavaInfo]) Compile time dependencies that were used to create the output jar.
runtime_deps: ([JavaInfo]) Runtime dependencies that are needed for this library.
exports: ([JavaInfo]) Libraries to make available for users of this library.
exported_plugins: ([JavaPluginInfo]) A list of exported plugins.
compile_jdeps: (File) jdeps information about compile time dependencies to be consumed by
JavaCompileAction. This should be a binary proto encoded using the deps.proto protobuf
included with Bazel. If available this file is typically produced by a header compiler.
jdeps: (File) jdeps information for the rule output (if available). This should be a binary
proto encoded using the deps.proto protobuf included with Bazel. If available this file
is typically produced by a compiler. IDEs and other tools can use this information for
more efficient processing.
native_headers_jar: (File) A jar containing CC header files supporting native method
implementation (typically output of javac -h).
manifest_proto: (File) Manifest information for the rule output (if available). This should
be a binary proto encoded using the manifest.proto protobuf included with Bazel. IDEs
and other tools can use this information for more efficient processing.
native_libraries: ([CcInfo]) Native library dependencies that are needed for this library.
neverlink: (bool) If true, only use this library for compilation and not at runtime.
add_exports: ([str]) The <module>/<package>s this library was given access to.
add_opens: ([str]) The <module>/<package>s this library was given reflective access to.
direct_runtime_jars: ([File]) The class jars needed directly by this library at runtime.
This is usually just the output_jar or empty if there were no sources/resources.
compilation_info: (struct) Information for IDE/tools
Returns:
(JavaInfo) the JavaInfo instance
"""
result, concatenated_deps = _javainfo_init_base(
output_jar,
compile_jar,
source_jar,
deps,
runtime_deps,
exports,
exported_plugins,
jdeps,
compile_jdeps,
native_headers_jar,
manifest_proto,
generated_class_jar,
generated_source_jar,
native_libraries,
neverlink,
header_compilation_jar,
)
# this differs ever so slightly from the usual JavaInfo in that direct_runtime_jars
# does not contain the output_jar is there were no sources/resources
transitive_runtime_jars = depset() if neverlink else depset(
order = "preorder",
direct = direct_runtime_jars,
transitive = [dep.transitive_runtime_jars for dep in concatenated_deps.exports_deps + runtime_deps],
)
result.update(
runtime_output_jars = direct_runtime_jars,
transitive_runtime_jars = transitive_runtime_jars,
transitive_source_jars = depset(
direct = [source_jar] if source_jar else [],
# only differs from the usual java_info.transitive_source_jars in the order of deps
transitive = [dep.transitive_source_jars for dep in concatenated_deps.runtimedeps_exports_deps],
),
# the JavaInfo constructor does not add flags from runtime_deps
module_flags_info = _create_module_flags_info(
add_exports = depset(add_exports, transitive = [
dep.module_flags_info.add_exports
for dep in concatenated_deps.runtimedeps_exports_deps
]),
add_opens = depset(add_opens, transitive = [
dep.module_flags_info.add_opens
for dep in concatenated_deps.runtimedeps_exports_deps
]),
),
)
if compilation_info:
result.update(
compilation_info = JavaCompilationInfo(
javac_options = compilation_info.javac_options,
boot_classpath = compilation_info.boot_classpath,
compilation_classpath = compilation_info.compilation_classpath,
runtime_classpath = compilation_info.runtime_classpath,
),
annotation_processing = _JavaGenJarsInfo(
enabled = compilation_info.uses_annotation_processing,
class_jar = result["annotation_processing"].class_jar,
source_jar = result["annotation_processing"].source_jar,
processor_classnames = plugin_info.plugins.processor_classes.to_list(),
processor_classpath = plugin_info.plugins.processor_jars,
transitive_class_jars = result["annotation_processing"].transitive_class_jars,
transitive_source_jars = result["annotation_processing"].transitive_source_jars,
),
)
else:
result.update(
compilation_info = None,
annotation_processing = None,
)
return _new_javainfo(**result)
def _validate_provider_list(provider_list, what, expected_provider_type):
get_internal_java_common().check_provider_instances(provider_list, what, expected_provider_type)
def _compute_concatenated_deps(deps, runtime_deps, exports):
deps_exports = []
deps_exports.extend(deps)
deps_exports.extend(exports)
exports_deps = []
exports_deps.extend(exports)
exports_deps.extend(deps)
runtimedeps_exports_deps = []
runtimedeps_exports_deps.extend(runtime_deps)
runtimedeps_exports_deps.extend(exports_deps)
return struct(
deps_exports = deps_exports,
exports_deps = exports_deps,
runtimedeps_exports_deps = runtimedeps_exports_deps,
)
def _javainfo_init_base(
output_jar,
compile_jar,
source_jar,
deps,
runtime_deps,
exports,
exported_plugins,
jdeps,
compile_jdeps,
native_headers_jar,
manifest_proto,
generated_class_jar,
generated_source_jar,
native_libraries,
neverlink,
header_compilation_jar = None):
_validate_provider_list(deps, "deps", JavaInfo)
_validate_provider_list(runtime_deps, "runtime_deps", JavaInfo)
_validate_provider_list(exports, "exports", JavaInfo)
_validate_provider_list(native_libraries, "native_libraries", CcInfo)
# For clients that don't create a header_compilation_jar (e.g. java_import), fall back to using
# the compile jar.
if compile_jar and not header_compilation_jar:
header_compilation_jar = compile_jar
concatenated_deps = _compute_concatenated_deps(deps, runtime_deps, exports)
source_jars = [source_jar] if source_jar else []
plugin_info = merge_plugin_info_without_outputs(exported_plugins + exports)
transitive_compile_time_jars = depset(
order = "preorder",
direct = [compile_jar] if compile_jar else [],
transitive = [dep.transitive_compile_time_jars for dep in concatenated_deps.exports_deps],
)
java_outputs = [_JavaOutputInfo(
class_jar = output_jar,
compile_jar = compile_jar,
header_compilation_jar = header_compilation_jar,
ijar = compile_jar, # deprecated
compile_jdeps = compile_jdeps,
generated_class_jar = generated_class_jar,
generated_source_jar = generated_source_jar,
native_headers_jar = native_headers_jar,
manifest_proto = manifest_proto,
jdeps = jdeps,
source_jars = depset(source_jars),
source_jar = source_jar, # deprecated
)]
result = {
"transitive_compile_time_jars": transitive_compile_time_jars,
"compile_jars": depset(
order = "preorder",
direct = [compile_jar] if compile_jar else [],
transitive = [dep.compile_jars for dep in exports],
),
"header_compilation_direct_deps": depset(
order = "preorder",
direct = [header_compilation_jar] if header_compilation_jar else [],
transitive = [dep.header_compilation_direct_deps for dep in exports],
),
"full_compile_jars": depset(
order = "preorder",
direct = [output_jar],
transitive = [
dep.full_compile_jars
for dep in exports
],
),
"source_jars": source_jars,
"runtime_output_jars": [output_jar],
"plugins": plugin_info.plugins,
"api_generating_plugins": plugin_info.api_generating_plugins,
"java_outputs": java_outputs,
# deprecated
"outputs": _JavaRuleOutputJarsInfo(
jars = java_outputs,
jdeps = jdeps,
native_headers = native_headers_jar,
),
"annotation_processing": _JavaGenJarsInfo(
enabled = False,
class_jar = generated_class_jar,
source_jar = generated_source_jar,
transitive_class_jars = depset(
direct = [generated_class_jar] if generated_class_jar else [],
transitive = [
dep.annotation_processing.transitive_class_jars
for dep in concatenated_deps.deps_exports
if dep.annotation_processing
],
),
transitive_source_jars = depset(
direct = [generated_source_jar] if generated_source_jar else [],
transitive = [
dep.annotation_processing.transitive_source_jars
for dep in concatenated_deps.deps_exports
if dep.annotation_processing
],
),
processor_classnames = [],
processor_classpath = depset(),
),
"_transitive_full_compile_time_jars": depset(
order = "preorder",
direct = [output_jar],
transitive = [dep._transitive_full_compile_time_jars for dep in concatenated_deps.exports_deps],
),
"_compile_time_java_dependencies": depset(
order = "preorder",
transitive = [dep._compile_time_java_dependencies for dep in exports] +
([depset([compile_jdeps])] if compile_jdeps else []),
),
"_neverlink": bool(neverlink),
"compilation_info": None,
"_constraints": [],
}
if get_internal_java_common().google_legacy_api_enabled():
transitive_cc_infos = [dep.cc_link_params_info for dep in concatenated_deps.runtimedeps_exports_deps]
transitive_cc_infos.extend(native_libraries)
cc_info = semantics.minimize_cc_info(semantics.merge_cc_infos(cc_infos = transitive_cc_infos))
result.update(
cc_link_params_info = cc_info,
transitive_native_libraries =
cc_info._legacy_transitive_native_libraries if hasattr(cc_info, "_legacy_transitive_native_libraries") else cc_info.transitive_native_libraries(),
)
else:
transitive_native_libraries = []
if native_libraries:
merged_cc_info = semantics.merge_cc_infos(cc_infos = native_libraries)
if hasattr(merged_cc_info, "_legacy_transitive_native_libraries"):
transitive_native_libraries = [merged_cc_info._legacy_transitive_native_libraries]
else:
transitive_native_libraries = [merged_cc_info.transitive_native_libraries()]
result.update(
transitive_native_libraries = depset(
order = "topological",
transitive = [dep.transitive_native_libraries for dep in concatenated_deps.runtimedeps_exports_deps] +
transitive_native_libraries,
),
)
return result, concatenated_deps
def _javainfo_init(
output_jar,
compile_jar,
header_compilation_jar = None,
source_jar = None,
compile_jdeps = None,
generated_class_jar = None,
generated_source_jar = None,
native_headers_jar = None,
manifest_proto = None,
neverlink = False,
deps = [],
runtime_deps = [],
exports = [],
exported_plugins = [],
jdeps = None,
native_libraries = [],
add_exports = [],
add_opens = []):
"""The JavaInfo constructor
Args:
output_jar: (File) The jar that was created as a result of a compilation.
compile_jar: (File) A jar that is the compile-time dependency in lieu of `output_jar`.
header_compilation_jar: (File) A jar that is used for header compilation in lieu of
compile_jar or output_jar.
source_jar: (File) The source jar that was used to create the output jar. Optional.
compile_jdeps: (File) jdeps information about compile time dependencies to be consumed by
JavaCompileAction. This should be a binary proto encoded using the deps.proto protobuf
included with Bazel. If available this file is typically produced by a header compiler.
Optional.
generated_class_jar: (File) A jar file containing class files compiled from sources
generated during annotation processing. Optional.
generated_source_jar: (File) The source jar that was created as a result of annotation
processing. Optional.
native_headers_jar: (File) A jar containing CC header files supporting native method
implementation (typically output of javac -h). Optional.
manifest_proto: (File) Manifest information for the rule output (if available). This should
be a binary proto encoded using the manifest.proto protobuf included with Bazel. IDEs
and other tools can use this information for more efficient processing. Optional.
neverlink: (bool) If true, only use this library for compilation and not at runtime.
deps: ([JavaInfo]) Compile time dependencies that were used to create the output jar.
runtime_deps: ([JavaInfo]) Runtime dependencies that are needed for this library.
exports: ([JavaInfo]) Libraries to make available for users of this library.
exported_plugins: ([JavaPluginInfo]) Optional. A list of exported plugins.
jdeps: (File) jdeps information for the rule output (if available). This should be a binary
proto encoded using the deps.proto protobuf included with Bazel. If available this file
is typically produced by a compiler. IDEs and other tools can use this information for
more efficient processing. Optional.
native_libraries: ([CcInfo]) Native library dependencies that are needed for this library.
add_exports: ([str]) The <module>/<package>s this library was given access to.
add_opens: ([str]) The <module>/<package>s this library was given reflective access to.
Returns:
(dict) arguments to the JavaInfo provider constructor
"""
if add_exports or add_opens:
semantics.check_java_info_opens_exports()
result, concatenated_deps = _javainfo_init_base(
output_jar,
compile_jar,
source_jar,
deps,
runtime_deps,
exports,
exported_plugins,
jdeps,
compile_jdeps,
native_headers_jar,
manifest_proto,
generated_class_jar,
generated_source_jar,
native_libraries,
neverlink,
header_compilation_jar = header_compilation_jar,
)
if neverlink:
transitive_runtime_jars = depset()
else:
transitive_runtime_jars = depset(
order = "preorder",
direct = [output_jar],
transitive = [dep.transitive_runtime_jars for dep in concatenated_deps.exports_deps + runtime_deps],
)
# For backward compatibility, we use deps_exports for add_exports/add_opens
# for the JavaInfo constructor rather than runtimedeps_exports_deps (used
# by java_info_for_compilation). However, runtimedeps_exports_deps makes
# more sense, since add_exports/add_opens from runtime_deps are needed at
# runtime anyway.
#
# TODO: When this flag is removed, move this logic into _javainfo_init_base
# and remove the special case from java_info_for_compilation.
module_flags_deps = concatenated_deps.deps_exports
if get_internal_java_common().incompatible_java_info_merge_runtime_module_flags():
module_flags_deps = concatenated_deps.runtimedeps_exports_deps
result.update(
transitive_runtime_jars = transitive_runtime_jars,
transitive_source_jars = depset(
direct = [source_jar] if source_jar else [],
# TODO(hvd): native also adds source jars from deps, but this should be unnecessary
transitive = [
dep.transitive_source_jars
for dep in deps + runtime_deps + exports
],
),
module_flags_info = _create_module_flags_info(
add_exports = depset(add_exports, transitive = [
dep.module_flags_info.add_exports
for dep in module_flags_deps
]),
add_opens = depset(add_opens, transitive = [
dep.module_flags_info.add_opens
for dep in module_flags_deps
]),
),
)
return result
JavaInfo, _new_javainfo = provider(
doc = "Info object encapsulating all information by java rules.",
fields = {
"transitive_runtime_jars": """(depset[File]) A transitive set of jars required on the
runtime classpath.
<p/>Note: for binary targets (such as java_binary and java_test), this is empty, since such
targets are not intended to be dependencies of other Java targets.
""",
"transitive_compile_time_jars": """(depset[File]) The transitive set of jars required to
build the target.
<p/>Note: for binary targets (such as java_binary and java_test), this is empty, since such
targets are not intended to be dependencies of other Java targets.
""",
"compile_jars": """(depset[File]) The jars required directly at compile time. They can be interface jars
(ijar or hjar), regular jars or both, depending on whether rule
implementations chose to create interface jars or not.""",
"header_compilation_direct_deps": """(depset[File]) The header compilation jars required
directly at compile time.""",
"full_compile_jars": """(depset[File]) The regular, full compile time Jars required by this target directly.
They can be:
- the corresponding regular Jars of the interface Jars returned by JavaInfo.compile_jars
- the regular (full) Jars returned by JavaInfo.compile_jars
Note: JavaInfo.compile_jars can return a mix of interface Jars and
regular Jars.<p>Only use this method if interface Jars don't work with
your rule set(s) (e.g. some Scala targets) If you're working with
Java-only targets it's preferable to use interface Jars via
JavaInfo.compile_jars""",
"source_jars": """([File]) A list of Jars with all the source files (including those generated by
annotations) of the target itself, i.e. NOT including the sources of the
transitive dependencies.""",
"outputs": "Deprecated: use java_outputs.",
"annotation_processing": "Deprecated: Please use plugins instead.",
"runtime_output_jars": "([File]) A list of runtime Jars created by this Java/Java-like target.",
"transitive_source_jars": "(depset[File]) The Jars of all source files in the transitive closure.",
"transitive_native_libraries": """(depset[LibraryToLink]) The transitive set of CC native
libraries required by the target.""",
"cc_link_params_info": "Deprecated. Do not use. C++ libraries to be linked into Java targets.",
"module_flags_info": "(_ModuleFlagsInfo) The Java module flag configuration.",
"plugins": """(_JavaPluginDataInfo) Data about all plugins that a consuming target should
apply.
This is typically either a `java_plugin` itself or a `java_library` exporting
one or more plugins.
A `java_library` runs annotation processing with all plugins from this field
appearing in <code>deps</code> and `plugins` attributes.""",
"api_generating_plugins": """"(_JavaPluginDataInfo) Data about API generating plugins
defined or exported by this target.
Those annotation processors are applied to a Java target before
producing its header jars (which contain method signatures). When
no API plugins are present, header jars are generated from the
sources, reducing critical path.
The `api_generating_plugins` is a subset of `plugins`.""",
"java_outputs": "(_JavaOutputInfo) Information about outputs of this Java/Java-like target.",
"compilation_info": """(java_compilation_info) Compilation information for this
Java/Java-like target.""",
"_transitive_full_compile_time_jars": "internal API, do not use",
"_compile_time_java_dependencies": "internal API, do not use",
"_neverlink": "internal API, do not use",
"_constraints": "internal API, do not use",
"_is_binary": "internal API, do not use",
},
init = _javainfo_init,
)
JavaPluginDataInfo = provider(
doc = "Provider encapsulating information about a Java compatible plugin.",
fields = {
"processor_classes": "depset(str) The fully qualified classnames of entry points for the compiler",
"processor_jars": "depset(file) Deps containing an annotation processor",
"processor_data": "depset(file) Files needed during execution",
},
)
_EMPTY_PLUGIN_DATA = JavaPluginDataInfo(
processor_classes = depset(),
processor_jars = depset(),
processor_data = depset(),
)
def _create_plugin_data_info(*, processor_classes, processor_jars, processor_data):
if processor_classes or processor_jars or processor_data:
return JavaPluginDataInfo(
processor_classes = processor_classes,
processor_jars = processor_jars,
processor_data = processor_data,
)
else:
return _EMPTY_PLUGIN_DATA
def disable_plugin_info_annotation_processing(plugin_info):
"""Returns a copy of the provided JavaPluginInfo without annotation processing info
Args:
plugin_info: (JavaPluginInfo) the instance to transform
Returns:
(JavaPluginInfo) a new, transformed instance.
"""
return _new_javaplugininfo(
plugins = _create_plugin_data_info(
processor_classes = depset(order = "preorder"),
# Preserve the processor path, since it may contain Error Prone plugins
# which will be service-loaded by JavaBuilder.
processor_jars = plugin_info.plugins.processor_jars,
# Preserve data, which may be used by Error Prone plugins.
processor_data = plugin_info.plugins.processor_data,
),
api_generating_plugins = _EMPTY_PLUGIN_DATA,
java_outputs = plugin_info.java_outputs,
)
def merge_plugin_info_without_outputs(infos):
""" Merge plugin information from a list of JavaPluginInfo or JavaInfo
Args:
infos: ([JavaPluginInfo|JavaInfo]) list of providers to merge
Returns:
(JavaPluginInfo)
"""
plugins = []
api_generating_plugins = []
for info in infos:
if _has_plugin_data(info.plugins):
plugins.append(info.plugins)
if _has_plugin_data(info.api_generating_plugins):
api_generating_plugins.append(info.api_generating_plugins)
return _new_javaplugininfo(
plugins = _merge_plugin_data(plugins),
api_generating_plugins = _merge_plugin_data(api_generating_plugins),
java_outputs = [],
)
def _has_plugin_data(plugin_data):
return plugin_data and (
plugin_data.processor_classes or
plugin_data.processor_jars or
plugin_data.processor_data
)
def _merge_plugin_data(datas):
return _create_plugin_data_info(
processor_classes = depset(transitive = [p.processor_classes for p in datas]),
processor_jars = depset(transitive = [p.processor_jars for p in datas]),
processor_data = depset(transitive = [p.processor_data for p in datas]),
)
def _javaplugininfo_init(
runtime_deps,
processor_class = None,
processor_classes = [],
data = [],
generates_api = False):
""" Constructs JavaPluginInfo
Args:
runtime_deps: ([JavaInfo]) list of deps containing an annotation
processor.
processor_class: (String) The fully qualified class name that the Java
compiler uses as an entry point to the annotation processor.
processor_classes: ([String]) Fully qualified class names that the
Java compiler uses as an entry point to the annotation processor.
data: (depset[File]) The files needed by this annotation
processor during execution.
generates_api: (boolean) Set to true when this annotation processor
generates API code. Such an annotation processor is applied to a
Java target before producing its header jars (which contains method
signatures). When no API plugins are present, header jars are
generated from the sources, reducing the critical path.
WARNING: This parameter affects build performance, use it only if
necessary.
Returns:
(JavaPluginInfo)
"""
java_infos = merge(runtime_deps)
You can’t perform that action at this time.