18 |
--------------------------------------------------------------------------------
/app/src/main/java/com/prudhvir3ddy/todo_app_gettingthingsdone/view/login/LoginViewModel.kt:
--------------------------------------------------------------------------------
1 | package com.prudhvir3ddy.todo_app_gettingthingsdone.view.login
2 |
3 | import androidx.lifecycle.LiveData
4 | import androidx.lifecycle.MutableLiveData
5 | import androidx.lifecycle.ViewModel
6 | import com.prudhvir3ddy.todo_app_gettingthingsdone.storage.SharedPrefs
7 | import dagger.hilt.android.lifecycle.HiltViewModel
8 | import javax.inject.Inject
9 |
10 | @HiltViewModel
11 | class LoginViewModel @Inject constructor(
12 | private val sharedPrefs: SharedPrefs
13 | ) : ViewModel() {
14 |
15 | private val _loginState = MutableLiveData(false)
16 | val loginState: LiveData = _loginState
17 |
18 | fun getStarted(fullName: String) {
19 | sharedPrefs.setLogin(true)
20 | sharedPrefs.setFullName(fullName)
21 | }
22 |
23 | fun checkLogin() = sharedPrefs.getLogin()
24 |
25 | }
--------------------------------------------------------------------------------
/app/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
13 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
--------------------------------------------------------------------------------
/app/src/main/java/com/prudhvir3ddy/todo_app_gettingthingsdone/di/AppModule.kt:
--------------------------------------------------------------------------------
1 | package com.prudhvir3ddy.todo_app_gettingthingsdone.di
2 |
3 | import android.content.Context
4 | import com.prudhvir3ddy.todo_app_gettingthingsdone.storage.SharedPrefs
5 | import com.prudhvir3ddy.todo_app_gettingthingsdone.storage.db.ToDoDatabase
6 | import dagger.Module
7 | import dagger.Provides
8 | import dagger.hilt.InstallIn
9 | import dagger.hilt.android.qualifiers.ApplicationContext
10 | import dagger.hilt.components.SingletonComponent
11 | import javax.inject.Singleton
12 |
13 | @InstallIn(SingletonComponent::class)
14 | @Module
15 | class AppModule {
16 |
17 | @Singleton
18 | @Provides
19 | fun provideSharedPrefs(@ApplicationContext context: Context): SharedPrefs {
20 | return SharedPrefs(context)
21 | }
22 |
23 | @Singleton
24 | @Provides
25 | fun provideToDoDatabase(@ApplicationContext context: Context): ToDoDatabase {
26 | return ToDoDatabase.getInstance(context)
27 | }
28 | }
--------------------------------------------------------------------------------
/.github/workflows/android.yml:
--------------------------------------------------------------------------------
1 | name: Android CI
2 |
3 | on:
4 | push:
5 | branches:
6 | - master
7 | - develop
8 |
9 | jobs:
10 | build:
11 | runs-on: ubuntu-latest
12 |
13 | steps:
14 | - uses: actions/checkout@v2
15 | - name: pre-ci
16 | env:
17 | GOOGLE_SERVICES: ${{ secrets.GOOGLE_SERVICES }}
18 | KEY_STORE: ${{ secrets.KEY_STORE }}
19 | run: bash scripts/addSecrets.sh
20 | - name: Lint check
21 | run: ./gradlew lint
22 | - name: set up JDK 11
23 | uses: actions/setup-java@v2
24 | with:
25 | distribution: 'adopt'
26 | java-version: '11'
27 | - name: Build with Gradle
28 | run: ./gradlew assembleRelease
29 | - name: Upload app APK
30 | uses: actions/upload-artifact@v1
31 | with:
32 | name: app
33 | path: app/build/outputs/apk/
34 | - name: upload code coverage reports
35 | run: bash <(curl -s https://codecov.io/bash)
36 |
--------------------------------------------------------------------------------
/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
22 |
23 | -keepnames class com.prudhvir3ddy.todo_app_gettingthingsdone.view.task.UniqueTaskFragment$Companion$TaskType
24 | -keepnames class com.prudhvir3ddy.todo_app_gettingthingsdone.storage.db.ToDo
--------------------------------------------------------------------------------
/app/src/main/java/com/prudhvir3ddy/todo_app_gettingthingsdone/storage/db/ToDoDao.kt:
--------------------------------------------------------------------------------
1 | package com.prudhvir3ddy.todo_app_gettingthingsdone.storage.db
2 |
3 | import androidx.room.Dao
4 | import androidx.room.Insert
5 | import androidx.room.OnConflictStrategy
6 | import androidx.room.Query
7 | import androidx.room.Update
8 | import kotlinx.coroutines.flow.Flow
9 |
10 | @Dao
11 | interface ToDoDao {
12 |
13 | @Query("SELECT * FROM todo")
14 | fun getAllToDos(): Flow>
15 |
16 | @Insert(onConflict = OnConflictStrategy.REPLACE)
17 | suspend fun insertToDo(toDo: ToDo)
18 |
19 | @Update
20 | suspend fun updateToDo(toDo: ToDo)
21 |
22 | @Query("DELETE FROM todo WHERE id =:taskId")
23 | suspend fun delete(taskId: String?)
24 |
25 | @Query("DELETE FROM todo WHERE isCompleted =:status")
26 | suspend fun deleteCompleted(status: Boolean)
27 |
28 | @Insert(onConflict = OnConflictStrategy.REPLACE)
29 | suspend fun addToDos(todoList: List)
30 |
31 | @Query("SELECT * FROM todo WHERE id=:taskId LIMIT 1")
32 | suspend fun getTaskById(taskId: String?): ToDo
33 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/prudhvir3ddy/todo_app_gettingthingsdone/repository/ToDoRepository.kt:
--------------------------------------------------------------------------------
1 | package com.prudhvir3ddy.todo_app_gettingthingsdone.repository
2 |
3 | import com.prudhvir3ddy.todo_app_gettingthingsdone.storage.db.ToDo
4 | import com.prudhvir3ddy.todo_app_gettingthingsdone.storage.db.ToDoDatabase
5 | import kotlinx.coroutines.flow.Flow
6 | import javax.inject.Inject
7 |
8 | /**
9 | * Not running most database queries on i/o thread
10 | * because room will shift itself
11 | */
12 | class ToDoRepository @Inject constructor(
13 | private val toDoDatabase: ToDoDatabase
14 | ) {
15 |
16 | suspend fun addToDo(todo: ToDo) = toDoDatabase.todoDao().insertToDo(todo)
17 |
18 | fun getAllToDos(): Flow> = toDoDatabase.todoDao().getAllToDos()
19 |
20 | suspend fun updateToDo(todo: ToDo) = toDoDatabase.todoDao().updateToDo(todo)
21 |
22 | suspend fun deleteToDo(taskId: String?) = toDoDatabase.todoDao().delete(taskId)
23 |
24 | suspend fun addToDos(todoList: List) = toDoDatabase.todoDao().addToDos(todoList)
25 |
26 | suspend fun getTaskById(taskId: String?) = toDoDatabase.todoDao().getTaskById(taskId)
27 |
28 | }
--------------------------------------------------------------------------------
/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=-Xmx1536m
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
22 |
--------------------------------------------------------------------------------
/app/mock-google-services.json:
--------------------------------------------------------------------------------
1 | {
2 | "project_info": {
3 | "project_number": "",
4 | "project_id": ""
5 | },
6 | "client": [
7 | {
8 | "client_info": {
9 | "mobilesdk_app_id": "1:799842443839:android:c7220d3e3eb8745e630e8a",
10 | "android_client_info": {
11 | "package_name": "com.prudhvir3ddy.todo_app_gettingthingsdone"
12 | }
13 | },
14 | "oauth_client": [
15 | {
16 | "client_id": "",
17 | "client_type": 3
18 | },
19 | {
20 | "client_id": "",
21 | "client_type": 1,
22 | "android_info": {
23 | "package_name": "com.prudhvir3ddy.todo_app_gettingthingsdone",
24 | "certificate_hash": ""
25 | }
26 | }
27 | ],
28 | "api_key": [
29 | {
30 | "current_key": ""
31 | }
32 | ],
33 | "services": {
34 | "analytics_service": {
35 | "status": 2,
36 | "analytics_property": {
37 | "tracking_id": ""
38 | }
39 | },
40 | "appinvite_service": {
41 | "status": 1,
42 | "other_platform_oauth_client": []
43 | },
44 | "ads_service": {
45 | "status": 1
46 | }
47 | }
48 | }
49 | ],
50 | "configuration_version": "1"
51 | }
52 |
--------------------------------------------------------------------------------
/app/src/main/java/com/prudhvir3ddy/todo_app_gettingthingsdone/storage/SharedPrefs.kt:
--------------------------------------------------------------------------------
1 | package com.prudhvir3ddy.todo_app_gettingthingsdone.storage
2 |
3 | import android.content.Context
4 | import android.content.SharedPreferences
5 | import com.prudhvir3ddy.todo_app_gettingthingsdone.storage.SharedPrefs.PrefConstants.FULL_NAME
6 | import com.prudhvir3ddy.todo_app_gettingthingsdone.storage.SharedPrefs.PrefConstants.IS_LOGGED_IN
7 | import com.prudhvir3ddy.todo_app_gettingthingsdone.storage.SharedPrefs.PrefConstants.TODO_APP_PREFS
8 |
9 | class SharedPrefs(context: Context) {
10 |
11 | object PrefConstants {
12 | const val TODO_APP_PREFS = "todoAppPrefs"
13 | const val IS_LOGGED_IN = "isLoggedIn"
14 | const val FULL_NAME = "firstName"
15 | }
16 |
17 | private val sharedPreferences: SharedPreferences =
18 | context.getSharedPreferences(TODO_APP_PREFS, Context.MODE_PRIVATE)
19 |
20 | private val editor: SharedPreferences.Editor = sharedPreferences.edit()
21 |
22 | fun setLogin(login: Boolean) {
23 | editor.putBoolean(IS_LOGGED_IN, login)
24 | editor.commit()
25 | }
26 |
27 | fun setFullName(fullName: String) {
28 | editor.putString(FULL_NAME, fullName)
29 | editor.commit()
30 | }
31 |
32 | fun getFullName(): String = sharedPreferences.getString(FULL_NAME, null) ?: "boo"
33 |
34 | fun getLogin(): Boolean = sharedPreferences.getBoolean(IS_LOGGED_IN, false)
35 |
36 | }
--------------------------------------------------------------------------------
/app/build.gradle:
--------------------------------------------------------------------------------
1 | plugins {
2 | id 'com.android.application'
3 | id 'kotlin-android'
4 | id 'kotlin-parcelize'
5 | id 'com.google.gms.google-services'
6 | id 'kotlin-kapt'
7 | id 'com.google.firebase.crashlytics'
8 | id 'dagger.hilt.android.plugin'
9 | id 'androidx.navigation.safeargs.kotlin'
10 | }
11 |
12 | apply from: './variants.gradle'
13 | apply from: './signing.gradle'
14 | apply from: './versions.gradle'
15 |
16 | android {
17 |
18 | testOptions {
19 | unitTests {
20 | includeAndroidResources = true
21 | }
22 | }
23 |
24 | compileSdkVersion 30
25 | buildToolsVersion "30.0.3"
26 |
27 | defaultConfig {
28 | applicationId "com.prudhvir3ddy.todo_app_gettingthingsdone"
29 | minSdkVersion 21
30 | targetSdkVersion 30
31 | versionCode VERSION_CODE
32 | versionName VERSION_NAME
33 | testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
34 | }
35 |
36 | compileOptions {
37 | sourceCompatibility = JavaVersion.VERSION_1_8
38 | targetCompatibility = JavaVersion.VERSION_1_8
39 | }
40 |
41 | tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).configureEach {
42 | kotlinOptions {
43 | jvmTarget = "1.8"
44 | }
45 | }
46 |
47 | buildFeatures {
48 | dataBinding true
49 | compose true
50 | }
51 |
52 | composeOptions {
53 | kotlinCompilerExtensionVersion libs.versions.compose.get()
54 | }
55 | }
56 |
57 | apply from: './dependency.gradle'
--------------------------------------------------------------------------------
/app/src/main/res/values/strings.xml:
--------------------------------------------------------------------------------
1 |
2 | ToDo-App
3 | Welcome, %1$s 🙏
4 | Task Name
5 | Task Description
6 | Add Task
7 | save
8 | Username
9 | Full Name
10 | Log in
11 | Camera
12 | Gallery
13 | Task Image
14 | Hi 👋, It\'s Great To See You Here
15 | Let\'s get started with a plan ?
16 | Get Started
17 | Please Enter Your Name
18 | Continue
19 | •
20 | Sign in With Google
21 | Edit Task
22 | No Tasks
23 | Delete Task
24 | Daily Notifications
25 | Remember Why You Started
26 | Get Back to Plan The Work
27 | Daily Notification
28 | drag handler
29 | Task name cannot be empty
30 |
31 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Built application files
2 | *.apk
3 | *.aar
4 | *.ap_
5 | *.aab
6 |
7 | # Files for the ART/Dalvik VM
8 | *.dex
9 |
10 | # Java class files
11 | *.class
12 |
13 | # Generated files
14 | bin/
15 | gen/
16 | out/
17 | # Uncomment the following line in case you need and you don't have the release build type files in your app
18 | # release/
19 |
20 | # Gradle files
21 | .gradle/
22 | build/
23 |
24 | .DS_Store
25 | # Local configuration file (sdk path, etc)
26 | local.properties
27 |
28 | # Proguard folder generated by Eclipse
29 | proguard/
30 |
31 | # Log Files
32 | *.log
33 |
34 | # Android Studio Navigation editor temp files
35 | .navigation/
36 |
37 | # Android Studio captures folder
38 | captures/
39 |
40 | # IntelliJ
41 | *.iml
42 | .idea/workspace.xml
43 | .idea/tasks.xml
44 | .idea/gradle.xml
45 | .idea/assetWizardSettings.xml
46 | .idea/dictionaries
47 | .idea/libraries
48 | # Android Studio 3 in .gitignore file.
49 | .idea/caches
50 | .idea/
51 | .idea/modules.xml
52 | /.idea/gradle.xml
53 | /.idea/caches/
54 | /.idea/.name
55 | /.idea/misc.xml
56 | /.idea/vcs.xml
57 | /.idea/runConfigurations.xml
58 |
59 | # Comment next line if keeping position of elements in Navigation Editor is relevant for you
60 | .idea/navEditor.xml
61 |
62 | # Keystore files
63 | # Uncomment the following lines if you do not want to check your keystore files in.
64 | *.jks
65 | release.keystore
66 | *.pepk
67 |
68 | # External native build folder generated in Android Studio 2.2 and later
69 | .externalNativeBuild
70 | .cxx/
71 |
72 | # Google Services (e.g. APIs or Firebase)
73 | google-services.json
74 | # Freeline
75 | freeline.py
76 | freeline/
77 | freeline_project_description.json
78 |
79 | # fastlane
80 | fastlane/report.xml
81 | fastlane/Preview.html
82 | fastlane/screenshots
83 | fastlane/test_output
84 | fastlane/readme.md
85 |
86 | # Version control
87 | vcs.xml
88 |
89 | # lint
90 | lint/intermediates/
91 | lint/generated/
92 | lint/outputs/
93 | lint/tmp/
94 | /.idea/compiler.xml
95 | /.idea/jarRepositories.xml
96 |
--------------------------------------------------------------------------------
/app/src/main/java/com/prudhvir3ddy/todo_app_gettingthingsdone/view/main/TasksViewModel.kt:
--------------------------------------------------------------------------------
1 | package com.prudhvir3ddy.todo_app_gettingthingsdone.view.main
2 |
3 | import androidx.lifecycle.LiveData
4 | import androidx.lifecycle.ViewModel
5 | import androidx.lifecycle.asLiveData
6 | import androidx.lifecycle.viewModelScope
7 | import com.prudhvir3ddy.todo_app_gettingthingsdone.repository.ToDoRepository
8 | import com.prudhvir3ddy.todo_app_gettingthingsdone.storage.SharedPrefs
9 | import com.prudhvir3ddy.todo_app_gettingthingsdone.storage.db.ToDo
10 | import dagger.hilt.android.lifecycle.HiltViewModel
11 | import kotlinx.coroutines.launch
12 | import kotlinx.coroutines.runBlocking
13 | import javax.inject.Inject
14 |
15 | @HiltViewModel
16 | class TasksViewModel @Inject constructor(
17 | private val repository: ToDoRepository,
18 | private val sharedPrefs: SharedPrefs
19 | ) : ViewModel() {
20 |
21 | val tasksList: LiveData> = repository.getAllToDos().asLiveData()
22 |
23 | fun onTaskToggle(todo: ToDo, isCompleted: Boolean) {
24 | viewModelScope.launch {
25 | val updatedToDo = todo.copy(isCompleted = isCompleted)
26 | repository.updateToDo(updatedToDo)
27 | }
28 | }
29 |
30 | fun updateTaskList(todoList: List) {
31 | viewModelScope.launch {
32 | repository.addToDos(todoList)
33 | }
34 | }
35 |
36 | fun onTaskUpdate(todo: ToDo) {
37 | viewModelScope.launch {
38 | repository.updateToDo(todo)
39 | }
40 | }
41 |
42 | fun getFirstName(): String {
43 | return sharedPrefs.getFullName()
44 | }
45 |
46 | fun onTaskDelete(taskId: String?) {
47 | viewModelScope.launch {
48 | repository.deleteToDo(taskId)
49 | }
50 | }
51 |
52 | fun getTaskByIdAsync(taskId: String?): ToDo {
53 | return runBlocking {
54 | repository.getTaskById(taskId)
55 | }
56 | }
57 |
58 | fun onTaskSave(taskName: String, taskDesc: String) {
59 | viewModelScope.launch {
60 | val todo = ToDo(
61 | title = taskName,
62 | description = taskDesc
63 | )
64 | repository.addToDo(todo)
65 | }
66 | }
67 | }
--------------------------------------------------------------------------------
/app/dependency.gradle:
--------------------------------------------------------------------------------
1 | dependencies {
2 | implementation libs.kotlin.stdlib
3 | implementation libs.androidx.ktx.core
4 | implementation libs.androidx.lifecycle.viewmodel
5 | implementation libs.androidx.lifecycle.livedata
6 | implementation libs.androidx.appcompat
7 | implementation libs.androidx.constraintlayout
8 | implementation libs.google.android.material
9 | androidTestImplementation libs.androidx.test.ext.junit
10 | androidTestImplementation libs.androidx.test.runner
11 | androidTestImplementation libs.androidx.test.ext.truth
12 | androidTestImplementation libs.google.truth
13 | androidTestImplementation libs.androidx.test.rules
14 |
15 | implementation libs.androidx.activity.ktx
16 | implementation libs.androidx.fragment.ktx
17 |
18 | testImplementation libs.junit
19 | testImplementation libs.androidx.test.core
20 | testImplementation libs.mockito
21 |
22 | implementation libs.androidx.room.lib
23 | kapt libs.androidx.room.compiler
24 |
25 | implementation libs.google.firebase.crashlytics.lib
26 |
27 | implementation libs.glide.lib
28 | kapt libs.glide.compiler
29 |
30 | implementation libs.androidx.viewpager
31 |
32 | implementation libs.dagger.hilt.android.lib
33 | kapt libs.dagger.hilt.android.compiler
34 | kapt libs.androidx.hilt.compiler
35 | implementation libs.androidx.hilt.navigation.compose
36 | androidTestImplementation libs.dagger.hilt.android.testing
37 |
38 |
39 | implementation libs.retrofit.lib
40 | implementation libs.retrofit.converter.moshi
41 | implementation libs.okhttp.log
42 |
43 | implementation libs.timber
44 | debugImplementation libs.leakcanary
45 |
46 | implementation libs.compose.ui.ui
47 | implementation libs.compose.ui.tooling
48 | implementation libs.compose.runtime.runtime
49 | implementation libs.compose.runtime.livedata
50 | implementation libs.compose.foundation.foundation
51 | implementation libs.compose.foundation.layout
52 | implementation libs.compose.material
53 | implementation libs.compose.google.material.theme.adapter
54 | implementation libs.compose.navigation
55 |
56 | implementation libs.androidx.activity.compose
57 | implementation libs.androidx.navigation.fragment
58 | implementation libs.androidx.navigation.ui
59 | }
--------------------------------------------------------------------------------
/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 |
--------------------------------------------------------------------------------
/app/src/main/java/com/prudhvir3ddy/todo_app_gettingthingsdone/view/HostActivity.kt:
--------------------------------------------------------------------------------
1 | package com.prudhvir3ddy.todo_app_gettingthingsdone.view
2 |
3 | import android.os.Bundle
4 | import androidx.activity.ComponentActivity
5 | import androidx.activity.compose.setContent
6 | import androidx.compose.material.ExperimentalMaterialApi
7 | import androidx.compose.material.MaterialTheme
8 | import androidx.compose.runtime.remember
9 | import androidx.hilt.navigation.compose.hiltViewModel
10 | import androidx.navigation.NavType
11 | import androidx.navigation.compose.NavHost
12 | import androidx.navigation.compose.composable
13 | import androidx.navigation.compose.navArgument
14 | import androidx.navigation.compose.rememberNavController
15 | import com.prudhvir3ddy.todo_app_gettingthingsdone.view.login.LoginScreen
16 | import com.prudhvir3ddy.todo_app_gettingthingsdone.view.login.LoginViewModel
17 | import com.prudhvir3ddy.todo_app_gettingthingsdone.view.main.TasksScreen
18 | import com.prudhvir3ddy.todo_app_gettingthingsdone.view.task.TaskType
19 | import com.prudhvir3ddy.todo_app_gettingthingsdone.view.task.UniqueTaskScreen
20 | import dagger.hilt.android.AndroidEntryPoint
21 |
22 | @AndroidEntryPoint
23 | class HostActivity : ComponentActivity() {
24 | @ExperimentalMaterialApi
25 | override fun onCreate(savedInstanceState: Bundle?) {
26 | super.onCreate(savedInstanceState)
27 | setContent {
28 | MaterialTheme {
29 | val navController = rememberNavController()
30 | val viewModel: LoginViewModel = hiltViewModel()
31 | NavHost(
32 | navController = navController,
33 | startDestination = if (viewModel.checkLogin()) Screens.TASKS else Screens.LOGIN
34 | ) {
35 | composable(Screens.LOGIN) {
36 | LoginScreen(navController = navController)
37 | }
38 | composable(Screens.TASKS) {
39 | TasksScreen(navController = navController)
40 | }
41 | composable(
42 | "${Screens.UNIQUE_TASK}?${Params.TASK_ID}={${Params.TASK_ID}}&${Params.TASK_TYPE}={${Params.TASK_TYPE}}",
43 | arguments = listOf(
44 | navArgument(Params.TASK_TYPE) {
45 | defaultValue = TaskType.ADD_TASK
46 | type = NavType.EnumType(TaskType::class.java)
47 | }, navArgument(Params.TASK_ID) {
48 | nullable = true
49 | defaultValue = null
50 | type = NavType.StringType
51 | })
52 | ) {
53 | val taskId = remember {
54 | it.arguments?.getString(Params.TASK_ID)
55 | }
56 | val type: TaskType = remember {
57 | it.arguments?.get(Params.TASK_TYPE) as TaskType
58 | }
59 | UniqueTaskScreen(navController = navController, taskId = taskId, taskType = type)
60 | }
61 | }
62 | }
63 | }
64 | }
65 |
66 | }
67 |
68 | object Screens {
69 | const val LOGIN = "login_screen"
70 | const val TASKS = "tasks_screen"
71 | const val UNIQUE_TASK = "unique_task_screen"
72 | }
73 |
74 | object Params {
75 | const val TASK_ID = "taskId"
76 | const val TASK_TYPE = "taskType"
77 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/prudhvir3ddy/todo_app_gettingthingsdone/view/login/LoginScreen.kt:
--------------------------------------------------------------------------------
1 | package com.prudhvir3ddy.todo_app_gettingthingsdone.view.login
2 |
3 | import androidx.compose.foundation.Image
4 | import androidx.compose.foundation.layout.Box
5 | import androidx.compose.foundation.layout.Column
6 | import androidx.compose.foundation.layout.fillMaxHeight
7 | import androidx.compose.foundation.layout.fillMaxWidth
8 | import androidx.compose.foundation.layout.height
9 | import androidx.compose.foundation.layout.padding
10 | import androidx.compose.foundation.layout.size
11 | import androidx.compose.material.Button
12 | import androidx.compose.material.ExperimentalMaterialApi
13 | import androidx.compose.material.MaterialTheme
14 | import androidx.compose.material.OutlinedTextField
15 | import androidx.compose.material.Text
16 | import androidx.compose.runtime.Composable
17 | import androidx.compose.runtime.mutableStateOf
18 | import androidx.compose.runtime.remember
19 | import androidx.compose.ui.Alignment
20 | import androidx.compose.ui.Modifier
21 | import androidx.compose.ui.res.painterResource
22 | import androidx.compose.ui.res.stringResource
23 | import androidx.compose.ui.text.style.TextAlign
24 | import androidx.compose.ui.unit.dp
25 | import androidx.hilt.navigation.compose.hiltViewModel
26 | import androidx.navigation.NavController
27 | import com.prudhvir3ddy.todo_app_gettingthingsdone.R.mipmap
28 | import com.prudhvir3ddy.todo_app_gettingthingsdone.R.string
29 | import com.prudhvir3ddy.todo_app_gettingthingsdone.view.Screens
30 |
31 | @ExperimentalMaterialApi
32 | @Composable
33 | fun LoginScreen(
34 | modifier: Modifier = Modifier,
35 | navController: NavController,
36 | viewModel: LoginViewModel = hiltViewModel()
37 | ) {
38 | Column(
39 | modifier = modifier
40 | .padding(16.dp)
41 | .fillMaxWidth()
42 | .fillMaxHeight()
43 | ) {
44 | GreetingText()
45 | PlanText()
46 | Box(
47 | modifier = Modifier
48 | .fillMaxWidth()
49 | .height(200.dp),
50 | contentAlignment = Alignment.Center
51 | ) {
52 | Image(
53 | painter = painterResource(id = mipmap.ic_launcher_round),
54 | contentDescription = null, modifier = modifier.size(100.dp),
55 | alignment = Alignment.Center
56 | )
57 | }
58 | val (text, setText) = remember { mutableStateOf("") }
59 | LoginTextField(text = text, setText = setText)
60 | LoginButton(onClick = {
61 | viewModel.getStarted(it)
62 | navController.navigate(Screens.TASKS) {
63 | popUpTo(Screens.LOGIN) {
64 | inclusive = true
65 | }
66 | }
67 | }, text = text)
68 | }
69 | }
70 |
71 | @Composable
72 | fun GreetingText(
73 | modifier: Modifier = Modifier,
74 | text: String = stringResource(id = string.hi_it_s_great_to_see_you_here)
75 | ) {
76 |
77 | Text(
78 | text = text,
79 | textAlign = TextAlign.Start,
80 | style = MaterialTheme.typography.h5,
81 | modifier = modifier
82 | .fillMaxWidth()
83 | .padding(top = 16.dp)
84 | )
85 | }
86 |
87 | @Composable
88 | fun PlanText(
89 | modifier: Modifier = Modifier,
90 | text: String = stringResource(id = string.let_s_get_started_with_a_plan)
91 | ) {
92 |
93 | Text(
94 | text = text,
95 | textAlign = TextAlign.Start,
96 | style = MaterialTheme.typography.h6,
97 | modifier = modifier
98 | .fillMaxWidth()
99 | .padding(top = 16.dp)
100 | )
101 | }
102 |
103 | @Composable
104 | fun LoginTextField(
105 | modifier: Modifier = Modifier,
106 | text: String,
107 | setText: (String) -> Unit,
108 | hint: String = stringResource(id = string.please_enter_your_name),
109 | ) {
110 | OutlinedTextField(
111 | value = text,
112 | onValueChange = setText,
113 | singleLine = true,
114 | label = { Text(text = hint) },
115 | modifier = modifier
116 | .fillMaxWidth()
117 | .padding(top = 8.dp)
118 | )
119 | }
120 |
121 | @Composable
122 | fun LoginButton(
123 | modifier: Modifier = Modifier,
124 | onClick: (String) -> Unit,
125 | text: String
126 | ) {
127 | Button(
128 | onClick = { onClick(text) },
129 | enabled = text.isNotBlank(),
130 | modifier = modifier
131 | .fillMaxWidth()
132 | .padding(top = 16.dp),
133 | ) {
134 | Text(text = stringResource(id = string.log_in))
135 | }
136 | }
137 |
138 | //@Preview(showBackground = true, backgroundColor = 0xffffff)
139 | //@Composable
140 | //fun PreviewLoginScreen() {
141 | // LoginScreen {
142 | //
143 | // }
144 | //}
--------------------------------------------------------------------------------
/gradle/libs.versions.toml:
--------------------------------------------------------------------------------
1 | [versions]
2 | navigation = "2.3.2"
3 | navigationcompose = "2.4.0-alpha06"
4 | compose = "1.0.0"
5 | kotlin = "1.5.10"
6 | hilt = "2.37"
7 | room = "2.3.0"
8 | glide = "4.11.0"
9 | retrofit = "2.9.0"
10 | okhttp = "4.9.0"
11 | androidxhilt = "1.0.0"
12 | lifecycle = "2.2.0"
13 | navigationhilt="1.0.0-alpha03"
14 |
15 | [libraries]
16 | compose-ui-ui = { module = "androidx.compose.ui:ui", version.ref = "compose" }
17 | compose-ui-tooling = { module = "androidx.compose.ui:ui-tooling", version.ref = "compose" }
18 | compose-runtime-runtime = { module = "androidx.compose.runtime:runtime", version.ref = "compose" }
19 | compose-runtime-livedata = { module = "androidx.compose.runtime:runtime-livedata", version.ref = "compose" }
20 | compose-foundation-foundation = { module = "androidx.compose.foundation:foundation", version.ref = "compose" }
21 | compose-foundation-layout = { module = "androidx.compose.foundation:foundation-layout", version.ref = "compose" }
22 | compose-material = { module = "androidx.compose.material:material", version.ref = "compose" }
23 | compose-google-material-theme-adapter = { module = "com.google.android.material:compose-theme-adapter", version.ref = "compose" }
24 | compose-navigation = { module = "androidx.navigation:navigation-compose", version.ref = "navigationcompose" }
25 |
26 | androidx-activity-compose = "androidx.activity:activity-compose:1.3.1"
27 |
28 | androidx-navigation-fragment = { module = "androidx.navigation:navigation-fragment-ktx", version.ref = "navigation" }
29 | androidx-navigation-ui = { module = "androidx.navigation:navigation-ui-ktx", version.ref = "navigation" }
30 |
31 | androidx-navigation-safe-args-gradle-plugin = { module = "androidx.navigation:navigation-safe-args-gradle-plugin", version.ref = "navigation" }
32 |
33 | androidx-room-lib = { module = "androidx.room:room-ktx", version.ref = "room" }
34 | androidx-room-compiler = { module = "androidx.room:room-compiler", version.ref = "room" }
35 |
36 | androidx-hilt-lifecycleViewmodel = { module = "androidx.hilt:hilt-lifecycle-viewmodel", version.ref = "androidxhilt" }
37 | androidx-hilt-compiler = { module = "androidx.hilt:hilt-compiler", version.ref = "androidxhilt" }
38 | androidx-hilt-navigation-compose = { module = "androidx.hilt:hilt-navigation-compose", version.ref = "navigationhilt" }
39 |
40 | androidx-appcompat = "androidx.appcompat:appcompat:1.1.0"
41 |
42 | androidx-lifecycle-viewmodel = { module = "androidx.lifecycle:lifecycle-viewmodel-ktx", version.ref = "lifecycle"}
43 | androidx-lifecycle-livedata = { module = "androidx.lifecycle:lifecycle-livedata-ktx", version.ref = "lifecycle"}
44 |
45 | androidx-ktx-core = "androidx.core:core-ktx:1.2.0"
46 | androidx-constraintlayout = "androidx.constraintlayout:constraintlayout:1.1.3"
47 | androidx-viewpager = "androidx.viewpager2:viewpager2:1.0.0"
48 |
49 | androidx-activity-ktx = "androidx.activity:activity-ktx:1.2.0"
50 | androidx-fragment-ktx = "androidx.fragment:fragment-ktx:1.3.0"
51 |
52 | google-android-material = "com.google.android.material:material:1.1.0"
53 | google-firebase-crashlytics-lib = "com.google.firebase:firebase-crashlytics:17.3.0"
54 |
55 | android-tools-gradle-plugin = "com.android.tools.build:gradle:7.1.0-alpha03"
56 |
57 | kotlin-stdlib = { module = "org.jetbrains.kotlin:kotlin-stdlib-jdk7", version.ref = "kotlin" }
58 | kotlin-gradle-plugin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
59 |
60 | dagger-hilt-android-lib = { module = "com.google.dagger:hilt-android", version.ref = "hilt" }
61 | dagger-hilt-android-compiler = { module = "com.google.dagger:hilt-android-compiler", version.ref = "hilt" }
62 | dagger-hilt-android-testing = { module = "com.google.dagger:hilt-android-testing", version.ref = "hilt" }
63 | dagger-hilt-gradle-plugin = { module = "com.google.dagger:hilt-android-gradle-plugin", version.ref = "hilt"}
64 |
65 | retrofit-converter-moshi = { module = "com.squareup.retrofit2:converter-moshi", version.ref = "retrofit" }
66 | retrofit-lib = { module = "com.squareup.retrofit2:retrofit", version.ref = "retrofit" }
67 |
68 | okhttp-log = { module = "com.squareup.okhttp3:logging-interceptor", version.ref = "okhttp" }
69 |
70 | timber = "com.jakewharton.timber:timber:4.7.1"
71 | leakcanary = "com.squareup.leakcanary:leakcanary-android:2.6"
72 |
73 | glide-lib = { module = "com.github.bumptech.glide:glide", version.ref = "glide" }
74 | glide-compiler = { module = "com.github.bumptech.glide:compiler", version.ref = "glide" }
75 | google-gmsGoogleServices = "com.google.gms:google-services:4.3.5"
76 | google-firebase-crashlytics-gradle-plugin = "com.google.firebase:firebase-crashlytics-gradle:2.4.1"
77 |
78 | androidx-test-core = "androidx.test:core:1.2.0"
79 | mockito = "org.mockito:mockito-core:2.23.4"
80 | androidx-test-ext-junit = "androidx.test.ext:junit-ktx:1.1.1"
81 | junit = "junit:junit:4.12"
82 | androidx-test-runner = "androidx.test:runner:1.1.0"
83 | androidx-test-ext-truth = "androidx.test.ext:truth:1.0.0"
84 | google-truth = "com.google.truth:truth:0.42"
85 | androidx-test-rules = "androidx.test:rules:1.1.0"
--------------------------------------------------------------------------------
/app/src/main/java/com/prudhvir3ddy/todo_app_gettingthingsdone/view/task/UniqueTaskScreen.kt:
--------------------------------------------------------------------------------
1 | package com.prudhvir3ddy.todo_app_gettingthingsdone.view.task
2 |
3 | import androidx.compose.foundation.layout.Arrangement
4 | import androidx.compose.foundation.layout.Column
5 | import androidx.compose.foundation.layout.Row
6 | import androidx.compose.foundation.layout.fillMaxHeight
7 | import androidx.compose.foundation.layout.fillMaxWidth
8 | import androidx.compose.foundation.layout.padding
9 | import androidx.compose.material.MaterialTheme
10 | import androidx.compose.material.Text
11 | import androidx.compose.material.TextButton
12 | import androidx.compose.material.TextField
13 | import androidx.compose.material.TextFieldColors
14 | import androidx.compose.material.TextFieldDefaults
15 | import androidx.compose.runtime.Composable
16 | import androidx.compose.runtime.mutableStateOf
17 | import androidx.compose.runtime.remember
18 | import androidx.compose.ui.Alignment
19 | import androidx.compose.ui.Modifier
20 | import androidx.compose.ui.graphics.Color
21 | import androidx.compose.ui.res.stringResource
22 | import androidx.compose.ui.unit.dp
23 | import androidx.hilt.navigation.compose.hiltViewModel
24 | import androidx.navigation.NavController
25 | import com.prudhvir3ddy.todo_app_gettingthingsdone.R.string
26 | import com.prudhvir3ddy.todo_app_gettingthingsdone.storage.db.ToDo
27 | import com.prudhvir3ddy.todo_app_gettingthingsdone.view.Screens
28 | import com.prudhvir3ddy.todo_app_gettingthingsdone.view.main.TasksViewModel
29 | import com.prudhvir3ddy.todo_app_gettingthingsdone.view.task.TaskType.ADD_TASK
30 | import com.prudhvir3ddy.todo_app_gettingthingsdone.view.task.TaskType.EDIT_TASK
31 |
32 | @Composable
33 | fun UniqueTaskScreen(
34 | modifier: Modifier = Modifier,
35 | navController: NavController,
36 | viewModel: TasksViewModel = hiltViewModel(),
37 | taskId: String?,
38 | taskType: TaskType = ADD_TASK
39 | ) {
40 |
41 | val onSaveButtonClicked = { savedTask: ToDo ->
42 | when (taskType) {
43 | ADD_TASK -> viewModel.onTaskSave(savedTask.title, savedTask.description)
44 | EDIT_TASK -> viewModel.onTaskUpdate(savedTask)
45 | }
46 |
47 | navController.navigate(Screens.TASKS) {
48 | popUpTo(Screens.TASKS) {
49 | inclusive = true
50 | }
51 | }
52 | }
53 |
54 | Column(
55 | modifier = modifier
56 | .fillMaxHeight()
57 | .fillMaxWidth()
58 | .padding(16.dp)
59 | ) {
60 |
61 | val task = remember {
62 | if (taskId != null) {
63 | viewModel.getTaskByIdAsync(taskId)
64 | } else {
65 | ToDo()
66 | }
67 | }
68 |
69 | val (titleText, setTitleText) = remember { mutableStateOf(task.title) }
70 | val (descriptionText, setDescriptionText) = remember { mutableStateOf(task.description) }
71 | Row(
72 | horizontalArrangement = Arrangement.SpaceBetween,
73 | verticalAlignment = Alignment.CenterVertically,
74 | modifier = Modifier.fillMaxWidth()
75 | ) {
76 | TaskModeText(taskType = taskType)
77 | SaveTaskButton(
78 | onSaveButtonClicked = {
79 | task.title = titleText
80 | task.description = descriptionText
81 | onSaveButtonClicked(
82 | task
83 | )
84 | }
85 | )
86 | }
87 | TitleTextField(
88 | text = titleText,
89 | setText = setTitleText,
90 | modifier = Modifier
91 | .fillMaxWidth()
92 | .padding(top = 16.dp)
93 | )
94 | DescriptionTextField(
95 | text = descriptionText,
96 | setText = setDescriptionText,
97 | modifier = Modifier.fillMaxWidth()
98 | )
99 | }
100 | }
101 |
102 | @Composable
103 | fun SaveTaskButton(modifier: Modifier = Modifier, onSaveButtonClicked: () -> Unit) {
104 | TextButton(onClick = { onSaveButtonClicked() }) {
105 | Text(text = stringResource(id = string.save), modifier = modifier)
106 | }
107 | }
108 |
109 | @Composable
110 | fun TaskModeText(
111 | modifier: Modifier = Modifier,
112 | taskType: TaskType = ADD_TASK
113 | ) {
114 | when (taskType) {
115 | ADD_TASK -> Text(
116 | modifier = modifier,
117 | text = stringResource(id = string.add_task),
118 | style = MaterialTheme.typography.h5
119 | )
120 | EDIT_TASK -> Text(
121 | modifier = modifier,
122 | text = stringResource(id = string.edit_task),
123 | style = MaterialTheme.typography.h5
124 | )
125 | }
126 |
127 | }
128 |
129 | @Composable
130 | fun TitleTextField(
131 | modifier: Modifier = Modifier,
132 | text: String,
133 | setText: (String) -> Unit
134 | ) {
135 | TextField(
136 | value = text,
137 | onValueChange = setText,
138 | modifier = modifier,
139 | colors = taskTextFieldColors(),
140 | label = { Text(text = stringResource(id = string.task_name)) }
141 | )
142 | }
143 |
144 | @Composable
145 | fun taskTextFieldColors(): TextFieldColors = TextFieldDefaults.textFieldColors(
146 | focusedIndicatorColor = Color.Transparent,
147 | disabledIndicatorColor = Color.Transparent,
148 | unfocusedIndicatorColor = Color.Transparent,
149 | backgroundColor = Color.Transparent,
150 | )
151 |
152 | @Composable
153 | fun DescriptionTextField(
154 | modifier: Modifier = Modifier,
155 | text: String,
156 | setText: (String) -> Unit
157 | ) {
158 | TextField(
159 | value = text,
160 | onValueChange = setText,
161 | modifier = modifier,
162 | colors = taskTextFieldColors(),
163 | label = { Text(text = stringResource(id = string.task_description)) }
164 | )
165 | }
--------------------------------------------------------------------------------
/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 |
--------------------------------------------------------------------------------
/app/src/main/java/com/prudhvir3ddy/todo_app_gettingthingsdone/view/main/TasksScreen.kt:
--------------------------------------------------------------------------------
1 | package com.prudhvir3ddy.todo_app_gettingthingsdone.view.main
2 |
3 | import androidx.compose.animation.animateColorAsState
4 | import androidx.compose.animation.core.animateFloatAsState
5 | import androidx.compose.foundation.Image
6 | import androidx.compose.foundation.background
7 | import androidx.compose.foundation.clickable
8 | import androidx.compose.foundation.layout.Box
9 | import androidx.compose.foundation.layout.Column
10 | import androidx.compose.foundation.layout.Row
11 | import androidx.compose.foundation.layout.fillMaxHeight
12 | import androidx.compose.foundation.layout.fillMaxSize
13 | import androidx.compose.foundation.layout.fillMaxWidth
14 | import androidx.compose.foundation.layout.padding
15 | import androidx.compose.foundation.lazy.LazyColumn
16 | import androidx.compose.foundation.lazy.items
17 | import androidx.compose.material.Checkbox
18 | import androidx.compose.material.DismissDirection.EndToStart
19 | import androidx.compose.material.DismissDirection.StartToEnd
20 | import androidx.compose.material.DismissValue.Default
21 | import androidx.compose.material.DismissValue.DismissedToEnd
22 | import androidx.compose.material.DismissValue.DismissedToStart
23 | import androidx.compose.material.Divider
24 | import androidx.compose.material.ExperimentalMaterialApi
25 | import androidx.compose.material.FloatingActionButton
26 | import androidx.compose.material.FractionalThreshold
27 | import androidx.compose.material.Icon
28 | import androidx.compose.material.MaterialTheme
29 | import androidx.compose.material.Scaffold
30 | import androidx.compose.material.SwipeToDismiss
31 | import androidx.compose.material.Text
32 | import androidx.compose.material.icons.Icons
33 | import androidx.compose.material.icons.filled.Add
34 | import androidx.compose.material.icons.filled.Delete
35 | import androidx.compose.material.rememberDismissState
36 | import androidx.compose.runtime.Composable
37 | import androidx.compose.runtime.getValue
38 | import androidx.compose.runtime.livedata.observeAsState
39 | import androidx.compose.ui.Alignment
40 | import androidx.compose.ui.Modifier
41 | import androidx.compose.ui.draw.scale
42 | import androidx.compose.ui.graphics.Color
43 | import androidx.compose.ui.res.painterResource
44 | import androidx.compose.ui.res.stringResource
45 | import androidx.compose.ui.text.style.TextDecoration
46 | import androidx.compose.ui.unit.dp
47 | import androidx.hilt.navigation.compose.hiltViewModel
48 | import androidx.navigation.NavController
49 | import com.prudhvir3ddy.todo_app_gettingthingsdone.R
50 | import com.prudhvir3ddy.todo_app_gettingthingsdone.R.string
51 | import com.prudhvir3ddy.todo_app_gettingthingsdone.storage.db.ToDo
52 | import com.prudhvir3ddy.todo_app_gettingthingsdone.view.Params
53 | import com.prudhvir3ddy.todo_app_gettingthingsdone.view.Screens
54 | import com.prudhvir3ddy.todo_app_gettingthingsdone.view.task.TaskType
55 |
56 | @Composable
57 | fun WelcomeText(userName: String) {
58 | Text(
59 | text = String.format(stringResource(id = string.welcome), userName),
60 | style = MaterialTheme.typography.h5
61 | )
62 | }
63 |
64 | @ExperimentalMaterialApi
65 | @Composable
66 | fun TasksScreen(
67 | modifier: Modifier = Modifier,
68 | navController: NavController,
69 | viewModel: TasksViewModel = hiltViewModel()
70 | ) {
71 |
72 | val tasks: List by viewModel.tasksList.observeAsState(initial = emptyList())
73 |
74 | val onTaskAddButtonClicked = {
75 | navController.navigate(Screens.UNIQUE_TASK) {
76 | popUpTo(Screens.TASKS)
77 | }
78 | }
79 |
80 | Scaffold(floatingActionButton = {
81 | AddTaskFabButton(onTaskAddButtonClicked)
82 | }) {
83 |
84 | val onTaskClicked = { task: ToDo ->
85 | navController.navigate("${Screens.UNIQUE_TASK}?${Params.TASK_ID}=${task.id}&${Params.TASK_TYPE}=${TaskType.EDIT_TASK}") {
86 | popUpTo(Screens.TASKS)
87 | }
88 | }
89 |
90 | val onTaskToggle = { task: ToDo, toggle: Boolean ->
91 | viewModel.onTaskToggle(task, toggle)
92 | }
93 |
94 | LazyColumn(modifier = modifier.padding(16.dp)) {
95 | item {
96 | WelcomeText(viewModel.getFirstName())
97 | }
98 | if (tasks.isNotEmpty()) {
99 | items(tasks) { task ->
100 | TasksSwipeable(task, viewModel, onTaskClicked, onTaskToggle)
101 | Divider(color = Color.LightGray)
102 | }
103 | } else {
104 | item {
105 | ShowNoTasks()
106 | }
107 | }
108 | }
109 | }
110 | }
111 |
112 | @Composable
113 | fun AddTaskFabButton(onTaskAddButtonClicked: () -> Unit) {
114 | FloatingActionButton(
115 | onClick = { onTaskAddButtonClicked() },
116 | content = {
117 | Icon(
118 | imageVector = Icons.Filled.Add,
119 | contentDescription = stringResource(id = string.add_task)
120 | )
121 | }
122 | )
123 | }
124 |
125 | @ExperimentalMaterialApi
126 | @Composable
127 | fun ToDoCard(
128 | task: ToDo,
129 | onTaskClicked: (ToDo) -> Unit,
130 | onTaskToggle: (ToDo, Boolean) -> Unit,
131 | modifier: Modifier = Modifier,
132 | ) {
133 |
134 | Row(
135 | modifier = modifier
136 | .fillMaxWidth()
137 | .clickable {
138 | onTaskClicked(task)
139 | }
140 | .padding(16.dp), verticalAlignment = Alignment.CenterVertically
141 | ) {
142 | Checkbox(
143 | checked = task.isCompleted,
144 | onCheckedChange = {
145 | onTaskToggle(task, it)
146 | }
147 | )
148 |
149 | Column(
150 | modifier = Modifier
151 | .fillMaxSize()
152 | .padding(start = 16.dp),
153 | ) {
154 | val body1Style = MaterialTheme.typography.body1
155 | val body2Style = MaterialTheme.typography.body2
156 | if (task.isCompleted) {
157 | Text(
158 | text = task.title,
159 | style = body1Style.copy(textDecoration = TextDecoration.LineThrough)
160 | )
161 | Text(
162 | text = task.description,
163 | style = body2Style.copy(textDecoration = TextDecoration.LineThrough)
164 | )
165 | } else {
166 | Text(text = task.title, style = body1Style)
167 | Text(text = task.description, style = body2Style)
168 | }
169 | }
170 | }
171 | }
172 |
173 | @ExperimentalMaterialApi
174 | @Composable
175 | fun TasksSwipeable(
176 | task: ToDo,
177 | viewModel: TasksViewModel,
178 | onTaskClicked: (ToDo) -> Unit,
179 | onTaskToggle: (ToDo, Boolean) -> Unit,
180 | modifier: Modifier = Modifier
181 | ) {
182 | val dismissState = rememberDismissState(
183 | confirmStateChange = {
184 | if (it == DismissedToEnd)
185 | viewModel.onTaskDelete(task.id)
186 | it != DismissedToEnd
187 | }
188 | )
189 | SwipeToDismiss(directions = setOf(StartToEnd), state = dismissState, background = {
190 | val direction = dismissState.dismissDirection ?: return@SwipeToDismiss
191 | val color by animateColorAsState(
192 | when (dismissState.targetValue) {
193 | Default -> Color.LightGray
194 | DismissedToEnd -> Color.Red
195 | DismissedToStart -> return@SwipeToDismiss
196 | }
197 | )
198 | val alignment = when (direction) {
199 | StartToEnd -> Alignment.CenterStart
200 | EndToStart -> return@SwipeToDismiss
201 | }
202 | val icon = Icons.Default.Delete
203 | val scale by animateFloatAsState(
204 | if (dismissState.targetValue == Default) 0.75f else 1f
205 | )
206 |
207 | Box(
208 | modifier
209 | .fillMaxSize()
210 | .background(color)
211 | .padding(horizontal = 20.dp),
212 | contentAlignment = alignment
213 | ) {
214 | Icon(
215 | icon,
216 | contentDescription = stringResource(id = string.delete_task),
217 | modifier = Modifier.scale(scale)
218 | )
219 | }
220 | }, dismissThresholds = { direction ->
221 | FractionalThreshold(0.25f)
222 | }) {
223 | ToDoCard(task, onTaskClicked, onTaskToggle)
224 | }
225 | }
226 |
227 | @Composable
228 | fun ShowNoTasks() {
229 | Image(
230 | alignment = Alignment.Center,
231 | modifier = Modifier
232 | .fillMaxHeight()
233 | .padding(32.dp),
234 | painter = painterResource(R.drawable.add_task),
235 | contentDescription = stringResource(id = string.no_tasks)
236 | )
237 | }
238 |
239 | //@ExperimentalMaterialApi
240 | //@Preview(showBackground = true, backgroundColor = 0xffffff)
241 | //@Composable
242 | //fun PreviewTasksScreen() {
243 | // TasksScreen(
244 | // "",
245 | // tasks = emptyList(),
246 | // onTaskStatusChanged = { todo, b ->
247 | //
248 | // },
249 | // onTaskAddButtonClicked = {
250 | //
251 | // }, onTaskSwiped = {
252 | //
253 | // }, onTaskClicked = {
254 | //
255 | // })
256 | //}
--------------------------------------------------------------------------------
/.idea/codeStyles/Project.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
12 |
13 |
14 |
17 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 |
54 |
55 |
56 |
57 |
58 |
59 |
60 |
66 |
67 |
68 |
69 |
70 |
71 |
72 |
73 |
74 |
75 |
82 |
83 |
84 |
85 |
86 |
87 |
88 |
89 |
90 |
91 |
94 |
95 |
96 |
97 |
98 |
99 |
100 |
101 |
102 |
103 |
104 |
105 |
106 |
107 |
108 |
109 |
110 |
111 |
112 |
113 |
114 |
115 |
116 |
117 |
118 |
119 |
120 |
121 |
122 |
123 |
124 |
125 |
126 |
127 |
128 |
129 |
130 |
131 |
132 |
133 |
134 |
135 |
136 |
137 |
138 |
139 |
140 |
141 |
142 |
143 |
144 |
145 |
146 |
147 |
148 |
149 |
150 |
151 |
152 |
153 |
154 |
155 |
156 |
157 |
158 |
159 |
160 |
161 |
162 |
163 |
164 |
165 |
166 |
167 |
168 |
169 |
170 |
171 |
172 |
173 |
174 |
175 |
176 |
177 |
178 |
179 |
180 |
181 |
182 |
183 |
184 |
185 |
186 |
187 |
188 |
189 |
190 |
191 |
192 |
193 |
194 |
195 |
196 |
197 |
198 |
199 |
200 |
201 |
202 |
203 |
204 |
205 |
206 |
207 |
208 |
209 |
210 |
211 |
212 |
213 |
214 |
215 |
216 |
217 |
218 |
219 |
220 |
221 |
222 |
223 |
224 |
225 |
226 |
227 |
228 |
229 |
230 |
231 |
232 |
233 |
234 |
235 |
236 |
237 |
238 |
239 |
240 |
241 |
242 |
243 |
244 |
245 |
246 |
247 |
248 |
249 |
250 |
251 |
252 |
253 |
254 |
255 |
256 |
257 |
258 |
259 |
260 |
261 |
262 | xmlns:android
263 |
264 | ^$
265 |
266 |
267 |
268 |
269 |
270 |
271 |
272 |
273 | xmlns:.*
274 |
275 | ^$
276 |
277 |
278 | BY_NAME
279 |
280 |
281 |
282 |
283 |
284 |
285 | .*:id
286 |
287 | http://schemas.android.com/apk/res/android
288 |
289 |
290 |
291 |
292 |
293 |
294 |
295 |
296 | .*:name
297 |
298 | http://schemas.android.com/apk/res/android
299 |
300 |
301 |
302 |
303 |
304 |
305 |
306 |
307 | name
308 |
309 | ^$
310 |
311 |
312 |
313 |
314 |
315 |
316 |
317 |
318 | style
319 |
320 | ^$
321 |
322 |
323 |
324 |
325 |
326 |
327 |
328 |
329 | .*
330 |
331 | ^$
332 |
333 |
334 | BY_NAME
335 |
336 |
337 |
338 |
339 |
340 |
341 | .*
342 |
343 | http://schemas.android.com/apk/res/android
344 |
345 |
346 | ANDROID_ATTRIBUTE_ORDER
347 |
348 |
349 |
350 |
351 |
352 |
353 | .*
354 |
355 | .*
356 |
357 |
358 | BY_NAME
359 |
360 |
361 |
362 |
363 |
364 |
365 |
366 |
367 |
368 |
369 |
370 |
371 |
372 |
373 |
374 |
375 |
376 |
377 |
378 |
379 |
380 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
