[swift-evolution] deinit and failable initializers

[Jean-Daniel Dupas]

Forcing usage of local variable don’t solve the code duplication issue.
You will still have to replicate the deinit logic in the initializer (to release resources used by temporary local variable instead of member variables, but this is the same).


> Le 27 janv. 2016 à 10:26, Kostiantyn Koval via swift-evolution <swift-evolution at swift.org> a écrit :
> 
> In my opinion deinit should be called only for objets that we fully initialized successfully (as it works now).
> How about allowing early return only when no properties were initialized. 
> 
> The possible problem with this solution is that complex initializers would need to store intermediate results in local variables before assigning them to properties.
> Example: 
> 
> struct MyArray<T> {
>   var pointer: UnsafeMutablePointer<T>
>   var capacity: Int
> 
>   init?(capacity: Int) {
>     self.pointer = UnsafeMutablePointer.alloc(capacity)
>     if capacity > 100 {
>       return nil // Error. Can't return nil after partial initialization. 
>     }
>     self.capacity = capacity
>   }
> 
>   init?(capacity: Int) {
>     if capacity > 100 {
>       return nil // This is ok, early return before initializing any property
>     }
>     self.pointer = UnsafeMutablePointer.alloc(capacity)
>     self.capacity = capacity
>   }
> }
> 
> Kostiantyn
> 
>> On 27 Jan 2016, at 02:40, Joseph Lord via swift-evolution <swift-evolution at swift.org <mailto:swift-evolution at swift.org>> wrote:
>> 
>> I think that there is risk here but I don't think it is serious enough one to be with making changes for.
>> 
>> 1. For most classes there is no problem because everything is managed by ARC anyway so will clean up without special consideration (few of my classes require a deinit). 
>> 2. It doesn't seem surprising that if init did not succeed that deinit will not run.
>> 
>> I suppose the risk is greatest where the nil is a result of a returned value from a call made being passed up as explicit `return nil` or `throw` are more visible. 
>> 
>> If something were to be changed I wonder if in cases where a failable init exists in a class with a deinit the init could still be responsible for the clean up but must also call an special empty function to confirm to compiler that the situation has been handled. Not sure on name but maybe `deinited()`. Maybe it would just be a warning if not called. Treatment could maybe be similar to warnings where super calls are not made.
>> 
>> Joseph
>> 
>> 
>> On Jan 26, 2016, at 9:39 PM, Chris Eidhof via swift-evolution <swift-evolution at swift.org <mailto:swift-evolution at swift.org>> wrote:
>> 
>>> Absolutely, I agree with you. Of course, this was a simplified example, you can easily construct an example where just reordering isn’t going to cut it.
>>> 
>>> It’s not hard to do things right in the current model. We can reorder statements, write wrappers, or think of different solutions altogether. Once you understand how it works, it’s very easy to write correct code.
>>> 
>>> However, my complaint is that it’s now also easy to make a mistake. In the previous model, it wasn’t so easy (the previous model was simpler: an init would always be matched by a deinit).
>>> 
>>> On Tue, Jan 26, 2016 at 6:39 PM, Douglas Gregor <dgregor at apple.com <mailto:dgregor at apple.com>> wrote:
>>> 
>>>> On Jan 26, 2016, at 9:15 AM, Chris Eidhof via swift-evolution <swift-evolution at swift.org <mailto:swift-evolution at swift.org>> wrote:
>>>> 
>>>> Now that we can return nil from a failable initializer without having initialized all the properties, it’s easier to make a mistake. For example, consider the following (artificial) code:
>>>> 
>>>> class MyArray<T> {
>>>>     var pointer: UnsafeMutablePointer<T>
>>>>     var capacity: Int
>>>>     
>>>>     init?(capacity: Int) {
>>>>         pointer = UnsafeMutablePointer.alloc(capacity)
>>>>         if capacity > 100 {
>>>>             // Here we should also free the memory. In other words, duplicate the code from deinit.
>>>>             return nil
>>>>         }
>>>>         self.capacity = capacity
>>>>         
>>>>     }
>>>>     
>>>>     deinit {
>>>>         pointer.destroy(capacity)
>>>>     }
>>>> }
>>>> 
>>>> In the `return nil` case, we should really free the memory allocated by the pointer. Or in other words, we need to duplicate the behavior from the deinit.
>>>> 
>>>> Before Swift 2.2, this mistake wasn’t possible, because we knew that we could count on deinit being called, *always*. With the current behavior, return `nil` is easier, but it does come at the cost of accidentally introducing bugs. As Joe Groff pointed out, a solution would be to have something like “deferOnError” (or in this case, “deferOnNil”), but that feels a bit heavy-weight to me (and you still have to duplicate code).
>>>> 
>>>> In any case, I think it’s nice that we can now return nil earlier. I don’t like that it goes at the cost of safety, but I realize it’s probably only making things less safe in a small amount of edge cases.
>>> 
>>> Let’s re-order the statements in your example:
>>> 
>>> class MyArray<T> {
>>>     var pointer: UnsafeMutablePointer<T>
>>>     var capacity: Int
>>> 
>>>     init?(capacity: Int) {
>>>         if capacity > 100 {
>>>             // Here we should also free the memory. In other words, duplicate the code from deinit.
>>>             return nil
>>>         }
>>>         self.capacity = capacity
>>>         pointer = UnsafeMutablePointer.alloc(capacity)
>>>     }
>>>     
>>>     deinit {
>>>         pointer.destroy(capacity)
>>>     }
>>> }
>>> 
>>> If the initializer returns ‘nil’ and we still call deinit, we end up destroying a pointer that was never allocated.
>>> 
>>> If you come from an Objective-C background, you might expect implicit zeroing of the allocated block to help here. However, Swift doesn’t have that, because many Swift types don’t have a “zero” state that’s safe to destroy. For example, anything with a member of non-optional reference type, e.g.,
>>> 
>>> class ClassWrapper {
>>>   var array: MyArray<String>
>>> 
>>>   init(array: MyArray<String>) {
>>>     self.array = array
>>>   }
>>> 
>>>   deinit {
>>>     print(array) // array is a valid instance of MyArray<String>
>>>   }
>>> }
>>> 
>>> A valid ClassWrapper instance will always have an instance of MyArray<String>, even throughout its deinitializer.
>>> 
>>> The basic property here is that one cannot run a deinitializer on an instance that hasn’t been fully constructed (all the way up the class hierarchy).
>>> 
>>> 	- Doug
>>> 
>>> 
>>> 
>>> 
>>> 
>>> -- 
>>> Chris Eidhof
>>> _______________________________________________
>>> swift-evolution mailing list
>>> swift-evolution at swift.org <mailto:swift-evolution at swift.org>
>>> https://lists.swift.org/mailman/listinfo/swift-evolution <https://lists.swift.org/mailman/listinfo/swift-evolution>
>> _______________________________________________
>> swift-evolution mailing list
>> swift-evolution at swift.org <mailto:swift-evolution at swift.org>
>> https://lists.swift.org/mailman/listinfo/swift-evolution
> 
> _______________________________________________
> swift-evolution mailing list
> swift-evolution at swift.org
> https://lists.swift.org/mailman/listinfo/swift-evolution

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.swift.org/pipermail/swift-evolution/attachments/20160127/30521bf3/attachment.html>