package lablqml

  1. Overview
  2. Docs

Source file generation2.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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
open Base
open PpxQtCfg
open TypeRepr
open Format

let fprintfn ch fmt = ksprintf (Format.fprintf ch "%s\n%!") fmt

open Gencpp
open Ppxlib
open Myparser.Testdemo

module GenProp = struct
  open Gencpp

  module Mangling = struct
    let signal_stub ~classname ~signal_name =
      sprintf "caml_%s_%s_cppmeth_wrapper" classname signal_name

    let getter_stub ~classname ~getter_name =
      [%string "register_$(classname)_$(getter_name)_getter"]
  end

  module CamlSidePreRegistered = struct
    let run ~classname ~propname (typ : Arg.default Arg.t) pinfo =
      let sgnl_name = Names.signal_of_prop propname in
      let getter_name = Option.value_exn pinfo.p_read in
      let cpptyp_name = cpptyp_of_proptyp @@ wrap_typ_simple typ in
      let cpp () =
        let ppf, prints_ = get_smart_ppf get_source_ch ~classname in
        let println fmt = fprintfn ppf fmt in
        let typ = Arg.default_plus_model typ in
        (* There we only call registered in OCaml functions *)
        let () =
          let registration_f =
            Mangling.getter_stub ~classname
              ~getter_name:(Option.value_exn pinfo.p_read)
          in
          println "%s %s::%s() {" cpptyp_name classname getter_name;
          println "  CAMLparam0();";
          println "  CAMLlocal1(_ans);";
          prints_
            [%string
              {|
            static value *closure = nullptr;
            if (closure == nullptr) {
              closure = (value*) caml_named_value("$registration_f") ;
              Q_ASSERT_X(closure, Q_FUNC_INFO, "Value $registration_f is not created on OCaml side");
            }
            _ans = caml_callback(*closure, Val_unit);
            |}];
          let cppvar = "ans" in
          println "  %s %s;" (cpptyp_of_typ (typ, ai_empty)) cppvar;
          Gencpp.cpp_value_of_ocaml ~cppvar ~ocamlvar:"_ans" ppf
            (Gencpp.vars_triplet [ "_ans" ])
            typ;
          println "  CAMLreturnT(%s,ans);" (cpptyp_of_typ (typ, ai_empty));
          println "}\n"
        in
        let _setter =
          let setter_name = Option.value_exn pinfo.p_write in
          let registration_f =
            [%string "register_$(classname)_$(propname)_setter"]
          in
          let ocaml_var = "_val" in
          println "void %s::%s(%s newVal) {" classname setter_name cpptyp_name;
          println "  CAMLparam0();";
          println "  CAMLlocal1(%s);" ocaml_var;
          Gencpp.ocaml_value_of_cpp ppf
            (Gencpp.vars_triplet [ ocaml_var ])
            ~ocamlvar:ocaml_var ~cppvar:"newVal" typ;
          prints_
            [%string
              {|
            static value *closure = nullptr;
            closure = (value*) caml_named_value("$registration_f");
            Q_ASSERT_X(closure, Q_FUNC_INFO, "Value $registration_f is not created on OCaml side");
            caml_callback(*closure, $(ocaml_var));
            CAMLreturn0;
            |}];
          println "\n}\n"
        in
        let _notifier =
          let stubname =
            Mangling.signal_stub ~classname ~signal_name:sgnl_name
          in
          Gencpp.gen_stub_cpp ~classname ~methname:sgnl_name ~stubname ppf
            [ (typ, ai_empty); (Arg.default_plus_model Unit, ai_empty) ]
        in
        ()
      in
      let hdr () =
        let ppf = get_header_ppf ~classname in
        let println fmt = fprintfn ppf fmt in
        fprintfn ppf "public:";
        println "  Q_PROPERTY(%s %s READ %s %s NOTIFY %s)" cpptyp_name propname
          (Option.value_exn pinfo.p_read)
          (Option.value_map pinfo.p_write ~default:"" ~f:(sprintf "WRITE %s"))
          sgnl_name;
        println "  %s %s();" cpptyp_name getter_name;
        Option.iter pinfo.p_write ~f:(fun setter_name ->
            println "  void %s(%s);" setter_name cpptyp_name);
        println "signals:";
        println "  void %s(%s %s);" sgnl_name cpptyp_name propname;
        ()
      in
      let ml () = () in
      cpp ();
      hdr ();
      ml ()
  end
end

module OnSingleton = struct
  let creation_callback ~classname = [%string "save_freshly_created_$classname"]

  let callback_of_invokable ~classname name =
    [%string "invoke_$(classname)_$name"]

  let on_header ~loc ~classname ~inv_signs info =
    let ppf, _ = Gencpp.get_smart_ppf Gencpp.get_header_ch ~classname in
    let println fmt = fprintfn ppf fmt in
    println "class %s : public %s {" classname "QObject";
    println "  Q_OBJECT";
    println "  QML_NAMED_ELEMENT(%s)" classname;
    println "  QML_SINGLETON";
    println "public:";
    println "  %s();" classname;
    let open Ppxlib in
    List.iter inv_signs ~f:(function
        | { pval_name; pval_type; pval_loc = loc } ->
        let args = TypeRepr.parse_arrow_type_exn pval_type in
        let args, res = List.(drop_last_exn args, last_exn args) in
        let args, res =
          let f = function
            | Nolabel, arg -> (Arg.default_plus_model arg, ai_empty)
            | _ -> ppxqt_failed ~loc "Labeled arguments not yet supported"
          in
          (List.map ~f args, f res)
        in
        Gencpp.gen_meth_header ~methname:pval_name.txt ~res ~args ppf);
    List.iter info.props ~f:(fun (propname, typ, pinfo) ->
        match TypeRepr.string_suites_prop typ with
        | Error msg ->
            raise
            @@ ErrorMsg
                 (sprintf "Can't wrap property '%s': %s" propname msg, loc)
        | Ok typ ->
            ();
            GenProp.CamlSidePreRegistered.run ~classname ~propname typ pinfo)

  let on_src ~loc:_ ~classname ~inv_signs info =
    let ppf, prints_ = Gencpp.get_smart_ppf Gencpp.get_source_ch ~classname in
    ignore prints_;
    let println fmt = fprintfn ppf fmt in
    println "#include <QtQml/QQmlEngine>";
    println "#ifdef __cplusplus";
    println "extern \"C\" {";
    println "#endif";
    println "#include <caml/alloc.h>";
    println "#include <caml/mlvalues.h>";
    println "#include <caml/callback.h>";
    println "#include <caml/memory.h>";
    println "#include <caml/threads.h>";
    println "#ifdef __cplusplus";
    println "}";
    println "#endif";
    let _namespace =
      Option.value info.namespace ~default:"Qt.example.qobjectSingleton"
    in
    let _construction =
      let registration_f = creation_callback ~classname in
      let obj = "this" in
      Format.pp_print_string ppf
        [%string
          {|
      $classname::$classname() {
            CAMLparam0();
            CAMLlocal1(_ans);

            // store this shit in OCaml
            static value *closure = nullptr;
            if (closure == nullptr) {
              closure = (value*) caml_named_value("$registration_f");
              Q_ASSERT_X(closure, Q_FUNC_INFO, "Value $registration_f is not created on OCaml side");
            }   |}];
      Gencpp.alloc_and_store ppf ~classname ~obj ~where:"_ans";
      Gencpp.leave_blocking_section ppf;
      println "  caml_callback(*closure, _ans);";
      Gencpp.enter_blocking_section ppf;
      println "  CAMLreturn0;";
      println "}\n%!"
    in
    let _invokables =
      List.iter inv_signs ~f:(function
          | { pval_name; pval_type; pval_loc = loc } ->
          let methname = pval_name.txt in
          let wrap ~make_cb_var _ocaml_var locals ~args =
            let args : (_ TypeRepr.Arg.t * _) list = args in
            println "  static value *closure = nullptr;";
            let registration_f = callback_of_invokable ~classname methname in
            println "  if (closure == nullptr) {";
            println "    closure = (value*) caml_named_value(%S);"
              registration_f;
            println "    Q_ASSERT_X(closure, Q_FUNC_INFO, %S);"
              [%string "Value $registration_f is not created on OCaml side"];
            println "  }";
            let triplet = vars_triplet locals in
            let call_closure_str =
              match List.length args with
              | (0 | 1)
                when match args with [ (Arg.Unit, _) ] -> true | _ -> false ->
                  sprintf "caml_callback(*closure, Val_unit);"
              | n ->
                  List.iteri args ~f:(fun i ((typ : _ Arg.t), _) ->
                      let cppvar = sprintf "x%d" i in
                      let ocamlvar = make_cb_var i in
                      fprintf ppf "  ";
                      ocaml_value_of_cpp ppf triplet ~ocamlvar ~cppvar typ;
                      println "  _args[%d] = %s;" i ocamlvar);
                  sprintf "caml_callbackN(*closure, %d, _args);" n
            in
            (triplet, call_closure_str)
          in
          let args =
            TypeRepr.parse_arrow_type_exn pval_type
            |> List.map ~f:(function
                 | Nolabel, arg -> (Arg.default_plus_model arg, ai_empty)
                 | _ -> ppxqt_failed ~loc "Labeled arguments not yet supported")
          in
          Gencpp.gen_meth_cpp_generic ~methname ~classname wrap ppf args)
    in
    ()

  let on_ml ~loc ~classname ~inv_signs (name, stru, sign) info =
    let open Ppxlib.Ast_builder.Default in
    let extra_stru ?(creation = false) ?(notifiers = false) ?(getters = false)
        ?(invokables = false) () =
      List.concat
        [
          (if creation then
           [
             [%stri type t];
             [%stri
               let self_container :
                   (t Lablqml.cppobj, [< `Noninitialized ]) Result.t ref =
                 ref (Result.error `Noninitialized)];
             (let stub_name = creation_callback ~classname in
              [%stri
                let () =
                  Callback.register
                    [%e
                      pexp_constant ~loc @@ Pconst_string (stub_name, loc, None)]
                    (fun cppobj ->
                      Format.printf "initialized %s %d\n%!" __FILE__ __LINE__;
                      self_container := Result.ok cppobj)]);
           ]
          else []);
          List.concat_map info.props ~f:(fun (_, ptyp, info) ->
              Stdlib.List.flatten
                [
                  (match info.p_notify with
                  | Some notifier when notifiers ->
                      let stub_name =
                        GenProp.Mangling.signal_stub ~classname
                          ~signal_name:notifier
                      in
                      let open Ppxlib.Ast_builder.Default in
                      List.return @@ pstr_primitive ~loc
                      @@ value_description ~loc ~name:(Located.mk ~loc notifier)
                           ~type_:
                             [%type:
                               t Lablqml.cppobj ->
                               [%t
                                 ptyp_constr ~loc
                                   (Located.mk ~loc @@ Lident ptyp)
                                   []] ->
                               unit]
                           ~prim:[ stub_name ]
                  | _ -> []);
                  (match info.p_read with
                  | Some getter when getters ->
                      let stub_name =
                        GenProp.Mangling.getter_stub ~classname
                          ~getter_name:getter
                      in
                      List.return
                        [%stri
                          let () =
                            Callback.register
                              [%e
                                pexp_constant ~loc
                                @@ Pconst_string (stub_name, loc, None)]
                              (fun () ->
                                [%e
                                  pexp_ident ~loc
                                    (Located.mk ~loc (Lident getter))]
                                  ())]
                  | _ -> []);
                ]);
          (if not invokables then []
          else
            List.map inv_signs ~f:(function { pval_name; pval_loc = loc } ->
                let methname = pval_name.txt in
                let stub_name = callback_of_invokable ~classname methname in
                [%stri
                  let () =
                    Callback.register
                      [%e
                        pexp_constant ~loc
                        @@ Pconst_string (stub_name, loc, None)]
                      [%e pexp_ident ~loc @@ Located.map lident pval_name]]));
        ]
    in
    let extra_sign =
      Stdlib.List.flatten
        [
          [ [%sigi: type t] ];
          [
            [%sigi:
              val self_container :
                (t Lablqml.cppobj, [ `Noninitialized ]) Result.t ref];
          ];
          List.concat_map info.props ~f:(fun (_, ptyp, info) ->
              Stdlib.List.flatten
                [
                  (match info.p_notify with
                  | None -> []
                  | Some notifier ->
                      let stub_name =
                        GenProp.Mangling.signal_stub ~classname
                          ~signal_name:notifier
                      in
                      let open Ppxlib.Ast_builder.Default in
                      List.return @@ psig_value ~loc
                      @@ value_description ~loc ~name:(Located.mk ~loc notifier)
                           ~type_:
                             [%type:
                               t Lablqml.cppobj ->
                               [%t
                                 ptyp_constr ~loc
                                   (Located.mk ~loc @@ Lident ptyp)
                                   []] ->
                               unit]
                           ~prim:[ stub_name ]);
                ]);
        ]
    in
    pstr_module ~loc
    @@ module_binding ~loc
         ~name:(Located.mk ~loc (Option.some name))
         ~expr:
           (pmod_constraint ~loc
              (pmod_structure ~loc
              @@ extra_stru ~creation:true ~notifiers:true ()
              @ stru
              @ extra_stru ~getters:true ~invokables:true ())
              (pmty_signature ~loc @@ sign @ extra_sign))
    |> List.return

  let run ~loc ~classname ((_, _, sigis) as mb) info =
    let inv_signs =
      let open PpxQtCfg in
      let open Ppxlib in
      List.filter_map sigis ~f:(fun sigi ->
          match sigi.psig_desc with
          | Psig_value ({ pval_attributes } as vd)
            when has_attr "qinvokable" pval_attributes ->
              Some vd
          | _ -> None)
    in
    if PpxQtCfg.config.gencpp then (
      on_src ~loc ~classname ~inv_signs info;
      on_header ~loc ~classname ~inv_signs info);
    on_ml ~loc ~classname ~inv_signs mb info
end

let wrap_module_decl ~loc name stru sign info =
  (* print_endline @@ Testdemo.show_info info; *)
  let classname =
    match info.name with Some s -> s | None -> failwith "class has no name"
  in
  Gencpp.only_open ~classname;
  Gencpp.print_header_preamble ~classname;
  Gencpp.print_source_preamble ~classname;
  let ans =
    if info.is_singleton then
      OnSingleton.run ~loc ~classname (name, stru, sign) info
    else failwith "not implemented"
  in
  let () = Gencpp.close_files ~caml_owner:false ~options:[] () in
  ans
OCaml

Innovation. Community. Security.