gen_aidl

A gen_aidl() rule is used to generate .java files from .aidl files.

Function Signature

def gen_aidl(
    *,
    name: str,
    default_target_platform: None | str = None,
    target_compatible_with: list[str] = [],
    compatible_with: list[str] = [],
    exec_compatible_with: list[str] = [],
    visibility: list[str] = [],
    within_view: list[str] = ["PUBLIC"],
    metadata: OpaqueMetadata = {},
    tests: list[str] = [],
    modifiers: OpaqueMetadata = [],
    _android_toolchain: str = "gh_facebook_buck2_shims_meta//:android",
    _apple_platforms: dict[str, str] = {},
    _exec_os_type: str = "prelude//os_lookup/targets:os_lookup",
    _java_toolchain: str = "gh_facebook_buck2_shims_meta//:java_for_android",
    aidl: str,
    aidl_srcs: list[str] = [],
    contacts: list[str] = [],
    default_host_platform: None | str = None,
    deps: list[str] = [],
    import_path: str = "",
    import_paths: list[str] = [],
    labels: list[str] = [],
    licenses: list[str] = [],
) -> None

Parameters

name: (required)

name of the target
default_target_platform: (defaults to: None)

specifies the default target platform, used when no platforms are specified on the command line
target_compatible_with: (defaults to: [])

a list of constraints that are required to be satisfied for this target to be compatible with a configuration
compatible_with: (defaults to: [])

a list of constraints that are required to be satisfied for this target to be compatible with a configuration
exec_compatible_with: (defaults to: [])

a list of constraints that are required to be satisfied for this target to be compatible with an execution platform
visibility: (defaults to: [])

a list of visibility patterns restricting what targets can depend on this one
within_view: (defaults to: ["PUBLIC"])

a list of visibility patterns restricting what this target can depend on
metadata: (defaults to: {})

a key-value map of metadata associated with this target
tests: (defaults to: [])

a list of targets that provide tests for this one
modifiers: (defaults to: [])

an array of modifiers associated with this target
aidl: (required)

The path to an .aidl file to convert to a .java file.
aidl_srcs: (defaults to: [])

Path to .aidl files the target aidl file imports.
contacts: (defaults to: [])

A list of organizational contacts for this rule. These could be individuals who you would contact in the event of a failure or other issue with the rule.
```
contacts = [ 'Joe Sixpack', 'Erika Mustermann' ]
```
deps: (defaults to: [])

A list of rules that must be built before this rule.
import_path: (defaults to: "")

The search path for import statements for the aidl command. (This is the -I argument when invoking aidl from the command line. For many apps it will be the base dir where all aidl files are, with project root as its parent, e.g. app/src/main/aidl.). This is the same as the path to the aidl file relative to what would be returned from root.
labels: (defaults to: [])

Set of arbitrary strings which allow you to annotate a build rule with tags that can be searched for over an entire dependency tree using buck query().
licenses: (defaults to: [])

Set of license files for this library. To get the list of license files for a given build rule and all of its dependencies, you can use buck query

Examples

android_library(
  name = 'lib',
  srcs = glob(['**/*.java']) + [':aidl'],
  manifest = '//res/org/opencv:manifest',
  deps = [
    '//res/org/opencv:res',
  ],
  visibility = [ 'PUBLIC' ],
)

gen_aidl(
    name = 'aidl',
    aidl = 'engine/OpenCVEngineInterface.aidl',
    import_path = 'java/',
)

Function Signature​

Parameters​

Examples​

Function Signature

Parameters

Examples