manzana_común

7.3 · 7.2 · 7.1 · 7.0 · 6.5

Funciones para que Starlark acceda a los componentes 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()

Utilidades para resolver elementos de la cadena de herramientas de Apple.

AppleDebugOutputs

Provider apple_common.AppleDebugOutputs

El constructor/la clave para el proveedor AppleDebugOutputs.

Si un destino propaga el proveedor AppleDebugOutputs, úsalo como la clave con la que lo recuperarás. 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 lo recuperarás. Ejemplo:

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

AppleExecutableBinary

Provider apple_common.AppleExecutableBinary

El constructor/la clave para el proveedor AppleExecutableBinary.

Si un destino propaga el proveedor AppleExecutableBinary, úsalo como la clave con la que lo recuperarás. 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=[], extra_requested_features=[], extra_disabled_features=[], stamp=-1)

Vincula un objeto binario (potencialmente de varias arquitecturas) orientado a las 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
El contexto de la regla de Starlark.
Secuencia de objetivos o None; El valor predeterminado es None
Es una lista de Target que están en el gráfico de dependencias del 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.
Secuencia de cadenas. El valor predeterminado es []
. Opciones de vinculación adicionales que se pasarán a la acción del vinculador.
Secuencia de archivos. El valor predeterminado es []
. Son archivos adicionales que se pasan a la acción del vinculador.
secuencia de strings; el valor predeterminado es []
Funciones adicionales solicitadas que se pasarán a la acción del vinculador.
secuencia de strings; el valor predeterminado es []
Funciones adicionales inhabilitadas que se pasarán a la acción del vinculador.
El valor predeterminado es -1
Indica si se debe incluir información de compilación en el objeto 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 (el valor predeterminado), el comportamiento se determina a través de 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 de varias arquitecturas) 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.

new_dynamic_framework_provider

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

Crea una instancia nueva del proveedor de AppleDynamicFramework.

Parámetros

Parámetro Descripción
binary File o None; el valor predeterminado es None
. Es el artefacto binario dylib del framework dinámico.
cc_info El valor predeterminado es None
Un CcInfo que contiene información sobre las dependencias transitivas vinculadas al objeto binario.
objc El valor predeterminado es None
Un ObjcProvider que contiene información sobre las dependencias transitivas vinculadas al objeto binario.
framework_dirs depset de cadenas; o None; el valor predeterminado es None
Los nombres de ruta de acceso del framework que se usan como entradas de vínculo para vincular con el framework dinámico.
framework_files depset de Files; o None; el valor predeterminado es None
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=None)

Crea una nueva instancia del proveedor AppleExecutableBinaryInfo.

Parámetros

Parámetro Descripción
binary Archivo o None; el valor predeterminado es None
Es el artefacto binario del ejecutable.
cc_info El valor predeterminado es None
Un CcInfo que contiene información sobre las dependencias transitivas vinculadas al objeto binario.
objc El valor predeterminado es None
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 instancia nueva de ObjcProvider.

Parámetros

Parámetro Descripción
kwargs la configuración predeterminada es {}
Diccionario de argumentos.

Objc

Provider apple_common.Objc

El constructor/la clave para el 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
  • visionos_device
  • visionos_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

Un struct similar a una enumeración que contiene los siguientes campos correspondientes a los tipos de plataformas de Apple:
  • ios
  • macos
  • tvos
  • visionos
  • 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 configurar para las acciones que compilan destinos de un 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 los que se 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/la clave para el proveedor XcodeVersionProperties.

Si un destino propaga el proveedor XcodeVersionProperties, úsalo como la clave con la que lo recuperarás. Ejemplo:

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

XcodeVersionConfig

Provider apple_common.XcodeVersionConfig

El constructor/la clave para el proveedor XcodeVersionConfig.