List of functions in the ude.interfaces namespace.
| Entity Name | Description |
|---|
| sanitize_filename_slug | Produces a filesystem-safe, cross-platform slug from a logical filename. |
| sanitize_html_id | Produces a safe HTML id attribute value from a raw entity name. |
| build_inheritance_columns | Builds the box layout for a class’s inheritance diagram: a list of columns (left = most distant ancestor, right = cls itself), each column a list of display-name labels stacked top-to-bottom. |
| render_inheritance_diagram_png | Rasterizes a column-of-boxes inheritance layout (see build_inheritance_columns) into a simple box-and-arrow PNG. Own visual style, not a byte-for-byte clone of any third-party tool’s diagrams – shared between the ODA and Default renderer families. |
Generated with Flude
Copyright © 2026
Directory & Entity Index
| Entity Name | Summary / Description |
|---|
| build_inheritance_columns function | Builds the box layout for a class’s inheritance diagram: a list of
columns (left = most distant ancestor, right = cls itself), each column
a list of display-name labels stacked top-to-bottom. Only the class’s PRIMARY (first-listed) base is walked further up its own
ancestry chain (one box per generation, single-file) – additional direct
bases (multiple inheritance) each contribute exactly one box, placed in
the column immediately left of cls alongside the primary base’s nearest
ancestor, fanning in to cls. This covers both the common single-
inheritance chain (e.g. OdGiDrawable -> OdNwObject -> OdNwDatabase) and
simple multiple inheritance (e.g. Box : Shape, IDrawable) without
attempting to lay out full diamond/deep-multi-inheritance graphs. |
| render_inheritance_diagram_png function | Rasterizes a column-of-boxes inheritance layout (see
build_inheritance_columns) into a simple box-and-arrow PNG. Own visual
style, not a byte-for-byte clone of any third-party tool’s diagrams –
shared between the ODA and Default renderer families. Returns: Raw PNG bytes. Methodsrender_inheritance_diagram_pngrender_inheritance_diagram_png(columns: List]) -> bytes
Rasterizes a column-of-boxes inheritance layout (see
build_inheritance_columns) into a simple box-and-arrow PNG. Own visual
style, not a byte-for-byte clone of any third-party tool’s diagrams –
shared between the ODA and Default renderer families. |
| sanitize_filename_slug function | Produces a filesystem-safe, cross-platform slug from a logical filename. Neutralizes every character Windows forbids in a filename (< > : " / \\ | ? *) plus .. traversal, so a malformed entity/namespace name –
or an overloaded C++ operator function whose own name IS one of these
characters (confirmed crash: operator| produced
function_operator|.html, rejected by Windows with Invalid argument
during a real Kernel SDK render) – can never produce an illegal or
output-directory-escaping path. Kept deliberately minimal so it matches
the pre-existing per-family behaviour for every ordinary name and only
adds* uniform escaping the per-language _resolve_base_filename hooks
don’t already cover (some handle */& themselves for C++ pointer/
reference types; re-escaping here is idempotent, a harmless no-op for
characters already gone by the time this runs). A single trailing
extension (.html/.md) is preserved and the intentional __
scope separator is left intact. |
| sanitize_html_id function | Produces a safe HTML id attribute value from a raw entity name. Unlike sanitize_filename_slug, this targets HTML id semantics, not
filesystem safety: a primary template’s display name carries its formal
parameter list with literal </>/whitespace (e.g.
"MockExchangeTraits< kMock2Ifc >") – valid inside a
double-quoted HTML attribute per spec, but the whitespace and angle
brackets break #id-style CSS/JS selectors and anchor-link ergonomics.
Collapses any run of characters outside [A-Za-z0-9_-] to a single
underscore, trims leading/trailing underscores, and falls back to a
literal “_” for an empty/all-punctuation input so the id is never blank. |