Skip to content
Project referenceDevelopmentEngine ccf7d03f
Authored
  • The bounded Console backend, immutable occurrences and current diagnostic lifetime.

This project owns the Console’s history, current diagnostic state, grouping and Clear-on-Play policy. It implements logging and diagnostic sink contracts without drawing ImGui. The application composition root owns EditorConsole; panels and features read through IEditorConsole and immutable snapshots.

Logs and diagnostics explains filtering, collapse and current issues. Console presentation explains the separate panel implementation.

The timeline and collapsed groups are ordered by occurrence sequence, oldest first. A new error appearing at the bottom is normal chronological behavior. The view follows new output only while the user is already at the bottom or explicitly requests it.

Ordinary logs retain past occurrences. Diagnostics belong to the reporting producer until it replaces or clears its report. Clear() removes historical logs; it does not claim ownership of producer diagnostics. Re-publishing an unchanged issue does not move it to a new timeline position. Recoverable rendering issues reconcile after a successful frame rather than accumulating as permanent logs.

Grouping includes entry kind, severity, source, code, message, location, stack identity and LogSessionId. Equivalent nonadjacent occurrences can group within one session. Matching text from different Edit/Play sessions remains distinct.

The host creates and starts the Console with its logging router, diagnostic hub and Play Mode source. Start registers sinks and a state-change subscription; failed startup compensates those registrations. Dispose ends those subscriptions and ownership. Snapshot models do not transfer ownership of the producing services to a panel.

Ordinary log capacity is bounded and clamps to at least 16 entries. The default Clear-on-Play policy is enabled. Its user-facing persisted value lives at Editor/Diagnostics/Console/Clear on Play; the panel does not maintain another toolbar or layout preference for it. Apply, Undo and Redo update the backend through the Settings owner.

Reference types cover the service, read-only interface, snapshot, group, occurrence and Log/Diagnostic kind. Internal queues, grouping helpers and buffers remain implementation details. Source declarations and XML do not make every public CLR type a script export.

Browse Console backend types.

Project: Inno.Editor.Diagnostics
Source: src/composition/editor/framework/Inno.Editor.Diagnostics/Inno.Editor.Diagnostics.csproj

Type API Description
EditorConsole engine Owns one editor’s bounded Console history, current diagnostics, grouping, and Play Mode clearing policy.
EditorConsoleEntryKind engine Identifies the source protocol represented by one editor Console occurrence.
EditorConsoleGroup engine Groups equivalent Console occurrences regardless of whether they arrived consecutively.
EditorConsoleOccurrence engine Describes one immutable log or diagnostic occurrence in the editor Console timeline.
EditorConsoleSnapshot engine Provides one immutable and internally consistent view of editor Console state.
IEditorConsole engine Exposes read-only editor Console snapshots and explicit retention controls to editor features.