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