Use escaped canonical string from of labels as canonical names

Author: cerisier

zig/private/BUILD.bazel

@@ -16,6 +16,7 @@ bzl_library(
     deps = [
         "//zig/private/common:bazel_builtin",
         "//zig/private/common:data",
+        "//zig/private/common:escape_label",
         "//zig/private/common:filetypes",
         "//zig/private/providers:zig_module_info",
     ],

zig/private/common/BUILD.bazel

@@ -25,6 +25,7 @@ bzl_library(
         ":cdeps",
         ":csrcs",
         ":data",
+        ":escape_label",
         ":filetypes",
         ":linker_script",
         ":location_expansion",
@@ -50,6 +51,7 @@ bzl_library(
         ":bazel_builtin",
         ":cdeps",
         ":csrcs",
+        ":escape_label",
         ":location_expansion",
         ":zig_cache",
         ":zig_lib_dir",
@@ -67,6 +69,12 @@ bzl_library(
     deps = ["@bazel_skylib//lib:paths"],
 )
 
+bzl_library(
+    name = "escape_label",
+    srcs = ["escape_label.bzl"],
+    visibility = ["//zig:__subpackages__"],
+)
+
 bzl_library(
     name = "location_expansion",
     srcs = ["location_expansion.bzl"],
@@ -86,6 +94,7 @@ bzl_library(
     srcs = ["translate_c.bzl"],
     visibility = ["//zig:__subpackages__"],
     deps = [
+        ":escape_label",
         "//zig/private:cc_helper",
         "//zig/private/providers:zig_module_info",
         "@rules_cc//cc:action_names.bzl",

zig/private/common/escape_label.bzl

@@ -0,0 +1,25 @@
+"""Utility function for escaping Bazel labels into valid path components."""
+
+# Taken from https://github.com/bazelbuild/rules_cc/blob/109e43da9b210aa1806ac27bb640d2233c9703ce/cc/private/cc_common.bzl#L681-L701
+
+_PATH_ESCAPE_REPLACEMENTS = {
+    "_": "_U",
+    "/": "_S",
+    "\\": "_B",
+    ":": "_C",
+    "@": "_A",
+}
+
+# buildifier: disable=function-docstring
+def escape_label(*, label):
+    path = label.package + ":" + label.name
+    if label.repo_name:
+        path = label.repo_name + "@" + path
+    result = []
+    for idx in range(len(path)):
+        c = path[idx]
+        result.append(_PATH_ESCAPE_REPLACEMENTS.get(
+            c,
+            c,  # no escaping by default
+        ))
+    return "".join(result)

zig/private/common/translate_c.bzl

@@ -3,6 +3,7 @@
 load("@rules_cc//cc:find_cc_toolchain.bzl", "find_cc_toolchain")
 load("@rules_cc//cc/common:cc_common.bzl", "cc_common")
 load("@rules_cc//cc/common:cc_info.bzl", "CcInfo")
+load("//zig/private/common:escape_label.bzl", "escape_label")
 load("//zig/private/providers:zig_module_info.bzl", "zig_module_info")
 
 def zig_translate_c(*, ctx, name, zigtoolchaininfo, global_args, cc_infos, output_prefix = ""):
@@ -84,7 +85,7 @@ def zig_translate_c(*, ctx, name, zigtoolchaininfo, global_args, cc_infos, outpu
 
     return zig_module_info(
         name = name,
-        canonical_name = "{}/{}".format(str(ctx.label), name),
+        canonical_name = "{}_U{}".format(escape_label(label = ctx.label), name),
         main = zig_out,
         cdeps = [cc_info],
     )

zig/private/common/zig_build.bzl

@@ -14,6 +14,7 @@ load(
 load("//zig/private/common:cdeps.bzl", "zig_cdeps_copts", "zig_cdeps_linker_inputs")
 load("//zig/private/common:csrcs.bzl", "zig_csrcs")
 load("//zig/private/common:data.bzl", "zig_collect_data", "zig_create_runfiles")
+load("//zig/private/common:escape_label.bzl", "escape_label")
 load(
     "//zig/private/common:filetypes.bzl",
     "ZIG_C_SOURCE_EXTENSIONS",
@@ -336,7 +337,7 @@ def zig_build_impl(ctx, *, kind):
     else:
         root_module = zig_module_info(
             name = ctx.attr.name,
-            canonical_name = str(ctx.label),
+            canonical_name = escape_label(label = ctx.label),
             main = ctx.file.main,
             srcs = ctx.files.srcs,
             extra_srcs = ctx.files.extra_srcs,

zig/private/common/zig_docs.bzl

@@ -7,6 +7,7 @@ load(
     "bazel_builtin_module",
 )
 load("//zig/private/common:csrcs.bzl", "zig_csrcs")
+load("//zig/private/common:escape_label.bzl", "escape_label")
 load("//zig/private/common:location_expansion.bzl", "location_expansion")
 load("//zig/private/common:translate_c.bzl", "zig_translate_c")
 load("//zig/private/common:zig_cache.bzl", "zig_cache_output")
@@ -120,7 +121,7 @@ def zig_docs_impl(ctx, *, kind):
     else:
         root_module = zig_module_info(
             name = ctx.attr.name,
-            canonical_name = str(ctx.label),
+            canonical_name = escape_label(label = ctx.label),
             main = ctx.file.main,
             srcs = ctx.files.srcs,
             extra_srcs = ctx.files.extra_srcs,

zig/private/zig_library.bzl

@@ -7,6 +7,7 @@ load(
     BAZEL_BUILTIN_ATTRS = "ATTRS",
 )
 load("//zig/private/common:data.bzl", "zig_collect_data", "zig_create_runfiles")
+load("//zig/private/common:escape_label.bzl", "escape_label")
 load("//zig/private/common:filetypes.bzl", "ZIG_SOURCE_EXTENSIONS")
 load(
     "//zig/private/providers:zig_module_info.bzl",
@@ -112,7 +113,7 @@ def _zig_library_impl(ctx):
 
     module = zig_module_info(
         name = ctx.attr.import_name or ctx.label.name,
-        canonical_name = str(ctx.label),
+        canonical_name = escape_label(label = ctx.label),
         main = ctx.file.main,
         srcs = ctx.files.srcs,
         extra_srcs = ctx.files.extra_srcs,