annotate libsci/strlcpy.c @ 33:1d0ddf9e6efd

misc: general documentation
author David Demelier <markand@malikania.fr>
date Thu, 04 Aug 2022 16:47:10 +0200
parents lib/strlcpy.c@dd078aea5d02
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
22
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /* $OpenBSD: strlcpy.c,v 1.16 2019/01/25 00:19:25 millert Exp $ */
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
2
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 /*
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 1998, 2015 Todd C. Miller <millert@openbsd.org>
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and distribute this software for any
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #include <sys/types.h>
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
20
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 /*
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 * Copy string src to buffer dst of size dsize. At most dsize-1
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 * chars will be copied. Always NUL terminates (unless dsize == 0).
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 * Returns strlen(src); if retval >= dsize, truncation occurred.
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 */
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 size_t
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 util_strlcpy(char *dst, const char *src, size_t dsize)
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 {
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 const char *osrc = src;
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 size_t nleft = dsize;
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
31
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 /* Copy as many bytes as will fit. */
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 if (nleft != 0) {
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 while (--nleft != 0) {
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 if ((*dst++ = *src++) == '\0')
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 break;
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 }
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 }
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
39
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 /* Not enough room in dst, add NUL and traverse rest of src. */
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 if (nleft == 0) {
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 if (dsize != 0)
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 *dst = '\0'; /* NUL-terminate dst */
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 while (*src++)
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 ;
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 }
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
47
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 return(src - osrc - 1); /* count does not include NUL */
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 }