Class HereDoc

A “here document”. For example:

query = <<SQL
SELECT * FROM person
WHERE age > 21
SQL

Import path

import codeql.ruby.ast.Literal

Direct supertypes

StringlikeLiteral

Indirect supertypes

Known direct subtypes

Predicates

getAPrimaryQlClass	Gets the name of a primary CodeQL class to which this node belongs.
getIndentationModifier	Gets the indentation modifier (`-` or `~`) of the here document identifier, if any. `rb <<~IDENTIFIER <<-IDENTIFIER <<IDENTIFIER`
getQuoteStyle	Gets the quotation mark (`"`, `'` or `) that surrounds the here document identifier, if any. rb <<"IDENTIFIER" <<'IDENTIFIER' <<`IDENTIFIER`
isSubShell	Holds if this here document is executed in a subshell. rb <<`COMMAND` echo "Hello world!" COMMAND

Inherited predicates

getAChild	Gets a child node of this `AstNode`.	from AstNode
getAChild	Gets a child of this node, which can also be retrieved using a predicate named `pred`.	from StringlikeLiteral
getAControlFlowEntryNode	Gets a control-flow entry node for this statement, if any	from Stmt
getAControlFlowNode	Gets a control-flow node for this statement, if any.	from Stmt
getCfgScope	Gets the control-flow scope of this statement, if any.	from Stmt
getComponent	Gets the `n`th component of this string or string-like literal. The result will be one of `StringTextComponent`, `StringInterpolationComponent`, and `StringEscapeSequenceComponent`.	from StringlikeLiteral
getConstantValue	Gets the constant value of this expression, if any.	from Expr
getDesugared	Gets the desugared version of this AST node, if any.	from AstNode
getEnclosingCallable	Gets the enclosing callable, if any.	from Stmt
getEnclosingMethod	Gets the enclosing method, if any.	from AstNode
getEnclosingModule	Gets the enclosing module, if any.	from AstNode
getEnclosingToplevel	Gets the enclosing top-level.	from AstNode
getFile	Gets the file of this node.	from AstNode
getLocation	Gets the location of this node.	from AstNode
getNumberOfComponents	Gets the number of components in this string or string-like literal.	from StringlikeLiteral
getParent	Gets the parent of this `AstNode`, if this node is not a root node.	from AstNode
getPrimaryQlClasses	Gets a comma-separated list of the names of the primary CodeQL classes to which this element belongs.	from AstNode
getValueText	DEPRECATED: Use `getConstantValue` instead.	from Expr
isSynthesized	Holds if this node was synthesized to represent an implicit AST node not present in the source code. In the following example method call, the receiver is an implicit `self` reference, for which there is a synthesized `Self` node.	from AstNode
toString	Gets a textual representation of this node.	from AstNode

Charpred

HereDoc