| // Copyright 2014 The Bazel Authors. All rights reserved. |
| // |
| // 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.google.devtools.build.lib.skyframe; |
| |
| import com.google.common.base.Preconditions; |
| import com.google.common.collect.Interner; |
| import com.google.devtools.build.lib.cmdline.PackageIdentifier; |
| import com.google.devtools.build.lib.concurrent.BlazeInterners; |
| import com.google.devtools.build.lib.skyframe.serialization.autocodec.AutoCodec; |
| import com.google.devtools.build.lib.vfs.Root; |
| import com.google.devtools.build.skyframe.AbstractSkyKey; |
| import com.google.devtools.build.skyframe.SkyFunctionName; |
| import com.google.devtools.build.skyframe.SkyValue; |
| |
| /** |
| * A value that represents the result of looking for the existence of a package that owns a |
| * specific directory path. Compare with {@link PackageLookupValue}, which deals with existence of |
| * a specific package. |
| */ |
| public abstract class ContainingPackageLookupValue implements SkyValue { |
| |
| @AutoCodec public static final NoContainingPackage NONE = new NoContainingPackage(); |
| |
| /** Returns whether there is a containing package. */ |
| public abstract boolean hasContainingPackage(); |
| |
| /** If there is a containing package, returns its name. */ |
| public abstract PackageIdentifier getContainingPackageName(); |
| |
| /** If there is a containing package, returns its package root */ |
| public abstract Root getContainingPackageRoot(); |
| |
| public static Key key(PackageIdentifier id) { |
| Preconditions.checkArgument(!id.getPackageFragment().isAbsolute(), id); |
| Preconditions.checkArgument(!id.getRepository().isDefault(), id); |
| return Key.create(id); |
| } |
| |
| @AutoCodec.VisibleForSerialization |
| @AutoCodec |
| static class Key extends AbstractSkyKey<PackageIdentifier> { |
| private static final Interner<Key> interner = BlazeInterners.newWeakInterner(); |
| |
| private Key(PackageIdentifier arg) { |
| super(arg); |
| } |
| |
| @AutoCodec.VisibleForSerialization |
| @AutoCodec.Instantiator |
| static Key create(PackageIdentifier arg) { |
| return interner.intern(new Key(arg)); |
| } |
| |
| @Override |
| public SkyFunctionName functionName() { |
| return SkyFunctions.CONTAINING_PACKAGE_LOOKUP; |
| } |
| } |
| |
| public static ContainingPackage withContainingPackage(PackageIdentifier pkgId, Root root) { |
| return new ContainingPackage(pkgId, root); |
| } |
| |
| /** Value indicating there is no containing package. */ |
| public static class NoContainingPackage extends ContainingPackageLookupValue { |
| private NoContainingPackage() {} |
| |
| @Override |
| public boolean hasContainingPackage() { |
| return false; |
| } |
| |
| @Override |
| public PackageIdentifier getContainingPackageName() { |
| throw new IllegalStateException(); |
| } |
| |
| @Override |
| public Root getContainingPackageRoot() { |
| throw new IllegalStateException(); |
| } |
| } |
| |
| /** A successful lookup value. */ |
| @AutoCodec |
| public static class ContainingPackage extends ContainingPackageLookupValue { |
| private final PackageIdentifier containingPackage; |
| private final Root containingPackageRoot; |
| |
| @AutoCodec.Instantiator |
| @AutoCodec.VisibleForSerialization |
| ContainingPackage(PackageIdentifier containingPackage, Root containingPackageRoot) { |
| this.containingPackage = containingPackage; |
| this.containingPackageRoot = containingPackageRoot; |
| } |
| |
| @Override |
| public boolean hasContainingPackage() { |
| return true; |
| } |
| |
| @Override |
| public PackageIdentifier getContainingPackageName() { |
| return containingPackage; |
| } |
| |
| @Override |
| public Root getContainingPackageRoot() { |
| return containingPackageRoot; |
| } |
| |
| @Override |
| public boolean equals(Object obj) { |
| if (this == obj) { |
| return true; |
| } |
| if (!(obj instanceof ContainingPackage)) { |
| return false; |
| } |
| ContainingPackage other = (ContainingPackage) obj; |
| return containingPackage.equals(other.containingPackage) |
| && containingPackageRoot.equals(other.containingPackageRoot); |
| } |
| |
| @Override |
| public int hashCode() { |
| return containingPackage.hashCode(); |
| } |
| } |
| } |