xref: /aosp_15_r20/external/cronet/third_party/libc++/src/test/libcxx/system_reserved_names.gen.py (revision 6777b5387eb2ff775bb5750e3f5d96f37fb7352b)
1#===----------------------------------------------------------------------===##
2#
3# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4# See https://llvm.org/LICENSE.txt for license information.
5# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6#
7#===----------------------------------------------------------------------===##
8
9# Test that headers are not tripped up by the surrounding code defining various
10# alphabetic macros. Also ensure that we don't swallow the definition of user
11# provided macros (in other words, ensure that we push/pop correctly everywhere).
12
13# RUN: %{python} %s %{libcxx-dir}/utils
14
15import sys
16sys.path.append(sys.argv[1])
17from libcxx.header_information import lit_header_restrictions, public_headers
18
19for header in public_headers:
20  print(f"""\
21//--- {header}.compile.pass.cpp
22{lit_header_restrictions.get(header, '')}
23
24#define SYSTEM_RESERVED_NAME This name should not be used in libc++
25
26// libc++ does not use single-letter names as a matter of principle.
27// But Windows' own <wchar.h>, <math.h>, and <exception> use many of these
28// (at least C,E,F,I,M,N,P,S,X,Y,Z) as uglified function parameter names,
29// so don't define these on Windows.
30//
31#ifndef _WIN32
32#define _A SYSTEM_RESERVED_NAME
33#define _B SYSTEM_RESERVED_NAME
34#define _C SYSTEM_RESERVED_NAME
35#define _D SYSTEM_RESERVED_NAME
36#define _E SYSTEM_RESERVED_NAME
37#define _F SYSTEM_RESERVED_NAME
38#define _G SYSTEM_RESERVED_NAME
39#define _H SYSTEM_RESERVED_NAME
40#define _I SYSTEM_RESERVED_NAME
41#define _J SYSTEM_RESERVED_NAME
42#define _K SYSTEM_RESERVED_NAME
43#define _L SYSTEM_RESERVED_NAME
44#define _M SYSTEM_RESERVED_NAME
45#define _N SYSTEM_RESERVED_NAME
46#define _O SYSTEM_RESERVED_NAME
47#define _P SYSTEM_RESERVED_NAME
48#define _Q SYSTEM_RESERVED_NAME
49#define _R SYSTEM_RESERVED_NAME
50#define _S SYSTEM_RESERVED_NAME
51#define _T SYSTEM_RESERVED_NAME
52#define _U SYSTEM_RESERVED_NAME
53#define _V SYSTEM_RESERVED_NAME
54#define _W SYSTEM_RESERVED_NAME
55#define _X SYSTEM_RESERVED_NAME
56#define _Y SYSTEM_RESERVED_NAME
57#define _Z SYSTEM_RESERVED_NAME
58#endif
59
60// FreeBSD's <sys/types.h> uses _M
61//
62#ifdef __FreeBSD__
63# undef _M
64#endif
65
66// Test that libc++ doesn't use names that collide with FreeBSD system macros.
67// newlib and picolibc also define these macros
68#if !defined(__FreeBSD__) && !defined(_NEWLIB_VERSION)
69#  define __null_sentinel SYSTEM_RESERVED_NAME
70#  define __generic SYSTEM_RESERVED_NAME
71#endif
72
73// tchar.h defines these macros on Windows
74#ifndef _WIN32
75# define _UI   SYSTEM_RESERVED_NAME
76# define _PUC  SYSTEM_RESERVED_NAME
77# define _CPUC SYSTEM_RESERVED_NAME
78# define _PC   SYSTEM_RESERVED_NAME
79# define _CRPC SYSTEM_RESERVED_NAME
80# define _CPC  SYSTEM_RESERVED_NAME
81#endif
82
83// yvals.h on MINGW defines this macro
84#ifndef _WIN32
85# define _C2 SYSTEM_RESERVED_NAME
86#endif
87
88// Test that libc++ doesn't use names that collide with Win32 API macros.
89// Obviously we can only define these on non-Windows platforms.
90#ifndef _WIN32
91# define __allocator SYSTEM_RESERVED_NAME
92# define __bound SYSTEM_RESERVED_NAME
93# define __deallocate SYSTEM_RESERVED_NAME
94# define __deref SYSTEM_RESERVED_NAME
95# define __format_string SYSTEM_RESERVED_NAME
96# define __full SYSTEM_RESERVED_NAME
97# define __in SYSTEM_RESERVED_NAME
98# define __inout SYSTEM_RESERVED_NAME
99# define __nz SYSTEM_RESERVED_NAME
100# define __out SYSTEM_RESERVED_NAME
101# define __part SYSTEM_RESERVED_NAME
102# define __post SYSTEM_RESERVED_NAME
103# define __pre SYSTEM_RESERVED_NAME
104#endif
105
106// Newlib & picolibc use __input as a parameter name of a64l & l64a
107#ifndef _NEWLIB_VERSION
108# define __input SYSTEM_RESERVED_NAME
109#endif
110#define __output SYSTEM_RESERVED_NAME
111
112#define __acquire SYSTEM_RESERVED_NAME
113#define __release SYSTEM_RESERVED_NAME
114
115// These names are not reserved, so the user can macro-define them.
116// These are intended to find improperly _Uglified template parameters.
117#define A SYSTEM_RESERVED_NAME
118#define Arg SYSTEM_RESERVED_NAME
119#define Args SYSTEM_RESERVED_NAME
120#define As SYSTEM_RESERVED_NAME
121#define B SYSTEM_RESERVED_NAME
122#define Bs SYSTEM_RESERVED_NAME
123#define C SYSTEM_RESERVED_NAME
124#define Cp SYSTEM_RESERVED_NAME
125#define Cs SYSTEM_RESERVED_NAME
126// Windows setjmp.h contains a struct member named 'D' on ARM/AArch64.
127#ifndef _WIN32
128# define D SYSTEM_RESERVED_NAME
129#endif
130#define Dp SYSTEM_RESERVED_NAME
131#define Ds SYSTEM_RESERVED_NAME
132#define E SYSTEM_RESERVED_NAME
133#define Ep SYSTEM_RESERVED_NAME
134#define Es SYSTEM_RESERVED_NAME
135#define N SYSTEM_RESERVED_NAME
136#define Np SYSTEM_RESERVED_NAME
137#define Ns SYSTEM_RESERVED_NAME
138#define R SYSTEM_RESERVED_NAME
139#define Rp SYSTEM_RESERVED_NAME
140#define Rs SYSTEM_RESERVED_NAME
141#define T SYSTEM_RESERVED_NAME
142#define Tp SYSTEM_RESERVED_NAME
143#define Ts SYSTEM_RESERVED_NAME
144#define Type SYSTEM_RESERVED_NAME
145#define Types SYSTEM_RESERVED_NAME
146#define U SYSTEM_RESERVED_NAME
147#define Up SYSTEM_RESERVED_NAME
148#define Us SYSTEM_RESERVED_NAME
149#define V SYSTEM_RESERVED_NAME
150#define Vp SYSTEM_RESERVED_NAME
151#define Vs SYSTEM_RESERVED_NAME
152#define X SYSTEM_RESERVED_NAME
153#define Xp SYSTEM_RESERVED_NAME
154#define Xs SYSTEM_RESERVED_NAME
155
156// The classic Windows min/max macros
157#define min SYSTEM_RESERVED_NAME
158#define max SYSTEM_RESERVED_NAME
159
160// Test to make sure curses has no conflicting macros with the standard library
161#define move SYSTEM_RESERVED_NAME
162#define erase SYSTEM_RESERVED_NAME
163#define refresh SYSTEM_RESERVED_NAME
164
165#include <{header}>
166
167// Make sure we don't swallow the definition of the macros we push/pop
168#define STRINGIFY_IMPL(x) #x
169#define STRINGIFY(x) STRINGIFY_IMPL(x)
170static_assert(__builtin_strcmp(STRINGIFY(min), STRINGIFY(SYSTEM_RESERVED_NAME)) == 0, "");
171static_assert(__builtin_strcmp(STRINGIFY(max), STRINGIFY(SYSTEM_RESERVED_NAME)) == 0, "");
172static_assert(__builtin_strcmp(STRINGIFY(move), STRINGIFY(SYSTEM_RESERVED_NAME)) == 0, "");
173static_assert(__builtin_strcmp(STRINGIFY(erase), STRINGIFY(SYSTEM_RESERVED_NAME)) == 0, "");
174static_assert(__builtin_strcmp(STRINGIFY(refresh), STRINGIFY(SYSTEM_RESERVED_NAME)) == 0, "");
175""")
176