-
Notifications
You must be signed in to change notification settings - Fork 21
/
HsName.chs
1037 lines (869 loc) · 33 KB
/
HsName.chs
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
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Haskell names
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[doesWhat doclatex
HsName represents names as used inside the compiler. A HsName can be a
base name, like a string or an int (for offset names), or it can be a
modified base name. Modification is done by qualification and
unification, the first related to hierarchical modules, the second used
internally whenever a name gives rise to a newly introduced identifier.
In that case the unification also carries a HsNameUniqifier which indicates
what the purpose of the uniqification is. The unification is carried
with a name forever, so it can also be used to detect properties of a
name. For example, a name can represent an evaluated value. However, it
is the responsibility of the compiler part using a particular
HsNameUniqifier to guarantee such an invariant.
%%]
%%[1 module {%{EH}Base.HsName} import(UHC.Util.Utils,UHC.Util.Pretty, Data.List)
%%]
%%[1 import({%{EH}Base.UID})
%%]
%%[1 import(UU.Scanner.Position) export(HSNM(..))
%%]
%%[3 import(qualified Data.Set as Set,Data.Maybe)
%%]
%%[8 import(qualified Data.Set as Set,Data.Maybe, Data.Char, Numeric)
%%]
%%[7 import(qualified Data.Map as Map)
%%]
%%[8 import(UHC.Util.FPath,Data.Char)
%%]
%%[8 export(OrigName(..))
%%]
%%[10 export(hsnConcat)
%%]
%%[50 import(Control.Monad, {%{EH}Base.Binary}, {%{EH}Base.Serialize})
%%]
%%[99 import(Data.Hashable)
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Haskell names, uniqification info
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[7 export(HsNameUniqifier(..))
-- | A HsNameUniqifier represents the 'type' of unification
data HsNameUniqifier
= HsNameUniqifier_Blank -- just a new identifier, with an empty show
| HsNameUniqifier_New -- just a new identifier
| HsNameUniqifier_GloballyUnique -- globally unique
| HsNameUniqifier_Evaluated -- evaluated
| HsNameUniqifier_Field -- extracted field
| HsNameUniqifier_Class -- class
| HsNameUniqifier_ClassDict -- dictionary
| HsNameUniqifier_SelfDict -- dictionary under construction itself, passed as arg in tying the knot recursion
| HsNameUniqifier_ResultDict -- dictionary under construction result
| HsNameUniqifier_SuperClass -- super class field
| HsNameUniqifier_DictField -- dictionary field
| HsNameUniqifier_Inline -- new identifier because of inlining
| HsNameUniqifier_GloballyUniqueDict -- globally unique dictionary
| HsNameUniqifier_FieldOffset -- offset for a field
| HsNameUniqifier_CaseContinuation -- continuation of a case expression
| HsNameUniqifier_GrinUpdated -- Grin: updated value
| HsNameUniqifier_FFIArg -- arg evaluated for FFI
| HsNameUniqifier_LacksLabel -- label used in lacking predicates
| HsNameUniqifier_BindAspect -- binding aspect
| HsNameUniqifier_Strict -- strict variant of binding
%%[[92
| HsNameUniqifier_GenericClass -- a name introduced by generics
%%]]
%%[[(8 javascript)
| HsNameUniqifier_JSSwitchResult -- var for result of switch
%%]]
%%[[(90 codegen)
| HsNameUniqifier_FFE -- name of value to be ff exported
| HsNameUniqifier_FFECoerced -- name of possibly coerced value to be ff exported
%%]]
deriving (Eq,Ord,Enum)
-- | The show of a HsNameUniqifier is found back in the pretty printed code, current convention is 3 uppercase letters, as a balance between size and clarity of meaning
instance Show HsNameUniqifier where
show HsNameUniqifier_Blank = ""
show HsNameUniqifier_New = "NEW"
show HsNameUniqifier_GloballyUnique = "UNQ"
show HsNameUniqifier_Evaluated = "EVL"
show HsNameUniqifier_Field = "FLD"
show HsNameUniqifier_Class = "CLS"
show HsNameUniqifier_ClassDict = "DCT"
show HsNameUniqifier_SelfDict = "SDC"
show HsNameUniqifier_ResultDict = "RDC"
show HsNameUniqifier_SuperClass = "SUP"
show HsNameUniqifier_DictField = "DFL"
show HsNameUniqifier_Inline = "INL"
show HsNameUniqifier_GloballyUniqueDict = "UND"
show HsNameUniqifier_FieldOffset = "OFF"
show HsNameUniqifier_CaseContinuation = "CCN"
show HsNameUniqifier_GrinUpdated = "UPD"
show HsNameUniqifier_FFIArg = "FFI"
show HsNameUniqifier_LacksLabel = "LBL"
show HsNameUniqifier_BindAspect = "ASP"
show HsNameUniqifier_Strict = "STR"
%%[[91
show HsNameUniqifier_GenericClass = "GEN"
%%]]
%%[[(8 javascript)
show HsNameUniqifier_JSSwitchResult = "JSW"
%%]]
%%[[(90 codegen)
show HsNameUniqifier_FFE = "FFE"
show HsNameUniqifier_FFECoerced = "FFC"
%%]]
%%]
%%[7 export(HsNameUnique(..))
-- | A HsNameUnique represents the optional additional info to make the uniqification even more unique
data HsNameUnique
= HsNameUnique_None
| HsNameUnique_String !String
| HsNameUnique_Int !Int
| HsNameUnique_UID !UID
deriving (Eq,Ord)
instance Show HsNameUnique where
show (HsNameUnique_None ) = ""
show (HsNameUnique_String s) = s
show (HsNameUnique_Int i) = show i
show (HsNameUnique_UID u) = show u
%%]
%%[7
type HsNameUniqifierMp = Map.Map HsNameUniqifier [HsNameUnique]
emptyHsNameUniqifierMp :: HsNameUniqifierMp
emptyHsNameUniqifierMp = Map.empty
showHsNameUniqifierMp' :: Bool -> String -> HsNameUniqifierMp -> [String]
showHsNameUniqifierMp' showLen usep us
= [ slen u ++ show uqf ++ concat [ usep ++ show uu | uu <- u, uu /= HsNameUnique_None ] | (uqf,u) <- Map.toList us ]
where slen u | showLen = usep ++ show (length u)
| otherwise = ""
showHsNameUniqifierMp :: String -> HsNameUniqifierMp -> [String]
showHsNameUniqifierMp = showHsNameUniqifierMp' True
%%]
%%[7
%%]
class HsNameUniqueable x where
hsnuniqeable :: x -> HsNameUnique
instance HsNameUniqueable String where
hsnuniqeable = HsNameUnique_String
instance HsNameUniqueable Int where
hsnuniqeable = HsNameUnique_Int
instance HsNameUniqueable UID where
hsnuniqeable = HsNameUnique_UID
%%[7
uniqifierMpAdd :: HsNameUniqifier -> HsNameUnique -> HsNameUniqifierMp -> HsNameUniqifierMp
uniqifierMpAdd ufier u m = Map.unionWith (++) (Map.singleton ufier [u]) m
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Uniqification
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[7 export(hsnUniqify,hsnUniqifyUID,hsnUniqifyStr,hsnUniqifyInt,hsnUniqifyEval)
hsnUniqify' :: HsNameUniqifier -> HsNameUnique -> HsName -> HsName
hsnUniqify' ufier u
= mk
where mk n@(HsName_Modf {hsnUniqifiers=us}) = hsnFixateHash (n {hsnUniqifiers = uniqifierMpAdd ufier u us})
mk n = mk (hsnMkModf [] n Map.empty)
-- | Uniqify with just a name suffix
hsnUniqify :: HsNameUniqifier -> HsName -> HsName
hsnUniqify ufier = hsnUniqify' ufier HsNameUnique_None
-- | Uniqify with a name suffix + extra Int uniq info
hsnUniqifyInt :: HsNameUniqifier -> Int -> HsName -> HsName
hsnUniqifyInt ufier u = hsnUniqify' ufier (HsNameUnique_Int u)
-- | Uniqify with a name suffix + extra UID uniq info
hsnUniqifyUID :: HsNameUniqifier -> UID -> HsName -> HsName
hsnUniqifyUID ufier u = hsnUniqify' ufier (HsNameUnique_UID u)
-- | Uniqify with a name suffix + extra String uniq info
hsnUniqifyStr :: HsNameUniqifier -> String -> HsName -> HsName
hsnUniqifyStr ufier u = hsnUniqify' ufier (HsNameUnique_String u)
-- | Uniqify for use as evaluated name
hsnUniqifyEval :: HsName -> HsName
hsnUniqifyEval = hsnUniqify HsNameUniqifier_Evaluated
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Haskell names: hashing
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[99
hsnHashWithSalt :: Int -> HsName -> Int
hsnHashWithSalt salt (HsName_Base s ) = hashWithSalt salt s
hsnHashWithSalt salt (HsName_Pos p ) = hashWithSalt salt p
hsnHashWithSalt salt (HsName_Modf _ q b u) = hashWithSalt salt q `combine` hashWithSalt salt b `combine` hashWithSalt salt (Map.toList u)
hsnHashWithSalt salt (HNmNr i n ) = i `combine` hashWithSalt salt n
instance Hashable HsName where
hashWithSalt salt n@(HsName_Modf h _ _ _) | h /= 0 = h
hashWithSalt salt n = hsnHashWithSalt salt n
instance Hashable OrigName where
hashWithSalt salt (OrigNone ) = salt
hashWithSalt salt (OrigLocal n) = 23 `combine` hashWithSalt salt n
hashWithSalt salt (OrigGlobal n) = 19 `combine` hashWithSalt salt n
hashWithSalt salt (OrigFunc n) = 17 `combine` hashWithSalt salt n
instance Hashable HsNameUnique where
hashWithSalt salt (HsNameUnique_None ) = salt
hashWithSalt salt (HsNameUnique_String s) = hashWithSalt salt s
hashWithSalt salt (HsNameUnique_Int i) = hashWithSalt salt i
hashWithSalt salt (HsNameUnique_UID u) = hashWithSalt salt u
instance Hashable HsNameUniqifier where
hashWithSalt salt u = hashWithSalt salt (fromEnum u)
%%]
%%[1
-- | Fixate hash
hsnFixateHash :: HsName -> HsName
%%[[99
hsnFixateHash n@(HsName_Modf _ _ _ _) = n {hsnHash = hsnHashWithSalt 17 n}
%%]]
hsnFixateHash n = n
{-# INLINE hsnFixateHash #-}
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Haskell names, datatype
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[1.HsName.type export(HsName(HsName_Base,HsName_Pos,HNmNr))
data HsName
= HsName_Base !String
%%[[7
| HsName_Modf
{
-- a secret hash, prefixing other fields as to enforce comparison on the hash first; only used at variant 99 and onwards to avoid clutter
hsnHash :: !Int
, hsnQualifiers :: ![String]
, hsnBase :: !HsName
, hsnUniqifiers :: !HsNameUniqifierMp
}
| HsName_Pos !Int
%%]]
%%[[8
| HNmNr !Int !OrigName
%%]]
deriving (Eq,Ord)
%%]
%%[1
-- | Smart constructor for HsName_Modf
hsnMkModf :: [String] -> HsName -> HsNameUniqifierMp -> HsName
%%[[1
hsnMkModf = HsName_Modf 0
%%][99
hsnMkModf q b u = hsnFixateHash $ HsName_Modf 0 q b u
%%]]
{-# INLINE hsnMkModf #-}
%%]
instance Eq HsName where
n1 == n2
= hsnCanonicSplit n1 == hsnCanonicSplit n2
where base (HsName_Base s1) (HsName_Base s2) = s1 == s2
instance Ord HsName where
n1 `compare` n2 = hsnCanonicSplit n1 `compare` hsnCanonicSplit n2
%%[1 export(mkHNmBase)
-- | Just lift a string to the base HsName variant
mkHNmBase :: String -> HsName
%%[[1
mkHNmBase = HsName_Base
%%][7
mkHNmBase s = hsnMkModf [] (HsName_Base s) Map.empty
%%]]
%%]
%%[1 export(hsnBaseUnpack',hsnBaseUnpack)
-- | unpack a HsName into qualifiers + base string + repack function
hsnBaseUnpack' :: HsName -> Maybe ([String],String,[String] -> String -> HsName)
hsnBaseUnpack' (HsName_Base s ) = Just ([],s,\_ s -> HsName_Base s)
%%[[7
hsnBaseUnpack' (HsName_Modf _ q b u) = fmap (\(bs,mk) -> (q, bs, \q s -> hsnMkModf q (mk s) u)) (hsnBaseUnpack b)
hsnBaseUnpack' _ = Nothing
%%]]
-- | unpack a HsName into base string + repack function
hsnBaseUnpack :: HsName -> Maybe (String,String -> HsName)
hsnBaseUnpack (HsName_Base s ) = Just (s,HsName_Base)
%%[[7
hsnBaseUnpack (HsName_Modf _ q b u) = fmap (\(bs,mk) -> (bs, \s -> hsnMkModf q (mk s) u)) (hsnBaseUnpack b)
hsnBaseUnpack _ = Nothing
%%]]
%%]
%%[1 export(hsnMbBaseString,hsnBaseString)
-- | If name is a HsName_Base after some unpacking, return the base string, without qualifiers, without uniqifiers
hsnMbBaseString :: HsName -> Maybe String
hsnMbBaseString = fmap fst . hsnBaseUnpack
hsnBaseString :: HsName -> String
hsnBaseString = maybe "??" id . hsnMbBaseString
%%]
%%[7 export(mkHNmPos)
-- | Just lift a int to the int HsName variant
mkHNmPos :: Int -> HsName
%%[[1
mkHNmPos = HsName_Pos
%%][7
mkHNmPos s = hsnMkModf [] (HsName_Pos s) Map.empty
%%]]
%%]
%%[7 export(cmpHsNameOnNm)
-- | Compare, ignoring hash
cmpHsNameOnNm :: HsName -> HsName -> Ordering
%%[[99
cmpHsNameOnNm (HsName_Modf _ q1 b1 u1) (HsName_Modf _ q2 b2 u2) = compare (HsName_Modf 0 q1 b1 u1) (HsName_Modf 0 q2 b2 u2)
%%]]
cmpHsNameOnNm n1 n2 = compare n1 n2
%%]
%%[1 export(mbHNm)
mbHNm :: HsName -> Maybe String
mbHNm = hsnMbBaseString
%%]
%%[1.hsnFromString export(hsnFromString)
hsnFromString :: String -> HsName
hsnFromString = mkHNmBase
%%]
%%[1111.hsnHNmFldToString export(hsnHNmFldToString)
hsnHNmFldToString :: String -> String
hsnHNmFldToString = id
%%]
%%[8
data OrigName
= OrigNone
| OrigLocal HsName
| OrigGlobal HsName
| OrigFunc HsName
deriving (Eq,Ord)
%%]
%%[1
instance PP HsName where
pp h = pp (show h)
%%]
%%[7 export(hsnShow)
hsnShow :: Bool -> String -> String -> HsName -> String
hsnShow _ _ _ (HsName_Base s ) = {- hsnHNmFldToString -} s
hsnShow l qsep usep (HsName_Modf _ qs b us ) = concat $ (intersperse qsep $ qs ++ [hsnShow l qsep usep b]) ++ showHsNameUniqifierMp' l usep us
hsnShow _ _ _ (HsName_Pos p ) = show p
%%[[8
hsnShow _ _ _ (HNmNr n OrigNone ) = "x_" ++ show n
hsnShow l _ usep (HNmNr n (OrigLocal hsn)) = "x_" ++ show n ++ "_" ++ hsnShow l "." usep hsn
hsnShow l _ usep (HNmNr n (OrigGlobal hsn)) = "global_x_" ++ show n ++ "_" ++ hsnShow l "." usep hsn
hsnShow l _ usep (HNmNr n (OrigFunc hsn)) = "fun_x_" ++ show n ++ "_" ++ hsnShow l "." usep hsn
%%]]
%%]
%%[1
instance Show HsName where
%%[[1
show (HsName_Base s) = s
%%][7
show = hsnShow True "." "_@"
%%]]
%%]
%%[1
-- | A HsName is either a complex/aggregrate name or a base case
hsnCanonicSplit :: HsName -> Either ([String],HsName) HsName
%%[[7
-- hsnCanonicSplit (HNmQ ns ) = Left $ maybe ([],mkHNmBase "??") (\(i,l) -> (catMaybes $ map hsnMbBaseString i,l) ) (initlast ns)
hsnCanonicSplit n@(HsName_Modf _ qs _ _) = Left $ (qs, hsnFixateHash (n {hsnQualifiers = []}))
%%]]
hsnCanonicSplit n = Right n
%%]
%%[1
hsnToList :: HsName -> [HsName]
hsnToList n = either (\(qs,b) -> map mkHNmBase qs ++ [b]) (:[]) (hsnCanonicSplit n)
%%]
%%[1 export(hsnInitLast)
hsnInitLast :: HsName -> ([HsName],HsName)
hsnInitLast n = either (\(qs,b) -> (map mkHNmBase qs, b)) (\x -> ([],x)) (hsnCanonicSplit n)
%%]
%%[1 export(hsnPrefix,hsnSuffix,mkHNmPrefix)
hsnPrefix :: String -> HsName -> HsName
hsnPrefix p hsn
= maybe (mkHNmBase $ p ++ show hsn) (\(s,mk) -> mk $ p ++ s) $ hsnBaseUnpack hsn
{-
= case hsnInitLast hsn of
(ns,n) -> mkHNm (ns,hsnFromString (p ++ show n))
-}
hsnSuffix :: HsName -> String -> HsName
hsnSuffix hsn p
= maybe (mkHNmBase $ show hsn ++ p) (\(s,mk) -> mk $ s ++ p) $ hsnBaseUnpack hsn
{-
= case hsnInitLast hsn of
(ns,n) -> mkHNm (ns,hsnFromString (show n ++ p))
-}
mkHNmPrefix :: HSNM x => String -> x -> HsName
mkHNmPrefix p = hsnPrefix p . mkHNm
%%]
%%[8
stringAlphanumeric :: String -> String
stringAlphanumeric s
= concat (map (charAlphanumeric) s)
%%]
stringAlphanumeric :: String -> String
stringAlphanumeric s
| isAlphaNum c || c=='_' = s
| otherwise = concat (map (('_':).charAlphanumeric) s)
where c = head s -- we assume that the whole string is alphanumeric if the first character is.
-- this is more efficient than testing each character of the string separately,
-- and can safely be assumed in Haskell
%%[8
charAlphanumeric :: Char -> String
charAlphanumeric '\'' = "prime"
charAlphanumeric ':' = "colon"
charAlphanumeric '!' = "exclam"
charAlphanumeric '@' = "at"
charAlphanumeric '#' = "number"
charAlphanumeric '$' = "dollar"
charAlphanumeric '%' = "percent"
charAlphanumeric '^' = "circon"
charAlphanumeric '&' = "amp"
charAlphanumeric '*' = "star"
charAlphanumeric '+' = "plus"
charAlphanumeric '-' = "minus"
charAlphanumeric '.' = "dot"
charAlphanumeric '/' = "slash"
charAlphanumeric '\\' = "backsl"
charAlphanumeric '|' = "bar"
charAlphanumeric '<' = "lt"
charAlphanumeric '=' = "eq"
charAlphanumeric '>' = "gt"
charAlphanumeric '?' = "quest"
charAlphanumeric '~' = "tilde"
charAlphanumeric '[' = "sub" -- although this is not a legal Haskell operator symbol, it can be part of the Nil constructor
charAlphanumeric ']' = "bus"
charAlphanumeric '(' = "open" -- although this is not a legal Haskell operator symbol, it can be part of the tuple constructor
charAlphanumeric ',' = "comma"
charAlphanumeric ')' = "close"
charAlphanumeric c = [c]
%%]
charAlphanumeric c | isDigit c = [c]
| otherwise = error ("no alphanumeric representation for " ++ show c)
%%[8 export(hsnShowAlphanumeric, hsnShowAlphanumericShort)
dontStartWithDigit :: String -> String
dontStartWithDigit xs@(a:_) | isDigit a || a=='_' = "y"++xs
| otherwise = xs
hsnShowAlphanumericShort :: HsName -> String
hsnShowAlphanumericShort (HNmNr n (OrigFunc orig)) = hsnShowAlphanumeric orig
hsnShowAlphanumericShort x = hsnShowAlphanumeric x
hsnShowAlphanumeric :: HsName -> String
hsnShowAlphanumeric (HsName_Base s ) = dontStartWithDigit(stringAlphanumeric s)
hsnShowAlphanumeric (HsName_Pos p) = "y" ++ show p
hsnShowAlphanumeric (HNmNr n OrigNone) = "x" ++ show n
hsnShowAlphanumeric (HNmNr n (OrigLocal orig)) = "x" ++ show n -- hsnShowAlphanumeric orig
hsnShowAlphanumeric (HNmNr n (OrigGlobal orig)) = "global_" ++ hsnShowAlphanumeric orig
hsnShowAlphanumeric (HNmNr n (OrigFunc orig)) = "fun_" ++ hsnShowAlphanumeric orig
hsnShowAlphanumeric (HsName_Modf _ q b u) = concat $ intersperse "_" $ q ++ [hsnShowAlphanumeric b] ++ map stringAlphanumeric (showHsNameUniqifierMp "_" u)
-- hsnShowAlphanumeric n = concat $ intersperse "_" $ map hsnShowAlphanumeric $ hsnToList n
%%]
%%[8
hsnToFPath :: HsName -> FPath
hsnToFPath n
= mkFPathFromDirsFile qs b
where (qs,b) = hsnInitLast n
instance FPATH HsName where
mkFPath = hsnToFPath
%%]
-- replace this by something better, taking into account qualifiers
%%[10
hsnConcat :: HsName -> HsName -> HsName
hsnConcat h1 h2 = hsnFromString (show h1 ++ show h2)
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Row specific
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[7 hs export(rowLabCmp)
-- compare for row labels, lexicographic ordering (currently)
rowLabCmp :: HsName -> HsName -> Ordering
rowLabCmp = cmpHsNameOnNm
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% HsName & module related
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[8 export(hsnSplitQualify,hsnQualified,hsnPrefixQual,hsnMapQualified)
-- qualifier (i.e. module name) and qualified part of name
hsnSplitQualify :: HsName -> (Maybe HsName,HsName)
hsnSplitQualify n
= case hsnInitLast n of
([],n') -> (Nothing,n')
(ns,n') -> (Just (mkHNm ns),n')
-- qualified part of a name
hsnQualified :: HsName -> HsName
hsnQualified = snd . hsnSplitQualify
-- prefix/qualify with module name, on top of possible previous qualifier
hsnPrefixQual :: HsName -> HsName -> HsName
hsnPrefixQual m n = mkHNm (hsnToList m ++ hsnToList n)
-- map qualified part
hsnMapQualified :: (String -> String) -> HsName -> HsName
hsnMapQualified f qn
= maybe qn (\(s,mk) -> mk $ f s) $ hsnBaseUnpack qn
{-
= case hsnSplitQualify qn of
(Nothing,n) -> f n
(Just q ,n) -> hsnPrefixQual q (f n)
-}
%%]
%%[50 export(hsnQualifier,hsnSetQual,hsnIsQual,hsnMapQual,hsnSetLevQual)
-- qualifier (i.e. module name) of name
hsnQualifier :: HsName -> Maybe HsName
hsnQualifier = fst . hsnSplitQualify
-- replace/set qualifier
hsnSetQual :: HsName -> HsName -> HsName
hsnSetQual m = hsnPrefixQual m . hsnQualified
hsnMapQual :: (HsName -> HsName) -> HsName -> HsName
hsnMapQual f qn
= case hsnSplitQualify qn of
(Nothing,n) -> qn
(Just q ,n) -> hsnSetQual (f q) n
-- is qualified?
hsnIsQual :: HsName -> Bool
hsnIsQual = isJust . hsnQualifier
hsnSetLevQual :: Int -> HsName -> HsName -> HsName
hsnSetLevQual 0 m n = hsnSetQual m n
hsnSetLevQual _ _ n = n
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Fix the uniqifier part by making a string of it, suffixing it to the base part
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[8 export(hsnFixUniqifiers)
hsnFixUniqifiers' :: Bool -> String -> HsName -> HsName
hsnFixUniqifiers' showlen sep (HsName_Modf _ qs n us) = hsnMkModf qs (hsnSuffix n (concat $ showHsNameUniqifierMp' showlen sep us)) Map.empty
hsnFixUniqifiers' _ _ n = n
hsnFixUniqifiers :: HsName -> HsName
hsnFixUniqifiers = hsnFixUniqifiers' True "_@"
hsnJavalikeFixUniqifiers :: HsName -> HsName
hsnJavalikeFixUniqifiers = hsnFixUniqifiers' False ""
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Strip the uniqifier part
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[8 export(hsnStripUniqifiers)
hsnStripUniqifiers :: HsName -> HsName
hsnStripUniqifiers (HsName_Modf _ qs n us) = hsnMkModf qs n emptyHsNameUniqifierMp
hsnStripUniqifiers n = n
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Make globally unique by prefixing with module name (if not already done so)
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[50 export(hsnQualUniqify)
hsnQualUniqify :: HsName -> HsName -> HsName
hsnQualUniqify modNm n
= if hsnIsQual n
then n
else hsnSetQual modNm n
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Make HsName of something
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[1
class HSNM a where
mkHNm :: a -> HsName
instance HSNM HsName where
mkHNm = id
instance HSNM Int where
mkHNm = mkHNm . show
%%]
%%[1.HSNM.String
instance HSNM String where
mkHNm s = hsnFromString s
%%]
%%[8.HSNM.String -1.HSNM.String
instance HSNM String where
mkHNm s
= mkHNm $ map hsnFromString $ splitForQualified s
%%]
%%[1
instance HSNM ([HsName],HsName) where
mkHNm (l,n) = mkHNm (l ++ [n])
instance HSNM [HsName] where
mkHNm [n] = n
mkHNm [] = hsnFromString "" -- ????, or empty alternative of HsName
%%[[7777
mkHNm ns = HNmQ ns
%%]]
%%[[7
mkHNm ns = case initlast ns of
Just (i,l) -> case l of
n@(HsName_Modf _ _ _ _) -> hsnFixateHash (n {hsnQualifiers = qs})
n -> hsnMkModf qs n Map.empty
where qs = catMaybes $ map hsnMbBaseString i
%%]]
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% HsName class instances
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[1 hs
instance Position HsName where
line _ = (-1)
column _ = (-1)
file _ = ""
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Instances: Typeable, Data
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[50
deriving instance Typeable HsNameUniqifier
deriving instance Data HsNameUniqifier
deriving instance Typeable HsNameUnique
deriving instance Data HsNameUnique
deriving instance Typeable HsName
deriving instance Data HsName
deriving instance Typeable OrigName
deriving instance Data OrigName
deriving instance Typeable IdOccKind
deriving instance Data IdOccKind
deriving instance Typeable IdOcc
deriving instance Data IdOcc
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Instances: Binary, Serialize
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[50
instance Binary HsNameUniqifier where
put = putEnum8
get = getEnum8
instance Binary HsNameUnique where
put (HsNameUnique_String a ) = putWord8 0 >> put a
put (HsNameUnique_Int a ) = putWord8 1 >> put a
put (HsNameUnique_UID a ) = putWord8 2 >> put a
put (HsNameUnique_None ) = putWord8 3
get = do t <- getWord8
case t of
0 -> liftM HsNameUnique_String get
1 -> liftM HsNameUnique_Int get
2 -> liftM HsNameUnique_UID get
3 -> return HsNameUnique_None
instance Binary HsName where
put (HsName_Base a ) = putWord8 0 >> put a
-- put (HNmQ a ) = putWord8 1 >> put a
put (HsName_Pos a ) = putWord8 2 >> put a
put (HNmNr a b ) = putWord8 3 >> put a >> put b
put (HsName_Modf a b c d) = putWord8 4 >> put a >> put b >> put c >> put d
get = do t <- getWord8
case t of
0 -> liftM HsName_Base get
-- 1 -> liftM HNmQ get
2 -> liftM HsName_Pos get
3 -> liftM2 HNmNr get get
4 -> liftM4 HsName_Modf get get get get
instance Serialize HsName where
sput = sputShared
sget = sgetShared
sputNested = sputPlain
sgetNested = sgetPlain
instance Binary OrigName where
put (OrigNone ) = putWord8 0
put (OrigLocal a) = putWord8 1 >> put a
put (OrigGlobal a) = putWord8 2 >> put a
put (OrigFunc a) = putWord8 3 >> put a
get = do t <- getWord8
case t of
0 -> return OrigNone
1 -> liftM OrigLocal get
2 -> liftM OrigGlobal get
3 -> liftM OrigFunc get
instance Binary IdOccKind where
put = putEnum8
get = getEnum8
instance Serialize IdOccKind where
sput = sputPlain
sget = sgetPlain
instance Binary IdOcc where
put (IdOcc a b) = put a >> put b
get = liftM2 IdOcc get get
instance Serialize IdOcc where
sput = sputShared
sget = sgetShared
sputNested = sputPlain
sgetNested = sgetPlain
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Identifier occurrences
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[1 export(IdOccKind(..))
data IdOccKind
= IdOcc_Val
| IdOcc_Pat
| IdOcc_Type
%%[[6
| IdOcc_Kind
%%]]
%%[[7
| IdOcc_Fld
%%]]
%%[[9
| IdOcc_Class
| IdOcc_Inst
| IdOcc_Dflt
%%]]
| IdOcc_Any
%%[[50
| IdOcc_Data
%%]]
%%[[93
| IdOcc_Fusion
%%]]
deriving (Eq,Ord,Enum)
%%]
%%[1
-- intended for parsing
instance Show IdOccKind where
show IdOcc_Val = "Value"
show IdOcc_Pat = "Pat"
show IdOcc_Type = "Type"
%%[[6
show IdOcc_Kind = "Kind"
%%]]
%%[[7
show IdOcc_Fld = "Field"
%%]]
%%[[9
show IdOcc_Class = "Class"
show IdOcc_Inst = "Instance"
show IdOcc_Dflt = "Default"
%%]]
show IdOcc_Any = "Any"
%%[[50
show IdOcc_Data = "Data"
%%]]
%%[[93
show IdOcc_Fusion = "Fusion"
%%]]
%%]
%%[1
-- intended for parsing
instance PP IdOccKind where
pp = text . show
%%]
%%[1 export(IdOcc(..))
data IdOcc
= IdOcc { ioccNm :: !HsName, ioccKind :: !IdOccKind }
deriving (Show,Eq,Ord)
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Set of names
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[3 export(HsNameS)
type HsNameS = Set.Set HsName
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Safe names for Java like backends
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[(8 jazy || javascript) hs export(hsnSafeJavaLike)
-- ensure a name valid for JVM like backends
hsnSafeJavaLike :: HsName -> HsName
hsnSafeJavaLike
= hsnMapQualified (concatMap safe) . hsnJavalikeFixUniqifiers
where safe '_' = "__"
safe c | isDigit c || isLetter c || c == '_' = [c]
| otherwise = "_" ++ showHex (ord c) ""
%%]
safe '.' = "_dot"
safe ':' = "_colon"
safe '/' = "_fslash"
-- safe '<' = "_lt"
-- safe '>' = "_gt"
safe '\\' = "_bslash"
safe '[' = "_lbrack"
safe ']' = "_rbrack"
safe '@' = "_at"
safe c = [c]
%%[(8 jazy || javascript) hs export(hsnJavaLikeVar)
-- safe name of a variable
hsnJavaLikeVar
:: ( HsName -> HsName -- adapt for particular platform, before mangling here
, HsName -> HsName -- post prefix
, String -> String -- adapt module qualifiers
)
-> HsName -> HsName -> HsName -> HsName
hsnJavaLikeVar (preadapt, postprefix, updqual) pkg mod v
%%[[8
= hsnSafeJavaLike v
%%][50
= postprefix $ hsnSafeJavaLike $ handleUpper $ qual $ preadapt v
where handleUpper v
= case hsnBaseUnpack v of
Just (s@(c:vs), mk) | isUpper c -> mk (s ++ "_")
_ -> v
qual v
= case hsnBaseUnpack' v of
Just (q, s, mk) -> mk (map updqual q) s
_ -> v
%%]]
%%]
%%[(8 jazy || javascript) hs export(hsnJavaLikeVarCls)
-- name of the class of a variable
hsnJavaLikeVarCls :: HsName -> HsName -> HsName -> HsName
hsnJavaLikeVarCls pkg mod v
%%[[8
= hsnSuffix mod ("-" ++ show v)
%%][50
= hsnSetQual pkg v
%%]]
%%]
%%[(8 jazy || javascript) hs export(hsnJavaLikeVarToFld)
-- field name of var name
hsnJavaLikeVarToFld :: HsName -> HsName
hsnJavaLikeVarToFld v
%%[[8
= v
%%][50
= hsnQualified v
%%]]
%%]
%%[(8 jazy || javascript) hs export(hsnJavaLikeDataTy, hsnJavaLikeDataCon, hsnJavaLikeDataFldAt, hsnJavaLikeDataFlds)
-- name of class of data type
hsnJavaLikeDataTy :: HsName -> HsName -> HsName -> HsName
hsnJavaLikeDataTy pkg mod d = hsnSafeJavaLike d `hsnSuffix` "_Ty"
-- name of class of data constructor
hsnJavaLikeDataCon :: HsName -> HsName -> HsName -> HsName
hsnJavaLikeDataCon pkg mod d = hsnSafeJavaLike d `hsnSuffix` "_Con"
-- name of field of data
hsnJavaLikeDataFldAt :: Int -> String
hsnJavaLikeDataFldAt i = show i
-- all names of fields of data
hsnJavaLikeDataFlds :: Int -> [String]
hsnJavaLikeDataFlds arity = map hsnJavaLikeDataFldAt [0..arity-1]
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Support for transformations
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[(8 codegen) hs export(FvS,FvSMp)
type FvS = HsNameS
type FvSMp = Map.Map HsName FvS
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Map of names
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[8 export(HsNameMp,hsnRepl)
type HsNameMp = Map.Map HsName HsName
hsnRepl :: HsNameMp -> HsName -> HsName
hsnRepl m n = Map.findWithDefault n n m
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Name of a pattern var/con
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%[(8 codegen) hs export(RPatNm(..))
data RPatNm
= RPatNmOrig {rpatNmNm :: !HsName}
| RPatNmUniq {rpatNmNm :: !HsName}
deriving Eq
instance Ord RPatNm where
x `compare` y = rpatNmNm x `cmpHsNameOnNm` rpatNmNm y
instance Show RPatNm where
show pnm = show (rpatNmNm pnm)
instance PP RPatNm where
pp (RPatNmOrig n) = n >|< "(O)"
pp (RPatNmUniq n) = n >|< "(U)"
%%]
%%[(8 codegen) hs export(rpatNmIsOrig)
rpatNmIsOrig :: RPatNm -> Bool
rpatNmIsOrig (RPatNmOrig _) = True
rpatNmIsOrig _ = False
%%]
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%% Track dictionary intentions
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%