Add new file include/share/safe_str.h.
[platform/upstream/flac.git] / include / share / safe_str.h
1 /* libFLAC - Free Lossless Audio Codec library
2  * Copyright (C) 2013  Xiph.org Foundation
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * - Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * - Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  *
15  * - Neither the name of the Xiph.org Foundation nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 /* Safe string handling functions to replace things like strcpy, strncpy,
33  * strcat, strncat etc.
34  * All of these functions guarantee a correctly NUL terminated string but
35  * the string may be truncated if the destination buffer was too short.
36  */
37
38 #ifndef FLAC__SHARE_SAFE_STR_H
39 #define FLAC__SHARE_SAFE_STR_H
40
41 static inline char *
42 safe_strncat(char *dest, const char *src, size_t dest_size)
43 {
44         char * ret;
45
46         if (dest_size < 1)
47                 return dest;
48
49         ret = strncat(dest, src, dest_size - strlen (dest));
50         dest [dest_size - 1] = 0;
51
52         return ret;
53 }
54
55 static inline char *
56 safe_strncpy(char *dest, const char *src, size_t dest_size)
57 {
58         char * ret;
59
60         if (dest_size < 1)
61                 return dest;
62
63         ret = strncpy(dest, src, dest_size);
64         dest [dest_size - 1] = 0;
65
66         return ret;
67 }
68
69 #endif /* FLAC__SHARE_SAFE_STR_H */