-
Notifications
You must be signed in to change notification settings - Fork 859
Expand file tree
/
Copy pathServiceInterfaceStubGenerator.fs
More file actions
979 lines (804 loc) · 42.1 KB
/
ServiceInterfaceStubGenerator.fs
File metadata and controls
979 lines (804 loc) · 42.1 KB
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
// Copyright (c) Microsoft Corporation. All Rights Reserved. See License.txt in the project root for license information.
namespace FSharp.Compiler.EditorServices
open System
open System.Diagnostics
open Internal.Utilities.Library
open FSharp.Compiler.CodeAnalysis
open FSharp.Compiler.EditorServices.ParsedInput
open FSharp.Compiler.Symbols
open FSharp.Compiler.Syntax
open FSharp.Compiler.SyntaxTreeOps
open FSharp.Compiler.Text
open FSharp.Compiler.Text.Range
open FSharp.Compiler.Tokenization
[<AutoOpen>]
module internal CodeGenerationUtils =
open System.IO
open System.CodeDom.Compiler
type ColumnIndentedTextWriter() =
let stringWriter = new StringWriter()
let indentWriter = new IndentedTextWriter(stringWriter, " ")
member _.Write(s: string) = indentWriter.Write("{0}", s)
member _.Write(s: string, [<ParamArray>] objs: obj[]) = indentWriter.Write(s, objs)
member _.WriteLine(s: string) = indentWriter.WriteLine("{0}", s)
member _.WriteLine(s: string, [<ParamArray>] objs: obj[]) = indentWriter.WriteLine(s, objs)
member x.WriteBlankLines count =
for _ in 0 .. count - 1 do
x.WriteLine ""
member _.Indent i =
indentWriter.Indent <- indentWriter.Indent + i
member _.Unindent i =
indentWriter.Indent <- max 0 (indentWriter.Indent - i)
member _.Dump() = !!indentWriter.InnerWriter.ToString()
interface IDisposable with
member _.Dispose() =
stringWriter.Dispose()
indentWriter.Dispose()
/// Represent environment where a captured identifier should be renamed
type NamesWithIndices = Map<string, Set<int>>
let keywordSet = set FSharpKeywords.KeywordNames
/// Rename a given argument if the identifier has been used
let normalizeArgName (namesWithIndices: NamesWithIndices) nm =
match nm with
| "()" -> nm, namesWithIndices
| _ ->
let nm = String.lowerCaseFirstChar nm
let nm, index = String.extractTrailingIndex nm
let index, namesWithIndices =
match namesWithIndices |> Map.tryFind nm, index with
| Some indexes, index ->
let rec getAvailableIndex idx =
if indexes |> Set.contains idx then
getAvailableIndex (idx + 1)
else
idx
let index = index |> Option.defaultValue 1 |> getAvailableIndex
Some index, namesWithIndices |> Map.add nm (indexes |> Set.add index)
| None, Some index -> Some index, namesWithIndices |> Map.add nm (Set.ofList [ index ])
| None, None -> None, namesWithIndices |> Map.add nm Set.empty
let nm =
match index with
| Some index -> sprintf "%s%d" nm index
| None -> nm
let nm =
if Set.contains nm keywordSet then
sprintf "``%s``" nm
else
nm
nm, namesWithIndices
/// Capture information about an interface in ASTs
[<RequireQualifiedAccess; NoEquality; NoComparison>]
type InterfaceData =
| Interface of interfaceType: SynType * memberDefns: SynMemberDefns option
| ObjExpr of objType: SynType * bindings: SynBinding list
member x.Range =
match x with
| InterfaceData.Interface(ty, _) -> ty.Range
| InterfaceData.ObjExpr(ty, _) -> ty.Range
member x.TypeParameters =
match x with
| InterfaceData.Interface(StripParenTypes ty, _)
| InterfaceData.ObjExpr(StripParenTypes ty, _) ->
let rec (|RationalConst|) =
function
| SynRationalConst.Integer(value = i) -> string i
| SynRationalConst.Rational(numerator = numerator; denominator = denominator) -> sprintf "%i/%i" numerator denominator
| SynRationalConst.Negate(rationalConst = (RationalConst s)) -> sprintf "- %s" s
| SynRationalConst.Paren(rationalConst = (RationalConst s)) -> sprintf "(%s)" s
let rec (|TypeIdent|_|) =
function
| SynType.Var(SynTypar(s, req, _), _) ->
match req with
| TyparStaticReq.None -> Some("'" + s.idText)
| TyparStaticReq.HeadType -> Some("^" + s.idText)
| SynType.LongIdent(SynLongIdent(xs, _, _)) -> xs |> Seq.map (fun x -> x.idText) |> String.concat "." |> Some
| SynType.App(t, _, ts, _, _, isPostfix, _) ->
match t, ts with
| TypeIdent typeName, [] -> Some typeName
| TypeIdent typeName, [ TypeIdent typeArg ] ->
if isPostfix then
Some(sprintf "%s %s" typeArg typeName)
else
Some(sprintf "%s<%s>" typeName typeArg)
| TypeIdent typeName, _ ->
let typeArgs = ts |> Seq.choose (|TypeIdent|_|) |> String.concat ", "
if isPostfix then
Some(sprintf "(%s) %s" typeArgs typeName)
else
Some(sprintf "%s<%s>" typeName typeArgs)
| _ ->
//debug "Unsupported case with %A and %A" t ts
None
| SynType.Anon _ -> Some "_"
| SynType.AnonRecd(_, ts, _) -> Some(ts |> Seq.choose (snd >> (|TypeIdent|_|)) |> String.concat "; ")
| SynType.Array(dimension, TypeIdent typeName, _) -> Some(sprintf "%s [%s]" typeName (String(',', dimension - 1)))
| SynType.MeasurePower(TypeIdent typeName, RationalConst power, _) -> Some(sprintf "%s^%s" typeName power)
| SynType.Paren(TypeIdent typeName, _) -> Some typeName
| _ -> None
match ty with
| SynType.App(_, _, ts, _, _, _, _)
| SynType.LongIdentApp(_, _, _, ts, _, _, _) -> ts |> Seq.choose (|TypeIdent|_|) |> Seq.toArray
| _ -> [||]
module InterfaceStubGenerator =
[<NoComparison>]
type internal Context =
{
Writer: ColumnIndentedTextWriter
/// Map generic types to specific instances for specialized interface implementation
TypeInstantiations: Map<string, string>
/// Data for interface instantiation
ArgInstantiations: (FSharpGenericParameter * FSharpType) seq
/// Indentation inside method bodies
Indentation: int
/// Object identifier of the interface e.g. 'x', 'this', '__', etc.
ObjectIdent: string
/// A list of lines represents skeleton of each member
MethodBody: string[]
/// Context in order to display types in the short form
DisplayContext: FSharpDisplayContext
}
// Adapt from MetadataFormat module in FSharp.Formatting
let internal (|AllAndLast|_|) (xs: 'T list) =
match xs with
| [] -> None
| _ ->
let revd = List.rev xs
Some(List.rev revd.Tail, revd.Head)
let internal getTypeParameterName (typar: FSharpGenericParameter) =
(if typar.IsSolveAtCompileTime then "^" else "'") + typar.Name
let internal bracket (str: string) =
if str.Contains(" ") then "(" + str + ")" else str
let internal formatType ctx (ty: FSharpType) =
let genericDefinition =
ty.Instantiate(Seq.toList ctx.ArgInstantiations).Format(ctx.DisplayContext)
(genericDefinition, ctx.TypeInstantiations)
||> Map.fold (fun s k v -> s.Replace(k, v))
// Format each argument, including its name and type
let internal formatArgUsage ctx hasTypeAnnotation (namesWithIndices: Map<string, Set<int>>) (arg: FSharpParameter) =
let nm =
match arg.Name with
| None ->
if
arg.Type.HasTypeDefinition
&& arg.Type.TypeDefinition.CompiledName = "unit"
&& arg.Type.TypeDefinition.Namespace = Some "Microsoft.FSharp.Core"
then
"()"
else
sprintf "arg%d" (namesWithIndices |> Map.toSeq |> Seq.map snd |> Seq.sumBy Set.count |> max 1)
| Some x -> x
let nm, namesWithIndices = normalizeArgName namesWithIndices nm
// Detect an optional argument
let isOptionalArg = arg.HasAttribute<OptionalArgumentAttribute>()
let argName = if isOptionalArg then "?" + nm else nm
(if hasTypeAnnotation && argName <> "()" then
argName + ": " + formatType ctx arg.Type
else
argName),
namesWithIndices
let internal formatArgsUsage ctx hasTypeAnnotation (v: FSharpMemberOrFunctionOrValue) args =
let isItemIndexer = (v.IsInstanceMember && v.DisplayName = "Item")
let unit, argSep, tupSep = "()", " ", ", "
let args, namesWithIndices =
args
|> List.fold
(fun (argsSoFar: string list list, namesWithIndices) args ->
let argsSoFar', namesWithIndices =
args
|> List.fold
(fun (acc: string list, allNames) arg ->
let name, allNames = formatArgUsage ctx hasTypeAnnotation allNames arg
name :: acc, allNames)
([], namesWithIndices)
List.rev argsSoFar' :: argsSoFar, namesWithIndices)
([], Map.ofList [ ctx.ObjectIdent, Set.empty ])
let argText =
args
|> List.rev
|> List.map (function
| [] -> unit
| [ arg ] when arg = unit -> unit
| [ arg ] when not v.IsMember || isItemIndexer -> arg
| args when isItemIndexer -> String.concat tupSep args
| args -> bracket (String.concat tupSep args))
|> String.concat argSep
argText, namesWithIndices
[<RequireQualifiedAccess; NoComparison>]
type internal MemberInfo =
| PropertyGetSet of FSharpMemberOrFunctionOrValue * FSharpMemberOrFunctionOrValue
| Member of FSharpMemberOrFunctionOrValue
let internal getArgTypes (ctx: Context) (v: FSharpMemberOrFunctionOrValue) =
let argInfos = v.CurriedParameterGroups |> Seq.map Seq.toList |> Seq.toList
let retType = v.ReturnParameter.Type
let argInfos, retType =
match argInfos, v.IsPropertyGetterMethod, v.IsPropertySetterMethod with
| [ AllAndLast(args, last) ], _, true -> [ args ], Some last.Type
| [ [] ], true, _ -> [], Some retType
| _, _, _ -> argInfos, Some retType
let retType =
match retType with
| Some ty ->
let coreType = formatType ctx ty
if v.IsEvent then
let isEventHandler =
ty.BaseType
|> Option.bind (fun t ->
if t.HasTypeDefinition then
t.TypeDefinition.TryGetFullName()
else
None)
|> Option.exists ((=) "System.MulticastDelegate")
if isEventHandler then
sprintf "IEvent<%s, _>" coreType
else
coreType
else
coreType
| None -> "unit"
argInfos, retType
/// Convert a getter/setter to its canonical form
let internal normalizePropertyName (v: FSharpMemberOrFunctionOrValue) =
let displayName = v.DisplayName
if
(v.IsPropertyGetterMethod && displayName.StartsWithOrdinal("get_"))
|| (v.IsPropertySetterMethod && displayName.StartsWithOrdinal("set_"))
then
displayName[4..]
else
displayName
let internal isEventMember (m: FSharpMemberOrFunctionOrValue) =
m.IsEvent || m.HasAttribute<CLIEventAttribute>()
let internal formatMember (ctx: Context) m verboseMode =
let getParamArgs (argInfos: FSharpParameter list list) (ctx: Context) (v: FSharpMemberOrFunctionOrValue) =
let args, namesWithIndices =
match argInfos with
| [ [ x ] ] when
v.IsPropertyGetterMethod
&& x.Name.IsNone
&& x.Type.TypeDefinition.CompiledName = "unit"
&& x.Type.TypeDefinition.Namespace = Some "Microsoft.FSharp.Core"
->
"", Map.ofList [ ctx.ObjectIdent, Set.empty ]
| _ -> formatArgsUsage ctx verboseMode v argInfos
let argText =
if String.IsNullOrWhiteSpace(args) then
""
elif args.StartsWithOrdinal("(") then
args
elif v.CurriedParameterGroups.Count > 1 && (not verboseMode) then
" " + args
else
sprintf "(%s)" args
argText, namesWithIndices
let preprocess (ctx: Context) (v: FSharpMemberOrFunctionOrValue) =
let buildUsage argInfos =
let parArgs, _ = getParamArgs argInfos ctx v
match v.IsMember, v.IsInstanceMember, v.LogicalName, v.DisplayName with
// Constructors
| _, _, ".ctor", _ -> "new" + parArgs
// Properties (skipping arguments)
| _, true, _, name when v.IsPropertyGetterMethod || v.IsPropertySetterMethod ->
if name.StartsWithOrdinal("get_") || name.StartsWithOrdinal("set_") then
name[4..]
else
name
// Ordinary instance members
| _, true, _, name -> name + parArgs
// Ordinary functions or values
| false, _, _, name when
v.ApparentEnclosingEntity
|> Option.map _.HasAttribute<RequireQualifiedAccessAttribute>()
|> Option.defaultValue false
|> not
->
name + " " + parArgs
// Ordinary static members or things (?) that require fully qualified access
| _, _, _, name -> name + parArgs
let modifiers =
[
if v.InlineAnnotation = FSharpInlineAnnotation.AlwaysInline then
yield "inline"
if v.Accessibility.IsInternal then
yield "internal"
]
let argInfos, retType = getArgTypes ctx v
let usage = buildUsage argInfos
usage, modifiers, argInfos, retType
// A couple of helper methods for emitting close declarations of members and stub method bodies.
let closeDeclaration (returnType: string) (writer: ColumnIndentedTextWriter) =
if verboseMode then
writer.Write(": {0}", returnType)
writer.Write(" = ", returnType)
if verboseMode then
writer.WriteLine("")
let writeImplementation (ctx: Context) (writer: ColumnIndentedTextWriter) =
match verboseMode, ctx.MethodBody with
| false, [| singleLine |] -> writer.WriteLine(singleLine)
| _, lines ->
writer.Indent ctx.Indentation
for line in lines do
writer.WriteLine(line)
writer.Unindent ctx.Indentation
match m with
| MemberInfo.PropertyGetSet(getter, setter) ->
let usage, modifiers, getterArgInfos, retType = preprocess ctx getter
let closeDeclaration = closeDeclaration retType
let writeImplementation = writeImplementation ctx
let _, _, setterArgInfos, _ = preprocess ctx setter
let writer = ctx.Writer
writer.Write("member ")
for modifier in modifiers do
writer.Write("{0} ", modifier)
writer.Write("{0}.", ctx.ObjectIdent)
// Try to print getters and setters on the same identifier
writer.WriteLine(usage)
writer.Indent ctx.Indentation
match getParamArgs getterArgInfos ctx getter with
| "", _
| "()", _ -> writer.Write("with get ()")
| args, _ -> writer.Write("with get {0}", args)
writer |> closeDeclaration
writer |> writeImplementation
match getParamArgs setterArgInfos ctx setter with
| "", _
| "()", _ ->
if verboseMode then
writer.WriteLine("and set (v: {0}): unit = ", retType)
else
writer.Write("and set v = ")
| args, namesWithIndices ->
let valueArgName, _ = normalizeArgName namesWithIndices "v"
if verboseMode then
writer.WriteLine("and set {0} ({1}: {2}): unit = ", args, valueArgName, retType)
else
writer.Write("and set {0} {1} = ", args, valueArgName)
writer |> writeImplementation
writer.Unindent ctx.Indentation
| MemberInfo.Member v ->
let usage, modifiers, argInfos, retType = preprocess ctx v
let closeDeclaration = closeDeclaration retType
let writeImplementation = writeImplementation ctx
let writer = ctx.Writer
if isEventMember v then
writer.WriteLine("[<CLIEvent>]")
writer.Write("member ")
for modifier in modifiers do
writer.Write("{0} ", modifier)
writer.Write("{0}.", ctx.ObjectIdent)
if v.IsEvent then
writer.Write(usage)
writer |> closeDeclaration
writer |> writeImplementation
elif v.IsPropertySetterMethod then
writer.WriteLine(usage)
writer.Indent ctx.Indentation
match getParamArgs argInfos ctx v with
| "", _
| "()", _ -> writer.WriteLine("with set (v: {0}): unit = ", retType)
| args, namesWithIndices ->
let valueArgName, _ = normalizeArgName namesWithIndices "v"
writer.Write("with set {0} ({1}", args, valueArgName)
if verboseMode then
writer.Write(": {0}): unit", retType)
else
writer.Write(")")
writer.Write(" = ")
if verboseMode then
writer.WriteLine("")
writer |> writeImplementation
writer.Unindent ctx.Indentation
elif v.IsPropertyGetterMethod then
writer.Write(usage)
match getParamArgs argInfos ctx v with
| "", _
| "()", _ ->
// Use the short-hand notation for getters without arguments
writer |> closeDeclaration
writer |> writeImplementation
| args, _ ->
writer.WriteLine("")
writer.Indent ctx.Indentation
writer.Write("with get {0}", args)
writer |> closeDeclaration
writer |> writeImplementation
writer.Unindent ctx.Indentation
else
writer.Write(usage)
writer |> closeDeclaration
writer |> writeImplementation
let rec internal getNonAbbreviatedType (ty: FSharpType) =
if ty.HasTypeDefinition && ty.TypeDefinition.IsFSharpAbbreviation then
getNonAbbreviatedType ty.AbbreviatedType
else
ty
// Sometimes interface members are stored in the form of `IInterface<'T> -> ...`,
// so we need to get the 2nd generic argument
let internal (|MemberFunctionType|_|) (ty: FSharpType) =
if ty.IsFunctionType && ty.GenericArguments.Count = 2 then
Some ty.GenericArguments[1]
else
None
let internal (|TypeOfMember|_|) (m: FSharpMemberOrFunctionOrValue) =
match m.FullTypeSafe with
| Some(MemberFunctionType ty) when m.IsProperty && m.DeclaringEntity.IsSome && m.DeclaringEntity.Value.IsFSharp -> Some ty
| Some ty -> Some ty
| None -> None
let internal removeWhitespace (str: string) = str.Replace(" ", "")
/// Filter out duplicated interfaces in inheritance chain
let rec internal getInterfaces (e: FSharpEntity) =
seq {
for iface in e.AllInterfaces ->
let ty = getNonAbbreviatedType iface
// Argument should be kept lazy so that it is only evaluated when instantiating a new type
ty.TypeDefinition, Seq.zip ty.TypeDefinition.GenericParameters ty.GenericArguments
}
|> Seq.distinct
/// Get members in the decreasing order of inheritance chain
let GetInterfaceMembers (entity: FSharpEntity) =
seq {
for iface, instantiations in getInterfaces entity do
yield!
iface.TryGetMembersFunctionsAndValues()
|> Seq.choose (fun m ->
// Use this hack when FCS doesn't return enough information on .NET properties and events
if m.IsProperty || m.IsEventAddMethod || m.IsEventRemoveMethod then
None
else
Some(m, instantiations))
}
/// Check whether an interface is empty
let HasNoInterfaceMember entity =
GetInterfaceMembers entity |> Seq.isEmpty
let internal (|LongIdentPattern|_|) =
function
| SynPat.LongIdent(longDotId = SynLongIdent(xs, _, _)) ->
// let (name, range) = xs |> List.map (fun x -> x.idText, x.idRange) |> List.last
let last = List.last xs
Some(last.idText, last.idRange)
| _ -> None
// Get name and associated range of a member
// On merged properties (consisting both getters and setters), they have the same range values,
// so we use 'get_' and 'set_' prefix to ensure corresponding symbols are retrieved correctly.
let internal (|MemberNameAndRange|_|) =
function
| SynBinding(valData = SynValData(memberFlags = Some mf); headPat = LongIdentPattern(name, range)) when
mf.MemberKind = SynMemberKind.PropertyGet
->
if name.StartsWithOrdinal("get_") then
Some(name, range)
else
Some("get_" + name, range)
| SynBinding(valData = SynValData(memberFlags = Some mf); headPat = LongIdentPattern(name, range)) when
mf.MemberKind = SynMemberKind.PropertySet
->
if name.StartsWithOrdinal("set_") then
Some(name, range)
else
Some("set_" + name, range)
| SynBinding(headPat = LongIdentPattern(name, range)) -> Some(name, range)
| _ -> None
/// Get associated member names and ranges
/// In case of properties, intrinsic ranges might not be correct for the purpose of getting
/// positions of 'member', which indicate the indentation for generating new members
let GetMemberNameAndRanges interfaceData =
match interfaceData with
| InterfaceData.Interface(_, None) -> []
| InterfaceData.Interface(_, Some memberDefns) ->
memberDefns
|> Seq.collect (function
| SynMemberDefn.Member(binding, _) -> [ binding ]
| SynMemberDefn.GetSetMember(Some getBinding, Some setBinding, _, _) -> [ getBinding; setBinding ]
| SynMemberDefn.GetSetMember(Some binding, None, _, _)
| SynMemberDefn.GetSetMember(None, Some binding, _, _) -> [ binding ]
| _ -> [])
|> Seq.choose (|MemberNameAndRange|_|)
|> Seq.toList
| InterfaceData.ObjExpr(_, bindings) -> List.choose (|MemberNameAndRange|_|) bindings
let internal normalizeEventName (m: FSharpMemberOrFunctionOrValue) =
let name = m.DisplayName
if name.StartsWithOrdinal("add_") then name[4..]
elif name.StartsWithOrdinal("remove_") then name[7..]
else name
/// Ideally this info should be returned in error symbols from FCS.
/// Because it isn't, we implement a crude way of getting member signatures:
/// (1) Crack ASTs to get member names and their associated ranges
/// (2) Check symbols of those members based on ranges
/// (3) If any symbol found, capture its member signature
let GetImplementedMemberSignatures (getMemberByLocation: string * range -> FSharpSymbolUse option) displayContext interfaceData =
let formatMemberSignature (symbolUse: FSharpSymbolUse) =
match symbolUse.Symbol with
| :? FSharpMemberOrFunctionOrValue as m ->
match m.FullTypeSafe with
| Some _ when isEventMember m ->
// Events don't have overloads so we use only display names for comparison
let signature = normalizeEventName m
Some [ signature ]
| Some ty ->
let signature =
removeWhitespace (sprintf "%s:%s" m.DisplayName (ty.Format(displayContext)))
Some [ signature ]
| None -> None
| _ ->
//fail "Should only accept symbol uses of members."
None
async {
let symbolUses =
GetMemberNameAndRanges interfaceData
|> List.toArray
|> Array.map getMemberByLocation
return
symbolUses
|> Array.choose (Option.bind formatMemberSignature >> Option.map String.Concat)
|> Set.ofArray
}
/// Check whether an entity is an interface or type abbreviation of an interface
let rec IsInterface (entity: FSharpEntity) =
entity.IsInterface
|| (entity.IsFSharpAbbreviation && IsInterface entity.AbbreviatedType.TypeDefinition)
/// Generate stub implementation of an interface at a start column
let FormatInterface
startColumn
indentation
(typeInstances: string[])
objectIdent
(methodBody: string)
(displayContext: FSharpDisplayContext)
excludedMemberSignatures
(e: FSharpEntity)
verboseMode
=
Debug.Assert(IsInterface e, "The entity should be an interface.")
let lines = String.getLines methodBody
use writer = new ColumnIndentedTextWriter()
let typeParams = Seq.map getTypeParameterName e.GenericParameters
let instantiations =
let insts =
Seq.zip typeParams typeInstances
// Filter out useless instances (when it is replaced by the same name or by wildcard)
|> Seq.filter (fun (t1, t2) -> t1 <> t2 && t2 <> "_")
|> Map.ofSeq
// A simple hack to handle instantiation of type alias
if e.IsFSharpAbbreviation then
let ty = getNonAbbreviatedType e.AbbreviatedType
(ty.TypeDefinition.GenericParameters |> Seq.map getTypeParameterName,
ty.GenericArguments |> Seq.map (fun ty -> ty.Format(displayContext)))
||> Seq.zip
|> Seq.fold (fun acc (x, y) -> Map.add x y acc) insts
else
insts
let ctx =
{
Writer = writer
TypeInstantiations = instantiations
ArgInstantiations = Seq.empty
Indentation = indentation
ObjectIdent = objectIdent
MethodBody = lines
DisplayContext = displayContext
}
let missingMembers =
GetInterfaceMembers e
|> Seq.groupBy (fun (m, insts) ->
match m with
| _ when isEventMember m -> Some(normalizeEventName m)
| TypeOfMember ty ->
let signature =
removeWhitespace (sprintf "%s:%s" m.DisplayName (formatType { ctx with ArgInstantiations = insts } ty))
Some signature
| _ ->
//debug "FullType throws exceptions due to bugs in FCS."
None)
|> Seq.collect (fun (signature, members) ->
match signature with
| None -> members
| Some signature when not (Set.contains signature excludedMemberSignatures) ->
// Return the first member from a group of members for a particular signature
Seq.truncate 1 members
| _ -> Seq.empty)
// All members have already been implemented
if Seq.isEmpty missingMembers then
String.Empty
else
writer.Indent startColumn
writer.WriteLine("")
let duplicatedMembers =
missingMembers
|> Seq.countBy (fun (m, insts) -> m.DisplayName, insts |> Seq.length)
|> Seq.filter (snd >> (<) 1)
|> Seq.map (fst >> fst)
|> Set.ofSeq
let getReturnType v = snd (getArgTypes ctx v)
let rec formatMembers (members: (FSharpMemberOrFunctionOrValue * _) list) =
match members with
// Since there is no unified source of information for properties,
// we try to merge getters and setters when they seem to match.
// Assume that getter and setter come right after each other.
// They belong to the same property if names and return types are the same
| (getter as first, insts) :: (setter, _) :: otherMembers
| (setter as first, _) :: (getter, insts) :: otherMembers when
getter.IsPropertyGetterMethod
&& setter.IsPropertySetterMethod
&& normalizePropertyName getter = normalizePropertyName setter
&& getReturnType getter = getReturnType setter
->
let useVerboseMode = verboseMode || duplicatedMembers.Contains first.DisplayName
formatMember { ctx with ArgInstantiations = insts } (MemberInfo.PropertyGetSet(getter, setter)) useVerboseMode
formatMembers otherMembers
| (m, insts) :: otherMembers ->
let useVerboseMode = verboseMode || duplicatedMembers.Contains m.DisplayName
formatMember { ctx with ArgInstantiations = insts } (MemberInfo.Member m) useVerboseMode
formatMembers otherMembers
| [] -> ()
missingMembers
|> Seq.sortBy (fun (m, _) ->
// Sort by normalized name and return type so that getters and setters of the same properties
// are guaranteed to be neighboring.
normalizePropertyName m, getReturnType m)
|> Seq.toList
|> formatMembers
writer.Dump()
/// Find corresponding interface declaration at a given position
let TryFindInterfaceDeclaration (pos: pos) (parsedInput: ParsedInput) =
let rec walkImplFileInput (file: ParsedImplFileInput) =
List.tryPick walkSynModuleOrNamespace file.Contents
and walkSynModuleOrNamespace (SynModuleOrNamespace(decls = decls; range = range)) =
if not <| rangeContainsPos range pos then
None
else
List.tryPick walkSynModuleDecl decls
and walkSynModuleDecl (decl: SynModuleDecl) =
if not <| rangeContainsPos decl.Range pos then
None
else
match decl with
| SynModuleDecl.Exception(SynExceptionDefn(_, _, synMembers, _), _) -> List.tryPick walkSynMemberDefn synMembers
| SynModuleDecl.Let(bindings = bindings) -> List.tryPick walkBinding bindings
| SynModuleDecl.ModuleAbbrev(_lhs, _rhs, _range) -> None
| SynModuleDecl.NamespaceFragment(fragment) -> walkSynModuleOrNamespace fragment
| SynModuleDecl.NestedModule(decls = modules) -> List.tryPick walkSynModuleDecl modules
| SynModuleDecl.Types(typeDefs, _range) -> List.tryPick walkSynTypeDefn typeDefs
| SynModuleDecl.Expr(expr, _) -> walkExpr expr
| SynModuleDecl.Attributes _
| SynModuleDecl.HashDirective _
| SynModuleDecl.Open _ -> None
and walkSynTypeDefn (SynTypeDefn(typeRepr = representation; members = members; range = range)) =
if not <| rangeContainsPos range pos then
None
else
walkSynTypeDefnRepr representation
|> Option.orElse (List.tryPick walkSynMemberDefn members)
and walkSynTypeDefnRepr (typeDefnRepr: SynTypeDefnRepr) =
if not <| rangeContainsPos typeDefnRepr.Range pos then
None
else
match typeDefnRepr with
| SynTypeDefnRepr.ObjectModel(_kind, members, _range) -> List.tryPick walkSynMemberDefn members
| SynTypeDefnRepr.Simple(_repr, _range) -> None
| SynTypeDefnRepr.Exception _ -> None
and walkSynMemberDefn (memberDefn: SynMemberDefn) =
if not <| rangeContainsPos memberDefn.Range pos then
None
else
match memberDefn with
| SynMemberDefn.AbstractSlot _ -> None
| SynMemberDefn.AutoProperty(synExpr = expr) -> walkExpr expr
| SynMemberDefn.Interface(interfaceType = interfaceType; members = members) ->
if rangeContainsPos interfaceType.Range pos then
Some(InterfaceData.Interface(interfaceType, members))
else
Option.bind (List.tryPick walkSynMemberDefn) members
| SynMemberDefn.Member(binding, _range) -> walkBinding binding
| SynMemberDefn.GetSetMember(getBinding, setBinding, _, _) ->
match getBinding, setBinding with
| None, None -> None
| Some binding, None
| None, Some binding -> walkBinding binding
| Some getBinding, Some setBinding -> walkBinding getBinding |> Option.orElseWith (fun () -> walkBinding setBinding)
| SynMemberDefn.NestedType(typeDef, _access, _range) -> walkSynTypeDefn typeDef
| SynMemberDefn.ValField _ -> None
| SynMemberDefn.LetBindings(bindings = bindings) -> List.tryPick walkBinding bindings
| SynMemberDefn.Open _
| SynMemberDefn.ImplicitCtor _
| SynMemberDefn.Inherit _ -> None
| SynMemberDefn.ImplicitInherit(_, expr, _, _, _) -> walkExpr expr
and walkBinding (SynBinding(expr = expr)) = walkExpr expr
and walkExpr expr =
if not <| rangeContainsPos expr.Range pos then
None
else
match expr with
| SynExpr.Quote(synExpr1, _, synExpr2, _, _range) -> List.tryPick walkExpr [ synExpr1; synExpr2 ]
| SynExpr.Const(_synConst, _range) -> None
| SynExpr.Paren(synExpr, _, _, _parenRange) -> walkExpr synExpr
| SynExpr.Typed(synExpr, _synType, _range) -> walkExpr synExpr
| SynExpr.Tuple(_, synExprList, _, _range)
| SynExpr.ArrayOrList(_, synExprList, _range) -> List.tryPick walkExpr synExprList
| SynExpr.Record(_inheritOpt, _copyOpt, fields, _range) ->
List.tryPick (fun (SynExprRecordField(expr = e)) -> Option.bind walkExpr e) fields
| SynExpr.New(_, _synType, synExpr, _range) -> walkExpr synExpr
| SynExpr.ObjExpr(objType = ty; argOptions = baseCallOpt; bindings = binds; members = ms; extraImpls = ifaces) ->
let binds = unionBindingAndMembers binds ms
match baseCallOpt with
| None ->
if rangeContainsPos ty.Range pos then
Some(InterfaceData.ObjExpr(ty, binds))
else
ifaces
|> List.tryPick (fun (SynInterfaceImpl(interfaceTy = ty; bindings = binds; range = range)) ->
if rangeContainsPos range pos then
Some(InterfaceData.ObjExpr(ty, binds))
else
None)
| Some _ ->
// Ignore object expressions of normal objects
None
| SynExpr.While(_spWhile, synExpr1, synExpr2, _range) -> List.tryPick walkExpr [ synExpr1; synExpr2 ]
| SynExpr.ForEach(_spFor, _spIn, _seqExprOnly, _isFromSource, _synPat, synExpr1, synExpr2, _range) ->
List.tryPick walkExpr [ synExpr1; synExpr2 ]
| SynExpr.For(identBody = synExpr1; toBody = synExpr2; doBody = synExpr3) ->
List.tryPick walkExpr [ synExpr1; synExpr2; synExpr3 ]
| SynExpr.ArrayOrListComputed(_, synExpr, _range) -> walkExpr synExpr
| SynExpr.ComputationExpr(_, synExpr, _range) -> walkExpr synExpr
| SynExpr.Lambda(body = synExpr) -> walkExpr synExpr
| SynExpr.DotLambda(expr = synExpr) -> walkExpr synExpr
| SynExpr.MatchLambda(_isExnMatch, _argm, synMatchClauseList, _spBind, _wholem) ->
synMatchClauseList
|> List.tryPick (fun (SynMatchClause(resultExpr = e)) -> walkExpr e)
| SynExpr.Match(expr = synExpr; clauses = synMatchClauseList) ->
walkExpr synExpr
|> Option.orElse (
synMatchClauseList
|> List.tryPick (fun (SynMatchClause(resultExpr = e)) -> walkExpr e)
)
| SynExpr.Lazy(synExpr, _range) -> walkExpr synExpr
| SynExpr.Do(synExpr, _range) -> walkExpr synExpr
| SynExpr.Assert(synExpr, _range) -> walkExpr synExpr
| SynExpr.App(_exprAtomicFlag, _isInfix, synExpr1, synExpr2, _range) -> List.tryPick walkExpr [ synExpr1; synExpr2 ]
| SynExpr.TypeApp(synExpr, _, _synTypeList, _commas, _, _, _range) -> walkExpr synExpr
| SynExpr.LetOrUse({
Bindings = synBindingList
Body = synExpr
}) -> Option.orElse (List.tryPick walkBinding synBindingList) (walkExpr synExpr)
| SynExpr.TryWith(tryExpr = synExpr) -> walkExpr synExpr
| SynExpr.TryFinally(tryExpr = synExpr1; finallyExpr = synExpr2) -> List.tryPick walkExpr [ synExpr1; synExpr2 ]
| Sequentials exprs -> List.tryPick walkExpr exprs
| SynExpr.IfThenElse(ifExpr = synExpr1; thenExpr = synExpr2; elseExpr = synExprOpt) ->
match synExprOpt with
| Some synExpr3 -> List.tryPick walkExpr [ synExpr1; synExpr2; synExpr3 ]
| None -> List.tryPick walkExpr [ synExpr1; synExpr2 ]
| SynExpr.Ident _ident -> None
| SynExpr.LongIdent(_, _longIdent, _altNameRefCell, _range) -> None
| SynExpr.LongIdentSet(_longIdent, synExpr, _range) -> walkExpr synExpr
| SynExpr.DotGet(synExpr, _dotm, _longIdent, _range) -> walkExpr synExpr
| SynExpr.DotSet(synExpr1, _longIdent, synExpr2, _range) -> List.tryPick walkExpr [ synExpr1; synExpr2 ]
| SynExpr.Set(synExpr1, synExpr2, _range) -> List.tryPick walkExpr [ synExpr1; synExpr2 ]
| SynExpr.DotIndexedGet(synExpr, indexArgs, _range, _range2) -> Option.orElse (walkExpr synExpr) (walkExpr indexArgs)
| SynExpr.DotIndexedSet(synExpr1, indexArgs, synExpr2, _, _range, _range2) ->
[ synExpr1; indexArgs; synExpr2 ] |> List.tryPick walkExpr
| SynExpr.JoinIn(synExpr1, _range, synExpr2, _range2) -> List.tryPick walkExpr [ synExpr1; synExpr2 ]
| SynExpr.NamedIndexedPropertySet(_longIdent, synExpr1, synExpr2, _range) -> List.tryPick walkExpr [ synExpr1; synExpr2 ]
| SynExpr.DotNamedIndexedPropertySet(synExpr1, _longIdent, synExpr2, synExpr3, _range) ->
List.tryPick walkExpr [ synExpr1; synExpr2; synExpr3 ]
| SynExpr.TypeTest(synExpr, _synType, _range)
| SynExpr.Upcast(synExpr, _synType, _range)
| SynExpr.Downcast(synExpr, _synType, _range) -> walkExpr synExpr
| SynExpr.InferredUpcast(synExpr, _range)
| SynExpr.InferredDowncast(synExpr, _range) -> walkExpr synExpr
| SynExpr.AddressOf(_, synExpr, _range, _range2) -> walkExpr synExpr
| SynExpr.TraitCall(_synTyparList, _synMemberSig, synExpr, _range) -> walkExpr synExpr
| SynExpr.Null _range
| SynExpr.ImplicitZero _range -> None
| SynExpr.YieldOrReturn(expr = synExpr)
| SynExpr.YieldOrReturnFrom(expr = synExpr)
| SynExpr.DoBang(expr = synExpr) -> walkExpr synExpr
| SynExpr.LibraryOnlyILAssembly _
| SynExpr.LibraryOnlyStaticOptimization _
| SynExpr.LibraryOnlyUnionCaseFieldGet _
| SynExpr.LibraryOnlyUnionCaseFieldSet _ -> None
| SynExpr.ArbitraryAfterError(_debugStr, _range) -> None
| SynExpr.FromParseError(synExpr, _range)
| SynExpr.DiscardAfterMissingQualificationAfterDot(synExpr, _, _range) -> walkExpr synExpr
| _ -> None
match parsedInput with
| ParsedInput.SigFile _input -> None
| ParsedInput.ImplFile input -> walkImplFileInput input