com.facebook.buck.features.ocaml

Class OcamlLinkStep

java.lang.Object

com.facebook.buck.shell.ShellStep

com.facebook.buck.features.ocaml.OcamlLinkStep

All Implemented Interfaces:

Step

public class OcamlLinkStep
extends ShellStep

OCaml linking step. Dependencies and inputs should be topologically ordered

Field Summary

Fields

Modifier and Type	Field and Description
Path	argFile
com.google.common.collect.ImmutableList<String>	cDepInput
com.google.common.collect.ImmutableList<String>	cxxCompiler
com.google.common.collect.ImmutableMap<String,String>	environment
ProjectFilesystem	filesystem
com.google.common.collect.ImmutableList<String>	flags
com.google.common.collect.ImmutableList<Path>	input
boolean	isBytecode
boolean	isLibrary
com.google.common.collect.ImmutableList<String>	ocamlCompilerCommandPrefix
Path	output
Optional<String>	stdlib

Fields inherited from class com.facebook.buck.shell.ShellStep

workingDirectory

Method Summary

Modifier and Type	Method and Description
static OcamlLinkStep	create(ProjectFilesystem filesystem, com.google.common.collect.ImmutableMap<String,String> environment, com.google.common.collect.ImmutableList<String> cxxCompiler, com.google.common.collect.ImmutableList<String> ocamlCompilerCommandPrefix, com.google.common.collect.ImmutableList<Arg> flags, Optional<String> stdlib, Path output, Path argFile, com.google.common.collect.ImmutableList<Arg> depInput, com.google.common.collect.ImmutableList<Arg> cDepInput, com.google.common.collect.ImmutableList<Path> input, boolean isLibrary, boolean isBytecode, SourcePathResolverAdapter pathResolver) Factory method for OcamlLinkStep.
com.google.common.collect.ImmutableMap<String,String>	getEnvironmentVariables(ExecutionContext context) Returns the environment variables to include when running this ShellStep.
protected com.google.common.collect.ImmutableList<String>	getShellCommandInternal(ExecutionContext context) Implementations of this method should not have any observable side-effects.
String	getShortName()

Methods inherited from class com.facebook.buck.shell.ShellStep

addOptions, execute, getDescription, getDuration, getExitCodeFromResult, getShellCommand, getShellCommandArgsForDescription, getStderr, getStdin, getStdout, getTimeout, getTimeoutHandler, shouldPrintStderr, shouldPrintStdout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

filesystem

public final ProjectFilesystem filesystem

environment

public final com.google.common.collect.ImmutableMap<String,String> environment

cxxCompiler

public final com.google.common.collect.ImmutableList<String> cxxCompiler

ocamlCompilerCommandPrefix

public final com.google.common.collect.ImmutableList<String> ocamlCompilerCommandPrefix

flags

public final com.google.common.collect.ImmutableList<String> flags

stdlib

public final Optional<String> stdlib

output

public final Path output

argFile

public final Path argFile

cDepInput

public final com.google.common.collect.ImmutableList<String> cDepInput

input

public final com.google.common.collect.ImmutableList<Path> input

isLibrary

public final boolean isLibrary

isBytecode

public final boolean isBytecode

Method Detail

create

public static OcamlLinkStep create(ProjectFilesystem filesystem,
                                   com.google.common.collect.ImmutableMap<String,String> environment,
                                   com.google.common.collect.ImmutableList<String> cxxCompiler,
                                   com.google.common.collect.ImmutableList<String> ocamlCompilerCommandPrefix,
                                   com.google.common.collect.ImmutableList<Arg> flags,
                                   Optional<String> stdlib,
                                   Path output,
                                   Path argFile,
                                   com.google.common.collect.ImmutableList<Arg> depInput,
                                   com.google.common.collect.ImmutableList<Arg> cDepInput,
                                   com.google.common.collect.ImmutableList<Path> input,
                                   boolean isLibrary,
                                   boolean isBytecode,
                                   SourcePathResolverAdapter pathResolver)

Factory method for OcamlLinkStep.

getShortName

public String getShortName()

Returns:

a short name/description for the command, such as "javac". Should fit on one line.

getShellCommandInternal

protected com.google.common.collect.ImmutableList<String> getShellCommandInternal(ExecutionContext context)

Description copied from class: ShellStep

Implementations of this method should not have any observable side-effects.

Specified by:

getShellCommandInternal in class ShellStep

getEnvironmentVariables

public com.google.common.collect.ImmutableMap<String,String> getEnvironmentVariables(ExecutionContext context)

Description copied from class: ShellStep

Returns the environment variables to include when running this ShellStep.

By default, this method returns an empty map.

Overrides:

getEnvironmentVariables in class ShellStep

Parameters:

context - that may be useful when determining environment variables to include.