Rules
j2objc_library
View rule sourcej2objc_library(name, deps, compatible_with, deprecation, distribs, entry_classes, exec_compatible_with, exec_properties, features, jre_deps, restricted_to, tags, target_compatible_with, testonly, toolchains, visibility)
This rule uses J2ObjC to translate Java source files to Objective-C, which then can be used used as dependencies of objc_library and objc_binary rules. Detailed information about J2ObjC itself can be found at the J2ObjC site
Custom J2ObjC transpilation flags can be specified using the build flag
--j2objc_translation_flags
in the command line.
Please note that the translated files included in a j2objc_library target will be compiled using the default compilation configuration, the same configuration as for the sources of an objc_library rule with no compilation options specified in attributes.
Plus, generated code is de-duplicated at target level, not source level. If you have two different Java targets that include the same Java source files, you may see a duplicate symbol error at link time. The correct way to resolve this issue is to move the shared Java source files into a separate common target that can be depended upon.
Arguments
Attributes | |
---|---|
name |
Name; required A unique name for this target. |
deps
|
List of labels; default is j2objc_library , java_library ,
java_import and java_proto_library targets that contain
Java files to be transpiled to Objective-C.
All The J2ObjC translation works differently depending on the type of source Java source
files included in the transitive closure. For each .java source files included in
Users can import the J2ObjC-generated header files in their code. The import paths for
these files are the root-relative path of the original Java artifacts. For example,
If proto_library rules are in the transitive closure of this rule, J2ObjC protos will also
be generated, compiled and linked-in at the binary level. For proto
|
entry_classes
|
List of strings; default is --j2objc_dead_code_removal
is on. The Java classes should be specified in their canonical names as defined by
the Java
Language Specification.
When flag --j2objc_dead_code_removal is specified, the list of entry classes
will be collected transitively and used as entry points to perform dead code analysis.
Unused classes will then be removed from the final ObjC app bundle.
|
jre_deps
|
List of labels; default is j2objc_library rule. Only core JRE functionality is linked by default.
|
objc_import
View rule sourceobjc_import(name, deps, hdrs, alwayslink, archives, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, includes, restricted_to, sdk_dylibs, sdk_frameworks, sdk_includes, tags, target_compatible_with, testonly, textual_hdrs, toolchains, visibility, weak_sdk_frameworks)
This rule encapsulates an already-compiled static library in the form of an
.a
file. It also allows exporting headers and resources using the same
attributes supported by objc_library
.
Arguments
Attributes | |
---|---|
name |
Name; required A unique name for this target. |
deps
|
List of labels; default is |
hdrs
|
List of labels; default is These headers describe the public interface for the library and will be made available for inclusion by sources in this rule or in dependent rules. Headers not meant to be included by a client of this library should be listed in the srcs attribute instead. These will be compiled separately from the source if modules are enabled. |
alwayslink
|
Boolean; default is srcs and non_arc_srcs , even if some contain no
symbols referenced by the binary.
This is useful if your code isn't explicitly called by code in
the binary, e.g., if your code registers to receive some callback
provided by some service.
|
archives
|
List of labels; required The list of.a files provided to Objective-C targets that
depend on this target.
|
includes
|
List of strings; default is #include/#import search paths to add to this target
and all depending targets.
This is to support third party and open-sourced libraries that do not
specify the entire workspace path in their
#import/#include statements.
The paths are interpreted relative to the package directory, and the
genfiles and bin roots (e.g. Unlike COPTS, these flags are added for this rule and every rule that depends on it. (Note: not the rules it depends upon!) Be very careful, since this may have far-reaching effects. When in doubt, add "-iquote" flags to COPTS instead. |
sdk_dylibs
|
List of strings; default is |
sdk_frameworks
|
List of strings; default is When linking a top level Apple binary, all SDK frameworks listed in that binary's transitive dependency graph are linked. |
sdk_includes
|
List of strings; default is #include/#import search paths to add to this target
and all depending targets, where each path is relative to
$(SDKROOT)/usr/include .
|
textual_hdrs
|
List of labels; default is |
weak_sdk_frameworks
|
List of strings; default is |
objc_library
View rule sourceobjc_library(name, deps, srcs, data, hdrs, alwayslink, compatible_with, copts, defines, deprecation, distribs, enable_modules, exec_compatible_with, exec_properties, features, implementation_deps, includes, linkopts, module_map, module_name, non_arc_srcs, pch, restricted_to, sdk_dylibs, sdk_frameworks, sdk_includes, stamp, tags, target_compatible_with, testonly, textual_hdrs, toolchains, visibility, weak_sdk_frameworks)
This rule produces a static library from the given Objective-C source files.
Arguments
Attributes | |
---|---|
name |
Name; required A unique name for this target. |
deps
|
List of labels; default is |
srcs
|
List of labels; default is |
hdrs
|
List of labels; default is These headers describe the public interface for the library and will be made available for inclusion by sources in this rule or in dependent rules. Headers not meant to be included by a client of this library should be listed in the srcs attribute instead. These will be compiled separately from the source if modules are enabled. |
alwayslink
|
Boolean; default is srcs and non_arc_srcs , even if some contain no
symbols referenced by the binary.
This is useful if your code isn't explicitly called by code in
the binary, e.g., if your code registers to receive some callback
provided by some service.
|
copts
|
List of strings; default is Note that for the generated Xcode project, directory paths specified using "-I" flags in copts are parsed out, prepended with "$(WORKSPACE_ROOT)/" if they are relative paths, and added to the header search paths for the associated Xcode target. |
defines
|
List of strings; default is -D flags to pass to the compiler. 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.
Subject to "Make variable" substitution and
Bourne shell tokenization.
|
enable_modules
|
Boolean; default is |
implementation_deps
|
List of labels; default is deps , the headers and include paths of these libraries (and all their
transitive deps) are only used for compilation of this library, and not libraries that
depend on it. Libraries specified with implementation_deps are still linked
in binary targets that depend on this library.
|
includes
|
List of strings; default is #include/#import search paths to add to this target
and all depending targets.
This is to support third party and open-sourced libraries that do not
specify the entire workspace path in their
#import/#include statements.
The paths are interpreted relative to the package directory, and the
genfiles and bin roots (e.g. Unlike COPTS, these flags are added for this rule and every rule that depends on it. (Note: not the rules it depends upon!) Be very careful, since this may have far-reaching effects. When in doubt, add "-iquote" flags to COPTS instead. |
linkopts
|
List of strings; default is |
module_map
|
Label; default is |
module_name
|
String; default is |
non_arc_srcs
|
List of labels; default is |
pch
|
Label; default is |
sdk_dylibs
|
List of strings; default is |
sdk_frameworks
|
List of strings; default is When linking a top level Apple binary, all SDK frameworks listed in that binary's transitive dependency graph are linked. |
sdk_includes
|
List of strings; default is #include/#import search paths to add to this target
and all depending targets, where each path is relative to
$(SDKROOT)/usr/include .
|
stamp
|
Boolean; default is |
textual_hdrs
|
List of labels; default is |
weak_sdk_frameworks
|
List of strings; default is |