Resolves #254 - Add validation support for around 50 more options

Author: Steve Ramage

README.md

@@ -22,7 +22,8 @@ This plugin adds support for [systemd unit files](https://www.freedesktop.org/so
    * When the section name is invalid or used in the wrong file type
    * Whitespace after a line continuation \ character.
    * When a key has been deprecated.
- * Built-in documentation for options or section name (available when hitting <kbd>CTRL+Q</kbd> or <kbd>F1</kbd> on Mac)   
+ * Built-in documentation for options or section name (available when hitting <kbd>CTRL+Q</kbd> or <kbd>F1</kbd> on Mac)
+ * Templates for several unit types
 
       
 ## Usage

src/main/kotlin/net/sjrx/intellij/plugins/systemdunitfiles/semanticdata/SemanticDataRepository.kt

@@ -70,6 +70,7 @@ class SemanticDataRepository private constructor() {
           }
 
           validatorMap.putAll(BooleanOptionValue.validators)
+          validatorMap.putAll(TriStateOptionValue.validators)
           validatorMap.putAll(DocumentationOptionValue.validators)
           validatorMap.putAll(ModeStringOptionValue.validators)
           validatorMap.putAll(ExecOptionValue.validators)
@@ -81,7 +82,9 @@ class SemanticDataRepository private constructor() {
           validatorMap.putAll(UnsignedIntegerOptionValue.validators)
           validatorMap.putAll(PathOptionValue.validators)
           validatorMap.putAll(EnumOptionValues.validators)
-          validatorMap.putAll(ConfigParseSecOptionValue.validators)
+          validatorMap.putAll(ConfigParseSecValidators.validators)
+          validatorMap.putAll(AllowedCpuSetOptionValue.validators)
+          validatorMap.putAll(TtySizeOptionValue.validators)
 
          // Scopes are not supported since they aren't standard unit files.
 

src/main/kotlin/net/sjrx/intellij/plugins/systemdunitfiles/semanticdata/optionvalues/AllowedCpuSetOptionValue.kt

@@ -0,0 +1,58 @@
+package net.sjrx.intellij.plugins.systemdunitfiles.semanticdata.optionvalues
+
+import com.intellij.openapi.project.Project
+import net.sjrx.intellij.plugins.systemdunitfiles.semanticdata.Validator
+import java.util.regex.Pattern
+
+class AllowedCpuSetOptionValue() : OptionValueInformation  {
+  override fun getAutoCompleteOptions(project: Project): Set<String> {
+    return emptySet()
+  }
+
+  override fun getErrorMessage(value: String): String? {
+    val cpuSetElement = value.split(" ", ",")
+
+    // Loop over cpuSetElement and for each element, if it's an integer do continue
+    // if it's a range value that the first value is less than the second
+
+    for (element in cpuSetElement) {
+
+      if (element.length == 0) {
+        continue
+      }
+
+      // Note we don't validate the input very much because
+      // the regex is very tight, so we know we have integers.
+
+      if (element.matches(CPU_ELEMENT_REGEX.toRegex())) {
+        val range = element.split("-")
+        if (range.size == 2) {
+
+
+          val start = range[0].toInt()
+          val end = range[1].toInt()
+          if (start > end) {
+            return "The start %d of the range must be less than the end %d of the range".format(start, end)
+          }
+        }
+
+      } else {
+        return "Invalid syntax for CPU Range: %s".format(element)
+      }
+    }
+
+    return null
+
+
+  }
+
+  override val validatorName: String
+    get() = VALIDATOR_NAME
+
+  companion object {
+    const val VALIDATOR_NAME = "config_parse_allowed_cpuset"
+
+    private val CPU_ELEMENT_REGEX= Pattern.compile("^[0-9]+(-[0-9]+)?$")
+    val validators = mapOf(Validator(VALIDATOR_NAME) to AllowedCpuSetOptionValue())
+  }
+}

src/main/kotlin/net/sjrx/intellij/plugins/systemdunitfiles/semanticdata/optionvalues/ConfigParseSecOptionValue.kt

@@ -2,8 +2,10 @@ package net.sjrx.intellij.plugins.systemdunitfiles.semanticdata.optionvalues
 
 import com.intellij.openapi.project.Project
 import net.sjrx.intellij.plugins.systemdunitfiles.semanticdata.Validator
+import net.sjrx.intellij.plugins.systemdunitfiles.semanticdata.optionvalues.ConfigParseSecOptionValue.Companion.VALIDATOR_NAME
+
+abstract class AbstractConfigParseSecOptionValue(override val validatorName: String) : OptionValueInformation {
 
-class ConfigParseSecOptionValue : OptionValueInformation {
   override fun getAutoCompleteOptions(project: Project): Set<String> {
     return emptySet()
   }
@@ -17,14 +19,31 @@ class ConfigParseSecOptionValue : OptionValueInformation {
 
     }
   }
+}
 
-  override val validatorName : String
-    get() = VALIDATOR_NAME
-
-
+class ConfigParseSecOptionValue : AbstractConfigParseSecOptionValue(VALIDATOR_NAME){
   companion object {
     const val VALIDATOR_NAME = "config_parse_sec"
+  }
+}
+
+class ConfigParseSecFix0OptionValue : AbstractConfigParseSecOptionValue(VALIDATOR_NAME){
+  companion object {
+    const val VALIDATOR_NAME = "config_parse_sec_fix_0"
+  }
+}
 
-    val validators = mapOf(Validator(VALIDATOR_NAME, "0") to ConfigParseSecOptionValue())
+class ConfigParseSecDefInifinityOptionValue : AbstractConfigParseSecOptionValue(VALIDATOR_NAME){
+  companion object {
+    const val VALIDATOR_NAME = "config_parse_sec_def_infinity"
   }
 }
+
+
+object ConfigParseSecValidators {
+  val validators = mapOf(
+    Validator(ConfigParseSecOptionValue.VALIDATOR_NAME, "0") to ConfigParseSecOptionValue(),
+    Validator(ConfigParseSecFix0OptionValue.VALIDATOR_NAME, "0") to ConfigParseSecFix0OptionValue(),
+    Validator(ConfigParseSecDefInifinityOptionValue.VALIDATOR_NAME, "0") to ConfigParseSecDefInifinityOptionValue()
+  )
+}

src/main/kotlin/net/sjrx/intellij/plugins/systemdunitfiles/semanticdata/optionvalues/TriStateOptionValue.kt

@@ -0,0 +1,43 @@
+package net.sjrx.intellij.plugins.systemdunitfiles.semanticdata.optionvalues
+
+import com.google.common.collect.ImmutableSet
+import com.intellij.openapi.project.Project
+import net.sjrx.intellij.plugins.systemdunitfiles.semanticdata.Validator
+import java.util.*
+
+/**
+ * This validator is for the config_parse_bool validator.
+ *
+ *
+ * The code for this is in: parse-util.c ~ line 21
+ *
+ */
+class TriStateOptionValue : OptionValueInformation {
+  override fun getAutoCompleteOptions(project: Project): Set<String> {
+    return autoCompleteValues
+  }
+
+  override fun getErrorMessage(value: String): String? {
+    return if (validValuesLowerCase.contains(value.lowercase(Locale.getDefault()))) {
+      null
+    } else {
+      "This option takes a boolean value, " + value + " must be one of: " + validValuesLowerCase +  " or the empty string"
+    }
+  }
+
+  override val validatorName: String
+    get() = VALIDATOR_NAME
+
+  companion object {
+    private val validValuesLowerCase: Set<String> = ImmutableSet.of("", "1", "yes", "y", "true", "t", "on", "0", "no", "n", "false", "f", "off")
+    private val autoCompleteValues: Set<String> = ImmutableSet.of("on", "off", "yes", "no", "true", "false")
+    const val VALIDATOR_NAME = "config_parse_tristate"
+
+    val validators = mapOf(
+      Validator(VALIDATOR_NAME, "0") to TriStateOptionValue(),
+
+    )
+
+
+  }
+}

src/main/kotlin/net/sjrx/intellij/plugins/systemdunitfiles/semanticdata/optionvalues/TtySizeOptionValue.kt

@@ -0,0 +1,29 @@
+package net.sjrx.intellij.plugins.systemdunitfiles.semanticdata.optionvalues
+
+import com.intellij.openapi.project.Project
+import net.sjrx.intellij.plugins.systemdunitfiles.semanticdata.Validator
+
+class TtySizeOptionValue : OptionValueInformation {
+
+  override fun getAutoCompleteOptions(project: Project): Set<String> {
+    return emptySet()
+  }
+
+  override fun getErrorMessage(value: String): String? {
+    try {
+      Integer.parseUnsignedInt(value)
+      return null
+    } catch(e : NumberFormatException) {
+      return "This value must be an unsigned integer"
+    }
+  }
+
+  override val validatorName: String
+    get() = VALIDATOR_NAME
+
+  companion object {
+    const val VALIDATOR_NAME="config_parse_tty_size"
+
+    val validators = mapOf(Validator(VALIDATOR_NAME, "0") to TtySizeOptionValue())
+  }
+}

src/main/resources/META-INF/plugin.xml

@@ -15,6 +15,7 @@
         <li>Inspections for some errors such as invalid or unknown or deprecated options</li>
         <li>Quick fixes</li>
         <li>Built-in documentation reference for options</li>
+        <li>Templates for unit files</li>
       </ul>
     ]]></description>