manzana_común

Funciones para que Starlark acceda a los elementos internos de las implementaciones de reglas de Apple.

Miembros

apple_host_system_env

dict apple_common.apple_host_system_env(xcode_config)

Devuelve un dict de variables de entorno que se deben establecer para las acciones que deben ejecutar herramientas de compilación en un sistema host de Apple, como la versión de Xcode que se debe usar. Las claves son nombres de variables y los valores son sus valores correspondientes.

Parámetros

Parámetro Descripción
xcode_config obligatorio
Un proveedor que contiene información sobre la configuración de Xcode.

apple_toolchain

apple_toolchain apple_common.apple_toolchain()

Son utilidades para resolver elementos de la cadena de herramientas de Apple.

AppleDebugOutputs

Provider apple_common.AppleDebugOutputs

El constructor o la clave del proveedor AppleDebugOutputs.

Si un destino propaga el proveedor AppleDebugOutputs, úsalo como la clave con la que recuperarlo. Ejemplo:

dep = ctx.attr.deps[0]
p = dep[apple_common.AppleDebugOutputs]

AppleDynamicFramework

Provider apple_common.AppleDynamicFramework

El constructor o la clave del proveedor AppleDynamicFramework.

Si un destino propaga el proveedor AppleDynamicFramework, úsalo como la clave con la que recuperarlo. Ejemplo:

dep = ctx.attr.deps[0]
p = dep[apple_common.AppleDynamicFramework]

AppleExecutableBinary

Provider apple_common.AppleExecutableBinary

El constructor o la clave del proveedor AppleExecutableBinary.

Si un destino propaga el proveedor AppleExecutableBinary, úsalo como la clave con la que recuperarlo. Ejemplo:

dep = ctx.attr.deps[0]
p = dep[apple_common.AppleExecutableBinary]

dotted_version

DottedVersion apple_common.dotted_version(version)

Crea una nueva instancia de DottedVersion.

Parámetros

Parámetro Descripción
version obligatorio
Es la representación de cadena de DottedVersion. 

struct apple_common.link_multi_arch_binary(ctx, avoid_deps=None, extra_linkopts=[], extra_link_inputs=[], stamp=-1)

Vincula un objeto binario (potencialmente multiarquitectura) que se orienta a plataformas de Apple. Este método comprende la mayor parte de la lógica de la regla apple_binary de Starlark en el dominio rules_apple y existe para ayudar en la migración de su lógica de vinculación a Starlark en rules_apple.

Esta API es altamente experimental y está sujeta a cambios en cualquier momento. No dependas de la estabilidad de esta función en este momento.

Parámetros

Parámetro Descripción
obligatorio
Es el contexto de la regla de Starlark.
sequence of Targets; or None; default = None
Es una lista de Target que están en el gráfico de dependencias del objeto binario, pero cuyas bibliotecas no deben vincularse en él. Este es el caso de las dependencias que se encontrarán en el tiempo de ejecución en otra imagen, como el cargador de paquetes o cualquier biblioteca o framework dinámico que cargue este binario.
sequence of strings; default = []
Opciones de vínculo adicionales que se pasarán a la acción del vinculador.
sequence of Files; default = []
Archivos adicionales para pasar a la acción del vinculador.
default = -1
Indica si se debe incluir información de compilación en el binario vinculado. Si es 1, siempre se incluye la información de compilación. Si es 0, la información de compilación siempre se excluye. Si es -1 (la opción predeterminada), el comportamiento se determina según la marca --[no]stamp. Se debe establecer en 0 cuando se genera el resultado ejecutable para las reglas de prueba. 

struct apple_common.link_multi_arch_static_library(ctx)

Vincula una biblioteca estática (potencialmente multiarquitectura) orientada a plataformas de Apple. Este método comprende una parte de la lógica de la regla apple_static_library de Starlark, en el dominio rules_apple, y existe para ayudar en la migración de su lógica de vinculación a Starlark en rules_apple.

Esta API es altamente experimental y está sujeta a cambios en cualquier momento. No dependas de la estabilidad de esta función en este momento.

Parámetros

Parámetro Descripción
obligatorio
Es el contexto de la regla de Starlark.

multi_arch_split

SplitTransitionProviderApi apple_common.multi_arch_split

Es una transición de configuración para los atributos de reglas para compilar dependencias en una o más plataformas de Apple.

El uso de esta transición requiere que los atributos de cadena "platform_type" y "minimum_os_version" estén definidos y sean obligatorios en la regla.

El valor del atributo platform_type dictará las arquitecturas de destino para las que se compilarán las dependencias a lo largo de esta transición de configuración.

Las opciones son las siguientes:

  • ios: Son las arquitecturas recopiladas de --ios_multi_cpus.
  • macos: Son las arquitecturas recopiladas de --macos_cpus.
  • tvos: Son las arquitecturas recopiladas de --tvos_cpus.
  • watchos: Son las arquitecturas recopiladas de --watchos_cpus.

minimum_os_version debe ser una cadena de versión con puntos, como "7.3", y se usa para establecer el sistema operativo mínimo en la configuración de manera similar según el tipo de plataforma. Por ejemplo, especificar platform_type 'ios' y minimum_os_version '8.0' garantizará que las dependencias se compilen con la versión mínima de iOS '8.0'.

new_dynamic_framework_provider

AppleDynamicFramework apple_common.new_dynamic_framework_provider(binary=None, cc_info=None, objc, framework_dirs=None, framework_files=None)

Crea una nueva instancia del proveedor AppleDynamicFramework.

Parámetros

Parámetro Descripción
binary File; or None; default = None
Es el artefacto binario dylib del framework dinámico.
cc_info default = None
Un CcInfo que contiene información sobre las dependencias transitivas vinculadas al objeto binario.
objc obligatorio
Un ObjcProvider que contiene información sobre las dependencias transitivas vinculadas al objeto binario.
framework_dirs depset of strings; or None; default = None
Son los nombres de ruta de acceso del framework que se usan como entradas de vinculación para vincularse con el framework dinámico.
framework_files depset of Files; or None; valor predeterminado = Ninguno
Es el conjunto completo de artefactos que se deben incluir como entradas para vincular con el framework dinámico.

new_executable_binary_provider

AppleExecutableBinary apple_common.new_executable_binary_provider(binary=None, cc_info=None, objc)

Crea una nueva instancia del proveedor AppleExecutableBinaryInfo.

Parámetros

Parámetro Descripción
binary File; or None; valor predeterminado = Ninguno
Es el artefacto binario del ejecutable.
cc_info default = None
Un CcInfo que contiene información sobre las dependencias transitivas vinculadas al objeto binario.
objc obligatorio
Un ObjcProvider que contiene información sobre las dependencias transitivas vinculadas al objeto binario.

new_objc_provider

ObjcProvider apple_common.new_objc_provider(**kwargs)

Crea una nueva instancia de ObjcProvider.

Parámetros

Parámetro Descripción
kwargs default = {}
Diccionario de argumentos.

ObjC

Provider apple_common.Objc

El constructor o la clave del proveedor Objc.

Si un destino propaga el proveedor Objc, úsalo como la clave con la que recuperarlo. Ejemplo:

dep = ctx.attr.deps[0]
p = dep[apple_common.Objc]

plataforma

struct apple_common.platform

Es una estructura similar a una enumeración que contiene los siguientes campos correspondientes a las plataformas de Apple:
  • ios_device
  • ios_simulator
  • macos
  • tvos_device
  • tvos_simulator
  • watchos_device
  • watchos_simulator

Estos valores se pueden pasar a métodos que esperan una plataforma, como XcodeVersionConfig.sdk_version_for_platform.

platform_type

struct apple_common.platform_type

Es una estructura similar a una enumeración que contiene los siguientes campos correspondientes a los tipos de plataformas de Apple:
  • ios
  • macos
  • tvos
  • watchos

Estos valores se pueden pasar a métodos que esperan un tipo de plataforma, como el método multi_arch_platform del fragmento de configuración "apple".

Ejemplo:

ctx.fragments.apple.multi_arch_platform(apple_common.platform_type.ios)

target_apple_env

dict apple_common.target_apple_env(xcode_config, platform)

Muestra un dict de variables de entorno que se deben establecer para las acciones que compilan destinos del tipo de plataforma de Apple determinado. Por ejemplo, este diccionario contiene variables que denotan el nombre de la plataforma y la versión del SDK con la que se debe compilar. Las claves son nombres de variables y los valores son sus valores correspondientes.

Parámetros

Parámetro Descripción
xcode_config obligatorio
Un proveedor que contiene información sobre la configuración de Xcode.
platform obligatorio
La plataforma de Apple.

XcodeProperties

Provider apple_common.XcodeProperties

El constructor o la clave del proveedor XcodeVersionProperties.

Si un destino propaga el proveedor XcodeVersionProperties, úsalo como la clave con la que recuperarlo. Ejemplo:

dep = ctx.attr.deps[0]
p = dep[apple_common.XcodeVersionProperties]

XcodeVersionConfig

Provider apple_common.XcodeVersionConfig

El constructor o la clave del proveedor XcodeVersionConfig.