From 9d5989ce2dbf1bf462543151e4240fb349e72441 Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Wed, 6 Mar 2019 22:28:47 -0800 Subject: [PATCH] markdown fixes --- proposals/caller-argument-expression.md | 16 +- proposals/covariant-returns.md | 5 +- proposals/declaration-expressions.md | 9 +- proposals/default-interface-methods.md | 198 ++++++++++++------------ proposals/fixed-sized-buffers.md | 11 +- 5 files changed, 118 insertions(+), 121 deletions(-) diff --git a/proposals/caller-argument-expression.md b/proposals/caller-argument-expression.md index 5e7b1e2b..85d1ade1 100755 --- a/proposals/caller-argument-expression.md +++ b/proposals/caller-argument-expression.md @@ -15,7 +15,7 @@ Allow developers to capture the expressions passed to a method, to enable better When an assertion or argument validation fails, the developer wants to know as much as possible about where and why it failed. However, today's diagnostic APIs do not fully facilitate this. Consider the following method: -```cs +```csharp T Single(this T[] array) { Debug.Assert(array != null); @@ -31,7 +31,7 @@ This is also the reason testing frameworks have to provide a variety of assert m While the situation is a bit better for argument validation because the names of invalid arguments are shown to the developer, the developer must pass these names to exceptions manually. If the above example were rewritten to use traditional argument validation instead of `Debug.Assert`, it would look like -```cs +```csharp T Single(this T[] array) { if (array == null) @@ -55,7 +55,7 @@ Notice that `nameof(array)` must be passed to each exception, although it's alre In the above examples, including the string `"array != null"` or `"array.Length == 1"` in the assert message would help the developer determine what failed. Enter `CallerArgumentExpression`: it's an attribute the framework can use to obtain the string associated with a particular method argument. We would add it to `Debug.Assert` like so -```cs +```csharp public static class Debug { public static void Assert(bool condition, [CallerArgumentExpression("condition")] string message = null); @@ -64,7 +64,7 @@ public static class Debug The source code in the above example would stay the same. However, the code the compiler actually emits would correspond to -```cs +```csharp T Single(this T[] array) { Debug.Assert(array != null, "array != null"); @@ -78,7 +78,7 @@ The compiler specially recognizes the attribute on `Debug.Assert`. It passes the For argument validation, the attribute cannot be used directly, but can be made use of through a helper class: -```cs +```csharp public static class Verify { public static void Argument(bool condition, string message, [CallerArgumentExpression("condition")] string conditionExpression = null) @@ -137,7 +137,7 @@ A proposal to add such a helper class to the framework is underway at https://gi The `this` parameter in an extension method may be referenced by `CallerArgumentExpression`. For example: -```cs +```csharp public static void ShouldBe(this T @this, T expected, [CallerArgumentExpression("this")] string thisExpression = null) {} contestant.Points.ShouldBe(1337); // thisExpression: "contestant.Points" @@ -167,7 +167,7 @@ There should always be an expression corresponding to the `this` parameter. Even - If being able to see source code at call sites for methods that use this attribute proves to be a problem, we can make the attribute's effects opt-in. Developers will enable it through an assembly-wide `[assembly: EnableCallerArgumentExpression]` attribute they put in `AssemblyInfo.cs`. - In the case the attribute's effects are not enabled, calling methods marked with the attribute would not be an error, to allow existing methods to use the attribute and maintain source compatibility. However, the attribute would be ignored and the method would be called with whatever default value was provided. -```cs +```csharp // Assembly1 void Foo(string bar); // V1 @@ -189,7 +189,7 @@ Foo(a, "provided"); // V2, V3: Compiles to Foo(a, "provided") - To prevent the [binary compatibility problem][drawbacks] from occurring every time we want to add new caller info to `Debug.Assert`, an alternative solution would be to add a `CallerInfo` struct to the framework that contains all the necessary information about the caller. -```cs +```csharp struct CallerInfo { public string MemberName { get; set; } diff --git a/proposals/covariant-returns.md b/proposals/covariant-returns.md index 73844eb1..5f9d3f66 100644 --- a/proposals/covariant-returns.md +++ b/proposals/covariant-returns.md @@ -50,7 +50,7 @@ The implementation of this would be for the compiler to emit the overriding meth We could relax the language rules slightly to allow, in source, -``` c# +```csharp abstract class Cloneable { public abstract Cloneable Clone(); @@ -77,5 +77,4 @@ class Digit : Cloneable ## Design meetings -None yet. There has been some discussion at https://github.com/dotnet/roslyn/issues/357 - +None yet. There has been some discussion at . \ No newline at end of file diff --git a/proposals/declaration-expressions.md b/proposals/declaration-expressions.md index 876c31ca..b8085471 100644 --- a/proposals/declaration-expressions.md +++ b/proposals/declaration-expressions.md @@ -6,13 +6,15 @@ Support declaration assignments as expressions. [motivation]: #motivation Allow initialization at the point of declaration in more cases, simplifying code, and allowing `var` to be used. -```C# + +```csharp SpecialType ReferenceType => (var st = _type.SpecialType).IsValueType() ? SpecialType.None : st; ``` Allow declarations for `ref` arguments, similar to `out var`. -```C# + +```csharp Convert(source, destination, ref List diagnostics = null); ``` @@ -48,7 +50,8 @@ the expression is a copy. The declaration assignment expression may declare a `ref` local. There is an ambiguity when `ref` is used for a declaration expression in a `ref` argument. The local variable initializer determines whether the declaration is a `ref` local. -```C# + +```csharp F(ref int x = IntFunc()); // int x; F(ref int y = RefIntFunc()); // ref int y; ``` diff --git a/proposals/default-interface-methods.md b/proposals/default-interface-methods.md index b80992fc..89eddab5 100644 --- a/proposals/default-interface-methods.md +++ b/proposals/default-interface-methods.md @@ -5,7 +5,6 @@ * [ ] Implementation: None * [ ] Specification: In progress, below - ## Summary [summary]: #summary @@ -15,21 +14,21 @@ These are similar to Java's ["Default Methods"](http://docs.oracle.com/javase/tu (Based on the likely implementation technique) this feature requires corresponding support in the CLI/CLR. Programs that take advantage of this feature cannot run on earlier versions of the platform. - ## Motivation [motivation]: #motivation The principal motivations for this feature are -- Default interface methods enable an API author to add methods to an interface in future versions without breaking source or binary compatibility with existing implementations of that interface. -- The feature enables C# to interoperate with APIs targeting [Android (Java)](http://docs.oracle.com/javase/tutorial/java/IandI/defaultmethods.html) and [iOS (Swift)](https://developer.apple.com/library/content/documentation/Swift/Conceptual/Swift_Programming_Language/Protocols.html#//apple_ref/doc/uid/TP40014097-CH25-ID267), which support similar features. -- As it turns out, adding default interface implementations provides the elements of the "traits" language feature (https://en.wikipedia.org/wiki/Trait_(computer_programming)). Traits have proven to be a powerful programming technique (http://scg.unibe.ch/archive/papers/Scha03aTraits.pdf). +- Default interface methods enable an API author to add methods to an interface in future versions without breaking source or binary compatibility with existing implementations of that interface. +- The feature enables C# to interoperate with APIs targeting [Android (Java)](http://docs.oracle.com/javase/tutorial/java/IandI/defaultmethods.html) and [iOS (Swift)](https://developer.apple.com/library/content/documentation/Swift/Conceptual/Swift_Programming_Language/Protocols.html#//apple_ref/doc/uid/TP40014097-CH25-ID267), which support similar features. +- As it turns out, adding default interface implementations provides the elements of the "traits" language feature ()). Traits have proven to be a powerful programming technique (). ## Detailed design [design]: #detailed-design The syntax for an interface is extended to permit -- a *body* for a method or indexer, property, or event accessor (i.e. a "default" implementation) + +- a *body* for a method or indexer, property, or event accessor (that is, a "default" implementation) - static methods, properties, indexers, and events. - Explicit access modifiers (the default access is `public`) @@ -41,12 +40,11 @@ Static and private methods permit useful refactoring and organization of code us A method override in an interface must use the explicit interface implementation syntax. - ### Concrete methods in interfaces The simplest form of this feature is the ability to declare a *concrete method* in an interface, which is a method with a body. -``` c# +```csharp interface IA { void M() { WriteLine("IA.M"); } @@ -55,7 +53,7 @@ interface IA A class that implements this interface need not implement its concrete method. -``` c# +```csharp class C : IA { } // OK IA i = new C(); @@ -64,20 +62,19 @@ i.M(); // prints "IA.M" The final override for `IA.M` in class `C` is the concrete method `M` declared in `IA`. Note that a class does not inherit members from its interfaces; that is not changed by this feature: -``` c# +```csharp new C().M(); // error: class 'C' does not contain a member 'M' ``` Within an instance member of an interface, `this` has the type of the enclosing interface. - ### Modifiers in interfaces The syntax for an interface is relaxed to permit modifiers on its members. The following are permitted: `private`, `protected`, `internal`, `public`, `virtual`, `abstract`, `sealed`, `static`, `extern`, and `partial`. > ***TODO***: check what other modifiers exist. -An interface member whose declaration includes a body is a `virtual` member unless the `sealed` or `private` modifier is used. The `virtual` modifier may be used on a function member that would otherwise be implicitly `virtual`. Similarly, although `abstract` is the default on interface members without bodies, that modifier may be given explicitly. A non-virtual member may be declared using the `sealed` keyword. +An interface member whose declaration includes a body is a `virtual` member unless the `sealed` or `private` modifier is used. The `virtual` modifier may be used on a function member that would otherwise be implicitly `virtual`. Similarly, although `abstract` is the default on interface members without bodies, that modifier may be given explicitly. A non-virtual member may be declared using the `sealed` keyword. It is an error for a `private` or `sealed` function member of an interface to have no body. A `private` function member may not have the modifier `sealed`. @@ -95,15 +92,13 @@ Interfaces may not declare instance constructors, destructors, or fields. > ***Open Issue:*** Should `const` declarations be permitted in an interface? -> ***Closed Issue:*** We do not currently permit `partial` on an interface or its members. That would require a separate proposal. ***Decision***: Yes. https://github.com/dotnet/csharplang/blob/master/meetings/2018/LDM-2018-10-17.md#permit-partial-in-interface - +> ***Closed Issue:*** We do not currently permit `partial` on an interface or its members. That would require a separate proposal. ***Decision***: Yes. ### Overrides in interfaces -Override declarations (i.e. those containing the `override` modifier) allow the programmer to provide a most specific implementation of a virtual member in an interface where the compiler or runtime would not otherwise find one. It also allows turning an abstract member from a super-interface into a default member in a derived interface. An override declaration is permitted to *explicitly* override a particular base interface method by qualifying the declaration with the interface name (no access modifier is permitted in this case). Implicit overrides are not permitted. +Override declarations (i.e. those containing the `override` modifier) allow the programmer to provide a most specific implementation of a virtual member in an interface where the compiler or runtime would not otherwise find one. It also allows turning an abstract member from a super-interface into a default member in a derived interface. An override declaration is permitted to *explicitly* override a particular base interface method by qualifying the declaration with the interface name (no access modifier is permitted in this case). Implicit overrides are not permitted. - -``` c# +```csharp interface IA { void M() { WriteLine("IA.M"); } @@ -128,7 +123,7 @@ Public `virtual` function members in an interface may be overridden in a derived A virtual (concrete) method declared in an interface may be overridden to be abstract in a derived interface -``` c# +```csharp interface IA { void M() { WriteLine("IA.M"); } @@ -151,12 +146,13 @@ This is useful in derived interfaces where the default implementation of a metho We require that every interface and class have a *most specific override* for every virtual member among the overrides appearing in the type or its direct and indirect interfaces. The *most specific override* is a unique override that is more specific than every other override. If there is no override, the member itself is considered the most specific override. One override `M1` is considered *more specific* than another override `M2` if `M1` is declared on type `T1`, `M2` is declared on type `T2`, and either + 1. `T1` contains `T2` among its direct or indirect interfaces, or 2. `T2` is an interface type but `T1` is not an interface type. For example: -``` c# +```csharp interface IA { void M() { WriteLine("IA.M"); } @@ -182,7 +178,7 @@ The most specific override rule ensures that a conflict (i.e. an ambiguity arisi Because we support explicit abstract overrides in interfaces, we could do so in classes as well -``` c# +```csharp abstract class E : IA, IB, IC // ok { abstract void IA.M(); @@ -193,7 +189,7 @@ abstract class E : IA, IB, IC // ok In addition, it is an error if in a class declaration the most specific override of some interface method is an abstract override that was declared in an interface. This is an existing rule restated using the new terminology. -``` c# +```csharp interface IF { void M(); @@ -213,13 +209,11 @@ Because interfaces may now contain executable code, it is useful to abstract com > ***Open issue***: If we support static methods, should we support (static) operators? - ### Base interface invocations Code in a type that derives from an interface with a default method can explicitly invoke that interface's "base" implementation. - -``` c# +```csharp interface I0 { void M() { Console.WriteLine("I0"); } @@ -240,10 +234,9 @@ interface I3 : I1, I2 ``` - An instance (nonstatic) method is permitted to invoke the implementation of an accessible instance method in a direct base interface nonvirtually by naming it using the syntax `base(Type).M`. This is useful when an override that is required to be provided due to diamond inheritance is resolved by delegating to one particular base implementation. -``` c# +```csharp interface IA { void M() { WriteLine("IA.M"); } @@ -259,7 +252,7 @@ interface IC : IA class D : IA, IB, IC { - void IA.M() { base(IB).M(); } + void IA.M() { base(IB).M(); } } ``` @@ -271,7 +264,7 @@ The rules presented here are intended to have no effect on the meaning of existi Example 1: -``` c# +```csharp interface IA { void M(); @@ -284,7 +277,7 @@ class C: IA // Error: IA.M has no concrete most specific override in C Example 2: -``` c# +```csharp interface IA { void M(); @@ -301,7 +294,7 @@ class Derived: Base, IA // OK, all interface members have a concrete most specif The same rules give similar results to the analogous situation involving default interface methods: -``` c# +```csharp interface IA { void M() { } @@ -320,9 +313,9 @@ class Derived: IA // OK, all interface members have a concrete most specific ove ### CLR support API -In order for compilers to detect when they are compiling for a runtime that supports this feature, libraries for such runtimes are modified to advertise that fact through the API discussed in https://github.com/dotnet/corefx/issues/17116. We add +In order for compilers to detect when they are compiling for a runtime that supports this feature, libraries for such runtimes are modified to advertise that fact through the API discussed in . We add -``` c# +```csharp namespace System.Runtime.CompilerServices { public static class RuntimeFeature @@ -335,13 +328,10 @@ namespace System.Runtime.CompilerServices > ***Open issue***: Is that the best name for the *CLR* feature? The CLR feature does much more than just that (e.g. relaxes protection constraints, supports overrides in interfaces, etc). Perhaps it should be called something like "concrete methods in interfaces", or "traits"? - ### Further areas to be specified - [ ] It would be useful to catalog the kinds of source and binary compatibility effects caused by adding default interface methods and overrides to existing interfaces. - - ## Drawbacks [drawbacks]: #drawbacks @@ -356,7 +346,7 @@ None. [unresolved]: #unresolved-questions - Open questions are called out throughout the proposal, above. -- See also https://github.com/dotnet/csharplang/issues/406 for a list of open questions. +- See also for a list of open questions. - The detailed specification must describe the resolution mechanism used at runtime to select the precise method to be invoked. - The interaction of metadata produced by new compilers and consumed by older compilers needs to be worked out in detail. For example, we need to ensure that the metadata representation that we use does not cause the addition of a default implementation in an interface to break an existing class that implements that interface when compiled by an older compiler. This may affect the metadata representation that we can use. - The design must consider interoperation with other languages and existing compilers for other languages. @@ -367,7 +357,7 @@ None. The earlier draft spec contained the ability to "reabstract" an inherited method: -``` c# +```csharp interface IA { void M(); @@ -387,7 +377,7 @@ My notes for 2017-03-20 showed that we decided not to allow this. However, there 1. The Java APIs, with which some users of this feature hope to interoperate, depend on this facility. 2. Programming with *traits* benefits from this. Reabstraction is one of the elements of the "traits" language feature (https://en.wikipedia.org/wiki/Trait_(computer_programming)). The following is permitted with classes: -``` c# +```csharp public abstract class Base { public abstract void M(); @@ -406,24 +396,25 @@ Unfortunately this code cannot be refactored as a set of interfaces (traits) unl > ***Closed issue:*** Should reabstraction be permitted? [YES] My notes were wrong. The [LDM notes](https://github.com/dotnet/csharplang/blob/master/meetings/2017/LDM-2017-03-21.md) say that reabstraction is permitted in an interface. Not in a class. - ### Virtual Modifier vs Sealed Modifier From [Aleksey Tsingauz](https://github.com/AlekseyTs): -> We decided to allow modifiers explicitly stated on interface members, unless there is a reason to disallow some of them. This brings an interesting question around virtual modifier. Should it be required on members with default implementation? -> +> We decided to allow modifiers explicitly stated on interface members, unless there is a reason to disallow some of them. This brings an interesting question around virtual modifier. Should it be required on members with default implementation? +> > We could say that: -> - if there is no implementation and neither virtual, nor sealed are specified, we assume the member is abstract. -> - if there is an implementation and neither abstract, nor sealed are specified, we assume the member is virtual. -> - sealed modifier is required to make a method neither virtual, nor abstract. -> +> +> - if there is no implementation and neither virtual, nor sealed are specified, we assume the member is abstract. +> - if there is an implementation and neither abstract, nor sealed are specified, we assume the member is virtual. +> - sealed modifier is required to make a method neither virtual, nor abstract. +> > Alternatively, we could say that virtual modifier is required for a virtual member. I.e, if there is a member with implementation not explicitly marked with virtual modifier, it is neither virtual, nor abstract. This approach might provide better experience when a method is moved from a class to an interface: -> - an abstract method stays abstract. -> - a virtual method stays virtual. -> - a method without any modifier stays neither virtual, nor abstract. -> - sealed modifier cannot be applied to a method that is not an override. -> +> +> - an abstract method stays abstract. +> - a virtual method stays virtual. +> - a method without any modifier stays neither virtual, nor abstract. +> - sealed modifier cannot be applied to a method that is not an override. +> > What do you think? > ***Closed Issue:*** Should a concrete method (with implementation) be implicitly `virtual`? [YES] @@ -438,12 +429,11 @@ From [Aleksey Tsingauz](https://github.com/AlekseyTs): 6. Private classes (in interfaces) are permitted and can be sealed, and that means sealed in the class sense of sealed. 7. Absent a good proposal, partial is still not allowed on interfaces or their members. - ### Binary Compatibility 1 When a library provides a default implementation -``` c# +```csharp interface I1 { void M() { Impl1 } @@ -458,7 +448,7 @@ class C : I2 We understand that the implementation of `I1.M` in `C` is `I1.M`. What if the assembly containing `I2` is changed as follows and recompiled -``` c# +```csharp interface I2 : I1 { override void M() { Impl2 } @@ -479,7 +469,7 @@ but `C` is not recompiled. What happens when the program is run? An invocation o Consider this case: -``` c# +```csharp public interface I1 { event T e1; @@ -490,13 +480,13 @@ public interface I2 : I1 { add { } // error: "remove" accessor missing - } + } } ``` This "partial" implementation of the event is not permitted because, as in a class, the syntax for an event declaration does not permit only one accessor; both (or neither) must be provided. You could accomplish the same thing by permitting the abstract remove accessor in the syntax to be implicitly abstract by the absence of a body: -``` c# +```csharp public interface I1 { event T e1; @@ -507,7 +497,7 @@ public interface I2 : I1 { add { } remove; // implicitly abstract - } + } } ``` @@ -521,7 +511,7 @@ Note that *this is a new (proposed) syntax*. In the current grammar, event acces ***Closed Issue:*** We should confirm that this is permitted (otherwise adding a default implementation would be a breaking change): -``` c# +```csharp interface I1 { void M() { } @@ -547,14 +537,15 @@ The previous question implicitly assumes that the `sealed` modifier can be appli The draft of the proposal prefers class overrides to interface overrides in diamond inheritance scenarios: > We require that every interface and class have a *most specific override* for every interface method among the overrides appearing in the type or its direct and indirect interfaces. The *most specific override* is a unique override that is more specific than every other override. If there is no override, the method itself is considered the most specific override. -> +> > One override `M1` is considered *more specific* than another override `M2` if `M1` is declared on type `T1`, `M2` is declared on type `T2`, and either +> > 1. `T1` contains `T2` among its direct or indirect interfaces, or > 2. `T2` is an interface type but `T1` is not an interface type. The scenario is this -``` c# +```csharp interface IA { void M(); @@ -579,14 +570,13 @@ class Derived : Base, IB // allowed? We should confirm this behavior (or decide otherwise) -> ***Closed Issue:*** Confirm the draft spec, above, for *most specific override* as it applies to mixed classes and interfaces (a class takes priority over an interface). See https://github.com/dotnet/csharplang/blob/master/meetings/2017/LDM-2017-04-19.md#diamonds-with-classes - +> ***Closed Issue:*** Confirm the draft spec, above, for *most specific override* as it applies to mixed classes and interfaces (a class takes priority over an interface). See . ### Interface methods vs structs (closed) There are some unfortunate interactions between default interface methods and structs. -``` c# +```csharp interface IA { public void M() { } @@ -598,21 +588,21 @@ struct S : IA Note that interface members are not inherited: -``` c# +```csharp var s = default(S); s.M(); // error: 'S' does not contain a member 'M' ``` Consequently, the client must box the struct to invoke interface methods -``` c# +```csharp IA s = default(S); // an S, boxed s.M(); // ok ``` Boxing in this way defeats the principal benefits of a `struct` type. Moreover, any mutation methods will have no apparent effect, because they are operating on a *boxed copy* of the struct: -``` c# +```csharp interface IB { public void Increment() { P += 1; } @@ -630,12 +620,13 @@ Console.WriteLine(t.P); // prints 0 ``` > ***Closed Issue:*** What can we do about this: +> > 1. Forbid a `struct` from inheriting a default implementation. All interface methods would be treated as abstract in a `struct`. Then we may take time later to decide how to make it work better. > 2. Come up with some kind of code generation strategy that avoids boxing. Inside a method like `IB.Increment`, the type of `this` would perhaps be akin to a type parameter constrained to `IB`. In conjunction with that, to avoid boxing in the caller, non-abstract methods would be inherited from interfaces. This may increase compiler and CLR implementation work substantially. > 3. Not worry about it and just leave it as a wart. > 4. Other ideas? -***Decision:*** Not worry about it and just leave it as a wart. See https://github.com/dotnet/csharplang/blob/master/meetings/2017/LDM-2017-04-19.md#structs-and-default-implementations +***Decision:*** Not worry about it and just leave it as a wart. See . ### Base interface invocations (closed) @@ -643,12 +634,11 @@ The draft spec suggests a syntax for base interface invocations inspired by Java > ***Closed Issue:*** What is the syntax for a base member invocation? -***Decision:*** The syntax is `base(Interface).M()`. See https://github.com/dotnet/csharplang/blob/master/meetings/2017/LDM-2017-04-19.md#base-invocation. The interface so named must be a base interface, but does not need to be a direct base interface. +***Decision:*** The syntax is `base(Interface).M()`. See . The interface so named must be a base interface, but does not need to be a direct base interface. > ***Open Issue:*** Should base interface invocations be permitted in class members? -***Decision***: Yes. https://github.com/dotnet/csharplang/blob/master/meetings/2017/LDM-2017-04-19.md#base-invocation - +***Decision***: Yes. ### Overriding non-public interface members (closed) @@ -656,14 +646,15 @@ In an interface, non-public members from base interfaces are overridden using th > ***Closed Issue:*** If it is an "implicit" override that does not name the interface, does the access modifier have to match? -***Decision:*** Only public members may be implicitly overridden, and the access must match. See https://github.com/dotnet/csharplang/blob/master/meetings/2017/LDM-2017-04-18.md#dim-implementing-a-non-public-interface-member-not-in-list +***Decision:*** Only public members may be implicitly overridden, and the access must match. See . -> ***Open Issue:*** Is the access modifier required, optional, or omitted on an explicit override such as `override void IB.M() {}`? +> ***Open Issue:*** Is the access modifier required, optional, or omitted on an explicit override such as `override void IB.M() {}`? -> ***Open Issue:*** Is `override` required, optional, or omitted on an explicit override such as `void IB.M() {}`? +> ***Open Issue:*** Is `override` required, optional, or omitted on an explicit override such as `void IB.M() {}`? How does one implement a non-public interface member in a class? Perhaps it must be done explicitly? -``` c# + +```csharp interface IA { internal void MI(); @@ -677,17 +668,17 @@ class C : IA } ``` -> ***Closed Issue:*** How does one implement a non-public interface member in a class? +> ***Closed Issue:*** How does one implement a non-public interface member in a class? -***Decision:*** You can only implement non-public interface members explicitly. See https://github.com/dotnet/csharplang/blob/master/meetings/2017/LDM-2017-04-18.md#dim-implementing-a-non-public-interface-member-not-in-list +***Decision:*** You can only implement non-public interface members explicitly. See . -***Decision***: No `override` keyword permitted on interface members. https://github.com/dotnet/csharplang/blob/master/meetings/2018/LDM-2018-10-17.md#does-an-override-in-an-interface-introduce-a-new-member +***Decision***: No `override` keyword permitted on interface members. ### Binary Compatibility 2 (closed) Consider the following code in which each type is in a separate assembly -``` c# +```csharp interface I1 { void M() { Impl1 } @@ -706,7 +697,7 @@ class C : I2, I3 We understand that the implementation of `I1.M` in `C` is `I2.M`. What if the assembly containing `I3` is changed as follows and recompiled -``` c# +```csharp interface I3 : I1 { override void M() { Impl3 } @@ -721,7 +712,7 @@ but `C` is not recompiled. What happens when the program is run? An invocation o 4. Either 2 or 3, deterministically 5. Throws some kind of runtime exception -***Decision***: Throw an exception (5). See https://github.com/dotnet/csharplang/blob/master/meetings/2018/LDM-2018-10-17.md#issues-in-default-interface-methods +***Decision***: Throw an exception (5). See . ### Permit `partial` in interface? (closed) @@ -729,19 +720,19 @@ Given that interfaces may be used in ways analogous to the way abstract classes > ***Proposal:*** Remove the language restriction that interfaces and members of interfaces may not be declared `partial`. -***Decision***: Yes. See https://github.com/dotnet/csharplang/blob/master/meetings/2018/LDM-2018-10-17.md#permit-partial-in-interface +***Decision***: Yes. See . ### `Main` in an interface? (closed) > ***Open Issue:*** Is a `static Main` method in an interface a candidate to be the program's entry point? -***Decision***: Yes. See https://github.com/dotnet/csharplang/blob/master/meetings/2018/LDM-2018-10-17.md#main-in-an-interface +***Decision***: Yes. See . ### Confirm intent to support public non-virtual methods (closed) Can we please confirm (or reverse) our decision to permit non-virtual public methods in an interface? -``` c# +```csharp interface IA { public sealed void M() { } @@ -750,13 +741,13 @@ interface IA > ***Semi-Closed Issue:*** (2017-04-18) We think it is going to be useful, but will come back to it. This is a mental model tripping block. -***Decision***: Yes. https://github.com/dotnet/csharplang/blob/master/meetings/2018/LDM-2018-10-17.md#confirm-that-we-support-public-non-virtual-methods +***Decision***: Yes. . ### Does an `override` in an interface introduce a new member? (closed) There are a few ways to observe whether an override declaration introduces a new member or not. -``` c# +```csharp interface IA { void M(int x) { } @@ -781,26 +772,26 @@ In a class, an overriding method is "visible" in some senses. For example, the n Also, it is possible to "override" an override method? [Moot] -***Decision***: No `override` keyword permitted on interface members. https://github.com/dotnet/csharplang/blob/master/meetings/2018/LDM-2018-10-17.md#does-an-override-in-an-interface-introduce-a-new-member +***Decision***: No `override` keyword permitted on interface members. . ### Properties with a private accessor (closed) We say that private members are not virtual, and the combination of virtual and private is disallowed. But what about a property with a private accessor? -``` c# +```csharp interface IA { public virtual int P { get => 3; - private set => { } + private set => { } } } ``` Is this allowed? Is the `set` accessor here `virtual` or not? Can it be overridden where it is accessible? Does the following implicitly implement only the `get` accessor? -``` c# +```csharp class C : IA { public int P @@ -813,7 +804,7 @@ class C : IA Is the following presumably an error because IA.P.set isn't virtual and also because it isn't accessible? -``` c# +```csharp class C : IA { int IA.P @@ -824,8 +815,7 @@ class C : IA } ``` -***Decision***: The first example looks valid, while the last does not. This is resolved analogously to how it already works in C#. https://github.com/dotnet/csharplang/blob/master/meetings/2018/LDM-2018-10-17.md#properties-with-a-private-accessor - +***Decision***: The first example looks valid, while the last does not. This is resolved analogously to how it already works in C#. ### Base Interface Invocations, round 2 (closed) @@ -833,7 +823,7 @@ Our previous "resolution" to how to handle base invocations doesn't actually pro I propose the following syntax for base calls in interfaces. I’m not in love with it, but it illustrates what any syntax must be able to express: -``` c# +```csharp interface I1 { void M(); } interface I2 { void M(); } interface I3 : I1, I2 { void I1.M() { } void I2.M() { } } @@ -852,8 +842,10 @@ interface I5 : I3, I4 } } ``` + If there is no ambiguity, you can write it more simply -``` c# + +```csharp interface I1 { void M(); } interface I3 : I1 { void I1.M() { } } interface I4 : I1 { void I1.M() { } } @@ -866,8 +858,10 @@ interface I5 : I3, I4 } } ``` + Or -``` c# + +```csharp interface I1 { void M(); } interface I2 { void M(); } interface I3 : I1, I2 { void I1.M() { } void I2.M() { } } @@ -883,8 +877,10 @@ interface I5 : I3 } } ``` + Or -``` c# + +```csharp interface I1 { void M(); } interface I3 : I1 { void I1.M() { } } interface I5 : I3 @@ -896,21 +892,21 @@ interface I5 : I3 } ``` -***Decision***: Decided on `base(N.I1).M(s)`, conceding that if we have an invocation binding there may be problem here later on. https://github.com/dotnet/csharplang/blob/master/meetings/2018/LDM-2018-11-14.md#default-interface-implementations +***Decision***: Decided on `base(N.I1).M(s)`, conceding that if we have an invocation binding there may be problem here later on. ### Warning for struct not implementing default method? (closed) @vancem asserts that we should seriously consider producing a warning if a value type declaration fails to override some interface method, even if it would inherit an implementation of that method from an interface. Because it causes boxing and undermines constrained calls. -***Decision***: This seems like something more suited for an analyzer. It also seems like this warning could be noisy, since it would fire even if the default interface method is never called and no boxing will ever occur. https://github.com/dotnet/csharplang/blob/master/meetings/2018/LDM-2018-10-17.md#warning-for-struct-not-implementing-default-method +***Decision***: This seems like something more suited for an analyzer. It also seems like this warning could be noisy, since it would fire even if the default interface method is never called and no boxing will ever occur. ### Interface static constructors (closed) -When are interface static constructors run? The current CLI draft proposes that it occurs when the first static method or field is accessed. If there are neither of those then it might never be run?? +When are interface static constructors run? The current CLI draft proposes that it occurs when the first static method or field is accessed. If there are neither of those then it might never be run?? [2018-10-09 The CLR team proposes "Going to mirror what we do for valuetypes (cctor check on access to each instance method)"] -***Decision***: Static constructors are also run on entry to instance methods, if the static constructor was not `beforefieldinit`, in which case static constructors are run before access to the first static field. https://github.com/dotnet/csharplang/blob/master/meetings/2018/LDM-2018-10-17.md#when-are-interface-static-constructors-run +***Decision***: Static constructors are also run on entry to instance methods, if the static constructor was not `beforefieldinit`, in which case static constructors are run before access to the first static field. ## Design meetings @@ -925,4 +921,4 @@ When are interface static constructors run? The current CLI draft proposes that [2017-05-31 LDM Meeting Notes](https://github.com/dotnet/csharplang/blob/master/meetings/2017/LDM-2017-05-31.md) [2017-06-14 LDM Meeting Notes](https://github.com/dotnet/csharplang/blob/master/meetings/2017/LDM-2017-06-14.md) [2018-10-17 LDM Meeting Notes](https://github.com/dotnet/csharplang/blob/master/meetings/2018/LDM-2018-10-17.md) -[2018-11-14 LDM Meeting Notes](https://github.com/dotnet/csharplang/blob/master/meetings/2018/LDM-2018-11-14.md) +[2018-11-14 LDM Meeting Notes](https://github.com/dotnet/csharplang/blob/master/meetings/2018/LDM-2018-11-14.md) \ No newline at end of file diff --git a/proposals/fixed-sized-buffers.md b/proposals/fixed-sized-buffers.md index 0bc673e6..9697cec7 100644 --- a/proposals/fixed-sized-buffers.md +++ b/proposals/fixed-sized-buffers.md @@ -24,14 +24,13 @@ With a few minor tweaks, we could provide general-purpose fixed-sized buffers wh One would declare a safe fixed-sized buffer via the following: -```C# +```csharp public fixed DXGI_RGB GammaCurve[1025]; ``` The declaration would get translated into an internal representation by the compiler that is similar to the following -```C# - +```csharp [FixedBuffer(typeof(DXGI_RGB), 1024)] public ConsoleApp1.e__FixedBuffer_1024 GammaCurve; @@ -57,10 +56,10 @@ Since such fixed-sized buffers no longer require use of `fixed`, it makes sense ## Drawbacks [drawbacks]: #drawbacks -* There could be some challenges with backwards compatibility, but given that the existing fixed-sized buffers only work with a selection of primitive types, it should be possible for the compiler to continue "just-working" if the user treats the fixed-buffer as a pointer. +* There could be some challenges with backwards compatibility, but given that the existing fixed-sized buffers only work with a selection of primitive types, it should be possible for the compiler to continue "just-working" if the user treats the fixed-buffer as a pointer. * Incompatible constructs may need to use slightly different `v2` encoding to hide the fields from old compiler. * Packing is not well defined in IL spec for generic types. While the approach should work, we will be bordering on undocumented behavior. We should make that documented and make sure other JITs like Mono have the same behavior. -* Specifying a separate type for every length (an possibly another for `readonly` fields, if supported) will have impact on metadata. It will be bound by the number of arrays of different sizes in the given app. +* Specifying a separate type for every length (an possibly another for `readonly` fields, if supported) will have impact on metadata. It will be bound by the number of arrays of different sizes in the given app. * `ref` math is not formally verifiable (since it is unsafe). We will need to find a way to update verification rules to know that our use is ok. ## Alternatives @@ -79,4 +78,4 @@ Manually declare your structures and use unsafe code to construct indexers. ## Design meetings -Link to design notes that affect this proposal, and describe in one sentence for each what changes they led to. +Link to design notes that affect this proposal, and describe in one sentence for each what changes they led to. \ No newline at end of file