[libc] wcscat implementation

[sribee8]

Implemented wcscat and tests.

[llvmbot]

@llvm/pr-subscribers-libc

Author: None (sribee8)

Changes

Implemented wcscat and tests.

---

Full diff: https://github.com/llvm/llvm-project/pull/142243.diff

7 Files Affected:

• (modified) libc/config/linux/x86_64/entrypoints.txt (+1)
• (modified) libc/include/wchar.yaml (+7)
• (modified) libc/src/wchar/CMakeLists.txt (+12)
• (added) libc/src/wchar/wcscat.cpp (+29)
• (added) libc/src/wchar/wcscat.h (+21)
• (modified) libc/test/src/wchar/CMakeLists.txt (+10)
• (added) libc/test/src/wchar/wcscat_test.cpp (+47)

diff --git a/libc/config/linux/x86_64/entrypoints.txt b/libc/config/linux/x86_64/entrypoints.txt
index 7ddeb4d31b466..cb84ba9888bc9 100644
--- a/libc/config/linux/x86_64/entrypoints.txt
+++ b/libc/config/linux/x86_64/entrypoints.txt
@@ -370,6 +370,7 @@ set(TARGET_LIBC_ENTRYPOINTS
     libc.src.wchar.wcsspn
     libc.src.wchar.wmemcmp
     libc.src.wchar.wmemcpy
+    libc.src.wchar.wcscat
 
     # sys/uio.h entrypoints
     libc.src.sys.uio.writev
diff --git a/libc/include/wchar.yaml b/libc/include/wchar.yaml
index bfd9a10342019..28ca540ad75bc 100644
--- a/libc/include/wchar.yaml
+++ b/libc/include/wchar.yaml
@@ -72,3 +72,10 @@ functions:
       - type: __restrict wchar_t *
       - type: const __restrict wchar_t *
       - type: size_t
+  - name: wcscat
+    standards:
+      - stdc
+    return_type: wchar_t *
+    arguments: 
+      - type: __restrict wchar_t *
+      - type: const __restrict wchar_t *
diff --git a/libc/src/wchar/CMakeLists.txt b/libc/src/wchar/CMakeLists.txt
index 9db121762348b..616ccdbc130d5 100644
--- a/libc/src/wchar/CMakeLists.txt
+++ b/libc/src/wchar/CMakeLists.txt
@@ -104,3 +104,15 @@ add_entrypoint_object(
     libc.hdr.wchar_macros
     libc.src.__support.wctype_utils
 )
+
+add_entrypoint_object(
+  wcscat
+  SRCS
+    wcscat.cpp
+  HDRS
+    wcscat.h
+  DEPENDS
+    libc.hdr.types.size_t
+    libc.hdr.wchar_macros
+    libc.src.string.string_utils
+)
diff --git a/libc/src/wchar/wcscat.cpp b/libc/src/wchar/wcscat.cpp
new file mode 100644
index 0000000000000..efdc5012701ff
--- /dev/null
+++ b/libc/src/wchar/wcscat.cpp
@@ -0,0 +1,29 @@
+//===-- Implementation of wcscat ------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "src/wchar/wcscat.h"
+
+#include "hdr/types/size_t.h"
+#include "hdr/types/wchar_t.h"
+#include "src/__support/common.h"
+#include "src/__support/macros/config.h"
+#include "src/string/string_utils.h"
+
+namespace LIBC_NAMESPACE_DECL {
+
+LLVM_LIBC_FUNCTION(wchar_t *, wcscat,
+                   (wchar_t *__restrict s1, const wchar_t *__restrict s2)) {
+  size_t size_1 = internal::string_length(s1);
+  size_t size_2 = internal::string_length(s2);
+  for (size_t i = 0; i <= size_2; i++) {
+    s1[size_1 + i] = s2[i];
+  }
+  return s1;
+}
+
+} // namespace LIBC_NAMESPACE_DECL
diff --git a/libc/src/wchar/wcscat.h b/libc/src/wchar/wcscat.h
new file mode 100644
index 0000000000000..b0b4455983b4e
--- /dev/null
+++ b/libc/src/wchar/wcscat.h
@@ -0,0 +1,21 @@
+//===-- Implementation header for wcscat ----------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#ifndef LLVM_LIBC_SRC_WCHAR_WCSCAT_H
+#define LLVM_LIBC_SRC_WCHAR_WCSCAT_H
+
+#include "hdr/types/wchar_t.h"
+#include "src/__support/macros/config.h"
+
+namespace LIBC_NAMESPACE_DECL {
+
+wchar_t *wcscat(wchar_t *__restrict s1, const wchar_t *__restrict s2);
+
+} // namespace LIBC_NAMESPACE_DECL
+
+#endif // LLVM_LIBC_SRC_WCHAR_WCSCAT_H
diff --git a/libc/test/src/wchar/CMakeLists.txt b/libc/test/src/wchar/CMakeLists.txt
index 9bc230e0bddf3..a7c922cd3e8cf 100644
--- a/libc/test/src/wchar/CMakeLists.txt
+++ b/libc/test/src/wchar/CMakeLists.txt
@@ -94,3 +94,13 @@ add_libc_test(
   DEPENDS
     libc.src.wchar.wmemcpy
 )
+
+add_libc_test(
+  wcscat_test
+  SUITE
+    libc_wchar_unittests
+  SRCS
+    wcscat_test.cpp
+  DEPENDS
+    libc.src.wchar.wcscat
+)
diff --git a/libc/test/src/wchar/wcscat_test.cpp b/libc/test/src/wchar/wcscat_test.cpp
new file mode 100644
index 0000000000000..e91f79613ca9c
--- /dev/null
+++ b/libc/test/src/wchar/wcscat_test.cpp
@@ -0,0 +1,47 @@
+//===-- Unittests for wcscat ---------------------------------------------===//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+#include "hdr/types/wchar_t.h"
+#include "src/wchar/wcscat.h"
+#include "test/UnitTest/Test.h"
+
+TEST(LlvmLibcWCSCatTest, EmptyDest) {
+  // Dest should be fully replaced with src.
+  wchar_t dest[4] = {L'\0'};
+  const wchar_t *src = L"abc";
+  LIBC_NAMESPACE::wcscat(dest, src);
+  ASSERT_TRUE(dest[0] == L'a');
+  ASSERT_TRUE(dest[1] == L'b');
+  ASSERT_TRUE(dest[2] == L'c');
+  ASSERT_TRUE(dest[3] == L'\0');
+}
+
+TEST(LlvmLibcWCSCatTest, NonEmptyDest) {
+  // Src should be appended on to dest.
+  wchar_t dest[7] = {L'x', L'y', L'z', L'\0'};
+  const wchar_t *src = L"abc";
+  LIBC_NAMESPACE::wcscat(dest, src);
+  ASSERT_TRUE(dest[0] == L'x');
+  ASSERT_TRUE(dest[1] == L'y');
+  ASSERT_TRUE(dest[2] == L'z');
+  ASSERT_TRUE(dest[3] == L'a');
+  ASSERT_TRUE(dest[4] == L'b');
+  ASSERT_TRUE(dest[5] == L'c');
+  ASSERT_TRUE(dest[6] == L'\0');
+}
+
+TEST(LlvmLibcWCSCatTest, EmptySrc) {
+  // Dest should remain intact.
+  wchar_t dest[4] = {L'x', L'y', L'z', L'\0'};
+  const wchar_t *src = L"";
+  LIBC_NAMESPACE::wcscat(dest, src);
+  ASSERT_TRUE(dest[0] == L'x');
+  ASSERT_TRUE(dest[1] == L'y');
+  ASSERT_TRUE(dest[2] == L'z');
+  ASSERT_TRUE(dest[3] == L'\0');
+}

[michaelrj-google]

This looks like it will work, but I think it can be a little cleaner

[michaelrj-google]

LGTM