Apple_common

Funções do Starlark para acessar os componentes internos das implementações das regras da Apple

Membros

apple_host_system_env

dict apple_common.apple_host_system_env(xcode_config)

Retorna um dict de variáveis de ambiente que precisam ser definidas para ações que precisam executar ferramentas de build em um sistema host da Apple, como a versão do Xcode a ser usada. As chaves são nomes de variáveis e os valores são seus valores correspondentes.

Parâmetros

Parâmetro Descrição
xcode_config obrigatório
Um provedor que contém informações sobre a configuração do Xcode.

apple_toolchain

apple_toolchain apple_common.apple_toolchain()

Utilitários para resolver itens do conjunto de ferramentas da Apple.

AppleDebugOutputs

Provider apple_common.AppleDebugOutputs

O construtor/chave do provedor AppleDebugOutputs.

Se um destino propagar o provedor AppleDebugOutputs, use-o como a chave para recuperá-lo. Exemplo:

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

AppleDynamicFramework

Provider apple_common.AppleDynamicFramework

O construtor/chave do provedor AppleDynamicFramework.

Se um destino propagar o provedor AppleDynamicFramework, use-o como a chave para recuperá-lo. Exemplo:

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

AppleExecutableBinary

Provider apple_common.AppleExecutableBinary

O construtor/chave do provedor AppleExecutableBinary.

Se um destino propagar o provedor AppleExecutableBinary, use-o como a chave para recuperá-lo. Exemplo:

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

dotted_version

DottedVersion apple_common.dotted_version(version)

Cria uma nova instância de DottedVersion.

Parâmetros

Parâmetro Descrição
version obrigatório
A representação da string de DottedVersion. 

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

Vincula um binário (possivelmente multiarquitetura) destinado a plataformas Apple. Esse método compreende uma grande parte da lógica da regra apple_binary do Starlark no domínio rules_apple e existe para ajudar na migração da lógica de vinculação para o Starlark no rules_apple.

Essa API é altamente experimental e está sujeita a mudanças a qualquer momento. Não dependa da estabilidade desta função neste momento.

Parâmetros

Parâmetro Descrição
obrigatório
O contexto da regra Starlark.
sequence of Targets; or None padrão = Nenhum
Uma lista de Targets que estão no gráfico de dependências do binário, mas cujas bibliotecas não devem ser vinculadas ao binário. Isso se aplica a dependências que serão encontradas durante a execução em outra imagem, como o carregador de pacotes ou quaisquer bibliotecas/frameworks dinâmicos que serão carregados por esse binário.
sequence of strings padrão = []
Linkopts extras que são transmitidos para a ação do vinculador.
sequence of Files padrão = []
Arquivos extras a serem passados para a ação do vinculador.
padrão = -1
Indica se as informações de build precisam ser incluídas no binário vinculado. Se 1, as informações da versão serão sempre incluídas. Se 0, as informações da versão serão sempre excluídas. Se for -1 (o padrão), o comportamento será determinado pela sinalização --[no]stamp. Ele precisa ser definido como 0 ao gerar a saída executável para regras de teste. 

struct apple_common.link_multi_arch_static_library(ctx)

Vincula uma biblioteca estática (possivelmente multiarquitetura) destinada a plataformas Apple. Esse método compreende uma parte da lógica de regra apple_static_library do Starlark, no domínio rules_apple, e existe para ajudar na migração da lógica de vinculação para o Starlark no rules_apple.

Essa API é altamente experimental e está sujeita a mudanças a qualquer momento. Não dependa da estabilidade desta função neste momento.

Parâmetros

Parâmetro Descrição
obrigatório
O contexto da regra Starlark.

multi_arch_split

SplitTransitionProviderApi apple_common.multi_arch_split

Uma transição de configuração para atributos de regra para criar dependências em uma ou mais plataformas da Apple.

O uso dessa transição exige que o elemento "platform_type" e "minimum_os_version" atributos de string são definidos e obrigatórios na regra.

O valor do atributo platform_type determinará as arquiteturas de destino para criar as dependências com essa transição de configuração.

As opções são:

  • ios: arquiteturas coletadas de --ios_multi_cpus.
  • macos: arquiteturas coletadas de --macos_cpus.
  • tvos: arquiteturas coletadas de --tvos_cpus.
  • watchos: arquiteturas coletadas de --watchos_cpus.

O campo "minimum_os_version" precisa ser uma string de versão com pontos, como "7.3", e é usado para definir o sistema operacional mínimo na configuração, de forma semelhante, com base no tipo de plataforma. Por exemplo, especificar platform_type "ios" e average_os_version '8.0' garante que as dependências sejam criadas com a versão mínima do 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)

Cria uma nova instância do provedor AppleDynamicFramework.

Parâmetros

Parâmetro Descrição
binary File; or None padrão = Nenhum
O artefato binário dylib do framework dinâmico.
cc_info padrão = Nenhum
Um CcInfo que contém informações sobre as dependências transitivas vinculadas ao binário.
objc obrigatório
Um ObjcProvider que contém informações sobre as dependências transitivas vinculadas ao binário.
framework_dirs depset of strings; or None padrão = Nenhum
Os nomes de caminho do framework usados como entradas de link para vinculação ao framework dinâmico.
framework_files depset of Files; or None padrão = Nenhum
O conjunto completo de artefatos que precisa ser incluído como entradas para vincular ao framework dinâmico

new_executable_binary_provider

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

Cria uma nova instância do provedor AppleExecutableBinaryInfo.

Parâmetros

Parâmetro Descrição
binary File; or None padrão = Nenhum
O artefato binário do executável.
cc_info padrão = Nenhum
Um CcInfo que contém informações sobre as dependências transitivas vinculadas ao binário.
objc obrigatório
Um ObjcProvider que contém informações sobre as dependências transitivas vinculadas ao binário.

new_objc_provider

ObjcProvider apple_common.new_objc_provider(**kwargs)

Cria uma nova instância do ObjcProvider.

Parâmetros

Parâmetro Descrição
kwargs default = {}
Dicionário de argumentos.

Objc

Provider apple_common.Objc

O construtor/chave do provedor Objc.

Se um destino propagar o provedor Objc, use-o como a chave para recuperá-lo. Exemplo:

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

plataforma

struct apple_common.platform

Um struct semelhante a um tipo enumerado que contém os seguintes campos correspondentes às plataformas da Apple:
  • ios_device
  • ios_simulator
  • macos
  • tvos_device
  • tvos_simulator
  • watchos_device
  • watchos_simulator

Esses valores podem ser transmitidos para métodos que esperam uma plataforma, como XcodeVersionConfig.sdk_version_for_platform.

platform_type

struct apple_common.platform_type

Um struct semelhante a enum que contém os seguintes campos correspondentes aos tipos de plataforma da Apple:
  • ios
  • macos
  • tvos
  • watchos

Esses valores podem ser passados para métodos que esperam um tipo de plataforma, como o "apple" do fragmento de configuração do método multi_arch_platform.

Exemplo:

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

target_apple_env

dict apple_common.target_apple_env(xcode_config, platform)

Retorna um dict de variáveis de ambiente que precisam ser definidas para ações que criam destinos do tipo de plataforma da Apple especificado. Por exemplo, esse dicionário contém variáveis que indicam o nome da plataforma e a versão do SDK a serem usados no build. As chaves são nomes de variáveis e os valores são seus valores correspondentes.

Parâmetros

Parâmetro Descrição
xcode_config obrigatório
Um provedor que contém informações sobre a configuração do Xcode.
platform obrigatório
A plataforma Apple.

XcodeProperties

Provider apple_common.XcodeProperties

O construtor/chave do provedor XcodeVersionProperties.

Se um destino propagar o provedor XcodeVersionProperties, use-o como a chave para recuperá-lo. Exemplo:

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

XcodeVersionConfig

Provider apple_common.XcodeVersionConfig

O construtor/chave do provedor XcodeVersionConfig.