com.facebook.buck.features.ocaml.OcamlLinkStep.java Source code

Introduction

Here is the source code for com.facebook.buck.features.ocaml.OcamlLinkStep.java

Source

/*
 * Copyright 2014-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.ocaml;

import com.facebook.buck.core.build.execution.context.ExecutionContext;
import com.facebook.buck.core.sourcepath.resolver.SourcePathResolver;
import com.facebook.buck.rules.args.Arg;
import com.facebook.buck.shell.ShellStep;
import com.facebook.buck.util.MoreIterables;
import com.google.common.collect.FluentIterable;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Iterables;
import java.nio.file.Path;
import java.util.Optional;

/** OCaml linking step. Dependencies and inputs should be topologically ordered */
public class OcamlLinkStep extends ShellStep {

    public final ImmutableMap<String, String> environment;
    public final ImmutableList<String> cxxCompiler;
    public final ImmutableList<String> ocamlCompilerCommandPrefix;
    public final ImmutableList<String> flags;
    public final Optional<String> stdlib;
    public final Path output;
    public final ImmutableList<String> cDepInput;
    public final ImmutableList<Path> input;
    public final boolean isLibrary;
    public final boolean isBytecode;

    private final ImmutableList<String> ocamlInput;

    public static OcamlLinkStep create(Path workingDirectory, ImmutableMap<String, String> environment,
            ImmutableList<String> cxxCompiler, ImmutableList<String> ocamlCompilerCommandPrefix,
            ImmutableList<Arg> flags, Optional<String> stdlib, Path output, ImmutableList<Arg> depInput,
            ImmutableList<Arg> cDepInput, ImmutableList<Path> input, boolean isLibrary, boolean isBytecode,
            SourcePathResolver pathResolver) {
        ImmutableList.Builder<String> ocamlInputBuilder = ImmutableList.builder();

        String linkExt = isBytecode ? OcamlCompilables.OCAML_CMA : OcamlCompilables.OCAML_CMXA;

        for (String linkInput : Arg.stringify(depInput, pathResolver)) {
            if (isLibrary && linkInput.endsWith(linkExt)) {
                continue;
            }
            ocamlInputBuilder.add(linkInput);
        }

        ImmutableList<String> ocamlInput = ocamlInputBuilder.build();

        return new OcamlLinkStep(workingDirectory, environment, cxxCompiler, ocamlCompilerCommandPrefix,
                Arg.stringify(flags, pathResolver), stdlib, output, ocamlInput,
                FluentIterable.from(cDepInput).transformAndConcat(a -> Arg.stringifyList(a, pathResolver)).toList(),
                input, isLibrary, isBytecode);
    }

    private OcamlLinkStep(Path workingDirectory, ImmutableMap<String, String> environment,
            ImmutableList<String> cxxCompiler, ImmutableList<String> ocamlCompilerCommandPrefix,
            ImmutableList<String> flags, Optional<String> stdlib, Path output, ImmutableList<String> ocamlInput,
            ImmutableList<String> cDepInput, ImmutableList<Path> input, boolean isLibrary, boolean isBytecode) {
        super(workingDirectory);
        this.environment = environment;
        this.ocamlCompilerCommandPrefix = ocamlCompilerCommandPrefix;
        this.cxxCompiler = cxxCompiler;
        this.flags = flags;
        this.stdlib = stdlib;
        this.output = output;
        this.cDepInput = cDepInput;
        this.input = input;
        this.isLibrary = isLibrary;
        this.isBytecode = isBytecode;
        this.ocamlInput = ocamlInput;
    }

    @Override
    public String getShortName() {
        return "OCaml link";
    }

    @Override
    protected ImmutableList<String> getShellCommandInternal(ExecutionContext context) {
        ImmutableList.Builder<String> cmd = ImmutableList.<String>builder().addAll(ocamlCompilerCommandPrefix)
                .addAll(OcamlCompilables.DEFAULT_OCAML_FLAGS);

        if (stdlib.isPresent()) {
            cmd.add("-nostdlib", OcamlCompilables.OCAML_INCLUDE_FLAG, stdlib.get());
        }

        cmd.add("-cc", cxxCompiler.get(0));
        cmd.addAll(
                MoreIterables.zipAndConcat(Iterables.cycle("-ccopt"), cxxCompiler.subList(1, cxxCompiler.size())));
        if (isLibrary) {
            cmd.add("-a");
        } else if (isBytecode) {
            cmd.add("-custom");
        }
        return cmd.add("-o", output.toString()).addAll(flags).addAll(ocamlInput)
                .addAll(input.stream().map(Object::toString).iterator())
                .addAll(MoreIterables.zipAndConcat(Iterables.cycle("-cclib"), cDepInput)).build();
    }

    @Override
    public ImmutableMap<String, String> getEnvironmentVariables(ExecutionContext context) {
        return environment;
    }
}