Guide de référence des macros du langage de génération par template

Le langage de génération par template (GTL) prend en charge des macros pour exprimer la logique de template, et pour boucler sur les collections d'objets. Chaque mot clé de macro doit être précédé d'un caractère . (point), et doit être le premier caractère, autre qu'un espace, sur une ligne. Prenez soin de respecter la syntaxe des macros en termes de passage à la ligne.

• Macro .abort_command
  Cette commande stoppe l'exécution d'une commande de génération.
• Macro .block
  Cette macro ajoute un en-tête et/ou une fin à un bloc de résultats, si le résultat n'est pas vide.
• Macro .bool
  Cette macro renvoie true ou false en fonction de la valeur de la condition spécifiée.
• Macro .break
  Cette macro peut être utilisée pour quitter des boucles .foreach.
• Macros .change_dir et .create_path
  Ces macros changent le répertoire courant ou créent le chemin spécifié dans le cadre d'une commande de génération.
• Macros .comment et .//
  Ces macros sont utilisées pour insérer des commentaires dans un template. Les lignes qui commencent par .// ou par .comment sont ignorées lors de la génération.
• Macros .convert_name et .convert_code
  Ces macros convertissent le nom d'un objet en son code (et vice versa).
• Macros .delete et .replace
  Ces macros suppriment ou remplacent toutes les instances de la chaîne donnée dans le texte en entrée.
• Macros .error et .warning
  Ces macros sont utilisées pour émettre des messages d'erreur et des avertissements lors de la conversion. Les erreurs interrompent la génération, tandis que les avertissements sont émis à titre d'information uniquement et peuvent être déclenchés si une incohérence est détectée lorsque vous appliquez le template sur un objet particulier. Les messages sont affichés à la fois dans le volet Aperçu de la feuille de propriétés d'objet et dans la fenêtre Résultats.
• Macro .execute_command
  Cette macro lance des exécutables dans le cadre d'une commande de génération. Si elle échoue pour une raison quelconque (exécutables non trouvés, ou bien résultat envoyé vers stderr), l'exécution de la commande est interrompue.
• Macro .execute_vbscript
  Cette macro est utilisée pour exécuter un script VB spécifié dans un fichier séparé dans le cadre d'une commande de génération.
• Macro .foreach_item
  Cette macro procède à l'itération sur une collection de sous-objets ou d'objets associés.
• Macro .foreach_line
  Cette macro procède à l'itération sur les lignes d'un bloc de texte multiligne en utilisant la variable locale %CurrentLine%.
• Macro .foreach_part
  Cette macro permet une itération des parties d'une chaîne divisée par un délimiteur utilisant la variable locale %CurrentPart% spéciale.
• Macro .if
  Cette macro est utilisée pour la génération conditionnelle.
• Macro .log
  Cette macro consigne un message dans l'onglet Génération de la fenêtre Résultats dans le cadre d'une commande de génération.
• Macros .lowercase et .uppercase
  Ces macros convertissent des blocs de texte dans la casse spécifiée.
• Macros .object et .collection
  Ces macro renvoient un OID d'objet unique ou une collection d'objets sous la forme d'une concaténation des OID terminées par des points-virgules, et sont généralement utilisées pour créer des templates qui renvoient des objets à utiliser par les autres templates.
• Macro .set_interactive_mode
  Cette macro permet de décider si l'exécution du GTL doit s'effectuer avec des interactions de l'utilisateur ou non.
• Macros .set_object, .set_value et .unset
  Ces macros sont utilisées afin de définir une variable locale de type objet (objet local) ou un type de valeur, ou d'annuler leur définition.
• Macro .unique
  Cette macro produit un bloc dans lequel chaque ligne de texte généré est unique, et elle est souvent utilisée pour calculer les importations, inclusions, typedefs ou des déclarations anticipées dans des langages tels que Java, C++ ou C#.
• Macro .vbscript
  Cette macro est utilisée pour incorporer du code VBScript dans un template dans le cadre d'une commande de génération. Le résultat du script est disponible sous la forme du tableau ScriptResult.