From a4a2d039a9117266ed8cb1977241e7c34b368993 Mon Sep 17 00:00:00 2001 From: Paul Eggert Date: Tue, 7 Sep 2021 17:51:39 -0700 Subject: string, wchar: avoid some namespace pollution * lib/string.in.h, lib/wchar.in.h: (free): Declare by hand instead of including stdlib.h. This avoids some namespace pollution. It should also avoid some nested-include problems described by Lucy Phipps in: https://lists.gnu.org/r/bug-gnulib/2021-09/msg00018.html * modules/string, modules/wchar: (Depends-on): Add stdlib, so that REPLACE_FREE has the right value. (Makefile.am): Replace @REPLACE_FREE@ when creating the include file. --- ChangeLog | 12 ++++++++++++ lib/attribute.h | 2 +- lib/stdlib.in.h | 2 +- lib/string.in.h | 9 ++++++--- lib/wchar.in.h | 9 ++++++--- m4/gnulib-common.m4 | 2 +- modules/string | 2 ++ modules/wchar | 2 ++ 8 files changed, 31 insertions(+), 9 deletions(-) diff --git a/ChangeLog b/ChangeLog index 39a892e287..f73dc5a130 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,15 @@ +2021-09-07 Paul Eggert + + string, wchar: avoid some namespace pollution + * lib/string.in.h, lib/wchar.in.h: + (free): Declare by hand instead of including stdlib.h. + This avoids some namespace pollution. It should also avoid some + nested-include problems described by Lucy Phipps in: + https://lists.gnu.org/r/bug-gnulib/2021-09/msg00018.html + * modules/string, modules/wchar: + (Depends-on): Add stdlib, so that REPLACE_FREE has the right value. + (Makefile.am): Replace @REPLACE_FREE@ when creating the include file. + 2021-09-04 Paul Eggert idx: break copying from glibc diff --git a/lib/attribute.h b/lib/attribute.h index 26a5556557..eb36188d48 100644 --- a/lib/attribute.h +++ b/lib/attribute.h @@ -80,7 +80,7 @@ that can be freed by passing them as the Ith argument to the function F. ATTRIBUTE_DEALLOC_FREE declares that the function returns pointers that - can be freed via 'free'; it can be used only after including . */ + can be freed via 'free'; it can be used only after declaring 'free'. */ /* Applies to: functions. Cannot be used on inline functions. */ #define ATTRIBUTE_DEALLOC(f, i) _GL_ATTRIBUTE_DEALLOC(f, i) #define ATTRIBUTE_DEALLOC_FREE _GL_ATTRIBUTE_DEALLOC_FREE diff --git a/lib/stdlib.in.h b/lib/stdlib.in.h index d0ea07f8bc..0855112d19 100644 --- a/lib/stdlib.in.h +++ b/lib/stdlib.in.h @@ -111,7 +111,7 @@ struct random_data #endif /* _GL_ATTRIBUTE_DEALLOC_FREE declares that the function returns pointers that - can be freed via 'free'; it can be used only after including . */ + can be freed via 'free'; it can be used only after declaring 'free'. */ /* Applies to: functions. Cannot be used on inline functions. */ #ifndef _GL_ATTRIBUTE_DEALLOC_FREE # define _GL_ATTRIBUTE_DEALLOC_FREE _GL_ATTRIBUTE_DEALLOC (free, 1) diff --git a/lib/string.in.h b/lib/string.in.h index fa2e40c257..6214b55784 100644 --- a/lib/string.in.h +++ b/lib/string.in.h @@ -47,9 +47,6 @@ /* NetBSD 5.0 mis-defines NULL. */ #include -/* Get free(). */ -#include - /* MirBSD defines mbslen as a macro. */ #if @GNULIB_MBSLEN@ && defined __MirBSD__ # include @@ -86,6 +83,12 @@ /* The definition of _GL_WARN_ON_USE is copied here. */ +/* Declare 'free' if needed for _GL_ATTRIBUTE_DEALLOC_FREE. */ +#if (@REPLACE_FREE@ && !defined free \ + && !(defined __cplusplus && defined GNULIB_NAMESPACE)) +# define free rpl_free +#endif +_GL_EXTERN_C void free (void *); /* Clear a block of memory. The compiler will not delete a call to this function, even if the block is dead after the call. */ diff --git a/lib/wchar.in.h b/lib/wchar.in.h index be5d36c8de..027a145496 100644 --- a/lib/wchar.in.h +++ b/lib/wchar.in.h @@ -72,9 +72,6 @@ # include #endif -/* Get free(). */ -#include - /* Include the original if it exists. Some builds of uClibc lack it. */ /* The include_next requires a split double-inclusion guard. */ @@ -149,6 +146,12 @@ typedef int rpl_mbstate_t; # endif #endif +/* Declare 'free' if needed for _GL_ATTRIBUTE_DEALLOC_FREE. */ +#if (@REPLACE_FREE@ && !defined free \ + && !(defined __cplusplus && defined GNULIB_NAMESPACE)) +# define free rpl_free +#endif +_GL_EXTERN_C void free (void *); /* Convert a single-byte character to a wide character. */ #if @GNULIB_BTOWC@ diff --git a/m4/gnulib-common.m4 b/m4/gnulib-common.m4 index 5d667052d9..12b19dbcb4 100644 --- a/m4/gnulib-common.m4 +++ b/m4/gnulib-common.m4 @@ -174,7 +174,7 @@ AC_DEFUN([gl_COMMON_BODY], [ that can be freed by passing them as the Ith argument to the function F. _GL_ATTRIBUTE_DEALLOC_FREE declares that the function returns pointers that - can be freed via 'free'; it can be used only after including . */ + can be freed via 'free'; it can be used only after declaring 'free'. */ /* Applies to: functions. Cannot be used on inline functions. */ #if _GL_GNUC_PREREQ (11, 0) # define _GL_ATTRIBUTE_DEALLOC(f, i) __attribute__ ((__malloc__ (f, i))) diff --git a/modules/string b/modules/string index e1d9980bbd..306834591e 100644 --- a/modules/string +++ b/modules/string @@ -13,6 +13,7 @@ snippet/arg-nonnull snippet/c++defs snippet/warn-on-use stddef +stdlib configure.ac: gl_STRING_H @@ -102,6 +103,7 @@ string.h: string.in.h $(top_builddir)/config.status $(CXXDEFS_H) $(ARG_NONNULL_H -e 's|@''REPLACE_FFSLL''@|$(REPLACE_FFSLL)|g' \ -e 's|@''REPLACE_MEMCHR''@|$(REPLACE_MEMCHR)|g' \ -e 's|@''REPLACE_MEMMEM''@|$(REPLACE_MEMMEM)|g' \ + -e 's|@''REPLACE_FREE''@|$(REPLACE_FREE)|g' \ -e 's|@''REPLACE_STPNCPY''@|$(REPLACE_STPNCPY)|g' \ -e 's|@''REPLACE_STRCHRNUL''@|$(REPLACE_STRCHRNUL)|g' \ -e 's|@''REPLACE_STRDUP''@|$(REPLACE_STRDUP)|g' \ diff --git a/modules/wchar b/modules/wchar index d4e6d6933b..d34cb6a22a 100644 --- a/modules/wchar +++ b/modules/wchar @@ -14,6 +14,7 @@ snippet/c++defs snippet/warn-on-use inttypes-incomplete stddef +stdlib configure.ac: gl_WCHAR_H @@ -126,6 +127,7 @@ wchar.h: wchar.in.h $(top_builddir)/config.status $(CXXDEFS_H) $(ARG_NONNULL_H) sed -e 's|@''REPLACE_MBSTATE_T''@|$(REPLACE_MBSTATE_T)|g' \ -e 's|@''REPLACE_BTOWC''@|$(REPLACE_BTOWC)|g' \ -e 's|@''REPLACE_WCTOB''@|$(REPLACE_WCTOB)|g' \ + -e 's|@''REPLACE_FREE''@|$(REPLACE_FREE)|g' \ -e 's|@''REPLACE_MBSINIT''@|$(REPLACE_MBSINIT)|g' \ -e 's|@''REPLACE_MBRTOWC''@|$(REPLACE_MBRTOWC)|g' \ -e 's|@''REPLACE_MBRLEN''@|$(REPLACE_MBRLEN)|g' \ -- cgit v1.2.1