PythonExtra/README.md

# PythonExtra - A community MicroPython for CASIO calculators

*Original MicroPython README: [`README-MicroPython.md`](README-MicroPython.md).*

This is a MicroPython port for fx-CG 50, fx-9860G III and related CASIO calculators.

**Build instructions**

Requires the [fxSDK](/Lephenixnoir/fxsdk). Go to `ports/fxcg50` or `ports/fx9860g3` and run `make`. If it doesn't build, first try to use the `dev` branches for [fxSDK](/Lephenixnoir/fxSDK), [gint](/Lephenixnoir/gint), [fxlibc](/Lephenixnoir/fxlib) and [JustUI](/Lephenixnoir/JustUI). Rebuilds don't always work especially when checking out other commits (maybe my fault), so try to delete `build` if you think that's related.

Most of the code is in `ports/sh` and is shared between the platforms.

---

**TODO list**

Bugs to fix:
- Fix not world switching during filesystem accesses (very unstable)
- Fix the console not garbage collecting its lines (enable and test the feature)
- Fix not resetting the shell when importing a file from command-line
- Fix current working directory not changing during a module import (for
  relative imports)
- Fix accumulated events being processed when the program "ends" (if we can
  detect that)

Python features:
- Compare features with existing implementations and other brands
- Get filesystem access (open etc) with the POSIX interface
- Get a decent amount of RAM not just the fixed 32 kiB that's hardcoded so far

UI:
- Better input system in the shell (don't use VT-100 escapes, then move cursor
  and handle history)
- Add an option for fixed-width font which also sets $COLUMNS properly so that
  MicroPython paginates (requires better getenv/setenv support in fxlib)
- Use [unicode-fonts](/Lephenixnoir/unicode-fonts) to provide Unicode support
  * Extend it with a fixed-width uf8x9 which maybe changes some glyphs (like
    `i` and `l`; the usual fixed-width unambiguous styles)
  * Try and provide a font smaller than 5x7 for more compact shell on mono
- A decent keymap that can input all relevant characters into the shell

Test cases:
- [x] Chute tridimensionnelle (Working on G35+eII)
- [ ] Bad Apple
- [ ] Island of the Dead Kings
- [ ] Synchro-Donjon
- [x] Flappy bird (Working on G35+eII)

Future wishes:
- Build for fx-9860G II (requires manual filesystem support)
- Lephe's secret ideas (complete previous list to unlock)
meta: README file with basic TODO list 2022-10-29 20:56:10 +02:00			`# PythonExtra - A community MicroPython for CASIO calculators`

			Original MicroPython README: [`README-MicroPython.md`](README-MicroPython.md).

			`This is a MicroPython port for fx-CG 50, fx-9860G III and related CASIO calculators.`

meta: basic build instructions 2022-10-30 11:07:33 +01:00			`Build instructions`

pe: debugging tools 2022-11-10 22:35:41 +01:00			Requires the [fxSDK](/Lephenixnoir/fxsdk). Go to `ports/fxcg50` or `ports/fx9860g3` and run `make`. If it doesn't build, first try to use the `dev` branches for [fxSDK](/Lephenixnoir/fxSDK), [gint](/Lephenixnoir/gint), [fxlibc](/Lephenixnoir/fxlib) and [JustUI](/Lephenixnoir/JustUI). Rebuilds don't always work especially when checking out other commits (maybe my fault), so try to delete `build` if you think that's related.
meta: basic build instructions 2022-10-30 11:07:33 +01:00
			Most of the code is in `ports/sh` and is shared between the platforms.

meta: README file with basic TODO list 2022-10-29 20:56:10 +02:00			`---`

			`TODO list`

			`Bugs to fix:`
			`- Fix not world switching during filesystem accesses (very unstable)`
pe: enable the time module Based on the UNIX port version, and extmod/utime_mphal.c. 2022-10-30 18:36:22 +01:00			`- Fix the console not garbage collecting its lines (enable and test the feature)`
pe: fix clear_screeb typo in modcasioplot 2022-11-09 13:57:13 +01:00			`- Fix not resetting the shell when importing a file from command-line`
ports/sh: start adding decent memory on fx-CG 50 (~ 350 kB) 2022-11-10 23:02:20 +01:00			`- Fix current working directory not changing during a module import (for`
			`relative imports)`
ports/sh: fix AC/ON locking after some time The Python program being run is in charge of keyboard events with the gint module. Most programs don't care though, and simply let events accumulate until the queue is full. The async filter is able to receive events even when the queue is full. However, it filtered only AC/ON presses, not releases, so the releases were sent back to the driver to queue. This was impossible as the queue was full, so the release was never recorded. This failure then repeated at every tick, forever. Since the key was never properly released, further presses were just seen as a continuation of the current press and thus did not produce any new event, so the async filter was no longer called and the Python program could no longer be interrupted. 2022-12-04 14:42:32 +01:00			`- Fix accumulated events being processed when the program "ends" (if we can`
			`detect that)`
meta: README file with basic TODO list 2022-10-29 20:56:10 +02:00
			`Python features:`
			`- Compare features with existing implementations and other brands`
			`- Get filesystem access (open etc) with the POSIX interface`
			`- Get a decent amount of RAM not just the fixed 32 kiB that's hardcoded so far`

			`UI:`
pe: fix clear_screeb typo in modcasioplot 2022-11-09 13:57:13 +01:00			`- Better input system in the shell (don't use VT-100 escapes, then move cursor`
			`and handle history)`
meta: README file with basic TODO list 2022-10-29 20:56:10 +02:00			`- Add an option for fixed-width font which also sets $COLUMNS properly so that`
			`MicroPython paginates (requires better getenv/setenv support in fxlib)`
			`- Use [unicode-fonts](/Lephenixnoir/unicode-fonts) to provide Unicode support`
			`* Extend it with a fixed-width uf8x9 which maybe changes some glyphs (like`
			`i` and `l`; the usual fixed-width unambiguous styles)
			`* Try and provide a font smaller than 5x7 for more compact shell on mono`
meta: cleanup 2022-10-29 21:48:01 +02:00			`- A decent keymap that can input all relevant characters into the shell`
meta: README file with basic TODO list 2022-10-29 20:56:10 +02:00
pe: casioplot: make the final argument of draw_string() optional (note: it is currently ignored even when specified) 2022-11-09 21:21:07 +01:00			`Test cases:`
Added python ram in a dirty way 2022-11-23 13:56:48 +01:00			`- [x] Chute tridimensionnelle (Working on G35+eII)`
pe: casioplot: make the final argument of draw_string() optional (note: it is currently ignored even when specified) 2022-11-09 21:21:07 +01:00			`- [ ] Bad Apple`
			`- [ ] Island of the Dead Kings`
			`- [ ] Synchro-Donjon`
1 more test. 2022-11-23 16:27:27 +01:00			`- [x] Flappy bird (Working on G35+eII)`
pe: casioplot: make the final argument of draw_string() optional (note: it is currently ignored even when specified) 2022-11-09 21:21:07 +01:00
meta: README file with basic TODO list 2022-10-29 20:56:10 +02:00			`Future wishes:`
			`- Build for fx-9860G II (requires manual filesystem support)`
			`- Lephe's secret ideas (complete previous list to unlock)`