XCScheme.java

/*
 * Copyright 2013-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.xcode;

import java.util.ArrayList;
import java.util.EnumSet;
import java.util.List;
import java.util.Optional;

public class XCScheme {
  private String name;
  private Optional<BuildAction> buildAction;
  private Optional<TestAction> testAction;
  private Optional<LaunchAction> launchAction;
  private Optional<ProfileAction> profileAction;
  private Optional<AnalyzeAction> analyzeAction;
  private Optional<ArchiveAction> archiveAction;

  public XCScheme(
      String name,
      Optional<BuildAction> buildAction,
      Optional<TestAction> testAction,
      Optional<LaunchAction> launchAction,
      Optional<ProfileAction> profileAction,
      Optional<AnalyzeAction> analyzeAction,
      Optional<ArchiveAction> archiveAction) {
    this.name = name;
    this.buildAction = buildAction;
    this.testAction = testAction;
    this.launchAction = launchAction;
    this.profileAction = profileAction;
    this.analyzeAction = analyzeAction;
    this.archiveAction = archiveAction;
  }

  public String getName() {
    return name;
  }

  public Optional<BuildAction> getBuildAction() {
    return buildAction;
  }

  public Optional<TestAction> getTestAction() {
    return testAction;
  }

  public Optional<LaunchAction> getLaunchAction() {
    return launchAction;
  }

  public Optional<ProfileAction> getProfileAction() {
    return profileAction;
  }

  public Optional<AnalyzeAction> getAnalyzeAction() {
    return analyzeAction;
  }

  public Optional<ArchiveAction> getArchiveAction() {
    return archiveAction;
  }

  public static class BuildableReference {
    private String containerRelativePath;
    private String blueprintIdentifier;
    public final String buildableName;
    public final String blueprintName;

    public BuildableReference(
        String containerRelativePath,
        String blueprintIdentifier,
        String buildableName,
        String blueprintName) {
      this.containerRelativePath = containerRelativePath;
      this.blueprintIdentifier = blueprintIdentifier;
      this.buildableName = buildableName;
      this.blueprintName = blueprintName;
    }

    public String getContainerRelativePath() {
      return containerRelativePath;
    }

    public String getBlueprintIdentifier() {
      return blueprintIdentifier;
    }

    public String getBuildableName() {
      return buildableName;
    }

    public String getBlueprintName() {
      return blueprintName;
    }
  }

  public static class BuildAction {
    private List<BuildActionEntry> buildActionEntries;

    private final boolean parallelizeBuild;

    public BuildAction(boolean parallelizeBuild) {
      buildActionEntries = new ArrayList<>();
      this.parallelizeBuild = parallelizeBuild;
    }

    public void addBuildAction(BuildActionEntry entry) {
      this.buildActionEntries.add(entry);
    }

    public List<BuildActionEntry> getBuildActionEntries() {
      return buildActionEntries;
    }

    public boolean getParallelizeBuild() {
      return parallelizeBuild;
    }
  }

  public static class BuildActionEntry {
    public enum BuildFor {
      RUNNING,
      TESTING,
      PROFILING,
      ARCHIVING,
      ANALYZING;

      public static final EnumSet<BuildFor> DEFAULT = EnumSet.allOf(BuildFor.class);
      public static final EnumSet<BuildFor> INDEXING = EnumSet.of(TESTING, ANALYZING, ARCHIVING);
      public static final EnumSet<BuildFor> TEST_ONLY = EnumSet.of(TESTING, ANALYZING);
    }

    private BuildableReference buildableReference;

    private final EnumSet<BuildFor> buildFor;

    public BuildActionEntry(BuildableReference buildableReference, EnumSet<BuildFor> buildFor) {
      this.buildableReference = buildableReference;
      this.buildFor = buildFor;
    }

    public BuildableReference getBuildableReference() {
      return buildableReference;
    }

    public EnumSet<BuildFor> getBuildFor() {
      return buildFor;
    }
  }

  public static class LaunchAction {

    public enum LaunchStyle {
      /** Starts the process with attached debugger. */
      AUTO,
      /** Debugger waits for executable to be launched. */
      WAIT,
      ;
    }

    BuildableReference buildableReference;
    private final String buildConfiguration;
    private final Optional<String> runnablePath;
    private final Optional<String> remoteRunnablePath;
    private final LaunchStyle launchStyle;

    public LaunchAction(
        BuildableReference buildableReference,
        String buildConfiguration,
        Optional<String> runnablePath,
        Optional<String> remoteRunnablePath,
        LaunchStyle launchStyle) {
      this.buildableReference = buildableReference;
      this.buildConfiguration = buildConfiguration;
      this.runnablePath = runnablePath;
      this.remoteRunnablePath = remoteRunnablePath;
      this.launchStyle = launchStyle;
    }

    public BuildableReference getBuildableReference() {
      return buildableReference;
    }

    public String getBuildConfiguration() {
      return buildConfiguration;
    }

    public Optional<String> getRunnablePath() {
      return runnablePath;
    }

    public Optional<String> getRemoteRunnablePath() {
      return remoteRunnablePath;
    }

    public LaunchStyle getLaunchStyle() {
      return launchStyle;
    }
  }

  public static class ProfileAction {
    BuildableReference buildableReference;
    private final String buildConfiguration;

    public ProfileAction(BuildableReference buildableReference, String buildConfiguration) {
      this.buildableReference = buildableReference;
      this.buildConfiguration = buildConfiguration;
    }

    public BuildableReference getBuildableReference() {
      return buildableReference;
    }

    public String getBuildConfiguration() {
      return buildConfiguration;
    }
  }

  public static class TestAction {
    List<TestableReference> testables;
    private final String buildConfiguration;

    public TestAction(String buildConfiguration) {
      this.testables = new ArrayList<>();
      this.buildConfiguration = buildConfiguration;
    }

    public void addTestableReference(TestableReference testable) {
      this.testables.add(testable);
    }

    public List<TestableReference> getTestables() {
      return testables;
    }

    public String getBuildConfiguration() {
      return buildConfiguration;
    }
  }

  public static class TestableReference {
    private BuildableReference buildableReference;

    public TestableReference(BuildableReference buildableReference) {
      this.buildableReference = buildableReference;
    }

    public BuildableReference getBuildableReference() {
      return buildableReference;
    }
  }

  public static class AnalyzeAction {
    public final String buildConfiguration;

    public AnalyzeAction(String buildConfiguration) {
      this.buildConfiguration = buildConfiguration;
    }

    public String getBuildConfiguration() {
      return buildConfiguration;
    }
  }

  public static class ArchiveAction {
    public final String buildConfiguration;

    public ArchiveAction(String buildConfiguration) {
      this.buildConfiguration = buildConfiguration;
    }

    public String getBuildConfiguration() {
      return buildConfiguration;
    }
  }
}