src/main/java/com/android/tools/r8/graph/AccessControl.java

// Copyright (c) 2019, the R8 project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
package com.android.tools.r8.graph;

import com.android.tools.r8.features.FeatureSplitConfiguration;
import com.android.tools.r8.utils.OptionalBool;

/**
 * Definitions of access control routines.
 *
 * <p>Follows SE 11, jvm spec, section 5.4.4 on "Access Control", except for aspects related to
 * "run-time module", for which all items are assumed to be in the same single such module.
 */
public class AccessControl {

  public static OptionalBool isClassAccessible(
      DexClass clazz, ProgramMethod context, AppView<?> appView) {
    return isClassAccessible(
        clazz, context.getHolder(), appView.options().featureSplitConfiguration);
  }

  public static OptionalBool isClassAccessible(
      DexClass clazz,
      DexProgramClass context,
      FeatureSplitConfiguration featureSplitConfiguration) {
    if (!clazz.isPublic() && !clazz.getType().isSamePackage(context.getType())) {
      return OptionalBool.FALSE;
    }
    if (featureSplitConfiguration != null
        && clazz.isProgramClass()
        && !featureSplitConfiguration.inBaseOrSameFeatureAs(clazz.asProgramClass(), context)) {
      return OptionalBool.UNKNOWN;
    }
    return OptionalBool.TRUE;
  }

  public static OptionalBool isMethodAccessible(
      DexEncodedMethod method,
      DexClass resolvedHolder,
      DexClass initialResolutionHolder,
      ProgramMethod context,
      AppView<? extends AppInfoWithClassHierarchy> appView) {
    return isMethodAccessible(
        method, resolvedHolder, initialResolutionHolder, context.getHolder(), appView.appInfo());
  }

  public static OptionalBool isMethodAccessible(
      DexEncodedMethod method,
      DexClass resolvedHolder,
      DexClass initialResolutionHolder,
      DexProgramClass context,
      AppInfoWithClassHierarchy appInfo) {
    return isMemberAccessible(
        method.accessFlags, resolvedHolder, initialResolutionHolder, context, appInfo);
  }

  public static OptionalBool isFieldAccessible(
      DexEncodedField field,
      DexClass resolvedHolder,
      DexClass initialResolutionHolder,
      ProgramMethod context,
      AppView<? extends AppInfoWithClassHierarchy> appView) {
    return isFieldAccessible(
        field, resolvedHolder, initialResolutionHolder, context.getHolder(), appView.appInfo());
  }

  public static OptionalBool isFieldAccessible(
      DexEncodedField field,
      DexClass resolvedHolder,
      DexClass initialResolutionHolder,
      DexProgramClass context,
      AppInfoWithClassHierarchy appInfo) {
    return isMemberAccessible(
        field.accessFlags, resolvedHolder, initialResolutionHolder, context, appInfo);
  }

  private static OptionalBool isMemberAccessible(
      AccessFlags<?> memberFlags,
      DexClass resolvedHolder,
      DexClass initialResolutionHolder,
      DexProgramClass context,
      AppInfoWithClassHierarchy appInfo) {
    OptionalBool classAccessibility =
        isClassAccessible(
            initialResolutionHolder, context, appInfo.options().featureSplitConfiguration);
    if (classAccessibility.isFalse()) {
      return OptionalBool.FALSE;
    }
    if (memberFlags.isPublic()) {
      return classAccessibility;
    }
    if (memberFlags.isPrivate()) {
      if (!isNestMate(resolvedHolder, context)) {
        return OptionalBool.FALSE;
      }
      return classAccessibility;
    }
    if (resolvedHolder.getType().isSamePackage(context.getType())) {
      return classAccessibility;
    }
    if (memberFlags.isProtected()
        && appInfo.isSubtype(context.getType(), resolvedHolder.getType())) {
      return classAccessibility;
    }
    return OptionalBool.FALSE;
  }

  private static boolean isNestMate(DexClass clazz, DexProgramClass context) {
    if (clazz == context) {
      return true;
    }
    if (!clazz.isInANest() || !context.isInANest()) {
      return false;
    }
    return clazz.getNestHost() == context.getNestHost();
  }
}