| License | GNU LGPLv3 |
|---|---|
| Maintainer | paul.bittner@uni-ulm.de |
| Safe Haskell | None |
FeatureTraceRecording
Description
Data types and framework for feature trace recording. This module provides functions to run feature trace recording as well as the datatypes required to implement custom feature trace recording algorithms (i.e., variations of Algorithm 1 in the paper) and functions (i.e., supporting new edit types or adapting/replacing the default recording functions for different use cases).
Synopsis
- type FeatureContext = FeatureFormula
- type RecordedEdit g a = (Edit g a, FeatureContext)
- type History g a = [RecordedEdit g a]
- type Version g a = (FeatureTrace g a, AST g a)
- type RecordingFunction g a = RecordedEdit g a -> Version g a -> FeatureTrace g a
- type FeatureTraceRecording g a = EditType -> RecordingFunction g a
- runFTR :: (Show a, Eq a) => FeatureTraceRecording g a -> Version g a -> History g a -> Version g a
- runFTRWithIntermediateSteps :: (Show a, Eq a) => FeatureTraceRecording g a -> Version g a -> History g a -> [Version g a]
Documentation
type FeatureContext = FeatureFormula Source #
The feature context is a nullable propositional formula over features to tag edits to source code with the feature that was edited.
type RecordedEdit g a = (Edit g a, FeatureContext) Source #
Encapsulates an edit that was made under a given FeatureContext.
This relation might be established upon commit to version control or via IDE interaction (see Section 4.1 in the paper).
type History g a = [RecordedEdit g a] Source #
We call a list of edits a change History.
type Version g a = (FeatureTrace g a, AST g a) Source #
We denote the state of a software system at any point in time as a Version.
We describe a version by the software artefacts in terms of an AST and the according FeatureTraces we have at that version.
type RecordingFunction g a = RecordedEdit g a -> Version g a -> FeatureTrace g a Source #
Type of recording functions for individual edit types. In the paper, these edits are referred to as R_ins, R_del, R_mov, and R_up. Instead of passing the delta, we give the entire edit as input to the function from which the delta can be calculated.
type FeatureTraceRecording g a = EditType -> RecordingFunction g a Source #
Abstraction over Algorithm 1 in the paper. For different use cases and to prevent future errors, feature trace recording is configurable. In a framework-like manner, it gives us an implementation for a recording function identified by edit types.
runFTR :: (Show a, Eq a) => FeatureTraceRecording g a -> Version g a -> History g a -> Version g a Source #
Runs the given FeatureTraceRecording implementation starting at the given Version.
All edits in the given History will be applied to the given version yielding the new version after that history.
runFTRWithIntermediateSteps :: (Show a, Eq a) => FeatureTraceRecording g a -> Version g a -> History g a -> [Version g a] Source #
Similar to runFTR but also returns all intermediate results.