A list can hold more choices than the screen has rows while its cursor still stays in view.
Use it in a project
ITEM_COUNT and PAGE_ROWS must be nonzero and SELECTED below ITEM_COUNT. TOP is a retained requested first row; clamp it to max(0, ITEM_COUNT-PAGE_ROWS). Shift it just enough to contain SELECTED. Return ROW=SELECTED-TOP and VISIBLE=min(PAGE_ROWS, ITEM_COUNT-TOP). Invalid input clears ROW/VISIBLE/VALID and preserves TOP. Selection changes, disabled choices and input repeat remain caller-owned.
Include component.inc once (MOS callers include the shared 6502 implementation through it). Reserve the public fields in this exact order: TOP, ROW, VISIBLE, VALID, SELECTED, ITEM_COUNT, PAGE_ROWS. They occupy 7 contiguous bytes. Also reserve the private workspace: T0, T1 (2 bytes). Array names in the explanation refer to the numbered consecutive bindings, such as C0, C1 and so on.
Call menu_page_window_init once at the intended reset boundary. It clears inputs as well as outputs and workspace. Set your starting state and configuration afterwards, then call menu_page_window_step whenever the described event occurs. The helper reads no device, waits for no frame and installs no interrupt handler.
| Ownership | Fields |
|---|---|
| Retain between calls | TOP |
| Supply before service | SELECTED, ITEM_COUNT and PAGE_ROWS |
| Read after service | TOP, ROW, VISIBLE and VALID |
Clamp the old window against the list, then move only when selection crosses either edge. Compute relative differences instead of adding page size to TOP, avoiding byte wrap near the end of a long list.
Reusable initialisation and service
; SPDX-License-Identifier: MIT
; Keep a Menu Selection Visible. See README.md for the byte interface and ownership.
; init clears the public fields and private workspace; set inputs afterwards.
menu_page_window_init:
move.b #0,d0
move.b d0,TOP
move.b d0,ROW
move.b d0,VISIBLE
move.b d0,VALID
move.b d0,SELECTED
move.b d0,ITEM_COUNT
move.b d0,PAGE_ROWS
move.b d0,T0
move.b d0,T1
rts
menu_page_window_step:
; ROW = 0
move.b #0,d0
move.b d0,ROW
; VISIBLE = 0
move.b #0,d0
move.b d0,VISIBLE
; VALID = 0
move.b #0,d0
move.b d0,VALID
; if ITEM_COUNT == 0:
move.b ITEM_COUNT,d0
cmp.b #0,d0
beq menu_page_window_L1
jmp menu_page_window_L2
menu_page_window_L1:
; return
rts
jmp menu_page_window_L3
menu_page_window_L2:
menu_page_window_L3:
; if PAGE_ROWS == 0:
move.b PAGE_ROWS,d0
cmp.b #0,d0
beq menu_page_window_L4
jmp menu_page_window_L5
menu_page_window_L4:
; return
rts
jmp menu_page_window_L6
menu_page_window_L5:
menu_page_window_L6:
; if SELECTED >= ITEM_COUNT:
move.b SELECTED,d0
move.b ITEM_COUNT,d1
cmp.b d1,d0
bcc menu_page_window_L7
jmp menu_page_window_L8
menu_page_window_L7:
; return
rts
jmp menu_page_window_L9
menu_page_window_L8:
menu_page_window_L9:
; VALID = 1
move.b #1,d0
move.b d0,VALID
; T0 = 0
move.b #0,d0
move.b d0,T0
; if ITEM_COUNT > PAGE_ROWS:
move.b ITEM_COUNT,d0
move.b PAGE_ROWS,d1
cmp.b d1,d0
bhi menu_page_window_L10
jmp menu_page_window_L11
menu_page_window_L10:
; T0 = ITEM_COUNT - PAGE_ROWS
move.b ITEM_COUNT,d0
move.b PAGE_ROWS,d1
sub.b d1,d0
move.b d0,T0
jmp menu_page_window_L12
menu_page_window_L11:
menu_page_window_L12:
; if TOP > T0:
move.b TOP,d0
move.b T0,d1
cmp.b d1,d0
bhi menu_page_window_L13
jmp menu_page_window_L14
menu_page_window_L13:
; TOP = T0
move.b T0,d0
move.b d0,TOP
jmp menu_page_window_L15
menu_page_window_L14:
menu_page_window_L15:
; if SELECTED < TOP:
move.b SELECTED,d0
move.b TOP,d1
cmp.b d1,d0
bcs menu_page_window_L16
jmp menu_page_window_L17
menu_page_window_L16:
; TOP = SELECTED
move.b SELECTED,d0
move.b d0,TOP
jmp menu_page_window_L18
menu_page_window_L17:
; T1 = SELECTED - TOP
move.b SELECTED,d0
move.b TOP,d1
sub.b d1,d0
move.b d0,T1
; if T1 >= PAGE_ROWS:
move.b T1,d0
move.b PAGE_ROWS,d1
cmp.b d1,d0
bcc menu_page_window_L19
jmp menu_page_window_L20
menu_page_window_L19:
; T1 = SELECTED - PAGE_ROWS
move.b SELECTED,d0
move.b PAGE_ROWS,d1
sub.b d1,d0
move.b d0,T1
; TOP = T1 + 1
move.b T1,d0
add.b #1,d0
move.b d0,TOP
jmp menu_page_window_L21
menu_page_window_L20:
menu_page_window_L21:
menu_page_window_L18:
; ROW = SELECTED - TOP
move.b SELECTED,d0
move.b TOP,d1
sub.b d1,d0
move.b d0,ROW
; VISIBLE = ITEM_COUNT - TOP
move.b ITEM_COUNT,d0
move.b TOP,d1
sub.b d1,d0
move.b d0,VISIBLE
; if VISIBLE > PAGE_ROWS:
move.b VISIBLE,d0
move.b PAGE_ROWS,d1
cmp.b d1,d0
bhi menu_page_window_L22
jmp menu_page_window_L23
menu_page_window_L22:
; VISIBLE = PAGE_ROWS
move.b PAGE_ROWS,d0
move.b d0,VISIBLE
jmp menu_page_window_L24
menu_page_window_L23:
menu_page_window_L24:
rts
component_end:Machine contract
D0–D3/A0–A1/CCR may change; D4–D7/A2–A6 are preserved. A direct BSR/JSR needs four return-address stack bytes. The helper makes no nested calls and adds no other stack use. Its named scratch is private workspace, not a pointer, a ROM variable or shared zero-page space that the game may borrow concurrently. The samples use fixed symbol bindings. Scope or rename every label and binding, including the component_end measurement marker, and allocate a separate block for each independent instance. Different helpers can also use common field names, so combining them needs separate namespaces or explicitly renamed bindings. Give each block one mutation owner.
The A500 OCS diagnostic cold-boots an OFS disk, owns the Copper and bitplane and disables interrupt/DMA sources. The helper does not take over hardware or allocate Chip RAM.
Adapt the caller
demo.asm supplies the bindings and include order. exercise.inc first runs table cases, then a separate client retaining state between calls. A game can call the public step entry directly and remove the diagnostic packet and display. Do not copy the diagnostic’s hardware takeover into an existing game loop.
Build with make ASM198X=/path/to/asm198x and BUILD198X=/path/to/build198x. The Makefile produces normal, custom, deliberately wrong and repaired programs. Tools must already be installed; the sample downloads nothing.
Bindings and include order
section code,code_c
CUSTOM = 0
BROKEN = 0
COYOTE_STEPS = 4
BUFFER_STEPS = 4
TEXT_CAP = 8
PROPERTY_COUNT = 16
STREAM_BYTES = 13
CRC_POLY = 7
include "caller.inc"
include "exercise.inc"
component_start:
include "component.inc"
even
include "data.inc"
include "cases.inc"
even
include "display.inc"
include "../../framework/turn-deadline/font.inc"
code_end:
STATE:
TOP: dc.b 0
ROW: dc.b 0
VISIBLE: dc.b 0
VALID: dc.b 0
SELECTED: dc.b 0
ITEM_COUNT: dc.b 0
PAGE_ROWS: dc.b 0
T0: dc.b 0
T1: dc.b 0
even
ready: dc.w 0
preview: dcb.b 8,0
OUTPUT: dcb.b 1300,0
even
signature: dc.b "198XNIGHTTWO000",0
even
copperlist:
dc.w $08e,$2c81,$090,$2cc1,$092,$0038,$094,$00d0
dc.w $100,$1200,$102,0,$104,0,$108,0,$10a,0
dc.w $180,$012,$182,$fff
copbpl:
dc.w $0e0,0,$0e2,0
dc.w $ffff,$fffe
plane: dcb.b 10240,0A client retaining state between calls
preview_rules:
ifne CUSTOM
; ITEM_COUNT = 255
move.b #255,d0
move.b d0,ITEM_COUNT
; PAGE_ROWS = 8
move.b #8,d0
move.b d0,PAGE_ROWS
; SELECTED = 254
move.b #254,d0
move.b d0,SELECTED
; TOP = 255
move.b #255,d0
move.b d0,TOP
ifne BROKEN
; TOP = 0
move.b #0,d0
move.b d0,TOP
endif
bsr checked_step
bsr emit_state
rts
else
; ITEM_COUNT = 20
move.b #20,d0
move.b d0,ITEM_COUNT
; PAGE_ROWS = 4
move.b #4,d0
move.b d0,PAGE_ROWS
; SELECTED = 5
move.b #5,d0
move.b d0,SELECTED
ifne BROKEN
; TOP = 0
move.b #0,d0
move.b d0,TOP
endif
bsr checked_step
bsr emit_state
; SELECTED = 6
move.b #6,d0
move.b d0,SELECTED
ifne BROKEN
; TOP = 0
move.b #0,d0
move.b d0,TOP
endif
bsr checked_step
bsr emit_state
; SELECTED = 3
move.b #3,d0
move.b d0,SELECTED
ifne BROKEN
; TOP = 0
move.b #0,d0
move.b d0,TOP
endif
bsr checked_step
bsr emit_state
endif
rtsCustomise it
Show the last item of a 255-entry list in an eight-row page. The maintained custom caller changes its inputs or client sequence rather than hiding a different implementation behind the same label. Compare every state of the two clients, not only their final display.
Custom client selection
section code,code_c
CUSTOM = 1
BROKEN = 0
COYOTE_STEPS = 2
BUFFER_STEPS = 2
TEXT_CAP = 4
PROPERTY_COUNT = 16
STREAM_BYTES = 13
CRC_POLY = 49
include "caller.inc"
include "exercise.inc"
component_start:
include "component.inc"
even
include "data.inc"
include "cases.inc"
even
include "display.inc"
include "../../framework/turn-deadline/font.inc"
code_end:
STATE:
TOP: dc.b 0
ROW: dc.b 0
VISIBLE: dc.b 0
VALID: dc.b 0
SELECTED: dc.b 0
ITEM_COUNT: dc.b 0
PAGE_ROWS: dc.b 0
T0: dc.b 0
T1: dc.b 0
even
ready: dc.w 0
preview: dcb.b 8,0
OUTPUT: dcb.b 1300,0
even
signature: dc.b "198XNIGHTTWO000",0
even
copperlist:
dc.w $08e,$2c81,$090,$2cc1,$092,$0038,$094,$00d0
dc.w $100,$1200,$102,0,$104,0,$108,0,$10a,0
dc.w $180,$012,$182,$fff
copbpl:
dc.w $0e0,0,$0e2,0
dc.w $ffff,$fffe
plane: dcb.b 10240,0The custom diagnostic row is F7 07 08 01 FE FF 08 00. The full client trace in the source explains how it gets there.
Mistake and repair
The wrong client resets the retained top row before each call. Moving back to row three jumps the list to the beginning instead of preserving the nearby window. Retain TOP between selection changes.
The BROKEN branch lives in the sequential client, not the reusable helper. wrong.asm selects it; repaired.asm restores the normal call sequence. The repaired executable matches the normal program (for Spectrum, compare loaded CODE rather than the tape filename).
Select the deliberately wrong client
section code,code_c
CUSTOM = 0
BROKEN = 1
COYOTE_STEPS = 4
BUFFER_STEPS = 4
TEXT_CAP = 8
PROPERTY_COUNT = 16
STREAM_BYTES = 13
CRC_POLY = 7
include "caller.inc"
include "exercise.inc"
component_start:
include "component.inc"
even
include "data.inc"
include "cases.inc"
even
include "display.inc"
include "../../framework/turn-deadline/font.inc"
code_end:
STATE:
TOP: dc.b 0
ROW: dc.b 0
VISIBLE: dc.b 0
VALID: dc.b 0
SELECTED: dc.b 0
ITEM_COUNT: dc.b 0
PAGE_ROWS: dc.b 0
T0: dc.b 0
T1: dc.b 0
even
ready: dc.w 0
preview: dcb.b 8,0
OUTPUT: dcb.b 1300,0
even
signature: dc.b "198XNIGHTTWO000",0
even
copperlist:
dc.w $08e,$2c81,$090,$2cc1,$092,$0038,$094,$00d0
dc.w $100,$1200,$102,0,$104,0,$108,0,$10a,0
dc.w $180,$012,$182,$fff
copbpl:
dc.w $0e0,0,$0e2,0
dc.w $ffff,$fffe
plane: dcb.b 10240,0
Cost and alternatives
The measured helper extent is 392 code bytes; public state is 7 bytes and private scratch is 2 bytes. There are no immutable helper tables. Caller data, the test cases, return-address stack, alignment and display buffers cost additional space. These are assembled sizes, not cycle measurements.
Constant work regardless of list length. Redraw only changed rows when your display path permits it; the helper does not promise that scrolling a bitmap costs the same as changing a hardware character map.
The helper returns logical indices, not character or pixel positions. Count255 means valid indices0..254. An empty list needs a separate empty-state view. For variable-height rows, use a pixel-offset viewport rather than this fixed-row policy.
Execution evidence
Four variants run on A500 OCS PAL, Kickstart1.3 OFS cold boot, using Asm198x 0.0.72, Emu198x 0.44.2 and Build198x 0.2.9. Each executes 64 boundary/varied/error table cases, dirty initialisation and the separate retained-state client. An independent mathematical/container model checks every public byte after every call. This is bounded example coverage, not exhaustive correctness for every possible state.
The records retain loaded immutable code, completion, register sentinels, full packets, source/tool/firmware hashes and captures. The public gate validates these retained observations and rejects altered evidence; it does not run restricted firmware. No firmware is distributed. The eight displayed bytes are the first eight public fields, zero-padded when shorter; the packet includes every field.
Where it fits
Menu navigation: Resolve selection and disabled options first, then use this window to choose which rows to draw.