/
SearchViewQueryTextChanges.kt
151 lines (141 loc) · 4.71 KB
/
SearchViewQueryTextChanges.kt
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*
* Copyright 2019 Vladimir Raupov
*
* 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 ru.ldralighieri.corbind.appcompat
import androidx.annotation.CheckResult
import androidx.appcompat.widget.SearchView
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.channels.Channel
import kotlinx.coroutines.channels.ReceiveChannel
import kotlinx.coroutines.channels.actor
import kotlinx.coroutines.channels.awaitClose
import kotlinx.coroutines.coroutineScope
import kotlinx.coroutines.flow.channelFlow
import kotlinx.coroutines.isActive
import ru.ldralighieri.corbind.internal.InitialValueFlow
import ru.ldralighieri.corbind.internal.asInitialValueFlow
import ru.ldralighieri.corbind.internal.corbindReceiveChannel
/**
* Perform an action on character sequences for query text changes on [SearchView].
*
* *Warning:* The created actor uses [SearchView.setOnQueryTextListener]. Only one actor can be used
* at a time.
*
* @param scope Root coroutine scope
* @param capacity Capacity of the channel's buffer (no buffer by default)
* @param action An action to perform
*/
fun SearchView.queryTextChanges(
scope: CoroutineScope,
capacity: Int = Channel.RENDEZVOUS,
action: suspend (CharSequence) -> Unit
) {
val events = scope.actor<CharSequence>(Dispatchers.Main.immediate, capacity) {
for (chars in channel) action(chars)
}
events.trySend(query)
setOnQueryTextListener(listener(scope, events::trySend))
events.invokeOnClose { setOnQueryTextListener(null) }
}
/**
* Perform an action on character sequences for query text changes on [SearchView], inside new
* [CoroutineScope].
*
* *Warning:* The created actor uses [SearchView.setOnQueryTextListener]. Only one actor can be used
* at a time.
*
* @param capacity Capacity of the channel's buffer (no buffer by default)
* @param action An action to perform
*/
suspend fun SearchView.queryTextChanges(
capacity: Int = Channel.RENDEZVOUS,
action: suspend (CharSequence) -> Unit
) = coroutineScope {
queryTextChanges(this, capacity, action)
}
/**
* Create a channel of character sequences for query text changes on [SearchView].
*
* *Warning:* The created channel uses [SearchView.setOnQueryTextListener]. Only one channel can be
* used at a time.
*
* *Note:* A value will be emitted immediately.
*
* Example:
*
* ```
* launch {
* searchView.queryTextChanges(scope)
* .consumeEach { /* handle query text change */ }
* }
* ```
*
* @param scope Root coroutine scope
* @param capacity Capacity of the channel's buffer (no buffer by default)
*/
@CheckResult
fun SearchView.queryTextChanges(
scope: CoroutineScope,
capacity: Int = Channel.RENDEZVOUS
): ReceiveChannel<CharSequence> = corbindReceiveChannel(capacity) {
trySend(query)
setOnQueryTextListener(listener(scope, ::trySend))
invokeOnClose { setOnQueryTextListener(null) }
}
/**
* Create a flow of character sequences for query text changes on [SearchView].
*
* *Warning:* The created flow uses [SearchView.setOnQueryTextListener]. Only one flow can be used
* at a time.
*
* *Note:* A value will be emitted immediately.
*
* Examples:
*
* ```
* // handle initial value
* searchView.queryTextChanges()
* .onEach { /* handle query text change */ }
* .flowWithLifecycle(lifecycle)
* .launchIn(lifecycleScope) // lifecycle-runtime-ktx
*
* // drop initial value
* searchView.queryTextChanges()
* .dropInitialValue()
* .onEach { /* handle query text change */ }
* .flowWithLifecycle(lifecycle)
* .launchIn(lifecycleScope) // lifecycle-runtime-ktx
* ```
*/
@CheckResult
fun SearchView.queryTextChanges(): InitialValueFlow<CharSequence> = channelFlow {
setOnQueryTextListener(listener(this, ::trySend))
awaitClose { setOnQueryTextListener(null) }
}.asInitialValueFlow(query)
@CheckResult
private fun listener(
scope: CoroutineScope,
emitter: (CharSequence) -> Unit
) = object : SearchView.OnQueryTextListener {
override fun onQueryTextChange(s: String): Boolean {
if (scope.isActive) {
emitter(s)
return true
}
return false
}
override fun onQueryTextSubmit(query: String): Boolean { return false }
}