Helpers for script writers¶
Writing a plugin or any Python API script usually starts with two questions: what does the API return for this entity? and what tokens does the lexer produce here? These interactive reports answer both without writing a line of code — right-click the entity you're experimenting with and read off exactly what your script will see.
| Use... | When... |
|---|---|
| API Info (tree) or API Info Table (flat table) | You want to see all the information available from the API for a specific entity or architecture — kinds, references, metrics, and properties — before you hard-code a kind string or debug a filter that isn't matching. |
| References Table or File References Table | You want a filterable list of every reference — to an entity, or every reference inside a file — so you can quickly check which references exist and find their exact kind strings for ent.refs(...). |
| Tokenizer or Tokenizer Table | You're working with the lexer and want to understand how a segment of text will actually be processed — token kind, position, and (if it's a reference) the reference details. Both have options to expand macro text and show whitespace tokens. |
For the full API contract behind what these reports show, see the Python API reference and the generated Python API docs; report plugins themselves are covered by the ireport guide.
Enable them first
Only API Info and API Info Table ship enabled. References Table, File References Table, and the Tokenizer reports ship disabled; turn them on in the Plugin Manager (Tools menu) — see Install & run plugins.