base/src/com/google/idea/blaze/base/lang/buildfile/language/semantics/AttributeDefinition.java

/*
 * Copyright 2016 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.idea.blaze.base.lang.buildfile.language.semantics;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableList;
import com.google.repackaged.devtools.build.lib.query2.proto.proto2api.Build;
import java.io.Serializable;
import javax.annotation.Nullable;

/** Simple implementation of AttributeDefinition, from build.proto */
public class AttributeDefinition implements Serializable {

  public static AttributeDefinition fromProto(Build.AttributeDefinition attr) {
    return new AttributeDefinition(
        attr.getName(),
        attr.getType(),
        attr.getMandatory(),
        attr.hasDocumentation() ? attr.getDocumentation() : null,
        getAllowedRuleClasses(attr));
  }

  @Nullable
  private static ImmutableList<String> getAllowedRuleClasses(Build.AttributeDefinition attr) {
    if (!attr.hasAllowedRuleClasses()) {
      return null;
    }
    return ImmutableList.copyOf(attr.getAllowedRuleClasses().getAllowedRuleClassList());
  }

  public final String name;
  public final Build.Attribute.Discriminator type;
  public final boolean mandatory;
  public final String documentation;

  // the names of rules allowed in this attribute, or null if any rules are allowed.
  @Nullable private final ImmutableList<String> allowedRuleClasses;

  @VisibleForTesting
  public AttributeDefinition(
      String name,
      Build.Attribute.Discriminator type,
      boolean mandatory,
      String documentation,
      @Nullable ImmutableList<String> allowedRuleClasses) {

    this.name = name;
    this.type = type;
    this.mandatory = mandatory;
    this.documentation = documentation;
    this.allowedRuleClasses = allowedRuleClasses;
  }

  /**
   * Only relevant for attributes of type LABEL and LABEL_LIST. Some such attributes can only
   * contain certain rule types.
   */
  public boolean isRuleTypeAllowed(RuleDefinition rule) {
    return allowedRuleClasses == null || allowedRuleClasses.contains(rule.name);
  }
}