\nOutput<\/a>
\nExpression Substitution<\/a>
\nStatements<\/a>
\nset<\/a>
\nforeach<\/a>
\nif<\/a>
\nVariables<\/a>
\nFunctions and Generators<\/a>
\nData Types<\/a>
\nstring<\/a>
\narray<\/a>
\nMain Generator Parameters<\/a>
\nAttributes<\/a><\/p>\n
<\/a>Overview<\/h2>\nThe RefactorScript syntax is based on a simplified C# syntax. It is optimized for extremely fast execution, so you can typically preview the results of running your script directly as you type it.<\/p>\n
Each RefactorScript must contain at least one generator<\/strong> – a function that generates output. The simplest syntax for a generator is shown below:<\/p>\n[Main]\r\ngenerator DemoGenerator(Function func)\r\n{\r\n}<\/pre>\nNote that the [Main]<\/strong> attribute marks the entry point of the RefactorScript and is only needed if the script contains multiple generators.<\/p>\n<\/a>Output<\/h2>\nAny line inside a generator that starts with “>” will be directly translated to an output line. E.g. the following generator will just produce the “\/\/Hello, World” text:<\/p>\n
generator DemoGenerator(Function func)\r\n{\r\n>\/\/Hello, World\r\n}<\/pre>\nLines starting with “>>” will be treated as incomplete (i.e. no newline will be inserted after them). E.g.:<\/p>\n
generator DemoGenerator(Function func)\r\n{\r\n>>\/\/Hello,\r\n> World!\r\n>\/\/Hello, Script!\r\n}<\/pre>\nThe generator above will produce the following output:<\/p>\n
\/\/Hello, World!\r\n\/\/Hello, Script!<\/pre>\n<\/a>Expression Substitution<\/h2>\nThe lines starting with “>” and “>>” can use the “$” syntax to refer to expressions based on the generator parameters. E.g. the following script will output the name of the function passed to it:<\/p>\n
generator DemoGenerator(Function func)\r\n{\r\n>\/\/Hello, $func.ShortName\r\n}<\/pre>\nThe expressions can include multiple levels of fields, but cannot include function calls, e.g.:<\/p>\n
[Main]\r\ngenerator DemoGenerator(Function func)\r\n{\r\n}<\/pre>\nNote that the [Main]<\/strong> attribute marks the entry point of the RefactorScript and is only needed if the script contains multiple generators.<\/p>\n<\/a>Output<\/h2>\nAny line inside a generator that starts with “>” will be directly translated to an output line. E.g. the following generator will just produce the “\/\/Hello, World” text:<\/p>\n
generator DemoGenerator(Function func)\r\n{\r\n>\/\/Hello, World\r\n}<\/pre>\nLines starting with “>>” will be treated as incomplete (i.e. no newline will be inserted after them). E.g.:<\/p>\n
generator DemoGenerator(Function func)\r\n{\r\n>>\/\/Hello,\r\n> World!\r\n>\/\/Hello, Script!\r\n}<\/pre>\nThe generator above will produce the following output:<\/p>\n
\/\/Hello, World!\r\n\/\/Hello, Script!<\/pre>\n<\/a>Expression Substitution<\/h2>\nThe lines starting with “>” and “>>” can use the “$” syntax to refer to expressions based on the generator parameters. E.g. the following script will output the name of the function passed to it:<\/p>\n
generator DemoGenerator(Function func)\r\n{\r\n>\/\/Hello, $func.ShortName\r\n}<\/pre>\nThe expressions can include multiple levels of fields, but cannot include function calls, e.g.:<\/p>\n
![\"\"](\"https:\/\/visualgdb.com\/w\/wp-content\/uploads\/2021\/10\/demo1.png\")
<\/a><\/p>\n![\"\"](\"https:\/\/visualgdb.com\/w\/wp-content\/uploads\/2021\/10\/types.png\")
<\/a>Note that most C\/C++ entities inherit from the Entity<\/strong> type.<\/p>\n![\"\"](\"https:\/\/visualgdb.com\/w\/wp-content\/uploads\/2021\/10\/args.png\")
<\/a><\/p>\n![\"\"](\"https:\/\/visualgdb.com\/w\/wp-content\/uploads\/2021\/10\/hint.png\")
<\/a><\/p>\n