plugin/org.danbrough.xtras

Package-level declarations

Types

data class CInteropsConfig(var defFile: File, var interopsPackage: String, var isStatic: Boolean = false, var declaration: String? = null, var targetWriter: CInteropsTargetWriter = defaultCInteropsTargetWriter, var code: String? = null, var codeFile: File? = null, var extraLibsDirs: List<ExtraLibsDirectory> = emptyList())

CInteropsTargetWriter

typealias CInteropsTargetWriter = XtrasLibrary.(CInteropsConfig, KonanTarget, PrintWriter) -> Unit

ExtraLibsDirectory

typealias ExtraLibsDirectory = (KonanTarget) -> File

ScriptCommand

typealias ScriptCommand = ScriptCommandContext.(KonanTarget) -> Unit

ScriptCommandContext

class ScriptCommandContext(val writer: PrintWriter)

TaskConfig

typealias TaskConfig = (KonanTarget) -> TaskProvider<*>

Xtras

abstract class Xtras(val project: Project)

XtrasDSL

@DslMarker

annotation class XtrasDSL

XtrasEnvironment

typealias XtrasEnvironment = MutableMap<String, Any>

XtrasEnvironmentConfig

typealias XtrasEnvironmentConfig = XtrasEnvironment.(target: KonanTarget?) -> Unit

XtrasLibrary

abstract class XtrasLibrary(val group: String, val name: String, val version: String, val project: Project)

XtrasPath

enum XtrasPath : Enum<XtrasPath>

XtrasPlugin

class XtrasPlugin : Plugin<Any>

Properties

androidLibDir

val KonanTarget.androidLibDir: String?

ENV_BUILD_DIR

const val ENV_BUILD_DIR: String

envLibraryPathName

val KonanTarget.envLibraryPathName: String

goArch

val KonanTarget.goArch: String

goOS

val KonanTarget.goOS: String?

hostTriplet

val KonanTarget.hostTriplet: String

INITIAL_ENVIRONMENT

val Xtras.INITIAL_ENVIRONMENT: XtrasEnvironmentConfig

jniTargets

val jniTargets: Set<KonanTarget>

Set of KonanTarget that support JNI implementations

konanDir

val Project.konanDir: File

kotlinTargetName

val KonanTarget.kotlinTargetName: String

mixedPath

val File.mixedPath: String

sharedLibExtn

val KonanTarget.sharedLibExtn: String

supportsJNI

val KonanTarget.supportsJNI: Boolean

Whether the KonanTarget is in jniTargets

targetNameMap

val KonanTarget.Companion.targetNameMap: Map<String, KonanTarget>

XTRAS_EXTENSION_NAME

const val XTRAS_EXTENSION_NAME: String

XTRAS_GROUP

const val XTRAS_GROUP: String

XTRAS_LOCAL_REPO_NAME

const val XTRAS_LOCAL_REPO_NAME: String

XTRAS_REPO_NAME

const val XTRAS_REPO_NAME: String

XTRAS_SONATYPE_REPO_NAME

const val XTRAS_SONATYPE_REPO_NAME: String

XTRAS_TASK_GROUP

const val XTRAS_TASK_GROUP: String

xtrasBuildDir

val Project.xtrasBuildDir: File

Path to the xtras build directory. This is the prefix directory for compiled source code.

xtrasCInteropsDir

val Project.xtrasCInteropsDir: File

Path to the xtras cinterops directory. This is where cinterop files are generated from headers.

xtrasDir

val Project.xtrasDir: File

Path to the top level xtras directory. This is where sources and binary packages are downloaded and built.

xtrasDocsDir

val Project.xtrasDocsDir: File

Path to the xtras kdocs directory. This is where kdoc documentation is generated to.

xtrasDownloadsDir

val Project.xtrasDownloadsDir: File

Path to the xtras downloads directory. This is where source archives are downloaded to.

xtrasExtension

val Project.xtrasExtension: Xtras

xtrasLibsDir

val Project.xtrasLibsDir: File

Path to the xtras libs directory. This where binary packages are extracted to.

xtrasLocalRepoDir

val Project.xtrasLocalRepoDir: File

xtrasLogsDir

val Project.xtrasLogsDir: File

Path to the xtras logs directory. This is where log output of build tasks are stored.

xtrasMavenDir

val Project.xtrasMavenDir: File

Path to the xtras maven directory. This is where binary archives are published to.

xtrasMsysDir

val Project.xtrasMsysDir: File

Path to the msys directory (used on windows).

xtrasNdkDir

val Project.xtrasNdkDir: File

Path to the ndk directory. Defaults to the environment variable ANDROID_NDK_ROOT then ANDROID_NDK_HOME

xtrasPackagesDir

val Project.xtrasPackagesDir: File

Path to the xtras packages directory. This is where binary archives are stored.

xtrasSourceDir

val Project.xtrasSourceDir: File

Path to the xtras source directory. This is where source code is located

Functions

capitalized

fun String.capitalized(): String

decapitalized

fun String.decapitalized(): String

environmentKonan

fun XtrasEnvironment.environmentKonan(library: XtrasLibrary, target: KonanTarget, project: Project)

environmentNDK

fun XtrasEnvironment.environmentNDK(xtras: Xtras, target: KonanTarget, project: Project)

log

fun Project.log(msg: String, level: LogLevel = LogLevel.INFO, err: Throwable? = null)

logDebug

inline fun Project.logDebug(msg: String, err: Throwable? = null)

logError

inline fun Project.logError(msg: String, err: Throwable? = null)

logInfo

inline fun Project.logInfo(msg: String, err: Throwable? = null)

logTrace

inline fun Project.logTrace(msg: String, err: Throwable? = null)

logWarn

inline fun Project.logWarn(msg: String, err: Throwable? = null)

pathOf

fun Project.pathOf(vararg paths: Any?): String

fun Project.pathOf(paths: List<Any?>): String

projectProperty

inline fun <T> Project.projectProperty(name: String, noinline defaultValue: () -> T? = null): T

registerBinaryPublication

fun XtrasLibrary.registerBinaryPublication(target: KonanTarget)

registerXtrasGitLibrary

inline fun <T : XtrasLibrary> Project.registerXtrasGitLibrary(extensionName: String, group: String = projectProperty<String>("$extensionName.group"), version: String = projectProperty<String>("$extensionName.version"), url: String = projectProperty<String>("$extensionName.url"), commit: String = projectProperty<String>("$extensionName.commit"), noinline block: T.() -> Unit): T

resolveAll

fun File.resolveAll(vararg paths: String): File

fun File.resolveAll(paths: List<String>): File

resolveBinariesFromMaven

fun XtrasLibrary.resolveBinariesFromMaven(target: KonanTarget): File?

unixPath

fun Project.unixPath(file: File): String

xtrasAndroidConfig

fun Project.xtrasAndroidConfig(namespace: String = group.toString(), compileSdk: Int = xtrasExtension.androidConfig.compileSDKVersion, block: LibraryExtension.() -> Unit = {})

xtrasPath

fun Project.xtrasPath(path: XtrasPath): File

xtrasPom

fun Publication.xtrasPom(projectName: String, projectDescription: String, githubAccount: String = "danbrough", website: String = "https://github.com/", issuesSite: String? = "/issues", scmSite: String? = "scm:git:git@github.com:", licenseApache2: Boolean = true, block: MavenPom.() -> Unit = {})

xtrasProperty

inline fun <T> Project.xtrasProperty(name: String, noinline notFound: () -> T? = null): T

xtrasRegisterLibrary

inline fun <T : XtrasLibrary> Project.xtrasRegisterLibrary(group: String, name: String, version: String, noinline block: T.() -> Unit = {}): T

fun <T : XtrasLibrary> Project.xtrasRegisterLibrary(group: String, name: String, version: String, clazz: Class<T>, block: T.() -> Unit = {}): T

xtrasSharedLibs

fun Project.xtrasSharedLibs(targetFilter: (KotlinNativeTarget) -> Boolean = { it.konanTarget == HostManager.host }, binariesFilter: (NativeBinary) -> Boolean = { it.buildType == NativeBuildType.DEBUG }): List<SharedLibrary>

xtrasTestExecutables

fun Project.xtrasTestExecutables(configPrefix: String, tests: List<String>, targets: List<KotlinNativeTarget> = (kotlinExtension as KotlinMultiplatformExtension).targets.withType<KotlinNativeTarget>() .toList(), block: Executable.() -> Unit = {})

xtrasTesting

fun Project.xtrasTesting(block: AbstractTestTask.() -> Unit): DomainObjectCollection<AbstractTestTask>