Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Symbol uses #34

Merged
merged 7 commits into from
Jun 30, 2015
Merged

Symbol uses #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
24a192d
Add symboluse command
rojepp Jun 28, 2015
df22882
Use proper types

rojepp Jun 28, 2015
26d0969
Add potentially useful fields to symboluse
rojepp Jun 28, 2015
519efbf
Make ouput columns 1-based
rojepp Jun 29, 2015
5a35a29
Make output columns 1-based for FSharpErrorInfo
rojepp Jun 29, 2015
9db21dd
Serialize Ranges as 1-based
rojepp Jun 29, 2015
ae5a618
Remove unused var warning
rojepp Jun 29, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 95 additions & 7 deletions FSharp.AutoComplete/Program.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,50 @@ type MethodResponse =
Overloads : Overload list
}

type SymbolUseRange =
{
Filename: string
StartLine: int
StartColumn: int
EndLine: int
EndColumn: int
IsFromDefinition: bool
IsFromAttribute : bool
IsFromComputationExpression : bool
IsFromDispatchSlotImplementation : bool
IsFromPattern : bool
IsFromType : bool
}

type SymbolUseResponse =
{
Name: string
Uses: SymbolUseRange list
}

type FSharpErrorInfo =
{
FileName: string
StartLine:int
EndLine:int
StartColumn:int
EndColumn:int
Severity:FSharpErrorSeverity
Message:string
Subcategory:string
}
static member OfFSharpError(e:Microsoft.FSharp.Compiler.FSharpErrorInfo) =
{
FileName = e.FileName
StartLine = e.StartLineAlternate
EndLine = e.EndLineAlternate
StartColumn = e.StartColumn + 1
EndColumn = e.EndColumn + 1
Severity = e.Severity
Message = e.Message
Subcategory = e.Subcategory
}

type FSharpErrorSeverityConverter() =
inherit JsonConverter()

Expand All @@ -106,9 +150,18 @@ type RangeConverter() =

override x.CanConvert(t:System.Type) = t = typeof<Range.range>

override x.WriteJson(writer, value, serializer) =
override x.WriteJson(writer, value, _serializer) =
let range = value :?> Range.range
serializer.Serialize(writer, (range.Start, range.End))
writer.WriteStartObject()
writer.WritePropertyName("StartColumn")
writer.WriteValue(range.StartColumn + 1)
writer.WritePropertyName("StartLine")
writer.WriteValue(range.StartLine)
writer.WritePropertyName("EndColumn")
writer.WriteValue(range.EndColumn + 1)
writer.WritePropertyName("EndLine")
writer.WriteValue(range.EndLine)
writer.WriteEndObject()

override x.ReadJson(_reader, _t, _, _serializer) =
raise (System.NotSupportedException())
Expand Down Expand Up @@ -144,6 +197,8 @@ module internal CommandInput =
helptext <candidate>
- fetch type signature for specified completion candidate
(from last completion request). Only use in JSON mode.
symboluse ""<filename>"" <line> <col> [timeout]
- find all uses of the symbol for the specified location
tooltip ""<filename>"" <line> <col> [timeout]
- get tool tip for the specified location
finddecl ""<filename>"" <line> <col> [timeout]
Expand Down Expand Up @@ -188,6 +243,7 @@ module internal CommandInput =
type PosCommand =
| Completion
| Methods
| SymbolUse
| ToolTip
| FindDeclaration

Expand Down Expand Up @@ -260,6 +316,7 @@ module internal CommandInput =
// Parse 'completion "<filename>" <line> <col> [timeout]' command
let completionTipOrDecl = parser {
let! f = (string "completion " |> Parser.map (fun _ -> Completion)) <|>
(string "symboluse " |> Parser.map (fun _ -> SymbolUse)) <|>
(string "tooltip " |> Parser.map (fun _ -> ToolTip)) <|>
(string "methods " |> Parser.map (fun _ -> Methods)) <|>
(string "finddecl " |> Parser.map (fun _ -> FindDeclaration))
Expand Down Expand Up @@ -456,12 +513,13 @@ module internal Main =
match results.GetErrors() with
| None -> ()
| Some errs ->
let errs = errs |> Seq.map FSharpErrorInfo.OfFSharpError
match state.OutputMode with
| Text ->
let sb = new System.Text.StringBuilder()
sb.AppendLine("DATA: errors") |> ignore
for e in errs do
sb.AppendLine(sprintf "[%d:%d-%d:%d] %s %s" e.StartLineAlternate e.StartColumn e.EndLineAlternate e.EndColumn
sb.AppendLine(sprintf "[%d:%d-%d:%d] %s %s" e.StartLine e.StartColumn e.EndLine e.EndColumn
(if e.Severity = FSharpErrorSeverity.Error then "ERROR" else "WARNING") e.Message)
|> ignore
sb.Append("<<EOF>>") |> ignore
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The JSON printing just below Data =errs is also affected

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch, I'll fix it shortly.

Expand Down Expand Up @@ -521,11 +579,11 @@ module internal Main =
let declstrings =
[ for tld in decls do
let m = tld.Declaration.Range
let (s1, e1), (s2, e2) = ((m.StartColumn, m.StartLine), (m.EndColumn, m.EndLine))
let (s1, e1), (s2, e2) = ((m.StartColumn + 1, m.StartLine), (m.EndColumn + 1, m.EndLine))
yield sprintf "[%d:%d-%d:%d] %s" e1 s1 e2 s2 tld.Declaration.Name
for d in tld.Nested do
let m = d.Range
let (s1, e1), (s2, e2) = ((m.StartColumn, m.StartLine), (m.EndColumn, m.EndLine))
let (s1, e1), (s2, e2) = ((m.StartColumn + 1, m.StartLine), (m.EndColumn + 1, m.EndLine))
yield sprintf " - [%d:%d-%d:%d] %s" e1 s1 e2 s2 d.Name ]
printAgent.WriteLine(sprintf "DATA: declarations\n%s\n<<EOF>>" (String.concat "\n" declstrings))
| Json -> prAsJson { Kind = "declarations"; Data = decls }
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line is also affected

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one could be handled in the Range converter?
https://github.com/fsharp/FsAutoComplete/blob/master/FSharp.AutoComplete/Program.fs#L111

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OTOH, maybe we should have a record type for this as well. It'd be nice to have StartColumn/StartLine etc in this type as well, for consistency.

Expand Down Expand Up @@ -617,6 +675,36 @@ module internal Main =

main state

| SymbolUse ->
let symboluses =
async {
let! symboluse = tyRes.GetSymbol(line, col, lineStr)
if symboluse.IsNone then return None else
let! symboluses = tyRes.GetUsesOfSymbolInFile symboluse.Value.Symbol
return Some {
Name = symboluse.Value.Symbol.DisplayName
Uses =
[ for su in symboluses do
yield { StartLine = su.RangeAlternate.StartLine
StartColumn = su.RangeAlternate.StartColumn + 1
EndLine = su.RangeAlternate.EndLine
EndColumn = su.RangeAlternate.EndColumn + 1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding 1 here doesn't seem right, they should already be 1-based from the Alternate syntax. Looking at the results I also think they should end one earlier e.g. with:

let testval = FileTwo.NewObjectType()

The results have a range with columns start=5 and end=12. t is definitely at 5, and l is 6 further on, so 11. This is an inclusive range and I think we should leave it alone, documenting it as such (if we ever get around to adding documentation for this project!). If editors prefer to work with an exclusive range they can make the adjustement locally.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

XS columns are 1 based we do something like:

        let start, finish = Symbols.trimSymbolRegion symbolUse lastIdentAtLoc
        let filename = doc.FileName.ToString()  
        let offset = doc.LocationToOffset(start.Line, start.Column+1)
        let domRegion = DomRegion(filename, start.Line, start.Column+1, finish.Line, finish.Column+1)

        let symbol = createSymbol(doc, context, symbolUse.Symbol, lastIdentAtLoc, domRegion)
        let memberRef = MemberReference(symbol, filename, offset, lastIdentAtLoc.Length)

        //if the current range is a symbol range and the fileNameOfRefs match change the ReferenceUsageType
        if symbolUse.IsFromDefinition then
            memberRef.ReferenceUsageType <- ReferenceUsageType.Write

        memberRef

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure how to fix this. FCS seems to report 0-based columns (lines are 1-based). Do you want me to only add 1 to StartColumn? That doesn't seem right to me. That would leave testva highlighted.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I misread. It seems that FCS accepts 1-based column numbers but returns 0-based. Why would this possibly be a good idea?

I've looked at the output we give and I think only declarations, finddecl and this new command return positions. I think they should all return 0-based or all return 1-based columns, for consistency. However, I think that if FCS is outputting 0-based columns it should probably be accepting 0-based as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is all very confusing. Adding 1 to StartColumn and EndColumn seems to be the right thing to do, so we normalize to consistently being 1-based . Do the other commands return 0-based?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Find Declaration seems to return 0-based.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I guess you posted at the same time as me ;-)

I would be happy if everything returned 1-based so at least FSAC is consistent even if FCS isn't.

@7sharp9 do you adjust the results you get from GetNavigationItems for the pathed document support as well to be 1-based?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's do it. :)

Separate PR or this one?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here is fine by me.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Filename = su.FileName
IsFromDefinition = su.IsFromDefinition
IsFromAttribute = su.IsFromAttribute
IsFromComputationExpression = su.IsFromComputationExpression
IsFromDispatchSlotImplementation = su.IsFromDispatchSlotImplementation
IsFromPattern = su.IsFromPattern
IsFromType = su.IsFromType } ] } }
|> Async.RunSynchronously

match state.OutputMode, symboluses with
| Text, _ -> printMsg "ERROR" "symboluse not supported in text mode"
| Json, Some su -> prAsJson { Kind = "symboluse"; Data = su }
| _ -> printMsg "ERROR" "No symbols found"

main state

| FindDeclaration ->
let declarations = tyRes.GetDeclarationLocation(line,col,lineStr)
|> Async.RunSynchronously
Expand All @@ -625,9 +713,9 @@ module internal Main =
| FSharpFindDeclResult.DeclFound range ->

match state.OutputMode with
| Text -> printAgent.WriteLine(sprintf "DATA: finddecl\n%s:%d:%d\n<<EOF>>" range.FileName range.StartLine range.StartColumn)
| Text -> printAgent.WriteLine(sprintf "DATA: finddecl\n%s:%d:%d\n<<EOF>>" range.FileName range.StartLine (range.StartColumn + 1))
| Json ->
let data = { Line = range.StartLine; Column = range.StartColumn; File = range.FileName }
let data = { Line = range.StartLine; Column = range.StartColumn + 1; File = range.FileName }
prAsJson { Kind = "finddecl"; Data = data }

main state
Expand Down
2 changes: 1 addition & 1 deletion FSharp.AutoComplete/test/integration/CompletionFilter/output.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
INFO: Synchronous parsing started
<<EOF>>
DATA: errors
[2:5-2:6] ERROR The value, constructor, namespace or type 'c' is not defined
[2:6-2:7] ERROR The value, constructor, namespace or type 'c' is not defined
<<EOF>>
DATA: completion
Cons
Expand Down
8 changes: 4 additions & 4 deletions FSharp.AutoComplete/test/integration/ErrorTests/output.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ DATA: project
INFO: Synchronous parsing started
<<EOF>>
DATA: errors
[4:14-4:21] ERROR The namespace or module 'FileTwo' is not defined
[8:11-8:27] ERROR Lookup on object of indeterminate type based on information prior to this program point. A type annotation may be needed prior to this program point to constrain the type of the object. This may allow the lookup to be resolved.
[10:18-10:22] ERROR This expression was expected to have type
[4:15-4:22] ERROR The namespace or module 'FileTwo' is not defined
[8:12-8:28] ERROR Lookup on object of indeterminate type based on information prior to this program point. A type annotation may be needed prior to this program point to constrain the type of the object. This may allow the lookup to be resolved.
[10:19-10:23] ERROR This expression was expected to have type
int
but here has type
string
Expand All @@ -18,7 +18,7 @@ func
INFO: Synchronous parsing started
<<EOF>>
DATA: errors
[8:12-8:19] ERROR The value or constructor 'unnamed' is not defined
[8:13-8:20] ERROR The value or constructor 'unnamed' is not defined
<<EOF>>
DATA: completion
func
Expand Down
56 changes: 24 additions & 32 deletions FSharp.AutoComplete/test/integration/ErrorTestsJson/output.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,40 +24,34 @@
"Kind": "errors",
"Data": [
{
"StartLine": 3,
"StartLineAlternate": 4,
"EndLine": 3,
"EndLineAlternate": 4,
"StartColumn": 14,
"EndColumn": 21,
"FileName": "<absolute path removed>/test/integration/ErrorTestsJson/Program.fs",
"StartLine": 4,
"EndLine": 4,
"StartColumn": 15,
"EndColumn": 22,
"Severity": "Error",
"Message": "The namespace or module 'FileTwo' is not defined",
"Subcategory": "typecheck",
"FileName": "<absolute path removed>/test/integration/ErrorTestsJson/Program.fs"
"Subcategory": "typecheck"
},
{
"StartLine": 7,
"StartLineAlternate": 8,
"EndLine": 7,
"EndLineAlternate": 8,
"StartColumn": 11,
"EndColumn": 27,
"FileName": "<absolute path removed>/test/integration/ErrorTestsJson/Program.fs",
"StartLine": 8,
"EndLine": 8,
"StartColumn": 12,
"EndColumn": 28,
"Severity": "Error",
"Message": "Lookup on object of indeterminate type based on information prior to this program point. A type annotation may be needed prior to this program point to constrain the type of the object. This may allow the lookup to be resolved.",
"Subcategory": "typecheck",
"FileName": "<absolute path removed>/test/integration/ErrorTestsJson/Program.fs"
"Subcategory": "typecheck"
},
{
"StartLine": 9,
"StartLineAlternate": 10,
"EndLine": 9,
"EndLineAlternate": 10,
"StartColumn": 18,
"EndColumn": 22,
"FileName": "<absolute path removed>/test/integration/ErrorTestsJson/Program.fs",
"StartLine": 10,
"EndLine": 10,
"StartColumn": 19,
"EndColumn": 23,
"Severity": "Error",
"Message": "This expression was expected to have type\n int \nbut here has type\n string ",
"Subcategory": "typecheck",
"FileName": "<absolute path removed>/test/integration/ErrorTestsJson/Program.fs"
"Subcategory": "typecheck"
}
]
}
Expand All @@ -69,16 +63,14 @@
"Kind": "errors",
"Data": [
{
"StartLine": 7,
"StartLineAlternate": 8,
"EndLine": 7,
"EndLineAlternate": 8,
"StartColumn": 12,
"EndColumn": 19,
"FileName": "<absolute path removed>/test/integration/ErrorTestsJson/Script.fsx",
"StartLine": 8,
"EndLine": 8,
"StartColumn": 13,
"EndColumn": 20,
"Severity": "Error",
"Message": "The value or constructor 'unnamed' is not defined",
"Subcategory": "typecheck",
"FileName": "<absolute path removed>/test/integration/ErrorTestsJson/Script.fsx"
"Subcategory": "typecheck"
}
]
}
Expand Down
10 changes: 5 additions & 5 deletions FSharp.AutoComplete/test/integration/FindDeclarations/output.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,17 @@ INFO: Synchronous parsing started
DATA: errors
<<EOF>>
DATA: finddecl
<absolute path removed>/test/integration/FindDeclarations/Program.fs:2:6
<absolute path removed>/test/integration/FindDeclarations/Program.fs:2:7
<<EOF>>
DATA: finddecl
<absolute path removed>/test/integration/FindDeclarations/FileTwo.fs:13:11
<absolute path removed>/test/integration/FindDeclarations/FileTwo.fs:13:12
<<EOF>>
DATA: finddecl
<absolute path removed>/test/integration/FindDeclarations/Program.fs:6:4
<absolute path removed>/test/integration/FindDeclarations/Program.fs:6:5
<<EOF>>
DATA: finddecl
<absolute path removed>/test/integration/FindDeclarations/FileTwo.fs:11:5
<absolute path removed>/test/integration/FindDeclarations/FileTwo.fs:11:6
<<EOF>>
DATA: finddecl
<absolute path removed>/test/integration/FindDeclarations/Script.fsx:4:6
<absolute path removed>/test/integration/FindDeclarations/Script.fsx:4:7
<<EOF>>
2 changes: 1 addition & 1 deletion FSharp.AutoComplete/test/integration/MultipleUnsavedFiles/output.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ DATA: errors
INFO: Synchronous parsing started
<<EOF>>
DATA: errors
[1:22-1:28] ERROR The value, constructor, namespace or type 'addTwo' is not defined
[1:23-1:29] ERROR The value, constructor, namespace or type 'addTwo' is not defined
<<EOF>>
8 changes: 4 additions & 4 deletions FSharp.AutoComplete/test/integration/OutOfRange/output.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
INFO: Synchronous parsing started
<<EOF>>
DATA: errors
[6:14-6:15] ERROR Missing qualification after '.'
[6:14-6:15] ERROR Missing qualification after '.'
[6:12-6:14] ERROR The value or constructor 'XA' is not defined
[6:15-6:16] ERROR Missing qualification after '.'
[6:15-6:16] ERROR Missing qualification after '.'
[6:13-6:15] ERROR The value or constructor 'XA' is not defined
<<EOF>>
ERROR: Position is out of range
<<EOF>>
Expand All @@ -22,7 +22,7 @@ INFO: No tooltip information
ERROR: Position is out of range
<<EOF>>
DATA: finddecl
<absolute path removed>/test/integration/OutOfRange/Script.fsx:3:7
<absolute path removed>/test/integration/OutOfRange/Script.fsx:3:8
<<EOF>>
ERROR: Could not find declaration
<<EOF>>
Expand Down
32 changes: 16 additions & 16 deletions FSharp.AutoComplete/test/integration/RawIdTest/output.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
INFO: Synchronous parsing started
<<EOF>>
DATA: errors
[9:1-9:2] ERROR Missing qualification after '.'
[11:1-11:2] ERROR Missing qualification after '.'
[11:2-11:3] ERROR Unexpected reserved keyword in implementation file
[11:2-11:3] ERROR Unexpected reserved keyword in implementation file
[11:1-11:2] ERROR Missing qualification after '.'
[9:1-9:2] ERROR Missing qualification after '.'
[9:0-9:1] ERROR The value or constructor 'X' is not defined
[11:0-11:1] ERROR The value or constructor 'X' is not defined
[9:2-9:3] ERROR Missing qualification after '.'
[11:2-11:3] ERROR Missing qualification after '.'
[11:3-11:4] ERROR Unexpected reserved keyword in implementation file
[11:3-11:4] ERROR Unexpected reserved keyword in implementation file
[11:2-11:3] ERROR Missing qualification after '.'
[9:2-9:3] ERROR Missing qualification after '.'
[9:1-9:2] ERROR The value or constructor 'X' is not defined
[11:1-11:2] ERROR The value or constructor 'X' is not defined
<<EOF>>
INFO: Synchronous parsing started
<<EOF>>
DATA: errors
[9:1-9:2] ERROR Missing qualification after '.'
[11:1-11:2] ERROR Missing qualification after '.'
[11:2-11:3] ERROR Unexpected reserved keyword in implementation file
[11:2-11:3] ERROR Unexpected reserved keyword in implementation file
[11:1-11:2] ERROR Missing qualification after '.'
[9:1-9:2] ERROR Missing qualification after '.'
[9:0-9:1] ERROR The value or constructor 'Y' is not defined
[11:0-11:1] ERROR The value or constructor 'Y' is not defined
[9:2-9:3] ERROR Missing qualification after '.'
[11:2-11:3] ERROR Missing qualification after '.'
[11:3-11:4] ERROR Unexpected reserved keyword in implementation file
[11:3-11:4] ERROR Unexpected reserved keyword in implementation file
[11:2-11:3] ERROR Missing qualification after '.'
[9:2-9:3] ERROR Missing qualification after '.'
[9:1-9:2] ERROR The value or constructor 'Y' is not defined
[11:1-11:2] ERROR The value or constructor 'Y' is not defined
<<EOF>>
DATA: completion
Another`Column
Expand Down
4 changes: 2 additions & 2 deletions FSharp.AutoComplete/test/integration/RobustCommands/completewithoutproject.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ func
INFO: Synchronous parsing started
<<EOF>>
DATA: errors
[4:14-4:21] ERROR The namespace or module 'FileTwo' is not defined
[8:11-8:27] ERROR Lookup on object of indeterminate type based on information prior to this program point. A type annotation may be needed prior to this program point to constrain the type of the object. This may allow the lookup to be resolved.
[4:15-4:22] ERROR The namespace or module 'FileTwo' is not defined
[8:12-8:28] ERROR Lookup on object of indeterminate type based on information prior to this program point. A type annotation may be needed prior to this program point to constrain the type of the object. This may allow the lookup to be resolved.
<<EOF>>
DATA: completion
<<EOF>>
Loading