Source file interfaces.ml

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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
module type MINIMAL_PARSER =
sig
    type t
    type token
    type item = token

    val needs_more: t -> bool
    val put: token -> t -> t
    val put_end: t -> t

    type final
    val has_succeeded: t -> bool
    val has_ended : t -> bool
    val has_consumed_end: t -> bool
    val final: t -> final

    type expect
    val has_failed_syntax: t -> bool
    val failed_expectations: t -> expect list
end






module type NORMAL_PARSER =
sig
    include MINIMAL_PARSER

    type semantic
    val has_failed_semantic: t -> bool
    val failed_semantic: t -> semantic

    type state
    val state: t -> state
end


module type FULL_PARSER =
sig
    include NORMAL_PARSER

    val has_lookahead: t -> bool
    val first_lookahead_token: t -> token option
    val has_received_end: t -> bool
    val has_consumed_end: t -> bool
    val fold_lookahead: 'a -> (token -> 'a -> 'a) -> ('a -> 'a) -> t -> 'a
    val transfer_lookahead: t -> t -> t
    val lookaheads: t -> token array * bool
end





module type LEXER =
sig
    include MINIMAL_PARSER
        with type expect = string * Indent.expectation option

    val has_consumed_end: t -> bool
    val position: t -> Position.t

    val start:   t
    val restart: t -> t
end







module type COMBINATOR =
sig
    type state
    type expect
    type semantic

    type _ t
    val (>>=):   'a t -> ('a -> 'b t) -> 'b t
    val (let* ): 'a t -> ('a -> 'b t) -> 'b t
    val map: ('a -> 'b) -> 'a t -> 'b t
    val map_and_update: (state -> 'a -> 'b * state) -> 'a t -> 'b t
    val succeed: 'a -> 'a t
    val return:  'a -> 'a t
    val unexpected: expect -> 'a t
    val clear_last_expectation: 'a -> 'a t
    val fail: semantic -> 'a t
    val (</>):   'a t -> 'a t -> 'a t
    val choices: 'a t -> 'a t list -> 'a t
    val (<?>):   'a t -> expect -> 'a t
    val no_expectations: 'a t -> 'a t

    val get: state t
    val set: state -> unit t
    val update: (state -> state) -> unit t
    val get_and_update: (state -> state) -> state t
    val state_around:
        (state -> state) -> 'a t -> (state -> 'a -> state -> state) -> 'a t



    val optional: 'a t -> 'a option t

    val zero_or_more_fold_left:
        'r -> ('r -> 'a -> 'r t) -> 'a t -> 'r t

    val zero_or_more_fold_right:
        ('a -> 'r -> 'r t) -> 'a t -> 'r  -> 'r t

    val one_or_more_fold_left:
        ('a -> 'r t) -> ('r -> 'a -> 'r t) -> 'a t -> 'r t


    val zero_or_more: 'a t -> 'a list t

    val one_or_more:  'a t -> ('a * 'a list) t

    val skip_zero_or_more: 'a t -> int t

    val skip_one_or_more:  'a t -> int t

    val one_or_more_separated:
        ('item -> 'r t)
        -> ('r -> 'sep -> 'item -> 'r t)
        -> 'item t
        -> 'sep t
        -> 'r t

    val counted: int -> int -> 'r -> (int -> 'e -> 'r -> 'r) -> 'e t -> 'r t

    val parenthesized:
        ('lpar -> 'a -> 'rpar -> 'b t)
        -> 'lpar t
        -> (unit -> 'a t)
        -> ('lpar -> 'rpar t)
        -> 'b t

    val operator_expression:
        'exp t
        -> 'op t option
        -> 'op t
        -> ('op -> 'op -> bool t)
        -> ('op -> 'exp -> 'exp t)
        -> ('exp -> 'op -> 'exp -> 'exp t)
        -> 'exp t

    val backtrack: 'a t -> expect -> 'a t

    val followed_by: 'a t -> expect -> 'a t

    val not_followed_by: 'a t -> expect -> unit t
end









module type CHAR_DECODER =
sig
    type t

    val is_complete: t -> bool
    val has_error:   t -> bool
    val uchar:       t -> Uchar.t
    val scalar:      t -> int
    val width:       t -> int
    val byte_width:  t -> int
    val is_newline:  t -> bool

    val init: t
    val put: char -> t -> t
end



module type CHAR_ENCODER =
sig
    type t = Uchar.t

    val to_internal: t -> string
    val to_external: t -> string
end




module type CHAR_CODEC =
sig
    module Encoder: CHAR_ENCODER

    module Decoder: CHAR_DECODER
end