-
Notifications
You must be signed in to change notification settings - Fork 85
/
library.bzl
1149 lines (1037 loc) · 45.9 KB
/
library.bzl
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
"""Library rules"""
load("@bazel_skylib//lib:dicts.bzl", "dicts")
load("@bazel_skylib//lib:paths.bzl", "paths")
load("@bazel_skylib//lib:sets.bzl", "sets")
load("@bazel_skylib//lib:selects.bzl", "selects")
load("@bazel_skylib//rules:write_file.bzl", "write_file")
load("@build_bazel_rules_apple//apple/internal:apple_framework_import.bzl", "apple_dynamic_framework_import", "apple_static_framework_import")
load("@build_bazel_rules_apple//apple/internal/resource_rules:apple_intent_library.bzl", "apple_intent_library")
load("@build_bazel_rules_swift//swift:swift.bzl", "swift_library")
load("//rules:precompiled_apple_resource_bundle.bzl", "precompiled_apple_resource_bundle")
load("//rules:hmap.bzl", "headermap")
load("//rules:features.bzl", "feature_names")
load("//rules/framework:vfs_overlay.bzl", "framework_vfs_overlay", VFS_OVERLAY_FRAMEWORK_SEARCH_PATH = "FRAMEWORK_SEARCH_PATH")
load("//rules/library:resources.bzl", "wrap_resources_in_filegroup")
load("//rules/library:xcconfig.bzl", "copts_by_build_setting_with_defaults")
load("//rules:import_middleman.bzl", "import_middleman")
load("//rules:utils.bzl", "bundle_identifier_for_bundle")
PrivateHeadersInfo = provider(
doc = "Propagates private headers, so they can be accessed if necessary",
fields = {
"headers": "Private headers",
},
)
GLOBAL_INDEX_STORE_PATH = "bazel-out/_global_index_store"
_MANUAL = ["manual"]
_SWIFT_LIBRARY_KWARGS = [
"always_include_developer_search_paths",
"package_name",
"plugins",
]
def _private_headers_impl(ctx):
return [
PrivateHeadersInfo(
headers = depset(direct = ctx.files.headers),
),
apple_common.new_objc_provider(),
CcInfo(
compilation_context = cc_common.create_compilation_context(
headers = depset(direct = ctx.files.headers),
),
),
]
_private_headers = rule(
implementation = _private_headers_impl,
attrs = {
"headers": attr.label_list(mandatory = True, allow_files = [".inc", ".h", ".hh", ".hpp"]),
},
)
def _extend_modulemap_impl(ctx):
args = ctx.actions.args()
args.add("""
module {module_name}.Swift {{
header "{swift_umbrella_header}"
requires objc
}}""".format(
module_name = ctx.attr.module_name,
swift_umbrella_header = ctx.attr.swift_header,
))
args.add(ctx.file.source)
args.add(ctx.outputs.destination)
ctx.actions.run_shell(
inputs = [ctx.file.source],
outputs = [ctx.outputs.destination],
mnemonic = "ExtendModulemap",
progress_message = "Extending %s" % ctx.file.source.basename,
command = "echo \"$1\" | cat \"$2\" - > \"$3\"",
arguments = [args],
)
return [
DefaultInfo(
files = depset([ctx.outputs.destination]),
),
CcInfo(
compilation_context = cc_common.create_compilation_context(
headers = depset([ctx.outputs.destination]),
),
),
]
extend_modulemap = rule(
implementation = _extend_modulemap_impl,
attrs = {
"source": attr.label(
doc = "",
allow_single_file = True,
),
"destination": attr.output(),
"module_name": attr.string(
mandatory = True,
),
"swift_header": attr.string(
doc = "",
),
},
doc = "Extends a modulemap with a Swift submodule",
)
def _write_modulemap(name, library_tools, umbrella_header = None, public_headers = [], private_headers = [], module_name = None, framework = False, **kwargs):
basename = "{}.modulemap".format(name)
destination = paths.join(name + "-modulemap", basename)
if not module_name:
module_name = name
content = """\
module {module_name} {{
umbrella header "{umbrella_header}"
export *
module * {{ export * }}
}}
""".format(
module_name = module_name,
umbrella_header = umbrella_header,
)
if framework:
content = "framework " + content
write_file(
name = basename + "~",
out = destination,
content = content.split("\n"),
tags = _MANUAL,
)
return destination
def _write_umbrella_header(
name,
generate_default_umbrella_header,
public_headers = [],
module_name = None):
basename = "{name}-umbrella.h".format(name = name)
destination = paths.join(name + "-modulemap", basename)
if not module_name:
module_name = name
content = ""
extern_keyword = "extern"
if generate_default_umbrella_header:
extern_keyword = "FOUNDATION_EXPORT"
content += """\
#ifdef __OBJC__
# import <Foundation/Foundation.h>
# if __has_include(<UIKit/UIKit.h>)
# import <UIKit/UIKit.h>
# endif
#else
# ifndef FOUNDATION_EXPORT
# if defined(__cplusplus)
# define FOUNDATION_EXPORT extern "C"
# else
# define FOUNDATION_EXPORT extern
# endif
# endif
#endif
"""
for header in public_headers:
content += "#import \"{header}\"\n".format(header = paths.basename(header))
content += """
{extern_keyword} double {module_name}VersionNumber;
{extern_keyword} const unsigned char {module_name}VersionString[];
""".format(
extern_keyword = extern_keyword,
module_name = module_name,
)
write_file(
name = basename + "~",
out = destination,
content = content.split("\n"),
tags = _MANUAL,
)
return destination
def _generate_resource_bundles(name, library_tools, resource_bundles, platforms):
bundle_target_names = []
for bundle_name in resource_bundles:
target_name = "%s-%s" % (name, bundle_name)
precompiled_apple_resource_bundle(
name = target_name,
bundle_name = bundle_name,
bundle_id = bundle_identifier_for_bundle(bundle_name),
resources = [
library_tools["wrap_resources_in_filegroup"](name = target_name + "_resources", srcs = resource_bundles[bundle_name]),
],
platforms = platforms,
tags = _MANUAL,
)
bundle_target_names.append(target_name)
return bundle_target_names
def _error_on_default_xcconfig(name, default_xcconfig_name):
fail("{name} specifies a default xcconfig ({default_xcconfig_name}). You must override fetch_default_xcconfig to use this feature.".format(
name = name,
default_xcconfig_name = default_xcconfig_name,
))
_DEFAULT_LIBRARY_TOOLS = {
"modulemap_generator": _write_modulemap,
"umbrella_header_generator": _write_umbrella_header,
"resource_bundle_generator": _generate_resource_bundles,
"wrap_resources_in_filegroup": wrap_resources_in_filegroup,
"fetch_default_xcconfig": _error_on_default_xcconfig,
}
# buildifier: disable=list-append
def _append_headermap_copts(hmap, flag, objc_copts, swift_copts, cc_copts):
copt = flag + "$(execpath :{hmap})".format(hmap = hmap)
objc_copts += [copt]
cc_copts += [copt]
swift_copts += ["-Xcc", copt]
return objc_copts, swift_copts, cc_copts
def _uppercase_string(s):
return s.upper()
def _canonicalize_swift_version(swift_version):
if not swift_version:
return None
version_parts = swift_version.split(".", 2)
if int(version_parts[0]) >= 5:
# Swift 5+ doesn't allow the minor version to be supplied, though Xcode is more lenient
swift_version = version_parts[0]
else:
# Drop any trailing ".0" versions
version_parts_scrubbed = []
only_zeros_seen = True
for part in reversed(version_parts):
if part == "0" and only_zeros_seen:
continue
only_zeros_seen = False
version_parts_scrubbed.insert(0, part)
swift_version = ".".join(version_parts_scrubbed)
return swift_version
def _xcframework_build_type(*, linkage, packaging):
return (linkage, packaging)
def _xcframework_slice(*, xcframework_name, identifier, platform, platform_variant, supported_archs, build_type, path, dsym_imports = []):
linkage, packaging = _xcframework_build_type(**build_type)
resolved_target_name = "{}-{}".format(xcframework_name, identifier)
resolved_target_name_vfs_overlay = resolved_target_name + "_vfs"
def _xcframework_slice_imports(path):
"""
Returns a tuple of the headers, module map and swiftmodules for the given path in a .xcframework.
"""
hdrs = native.glob(["%s/**/*.h" % path], allow_empty = True)
modulemaps = native.glob(["%s/**/*.modulemap" % path], allow_empty = True)
swiftmodules = native.glob(["%s/**/*.swiftmodule/*.*" % path], allow_empty = True)
modulemap = modulemaps[0] if modulemaps else None
return hdrs, modulemap, swiftmodules
def _make_xcframework_vfs(hdrs, modulemap, swiftmodules, static = False):
"""
Creates a framework_vfs_overlay with the provided arguments.
If static is True, the framework_vfs_overlay will be created within the context
of a static library within a .xcframework.
"""
imported_framework_name = _find_imported_xcframework_name(hdrs) if static else _find_imported_framework_name(hdrs)
vfs_framework_name = imported_framework_name if imported_framework_name else xcframework_name
framework_vfs_overlay(
name = resolved_target_name_vfs_overlay,
framework_name = vfs_framework_name,
modulemap = modulemap,
swiftmodules = swiftmodules,
hdrs = hdrs,
tags = _MANUAL,
extra_search_paths = None if static else xcframework_name,
)
if (linkage, packaging) == ("dynamic", "framework"):
apple_dynamic_framework_import(
name = resolved_target_name,
framework_imports = native.glob(
[path + "/**/*"],
exclude = ["**/.DS_Store"],
),
deps = [],
dsym_imports = dsym_imports,
tags = _MANUAL,
)
import_headers, import_module_map, import_swiftmodules = _xcframework_slice_imports(path)
_make_xcframework_vfs(import_headers, import_module_map, import_swiftmodules)
elif (linkage, packaging) == ("static", "framework"):
apple_static_framework_import(
name = resolved_target_name,
framework_imports = native.glob(
[path + "/**/*"],
exclude = ["**/.DS_Store"],
),
deps = [],
tags = _MANUAL,
)
import_headers, import_module_map, import_swiftmodules = _xcframework_slice_imports(path)
_make_xcframework_vfs(import_headers, import_module_map, import_swiftmodules)
elif (linkage, packaging) == ("static", "library"):
# For a static library the `path` is the path to the library (`.a`) itself.
# We need the path to the top-level slice directory so we can find headers, modulemaps and swiftmodules.
slice_dir = paths.dirname(path)
import_headers, import_module_map, import_swiftmodules = _xcframework_slice_imports(slice_dir)
includes = [paths.dirname(f) for f in import_headers] + ["%s/Headers" % slice_dir]
native.objc_import(
name = resolved_target_name,
archives = [path],
hdrs = import_headers,
includes = includes,
tags = _MANUAL,
)
_make_xcframework_vfs(import_headers, import_module_map, import_swiftmodules, static = True)
else:
fail("Unsupported xcframework slice type {} ({}) in {}".format(
build_type,
identifier,
xcframework_name,
))
return (platform, platform_variant, supported_archs, resolved_target_name, resolved_target_name_vfs_overlay)
def _xcframework(*, library_name, name, slices):
xcframework_name = "{}-import-{}.xcframework".format(library_name, name)
xcframework_name_vfs = xcframework_name + "_vfs"
conditions = {}
conditions_vfs = {}
arm64_ios_device_slice = None
arm64_simulator_slice = None
if not slices:
fail("No slices found for XCFramework {}".format(xcframework_name))
for slice in slices:
platform, platform_variant, archs, name, vfs_overlay_target_name = _xcframework_slice(xcframework_name = xcframework_name, **slice)
platform_setting = "@build_bazel_rules_ios//rules/apple_platform:" + platform
for arch in archs:
if platform == "ios":
unsupported_platforms = ["armv7", "armv7s", "i386"]
if arch in unsupported_platforms:
continue
elif platform_variant == "maccatalyst":
# TODO: support maccatalyst
continue
elif arch == "arm64":
if platform_variant == "simulator":
arm64_simulator_slice = name
else:
arm64_ios_device_slice = name
rules_apple_platfrom = "darwin" if platform == "macos" else platform
arch_prefix = "sim_" if platform_variant == "simulator" and arch == "arm64" else ""
arch_setting = "@build_bazel_rules_apple//apple:{}_{}{}".format(rules_apple_platfrom, arch_prefix, arch)
config_setting_name = "{}-{}".format(
xcframework_name,
"_".join([x for x in (platform, platform_variant, arch) if x]),
)
if config_setting_name in conditions:
fail("Duplicate slice for {}.xcframework used by {} ({}): {} and {}".format(
name,
library_name,
config_setting_name,
conditions[config_setting_name],
name,
))
if config_setting_name in conditions_vfs:
fail("Duplicate slice for {}.xcframework used by {} ({}): {} and {}".format(
vfs_overlay_target_name,
library_name,
config_setting_name,
conditions[config_setting_name],
vfs_overlay_target_name,
))
conditions[config_setting_name] = name
conditions_vfs[config_setting_name] = vfs_overlay_target_name
selects.config_setting_group(
name = config_setting_name,
match_all = [platform_setting, arch_setting],
)
# Use the arm64 slice when overriding the CPU
alias_slice = arm64_simulator_slice if arm64_simulator_slice else arm64_ios_device_slice
if alias_slice:
native.alias(name = xcframework_name + "default", actual = select(conditions), tags = _MANUAL)
native.alias(name = xcframework_name + "default_vfs", actual = select(conditions_vfs), tags = _MANUAL)
conditions = {
"//conditions:default": xcframework_name + "default",
"@build_bazel_rules_ios//:arm64_simulator_use_device_deps": alias_slice,
}
conditions_vfs = {
"//conditions:default": xcframework_name + "default_vfs",
"@build_bazel_rules_ios//:arm64_simulator_use_device_deps": alias_slice + "_vfs",
}
native.alias(
name = xcframework_name,
actual = select(conditions, no_match_error = "Unable to find a matching slice for {}.xcframework used by {}".format(
name,
library_name,
)),
tags = _MANUAL,
)
native.alias(
name = xcframework_name_vfs,
actual = select(conditions_vfs, no_match_error = "Unable to find a matching vfs overlay for {}.xcframework used by {}".format(
name,
library_name,
)),
tags = _MANUAL,
)
return xcframework_name, xcframework_name_vfs
def _find_imported_framework_name(outputs):
"""
Returns the name of the .framework that includes the given outputs.
Note: safely assume for an import the paths will be relative to the .framework directory
(afterall, that is what a .framework means)
"""
for output in outputs:
if not ".framework" in output:
continue
prefix = output.split(".framework/")[0]
fw_name = prefix.split("/")[-1]
return fw_name
return None
def _find_imported_xcframework_name(outputs):
"""
Returns the name of the .xcframework that includes the given outputs.
Note: for a static library there is no .framework.
Instead, the .xcframework is the name of the static library.
"""
for output in outputs:
if not ".xcframework" in output:
continue
prefix = output.split(".xcframework/")[0]
fw_name = prefix.split("/")[-1]
return fw_name
return None
def _xcframework_contains_arm64_sim_slice(xcframework):
slices = xcframework["slices"]
for s in slices:
if s["platform"] == "ios" and \
s["platform_variant"] == "simulator" and \
"arm64" in s["supported_archs"]:
return True
return False
def apple_library(
name,
library_tools = {},
export_private_headers = True,
namespace_is_module_name = True,
default_xcconfig_name = None,
xcconfig = {},
xcconfig_by_build_setting = {},
objc_defines = [],
swift_defines = [],
**kwargs):
"""Create libraries for native source code on Apple platforms.
Automatically handles mixed-source libraries and comes with
reasonable defaults that mimic Xcode's behavior.
Args:
name: The base name for all of the underlying targets.
library_tools: An optional dictionary containing overrides for
default behaviors.
export_private_headers: Whether private headers should be exported via
a `PrivateHeadersInfo` provider.
namespace_is_module_name: Whether the module name should be used as the
namespace for header imports, instead of the target name.
default_xcconfig_name: The name of a default xcconfig to be applied to this target.
xcconfig: A dictionary of Xcode build settings to be applied to this target in the
form of different `copt` attributes.
xcconfig_by_build_setting: A dictionary of Xcode build settings grouped by bazel build setting.
Each value is applied (overriding any matching setting in 'xcconfig') if
the respective bazel build setting is resolved during the analysis phase.
objc_defines: A list of Objective-C defines to add to the compilation command line. They should be in the form KEY=VALUE or simply KEY and are passed not only to the compiler for this target (as copts are) but also to all objc_ dependers of this target.
swift_defines: A list of Swift defines to add to the compilation command line. Swift defines do not have values, so strings in this list should be simple identifiers and not KEY=VALUE pairs. (only expections are KEY=1 and KEY=0). These flags are added for the target and every target that depends on it.
**kwargs: keyword arguments.
Returns:
Struct with a bunch of info
"""
library_tools = dict(_DEFAULT_LIBRARY_TOOLS, **library_tools)
swift_sources = []
objc_sources = []
objc_non_arc_sources = []
cpp_sources = []
intent_sources = []
public_headers = kwargs.pop("public_headers", [])
private_headers = kwargs.pop("private_headers", [])
objc_hdrs = [f for f in public_headers if f.endswith((".inc", ".h", ".hh", ".hpp"))]
objc_non_exported_hdrs = []
objc_private_hdrs = [f for f in private_headers if f.endswith((".inc", ".h", ".hh", ".hpp"))]
if public_headers:
public_headers = sets.make(public_headers)
if private_headers:
private_headers = sets.make(private_headers)
for f in sorted(kwargs.pop("non_arc_srcs", []), key = _uppercase_string):
if f.endswith((".m", ".mm")):
objc_non_arc_sources.append(f)
else:
kwargs["srcs"] = kwargs.pop("srcs", []) + [f]
for f in sorted(kwargs.pop("srcs", []), key = _uppercase_string):
if f.endswith((".h", ".hh", ".hpp")):
if (private_headers and sets.contains(private_headers, f)) or \
(public_headers and sets.contains(public_headers, f)):
pass
elif public_headers and private_headers:
objc_non_exported_hdrs.append(f)
elif public_headers:
objc_private_hdrs.append(f)
else:
objc_hdrs.append(f)
elif f.endswith((".inc", ".m", ".mm", ".c", ".s", ".S")):
objc_sources.append(f)
elif f.endswith((".swift")):
swift_sources.append(f)
elif f.endswith((".cc", ".cpp")):
cpp_sources.append(f)
elif f.endswith((".intentdefinition")):
intent_sources.append(f)
else:
fail("Unable to compile %s in apple_framework %s" % (f, name))
module_name = kwargs.pop("module_name", name)
namespace = module_name if namespace_is_module_name else name
module_map = kwargs.pop("module_map", None)
swift_objc_bridging_header = kwargs.pop("swift_objc_bridging_header", None)
has_swift_sources = len(swift_sources) > 0
# Historically, xcode and cocoapods use an umbrella header that imports Foundation and UIKit at the
# beginning of it. See:
# * https://github.com/CocoaPods/CocoaPods/issues/6815#issuecomment-330046236
# * https://github.com/facebookarchive/xcbuild/issues/92#issuecomment-234372926
#
# As a result, when writing swift code, both Foundation and UIKit get imported automatically. See:
# * https://github.com/facebookarchive/xcbuild/issues/92#issuecomment-234400427
#
# But these automatic imports are a problem when strict imports are wanted. See:
# * https://forums.swift.org/t/supporting-strict-imports/42472
#
# So provide here two behaviours:
# * By default, follow xcode and cocoapods and populate the umbrella header with the usual content
# * Optionally, allow the consumers to set generate_default_umbrella_header to False, so the
# generated umbrella header does not contain any imports
generate_default_umbrella_header = kwargs.pop("generate_default_umbrella_header", True)
cc_copts = kwargs.pop("cc_copts", [])
additional_cc_copts = []
swift_copts = kwargs.pop("swift_copts", [])
additional_swift_copts = []
ibtool_copts = kwargs.pop("ibtool_copts", [])
momc_copts = kwargs.pop("momc_copts", [])
mapc_copts = kwargs.pop("mapc_copts", [])
linkopts = kwargs.pop("linkopts", [])
objc_copts = kwargs.pop("objc_copts", [])
additional_objc_copts = []
other_inputs = kwargs.pop("other_inputs", [])
sdk_dylibs = kwargs.pop("sdk_dylibs", [])
sdk_frameworks = kwargs.pop("sdk_frameworks", [])
weak_sdk_frameworks = kwargs.pop("weak_sdk_frameworks", [])
sdk_includes = kwargs.pop("sdk_includes", [])
pch = kwargs.pop("pch", "@build_bazel_rules_ios//rules/library:common.pch")
deps = [] + kwargs.pop("deps", [])
data = kwargs.pop("data", [])
tags = kwargs.pop("tags", [])
tags_manual = tags if "manual" in tags else tags + _MANUAL
platforms = kwargs.pop("platforms", None)
private_deps = [] + kwargs.pop("private_deps", [])
private_dep_names = []
lib_names = []
fetch_default_xcconfig = library_tools["fetch_default_xcconfig"](name, default_xcconfig_name, **kwargs) if default_xcconfig_name else {}
copts_by_build_setting = copts_by_build_setting_with_defaults(xcconfig, fetch_default_xcconfig, xcconfig_by_build_setting)
enable_framework_vfs = kwargs.pop("enable_framework_vfs", False) or namespace_is_module_name
defines = kwargs.pop("defines", [])
testonly = kwargs.pop("testonly", False)
features = kwargs.pop("features", [])
extension_safe = kwargs.pop("extension_safe", None)
# Set extra linkopt for application extension safety
if extension_safe:
linkopts += ["-fapplication-extension"]
objc_copts += ["-fapplication-extension"]
swift_copts += ["-application-extension"]
# Collect the swift_library related kwargs, these are typically only set when provided to allow
# for wider compatibility with rule_swift versions.
swift_kwargs = {arg: kwargs.pop(arg) for arg in _SWIFT_LIBRARY_KWARGS if arg in kwargs}
for (k, v) in {"momc_copts": momc_copts, "mapc_copts": mapc_copts, "ibtool_copts": ibtool_copts}.items():
if v:
fail("Specifying {attr} for {name} is not yet supported. Given: {opts}".format(
attr = k,
name = name,
opts = repr(v),
))
# Generate code for `.intentdefinition` source files and forward the original plist as data
for intent in intent_sources:
intent_name = "%s_%s_gen" % (name, intent)
# Avoid swift_intent_library and objc_intent_library because they wrap the generated code in a new module
#
# If other Swift sources are present, generate Swift intent code, otherwise use Obj-C.
# This mimics the behavior for INTENTS_CODEGEN_LANGUAGE="automatic" in Xcode.
if has_swift_sources:
apple_intent_library(
name = intent_name,
src = intent,
language = "Swift",
tags = _MANUAL,
testonly = testonly,
)
swift_sources.append(intent_name)
data.append(intent)
else:
intent_sources = "%s_srcs" % intent_name
intent_public_header = paths.split_extension(intent)[0]
apple_intent_library(
name = intent_name,
src = intent,
header_name = intent_public_header,
language = "Objective-C",
tags = _MANUAL,
testonly = testonly,
)
objc_hdrs.append(intent_name)
objc_sources.append(intent_name)
data.append(intent)
if linkopts:
linkopts_name = "%s_linkopts" % (name)
# https://docs.bazel.build/versions/master/be/c-cpp.html#cc_library
native.cc_library(
name = linkopts_name,
linkopts = copts_by_build_setting.linkopts + linkopts,
)
private_dep_names.append(linkopts_name)
vendored_deps = []
import_vfsoverlays = []
# There are some frameworks imported with private headers - this is totally
# expected.
for vendored_static_framework in kwargs.pop("vendored_static_frameworks", []):
import_name = "%s-%s-import" % (name, paths.basename(vendored_static_framework))
apple_static_framework_import(
name = import_name,
framework_imports = native.glob(
["%s/**/*" % vendored_static_framework],
exclude = ["**/.DS_Store"],
),
tags = _MANUAL,
)
import_headers = native.glob(
["%s/**/*.h" % vendored_static_framework],
)
import_module_maps = native.glob(
["%s/**/*.modulemap" % vendored_static_framework],
allow_empty = True,
)
import_swiftmodules = native.glob(
["%s/**/*.swiftmodule/*.*" % vendored_static_framework],
allow_empty = True,
)
vfs_root = vendored_static_framework
if len(import_module_maps) > 0:
import_module_map = import_module_maps[0]
else:
import_module_map = None
vfs_imported_framework = _find_imported_framework_name(import_headers)
vfs_framework_name = vfs_imported_framework if vfs_imported_framework else namespace
framework_vfs_overlay(
name = import_name + "_vfs",
framework_name = vfs_framework_name,
modulemap = import_module_map,
swiftmodules = import_swiftmodules,
hdrs = import_headers,
tags = _MANUAL,
testonly = testonly,
extra_search_paths = vfs_root,
)
import_vfsoverlays.append(import_name + "_vfs")
vendored_deps.append(import_name)
for vendored_dynamic_framework in kwargs.pop("vendored_dynamic_frameworks", []):
import_name = "%s-%s-import" % (name, paths.basename(vendored_dynamic_framework))
apple_dynamic_framework_import(
name = import_name,
framework_imports = native.glob(
["%s/**/*" % vendored_dynamic_framework],
exclude = ["**/.DS_Store"],
),
deps = [],
tags = _MANUAL,
)
vendored_deps.append(import_name)
import_headers = native.glob(
["%s/**/*.h" % vendored_dynamic_framework],
)
import_module_maps = native.glob(
["%s/**/*.modulemap" % vendored_dynamic_framework],
allow_empty = True,
)
import_swiftmodules = native.glob(
["%s/**/*.swiftmodule/*.*" % vendored_dynamic_framework],
allow_empty = True,
)
if len(import_module_maps) > 0:
import_module_map = import_module_maps[0]
else:
import_module_map = None
vfs_root = vendored_dynamic_framework
vfs_imported_framework = _find_imported_framework_name(import_headers)
vfs_framework_name = vfs_imported_framework if vfs_imported_framework else namespace
framework_vfs_overlay(
name = import_name + "_vfs",
framework_name = vfs_framework_name,
modulemap = import_module_map,
swiftmodules = import_swiftmodules,
hdrs = import_headers,
tags = _MANUAL,
testonly = testonly,
extra_search_paths = vfs_root,
)
import_vfsoverlays.append(import_name + "_vfs")
for vendored_static_library in kwargs.pop("vendored_static_libraries", []):
import_name = "%s-%s-library-import" % (name, paths.basename(vendored_static_library))
native.objc_import(
name = import_name,
archives = [vendored_static_library],
tags = _MANUAL,
)
vendored_deps.append(import_name)
import_headers = native.glob(
["**/*.h"],
)
import_module_maps = native.glob(
["**/*.modulemap"],
allow_empty = True,
)
import_swiftmodules = native.glob(
["**/*.swiftmodule/*.*"],
allow_empty = True,
)
if len(import_module_maps) > 0:
import_module_map = import_module_maps[0]
else:
import_module_map = None
vfs_imported_framework = _find_imported_framework_name(import_headers)
vfs_framework_name = vfs_imported_framework if vfs_imported_framework else namespace
framework_vfs_overlay(
name = import_name + "_vfs",
framework_name = vfs_framework_name,
modulemap = import_module_map,
swiftmodules = import_swiftmodules,
hdrs = import_headers,
tags = _MANUAL,
testonly = testonly,
)
import_vfsoverlays.append(import_name + "_vfs")
vendored_deps_contains_arm64_sim_slice = {}
for xcframework in kwargs.pop("vendored_xcframeworks", []):
xcframework_name, xcframework_name_vfs = _xcframework(library_name = name, **xcframework)
vendored_deps_contains_arm64_sim_slice[xcframework_name] = _xcframework_contains_arm64_sim_slice(xcframework)
vendored_deps.append(xcframework_name)
import_vfsoverlays.append(xcframework_name_vfs)
# We don't currently support dynamic library
for vendored_dynamic_library in kwargs.pop("vendored_dynamic_libraries", []):
fail("no support for dynamic library: %s" % vendored_dynamic_library)
vendored_deps_non_arm64_sim = [d for d in vendored_deps if not vendored_deps_contains_arm64_sim_slice.get(d, False)]
if vendored_deps_non_arm64_sim:
import_middleman(
name = name + ".import_middleman",
deps = vendored_deps_non_arm64_sim,
tags = ["manual"],
)
deps += select({
"@build_bazel_rules_ios//:arm64_simulator_use_device_deps": [name + ".import_middleman"],
"//conditions:default": vendored_deps_non_arm64_sim,
})
vendored_deps_arm64_sim = [d for d in vendored_deps if vendored_deps_contains_arm64_sim_slice.get(d, False)]
if vendored_deps_arm64_sim:
deps += vendored_deps_arm64_sim
objc_libname = "%s_objc" % name
swift_libname = "%s_swift" % name
cpp_libname = "%s_cpp" % name
framework_vfs_overlay_name = name + "_vfs"
framework_vfs_overlay_name_swift = swift_libname + "_vfs"
# TODO: remove under certian circumstances when framework if set
# Needs to happen before headermaps are made, so the generated umbrella header gets added to those headermaps
has_compile_srcs = (objc_hdrs or objc_private_hdrs or has_swift_sources or objc_sources or cpp_sources)
generate_umbrella_module = (namespace_is_module_name and has_compile_srcs)
if generate_umbrella_module:
if not module_map:
umbrella_header = library_tools["umbrella_header_generator"](
name = name,
generate_default_umbrella_header = generate_default_umbrella_header,
public_headers = objc_hdrs,
module_name = module_name,
)
if umbrella_header:
objc_hdrs.append(umbrella_header)
module_map = library_tools["modulemap_generator"](
name = name,
library_tools = library_tools,
umbrella_header = paths.basename(umbrella_header),
public_headers = objc_hdrs,
private_headers = objc_private_hdrs,
module_name = module_name,
framework = True,
**kwargs
)
if has_swift_sources:
framework_vfs_overlay(
name = framework_vfs_overlay_name_swift,
framework_name = module_name,
modulemap = module_map,
has_swift = has_swift_sources,
private_hdrs = objc_private_hdrs,
hdrs = objc_hdrs,
tags = _MANUAL,
testonly = testonly,
deps = deps + private_deps + private_dep_names + lib_names + import_vfsoverlays,
)
framework_vfs_objc_copts = [
"-ivfsoverlay$(execpath :{})".format(framework_vfs_overlay_name),
"-F{}".format(VFS_OVERLAY_FRAMEWORK_SEARCH_PATH),
]
framework_vfs_swift_copts = []
if has_swift_sources:
framework_vfs_swift_copts = [
"-Xfrontend",
"-vfsoverlay$(execpath :{})".format(framework_vfs_overlay_name_swift),
"-Xfrontend",
"-F{}".format(VFS_OVERLAY_FRAMEWORK_SEARCH_PATH),
"-I{}".format(VFS_OVERLAY_FRAMEWORK_SEARCH_PATH),
"-Xcc",
"-ivfsoverlay$(execpath :{})".format(framework_vfs_overlay_name_swift),
"-Xcc",
"-F{}".format(VFS_OVERLAY_FRAMEWORK_SEARCH_PATH),
]
## BEGIN HMAP
if len(objc_hdrs) > 0:
public_hmap_name = name + "_public_hmap"
# Public hmaps are for vendored static libs to export their header only.
# Other dependencies' headermaps will be generated by li_ios_framework
# rules.
headermap(
name = public_hmap_name,
namespace = namespace,
hdrs = objc_hdrs,
tags = _MANUAL,
)
private_dep_names.append(public_hmap_name)
additional_objc_copts, additional_swift_copts, additional_cc_copts = _append_headermap_copts(public_hmap_name, "-I", additional_objc_copts, additional_swift_copts, additional_cc_copts)
if len(objc_non_exported_hdrs + objc_private_hdrs) > 0:
private_hmap_name = name + "_private_hmap"
headermap(
name = private_hmap_name,
hdrs = objc_non_exported_hdrs + objc_private_hdrs,
tags = _MANUAL,
)
private_dep_names.append(private_hmap_name)
additional_objc_copts, additional_swift_copts, additional_cc_copts = _append_headermap_copts(private_hmap_name, "-I", additional_objc_copts, additional_swift_copts, additional_cc_copts)
## END HMAP
additional_objc_copts += [
"-fmodules",
"-fmodule-name=%s" % module_name,
]
additional_swift_copts += [
"-Xcc",
"-D__SWIFTC__",
"-Xfrontend",
"-no-clang-module-breadcrumbs",
]
swift_version = _canonicalize_swift_version(kwargs.pop("swift_version", None))
if swift_version:
additional_swift_copts += ["-swift-version", swift_version]
if has_swift_sources:
additional_swift_copts += ["-Xcc", "-I."]
swiftc_inputs = other_inputs + objc_hdrs + objc_private_hdrs
if module_map:
# Frameworks find the modulemap file via the framework vfs overlay
if not namespace_is_module_name:
additional_swift_copts += ["-Xcc", "-fmodule-map-file=" + "$(execpath " + module_map + ")"]
additional_swift_copts += select({
"@build_bazel_rules_ios//:swift_disable_import_underlying_module": [],
"//conditions:default": ["-import-underlying-module"] if not feature_names.swift_disable_import_underlying_module in features else [],
})
swiftc_inputs += [module_map]
if swift_objc_bridging_header:
if swift_objc_bridging_header not in objc_hdrs:
swiftc_inputs.append(swift_objc_bridging_header)
additional_swift_copts += [
"-import-objc-header",
"$(execpath :{})".format(swift_objc_bridging_header),
]
generated_swift_header_name = module_name + "-Swift.h"
if module_map:
# Extended modulemap contains the Swift module and its generated header
# It is to be used by the Objective-C part of the library.
extend_modulemap(
name = module_map + ".extended." + name,
destination = "%s.extended.modulemap" % name,
source = module_map,
swift_header = generated_swift_header_name,
module_name = module_name,
tags = _MANUAL,
)
module_map = "%s.extended.modulemap" % name
# Note: this needs to go here, in order to virtualize the extended module
framework_vfs_overlay(
name = framework_vfs_overlay_name,
framework_name = module_name,
has_swift = has_swift_sources,
modulemap = module_map,
private_hdrs = objc_private_hdrs,
hdrs = objc_hdrs,
tags = _MANUAL,
testonly = testonly,
deps = deps + private_deps + private_dep_names + lib_names + import_vfsoverlays,
#enable_framework_vfs = enable_framework_vfs
)
# Generate resource bundles
module_data = library_tools["wrap_resources_in_filegroup"](
name = name + "_wrapped_resources_filegroup",
srcs = data,
testonly = testonly,
)
resource_bundles = library_tools["resource_bundle_generator"](
name = name,
library_tools = library_tools,
resource_bundles = kwargs.pop("resource_bundles", {}),
platforms = platforms,
)
deps += resource_bundles
if has_swift_sources:
# Forward the kwargs and the swift specific kwargs to the swift_library
swift_library_kwargs = dicts.add(kwargs, swift_kwargs)
swift_library(