Scott Duensing
c3ae983a73
TKPAnsi is a TCustomControl descendant providing a visual ANSI terminal with 16-color palette, scrollback buffer, blinking cursor, and ANSI music. Supports CSI sequences (cursor movement, erase, SGR colors/attributes, insert/delete lines/chars, scroll), DEC private modes (wrap, cursor visibility), and keyboard translation (arrows, function keys, etc.). Test app (TESTMAIN.PAS) updated to wire TKPAnsi to TKPComm as a full terminal: received data feeds the terminal display, keystrokes are sent out the serial port. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
210 lines
7.1 KiB
Markdown
210 lines
7.1 KiB
Markdown
# KP Serial Components for Delphi 1.0
|
||
|
||
Native Delphi 1.0 components for serial communications and ANSI BBS terminal
|
||
emulation under Windows 3.1. Both components install to the **KP** component
|
||
palette tab.
|
||
|
||
## Components
|
||
|
||
### TKPComm — Serial Communications (`KPCOMM.PAS`)
|
||
|
||
Non-visual `TComponent` descendant providing RS-232 serial I/O via the
|
||
Windows 3.1 comm API (`OpenComm`, `BuildCommDCB`, `SetCommState`,
|
||
`EnableCommNotification`, etc.).
|
||
|
||
**Published properties:**
|
||
|
||
| Property | Type | Default | Description |
|
||
|---|---|---|---|
|
||
| CommPort | Integer | 1 | COM port number (1–16) |
|
||
| Settings | string | `9600,N,8,1` | Baud, parity, data bits, stop bits |
|
||
| PortOpen | Boolean | False | Open/close the port |
|
||
| InBufferSize | Integer | 4096 | Receive buffer size (bytes) |
|
||
| OutBufferSize | Integer | 4096 | Transmit buffer size (bytes) |
|
||
| RThreshold | Integer | 0 | Receive notification threshold (0 = disabled) |
|
||
| SThreshold | Integer | 0 | Send notification threshold (0 = disabled) |
|
||
| Handshaking | THandshaking | hsNone | Flow control (hsNone, hsXonXoff, hsRtsCts, hsBoth) |
|
||
| InputLen | Integer | 0 | Max bytes per Input read (0 = all available) |
|
||
| InputMode | TInputMode | imText | imText or imBinary |
|
||
| DTREnable | Boolean | True | Assert DTR on open |
|
||
| RTSEnable | Boolean | True | Assert RTS on open |
|
||
| NullDiscard | Boolean | False | Discard received null bytes |
|
||
| EOFEnable | Boolean | False | Treat Ctrl-Z as EOF |
|
||
| ParityReplace | string | `?` | Replacement char for parity errors |
|
||
| OnComm | TNotifyEvent | nil | Fired on comm events (receive, send, modem line changes, errors) |
|
||
|
||
**Public runtime properties:**
|
||
|
||
| Property | Type | Description |
|
||
|---|---|---|
|
||
| Input | string | Read received data from the buffer |
|
||
| Output | string | Write data to the transmit buffer |
|
||
| InBufferCount | Integer | Bytes waiting in receive buffer |
|
||
| OutBufferCount | Integer | Bytes waiting in transmit buffer |
|
||
| CTSHolding | Boolean | CTS line state (shadow, toggled on transitions) |
|
||
| DSRHolding | Boolean | DSR line state |
|
||
| CDHolding | Boolean | CD/RLSD line state |
|
||
| Break | Boolean | Set/clear break condition |
|
||
| CommEvent | Integer | Last event code (comEvReceive, comEvCTS, comEvtBreak, etc.) |
|
||
|
||
**Usage:**
|
||
|
||
```pascal
|
||
Comm := TKPComm.Create(Self);
|
||
Comm.CommPort := 1;
|
||
Comm.Settings := '9600,N,8,1';
|
||
Comm.RThreshold := 1;
|
||
Comm.OnComm := CommEvent;
|
||
Comm.PortOpen := True;
|
||
|
||
{ Send data }
|
||
Comm.Output := 'ATZ' + #13;
|
||
|
||
{ In OnComm handler }
|
||
if Comm.CommEvent = comEvReceive then
|
||
Data := Comm.Input;
|
||
```
|
||
|
||
### TKPAnsi — ANSI BBS Terminal Emulator (`KPANSI.PAS`)
|
||
|
||
Visual `TCustomControl` descendant providing a full ANSI terminal display with
|
||
scrollback, blinking cursor, 16-color palette, and ANSI music.
|
||
|
||
**Published properties:**
|
||
|
||
| Property | Type | Default | Description |
|
||
|---|---|---|---|
|
||
| Cols | Integer | 80 | Terminal width in columns (1–256) |
|
||
| Rows | Integer | 25 | Terminal height in rows (1–255) |
|
||
| ScrollbackSize | Integer | 500 | Maximum scrollback lines |
|
||
| CursorVisible | Boolean | True | Show/hide blinking block cursor |
|
||
| Font | TFont | Terminal 9pt | Monospace font for rendering |
|
||
| Color | TColor | clBlack | Default background color |
|
||
| TabStop | Boolean | True | Accept keyboard focus |
|
||
| OnKeyData | TKeyDataEvent | nil | Fired when user presses a key |
|
||
|
||
**Public methods and properties:**
|
||
|
||
| Member | Kind | Description |
|
||
|---|---|---|
|
||
| Write(const S: string) | method | Feed data to the terminal for parsing and display |
|
||
| Clear | method | Move screen to scrollback, blank the display, home cursor |
|
||
| Reset | method | Reset all attributes, clear screen, home cursor |
|
||
| CursorRow | Integer | Current cursor row (0-based, read-only) |
|
||
| CursorCol | Integer | Current cursor column (0-based, read-only) |
|
||
|
||
**Supported ANSI escape sequences:**
|
||
|
||
CSI (ESC\[) sequences:
|
||
|
||
| Sequence | Name | Action |
|
||
|---|---|---|
|
||
| ESC\[*n*A | CUU | Cursor up *n* rows |
|
||
| ESC\[*n*B | CUD | Cursor down *n* rows |
|
||
| ESC\[*n*C | CUF | Cursor forward *n* columns |
|
||
| ESC\[*n*D | CUB | Cursor back *n* columns |
|
||
| ESC\[*r*;*c*H | CUP | Cursor position (1-based row;col) |
|
||
| ESC\[*r*;*c*f | HVP | Same as CUP |
|
||
| ESC\[*n*J | ED | Erase display (0=below, 1=above, 2=all) |
|
||
| ESC\[*n*K | EL | Erase line (0=right, 1=left, 2=all) |
|
||
| ESC\[*n*S | SU | Scroll up *n* lines |
|
||
| ESC\[*n*T | SD | Scroll down *n* lines |
|
||
| ESC\[*n*L | IL | Insert *n* blank lines at cursor |
|
||
| ESC\[*n*M | DL | Delete *n* lines at cursor |
|
||
| ESC\[*n*@ | ICH | Insert *n* blank characters at cursor |
|
||
| ESC\[*n*P | DCH | Delete *n* characters at cursor |
|
||
| ESC\[*params*m | SGR | Set graphic rendition (see below) |
|
||
| ESC\[s | SCP | Save cursor position |
|
||
| ESC\[u | RCP | Restore cursor position |
|
||
|
||
SGR codes:
|
||
|
||
| Code | Effect |
|
||
|---|---|
|
||
| 0 | Reset all attributes |
|
||
| 1 | Bold (bright foreground) |
|
||
| 5 | Blink (rendered as bright background) |
|
||
| 7 | Reverse video |
|
||
| 22 | Cancel bold |
|
||
| 25 | Cancel blink |
|
||
| 27 | Cancel reverse |
|
||
| 30–37 | Foreground color (ANSI 0–7) |
|
||
| 40–47 | Background color (ANSI 0–7) |
|
||
|
||
DEC private modes:
|
||
|
||
| Sequence | Effect |
|
||
|---|---|
|
||
| ESC\[?7h | Enable line wrap (default) |
|
||
| ESC\[?7l | Disable line wrap |
|
||
| ESC\[?25h | Show cursor |
|
||
| ESC\[?25l | Hide cursor |
|
||
|
||
Control characters:
|
||
|
||
| Char | Effect |
|
||
|---|---|
|
||
| CR (#13) | Carriage return |
|
||
| LF (#10) | Line feed (scrolls at bottom) |
|
||
| BS (#8) | Backspace (no erase) |
|
||
| TAB (#9) | Tab to next 8-column stop |
|
||
| BEL (#7) | System beep |
|
||
|
||
**ANSI Music:**
|
||
|
||
Detected by `ESC[M` followed by a music string terminated by Ctrl-N (#14).
|
||
Syntax: `T<tempo> L<length> O<octave> <notes>` where notes are A–G with
|
||
optional sharp (`#`/`+`) or flat (`-`), duration (1/2/4/8/16), and dot (`.`)
|
||
for dotted notes. `P` inserts a rest. `>` and `<` shift octave. Played
|
||
asynchronously via the Windows 3.1 Sound API.
|
||
|
||
**Keyboard mapping (via OnKeyData):**
|
||
|
||
| Key | Output |
|
||
|---|---|
|
||
| Printable chars | The character itself |
|
||
| Enter | CR (#13) |
|
||
| Backspace | BS (#8) |
|
||
| Tab | TAB (#9) |
|
||
| Escape | ESC (#27) |
|
||
| Arrow Up/Down/Right/Left | ESC\[A / ESC\[B / ESC\[C / ESC\[D |
|
||
| Home / End | ESC\[H / ESC\[K |
|
||
| Page Up / Page Down | ESC\[V / ESC\[U |
|
||
| Insert / Delete | ESC\[@ / ESC DEL |
|
||
| F1–F4 | ESC OP / OQ / OR / OS |
|
||
| F5–F10 | ESC Ot / Ou / Ov / Ow / Ox / Oy |
|
||
|
||
## Test Application
|
||
|
||
`KPTEST.DPR` / `TESTMAIN.PAS` — a minimal terminal application that wires the
|
||
two components together. The form is created entirely in code (no DFM).
|
||
|
||
**Layout:** A toolbar row at the top with port number, settings, Open/Close
|
||
buttons, and a status label. The TKPAnsi terminal fills the rest of the form.
|
||
|
||
**Wiring:**
|
||
|
||
- `TKPComm.OnComm` handler reads `Input` and passes it to `TKPAnsi.Write`
|
||
- `TKPAnsi.OnKeyData` handler sends keystrokes to `TKPComm.Output`
|
||
|
||
## Building
|
||
|
||
Requires Delphi 1.0.
|
||
|
||
1. Open `KPTEST.DPR` in the Delphi IDE
|
||
2. Compile and run (F9)
|
||
|
||
To install the components for design-time use:
|
||
|
||
1. Component > Install Component
|
||
2. Add `KPCOMM.PAS` and `KPANSI.PAS`
|
||
3. Both appear on the **KP** palette tab
|
||
|
||
## Files
|
||
|
||
| File | Description |
|
||
|---|---|
|
||
| `KPCOMM.PAS` | TKPComm serial communications component |
|
||
| `KPANSI.PAS` | TKPAnsi ANSI terminal emulator component |
|
||
| `KPTEST.DPR` | Test application project file |
|
||
| `TESTMAIN.PAS` | Test application main form unit |
|