/
PredicateMapping.ts
73 lines (65 loc) · 2.12 KB
/
PredicateMapping.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
/*
* Copyright © 2019 Atomist, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { Mapping } from "./Mapping";
/**
* Style of logical composition
*/
export enum PredicateMappingCompositionStyle {
And = "and",
Or = "or",
Not = "not",
}
/**
* Mapping to a boolean
*/
export interface PredicateMapping<F> extends Mapping<F, boolean> {
/**
* If this predicate has internal structure,
* the components and how they are applied.
* For internal and tooling use.
*/
readonly structure?: {
components: Array<PredicateMapping<F>>,
readonly compositionStyle: PredicateMappingCompositionStyle,
};
}
/**
* Implemented by types whose behavior is potentially explicable by a single PredicateMapping
*/
export interface Predicated<F> {
/**
* The test for the contribution. Contributions may be
* applied in various ways.
*/
test?: PredicateMapping<F>;
}
/**
* Function that can visit a PredicateMappings.
* @return whether to visit the mapping's subcomponents, if any
*/
export type PredicateMappingVisitor<F> = (pm: PredicateMapping<F>) => boolean;
/**
* Visit the PredicateMappings, returning whether to continue
* @param pm predicate mapping to visit. Always visits root,
* and any subcomponents as long as the visitor returns true
* @param v visitor
* @return {boolean} whether to visit the mapping's structure, if any
*/
export function visitPredicateMappings<F>(pm: PredicateMapping<F>, v: PredicateMappingVisitor<F>): void {
if (v(pm) && !!pm.structure) {
pm.structure.components.forEach(n => visitPredicateMappings(n, v));
}
}