ncurses 6.0 - patch 20160910
[ncurses.git] / include / nc_string.h
1 /****************************************************************************
2  * Copyright (c) 2012-2013,2016 Free Software Foundation, Inc.              *
3  *                                                                          *
4  * Permission is hereby granted, free of charge, to any person obtaining a  *
5  * copy of this software and associated documentation files (the            *
6  * "Software"), to deal in the Software without restriction, including      *
7  * without limitation the rights to use, copy, modify, merge, publish,      *
8  * distribute, distribute with modifications, sublicense, and/or sell       *
9  * copies of the Software, and to permit persons to whom the Software is    *
10  * furnished to do so, subject to the following conditions:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22  *                                                                          *
23  * Except as contained in this notice, the name(s) of the above copyright   *
24  * holders shall not be used in advertising or otherwise to promote the     *
25  * sale, use or other dealings in this Software without prior written       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
29 /****************************************************************************
30  *  Author: Thomas E. Dickey                        2012                    *
31  ****************************************************************************/
32
33 #ifndef STRING_HACKS_H
34 #define STRING_HACKS_H 1
35
36 #include <ncurses_cfg.h>
37
38 #if HAVE_BSD_STRING_H
39 #include <bsd/string.h>
40 #endif
41
42 /*
43  * $Id: nc_string.h,v 1.7 2016/09/10 19:57:15 tom Exp $
44  *
45  * String-hacks.  Use these macros to stifle warnings on (presumably) correct
46  * uses of strcat, strcpy and sprintf.
47  *
48  * By the way -
49  * A fundamental limitation of the interfaces (and frequent issue in bug
50  * reports using these functions) is that sizes are passed as unsigned values
51  * (with associated sign-extension problems), limiting their effectiveness
52  * when checking for buffer overflow.
53  */
54
55 #ifdef __cplusplus
56 #define NCURSES_VOID            /* nothing */
57 #else
58 #define NCURSES_VOID (void)
59 #endif
60
61 #if USE_STRING_HACKS && HAVE_STRLCAT
62 #define _nc_STRCAT(d,s,n)       NCURSES_VOID strlcat((d),(s),NCURSES_CAST(size_t,n))
63 #define _nc_STRNCAT(d,s,m,n)    NCURSES_VOID strlcat((d),(s),NCURSES_CAST(size_t,m))
64 #else
65 #define _nc_STRCAT(d,s,n)       NCURSES_VOID strcat((d),(s))
66 #define _nc_STRNCAT(d,s,m,n)    NCURSES_VOID strncat((d),(s),(n))
67 #endif
68
69 #if USE_STRING_HACKS && HAVE_STRLCPY
70 #define _nc_STRCPY(d,s,n)       NCURSES_VOID strlcpy((d),(s),NCURSES_CAST(size_t,n))
71 #define _nc_STRNCPY(d,s,n)      NCURSES_VOID strlcpy((d),(s),NCURSES_CAST(size_t,n))
72 #else
73 #define _nc_STRCPY(d,s,n)       NCURSES_VOID strcpy((d),(s))
74 #define _nc_STRNCPY(d,s,n)      NCURSES_VOID strncpy((d),(s),(n))
75 #endif
76
77 #if USE_STRING_HACKS && HAVE_SNPRINTF
78 #define _nc_SPRINTF             NCURSES_VOID snprintf
79 #define _nc_SLIMIT(n)           NCURSES_CAST(size_t,n),
80 #else
81 #define _nc_SPRINTF             NCURSES_VOID sprintf
82 #define _nc_SLIMIT(n)           /* nothing */
83 #endif
84
85 #endif /* STRING_HACKS_H */