Add VCC Plus disk packaging and verified Ebitor demo documentation

This commit is contained in:
Brian Holman committed 2026-11-09 23:45:55 -07:00
1 parent 53bf6abdd5
commit b81617dec8
12 files changed
+1002 -139

No files matched your search

+50
View File
@@ -0,0 +1,50 @@
# Source provenance
## Upstream snapshot
- Original author: Pierre Sarrazin.
- Package: ebitor 0.1.1.
- Source archive: <http://sarrazip.com/dev/ebitor-0.1.1.tar.gz>.
- Author project page: <http://sarrazip.com/dev/cmoc.html>.
- Archive SHA-256: `6911a9d2ee80925622f1d82db1b77710a1f896865e63d29a04dc16489b150e83`.
- Git import baseline: `53bf6abdd50177da8b6dad36f487dcdac1b59176`.
The first Git commit is the regular-file contents of the original release archive,
with its single enclosing package directory removed and executable modes retained.
It is an archive snapshot, not a reconstruction of upstream Git history.
The following integration commit records the VCC Plus adaptations separately.
The original README is preserved byte-for-byte in
[UPSTREAM_README.md](UPSTREAM_README.md).
The author’s project index linked the matching archive during provenance review.
No historical HTTP receipt establishes the date of the original download; the
SHA-256 identifies the observed archive bytes, not authenticity or a license grant.
## VCC Plus integration
- The original C/header sources and Makefile are byte-identical to the archive.
- `VCCPlus.mk` includes the original Makefile and adds target `vccplus-disk`
to package `ebitdemo.bin` into `Ebitor.DSK`.
- `vccplus-project.json` selects that disk target and launches the demo with
`LOADM"EBITDEMO":EXEC`.
- Public documentation, build-output exclusions and actual guest screenshots
accompany the verified disk. Source notices and authored runtime data remain
intact. Generated intermediate build files are excluded from Git.
## License scope
The upstream README and source explicitly grant GPL-3.0-or-later permissions.
The archive omits the `COPYING` file referenced by its README. This integration
adds unmodified GPLv3 license text from VCC Plus’s `COPYING`, accompanying the
existing notices without changing their “or later” permission.
The upstream version history says “2027-07-27” for version 0.1.0, while the author’s
project index observed during provenance review identifies version 0.1.1 in 2025.
The original README is preserved without correcting that inconsistent historical
date; the archive version and hash identify this import.
## Verification
The Release disk build and guest execution were verified through the public MCP
interface of installed VCC Plus 3.5.0 build 43. The checked-in disk and screenshots
are identified in [VALIDATION.md](VALIDATION.md), including the limits of that check.
+150
View File
@@ -0,0 +1,150 @@
# Ebitor: A reusable text editor C library for 8-bit systems
Ebitor is a C library that implements a bare bones text editor
that can be adapted to work in any terminal. It features text
search and can be extended by the client program.
Copyright © 2021-2025 Pierre Sarrazin <http://sarrazip.com/>
This code comes with ABSOLUTELY NO WARRANTY.
It is recommended to make backups of any files whose contents
are subjected to this editor.
## License: GPLv3
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
See file COPYING.
## Introduction
This is NOT an editor application, it is only a **C library**.
It is intended for programmers who want to integrate a full-screen
editor into their own application.
This library implements a bare bones editor: It has very few features.
More features can be implemented by the client program. They would
typically be invoked by the user by typing the escape key followed by
another key. For example, the Break key followed by A could be used to
put the cursor at the start of the current line.
## Features
- Used as a library, not a program.
- Terminal functions are entirely provided by the client program.
This allows this editor to be used with any terminal type.
- CoCo 32x16, 40x25, 64x25, 80x25 terminal drivers provided.
- OS-9 40- and 80-column driver provided.
The 32-column terminal is not supported.
(The OS-9 version needs the BControl library, available from
the CMOC home page.)
- Does not require dynamic memory allocation.
- Folds lines that are longer than the terminal width.
Does not support non-folding with horizontal scrolling.
- Only one editor can be operated at a given time.
- Should be compiled with the CMOC compiler.
See <http://sarrazip.com/dev/cmoc.html>.
The code assumes a 64k addressable space.
- The only controls provided are moving the cursor with the arrow
keys, and a backspace key to erase the previous character.
Other controls like page-up, page-down and string search must be
implemented by the client program.
The library offers function Ebitor_findStringAndScrollToShow()
to facilitate the latter.
## Building Ebitor
In a Unix-like development environment, do `make` to compile
for the CoCo, or `make TARGET=os9` to compile for OS-9.
See `Makefile` for details.
## Programming for Ebitor
See `smoldemo.c` for a minimal example and `ebitdemo.c` for a
substantial one. To compile these demos, do `make`, then run
`smoldemo.bin` or `ebitdemo.bin` on a CoCo or an emulator.
Either of these demos first #includes header files for one or
more terminal structs, e.g., `sgterm.h` for SG-4 mode (32x16),
`gimeterm.h` for the CoCo 3 text modes, or `os9term.h` for an
OS-9 40- or 80-character terminal.
Then it #includes `Ebitor.h` to use the editor structs and functions.
The demo's first step is to fill an ebitor_Window object that defines
the text window that the editor will use. Then it calls Ebitor's
`sg4term_init()` function, in the case of ,`smoldemo.c` to initialize
the 32x16 screen terminal.
Then `Ebitor_init()` is called to initialize the editor. This call
receives several pointers to several functions that Ebitor will need,
e.g., clearing the terminal, locating the cursor, etc. In the case of
the 32x16 screen, `sg4term_clear` and `sg4term_locate` are passed.
Then the demo enters its main editing loop. This loop must call
`Ebitor_processEditing()`. This function will operate until the user
presses the escape key, typically Break on a CoCo.
Then the editing loop shows a prompt to ask the user what to do after
pressing the escape key. Both demos offer to quit the program or to
show a help page. `ebitdemo.c` also offers to find some text.
If the user presses the escape key again instead of choosing one
of those options, the editing loop just goes back to the call to
`Ebitor_processEditing()`.
When exiting the editor loop, `Ebitor_shutdown()` must be called.
## Porting to other environments
`Ebitor_init()` accepts pointers to functions that handle the
terminal operations needed by the editor. Porting to a different
type of terminal mainly involves writing functions that fill the
same roles, and passing the addresses of those functions to
`Ebitor_init()`.
A good starting point can be to make a copy of sg4term.h and
sg4term.c under new names, then reworking the code for the new
terminal type.
## Memory requirements
The Ebitor library code should take about 5100 bytes in memory under DECB,
but about 5400 under OS-9.
The SG4 (32x16) terminal code (sg4term.c) should take about 1300 bytes.
The GIME (CoCo 3) terminal code (gimeterm.c) should take about 1300 bytes.
The OS-9 terminal code should take about 1000 bytes.
These sizes do not count:
* the text buffer in which the edited text is stored;
* the stack space needed during operation;
* the space that would be used if the assert() statements were enabled
by compiling without NDEBUG.
## Version history
0.1.0 - 2027-07-27 - First public release.
+47
View File
@@ -0,0 +1,47 @@
# VCC Plus validation
Verified November 9, 2026 (Mountain time; receipts continue into November 10 UTC).
## Environment and scope
- Installed VCC Plus **3.5.0, build 43**, using its public MCP project/build/playtest
interface and bundled toolchain.
- An isolated native copy retained the installed emulator code; its bundle identity
and ad-hoc signature were changed to avoid interfering with another active app.
- **Release**, **512 KB CoCo 3**, emulated **MC6809**, Disk BASIC.
- This verifies the source layout and build recipe in this repository. No host
rebuild, Xcode toolchain or alternate emulator was used for the guest check.
The disk build succeeded with no compiler warnings shown in the build receipt.
## Observed result
The demo launched with `LOADM"EBITDEMO":EXEC` and displayed its terminal-mode
menu. Mode 8 selected the 80-column editor, and the text `VCC PLUS` was entered
and appeared in the actual guest display. The inspected editor screenshot shows
that text and the `PRESS BREAK FOR MENU` prompt. No search, scrolling, deletion,
command menu, quit, file persistence, other terminal modes or OS-9 execution was
tested. The library’s `ebittest` test program was not run.
The playtest was stopped cleanly. The receipt reported no disk writes and matching
initial/final disk hashes. The screenshots are actual emulator framebuffer captures,
not mockups.
- Download disk: [`Ebitor.DSK`](../Ebitor.DSK), 161280 bytes.
- Disk SHA-256: `91c1ca42316042923537ad9da2c8933117264c1c0f238c8c2e38df90a6268eeb`.
- Main screenshot: [`screenshots/editor.png`](screenshots/editor.png).
- Initial screen: [`screenshots/running.png`](screenshots/running.png).
## Evidence identifiers
- Build: `169420CA-0B1D-4E4F-8F1A-6F6918DB40D8`.
- Artifact: `84B6A900-382F-43E0-9160-6777A3D46F95`.
- Run: `BF481772-32CF-457B-B344-3A5A4BD5BEB5`.
- Editor capture: machine frame `1280`; 80-column GIME text,
captured as a 640 × 480 framebuffer.
Private build/run/input/capture/stop receipts supplied these identifiers. Raw logs,
access grants and machine-specific paths are intentionally excluded.
No claim is made for full application coverage, audible output, emulated HD6309,
Intel/Rosetta execution, physical Intel hardware or all supported macOS versions.
Binary file not shown.

After

Width:  |  Height:  |  Size: 7.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.4 KiB