@eagleoutice/flowr - v2.13.14
    Preparing search index...

    Interface DefaultBuiltInProcessorConfiguration

    Semantics of a built-in that hold no matter which processor handles the call. The remaining facts already have a home: the exit behavior in cfg, whether flowR can fold the call in the evalHandler of the definition, and the fallback for everything unmodelled in hasUnknownSideEffects.

    interface DefaultBuiltInProcessorConfiguration {
        cfg?: ExitPointType;
        forceArgs?: "all" | readonly boolean[];
        hasUnknownSideEffects?: boolean | LinkTo<string | RegExp>;
        keepArgumentOut?: boolean;
        keepEnvironment?: boolean;
        markArgsAsMasked?: readonly number[] | NseArguments;
        markArgsAsNSE?: readonly number[] | NseArguments;
        props?: number;
        readAllArguments?: boolean;
        sig?: FnSig;
        treatAsFnCall?: Record<string, readonly string[]>;
        useAsProcessor?: BuiltInProcName;
    }

    Hierarchy (View Summary)

    Index
    cfg? forceArgs? hasUnknownSideEffects? keepArgumentOut? keepEnvironment? markArgsAsMasked? markArgsAsNSE? props? readAllArguments? sig? treatAsFnCall? useAsProcessor?
    cfg?: ExitPointType
    forceArgs?: "all" | readonly boolean[]

    which of the arguments should be forced? this may be all, e.g., if the function itself is unknown on encounter

    hasUnknownSideEffects?: boolean | LinkTo<string | RegExp>
    keepArgumentOut?: boolean

    Propagate the out references produced by the arguments instead of dropping them. Set this for functions that are transparent about their arguments, like (.

    keepEnvironment?: boolean

    keep the environment on the call vertex, for a later pass to look names up in

    markArgsAsMasked?: readonly number[] | NseArguments

    Mark the given arguments as evaluated in a data mask, like subset: their symbols may name columns of the data instead of variables, while everything else in them is evaluated in the caller's frame as usual.

    markArgsAsNSE?: readonly number[] | NseArguments

    Mark the given arguments as non-standard-evaluated, like quote.

    props?: number

    bitfield of CallProp

    readAllArguments?: boolean
    sig?: FnSig

    the parameters and what each of their arguments is used for

    treatAsFnCall?: Record<string, readonly string[]>

    record mapping the actual function name called to the arguments that should be treated as function calls

    useAsProcessor?: BuiltInProcName

    Name that should be used for the origin (useful when needing to differentiate between functions like 'return' that use the default builtin processor)

    Settings
    Member Visibility

    On This Page
    Properties