xref: /aosp_15_r20/external/clang/include/clang/Driver/CLCompatOptions.td (revision 67e74705e28f6214e480b399dd47ea732279e315)
1//===--- CLCompatOptions.td - Options for clang-cl ------------------------===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10//  This file defines the options accepted by clang-cl.
11//
12//===----------------------------------------------------------------------===//
13
14def cl_Group : OptionGroup<"<clang-cl options>">,
15  HelpText<"CL.EXE COMPATIBILITY OPTIONS">;
16
17def cl_compile_Group : OptionGroup<"<clang-cl compile-only options>">,
18  Group<cl_Group>;
19
20def cl_ignored_Group : OptionGroup<"<clang-cl ignored options>">,
21  Group<cl_Group>;
22
23class CLFlag<string name> : Option<["/", "-"], name, KIND_FLAG>,
24  Group<cl_Group>, Flags<[CLOption, DriverOption]>;
25
26class CLCompileFlag<string name> : Option<["/", "-"], name, KIND_FLAG>,
27  Group<cl_compile_Group>, Flags<[CLOption, DriverOption]>;
28
29class CLIgnoredFlag<string name> : Option<["/", "-"], name, KIND_FLAG>,
30  Group<cl_ignored_Group>, Flags<[CLOption, DriverOption, HelpHidden]>;
31
32class CLJoined<string name> : Option<["/", "-"], name, KIND_JOINED>,
33  Group<cl_Group>, Flags<[CLOption, DriverOption]>;
34
35class CLCompileJoined<string name> : Option<["/", "-"], name, KIND_JOINED>,
36  Group<cl_compile_Group>, Flags<[CLOption, DriverOption]>;
37
38class CLIgnoredJoined<string name> : Option<["/", "-"], name, KIND_JOINED>,
39  Group<cl_ignored_Group>, Flags<[CLOption, DriverOption, HelpHidden]>;
40
41class CLJoinedOrSeparate<string name> : Option<["/", "-"], name,
42  KIND_JOINED_OR_SEPARATE>, Group<cl_Group>, Flags<[CLOption, DriverOption]>;
43
44class CLCompileJoinedOrSeparate<string name> : Option<["/", "-"], name,
45  KIND_JOINED_OR_SEPARATE>, Group<cl_compile_Group>,
46  Flags<[CLOption, DriverOption]>;
47
48class CLRemainingArgsJoined<string name> : Option<["/", "-"], name,
49  KIND_REMAINING_ARGS_JOINED>, Group<cl_Group>, Flags<[CLOption, DriverOption]>;
50
51// Aliases:
52// (We don't put any of these in cl_compile_Group as the options they alias are
53// already in the right group.)
54
55def _SLASH_Brepro : CLFlag<"Brepro">,
56  HelpText<"Emit an object file which can be reproduced over time">,
57  Alias<mincremental_linker_compatible>;
58def _SLASH_Brepro_ : CLFlag<"Brepro-">,
59  HelpText<"Emit an object file which cannot be reproduced over time">,
60  Alias<mno_incremental_linker_compatible>;
61def _SLASH_C : CLFlag<"C">,
62  HelpText<"Don't discard comments when preprocessing">, Alias<C>;
63def _SLASH_c : CLFlag<"c">, HelpText<"Compile only">, Alias<c>;
64def _SLASH_D : CLJoinedOrSeparate<"D">, HelpText<"Define macro">,
65  MetaVarName<"<macro[=value]>">, Alias<D>;
66def _SLASH_E : CLFlag<"E">, HelpText<"Preprocess to stdout">, Alias<E>;
67def _SLASH_fp_except : CLFlag<"fp:except">, HelpText<"">, Alias<ftrapping_math>;
68def _SLASH_fp_except_ : CLFlag<"fp:except-">,
69  HelpText<"">, Alias<fno_trapping_math>;
70def _SLASH_fp_fast : CLFlag<"fp:fast">, HelpText<"">, Alias<ffast_math>;
71def _SLASH_fp_precise : CLFlag<"fp:precise">,
72  HelpText<"">, Alias<fno_fast_math>;
73def _SLASH_fp_strict : CLFlag<"fp:strict">, HelpText<"">, Alias<fno_fast_math>;
74def _SLASH_GA : CLFlag<"GA">, Alias<ftlsmodel_EQ>, AliasArgs<["local-exec"]>,
75  HelpText<"Assume thread-local variables are defined in the executable">;
76def _SLASH_GR : CLFlag<"GR">, HelpText<"Enable emission of RTTI data">;
77def _SLASH_GR_ : CLFlag<"GR-">, HelpText<"Disable emission of RTTI data">;
78def _SLASH_GF_ : CLFlag<"GF-">, HelpText<"Disable string pooling">,
79  Alias<fwritable_strings>;
80def _SLASH_GS : CLFlag<"GS">, HelpText<"Enable buffer security check">;
81def _SLASH_GS_ : CLFlag<"GS-">, HelpText<"Disable buffer security check">;
82def _SLASH_Gs : CLJoined<"Gs">, HelpText<"Set stack probe size">,
83  Alias<mstack_probe_size>;
84def _SLASH_Gy : CLFlag<"Gy">, HelpText<"Put each function in its own section">,
85  Alias<ffunction_sections>;
86def _SLASH_Gy_ : CLFlag<"Gy-">,
87  HelpText<"Don't put each function in its own section">,
88  Alias<fno_function_sections>;
89def _SLASH_Gw : CLFlag<"Gw">, HelpText<"Put each data item in its own section">,
90  Alias<fdata_sections>;
91def _SLASH_Gw_ : CLFlag<"Gw-">,
92  HelpText<"Don't put each data item in its own section">,
93  Alias<fno_data_sections>;
94def _SLASH_help : CLFlag<"help">, Alias<help>,
95  HelpText<"Display available options">;
96def _SLASH_HELP : CLFlag<"HELP">, Alias<help>;
97def _SLASH_I : CLJoinedOrSeparate<"I">,
98  HelpText<"Add directory to include search path">, MetaVarName<"<dir>">,
99  Alias<I>;
100def _SLASH_J : CLFlag<"J">, HelpText<"Make char type unsigned">,
101  Alias<funsigned_char>;
102def _SLASH_O0 : CLFlag<"O0">, Alias<O0>;
103// /Oy- is handled by the /O option because /Oy- only has an effect on 32-bit.
104def _SLASH_O : CLJoined<"O">, HelpText<"Optimization level">;
105def _SLASH_Od : CLFlag<"Od">, HelpText<"Disable optimization">, Alias<O0>;
106def _SLASH_Oi : CLFlag<"Oi">, HelpText<"Enable use of builtin functions">,
107  Alias<fbuiltin>;
108def _SLASH_Oi_ : CLFlag<"Oi-">, HelpText<"Disable use of builtin functions">,
109  Alias<fno_builtin>;
110def _SLASH_Os : CLFlag<"Os">, HelpText<"Optimize for size">, Alias<O>,
111  AliasArgs<["s"]>;
112def _SLASH_Ot : CLFlag<"Ot">, HelpText<"Optimize for speed">, Alias<O>,
113  AliasArgs<["2"]>;
114def _SLASH_QUESTION : CLFlag<"?">, Alias<help>,
115  HelpText<"Display available options">;
116def _SLASH_Qvec : CLFlag<"Qvec">,
117  HelpText<"Enable the loop vectorization passes">, Alias<fvectorize>;
118def _SLASH_Qvec_ : CLFlag<"Qvec-">,
119  HelpText<"Disable the loop vectorization passes">, Alias<fno_vectorize>;
120def _SLASH_showIncludes : CLFlag<"showIncludes">,
121  HelpText<"Print info about included files to stderr">,
122  Alias<show_includes>;
123def _SLASH_std : CLCompileJoined<"std:">,
124  HelpText<"Language standard to compile for">;
125def _SLASH_U : CLJoinedOrSeparate<"U">, HelpText<"Undefine macro">,
126  MetaVarName<"<macro>">, Alias<U>;
127def _SLASH_W0 : CLFlag<"W0">, HelpText<"Disable all warnings">, Alias<w>;
128def _SLASH_W1 : CLFlag<"W1">, HelpText<"Enable -Wall">, Alias<Wall>;
129def _SLASH_W2 : CLFlag<"W2">, HelpText<"Enable -Wall">, Alias<Wall>;
130def _SLASH_W3 : CLFlag<"W3">, HelpText<"Enable -Wall">, Alias<Wall>;
131def _SLASH_W4 : CLFlag<"W4">, HelpText<"Enable -Wall and -Wextra">, Alias<WCL4>;
132def _SLASH_Wall : CLFlag<"Wall">, HelpText<"Enable -Wall and -Wextra">, Alias<WCL4>;
133def _SLASH_WX : CLFlag<"WX">, HelpText<"Treat warnings as errors">,
134  Alias<W_Joined>, AliasArgs<["error"]>;
135def _SLASH_WX_ : CLFlag<"WX-">, HelpText<"Do not treat warnings as errors">,
136  Alias<W_Joined>, AliasArgs<["no-error"]>;
137def _SLASH_w_flag : CLFlag<"w">, HelpText<"Disable all warnings">, Alias<w>;
138def _SLASH_wd4005 : CLFlag<"wd4005">, Alias<W_Joined>,
139  AliasArgs<["no-macro-redefined"]>;
140def _SLASH_wd4100 : CLFlag<"wd4100">, Alias<W_Joined>,
141  AliasArgs<["no-unused-parameter"]>;
142def _SLASH_wd4910 : CLFlag<"wd4910">, Alias<W_Joined>,
143  AliasArgs<["no-dllexport-explicit-instantiation-decl"]>;
144def _SLASH_wd4996 : CLFlag<"wd4996">, Alias<W_Joined>,
145  AliasArgs<["no-deprecated-declarations"]>;
146def _SLASH_vd : CLJoined<"vd">, HelpText<"Control vtordisp placement">,
147  Alias<vtordisp_mode_EQ>;
148def _SLASH_Zc_sizedDealloc : CLFlag<"Zc:sizedDealloc">,
149  HelpText<"Enable C++14 sized global deallocation functions">,
150  Alias<fsized_deallocation>;
151def _SLASH_Zc_sizedDealloc_ : CLFlag<"Zc:sizedDealloc-">,
152  HelpText<"Disable C++14 sized global deallocation functions">,
153  Alias<fno_sized_deallocation>;
154def _SLASH_Zc_strictStrings : CLFlag<"Zc:strictStrings">,
155  HelpText<"Treat string literals as const">, Alias<W_Joined>,
156  AliasArgs<["error=c++11-compat-deprecated-writable-strings"]>;
157def _SLASH_Zc_threadSafeInit : CLFlag<"Zc:threadSafeInit">,
158  HelpText<"Enable thread-safe initialization of static variables">,
159  Alias<fthreadsafe_statics>;
160def _SLASH_Zc_threadSafeInit_ : CLFlag<"Zc:threadSafeInit-">,
161  HelpText<"Disable thread-safe initialization of static variables">,
162  Alias<fno_threadsafe_statics>;
163def _SLASH_Zc_trigraphs : CLFlag<"Zc:trigraphs">,
164  HelpText<"Enable trigraphs">, Alias<ftrigraphs>;
165def _SLASH_Zc_trigraphs_off : CLFlag<"Zc:trigraphs-">,
166  HelpText<"Disable trigraphs (default)">, Alias<fno_trigraphs>;
167def _SLASH_Z7 : CLFlag<"Z7">,
168  HelpText<"Enable CodeView debug information in object files">;
169def _SLASH_Zd : CLFlag<"Zd">,
170  HelpText<"Emit debug line number tables only">;
171def _SLASH_Zi : CLFlag<"Zi">, Alias<_SLASH_Z7>,
172  HelpText<"Alias for /Z7. Does not produce PDBs.">;
173def _SLASH_Zp : CLJoined<"Zp">,
174  HelpText<"Specify the default maximum struct packing alignment">,
175  Alias<fpack_struct_EQ>;
176def _SLASH_Zp_flag : CLFlag<"Zp">,
177  HelpText<"Set the default maximum struct packing alignment to 1">,
178  Alias<fpack_struct_EQ>, AliasArgs<["1"]>;
179def _SLASH_Zs : CLFlag<"Zs">, HelpText<"Syntax-check only">,
180  Alias<fsyntax_only>;
181
182
183// Non-aliases:
184
185def _SLASH_arch : CLCompileJoined<"arch:">,
186  HelpText<"Set architecture for code generation">;
187
188def _SLASH_M_Group : OptionGroup<"</M group>">, Group<cl_compile_Group>;
189def _SLASH_volatile_Group : OptionGroup<"</volatile group>">,
190  Group<cl_compile_Group>;
191
192def _SLASH_EH : CLJoined<"EH">, HelpText<"Exception handling model">;
193def _SLASH_EP : CLFlag<"EP">,
194  HelpText<"Disable linemarker output and preprocess to stdout">;
195def _SLASH_FA : CLFlag<"FA">,
196  HelpText<"Output assembly code file during compilation">;
197def _SLASH_Fa : CLJoined<"Fa">,
198  HelpText<"Output assembly code to this file during compilation (with /FA)">,
199  MetaVarName<"<file or directory>">;
200def _SLASH_fallback : CLCompileFlag<"fallback">,
201  HelpText<"Fall back to cl.exe if clang-cl fails to compile">;
202def _SLASH_FI : CLJoinedOrSeparate<"FI">,
203  HelpText<"Include file before parsing">, Alias<include_>;
204def _SLASH_Fe : CLJoined<"Fe">,
205  HelpText<"Set output executable file or directory (ends in / or \\)">,
206  MetaVarName<"<file or directory>">;
207def _SLASH_Fi : CLCompileJoined<"Fi">,
208  HelpText<"Set preprocess output file name (with /P)">,
209  MetaVarName<"<file>">;
210def _SLASH_Fo : CLCompileJoined<"Fo">,
211  HelpText<"Set output object file, or directory (ends in / or \\) (with /c)">,
212  MetaVarName<"<file or directory>">;
213def _SLASH_GX : CLFlag<"GX">,
214  HelpText<"Enable exception handling">;
215def _SLASH_GX_ : CLFlag<"GX-">,
216  HelpText<"Enable exception handling">;
217def _SLASH_imsvc : CLJoinedOrSeparate<"imsvc">,
218  HelpText<"Add directory to system include search path, as if part of %INCLUDE%">,
219  MetaVarName<"<dir>">;
220def _SLASH_LD : CLFlag<"LD">, HelpText<"Create DLL">;
221def _SLASH_LDd : CLFlag<"LDd">, HelpText<"Create debug DLL">;
222def _SLASH_link : CLRemainingArgsJoined<"link">,
223  HelpText<"Forward options to the linker">, MetaVarName<"<options>">;
224def _SLASH_MD : Option<["/", "-"], "MD", KIND_FLAG>, Group<_SLASH_M_Group>,
225  Flags<[CLOption, DriverOption]>, HelpText<"Use DLL run-time">;
226def _SLASH_MDd : Option<["/", "-"], "MDd", KIND_FLAG>, Group<_SLASH_M_Group>,
227  Flags<[CLOption, DriverOption]>, HelpText<"Use DLL debug run-time">;
228def _SLASH_MT : Option<["/", "-"], "MT", KIND_FLAG>, Group<_SLASH_M_Group>,
229  Flags<[CLOption, DriverOption]>, HelpText<"Use static run-time">;
230def _SLASH_MTd : Option<["/", "-"], "MTd", KIND_FLAG>, Group<_SLASH_M_Group>,
231  Flags<[CLOption, DriverOption]>, HelpText<"Use static debug run-time">;
232def _SLASH_o : CLJoinedOrSeparate<"o">,
233  HelpText<"Set output file or directory (ends in / or \\)">,
234  MetaVarName<"<file or directory>">;
235def _SLASH_P : CLFlag<"P">, HelpText<"Preprocess to file">;
236def _SLASH_Tc : CLCompileJoinedOrSeparate<"Tc">,
237  HelpText<"Specify a C source file">, MetaVarName<"<filename>">;
238def _SLASH_TC : CLCompileFlag<"TC">, HelpText<"Treat all source files as C">;
239def _SLASH_Tp : CLCompileJoinedOrSeparate<"Tp">,
240  HelpText<"Specify a C++ source file">, MetaVarName<"<filename>">;
241def _SLASH_TP : CLCompileFlag<"TP">, HelpText<"Treat all source files as C++">;
242def _SLASH_volatile_iso : Option<["/", "-"], "volatile:iso", KIND_FLAG>,
243  Group<_SLASH_volatile_Group>, Flags<[CLOption, DriverOption]>,
244  HelpText<"Volatile loads and stores have standard semantics">;
245def _SLASH_vmb : CLFlag<"vmb">,
246  HelpText<"Use a best-case representation method for member pointers">;
247def _SLASH_vmg : CLFlag<"vmg">,
248  HelpText<"Use a most-general representation for member pointers">;
249def _SLASH_vms : CLFlag<"vms">,
250  HelpText<"Set the default most-general representation to single inheritance">;
251def _SLASH_vmm : CLFlag<"vmm">,
252  HelpText<"Set the default most-general representation to "
253           "multiple inheritance">;
254def _SLASH_vmv : CLFlag<"vmv">,
255  HelpText<"Set the default most-general representation to "
256           "virtual inheritance">;
257def _SLASH_volatile_ms  : Option<["/", "-"], "volatile:ms", KIND_FLAG>,
258  Group<_SLASH_volatile_Group>, Flags<[CLOption, DriverOption]>,
259  HelpText<"Volatile loads and stores have acquire and release semantics">;
260def _SLASH_Zl : CLFlag<"Zl">,
261  HelpText<"Don't mention any default libraries in the object file">;
262
263def _SLASH_Yc : CLJoined<"Yc">,
264  HelpText<"Generate a pch file for all code up to and including <filename>">,
265  MetaVarName<"<filename>">;
266def _SLASH_Yu : CLJoined<"Yu">,
267  HelpText<"Load a pch file and use it instead of all code up to "
268           "and including <filename>">,
269  MetaVarName<"<filename>">;
270def _SLASH_Y_ : CLFlag<"Y-">,
271  HelpText<"Disable precompiled headers, overrides /Yc and /Yu">;
272def _SLASH_Fp : CLJoined<"Fp">,
273  HelpText<"Set pch filename (with /Yc and /Yu)">, MetaVarName<"<filename>">;
274
275def _SLASH_Gd : CLFlag<"Gd">,
276  HelpText<"Set __cdecl as a default calling convention">;
277def _SLASH_Gr : CLFlag<"Gr">,
278  HelpText<"Set __fastcall as a default calling convention">;
279def _SLASH_Gz : CLFlag<"Gz">,
280  HelpText<"Set __stdcall as a default calling convention">;
281def _SLASH_Gv : CLFlag<"Gv">,
282  HelpText<"Set __vectorcall as a default calling convention">;
283
284// Ignored:
285
286def _SLASH_analyze_ : CLIgnoredFlag<"analyze-">;
287def _SLASH_bigobj : CLIgnoredFlag<"bigobj">;
288def _SLASH_cgthreads : CLIgnoredJoined<"cgthreads">;
289def _SLASH_d2FastFail : CLIgnoredFlag<"d2FastFail">;
290def _SLASH_d2Zi_PLUS : CLIgnoredFlag<"d2Zi+">;
291def _SLASH_errorReport : CLIgnoredJoined<"errorReport">;
292def _SLASH_Fd : CLIgnoredJoined<"Fd">;
293def _SLASH_FC : CLIgnoredFlag<"FC">;
294def _SLASH_FS : CLIgnoredFlag<"FS">, HelpText<"Force synchronous PDB writes">;
295def _SLASH_GF : CLIgnoredFlag<"GF">;
296def _SLASH_kernel_ : CLIgnoredFlag<"kernel-">;
297def _SLASH_nologo : CLIgnoredFlag<"nologo">;
298def _SLASH_Og : CLIgnoredFlag<"Og">;
299def _SLASH_openmp_ : CLIgnoredFlag<"openmp-">;
300def _SLASH_RTC : CLIgnoredJoined<"RTC">;
301def _SLASH_sdl : CLIgnoredFlag<"sdl">;
302def _SLASH_sdl_ : CLIgnoredFlag<"sdl-">;
303def _SLASH_w : CLIgnoredJoined<"w">;
304def _SLASH_Zc_auto : CLIgnoredFlag<"Zc:auto">;
305def _SLASH_Zc_forScope : CLIgnoredFlag<"Zc:forScope">;
306def _SLASH_Zc_inline : CLIgnoredFlag<"Zc:inline">;
307def _SLASH_Zc_rvalueCast : CLIgnoredFlag<"Zc:rvalueCast">;
308def _SLASH_Zc_wchar_t : CLIgnoredFlag<"Zc:wchar_t">;
309def _SLASH_Zm : CLIgnoredJoined<"Zm">;
310def _SLASH_Zo : CLIgnoredFlag<"Zo">;
311def _SLASH_Zo_ : CLIgnoredFlag<"Zo-">;
312
313
314// Unsupported:
315
316def _SLASH_AI : CLJoined<"AI">;
317def _SLASH_clr : CLJoined<"clr">;
318def _SLASH_doc : CLJoined<"doc">;
319def _SLASH_FA_joined : CLJoined<"FA">;
320def _SLASH_favor : CLJoined<"favor">;
321def _SLASH_F : CLFlag<"F">;
322def _SLASH_Fm : CLJoined<"Fm">;
323def _SLASH_Fr : CLJoined<"Fr">;
324def _SLASH_FR : CLJoined<"FR">;
325def _SLASH_FU : CLJoinedOrSeparate<"FU">;
326def _SLASH_Fx : CLFlag<"Fx">;
327def _SLASH_G1 : CLFlag<"G1">;
328def _SLASH_G2 : CLFlag<"G2">;
329def _SLASH_Ge : CLFlag<"Ge">;
330def _SLASH_Gh : CLFlag<"Gh">;
331def _SLASH_GH : CLFlag<"GH">;
332def _SLASH_GL : CLFlag<"GL">;
333def _SLASH_GL_ : CLFlag<"GL-">;
334def _SLASH_Gm : CLFlag<"Gm">;
335def _SLASH_Gm_ : CLFlag<"Gm-">;
336def _SLASH_GT : CLFlag<"GT">;
337def _SLASH_Guard : CLJoined<"guard:">;
338def _SLASH_GZ : CLFlag<"GZ">;
339def _SLASH_H : CLFlag<"H">;
340def _SLASH_homeparams : CLFlag<"homeparams">;
341def _SLASH_hotpatch : CLFlag<"hotpatch">;
342def _SLASH_kernel : CLFlag<"kernel">;
343def _SLASH_LN : CLFlag<"LN">;
344def _SLASH_MP : CLJoined<"MP">;
345def _SLASH_openmp : CLFlag<"openmp">;
346def _SLASH_Qfast_transcendentals : CLFlag<"Qfast_transcendentals">;
347def _SLASH_QIfist : CLFlag<"QIfist">;
348def _SLASH_Qimprecise_fwaits : CLFlag<"Qimprecise_fwaits">;
349def _SLASH_Qpar : CLFlag<"Qpar">;
350def _SLASH_Qvec_report : CLJoined<"Qvec-report">;
351def _SLASH_u : CLFlag<"u">;
352def _SLASH_V : CLFlag<"V">;
353def _SLASH_WL : CLFlag<"WL">;
354def _SLASH_Wp64 : CLFlag<"Wp64">;
355def _SLASH_X : CLFlag<"X">;
356def _SLASH_Yd : CLFlag<"Yd">;
357def _SLASH_Yl : CLJoined<"Yl">;
358def _SLASH_Za : CLFlag<"Za">;
359def _SLASH_Zc : CLJoined<"Zc:">;
360def _SLASH_Ze : CLFlag<"Ze">;
361def _SLASH_Zg : CLFlag<"Zg">;
362def _SLASH_ZI : CLFlag<"ZI">;
363def _SLASH_ZW : CLJoined<"ZW">;
364