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