GTL Macro Reference

GTL supports macros to express template logic, and to loop on object collections. Macro keywords are prefixed by a . (dot) character, which must be the first non-blank character in the line, and you must respect the use of line breaks in the macro syntax.

• .abort_command Macro
  This macro stops a generation command.
• .block Macro
  This macro wraps a block of output with a header and/or a footer, if the output is not empty.
• .bool Macro
  This macro returns true or false depending on the value of the condition specified.
• .break Macro
  This macro can be used to break out of .foreach loops.
• .change_dir and .create_path Macros
  These macros change the current directory or create the specified path as part of a generation command.
• .comment and .// Macro
  These macros are used to insert comments in a template. Lines starting with .// or .comment are ignored during generation.
• .convert_name and .convert_code Macros
  These macros convert the object name to its code (or vice versa).
• .delete and .replace Macros
  These macros delete or replace all instances of the given string in the text input.
• .error and .warning Macros
  These macros are used to output errors and warnings during translation. Errors stop generation, while warnings are purely informational and can be triggered when an inconsistency is detected while applying the template on a particular object. The messages are displayed in both the object Preview tab and the Output window.
• .execute_command Macro
  This macro is launches executables as part of a generation command. If there is a failure for any reason (executable not found or output sent to stderr), then command execution is stopped.
• .execute_vbscript Macro
  This macro is used to execute a VB script specified in a separate file as part of a generation command.
• .foreach_item Macro
  This macro iterates over a collection of sub-objects or related objects.
• .foreach_line Macro
  This macro iterates over the lines of the multiline block of text using the special %CurrentLine% local variable.
• .foreach_part Macro
  This macro iterates over the parts of a string divided by a delimiter using the special %CurrentPart% local variable.
• .if Macro
  This macro is used for conditional generation.
• .log Macro
  This macro logs a message to the Output window Generation tab as part of a generation command.
• .lowercase and .uppercase Macros
  These macros convert text blocks to the specified case.
• .object and .collection Macros
  These macro return a single object OID or a collection of objects as a concatenation of semi-colon terminated OIDs, and are generally used to create templates returning objects for use by other templates.
• .set_interactive_mode Macro
  This macro is used to define if the GTL execution must interact with the user or not.
• .set_object, .set_value, and .unset Macros
  These macros are used to define a local variable of object (local object) or value type or to unset them.
• .unique Macro
  This macro outputs a block in which each line of the text generated is unique, and is often used for calculating imports, includes, typedefs, or forward declarations in languages such as Java, C++ or C#.
• .vbscript Macro
  This macro is used to embed VBScript code inside a template as part of a generation command. The result of the script is available as the ScriptResult array