Index | Thread | Search

From:
Jeremie Courreges-Anglas <jca@wxcvbn.org>
Subject:
Add wcsnlen(3)
To:
tech@openbsd.org
Cc:
fcambus@openbsd.org
Date:
Fri, 12 Jul 2024 12:36:58 +0200

Download raw body.

Thread
  • Jeremie Courreges-Anglas:

    Add wcsnlen(3)

Missing function hit by fcambus@ in a wip port some time ago.  The
implementation is basically wcslen(3) with the added argument.  Shared
lib bump not included, there may be other changes by the end of c2k24.

ok?


Index: string/Makefile.inc
===================================================================
RCS file: /cvs/src/lib/libc/string/Makefile.inc,v
diff -u -p -r1.39 Makefile.inc
--- string/Makefile.inc	5 Sep 2017 03:16:13 -0000	1.39
+++ string/Makefile.inc	19 Apr 2024 07:20:30 -0000
@@ -9,9 +9,9 @@ SRCS+=	explicit_bzero.c memccpy.c memmem
 	strndup.c strnlen.c strsignal.c strtok.c strxfrm.c strxfrm_l.c \
 	timingsafe_bcmp.c timingsafe_memcmp.c \
 	wcscat.c wcschr.c wcscmp.c wcscpy.c wcscspn.c wcslcat.c wcslcpy.c \
-	wcslen.c wcsncat.c wcsncmp.c wcsncpy.c wcspbrk.c wcsrchr.c wcsspn.c \
-	wcsstr.c wcstok.c wcswcs.c wcswidth.c wmemchr.c wmemcmp.c wmemcpy.c \
-	wmemmove.c wmemset.c wcsdup.c wcscasecmp.c wcscasecmp_l.c
+	wcslen.c wcsncat.c wcsncmp.c wcsncpy.c wcsnlen.c wcspbrk.c wcsrchr.c \
+	wcsspn.c wcsstr.c wcstok.c wcswcs.c wcswidth.c wmemchr.c wmemcmp.c \
+	wmemcpy.c wmemmove.c wmemset.c wcsdup.c wcscasecmp.c wcscasecmp_l.c
 
 # machine-dependent net sources
 # ../arch/ARCH/Makefile.inc must include sources for:
Index: string/wcslen.3
===================================================================
RCS file: /cvs/src/lib/libc/string/wcslen.3,v
diff -u -p -r1.3 wcslen.3
--- string/wcslen.3	5 Jun 2013 03:39:23 -0000	1.3
+++ string/wcslen.3	19 Apr 2024 04:28:01 -0000
@@ -35,22 +35,46 @@
 .Dt WCSLEN 3
 .Os
 .Sh NAME
-.Nm wcslen
+.Nm wcslen ,
+.Nm wcsnlen
 .Nd find length of a wide string
 .Sh SYNOPSIS
 .In wchar.h
 .Ft size_t
 .Fn wcslen "const wchar_t *s"
+.Ft size_t
+.Fn wcsnlen "const wchar_t *s" "size_t maxlen"
 .Sh DESCRIPTION
 The
 .Fn wcslen
 function computes the length of the wide string
 .Fa s .
+The
+.Fn wcsnlen
+function computes the length of the wide string
+.Fa s ,
+up to
+.Fa maxlen
+wide characters.
+The
+.Fn wcsnlen
+function will never attempt to address more than
+.Fa maxlen
+wide characters, making it suitable for use with wide character arrays
+that are not guaranteed to be NUL-terminated.
 .Sh RETURN VALUES
 The
 .Fn wcslen
 function returns the number of wide characters that precede the terminating
 null wide character.
+.Pp
+The
+.Fn wcsnlen
+function returns the number of wide characters that precede the terminating
+null wide character
+or
+.Fa maxlen ,
+whichever is smaller.
 .Sh SEE ALSO
 .Xr strlen 3 ,
 .Xr wcswidth 3
@@ -61,6 +85,10 @@ function conforms to
 .St -isoC-99
 and was first introduced in
 .St -isoC-amd1 .
+The
+.Fn wcsnlen
+function conforms to
+.St -p1003.1-2008 .
 .Sh HISTORY
 The
 .Fn wcslen
@@ -68,3 +96,7 @@ function was ported from
 .Nx
 and first appeared in
 .Ox 3.8 .
+The
+.Fn wcsnlen
+function first appeared in
+.Ox 7.6 .
Index: string/wcsnlen.c
===================================================================
RCS file: string/wcsnlen.c
diff -N string/wcsnlen.c
--- /dev/null	1 Jan 1970 00:00:00 -0000
+++ string/wcsnlen.c	19 Apr 2024 09:04:51 -0000
@@ -0,0 +1,45 @@
+/*	$OpenBSD: wcslen.c,v 1.4 2015/09/12 16:23:14 guenther Exp $	*/
+/*	$NetBSD: wcslen.c,v 1.2 2001/01/03 14:29:36 lukem Exp $	*/
+
+/*-
+ * Copyright (c)1999 Citrus Project,
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ *
+ *	citrus Id: wcslen.c,v 1.1 1999/12/29 21:47:45 tshiozak Exp
+ */
+
+#include <wchar.h>
+
+size_t
+wcsnlen(const wchar_t *s, size_t maxlen)
+{
+	const wchar_t *p;
+
+	p = s;
+	while (maxlen-- && *p)
+		p++;
+
+	return p - s;
+}
+
Index: hidden/wchar.h
===================================================================
RCS file: /cvs/src/lib/libc/hidden/wchar.h,v
diff -u -p -r1.4 wchar.h
--- hidden/wchar.h	5 Sep 2017 03:16:13 -0000	1.4
+++ hidden/wchar.h	12 Jul 2024 10:26:28 -0000
@@ -65,6 +65,7 @@ PROTO_NORMAL(wcsncasecmp);
 PROTO_NORMAL(wcsncat);
 PROTO_NORMAL(wcsncmp);
 PROTO_NORMAL(wcsncpy);
+PROTO_DEPRECATED(wcsnlen);
 PROTO_NORMAL(wcsnrtombs);
 PROTO_NORMAL(wcspbrk);
 PROTO_NORMAL(wcsrchr);

-- 
jca