aboutsummaryrefslogtreecommitdiff
path: root/editor/prosemirror/bindings.ml
blob: d2ef2e657536dfbe1297a570aceff29cb74e863b (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
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
open Js_of_ocaml.Js

module Model = struct

  type mark

  type schema

  type content_match

  type node_spec

  type slice

  class type _node_props = object ('this)

    method inlineContent:
      bool readonly_prop
    (** True if this node type has inline content. *)

    method isBlock:
      bool readonly_prop

    method isText:
      bool readonly_prop

    method isInline:
      bool readonly_prop

    method isTextblock:
      bool readonly_prop

    method isLeaf:
      bool readonly_prop

    method isAtom:
      bool readonly_prop

  end

  class type node_type = object ('this)

    inherit _node_props

    method name:
      string readonly_prop

    method schema:
      schema t readonly_prop

    method spec:
      node_spec t readonly_prop

    method contentMatch:
      content_match t readonly_prop

    method hasRequiredAttrs:
      unit -> bool meth

  end

  class type mark_type = object ('this)
  end

  (** Common signature between fragment and node *)
  class type _element = object ('this)

    method childCount:
      int readonly_prop
    (** The number of children that the node has. *)

    method child:
      int -> node t meth
    (**  Get the child node at the given index. Raise an error when the index
         is out of range. *)

    method maybeChild:
      int -> node t opt meth
    (** Get the child node at the given index, if it exists. *)

    method eq:
      'this t -> bool meth
    (** Compare this element to another one. *)

    method cut:
      int -> int opt -> 'this meth
    (** Cut out the element between the two given positions. *)

    method toString:
      unit -> Jstr.t meth
    (** Return a debugging string that describes this element. *)

    method forEach:
      (node t -> int -> int) -> unit meth

  end

  and fragment = object ('this)

    inherit _element

    method size:
      int readonly_prop
    (** The size of the fragment, which is the total of the size of its
        content nodes. *)

    method append:
      'this t -> 'this t meth

    method lastChild:
      node t opt readonly_prop

    method firstChild:
      node t opt readonly_prop

  end

  and node = object ('this)

    inherit _element

    inherit _node_props

    method _type:
      node_type t readonly_prop

    method attrs:
      < .. > t readonly_prop

    method content:
      fragment t readonly_prop

    method marks:
      mark t js_array t readonly_prop

    method sameMarkupd:
      node t -> bool meth
  end

end

module Transform = struct

  type step_result

  class type step = object ('this)

  end

  class type replace_step = object ('this)

    inherit step

  end

  class type replace_around_step = object ('this)

    inherit step

  end

  class type add_mark_step = object ('this)

    inherit step

  end


  class type transform = object ('this)

    method doc:
      Model.node t readonly_prop

    method steps:
      step t js_array t readonly_prop

    method docs:
      Model.node t js_array t readonly_prop

    method step:
      step t -> 'this t meth

  end

end

(**

   The class is defined outside of the module View for prevent recursive
   declaration.

*)
class type _editor_props = object ('this)

end


module State = struct

  class type plugin = object ('this)

    method props : _editor_props t readonly_prop

  end

  class type selection = object ('this)

    method content:
      unit -> Model.slice t meth

    method replace:
      transaction t -> Model.slice t -> unit meth

  end

  and transaction = object ('this)

    inherit Transform.transform

    method time:
      int readonly_prop

    method setTime:
      int -> 'this t meth

    method storedMarks:
      Model.mark t js_array t opt readonly_prop

    method setStoredMarks:
      Model.mark t js_array t opt -> 'this t meth

    method addStoredMark:
      Model.mark t -> 'this t meth

    method removeStoredMark_mark:
      Model.mark t -> 'this t meth

    method removeStoredMark_marktype:
      Model.mark_type t -> 'this t meth

    method ensureMarks:
      Model.mark t js_array t -> 'this t meth

    method storedMarksSet:
      bool readonly_prop

    method selection:
      selection t readonly_prop

    method setSelection:
      selection t -> 'this t meth

    method deleteSelection:
      'this t meth

    method replaceSelection:
      Model.slice t -> 'this t meth

    method selectionSet:
      bool readonly_prop

    method before:
      Model.node t readonly_prop

  end

  class type configuration_prop = object ('this)

    method schema:
      Model.schema t opt prop

    method plugins:
      plugin t js_array t opt prop

  end

  class type creation_prop = object ('this)

    inherit configuration_prop

    method doc:
      Model.node t opt prop

    method selection:
      selection t opt prop

    method storedMarks:
      Model.mark t js_array t opt prop

  end

  class type editor_state = object ('this)

    method doc :
      Model.node t readonly_prop

    method selection:
      selection t readonly_prop

    method storedMarks:
      Model.mark t js_array t opt readonly_prop

    method schema:
      Model.schema t readonly_prop

    method plugins:
      plugin t js_array t readonly_prop

    method apply:
      transaction t -> 'this t meth

    method tr:
      transaction t readonly_prop

    method reconfigure:
      configuration_prop t meth

    method toJSON:
      unit -> Brr.Json.t meth

  end

end

module View = struct

  class type editor_props = _editor_props

  class type direct_editor_props = object ('this)

    inherit editor_props

    method state:
      State.editor_state t writeonly_prop

    (** The call back is called with this = instance of editor_view *)
    method dispatchTransaction:
      (editor_view t, State.transaction t -> unit) meth_callback writeonly_prop

  end

  and editor_view = object ('this)

    method state:
      State.editor_state t readonly_prop

    method dom:
      Brr.El.t readonly_prop prop

    method editable:
      bool readonly_prop prop

    method update:
      direct_editor_props t -> unit meth

    method setProps:
      direct_editor_props t -> unit meth

    method updateState:
      State.editor_state t -> unit meth

  end

end

module History = struct

  class type history_prop = object ('this)

    method depth: int opt prop

    method newGroupDelay: int opt prop

  end

end