Merge pull request #3438 from xlsynth:meheff/2025-11-27-attribute

PiperOrigin-RevId: 838951951

Author: copybara-github

xls/public/c_api_dslx.cc

@@ -681,6 +681,10 @@ xls_dslx_attribute_argument_kind xls_dslx_attribute_get_argument_kind(
           argument)) {
     return xls_dslx_attribute_argument_kind_int_key_value;
   }
+  if (std::holds_alternative<xls::dslx::Attribute::StringLiteralArgument>(
+          argument)) {
+    return xls_dslx_attribute_argument_kind_string_literal;
+  }
   CHECK(false) << "Unexpected attribute argument kind";
   return xls_dslx_attribute_argument_kind_string;
 }
@@ -695,6 +699,17 @@ char* xls_dslx_attribute_get_string_argument(
   return xls::ToOwnedCString(*value);
 }
 
+char* xls_dslx_attribute_get_string_literal_argument(
+    struct xls_dslx_attribute* attribute, int64_t index) {
+  auto* cpp_attribute = reinterpret_cast<xls::dslx::Attribute*>(attribute);
+  const xls::dslx::Attribute::Argument& argument =
+      cpp_attribute->args().at(index);
+  const xls::dslx::Attribute::StringLiteralArgument* value =
+      std::get_if<xls::dslx::Attribute::StringLiteralArgument>(&argument);
+  CHECK(value != nullptr) << "Attribute argument is not a string literal";
+  return xls::ToOwnedCString(value->text);
+}
+
 char* xls_dslx_attribute_get_key_value_argument_key(
     struct xls_dslx_attribute* attribute, int64_t index) {
   auto* cpp_attribute = reinterpret_cast<xls::dslx::Attribute*>(attribute);

xls/public/c_api_dslx.h

@@ -78,6 +78,7 @@ enum {
   xls_dslx_attribute_argument_kind_string,
   xls_dslx_attribute_argument_kind_string_key_value,
   xls_dslx_attribute_argument_kind_int_key_value,
+  xls_dslx_attribute_argument_kind_string_literal,
 };
 
 // Opaque structs.
@@ -326,6 +327,12 @@ xls_dslx_attribute_argument_kind xls_dslx_attribute_get_argument_kind(
 char* xls_dslx_attribute_get_string_argument(
     struct xls_dslx_attribute* attribute, int64_t index);
 
+// Returns the argument value when the argument kind is
+// `xls_dslx_attribute_argument_kind_string_literal`.
+// Note: return value is owned by the caller, free via `xls_c_str_free`.
+char* xls_dslx_attribute_get_string_literal_argument(
+    struct xls_dslx_attribute* attribute, int64_t index);
+
 // Returns the argument key when the argument kind is a key/value variant.
 // Note: return value is owned by the caller, free via `xls_c_str_free`.
 char* xls_dslx_attribute_get_key_value_argument_key(

xls/public/c_api_symbols.txt

@@ -112,6 +112,7 @@ xls_dslx_attribute_get_key_value_int_argument_value
 xls_dslx_attribute_get_key_value_string_argument_value
 xls_dslx_attribute_get_kind
 xls_dslx_attribute_get_string_argument
+xls_dslx_attribute_get_string_literal_argument
 xls_dslx_attribute_to_string
 xls_dslx_call_graph_free
 xls_dslx_call_graph_get_callee_count

xls/public/c_api_test.cc

@@ -3499,4 +3499,54 @@ fn top(x: u32, y: MyE) -> u32 { x }
   xls_dslx_import_data_free(import_data);
 }
 
+TEST(XlsCApiTest, DslxStringLiteralAttribute) {
+  const char* kDslx = R"DSLX(
+#[dslx_format_disable("fmt-off")]
+fn fmt_fn(x: u32) -> u32 { x }
+)DSLX";
+  const char* additional_search_paths[] = {};
+  std::string dslx_stdlib_path = std::string(xls::kDefaultDslxStdlibPath);
+  xls_dslx_import_data* import_data = xls_dslx_import_data_create(
+      dslx_stdlib_path.c_str(), additional_search_paths, 0);
+  ASSERT_NE(import_data, nullptr);
+  absl::Cleanup free_import_data(
+      [&]() { xls_dslx_import_data_free(import_data); });
+  char* error = nullptr;
+  xls_dslx_typechecked_module* tm = nullptr;
+  ASSERT_TRUE(xls_dslx_parse_and_typecheck(kDslx, "attr_test.x", "attr_test",
+                                           import_data, &error, &tm))
+      << (error ? error : "");
+  absl::Cleanup free_tm([&]() { xls_dslx_typechecked_module_free(tm); });
+  xls_c_str_free(error);
+
+  xls_dslx_module* module = xls_dslx_typechecked_module_get_module(tm);
+  auto find_function = [&](std::string_view target) -> xls_dslx_function* {
+    int64_t member_count = xls_dslx_module_get_member_count(module);
+    for (int64_t i = 0; i < member_count; ++i) {
+      xls_dslx_module_member* member = xls_dslx_module_get_member(module, i);
+      xls_dslx_function* fn = xls_dslx_module_member_get_function(member);
+      if (fn) {
+        char* id = xls_dslx_function_get_identifier(fn);
+        absl::Cleanup free_id([&]() { xls_c_str_free(id); });
+        if (std::string_view(id) == target) return fn;
+      }
+    }
+    return nullptr;
+  };
+
+  xls_dslx_function* fmt_fn = find_function("fmt_fn");
+  ASSERT_NE(fmt_fn, nullptr);
+
+  ASSERT_EQ(xls_dslx_function_get_attribute_count(fmt_fn), 1);
+  xls_dslx_attribute* fmt_attr = xls_dslx_function_get_attribute(fmt_fn, 0);
+  EXPECT_EQ(xls_dslx_attribute_get_kind(fmt_attr),
+            xls_dslx_attribute_kind_dslx_format_disable);
+  ASSERT_EQ(xls_dslx_attribute_get_argument_count(fmt_attr), 1);
+  EXPECT_EQ(xls_dslx_attribute_get_argument_kind(fmt_attr, 0),
+            xls_dslx_attribute_argument_kind_string_literal);
+  char* fmt_arg = xls_dslx_attribute_get_string_literal_argument(fmt_attr, 0);
+  absl::Cleanup free_fmt_arg([&]() { xls_c_str_free(fmt_arg); });
+  EXPECT_EQ(std::string(fmt_arg), "fmt-off");
+}
+
 }  // namespace