Variable FlowrSearchGeneratorConst

Type Declaration

• all: function

  • all(): FlowrSearchBuilder<"all">

    Returns all elements (nodes/dataflow vertices) from the given data.

    Returns FlowrSearchBuilder<"all">

• criterion: function

  • criterion<Criteria extends SlicingCriteria>(
        ...criterion: Criteria,
    ): FlowrSearchBuilder<
        "criterion",
        [],
        ParentInformation,
        FlowrCriteriaReturn<Criteria>,
    >

    Returns all elements that match the given criteria (e.g., criterion('2@x', '3@<-'), to retrieve the first use of x in the second line and the first <- assignment in the third line). This will throw an error, if any criteria cannot be resolved to an id.

    Type Parameters

    • Criteria extends SlicingCriteria

    Parameters

    • ...criterion: Criteria

    Returns FlowrSearchBuilder<
        "criterion",
        [],
        ParentInformation,
        FlowrCriteriaReturn<Criteria>,
    >

• from: function

  • from(
        from:
            | FlowrSearchElement<ParentInformation>
            | FlowrSearchElement<ParentInformation>[],
    ): FlowrSearchBuilder<"from">

    Initialize a search query with the given elements. This is not intended to serialize well wrt. the nodes, see FlowrSearchGenerator.criterion for a serializable alternative (passing the ids with $id).

    Parameters

    • from: FlowrSearchElement<ParentInformation> | FlowrSearchElement<ParentInformation>[]

    Returns FlowrSearchBuilder<"from">

• fromQuery: function

  • fromQuery(
        ...from: readonly Query[],
    ): FlowrSearchBuilder<
        "from-query",
        [],
        ParentInformation,
        FlowrSearchElements<
            ParentInformation,
            FlowrSearchElement<ParentInformation>[],
        >,
    >

    Initializes a new search query based on the results of the given JSON query or queries. Internally, the SupportedQuery#flattenInvolvedNodes function is used to flatten the resulting nodes of the query. Please note that, due to the fact that not every query involves dataflow nodes, the search may not contain any elements at all for certain queries.

    Parameters

    • ...from: readonly Query[]

    Returns FlowrSearchBuilder<
        "from-query",
        [],
        ParentInformation,
        FlowrSearchElements<
            ParentInformation,
            FlowrSearchElement<ParentInformation>[],
        >,
    >

• get: function

  • get(filter: FlowrSearchGetFilter): FlowrSearchBuilder<"get">

    Returns all elements that match the given FlowrSearchGetFilters|filters. You may pass a negative line number to count from the back. Please note that this is currently only working for single files, it approximates over the nodes, and it is not to be used for "production".

    Parameters

    • filter: FlowrSearchGetFilter

    Returns FlowrSearchBuilder<"get">

• id: function

  • id(id: NodeId): FlowrSearchBuilder<"get">

    Short form of get with only the FlowrSearchGetFilters#id|id filter: get({id}).

    Parameters

    • id: NodeId

    Returns FlowrSearchBuilder<"get">

• loc: function

  • loc(line?: number, column?: number): FlowrSearchBuilder<"get">

    Short form of get with only the FlowrSearchGetFilters#line|line and FlowrSearchGetFilters#column|column filters: get({line, column}).

    Parameters

    • Optionalline: number
    • Optionalcolumn: number

    Returns FlowrSearchBuilder<"get">

• syntax: function

  • syntax(
        source: string | Query,
        ...captures: readonly string[],
    ): FlowrSearchBuilder<
        "from-query",
        [],
        ParentInformation,
        FlowrSearchElements<
            ParentInformation,
            FlowrSearchElement<ParentInformation>[],
        >,
    >

    Initializes a new search query based on the results of the given tree-sitter syntax query. Please note that this search generator is incompatible with the RShell parser and only works when using flowR with the TreeSitterExecutor.

    Parameters

    • source: string | Query
    • ...captures: readonly string[]

    Returns FlowrSearchBuilder<
        "from-query",
        [],
        ParentInformation,
        FlowrSearchElements<
            ParentInformation,
            FlowrSearchElement<ParentInformation>[],
        >,
    >

• var: function

  • var(name: string): FlowrSearchBuilder<"get">

    Short form of get with only the FlowrSearchGetFilters#name|name filter: get({name}).

    Parameters

    • name: string

    Returns FlowrSearchBuilder<"get">

• varInLine: function

  • varInLine(name: string, line: number): FlowrSearchBuilder<"get">

    Short form of get with only the FlowrSearchGetFilters#name|name and FlowrSearchGetFilters#line|line filters: get({name, line}).

    Parameters

    • name: string
    • line: number

    Returns FlowrSearchBuilder<"get">