com.facebook.buck.rules.macros.QueryTargetsMacroExpander.java Source code

Introduction

Here is the source code for com.facebook.buck.rules.macros.QueryTargetsMacroExpander.java

Source

/*
 * Copyright 2016-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.rules.macros;

import com.facebook.buck.model.BuildTarget;
import com.facebook.buck.model.MacroException;
import com.facebook.buck.query.QueryBuildTarget;
import com.facebook.buck.query.QueryTarget;
import com.facebook.buck.rules.BuildRule;
import com.facebook.buck.rules.BuildRuleResolver;
import com.facebook.buck.rules.CellPathResolver;
import com.facebook.buck.rules.TargetGraph;
import com.facebook.buck.util.MoreCollectors;
import com.google.common.base.CharMatcher;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Ordering;

import java.util.Optional;
import java.util.stream.Collectors;

/**
 * Used to expand the macro {@literal $(query_targets "some(query(:expression))")} to the
 * set of targets matching the query.
 * Example queries
 * <pre>
 *   '$(query_targets "deps(:foo)")'
 *   '$(query_targets "filter(bar, classpath(:bar))")'
 *   '$(query_targets "attrfilter(annotation_processors, com.foo.Processor, deps(:app))")'
 * </pre>
 */
public class QueryTargetsMacroExpander extends QueryMacroExpander {

    public QueryTargetsMacroExpander(Optional<TargetGraph> targetGraph) {
        super(targetGraph);
    }

    @Override
    public String expand(BuildTarget target, CellPathResolver cellNames, BuildRuleResolver resolver,
            ImmutableList<String> input) throws MacroException {
        if (input.isEmpty()) {
            throw new MacroException("One quoted query expression is expected");
        }
        String queryExpression = CharMatcher.anyOf("\"'").trimFrom(input.get(0));
        return resolveQuery(target, cellNames, resolver, queryExpression).map(queryTarget -> {
            Preconditions.checkState(queryTarget instanceof QueryBuildTarget);
            BuildRule rule = resolver.getRule(((QueryBuildTarget) queryTarget).getBuildTarget());
            return rule.getBuildTarget().toString();
        }).sorted().collect(Collectors.joining(" "));
    }

    @Override
    public Object extractRuleKeyAppendables(BuildTarget target, CellPathResolver cellNames,
            final BuildRuleResolver resolver, ImmutableList<String> input) throws MacroException {
        if (input.isEmpty()) {
            throw new MacroException("One quoted query expression is expected");
        }
        String queryExpression = CharMatcher.anyOf("\"'").trimFrom(input.get(0));
        // Return the set of targets which matched the query
        return resolveQuery(target, cellNames, resolver, queryExpression).map(QueryTarget::toString)
                .collect(MoreCollectors.toImmutableSortedSet(Ordering.natural()));
    }

    @Override
    public ImmutableList<BuildRule> extractBuildTimeDeps(BuildTarget target, CellPathResolver cellNames,
            BuildRuleResolver resolver, ImmutableList<String> input) throws MacroException {
        // The query_targets macro is only used for inspecting the build graph or creating
        // log files, or buck invocations, so it should not depend on actual builds of the referenced
        // rules
        return ImmutableList.of();
    }
}