pw_multibuf/examples/BUILD.bazel

# Copyright 2025 The Pigweed Authors
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may not
# use this file except in compliance with the License. You may obtain a copy of
# the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations under
# the License.

load("@com_google_emboss//:build_defs.bzl", "emboss_cc_library")
load("@rules_cc//cc:cc_library.bzl", "cc_library")
load("@sphinxdocs//sphinxdocs:sphinx_docs_library.bzl", "sphinx_docs_library")
load("//pw_build:compatibility.bzl", "incompatible_with_mcu")
load("//pw_unit_test:pw_cc_test.bzl", "pw_cc_test")

package(default_visibility = ["//pw_multibuf:__subpackages__"])

licenses(["notice"])

cc_library(
    name = "protocol",
    hdrs = ["public/pw_multibuf/examples/protocol.h"],
    strip_include_prefix = "public",
)

emboss_cc_library(
    name = "_emboss_protocol",
    srcs = ["public/pw_multibuf/examples/protocol.emb"],
    enable_enum_traits = False,
    import_dirs = ["public"],
    visibility = ["//visibility:private"],  # Use :emboss_protocol
)

# emboss_cc_library doesn't support includes, so we need to wrap it. We also
# need to disable layering_check since this library isn't what generates the
# headers.
cc_library(
    name = "emboss_protocol",
    includes = ["public"],
    deps = [":_emboss_protocol"],
)

pw_cc_test(
    name = "basic",
    srcs = ["basic.cc"],
    deps = [
        "//pw_allocator",
        "//pw_allocator:testing",
        "//pw_bytes",
        "//pw_multibuf:pw_multibuf.facade",
        "//pw_multibuf/v2",
        "//pw_unit_test",
    ],
)

pw_cc_test(
    name = "iterate",
    srcs = ["iterate.cc"],
    deps = [
        "//pw_allocator",
        "//pw_allocator:testing",
        "//pw_bytes",
        "//pw_checksum",
        "//pw_multibuf:pw_multibuf.facade",
        "//pw_multibuf/v2",
        "//pw_random",
        "//pw_unit_test",
    ],
)

pw_cc_test(
    name = "queue",
    srcs = ["queue.cc"],
    deps = [
        "//pw_allocator",
        "//pw_allocator:testing",
        "//pw_assert:assert",
        "//pw_bytes",
        "//pw_multibuf:pw_multibuf.facade",
        "//pw_multibuf/v2",
        "//pw_unit_test",
    ],
)

pw_cc_test(
    name = "async_queue",
    srcs = ["async_queue.cc"],
    deps = [
        "//pw_allocator",
        "//pw_allocator:testing",
        "//pw_assert:assert",
        "//pw_async2",
        "//pw_async2:basic_dispatcher",
        "//pw_async2:testing",
        "//pw_bytes",
        "//pw_multibuf:pw_multibuf.facade",
        "//pw_multibuf/v2",
        "//pw_unit_test",
    ],
)

pw_cc_test(
    name = "pseudo_encrypt",
    srcs = ["pseudo_encrypt.cc"],
    copts = ["-Wno-deprecated-declarations"],
    deps = [
        ":protocol",
        "//pw_allocator",
        "//pw_allocator:testing",
        "//pw_assert:check",
        "//pw_async2",
        "//pw_async2:basic_dispatcher",
        "//pw_async2:channel",
        "//pw_async2:testing",
        "//pw_bytes",
        "//pw_multibuf:pw_multibuf.facade",
        "//pw_multibuf/v2",
        "//pw_random",
        "//pw_span:cast",
        "//pw_unit_test",
    ],
)

pw_cc_test(
    name = "scatter_gather",
    srcs = ["scatter_gather.cc"],
    deps = [
        "//pw_allocator",
        "//pw_allocator:testing",
        "//pw_bytes",
        "//pw_chrono:system_clock",
        "//pw_containers:dynamic_vector",
        "//pw_i2c:address",
        "//pw_i2c:initiator",
        "//pw_i2c:message",
        "//pw_multibuf:pw_multibuf.facade",
        "//pw_multibuf/v2",
        "//pw_sync:timed_thread_notification",
        "//pw_thread:test_thread_context",
        "//pw_thread:thread",
        "//pw_unit_test",
    ],
)

pw_cc_test(
    name = "transfer",
    srcs = ["transfer.cc"],
    deps = [
        ":protocol",
        "//pw_allocator",
        "//pw_allocator:testing",
        "//pw_assert:check",
        "//pw_async2",
        "//pw_async2:basic_dispatcher",
        "//pw_async2:testing",
        "//pw_bytes",
        "//pw_checksum",
        "//pw_multibuf:pw_multibuf.facade",
        "//pw_multibuf/v2",
        "//pw_status",
        "//pw_unit_test",
    ],
)

pw_cc_test(
    name = "top_down_forward",
    srcs = ["top_down_forward.cc"],
    # The _emboss_protocol headers come in via emboss_protocol as the former
    # does not allow for an "includes" attribute, which violates the layering
    # check. Turn it off locally so we can build anyway.
    features = ["-layering_check"],
    deps = [
        ":emboss_protocol",
        ":protocol",
        "//pw_allocator",
        "//pw_allocator:libc_allocator",
        "//pw_assert:check",
        "//pw_bytes",
        "//pw_hex_dump:log_bytes",
        "//pw_log",
        "//pw_multibuf:pw_multibuf.facade",
        "//pw_multibuf/v2",
        "//pw_span",
    ],
)

sphinx_docs_library(
    name = "docs",
    srcs = [
        "async_queue.cc",
        "basic.cc",
        "iterate.cc",
        "pseudo_encrypt.cc",
        "public/pw_multibuf/examples/protocol.emb",
        "public/pw_multibuf/examples/protocol.h",
        "queue.cc",
        "scatter_gather.cc",
        "top_down_forward.cc",
        "transfer.cc",
    ],
    target_compatible_with = incompatible_with_mcu(),
)