Introduce BinaryVersion.isCompatible()

To decrease the chance to mix up the receiver and the first argument when
checking version compatibility
This commit is contained in:
Alexander Udalov
2015-12-28 16:39:17 +03:00
parent 04d335db15
commit 9552accaec
17 changed files with 31 additions and 56 deletions
@@ -20,7 +20,6 @@ import com.google.common.base.Predicate;
import com.google.common.collect.Collections2; import com.google.common.collect.Collections2;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import org.jetbrains.kotlin.backend.common.output.OutputFile; import org.jetbrains.kotlin.backend.common.output.OutputFile;
import org.jetbrains.kotlin.load.java.AbiVersionUtil;
import org.jetbrains.kotlin.load.java.JvmAbi; import org.jetbrains.kotlin.load.java.JvmAbi;
import org.jetbrains.kotlin.load.java.JvmBytecodeBinaryVersion; import org.jetbrains.kotlin.load.java.JvmBytecodeBinaryVersion;
import org.jetbrains.kotlin.name.FqName; import org.jetbrains.kotlin.name.FqName;
@@ -147,6 +146,6 @@ public class KotlinSyntheticClassAnnotationTest extends CodegenTestCase {
int[] version = (int[]) CodegenTestUtil.getAnnotationAttribute(annotation, VERSION_FIELD_NAME); int[] version = (int[]) CodegenTestUtil.getAnnotationAttribute(annotation, VERSION_FIELD_NAME);
assertNotNull(version); assertNotNull(version);
assertTrue("Annotation " + annotationFqName + " is written with an unsupported format", assertTrue("Annotation " + annotationFqName + " is written with an unsupported format",
AbiVersionUtil.isAbiVersionCompatible(JvmBytecodeBinaryVersion.create(version))); JvmBytecodeBinaryVersion.create(version).isCompatible());
} }
} }
@@ -29,6 +29,8 @@ class KotlinJavascriptMetadata(val abiVersion: Int, val moduleName: String, val
class JsBinaryVersion protected constructor( class JsBinaryVersion protected constructor(
major: Int, minor: Int, patch: Int, rest: List<Int> major: Int, minor: Int, patch: Int, rest: List<Int>
) : BinaryVersion(major, minor, patch, rest) { ) : BinaryVersion(major, minor, patch, rest) {
override fun isCompatible() = this.isCompatibleTo(INSTANCE)
companion object { companion object {
@JvmField val INSTANCE = create(0, 3, 0) @JvmField val INSTANCE = create(0, 3, 0)
@@ -1,29 +0,0 @@
/*
* Copyright 2010-2015 JetBrains s.r.o.
*
* 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 org.jetbrains.kotlin.load.java;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.kotlin.serialization.deserialization.BinaryVersion;
public final class AbiVersionUtil {
public static boolean isAbiVersionCompatible(@NotNull BinaryVersion actual) {
return actual.isCompatibleTo(JvmBytecodeBinaryVersion.INSTANCE);
}
private AbiVersionUtil() {
}
}
@@ -21,6 +21,8 @@ import org.jetbrains.kotlin.serialization.deserialization.BinaryVersion
class JvmBytecodeBinaryVersion protected constructor( class JvmBytecodeBinaryVersion protected constructor(
major: Int, minor: Int, patch: Int, rest: List<Int> major: Int, minor: Int, patch: Int, rest: List<Int>
) : BinaryVersion(major, minor, patch, rest) { ) : BinaryVersion(major, minor, patch, rest) {
override fun isCompatible() = this.isCompatibleTo(INSTANCE)
companion object { companion object {
@JvmField @JvmField
val INSTANCE = create(1, 0, 2) val INSTANCE = create(1, 0, 2)
@@ -70,7 +70,7 @@ fun LazyJavaResolverContext.resolveKotlinBinaryClass(kotlinClass: KotlinJvmBinar
val header = kotlinClass.classHeader val header = kotlinClass.classHeader
return when { return when {
!header.isCompatibleAbiVersion -> { !header.version.isCompatible() -> {
components.errorReporter.reportIncompatibleAbiVersion(kotlinClass.classId, kotlinClass.location, header.version) components.errorReporter.reportIncompatibleAbiVersion(kotlinClass.classId, kotlinClass.location, header.version)
KotlinClassLookupResult.NotFound KotlinClassLookupResult.NotFound
} }
@@ -115,7 +115,7 @@ public final class DeserializedDescriptorResolver {
@Nullable @Nullable
public String[] readData(@NotNull KotlinJvmBinaryClass kotlinClass, @NotNull Set<KotlinClassHeader.Kind> expectedKinds) { public String[] readData(@NotNull KotlinJvmBinaryClass kotlinClass, @NotNull Set<KotlinClassHeader.Kind> expectedKinds) {
KotlinClassHeader header = kotlinClass.getClassHeader(); KotlinClassHeader header = kotlinClass.getClassHeader();
if (!header.isCompatibleAbiVersion()) { if (!header.getVersion().isCompatible()) {
errorReporter.reportIncompatibleAbiVersion(kotlinClass.getClassId(), kotlinClass.getLocation(), header.getVersion()); errorReporter.reportIncompatibleAbiVersion(kotlinClass.getClassId(), kotlinClass.getLocation(), header.getVersion());
} }
else if (expectedKinds.contains(header.getKind())) { else if (expectedKinds.contains(header.getKind())) {
@@ -16,7 +16,6 @@
package org.jetbrains.kotlin.load.kotlin package org.jetbrains.kotlin.load.kotlin
import org.jetbrains.kotlin.load.java.AbiVersionUtil
import org.jetbrains.kotlin.load.java.JvmBytecodeBinaryVersion import org.jetbrains.kotlin.load.java.JvmBytecodeBinaryVersion
import org.jetbrains.kotlin.serialization.jvm.JvmPackageTable import org.jetbrains.kotlin.serialization.jvm.JvmPackageTable
import java.io.ByteArrayInputStream import java.io.ByteArrayInputStream
@@ -43,7 +42,7 @@ class ModuleMapping private constructor(val packageFqName2Parts: Map<String, Pac
val version = JvmBytecodeBinaryVersion.create((0..size - 1).map { inputStream.readInt() }.toIntArray()) val version = JvmBytecodeBinaryVersion.create((0..size - 1).map { inputStream.readInt() }.toIntArray())
if (AbiVersionUtil.isAbiVersionCompatible(version)) { if (version.isCompatible()) {
val parseFrom = JvmPackageTable.PackageTable.parseFrom(inputStream) val parseFrom = JvmPackageTable.PackageTable.parseFrom(inputStream)
if (parseFrom != null) { if (parseFrom != null) {
val packageFqNameParts = hashMapOf<String, PackageParts>() val packageFqNameParts = hashMapOf<String, PackageParts>()
@@ -16,7 +16,6 @@
package org.jetbrains.kotlin.load.kotlin.header package org.jetbrains.kotlin.load.kotlin.header
import org.jetbrains.kotlin.load.java.AbiVersionUtil
import org.jetbrains.kotlin.serialization.deserialization.BinaryVersion import org.jetbrains.kotlin.serialization.deserialization.BinaryVersion
class KotlinClassHeader( class KotlinClassHeader(
@@ -30,8 +29,6 @@ class KotlinClassHeader(
val isInterfaceDefaultImpls: Boolean, val isInterfaceDefaultImpls: Boolean,
val isLocalClass: Boolean val isLocalClass: Boolean
) { ) {
val isCompatibleAbiVersion: Boolean get() = AbiVersionUtil.isAbiVersionCompatible(version)
enum class Kind { enum class Kind {
CLASS, CLASS,
FILE_FACADE, FILE_FACADE,
@@ -47,7 +44,7 @@ class KotlinClassHeader(
"version=$version" "version=$version"
} }
fun KotlinClassHeader.isCompatibleClassKind(): Boolean = isCompatibleAbiVersion && kind == KotlinClassHeader.Kind.CLASS fun KotlinClassHeader.isCompatibleClassKind(): Boolean = version.isCompatible() && kind == KotlinClassHeader.Kind.CLASS
fun KotlinClassHeader.isCompatibleFileFacadeKind(): Boolean = isCompatibleAbiVersion && kind == KotlinClassHeader.Kind.FILE_FACADE fun KotlinClassHeader.isCompatibleFileFacadeKind(): Boolean = version.isCompatible() && kind == KotlinClassHeader.Kind.FILE_FACADE
fun KotlinClassHeader.isCompatibleMultifileClassKind(): Boolean = isCompatibleAbiVersion && kind == KotlinClassHeader.Kind.MULTIFILE_CLASS fun KotlinClassHeader.isCompatibleMultifileClassKind(): Boolean = version.isCompatible() && kind == KotlinClassHeader.Kind.MULTIFILE_CLASS
fun KotlinClassHeader.isCompatibleMultifileClassPartKind(): Boolean = isCompatibleAbiVersion && kind == KotlinClassHeader.Kind.MULTIFILE_CLASS_PART fun KotlinClassHeader.isCompatibleMultifileClassPartKind(): Boolean = version.isCompatible() && kind == KotlinClassHeader.Kind.MULTIFILE_CLASS_PART
@@ -19,7 +19,6 @@ package org.jetbrains.kotlin.load.kotlin.header;
import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable; import org.jetbrains.annotations.Nullable;
import org.jetbrains.kotlin.descriptors.SourceElement; import org.jetbrains.kotlin.descriptors.SourceElement;
import org.jetbrains.kotlin.load.java.AbiVersionUtil;
import org.jetbrains.kotlin.load.java.JvmBytecodeBinaryVersion; import org.jetbrains.kotlin.load.java.JvmBytecodeBinaryVersion;
import org.jetbrains.kotlin.name.ClassId; import org.jetbrains.kotlin.name.ClassId;
import org.jetbrains.kotlin.name.FqName; import org.jetbrains.kotlin.name.FqName;
@@ -62,7 +61,7 @@ public class ReadKotlinClassHeaderAnnotationVisitor implements AnnotationVisitor
return null; return null;
} }
if (!AbiVersionUtil.isAbiVersionCompatible(version)) { if (!version.isCompatible()) {
annotationData = null; annotationData = null;
} }
else if (shouldHaveData() && annotationData == null) { else if (shouldHaveData() && annotationData == null) {
@@ -25,6 +25,8 @@ import org.jetbrains.kotlin.serialization.deserialization.BinaryVersion
class BuiltInsBinaryVersion protected constructor( class BuiltInsBinaryVersion protected constructor(
major: Int, minor: Int, patch: Int, rest: List<Int> major: Int, minor: Int, patch: Int, rest: List<Int>
) : BinaryVersion(major, minor, patch, rest) { ) : BinaryVersion(major, minor, patch, rest) {
override fun isCompatible() = this.isCompatibleTo(INSTANCE)
companion object { companion object {
@JvmField @JvmField
val INSTANCE = create(1, 0, 0) val INSTANCE = create(1, 0, 0)
@@ -38,7 +38,7 @@ class BuiltinsPackageFragment(
val dataInput = DataInputStream(stream) val dataInput = DataInputStream(stream)
val version = BuiltInsBinaryVersion.create((1..dataInput.readInt()).map { dataInput.readInt() }.toIntArray()) val version = BuiltInsBinaryVersion.create((1..dataInput.readInt()).map { dataInput.readInt() }.toIntArray())
if (!version.isCompatibleTo(BuiltInsBinaryVersion.INSTANCE)) { if (!version.isCompatible()) {
// TODO: report a proper diagnostic // TODO: report a proper diagnostic
throw UnsupportedOperationException( throw UnsupportedOperationException(
"Kotlin built-in definition format version is not supported: " + "Kotlin built-in definition format version is not supported: " +
@@ -31,6 +31,8 @@ abstract class BinaryVersion protected constructor(
val patch: Int, val patch: Int,
val rest: List<Int> val rest: List<Int>
) { ) {
abstract fun isCompatible(): Boolean
fun toArray(): IntArray = fun toArray(): IntArray =
intArrayOf(major, minor, patch, *rest.toIntArray()) intArrayOf(major, minor, patch, *rest.toIntArray())
@@ -40,7 +42,7 @@ abstract class BinaryVersion protected constructor(
* *
* @param ourVersion the version of this format in the current compiler * @param ourVersion the version of this format in the current compiler
*/ */
fun isCompatibleTo(ourVersion: BinaryVersion): Boolean { protected fun isCompatibleTo(ourVersion: BinaryVersion): Boolean {
return if (major == 0) ourVersion.major == 0 && minor == ourVersion.minor return if (major == 0) ourVersion.major == 0 && minor == ourVersion.minor
else major == ourVersion.major && minor <= ourVersion.minor else major == ourVersion.major && minor <= ourVersion.minor
} }
@@ -53,8 +53,8 @@ fun isKotlinJvmCompiledFile(file: VirtualFile): Boolean {
fun isKotlinWithCompatibleAbiVersion(file: VirtualFile): Boolean { fun isKotlinWithCompatibleAbiVersion(file: VirtualFile): Boolean {
if (!isKotlinJvmCompiledFile(file)) return false if (!isKotlinJvmCompiledFile(file)) return false
val header = IDEKotlinBinaryClassCache.getKotlinBinaryClassHeaderData(file)?.classHeader val kotlinClass = IDEKotlinBinaryClassCache.getKotlinBinaryClassHeaderData(file)
return header != null && header.isCompatibleAbiVersion return kotlinClass != null && kotlinClass.classHeader.version.isCompatible()
} }
/** /**
@@ -86,7 +86,7 @@ fun buildDecompiledTextForClassFile(
val packageFqName = classId.packageFqName val packageFqName = classId.packageFqName
return when { return when {
!classHeader.isCompatibleAbiVersion -> { !classHeader.version.isCompatible() -> {
DecompiledText( DecompiledText(
INCOMPATIBLE_ABI_VERSION_COMMENT INCOMPATIBLE_ABI_VERSION_COMMENT
.replace(CURRENT_ABI_VERSION_MARKER, JvmBytecodeBinaryVersion.INSTANCE.toString()) .replace(CURRENT_ABI_VERSION_MARKER, JvmBytecodeBinaryVersion.INSTANCE.toString())
@@ -103,6 +103,6 @@ fun buildDecompiledTextForClassFile(
buildDecompiledText(packageFqName, partMembers, decompilerRendererForClassFiles) buildDecompiledText(packageFqName, partMembers, decompilerRendererForClassFiles)
} }
else -> else ->
throw UnsupportedOperationException("Unknown header kind: ${classHeader.kind} ${classHeader.isCompatibleAbiVersion}") throw UnsupportedOperationException("Unknown header kind: ${classHeader.kind} ${classHeader.version.isCompatible()}")
} }
} }
@@ -62,7 +62,7 @@ open class KotlinClsStubBuilder : ClsStubBuilder() {
val header = kotlinClassHeaderInfo.classHeader val header = kotlinClassHeaderInfo.classHeader
val classId = kotlinClassHeaderInfo.classId val classId = kotlinClassHeaderInfo.classId
val packageFqName = classId.packageFqName val packageFqName = classId.packageFqName
if (!header.isCompatibleAbiVersion) { if (!header.version.isCompatible()) {
return createIncompatibleAbiVersionFileStub() return createIncompatibleAbiVersionFileStub()
} }
@@ -78,8 +78,8 @@ object KotlinClassFileIndex : KotlinFileIndexBase<KotlinClassFileIndex>(KotlinCl
private val VERSION = 2 private val VERSION = 2
private val INDEXER = indexer() { fileContent -> private val INDEXER = indexer() { fileContent ->
val kotlinClassHeaderInfo = IDEKotlinBinaryClassCache.getKotlinBinaryClassHeaderData(fileContent.file, fileContent.content) val headerInfo = IDEKotlinBinaryClassCache.getKotlinBinaryClassHeaderData(fileContent.file, fileContent.content)
if (kotlinClassHeaderInfo != null && kotlinClassHeaderInfo.classHeader.isCompatibleAbiVersion) kotlinClassHeaderInfo.classId.asSingleFqName() else null if (headerInfo != null && headerInfo.classHeader.version.isCompatible()) headerInfo.classId.asSingleFqName() else null
} }
} }
@@ -21,7 +21,10 @@ import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.module.Module; import com.intellij.openapi.module.Module;
import com.intellij.openapi.module.ModuleManager; import com.intellij.openapi.module.ModuleManager;
import com.intellij.openapi.project.Project; import com.intellij.openapi.project.Project;
import com.intellij.openapi.roots.*; import com.intellij.openapi.roots.LibraryOrderEntry;
import com.intellij.openapi.roots.ModuleRootManager;
import com.intellij.openapi.roots.OrderEntry;
import com.intellij.openapi.roots.ProjectFileIndex;
import com.intellij.openapi.roots.libraries.Library; import com.intellij.openapi.roots.libraries.Library;
import com.intellij.openapi.util.io.FileUtil; import com.intellij.openapi.util.io.FileUtil;
import com.intellij.openapi.util.text.StringUtil; import com.intellij.openapi.util.text.StringUtil;
@@ -46,7 +49,6 @@ import org.jetbrains.kotlin.idea.framework.JSLibraryStdPresentationProvider;
import org.jetbrains.kotlin.idea.framework.JavaRuntimePresentationProvider; import org.jetbrains.kotlin.idea.framework.JavaRuntimePresentationProvider;
import org.jetbrains.kotlin.idea.framework.LibraryPresentationProviderUtil; import org.jetbrains.kotlin.idea.framework.LibraryPresentationProviderUtil;
import org.jetbrains.kotlin.idea.project.ProjectStructureUtil; import org.jetbrains.kotlin.idea.project.ProjectStructureUtil;
import org.jetbrains.kotlin.load.java.AbiVersionUtil;
import org.jetbrains.kotlin.serialization.deserialization.BinaryVersion; import org.jetbrains.kotlin.serialization.deserialization.BinaryVersion;
import org.jetbrains.kotlin.utils.KotlinJavascriptMetadataUtils; import org.jetbrains.kotlin.utils.KotlinJavascriptMetadataUtils;
import org.jetbrains.kotlin.utils.KotlinPaths; import org.jetbrains.kotlin.utils.KotlinPaths;
@@ -77,7 +79,7 @@ public class KotlinRuntimeLibraryUtil {
new Function1<BinaryVersion, Boolean>() { new Function1<BinaryVersion, Boolean>() {
@Override @Override
public Boolean invoke(@NotNull BinaryVersion version) { public Boolean invoke(@NotNull BinaryVersion version) {
return !AbiVersionUtil.isAbiVersionCompatible(version); return !version.isCompatible();
} }
}); });
} }