aboutsummaryrefslogtreecommitdiff
path: root/core/src/main/kotlin/ca/allanwang/kau/utils/CoroutineUtils.kt
blob: 741f4e22f7453de43483535d35b96aa184ed5bf0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/*
 * Copyright 2019 Allan Wang
 *
 * 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.
 */
package ca.allanwang.kau.utils

import android.content.Context
import android.os.Handler
import android.os.Looper
import ca.allanwang.kau.internal.KauBaseActivity
import kotlin.coroutines.CoroutineContext
import kotlin.coroutines.EmptyCoroutineContext
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.CoroutineStart
import kotlinx.coroutines.android.asCoroutineDispatcher
import kotlinx.coroutines.async
import kotlinx.coroutines.launch
import kotlinx.coroutines.withContext

object ContextHelper : CoroutineScope {

    val looper = Looper.getMainLooper()

    val handler = Handler(looper)

    /**
     * Creating dispatcher from main handler to avoid IO
     * See https://github.com/Kotlin/kotlinx.coroutines/issues/878
     */
    val dispatcher = handler.asCoroutineDispatcher("kau-main")

    override val coroutineContext: CoroutineContext get() = dispatcher
}

/**
 * Most context items implement [CoroutineScope] by default (through [KauBaseActivity]).
 * We will add a fallback just in case.
 * It is expected that the scope returned always has the Android main dispatcher as part of the context.
 */
inline val Context.ctxCoroutine: CoroutineScope
    get() = this as? CoroutineScope ?: ContextHelper

/**
 * Calls [launch] with an explicit dispatcher for Android's main thread
 */
fun CoroutineScope.launchMain(
    context: CoroutineContext = EmptyCoroutineContext,
    start: CoroutineStart = CoroutineStart.DEFAULT,
    block: suspend CoroutineScope.() -> Unit
) = launch(ContextHelper.dispatcher + context, start, block)

/**
 * Calls [async] with an explicit dispatcher for Android's main thread
 */
fun CoroutineScope.asyncMain(
    context: CoroutineContext = EmptyCoroutineContext,
    start: CoroutineStart = CoroutineStart.DEFAULT,
    block: suspend CoroutineScope.() -> Unit
) = async(ContextHelper.dispatcher + context, start, block)

/**
 * Calls [withContext] with an explicit dispatcher for Android's main thread
 */
suspend fun <T> withMainContext(block: suspend CoroutineScope.() -> T) =
    withContext(ContextHelper.dispatcher, block)