I have this struct (simplified for brevity):
public struct Period
{
public Period(DateTime? start, DateTime? end) : this()
{
if (end.HasValue && start.HasValue && end.Value < start.Value)
{
throw new ArgumentOutOfRangeException("end", "...");
}
Contract.EndContractBlock();
this.start = start;
this.end = end;
}
private readonly DateTime? start;
private readonly DateTime? end;
public static Period operator +(Period p, TimeSpan t)
{
Contract.Assume(!p.start.HasValue || !p.end.HasValue || p.start.Value <= p.end.Value);
return new Period(
p.start.HasValue ? p.start.Value + t : (DateTime?) null,
p.end.HasValue ? p.end.Value + t : (DateTime?) null);
}
}
But the static checker is giving me this warning:
CodeContracts: requires unproven: end.HasValue && start.HasValue && end.Value >= start.Value
This requirement that it inferred from the custom parameter validation is just plain wrong. I want to allow null values for start or end, and only require start <= end if both are provided. However, if I change the constructor to this:
public Period(DateTime? start, DateTime? end) : this()
{
Contract.Requires(!start.HasValue || !end.HasValue || start.Value <= end.Value);
this.start = start;
this.end = end;
}
I get this warning, which looks more correct, but it's hard to see why the requires can't be proven:
CodeContracts: requires unproven: !start.HasValue || !end.HasValue || start.Value <= end.Value
I thought it might be having trouble with the ?:, but this warning is still there when I change the operator to:
public static Period operator +(Period p, TimeSpan t)
{
var start = p.start.HasValue ? p.start.Value + t : (DateTime?) null;
var end = p.end.HasValue ? p.end.Value + t : (DateTime?) null;
Contract.Assume(!start.HasValue || !end.HasValue || start.Value <= end.Value);
return new Period(start, end);
}
And of course, if I change that .Requires to .Assume, the warning goes away completely, but that's not an acceptable solution.
So it appears that the static checker in Code Contracts is not able to invert the condition correctly. Rather than simply inverting the condition by wrapping it with !(…) or applying De Morgan's law (as shown above), it appears to be inverting just the last component of the condition. Is the static checker unable to correctly interpret complex conditionals when using custom parameter validation?
Interestingly, I tried this, thinking the static checker would just strip the ! off the front, but no:
if (!(!start.HasValue || !end.HasValue || start.Value <= end.Value))
{
throw new ArgumentOutOfRangeException("end", "...");
}
Contract.EndContractBlock();
CodeContracts: requires unproven: !(!(!start.HasValue || !end.HasValue || start.Value <= end.Value))
In this case, it did just wrap the whole condition with !(…), even though it didn't have to.
Also, if I change the nullable DateTime's to just plain non-nullable DateTime's and rewrite the contracts like this, it works as expected without any warnings:
public struct Period
{
public Period(DateTime start, DateTime end) : this()
{
Contract.Requires(start <= end);
this.start = start;
this.end = end;
}
private readonly DateTime start;
private readonly DateTime end;
public static Period operator +(Period p, TimeSpan t)
{
Contract.Assume(p.start + t <= p.end + t); // or use temp variables
return new Period(p.start + t <= p.end + t);
}
}
But simply using Contract.Assume(p.start <= p.end) won't work.
CodeContracts: requires unproven: start <= end
.Requiresit still generates an warning, it uses the exact condition text that I provided. This also introduces the possibility that it might not be a bug in the type checker, but just a bug in how it creates the warning text. - p.s.w.g.Requires(start <= end). When I changed it to use custom parameter validation withif (start > end) …it gave merequires unproved: start <= end, but then I triedif (!(start <= end)) …and it worked perfectly. I think your assessment about<=vs.>is correct; the code that generates the message appears to assume!(x > y)→x <= y, but the actual checker does not. Although there's also probably something else going on here related to the AND's and OR's. - p.s.w.g