16 |
17 |
--------------------------------------------------------------------------------
/.idea/vcs.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | Copyright [2024] [Ali Shobeyri]
179 |
180 | Licensed under the Apache License, Version 2.0 (the "License");
181 | you may not use this file except in compliance with the License.
182 | You may obtain a copy of the License at
183 |
184 | http://www.apache.org/licenses/LICENSE-2.0
185 |
186 | Unless required by applicable law or agreed to in writing, software
187 | distributed under the License is distributed on an "AS IS" BASIS,
188 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189 | See the License for the specific language governing permissions and
190 | limitations under the License.
191 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | [](https://jitpack.io/#sasssass/easynavigation)
2 | [](https://opensource.org/licenses/Apache-2.0)
3 |
4 |
5 |
6 | Simplify navigation in your Compose project with auto-generated helper functions for passing both required and optional arguments to your composables.
7 |
8 | Installation :
9 | 1. add maven("https://jitpack.io") to your setting.gradle
10 | 2. add ksp plugin in your project level gradle and apply it in your app level gradle (be aware that your Kotlin version must be suitable for your ksp version, if you're using Kotlin 2.0.0 or above you need compose compiler as plugin)
11 | 3. add dependencies in your app level gradle :
12 | ```
13 | implementation("com.github.sasssass.easynavigation:compose-navigation-annotation:0.4")
14 | ksp("com.github.sasssass.easynavigation:compose-navigation-annotation-helper:0.4")
15 | ```
16 | Using the @NavigationNode annotation above your composable function, you can easily specify parameters like "route", "args", and "optionalArgs". This annotation automatically generates navigation code for you, reducing boilerplate and making your navigation logic cleaner and easier to maintain.
17 |
18 | Generated Helper Code Pattern:
19 | The generated navigation helper will be named as: YOUR_COMPOSABLE_FUNCTION_NAME + GraphNode.
20 |
21 | Example Usage:
22 |
23 | ```
24 | @NavigationNode(route = "screen_with_optional_arguments", args = arrayOf("id", "name"),
25 | optionalArgs = arrayOf("age","nickName")
26 | )
27 | @Composable
28 | fun ScreenWithOptionalArguments(
29 | id: String,
30 | name: String,
31 | nickName: String?,
32 | age: String?
33 | ) {
34 | Column(modifier = Modifier.fillMaxSize()) {
35 | Text(text = "OK, you're $name with id as $name, your nick name is ${nickName?:"Undefined"}, and your age is ${age?:"Undefined"}")
36 | }
37 | }
38 | ```
39 |
40 | this gives you a generated code like this :
41 |
42 | ```
43 | public object ScreenWithOptionalArgumentsGraphNode {
44 | public val rawRoute: String = "screen_with_optional_arguments"
45 |
46 | public val route: String =
47 | "screen_with_optional_arguments/{id}/{name}?age={age}&nickName={nickName}"
48 |
49 | private val args: Array = arrayOf("id", "name")
50 |
51 | private val optionalArgs: Array = arrayOf("age", "nickName")
52 |
53 | public const val age: String = "age"
54 |
55 | public const val nickName: String = "nickName"
56 |
57 | public const val id: String = "id"
58 |
59 | public const val name: String = "name"
60 |
61 | public fun navigationRoute(
62 | id: String,
63 | name: String,
64 | age: String?,
65 | nickName: String?,
66 | ): String {
67 | val ret = buildString {
68 | append(rawRoute)
69 | append("/$id")
70 | append("/$name")
71 | append("?")
72 | if (optionalage != null) {
73 | append("age=$age")
74 | append("&")
75 | }
76 | if (optionalnickName != null) {
77 | append("nickName=$nickName")
78 | }
79 | }
80 | return ret
81 | }
82 | }
83 | ```
84 |
85 | if you don't declare args or optionalArgs for your annotation the code would be simpler and you won't see any related code for those parameters
86 |
87 | rawRoute = raw version of the route without declraing needed arguments
88 |
89 | route = processed version of route which you can pass to you NavHost
90 |
91 | navigationRoute = the fucntion which you can pass your argument and optionalArguments (if there're any) and in return it will pass you the route you need to pass to navController.navigate() function
92 |
93 | You can then navigate effortlessly with the generated helper functions:
94 |
95 | ```
96 | navController.navigate(ScreenWithOptionalArgumentsGraphNode.navigationRoute(
97 | id = id, name = name, optionalnickName = "Sadegh", optionalage = null
98 | )
99 | ```
100 | Or use it within a composable block for handling back stack entries:
101 |
102 | ```
103 | composable(ScreenWithOptionalArgumentsGraphNode.route) {backStackEntry ->
104 | val id = checkNotNull(backStackEntry.arguments?.getString(ScreenWithOptionalArgumentsGraphNode.id))
105 | val name = checkNotNull(backStackEntry.arguments?.getString(ScreenWithOptionalArgumentsGraphNode.name))
106 | val nickName = backStackEntry.arguments?.getString(ScreenWithOptionalArgumentsGraphNode.nickName)
107 | val age = backStackEntry.arguments?.getString(ScreenWithOptionalArgumentsGraphNode.age)
108 | ScreenWithOptionalArguments(
109 | name = name,
110 | id = id,
111 | nickName = nickName,
112 | age = age
113 | )
114 | }
115 | ```
116 |
--------------------------------------------------------------------------------
/app/.gitignore:
--------------------------------------------------------------------------------
1 | /build
--------------------------------------------------------------------------------
/app/build.gradle.kts:
--------------------------------------------------------------------------------
1 | plugins {
2 | alias(libs.plugins.androidApplication)
3 | alias(libs.plugins.jetbrainsKotlinAndroid)
4 | alias(libs.plugins.ksp)
5 | alias(libs.plugins.compose.compiler)
6 | }
7 |
8 | android {
9 | namespace = "sass.compose.easynavigation"
10 | compileSdk = 34
11 |
12 | defaultConfig {
13 | applicationId = "sass.compose.easynavigation"
14 | minSdk = 21
15 | targetSdk = 34
16 | versionCode = 1
17 | versionName = "1.0"
18 |
19 | testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
20 | vectorDrawables {
21 | useSupportLibrary = true
22 | }
23 | }
24 |
25 | buildTypes {
26 | release {
27 | isMinifyEnabled = false
28 | proguardFiles(
29 | getDefaultProguardFile("proguard-android-optimize.txt"),
30 | "proguard-rules.pro"
31 | )
32 | }
33 | }
34 | compileOptions {
35 | sourceCompatibility = JavaVersion.VERSION_21
36 | targetCompatibility = JavaVersion.VERSION_21
37 | }
38 | kotlinOptions {
39 | jvmTarget = "21"
40 | }
41 | buildFeatures {
42 | compose = true
43 | }
44 | composeOptions {
45 | kotlinCompilerExtensionVersion = "1.5.1"
46 | }
47 | packaging {
48 | resources {
49 | excludes += "/META-INF/{AL2.0,LGPL2.1}"
50 | }
51 | }
52 | }
53 |
54 | dependencies {
55 | implementation(libs.androidx.core.ktx)
56 | implementation(libs.androidx.lifecycle.runtime.ktx)
57 | implementation(libs.androidx.activity.compose)
58 | implementation(platform(libs.androidx.compose.bom))
59 | implementation(libs.androidx.ui)
60 | implementation(libs.androidx.ui.graphics)
61 | implementation(libs.androidx.ui.tooling.preview)
62 | implementation(libs.androidx.material3)
63 | testImplementation(libs.junit)
64 | androidTestImplementation(libs.androidx.junit)
65 | androidTestImplementation(libs.androidx.espresso.core)
66 | androidTestImplementation(platform(libs.androidx.compose.bom))
67 | androidTestImplementation(libs.androidx.ui.test.junit4)
68 | debugImplementation(libs.androidx.ui.tooling)
69 | debugImplementation(libs.androidx.ui.test.manifest)
70 | implementation(libs.androidx.navigation.compose)
71 | implementation(project(path = ":navigation:annotation"))
72 | ksp(project(path = ":navigation:processor"))
73 | }
--------------------------------------------------------------------------------
/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/sass/compose/easynavigation/ExampleInstrumentedTest.kt:
--------------------------------------------------------------------------------
1 | package sass.compose.easynavigation
2 |
3 | import androidx.compose.ui.test.junit4.createAndroidComposeRule
4 | import androidx.compose.ui.test.onNodeWithTag
5 | import androidx.compose.ui.test.performClick
6 | import androidx.test.ext.junit.runners.AndroidJUnit4
7 |
8 | import org.junit.Test
9 | import org.junit.runner.RunWith
10 |
11 | import org.junit.Rule
12 |
13 | @RunWith(AndroidJUnit4::class)
14 | class ExampleInstrumentedTest {
15 |
16 | @get:Rule
17 | val composeTestRule = createAndroidComposeRule()
18 |
19 | @Test
20 | fun useAppContext() {
21 | composeTestRule.onNodeWithTag("btn1").performClick()
22 |
23 | composeTestRule.onNodeWithTag("btn2").performClick()
24 | }
25 | }
--------------------------------------------------------------------------------
/app/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
15 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/app/src/main/java/sass/compose/easynavigation/MainActivity.kt:
--------------------------------------------------------------------------------
1 | package sass.compose.easynavigation
2 |
3 | import android.os.Bundle
4 | import androidx.activity.ComponentActivity
5 | import androidx.activity.compose.setContent
6 | import androidx.activity.enableEdgeToEdge
7 | import androidx.navigation.compose.NavHost
8 | import androidx.navigation.compose.composable
9 | import androidx.navigation.compose.rememberNavController
10 |
11 | class MainActivity : ComponentActivity() {
12 | override fun onCreate(savedInstanceState: Bundle?) {
13 | super.onCreate(savedInstanceState)
14 | enableEdgeToEdge()
15 | setContent {
16 | val navController = rememberNavController()
17 | NavHost(navController, startDestination = SimpleScreenGraphNode.route) {
18 |
19 | composable(SimpleScreenGraphNode.route) {
20 | SimpleScreen(navController = navController)
21 | }
22 |
23 | composable(ScreenWithArgumentGraphNode.route) {backStackEntry ->
24 | val id = checkNotNull(backStackEntry.arguments?.getString(ScreenWithArgumentGraphNode.id))
25 | val name = checkNotNull(backStackEntry.arguments?.getString(ScreenWithArgumentGraphNode.name))
26 |
27 | ScreenWithArgument(navController = navController, id, name)
28 | }
29 |
30 | composable(ScreenWithOptionalArgumentsGraphNode.route) {backStackEntry ->
31 | val id = checkNotNull(backStackEntry.arguments?.getString(ScreenWithOptionalArgumentsGraphNode.id))
32 | val name = checkNotNull(backStackEntry.arguments?.getString(ScreenWithOptionalArgumentsGraphNode.name))
33 | val nickName = backStackEntry.arguments?.getString(ScreenWithOptionalArgumentsGraphNode.nickName)
34 | val age = backStackEntry.arguments?.getString(ScreenWithOptionalArgumentsGraphNode.age)
35 | ScreenWithOptionalArguments(
36 | name = name,
37 | id = id,
38 | nickName = nickName,
39 | age = age
40 | )
41 | }
42 | }
43 | }
44 | }
45 | }
--------------------------------------------------------------------------------
/app/src/main/java/sass/compose/easynavigation/ScreenWithArgument.kt:
--------------------------------------------------------------------------------
1 | package sass.compose.easynavigation
2 |
3 | import androidx.compose.foundation.layout.Arrangement
4 | import androidx.compose.foundation.layout.Column
5 | import androidx.compose.foundation.layout.fillMaxSize
6 | import androidx.compose.material3.Button
7 | import androidx.compose.material3.Text
8 | import androidx.compose.runtime.Composable
9 | import androidx.compose.ui.Alignment
10 | import androidx.compose.ui.Modifier
11 | import androidx.compose.ui.platform.testTag
12 | import androidx.navigation.NavController
13 | import sass.compose.annotation.NavigationNode
14 |
15 | @NavigationNode(route = "sample_screen")
16 | @Composable
17 | fun SimpleScreen(navController: NavController) {
18 | Column(modifier = Modifier.fillMaxSize(),
19 | verticalArrangement = Arrangement.Center,
20 | horizontalAlignment = Alignment.CenterHorizontally) {
21 | Button(modifier = Modifier.testTag("btn1"), onClick = {
22 | navController.navigate(ScreenWithArgumentGraphNode.navigationRoute(
23 | id = "123", name = "Ali"
24 | ))
25 | }) {
26 | Text(text = "Go To Screen with Arguments")
27 | }
28 | }
29 | }
30 |
31 | @NavigationNode(route = "screen_with_argument", args = arrayOf("id", "name"))
32 | @Composable
33 | fun ScreenWithArgument(navController: NavController, id: String, name: String) {
34 | Column(modifier = Modifier.fillMaxSize(),
35 | verticalArrangement = Arrangement.Center,
36 | horizontalAlignment = Alignment.CenterHorizontally) {
37 | Text(text = "You're $name with id as $id")
38 | Button(modifier = Modifier.testTag("btn2"), onClick = {
39 | navController.navigate(ScreenWithOptionalArgumentsGraphNode.navigationRoute(
40 | id = id, name = name, nickName = "Sadegh", age = null
41 | ))
42 | }) {
43 | Text(text = "Go To Screen with Optional Arguments")
44 | }
45 | }
46 | }
47 |
48 | @NavigationNode(route = "screen_with_optional_arguments", args = arrayOf("id", "name"),
49 | optionalArgs = arrayOf("age","nickName")
50 | )
51 | @Composable
52 | fun ScreenWithOptionalArguments(
53 | id: String,
54 | name: String,
55 | nickName: String?,
56 | age: String?
57 | ) {
58 | Column(modifier = Modifier.fillMaxSize(),
59 | verticalArrangement = Arrangement.Center,
60 | horizontalAlignment = Alignment.CenterHorizontally) {
61 | Text(text = "OK, you're $name with id as $name, your nick name is ${nickName?:"Undefined"}, and your age is ${age?:"Undefined"}")
62 | }
63 | }
--------------------------------------------------------------------------------
/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/mipmap-anydpi-v26/ic_launcher.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-hdpi/ic_launcher.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sasssass/easynavigation/f23647689e94f9d2cc413aaf6c8aaf553bf79757/app/src/main/res/mipmap-hdpi/ic_launcher.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sasssass/easynavigation/f23647689e94f9d2cc413aaf6c8aaf553bf79757/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-mdpi/ic_launcher.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sasssass/easynavigation/f23647689e94f9d2cc413aaf6c8aaf553bf79757/app/src/main/res/mipmap-mdpi/ic_launcher.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sasssass/easynavigation/f23647689e94f9d2cc413aaf6c8aaf553bf79757/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xhdpi/ic_launcher.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sasssass/easynavigation/f23647689e94f9d2cc413aaf6c8aaf553bf79757/app/src/main/res/mipmap-xhdpi/ic_launcher.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sasssass/easynavigation/f23647689e94f9d2cc413aaf6c8aaf553bf79757/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sasssass/easynavigation/f23647689e94f9d2cc413aaf6c8aaf553bf79757/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sasssass/easynavigation/f23647689e94f9d2cc413aaf6c8aaf553bf79757/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sasssass/easynavigation/f23647689e94f9d2cc413aaf6c8aaf553bf79757/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sasssass/easynavigation/f23647689e94f9d2cc413aaf6c8aaf553bf79757/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp
--------------------------------------------------------------------------------
/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 | Easy Navigation
3 |
--------------------------------------------------------------------------------
/app/src/main/res/values/themes.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/app/src/main/res/xml/backup_rules.xml:
--------------------------------------------------------------------------------
1 |
8 |
9 |
13 |
--------------------------------------------------------------------------------
/app/src/main/res/xml/data_extraction_rules.xml:
--------------------------------------------------------------------------------
1 |
6 |
7 |
8 |
12 |
13 |
19 |
--------------------------------------------------------------------------------
/app/src/test/java/sass/compose/easynavigation/ExampleUnitTest.kt:
--------------------------------------------------------------------------------
1 | package sass.compose.easynavigation
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.kts:
--------------------------------------------------------------------------------
1 | // Top-level build file where you can add configuration options common to all sub-projects/modules.
2 | plugins {
3 | alias(libs.plugins.androidApplication) apply false
4 | alias(libs.plugins.jetbrainsKotlinAndroid) apply false
5 | alias(libs.plugins.jetbrainsKotlinJvm) apply false
6 | alias(libs.plugins.ksp) apply false
7 | alias(libs.plugins.androidLibrary) apply false
8 | alias(libs.plugins.compose.compiler) apply false
9 | }
--------------------------------------------------------------------------------
/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. For more details, visit
12 | # https://developer.android.com/r/tools/gradle-multi-project-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 | # Kotlin code style for this project: "official" or "obsolete":
19 | kotlin.code.style=official
20 | # Enables namespacing of each library's R class so that its R class includes only the
21 | # resources declared in the library itself and none from the library's dependencies,
22 | # thereby reducing the size of the R class for that library
23 | android.nonTransitiveRClass=true
--------------------------------------------------------------------------------
/gradle/libs.versions.toml:
--------------------------------------------------------------------------------
1 | [versions]
2 | agp = "8.3.2"
3 | kotlin = "2.0.0"
4 | coreKtx = "1.13.1"
5 | junit = "4.13.2"
6 | junitVersion = "1.2.1"
7 | espressoCore = "3.6.1"
8 | lifecycleRuntimeKtx = "2.8.6"
9 | activityCompose = "1.9.2"
10 | composeBom = "2024.09.03"
11 | jetbrainsKotlinJvm = "2.0.0"
12 | ksp = "2.0.0-1.0.21"
13 | appcompat = "1.7.0"
14 | material = "1.12.0"
15 | navigationCompose = "2.8.2"
16 | symbolProcessing = "2.0.0-1.0.21"
17 | kotlinpoet = "1.16.0"
18 |
19 | [libraries]
20 | androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" }
21 | androidx-navigation-compose = { module = "androidx.navigation:navigation-compose", version.ref = "navigationCompose" }
22 | junit = { group = "junit", name = "junit", version.ref = "junit" }
23 | androidx-junit = { group = "androidx.test.ext", name = "junit", version.ref = "junitVersion" }
24 | androidx-espresso-core = { group = "androidx.test.espresso", name = "espresso-core", version.ref = "espressoCore" }
25 | androidx-lifecycle-runtime-ktx = { group = "androidx.lifecycle", name = "lifecycle-runtime-ktx", version.ref = "lifecycleRuntimeKtx" }
26 | androidx-activity-compose = { group = "androidx.activity", name = "activity-compose", version.ref = "activityCompose" }
27 | androidx-compose-bom = { group = "androidx.compose", name = "compose-bom", version.ref = "composeBom" }
28 | androidx-ui = { group = "androidx.compose.ui", name = "ui" }
29 | androidx-ui-graphics = { group = "androidx.compose.ui", name = "ui-graphics" }
30 | androidx-ui-tooling = { group = "androidx.compose.ui", name = "ui-tooling" }
31 | androidx-ui-tooling-preview = { group = "androidx.compose.ui", name = "ui-tooling-preview" }
32 | androidx-ui-test-manifest = { group = "androidx.compose.ui", name = "ui-test-manifest" }
33 | androidx-ui-test-junit4 = { group = "androidx.compose.ui", name = "ui-test-junit4" }
34 | androidx-material3 = { group = "androidx.compose.material3", name = "material3" }
35 | androidx-appcompat = { group = "androidx.appcompat", name = "appcompat", version.ref = "appcompat" }
36 | material = { group = "com.google.android.material", name = "material", version.ref = "material" }
37 | symbol-processing = { group = "com.google.devtools.ksp" , name = "symbol-processing-api", version.ref = "symbolProcessing"}
38 | kotlinpoet = { group = "com.squareup" , name = "kotlinpoet-ksp" , version.ref = "kotlinpoet"}
39 |
40 | [plugins]
41 | androidApplication = { id = "com.android.application", version.ref = "agp" }
42 | jetbrainsKotlinAndroid = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
43 | jetbrainsKotlinJvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "jetbrainsKotlinJvm" }
44 | ksp = { id = "com.google.devtools.ksp" , version.ref = "ksp"}
45 | androidLibrary = { id = "com.android.library", version.ref = "agp" }
46 | compose-compiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sasssass/easynavigation/f23647689e94f9d2cc413aaf6c8aaf553bf79757/gradle/wrapper/gradle-wrapper.jar
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | #Tue Oct 15 13:25:06 CEST 2024
2 | distributionBase=GRADLE_USER_HOME
3 | distributionPath=wrapper/dists
4 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
5 | zipStoreBase=GRADLE_USER_HOME
6 | zipStorePath=wrapper/dists
7 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | #
4 | # Copyright 2015 the original author or authors.
5 | #
6 | # Licensed under the Apache License, Version 2.0 (the "License");
7 | # you may not use this file except in compliance with the License.
8 | # You may obtain a copy of the License at
9 | #
10 | # https://www.apache.org/licenses/LICENSE-2.0
11 | #
12 | # Unless required by applicable law or agreed to in writing, software
13 | # distributed under the License is distributed on an "AS IS" BASIS,
14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | # See the License for the specific language governing permissions and
16 | # limitations under the License.
17 | #
18 |
19 | ##############################################################################
20 | ##
21 | ## Gradle start up script for UN*X
22 | ##
23 | ##############################################################################
24 |
25 | # Attempt to set APP_HOME
26 | # Resolve links: $0 may be a link
27 | PRG="$0"
28 | # Need this for relative symlinks.
29 | while [ -h "$PRG" ] ; do
30 | ls=`ls -ld "$PRG"`
31 | link=`expr "$ls" : '.*-> \(.*\)$'`
32 | if expr "$link" : '/.*' > /dev/null; then
33 | PRG="$link"
34 | else
35 | PRG=`dirname "$PRG"`"/$link"
36 | fi
37 | done
38 | SAVED="`pwd`"
39 | cd "`dirname \"$PRG\"`/" >/dev/null
40 | APP_HOME="`pwd -P`"
41 | cd "$SAVED" >/dev/null
42 |
43 | APP_NAME="Gradle"
44 | APP_BASE_NAME=`basename "$0"`
45 |
46 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
47 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
48 |
49 | # Use the maximum available, or set MAX_FD != -1 to use that value.
50 | MAX_FD="maximum"
51 |
52 | warn () {
53 | echo "$*"
54 | }
55 |
56 | die () {
57 | echo
58 | echo "$*"
59 | echo
60 | exit 1
61 | }
62 |
63 | # OS specific support (must be 'true' or 'false').
64 | cygwin=false
65 | msys=false
66 | darwin=false
67 | nonstop=false
68 | case "`uname`" in
69 | CYGWIN* )
70 | cygwin=true
71 | ;;
72 | Darwin* )
73 | darwin=true
74 | ;;
75 | MINGW* )
76 | msys=true
77 | ;;
78 | NONSTOP* )
79 | nonstop=true
80 | ;;
81 | esac
82 |
83 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
84 |
85 |
86 | # Determine the Java command to use to start the JVM.
87 | if [ -n "$JAVA_HOME" ] ; then
88 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
89 | # IBM's JDK on AIX uses strange locations for the executables
90 | JAVACMD="$JAVA_HOME/jre/sh/java"
91 | else
92 | JAVACMD="$JAVA_HOME/bin/java"
93 | fi
94 | if [ ! -x "$JAVACMD" ] ; then
95 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
96 |
97 | Please set the JAVA_HOME variable in your environment to match the
98 | location of your Java installation."
99 | fi
100 | else
101 | JAVACMD="java"
102 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
103 |
104 | Please set the JAVA_HOME variable in your environment to match the
105 | location of your Java installation."
106 | fi
107 |
108 | # Increase the maximum file descriptors if we can.
109 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
110 | MAX_FD_LIMIT=`ulimit -H -n`
111 | if [ $? -eq 0 ] ; then
112 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
113 | MAX_FD="$MAX_FD_LIMIT"
114 | fi
115 | ulimit -n $MAX_FD
116 | if [ $? -ne 0 ] ; then
117 | warn "Could not set maximum file descriptor limit: $MAX_FD"
118 | fi
119 | else
120 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
121 | fi
122 | fi
123 |
124 | # For Darwin, add options to specify how the application appears in the dock
125 | if $darwin; then
126 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
127 | fi
128 |
129 | # For Cygwin or MSYS, switch paths to Windows format before running java
130 | if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
131 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
132 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
133 |
134 | JAVACMD=`cygpath --unix "$JAVACMD"`
135 |
136 | # We build the pattern for arguments to be converted via cygpath
137 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
138 | SEP=""
139 | for dir in $ROOTDIRSRAW ; do
140 | ROOTDIRS="$ROOTDIRS$SEP$dir"
141 | SEP="|"
142 | done
143 | OURCYGPATTERN="(^($ROOTDIRS))"
144 | # Add a user-defined pattern to the cygpath arguments
145 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
146 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
147 | fi
148 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
149 | i=0
150 | for arg in "$@" ; do
151 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
152 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
153 |
154 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
155 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
156 | else
157 | eval `echo args$i`="\"$arg\""
158 | fi
159 | i=`expr $i + 1`
160 | done
161 | case $i in
162 | 0) set -- ;;
163 | 1) set -- "$args0" ;;
164 | 2) set -- "$args0" "$args1" ;;
165 | 3) set -- "$args0" "$args1" "$args2" ;;
166 | 4) set -- "$args0" "$args1" "$args2" "$args3" ;;
167 | 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
168 | 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
169 | 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
170 | 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
171 | 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
172 | esac
173 | fi
174 |
175 | # Escape application args
176 | save () {
177 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
178 | echo " "
179 | }
180 | APP_ARGS=`save "$@"`
181 |
182 | # Collect all arguments for the java command, following the shell quoting and substitution rules
183 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
184 |
185 | exec "$JAVACMD" "$@"
186 |
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @rem
2 | @rem Copyright 2015 the original author or authors.
3 | @rem
4 | @rem Licensed under the Apache License, Version 2.0 (the "License");
5 | @rem you may not use this file except in compliance with the License.
6 | @rem You may obtain a copy of the License at
7 | @rem
8 | @rem https://www.apache.org/licenses/LICENSE-2.0
9 | @rem
10 | @rem Unless required by applicable law or agreed to in writing, software
11 | @rem distributed under the License is distributed on an "AS IS" BASIS,
12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | @rem See the License for the specific language governing permissions and
14 | @rem limitations under the License.
15 | @rem
16 |
17 | @if "%DEBUG%" == "" @echo off
18 | @rem ##########################################################################
19 | @rem
20 | @rem Gradle startup script for Windows
21 | @rem
22 | @rem ##########################################################################
23 |
24 | @rem Set local scope for the variables with windows NT shell
25 | if "%OS%"=="Windows_NT" setlocal
26 |
27 | set DIRNAME=%~dp0
28 | if "%DIRNAME%" == "" set DIRNAME=.
29 | set APP_BASE_NAME=%~n0
30 | set APP_HOME=%DIRNAME%
31 |
32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter.
33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
34 |
35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
37 |
38 | @rem Find java.exe
39 | if defined JAVA_HOME goto findJavaFromJavaHome
40 |
41 | set JAVA_EXE=java.exe
42 | %JAVA_EXE% -version >NUL 2>&1
43 | if "%ERRORLEVEL%" == "0" goto execute
44 |
45 | echo.
46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
47 | echo.
48 | echo Please set the JAVA_HOME variable in your environment to match the
49 | echo location of your Java installation.
50 |
51 | goto fail
52 |
53 | :findJavaFromJavaHome
54 | set JAVA_HOME=%JAVA_HOME:"=%
55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
56 |
57 | if exist "%JAVA_EXE%" goto execute
58 |
59 | echo.
60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
61 | echo.
62 | echo Please set the JAVA_HOME variable in your environment to match the
63 | echo location of your Java installation.
64 |
65 | goto fail
66 |
67 | :execute
68 | @rem Setup the command line
69 |
70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
71 |
72 |
73 | @rem Execute Gradle
74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
75 |
76 | :end
77 | @rem End local scope for the variables with windows NT shell
78 | if "%ERRORLEVEL%"=="0" goto mainEnd
79 |
80 | :fail
81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
82 | rem the _cmd.exe /c_ return code!
83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
84 | exit /b 1
85 |
86 | :mainEnd
87 | if "%OS%"=="Windows_NT" endlocal
88 |
89 | :omega
90 |
--------------------------------------------------------------------------------
/navigation/annotation/.gitignore:
--------------------------------------------------------------------------------
1 | /build
--------------------------------------------------------------------------------
/navigation/annotation/build.gradle.kts:
--------------------------------------------------------------------------------
1 | plugins {
2 | id("java-library")
3 | alias(libs.plugins.jetbrainsKotlinJvm)
4 | id("maven-publish")
5 | }
6 |
7 | java {
8 | sourceCompatibility = JavaVersion.VERSION_17
9 | targetCompatibility = JavaVersion.VERSION_17
10 | }
11 |
12 |
13 | tasks.withType {
14 | kotlinOptions {
15 | jvmTarget = "17" // Set this to match your Java target
16 | }
17 | }
18 |
19 | afterEvaluate {
20 | publishing {
21 | publications {
22 | create("release") {
23 | from(components["java"])
24 |
25 | groupId = "com.github.sasssass"
26 | artifactId = "compose-navigation-annotation"
27 | version = "0.2"
28 | }
29 | }
30 | }
31 | }
--------------------------------------------------------------------------------
/navigation/annotation/src/main/java/sass/compose/annotation/NavigationNode.kt:
--------------------------------------------------------------------------------
1 | package sass.compose.annotation
2 |
3 | @Target(AnnotationTarget.FUNCTION)
4 | @Retention(AnnotationRetention.RUNTIME)
5 | annotation class NavigationNode(
6 | val route: String,
7 | val args: Array = [],
8 | val optionalArgs: Array = []
9 | )
10 |
11 |
12 |
--------------------------------------------------------------------------------
/navigation/processor/.gitignore:
--------------------------------------------------------------------------------
1 | /build
--------------------------------------------------------------------------------
/navigation/processor/build.gradle.kts:
--------------------------------------------------------------------------------
1 | plugins {
2 | alias(libs.plugins.jetbrainsKotlinJvm)
3 | alias(libs.plugins.ksp)
4 | id("maven-publish")
5 | }
6 |
7 | java {
8 | sourceCompatibility = JavaVersion.VERSION_17
9 | targetCompatibility = JavaVersion.VERSION_17
10 | }
11 |
12 | tasks.withType {
13 | kotlinOptions {
14 | jvmTarget = "17" // Set this to match your Java target
15 | }
16 | }
17 |
18 | dependencies {
19 | implementation(project(":navigation:annotation"))
20 | implementation(libs.symbol.processing)
21 | implementation(libs.kotlinpoet)
22 | }
23 |
24 | afterEvaluate {
25 | publishing {
26 | publications {
27 | create("release") {
28 | from(components["java"])
29 |
30 | groupId = "com.github.sasssass"
31 | artifactId = "compose-navigation-annotation-helper"
32 | version = "0.2"
33 | }
34 | }
35 | }
36 | }
--------------------------------------------------------------------------------
/navigation/processor/src/main/java/sass/compose/processor/NodeProcessor.kt:
--------------------------------------------------------------------------------
1 | package sass.compose.processor
2 |
3 | import com.google.devtools.ksp.processing.CodeGenerator
4 | import com.google.devtools.ksp.processing.Dependencies
5 | import com.google.devtools.ksp.processing.KSPLogger
6 | import com.google.devtools.ksp.processing.Resolver
7 | import com.google.devtools.ksp.processing.SymbolProcessor
8 | import com.google.devtools.ksp.symbol.KSAnnotated
9 | import com.google.devtools.ksp.symbol.KSFunctionDeclaration
10 | import com.google.devtools.ksp.validate
11 | import com.squareup.kotlinpoet.FileSpec
12 | import com.squareup.kotlinpoet.FunSpec
13 | import com.squareup.kotlinpoet.KModifier
14 | import com.squareup.kotlinpoet.ParameterizedTypeName.Companion.parameterizedBy
15 | import com.squareup.kotlinpoet.PropertySpec
16 | import com.squareup.kotlinpoet.TypeSpec
17 | import com.squareup.kotlinpoet.asTypeName
18 | import sass.compose.annotation.NavigationNode
19 |
20 | class NodeProcessor(
21 | private val logger: KSPLogger,
22 | private val codeGenerator: CodeGenerator
23 | ): SymbolProcessor {
24 | override fun process(resolver: Resolver): List {
25 | logger.info("NodeProcessor was invoked.")
26 | val symbols = resolver.getSymbolsWithAnnotation(NavigationNode::class.qualifiedName!!)
27 | val ret = mutableListOf()
28 | symbols.forEach { symbol ->
29 | if (symbol is KSFunctionDeclaration && symbol.validate()) {
30 | val annotation = symbol.annotations.first { it.shortName.asString() == "NavigationNode" }
31 | val route = annotation.arguments.first { it.name?.asString() == "route" }.value as String
32 | val args = annotation.arguments.first { it.name?.asString() == "args" }.value as ArrayList
33 | val optionalArgs = annotation.arguments.first { it.name?.asString() == "optionalArgs" }.value as ArrayList
34 | generateCode(symbol, route, args, optionalArgs)
35 | } else {
36 | ret.add(symbol)
37 | }
38 | }
39 | return ret
40 | }
41 |
42 | private fun generateCode(symbol: KSFunctionDeclaration, route: String, args: ArrayList,
43 | optionalArgs: ArrayList) {
44 | val functionName = symbol.simpleName.asString()
45 | val packageName = symbol.packageName.asString()
46 | val fileName = "${functionName}GraphNode"
47 |
48 | val typeBuilder = TypeSpec.objectBuilder(fileName)
49 | typeBuilder.addProperty(
50 | PropertySpec.builder("rawRoute", String::class).initializer("%S", route).addModifiers(
51 | KModifier.PUBLIC).build()
52 | ).addProperty(
53 | PropertySpec.builder("route", String::class).initializer("%S", generateRoute(
54 | route, args, optionalArgs
55 | )).addModifiers(
56 | KModifier.PUBLIC).build()
57 | ).addProperty(
58 | PropertySpec.builder("args", Array::class.parameterizedBy(String::class))
59 | .initializer("arrayOf(${args.joinToString { "\"$it\"" }})")
60 | .addModifiers(KModifier.PRIVATE)
61 | .build()
62 | ).addProperty(
63 | PropertySpec.builder("optionalArgs", Array::class.parameterizedBy(String::class))
64 | .initializer("arrayOf(${optionalArgs.joinToString { "\"$it\"" }})")
65 | .addModifiers(KModifier.PRIVATE)
66 | .build()
67 | ).addFunction(generateNavigationRoute(args, optionalArgs))
68 |
69 | optionalArgs.forEach {
70 | typeBuilder.addProperty(
71 | PropertySpec.builder("$it",String::class).initializer("%S", it).addModifiers(KModifier.CONST).build()
72 | )
73 | }
74 |
75 | args.forEach {
76 | typeBuilder.addProperty(
77 | PropertySpec.builder("$it",String::class).initializer("%S", it).addModifiers(KModifier.CONST).build()
78 | )
79 | }
80 |
81 |
82 | val fileSpec = FileSpec.builder(packageName, fileName).addType(typeBuilder.build()).build()
83 |
84 | val dependencies = Dependencies(false, symbol.containingFile!!)
85 | val file = codeGenerator.createNewFile(dependencies, packageName, fileName)
86 | file.bufferedWriter().use { fileSpec.writeTo(it) }
87 | }
88 |
89 | private fun generateRoute(rawRoute: String, args: ArrayList, optionalArgs: ArrayList): String {
90 | val route = buildString {
91 | append(rawRoute)
92 |
93 | args.forEach {
94 | append("/{$it}")
95 | }
96 | if (optionalArgs.isNotEmpty()) {
97 | append("?")
98 |
99 | optionalArgs.forEachIndexed { index, it ->
100 | append("$it={$it}")
101 | if (index < optionalArgs.size - 1) {
102 | append("&")
103 | }
104 | }
105 | }
106 | }
107 |
108 | return route
109 | }
110 |
111 |
112 |
113 | private fun generateNavigationRoute(args: ArrayList, optionalArgs: ArrayList): FunSpec {
114 | val funBuilder = FunSpec.builder("navigationRoute")
115 |
116 | val argsCode = buildString {
117 | args.forEach {
118 | funBuilder.addParameter(
119 | "$it",
120 | String::class
121 | )
122 |
123 | append("""
124 | append("/${'$'}$it")
125 | """.trimIndent())
126 | append("\n")
127 | }
128 | }
129 | val optionalArgsCode = buildString {
130 | optionalArgs.forEachIndexed { index, it ->
131 | funBuilder.addParameter(
132 | "$it",
133 | String::class.asTypeName().copy(nullable = true)
134 | )
135 |
136 | if (index == 0)
137 | append("append(\"?\")")
138 | append("\n")
139 | append("""
140 | if ($it != null) {
141 | append("$it=${'$'}$it")
142 | """.trimIndent())
143 | append("\n")
144 | if (index < optionalArgs.size - 1) {
145 | append("\t")
146 | append("""
147 | append("&")
148 | """.trimIndent())
149 | append("\n")
150 | }
151 | append("}")
152 | }
153 | }
154 |
155 | val code = buildString {
156 | append("val ret = buildString {\n")
157 | append("append(rawRoute)\n")
158 | append(argsCode)
159 | append(optionalArgsCode)
160 | append("\n}\n")
161 | append("return ret")
162 | }
163 |
164 | funBuilder.returns(String::class).addCode(
165 | code
166 | )
167 |
168 | return funBuilder.build()
169 | }
170 | }
--------------------------------------------------------------------------------
/navigation/processor/src/main/java/sass/compose/processor/NodeProcessorProvider.kt:
--------------------------------------------------------------------------------
1 | package sass.compose.processor
2 |
3 | import com.google.devtools.ksp.processing.SymbolProcessor
4 | import com.google.devtools.ksp.processing.SymbolProcessorEnvironment
5 | import com.google.devtools.ksp.processing.SymbolProcessorProvider
6 |
7 |
8 | class NodeProcessorProvider : SymbolProcessorProvider {
9 |
10 | override fun create(environment: SymbolProcessorEnvironment): SymbolProcessor {
11 | return NodeProcessor(
12 | logger = environment.logger,
13 | codeGenerator = environment.codeGenerator
14 | )
15 | }
16 | }
--------------------------------------------------------------------------------
/navigation/processor/src/main/resources/META-INF/services/com.google.devtools.ksp.processing.SymbolProcessorProvider:
--------------------------------------------------------------------------------
1 | sass.compose.processor.NodeProcessorProvider
--------------------------------------------------------------------------------
/settings.gradle.kts:
--------------------------------------------------------------------------------
1 | pluginManagement {
2 | repositories {
3 | google {
4 | content {
5 | includeGroupByRegex("com\\.android.*")
6 | includeGroupByRegex("com\\.google.*")
7 | includeGroupByRegex("androidx.*")
8 | }
9 | }
10 | mavenCentral()
11 | gradlePluginPortal()
12 | }
13 | }
14 | dependencyResolutionManagement {
15 | repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
16 | repositories {
17 | google()
18 | mavenCentral()
19 | }
20 | }
21 |
22 | rootProject.name = "Easy Navigation"
23 | include(":app")
24 | include(":navigation")
25 | include(":navigation:annotation")
26 | include(":navigation:processor")
27 |
--------------------------------------------------------------------------------