src/com/facebook/buck/apple/xcode/xcodeproj/PBXGroup.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.xcodeproj;

import com.facebook.buck.apple.xcode.XcodeprojSerializer;
import com.google.common.cache.CacheBuilder;
import com.google.common.cache.CacheLoader;
import com.google.common.cache.LoadingCache;
import com.google.common.collect.Lists;

import java.util.Collections;
import java.util.Comparator;
import java.util.List;

import javax.annotation.Nullable;

/**
 * A collection of files in Xcode's virtual filesystem hierarchy.
 */
public class PBXGroup extends PBXReference {
  /**
   * Method by which group contents will be sorted.
   */
  public enum SortPolicy {
      /**
       * By name, in default Java sort order.
       */
      BY_NAME,

      /**
       * Group contents will not be sorted, and will remain in the
       * order they were added.
       */
      UNSORTED;
  }

  // Unfortunately, we can't determine this at constructor time, because CacheBuilder
  // calls our constructor and it's not easy to pass arguments to it.
  private SortPolicy sortPolicy;

  private final List<PBXReference> children;

  private final LoadingCache<String, PBXGroup> childGroupsByName;
  private final LoadingCache<String, PBXVariantGroup> childVariantGroupsByName;
  private final LoadingCache<SourceTreePath, PBXFileReference> fileReferencesBySourceTreePath;
  private final LoadingCache<SourceTreePath, XCVersionGroup> childVersionGroupsBySourceTreePath;

  public PBXGroup(String name, @Nullable String path, SourceTree sourceTree) {
    super(name, path, sourceTree);

    sortPolicy = SortPolicy.BY_NAME;
    children = Lists.newArrayList();

    childGroupsByName = CacheBuilder.newBuilder().build(
        new CacheLoader<String, PBXGroup>() {
          @Override
          public PBXGroup load(String key) throws Exception {
            PBXGroup group = new PBXGroup(key, null, SourceTree.GROUP);
            children.add(group);
            return group;
          }
        });

    childVariantGroupsByName = CacheBuilder.newBuilder().build(
        new CacheLoader<String, PBXVariantGroup>() {
          @Override
          public PBXVariantGroup load(String key) throws Exception {
            PBXVariantGroup group = new PBXVariantGroup(key, null, SourceTree.GROUP);
            children.add(group);
            return group;
          }
        });

    fileReferencesBySourceTreePath = CacheBuilder.newBuilder().build(
        new CacheLoader<SourceTreePath, PBXFileReference>() {
          @Override
          public PBXFileReference load(SourceTreePath key) throws Exception {
            PBXFileReference ref = new PBXFileReference(
                key.getPath().getFileName().toString(),
                key.getPath().toString(),
                key.getSourceTree());
            children.add(ref);
            return ref;
          }
        });

    childVersionGroupsBySourceTreePath = CacheBuilder.newBuilder().build(
        new CacheLoader<SourceTreePath, XCVersionGroup>() {
          @Override
          public XCVersionGroup load(SourceTreePath key) throws Exception {
            XCVersionGroup ref = new XCVersionGroup(
                key.getPath().getFileName().toString(),
                key.getPath().toString(),
                key.getSourceTree());
            children.add(ref);
            return ref;
          }
        });
  }

  public PBXGroup getOrCreateChildGroupByName(String name) {
    return childGroupsByName.getUnchecked(name);
  }

  public PBXVariantGroup getOrCreateChildVariantGroupByName(String name) {
    return childVariantGroupsByName.getUnchecked(name);
  }

  public PBXFileReference getOrCreateFileReferenceBySourceTreePath(SourceTreePath sourceTreePath) {
    return fileReferencesBySourceTreePath.getUnchecked(sourceTreePath);
  }

  public XCVersionGroup getOrCreateChildVersionGroupsBySourceTreePath(
      SourceTreePath sourceTreePath) {
    return childVersionGroupsBySourceTreePath.getUnchecked(sourceTreePath);
  }

  public List<PBXReference> getChildren() {
    return children;
  }

  public void setSortPolicy(SortPolicy sortPolicy) {
    this.sortPolicy = sortPolicy;
  }

  public SortPolicy getSortPolicy() {
    return sortPolicy;
  }

  @Override
  public String isa() {
    return "PBXGroup";
  }

  @Override
  public void serializeInto(XcodeprojSerializer s) {
    super.serializeInto(s);

    if (sortPolicy == SortPolicy.BY_NAME) {
      Collections.sort(children, new Comparator<PBXReference>() {
          @Override
          public int compare(PBXReference o1, PBXReference o2) {
            return o1.getName().compareTo(o2.getName());
          }
        });
    }

    s.addField("children", children);
  }
}