-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Add top-level members proposal #9719
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.
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
Open
jjonescz
wants to merge
4
commits into
dotnet:main
Choose a base branch
from
jjonescz:tlm
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| # Top-Level Members | ||
|
|
||
| Champion issue: (TODO) | ||
|
|
||
| ## Summary | ||
|
|
||
| Allow some members (methods, operators, extension blocks, and fields) to be declared in namespaces | ||
| and make them available when the corresponding namespace is imported. | ||
|
|
||
| ```cs | ||
| // util.cs | ||
| namespace MyApp; | ||
|
|
||
| void Print(string s) => Console.WriteLine(s); | ||
|
|
||
| string Capitalize(this string input) => | ||
| input.Length == 0 ? input : char.ToUpper(input[0]) + input[1..]; | ||
| ``` | ||
|
|
||
| ```cs | ||
| // app.cs | ||
| #!/usr/bin/env dotnet | ||
|
|
||
| using MyApp; | ||
|
|
||
| Print($"Hello, {args[0].Capitalize()}!"); | ||
| ``` | ||
|
|
||
| ```cs | ||
| // Fields are useful: | ||
| namespace MyUtils; | ||
|
|
||
| static string? cache; | ||
|
|
||
| string GetValue() => cache ??= Compute(); | ||
| ``` | ||
|
|
||
| ```cs | ||
| // Simplifies extensions: | ||
| namespace System.Linq; | ||
|
|
||
| extension<T>(IEnumerable<T> e) | ||
| { | ||
| public IEnumerable<T> AsEnumerable() => e; | ||
| } | ||
| ``` | ||
|
|
||
| ## Motivation | ||
|
|
||
| TODO: Why are we doing this? What use cases does it support? What is the expected outcome? | ||
|
|
||
| - Avoid boilerplate utility static classes. | ||
| - Evolve top-level statements from C# 9. | ||
|
|
||
| ## Detailed design | ||
|
|
||
| TODO: This is the bulk of the proposal. Explain the design in enough detail for somebody familiar with the language to understand, and for somebody familiar with the compiler to implement, and include examples of how the feature is used. This section can start out light before the prototyping phase but should get into specifics and corner-cases as the feature is iteratively designed and implemented. | ||
|
|
||
| - Some members can be declared directly in a namespace (file-scoped or block-scoped). | ||
| - Allowed kinds currently are: methods, operators, extension blocks, and fields. | ||
| - Existing declarations like classes still work the same, there shouldn't be any ambiguity. | ||
jjonescz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - There is no ambiguity with top-level statements because those are not allowed inside namespaces. | ||
jjonescz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - It is as if the members were in an "implicit" `static` class | ||
| whose accessibility is either `internal` (by default) or `public` (if any member is also `public`). | ||
| For top-level members, this means: | ||
| - The `static` modifier is disallowed (the members are implicitly static). | ||
| - The default accessibility is `internal`. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I definitely don't like this or expect this. I would expect members without modifiers to have the narrowest accessibility (so only visible within the file. To be visible outside, you'd need to be explicit about internal/public. |
||
| `public` and `private` is also allowed. | ||
| `protected` and `file` is disallowed. | ||
| - Overloading is supported. | ||
| - `extern` and `partial` are supported. | ||
| - XML doc comments work. | ||
| - Metadata: | ||
| - A type synthesized per namespace and file. That means `private` members are only visible in the file. | ||
| - Cannot be addressed from C#, but has speakable name `TopLevel` so it is callable from other languages. | ||
| This means that custom types named `TopLevel` become disallowed in a namespace where top-level members are used. | ||
| - Usage: | ||
| - `using NS;` implies `using static NS.TopLevel;`. | ||
jjonescz marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Lookup for `NS.Method()` can find `NS.TopLevel.Method()`. | ||
| - Nothing really changes for extensions. | ||
| - Entry points: | ||
| - Top-level `Main` methods can be entry points. | ||
| - Top-level statements are generated into `Program.Main` (speakable function). | ||
| This is a breaking change (previously the main method was unspeakable). | ||
| - Simplify the logic: TLS entry-points are normal candidates. | ||
| This is a breaking change (previously they were not considered to be candidates and for example `-main` could not be used to point to them). | ||
|
|
||
| ## Drawbacks | ||
|
|
||
| TODO: Why should we *not* do this? | ||
|
|
||
| - Polluting namespaces with loosely organized helpers. | ||
| - Requires tooling updates to properly surface and organize top-level methods in IntelliSense, refactorings, etc. | ||
| - Entry point resolution breaking changes. | ||
|
|
||
| ## Alternatives | ||
|
|
||
| TODO: What other designs have been considered? What is the impact of not doing this? | ||
|
|
||
| - Support `args` keyword in top-level members (just like it can be accessed in top-level statements). But we have `System.Environment.GetCommandLineArgs()`. | ||
| - Allow capturing variables from top-level statements inside non-`static` top-level members. | ||
| Could be used to refactor a single-file program into multi-file program just by extracting functions to separate files. | ||
| But it would mean that a method's implementation (top-level statements) can influence what other methods see (which variables are available in top-level members). | ||
| - Allow declaring top-level members outside namespaces as well. | ||
| - Would introduce ambiguities with top-level statements. | ||
| - Could be brought to scope via `extern alias`. | ||
| - To avoid needing to specify those in project files (e.g., so file-based apps also work), | ||
| there could be a syntax for that like `extern alias Util = Util.dll`. | ||
|
|
||
| ## Open questions | ||
|
|
||
| TODO: What parts of the design are still undecided? | ||
jjonescz marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| - Which member kinds? Methods, fields, properties, indexers, events, constructors, operators. | ||
| - Allow `file` or `private` or both? What should `private` really mean? Visible to file, namespace, or something else? | ||
| - Name for the speakable static class (currently `TopLevel`)? Should it be speakable at all? | ||
| - Should we simplify the TLS entry point logic? Should it be a breaking change? | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.