initial commit, composite restructure from DM-2 [https://github.com/uds-se/droidmate]

Author: Hotzkow

.gitignore

@@ -0,0 +1,40 @@
+### Gradle ###
+.gradle
+build
+local.gradle
+# See: https://intellij-support.jetbrains.com/entries/23393067-How-to-manage-projects-under-Version-Control-Systems
+**/.idea/libraries
+
+### Java ####
+*.class
+
+### Android SDK ###
+bin/
+gen/
+# Local configuration file (sdk path, etc)
+local.properties
+
+### IntelliJ IDEA ###
+.idea
+*.iml
+**/*.iws
+**/*.eml
+**/.idea/workspace.xml
+**/.idea/tasks.xml
+**/.idea/misc.xml
+/.idea
+.iml
+out/
+# Proguard folder generated by IntelliJ
+proguard_logs/
+
+
+### Eclipse ###
+# project files
+.classpath
+.project
+# Proguard folder generated by Eclipse
+proguard/
+
+# Temporary stuff
+out

build.gradle

@@ -0,0 +1,33 @@
+plugins {
+	id 'java'
+	id 'org.jetbrains.kotlin.jvm'
+}
+apply from: file("../../../versions.gradle")
+
+
+version '1.0-SNAPSHOT'
+
+sourceCompatibility = 1.8
+
+repositories {
+	mavenCentral()
+}
+
+dependencies {
+	compile group: 'org.droidmate', name: 'deviceDaemonLib', version: project.ext.driverLib_version
+
+	// we need the jdk dependency instead of stdlib to have enhanced java features like tue 'use' function for try-with-resources
+	compile group: 'org.jetbrains.kotlin', name: 'kotlin-stdlib-jdk8', version: project.ext.kotlin_version
+	compile "org.jetbrains.kotlin:kotlin-reflect:${project.ext.kotlin_version}" // because we need reflection to get annotated property values
+	compile "org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutines_version"
+	compile 'com.natpryce:konfig:1.6.6.0'  // configuration library
+
+	testCompile group: 'junit', name: 'junit', version: '4.12'
+}
+
+compileKotlin {
+	kotlinOptions.jvmTarget = "1.8"
+}
+compileTestKotlin {
+	kotlinOptions.jvmTarget = "1.8"
+}

settings.gradle

@@ -0,0 +1,4 @@
+rootProject.name = "explorationModel"
+
+includeBuild ('../../deviceCommonLib/deviceDaemonLib')
+

src/main/kotlin/org/droidmate/explorationModel/Actor.kt

@@ -0,0 +1,103 @@
+// DroidMate, an automated execution generator for Android apps.
+// Copyright (C) 2012-2018. Saarland University
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+// Current Maintainers:
+// Nataniel Borges Jr. <nataniel dot borges at cispa dot saarland>
+// Jenny Hotzkow <jenny dot hotzkow at cispa dot saarland>
+//
+// Former Maintainers:
+// Konrad Jamrozik <jamrozik at st dot cs dot uni-saarland dot de>
+//
+// web: www.droidmate.org
+
+@file:Suppress("ReplaceSingleLineLet")
+
+package org.droidmate.explorationModel
+
+import kotlinx.coroutines.*
+import kotlinx.coroutines.channels.*
+import kotlin.coroutines.CoroutineContext
+import kotlin.coroutines.coroutineContext
+
+// we have exactly one thread who is going to handle our model actors
+// (we use an own thread to avoid blocking issues for mono/duo-cores, where the default thread-pool only has size 1)
+private val actorThreadPool = newFixedThreadPoolContext (1,name="actor-thread")
+interface Actor<in E>: CoroutineScope{
+	suspend fun onReceive(msg: E)
+}
+
+/** REMARK: buffered channel currently have some race condition bug when the full capacity is reached.
+ * In particular, these sender are not properly woken up unless there is a print statement in the receiving loop of this actor
+ * (which probably eliminates any potential race condition due to sequential console access)*/
+internal inline fun<reified MsgType> Actor<MsgType>.create() = actor<MsgType>(capacity = Channel.UNLIMITED){
+	for (msg in channel)	onReceive(msg)
+}
+
+/** in principle adding any element to a collection would be a fast task, however due to the potential timeout for the widget.uid computation
+ * the state id may be delayed as well and the hash function of Widget and State base on this id.
+ * Therefore this computation and the set management was taken from the critical path of the execution by using this actor
+ */
+class CollectionActor<T>(private val actorState: MutableCollection<T>, private val actorName: String): Actor<CollectionMsg<T, Any?>> {
+	override val coroutineContext: CoroutineContext = actorThreadPool + CoroutineName(actorName)
+
+	override suspend fun onReceive(msg: CollectionMsg<T, Any?>){
+//		println("[${Thread.currentThread().name}] START msg handling ${msg::class.simpleName}: ${actorState.size}")
+		when(msg){
+			is Add -> actorState.add( msg.elem )
+			is AddAll -> actorState.addAll( msg.elements )
+			is Get -> msg.response.complete( msg.predicate(actorState) )
+			is GetAll ->
+				if(actorState is Set<*>) msg.response.complete( actorState.toSet() )
+				else msg.response.complete( actorState.toList() )
+		} //.run{  /* do nothing but keep this .run to ensure when raises compile error if not all sealed class cases are implemented */  }
+//		println("[${Thread.currentThread().name}] msg handling ${msg::class.simpleName}: ${actorState.size}")
+	}
+	override fun toString(): String = actorName
+}
+@kotlin.Suppress("unused")
+sealed class CollectionMsg<T,out R>
+
+class Add<T>(val elem: T): CollectionMsg<T, Any>()
+class AddAll<T>(val elements: Collection<T>): CollectionMsg<T, Any>()
+class GetAll<T,R>(val response: CompletableDeferred<R>): CollectionMsg<T, R>()
+/** this method allows to retrieve a specific element as determined by @predicate,
+ * however the predicate should only contain very cheap computations as otherwise the WHOLE exploration performance would suffer.
+ * For more expensive computations please retrieve the whole collection via [GetAll] and perform your operation on the result
+ */
+class Get<T,R>(inline val predicate:(Collection<T>)->R, val response: CompletableDeferred<R>): CollectionMsg<T, R>()
+
+/** this method allows to retrieve a specific element as determined by @predicate,
+ * however the predicate should only contain very cheap computations as otherwise the WHOLE exploration performance would suffer.
+ * For more expensive computations please retrieve the whole collection via [getAll] and perform your operation on the result
+ */
+suspend inline fun<reified T, reified R: Any?> SendChannel<CollectionMsg<T, R?>>.getOrNull(noinline predicate:(Collection<T>)->R): R?
+		= this.let{actor -> with(CompletableDeferred<R>()){ actor.send(Get(predicate, this)); this.await()} }
+
+/** this method allows to retrieve a specific element as determined by @predicate,
+ * however the predicate should only contain very cheap computations as otherwise the WHOLE exploration performance would suffer.
+ * For more expensive computations please retrieve the whole collection via [getAll] and perform your operation on the result
+ */
+suspend inline fun<reified T, reified R: Any> SendChannel<CollectionMsg<T, R?>>.get(noinline predicate:(Collection<T>)->R): R
+		= this.let{actor -> with(CompletableDeferred<R?>()){ actor.send(Get(predicate, this)); this.await()} }!!
+
+/** @return a copy of the actors current private collection (actorState) */
+suspend inline fun<reified T, reified R> SendChannel<CollectionMsg<T, R>>.getAll(): R
+		= this.let{actor -> with(CompletableDeferred<R>()){ actor.send(GetAll(this)); this.await()} }
+
+/** @return (blocking) a copy of the actors current private collection (actorState).
+ * !!! This method should not be called from coroutine */
+inline fun<reified T, reified R> SendChannel<CollectionMsg<T, R>>.S_getAll(): R
+		= this.let{actor -> with(CompletableDeferred<R>()){ actor.sendBlocking(GetAll(this)); runBlocking {await()}} }