com.facebook.buck.swift

Class SwiftBuckConfig

java.lang.Object

com.facebook.buck.swift.SwiftBuckConfig

All Implemented Interfaces:

ConfigView<BuckConfig>

public class SwiftBuckConfig
extends Object
implements ConfigView<BuckConfig>

A Swift-specific "view" of BuckConfig.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPILE_FORCE_CACHE
static String	COMPILER_FLAGS_NAME
static String	COPY_STDLIB_TO_FRAMEWORKS
static String	EMIT_SWIFTDOCS
static String	PROJECT_ADD_AST_PATHS
static String	PROJECT_EMBED_RUNTIME
static String	PROJECT_WMO
static String	USE_FILELIST
static String	USE_LIPO_THIN
static String	USE_MODULEWRAP
static String	VERSION_NAME

Constructor Summary

Constructors

Constructor and Description
SwiftBuckConfig(BuckConfig delegate)

Method Summary

Modifier and Type	Method and Description
boolean	getCompileForceCache()
Optional<Iterable<String>>	getCompilerFlags()
boolean	getCopyStdlibToFrameworks() If enabled, swift-stdlib-tool will be run on .framework bundles, copying the Swift standard library into them.
BuckConfig	getDelegate()
boolean	getEmitSwiftdocs() If enabled, a .swiftdoc file will be generated along with the .swiftmodule file.
boolean	getProjectAddASTPaths() If enabled, AST paths to the .swiftmodules will be added as part of the linker invocation.
boolean	getProjectEmbedRuntime() If enabled, automatically emebds the Swift runtime if a relevant target depends on any libraries that use Swift.
boolean	getProjectWMO() If enabled, turns on Whole Module Optimization for any targets that contain Swift.
boolean	getUseFileList()
boolean	getUseLipoThin() Uses `lipo -thin` instead of `lipo -extract` when copying the Swift standard libraries.
boolean	getUseModulewrap()
Optional<String>	getVersion()
static SwiftBuckConfig	of(BuckConfig delegate)

Methods inherited from class java.lang.Object

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

Field Detail

COMPILER_FLAGS_NAME

public static final String COMPILER_FLAGS_NAME

See Also:

Constant Field Values

VERSION_NAME

public static final String VERSION_NAME

See Also:

Constant Field Values

COMPILE_FORCE_CACHE

public static final String COMPILE_FORCE_CACHE

See Also:

Constant Field Values

USE_FILELIST

public static final String USE_FILELIST

See Also:

Constant Field Values

USE_MODULEWRAP

public static final String USE_MODULEWRAP

See Also:

Constant Field Values

PROJECT_WMO

public static final String PROJECT_WMO

See Also:

Constant Field Values

PROJECT_EMBED_RUNTIME

public static final String PROJECT_EMBED_RUNTIME

See Also:

Constant Field Values

PROJECT_ADD_AST_PATHS

public static final String PROJECT_ADD_AST_PATHS

See Also:

Constant Field Values

COPY_STDLIB_TO_FRAMEWORKS

public static final String COPY_STDLIB_TO_FRAMEWORKS

See Also:

Constant Field Values

USE_LIPO_THIN

public static final String USE_LIPO_THIN

See Also:

Constant Field Values

EMIT_SWIFTDOCS

public static final String EMIT_SWIFTDOCS

See Also:

Constant Field Values

Constructor Detail

SwiftBuckConfig

public SwiftBuckConfig(BuckConfig delegate)

Method Detail

getDelegate

public BuckConfig getDelegate()

Specified by:

getDelegate in interface ConfigView<BuckConfig>

of

public static SwiftBuckConfig of(BuckConfig delegate)

getCompilerFlags

public Optional<Iterable<String>> getCompilerFlags()

getVersion

public Optional<String> getVersion()

getCompileForceCache

public boolean getCompileForceCache()

getUseFileList

public boolean getUseFileList()

getUseModulewrap

public boolean getUseModulewrap()

getProjectEmbedRuntime

public boolean getProjectEmbedRuntime()

If enabled, automatically emebds the Swift runtime if a relevant target depends on any libraries that use Swift.

getProjectWMO

public boolean getProjectWMO()

If enabled, turns on Whole Module Optimization for any targets that contain Swift.

getProjectAddASTPaths

public boolean getProjectAddASTPaths()

If enabled, AST paths to the .swiftmodules will be added as part of the linker invocation. This is necessary for lldb to be able to debug statically linked Swift libraries.

getCopyStdlibToFrameworks

public boolean getCopyStdlibToFrameworks()

If enabled, swift-stdlib-tool will be run on .framework bundles, copying the Swift standard library into them. This is usually not what you want - it will lead to multiple redundant copies of the libraries being embedded in both the app bundle and any descendant framework bundles. Even if Swift is only used in a framework, and not in the app binary, Buck and swift-stdlib-tool will handle that correctly and embed the libraries.

getUseLipoThin

public boolean getUseLipoThin()

Uses `lipo -thin` instead of `lipo -extract` when copying the Swift standard libraries.

Regardless of the value of this config flag, the resulting libraries are then passed to `lipo -create`.

getEmitSwiftdocs

public boolean getEmitSwiftdocs()

If enabled, a .swiftdoc file will be generated along with the .swiftmodule file. This is necessary for Xcode to display the documentation for the libraries prebuilt with buck.