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