AbstractApplePlatform.java

/*
 * Copyright 2014-present Facebook, 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.facebook.buck.apple;

import com.facebook.buck.rules.RuleKeyAppendable;
import com.facebook.buck.rules.RuleKeyObjectSink;
import com.facebook.buck.util.immutables.BuckStyleImmutable;
import com.google.common.collect.ImmutableList;
import java.util.Optional;
import org.immutables.value.Value;

@Value.Immutable
@BuckStyleImmutable
abstract class AbstractApplePlatform
    implements Comparable<AbstractApplePlatform>, RuleKeyAppendable {

  public static final ApplePlatform IPHONEOS =
      ApplePlatform.builder()
          .setName("iphoneos")
          .setSwiftName("ios")
          .setProvisioningProfileName("iOS")
          .setArchitectures(ImmutableList.of("armv7", "arm64"))
          .setMinVersionFlagPrefix("-mios-version-min=")
          // only used for legacy watch apps
          .setStubBinaryPath(Optional.of("Library/Application Support/WatchKit/WK"))
          .build();
  public static final ApplePlatform IPHONESIMULATOR =
      ApplePlatform.builder()
          .setName("iphonesimulator")
          .setSwiftName("ios")
          .setArchitectures(ImmutableList.of("i386", "x86_64"))
          .setMinVersionFlagPrefix("-mios-simulator-version-min=")
          // only used for legacy watch apps
          .setStubBinaryPath(Optional.of("Library/Application Support/WatchKit/WK"))
          .build();
  public static final ApplePlatform WATCHOS =
      ApplePlatform.builder()
          .setName("watchos")
          .setProvisioningProfileName("iOS") // watchOS uses iOS provisioning profiles.
          .setArchitectures(ImmutableList.of("armv7k"))
          .setMinVersionFlagPrefix("-mwatchos-version-min=")
          .setStubBinaryPath(Optional.of("Library/Application Support/WatchKit/WK"))
          .build();
  public static final ApplePlatform WATCHSIMULATOR =
      ApplePlatform.builder()
          .setName("watchsimulator")
          .setArchitectures(ImmutableList.of("i386"))
          .setMinVersionFlagPrefix("-mwatchos-simulator-version-min=")
          .setStubBinaryPath(Optional.of("Library/Application Support/WatchKit/WK"))
          .build();
  public static final ApplePlatform APPLETVOS =
      ApplePlatform.builder()
          .setName("appletvos")
          .setProvisioningProfileName("tvOS")
          .setArchitectures(ImmutableList.of("arm64"))
          .setMinVersionFlagPrefix("-mtvos-version-min=")
          .build();
  public static final ApplePlatform APPLETVSIMULATOR =
      ApplePlatform.builder()
          .setName("appletvsimulator")
          .setArchitectures(ImmutableList.of("x86_64"))
          .setMinVersionFlagPrefix("-mtvos-simulator-version-min=")
          .setSwiftName("tvos")
          .build();
  public static final ApplePlatform MACOSX =
      ApplePlatform.builder()
          .setName("macosx")
          .setArchitectures(ImmutableList.of("i386", "x86_64"))
          .setAppIncludesFrameworks(true)
          .build();

  /** The full name of the platform. For example: {@code macosx}. */
  public abstract String getName();

  /**
   * The Swift name for the platform. For example: {@code ios}. If absent, use {@link #getName()}
   * instead.
   */
  public abstract Optional<String> getSwiftName();

  /**
   * The platform name used to match provisioning profiles. For example: {@code iOS}.
   *
   * <p>Not all platforms use provisioning profiles; these will return absent.
   */
  public abstract Optional<String> getProvisioningProfileName();

  @SuppressWarnings("immutables")
  @Value.Default
  public ImmutableList<String> getArchitectures() {
    return ImmutableList.of("armv7", "arm64", "i386", "x86_64");
  }

  @Value.Default
  public String getMinVersionFlagPrefix() {
    return "-m" + getName() + "-version-min=";
  }

  public abstract Optional<String> getStubBinaryPath();

  @Value.Default
  public boolean getAppIncludesFrameworks() {
    return false;
  }

  public static boolean needsCodeSign(String name) {
    return name.startsWith(IPHONEOS.getName())
        || name.startsWith(IPHONESIMULATOR.getName())
        || name.startsWith(WATCHOS.getName())
        || name.startsWith(WATCHSIMULATOR.getName())
        || name.startsWith(APPLETVOS.getName())
        || name.startsWith(APPLETVSIMULATOR.getName())
        || name.startsWith(MACOSX.getName());
  }

  public static boolean adHocCodeSignIsSufficient(String name) {
    return name.startsWith(IPHONESIMULATOR.getName())
        || name.startsWith(WATCHSIMULATOR.getName())
        || name.startsWith(APPLETVSIMULATOR.getName())
        || name.startsWith(MACOSX.getName());
  }

  public static boolean needsInstallHelper(String name) {
    return name.startsWith(IPHONEOS.getName());
  }

  public static boolean isSimulator(String name) {
    return name.startsWith(IPHONESIMULATOR.getName())
        || name.startsWith(WATCHSIMULATOR.getName())
        || name.startsWith(APPLETVSIMULATOR.getName());
  }

  public static ApplePlatform of(String name) {
    for (ApplePlatform platform :
        ImmutableList.of(
            IPHONEOS,
            IPHONESIMULATOR,
            WATCHOS,
            WATCHSIMULATOR,
            APPLETVOS,
            APPLETVSIMULATOR,
            MACOSX)) {
      if (name.equals(platform.getName())) {
        return platform;
      }
    }
    return ApplePlatform.builder().setName(name).build();
  }

  @Override
  public int compareTo(AbstractApplePlatform other) {
    if (this == other) {
      return 0;
    }

    return getName().compareTo(other.getName());
  }

  @Override
  public void appendToRuleKey(RuleKeyObjectSink sink) {
    sink.setReflectively("platform-name", getName());
  }
}