Module FlowSummaryImplSpecific

Provides Ruby specific classes and predicates for defining flow summaries.

Import path

import codeql.ruby.dataflow.internal.FlowSummaryImplSpecific

Imports

All definitions in this module are required by the shared implementation (for source/sink interpretation), but they are unused for Ruby, where we rely on API graphs instead.

Predicates

getArgumentPosition	Gets the textual representation of an argument position in the format used for flow summaries.
getCallbackParameterType	Gets the type of the `i`th parameter in a synthesized call that targets a callback of type `t`.
getCallbackReturnType	Gets the return type of kind `rk` in a synthesized call that targets a callback of type `t`.
getComponentSpecific	Gets the textual representation of a summary component in the format used for flow summaries.
getContentType	Gets the type of content `c`.
getParameterPosition	Gets the textual representation of a parameter position in the format used for flow summaries.
getReturnType	Gets the return type of kind `rk` for callable `c`.
getReturnValueKind	Gets the return kind corresponding to specification `"ReturnValue"`.
getSyntheticGlobalType	Gets the type of synthetic global `sg`.
inject
inputNeedsReferenceSpecific	Holds if input specification component `c` needs a reference.
instanceParameterPosition	Gets the parameter position of the instance parameter.
interpretComponentSpecific	Gets the summary component for specification component `c`, if any.
neutralElement	Holds if a neutral model exists for `c` with provenance `provenance`, which means that there is no flow through `c`.
outputNeedsReferenceSpecific	Holds if output specification component `c` needs a reference.
parseArgBody	Gets the parameter position obtained by parsing `X` in `Argument[X]`.
parseParamBody	Gets the argument position obtained by parsing `X` in `Parameter[X]`.
summaryDataFlowCall	Gets the synthesized data-flow call for `receiver`.
summaryElement	Holds if an external flow summary exists for `c` with input specification `input`, output specification `output`, kind `kind`, and provenance `provenance`.
summaryNode	Gets the synthesized summary data-flow node for the given values.

Modules

ParsePositions

Aliases

SummarizedCallableBase

The primitive type of strings of characters. A string consists of Unicode characters expressed internally as UTF-16. All predicates that work with string length or string indices are based on counting UTF-16 code units.