mirror of
https://github.com/whscullin/apple2js.git
synced 2024-01-12 14:14:38 +00:00
910238bf63
* Convert `cards/disk2.js` to Typescript
This is mostly a straightforward conversion of `cards/disk2.js` to
Typescript, with the following exceptions:
* `setState()` did not restore the drive light state correctly
because the callback was called with the old `on` value.
* `setPhase()` did not work for WOZ images.
* `getBinary()` did not work for `nib` files.
* `getBase64()` did not work for `nib` files and maybe didn't work
right at all.
Even with these fixes, local storage still doesn't work correctly.
I have also added several TODOs where methods don't support WOZ disks.
* Convert most uses of `memory` to `Uint8Array`
There are many places in the existing code where we use `Uint8Array`
directly. This change merely makes the `memory` type equivalent to
`Uint8Array`.
This change also changes most ROM data to be read-only in Typescript
to ensure that it is not modified by mistake. This can't be done just
by applying `as const` to the declaration because `Uint8Array`s are
can not be expressed as literals. Instead, we create a new type,
`ReadonlyUint8Array` that drops the mutation methods and makes indexed
access read-only.
See
https://www.growingwiththeweb.com/2020/10/typescript-readonly-typed-arrays.html
for details.
* Tighten types and document `disk2.ts`
While trying to understand the Disk ][ emulation, I tighted the types
and documented the parts that I could, including references to other
sources, like _Understanding the Apple //e_ by Jim Sather.
The one functional change is the addition of the P6 ROM of DOS 3.2 and
earlier. This is automatically selected if the card is initialized for
13 sector disks.
82 lines
1.9 KiB
TypeScript
82 lines
1.9 KiB
TypeScript
|
|
/**
|
|
* Extracts the members of a constant array as a type. Used as:
|
|
*
|
|
* @example
|
|
* const SOME_VALUES = ['a', 'b', 1, 2] as const;
|
|
* type SomeValues = MemberOf<typeof SOME_VALUES>; // 'a' | 'b' | 1 | 2
|
|
*/
|
|
export type MemberOf<T extends ReadonlyArray<unknown>> =
|
|
T extends ReadonlyArray<infer E> ? E : never;
|
|
|
|
/** A bit. */
|
|
export type bit = 0 | 1;
|
|
|
|
/** A nibble. */
|
|
export type nibble =
|
|
0x0 | 0x1 | 0x2 | 0x3 | 0x4 | 0x5 | 0x6 | 0x7 |
|
|
0x8 | 0x9 | 0xa | 0xb | 0xc | 0xd | 0xe | 0xf;
|
|
|
|
/** A byte (0..255). This is not enforced by the compiler. */
|
|
export type byte = number;
|
|
|
|
/** A word (0..65535). This is not enforced by the compiler. */
|
|
export type word = number;
|
|
|
|
/** A raw region of memory. */
|
|
export type memory = Uint8Array;
|
|
|
|
/** A raw region of memory. */
|
|
export type rom = ReadonlyUint8Array;
|
|
|
|
/** A mapped region of memory. */
|
|
export interface Memory {
|
|
/** Start page. */
|
|
start(): byte;
|
|
/** End page, inclusive. */
|
|
end(): byte;
|
|
/** Read a byte. */
|
|
read(page: byte, offset: byte): byte;
|
|
/** Write a byte. */
|
|
write(page: byte, offset: byte, value: byte): void;
|
|
}
|
|
|
|
export const DISK_FORMATS = [
|
|
'2mg',
|
|
'd13',
|
|
'do',
|
|
'dsk',
|
|
'hdv',
|
|
'po',
|
|
'nib',
|
|
'woz'
|
|
] as const;
|
|
|
|
export type DiskFormat = MemberOf<typeof DISK_FORMATS>;
|
|
|
|
export interface Drive {
|
|
format: DiskFormat,
|
|
volume: number,
|
|
tracks: Array<byte[] | Uint8Array>,
|
|
trackMap: unknown,
|
|
}
|
|
|
|
export interface DiskIIDrive extends Drive {
|
|
rawTracks: unknown,
|
|
track: number,
|
|
head: number,
|
|
phase: number,
|
|
readOnly: boolean,
|
|
dirty: boolean,
|
|
}
|
|
|
|
export interface Restorable<T> {
|
|
getState(): T;
|
|
setState(state: T): void;
|
|
}
|
|
|
|
// Read-only typed arrays for constants
|
|
export type TypedArrayMutableProperties = 'copyWithin' | 'fill' | 'reverse' | 'set' | 'sort';
|
|
export interface ReadonlyUint8Array extends Omit<Uint8Array, TypedArrayMutableProperties> {
|
|
readonly [n: number]: number
|
|
} |