com.facebook.buck.parser.AbstractBuildRuleFactory.java Source code

Introduction

Here is the source code for com.facebook.buck.parser.AbstractBuildRuleFactory.java

Source

/*
 * Copyright 2012-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.parser;

import com.facebook.buck.model.BuildTarget;
import com.facebook.buck.model.BuildTargetPattern;
import com.facebook.buck.rules.AbstractBuildRuleBuilder;
import com.facebook.buck.rules.AbstractBuildRuleBuilderParams;
import com.facebook.buck.rules.ResourcesAttributeBuilder;
import com.facebook.buck.rules.SourcePath;
import com.facebook.buck.rules.SrcsAttributeBuilder;
import com.facebook.buck.util.HumanReadableException;
import com.google.common.annotations.Beta;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Function;
import com.google.common.collect.ImmutableSet;

@Beta
public abstract class AbstractBuildRuleFactory<T extends AbstractBuildRuleBuilder<?>>
        implements BuildRuleFactory<T> {

    protected abstract T newBuilder(AbstractBuildRuleBuilderParams params);

    /**
     * Subclasses should override this method to extract any information from the Python object that
     * is not extracted by default.
     */
    protected abstract void amendBuilder(T builder, BuildRuleFactoryParams params)
            throws NoSuchBuildTargetException;

    @Override
    public T newInstance(BuildRuleFactoryParams params) throws NoSuchBuildTargetException {
        T builder = newBuilder(params.getAbstractBuildRuleFactoryParams());
        BuildTarget target = params.target;

        // name
        builder.setBuildTarget(target);

        // deps
        for (String dep : params.getOptionalListAttribute("deps")) {
            BuildTarget buildTarget = params.resolveBuildTarget(dep);
            builder.addDep(buildTarget);
        }

        // visibility
        for (BuildTargetPattern visiBuildTargetPattern : getVisibilityPatterns(params)) {
            builder.addVisibilityPattern(visiBuildTargetPattern);
        }

        // srcs
        if (builder instanceof SrcsAttributeBuilder) {
            for (String src : params.getOptionalListAttribute("srcs")) {
                String relativePath = params.resolveFilePathRelativeToBuildFileDirectory(src);
                ((SrcsAttributeBuilder) builder).addSrc(relativePath);
            }
        }

        // resources
        if (builder instanceof ResourcesAttributeBuilder) {
            ResourcesAttributeBuilder attributeBuilder = (ResourcesAttributeBuilder) builder;

            for (String resource : params.getOptionalListAttribute("resources")) {
                // Note that if resource is a build target, then this will add the resource as a dependency.
                // On the down side, this means that the file will appear on the classpath, but there's no
                // elegant way (yet) to avoid this.
                // TODO(simons): A smarter, more elegant way of adding additional deps not on the classpath.
                SourcePath path = params.asSourcePath(resource, builder);
                attributeBuilder.addResource(path);
            }
        }

        amendBuilder(builder, params);

        return builder;
    }

    @VisibleForTesting
    static ImmutableSet<BuildTargetPattern> getVisibilityPatterns(BuildRuleFactoryParams params)
            throws NoSuchBuildTargetException {
        ImmutableSet.Builder<BuildTargetPattern> builder = ImmutableSet.builder();
        for (String visibilityPattern : params.getOptionalListAttribute("visibility")) {
            builder.add(
                    params.buildTargetPatternParser.parse(visibilityPattern, ParseContext.forVisibilityArgument()));
        }
        return builder.build();
    }

    /**
     * @return a function that takes a dep from this build file and returns the fully-qualified
     *     version. The function will throw a {@link HumanReadableException} whose cause will be a
     *     {@link NoSuchBuildTargetException} if the function is passed a build target that it cannot
     *     parse or resolve.
     */
    protected Function<String, BuildTarget> createBuildTargetParseFunction(final BuildRuleFactoryParams params) {
        return new Function<String, BuildTarget>() {
            @Override
            public BuildTarget apply(String buildTargetName) {
                try {
                    return params.resolveBuildTarget(buildTargetName);
                } catch (NoSuchBuildTargetException e) {
                    throw new HumanReadableException(e);
                }
            }
        };
    }
}