Merge pull request #3722 from ntrel/fn-type-alias

[spec] Improve function type (alias) docs

Signed-off-by: Dennis <[email protected]>
Merged-on-behalf-of: Dennis <[email protected]>

Author: dlang-bot

spec/declaration.dd

@@ -433,11 +433,12 @@ assert(S.j == 4);
 
 $(H3 $(LNAME2 alias-function, Aliasing a Function Type))
 
-        $(P Function types can be aliased:)
+        $(P $(DDSUBLINK spec/type, functions, Function types) can be
+        aliased:)
 
 $(SPEC_RUNNABLE_EXAMPLE_COMPILE
 ---
-alias Fun = int(string p);
+alias Fun = int(string);
 int fun(string) {return 0;}
 static assert(is(typeof(fun) == Fun));
 
@@ -450,34 +451,49 @@ static assert(is(MemberFun1 == MemberFun2));
         $(P Type aliases can be used to call a function with different default
         arguments, change an argument from required to default or vice versa:)
 
+$(SPEC_RUNNABLE_EXAMPLE_RUN
+-----------
+import std.stdio : writeln;
+
+void fun(int v = 6)
+{
+    writeln("v: ", v);
+}
+
+void main()
+{
+    fun();  // prints v: 6
+
+    alias Foo = void function(int=7);
+    Foo foo = &fun;
+    foo();  // prints v: 7
+    foo(8); // prints v: 8
+}
+-----------
+)
 $(SPEC_RUNNABLE_EXAMPLE_RUN
 -----------
 import std.stdio : writefln;
 
-void main() {
-    Foo foo = &foofoo;
-    foo();              // prints v: 6
-    foo(8);             // prints v: 8
-    Bar bar = &barbar;
+void main()
+{
+    fun(4);          // prints a: 4, b: 6, c: 7
+
+    Bar bar = &fun;
     //bar(4);           // compilation error, because the `Bar` alias
                         // requires an explicit 2nd argument
-    barbar(4);          // prints a: 4, b: 6, c: 7
     bar(4, 5);          // prints a: 4, b: 5, c: 9
     bar(4, 5, 6);       // prints a: 4, b: 5, c: 6
 
-    Baz baz = &barbar;
+    Baz baz = &fun;
     baz();              // prints a: 2, b: 3, c: 4
 }
 
-alias Foo = void function(int=6);
 alias Bar = void function(int, int, int=9);
 alias Baz = void function(int=2, int=3, int=4);
 
-void foofoo(int v = 6) {
-    writefln("v: %d", v);
-}
-
-void barbar(int a, int b = 6, int c = 7) {
+void fun(int a, int b = 6, int c = 7)
+{
     writefln("a: %d, b: %d, c: %d", a, b, c);
 }
 -----------

spec/type.dd

@@ -557,22 +557,24 @@ $(GRAMMAR_INFORMATIVE
 $(GLINK2 declaration, StorageClasses)$(OPT) $(GLINK Type) $(GLINK2 function, Parameters) $(GLINK2 function, FunctionAttributes)$(OPT)
 )
 
-$(P A function type e.g. `int(int)` is only used for type tests.
-A function type $(DDSUBLINK spec/declaration, alias-function, can be aliased).)
+$(P Function types are not included in the $(GLINK Type) grammar.
+A function type e.g. `int(int)` $(DDSUBLINK spec/declaration, alias-function, can be aliased).
+A function type is only used for type tests or as the target type of a pointer.)
 
 $(P Instantiating a function type is illegal. Instead, a pointer to function
 or delegate can be used. Those have these type forms respectively:)
 
 $(GRAMMAR_INFORMATIVE
-$(GLINK TypeCtor)$(OPT) $(GLINK BasicType) $(GLINK TypeSuffixes) `function` $(GLINK2 function, Parameters) $(GLINK2 function, FunctionAttributes)$(OPT)
-$(GLINK TypeCtor)$(OPT) $(GLINK BasicType) $(GLINK TypeSuffixes) `delegate` $(GLINK2 function, Parameters) $(GLINK2 function, MemberFunctionAttributes)$(OPT)
+$(GLINK Type) `function` $(GLINK2 function, Parameters) $(GLINK2 function, FunctionAttributes)$(OPT)
+$(GLINK Type) `delegate` $(GLINK2 function, Parameters) $(GLINK2 function, MemberFunctionAttributes)$(OPT)
 )
 
 $(SPEC_RUNNABLE_EXAMPLE_COMPILE
 ---
 void f(int);
-pragma(msg, typeof(f));  // void(int)
-pragma(msg, typeof(&f)); // void function(int)
+alias Fun = void(int);
+static assert(is(typeof(f) == Fun));
+static assert(is(Fun* == void function(int)));
 ---
 )