com.facebook.buck.features.go

Class CGoLibrary

java.lang.Object

com.facebook.buck.core.rules.impl.AbstractBuildRule

com.facebook.buck.core.rules.impl.AbstractBuildRuleWithDeclaredAndExtraDeps

com.facebook.buck.core.rules.impl.NoopBuildRuleWithDeclaredAndExtraDeps

com.facebook.buck.features.go.CGoLibrary

All Implemented Interfaces:

BuildEngineAction, AllowsNonAnnotatedFields, HasDeclaredAndExtraDeps, BuildRule, HasNameAndType, Comparable<BuildRule>

public class CGoLibrary
extends NoopBuildRuleWithDeclaredAndExtraDeps

The CGoLibrary represents cgo build process which outputs the linkable object that is appended to the native go compiled program (via pack tool).

The process consists of four steps (similiar to go build): 1. Generate c sources with cgo tool 2. Compile and link cgo sources into single object 3. Generate cgo_import.go 4. Return generated go files and linked object (used by GoCompile)

Method Summary

Modifier and Type	Method and Description
static BuildRule	create(BuildRuleParams params, BuildTarget buildTarget, ProjectFilesystem projectFilesystem, ActionGraphBuilder graphBuilder, CellPathResolver cellRoots, CxxBuckConfig cxxBuckConfig, com.facebook.buck.features.go.GoPlatform platform, CgoLibraryDescriptionArg args, Iterable<BuildTarget> cxxDeps, Tool cgo)
com.google.common.collect.ImmutableList<SourcePath>	getGeneratedGoSource() returns .go files produced by cgo tool
Iterable<BuildRule>	getLinkableDeps()
SourcePath	getOutput() returns compiled linkable file source path

Methods inherited from class com.facebook.buck.core.rules.impl.NoopBuildRuleWithDeclaredAndExtraDeps

getBuildSteps, getSourcePathToOutput, hasBuildSteps, isCacheable

Methods inherited from class com.facebook.buck.core.rules.impl.AbstractBuildRuleWithDeclaredAndExtraDeps

deprecatedGetExtraDeps, getBuildDeps, getDeclaredDeps, getTargetGraphOnlyDeps

Methods inherited from class com.facebook.buck.core.rules.impl.AbstractBuildRule

equals, getBuildTarget, getDependencies, getProjectFilesystem, getSourcePathOutputs, getType, hashCode, injectFields, toString, updateBuildRuleResolver

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.facebook.buck.core.rules.BuildRule

compareTo, getFullyQualifiedName, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution

Method Detail

create

public static BuildRule create(BuildRuleParams params,
                               BuildTarget buildTarget,
                               ProjectFilesystem projectFilesystem,
                               ActionGraphBuilder graphBuilder,
                               CellPathResolver cellRoots,
                               CxxBuckConfig cxxBuckConfig,
                               com.facebook.buck.features.go.GoPlatform platform,
                               CgoLibraryDescriptionArg args,
                               Iterable<BuildTarget> cxxDeps,
                               Tool cgo)

getGeneratedGoSource

public com.google.common.collect.ImmutableList<SourcePath> getGeneratedGoSource()

returns .go files produced by cgo tool

getOutput

public SourcePath getOutput()

returns compiled linkable file source path

getLinkableDeps

public Iterable<BuildRule> getLinkableDeps()