summaryrefslogtreecommitdiffstats
path: root/libmisc/stpecpy.c
blob: 1f7e1f949095310c0209b3257d2f1c010afe39c0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/*
 * Copyright (c) 2022, Alejandro Colomar <alx.manpages@gmail.com>
 *
 * 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.
 * 3. The name of the copyright holders or contributors may not be used to
 *    endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT
 * HOLDERS 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.
 */

#ident "$Id$"

#include "prototypes.h"


/*
 * ARGUMENTS
 *	dst	Pointer to the first byte of the destination buffer.
 *
 *	src	Pointer to the first byte of the source string.
 *
 *	end	Pointer to one-past-the-end of the 'dst' buffer.
 *
 * DESCRIPTION
 *	This function reads the whole 'str' string, until a NUL
 *	character is found, and copies it (or the part of it that fits)
 *	into 'dst', guaranteeing that the resulting string is
 *	NUL-terminated.
 *
 * RETURN VALUE
 *	This function returns a pointer to the terminating NUL byte in
 *	the 'dst' string.
 *
 * CAVEATS
 *	This function silently truncates the source string if it
 *	doesn't fit in the 'dst'.  This is desirable in many cases, and
 *	simplifies usage.  If this is not wanted, other functions, such
 *	as strlcpy(3bsd) and strlcat(3bsd) may be preferred.
 *
 *	This function requires that the input string is NUL-terminated.
 *	If this cannot be guaranteed, other functions should be used,
 *	such as strscpy().
 *
 *	If the 'dst' buffer is a zero-sized array, that is, if
 *	'dst == end', the behavior is undefined.
 */

char *
stpecpy(char *dst, const char *restrict src, const char *end)
{
	for (/* void */; *src != '\0'; src++) {
		if (dst < end)
			*dst++ = *src;
	}
	if (dst < end)
		*dst = '\0';
	return dst;
}