aboutsummaryrefslogtreecommitdiff
path: root/edify/elements/types/quantifiers.py
blob: 9fbd8e460b14aedbe85ed9464f9170fd7db2d722 (plain)
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
"""Quantifier element classes — operators that repeat a single child element.

Each quantifier wraps exactly one child element and renders the appropriate
suffix at compile time (``?``, ``*``, ``+``, ``{n}``, ``{n,m}``, plus the
lazy variants).

Greedy quantifiers:

* :class:`OptionalElement` — ``?`` (zero or one).
* :class:`ZeroOrMoreElement` — ``*``.
* :class:`OneOrMoreElement` — ``+``.
* :class:`ExactlyElement` — ``{n}``.
* :class:`AtLeastElement` — ``{n,}``.
* :class:`AtMostElement` — ``{0,n}``.
* :class:`BetweenElement` — ``{lower,upper}``.

Lazy variants:

* :class:`ZeroOrMoreLazyElement` — ``*?``.
* :class:`OneOrMoreLazyElement` — ``+?``.
* :class:`BetweenLazyElement` — ``{lower,upper}?``.
"""

from __future__ import annotations

from dataclasses import dataclass

from edify.elements.types.base import BaseElement


@dataclass(frozen=True)
class OptionalElement(BaseElement):
    """Greedy ``?`` quantifier — zero or one match.

    Attributes:
        child: The element this quantifier applies to.
    """

    child: BaseElement


@dataclass(frozen=True)
class ZeroOrMoreElement(BaseElement):
    """Greedy ``*`` quantifier — zero or more matches.

    Attributes:
        child: The element this quantifier applies to.
    """

    child: BaseElement


@dataclass(frozen=True)
class ZeroOrMoreLazyElement(BaseElement):
    """Lazy ``*?`` quantifier — zero or more matches, prefer fewer.

    Attributes:
        child: The element this quantifier applies to.
    """

    child: BaseElement


@dataclass(frozen=True)
class OneOrMoreElement(BaseElement):
    """Greedy ``+`` quantifier — one or more matches.

    Attributes:
        child: The element this quantifier applies to.
    """

    child: BaseElement


@dataclass(frozen=True)
class OneOrMoreLazyElement(BaseElement):
    """Lazy ``+?`` quantifier — one or more matches, prefer fewer.

    Attributes:
        child: The element this quantifier applies to.
    """

    child: BaseElement


@dataclass(frozen=True)
class ExactlyElement(BaseElement):
    """``{times}`` quantifier — exactly ``times`` matches.

    Attributes:
        times: The exact number of repetitions required.
        child: The element this quantifier applies to.
    """

    times: int
    child: BaseElement


@dataclass(frozen=True)
class AtLeastElement(BaseElement):
    """``{times,}`` quantifier — at least ``times`` matches.

    Attributes:
        times: The minimum number of repetitions required.
        child: The element this quantifier applies to.
    """

    times: int
    child: BaseElement


@dataclass(frozen=True)
class AtMostElement(BaseElement):
    """``{0,times}`` quantifier — at most ``times`` matches.

    Attributes:
        times: The maximum number of repetitions allowed.
        child: The element this quantifier applies to.
    """

    times: int
    child: BaseElement


@dataclass(frozen=True)
class BetweenElement(BaseElement):
    """``{lower,upper}`` greedy quantifier — between ``lower`` and ``upper`` matches.

    Attributes:
        lower: The minimum number of repetitions required.
        upper: The maximum number of repetitions allowed.
        child: The element this quantifier applies to.
    """

    lower: int
    upper: int
    child: BaseElement


@dataclass(frozen=True)
class BetweenLazyElement(BaseElement):
    """``{lower,upper}?`` lazy quantifier — between ``lower`` and ``upper`` matches, prefer fewer.

    Attributes:
        lower: The minimum number of repetitions required.
        upper: The maximum number of repetitions allowed.
        child: The element this quantifier applies to.
    """

    lower: int
    upper: int
    child: BaseElement