- @eagleoutice/flowr
- src/project/plugins/file-plugins/flowr-analyzer-description-file-plugin
- FlowrAnalyzerDescriptionFilePlugin
Class FlowrAnalyzerDescriptionFilePlugin
Hierarchy (View Summary)
- FlowrAnalyzerFilePlugin
- FlowrAnalyzerDescriptionFilePlugin
Hierarchy-Diagram
Index
Constructors
Properties
Methods
Properties
Readonlydescription
description: "This plugin provides support for DESCRIPTION files and extracts their content into key-value(s) pairs." = 'This plugin provides support for DESCRIPTION files and extracts their content into key-value(s) pairs.'
A short description of what the plugin does.
Readonlyname
name: "flowr-analyzer-description-file-plugin" = 'flowr-analyzer-description-file-plugin'
A unique, human-readable name of the plugin.
Readonlytype
The type of the plugin, determining when and for what purpose it is applied during the analysis.
Readonlyversion
version: SemVer = ...
The version of the plugin, ideally following semver.
Methods
Staticdefault
Returns a default/dummy implementation to be used when no plugin of this type is registered or triggered.
Returns FlowrAnalyzerFilePlugin
applies
Determine whether this plugin applies to the given file.
Parameters
- file: PathLike
Returns boolean
process
Parameters
- _ctx: FlowrAnalyzerContext
- file: FlowrFileProvider<string>
Returns FlowrDescriptionFile
processor
Run the plugin with the given context and arguments.
Parameters
- context: FlowrAnalyzerContext
- args: FlowrFileProvider
Returns FlowrFileProvider
Settings
Member Visibility
On This Page
Constructors
Properties
- src
- util
- collections
- formats
- adapters
- adapter.ts
- adapter-format.ts
- mermaid
- simple-df
- text
- parallel.ts
- assert.ts
- containers.ts
- diff.ts
- diff-graph.ts
- files.ts
- html-hover-over.ts
- json.ts
- log.ts
- logic.ts
- numbers.ts
- objects.ts
- os.ts
- prefix.ts
- quads.ts
- r-value.ts
- random.ts
- range.ts
- schema.ts
- summarizer.ts
- version.ts
- abstract-interpretation
- data-frame
- mappers
- absint-info.ts
- absint-visitor.ts
- dataframe-domain.ts
- domain.ts
- <internal>
- addInterval
- ColNamesBottom
- ColNamesDomain
- ColNamesTop
- DataFrameBottom
- DataFrameDomain
- DataFrameStateDomain
- DataFrameTop
- equalColNames
- equalDataFrameDomain
- equalDataFrameState
- equalInterval
- extendIntervalToInfinity
- extendIntervalToZero
- IntervalBottom
- IntervalDomain
- IntervalTop
- joinColNames
- joinDataFrames
- joinDataFrameStates
- joinInterval
- leqColNames
- leqInterval
- maxInterval
- meetColNames
- meetDataFrames
- meetDataFrameStates
- meetInterval
- minInterval
- satisfiesColsNames
- satisfiesInterval
- satisfiesLeqInterval
- subtractColNames
- subtractInterval
- wideningColNames
- wideningDataFrames
- wideningDataFrameStates
- wideningInterval
- resolve-args.ts
- semantics.ts
- shape-inference.ts
- domains
- normalized-ast-fold.ts
- data-frame
- 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
- control-flow
- basic-cfg-guided-visitor.ts
- cfg-dead-code.ts
- cfg-properties.ts
- cfg-simplification.ts
- cfg-to-basic-blocks.ts
- control-flow-graph.ts
- <internal>
- CfgBasicBlockVertex
- CfgControlDependencyEdge
- CfgEdge
- CfgEdgeType
- CfgEndMarkerVertex
- CfgExpressionVertex
- CfgSimpleVertex
- CfgStatementVertex
- CfgVertexType
- CfgWithRoot
- ControlFlowGraph
- ControlFlowInformation
- edgeTypeToString
- emptyControlFlowInformation
- equalVertex
- getVertexRootId
- isMarkerVertex
- ReadOnlyControlFlowGraph
- dfg-cfg-guided-visitor.ts
- diff-cfg.ts
- extract-cfg.ts
- happens-before.ts
- semantic-cfg-guided-visitor.ts
- simple-visitor.ts
- syntax-cfg-guided-visitor.ts
- useless-loop.ts
- core
- steps
- all
- core
- static-slicing
- pipeline
- create-pipeline.ts
- default-pipelines.ts
- createDataflowPipeline
- createNormalizePipeline
- createParsePipeline
- createSlicePipeline
- DEFAULT_DATAFLOW_PIPELINE
- DEFAULT_NORMALIZE_PIPELINE
- DEFAULT_PARSE_PIPELINE
- DEFAULT_SLICE_AND_RECONSTRUCT_PIPELINE
- DEFAULT_SLICE_WITHOUT_RECONSTRUCT_PIPELINE
- DEFAULT_SLICING_PIPELINE
- TREE_SITTER_DATAFLOW_PIPELINE
- TREE_SITTER_NORMALIZE_PIPELINE
- TREE_SITTER_PARSE_PIPELINE
- TREE_SITTER_SLICE_AND_RECONSTRUCT_PIPELINE
- TREE_SITTER_SLICE_WITHOUT_RECONSTRUCT_PIPELINE
- TREE_SITTER_SLICING_PIPELINE
- invalid-pipeline-error.ts
- pipeline.ts
- pipeline-step.ts
- all
- pipeline-executor.ts
- dataflow
- environments
- append.ts
- built-in.ts
- BuiltIn
- BuiltInEvalHandler
- BuiltInEvalHandlerMapper
- builtInId
- BuiltInIdentifierConstant
- BuiltInIdentifierDefinition
- BuiltInIdentifierProcessor
- BuiltInIdentifierProcessorWithConfig
- BuiltInMappingName
- BuiltInMemory
- BuiltInProcessorMapper
- BuiltIns
- ConfigOfBuiltInMappingName
- DefaultBuiltInProcessorConfiguration
- isBuiltIn
- UseAsProcessors
- built-in-config.ts
- clone.ts
- default-builtin-config.ts
- define.ts
- diff.ts
- environment.ts
- identifier.ts
- overwrite.ts
- remove.ts
- resolve-by-name.ts
- scoping.ts
- eval
- resolve
- values
- intervals
- logical
- scalar
- sets
- string
- vectors
- general.ts
- r-value.ts
- fn
- graph
- dataflowgraph-builder.ts
- diff-dataflow-graph.ts
- edge.ts
- graph.ts
- invert-dfg.ts
- quads.ts
- resolve-graph.ts
- unknown-replacement.ts
- unknown-side-effect.ts
- vertex.ts
- <internal>
- ContainerIndex
- ContainerIndices
- ContainerIndicesCollection
- ContainerLeafIndex
- ContainerParentIndex
- DataflowGraphVertexArgument
- DataflowGraphVertexAstLink
- DataflowGraphVertexFunctionCall
- DataflowGraphVertexFunctionDefinition
- DataflowGraphVertexInfo
- DataflowGraphVertexUse
- DataflowGraphVertexValue
- DataflowGraphVertexVariableDefinition
- DataflowGraphVertices
- FunctionOriginInformation
- IndexIdentifier
- isAccessed
- isFunctionCallVertex
- isFunctionDefinitionVertex
- isNamedArgumentId
- isParentContainerIndex
- isSameIndex
- isUseVertex
- isValueVertex
- isVariableDefinitionVertex
- NamedArgumentId
- UnnamedArgumentId
- ValidVertexTypeReverse
- ValidVertexTypes
- VertexType
- internal
- process
- functions
- call
- argument
- built-in
- built-in-access.ts
- built-in-apply.ts
- built-in-assignment.ts
- built-in-eval.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-list.ts
- built-in-pipe.ts
- built-in-quote.ts
- built-in-repeat-loop.ts
- built-in-replacement.ts
- built-in-rm.ts
- built-in-source.ts
- built-in-special-bin-op.ts
- built-in-vector.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
- origin
- cluster.ts
- extractor.ts
- info.ts
- logger.ts
- processor.ts
- environments
- documentation
- data
- doc-util
- doc-auto-gen.ts
- doc-benchmarks.ts
- doc-cfg.ts
- doc-cli-option.ts
- doc-code.ts
- doc-dfg.ts
- doc-docker.ts
- doc-env.ts
- doc-escape.ts
- doc-files.ts
- doc-functions.ts
- doc-general.ts
- doc-issue.ts
- doc-normalized-ast.ts
- doc-print.ts
- doc-query.ts
- doc-repl.ts
- doc-search.ts
- doc-server-message.ts
- doc-structure.ts
- doc-types.ts
- <internal>
- dropGenericsFromTypeName
- followTypeReference
- getDocumentationForType
- GetDocumentationForTypeFilters
- getStartLineOfTypeScriptNode
- getTextualCommentsFromTypeScript
- getType
- getTypePathForTypeScript
- getTypePathLink
- GetTypesAsMermaidOption
- getTypeScriptSourceFiles
- getTypesFromFolder
- implSnippet
- mermaidHide
- printCodeOfElement
- printHierarchy
- PrintHierarchyArguments
- removeCommentSymbolsFromTypeScriptComment
- shortLink
- shortLinkFile
- TypeElementInSource
- TypeElementKind
- TypeReport
- print-analyzer-wiki.ts
- print-capabilities-markdown.ts
- print-cfg-wiki.ts
- print-core-wiki.ts
- print-dataflow-graph-wiki.ts
- print-engines-wiki.ts
- print-faq-wiki.ts
- print-interface-wiki.ts
- print-linter-issue.ts
- print-linter-wiki.ts
- print-linting-and-testing-wiki.ts
- print-normalized-ast-wiki.ts
- print-onboarding-wiki.ts
- print-query-wiki.ts
- print-readme.ts
- print-search-wiki.ts
- linter
- project
- cache
- context
- plugins
- file-plugins
- loading-order-plugins
- package-version-plugins
- project-discovery
- flowr-analyzer-plugin.ts
- cfg-kind.ts
- flowr-analyzer.ts
- flowr-analyzer-builder.ts
- queries
- catalog
- call-context-query
- cluster-query
- config-query
- control-flow-query
- dataflow-lens-query
- dataflow-query
- dependencies-query
- df-shape-query
- happens-before-query
- id-map-query
- inspect-higher-order-query
- lineage-query
- linter-query
- location-map-query
- normalized-ast-query
- origin-query
- project-query
- resolve-value-query
- search-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
- tree-sitter
- convert-values.ts
- ast
- init.ts
- parser.ts
- retriever.ts
- fileProtocol
- isEmptyRequest
- isParseRequest
- ParseRequestAdditionalInfoBase
- removeRQuotes
- requestFromInput
- requestProviderFromFile
- requestProviderFromText
- retrieveNormalizedAstFromRCode
- retrieveNumberOfRTokensOfLastParse
- retrieveParseDataFromRCode
- RParseRequest
- RParseRequestFromFile
- RParseRequestFromText
- RParseRequestProvider
- RParseRequests
- shell.ts
- shell-executor.ts
- reconstruct
- search
- search-executor
- search-enrichers.ts
- CallTargetsContent
- CfgInformationArguments
- CfgInformationElementContent
- CfgInformationSearchContent
- enrichElement
- Enrichment
- enrichmentContent
- EnrichmentData
- EnrichmentElementArguments
- EnrichmentElementContent
- Enrichments
- EnrichmentSearchArguments
- EnrichmentSearchContent
- LastCallContent
- QueryDataElementContent
- QueryDataSearchContent
- search-generators.ts
- search-mappers.ts
- search-transformer.ts
- search-enrichers.ts
- search-optimizer
- flowr-search.ts
- flowr-search-builder.ts
- flowr-search-executor.ts
- flowr-search-filters.ts
- flowr-search-printer.ts
- flowr-search-traverse.ts
- search-executor
- 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
- engines.ts
- util
- test
- functionality
- _helper
- controlflow
- dataflow
- ast-builder.ts
- label.ts
- linter.ts
- log.ts
- net.ts
- network.ts
- pointer-analysis.ts
- provider.ts
- query.ts
- search.ts
- shell.ts
- <internal>
- assertAst
- assertContainerIndicesDefinition
- assertDataflow
- assertDecoratedAst
- assertOutput
- assertReconstructed
- assertSliced
- assertSlicedF
- defaultTestConfiguration
- retrieveNormalizedAst
- sameForSteps
- skipTestBecauseConfigNotMet
- TestCaseFailType
- TestConfiguration
- TestConfigurationWithOutput
- testWithShell
- withShell
- withTreeSitter
- _helper
- functionality
This plugin provides support for R
DESCRIPTIONfiles.