Merge pull request #391 from FWDekker/uds-dialog

Template dialog

Author: fwdekker

build.gradle.kts

@@ -7,7 +7,6 @@ fun properties(key: String) = project.findProperty(key).toString()
 /// Plugins
 plugins {
     // Compilation
-    id("java")
     id("org.jetbrains.kotlin.jvm") version "1.5.10"  // See also `gradle.properties`
     id("org.jetbrains.intellij") version "0.7.3"
 

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

@@ -1,28 +1,17 @@
 package com.fwdekker.randomness
 
-import com.fwdekker.randomness.array.ArrayScheme
-import com.fwdekker.randomness.array.ArraySettingsAction
 import com.intellij.codeInsight.hint.HintManager
-import com.intellij.icons.AllIcons
-import com.intellij.ide.actions.QuickSwitchSchemeAction
 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.DataContext
-import com.intellij.openapi.actionSystem.DefaultActionGroup
 import com.intellij.openapi.command.WriteCommandAction
+import com.intellij.openapi.options.Configurable
 import com.intellij.openapi.options.ShowSettingsUtil
-import com.intellij.openapi.project.DumbAwareAction
-import com.intellij.openapi.project.Project
 import icons.RandomnessIcons
 import java.awt.event.ActionEvent
-import java.util.concurrent.ExecutionException
-import java.util.concurrent.Executors
-import java.util.concurrent.TimeUnit
-import java.util.concurrent.TimeoutException
 import javax.swing.Icon
-import kotlin.random.Random
 
 
 /**
@@ -45,36 +34,11 @@ abstract class DataGroupAction(private val icon: Icon = RandomnessIcons.Data.Bas
      */
     abstract val insertAction: DataInsertAction
 
-    /**
-     * The action used to insert arrays of data.
-     */
-    abstract val insertArrayAction: DataInsertArrayAction
-
-    /**
-     * The action used to insert repeated single data.
-     */
-    abstract val insertRepeatAction: DataInsertRepeatAction
-
-    /**
-     * The action used to insert repeated arrays of data.
-     */
-    abstract val insertRepeatArrayAction: DataInsertRepeatArrayAction
-
     /**
      * The action used to edit the generator settings for this data type.
      */
     abstract val settingsAction: DataSettingsAction
 
-    /**
-     * The action used to quickly switch between schemes of this data type.
-     */
-    abstract val quickSwitchSchemeAction: DataQuickSwitchSchemeAction<*>
-
-    /**
-     * The action used to quickly switch between array schemes.
-     */
-    abstract val quickSwitchArraySchemeAction: DataQuickSwitchSchemeAction<*>
-
 
     /**
      * Returns the insert action, array insert action, and settings action.
@@ -83,7 +47,7 @@ abstract class DataGroupAction(private val icon: Icon = RandomnessIcons.Data.Bas
      * @return the insert action, array insert action, and settings action
      */
     override fun getChildren(event: AnActionEvent?) =
-        arrayOf(insertArrayAction, insertRepeatAction, insertRepeatArrayAction, settingsAction, quickSwitchSchemeAction)
+        arrayOf(settingsAction)
 
     /**
      * Returns `true`.
@@ -99,21 +63,9 @@ abstract class DataGroupAction(private val icon: Icon = RandomnessIcons.Data.Bas
      * @param event carries information on the invocation place
      */
     override fun actionPerformed(event: AnActionEvent) {
-        val altPressed = event.modifiers and ActionEvent.ALT_MASK != 0
-        val ctrlPressed = event.modifiers and ActionEvent.CTRL_MASK != 0
-        val shiftPressed = event.modifiers and ActionEvent.SHIFT_MASK != 0
-
         // alt behavior is handled by implementation of `actionPerformed`
-        when {
-            altPressed && ctrlPressed && shiftPressed -> quickSwitchArraySchemeAction.actionPerformed(event)
-            altPressed && ctrlPressed -> quickSwitchSchemeAction.actionPerformed(event)
-            altPressed && shiftPressed -> insertRepeatArrayAction.actionPerformed(event)
-            ctrlPressed && shiftPressed -> ArraySettingsAction().actionPerformed(event)
-            altPressed -> insertRepeatAction.actionPerformed(event)
-            ctrlPressed -> settingsAction.actionPerformed(event)
-            shiftPressed -> insertArrayAction.actionPerformed(event)
-            else -> insertAction.actionPerformed(event)
-        }
+        if (event.modifiers and ActionEvent.CTRL_MASK != 0) settingsAction.actionPerformed(event)
+        else insertAction.actionPerformed(event)
     }
 
     /**
@@ -149,9 +101,9 @@ abstract class DataInsertAction(private val icon: Icon) : AnAction() {
     abstract val name: String
 
     /**
-     * The random generator used to generate random values.
+     * The scheme that is used to generate data.
      */
-    var random: Random = Random.Default
+    abstract val scheme: Scheme
 
 
     /**
@@ -169,7 +121,7 @@ abstract class DataInsertAction(private val icon: Icon) : AnAction() {
     }
 
     /**
-     * Inserts the data generated by [generateStrings] at the caret(s) in the editor; one datum for each caret.
+     * Inserts the data generated by the scheme at the caret(s) in the editor; one datum for each caret.
      *
      * @param event carries information on the invocation place
      */
@@ -182,7 +134,7 @@ abstract class DataInsertAction(private val icon: Icon) : AnAction() {
 
         val data =
             try {
-                generateStringsTimely(editor.caretModel.caretCount)
+                generateTimely { scheme.generateStrings(editor.caretModel.caretCount) }
             } catch (e: DataGenerationException) {
                 HintManager.getInstance().showErrorHint(
                     editor,
@@ -207,67 +159,6 @@ abstract class DataInsertAction(private val icon: Icon) : AnAction() {
         }
     }
 
-    /**
-     * Generates a random datum.
-     *
-     * @return a random datum
-     * @throws DataGenerationException if data could not be generated
-     */
-    @Throws(DataGenerationException::class)
-    fun generateString() = generateStrings(1).first()
-
-    /**
-     * Generates a random datum, or throws an exception if it takes longer than [GENERATOR_TIMEOUT] milliseconds.
-     *
-     * @return a random datum
-     * @throws DataGenerationException if data could not be generated in time
-     */
-    @Throws(DataGenerationException::class)
-    fun generateStringTimely() = generateTimely { generateString() }
-
-    /**
-     * Generates random data.
-     *
-     * @param count the number of data to generate
-     * @return random data
-     * @throws DataGenerationException if data could not be generated
-     */
-    @Throws(DataGenerationException::class)
-    abstract fun generateStrings(count: Int = 1): List<String>
-
-    /**
-     * Generates random data, or throws an exception if it takes longer than [GENERATOR_TIMEOUT] milliseconds.
-     *
-     * @param count the number of data to generate
-     * @return random data
-     * @throws DataGenerationException if data could not be generated in time
-     */
-    @Throws(DataGenerationException::class)
-    fun generateStringsTimely(count: Int = 1) = generateTimely { generateStrings(count) }
-
-    /**
-     * Runs the given function and returns its return value, or throws an exception if it takes longer than
-     * [GENERATOR_TIMEOUT] milliseconds.
-     *
-     * @param T the return type of [generator]
-     * @param generator the function to call
-     * @return the return value of [generator]
-     * @throws DataGenerationException if data could not be generated in time
-     */
-    @Throws(DataGenerationException::class)
-    private fun <T> generateTimely(generator: () -> T): T {
-        val executor = Executors.newSingleThreadExecutor()
-        try {
-            return executor.submit<T> { generator() }.get(GENERATOR_TIMEOUT, TimeUnit.MILLISECONDS)
-        } catch (e: TimeoutException) {
-            throw DataGenerationException("Timed out while generating data.", e)
-        } catch (e: ExecutionException) {
-            throw DataGenerationException(e.cause?.message ?: e.message, e)
-        } finally {
-            executor.shutdown()
-        }
-    }
-
 
     /**
      * Holds constants.
@@ -281,86 +172,6 @@ abstract class DataInsertAction(private val icon: Icon) : AnAction() {
 }
 
 
-/**
- * Inserts randomly generated arrays of strings at the event's editor's carets.
- *
- * @param arrayScheme the scheme to use for generating arrays
- * @param dataInsertAction the action to generate data with
- * @param icon the icon to display with the action
- */
-abstract class DataInsertArrayAction(
-    private val arrayScheme: ArrayScheme,
-    private val dataInsertAction: DataInsertAction,
-    icon: Icon = RandomnessIcons.Data.Array
-) : DataInsertAction(icon) {
-    /**
-     * Generates array-like strings of random data.
-     *
-     * @param count the number of array-like strings to generate
-     * @return array-like strings of random data
-     * @throws DataGenerationException if data could not be generated
-     */
-    @Throws(DataGenerationException::class)
-    override fun generateStrings(count: Int): List<String> {
-        if (arrayScheme.count <= 0)
-            throw DataGenerationException("Array cannot have fewer than 1 element.")
-
-        dataInsertAction.random = random
-        return dataInsertAction.generateStrings(count * arrayScheme.count)
-            .chunked(arrayScheme.count)
-            .map { arrayScheme.arrayify(it) }
-    }
-}
-
-
-/**
- * Inserts the same randomly generated string at the event's editor's carets.
- *
- * @param dataInsertAction the action to generate data with
- * @param icon the icon to display with the action
- */
-abstract class DataInsertRepeatAction(
-    private val dataInsertAction: DataInsertAction,
-    icon: Icon = RandomnessIcons.Data.Array
-) : DataInsertAction(icon) {
-    /**
-     * Generates a random datum and repeats it [count] times.
-     *
-     * @param count the number of times to repeat the data
-     * @return a random datum, repeated [count] times
-     * @throws DataGenerationException if data could not be generated
-     */
-    @Throws(DataGenerationException::class)
-    override fun generateStrings(count: Int): List<String> {
-        dataInsertAction.random = random
-        return dataInsertAction.generateString().let { string -> List(count) { string } }
-    }
-}
-
-
-/**
- * Inserts the same randomly generated array of strings at the event's editor's carets.
- *
- * @param dataInsertArrayAction the action to generate data with
- * @param icon the icon to display with the action
- */
-abstract class DataInsertRepeatArrayAction(
-    private val dataInsertArrayAction: DataInsertArrayAction,
-    icon: Icon = RandomnessIcons.Data.Array
-) : DataInsertAction(icon) {
-    /**
-     * Generates a random array-like string of random data and repeats it [count] times.
-     *
-     * @param count the number of times to repeat the data
-     * @return a random array-like string of random data and repeats it [count] times
-     * @throws DataGenerationException if data could not be generated
-     */
-    @Throws(DataGenerationException::class)
-    override fun generateStrings(count: Int) =
-        dataInsertArrayAction.generateString().let { string -> List(count) { string } }
-}
-
-
 /**
  * Opens the settings window for changing settings.
  *
@@ -375,7 +186,7 @@ abstract class DataSettingsAction(private val icon: Icon = RandomnessIcons.Data.
     /**
      * The class of the configurable maintaining the settings.
      */
-    protected abstract val configurableClass: Class<out SettingsConfigurable<*, *>>
+    protected abstract val configurableClass: Class<out Configurable>
 
 
     /**
@@ -398,55 +209,3 @@ abstract class DataSettingsAction(private val icon: Icon = RandomnessIcons.Data.
     override fun actionPerformed(event: AnActionEvent) =
         ShowSettingsUtil.getInstance().showSettingsDialog(event.project, configurableClass)
 }
-
-
-/**
- * Opens a popup to allow the user to quickly switch to the selected scheme.
- *
- * @param T the type of scheme that can be switched between
- * @param settings the settings containing the schemes that can be switched between
- * @param icon the icon to present with this action
- */
-abstract class DataQuickSwitchSchemeAction<T : Scheme<T>>(
-    private val settings: Settings<*, T>,
-    private val icon: Icon = RandomnessIcons.Data.Settings
-) : QuickSwitchSchemeAction(true) {
-    /**
-     * The name of the action.
-     */
-    abstract val name: String
-
-
-    /**
-     * Sets the title and icon of this action.
-     *
-     * @param event carries information on the invocation place
-     */
-    override fun update(event: AnActionEvent) {
-        super.update(event)
-
-        event.presentation.text = name
-        event.presentation.icon = icon
-    }
-
-    /**
-     * Adds actions for all schemes in `settings` to the given group.
-     *
-     * @param project ignored
-     * @param group the group to add actions to
-     * @param dataContext ignored
-     */
-    override fun fillActions(project: Project?, group: DefaultActionGroup, dataContext: DataContext) {
-        val current = settings.currentScheme
-
-        settings.schemes.forEach { scheme ->
-            val icon = if (scheme === current) AllIcons.Actions.Forward else ourNotCurrentAction
-
-            group.add(object : DumbAwareAction(scheme.myName, "", icon) {
-                override fun actionPerformed(event: AnActionEvent) {
-                    settings.currentSchemeName = scheme.name
-                }
-            })
-        }
-    }
-}