├── .circleci └── config.yml ├── .github └── FUNDING.yml ├── .gitignore ├── .idea ├── .gitignore ├── codeStyles │ ├── Project.xml │ └── codeStyleConfig.xml ├── compiler.xml ├── gradle.xml ├── inspectionProfiles │ └── Project_Default.xml ├── jarRepositories.xml ├── kotlinc.xml ├── misc.xml └── vcs.xml ├── LICENSE ├── README.md ├── app ├── .gitignore ├── build.gradle ├── proguard-rules.pro └── src │ ├── androidTest │ └── java │ │ └── com │ │ └── jintin │ │ └── fancylocation │ │ └── app │ │ └── ExampleInstrumentedTest.kt │ ├── main │ ├── AndroidManifest.xml │ ├── java │ │ └── com │ │ │ └── jintin │ │ │ └── fancylocation │ │ │ └── app │ │ │ ├── MainActivity.kt │ │ │ └── MainViewModel.kt │ └── res │ │ ├── drawable-v24 │ │ └── ic_launcher_foreground.xml │ │ ├── drawable │ │ └── ic_launcher_background.xml │ │ ├── layout │ │ └── activity_main.xml │ │ ├── mipmap-anydpi-v26 │ │ ├── ic_launcher.xml │ │ └── ic_launcher_round.xml │ │ ├── mipmap-hdpi │ │ ├── ic_launcher.png │ │ └── ic_launcher_round.png │ │ ├── mipmap-mdpi │ │ ├── ic_launcher.png │ │ └── ic_launcher_round.png │ │ ├── mipmap-xhdpi │ │ ├── ic_launcher.png │ │ └── ic_launcher_round.png │ │ ├── mipmap-xxhdpi │ │ ├── ic_launcher.png │ │ └── ic_launcher_round.png │ │ ├── mipmap-xxxhdpi │ │ ├── ic_launcher.png │ │ └── ic_launcher_round.png │ │ ├── values-night │ │ └── themes.xml │ │ └── values │ │ ├── colors.xml │ │ ├── strings.xml │ │ └── themes.xml │ └── test │ └── java │ └── com │ └── jintin │ └── fancylocation │ └── app │ └── ExampleUnitTest.kt ├── build.gradle ├── gradle.properties ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── lib ├── .gitignore ├── build.gradle ├── consumer-rules.pro ├── proguard-rules.pro └── src │ ├── androidTest │ └── java │ │ └── com │ │ └── jintin │ │ └── fancylocation │ │ └── ExampleInstrumentedTest.kt │ ├── main │ ├── AndroidManifest.xml │ └── java │ │ └── com │ │ └── jintin │ │ └── fancylocation │ │ ├── ILocationObserver.kt │ │ ├── ILocationProvider.kt │ │ ├── LocationData.kt │ │ ├── LocationExtension.kt │ │ ├── LocationFlow.kt │ │ ├── LocationLiveData.kt │ │ ├── LocationProvider.kt │ │ └── LocationStateFlow.kt │ └── test │ └── java │ └── com │ └── jintin │ └── fancylocation │ └── ExampleUnitTest.kt └── settings.gradle /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | version: 2.1 2 | 3 | orbs: 4 | android: circleci/android@0.2.1 5 | 6 | jobs: 7 | build: 8 | docker: 9 | - image: cimg/android:2023.08 10 | 11 | steps: 12 | - checkout 13 | - run: 14 | command: ./gradlew build 15 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 4 | patreon: Jintin 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: Jintin 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | .gradle 3 | /local.properties 4 | /.idea/caches 5 | /.idea/libraries 6 | /.idea/modules.xml 7 | /.idea/workspace.xml 8 | /.idea/navEditor.xml 9 | /.idea/assetWizardSettings.xml 10 | .DS_Store 11 | /build 12 | /captures 13 | .externalNativeBuild 14 | .cxx 15 | local.properties 16 | -------------------------------------------------------------------------------- /.idea/.gitignore: -------------------------------------------------------------------------------- 1 | # Default ignored files 2 | /shelf/ 3 | /workspace.xml 4 | -------------------------------------------------------------------------------- /.idea/codeStyles/Project.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 11 | 20 | 22 | 23 | 135 | 136 | 138 | 139 | -------------------------------------------------------------------------------- /.idea/codeStyles/codeStyleConfig.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | -------------------------------------------------------------------------------- /.idea/compiler.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /.idea/gradle.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 20 | 21 | -------------------------------------------------------------------------------- /.idea/inspectionProfiles/Project_Default.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 6 | -------------------------------------------------------------------------------- /.idea/jarRepositories.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 9 | 10 | 14 | 15 | 19 | 20 | 24 | 25 | 29 | 30 | 34 | 35 | -------------------------------------------------------------------------------- /.idea/kotlinc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 6 | -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 8 | -------------------------------------------------------------------------------- /.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2020 Jintin 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # FancyLocationProvider 2 | 3 | [![CircleCI](https://circleci.com/gh/Jintin/FancyLocationProvider.svg?style=shield)](https://circleci.com/gh/Jintin/FancyLocationProvider) 4 | [![jitpack](https://jitpack.io/v/Jintin/FancyLocationProvider.svg)](https://jitpack.io/#Jintin/FancyLocationProvider) 5 | 6 | Wrapper of FusedLocationProviderClient for Android to support modern usage like LiveData or Flow. 7 | 8 | ## Install 9 | 10 | Add [Jitpack](https://jitpack.io/) repository to your root `build.grable`: 11 | ```groovy 12 | allprojects { 13 | repositories { 14 | ... 15 | maven { url 'https://jitpack.io' } 16 | } 17 | } 18 | ``` 19 | 20 | Then add dependency in your module `build.gradle`: 21 | ```groovy 22 | dependencies { 23 | implementation 'com.github.jintin:FancyLocationProvider:2.0.0' 24 | } 25 | ``` 26 | 27 | ## Usage 28 | 29 | ### LiveData 30 | Here is an example of how you can create a `LocationLiveData` in `ViewModel` layer, just provide `Context` and the `LocationRequest` with your own config. 31 | ```kotlin 32 | class MainViewModel(application: Application) : AndroidViewModel(application) { 33 | private val locationRequest = 34 | LocationRequest.create() 35 | .setInterval(3000) 36 | .setFastestInterval(3000) 37 | .setPriority(LocationRequest.PRIORITY_HIGH_ACCURACY) 38 | 39 | val locationLiveData = LocationLiveData(application, locationRequest) 40 | } 41 | ``` 42 | And here is how you observe the update on `View` layer. 43 | ```kotlin 44 | // check for the location permission first 45 | locationLiveData.observe(this) { 46 | when (it) { 47 | is LocationData.Success -> // get location by "it.location" 48 | is LocationData.Fail -> // Fail to get location 49 | } 50 | } 51 | 52 | ``` 53 | 54 | ### Flow 55 | 56 | ```kotlin 57 | val locationFlow = LocationFlow(application, locationRequest) 58 | 59 | // check for the location permission first 60 | // should inside coroutine 61 | locationFlow.get().collect { 62 | when (it) { 63 | is LocationData.Success -> // get location by "it.location" 64 | is LocationData.Fail -> // Fail to get location 65 | } 66 | } 67 | 68 | ``` 69 | 70 | You can go to ./app module for more information. 71 | 72 | ## Custom Location Provider 73 | FancyLocationProvider using GMS as the default location provider as it serve the most use case. 74 | But you can also used it with any other provider you want like Huawei HMS. Just create the custom provider implement the `ILocationProvider` interface like this: 75 | ```kotlin 76 | class LocationProvider( 77 | private val context: Context, 78 | private val locationRequest: LocationRequest 79 | ) : ILocationProvider { 80 | 81 | private val locationProviderClient by lazy { 82 | LocationServices.getFusedLocationProviderClient(context) 83 | } 84 | private val locationListener by lazy { 85 | LocationListener() 86 | } 87 | 88 | @RequiresPermission(anyOf = [Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION]) 89 | override fun requestLocationUpdates(locationObserver: ILocationObserver) { 90 | locationListener.locationObserver = locationObserver 91 | locationProviderClient.requestLocationUpdates( 92 | locationRequest, 93 | locationListener, 94 | Looper.getMainLooper() 95 | ) 96 | } 97 | 98 | override fun removeLocationUpdates() { 99 | locationProviderClient.removeLocationUpdates(locationListener) 100 | } 101 | 102 | private class LocationListener : LocationCallback() { 103 | var locationObserver: ILocationObserver? = null 104 | 105 | override fun onLocationResult(result: LocationResult?) { 106 | result?.lastLocation?.let { 107 | locationObserver?.onLocationResult(it) 108 | } 109 | } 110 | 111 | override fun onLocationAvailability(availability: LocationAvailability?) { 112 | if (availability?.isLocationAvailable == false) { 113 | locationObserver?.onLocationFailed() 114 | } 115 | } 116 | } 117 | } 118 | ``` 119 | Then you can create the custom provider and transform it into LiveData or Flow. 120 | ```kotlin 121 | private val locationProvider: ILocationProvider = LocationProvider(context, locationRequest) 122 | 123 | val locationFlow: LocationFlow = locationProvider.asFlow() 124 | val locationLiveData: LocationLiveData = locationProvider.asLiveData() 125 | ``` 126 | 127 | ## Contributing 128 | Bug reports and pull requests are welcome on GitHub at [https://github.com/Jintin/FancyLocationProvider](https://github.com/Jintin/FancyLocationProvider). 129 | 130 | ## License 131 | The package is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). 132 | 133 | [![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/jintin) 134 | -------------------------------------------------------------------------------- /app/.gitignore: -------------------------------------------------------------------------------- 1 | /build -------------------------------------------------------------------------------- /app/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.android.application' 3 | id 'kotlin-android' 4 | id 'kotlin-kapt' 5 | } 6 | 7 | android { 8 | namespace "com.jintin.fancylocation.app" 9 | 10 | defaultConfig { 11 | 12 | compileSdk 34 13 | buildToolsVersion = "34.0.0" 14 | applicationId "com.jintin.fancylocation.app" 15 | minSdkVersion 23 16 | targetSdkVersion 34 17 | versionCode 1 18 | versionName "1.0" 19 | 20 | testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" 21 | } 22 | 23 | buildTypes { 24 | release { 25 | minifyEnabled false 26 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' 27 | } 28 | } 29 | compileOptions { 30 | sourceCompatibility JavaVersion.VERSION_17 31 | targetCompatibility JavaVersion.VERSION_17 32 | } 33 | kotlinOptions { 34 | jvmTarget = '17' 35 | } 36 | } 37 | 38 | dependencies { 39 | implementation project(':lib') 40 | 41 | // implementation 'com.github.jintin:FancyLocationProvider:1.0' 42 | implementation 'com.google.android.gms:play-services-location:21.0.1' 43 | implementation 'androidx.activity:activity-ktx:1.8.0' 44 | implementation "com.github.permissions-dispatcher:permissionsdispatcher:4.8.0" 45 | kapt "com.github.permissions-dispatcher:permissionsdispatcher-processor:4.8.0" 46 | 47 | implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version" 48 | implementation 'androidx.core:core-ktx:1.12.0' 49 | implementation 'androidx.appcompat:appcompat:1.6.1' 50 | implementation 'com.google.android.material:material:1.10.0' 51 | implementation 'androidx.constraintlayout:constraintlayout:2.1.4' 52 | testImplementation 'junit:junit:4.13.2' 53 | androidTestImplementation 'androidx.test.ext:junit:1.1.5' 54 | androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1' 55 | } -------------------------------------------------------------------------------- /app/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile -------------------------------------------------------------------------------- /app/src/androidTest/java/com/jintin/fancylocation/app/ExampleInstrumentedTest.kt: -------------------------------------------------------------------------------- 1 | package com.jintin.fancylocation.app 2 | 3 | import androidx.test.platform.app.InstrumentationRegistry 4 | import androidx.test.ext.junit.runners.AndroidJUnit4 5 | 6 | import org.junit.Test 7 | import org.junit.runner.RunWith 8 | 9 | import org.junit.Assert.* 10 | 11 | /** 12 | * Instrumented test, which will execute on an Android device. 13 | * 14 | * See [testing documentation](http://d.android.com/tools/testing). 15 | */ 16 | @RunWith(AndroidJUnit4::class) 17 | class ExampleInstrumentedTest { 18 | @Test 19 | fun useAppContext() { 20 | // Context of the app under test. 21 | val appContext = InstrumentationRegistry.getInstrumentation().targetContext 22 | assertEquals("com.jintin.fancylocation", appContext.packageName) 23 | } 24 | } -------------------------------------------------------------------------------- /app/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 14 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /app/src/main/java/com/jintin/fancylocation/app/MainActivity.kt: -------------------------------------------------------------------------------- 1 | package com.jintin.fancylocation.app 2 | 3 | import android.Manifest 4 | import android.os.Bundle 5 | import android.widget.TextView 6 | import androidx.activity.viewModels 7 | import androidx.annotation.RequiresPermission 8 | import androidx.appcompat.app.AppCompatActivity 9 | import androidx.lifecycle.lifecycleScope 10 | import com.jintin.fancylocation.LocationData 11 | import kotlinx.coroutines.flow.collect 12 | import kotlinx.coroutines.launch 13 | import permissions.dispatcher.NeedsPermission 14 | import permissions.dispatcher.RuntimePermissions 15 | 16 | @RuntimePermissions 17 | class MainActivity : AppCompatActivity() { 18 | 19 | companion object { 20 | const val TYPE_LIVEDATA = 0 21 | const val TYPE_FLOW = 1 22 | const val TYPE_STATEFLOW = 2 23 | } 24 | 25 | private val viewModel by viewModels() 26 | 27 | private val type = TYPE_FLOW 28 | 29 | override fun onCreate(savedInstanceState: Bundle?) { 30 | super.onCreate(savedInstanceState) 31 | setContentView(R.layout.activity_main) 32 | 33 | observeLocationWithPermissionCheck() 34 | } 35 | 36 | override fun onRequestPermissionsResult( 37 | requestCode: Int, 38 | permissions: Array, 39 | grantResults: IntArray 40 | ) { 41 | super.onRequestPermissionsResult(requestCode, permissions, grantResults) 42 | onRequestPermissionsResult(requestCode, grantResults) 43 | } 44 | 45 | @NeedsPermission(Manifest.permission.ACCESS_FINE_LOCATION) 46 | @RequiresPermission(anyOf = [Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION]) 47 | fun observeLocation() { 48 | when (type) { 49 | TYPE_LIVEDATA -> liveDataObserve() 50 | TYPE_FLOW -> flowObserve() 51 | TYPE_STATEFLOW -> stateFlowObserve() 52 | } 53 | } 54 | 55 | @RequiresPermission(anyOf = [Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION]) 56 | private fun flowObserve() { 57 | lifecycleScope.launch { 58 | viewModel.locationFlow.get().collect(::updateUI) 59 | } 60 | } 61 | 62 | @RequiresPermission(anyOf = [Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION]) 63 | private fun stateFlowObserve() { 64 | lifecycleScope.launch { 65 | viewModel.locationStateFlow.start() 66 | viewModel.locationStateFlow.value.collect(::updateUI) 67 | } 68 | } 69 | 70 | @RequiresPermission(anyOf = [Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION]) 71 | private fun liveDataObserve() { 72 | viewModel.locationLiveData.observe(this, ::updateUI) 73 | } 74 | 75 | private fun updateUI(locationData: LocationData) { 76 | findViewById(R.id.location).text = when (locationData) { 77 | LocationData.Init -> "Init state" 78 | LocationData.Loading -> "Start loading" 79 | LocationData.Fail -> "Fail to get location" 80 | is LocationData.Success -> locationData.location.toString() 81 | } 82 | } 83 | } -------------------------------------------------------------------------------- /app/src/main/java/com/jintin/fancylocation/app/MainViewModel.kt: -------------------------------------------------------------------------------- 1 | package com.jintin.fancylocation.app 2 | 3 | import android.app.Application 4 | import androidx.lifecycle.AndroidViewModel 5 | import com.google.android.gms.location.LocationRequest 6 | import com.google.android.gms.location.Priority 7 | import com.jintin.fancylocation.* 8 | 9 | class MainViewModel(application: Application) : AndroidViewModel(application) { 10 | private val locationRequest = 11 | LocationRequest.Builder(Priority.PRIORITY_HIGH_ACCURACY, 3000) 12 | .setWaitForAccurateLocation(false) 13 | .setMinUpdateIntervalMillis(3000) 14 | .setMaxUpdateDelayMillis(3000) 15 | .build() 16 | 17 | // val locationFlow = LocationFlow(application, locationRequest) 18 | // val locationStateFlow = LocationFlow(application, locationRequest) 19 | // val locationLiveData = LocationLiveData(application, locationRequest) 20 | 21 | // we can also provide custom vendor by create your own LocationProvider 22 | private val locationProvider: ILocationProvider = LocationProvider(application, locationRequest) 23 | 24 | val locationFlow = locationProvider.asFlow() 25 | val locationLiveData = locationProvider.asLiveData() 26 | val locationStateFlow = locationProvider.asStateFlow() 27 | } -------------------------------------------------------------------------------- /app/src/main/res/drawable-v24/ic_launcher_foreground.xml: -------------------------------------------------------------------------------- 1 | 7 | 8 | 9 | 15 | 18 | 21 | 22 | 23 | 24 | 30 | -------------------------------------------------------------------------------- /app/src/main/res/drawable/ic_launcher_background.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 10 | 15 | 20 | 25 | 30 | 35 | 40 | 45 | 50 | 55 | 60 | 65 | 70 | 75 | 80 | 85 | 90 | 95 | 100 | 105 | 110 | 115 | 120 | 125 | 130 | 135 | 140 | 145 | 150 | 155 | 160 | 165 | 170 | 171 | -------------------------------------------------------------------------------- /app/src/main/res/layout/activity_main.xml: -------------------------------------------------------------------------------- 1 | 2 | 8 | 9 | 18 | 19 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Jintin/FancyLocationProvider/be352757c4ce8e903e1656a4ed13f29012e957f2/app/src/main/res/mipmap-hdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Jintin/FancyLocationProvider/be352757c4ce8e903e1656a4ed13f29012e957f2/app/src/main/res/mipmap-hdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Jintin/FancyLocationProvider/be352757c4ce8e903e1656a4ed13f29012e957f2/app/src/main/res/mipmap-mdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Jintin/FancyLocationProvider/be352757c4ce8e903e1656a4ed13f29012e957f2/app/src/main/res/mipmap-mdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Jintin/FancyLocationProvider/be352757c4ce8e903e1656a4ed13f29012e957f2/app/src/main/res/mipmap-xhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Jintin/FancyLocationProvider/be352757c4ce8e903e1656a4ed13f29012e957f2/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Jintin/FancyLocationProvider/be352757c4ce8e903e1656a4ed13f29012e957f2/app/src/main/res/mipmap-xxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Jintin/FancyLocationProvider/be352757c4ce8e903e1656a4ed13f29012e957f2/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Jintin/FancyLocationProvider/be352757c4ce8e903e1656a4ed13f29012e957f2/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Jintin/FancyLocationProvider/be352757c4ce8e903e1656a4ed13f29012e957f2/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/values-night/themes.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 16 | -------------------------------------------------------------------------------- /app/src/main/res/values/colors.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | #FFBB86FC 4 | #FF6200EE 5 | #FF3700B3 6 | #FF03DAC5 7 | #FF018786 8 | #FF000000 9 | #FFFFFFFF 10 | -------------------------------------------------------------------------------- /app/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | FancyLocation 3 | -------------------------------------------------------------------------------- /app/src/main/res/values/themes.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 16 | -------------------------------------------------------------------------------- /app/src/test/java/com/jintin/fancylocation/app/ExampleUnitTest.kt: -------------------------------------------------------------------------------- 1 | package com.jintin.fancylocation.app 2 | 3 | import org.junit.Test 4 | 5 | import org.junit.Assert.* 6 | 7 | /** 8 | * Example local unit test, which will execute on the development machine (host). 9 | * 10 | * See [testing documentation](http://d.android.com/tools/testing). 11 | */ 12 | class ExampleUnitTest { 13 | @Test 14 | fun addition_isCorrect() { 15 | assertEquals(4, 2 + 2) 16 | } 17 | } -------------------------------------------------------------------------------- /build.gradle: -------------------------------------------------------------------------------- 1 | // Top-level build file where you can add configuration options common to all sub-projects/modules. 2 | buildscript { 3 | ext.kotlin_version = "1.9.10" 4 | repositories { 5 | google() 6 | mavenCentral() 7 | } 8 | dependencies { 9 | classpath 'com.android.tools.build:gradle:8.1.2' 10 | classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" 11 | // NOTE: Do not place your application dependencies here; they belong 12 | // in the individual module build.gradle files 13 | } 14 | } 15 | 16 | allprojects { 17 | repositories { 18 | google() 19 | mavenCentral() 20 | maven { url 'https://jitpack.io' } 21 | } 22 | } 23 | 24 | task clean(type: Delete) { 25 | delete rootProject.buildDir 26 | } -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # Project-wide Gradle settings. 2 | # IDE (e.g. Android Studio) users: 3 | # Gradle settings configured through the IDE *will override* 4 | # any settings specified in this file. 5 | # For more details on how to configure your build environment visit 6 | # http://www.gradle.org/docs/current/userguide/build_environment.html 7 | # Specifies the JVM arguments used for the daemon process. 8 | # The setting is particularly useful for tweaking memory settings. 9 | org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8 10 | # When configured, Gradle will run in incubating parallel mode. 11 | # This option should only be used with decoupled projects. More details, visit 12 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects 13 | # org.gradle.parallel=true 14 | # AndroidX package structure to make it clearer which packages are bundled with the 15 | # Android operating system, and which are packaged with your app"s APK 16 | # https://developer.android.com/topic/libraries/support-library/androidx-rn 17 | android.useAndroidX=true 18 | # Automatically convert third-party libraries to use AndroidX 19 | android.enableJetifier=true 20 | # Kotlin code style for this project: "official" or "obsolete": 21 | kotlin.code.style=official -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Jintin/FancyLocationProvider/be352757c4ce8e903e1656a4ed13f29012e957f2/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.0-all.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | ############################################################################## 4 | ## 5 | ## Gradle start up script for UN*X 6 | ## 7 | ############################################################################## 8 | 9 | # Attempt to set APP_HOME 10 | # Resolve links: $0 may be a link 11 | PRG="$0" 12 | # Need this for relative symlinks. 13 | while [ -h "$PRG" ] ; do 14 | ls=`ls -ld "$PRG"` 15 | link=`expr "$ls" : '.*-> \(.*\)$'` 16 | if expr "$link" : '/.*' > /dev/null; then 17 | PRG="$link" 18 | else 19 | PRG=`dirname "$PRG"`"/$link" 20 | fi 21 | done 22 | SAVED="`pwd`" 23 | cd "`dirname \"$PRG\"`/" >/dev/null 24 | APP_HOME="`pwd -P`" 25 | cd "$SAVED" >/dev/null 26 | 27 | APP_NAME="Gradle" 28 | APP_BASE_NAME=`basename "$0"` 29 | 30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 31 | DEFAULT_JVM_OPTS="" 32 | 33 | # Use the maximum available, or set MAX_FD != -1 to use that value. 34 | MAX_FD="maximum" 35 | 36 | warn () { 37 | echo "$*" 38 | } 39 | 40 | die () { 41 | echo 42 | echo "$*" 43 | echo 44 | exit 1 45 | } 46 | 47 | # OS specific support (must be 'true' or 'false'). 48 | cygwin=false 49 | msys=false 50 | darwin=false 51 | nonstop=false 52 | case "`uname`" in 53 | CYGWIN* ) 54 | cygwin=true 55 | ;; 56 | Darwin* ) 57 | darwin=true 58 | ;; 59 | MINGW* ) 60 | msys=true 61 | ;; 62 | NONSTOP* ) 63 | nonstop=true 64 | ;; 65 | esac 66 | 67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 68 | 69 | # Determine the Java command to use to start the JVM. 70 | if [ -n "$JAVA_HOME" ] ; then 71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 72 | # IBM's JDK on AIX uses strange locations for the executables 73 | JAVACMD="$JAVA_HOME/jre/sh/java" 74 | else 75 | JAVACMD="$JAVA_HOME/bin/java" 76 | fi 77 | if [ ! -x "$JAVACMD" ] ; then 78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 79 | 80 | Please set the JAVA_HOME variable in your environment to match the 81 | location of your Java installation." 82 | fi 83 | else 84 | JAVACMD="java" 85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 86 | 87 | Please set the JAVA_HOME variable in your environment to match the 88 | location of your Java installation." 89 | fi 90 | 91 | # Increase the maximum file descriptors if we can. 92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 93 | MAX_FD_LIMIT=`ulimit -H -n` 94 | if [ $? -eq 0 ] ; then 95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 96 | MAX_FD="$MAX_FD_LIMIT" 97 | fi 98 | ulimit -n $MAX_FD 99 | if [ $? -ne 0 ] ; then 100 | warn "Could not set maximum file descriptor limit: $MAX_FD" 101 | fi 102 | else 103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 104 | fi 105 | fi 106 | 107 | # For Darwin, add options to specify how the application appears in the dock 108 | if $darwin; then 109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 110 | fi 111 | 112 | # For Cygwin, switch paths to Windows format before running java 113 | if $cygwin ; then 114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 116 | JAVACMD=`cygpath --unix "$JAVACMD"` 117 | 118 | # We build the pattern for arguments to be converted via cygpath 119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 120 | SEP="" 121 | for dir in $ROOTDIRSRAW ; do 122 | ROOTDIRS="$ROOTDIRS$SEP$dir" 123 | SEP="|" 124 | done 125 | OURCYGPATTERN="(^($ROOTDIRS))" 126 | # Add a user-defined pattern to the cygpath arguments 127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 129 | fi 130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 131 | i=0 132 | for arg in "$@" ; do 133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 135 | 136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 138 | else 139 | eval `echo args$i`="\"$arg\"" 140 | fi 141 | i=$((i+1)) 142 | done 143 | case $i in 144 | (0) set -- ;; 145 | (1) set -- "$args0" ;; 146 | (2) set -- "$args0" "$args1" ;; 147 | (3) set -- "$args0" "$args1" "$args2" ;; 148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;; 149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 154 | esac 155 | fi 156 | 157 | # Escape application args 158 | save () { 159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 160 | echo " " 161 | } 162 | APP_ARGS=$(save "$@") 163 | 164 | # Collect all arguments for the java command, following the shell quoting and substitution rules 165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 166 | 167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong 168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then 169 | cd "$(dirname "$0")" 170 | fi 171 | 172 | exec "$JAVACMD" "$@" 173 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @if "%DEBUG%" == "" @echo off 2 | @rem ########################################################################## 3 | @rem 4 | @rem Gradle startup script for Windows 5 | @rem 6 | @rem ########################################################################## 7 | 8 | @rem Set local scope for the variables with windows NT shell 9 | if "%OS%"=="Windows_NT" setlocal 10 | 11 | set DIRNAME=%~dp0 12 | if "%DIRNAME%" == "" set DIRNAME=. 13 | set APP_BASE_NAME=%~n0 14 | set APP_HOME=%DIRNAME% 15 | 16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 17 | set DEFAULT_JVM_OPTS= 18 | 19 | @rem Find java.exe 20 | if defined JAVA_HOME goto findJavaFromJavaHome 21 | 22 | set JAVA_EXE=java.exe 23 | %JAVA_EXE% -version >NUL 2>&1 24 | if "%ERRORLEVEL%" == "0" goto init 25 | 26 | echo. 27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 28 | echo. 29 | echo Please set the JAVA_HOME variable in your environment to match the 30 | echo location of your Java installation. 31 | 32 | goto fail 33 | 34 | :findJavaFromJavaHome 35 | set JAVA_HOME=%JAVA_HOME:"=% 36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 37 | 38 | if exist "%JAVA_EXE%" goto init 39 | 40 | echo. 41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 42 | echo. 43 | echo Please set the JAVA_HOME variable in your environment to match the 44 | echo location of your Java installation. 45 | 46 | goto fail 47 | 48 | :init 49 | @rem Get command-line arguments, handling Windows variants 50 | 51 | if not "%OS%" == "Windows_NT" goto win9xME_args 52 | 53 | :win9xME_args 54 | @rem Slurp the command line arguments. 55 | set CMD_LINE_ARGS= 56 | set _SKIP=2 57 | 58 | :win9xME_args_slurp 59 | if "x%~1" == "x" goto execute 60 | 61 | set CMD_LINE_ARGS=%* 62 | 63 | :execute 64 | @rem Setup the command line 65 | 66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 67 | 68 | @rem Execute Gradle 69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% 70 | 71 | :end 72 | @rem End local scope for the variables with windows NT shell 73 | if "%ERRORLEVEL%"=="0" goto mainEnd 74 | 75 | :fail 76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 77 | rem the _cmd.exe /c_ return code! 78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 79 | exit /b 1 80 | 81 | :mainEnd 82 | if "%OS%"=="Windows_NT" endlocal 83 | 84 | :omega 85 | -------------------------------------------------------------------------------- /lib/.gitignore: -------------------------------------------------------------------------------- 1 | /build -------------------------------------------------------------------------------- /lib/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.android.library' 3 | id 'kotlin-android' 4 | } 5 | 6 | android { 7 | namespace "com.jintin.fancylocation" 8 | 9 | defaultConfig { 10 | minSdkVersion 16 11 | compileSdk 34 12 | buildToolsVersion = "34.0.0" 13 | targetSdkVersion 34 14 | 15 | testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" 16 | consumerProguardFiles "consumer-rules.pro" 17 | } 18 | 19 | buildTypes { 20 | release { 21 | minifyEnabled false 22 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' 23 | } 24 | } 25 | compileOptions { 26 | sourceCompatibility JavaVersion.VERSION_17 27 | targetCompatibility JavaVersion.VERSION_17 28 | } 29 | kotlinOptions { 30 | jvmTarget = '17' 31 | } 32 | } 33 | 34 | dependencies { 35 | 36 | implementation 'com.google.android.gms:play-services-location:21.0.1' 37 | implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.1' 38 | 39 | implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version" 40 | testImplementation 'junit:junit:4.13.2' 41 | androidTestImplementation 'androidx.test.ext:junit:1.1.5' 42 | androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1' 43 | } -------------------------------------------------------------------------------- /lib/consumer-rules.pro: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Jintin/FancyLocationProvider/be352757c4ce8e903e1656a4ed13f29012e957f2/lib/consumer-rules.pro -------------------------------------------------------------------------------- /lib/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile -------------------------------------------------------------------------------- /lib/src/androidTest/java/com/jintin/fancylocation/ExampleInstrumentedTest.kt: -------------------------------------------------------------------------------- 1 | package com.jintin.fancylocation 2 | 3 | import androidx.test.platform.app.InstrumentationRegistry 4 | import androidx.test.ext.junit.runners.AndroidJUnit4 5 | 6 | import org.junit.Test 7 | import org.junit.runner.RunWith 8 | 9 | import org.junit.Assert.* 10 | 11 | /** 12 | * Instrumented test, which will execute on an Android device. 13 | * 14 | * See [testing documentation](http://d.android.com/tools/testing). 15 | */ 16 | @RunWith(AndroidJUnit4::class) 17 | class ExampleInstrumentedTest { 18 | @Test 19 | fun useAppContext() { 20 | // Context of the app under test. 21 | val appContext = InstrumentationRegistry.getInstrumentation().targetContext 22 | assertEquals("com.jintin.fancylocation.livedata.test", appContext.packageName) 23 | } 24 | } -------------------------------------------------------------------------------- /lib/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | -------------------------------------------------------------------------------- /lib/src/main/java/com/jintin/fancylocation/ILocationObserver.kt: -------------------------------------------------------------------------------- 1 | package com.jintin.fancylocation 2 | 3 | import android.location.Location 4 | 5 | interface ILocationObserver { 6 | fun onLocationResult(location: Location) 7 | fun onLocationFailed() 8 | } -------------------------------------------------------------------------------- /lib/src/main/java/com/jintin/fancylocation/ILocationProvider.kt: -------------------------------------------------------------------------------- 1 | package com.jintin.fancylocation 2 | 3 | import android.Manifest 4 | import androidx.annotation.RequiresPermission 5 | 6 | interface ILocationProvider { 7 | @RequiresPermission(anyOf = [Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION]) 8 | fun requestLocationUpdates(locationObserver: ILocationObserver) 9 | fun removeLocationUpdates() 10 | } -------------------------------------------------------------------------------- /lib/src/main/java/com/jintin/fancylocation/LocationData.kt: -------------------------------------------------------------------------------- 1 | package com.jintin.fancylocation 2 | 3 | import android.location.Location 4 | 5 | sealed class LocationData { 6 | data object Init : LocationData() 7 | data object Loading : LocationData() 8 | data class Success(val location: Location) : LocationData() 9 | data object Fail : LocationData() 10 | } -------------------------------------------------------------------------------- /lib/src/main/java/com/jintin/fancylocation/LocationExtension.kt: -------------------------------------------------------------------------------- 1 | package com.jintin.fancylocation 2 | 3 | fun ILocationProvider.asLiveData(): LocationLiveData { 4 | return LocationLiveData(this) 5 | } 6 | 7 | fun ILocationProvider.asFlow(): LocationFlow { 8 | return LocationFlow(this) 9 | } 10 | 11 | fun ILocationProvider.asStateFlow(): LocationStateFlow { 12 | return LocationStateFlow(this) 13 | } -------------------------------------------------------------------------------- /lib/src/main/java/com/jintin/fancylocation/LocationFlow.kt: -------------------------------------------------------------------------------- 1 | package com.jintin.fancylocation 2 | 3 | import android.Manifest 4 | import android.content.Context 5 | import android.location.Location 6 | import androidx.annotation.RequiresPermission 7 | import com.google.android.gms.location.LocationRequest 8 | import kotlinx.coroutines.channels.awaitClose 9 | import kotlinx.coroutines.channels.trySendBlocking 10 | import kotlinx.coroutines.flow.Flow 11 | import kotlinx.coroutines.flow.callbackFlow 12 | import kotlinx.coroutines.flow.channelFlow 13 | 14 | class LocationFlow( 15 | private val locationProvider: ILocationProvider 16 | ) { 17 | 18 | constructor( 19 | context: Context, 20 | locationRequest: LocationRequest 21 | ) : this(LocationProvider(context, locationRequest)) 22 | 23 | @RequiresPermission(anyOf = [Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION]) 24 | fun get(): Flow = callbackFlow { 25 | channel.trySendBlocking(LocationData.Loading) 26 | locationProvider.requestLocationUpdates(object : ILocationObserver { 27 | override fun onLocationResult(location: Location) { 28 | channel.trySendBlocking(LocationData.Success(location)) 29 | } 30 | 31 | override fun onLocationFailed() { 32 | channel.trySendBlocking(LocationData.Fail) 33 | } 34 | }) 35 | awaitClose { 36 | locationProvider.removeLocationUpdates() 37 | } 38 | } 39 | } -------------------------------------------------------------------------------- /lib/src/main/java/com/jintin/fancylocation/LocationLiveData.kt: -------------------------------------------------------------------------------- 1 | package com.jintin.fancylocation 2 | 3 | import android.Manifest 4 | import android.content.Context 5 | import android.location.Location 6 | import androidx.annotation.RequiresPermission 7 | import androidx.lifecycle.LifecycleOwner 8 | import androidx.lifecycle.LiveData 9 | import androidx.lifecycle.Observer 10 | import com.google.android.gms.location.LocationRequest 11 | 12 | class LocationLiveData( 13 | private val locationProvider: ILocationProvider 14 | ) : LiveData() { 15 | 16 | private val locationObserver = LocationObserver() 17 | 18 | constructor( 19 | context: Context, 20 | locationRequest: LocationRequest 21 | ) : this(LocationProvider(context, locationRequest)) 22 | 23 | @RequiresPermission(anyOf = [Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION]) 24 | override fun onActive() { 25 | super.onActive() 26 | locationProvider.requestLocationUpdates(locationObserver) 27 | } 28 | 29 | override fun onInactive() { 30 | super.onInactive() 31 | locationProvider.removeLocationUpdates() 32 | } 33 | 34 | @RequiresPermission(anyOf = [Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION]) 35 | override fun observe( 36 | owner: LifecycleOwner, 37 | observer: Observer 38 | ) { 39 | super.observe(owner, observer) 40 | } 41 | 42 | @RequiresPermission(anyOf = [Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION]) 43 | override fun observeForever(observer: Observer) { 44 | super.observeForever(observer) 45 | } 46 | 47 | private inner class LocationObserver : ILocationObserver { 48 | override fun onLocationResult(location: Location) { 49 | value = LocationData.Success(location) 50 | } 51 | 52 | override fun onLocationFailed() { 53 | value = LocationData.Fail 54 | } 55 | } 56 | } -------------------------------------------------------------------------------- /lib/src/main/java/com/jintin/fancylocation/LocationProvider.kt: -------------------------------------------------------------------------------- 1 | package com.jintin.fancylocation 2 | 3 | import android.Manifest 4 | import android.content.Context 5 | import android.os.Looper 6 | import androidx.annotation.RequiresPermission 7 | import com.google.android.gms.location.* 8 | 9 | class LocationProvider( 10 | private val context: Context, 11 | private val locationRequest: LocationRequest 12 | ) : ILocationProvider { 13 | 14 | private val locationProviderClient by lazy { 15 | LocationServices.getFusedLocationProviderClient(context) 16 | } 17 | private val locationListener by lazy { 18 | LocationListener() 19 | } 20 | 21 | @RequiresPermission(anyOf = [Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION]) 22 | override fun requestLocationUpdates(locationObserver: ILocationObserver) { 23 | locationListener.locationObserver = locationObserver 24 | locationProviderClient.requestLocationUpdates( 25 | locationRequest, 26 | locationListener, 27 | Looper.getMainLooper() 28 | ) 29 | } 30 | 31 | override fun removeLocationUpdates() { 32 | locationProviderClient.removeLocationUpdates(locationListener) 33 | } 34 | 35 | private class LocationListener : LocationCallback() { 36 | var locationObserver: ILocationObserver? = null 37 | 38 | override fun onLocationResult(result: LocationResult) { 39 | result.lastLocation?.let { 40 | locationObserver?.onLocationResult(it) 41 | } 42 | } 43 | 44 | override fun onLocationAvailability(availability: LocationAvailability) { 45 | if (!availability.isLocationAvailable) { 46 | locationObserver?.onLocationFailed() 47 | } 48 | } 49 | } 50 | } -------------------------------------------------------------------------------- /lib/src/main/java/com/jintin/fancylocation/LocationStateFlow.kt: -------------------------------------------------------------------------------- 1 | package com.jintin.fancylocation 2 | 3 | import android.Manifest 4 | import android.content.Context 5 | import android.location.Location 6 | import androidx.annotation.RequiresPermission 7 | import com.google.android.gms.location.LocationRequest 8 | import kotlinx.coroutines.CoroutineScope 9 | import kotlinx.coroutines.flow.MutableStateFlow 10 | import kotlinx.coroutines.flow.StateFlow 11 | import kotlinx.coroutines.launch 12 | import kotlinx.coroutines.suspendCancellableCoroutine 13 | import kotlin.coroutines.coroutineContext 14 | 15 | class LocationStateFlow( 16 | private val locationProvider: ILocationProvider 17 | ) { 18 | private val _value = MutableStateFlow(LocationData.Init) 19 | val value: StateFlow get() = _value 20 | 21 | constructor( 22 | context: Context, 23 | locationRequest: LocationRequest 24 | ) : this(LocationProvider(context, locationRequest)) 25 | 26 | @RequiresPermission(anyOf = [Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION]) 27 | suspend fun start() { 28 | _value.value = LocationData.Loading 29 | locationProvider.requestLocationUpdates(object : ILocationObserver { 30 | override fun onLocationResult(location: Location) { 31 | _value.value = LocationData.Success(location) 32 | } 33 | 34 | override fun onLocationFailed() { 35 | _value.value = LocationData.Fail 36 | } 37 | }) 38 | with(CoroutineScope(coroutineContext)) { // spawns and uses parent scope! 39 | launch { 40 | suspendCancellableCoroutine { 41 | it.invokeOnCancellation { 42 | locationProvider.removeLocationUpdates() 43 | } 44 | } 45 | } 46 | } 47 | } 48 | } -------------------------------------------------------------------------------- /lib/src/test/java/com/jintin/fancylocation/ExampleUnitTest.kt: -------------------------------------------------------------------------------- 1 | package com.jintin.fancylocation 2 | 3 | import org.junit.Test 4 | 5 | import org.junit.Assert.* 6 | 7 | /** 8 | * Example local unit test, which will execute on the development machine (host). 9 | * 10 | * See [testing documentation](http://d.android.com/tools/testing). 11 | */ 12 | class ExampleUnitTest { 13 | @Test 14 | fun addition_isCorrect() { 15 | assertEquals(4, 2 + 2) 16 | } 17 | } -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | include ':lib' 2 | include ':app' 3 | rootProject.name = "FancyLocationProvider" --------------------------------------------------------------------------------