Clang Project

clang_source_code/include/clang/Basic/LangOptions.def
1//===--- LangOptions.def - Language option database -------------*- C++ -*-===//
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// This file defines the language options. Users of this file must
10// define the LANGOPT macro to make use of this information.
11//
12// Optionally, the user may also define:
13//
14// BENIGN_LANGOPT: for options that don't affect the construction of the AST in
15//     any way (that is, the value can be different between an implicit module
16//     and the user of that module).
17//
18// COMPATIBLE_LANGOPT: for options that affect the construction of the AST in
19//     a way that doesn't prevent interoperability (that is, the value can be
20//     different between an explicit module and the user of that module).
21//
22// ENUM_LANGOPT: for options that have enumeration, rather than unsigned, type.
23//
24// VALUE_LANGOPT: for options that describe a value rather than a flag.
25//
26// BENIGN_ENUM_LANGOPT, COMPATIBLE_ENUM_LANGOPT,
27// BENIGN_VALUE_LANGOPT, COMPATIBLE_VALUE_LANGOPT: combinations of the above.
28//
29// FIXME: Clients should be able to more easily select whether they want
30// different levels of compatibility versus how to handle different kinds
31// of option.
32//
33// The Description field should be a noun phrase, for instance "frobbing all
34// widgets" or "C's implicit blintz feature".
35//===----------------------------------------------------------------------===//
36
37#ifndef LANGOPT
38#  error Define the LANGOPT macro to handle language options
39#endif
40
41#ifndef COMPATIBLE_LANGOPT
42#  define COMPATIBLE_LANGOPT(Name, Bits, Default, Description) \
43     LANGOPT(Name, Bits, Default, Description)
44#endif
45
46#ifndef BENIGN_LANGOPT
47#  define BENIGN_LANGOPT(Name, Bits, Default, Description) \
48     COMPATIBLE_LANGOPT(Name, Bits, Default, Description)
49#endif
50
51#ifndef ENUM_LANGOPT
52#  define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
53     LANGOPT(Name, Bits, Default, Description)
54#endif
55
56#ifndef COMPATIBLE_ENUM_LANGOPT
57#  define COMPATIBLE_ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
58     ENUM_LANGOPT(Name, Type, Bits, Default, Description)
59#endif
60
61#ifndef BENIGN_ENUM_LANGOPT
62#  define BENIGN_ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
63     COMPATIBLE_ENUM_LANGOPT(Name, Type, Bits, Default, Description)
64#endif
65
66#ifndef VALUE_LANGOPT
67#  define VALUE_LANGOPT(Name, Bits, Default, Description) \
68     LANGOPT(Name, Bits, Default, Description)
69#endif
70
71#ifndef COMPATIBLE_VALUE_LANGOPT
72#  define COMPATIBLE_VALUE_LANGOPT(Name, Bits, Default, Description) \
73     VALUE_LANGOPT(Name, Bits, Default, Description)
74#endif
75
76#ifndef BENIGN_VALUE_LANGOPT
77#  define BENIGN_VALUE_LANGOPT(Name, Bits, Default, Description) \
78     COMPATIBLE_VALUE_LANGOPT(Name, Bits, Default, Description)
79#endif
80
81// FIXME: A lot of the BENIGN_ options should be COMPATIBLE_ instead.
82LANGOPT(C99               , 1, 0, "C99")
83LANGOPT(C11               , 1, 0, "C11")
84LANGOPT(C17               , 1, 0, "C17")
85LANGOPT(MSVCCompat        , 1, 0, "Microsoft Visual C++ full compatibility mode")
86LANGOPT(MicrosoftExt      , 1, 0, "Microsoft C++ extensions")
87LANGOPT(AsmBlocks         , 1, 0, "Microsoft inline asm blocks")
88LANGOPT(Borland           , 1, 0, "Borland extensions")
89LANGOPT(CPlusPlus         , 1, 0, "C++")
90LANGOPT(CPlusPlus11       , 1, 0, "C++11")
91LANGOPT(CPlusPlus14       , 1, 0, "C++14")
92LANGOPT(CPlusPlus17       , 1, 0, "C++17")
93LANGOPT(CPlusPlus2a       , 1, 0, "C++2a")
94LANGOPT(ObjC              , 1, 0, "Objective-C")
95BENIGN_LANGOPT(ObjCDefaultSynthProperties , 1, 0,
96               "Objective-C auto-synthesized properties")
97BENIGN_LANGOPT(EncodeExtendedBlockSig , 1, 0,
98               "Encoding extended block type signature")
99BENIGN_LANGOPT(ObjCInferRelatedResultType , 1, 1,
100               "Objective-C related result type inference")
101LANGOPT(AppExt , 1, 0, "Objective-C App Extension")
102LANGOPT(Trigraphs         , 1, 0,"trigraphs")
103LANGOPT(LineComment       , 1, 0, "'//' comments")
104LANGOPT(Bool              , 1, 0, "bool, true, and false keywords")
105LANGOPT(Half              , 1, 0, "half keyword")
106LANGOPT(WChar             , 1, CPlusPlus, "wchar_t keyword")
107LANGOPT(Char8             , 1, 0, "char8_t keyword")
108LANGOPT(DeclSpecKeyword   , 1, 0, "__declspec keyword")
109BENIGN_LANGOPT(DollarIdents   , 1, 1, "'$' in identifiers")
110BENIGN_LANGOPT(AsmPreprocessor, 1, 0, "preprocessor in asm mode")
111LANGOPT(GNUMode           , 1, 1, "GNU extensions")
112LANGOPT(GNUKeywords       , 1, 1, "GNU keywords")
113BENIGN_LANGOPT(ImplicitInt, 1, !C99 && !CPlusPlus, "C89 implicit 'int'")
114LANGOPT(Digraphs          , 1, 0, "digraphs")
115BENIGN_LANGOPT(HexFloats  , 1, C99, "C99 hexadecimal float constants")
116LANGOPT(CXXOperatorNames  , 1, 0, "C++ operator name keywords")
117LANGOPT(AppleKext         , 1, 0, "Apple kext support")
118BENIGN_LANGOPT(PascalStrings, 1, 0, "Pascal string support")
119LANGOPT(WritableStrings   , 1, 0, "writable string support")
120LANGOPT(ConstStrings      , 1, 0, "const-qualified string support")
121LANGOPT(LaxVectorConversions , 1, 1, "lax vector conversions")
122LANGOPT(AltiVec           , 1, 0, "AltiVec-style vector initializers")
123LANGOPT(ZVector           , 1, 0, "System z vector extensions")
124LANGOPT(Exceptions        , 1, 0, "exception handling")
125LANGOPT(ObjCExceptions    , 1, 0, "Objective-C exceptions")
126LANGOPT(CXXExceptions     , 1, 0, "C++ exceptions")
127LANGOPT(DWARFExceptions   , 1, 0, "dwarf exception handling")
128LANGOPT(SjLjExceptions    , 1, 0, "setjmp-longjump exception handling")
129LANGOPT(SEHExceptions     , 1, 0, "SEH .xdata exception handling")
130LANGOPT(ExternCNoUnwind   , 1, 0, "Assume extern C functions don't unwind")
131LANGOPT(TraditionalCPP    , 1, 0, "traditional CPP emulation")
132LANGOPT(RTTI              , 1, 1, "run-time type information")
133LANGOPT(RTTIData          , 1, 1, "emit run-time type information data")
134LANGOPT(MSBitfields       , 1, 0, "Microsoft-compatible structure layout")
135LANGOPT(Freestanding, 1, 0, "freestanding implementation")
136LANGOPT(NoBuiltin         , 1, 0, "disable builtin functions")
137LANGOPT(NoMathBuiltin     , 1, 0, "disable math builtin functions")
138LANGOPT(GNUAsm            , 1, 1, "GNU-style inline assembly")
139LANGOPT(Coroutines        , 1, 0, "C++20 coroutines")
140LANGOPT(DllExportInlines  , 1, 1, "dllexported classes dllexport inline methods")
141LANGOPT(RelaxedTemplateTemplateArgs, 1, 0, "C++17 relaxed matching of template template arguments")
142
143LANGOPT(DoubleSquareBracketAttributes, 1, 0, "'[[]]' attributes extension for all language standard modes")
144
145BENIGN_LANGOPT(ThreadsafeStatics , 1, 1, "thread-safe static initializers")
146LANGOPT(POSIXThreads      , 1, 0, "POSIX thread support")
147LANGOPT(Blocks            , 1, 0, "blocks extension to C")
148BENIGN_LANGOPT(EmitAllDecls      , 1, 0, "emitting all declarations")
149LANGOPT(MathErrno         , 1, 1, "errno in math functions")
150BENIGN_LANGOPT(HeinousExtensions , 1, 0, "extensions that we really don't like and may be ripped out at any time")
151LANGOPT(Modules           , 1, 0, "modules extension to C")
152COMPATIBLE_LANGOPT(ModulesTS  , 1, 0, "C++ Modules TS")
153BENIGN_ENUM_LANGOPT(CompilingModule, CompilingModuleKind, 2, CMK_None,
154                    "compiling a module interface")
155BENIGN_LANGOPT(CompilingPCH, 1, 0, "building a pch")
156BENIGN_LANGOPT(BuildingPCHWithObjectFile, 1, 0, "building a pch which has a corresponding object file")
157BENIGN_LANGOPT(CacheGeneratedPCH, 1, 0, "cache generated PCH files in memory")
158COMPATIBLE_LANGOPT(ModulesDeclUse    , 1, 0, "require declaration of module uses")
159BENIGN_LANGOPT(ModulesSearchAll  , 1, 1, "searching even non-imported modules to find unresolved references")
160COMPATIBLE_LANGOPT(ModulesStrictDeclUse, 1, 0, "requiring declaration of module uses and all headers to be in modules")
161BENIGN_LANGOPT(ModulesErrorRecovery, 1, 1, "automatically importing modules as needed when performing error recovery")
162BENIGN_LANGOPT(ImplicitModules, 1, 1, "building modules that are not specified via -fmodule-file")
163COMPATIBLE_LANGOPT(ModulesLocalVisibility, 1, 0, "local submodule visibility")
164COMPATIBLE_LANGOPT(Optimize          , 1, 0, "__OPTIMIZE__ predefined macro")
165COMPATIBLE_LANGOPT(OptimizeSize      , 1, 0, "__OPTIMIZE_SIZE__ predefined macro")
166COMPATIBLE_LANGOPT(Static            , 1, 0, "__STATIC__ predefined macro (as opposed to __DYNAMIC__)")
167VALUE_LANGOPT(PackStruct  , 32, 0,
168              "default struct packing maximum alignment")
169VALUE_LANGOPT(MaxTypeAlign  , 32, 0,
170              "default maximum alignment for types")
171VALUE_LANGOPT(AlignDouble            , 1, 0, "Controls if doubles should be aligned to 8 bytes (x86 only)")
172COMPATIBLE_VALUE_LANGOPT(PICLevel    , 2, 0, "__PIC__ level")
173COMPATIBLE_VALUE_LANGOPT(PIE         , 1, 0, "is pie")
174LANGOPT(ROPI                         , 1, 0, "Read-only position independence")
175LANGOPT(RWPI                         , 1, 0, "Read-write position independence")
176COMPATIBLE_LANGOPT(GNUInline         , 1, 0, "GNU inline semantics")
177COMPATIBLE_LANGOPT(NoInlineDefine    , 1, 0, "__NO_INLINE__ predefined macro")
178COMPATIBLE_LANGOPT(Deprecated        , 1, 0, "__DEPRECATED predefined macro")
179COMPATIBLE_LANGOPT(FastMath          , 1, 0, "fast FP math optimizations, and __FAST_MATH__ predefined macro")
180COMPATIBLE_LANGOPT(FiniteMathOnly    , 1, 0, "__FINITE_MATH_ONLY__ predefined macro")
181COMPATIBLE_LANGOPT(UnsafeFPMath      , 1, 0, "Unsafe Floating Point Math")
182
183BENIGN_LANGOPT(ObjCGCBitmapPrint , 1, 0, "printing of GC's bitmap layout for __weak/__strong ivars")
184
185BENIGN_LANGOPT(AccessControl     , 1, 1, "C++ access control")
186LANGOPT(CharIsSigned      , 1, 1, "signed char")
187LANGOPT(WCharSize         , 4, 0, "width of wchar_t")
188LANGOPT(WCharIsSigned        , 1, 0, "signed or unsigned wchar_t")
189ENUM_LANGOPT(MSPointerToMemberRepresentationMethod, PragmaMSPointersToMembersKind, 2, PPTMK_BestCase, "member-pointer representation method")
190ENUM_LANGOPT(DefaultCallingConv, DefaultCallingConvention, 3, DCC_None, "default calling convention")
191
192LANGOPT(ShortEnums        , 1, 0, "short enum types")
193
194LANGOPT(OpenCL            , 1, 0, "OpenCL")
195LANGOPT(OpenCLVersion     , 32, 0, "OpenCL C version")
196LANGOPT(OpenCLCPlusPlus   , 1, 0, "OpenCL C++")
197LANGOPT(OpenCLCPlusPlusVersion     , 32, 0, "OpenCL C++ version")
198LANGOPT(NativeHalfType    , 1, 0, "Native half type support")
199LANGOPT(NativeHalfArgsAndReturns, 1, 0, "Native half args and returns")
200LANGOPT(HalfArgsAndReturns, 1, 0, "half args and returns")
201LANGOPT(CUDA              , 1, 0, "CUDA")
202LANGOPT(HIP               , 1, 0, "HIP")
203LANGOPT(OpenMP            , 32, 0, "OpenMP support and version of OpenMP (31, 40 or 45)")
204LANGOPT(OpenMPSimd        , 1, 0, "Use SIMD only OpenMP support.")
205LANGOPT(OpenMPUseTLS      , 1, 0, "Use TLS for threadprivates or runtime calls")
206LANGOPT(OpenMPIsDevice    , 1, 0, "Generate code only for OpenMP target device")
207LANGOPT(OpenMPCUDAMode    , 1, 0, "Generate code for OpenMP pragmas in SIMT/SPMD mode")
208LANGOPT(OpenMPCUDAForceFullRuntime , 1, 0, "Force to use full runtime in all constructs when offloading to CUDA devices")
209LANGOPT(OpenMPCUDANumSMs  , 32, 0, "Number of SMs for CUDA devices.")
210LANGOPT(OpenMPCUDABlocksPerSM  , 32, 0, "Number of blocks per SM for CUDA devices.")
211LANGOPT(OpenMPCUDAReductionBufNum , 32, 1024, "Number of the reduction records in the intermediate reduction buffer used for the teams reductions.")
212LANGOPT(OpenMPOptimisticCollapse  , 1, 0, "Use at most 32 bits to represent the collapsed loop nest counter.")
213LANGOPT(RenderScript      , 1, 0, "RenderScript")
214
215LANGOPT(CUDAIsDevice      , 1, 0, "compiling for CUDA device")
216LANGOPT(CUDAAllowVariadicFunctions, 1, 0, "allowing variadic functions in CUDA device code")
217LANGOPT(CUDAHostDeviceConstexpr, 1, 1, "treating unattributed constexpr functions as __host__ __device__")
218LANGOPT(CUDADeviceApproxTranscendentals, 1, 0, "using approximate transcendental functions")
219LANGOPT(GPURelocatableDeviceCode, 1, 0, "generate relocatable device code")
220
221LANGOPT(SYCLIsDevice      , 1, 0, "Generate code for SYCL device")
222
223LANGOPT(SizedDeallocation , 1, 0, "sized deallocation")
224LANGOPT(AlignedAllocation , 1, 0, "aligned allocation")
225LANGOPT(AlignedAllocationUnavailable, 1, 0, "aligned allocation functions are unavailable")
226LANGOPT(NewAlignOverride  , 32, 0, "maximum alignment guaranteed by '::operator new(size_t)'")
227LANGOPT(ConceptsTS , 1, 0, "enable C++ Extensions for Concepts")
228BENIGN_LANGOPT(ModulesCodegen , 1, 0, "Modules code generation")
229BENIGN_LANGOPT(ModulesDebugInfo , 1, 0, "Modules debug info")
230BENIGN_LANGOPT(ElideConstructors , 1, 1, "C++ copy constructor elision")
231BENIGN_LANGOPT(DumpRecordLayouts , 1, 0, "dumping the layout of IRgen'd records")
232BENIGN_LANGOPT(DumpRecordLayoutsSimple , 1, 0, "dumping the layout of IRgen'd records in a simple form")
233BENIGN_LANGOPT(DumpVTableLayouts , 1, 0, "dumping the layouts of emitted vtables")
234LANGOPT(NoConstantCFStrings , 1, 0, "no constant CoreFoundation strings")
235BENIGN_LANGOPT(InlineVisibilityHidden , 1, 0, "hidden visibility for inline C++ methods")
236LANGOPT(GlobalAllocationFunctionVisibilityHidden , 1, 0, "hidden visibility for global operator new and delete declaration")
237BENIGN_LANGOPT(ParseUnknownAnytype, 1, 0, "__unknown_anytype")
238BENIGN_LANGOPT(DebuggerSupport , 1, 0, "debugger support")
239BENIGN_LANGOPT(DebuggerCastResultToId, 1, 0, "for 'po' in the debugger, cast the result to id if it is of unknown type")
240BENIGN_LANGOPT(DebuggerObjCLiteral , 1, 0, "debugger Objective-C literals and subscripting support")
241
242BENIGN_LANGOPT(SpellChecking , 1, 1, "spell-checking")
243LANGOPT(SinglePrecisionConstants , 1, 0, "treating double-precision floating point constants as single precision constants")
244LANGOPT(FastRelaxedMath , 1, 0, "OpenCL fast relaxed math")
245/// FP_CONTRACT mode (on/off/fast).
246ENUM_LANGOPT(DefaultFPContractMode, FPContractModeKind, 2, FPC_Off, "FP contraction type")
247LANGOPT(NoBitFieldTypeAlign , 1, 0, "bit-field type alignment")
248LANGOPT(HexagonQdsp6Compat , 1, 0, "hexagon-qdsp6 backward compatibility")
249LANGOPT(ObjCAutoRefCount , 1, 0, "Objective-C automated reference counting")
250LANGOPT(ObjCWeakRuntime     , 1, 0, "__weak support in the ARC runtime")
251LANGOPT(ObjCWeak            , 1, 0, "Objective-C __weak in ARC and MRC files")
252LANGOPT(ObjCSubscriptingLegacyRuntime         , 1, 0, "Subscripting support in legacy ObjectiveC runtime")
253LANGOPT(CFProtectionBranch , 1, 0, "Control-Flow Branch Protection enabled")
254LANGOPT(FakeAddressSpaceMap , 1, 0, "OpenCL fake address space map")
255ENUM_LANGOPT(AddressSpaceMapMangling , AddrSpaceMapMangling, 2, ASMM_Target, "OpenCL address space map mangling mode")
256LANGOPT(IncludeDefaultHeader, 1, 0, "Include default header file for OpenCL")
257BENIGN_LANGOPT(DelayedTemplateParsing , 1, 0, "delayed template parsing")
258LANGOPT(BlocksRuntimeOptional , 1, 0, "optional blocks runtime")
259LANGOPT(
260    CompleteMemberPointers, 1, 0,
261    "Require member pointer base types to be complete at the point where the "
262    "type's inheritance model would be determined under the Microsoft ABI")
263
264ENUM_LANGOPT(GC, GCMode, 2, NonGC, "Objective-C Garbage Collection mode")
265ENUM_LANGOPT(ValueVisibilityMode, Visibility, 3, DefaultVisibility,
266             "default visibility for functions and variables [-fvisibility]")
267ENUM_LANGOPT(TypeVisibilityMode, Visibility, 3, DefaultVisibility,
268             "default visibility for types [-ftype-visibility]")
269LANGOPT(SetVisibilityForExternDecls, 1, 0,
270        "apply global symbol visibility to external declarations without an explicit visibility")
271ENUM_LANGOPT(StackProtector, StackProtectorMode, 2, SSPOff,
272             "stack protector mode")
273ENUM_LANGOPT(TrivialAutoVarInit, TrivialAutoVarInitKind, 2, TrivialAutoVarInitKind::Uninitialized,
274             "trivial automatic variable initialization")
275ENUM_LANGOPT(SignedOverflowBehavior, SignedOverflowBehaviorTy, 2, SOB_Undefined,
276             "signed integer overflow handling")
277
278BENIGN_LANGOPT(ArrowDepth, 32, 256,
279               "maximum number of operator->s to follow")
280BENIGN_LANGOPT(InstantiationDepth, 32, 1024,
281               "maximum template instantiation depth")
282BENIGN_LANGOPT(ConstexprCallDepth, 32, 512,
283               "maximum constexpr call depth")
284BENIGN_LANGOPT(ConstexprStepLimit, 32, 1048576,
285               "maximum constexpr evaluation steps")
286BENIGN_LANGOPT(BracketDepth, 32, 256,
287               "maximum bracket nesting depth")
288BENIGN_LANGOPT(NumLargeByValueCopy, 32, 0,
289        "if non-zero, warn about parameter or return Warn if parameter/return value is larger in bytes than this setting. 0 is no check.")
290VALUE_LANGOPT(MSCompatibilityVersion, 32, 0, "Microsoft Visual C/C++ Version")
291VALUE_LANGOPT(VtorDispMode, 2, 1, "How many vtordisps to insert")
292
293LANGOPT(ApplePragmaPack, 1, 0, "Apple gcc-compatible #pragma pack handling")
294
295LANGOPT(RetainCommentsFromSystemHeaders, 1, 0, "retain documentation comments from system headers in the AST")
296
297LANGOPT(SanitizeAddressFieldPadding, 2, 0, "controls how aggressive is ASan "
298                                           "field padding (0: none, 1:least "
299                                           "aggressive, 2: more aggressive)")
300
301LANGOPT(XRayInstrument, 1, 0, "controls whether to do XRay instrumentation")
302LANGOPT(XRayAlwaysEmitCustomEvents, 1, 0,
303        "controls whether to always emit intrinsic calls to "
304        "__xray_customevent(...) builtin.")
305LANGOPT(XRayAlwaysEmitTypedEvents, 1, 0,
306        "controls whether to always emit intrinsic calls to "
307        "__xray_typedevent(...) builtin.")
308
309LANGOPT(ForceEmitVTables, 1, 0, "whether to emit all vtables")
310
311BENIGN_LANGOPT(AllowEditorPlaceholders, 1, 0,
312               "allow editor placeholders in source")
313
314ENUM_LANGOPT(ClangABICompat, ClangABI, 4, ClangABI::Latest,
315             "version of Clang that we should attempt to be ABI-compatible "
316             "with")
317
318COMPATIBLE_VALUE_LANGOPT(FunctionAlignment, 5, 0, "Default alignment for functions")
319
320LANGOPT(FixedPoint, 1, 0, "fixed point types")
321LANGOPT(PaddingOnUnsignedFixedPoint, 1, 0,
322        "unsigned fixed point types having one extra padding bit")
323
324LANGOPT(RegisterStaticDestructors, 1, 1, "Register C++ static destructors")
325
326#undef LANGOPT
327#undef COMPATIBLE_LANGOPT
328#undef BENIGN_LANGOPT
329#undef ENUM_LANGOPT
330#undef COMPATIBLE_ENUM_LANGOPT
331#undef BENIGN_ENUM_LANGOPT
332#undef VALUE_LANGOPT
333#undef COMPATIBLE_VALUE_LANGOPT
334#undef BENIGN_VALUE_LANGOPT
335
CodeThinker, Enjoy your reading code