package fmlib_parse

  1. Overview
  2. Docs

Source file test_indent_yaml.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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
module Yaml =
struct
    type t =
        | Scalar of string
        | List   of t list
        | Record of (string * t) list


    let scalar str = Scalar str

    let list lst = List lst

    let record lst = Record lst

    module Pretty = Fmlib_pretty.Print

    let rec to_doc: t -> Pretty.doc = function
        | Scalar str ->
            Pretty.text str
        | List lst ->
            let open Pretty in
            lst
            |> List.map
                (fun y ->
                     text "- " <+> nest 2 (to_doc y))
            |> separated_by cut
        | Record lst ->
            let open Pretty in
            lst
            |> List.map
                   (fun (str,y) ->
                     text str <+> char ':'
                     <+> cut
                     <+> nest 4 (to_doc y))
            |> separated_by cut

    let to_string (str: string): string =
        String.(make 1 '"' ^ escaped str ^ make 1 '"')

    let rec to_json: t -> string = function
        | Scalar str ->
            to_string str
        | List lst ->
            "["
            ^
            String.concat ", " (List.map to_json lst)
            ^
            "]"
        | Record lst ->
            "{"
            ^
            String.concat
                ", "
                (List.map
                    (fun (key, y) -> to_string key ^ ": " ^ to_json y)
                    lst
                )
            ^
            "}"

    let write_to_channel (oc: out_channel) (y: t): unit =
        let open Pretty in
        to_doc y <+> cut
        |> layout 80
        |> write_to_channel oc
end


module CP = Character.Make (Unit) (Yaml) (Unit)

open CP


let comment: char t =
    let* _ = char '#' in
    let* _ =
        (charp (fun c -> c <> '\n') "comment character")
        |> skip_zero_or_more
    in
    return '#'


let whitespace: int t =
    char ' ' </> char '\n' </> comment
    |> skip_zero_or_more
    |> no_expectations
    |> detach


let lexeme (p: 'a t): 'a t =
    let* a = p in
    let* _ = whitespace in
    return a


let raw_string: string t =
    let expect  = "chars not containing colon and newline" in
    let inner c = c <> '\n' && c <> ':' && c <> '#' in
    let first c = c <> '"' && inner c
    in
    (word first inner expect)
    |> map String.trim
    |> lexeme

let quoted_string: string t =
    let expect = "chars except newline and dquote" in
    let ok c = c <> '\n' && c <> '"'
    in
    let* _   = char '"' in
    let* str = (word ok ok expect) </> return "" in
    let* _   = char '"' |> lexeme
    in
    return str

let scalar: Yaml.t t =
    quoted_string
    </>
    raw_string
    |>
    map Yaml.scalar
    <?>
    "scalar"

let dash: char t =
    char '-' |> lexeme

let key: string t =
    backtrack
        (
            let* str = raw_string </> quoted_string in
            let* _   = char ':' |> lexeme in
            return str
        )
        "<key>:"




let rec yaml (): Yaml.t t =
    sequence_block ()
    </>
    record_block ()
    </>
    scalar


and sequence_block (): Yaml.t t =
    one_or_more
        (
            sequence_element ()
            <?>
            "sequence element: \"- <yaml value>\""
            |> align
        )
    |> map (fun (a, lst) -> Yaml.list (a :: lst))
    <?> "sequence of aligned \"- <yaml value>\""


and record_block (): Yaml.t t =
    one_or_more
        (
            record_element ()
            <?> "key value pair: \"<key>: <yaml value>\""
            |> align
        )
    |> map (fun (a, lst) -> Yaml.record (a :: lst))
    <?> "sequence of aligned \"<key>: <yaml value>\""


and sequence_element (): Yaml.t t =
    let* _ = dash in
    yaml () |> indent 1


and record_element (): (string * Yaml.t) t =
    let* str = key in
    let* y   =
        sequence_block () |> indent 0
        </>
        (record_block () </> scalar |> indent 1)
    in
    return (str, y)




let parse: Parser.t =
    make
        ()
        (
            let* _ = whitespace in
            yaml ()
        )


module Pretty = Fmlib_pretty.Print



let write_errors (source: string) (p: Parser.t): unit =
    let open Parser in
    let module Error_reporter = Error_reporter.Make (Parser) in
    let open Error_reporter
    in
    assert (has_ended p);
    assert (not (has_succeeded p));
    make_syntax p
    |> run_on_string source
    |> Pretty.layout 50
    |> Pretty.write_to_channel stdout


let write_result (source: string) (p: Parser.t): unit =
    let open Parser in
    if has_succeeded p then
        Yaml.(to_json (final p))
        |> print_endline
    else if has_failed_syntax p then
        write_errors source p
    else
        assert false (* Illegal call, no semantic errors *)






(* Unit Tests
 * ==========
 *)



let%test _ =
    let str = "   hello  #comment"
    in
    let open Parser in
    let p = run_on_string str parse in
    has_succeeded p
    &&
    final p = Yaml.scalar "hello"



let%test _ =
    let str = "- - hello  #comment"
    in
    let open Parser in
    let p = run_on_string str parse in
    has_succeeded p
    &&
    Yaml.to_json (final p) = {|[["hello"]]|}



let%test _ =
    let str = "key : hello  "
    in
    let open Parser in
    let p = run_on_string str parse in
    has_succeeded p
    &&
    Yaml.to_json (final p) = {|{"key": "hello"}|}



let%test _ =
    let str = "key:\n hello"
    in
    let open Parser in
    let p = run_on_string str parse in
    has_succeeded p
    &&
    Yaml.to_json (final p) = {|{"key": "hello"}|}



let%test _ =
    let str = {|
        1: 11: hello  #comment"
           12: ""
           "###": hash
        |}
    in
    let open Parser in
    let p = run_on_string str parse in
    has_succeeded p
    &&
    Yaml.to_json (final p)
    =
    {|{"1": {"11": "hello", "12": "", "###": "hash"}}|}





let%test _ =
    let str = {|
        -
         hello
        |}
    in
    let open Parser in
    let p = run_on_string str parse in
    has_succeeded p
    &&
    Yaml.to_json (final p)
    = {|["hello"]|}





let%test _ =
    let str = {|
-
hello
        |}
    in
    let open Parser in
    let p = run_on_string str parse in
    has_failed_syntax p
    &&
    line p = 2
    &&
    column p = 0





let%test _ =
    let str = {|
"1:":- Alice # comment
  2: Bob
        |}
    in
    let open Parser in
    let p = run_on_string str parse in
    has_failed_syntax p
    &&
    (line p = 2)
    &&
    (column p = 2)




let%test _ =
    let str = {|
        k1:
        - 1
        - - 1.1
          - 1.2
        k2: s2
        |}
    in
    let open Parser in
    let p = run_on_string str parse in
    has_succeeded p
    &&
    Yaml.to_json (final p)
    =
    {|{"k1": ["1", ["1.1", "1.2"]], "k2": "s2"}|}
OCaml

Innovation. Community. Security.