/*
* Copyright 2015-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.jvm.java.HasClasspathEntries;
import com.facebook.buck.model.BuildTarget;
import com.facebook.buck.model.MacroException;
import com.facebook.buck.rules.BuildRule;
import com.facebook.buck.rules.BuildRuleResolver;
import com.facebook.buck.rules.CellPathResolver;
import com.facebook.buck.rules.SourcePathResolver;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSortedSet;
import com.google.common.collect.Ordering;
import java.io.File;
import java.util.Objects;
import java.util.stream.Collectors;
/**
* Used to expand the macro {@literal $(classpath //some:target)} to the transitive classpath of
* that target, expanding all paths to be absolute.
*/
public class ClasspathMacroExpander extends BuildTargetMacroExpander<ClasspathMacro>
implements MacroExpanderWithCustomFileOutput {
@Override
public Class<ClasspathMacro> getInputClass() {
return ClasspathMacro.class;
}
@Override
protected ClasspathMacro parse(
BuildTarget target, CellPathResolver cellNames, ImmutableList<String> input)
throws MacroException {
return ClasspathMacro.of(parseBuildTarget(target, cellNames, input));
}
private HasClasspathEntries getHasClasspathEntries(BuildRule rule) throws MacroException {
if (!(rule instanceof HasClasspathEntries)) {
throw new MacroException(
String.format(
"%s used in classpath macro does not correspond to a rule with a java classpath",
rule.getBuildTarget()));
}
return (HasClasspathEntries) rule;
}
@Override
public ImmutableList<BuildRule> extractBuildTimeDepsFrom(
BuildTarget target,
CellPathResolver cellNames,
BuildRuleResolver resolver,
ClasspathMacro input)
throws MacroException {
return ImmutableList.copyOf(
getHasClasspathEntries(resolve(resolver, input)).getTransitiveClasspathDeps());
}
@Override
public String expandForFile(
BuildTarget target,
CellPathResolver cellNames,
BuildRuleResolver resolver,
ImmutableList<String> input)
throws MacroException {
// javac is the canonical reader of classpaths, and its code for reading classpaths from
// files is a little weird:
// http://hg.openjdk.java.net/jdk7/jdk7/langtools/file/ce654f4ecfd8/src/share/classes/com/sun/tools/javac/main/CommandLine.java#l74
// The # characters that might be present in classpaths due to flavoring would be read as
// comments. As a simple workaround, we quote the entire classpath.
return String.format("'%s'", expand(target, cellNames, resolver, input));
}
@Override
protected String expand(SourcePathResolver resolver, BuildRule rule) throws MacroException {
return getHasClasspathEntries(rule)
.getTransitiveClasspathDeps()
.stream()
.filter(dep -> dep.getSourcePathToOutput() != null)
.map(dep -> resolver.getAbsolutePath(dep.getSourcePathToOutput()))
.map(Object::toString)
.sorted(Ordering.natural())
.collect(Collectors.joining(File.pathSeparator));
}
@Override
public Object extractRuleKeyAppendablesFrom(
BuildTarget target,
CellPathResolver cellNames,
BuildRuleResolver resolver,
ClasspathMacro input)
throws MacroException {
return ImmutableSortedSet.copyOf(
getHasClasspathEntries(resolve(resolver, input))
.getTransitiveClasspathDeps()
.stream()
.map(BuildRule::getSourcePathToOutput)
.filter(Objects::nonNull)
.collect(Collectors.toSet()));
}
}