Elfos-kilo

A full screen editor for the Elf/OS written in 1802 Assembly language and based loosely on the Kilo editor by Salvatore Sanfilippo aka antirez and the Elfos-Edit editor by Mike Riley.

Platform

The Elf/OS kilo editor was written for an 1802 based Microcomputer running the Elf/OS operating system, such as the Pico/Elf by Mike Riley or the 1802-Mini by David Madole or the AVI Elf II by Ed Keefe. A lot of information and software for the Pico/Elf, the 1802-Mini and the AVI Elf II can be found on the Elf-Emulation website and in the COSMAC ELF Group at groups.io.

The Elf/OS kilo editor were assembled and linked with updated versions of the Asm-02 assembler and Link-02 linker by Mike Riley. The updated versions required to assemble and link this code are available at fourstix/Asm-02 and fourstix/Link-02.

Elf/OS Kilo Commands

Keys	Command
Ctrl+B, Home	Move to the Beginning of line
Ctrl+C	Copy line to clip board
Ctrl+D, Down	Move cursor Down
Ctrl+E, End	Move to End of line
Ctrl+F	Find text
Ctrl+G	Go to line number
Ctrl+H, Backspace	Move back and delete character
Ctrl+I, Tab	Move forward to next tab stop
Ctrl+J	Join lines
Ctrl+K, Delete	Delete (Kill) character
Ctrl+L, Left	Move cursor Left
Ctrl+M, Enter	Insert Mode: insert new line or split at cursor
Ctrl+M, Enter	Overwrite Mode: Move down to the next line.
Ctrl+N, PgDn	Next screen
Ctrl+O, Insert	Toggle Overwrite/insert Mode screen
Ctrl+P, PgUp	Previous screen
Ctrl+Q	Quit, confirm if file changed
Ctrl+R, Right	Move cursor Right
Ctrl+S	Save file
Ctrl+T	Move to Top of file
Ctrl+U, Up	Move cursor Up
Ctrl+V	Paste line from clip board
Ctrl+W	show Where cursor is located in file
Ctrl+X	Cut line into clip board
Ctrl+Y	Save As new file
Ctrl+Z	Move to bottom of file
Ctrl+], Shift+Tab	Move back to previous tab stop
Ctrl+\	Split line at cursor
Ctrl+?	Show help information
Ctrl+_ (See Note)	Show help information

Note: On older DEC video terminals the Ctrl+_ key combination replaces the Ctrl+? combination key for help. Some emulators may support one or the other or both.

Elf/OS Kilo Modes

Insert Mode
- Characters are inserted into the text
- Enter inserts a new line at the beginning or end of a line
- Enter splits a line at the cursor inside a line
- Delete at the end of a line joins the current line with next line
- Backspace at the beginning of an empty line deletes the line
- Split (Ctrl-\) can also be used to insert lines or split a line
- Join (Ctrl-J) can also be used to join lines
Overwrite Mode
- Characters overwrite existing characters in the text
- Enter moves down to the beginning of the next line
- Delete and backspace do not delete empty lines automatically
- Use Split (Ctrl-\) at the beginning or end of a line to insert an empty line
- Use Split (Ctrl-\) to explicitly split a line at the cursor inside a line
- Use Join (Ctrl-J) to explicitly join lines
- Use Cut (Ctrl-X) to delete a line (and copy into the clip board)

Copy, Cut & Paste

Use Copy (Ctrl-C) to copy a line into the clip board
Use Cut (Ctrl-X) to delete a line and copy into the clip board
Use Paste (Ctrl-V) to paste a line from the clip board and insert above the current line

Text Limits

Lines can have up to 124 characters per line
Tabs are defined as 4 character tab stops (1, 5, 9, etc.)

File Limits

Buffers are used to edit files larger than 96 lines
Each buffer has up to 96 lines
A file can have up to 255 buffers, or 24,498 lines
Buffers are saved to temporary spill files, while the file is edited
Spill files are created automatically when a large file is loaded
Spill files are named __kilo.nn, where nn is the 2 digit hex value of their index
Spill files are deleted automatically when the application ends

Key Character Sequences

These key character sequences follow the VT102 terminal specification. In the table below, {ESC} is the Escape control character, ASCII 27, hex value $1B. Should one of these keys not behave as expected, you may need to configure your terminal program to return the expected key character sequence. Note that the Delete key can have either one of two possible sequences.

Key	Character Sequence
Up (Arrow)	{ESC}[A
Up (Arrow)	{ESC}A (See Note)
Down (Arrow)	{ESC}[B
Down (Arrow)	{ESC}B (See Note)
Right (Arrow)	{ESC}[C
Right (Arrow)	{ESC}C (See Note)
Left (Arrow)	{ESC}[D
Left (Arrow)	{ESC}D (See Note)
Home	{ESC}[1~
Insert	{ESC}[2~
Delete	{ESC}[3~
Delete	DEL ($7F)
End	{ESC}[4~
PgUp	{ESC}[5~
PgDn	{ESC}[6~
Backspace	Ctrl+H ($08)
Tab	Ctrl+I ($09)
Shift+Tab	{ESC}[Z
Enter	Ctrl+M ($0D)

Note: On some older DEC video terminals, the arrow keys send {ESC}A through {ESC}D instead of the ANSI sequences {ESC}[A through {ESC}[D.

Repository Contents

/src/ -- Source files for the Elf/OS kilo editor.
- kilo.asm - Main assembly source file.
- kilo_file.asm - Assembly source file for file routines.
- kilo_util.asm - Assembly source file for utility routines.
- kilo_keys.asm - Assembly source file for key handler routines.
- build.bat - Windows batch file to assemble and create the Elf/OS kilo editor.
- clean.bat - Windows batch file to delete the executable and the associated build files.
/src/include/ -- Include files for the graphics display programs and their libraries.
- kilo_def.inc - Definitions for Elf/OS kilo source files.
- ops.inc - Opcode definitions for Asm/02.
- bios.inc - Bios definitions from Elf/OS
- kernel.inc - Kernel definitions from Elf/OS
/bin/ -- Binary files for Elf/OS kilo editor.
- kilo.elfos - Elf/OS binary file for the Elf/OS kilo editor

References

License Information

This code is public domain under the MIT License, but please buy me a beverage if you use this and we meet someday (Beerware).

References to any products, programs or services do not imply that they will be available in all countries in which their respective owner operates.

Any company, product, or services names may be trademarks or services marks of others.

All libraries used in this code are copyright their respective authors.

This code is based on a Elf/OS kernel written by Mike Riley and created with the Asm/02 assembler and Link/02 linker also written by Mike Riley.

Many thanks to the original authors for making their designs and code available as open source.

This code, firmware, and software is released under the MIT License.

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

fourstix / Elfos-kilo

readme