summaryrefslogtreecommitdiff
path: root/platform/diff-impl/src/com/intellij/diff/tools/external/ExternalDiffSettings.kt
blob: 6212c47a899ad1f1f2392fe6928fcf66a760a1a9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
// Copyright 2000-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package com.intellij.diff.tools.external

import com.intellij.diff.util.DiffUtil
import com.intellij.openapi.components.*
import com.intellij.openapi.fileTypes.FileType
import com.intellij.openapi.fileTypes.FileTypeManager
import com.intellij.openapi.util.text.StringUtil
import com.intellij.util.PathUtilRt
import com.intellij.util.xmlb.annotations.OptionTag
import org.jetbrains.annotations.NonNls

@State(name = "ExternalDiffSettings", storages = [Storage(DiffUtil.DIFF_CONFIG)], category = SettingsCategory.TOOLS)
class ExternalDiffSettings : BaseState(), PersistentStateComponent<ExternalDiffSettings> {
  override fun getState(): ExternalDiffSettings = this
  override fun loadState(state: ExternalDiffSettings) {
    migrateOldSettings(state)
    copyFrom(state)
  }

  override fun noStateLoaded() {
    isSettingsMigrated = true
  }

  @get:OptionTag("MIGRATE_OLD_SETTINGS")
  var isSettingsMigrated by property(false)

  @get:OptionTag("EXTERNAL_TOOLS_ENABLED")
  var isExternalToolsEnabled: Boolean by property(false)

  @get:OptionTag("EXTERNAL_TOOLS_CONFIGURATION")
  var externalToolsConfiguration: MutableList<ExternalToolConfiguration> by list()

  @get:OptionTag("EXTERNAL_TOOLS")
  var externalTools: MutableMap<ExternalToolGroup, List<ExternalTool>> by map()

  @get:OptionTag("DEFAULT_TOOL_CONFIGURATION")
  var defaultToolConfiguration: ExternalToolConfiguration by property(ExternalToolConfiguration.builtinInstance) {
    it == ExternalToolConfiguration.builtinInstance
  }

  data class ExternalToolConfiguration(
    @NonNls var fileTypeName: String = DEFAULT_TOOL_NAME,
    @NonNls var diffToolName: String = BUILTIN_TOOL,
    @NonNls var mergeToolName: String = BUILTIN_TOOL
  ) {
    companion object {
      @NonNls
      const val DEFAULT_TOOL_NAME = "Default"

      @NonNls
      const val BUILTIN_TOOL = "Built-in"

      val builtinInstance = ExternalToolConfiguration()
    }
  }

  enum class ExternalToolGroup(val groupName: String) {
    DIFF_TOOL("Diff tool"),
    MERGE_TOOL("Merge tool")
  }

  data class ExternalTool(
    @NonNls var name: String = "",
    var programPath: String = "",
    var argumentPattern: String = "",
    var isMergeTrustExitCode: Boolean = false,
    var groupName: ExternalToolGroup = ExternalToolGroup.DIFF_TOOL
  )

  // OLD SETTINGS AREA
  @get:OptionTag("DIFF_ENABLED")
  var isDiffEnabled: Boolean by property(false)

  @get:OptionTag("DIFF_EXE_PATH")
  var diffExePath: String by nonNullString()

  @get:OptionTag("DIFF_PARAMETERS")
  var diffParameters: String by nonNullString("%1 %2 %3")

  @get:OptionTag("MERGE_ENABLED")
  var isMergeEnabled: Boolean by property(false)

  @get:OptionTag("MERGE_EXE_PATH")
  var mergeExePath: String by nonNullString()

  @get:OptionTag("MERGE_PARAMETERS")
  var mergeParameters: String by nonNullString("%1 %2 %3 %4")

  @get:OptionTag("MERGE_TRUST_EXIT_CODE")
  var isMergeTrustExitCode: Boolean by property(false)
  // ^^^ OLD SETTINGS AREA

  private fun nonNullString(initialValue: String = "") = property(initialValue) { it == initialValue }

  companion object {
    @JvmStatic
    val instance: ExternalDiffSettings
      get() = service()

    private val fileTypeManager
      get() = FileTypeManager.getInstance()

    @JvmStatic
    fun findDefaultDiffTool(): ExternalTool? {
      val diffToolName = instance.defaultToolConfiguration.diffToolName

      if (diffToolName == ExternalToolConfiguration.BUILTIN_TOOL) return null
      val diffTools = instance.externalTools[ExternalToolGroup.DIFF_TOOL] ?: return null

      return findTool(diffTools, diffToolName)
    }

    @JvmStatic
    fun findDiffTool(fileType: FileType): ExternalTool? {
      val diffToolName = findToolConfiguration(fileType)?.diffToolName
                         ?: instance.defaultToolConfiguration.diffToolName

      if (diffToolName == ExternalToolConfiguration.BUILTIN_TOOL) return null
      val diffTools = instance.externalTools[ExternalToolGroup.DIFF_TOOL] ?: return null

      return findTool(diffTools, diffToolName)
    }

    @JvmStatic
    fun findMergeTool(fileType: FileType): ExternalTool? {
      val mergeToolName = findToolConfiguration(fileType)?.mergeToolName
                          ?: instance.defaultToolConfiguration.mergeToolName

      if (mergeToolName == ExternalToolConfiguration.BUILTIN_TOOL) return null
      val mergeTools = instance.externalTools[ExternalToolGroup.MERGE_TOOL] ?: return null

      return findTool(mergeTools, mergeToolName)
    }

    @JvmStatic
    fun isNotBuiltinDiffTool(): Boolean {
      return instance.defaultToolConfiguration.diffToolName != ExternalToolConfiguration.BUILTIN_TOOL
    }

    @JvmStatic
    fun isNotBuiltinMergeTool(): Boolean {
      return instance.defaultToolConfiguration.mergeToolName != ExternalToolConfiguration.BUILTIN_TOOL
    }

    private fun findTool(tools: List<ExternalTool>, toolName: String): ExternalTool? = tools.find { it.name == toolName }

    private fun findToolConfiguration(fileType: FileType): ExternalToolConfiguration? = instance.externalToolsConfiguration.find {
      fileTypeManager.findFileTypeByName(it.fileTypeName) == fileType
    }

    private fun migrateOldSettings(state: ExternalDiffSettings) {
      if (!state.isSettingsMigrated) {
        // load old settings
        state.isExternalToolsEnabled = state.isDiffEnabled || state.isMergeEnabled

        // save old settings
        state.defaultToolConfiguration = ExternalToolConfiguration().apply {
          if (state.diffExePath.isNotEmpty()) {
            val oldDiffTool = ExternalTool(StringUtil.capitalize(PathUtilRt.getFileName(state.diffExePath)),
                                           state.diffExePath, state.diffParameters,
                                           false, ExternalToolGroup.DIFF_TOOL)
            state.externalTools[ExternalToolGroup.DIFF_TOOL] = listOf(oldDiffTool)
            diffToolName = oldDiffTool.name
          }

          if (state.mergeExePath.isNotEmpty()) {
            val oldMergeTool = ExternalTool(StringUtil.capitalize(PathUtilRt.getFileName(state.mergeExePath)),
                                            state.mergeExePath, state.mergeParameters,
                                            state.isMergeTrustExitCode, ExternalToolGroup.MERGE_TOOL)
            state.externalTools[ExternalToolGroup.MERGE_TOOL] = listOf(oldMergeTool)
            mergeToolName = oldMergeTool.name
          }
        }

        state.isSettingsMigrated = true
      }
    }
  }
}