package serde_derive

  1. Overview
  2. Docs

Source file de_record.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
365
366
367
open Ppxlib
module Ast = Ast_builder.Default
open De_base

(** implementation *)
let gen_visit_map ~ctxt ~type_name:_ ?constructor ~field_visitor kvs parts =
  let loc = loc ~ctxt in

  let create_value =
    let value = Ast.pexp_record ~loc kvs None in
    let value =
      match constructor with
      | None -> value
      | Some c ->
          Ast.pexp_construct ~loc (longident ~ctxt c)
            (Some (Ast.pexp_record ~loc kvs None))
    in

    [%expr Ok [%e value]]
  in

  let extract_fields =
    List.fold_left
      (fun body (name, pat, _ctyp, exp, _field_variant) ->
        let op = var ~ctxt "let*" in
        let exp =
          [%expr
            match ![%e exp] with
            | Some value -> Ok value
            | None -> Serde.De.Error.missing_field [%e name |> Ast.estring ~loc]]
        in
        let let_ = Ast.binding_op ~op ~loc ~pat ~exp in
        Ast.letop ~let_ ~ands:[] ~body |> Ast.pexp_letop ~loc)
      create_value (List.rev parts)
  in

  let fill_individual_field =
    let cases =
      List.map
        (fun (_name, _pat, ctyp, var, field_variant) ->
          let deser_value =
            if is_primitive_type ctyp then
              [%expr
                [%e de_fun ~ctxt ctyp]
                  (module De)
                  [%e visitor_mod ~ctxt ctyp |> Option.get]]
            else [%expr [%e de_fun ~ctxt ctyp] (module De)]
          in

          let assign_field =
            [%expr
              let* value =
                Serde.De.Map_access.next_value map_access
                  ~deser_value:(fun () -> [%e deser_value])
              in
              Ok ([%e var] := value)]
          in
          let constructor =
            Ast.ppat_construct ~loc (longident ~ctxt field_variant) None
          in
          Ast.case ~lhs:[%pat? [%p constructor]] ~guard:None ~rhs:assign_field)
        parts
    in
    let match_ = Ast.pexp_match ~loc [%expr f] cases in
    [%expr
      let* () = [%e match_] in
      fill ()]
  in

  let fill_fields =
    [%expr
      let deser_key () =
        Serde.De.deserialize_identifier (module De) [%e field_visitor]
      in
      let rec fill () =
        let* key = Serde.De.Map_access.next_key map_access ~deser_key in
        match key with None -> Ok () | Some f -> [%e fill_individual_field]
      in
      let* () = fill () in
      [%e extract_fields]]
  in

  let initialize_fields =
    List.fold_left
      (fun body (_name, pat, _type, _var, _field_variant) ->
        let expr = [%expr ref None] in
        let vb = Ast.value_binding ~loc ~pat ~expr in
        Ast.pexp_let ~loc Nonrecursive [ vb ] body)
      fill_fields (List.rev parts)
  in

  [%stri
    let visit_map :
        type de_state.
        value Serde.De.Visitor.t ->
        de_state Serde.De.Deserializer.t ->
        (value, 'error) Serde.De.Map_access.t ->
        (value, 'error Serde.De.Error.de_error) result =
     fun (module Self) (module De) map_access -> [%e initialize_fields]]

let gen_visit_seq ~ctxt ~type_name ?constructor kvs parts =
  let loc = loc ~ctxt in

  let create_value =
    let value = Ast.pexp_record ~loc kvs None in
    let value =
      match constructor with
      | None -> value
      | Some c ->
          Ast.pexp_construct ~loc (longident ~ctxt c)
            (Some (Ast.pexp_record ~loc kvs None))
    in

    [%expr Ok [%e value]]
  in

  let exprs =
    List.map
      (fun (_field_name, pat, ctyp, _expr, _field_variant) ->
        let err_msg =
          Printf.sprintf "%s needs %d argument" type_name.txt
            (List.length parts)
          |> Ast.estring ~loc
        in

        let deser_element =
          if is_primitive_type ctyp then
            [%expr
              [%e de_fun ~ctxt ctyp]
                (module De)
                [%e visitor_mod ~ctxt ctyp |> Option.get]]
          else [%expr [%e de_fun ~ctxt ctyp] (module De)]
        in

        let body =
          [%expr
            let deser_element () = [%e deser_element] in
            let* r =
              Serde.De.Sequence_access.next_element seq_access ~deser_element
            in
            match r with
            | None -> Serde.De.Error.message (Printf.sprintf [%e err_msg])
            | Some f0 -> Ok f0]
        in

        (pat, body))
      parts
  in

  let visit_seq =
    List.fold_left
      (fun body (pat, exp) ->
        let op = var ~ctxt "let*" in
        let let_ = Ast.binding_op ~op ~loc ~pat ~exp in
        Ast.letop ~let_ ~ands:[] ~body |> Ast.pexp_letop ~loc)
      create_value (List.rev exprs)
  in

  [%stri
    let visit_seq :
        type de_state.
        (module Serde.De.Visitor.Intf with type value = value) ->
        (module Serde.De.Deserializer with type state = de_state) ->
        (value, 'error) Serde.De.Sequence_access.t ->
        (value, 'error Serde.De.Error.de_error) result =
     fun (module Self) (module De) seq_access -> [%e visit_seq]]

let gen_visitor ~ctxt ~type_name ~field_visitor
    (label_declarations : (label_declaration * string) list) =
  let loc = loc ~ctxt in
  let visitor_module_name = "Visitor_for_" ^ type_name.txt in

  let make_vars_and_pats i (ldecl, field_variant) =
    let record_field_name = ldecl.pld_name.txt in
    let f_idx = "f_" ^ Int.to_string i in
    let pat = f_idx |> var ~ctxt |> Ast.ppat_var ~loc in
    let var = f_idx |> Longident.parse |> var ~ctxt |> Ast.pexp_ident ~loc in
    let kv = (longident ~ctxt record_field_name, var) in
    (kv, (record_field_name, pat, ldecl.pld_type, var, field_variant))
  in

  let labels = label_declarations |> List.mapi make_vars_and_pats in
  let kvs, parts = labels |> List.split in

  let visitor_module =
    [%str
      include Serde.De.Visitor.Unimplemented

      type value = [%t Ast.ptyp_constr ~loc (longident ~ctxt type_name.txt) []]
      type tag = fields]
    @ [
        gen_visit_seq ~ctxt ~type_name kvs parts;
        gen_visit_map ~ctxt ~type_name ~field_visitor kvs parts;
      ]
  in

  let visitor_module =
    Ast.module_binding ~loc
      ~name:(var ~ctxt (Some visitor_module_name))
      ~expr:
        (Ast.pmod_apply ~loc
           (Ast.pmod_ident ~loc (longident ~ctxt "Serde.De.Visitor.Make"))
           (Ast.pmod_structure ~loc visitor_module))
    |> Ast.pstr_module ~loc
  in

  let ident =
    let mod_name = Longident.parse visitor_module_name |> var ~ctxt in
    Ast.pexp_pack ~loc (Ast.pmod_ident ~loc mod_name)
  in

  (ident, visitor_module)

let gen_field_visitor ~ctxt ~type_name ?fields_type constructors =
  let loc = loc ~ctxt in

  let field_visitor_module_name = "Field_visitor_for_" ^ type_name.txt in

  let include_unimplemented = [%stri include Serde.De.Visitor.Unimplemented] in
  let type_value =
    match fields_type with
    | Some t -> [%stri type value = [%t t]]
    | None -> [%stri type value = fields]
  in
  let type_tag = [%stri type tag = unit] in

  let visit_int =
    let cases =
      List.mapi
        (fun idx (_field, constructor) ->
          let idx = Ast.pint ~loc idx in
          let constructor =
            Ast.pexp_construct ~loc (longident ~ctxt constructor) None
          in
          Ast.case
            ~lhs:[%pat? [%p idx]]
            ~guard:None
            ~rhs:[%expr Ok [%e constructor]])
        constructors
    in
    let cases =
      cases
      @ [
          Ast.case
            ~lhs:[%pat? _]
            ~guard:None
            ~rhs:[%expr Serde.De.Error.invalid_variant_index ~idx];
        ]
    in

    let match_ = Ast.pexp_match ~loc [%expr idx] cases in

    [%stri let visit_int idx = [%e match_]]
  in

  let visit_string =
    let cases =
      List.map
        (fun (field, constructor) ->
          let idx = Ast.pstring ~loc field.pld_name.txt in
          let constructor =
            Ast.pexp_construct ~loc (longident ~ctxt constructor) None
          in
          Ast.case
            ~lhs:[%pat? [%p idx]]
            ~guard:None
            ~rhs:[%expr Ok [%e constructor]])
        constructors
    in
    let cases =
      cases
      @ [
          Ast.case
            ~lhs:[%pat? _]
            ~guard:None
            ~rhs:[%expr Serde.De.Error.unknown_variant str];
        ]
    in

    let match_ = Ast.pexp_match ~loc [%expr str] cases in

    [%stri let visit_string str = [%e match_]]
  in

  let visitor_module =
    [ include_unimplemented; type_value; type_tag; visit_int; visit_string ]
  in

  let visitor_module =
    Ast.module_binding ~loc
      ~name:(var ~ctxt (Some field_visitor_module_name))
      ~expr:
        (Ast.pmod_apply ~loc
           (Ast.pmod_ident ~loc (longident ~ctxt "Serde.De.Visitor.Make"))
           (Ast.pmod_structure ~loc visitor_module))
    |> Ast.pstr_module ~loc
  in

  let ident =
    let mod_name = Longident.parse field_visitor_module_name |> var ~ctxt in
    Ast.pexp_pack ~loc (Ast.pmod_ident ~loc mod_name)
  in

  (ident, visitor_module)

(** Generate deserializer for record types. This generates:

    1 module for the deserializer itself
    1 visitor module for the fields
    1 visitor module for the contents

*)
let gen_deserialize_record_impl ~ctxt type_name
    (label_declarations : label_declaration list) =
  let loc = loc ~ctxt in

  let field_names = List.map (fun l -> l.pld_name.txt) label_declarations in

  let field_constructors =
    List.map (fun l -> (l, "Field_" ^ l.pld_name.txt)) label_declarations
  in
  let fields =
    let kind =
      Ptype_variant
        (List.map
           (fun (_loc, c) ->
             let name = var ~ctxt c in
             Ast.constructor_declaration ~loc ~name ~res:None
               ~args:(Pcstr_tuple []))
           field_constructors)
    in
    [
      Ast.type_declaration ~loc ~name:(var ~ctxt "fields") ~params:[] ~cstrs:[]
        ~kind ~manifest:None ~private_:Public;
    ]
    |> Ast.pstr_type ~loc Nonrecursive
  in

  let constants =
    [
      [%stri let name = [%e type_name.txt |> Ast.estring ~loc]];
      [%stri
        let fields =
          [%e field_names |> List.map (Ast.estring ~loc) |> Ast.elist ~loc]];
      fields;
    ]
  in

  let field_visitor_for_t_name, field_visitor_for_t =
    gen_field_visitor ~ctxt ~type_name field_constructors
  in

  let visitor_for_t_name, visitor_for_t =
    gen_visitor ~ctxt ~type_name ~field_visitor:field_visitor_for_t_name
      field_constructors
  in

  let str_items = constants @ [ field_visitor_for_t; visitor_for_t ] in

  let deserialize_body =
    [%expr
      Serde.De.deserialize_record ~name ~fields
        (module De)
        [%e visitor_for_t_name] [%e field_visitor_for_t_name]]
  in

  (str_items, deserialize_body)