refactor: encapsulate template segment indexes into TemplateSegment

Author: lppedd

src/main/kotlin/com/github/lppedd/cc/completion/ConventionalCommitTextCompletionContributor.kt

@@ -11,7 +11,7 @@ import com.github.lppedd.cc.completion.resultset.ContextResultSet
 import com.github.lppedd.cc.completion.resultset.TemplateResultSet
 import com.github.lppedd.cc.configuration.CCConfigService
 import com.github.lppedd.cc.configuration.CCConfigService.CompletionType.TEMPLATE
-import com.github.lppedd.cc.lookupElement.INDEX_TYPE
+import com.github.lppedd.cc.lookupElement.TemplateSegment
 import com.github.lppedd.cc.parser.CCParser
 import com.github.lppedd.cc.parser.CommitContext.*
 import com.github.lppedd.cc.parser.FooterContext.FooterTypeContext
@@ -147,10 +147,10 @@ internal class ConventionalCommitTextCompletionContributor : CompletionContribut
     val caretLineNumber = caretLogicalPosition.line
     var caretOffsetInLine = caretLogicalPosition.column
     val templateState = editor.getTemplateState()
-    val lineUntilCaret = if (templateState?.currentVariableNumber == INDEX_TYPE) {
+    val lineUntilCaret = if (templateState?.currentVariableNumber == TemplateSegment.Type) {
       // If we are completing a type with a template, we need to consider only
       // the part of the line after the range marker's start
-      val typeStartOffset = templateState.getSegmentRange(INDEX_TYPE).startOffset
+      val typeStartOffset = templateState.getSegmentRange(TemplateSegment.Type).startOffset
       val start = typeStartOffset - document.getLineRangeByOffset(typeStartOffset).startOffset
 
       caretOffsetInLine -= typeStartOffset

src/main/kotlin/com/github/lppedd/cc/liveTemplate/CCTemplateEditingListener.kt

@@ -2,10 +2,7 @@ package com.github.lppedd.cc.liveTemplate
 
 import com.github.lppedd.cc.*
 import com.github.lppedd.cc.annotation.Compatibility
-import com.github.lppedd.cc.lookupElement.INDEX_BODY_OR_FOOTER_TYPE
-import com.github.lppedd.cc.lookupElement.INDEX_FOOTER_VALUE
-import com.github.lppedd.cc.lookupElement.INDEX_SCOPE
-import com.github.lppedd.cc.lookupElement.INDEX_SUBJECT
+import com.github.lppedd.cc.lookupElement.TemplateSegment
 import com.intellij.codeInsight.template.Template
 import com.intellij.codeInsight.template.TemplateEditingAdapter
 import com.intellij.codeInsight.template.impl.TemplateState
@@ -44,8 +41,8 @@ internal class CCTemplateEditingListener : TemplateEditingAdapter() {
       return
     }
 
-    if (oldIndex == INDEX_BODY_OR_FOOTER_TYPE && newIndex > oldIndex) {
-      if (templateState.getSegmentRange(INDEX_BODY_OR_FOOTER_TYPE).isEmpty) {
+    if (oldIndex == TemplateSegment.BodyOrFooterType && newIndex > oldIndex) {
+      if (templateState.getSegmentRange(TemplateSegment.BodyOrFooterType).isEmpty) {
         deleteFooterValue(templateState)
         templateState.gotoEnd()
         return
@@ -59,7 +56,7 @@ internal class CCTemplateEditingListener : TemplateEditingAdapter() {
   }
 
   override fun beforeTemplateFinished(templateState: TemplateState, template: Template) {
-    val bodyOrFooterTypeRange = templateState.getSegmentRange(INDEX_BODY_OR_FOOTER_TYPE)
+    val bodyOrFooterTypeRange = templateState.getSegmentRange(TemplateSegment.BodyOrFooterType)
 
     if (bodyOrFooterTypeRange.isEmpty) {
       repositionCursorAfterSubjectAndCleanUp(templateState, bodyOrFooterTypeRange)
@@ -74,7 +71,7 @@ internal class CCTemplateEditingListener : TemplateEditingAdapter() {
   ) {
     // If the body is empty, it means the user didn't need to insert it.
     // Thus, we can reposition the cursor at the end of the subject
-    val newOffset = templateState.getSegmentRange(INDEX_SUBJECT).endOffset
+    val newOffset = templateState.getSegmentRange(TemplateSegment.Subject).endOffset
 
     if (newOffset <= bodyOrFooterTypeRange.endOffset) {
       val editor = templateState.editor
@@ -88,7 +85,7 @@ internal class CCTemplateEditingListener : TemplateEditingAdapter() {
   }
 
   private fun deleteScopeParenthesesIfEmpty(templateState: TemplateState) {
-    val (scopeStart, scopeEnd, isScopeEmpty) = templateState.getSegmentRange(INDEX_SCOPE)
+    val (scopeStart, scopeEnd, isScopeEmpty) = templateState.getSegmentRange(TemplateSegment.Scope)
 
     // If the scope is empty, it means the user didn't need to insert it, thus we can remove it
     if (isScopeEmpty) {
@@ -105,7 +102,7 @@ internal class CCTemplateEditingListener : TemplateEditingAdapter() {
   }
 
   private fun deleteFooterValue(templateState: TemplateState) {
-    val (start, end, isEmpty) = templateState.getSegmentRange(INDEX_FOOTER_VALUE)
+    val (start, end, isEmpty) = templateState.getSegmentRange(TemplateSegment.FooterValue)
 
     if (!isEmpty) {
       runWriteAction {

src/main/kotlin/com/github/lppedd/cc/lookupElement/TemplateCommitTypeLookupElement.kt

@@ -11,13 +11,6 @@ import com.intellij.codeInsight.template.impl.TemplateImpl
 import com.intellij.codeInsight.template.impl.TemplateSettings
 import com.intellij.openapi.application.runWriteAction
 
-// TODO: move them inside an object/namespace
-internal const val INDEX_TYPE = 0
-internal const val INDEX_SCOPE = 1
-internal const val INDEX_SUBJECT = 2
-internal const val INDEX_BODY_OR_FOOTER_TYPE = 3
-internal const val INDEX_FOOTER_VALUE = 4
-
 /**
  * @author Edoardo Luppi
  *

src/main/kotlin/com/github/lppedd/cc/lookupElement/TemplateLookupElementDecorator.kt

@@ -114,13 +114,13 @@ internal class TemplateLookupElementDecorator(private val delegate: CommitTokenL
     delegate.hashCode()
 
   private fun deleteScopeAndNext(editor: Editor, templateState: TemplateState) {
-    val (start, end) = templateState.getSegmentRange(INDEX_SCOPE)
+    val (start, end) = templateState.getSegmentRange(TemplateSegment.Scope)
     editor.document.deleteString(start, end)
     templateState.nextTab()
   }
 
   private fun appendSeparatorOnFooterType(editor: Editor, templateState: TemplateState) {
-    val offset = templateState.getSegmentRange(INDEX_BODY_OR_FOOTER_TYPE).endOffset
+    val offset = templateState.getSegmentRange(TemplateSegment.BodyOrFooterType).endOffset
     editor.document.insertString(offset, ": ")
 
     invokeLaterOnEdt {

src/main/kotlin/com/github/lppedd/cc/lookupElement/TemplateSegment.kt

@@ -0,0 +1,13 @@
+package com.github.lppedd.cc.lookupElement
+
+/**
+ * @author Edoardo Luppi
+ */
+@Suppress("ConstPropertyName")
+internal object TemplateSegment {
+  const val Type: Int = 0
+  const val Scope: Int = 1
+  const val Subject: Int = 2
+  const val BodyOrFooterType: Int = 3
+  const val FooterValue: Int = 4
+}