Interface FileAnalysisRequestMessage
cfg?: boolean;
content?: string;
filename?: string;
filepath?: string | readonly string[];
filetoken?: string;
format?: "json" | "n-quads";
id: undefined | string;
type: "request-file-analysis";
}
Hierarchy (view full)
- IdMessageBase
- FileAnalysisRequestMessage
Hierarchy-Diagram
Properties
Optionalcfg
Can be used to additionally extract the ControlFlowInformation of the file, which is not exposed (and not fully calculated) by default.
Optionalcontent
The contents of the file, or an R expression itself (like 1 + 1), give either this or the filepath.
If you want to load multiple R files as one, either use filepath or concatenate the file-contents for this field.
Optionalfilename
A human-readable file name. If you present a filepath or read from a file this should be straightforward.
However, the name is only for debugging and bears no semantic meaning.
Optionalfilepath
The filepath on the local machine, accessible to flowR, or simply. Give either this or the content.
If you want to load multiple R files as one, either use this or concatenate the file-contents for the content.
Optionalfiletoken
This is a unique token that you assign to subsequently slice the respective files. If you pass the same token multiple times, previous results will be overwritten.
If you do not pass a file token, the server will not store the results!
Optionalformat
Controls the serialization of the results (and the ControlFlowGraph if the corresponding flag is set). If missing, we assume json.
id
The id that links a request with its responses, it is up to the calling client to make sure it is unique. However, the client does not have to pass the id if it does not need to link the request with its response. The id is always undefined if the message is unprompted (e.g., with hello) or the id unknown.
type
The at this time unknown type
- src
- util
- abstract-interpretation
- benchmark
- stats
- summarizer
- first-phase
- second-phase
- data.ts
- summarizer.ts
- slicer.ts
- stopwatch.ts
- cli
- common
- repl
- commands
- server
- core.ts
- execute.ts
- print-version.ts
- prompt.ts
- script-core
- benchmark-app.ts
- benchmark-helper-app.ts
- export-quads-app.ts
- flowr.ts
- flowr-main-options.ts
- run-script.ts
- slicer-app.ts
- statistics-app.ts
- statistics-helper-app.ts
- summarizer-app.ts
- core
- dataflow
- environments
- graph
- dataflowgraph-builder.ts
- diff.ts
- edge.ts
- graph.ts
- quads.ts
- resolve-graph.ts
- vertex.ts
- <internal>
- DataflowGraphVertexArgument
- DataflowGraphVertexFunctionCall
- DataflowGraphVertexFunctionDefinition
- DataflowGraphVertexInfo
- DataflowGraphVertexUse
- DataflowGraphVertexValue
- DataflowGraphVertexVariableDefinition
- DataflowGraphVertices
- isFunctionCallVertex
- isFunctionDefinitionVertex
- isUseVertex
- isValueVertex
- isVariableDefinitionVertex
- VertexType
- internal
- process
- functions
- call
- argument
- built-in
- built-in-access.ts
- built-in-apply.ts
- built-in-assignment.ts
- built-in-expression-list.ts
- built-in-for-loop.ts
- built-in-function-definition.ts
- built-in-get.ts
- built-in-if-then-else.ts
- built-in-library.ts
- built-in-pipe.ts
- built-in-quote.ts
- built-in-repeat-loop.ts
- built-in-replacement.ts
- built-in-source.ts
- built-in-special-bin-op.ts
- built-in-while-loop.ts
- common.ts
- default-call-handling.ts
- known-call-handling.ts
- named-call-handling.ts
- unnamed-call-handling.ts
- process-argument.ts
- process-parameter.ts
- call
- process-named-call.ts
- process-symbol.ts
- process-uninteresting-leaf.ts
- process-value.ts
- functions
- linker.ts
- process
- cluster.ts
- extractor.ts
- info.ts
- logger.ts
- processor.ts
- documentation
- data
- doc-util
- print-capabilities-markdown.ts
- print-dataflow-graph-wiki.ts
- print-interface-wiki.ts
- print-linting-and-testing-wiki.ts
- print-normalized-ast-wiki.ts
- print-query-wiki.ts
- queries
- catalog
- call-context-query
- cluster-query
- dataflow-query
- dependencies-query
- id-map-query
- lineage-query
- location-map-query
- normalized-ast-query
- static-slice-query
- virtual-query
- base-query-format.ts
- query.ts
- query-print.ts
- two-layer-collector.ts
- catalog
- r-bridge
- data
- lang-4.x
- ast
- model
- nodes
- processing
- collect.ts
- model.ts
- operators.ts
- type.ts
- versions.ts
- parser
- json
- main
- internal
- control
- expression
- functions
- loops
- operators
- other
- structure
- values
- normalize-access.ts
- normalize-meta.ts
- normalizer-data.ts
- internal
- model
- convert-values.ts
- ast
- init.ts
- retriever.ts
- shell.ts
- shell-executor.ts
- reconstruct
- slicing
- criterion
- static
- statistics
- features
- supported
- assignments
- comments
- control-flow
- data-access
- defined-functions
- expression-list
- loops
- used-functions
- used-packages
- values
- variables
- common-syntax-probability.ts
- feature.ts
- post-processing.ts
- supported
- output
- summarizer
- first-phase
- post-process
- second-phase
- auto-detect.ts
- summarizer.ts
- meta-statistics.ts
- statistics.ts
- features
- config.ts
- test
- functionality
Send by the client to request an analysis of a given file. Answered by either an FlowrErrorMessage or a FileAnalysisResponseMessageJson.