Contracts and edge cases

Platform spec article

Contracts and edge cases

Back to Console controls ◎ Open feature in platform map

Spec standingStandard

Owner

Piotr Mikstacki pmikstacki@cybernomad.it

Submitter

Piotr Mikstacki pmikstacki@cybernomad.it

Current document

ADRs (2)

1. 0040-character-cell-layout Character-cell layout only Accepted

   Console controls operate on cell grid, not pixels.

   Context

   Terminal UI in corelib targets TTY character grids.

   Decision

   Rule	Detail
   Coordinates	Rows/columns in character cells
   Graphics	Pixel graphics are out of scope

   Consequences

   Layout helpers align with Console.ConsoleSize and resize events.

   Verification anchors

   Console control tests under packages/console.

   Open full ADR page

2. 0041-livetick-caller-owned-loop LiveTick caller-owned redraw loop Accepted

   Periodic redraw uses LiveTick; callers own fiber/channel loops.

   Context

   Corelib should not embed a full UI framework inside controls.

   Decision

   Rule	Detail
   Tick	LiveTick drives periodic redraw
   Loop	Callers compose fibers/channels around tick

   Consequences

   Interactive samples pair LiveTick with concurrency package channels.

   Verification anchors

   Console controls examples and tests.

   Open full ADR page

Articles

• Contracts and edge cases Layout and redraw requirements for console controls. article Standard Reviewed Thu May 21
• Design model Control tree, render context, and character-grid layout. article Standard Reviewed Thu May 21
• Examples Panel and progress bar render patterns. article Standard Reviewed Thu May 21
• Flow and algorithm Frame render and live tick loop. article Standard Reviewed Thu May 21
• Verification and traceability Control layout tests and module paths. article Standard Reviewed Thu May 21

History

0 revisions (git unavailable at build; counts may be empty)

Open full history on GitHub

No commits recorded for this path.

Completeness

OKfeature · 3 SpecSection(s) · 1 H2 heading(s)

Section id	Required	Found
what-this-feature-specifies	yes	yes
implementation-anchors	yes	yes

Full tree: run pnpm verify:platform-spec-layout (writes src/generated/platform-spec-layout-report.json).

Related spec docs

• Feature
  Console controls

  Parent feature hub

Purpose

Document contracts and edge cases for the Console Controls feature: role-specific normative detail beyond the feature hub.

Canonical references

• Feature hub: Console Controls
• Sibling articles in this bundle (design model, contracts, flow, examples, verification)

Detailed behavior

Normative requirements

ID	Requirement
CTL-001	Frame.Render must clamp child layout to columns × rows from ConsoleSize.
CTL-002	Progress ratio must be in 0..=1; out-of-range should clamp.
CTL-003	Full-screen controls should emit Erase.DisplayAll before draw when ANSI enabled.
CTL-004	LiveTick must not block the scheduler indefinitely; one tick == one render pass.

Edge cases

• Terminal shrink: controls should truncate lines rather than panic.
• Zero-size terminal: render may produce empty buffer.
• Resize mid-frame: next tick or ConsoleMessage::Resize should trigger relayout (Console terminal events).

Verification

See the verification and traceability article in this bundle and compiler/corelib/beskid_corelib/tests/corelib_tests/src/console/.

Related topics

• Parent feature hub and Terminal and console area