C++

Rules for generating C++ protobuf and gRPC .cc & .h files and libraries using standard Protocol Buffers and gRPC. Libraries are created with the Bazel native cc_library

Rules

Rule	Description
cpp_proto_compile	Generates C++ protobuf .h & .cc files
cpp_grpc_compile	Generates C++ protobuf and gRPC .h & .cc files
cpp_proto_library	Generates a C++ protobuf library using cc_library, with dependencies linked
cpp_grpc_library	Generates a C++ protobuf and gRPC library using cc_library, with dependencies linked

Installation

The C++ module can be installed by adding the following lines to your MODULE.bazel file, replacing the version number placeholder with the desired version:

bazel_dep(name = "rules_proto_grpc_cpp", version = "<version number here>")
bazel_dep(name = "toolchains_protoc", version = "0.6.1")

# Prevent version skew by matching protoc version to protobuf version, as C++ is the only lang that
# has no cross-version runtime guarantee:
# https://protobuf.dev/support/cross-version-runtime-guarantee/#cpp
protoc = use_extension("@toolchains_protoc//protoc:extensions.bzl", "protoc")
protoc.toolchain(
    google_protobuf = "com_google_protobuf",
    version = "v31.1",
)

cpp_proto_compile

Generates C++ protobuf .h & .cc files

Example

Full example project can be found here

BUILD.bazel

load("@rules_proto_grpc_cpp//:defs.bzl", "cpp_proto_compile")

cpp_proto_compile(
    name = "person_cpp_proto",
    protos = ["@rules_proto_grpc_example_protos//:person_proto"],
)

cpp_proto_compile(
    name = "place_cpp_proto",
    protos = ["@rules_proto_grpc_example_protos//:place_proto"],
)

cpp_proto_compile(
    name = "thing_cpp_proto",
    protos = ["@rules_proto_grpc_example_protos//:thing_proto"],
)

Attributes

Attributes for cpp_proto_compile

Name	Type	Mandatory	Default	Description
protos	label_list	true		List of labels that provide the ProtoInfo provider (such as proto_library from @protobuf)
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 0: Show nothing, 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 command line arguments to pass directly to protoc, not as plugin options
extra_protoc_files	label_list	false	[]	List of labels that provide extra files to be available during protoc execution
output_mode	string	false	PREFIXED	The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes

Plugins

• @rules_proto_grpc_cpp//:proto_plugin

cpp_grpc_compile

Generates C++ protobuf and gRPC .h & .cc files

Example

Full example project can be found here

BUILD.bazel

load("@rules_proto_grpc_cpp//:defs.bzl", "cpp_grpc_compile")

cpp_grpc_compile(
    name = "thing_cpp_grpc",
    protos = ["@rules_proto_grpc_example_protos//:thing_proto"],
)

cpp_grpc_compile(
    name = "greeter_cpp_grpc",
    protos = ["@rules_proto_grpc_example_protos//:greeter_grpc"],
)

Attributes

Attributes for cpp_grpc_compile

Name	Type	Mandatory	Default	Description
protos	label_list	true		List of labels that provide the ProtoInfo provider (such as proto_library from @protobuf)
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 0: Show nothing, 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 command line arguments to pass directly to protoc, not as plugin options
extra_protoc_files	label_list	false	[]	List of labels that provide extra files to be available during protoc execution
output_mode	string	false	PREFIXED	The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes

Plugins

• @rules_proto_grpc_cpp//:proto_plugin

• @rules_proto_grpc_cpp//:grpc_plugin

cpp_proto_library

Generates a C++ protobuf library using cc_library, with dependencies linked

Example

Full example project can be found here

BUILD.bazel

load("@rules_proto_grpc_cpp//:defs.bzl", "cpp_proto_library")

cpp_proto_library(
    name = "person_cpp_proto",
    protos = ["@rules_proto_grpc_example_protos//:person_proto"],
    deps = ["place_cpp_proto"],
)

cpp_proto_library(
    name = "place_cpp_proto",
    protos = ["@rules_proto_grpc_example_protos//:place_proto"],
    deps = ["thing_cpp_proto"],
)

cpp_proto_library(
    name = "thing_cpp_proto",
    protos = ["@rules_proto_grpc_example_protos//:thing_proto"],
)

Attributes

Attributes for cpp_proto_library

Name	Type	Mandatory	Default	Description
protos	label_list	true		List of labels that provide the ProtoInfo provider (such as proto_library from @protobuf)
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 0: Show nothing, 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 command line arguments to pass directly to protoc, not as plugin options
extra_protoc_files	label_list	false	[]	List of labels that provide extra files to be available during protoc execution
output_mode	string	false	PREFIXED	The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes
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.

cpp_grpc_library

Generates a C++ protobuf and gRPC library using cc_library, with dependencies linked

Example

Full example project can be found here

BUILD.bazel

load("@rules_proto_grpc_cpp//:defs.bzl", "cpp_grpc_library")

cpp_grpc_library(
    name = "thing_cpp_grpc",
    protos = ["@rules_proto_grpc_example_protos//:thing_proto"],
)

cpp_grpc_library(
    name = "greeter_cpp_grpc",
    protos = ["@rules_proto_grpc_example_protos//:greeter_grpc"],
    deps = ["thing_cpp_grpc"],
)

Attributes

Attributes for cpp_grpc_library

Name	Type	Mandatory	Default	Description
protos	label_list	true		List of labels that provide the ProtoInfo provider (such as proto_library from @protobuf)
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 0: Show nothing, 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 command line arguments to pass directly to protoc, not as plugin options
extra_protoc_files	label_list	false	[]	List of labels that provide extra files to be available during protoc execution
output_mode	string	false	PREFIXED	The output mode for the target. PREFIXED (the default) will output to a directory named by the target within the current package root, NO_PREFIX will output directly to the current package. Using NO_PREFIX may lead to conflicting writes
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.