com.facebook.buck.features.haskell.HaskellLinkRule.java Source code

Introduction

Here is the source code for com.facebook.buck.features.haskell.HaskellLinkRule.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.features.haskell;

import com.facebook.buck.core.build.buildable.context.BuildableContext;
import com.facebook.buck.core.build.context.BuildContext;
import com.facebook.buck.core.build.execution.context.ExecutionContext;
import com.facebook.buck.core.model.BuildTarget;
import com.facebook.buck.core.rulekey.AddToRuleKey;
import com.facebook.buck.core.rules.BuildRuleParams;
import com.facebook.buck.core.rules.impl.AbstractBuildRuleWithDeclaredAndExtraDeps;
import com.facebook.buck.core.sourcepath.ExplicitBuildTargetSourcePath;
import com.facebook.buck.core.sourcepath.SourcePath;
import com.facebook.buck.core.toolchain.tool.Tool;
import com.facebook.buck.io.BuildCellRelativePath;
import com.facebook.buck.io.filesystem.ProjectFilesystem;
import com.facebook.buck.rules.args.Arg;
import com.facebook.buck.shell.ShellStep;
import com.facebook.buck.step.Step;
import com.facebook.buck.step.fs.MkdirStep;
import com.facebook.buck.step.fs.RmStep;
import com.facebook.buck.util.MoreIterables;
import com.facebook.buck.util.Verbosity;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Iterables;
import java.nio.file.Path;

public class HaskellLinkRule extends AbstractBuildRuleWithDeclaredAndExtraDeps {

    @AddToRuleKey
    private final Tool linker;

    @AddToRuleKey(stringify = true)
    private final Path outputPath;

    @AddToRuleKey
    private final ImmutableList<Arg> args;

    @AddToRuleKey
    private final ImmutableList<Arg> linkerArgs;

    private final boolean cacheable;

    public HaskellLinkRule(BuildTarget buildTarget, ProjectFilesystem projectFilesystem,
            BuildRuleParams buildRuleParams, Tool linker, Path outputPath, ImmutableList<Arg> args,
            ImmutableList<Arg> linkerArgs, boolean cacheable) {
        super(buildTarget, projectFilesystem, buildRuleParams);
        this.linker = linker;
        this.args = args;
        this.linkerArgs = linkerArgs;
        this.cacheable = cacheable;
        this.outputPath = outputPath;
    }

    private Path getOutputDir() {
        return getOutput().getParent();
    }

    private Path getOutput() {
        return this.outputPath;
    }

    @Override
    public ImmutableList<Step> getBuildSteps(BuildContext buildContext, BuildableContext buildableContext) {
        buildableContext.recordArtifact(getOutput());
        return new ImmutableList.Builder<Step>()
                .add(MkdirStep.of(BuildCellRelativePath.fromCellRelativePath(buildContext.getBuildCellRootPath(),
                        getProjectFilesystem(), getOutputDir())))
                .add(
                        // The output path might be a folder, so delete it all
                        RmStep.of(BuildCellRelativePath.fromCellRelativePath(buildContext.getBuildCellRootPath(),
                                getProjectFilesystem(), getOutput())).withRecursive(true))
                .add(new ShellStep(getProjectFilesystem().getRootPath()) {

                    @Override
                    public ImmutableMap<String, String> getEnvironmentVariables(ExecutionContext context) {
                        return ImmutableMap.<String, String>builder().putAll(super.getEnvironmentVariables(context))
                                .putAll(linker.getEnvironment(buildContext.getSourcePathResolver())).build();
                    }

                    @Override
                    protected ImmutableList<String> getShellCommandInternal(ExecutionContext context) {
                        return ImmutableList.<String>builder()
                                .addAll(linker.getCommandPrefix(buildContext.getSourcePathResolver()))
                                .add("-o", getProjectFilesystem().resolve(getOutput()).toString())
                                .addAll(Arg.stringify(args, buildContext.getSourcePathResolver()))
                                .addAll(MoreIterables.zipAndConcat(Iterables.cycle("-optl"),
                                        Arg.stringify(linkerArgs, buildContext.getSourcePathResolver())))
                                .build();
                    }

                    @Override
                    protected boolean shouldPrintStderr(Verbosity verbosity) {
                        return !verbosity.isSilent();
                    }

                    @Override
                    public String getShortName() {
                        return "haskell-link";
                    }
                }).build();
    }

    @Override
    public SourcePath getSourcePathToOutput() {
        return ExplicitBuildTargetSourcePath.of(getBuildTarget(), getOutput());
    }

    @Override
    public boolean isCacheable() {
        return cacheable;
    }
}