Objective-C

Rules for generating Objective-C protobuf and gRPC .m & .h files and libraries using standard Protocol Buffers and gRPC. Libraries are created with the Bazel native objc_library

Rules

Rule

Description

objc_proto_compile

Generates Objective-C protobuf .m & .h files

objc_grpc_compile

Generates Objective-C protobuf and gRPC .m & .h files

objc_proto_library

Generates an Objective-C protobuf library using objc_library

objc_grpc_library

Generates an Objective-C protobuf and gRPC library using objc_library

objc_proto_compile

Generates Objective-C protobuf .m & .h files

Example

Full example project can be found here

WORKSPACE

load("@rules_proto_grpc//objc:repositories.bzl", rules_proto_grpc_objc_repos = "objc_repos")

rules_proto_grpc_objc_repos()

BUILD.bazel

load("@rules_proto_grpc//objc:defs.bzl", "objc_proto_compile")

objc_proto_compile(
    name = "person_objc_proto",
    protos = ["@rules_proto_grpc//example/proto:person_proto"],
)

objc_proto_compile(
    name = "place_objc_proto",
    protos = ["@rules_proto_grpc//example/proto:place_proto"],
)

objc_proto_compile(
    name = "thing_objc_proto",
    protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)

Attributes

Attributes for objc_proto_compile

Name

Type

Mandatory

Default

Description

protos

label_list

true

List of labels that provide the ProtoInfo provider (such as proto_library from rules_proto)

options

string_list_dict

false

[]

Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins

verbose

int

false

0

The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc

prefix_path

string

false

""

Path to prefix to the generated files in the output directory

extra_protoc_args

string_list

false

[]

A list of extra args to pass directly to protoc, not as plugin options

objc_grpc_compile

Generates Objective-C protobuf and gRPC .m & .h files

Example

Full example project can be found here

WORKSPACE

load("@rules_proto_grpc//objc:repositories.bzl", rules_proto_grpc_objc_repos = "objc_repos")

rules_proto_grpc_objc_repos()

load("@com_github_grpc_grpc//bazel:grpc_deps.bzl", "grpc_deps")

grpc_deps()

BUILD.bazel

load("@rules_proto_grpc//objc:defs.bzl", "objc_grpc_compile")

objc_grpc_compile(
    name = "thing_objc_grpc",
    protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)

objc_grpc_compile(
    name = "greeter_objc_grpc",
    protos = ["@rules_proto_grpc//example/proto:greeter_grpc"],
)

Attributes

Attributes for objc_grpc_compile

Name

Type

Mandatory

Default

Description

protos

label_list

true

List of labels that provide the ProtoInfo provider (such as proto_library from rules_proto)

options

string_list_dict

false

[]

Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins

verbose

int

false

0

The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc

prefix_path

string

false

""

Path to prefix to the generated files in the output directory

extra_protoc_args

string_list

false

[]

A list of extra args to pass directly to protoc, not as plugin options

objc_proto_library

Generates an Objective-C protobuf library using objc_library

Example

Full example project can be found here

WORKSPACE

load("@rules_proto_grpc//objc:repositories.bzl", rules_proto_grpc_objc_repos = "objc_repos")

rules_proto_grpc_objc_repos()

BUILD.bazel

load("@rules_proto_grpc//objc:defs.bzl", "objc_proto_library")

objc_proto_library(
    name = "person_objc_proto",
    protos = ["@rules_proto_grpc//example/proto:person_proto"],
    deps = ["place_objc_proto"],
)

objc_proto_library(
    name = "place_objc_proto",
    protos = ["@rules_proto_grpc//example/proto:place_proto"],
    deps = ["thing_objc_proto"],
)

objc_proto_library(
    name = "thing_objc_proto",
    protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)

Attributes

Attributes for objc_proto_library

Name

Type

Mandatory

Default

Description

protos

label_list

true

List of labels that provide the ProtoInfo provider (such as proto_library from rules_proto)

options

string_list_dict

false

[]

Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins

verbose

int

false

0

The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc

prefix_path

string

false

""

Path to prefix to the generated files in the output directory

extra_protoc_args

string_list

false

[]

A list of extra args to pass directly to protoc, not as plugin options

deps

label_list

false

[]

List of labels to pass as deps attr to underlying lang_library rule

alwayslink

bool

false

None

Passed to the alwayslink attribute of cc_library.

copts

string_list

false

None

Passed to the opts attribute of cc_library.

defines

string_list

false

None

Passed to the defines attribute of cc_library.

include_prefix

string

false

None

Passed to the include_prefix attribute of cc_library.

linkopts

string_list

false

None

Passed to the linkopts attribute of cc_library.

linkstatic

bool

false

None

Passed to the linkstatic attribute of cc_library.

local_defines

string_list

false

None

Passed to the local_defines attribute of cc_library.

nocopts

string

false

None

Passed to the nocopts attribute of cc_library.

strip_include_prefix

string

false

None

Passed to the strip_include_prefix attribute of cc_library.

objc_grpc_library

Warning

This rule is experimental. It may not work correctly!

Generates an Objective-C protobuf and gRPC library using objc_library

Example

Full example project can be found here

WORKSPACE

load("@rules_proto_grpc//objc:repositories.bzl", rules_proto_grpc_objc_repos = "objc_repos")

rules_proto_grpc_objc_repos()

load("@com_github_grpc_grpc//bazel:grpc_deps.bzl", "grpc_deps")

grpc_deps()

BUILD.bazel

load("@rules_proto_grpc//objc:defs.bzl", "objc_grpc_library")

objc_grpc_library(
    name = "thing_objc_grpc",
    protos = ["@rules_proto_grpc//example/proto:thing_proto"],
)

objc_grpc_library(
    name = "greeter_objc_grpc",
    protos = ["@rules_proto_grpc//example/proto:greeter_grpc"],
    deps = ["thing_objc_grpc"],
)

Attributes

Attributes for objc_grpc_library

Name

Type

Mandatory

Default

Description

protos

label_list

true

List of labels that provide the ProtoInfo provider (such as proto_library from rules_proto)

options

string_list_dict

false

[]

Extra options to pass to plugins, as a dict of plugin label -> list of strings. The key * can be used exclusively to apply to all plugins

verbose

int

false

0

The verbosity level. Supported values and results are 1: show command, 2: show command and sandbox after running protoc, 3: show command and sandbox before and after running protoc, 4. show env, command, expected outputs and sandbox before and after running protoc

prefix_path

string

false

""

Path to prefix to the generated files in the output directory

extra_protoc_args

string_list

false

[]

A list of extra args to pass directly to protoc, not as plugin options

deps

label_list

false

[]

List of labels to pass as deps attr to underlying lang_library rule

alwayslink

bool

false

None

Passed to the alwayslink attribute of cc_library.

copts

string_list

false

None

Passed to the opts attribute of cc_library.

defines

string_list

false

None

Passed to the defines attribute of cc_library.

include_prefix

string

false

None

Passed to the include_prefix attribute of cc_library.

linkopts

string_list

false

None

Passed to the linkopts attribute of cc_library.

linkstatic

bool

false

None

Passed to the linkstatic attribute of cc_library.

local_defines

string_list

false

None

Passed to the local_defines attribute of cc_library.

nocopts

string

false

None

Passed to the nocopts attribute of cc_library.

strip_include_prefix

string

false

None

Passed to the strip_include_prefix attribute of cc_library.