mbuhidar / retrotype Goto Github PK

Library of tools for typing-in, debugging, and converting 1980s magazine type-in games and programs.

License: MIT License

Python 54.07% BASIC 4.75% Assembly 41.18%

retrotype's Introduction

Hello, I'm Michael Buhidar

By profession, I'm a product development engineer working to develop construction machines, but I'm also working to learn software development using modern tools and languages. Currently focused on learning Python along with its surrounding ecosystem.

My primary projects relate to modernizing the experience of typing in Commodore 64 games from magazines popular in the 80's (throwback to my coding interests when I was in middle/high school). Using those projects mostly to learn by creating something to hone not only Python skills, but also learning/knowledge for C64 BASIC, Assembly, Pytest, Git, Github, releasing projects on PyPi, etc.

retrotype's People

Contributors

Stargazers

Watchers

retrotype's Issues

Add command line flag to turn off open bracket checking

Some program listings don't have equal open vs closed bracket count in all lines. The bracket checking feature prevents checksum determination for these lines. It is not clear if unclosed brackets are a syntax error in Commodore BASIC.

Split up ahoy_lines_list function into simpler elements

Improve return value for check_for_loose_braces() method for flexibility

Method currently returns None or the line number upon detection. Propose to have it return error text as string objects and have the main execution flow handle the program exit. This will provide more flexibility for interfaces besides cli.

Improve matching delimiter (brackets and braces) algorithm by using a stack and by adding an option flag too disable checking

Add rich formatting for CLI

Improve matching delimiter (brackets and braces) detection with algorithm using stacks and add option flag

Improve how loose brace errors are handled.

Currently, loose brace errors are detected in the ahoy_lines_list function. The way the error is handled is via return of None, making it inconsistent with the form returned when no error exists.

Add command line option flag to prevent writing binary .prg file for each run.

Refactor method line_number_sequence using next() function.

The next() function returns the next item from the iterator.

Checksums for ahoy1 source files not being generated properly

Checksums are not matching reference values for lines with spaces withing quotation marks. Look at handling of in/out of quotes in method for ahoy2. This was working in the prior releases as retro-typein-tools.

Add type hints as part of refactor to object oriented approach

Migrate existing code from retro-typein-tool repo to this project.

Improve check_line_number_seq function

Function currently prints error messages upon detection and exits. Propose to have it return error text as strings and have the main execution flow handle the program exit. This will provide more flexibility for interfaces besides cli.

Add reference code for bug repellent basic and decompiled asm.

Improve efficiency of _scan method in TokenizedLine class

Currently the method cycles through character maps for each token in each line. Not necessary based on max size of listings vs modern compute, but would like to improve the approach to this.

Refactor completely using object oriented approach to eliminate duplicate code accumulated via feature adds.

Good opportunities to reduce duplicate code themes via object oriented approach for some elements.

Refactor Checksums class to remove duplicate code

At a minimum, the calculation of the checksum letter codes for Ahoy is the same for all three Ahoy versions. Perhaps pull that out into another method in the class.

It may be better to create a class template that each Ahoy version can inherit with method overrides to reflect unique checksum calculation approaches between the versions of Bug Repellent.

Improve test coverage in retrotype_cli.py (see coverage report in description for missing coverage)

Notes (check via command sequence below for now - some day, add to ci):

$ coverage erase
$ coverage run -m pytest
$ coverage report -m

Name                             Stmts   Miss  Cover   Missing
--------------------------------------------------------------
src/retrotype/__init__.py            0      0   100%
src/retrotype/char_maps.py           6      0   100%
src/retrotype/retrotype_cli.py      78     12    85%   132-134, 139-140, 144-150, 156-157, 186-187, 220
src/retrotype/retrotype_lib.py     197      0   100%
tests/retrotype_cli_test.py         38      0   100%
tests/retrotype_lib_test.py         86      0   100%
--------------------------------------------------------------
TOTAL                              405     12    97%

Not yielding a matching checksum value for certain unique lines

For Ahoy November 1985 issue, the game Slither has a few unusual remark lines starting with a colon that are not in the program flow.
For lines that contain text corresponding to BASIC tokens, the checksum values produced by the app do not match those printed in the magazine. Examples below:

999 : * ML DATA *
1099 : * CHARACTER DATA *
3099 : * COORDINATE DATA *

Tried a fix by using a leading colon character to set the remark flag to True to prevent tokenizing the BASIC token text in the line. This didn't fix the issue.