Introduce Common AutoCloseable & use #KT-31066
Co-authored-by: Ilya Gorbunov <Ilya.Gorbunov@jetbrains.com> Merge-request: KT-MR-8113 Merged-by: Abduqodiri Qurbonzoda <abduqodiri.qurbonzoda@jetbrains.com>
This commit is contained in:
Abduqodiri Qurbonzoda
committed by
Space Team
Space Team
parent
70cd547c26
commit
fff593492d
@@ -1,68 +0,0 @@
|
||||
/*
|
||||
* Copyright 2010-2017 JetBrains s.r.o.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")
|
||||
@file:JvmName("AutoCloseableKt")
|
||||
@file:kotlin.jvm.JvmPackageName("kotlin.jdk7")
|
||||
package kotlin
|
||||
|
||||
import kotlin.contracts.*
|
||||
|
||||
/**
|
||||
* Executes the given [block] function on this resource and then closes it down correctly whether an exception
|
||||
* is thrown or not.
|
||||
*
|
||||
* In case if the resource is being closed due to an exception occurred in [block], and the closing also fails with an exception,
|
||||
* the latter is added to the [suppressed][java.lang.Throwable.addSuppressed] exceptions of the former.
|
||||
*
|
||||
* @param block a function to process this [AutoCloseable] resource.
|
||||
* @return the result of [block] function invoked on this resource.
|
||||
*/
|
||||
@SinceKotlin("1.2")
|
||||
@kotlin.internal.InlineOnly
|
||||
public inline fun <T : AutoCloseable?, R> T.use(block: (T) -> R): R {
|
||||
contract {
|
||||
callsInPlace(block, InvocationKind.EXACTLY_ONCE)
|
||||
}
|
||||
var exception: Throwable? = null
|
||||
try {
|
||||
return block(this)
|
||||
} catch (e: Throwable) {
|
||||
exception = e
|
||||
throw e
|
||||
} finally {
|
||||
this.closeFinally(exception)
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Closes this [AutoCloseable], suppressing possible exception or error thrown by [AutoCloseable.close] function when
|
||||
* it's being closed due to some other [cause] exception occurred.
|
||||
*
|
||||
* The suppressed exception is added to the list of suppressed exceptions of [cause] exception.
|
||||
*/
|
||||
@SinceKotlin("1.2")
|
||||
@PublishedApi
|
||||
internal fun AutoCloseable?.closeFinally(cause: Throwable?) = when {
|
||||
this == null -> {}
|
||||
cause == null -> close()
|
||||
else ->
|
||||
try {
|
||||
close()
|
||||
} catch (closeException: Throwable) {
|
||||
cause.addSuppressed(closeException)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,53 @@
|
||||
/*
|
||||
* Copyright 2010-2022 JetBrains s.r.o. and Kotlin Programming Language contributors.
|
||||
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
|
||||
*/
|
||||
|
||||
@file:Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")
|
||||
@file:kotlin.jvm.JvmName("AutoCloseableKt")
|
||||
@file:kotlin.jvm.JvmPackageName("kotlin.jdk7")
|
||||
|
||||
package kotlin
|
||||
|
||||
import kotlin.contracts.InvocationKind
|
||||
import kotlin.contracts.contract
|
||||
|
||||
// TODO: Introduce this typealias when Common AutoCloseable is stabilized.
|
||||
// This typealias shadows existing java.lang.AutoCloseable, and the experimental status would require
|
||||
// opt-in in exiting usages (that are w/o package prefix). Hence it would break previously compilable code.
|
||||
//@Suppress("ACTUAL_WITHOUT_EXPECT")
|
||||
//@SinceKotlin("1.8")
|
||||
//public actual typealias AutoCloseable = java.lang.AutoCloseable
|
||||
|
||||
@Suppress("ACTUAL_WITHOUT_EXPECT")
|
||||
@SinceKotlin("1.2")
|
||||
@kotlin.internal.InlineOnly
|
||||
// TODO: remove java.lang package prefix when the kotlin.AutoCloseable typealias is introduced and KT-55392 is fixed.
|
||||
// The prefix is currently needed for the current dokka to generate correct signature.
|
||||
public actual inline fun <T : java.lang.AutoCloseable?, R> T.use(block: (T) -> R): R {
|
||||
contract {
|
||||
callsInPlace(block, InvocationKind.EXACTLY_ONCE)
|
||||
}
|
||||
var exception: Throwable? = null
|
||||
try {
|
||||
return block(this)
|
||||
} catch (e: Throwable) {
|
||||
exception = e
|
||||
throw e
|
||||
} finally {
|
||||
this.closeFinally(exception)
|
||||
}
|
||||
}
|
||||
|
||||
@SinceKotlin("1.2")
|
||||
@PublishedApi
|
||||
internal fun java.lang.AutoCloseable?.closeFinally(cause: Throwable?) = when {
|
||||
this == null -> {}
|
||||
cause == null -> close()
|
||||
else ->
|
||||
try {
|
||||
close()
|
||||
} catch (closeException: Throwable) {
|
||||
cause.addSuppressed(closeException)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
/*
|
||||
* Copyright 2010-2022 JetBrains s.r.o. and Kotlin Programming Language contributors.
|
||||
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
|
||||
*/
|
||||
|
||||
package kotlin.jdk7.test
|
||||
|
||||
import test.platformNull
|
||||
import java.io.*
|
||||
import kotlin.test.*
|
||||
|
||||
class UseAutoCloseableResourceJVMTest {
|
||||
|
||||
class Resource : AutoCloseable {
|
||||
override fun close() {
|
||||
error("Unreachable")
|
||||
}
|
||||
}
|
||||
|
||||
@Test fun platformResourceOpFails() {
|
||||
val resource = platformNull<Resource>()
|
||||
val e = assertFails {
|
||||
resource.use { requireNotNull(it) }
|
||||
}
|
||||
assertTrue(e is IllegalArgumentException)
|
||||
assertTrue(e.suppressed.isEmpty())
|
||||
}
|
||||
}
|
||||
@@ -1,125 +0,0 @@
|
||||
/*
|
||||
* Copyright 2010-2019 JetBrains s.r.o. and Kotlin Programming Language contributors.
|
||||
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
|
||||
*/
|
||||
|
||||
package kotlin.jdk7.test
|
||||
|
||||
import test.platformNull
|
||||
import java.io.*
|
||||
import kotlin.test.*
|
||||
|
||||
class UseAutoCloseableResourceTest {
|
||||
|
||||
class Resource(val faultyClose: Boolean = false) : AutoCloseable {
|
||||
|
||||
var isClosed = false
|
||||
private set
|
||||
|
||||
override fun close() {
|
||||
if (faultyClose)
|
||||
throw IOException("Close failed")
|
||||
isClosed = true
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@Test fun success() {
|
||||
val resource = Resource()
|
||||
val result = resource.use { "ok" }
|
||||
assertEquals("ok", result)
|
||||
assertTrue(resource.isClosed)
|
||||
}
|
||||
|
||||
@Test fun closeFails() {
|
||||
val e = assertFails {
|
||||
Resource(faultyClose = true).use { it.isClosed }
|
||||
}
|
||||
assertTrue(e is IOException)
|
||||
}
|
||||
|
||||
@Test fun opFailsCloseSuccess() {
|
||||
val e = assertFails {
|
||||
Resource().use { error("op fail") }
|
||||
}
|
||||
assertTrue(e is IllegalStateException)
|
||||
assertTrue(e.suppressed.isEmpty())
|
||||
}
|
||||
|
||||
@Test fun opFailsCloseFails() {
|
||||
val e = assertFails {
|
||||
Resource(faultyClose = true).use { error("op fail") }
|
||||
}
|
||||
assertTrue(e is IllegalStateException)
|
||||
assertTrue(e.suppressed.single() is IOException)
|
||||
}
|
||||
|
||||
@Test fun opFailsCloseFailsTwice() {
|
||||
val e = assertFails {
|
||||
Resource(faultyClose = true).use { _ ->
|
||||
Resource(faultyClose = true).use { _ ->
|
||||
error("op fail")
|
||||
}
|
||||
}
|
||||
}
|
||||
assertTrue(e is IllegalStateException)
|
||||
val suppressed = e.suppressed
|
||||
assertEquals(2, suppressed.size)
|
||||
assertTrue(suppressed.all { it is IOException })
|
||||
}
|
||||
|
||||
@Test fun nonLocalReturnInBlock() {
|
||||
fun Resource.operation(nonLocal: Boolean): String {
|
||||
return use { if (nonLocal) return "nonLocal" else "local" }
|
||||
}
|
||||
|
||||
Resource().let { resource ->
|
||||
val result = resource.operation(nonLocal = false)
|
||||
assertEquals("local", result)
|
||||
assertTrue(resource.isClosed)
|
||||
}
|
||||
|
||||
Resource().let { resource ->
|
||||
val result = resource.operation(nonLocal = true)
|
||||
assertEquals("nonLocal", result)
|
||||
assertTrue(resource.isClosed)
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@Test fun nullableResourceSuccess() {
|
||||
val resource: Resource? = null
|
||||
val result = resource.use { "ok" }
|
||||
assertEquals("ok", result)
|
||||
}
|
||||
|
||||
@Test fun nullableResourceOpFails() {
|
||||
val resource: Resource? = null
|
||||
val e = assertFails {
|
||||
resource.use { requireNotNull(it) }
|
||||
}
|
||||
assertTrue(e is IllegalArgumentException)
|
||||
assertTrue(e.suppressed.isEmpty())
|
||||
}
|
||||
|
||||
@Test fun platformResourceOpFails() {
|
||||
val resource = platformNull<Resource>()
|
||||
val e = assertFails {
|
||||
resource.use { requireNotNull(it) }
|
||||
}
|
||||
assertTrue(e is IllegalArgumentException)
|
||||
assertTrue(e.suppressed.isEmpty())
|
||||
}
|
||||
|
||||
|
||||
@Test
|
||||
fun contractCallsInPlace() {
|
||||
val i: Int
|
||||
Resource().use { _ ->
|
||||
Resource().use { _ ->
|
||||
i = 1
|
||||
}
|
||||
}
|
||||
assertEquals(1, i)
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user