com.squareup.sqldelight.intellij.util.SqliteRenameUtil.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ide-plugin Show documentation
IDE plugin for generating java interfaces for sqlite files
There is a newer version: 0.9.0
/*
 * Copyright (C) 2016 Square, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.squareup.sqldelight.intellij.util

import com.intellij.psi.PsiElement
import com.intellij.psi.PsiFile
import com.intellij.psi.PsiMethod
import com.intellij.psi.impl.source.PsiFieldImpl
import com.intellij.psi.impl.source.PsiMethodImpl
import com.intellij.psi.search.searches.OverridingMethodsSearch
import com.intellij.refactoring.listeners.RefactoringElementListener
import com.intellij.refactoring.rename.RenameUtil
import com.intellij.refactoring.rename.RenameUtil.doRename
import com.intellij.usageView.UsageInfo
import com.squareup.sqldelight.SqliteCompiler
import com.squareup.sqldelight.intellij.lang.SqliteFile
import com.squareup.sqldelight.intellij.psi.SqliteElement
import com.squareup.sqldelight.intellij.psi.SqliteElement.ColumnNameElement
import com.squareup.sqldelight.intellij.psi.SqliteElement.SqlStmtNameElement
import com.squareup.sqldelight.model.methodName
import java.util.ArrayList

/**
 * Gather usage info for the given named element, where [SqliteElement.getName] is
 * a valid column name used for generating Java code. This returns a [SqliteUsageInfo]
 * containing sqlite usages, field usages and method usages (which could be the interface or
 * marshal method).
 * @param newElementName If this method is being used as part of a rename, this should be the
 * name the element is being renamed to as that information is stored in the returned usage info.
 */
internal fun SqliteElement.findUsages(newElementName: String): SqliteUsageInfo {
  val generatedFile = (containingFile as? SqliteFile)?.generatedPsiFile
  val sqliteUsages = RenameUtil.findUsages(this, newElementName, false, false, emptyMap())
  val fieldUsages = ArrayList()
  val methodUsages = ArrayList()
  val overridingMethods = ArrayList()

  generatedFile?.processElements {
    if (this is ColumnNameElement && it.isColumnConstantFor(this)) {
      fieldUsages.addAll(notInsideFile(RenameUtil.findUsages(it, SqliteCompiler.constantName(newElementName),
          false, false, emptyMap()), generatedFile))
    } else if (this is ColumnNameElement && it.isColumnMethodFor(this)) {
      methodUsages.addAll(notInsideFile(RenameUtil.findUsages(it, methodName(newElementName),
          false, false, emptyMap()), generatedFile))
      OverridingMethodsSearch.search(it as PsiMethod).toCollection(overridingMethods)
    } else if (this is SqlStmtNameElement && it.isSqlStmtConstantFor(this)) {
      fieldUsages.addAll(notInsideFile(RenameUtil.findUsages(it, SqliteCompiler.constantName(newElementName),
          false, false, emptyMap()), generatedFile))
    }
    true
  }
  return SqliteUsageInfo(fieldUsages, methodUsages, overridingMethods, sqliteUsages)
}

/**
 * Find all the Java PsiElements for a given named element. [SqliteElement.getName]
 * represents the name of the column we are matching PsiElements against.
 */
internal fun SqliteElement.getSecondaryElements() =
    (containingFile as? SqliteFile)?.generatedPsiFile?.collectElements {
      when (this) {
        is ColumnNameElement -> it.isColumnConstantFor(this) || it.isColumnMethodFor(this)
        is SqlStmtNameElement -> it.isSqlStmtConstantFor(this)
        else -> false
      }
    } ?: emptyArray()

/**
 * Rename the given element by using the [SqliteUsageInfo] provided. It performs three
 * separate rename batches: field usages, method usages and sqlite usages. This function should
 * be called from a single command, so that undo functions properly.
 */
internal fun SqliteElement.doRename(newElementName: String, usageInfo: SqliteUsageInfo,
    originatingFile: PsiFile, listener: RefactoringElementListener?) {
  when (this) {
    is ColumnNameElement -> {
      usageInfo.fieldUsages.forEach { RenameUtil.rename(it, SqliteCompiler.constantName(newElementName)) }
      usageInfo.methodUsages.forEach { RenameUtil.rename(it, methodName(newElementName)) }
      usageInfo.overridingMethods.forEach {
        RenameUtil.doRename(it, methodName(newElementName), emptyArray(), it.project, null)
      }
    }
    is SqlStmtNameElement -> {
      usageInfo.fieldUsages.forEach { RenameUtil.rename(it, SqliteCompiler.constantName(newElementName)) }
    }
  }
  doRename(this, newElementName, usageInfo.sqliteUsages, originatingFile.project, listener)
}

private fun notInsideFile(original: Array, file: PsiFile)
    = original.filter { it.file != file }

private fun PsiElement.isColumnMethodFor(element: SqliteElement) =
  this is PsiMethodImpl && name == methodName(element.name)

private fun PsiElement.isColumnConstantFor(element: SqliteElement) =
  this is PsiFieldImpl && name == SqliteCompiler.constantName(element.name)

private fun PsiElement.isSqlStmtConstantFor(element: SqliteElement) =
  this is PsiFieldImpl && name == SqliteCompiler.constantName(element.name)

data class SqliteUsageInfo(
    internal val fieldUsages: List,
    internal val methodUsages: List,
    internal val overridingMethods: List,
    internal val sqliteUsages: Array)