Merge pull request #397 from FWDekker/v3-major-features

Two major features for v3

Author: fwdekker

src/main/kotlin/com/fwdekker/randomness/PopupAction.kt

@@ -8,6 +8,7 @@ import com.intellij.openapi.actionSystem.ActionGroup
 import com.intellij.openapi.actionSystem.AnAction
 import com.intellij.openapi.actionSystem.AnActionEvent
 import com.intellij.openapi.actionSystem.CommonDataKeys
+import com.intellij.openapi.actionSystem.Separator
 import com.intellij.openapi.ui.popup.JBPopupFactory
 import com.intellij.ui.popup.list.ListPopupImpl
 import icons.RandomnessIcons
@@ -100,7 +101,9 @@ class PopupAction : AnAction() {
          * @param event carries information on the invocation place
          */
         override fun getChildren(event: AnActionEvent?) =
-            TemplateSettings.default.state.templates.map { TemplateGroupAction(it) }.toTypedArray()
+            TemplateSettings.default.state.templates.map { TemplateGroupAction(it) }.toTypedArray<AnAction>() +
+                Separator() +
+                TemplateSettingsAction()
     }
 
     /**
@@ -113,7 +116,9 @@ class PopupAction : AnAction() {
          * @param event carries information on the invocation place
          */
         override fun getChildren(event: AnActionEvent?) =
-            arrayOf(TemplateSettingsAction())
+            TemplateSettings.default.state.templates.map { TemplateSettingsAction(it) }.toTypedArray<AnAction>() +
+                Separator() +
+                TemplateSettingsAction()
     }
 
 

src/main/kotlin/com/fwdekker/randomness/Scheme.kt

@@ -2,6 +2,7 @@ package com.fwdekker.randomness
 
 import com.fwdekker.randomness.array.ArraySchemeDecorator
 import com.intellij.util.xmlb.annotations.Transient
+import icons.RandomnessIcons
 import javax.swing.Icon
 import kotlin.random.Random
 
@@ -17,14 +18,27 @@ abstract class Scheme : State() {
      */
     abstract val decorator: ArraySchemeDecorator?
 
+    /**
+     * The name of the scheme as shown to the user.
+     */
+    abstract val name: String
+
+    /**
+     * The icons that represent schemes of this type.
+     */
+    @Transient
+    open val icons: RandomnessIcons? = null
+
     /**
      * The icon for this scheme; depends on whether its array decorator is enabled.
      */
-    override val icon: Icon?
+    @get:Transient
+    val icon: Icon?
         get() =
             if (decorator?.enabled == true) icons?.Array
             else icons?.Base
 
+
     /**
      * The random number generator used to generate random values.
      */
@@ -63,8 +77,17 @@ abstract class Scheme : State() {
     @Throws(DataGenerationException::class)
     abstract fun generateUndecoratedStrings(count: Int = 1): List<String>
 
+    /**
+     * Sets the [SettingsState] that may be used by this scheme.
+     *
+     * Useful in case the scheme's behavior depends not only on its own internal state, but also that of other settings.
+     */
+    open fun setSettingsState(settingsState: SettingsState) {
+        decorator?.setSettingsState(settingsState)
+    }
+
 
-    abstract override fun deepCopy(): Scheme
+    abstract override fun deepCopy(retainUuid: Boolean): Scheme
 }
 
 /**

src/main/kotlin/com/fwdekker/randomness/Settings.kt

@@ -0,0 +1,9 @@
+package com.fwdekker.randomness
+
+
+/**
+ * A user-configurable persistent collection.
+ */
+abstract class Settings : State() {
+    abstract override fun deepCopy(retainUuid: Boolean): Settings
+}

src/main/kotlin/com/fwdekker/randomness/SettingsState.kt

@@ -0,0 +1,55 @@
+package com.fwdekker.randomness
+
+import com.fwdekker.randomness.string.SymbolSetSettings
+import com.fwdekker.randomness.template.TemplateList
+import com.fwdekker.randomness.template.TemplateSettings
+import com.fwdekker.randomness.word.DictionarySettings
+
+
+/**
+ * Contains references to various [Settings] objects.
+ *
+ * @property templateList The template list.
+ * @property symbolSetSettings The symbol set settings.
+ * @property dictionarySettings The dictionary settings.
+ */
+data class SettingsState(
+    var templateList: TemplateList = TemplateList(emptyList()),
+    var symbolSetSettings: SymbolSetSettings = SymbolSetSettings(emptyMap()),
+    var dictionarySettings: DictionarySettings = DictionarySettings(emptySet())
+) : State() {
+    override fun doValidate() =
+        templateList.doValidate() ?: symbolSetSettings.doValidate() ?: dictionarySettings.doValidate()
+
+    override fun copyFrom(scheme: State) {
+        require(scheme is SettingsState) { "Cannot copy from non-SettingsState." }
+
+        templateList.copyFrom(scheme.templateList)
+        symbolSetSettings.copyFrom(scheme.symbolSetSettings)
+        dictionarySettings.copyFrom(scheme.dictionarySettings)
+    }
+
+    override fun deepCopy(retainUuid: Boolean) =
+        copy(
+            templateList = templateList.deepCopy(retainUuid = retainUuid),
+            symbolSetSettings = symbolSetSettings.deepCopy(retainUuid = retainUuid),
+            dictionarySettings = dictionarySettings.deepCopy(retainUuid = retainUuid)
+        ).also { if (retainUuid) it.uuid = uuid }
+
+
+    /**
+     * Holds constants.
+     */
+    companion object {
+        /**
+         * The persistent `SettingsState` instance.
+         */
+        val default by lazy {
+            SettingsState(
+                TemplateSettings.default.state,
+                SymbolSetSettings.default,
+                DictionarySettings.default
+            )
+        }
+    }
+}

src/main/kotlin/com/fwdekker/randomness/State.kt

@@ -1,32 +1,22 @@
 package com.fwdekker.randomness
 
+import com.fasterxml.uuid.Generators
 import com.intellij.util.xmlb.XmlSerializerUtil
 import com.intellij.util.xmlb.annotations.Transient
-import icons.RandomnessIcons
-import javax.swing.Icon
+import java.util.UUID
+import kotlin.random.Random
+import kotlin.random.asJavaRandom
 
 
 /**
  * A state holds variables that can be configured.
  */
 abstract class State {
     /**
-     * The name of the scheme as shown to the user.
-     */
-    abstract val name: String
-
-    /**
-     * The icons that represent schemes of this type.
-     */
-    @Transient
-    open val icons: RandomnessIcons? = null
-
-    /**
-     * The icon that represents this scheme instance.
+     * A UUID to uniquely track this scheme even when it is copied.
      */
     @get:Transient
-    open val icon: Icon?
-        get() = icons?.Base
+    var uuid: UUID = Generators.randomBasedGenerator(Random.Default.asJavaRandom()).generate()
 
 
     /**
@@ -44,16 +34,17 @@ abstract class State {
      *
      * @param scheme the scheme to copy into this scheme; should be a subclass of this scheme
      */
-    fun copyFrom(scheme: State) = XmlSerializerUtil.copyBean(scheme.deepCopy(), this)
+    open fun copyFrom(scheme: State) = XmlSerializerUtil.copyBean(scheme.deepCopy(retainUuid = true), this)
 
     /**
      * Returns a deep copy of this scheme.
      *
      * Fields marked with [Transient] will be shallow-copied.
      *
+     * @param retainUuid false if and only if the copy should have a different [uuid]
      * @return a deep copy of this scheme
      */
-    abstract fun deepCopy(): State
+    abstract fun deepCopy(retainUuid: Boolean = false): State
 
 
     /**

src/main/kotlin/com/fwdekker/randomness/StateEditor.kt

@@ -40,7 +40,7 @@ abstract class StateEditor<S : State>(val originalState: S) {
      *
      * Does nothing if and only if [isModified] returns false.
      */
-    fun applyState() = originalState.copyFrom(readState())
+    open fun applyState() = originalState.copyFrom(readState())
 
 
     /**

src/main/kotlin/com/fwdekker/randomness/array/ArraySchemeDecorator.kt

@@ -42,7 +42,7 @@ data class ArraySchemeDecorator(
         if (count < MIN_COUNT) "Minimum count should be at least $MIN_COUNT, but is $count."
         else null
 
-    override fun deepCopy() = copy()
+    override fun deepCopy(retainUuid: Boolean) = copy().also { if (retainUuid) it.uuid = this.uuid }
 
 
     /**

src/main/kotlin/com/fwdekker/randomness/array/ArraySchemeDecoratorEditor.kt

@@ -80,7 +80,7 @@ class ArraySchemeDecoratorEditor(settings: ArraySchemeDecorator) : StateEditor<A
             brackets = bracketsGroup.getValue() ?: DEFAULT_BRACKETS,
             separator = separatorGroup.getValue() ?: DEFAULT_SEPARATOR,
             isSpaceAfterSeparator = spaceAfterSeparatorCheckBox.isSelected
-        )
+        ).also { it.uuid = originalState.uuid }
 
 
     override fun addChangeListener(listener: () -> Unit) =

src/main/kotlin/com/fwdekker/randomness/decimal/DecimalScheme.kt

@@ -75,10 +75,12 @@ data class DecimalScheme(
             maxValue - minValue > MAX_VALUE_DIFFERENCE -> "Value range should not exceed $MAX_VALUE_DIFFERENCE."
             decimalCount < MIN_DECIMAL_COUNT -> "Decimal count should be at least $MIN_DECIMAL_COUNT."
             decimalSeparator.isEmpty() -> "Select a decimal separator."
-            else -> null
+            else -> decorator.doValidate()
         }
 
-    override fun deepCopy() = copy(decorator = decorator.deepCopy())
+    override fun deepCopy(retainUuid: Boolean) =
+        copy(decorator = decorator.deepCopy(retainUuid))
+            .also { if (retainUuid) it.uuid = this.uuid }
 
 
     /**

src/main/kotlin/com/fwdekker/randomness/decimal/DecimalSchemeEditor.kt

@@ -43,7 +43,7 @@ class DecimalSchemeEditor(scheme: DecimalScheme = DecimalScheme()) : StateEditor
         decimalCount.addChangeListener { showTrailingZeroesCheckBox.isEnabled = decimalCount.value > 0 }
         decimalCount.changeListeners.forEach { it.stateChanged(ChangeEvent(decimalCount)) }
 
-        loadState(scheme)
+        loadState()
     }
 
     /**
@@ -88,7 +88,7 @@ class DecimalSchemeEditor(scheme: DecimalScheme = DecimalScheme()) : StateEditor
             prefix = prefixInput.text,
             suffix = suffixInput.text,
             decorator = arrayDecoratorEditor.readState()
-        )
+        ).also { it.uuid = originalState.uuid }
 
 
     override fun addChangeListener(listener: () -> Unit) =