This is an archive of the discontinued LLVM Phabricator instance.

Thank you for this, I think it's helpful documentation! I have a few questions. Given that LibASTMatchersReference.html is a generated document, will these changes get overwritten by running dump_ast_matchers.py? Would it be possible to use some form of markup in ASTMatchers.h to generate this documentation so that it's easier to flag a particular matcher as being a "convenience" matcher? I expect we'll want to extend this list and it'd be nice if we didn't have some types of documentation that come from ASTMatchers.h and others that require manually editing the generated HTML file.

Revision Contents

Path

Size

clang/

docs/

LibASTMatchersReference.html

18 lines

Diff 327213

clang/docs/LibASTMatchersReference.html

This file is larger than 256 KB, so syntax highlighting is disabled by default.

	Show First 20 Lines • Show All 537 Lines • ▼ Show 20 Lines
	</td>			</td>
	<td>			<td>
	No match found.			No match found.
	</td>			</td>
	</tr>			</tr>
	</table>			</table>

	<!-- ======================================================================= -->			<!-- ======================================================================= -->
				<h2 id="convenience-matchers">Convenience Matchers</h2>
				<!-- ======================================================================= -->

				<p>Several matchers are only for convenience, in that they allow matching of
				nodes which can be done in other, more verbose ways.</p>

				<dl>
				<dt><tt>optionally(...)</tt></dt>
				<dd>Equivalent to <tt>anyOf(..., anything())</tt>.</dd>
				<dt><tt>mapAnyOf(...).with(...)</tt></dt>
				<dd>A builder type for convenience matchers. Allows mapping matchers into specified node matchers without repetition. This makes <tt>mapAnyOf(ifStmt, forStmt).with(hasCondition(expr()))</tt> an equivalent to <tt>anyOf(ifStmt(hasCondition(expr())), forStmt(hasCondition(expr())))</tt>.</dd>
				<dt><tt>binaryOperation(...)</tt></dt>
				<dd>Convenience for <tt>mapAnyOf(binaryOperator(...), cxxOperatorCallExpr(...), cxxRewrittenBinaryOperator(...))</tt>.</dd>
				<dt><tt>invocation(...)</tt></dt>
				<dd>Convenience for <tt>mapAnyOf(callExpr(...), cxxConstructorExpr(...))</tt>. Primarily useful for matching arguments to either kind of node.</dd>
				</dl>

				<!-- ======================================================================= -->
	<h2 id="decl-matchers">Node Matchers</h2>			<h2 id="decl-matchers">Node Matchers</h2>
	<!-- ======================================================================= -->			<!-- ======================================================================= -->

	<p>Node matchers are at the core of matcher expressions - they specify the type			<p>Node matchers are at the core of matcher expressions - they specify the type
	of node that is expected. Every match expression starts with a node matcher,			of node that is expected. Every match expression starts with a node matcher,
	which can then be further refined with a narrowing or traversal matcher. All			which can then be further refined with a narrowing or traversal matcher. All
	traversal matchers take node matchers as their arguments.</p>			traversal matchers take node matchers as their arguments.</p>

	▲ Show 20 Lines • Show All 8,396 Lines • Show Last 20 Lines

This is an archive of the discontinued LLVM Phabricator instance.

[ASTMatchers] Add documentation for convenience matchersNeeds ReviewPublic

Details

Diff Detail

Event Timeline

Revision Contents

Diff 327213

clang/docs/LibASTMatchersReference.html

[ASTMatchers] Add documentation for convenience matchers
Needs ReviewPublic