D issues are now tracked on GitHub. This Bugzilla instance remains as a read-only archive.
Issue 3646 - Default values of function arguments are ignored when instantiating a template.
Summary: Default values of function arguments are ignored when instantiating a template.
Status: RESOLVED FIXED
Alias: None
Product: D
Classification: Unclassified
Component: dmd (show other issues)
Version: D2
Hardware: All All
: P2 normal
Assignee: yebblies
URL:
Keywords: accepts-invalid, pull, spec
: 4028 5456 8336 (view as issue list)
Depends on:
Blocks: 340
  Show dependency treegraph
 
Reported: 2009-12-25 01:02 UTC by Eldar Insafutdinov
Modified: 2013-07-04 04:51 UTC (History)
7 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this issue.
Description Eldar Insafutdinov 2009-12-25 01:02:49 UTC
void foo(Fn)(Fn fn)
{
    fn();
}

void bar(int i = 22) {
    writeln("bar ", i);
}
void bam(int i) {
    writeln("bam ", i);
}

void baz() {
    foo(&bar);
    foo(&bam);
}

This code compiles while it should not. You cannot call bam() without any arguments. If you switch the instantiations and call foo(&bam) first - it does not compile.


pragma(msg, typeof(&bar).stringof);
pragma(msg, typeof(&bam).stringof);

outputs

void function(int i = 22)
void function(int i)


But it is not respected by the template.
Comment 1 Koroskin Denis 2009-12-25 08:32:32 UTC
This is a bit more tricky than it looks like.

The question here is, how many times should foo be instanciated?
DMD answers "just 1 time", and I agree with it, since bar and bam have same signature and mangling.

Having only one instantiation means that code for it will also be generated once.

When you call a function that has default argument without providing that argument, the call is actually *rewritten to include that argument*. I.e. bar(); is rewritten as bar(22);

Not lets see how foo!(bar) looks like after a rewrite:

void foo(Fn)(Fn fn)
{
    fn(22);
}

Now there is no wonder why dmd behaves like this.

But this only happens if foo!(bar) is instanciated before foo!(bam), because when templates are instantiates on first use. When you instanciate foo!(bam) first, it doesn't get rewritten and therefore fails to compile.

I guess the only fix for this issue would be to create an implicit trampoline to invoke functions with default arguments, but only Walter can say for sure.
Comment 2 Eldar Insafutdinov 2009-12-26 12:51:57 UTC
(In reply to comment #1)
> This is a bit more tricky than it looks like.
> 
> The question here is, how many times should foo be instanciated?
> DMD answers "just 1 time", and I agree with it, since bar and bam have same
> signature and mangling.
 
> But this only happens if foo!(bar) is instanciated before foo!(bam), because
> when templates are instantiates on first use. When you instanciate foo!(bam)
> first, it doesn't get rewritten and therefore fails to compile.
> 
> I guess the only fix for this issue would be to create an implicit trampoline
> to invoke functions with default arguments, but only Walter can say for sure.

Yeah, that was pretty much what I was thinking about. The issue cuts down to a question, should Foo be instantiated once or are the function types equal? For binary size and efficiency purposes I agree that there should be one instantiation. On the other hand for meta programming and code generation which is what I am doing I would like to have them as separate types, as I don't want to loose this information. Walter or Andrei would probably have to comment on this issue.
Comment 3 Stewart Gordon 2010-01-03 08:53:39 UTC
I've never heard of default arguments being part of the function type's properties.  I'd probably guessed that the type is simply void function(int) but default arguments are filled in on the caller side.  In which case the functions are the same type, and so this isn't meant to work.  Either way, it's certainly a bug that the code is accepted.

And it applies to D1 too, but the code needs changing a bit:
----------
import std.stdio;

void foo(Fn)(Fn fn) {
    fn();
}

void bar(int i = 22) {
    writefln("bar ", i);
}
void bam(int i) {
    writefln("bam ", i);
}

void main() {
    foo(&bar);
    foo(&bam);
}
----------
Comment 4 yebblies 2011-07-03 05:22:51 UTC
*** Issue 4028 has been marked as a duplicate of this issue. ***
Comment 5 yebblies 2011-07-03 05:23:21 UTC
*** Issue 5456 has been marked as a duplicate of this issue. ***
Comment 7 Stewart Gordon 2011-07-03 08:42:20 UTC
(In reply to comment #1)
> Not lets see how foo!(bar) looks like after a rewrite:
> 
> void foo(Fn)(Fn fn)
> {
>     fn(22);
> }

Actually, before this rewrite comes substituting in the template argument.

    void fooInstance(void function(int = 22) fn)
    {
        fn();
    }

which then becomes

    void fooInstance(void function(int) fn)
    {
        fn(22);
    }

> Now there is no wonder why dmd behaves like this.

But it makes sense only if there are actually two template instances involved.  The essence of the bug is that, after it has instantiated foo with argument void function(int = 22), the compiler matches any attempt to instantiate foo with a void function(int), with or without a default argument, to this instance.

(In reply to comment #2)
> Yeah, that was pretty much what I was thinking about.  The issue 
> cuts down to a question, should Foo be instantiated once or are the 
> function types equal?  For binary size and efficiency purposes I 
> agree that there should be one instantiation.  On the other hand 
> for meta programming and code generation which is what I am doing I 
> would like to have them as separate types, as I don't want to loose 
> this information.  Walter or Andrei would probably have to comment 
> on this issue.

But this seems to me a rare use case.  And you can do it with an alias template parameter, though this does create a separate instance for each function name:
----------
import std.stdio;

void foo(alias fn)() {
    fn();
    fn(42);
}

void bar(int i = 22) {
    writefln("bar %d", i);
}
void bam(int i) {
    writefln("bam %d", i);
}
void quux() {
    writefln("quux");
}
void quux(int i) {
    writefln("quux %d", i);
}

void main() {
    foo!(bar)();    // works
    //foo!(bam)();  // correctly triggers compiler error (1.068 Win32)
    foo!(quux)();   // works with overloads as well
}
----------

I can see three possible ways to resolve this issue:

(a) Default arguments aren't part of the function type.  Then only one template instance exists: foo!(void function(int)).  The template instance is then illegal, since it tries to call a void function(int) with no arguments.

(b) Default arguments are part of the function type.  Then there are two template instances: 
    foo(&bar) is foo!(void function(int = 22))
    foo(&bam) is foo!(void function(int))

Then foo(&bar) is legal: foo(&bar)() calls bar(22)
 and foo(&bam) is illegal

(c) Default arguments are part of the function type, but can be optimised away.  Essentially, we detect while instantiating the template whether the template body makes use of a default argument.  If so, create a separate instance for each default argument or absence thereof.  Otherwise, create only one instance.  Not sure whether this is desirable.
Comment 8 yebblies 2012-02-11 18:57:19 UTC
This has the same causes (and same solutions) as issue 3866.
Comment 9 Mike Parker 2012-06-17 22:02:35 UTC
Somehow I managed to change the settings on the wrong bug. Sorry for the noise.
Comment 10 Jonathan M Davis 2012-07-02 08:34:37 UTC
*** Issue 8336 has been marked as a duplicate of this issue. ***
Comment 11 Kenji Hara 2012-09-05 18:53:52 UTC
D2 pull:
https://github.com/D-Programming-Language/dmd/pull/1102
Comment 12 github-bugzilla 2013-07-04 03:03:45 UTC
Commits pushed to master at https://github.com/D-Programming-Language/dmd

https://github.com/D-Programming-Language/dmd/commit/877e7bfd7c29fb016323934bb04bd3420bffe5c7
Default args and arg identifiers are now volatile information in TypeFunction.

1. The extra informations would be kept after semantic analysis for function pointer and delegate types. But merging type would strip all the extras from the type structure, then cache the stripped copy into.

2. The types has extra informations cannot be named. In other words, AliasDeclaration would always strip the aliased type. This rule also works for Template Type Parameter, and fixes issue 3646 well.

3. CondExp would strip them from the type of its result.

https://github.com/D-Programming-Language/dmd/commit/bce2d07d6cd2c09a5153afc65260b63c32447ade
fix Issue 3646 - Default values of function arguments are ignored when instantiating a template.
Comment 13 Kenji Hara 2013-07-04 04:51:50 UTC
Right now, default argument is changed to not part of function type in D2.