Interface FlowrConfigOptions

interface FlowrConfigOptions {
    defaultEngine?: "r-shell" | "tree-sitter";
    engines: readonly EngineConfig[];
    ignoreSourceCalls: boolean;
    semantics: {
        environment: {
            overwriteBuiltIns: {
                definitions: BuiltInDefinitions;
                loadDefaults?: boolean;
            };
        };
    };
    solver: {
        pointerTracking: boolean;
        variables: VariableResolve;
    };
}

Hierarchy (view full)

Hierarchy-Diagram

UML class diagram of FlowrConfigOptions

Properties

defaultEngine? engines ignoreSourceCalls semantics solver

Properties

Optional ReadonlydefaultEngine

defaultEngine?: "r-shell" | "tree-sitter"

The default engine to use for interacting with R code. If this is undefined, an arbitrary engine from engines will be used.

Readonlyengines

engines: readonly EngineConfig[]

The engines to use for interacting with R code. Currently supports TreeSitterEngineConfig and RShellEngineConfig. An empty array means all available engines will be used.

ReadonlyignoreSourceCalls

ignoreSourceCalls: boolean

Whether source calls should be ignored, causing processSourceCall's behavior to be skipped

Readonlysemantics

semantics: {
    environment: {
        overwriteBuiltIns: {
            definitions: BuiltInDefinitions;
            loadDefaults?: boolean;
        };
    };
}

Configure language semantics and how flowR handles them

Type declaration

  • Readonlyenvironment: {
        overwriteBuiltIns: {
            definitions: BuiltInDefinitions;
            loadDefaults?: boolean;
        };
    }

    Semantics regarding the handlings of the environment

    • ReadonlyoverwriteBuiltIns: {
          definitions: BuiltInDefinitions;
          loadDefaults?: boolean;
      }

      Do you want to overwrite (parts) of the builtin definition?

      • Readonlydefinitions: BuiltInDefinitions

        The definitions to load

      • Optional ReadonlyloadDefaults?: boolean

        Should the default configuration still be loaded?

Readonlysolver

solver: {
    pointerTracking: boolean;
    variables: VariableResolve;
}

How to resolve constants, constraints, cells, ...

Type declaration

  • ReadonlypointerTracking: boolean

    Whether to track pointers in the dataflow graph, if not, the graph will be over-approximated wrt. containers and accesses

  • Readonlyvariables: VariableResolve

    How to resolve variables and their values

Settings

Member Visibility

On This Page

Properties