-
Notifications
You must be signed in to change notification settings - Fork 125
/
string.opa
714 lines (633 loc) · 20.5 KB
/
string.opa
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
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
/*
Copyright © 2011, 2012 MLstate
This file is part of Opa.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
/**
* @author Nicolas Pelletier, 2010
* @author Valentin Gatien-Baron, 2010 (documentation)
* @destination public
* @stability unknown
* @category data
*/
/**
* {1 About this module}
*
* Definition of the string library
*
* Strings are immutable containers of characters.
*
* {1 Where should I start ?}
*
* {1 What if I need more?}
*/
/*
* TODO:
* define string_insert in opa
* define string_escaped in ??
*/
/**
* {1 Types defined in this module}
*/
/**
* Order type label for string
*/
type String.order = Order.default
@abstract type String.order_ci = void
/**
* {1 Interface}
*/
String =
{{
/**
* {2 Primitive operations}
*/
/**
* Compare two string
*/
compare(a,b): Order.comparison =
@opensums(ordering(a,b))
/**
* Compare two string
*/
ordering = %%BslString.ordering%%
compare_raw = %% BslPervasives.compare_string %%
/**
* Check equality of two string
*/
equals = eq
/*
* cannot call these functions <, > etc. because
* then the rest of the module cannot call the polymorphic >
*/
`lt` = %%BslString.lt%%
`gt` = %%BslString.gt%%
`le` = %%BslString.leq%%
`ge` = %%BslString.geq%%
`ne` = %%BslString.neq%%
`eq` = %%BslString.eq%%
`^` = %% BslString.concat %%
/**
* Returns the length of the string
*/
length = %% BslString.length %%
/**
* Returns the length of the string
*/
byte_length = %% BslPervasivesServer.byte_length %%
/**
* Determine if a string is empty
*
* @return true if the string is empty, false otherwise
*/
is_empty(s): bool =
length(s) == 0
/**
* Returns the string composed of the nth character of the given string
* (starting at index 0)
*
* Exits with an error when the index is out of bounds
*/
get(offset: int, source: string): string=
f= %% BslString.get %%
if offset < length(source) && offset >= 0 then f(source, offset)
else error("get out of range")
: string
/**
* [index(substring, string)] finds a sub-string in a string
*
* @return {none} if [substring] doesn't appear in [string]
* @return {some} containing the index of the first occurrence of the
* sub-string otherwise
*/
index = %% BslString.index %%
/**
* [contains(string, substring)] checks if a string contains a substring
*/
contains(string:string, substring:string) =
Option.is_some(index(substring, string))
/**
* [init(f, n)] creates a string which consists of the flattening of
* [f(0)],[f(1)], ..., [f(n-1)]
* Efficiency note: as the length of [f(0)] ... [f(n-1)] are not known in
* advance, [init] is not very efficient. For constant [f], [repeat] is faster.
*/
init(f, n) = flatten(List.init(f, n))
/**
* [repeat(s, n)] returns a string which consists in [n] repetitions of string [s]
*/
repeat(s, n) = %% BslString.repeat %%(n, s)
/**
* [replace(substring, replacement, source)] replaces every occurrence of
* [substring] by [replacement]
*
* Characters from the input cannot belong to several overlapping occurrences
* of the sub-string
* eg: [replace("aba","c","ababa")] will return ["cba"]
*/
replace = %% BslString.replace %%
/**
* Create a string in the reverse order of the original one
*/
reverse = %% BslString.reverse %%
/**
* [substring_opt(offset, length, source)] returns an option
* containing the string composed of the characters of [source],
* starting at [offset] (indexed from 0) and of length [length]
*
* Returns [Option.none] when [length(source) < offset+length]
*/
substring_opt(offset: int, len: int, source: string): option(string) =
(
src_len= length(source)
if len < 0 || offset < 0 || offset + len > src_len then
Option.none
else
// if we suppose that the previous verification are enough then this call must always work
Option.some(substring_unsafe(offset, len, source))
)
/**
* A variant of [substring] that can raise an exception if offsets are incorrect
*/
substring_unsafe(offset:int, len:int, source:string): string =
llsub = %% BslString.sub %%
src_len = length(source)
if offset == 0 && src_len == len then source
else llsub(offset, len, source)
/**
* [substring(offset, length, source)] returns the string composed of the
* characters of [source], starting at [offset] (indexed from 0) and of length
* [length]
*
* Exits with an error when [length(source) < offset+length]
*/
substring(offset: int, len: int, source: string)=
match (substring_opt(offset, len, source)) : option(string) with
| { ~some } -> some
| { none } -> error("[substring] out of range in \"{source}\" ({offset}, {len}, {length(source)} )")
: string
/**
* Gets a prefix of a given string of given length.
*
* @param length prefix length
* @param source source string
* @return [length]-character length prefix of [source] or [none] if
* [source] is shorter than [length] characters.
*/
get_prefix(length: int, source: string) : option(string) =
String.substring_opt(0, length, source)
/**
* Gets a suffix of a given string of given length.
*
* @param length suffix length
* @param source source string
* @return [length]-character length suffix of [source] or [none] if
* [source] is shorter than [length] characters.
*/
get_suffix(length: int, source: string) : option(string) =
String.substring_opt(String.length(source) - length, length, source)
/**
* [replace the first character by his uppercase]
*
* eg: [capitalize("toTo")] will return ["ToTo"]
*/
capitalize(str: string)=
len= length(str)
if len < 1 then ""
else to_upper(get(0, str))^substring(1, len - 1, str)
/**
* Order for string comparison
*
* The comparison differenciates lowercase from uppercase,
* use the "ASCII order" to compare them.
*/
order =
Order.make(ordering) : order(string, String.order)
/**
* Order for string comparison
*
* Same behavior than [String.order], but case insensitive.
*/
order_ci =
Order.make(x,y -> ordering(to_lower(x),to_lower(y)))
: order(string, String.order_ci)
/**
* Create the string representation of an integer
*/
of_int= %% BslString.of_int %%
/**
* Create the string representation of a float
*/
of_float= %% BslNumber.Float.to_string %%
/**
* Create the string representation of a void
*/
of_void(_: void)= "\{\}"
/**
* Converts all the characters of the string to lowercase
*/
to_lower= %% BslCactutf.lowercase %%
/**
* Converts all the characters of the string to uppercase
*/
to_upper= %% BslCactutf.uppercase %%
/**
* Removes some accents
*/
//FIXME 1: this should be done in a more complete way and moved to Catcutf
//FIXME 2: the server version probably breaks UTF-8 strings
//WARNING: used in external projects
remove_accents = %% Bslstring.remove_accents %%
/**
* Returns the UTF8 representation of a positive integer
*
* Exits with an error when the integer is negative
*/
of_utf8_val= %% BslString.to_character %%
/**
* Build a string from a byte value.
* Useful if you use strings for outputs in binary format
**/
of_byte_val = %% BslString.of_byte_val %%
/**
* Build a string from a byte value.
* Unsafe: may raise an error
**/
of_byte_unsafe = %% BslString.of_byte_unsafe %%
/**
* Peeks the nth byte in a string
* Unsafe: may raise an error
* Unsound: may give different results on server and client
**/
byte_at_unsafe = %% BslString.byte_at_unsafe %%
/**
* Escapes some characters. Used internally.
* Very slow: replace or improve
**/
escape_non_utf8_special(v) =
/* see json.org */
transform =
| "\"" -> "\\\""
| "\\" -> "\\\\"
/* | "\/" -> "\\\/"
| "\b" -> "\\n"
| "\f" -> "\\f" include in fallback*/
| "\n" -> "\\n"
| "\r" -> "\\r"
| "\t" -> "\\t"
| c ->
i = Cactutf.look(c,0)
if i < 32 then
if i < 10 then "\\u000{i}"
else "\\u00{i}"
else c
String.map(transform,v)
/**
* {2 Additional functions}
*/
/**
* [replace_first(substring, replacement, source)] replaces the leftmost
* occurrence of [substring] in [source] by [replacement] (if any)
*/
replace_first(search: string, replacement: string, source: string)=
lfun= offset ->
len= offset + length(search)
sub(0, offset, source)^replacement^drop_left(len, source)
Option.switch(lfun, source, index(search, source))
: string
/**
* the same as index but insensitive
*/
index_i(needle: string, source: string)=
index(to_lower(needle), to_lower(source))
: option(int)
/**
* Returns the right part of [source], [len] is the left part length
*/
drop_left(len: int, source: string)=
sub(len, length(source) - len, source)
: string
/**
* Returns the left part of [source], [len] is the right part length
*/
drop_right(len: int, source: string)=
sub(0, length(source) - len, source)
: string
/**
* same as get but from the end
*/
get_end(offset: int, source: string)=
get(length(source) - offset - 1, source)
: string
/**
* [check_substring(string, pos, substr)] checks that the sub-string
* of [string] starting at [pos] begins with [substr]
*/
check_substring : string, int, string -> bool = %% BslString.check_match_literal %%
/**
* Splits a string into a list of segments separated by a given string.
*
* @param separator a string to act as a separator
* @param source a source string
* @param chain_sep if true then two or more occurrences of a separator
* are treated as one. If false then empty strings occur between
* consecutive separators. I.e.
* [explode_with("/", "/a//b/", true) = ["a","b"]]
* [explode_with("/", "/a//b/", false) = ["a","","b"]]
* @return A list of segments from the string [source] in between
* [separator]s.
*/
explode_with(separator: string, source: string, chain_sep: bool) : list(string) =
sep_len = length(separator)
if sep_len == 0 then [ source ] else
source_len = length(source)
rec aux_sep(acc,pos) =
if Int.equals(pos,source_len) then
List.rev(acc)
else
if check_substring(source,pos,separator) then
aux_sep(if chain_sep then acc else ["" | acc],pos+sep_len)
else
aux_not_sep(acc,pos,pos+1)
and aux_not_sep(acc,start_pos,pos) =
if Int.`>=`(pos,source_len) then
acc = [substring_unsafe(start_pos,pos-start_pos,source)|acc]
List.rev(acc)
else
if check_substring(source,pos,separator) then
acc = [substring_unsafe(start_pos,pos-start_pos,source)|acc]
aux_sep(acc,pos+sep_len)
else
aux_not_sep(acc,start_pos,pos+1)
aux_sep([],0)
/**
* Splits a string into a list of segments separated by a given string.
* Two consecutive occurrences of a separator are treated as one; if
* that's not what you want check [String.explode_with].
*
* @param separator a string to act as a separator
* @param source a source string
* @return A list of segments from the string [source] in between
* [separator]s.
*/
explode(separator: string, source: string) : list(string) =
explode_with(separator, source, true)
ws_length(s) =
len = length(s)
rec aux(pos) =
if Int.equals(pos,len) then
pos
else
match get(pos,s) with
| " " | "\n" | "\r" | "\t" | /*"\v"*/"\11" | "\0" -> aux(pos+1)
| _ -> pos
aux(0)
/**
* Returns a copy of [source] string without padding which match with
* [" ", "\n", "\r", "\t", "\v", "\0"]
*/
strip(source: string): string=
len = length(source)
left = ws_length(source)
if len == left then ""
else
right = ws_length(rev(source))
sub(left, len - left - right, source)
/**
* the same as trim but strip only the left part
*/
strip_left(source: string)=
padding= ws_length(source)
drop_left(padding, source)
: string
/**
* the same as trim but strip only the right part
*/
strip_right(source)=
padding= ws_length(rev(source))
drop_right(padding, source)
: string
/**
* map each unicode character of [source] using the given character mapping function
*/
map(f: string -> string, source: string):string=
len=length(source)
if len > 0 then
buffer=Buffer.create(len*2)
rec aux(byte) =
do Buffer.append(buffer, f(Cactutf.cons(Cactutf.look(source,byte))))
byte=Cactutf.next(source,byte)
if byte < len then aux(byte)
do aux(0) // we know len>0
Buffer.contents(buffer)
else source
/**
* Replace all unicode characters [c] of the [source] by [e(c)] when [f(c)]
* returns bool.
*/
replace_char(source:string,
f:Unicode.character -> bool,
e:Unicode.character -> string):string =
len = String.length(source)
rec aux(i, stable, acc, size) =
if i >= len then
match acc with
| [] -> source
| _ ->
acc = if stable != i then [Cactutf.sub(source, stable, i - stable) | acc] else acc
b = Buffer.create(size)
do List.iter(Buffer.append(b, _), List.rev(acc))
Buffer.contents(b)
else
c = Cactutf.look(source, i)
n = Cactutf.next(source, i)
if f(c) then
esc = e(c)
acc = if stable != i then [Cactutf.sub(source, stable, i - stable) | acc] else acc
aux(n, n, [esc | acc], String.length(esc) + size + i - stable)
else aux(n, stable, acc, size)
aux(0, 0, [], 0)
/**
* iter on each character of [source] and call the function [callback] with the current character
* and an accumulator [accumulator]
* @return the last accumulator
*/
fold(callback:string, 'a -> 'a, source: string, accumulator: 'a)=
len= length(source)
rec aux= offset, accu ->
if offset < len
then aux(offset + 1, callback(get(offset, source), accu))
else accu
aux(0, accumulator)
: 'a
/**
* @return true if the source contains only white spaces characters, false otherwise
*/
is_blank(source: string) : bool =
strip_left(source) == ""
/**
* concatenates the list of alphas, inserting string [separator] between each.
* each element of this list is given to callback to make a string
*/
of_list(callback:'a -> string, separator: string, list: list('a)) : string =
concat(separator, List.map(callback, list))
/**
* The same as of_list but the list must contain strings
*/
@opacapi
concat(separator: string, list: list(string)) : string =
flatten(List.intersperse(separator, list))
/**
* The same as of_list but the list must contain strings and there is no separator
*/
flatten(list: list(string)): string=
(
size = List.fold(((x:string),(acc:int) -> String.length(x) + acc), list, 0)
llbuff = Buffer.create(size)
do List.iter(Buffer.append(llbuff, _), list)
Buffer.contents(llbuff)
)
/**
* This function returns an unsigned int to count blocks of non blank
*/
word_count(source: string)=
lfun= char, accu -> if xor(is_blank(char), accu.f1) then (not(accu.f1), accu.f2 + 1) else accu
(fold(lfun, source, (true, 0)).f2 + 1) / 2
: int
/**
* Returns the index of unmatched char
* Returns 0 if both strings [left] and [right] are equal
* Returns 1 if the first char differ
*/
diff(left: string, right: string)=
len = Int.min(length(left), length(right))
rec aux= offset ->
if get(offset, left) == get(offset, right) then if offset < len - 1 then aux(offset + 1) else len
else offset + 1
if len > 0 then res= aux(0) if res == Int.max(length(left), length(right)) then 0 else res
else 0
: int
/**
* same as diff but case insensitive
*/
diff_i(left: string, right: string)=
diff(to_lower(left), to_lower(right))
: int
/**
* this function completes the [source] string to get the length wanted [len] with the string [padder]
*/
padding_left(padder: string, len: int, source: string)=
src_len= length(source)
pad_len= length(padder)
if len < src_len || pad_len < 1 then source
else sub(0, len - src_len, repeat(((len - src_len) / pad_len) + 1, padder))^source
: string
/**
* the same as padding by pad on right
*/
padding_right(padder: string, len: int, source: string)=
src_len= length(source)
pad_len= length(padder)
if len < src_len || pad_len < 1 then source
else source^sub(0, len - src_len, repeat(((len - src_len) / pad_len) + 1, padder))
: string
/**
* Returns a string that succeed [source]
*/
next(source: string) : string =
if source == "" then "a"
else
last = length(source) - 1
i = byte_at_unsafe(last, source)
if (i >= 65 && i < 90) || (i >= 97 && i < 122)
then
substring(0, last, source) ^ of_byte_unsafe(i+1)
else
source ^ "a"
/**
* Returns a string fresh generator.
*/
fresh(init : int) =
ofint(i) =
if (i <= 25) then String.of_utf8_val(i + 65) //Capital Letter
else String.of_utf8_val(i + 72) //Small Letter
rec gen(i, l) =
if (i <= 50) then String.flatten(ofint(i)+>l)
else
gen(i/50, ofint(mod(i, 50))+>l)
x = Reference.create(init)
// We don't use Fresh module (because cyclic-dependencies)
->
gen(@atomic(
i = Reference.get(x)
do Reference.set(x, i+1)
i), [])
/**
* Returns true iff the source string has a given prefix.
*
* @param prefix a prefix to check
* @param source a source string
* @reutrn true iff [source] has prefix [prefix]
*/
has_prefix(prefix: string, source: string) : bool =
match get_prefix(length(prefix), source)
| {none} -> false
| {some=source_prefix} -> equals(prefix, source_prefix)
/**
* Returns true iff the source string has a given suffix.
*
* @param suffix a suffix to check
* @param source a source string
* @reutrn true iff [source] has suffix [suffix]
*/
has_suffix(suffix: string, source: string) : bool =
match get_suffix(length(suffix), source)
| {none} -> false
| {some=source_suffix} -> equals(suffix, source_suffix)
/**
* Returns a String with the [n] first letters capitalized
*
* @param len the number of characters to uppercase
* @param source a source string
*/
// Use of Text because it should be cheaper to append Text than String
uppercase_first(len, source) =
String.fold(s, (cpt, acc) ->
if cpt < len then
s = String.uppercase(s)
(cpt+1, Text.insert_right(acc, s))
else (cpt+1, Text.insert_right(acc, s))
, source, (0, Text.cons(""))).f2
|> Text.to_string(_)
/**
* ALIAS / SHORTHAND OF PREEXISTING FUNCTIONS
*/
strpos = index
strposi = index_i
rev = reverse
sub_opt = substring_opt
substr = substring
sub = substring
trim = strip
rtrim = strip_right
ltrim = strip_left
implode = of_list
pad_left = padding_left
pad_right = padding_right
uppercase = to_upper
lowercase = to_lower
of_string = identity:string -> string
to_int = Int.of_string
to_float = Float.of_string
to_string = of_string
/**
* DEPRECATED FUNCTIONS
*/
print_list = source -> "["^concat(",", source)^"]"
}}
@opacapi
String_flatten = String.flatten
@opacapi
String_quote(s) = "\"" ^ s ^ "\""