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.
7 lines
4.7 KiB
7 lines
4.7 KiB
<!DOCTYPE html>
|
|
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>ClangCommand (infer.InferModules.ClangCommand)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><meta name="generator" content="doc-ock-html v1.0.0-1-g1fc9bf0"/></head><body><nav id="top"><a href="../index.html">Up</a> — <span class="package">package <a href="../../index.html">infer</a></span></nav><header><h1><span class="keyword">Module</span> <span class="module-path">InferModules.ClangCommand</span></h1></header><div class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><div class="def type"><code><span class="keyword">type </span>t</code><code></code><code></code></div><div class="doc"></div></div><div class="spec val" id="val-mk"><a href="#val-mk" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>mk : is_driver:bool <span class="keyword">‑></span> <a href="../ClangQuotes/index.html#type-style">ClangQuotes.style</a> <span class="keyword">‑></span> prog:string <span class="keyword">‑></span> args:string list <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p><code class="code">mk ~is_driver qs prog args</code> finds the type of command depending on its arguments <code class="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 "clang -###
|
|
..." command on which to call <code class="code">command_to_run</code>, but other functions from the module will not work
|
|
as expected unless the command has been normalized by "clang -### ...".</p></div></div><div class="spec val" id="val-command_to_run"><a href="#val-command_to_run" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>command_to_run : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string</code></div><div class="doc"><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></div></div><div class="spec val" id="val-can_attach_ast_exporter"><a href="#val-can_attach_ast_exporter" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>can_attach_ast_exporter : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><p>Whether the command is suitable for attaching the AST exporter. Must be called on normalized commands.</p></div></div><div class="spec val" id="val-may_capture"><a href="#val-may_capture" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>may_capture : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> bool</code></div><div class="doc"><p>Whether the command has a chance of triggering compilation steps we can capture.</p></div></div><div class="spec val" id="val-with_plugin_args"><a href="#val-with_plugin_args" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>with_plugin_args : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"><p>Add the arguments needed to attach the facebook-clang-plugins plugin. Must be called on normalized commands.</p></div></div><div class="spec val" id="val-prepend_arg"><a href="#val-prepend_arg" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>prepend_arg : string <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-append_args"><a href="#val-append_args" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>append_args : string list <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> <a href="index.html#type-t">t</a></code></div><div class="doc"></div></div><div class="spec val" id="val-get_orig_argv"><a href="#val-get_orig_argv" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>get_orig_argv : <a href="index.html#type-t">t</a> <span class="keyword">‑></span> string list</code></div><div class="doc"></div></div><div class="spec val" id="val-pp"><a href="#val-pp" class="anchor"></a><div class="def val"><code><span class="keyword">val </span>pp : Format.formatter <span class="keyword">‑></span> <a href="index.html#type-t">t</a> <span class="keyword">‑></span> unit</code></div><div class="doc"></div></div></body></html> |