Objective-C 规则

报告问题 查看源代码 每夜 build · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

规则

j2objc_library

查看规则源代码
j2objc_library(name, deps, compatible_with, deprecation, distribs, entry_classes, features, jre_deps, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)

此规则使用 J2ObjC 将 Java 源文件转换为 Objective-C,然后可将其用作 objc_library 和 objc_binary 规则的依赖项。如需详细了解 J2ObjC 本身,请访问 J2ObjC 网站

您可以在命令行中使用 build 标志 --j2objc_translation_flags 指定自定义 J2ObjC 转译标志。

请注意,包含在 j2objc_library 目标中的已翻译文件将使用默认编译配置进行编译,该配置与未在属性中指定编译选项的 objc_library 规则来源的配置相同。

此外,系统会在目标级别(而不是源代码级别)对生成的代码进行去重。如果您有两个包含相同 Java 源文件的不同 Java 目标,则可能会在链接时看到重复符号错误。解决此问题的正确方法是将共享 Java 源文件移动到可以依赖的单独公共目标中。

参数

属性
name

名称(必需)

此目标的唯一名称。

deps

标签列表;默认值为 []

j2objc_libraryjava_libraryjava_importjava_proto_library 目标的列表,其中包含要转译为 Objective-C 的 Java 文件。

所有可通过 exportsdepsruntime_deps 传递到达的 java_libraryjava_import 目标都将被转换和编译,包括由 Java 注解处理生成的文件。不支持未指定 srcjar 的 code>java_import 目标。

J2ObjC 转换的工作方式因传递闭包中包含的源 Java 源文件的类型而异。对于 java_librarysrcs 中包含的每个 .java 源文件,系统都会生成一个相应的 .h 和 .m 源文件。对于 java_librarysrcsjava_importsrcjar 中包含的每个源 jar,系统都会生成一个包含该 jar 的所有代码的相应 .h 和 .m 源文件。

用户可以在其代码中导入 J2ObjC 生成的头文件。这些文件的导入路径是原始 Java 工件的相对于根目录的路径。例如,//some/package/foo.java 的导入路径为 some/package/foo.h//some/package/bar.srcjar 的导入路径为 some/package/bar.h

如果 proto_library 规则在此规则的传递闭包中,系统还会在二进制级生成、编译和链接 J2ObjC proto。对于 proto //some/proto/foo.proto,用户可以使用导入路径 some/proto/foo.j2objc.pb.h 引用生成的代码。

entry_classes

字符串列表;默认值为 []

用户 ObjC 代码将直接引用其翻译的 ObjC 对等项的 Java 类的列表。如果 --j2objc_dead_code_removal 标志处于启用状态,则此属性为必需属性。Java 类应在其规范名称(如 Java 语言规范中所定义)中指定。 如果指定了 --j2objc_dead_code_removal 标志,系统将以传递方式收集条目类列表,并将其用作入口点来执行无状态代码分析。 然后,未使用的类将从最终的 ObjC app bundle 中移除。
jre_deps

标签列表;默认值为 []

j2objc_library 规则转换的所有 Java 代码所需的其他 JRE 模拟库的列表。默认情况下,系统只会关联核心 JRE 功能。

objc_import

查看规则源代码
objc_import(name, deps, hdrs, alwayslink, archives, compatible_with, deprecation, distribs, features, includes, licenses, restricted_to, sdk_dylibs, sdk_frameworks, sdk_includes, tags, target_compatible_with, testonly, textual_hdrs, visibility, weak_sdk_frameworks)

此规则以 .a 文件的形式封装已编译的静态库。它还允许使用 objc_library 支持的相同属性导出头文件和资源。

参数

属性
name

名称(必需)

此目标的唯一名称。

deps

标签列表;默认值为 []

此目标依赖的目标列表。
hdrs

标签列表;默认值为 []

此库发布的 C、C++、Objective-C 和 Objective-C++ 头文件列表,以供依赖项规则中的源文件包含。

这些标头描述了库的公共接口,并可供来源添加到此规则或依赖规则中。不应由此库的客户端包含的头文件应改为列在 srcs 属性中。

如果启用了模块,这些模块将与源代码文件分开编译。

布尔值;默认值为 False

如果为 1,则(直接或间接)依赖于此库的任何软件包或二进制文件都将链接到 srcsnon_arc_srcs 中列出的文件的所有对象文件中,即使其中一些文件不包含二进制文件引用的符号也是如此。 如果您的代码没有被二进制文件中的代码明确调用(例如,您的代码注册以接收某项服务提供的某种回调),那么这种做法非常有用。
archives

标签列表(必需)

提供给依赖于此目标的 Objective-C 目标的 .a 文件的列表。
includes

字符串列表;默认值为 []

要添加到此目标和所有依赖目标的 #include/#import 搜索路径的列表。 这是为了支持未在 #import/#include 语句中指定完整工作区路径的第三方和开源库。

这些路径相对于软件包目录进行解释,并且除了实际的客户端根目录之外,还包含 genfile 和 bin 根目录(例如 blaze-genfiles/pkg/includedirblaze-out/pkg/includedir)。

COPTS 不同,这些标志会为此规则以及依赖于它的每个规则添加。(注意:不是它依赖的规则!)请务必谨慎,因为这可能会产生深远影响。如果不确定,请改为向 COPTS 添加“-iquote”标志。

sdk_dylibs

字符串列表;默认值为 []

要与之建立链接的 SDK .dylib 库的名称。例如“libz”或“libarchive”。 如果二进制文件的依赖项树中包含任何 C++ 或 Objective-C++ 源代码,系统会自动添加“libc++”。链接二进制文件时,将使用该二进制文件的传递依赖关系图中指定的所有库。
sdk_frameworks

字符串列表;默认值为 []

要关联的 SDK 框架的名称(例如“AddressBook”“QuartzCore”)。在面向 iOS、tvOS、visionOS 和 watchOS 平台进行构建时,始终包含“UIKit”和“Foundation”。对于 macOS,始终仅包含“基础”。

关联顶级 Apple 二进制文件时,系统会关联该二进制文件的传递依赖关系图中列出的所有 SDK 框架。

sdk_includes

字符串列表;默认值为 []

要添加到此目标和所有依赖目标的 #include/#import 搜索路径的列表,其中每个路径都相对于 $(SDKROOT)/usr/include
textual_hdrs

标签列表;默认值为 []

此规则中的源文件或此库的用户作为头文件包含的 C、C++、Objective-C 和 Objective-C++ 文件的列表。与 hdr 不同,这些文件不会与源代码分开编译。
weak_sdk_frameworks

字符串列表;默认值为 []

要与之建立弱关联的 SDK 框架的名称。例如,“MediaAccessibility”。 与常规关联的 SDK 框架不同,如果弱关联框架中的符号在运行时不存在,则不会导致错误。

objc_library

查看规则来源
objc_library(name, deps, srcs, data, hdrs, alwayslink, compatible_with, copts, defines, deprecation, distribs, enable_modules, exec_compatible_with, exec_properties, features, implementation_deps, includes, licenses, linkopts, module_map, module_name, non_arc_srcs, pch, restricted_to, sdk_dylibs, sdk_frameworks, sdk_includes, tags, target_compatible_with, testonly, textual_hdrs, toolchains, visibility, weak_sdk_frameworks)

此规则会根据给定的 Objective-C 源文件生成静态库。

参数

属性
name

名称(必需)

此目标的唯一名称。

deps

标签列表;默认值为 []

要关联在一起以形成最终软件包的目标的列表。
srcs

标签列表;默认值为 []

用于处理的 C、C++、Objective-C 和 Objective-C++ 源文件和头文件和/或(`.s`、`.S` 或 `.asm`)汇编源文件的列表。 这些是您已签入的文件以及所有生成的文件。 源文件会使用 Clang 编译为 .o 文件。头文件可由任何来源或头文件在此目标的 srcs 属性中包含/导入,但不能通过 hdr 或任何依赖于此规则的目标中的头文件包含/导入。 此外,可将预编译的 .o 文件作为 src 提供。请务必确保所提供的 .o 文件的架构与 build 的架构保持一致,以免出现缺少符号链接器错误。
hdrs

标签列表;默认值为 []

此库发布的 C、C++、Objective-C 和 Objective-C++ 头文件的列表,这些文件将包含在依赖规则中。

这些标头描述了库的公共接口,并可供来源添加到此规则或依赖规则中。不应由此库的客户端包含的头文件应改为列在 srcs 属性中。

如果启用了模块,这些模块将与源代码文件分开编译。

布尔值;默认值为 False

如果为 1,则(直接或间接)依赖于此库的任何软件包或二进制文件都将链接到 srcsnon_arc_srcs 中列出的文件的所有对象文件中,即使其中一些文件不包含二进制文件引用的符号也是如此。 如果二进制文件中的代码未明确调用您的代码(例如,您的代码注册接收某些服务提供的回调),此方法会很有用。
copts

字符串列表;默认值为 []

要传递给编译器的额外标记。 会受到 “Make 变量”替换和 Bourne shell 令牌化的影响。 这些标志仅适用于此目标,而不适用于它依赖的目标或依赖于它的目标。

请注意,对于生成的 Xcode 项目,系统会解析在 copts 中使用“-I”标志指定的目录路径,如果这些路径是相对路径,则将带有“$(WORKSPACE_ROOT)/”前缀,并会添加到关联 Xcode 目标的标头搜索路径中。

defines

字符串列表;默认值为 []

要传递给编译器的额外 -D 标志。它们应采用 KEY=VALUE 格式或直接采用 KEY 格式,并且不仅会传递到此目标的编译器(与 copts 一样),还会传递到此目标的所有 objc_ 依赖项。 会受到 “Make 变量”替换和 Bourne shell 令牌化的影响。
enable_modules

布尔值;默认值为 False

启用 Clang 模块支持(通过 -fmodules)。 将此值设为 1 后,您就可以 @import 系统头文件和其他目标: @import UIKit; @import path_to_package_target;
implementation_deps

标签列表;默认值为 []

库目标依赖的其他库的列表。与 deps 不同,这些库(及其所有传递依赖项)的头文件和包含路径仅用于编译此库,而非依赖于此库的库。使用 implementation_deps 指定的库仍会在依赖于此库的二进制文件目标中链接。
includes

字符串列表;默认值为 []

要添加到此目标和所有依赖目标的 #include/#import 搜索路径的列表。 这是为了支持未在 #import/#include 语句中指定完整工作区路径的第三方和开源库。

这些路径相对于软件包目录进行解释,并且除了实际的客户端根目录之外,还包含 genfile 和 bin 根目录(例如 blaze-genfiles/pkg/includedirblaze-out/pkg/includedir)。

COPTS 不同,系统会为此规则以及依赖于它的每条规则添加这些标记。(注意:并非其所依赖的规则!)请务必小心,因为这可能会造成深远的影响。如果不确定,请改为向 COPTS 添加“-iquote”标志。

linkopts

字符串列表;默认值为 []

要传递给链接器的额外标志。
module_map

标签;默认值为 None

此目标的自定义 Clang 模块映射。不建议使用自定义模块映射。大多数用户都应使用由 Bazel 生成的模块映射。 如果指定,Bazel 不会为此目标生成模块映射,但会将提供的模块映射传递给编译器。
module_name

字符串;默认值为 ""

设置此目标的模块名称。默认情况下,模块名称是目标路径,其中所有特殊符号都替换为 _,例如,//foo/baz:bar 可以导入为 foo_baz_bar。
non_arc_srcs

标签列表;默认值为 []

为创建不使用 ARC 的库目标而处理的 Objective-C 文件列表。 此属性中的文件的处理方式与 srcs 属性中的文件非常相似,但在编译时不启用 ARC。
pch

标签;默认值为 None

要附加到正在编译的每个源文件(包括 arc 和非 arc)的头文件。 不建议在 BUILD 文件中使用 pch 文件,应将其视为已弃用。由于 pch 文件实际上并不是预编译的,因此这并不是构建速度的增强功能,而只是一个全局依赖项。从构建效率的角度来看,您实际上做得更好,那就是直接在源代码中在需要时添加所需的内容。
sdk_dylibs

字符串列表;默认值为 []

要与之建立链接的 SDK .dylib 库的名称。例如“libz”或“libarchive”。 如果二进制文件的依赖项树中包含任何 C++ 或 Objective-C++ 源代码,系统会自动添加“libc++”。链接二进制文件时,将使用该二进制文件的传递依赖关系图中指定的所有库。
sdk_frameworks

字符串列表;默认值为 []

要关联的 SDK 框架的名称(例如“AddressBook”“QuartzCore”)。在面向 iOS、tvOS、visionOS 和 watchOS 平台进行构建时,始终包含“UIKit”和“Foundation”。对于 macOS,始终仅包含“基础”。

关联顶级 Apple 二进制文件时,系统会关联该二进制文件的传递依赖关系图中列出的所有 SDK 框架。

sdk_includes

字符串列表;默认值为 []

要添加到此目标和所有依赖目标的 #include/#import 搜索路径的列表,其中每个路径都相对于 $(SDKROOT)/usr/include
textual_hdrs

标签列表;默认值为 []

由此规则中的源文件或此库的用户作为头文件添加的 C、C++、Objective-C 和 Objective-C++ 文件的列表。与 hdr 不同,这些文件不会与源代码分开编译。
weak_sdk_frameworks

字符串列表;默认值为 []

要与之建立弱关联的 SDK 框架的名称。例如,“MediaAccessibility”。 与常规关联的 SDK 框架不同,如果弱关联框架中的符号在运行时不存在,则不会导致错误。

available_xcodes

查看规则源代码
available_xcodes(name, default, deprecation, distribs, features, licenses, tags, testonly, versions, visibility)

xcode_config 规则实例可以依赖此规则的两个目标来指示远程和本地可用的 Xcode 版本。这允许从集合可用的 Xcode 中选择官方 XCode 版本。

参数

属性
name

名称;必需

此目标的唯一名称。

default

标签不可配置;必需

此平台的默认 Xcode 版本。
versions

标签列表;不可配置;默认值为 []

此平台上提供的 Xcode 版本。

xcode_config

查看规则源代码
xcode_config(name, default, deprecation, distribs, features, licenses, local_versions, remote_versions, tags, testonly, versions, visibility)

--xcode_version_config build 标志可以引用此规则的单个目标,以将 --xcode_version 标志转换为接受的官方 xcode 版本。这样,您就可以从多个已注册的别名中选择官方 Xcode 版本。

参数

属性
name

名称(必需)

此目标的唯一名称。

default

标签不可配置;默认值为 None

要使用的默认官方 Xcode 版本。 如果未指定 xcode_version build 标志,则使用所提供的 xcode_version 目标指定的版本。如果设置了任何 versions,则此字段为必填字段。如果设置了 remote_versionslocal_versions,则无法设置此字段。
local_versions

标签不可配置;默认值为 None

本地可用的 xcode_version 目标。 这些变量与 local_versions 一起使用,用于选择共同可用的版本。如果设置了 versions,则无法设置此字段。
remote_versions

标签不可配置;默认值为 None

可远程访问的 xcode_version 目标。 这些变量与 remote_versions 一起使用,用于选择共同可用的版本。如果设置了 versions,则无法设置此字段。
versions

标签列表;不可配置;默认值为 []

可接受的 xcode_version 目标。 如果 xcode_version build 标志的值与给定 xcode_version 目标的别名或版本号之一匹配,则系统将使用匹配的目标。如果设置了 remote_versionslocal_versions,则不得设置此值。

xcode_version

查看规则源代码
xcode_version(name, default_ios_sdk_version, default_macos_sdk_version, default_tvos_sdk_version, default_visionos_sdk_version, default_watchos_sdk_version, deprecation, distribs, features, licenses, tags, testonly, version, visibility)

表示具有该 Xcode 版本可接受的别名的单个官方 Xcode 版本。请参阅 xcode_config 规则。

参数

属性
name

名称;必需

此目标的唯一名称。

default_ios_sdk_version

字符串;不可配置;默认值为 ""

使用此版本的 Xcode 时默认使用的 iOS SDK 版本。ios_sdk_version 构建标志将替换此处指定的值。
default_macos_sdk_version

字符串;不可配置;默认值为 ""

使用此版本 Xcode 时默认使用的 macosx SDK 版本。 macos_sdk_version 构建标志将替换此处指定的值。
default_tvos_sdk_version

字符串;不可配置;默认值为 ""

使用此版本 Xcode 时默认使用的 tvOS SDK 版本。 tvos_sdk_version build 标志将替换此处指定的值。
default_visionos_sdk_version

字符串;不可配置;默认值为 ""

使用此版本 Xcode 时默认使用的 VisionOS SDK 版本。 visionos_sdk_version build 标志将替换此处指定的值。
default_watchos_sdk_version

字符串;不可配置;默认值为 ""

使用此版本的 Xcode 时,默认使用的 watchos SDK 版本。watchos_sdk_version 构建标志将替换此处指定的值。
version

字符串;不可配置;必需

Xcode 版本的官方版本号。