plugins {
    id 'kotlin'
}

dependencies {
    // 以下二つのライブラリのバージョンは、Android Gradle Pluginのメジャーバージョンに23を足した値を指定すること
    // e.g. AGP: 7.0.4 -> 30.0.4
    // https://github.com/googlesamples/android-custom-lint-rules#lint-version
    compileOnly "com.android.tools.lint:lint-api:30.0.4"
    compileOnly "com.android.tools.lint:lint-checks:30.0.4"
}

sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8

@Suppress("UnstableApiUsage")
internal class SampleDetector : Detector(), Detector.UastScanner {
    // TODO: Applicableを定義し、何を検査対象とするか、より具体的に絞り込む（デフォルトだと、何も対象としない）

    // TODO: 定義したApplicableに適合するイベントコールバックメソッドをoverrideし、検査ロジックを実装する
}

// 特定の型のコンストラクタを呼び出している箇所を対象に含める
override fun getApplicableConstructorTypes(): List<String> {
    return listOf(
        SAMPLE_CLASS,
    )
}

companion object {
    private const val SAMPLE_CLASS = "com.example.sampleapp.SampleClass"
}

override fun visitConstructor(context: JavaContext, node: UCallExpression, constructor: PsiMethod) {
    // Applicableで検査対象を絞っているので、ここが呼ばれる == SampleClassのコンストラクタが呼ばれたとみなす
    context.report(
        // Lintルールに関する情報をまとめたもの。後ほど実装する
        issue = ISSUE_SAMPLE,
        // どの範囲を警告として視覚化するか。大抵はUASTあるいはPSIのクラスに応じてよしなに解釈してくれる
        // LocationTypeを明示して、レシーバまで含めるとか、構文全てで表示する、とかもできる
        location = context.getLocation(node),
        // 以下で指定したメッセージが、Inspectionや、あるいはエディタで波線をマウスホバーした際のポップアップにて表示される
        message = "We shouldn't use SampleClass.",
    )
}

// 検査するUastTypeを列挙する
// ここで列挙したものを、それぞれ対応するUElementHandlerのイベントコールバックメソッドで検査する
override fun getApplicableUastTypes(): List<Class<out UElement>> {
    return listOf(
        UBinaryExpression::class.java, // 二項演算の構文を検査対象に含める
        UCallExpression::class.java, // メソッド・コンストラクタ・配列初期化呼び出しを検査対象に含める
        UField::class.java, // フィールドを検査対象に含める
        UParameter::class.java, // パラメータを検査対象に含める
    )
}

override fun createUastHandler(context: JavaContext): UElementHandler {
    return object : UElementHandler() {

        // 二項演算の構文を検査する
        override fun visitBinaryExpression(node: UBinaryExpression) {
            val leftOperandType = node.leftOperand.getExpressionType()?.canonicalText ?: return
            if (leftOperandType.contains(SAMPLE_CLASS).not()) return

            val operator = node.operator
            if (operator == UastBinaryOperator.EQUALS || operator == UastBinaryOperator.NOT_EQUALS) {
                context.report(
                    issue = ISSUE_SAMPLE,
                    location = context.getLocation(node),
                    message = "Since lacks of implementing equals of SampleClass, we may lead unexpected behavior if we check equality around SampleClass.",
                )
            }
        }

        // メソッド・コンストラクタ・配列初期化の呼び出しを検査する
        override fun visitCallExpression(node: UCallExpression) {
            val receiverType = node.receiverType?.canonicalText
            if (receiverType?.contains(SAMPLE_CLASS) == false) return
            if (node.methodName == "equals") {
                context.report(
                    issue = ISSUE_SAMPLE,
                    location = context.getCallLocation(
                        call = node,
                        includeReceiver = true,
                        includeArguments = false,
                    ),
                    message = "Since lacks of implementing equals of SampleClass, we may lead unexpected behavior if we check equality around SampleClass.",
                )
            }
        }

        // フィールドを検査する
        override fun visitField(node: UField) {
            if (node.type.canonicalText.contains(SAMPLE_CLASS)) {
                context.report(
                    issue = ISSUE_SAMPLE,
                    location = context.getLocation(node),
                    message = "We should use FixedSampleClass rather than SampleClass.",
                )
            }
        }

        // パラメータを検査する
        override fun visitParameter(node: UParameter) {
            if (node.type.canonicalText.contains(SAMPLE_CLASS)) {
                context.report(
                    issue = ISSUE_SAMPLE,
                    location = context.getLocation(node, type = LocationType.DEFAULT),
                    message = "We should use FixedSampleClass rather than SampleClass.",
                )
            }
        }
    }
}

@Suppress("UnstableApiUsage")
internal class SampleDetector : Detector(), Detector.UastScanner {
    // Applicable実装済み
    // イベントコールバックメソッドでの検査ロジック実装済み

    companion object {
        private const val SAMPLE_CLASS = "com.example.sampleapp.SampleClass"

        private val ISSUE_SAMPLE = Issue.create(
            id = "SampleClass",
            briefDescription = "Using SampleClass",
            explanation = "Since lacks of implementing equals of SampleClass, we may lead unexpected behavior if we check equality around SampleClass.",
            category = Category.CORRECTNESS,
            priority = 5,
            severity = Severity.WARNING,
            implementation = Implementation(SampleDetector::class.java, Scope.JAVA_FILE_SCOPE),
        )

        val issue = ISSUE_SAMPLE
    }
}

@Suppress("UnstableApiUsage")
internal class IssueRegistry : IssueRegistry() {
    override val api: Int
        get() = CURRENT_API

    override val issues: List<Issue>
        get() = listOf(
            SampleDetector.issue,
        )
}

plugins {
    id 'kotlin'
}

dependencies {
    // 以下二つのライブラリのバージョンは、Android Gradle Pluginのメジャーバージョンに23を足した値を指定すること
    // e.g. AGP: 7.0.4 -> 30.0.4
    // https://github.com/googlesamples/android-custom-lint-rules#lint-version
    compileOnly "com.android.tools.lint:lint-api:30.0.4"
    compileOnly "com.android.tools.lint:lint-checks:30.0.4"
}

sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8

// 本記事冒頭の作業により、ここから上は既に実装済みのはず。以下を追加する。

jar {
    manifest {
        // 先ほど実装したIssueRegistryの完全修飾名（Fully Qualified Name）を書く
        attributes 'Lint-Registry': 'com.example.sampleapp.lint.IssueRegistry'
    }
}

dependencies {
    // projectに渡すモジュール名は、本記事冒頭で作成したLintモジュールのモジュール名で実装する
    lintChecks project('lint')
}

android {
    lintOptions {
        textReport true
        htmlReport true
        xmlReport false
    }
}