You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2 lines
4.2 KiB

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>ClangFrontend__ClangCommand (infer.ClangFrontend__ClangCommand)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../index.html">infer</a> &#x00BB; ClangFrontend__ClangCommand</nav><h1>Module <code>ClangFrontend__ClangCommand</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-mk"><a href="#val-mk" class="anchor"></a><code><span class="keyword">val</span> mk : <span>is_driver:bool</span> <span>&#45;&gt;</span> <a href="../ClangFrontend/ClangQuotes/index.html#type-style">ClangFrontend.ClangQuotes.style</a> <span>&#45;&gt;</span> <span>prog:string</span> <span>&#45;&gt;</span> <span>args:<span>string list</span></span> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p><code>mk ~is_driver qs prog args</code> finds the type of command depending on its arguments <code>args</code>. The quoting style of the arguments have to be provided, so that the command may be run later on. Beware that this doesn't look inside argument files. This can be used to create a &quot;clang -### ...&quot; command on which to call <code>command_to_run</code>, but other functions from the module will not work as expected unless the command has been normalized by &quot;clang -### ...&quot;.</p></dd></dl><dl><dt class="spec value" id="val-command_to_run"><a href="#val-command_to_run" class="anchor"></a><code><span class="keyword">val</span> command_to_run : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> string</code></dt><dd><p>Make a command into a string ready to be passed to a shell to be executed. Fine to call with clang driver commands.</p></dd></dl><dl><dt class="spec value" id="val-can_attach_ast_exporter"><a href="#val-can_attach_ast_exporter" class="anchor"></a><code><span class="keyword">val</span> can_attach_ast_exporter : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> bool</code></dt><dd><p>Whether the command is suitable for attaching the AST exporter. Must be called on normalized commands.</p></dd></dl><dl><dt class="spec value" id="val-may_capture"><a href="#val-may_capture" class="anchor"></a><code><span class="keyword">val</span> may_capture : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> bool</code></dt><dd><p>Whether the command has a chance of triggering compilation steps we can capture.</p></dd></dl><dl><dt class="spec value" id="val-with_plugin_args"><a href="#val-with_plugin_args" class="anchor"></a><code><span class="keyword">val</span> with_plugin_args : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p>Add the arguments needed to attach the facebook-clang-plugins plugin. Must be called on normalized commands.</p></dd></dl><dl><dt class="spec value" id="val-prepend_arg"><a href="#val-prepend_arg" class="anchor"></a><code><span class="keyword">val</span> prepend_arg : string <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-append_args"><a href="#val-append_args" class="anchor"></a><code><span class="keyword">val</span> append_args : <span>string list</span> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-get_orig_argv"><a href="#val-get_orig_argv" class="anchor"></a><code><span class="keyword">val</span> get_orig_argv : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <span>string list</span></code></dt><dt class="spec value" id="val-pp"><a href="#val-pp" class="anchor"></a><code><span class="keyword">val</span> pp : Stdlib.Format.formatter <span>&#45;&gt;</span> <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> unit</code></dt></dl></div></body></html>