[WIP] use Layout as a source data of classification related tasks by vladima · Pull Request #2070 · dotnet/fsharp

vladima · 2016-12-21T19:14:22Z

Early WIP
F# compiler uses Layout structure for pretty printing but ultimately outputs result as a string. This become a culprit in classification related scenarios since in order to colorize everything nicely we have to effectively recover original Layout. This PR introduces TaggedText annotations for text chunks in Layout. Later annotated text chunks can easily be converted from the Layout to Roslyn TaggedText.

Remaining items:

- add glyphs to quick info. Possible approach is proposed #1 but I think we can do this without doing extra request for symbol.
- make sure that formatting in final result matches current version (though differences might be ok if they improve the experience)
- fix existing tests
- clean-up API surface - currently PR changes shapes/signatures of existing types and methods which will be a breaking change for anyone who consumed previous version of the compiler. Existing API that deal with string should be reverted back and new API that use Layout should be added instead of replacing existing ones.

per @vasily-kirichenko' comment:

- bugfixes

Quick info:

Signature help:

Completion details:

dungpa · 2016-12-21T19:21:02Z

Woohoo! I've been waiting for this PR for so long.

vasily-kirichenko · 2016-12-21T20:00:57Z

It's just fantastic 🥇 🥇 🥇

vasily-kirichenko · 2016-12-21T20:06:15Z

As you have not mentioned any bugs in the to do list, I feel free to report first ones :)

Here type should be highlighted as keyword:

The namespace should not be highlighted, bool keyword is not highlighted, ThreadPool type is not highlighted:

saul · 2016-12-21T21:30:31Z

This look absolutely fantastic!

Another issue is that the indentation seems to be lost:

vasily-kirichenko · 2016-12-22T07:28:23Z

@vladima do I understand right that this color information can be used for normal semantic code highlighting in the editor?

vladima · 2016-12-22T18:31:13Z

I'm not sure that I understand the question: compiler uses layouts to pretty print various kinds of messages but it is not used to format the source text itself. For classification in the editor one should use IEditorClassificationService which I think F# language service already does

saul · 2016-12-25T01:04:42Z

Another bug - type parameters include the apostrophe prefix in the colouring. The editor doesn't colour the apostrophe when doing syntax highlighting - I'm not sure which is the preferred option here.

Another positive is that FSI's output can now be colourised too:

cloudRoutine · 2016-12-25T02:42:40Z

@saul including the apostrophe is correct, the current highlighting in the editor is wrong

vladima · 2016-12-27T05:57:30Z

per F# spec:

typar :=
_ -- anonymous variable type
'ident -- type variable
^ident -- static head-type type variable

so I read it as ' is considered part of the name

vladima · 2016-12-27T06:05:00Z

status update: fixed indentation and classification of types inside xml doc comments

saul · 2016-12-30T10:33:03Z

Another small issue - I've noticed that "Full name: XXX" seems to be indented by a couple of spaces. This is not the case on master without your PR, so looks like a bug

dsyme · 2016-12-30T12:08:58Z

Wow, this is fantastic!

dsyme · 2016-12-30T12:13:47Z

clean-up API surface - currently PR changes shapes/signatures of existing types and methods which will be a breaking change for anyone who consumed previous version of the compiler. Existing API that deal with string should be reverted back and new API that use Layout should be added instead of replacing existing ones.

This is OK as long as FSharp.Core is stable - for various reasons we have been making pretty regular breaking changes in the surface arera of FSharp.Compiler.Service, and bumping major version numbers on the nuget package when we do.

dsyme · 2016-12-30T12:16:09Z

If anyone wants to make some basic improvements like

replacing struct/end by [<Struct>]
eliding interface/end altogether
eliding class/end altogether

etc that would also be great

vladima · 2016-12-31T07:19:25Z

@dotnet-bot test this please

vasily-kirichenko · 2016-12-31T15:42:51Z

Instance members are indented:

But static members sometimes are not:

(ok)

(wrong)

Actually I've found the only case where it's broken - Async type. The tooltip is huge, maybe it's the root cause.

vasily-kirichenko · 2016-12-31T15:47:20Z

Another catch - namespace and module keywords are not highlighted:

vladima · 2017-01-01T02:48:02Z

Colors for module and namespace keywords are fixed. As for indentation I do agree that it is inconsistent with other cases however I'd prefer to fix this in a separate PR. Reasons:

technically this is not a regression since it matches existing behavior for types with hidden representation
current PR is already quite big and adding more things to it will make its review more complicated.

// cc @KevinRansom and @dsyme for opinions.

saul · 2017-01-01T15:18:46Z

One last issue @vladima, see how the separators look in current master:

Note that there are no blank lines around the separator, and there is no separator at the end of the tooltip. See @vasily-kirichenko's first screenshot in his last comment:

cartermp · 2017-01-01T18:00:43Z

@vladima Agreed re: indentation - unless it's a minor change, adding more improvements to this PR will make it more difficult to review and get merged.

cartermp · 2017-01-01T18:03:25Z

@vasily-kirichenko I've noticed the Async tooltip exploding in size in #1973 as well. Perhaps there's some strange code path executed for Async where it's not truncated, because in most situations it cuts off with a ... about 1/3 of the way through listing all the members. I haven't been able to reproduce that kind of behavior for anything other than Async.

vladima · 2017-01-01T22:21:57Z

turned out fix is fairly simple:

dsyme · 2017-01-02T18:56:04Z

This looks good to me. Unless there are other concerns I think we should accept this

KevinRansom · 2017-01-03T21:51:05Z

@vladima

Thank you this is awesome work ...

Kevin

…tnet#2070) * use Layout as a source data of classification related tasks * fix indentation * parse xml doc by hand instead of relying on VS service * revert back old API * fix portable build * fix output in FSI * fix printing of operators * update Surface test * internalize new types and modules * tag module/namespace as keywords * fix tooltip formatting for types with hidden representation * fix separator placement

use Layout as a source data of classification related tasks
38e9c65

msftclas added the cla-not-required label Dec 21, 2016

fix indentation
a2a7ebc

parse xml doc by hand instead of relying on VS service
ca9701e

Merge remote-tracking branch 'origin/master' into precise_classification
13c9e6f

vladima added 4 commits December 30, 2016 16:15

revert back old API
f8f5afa

Merge remote-tracking branch 'origin/master' into precise_classification
91cb7f3

fix portable build
06f67f9

fix output in FSI
d2826a6

vladima added 2 commits December 30, 2016 23:22

Merge remote-tracking branch 'origin/master' into precise_classification
bba49a7

fix printing of operators
be5983d

vladima added 2 commits December 31, 2016 08:17

update Surface test
2d87260

Merge remote-tracking branch 'origin/master' into precise_classification
98e94b0

vladima added 3 commits December 31, 2016 15:57

internalize new types and modules
b3c3484

tag module/namespace as keywords
3b96ca2

Merge remote-tracking branch 'origin/master' into precise_classification
d4e972f

fix tooltip formatting for types with hidden representation
33c1453

fix separator placement
a67b315

dsyme approved these changes Jan 2, 2017
View reviewed changes

KevinRansom approved these changes Jan 3, 2017
View reviewed changes

KevinRansom merged commit ed948ab into dotnet:masterJan 3, 2017

saul mentioned this pull request Jan 3, 2017
Add colours to FSI output #2156
Merged

dungpa mentioned this pull request Jan 4, 2017
Tuple types colorized slightly wrong in signature help #2045
Closed

cartermp mentioned this pull request Jan 6, 2017
QuickInfo doesn't truncate members on Async<'T> when code is invalid #1973
Closed

Uh oh!

Conversation

vladima commented Dec 21, 2016• edited by cartermp Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dungpa commented Dec 21, 2016

Uh oh!

vasily-kirichenko commented Dec 21, 2016

Uh oh!

vasily-kirichenko commented Dec 21, 2016

Uh oh!

saul commented Dec 21, 2016

Uh oh!

vasily-kirichenko commented Dec 22, 2016

Uh oh!

vladima commented Dec 22, 2016

Uh oh!

saul commented Dec 25, 2016

Uh oh!

cloudRoutine commented Dec 25, 2016

Uh oh!

vladima commented Dec 27, 2016

Uh oh!

vladima commented Dec 27, 2016

Uh oh!

saul commented Dec 30, 2016• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dsyme commented Dec 30, 2016

Uh oh!

dsyme commented Dec 30, 2016• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dsyme commented Dec 30, 2016

Uh oh!

vladima commented Dec 31, 2016

Uh oh!

vasily-kirichenko commented Dec 31, 2016

Uh oh!

vasily-kirichenko commented Dec 31, 2016• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vladima commented Jan 1, 2017

Uh oh!

saul commented Jan 1, 2017• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cartermp commented Jan 1, 2017

Uh oh!

cartermp commented Jan 1, 2017• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vladima commented Jan 1, 2017

Uh oh!

dsyme commented Jan 2, 2017

Uh oh!

KevinRansom commented Jan 3, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

vladima commented Dec 21, 2016•
edited by cartermp
Loading

saul commented Dec 30, 2016•
edited
Loading

dsyme commented Dec 30, 2016•
edited
Loading

vasily-kirichenko commented Dec 31, 2016•
edited
Loading

saul commented Jan 1, 2017•
edited
Loading

cartermp commented Jan 1, 2017•
edited
Loading