Merge pull request #19 from SnipMeDev/feature/better-theme-api

Better theme api

Author: tmaxxdd

.DS_Store

@@ -1,3 +1,13 @@
+## [0.7.0]
+
+### Added
+- `key` field to `SyntaxTheme` model
+- `getNames()` function to `SyntaxThemes`
+- `SyntaxTheme.useDark(darkMode: Boolean)` extension to `SyntaxThemes`
+
+### Changed
+- static theme constructors names in `SyntaxTheme`
+
 ## [0.6.0]
 
 ### Added

CHANGELOG.md

@@ -15,7 +15,7 @@ repositories {
 ```
 
 ```shell
-implementation("dev.snipme:highlights:0.6.0")
+implementation("dev.snipme:highlights:0.7.0")
 ```
 
 ## Features ✨
@@ -217,6 +217,7 @@ You can also prepare your own themes and use them. Just create the `SyntaxTheme`
 
 ```kotlin
 SyntaxTheme(
+    key = "MY_THEME",
     code = 0xEDEDED,
     keyword = 0xCC7832,
     string = 0x6A8759,

README.md

@@ -13,7 +13,7 @@ plugins {
 }
 
 group = "dev.snipme"
-version = "0.6.0"
+version = "0.7.0"
 
 kotlin {
     // Android

build.gradle.kts

@@ -31,5 +31,5 @@ application {
 }
 
 dependencies {
-    implementation("dev.snipme:highlights:0.6.0")
+    implementation("dev.snipme:highlights:0.7.0")
 }

sample/build.gradle.kts

@@ -2,6 +2,7 @@ import dev.snipme.highlights.Highlights
 import dev.snipme.highlights.model.BoldHighlight
 import dev.snipme.highlights.model.PhraseLocation
 import dev.snipme.highlights.model.SyntaxLanguage
+import dev.snipme.highlights.model.SyntaxThemes
 
 val sampleClass = """
     @Serializable
@@ -39,7 +40,7 @@ fun main() {
     println()
 
     println("Available themes:")
-    println("${Highlights.themes(darkMode = false).keys}")
+    println("${SyntaxThemes.getNames()}")
     println()
 
     println("This is a sample class:")
@@ -48,6 +49,7 @@ fun main() {
 
     val highlights = Highlights.Builder()
         .code(sampleClass)
+        .theme(SyntaxThemes.monokai())
         .language(SyntaxLanguage.JAVA)
         .build()
 

sample/src/main/kotlin/Main.kt

@@ -1,7 +1,7 @@
 package dev.snipme.highlights.model
 
-// TODO Replace Int with Pair to support light / dark mode
 data class SyntaxTheme(
+    val key: String,
     val code: Int,
     val keyword: Int,
     val string: Int,
@@ -13,7 +13,8 @@ data class SyntaxTheme(
     val mark: Int
 ) {
     companion object {
-        fun simple(code: Int, string: Int, accent: Int, value: Int) = SyntaxTheme(
+        fun simple(key: String, code: Int, string: Int, accent: Int, value: Int) = SyntaxTheme(
+            key = key,
             code = code,
             keyword = accent,
             string = string,
@@ -25,16 +26,18 @@ data class SyntaxTheme(
             mark = code
         )
 
-        fun general(code: Int, string: Int, accent: Int, value: Int, comment: Int) = SyntaxTheme(
-            code = code,
-            keyword = accent,
-            string = string,
-            literal = value,
-            comment = comment,
-            metadata = code,
-            multilineComment = comment,
-            punctuation = accent,
-            mark = code
-        )
+        fun basic(key: String, code: Int, string: Int, accent: Int, value: Int, comment: Int) =
+            SyntaxTheme(
+                key = key,
+                code = code,
+                keyword = accent,
+                string = string,
+                literal = value,
+                comment = comment,
+                metadata = code,
+                multilineComment = comment,
+                punctuation = accent,
+                mark = code
+            )
     }
 }

src/commonMain/kotlin/dev/snipme/highlights/model/SyntaxTheme.kt

@@ -10,6 +10,7 @@ object SyntaxThemes {
 
     val dark = mapOf(
         DARCULA_KEY to SyntaxTheme(
+            key = DARCULA_KEY,
             code = 0xEDEDED,
             keyword = 0xCC7832,
             string = 0x6A8759,
@@ -21,6 +22,7 @@ object SyntaxThemes {
             mark = 0xEDEDED
         ),
         MONOKAI_KEY to SyntaxTheme(
+            key = MONOKAI_KEY,
             code = 0xF8F8F2,
             keyword = 0xF92672,
             string = 0xE6DB74,
@@ -32,6 +34,7 @@ object SyntaxThemes {
             mark = 0xF8F8F2
         ),
         NOTEPAD_KEY to SyntaxTheme(
+            key = NOTEPAD_KEY,
             code = 0x000080,
             keyword = 0x0000FF,
             string = 0x808080,
@@ -43,6 +46,7 @@ object SyntaxThemes {
             mark = 0xAA2C8C
         ),
         MATRIX_KEY to SyntaxTheme(
+            key = MATRIX_KEY,
             code = 0x008500,
             keyword = 0x008500,
             string = 0x269926,
@@ -54,6 +58,7 @@ object SyntaxThemes {
             mark = 0x008500
         ),
         PASTEL_KEY to SyntaxTheme(
+            key = PASTEL_KEY,
             code = 0xDFDEE0,
             keyword = 0x729FCF,
             string = 0x93CF55,
@@ -68,6 +73,7 @@ object SyntaxThemes {
 
     val light = mapOf(
         DARCULA_KEY to SyntaxTheme(
+            key = DARCULA_KEY,
             code = 0x121212,
             keyword = 0xCC7832,
             string = 0x6A8759,
@@ -79,6 +85,7 @@ object SyntaxThemes {
             mark = 0x121212
         ),
         MONOKAI_KEY to SyntaxTheme(
+            key = MONOKAI_KEY,
             code = 0x07070D,
             keyword = 0xF92672,
             string = 0xE6DB74,
@@ -90,6 +97,7 @@ object SyntaxThemes {
             mark = 0x07070D
         ),
         NOTEPAD_KEY to SyntaxTheme(
+            key = NOTEPAD_KEY,
             code = 0x000080,
             keyword = 0x0000FF,
             string = 0x808080,
@@ -101,6 +109,7 @@ object SyntaxThemes {
             mark = 0xAA2C8C
         ),
         MATRIX_KEY to SyntaxTheme(
+            key = MATRIX_KEY,
             code = 0x008500,
             keyword = 0x008500,
             string = 0x269926,
@@ -112,6 +121,7 @@ object SyntaxThemes {
             mark = 0x008500
         ),
         PASTEL_KEY to SyntaxTheme(
+            key = PASTEL_KEY,
             code = 0x20211F,
             keyword = 0x729FCF,
             string = 0x93CF55,
@@ -127,10 +137,18 @@ object SyntaxThemes {
     fun themes(darkMode: Boolean = false) = if (darkMode) dark else light
 
     fun default(darkMode: Boolean = false) = themes(darkMode)[DARCULA_KEY]!!
+
     fun darcula(darkMode: Boolean = false) = themes(darkMode)[DARCULA_KEY]!!
     fun monokai(darkMode: Boolean = false) = themes(darkMode)[MONOKAI_KEY]!!
     fun notepad(darkMode: Boolean = false) = themes(darkMode)[NOTEPAD_KEY]!!
     fun matrix(darkMode: Boolean = false) = themes(darkMode)[MATRIX_KEY]!!
     fun pastel(darkMode: Boolean = false) = themes(darkMode)[PASTEL_KEY]!!
 
+    fun getNames(): List<String> = SyntaxThemes.light.map {
+        it.key
+            .lowercase()
+            .replaceFirstChar { if (it.isLowerCase()) it.titlecase() else it.toString() }
+    }
+
+    fun SyntaxTheme.useDark(darkMode: Boolean) = if (darkMode) dark[key] else light[key]
 }