~npalix/coccinelle/upstream

« back to all changes in this revision

Viewing changes to bundles/stdcompat/stdcompat-current/stdcompat__stringLabels_s.mli.in

  • Committer: Thierry Martinez
  • Date: 2019-08-20 13:37:04 UTC
  • Revision ID: git-v1:0214afad4a32c95349c2c5a38e37cea407c455d0
Update bundles

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
module type S = sig
 
2
@BEGIN_FROM_3_08_0@
 
3
type t = string
 
4
@END_FROM_3_08_0@
 
5
@BEGIN_BEFORE_3_08_0@
 
6
type t = string
 
7
@END_BEFORE_3_08_0@
 
8
(** @since 3.08.0: type t = string
 
9
 *)
 
10
 
 
11
@BEGIN_FROM_4_07_0@
 
12
val to_seq : t -> char Seq.t
 
13
@END_FROM_4_07_0@
 
14
@BEGIN_BEFORE_4_07_0@
 
15
val to_seq : t -> char Stdcompat__seq.t
 
16
@END_BEFORE_4_07_0@
 
17
(** @since 4.07.0: val to_seq : t -> char Seq.t
 
18
 *)
 
19
 
 
20
@BEGIN_FROM_4_07_0@
 
21
val to_seqi : t -> (int * char) Seq.t
 
22
@END_FROM_4_07_0@
 
23
@BEGIN_BEFORE_4_07_0@
 
24
val to_seqi : t -> (int * char) Stdcompat__seq.t
 
25
@END_BEFORE_4_07_0@
 
26
(** @since 4.07.0: val to_seqi : t -> (int * char) Seq.t
 
27
 *)
 
28
 
 
29
@BEGIN_FROM_4_07_0@
 
30
val of_seq : char Seq.t -> t
 
31
@END_FROM_4_07_0@
 
32
@BEGIN_BEFORE_4_07_0@
 
33
val of_seq : char Stdcompat__seq.t -> t
 
34
@END_BEFORE_4_07_0@
 
35
(** @since 4.07.0: val of_seq : char Seq.t -> t
 
36
 *)
 
37
 
 
38
val index_opt : string -> char -> int option
 
39
(** @since 4.05.0: val index_opt : string -> char -> int option *)
 
40
 
 
41
val rindex_opt : string -> char -> int option
 
42
(** @since 4.05.0: val rindex_opt : string -> char -> int option *)
 
43
 
 
44
val index_from_opt : string -> int -> char -> int option
 
45
(** @since 4.05.0: val index_from_opt : string -> int -> char -> int option *)
 
46
 
 
47
val rindex_from_opt : string -> int -> char -> int option
 
48
(** @since 4.05.0: val rindex_from_opt : string -> int -> char -> int option *)
 
49
 
 
50
val uppercase_ascii : string -> string
 
51
(** @since 4.05.0: val uppercase_ascii : string -> string *)
 
52
 
 
53
val lowercase_ascii : string -> string
 
54
(** @since 4.05.0: val lowercase_ascii : string -> string *)
 
55
 
 
56
val capitalize_ascii : string -> string
 
57
(** @since 4.05.0: val capitalize_ascii : string -> string *)
 
58
 
 
59
val uncapitalize_ascii : string -> string
 
60
(** @since 4.05.0: val uncapitalize_ascii : string -> string *)
 
61
 
 
62
val equal : t -> t -> bool
 
63
(** @since 4.05.0: val equal : t -> t -> bool *)
 
64
 
 
65
val split_on_char : sep:char -> string -> string list
 
66
(** @since 4.05.0: val split_on_char : sep:char -> string -> string list *)
 
67
 
 
68
@BEGIN_FROM_4_08_0@
 
69
external set : bytes -> int -> char -> unit = "%string_safe_set"
 
70
@END_FROM_4_08_0@
 
71
@BEGIN_BEFORE_4_08_0@
 
72
@BEGIN_FROM_4_02_0@
 
73
external set : bytes -> int -> char -> unit = "%string_safe_set"[@@ocaml.deprecated
 
74
                                                                  "Use BytesLabels.set instead."]
 
75
@END_FROM_4_02_0@
 
76
@BEGIN_BEFORE_4_02_0@
 
77
external set :
 
78
  Stdcompat__init.bytes -> int -> char -> unit = "%string_safe_set"
 
79
@END_BEFORE_4_02_0@
 
80
 
 
81
@END_BEFORE_4_08_0@
 
82
(** @since 4.08.0:
 
83
    external set : bytes -> int -> char -> unit = "%string_safe_set"
 
84
@since 4.02.0:
 
85
external set : bytes -> int -> char -> unit = "%string_safe_set"[@@ocaml.deprecated
 
86
                                                                  "Use BytesLabels.set instead."]
 
87
 *)
 
88
 
 
89
@BEGIN_FROM_4_08_0@
 
90
external create : int -> bytes = "caml_create_string"
 
91
@END_FROM_4_08_0@
 
92
@BEGIN_BEFORE_4_08_0@
 
93
@BEGIN_FROM_4_02_0@
 
94
external create : int -> bytes = "caml_create_string"[@@ocaml.deprecated
 
95
                                                       "Use BytesLabels.create instead."]
 
96
@END_FROM_4_02_0@
 
97
@BEGIN_BEFORE_4_02_0@
 
98
@BEGIN_FROM_3_08_0@
 
99
external create : int -> Stdcompat__init.bytes = "caml_create_string"
 
100
@END_FROM_3_08_0@
 
101
@BEGIN_BEFORE_3_08_0@
 
102
external create : int -> Stdcompat__init.bytes = "create_string"
 
103
@END_BEFORE_3_08_0@
 
104
 
 
105
@END_BEFORE_4_02_0@
 
106
 
 
107
@END_BEFORE_4_08_0@
 
108
(** @since 4.08.0: external create : int -> bytes = "caml_create_string"
 
109
@since 4.02.0:
 
110
external create : int -> bytes = "caml_create_string"[@@ocaml.deprecated
 
111
                                                       "Use BytesLabels.create instead."]
 
112
 *)
 
113
 
 
114
val init : int -> f:(int -> char) -> string
 
115
(** @since 4.02.0: val init : int -> f:(int -> char) -> string *)
 
116
 
 
117
@BEGIN_FROM_4_08_0@
 
118
val fill : bytes -> pos:int -> len:int -> char -> unit
 
119
@END_FROM_4_08_0@
 
120
@BEGIN_BEFORE_4_08_0@
 
121
@BEGIN_FROM_4_02_0@
 
122
val fill : bytes -> pos:int -> len:int -> char -> unit[@@ocaml.deprecated
 
123
                                                        "Use BytesLabels.fill instead."]
 
124
@END_FROM_4_02_0@
 
125
@BEGIN_BEFORE_4_02_0@
 
126
val fill : Stdcompat__init.bytes -> pos:int -> len:int -> char -> unit
 
127
@END_BEFORE_4_02_0@
 
128
 
 
129
@END_BEFORE_4_08_0@
 
130
(** @since 4.08.0: val fill : bytes -> pos:int -> len:int -> char -> unit
 
131
@since 4.02.0:
 
132
val fill : bytes -> pos:int -> len:int -> char -> unit[@@ocaml.deprecated
 
133
                                                        "Use BytesLabels.fill instead."]
 
134
 *)
 
135
 
 
136
@BEGIN_FROM_4_02_0@
 
137
val blit :
 
138
  src:string -> src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unit
 
139
@END_FROM_4_02_0@
 
140
@BEGIN_BEFORE_4_02_0@
 
141
val blit :
 
142
  src:string ->
 
143
    src_pos:int ->
 
144
      dst:Stdcompat__init.bytes -> dst_pos:int -> len:int -> unit
 
145
@END_BEFORE_4_02_0@
 
146
(** @since 4.02.0:
 
147
    val blit :
 
148
      src:string ->
 
149
        src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unit
 
150
 *)
 
151
 
 
152
val mapi : f:(int -> char -> char) -> string -> string
 
153
(** @since 4.02.0: val mapi : f:(int -> char -> char) -> string -> string *)
 
154
 
 
155
@BEGIN_FROM_4_08_0@
 
156
external unsafe_set : bytes -> int -> char -> unit = "%string_unsafe_set"
 
157
@END_FROM_4_08_0@
 
158
@BEGIN_BEFORE_4_08_0@
 
159
@BEGIN_FROM_4_02_0@
 
160
external unsafe_set : bytes -> int -> char -> unit = "%string_unsafe_set"
 
161
[@@ocaml.deprecated "- : bytes -> int -> char -> unit = <fun>"]
 
162
@END_FROM_4_02_0@
 
163
@BEGIN_BEFORE_4_02_0@
 
164
external unsafe_set :
 
165
  Stdcompat__init.bytes -> int -> char -> unit = "%string_unsafe_set"
 
166
@END_BEFORE_4_02_0@
 
167
 
 
168
@END_BEFORE_4_08_0@
 
169
(** @since 4.08.0:
 
170
    external unsafe_set : bytes -> int -> char -> unit = "%string_unsafe_set"
 
171
@since 4.02.0:
 
172
external unsafe_set : bytes -> int -> char -> unit = "%string_unsafe_set"
 
173
[@@ocaml.deprecated "- : bytes -> int -> char -> unit = <fun>"]
 
174
 *)
 
175
 
 
176
@BEGIN_FROM_4_03_0@
 
177
external unsafe_blit :
 
178
  src:string -> src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unit =
 
179
    "caml_blit_string"[@@noalloc ]
 
180
@END_FROM_4_03_0@
 
181
@BEGIN_BEFORE_4_03_0@
 
182
@BEGIN_FROM_4_02_0@
 
183
external unsafe_blit :
 
184
  src:string -> src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unit =
 
185
    "caml_blit_string" "noalloc"
 
186
@END_FROM_4_02_0@
 
187
@BEGIN_BEFORE_4_02_0@
 
188
@BEGIN_FROM_3_08_0@
 
189
external unsafe_blit :
 
190
  src:string ->
 
191
    src_pos:int ->
 
192
      dst:Stdcompat__init.bytes -> dst_pos:int -> len:int -> unit =
 
193
    "caml_blit_string" "noalloc"
 
194
@END_FROM_3_08_0@
 
195
@BEGIN_BEFORE_3_08_0@
 
196
external unsafe_blit :
 
197
  src:string ->
 
198
    src_pos:int ->
 
199
      dst:Stdcompat__init.bytes -> dst_pos:int -> len:int -> unit =
 
200
    "blit_string" "noalloc"
 
201
@END_BEFORE_3_08_0@
 
202
 
 
203
@END_BEFORE_4_02_0@
 
204
 
 
205
@END_BEFORE_4_03_0@
 
206
(** @since 4.03.0:
 
207
    external unsafe_blit :
 
208
      src:string ->
 
209
        src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unit =
 
210
        "caml_blit_string"[@@noalloc ]
 
211
@since 4.02.0:
 
212
external unsafe_blit :
 
213
  src:string -> src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unit =
 
214
    "caml_blit_string" "noalloc"
 
215
 *)
 
216
 
 
217
@BEGIN_FROM_4_08_0@
 
218
external unsafe_fill :
 
219
  bytes -> pos:int -> len:int -> char -> unit = "caml_fill_string"[@@noalloc
 
220
                                                                    ]
 
221
@END_FROM_4_08_0@
 
222
@BEGIN_BEFORE_4_08_0@
 
223
@BEGIN_FROM_4_03_0@
 
224
external unsafe_fill :
 
225
  bytes -> pos:int -> len:int -> char -> unit = "caml_fill_string"[@@ocaml.deprecated
 
226
                                                                    "- : bytes -> pos:int -> len:int -> char -> unit = <fun>"]
 
227
[@@noalloc ]
 
228
@END_FROM_4_03_0@
 
229
@BEGIN_BEFORE_4_03_0@
 
230
@BEGIN_FROM_4_02_0@
 
231
external unsafe_fill :
 
232
  bytes -> pos:int -> len:int -> char -> unit = "caml_fill_string" "noalloc"
 
233
[@@ocaml.deprecated
 
234
  "- : bytes -> pos:int -> len:int -> char -> unit = <fun>"]
 
235
@END_FROM_4_02_0@
 
236
@BEGIN_BEFORE_4_02_0@
 
237
@BEGIN_FROM_3_08_0@
 
238
external unsafe_fill :
 
239
  Stdcompat__init.bytes -> pos:int -> len:int -> char -> unit =
 
240
    "caml_fill_string" "noalloc"
 
241
@END_FROM_3_08_0@
 
242
@BEGIN_BEFORE_3_08_0@
 
243
external unsafe_fill :
 
244
  Stdcompat__init.bytes -> pos:int -> len:int -> char -> unit = "fill_string"
 
245
    "noalloc"
 
246
@END_BEFORE_3_08_0@
 
247
 
 
248
@END_BEFORE_4_02_0@
 
249
 
 
250
@END_BEFORE_4_03_0@
 
251
 
 
252
@END_BEFORE_4_08_0@
 
253
(** @since 4.08.0:
 
254
    external unsafe_fill :
 
255
      bytes -> pos:int -> len:int -> char -> unit = "caml_fill_string"
 
256
    [@@noalloc ]
 
257
@since 4.03.0:
 
258
external unsafe_fill :
 
259
  bytes -> pos:int -> len:int -> char -> unit = "caml_fill_string"[@@ocaml.deprecated
 
260
                                                                    "- : bytes -> pos:int -> len:int -> char -> unit = <fun>"]
 
261
[@@noalloc ]
 
262
@since 4.02.0:
 
263
external unsafe_fill :
 
264
  bytes -> pos:int -> len:int -> char -> unit = "caml_fill_string" "noalloc"
 
265
[@@ocaml.deprecated
 
266
  "- : bytes -> pos:int -> len:int -> char -> unit = <fun>"]
 
267
 *)
 
268
 
 
269
val iteri : f:(int -> char -> unit) -> string -> unit
 
270
(** @since 4.00.0: val iteri : f:(int -> char -> unit) -> string -> unit *)
 
271
 
 
272
val map : f:(char -> char) -> string -> string
 
273
(** @since 4.00.0: val map : f:(char -> char) -> string -> string *)
 
274
 
 
275
val trim : string -> string
 
276
(** @since 4.00.0: val trim : string -> string *)
 
277
 
 
278
val compare : t -> t -> int
 
279
(** @since 3.08.0: val compare : t -> t -> int *)
 
280
 
 
281
external length : string -> int = "%string_length"
 
282
(** Alias for {!StringLabels.length} *)
 
283
 
 
284
external get : string -> int -> char = "%string_safe_get"
 
285
(** Alias for {!StringLabels.get} *)
 
286
 
 
287
val make : int -> char -> string
 
288
(** Alias for {!StringLabels.make} *)
 
289
 
 
290
@BEGIN_FROM_4_08_0@
 
291
val copy : string -> string
 
292
@END_FROM_4_08_0@
 
293
@BEGIN_BEFORE_4_08_0@
 
294
@BEGIN_FROM_4_06_0@
 
295
val copy : string -> string[@@ocaml.deprecated
 
296
                             "- : string -> string = <fun>"]
 
297
@END_FROM_4_06_0@
 
298
@BEGIN_BEFORE_4_06_0@
 
299
val copy : string -> string
 
300
@END_BEFORE_4_06_0@
 
301
 
 
302
@END_BEFORE_4_08_0@
 
303
(** @since 4.08.0: val copy : string -> string
 
304
@since 4.06.0:
 
305
val copy : string -> string[@@ocaml.deprecated
 
306
                             "- : string -> string = <fun>"]
 
307
@since 3.07.0: val copy : string -> string
 
308
 *)
 
309
 
 
310
val sub : string -> pos:int -> len:int -> string
 
311
(** Alias for {!StringLabels.sub} *)
 
312
 
 
313
val concat : sep:string -> string list -> string
 
314
(** Alias for {!StringLabels.concat} *)
 
315
 
 
316
val iter : f:(char -> unit) -> string -> unit
 
317
(** Alias for {!StringLabels.iter} *)
 
318
 
 
319
val escaped : string -> string
 
320
(** Alias for {!StringLabels.escaped} *)
 
321
 
 
322
val index : string -> char -> int
 
323
(** Alias for {!StringLabels.index} *)
 
324
 
 
325
val rindex : string -> char -> int
 
326
(** Alias for {!StringLabels.rindex} *)
 
327
 
 
328
val index_from : string -> int -> char -> int
 
329
(** Alias for {!StringLabels.index_from} *)
 
330
 
 
331
val rindex_from : string -> int -> char -> int
 
332
(** Alias for {!StringLabels.rindex_from} *)
 
333
 
 
334
val contains : string -> char -> bool
 
335
(** Alias for {!StringLabels.contains} *)
 
336
 
 
337
val contains_from : string -> int -> char -> bool
 
338
(** Alias for {!StringLabels.contains_from} *)
 
339
 
 
340
val rcontains_from : string -> int -> char -> bool
 
341
(** Alias for {!StringLabels.rcontains_from} *)
 
342
 
 
343
@BEGIN_FROM_4_08_0@
 
344
val uppercase : string -> string
 
345
@END_FROM_4_08_0@
 
346
@BEGIN_BEFORE_4_08_0@
 
347
@BEGIN_FROM_4_05_0@
 
348
val uppercase : string -> string[@@ocaml.deprecated
 
349
                                  "Use String.uppercase_ascii instead."]
 
350
@END_FROM_4_05_0@
 
351
@BEGIN_BEFORE_4_05_0@
 
352
val uppercase : string -> string
 
353
@END_BEFORE_4_05_0@
 
354
 
 
355
@END_BEFORE_4_08_0@
 
356
(** @since 4.08.0: val uppercase : string -> string
 
357
@since 4.05.0:
 
358
val uppercase : string -> string[@@ocaml.deprecated
 
359
                                  "Use String.uppercase_ascii instead."]
 
360
@since 3.07.0: val uppercase : string -> string
 
361
 *)
 
362
 
 
363
@BEGIN_FROM_4_08_0@
 
364
val lowercase : string -> string
 
365
@END_FROM_4_08_0@
 
366
@BEGIN_BEFORE_4_08_0@
 
367
@BEGIN_FROM_4_05_0@
 
368
val lowercase : string -> string[@@ocaml.deprecated
 
369
                                  "Use String.lowercase_ascii instead."]
 
370
@END_FROM_4_05_0@
 
371
@BEGIN_BEFORE_4_05_0@
 
372
val lowercase : string -> string
 
373
@END_BEFORE_4_05_0@
 
374
 
 
375
@END_BEFORE_4_08_0@
 
376
(** @since 4.08.0: val lowercase : string -> string
 
377
@since 4.05.0:
 
378
val lowercase : string -> string[@@ocaml.deprecated
 
379
                                  "Use String.lowercase_ascii instead."]
 
380
@since 3.07.0: val lowercase : string -> string
 
381
 *)
 
382
 
 
383
@BEGIN_FROM_4_08_0@
 
384
val capitalize : string -> string
 
385
@END_FROM_4_08_0@
 
386
@BEGIN_BEFORE_4_08_0@
 
387
@BEGIN_FROM_4_05_0@
 
388
val capitalize : string -> string[@@ocaml.deprecated
 
389
                                   "Use String.capitalize_ascii instead."]
 
390
@END_FROM_4_05_0@
 
391
@BEGIN_BEFORE_4_05_0@
 
392
val capitalize : string -> string
 
393
@END_BEFORE_4_05_0@
 
394
 
 
395
@END_BEFORE_4_08_0@
 
396
(** @since 4.08.0: val capitalize : string -> string
 
397
@since 4.05.0:
 
398
val capitalize : string -> string[@@ocaml.deprecated
 
399
                                   "Use String.capitalize_ascii instead."]
 
400
@since 3.07.0: val capitalize : string -> string
 
401
 *)
 
402
 
 
403
@BEGIN_FROM_4_08_0@
 
404
val uncapitalize : string -> string
 
405
@END_FROM_4_08_0@
 
406
@BEGIN_BEFORE_4_08_0@
 
407
@BEGIN_FROM_4_05_0@
 
408
val uncapitalize : string -> string[@@ocaml.deprecated
 
409
                                     "Use String.uncapitalize_ascii instead."]
 
410
@END_FROM_4_05_0@
 
411
@BEGIN_BEFORE_4_05_0@
 
412
val uncapitalize : string -> string
 
413
@END_BEFORE_4_05_0@
 
414
 
 
415
@END_BEFORE_4_08_0@
 
416
(** @since 4.08.0: val uncapitalize : string -> string
 
417
@since 4.05.0:
 
418
val uncapitalize : string -> string[@@ocaml.deprecated
 
419
                                     "Use String.uncapitalize_ascii instead."]
 
420
@since 3.07.0: val uncapitalize : string -> string
 
421
 *)
 
422
 
 
423
external unsafe_get : string -> int -> char = "%string_unsafe_get"
 
424
(** Alias for {!StringLabels.unsafe_get} *)
 
425
 
 
426
end