#defineDiretivaOpcional
Define identificadores, constantes manifestas ou pseudofunções substituídas pelo pré-processador.
FUNDAMENTOPublicado
Diretivas de compilação no AdvPL
#define · #undef · #include · #ifdef · #ifndef · #else · #endif · #command · #translateControle o pré-processamento, compartilhe definições e escolha quais trechos serão enviados ao compilador.
Visão geral
Diretivas são instruções executadas pelo pré-processador antes da compilação. Uma analogia útil é preparar uma receita antes de levá-la ao forno: o pré-processador inclui cabeçalhos, expande símbolos, traduz sintaxe e escolhe blocos; o compilador recebe apenas o resultado dessas decisões. Para quem conhece C/C++, #define e #include têm origem conceitual semelhante, mas não se deve equiparar #include a sistemas modernos completos de módulos.
Sintaxe
#define · #undef · #include · #ifdef · #ifndef · #else · #endif · #command · #translateParâmetros
#undefDiretivaOpcional
Remove uma definição ativa a partir do ponto onde a diretiva aparece.
#includeDiretivaOpcional
Insere no ponto atual o conteúdo de um arquivo de cabeçalho localizado no caminho de includes da compilação.
#ifdefDiretivaOpcional
Inclui um trecho na compilação somente quando determinado identificador estiver definido.
#ifndefDiretivaOpcional
Inclui um trecho somente quando determinado identificador ainda não estiver definido.
#else e #endifDiretivaOpcional
Define o caminho alternativo e encerra blocos de compilação condicional.
#command e #translateDiretivaOpcional
Cria regras de transformação sintática aplicadas pelo pré-processador.
Constante e compilação condicional
#define LIMITE_ITENS 100
#define LOG_DETALHADO
User Function ExDiretivas()
Local nItens := 120
#ifdef LOG_DETALHADO
ConOut("Itens recebidos: " + CValToChar(nItens))
#endif
If nItens > LIMITE_ITENS
MsgAlert("Limite excedido")
EndIf
ReturnResultado esperado
Os símbolos são resolvidos antes da compilação; o If continua sendo uma decisão em execução.
Valor padrão com #ifndef
#ifndef TAMANHO_LOTE
#define TAMANHO_LOTE 50
#endif
User Function ExLote()
ConOut("Tamanho do lote: " + CValToChar(TAMANHO_LOTE))
ReturnResultado esperado
O valor padrão é usado somente quando o símbolo não foi definido anteriormente.
Include específico
#include "TOTVS.ch"
#include "FWMVCDef.ch"
User Function ExCabecalhos()
// Utilize símbolos do Framework MVC somente após incluir
// o cabeçalho compatível com o ambiente.
ReturnResultado esperado
O conteúdo dos cabeçalhos participa do pré-processamento do fonte.
- Diretivas são processadas antes da execução; If/Else, por outro lado, decide caminhos enquanto a rotina está sendo executada.
- Use constantes manifestas para eliminar valores mágicos, compilação condicional para compatibilidade necessária e includes compatíveis com o release.
- Para configuração que precisa mudar em produção sem recompilar, prefira parâmetros ou outra fonte de configuração em tempo de execução.
- #command e #translate são recursos avançados; em código de aplicação, clareza costuma ser mais importante que criar nova sintaxe.
- Não coloque segredos em #define: a expansão fará parte do material compilado e do processo de desenvolvimento.
- Evite usar símbolos de compilação para diferenciar clientes quando parametrização ou extensão desacoplada resolverem o problema.
- Não presuma que todo fonte precise de PROTHEUS.CH e TOTVS.CH simultaneamente; inclua o necessário para o framework e release.
- Não atribua a #command funções existentes da biblioteca: AAdd(), por exemplo, é uma função AdvPL.