systemless 0.105.1

High-Level Emulation for classic Macintosh applications
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
//! Typed low-memory accessor dispatch for PowerPC imports.

use super::*;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PpcLowMemoryAccessor {
    /// LMGetROM85: the ROM85 word at $028E.
    GetRom85,
    GetDoubleTime,
    GetFsFcbLen,
    GetGzMoveHnd,
    GetGzRootHnd,
    GetTheMenu,
    /// LMSetCursorNew: the CrsrNew byte at $08CE.
    SetCursorNew,
    /// LMSetMouseTemp: the MTemp Point at $0828.
    SetMouseTemp,
    /// LMSetRawMouseLocation: the RawMouse Point at $082C.
    SetRawMouseLocation,
}

pub(super) struct PpcLowMemoryDispatchContext<'a> {
    pub(super) target: &'a PpcImportDispatcherTarget,
    pub(super) cpu: &'a PpcCpu,
    pub(super) memory: &'a mut PpcSectionMem,
    pub(super) current_menu_list: u32,
    pub(super) default_dir_id: u32,
}

pub(super) fn dispatch_low_memory_import(
    context: PpcLowMemoryDispatchContext<'_>,
) -> Option<PpcImportAction> {
    let PpcLowMemoryDispatchContext {
        target,
        cpu,
        memory,
        current_menu_list,
        default_dir_id,
    } = context;
    match target {
        PpcImportDispatcherTarget::LowMemoryAccessor(accessor) => {
            // LowMem.h: plain accessors for the named low-memory globals.
            // The mouse globals feed the cursor task and are refreshed from
            // the host mouse with each input snapshot.
            use crate::memory::globals::addr;
            let written = match accessor {
                PpcLowMemoryAccessor::GetRom85 => {
                    return Some(
                        memory
                            .read_u16_be(addr::ROM85)
                            .map_or(PpcImportAction::Halt, |value| {
                                PpcImportAction::Return(ppc_i16_result(value as i16))
                            }),
                    );
                }
                PpcLowMemoryAccessor::GetDoubleTime
                | PpcLowMemoryAccessor::GetGzMoveHnd
                | PpcLowMemoryAccessor::GetGzRootHnd => {
                    let address = match accessor {
                        PpcLowMemoryAccessor::GetDoubleTime => addr::DOUBLE_TIME,
                        PpcLowMemoryAccessor::GetGzMoveHnd => addr::GZ_MOVE_HND,
                        PpcLowMemoryAccessor::GetGzRootHnd => addr::GZ_ROOT_HND,
                        _ => unreachable!(),
                    };
                    return Some(
                        memory
                            .read_u32_be(address)
                            .map_or(PpcImportAction::Halt, PpcImportAction::Return),
                    );
                }
                PpcLowMemoryAccessor::GetFsFcbLen | PpcLowMemoryAccessor::GetTheMenu => {
                    let address = if *accessor == PpcLowMemoryAccessor::GetFsFcbLen {
                        addr::FS_FCB_LEN
                    } else {
                        addr::THE_MENU
                    };
                    return Some(
                        memory
                            .read_u16_be(address)
                            .map_or(PpcImportAction::Halt, |value| {
                                PpcImportAction::Return(ppc_i16_result(value as i16))
                            }),
                    );
                }
                PpcLowMemoryAccessor::SetCursorNew => {
                    memory.write_u8(addr::CRSR_NEW, cpu.gpr[3] as u8)
                }
                PpcLowMemoryAccessor::SetMouseTemp => memory.write_u32_be(addr::M_TEMP, cpu.gpr[3]),
                PpcLowMemoryAccessor::SetRawMouseLocation => {
                    memory.write_u32_be(addr::MOUSE_LOC, cpu.gpr[3])
                }
            };
            Some(written.map_or(PpcImportAction::Halt, |_| PpcImportAction::ReturnPreserve))
        }
        PpcImportDispatcherTarget::LMGetKeyThresh
        | PpcImportDispatcherTarget::LMGetKeyRepThresh => {
            // Events.h: these accessors return SInt16 values in ticks.
            // Read the shared word on every call so guest writes are visible.
            let address = if *target == PpcImportDispatcherTarget::LMGetKeyThresh {
                crate::memory::globals::addr::KEY_THRESH
            } else {
                crate::memory::globals::addr::KEY_REP_THRESH
            };
            Some(
                memory
                    .read_u16_be(address)
                    .map_or(PpcImportAction::Halt, |value| {
                        PpcImportAction::Return(ppc_i16_result(value as i16))
                    }),
            )
        }
        PpcImportDispatcherTarget::LMSetKeyThresh
        | PpcImportDispatcherTarget::LMSetKeyRepThresh => {
            let address = if *target == PpcImportDispatcherTarget::LMSetKeyThresh {
                crate::memory::globals::addr::KEY_THRESH
            } else {
                crate::memory::globals::addr::KEY_REP_THRESH
            };
            Some(
                memory
                    .write_u16_be(address, cpu.gpr[3] as u16)
                    .map_or(PpcImportAction::Halt, |_| PpcImportAction::ReturnPreserve),
            )
        }
        PpcImportDispatcherTarget::LMGetHiliteRGB
        | PpcImportDispatcherTarget::LMSetHiliteRGB => {
            // Apple QuickDraw.h: void accessors copy an RGBColor through r3.
            // HiliteRGB is the six-byte system preference at $0DA0, distinct
            // from the per-port override installed by HiliteColor.
            let global = crate::memory::globals::addr::HILITE_RGB;
            let (source, destination) = if *target == PpcImportDispatcherTarget::LMGetHiliteRGB {
                (global, cpu.gpr[3])
            } else {
                (cpu.gpr[3], global)
            };
            if !ppc_memory_can_read_bytes(memory, source, 6)
                || !ppc_memory_can_write_bytes(memory, destination, 6)
            {
                return Some(PpcImportAction::Halt);
            }
            let mut color = [0; 6];
            let copied = memory.read_bytes_into(source, &mut color).is_some()
                && memory.write_bytes(destination, &color).is_some();
            Some(if copied {
                PpcImportAction::ReturnPreserve
            } else {
                PpcImportAction::Halt
            })
        }
        PpcImportDispatcherTarget::LMGetGhostWindow => Some(PpcImportAction::Return(
            memory.read_u32_be(crate::memory::globals::addr::GHOST_WINDOW).unwrap_or(0),
        )),
        PpcImportDispatcherTarget::LMGetMenuList => {
            Some(PpcImportAction::Return(current_menu_list))
        }
        PpcImportDispatcherTarget::LMSetMenuHook => {
            // Inside Macintosh Volume III (1985), low-memory globals:
            // MenuHook at $A30 is the callback address used by MenuSelect.
            let _ = memory.write_u32_be(0x0a30, cpu.gpr[3]);
            Some(PpcImportAction::ReturnPreserve)
        }
        PpcImportDispatcherTarget::LMSetCurActivate => {
            // CurActivate is the pointer to the window awaiting an activate
            // event. Inside Macintosh Volume I (1985), I-280; Volume III,
            // low-memory globals, $A64.
            let _ = memory.write_u32_be(crate::memory::globals::addr::CUR_ACTIVATE, cpu.gpr[3]);
            Some(PpcImportAction::ReturnPreserve)
        }
        PpcImportDispatcherTarget::LMGetCurDeactive => Some(PpcImportAction::Return(
            memory
                .read_u32_be(crate::memory::globals::addr::CUR_DEACTIVE)
                .unwrap_or(0),
        )),
        PpcImportDispatcherTarget::LMSetCurDeactive => {
            let _ = memory.write_u32_be(crate::memory::globals::addr::CUR_DEACTIVE, cpu.gpr[3]);
            Some(PpcImportAction::ReturnPreserve)
        }
        PpcImportDispatcherTarget::LMGetMenuFlash => Some(PpcImportAction::Return(ppc_i16_result(
            memory
                .read_u16_be(crate::memory::globals::addr::MENU_FLASH)
                .unwrap_or(crate::memory::globals::DEFAULT_MENU_FLASH_COUNT) as i16,
        ))),
        PpcImportDispatcherTarget::LMGetPaintWhite => Some(PpcImportAction::Return(u32::from(
            memory.read_u16_be(0x09dc).unwrap_or(1) != 0,
        ))),
        PpcImportDispatcherTarget::LMGetHWCfgFlags => Some(PpcImportAction::Return(
            // Apple Technical Note PT09 identifies HwCfgFlgs as a signed
            // low-memory word at $0B22.
            ppc_i16_result(memory.read_u16_be(0x0b22).unwrap_or(0) as i16),
        )),
        PpcImportDispatcherTarget::LMSetROMMapInsert => {
            // RomMapInsert is a byte global at $0B9E. The Resource Manager
            // consumes it on the next resource lookup.
            let _ = memory.write_u8(0x0b9e, cpu.gpr[3] as u8);
            Some(PpcImportAction::ReturnPreserve)
        }
        PpcImportDispatcherTarget::LMGetSysMap => {
            // LowMem.h: LMGetSysMap returns the signed reference number of
            // the System file's resource map. The HLE resource chain uses
            // refnum 0 as its system/application fallback map.
            Some(PpcImportAction::Return(ppc_i16_result(0)))
        }
        PpcImportDispatcherTarget::LMGetBootDrive => {
            // LowMem.h: LMGetBootDrive returns the SInt16 BootDrive word at
            // $0210, the reference number of the startup volume.
            Some(PpcImportAction::Return(ppc_i16_result(
                memory
                    .read_u16_be(crate::memory::globals::addr::BOOT_DRIVE)
                    .unwrap_or(0) as i16,
            )))
        }
        PpcImportDispatcherTarget::LMSetBootDrive => Some(
            memory
                .write_u16_be(crate::memory::globals::addr::BOOT_DRIVE, cpu.gpr[3] as u16)
                .map_or(PpcImportAction::Halt, |_| PpcImportAction::ReturnPreserve),
        ),
        PpcImportDispatcherTarget::LMGetCurApRefNum => {
            // Inside Macintosh Volume II (1985), II-58: CurApRefNum is the
            // reference number of the current application's resource file.
            Some(PpcImportAction::Return(ppc_i16_result(
                memory
                    .read_u16_be(crate::memory::globals::addr::CUR_APREF_NUM)
                    .unwrap_or(0) as i16,
            )))
        }
        PpcImportDispatcherTarget::GetVCBQHdr => {
            // Inside Macintosh Volume II (1985), II-126: GetVCBQHdr returns
            // a pointer to the volume-control-block queue header.
            Some(PpcImportAction::Return(
                crate::memory::globals::addr::VCB_Q_HDR,
            ))
        }
        PpcImportDispatcherTarget::GetDrvQHdr => {
            // Inside Macintosh: Files (1992), 2-236: GetDrvQHdr returns
            // the address of the drive queue header in low memory.
            Some(PpcImportAction::Return(
                crate::memory::globals::addr::DRV_Q_HDR,
            ))
        }
        PpcImportDispatcherTarget::LMGetSysEvtMask => Some(PpcImportAction::Return(
            u32::from(memory.read_u16_be(crate::memory::globals::addr::SYS_EVT_MASK)
                .unwrap_or(crate::memory::globals::DEFAULT_SYS_EVT_MASK)),
        )),
        PpcImportDispatcherTarget::LMSetSysEvtMask => {
            let _ = memory.write_u16_be(
                crate::memory::globals::addr::SYS_EVT_MASK, cpu.gpr[3] as u16,
            );
            Some(PpcImportAction::ReturnPreserve)
        }
        PpcImportDispatcherTarget::LMGetDefltStack => Some(PpcImportAction::Return(
            // Inside Macintosh Volume II (1985), II-17 and II-51:
            // DefltStack is the long default stack-space allotment.
            memory
                .read_u32_be(crate::memory::globals::addr::DEFLT_STACK)
                .unwrap_or(crate::memory::globals::DEFAULT_DEFLT_STACK_SIZE),
        )),
        PpcImportDispatcherTarget::LMGetCurStackBase => Some(PpcImportAction::Return(
            // Inside Macintosh Volume II (1985), II-51: CurStackBase is the
            // address of the stack base and start of application globals.
            memory
                .read_u32_be(crate::memory::globals::addr::CUR_STACK_BASE)
                .unwrap_or(PPC_STACK_BASE),
        )),
        PpcImportDispatcherTarget::LMSetPaintWhite => {
            let _ = memory.write_u16_be(0x09dc, u16::from(cpu.gpr[3] != 0));
            Some(PpcImportAction::ReturnPreserve)
        }
        PpcImportDispatcherTarget::LMSetResumeProc => {
            let resume_proc = crate::dialog_manager::evaluate_set_resume_proc(cpu.gpr[3]);
            let _ = memory.write_u32_be(crate::memory::globals::addr::RESUME_PROC, resume_proc);
            Some(PpcImportAction::ReturnPreserve)
        }
        PpcImportDispatcherTarget::LMGetResumeProc => {
            let raw_proc = memory
                .read_u32_be(crate::memory::globals::addr::RESUME_PROC)
                .unwrap_or(0);
            let resume_proc = crate::dialog_manager::evaluate_get_resume_proc(raw_proc);
            Some(PpcImportAction::Return(resume_proc))
        }
        PpcImportDispatcherTarget::LMSetACount => {
            let stage = crate::dialog_manager::evaluate_set_alert_stage(cpu.gpr[3] as u16 as i16);
            let _ =
                memory.write_u16_be(crate::memory::globals::addr::ALERT_STAGE, stage);
            Some(PpcImportAction::ReturnPreserve)
        }
        PpcImportDispatcherTarget::LMGetACount => {
            let raw_stage = memory
                .read_u16_be(crate::memory::globals::addr::ALERT_STAGE)
                .unwrap_or(0);
            let stage = crate::dialog_manager::evaluate_get_alert_stage(raw_stage);
            Some(PpcImportAction::Return(ppc_i16_result(stage)))
        }
        PpcImportDispatcherTarget::LMSetANumber => {
            let anumber = crate::dialog_manager::evaluate_set_anumber(cpu.gpr[3] as u16 as i16);
            let _ = memory.write_u16_be(crate::memory::globals::addr::ANUMBER, anumber);
            Some(PpcImportAction::ReturnPreserve)
        }
        PpcImportDispatcherTarget::LMGetANumber => {
            let raw_anumber = memory
                .read_u16_be(crate::memory::globals::addr::ANUMBER)
                .unwrap_or(0);
            let anumber = crate::dialog_manager::evaluate_get_anumber(raw_anumber);
            Some(PpcImportAction::Return(ppc_i16_result(anumber)))
        }
        PpcImportDispatcherTarget::LMSetDABeeper => {
            let sound_proc = crate::dialog_manager::evaluate_set_da_beeper(cpu.gpr[3]);
            let _ = memory.write_u32_be(crate::memory::globals::addr::DA_BEEPER, sound_proc);
            Some(PpcImportAction::ReturnPreserve)
        }
        PpcImportDispatcherTarget::LMGetDABeeper => {
            let raw_beeper = memory
                .read_u32_be(crate::memory::globals::addr::DA_BEEPER)
                .unwrap_or(0);
            let sound_proc = crate::dialog_manager::evaluate_get_da_beeper(raw_beeper);
            Some(PpcImportAction::Return(sound_proc))
        }
        PpcImportDispatcherTarget::LMGetDAStrings => {
            let addr = crate::dialog_manager::evaluate_get_da_strings_addr();
            Some(PpcImportAction::Return(addr))
        }
        PpcImportDispatcherTarget::LMSetDlgFont => {
            let params = crate::dialog_manager::evaluate_set_dialog_font_parameters(
                cpu.gpr[3] as u16 as i16,
            );
            let _ = memory.write_u16_be(
                crate::memory::globals::addr::DLG_FONT,
                params.font_num() as u16,
            );
            Some(PpcImportAction::ReturnPreserve)
        }
        PpcImportDispatcherTarget::LMGetDlgFont => {
            let raw_font = memory
                .read_u16_be(crate::memory::globals::addr::DLG_FONT)
                .unwrap_or(0);
            let font = crate::dialog_manager::evaluate_dialog_font(raw_font);
            Some(PpcImportAction::Return(ppc_i16_result(font)))
        }
        PpcImportDispatcherTarget::SetMenuFlash => {
            // Macintosh Toolbox Essentials (1992), p. 3-142: SetMenuFlash
            // stores the selected-menu blink count in the MenuFlash global.
            let _ =
                memory.write_u16_be(crate::memory::globals::addr::MENU_FLASH, cpu.gpr[3] as u16);
            Some(PpcImportAction::ReturnPreserve)
        }
        PpcImportDispatcherTarget::GetGrayRgn => Some(PpcImportAction::Return(
            memory
                .read_u32_be(PPC_GRAY_RGN_ADDR)
                .unwrap_or(PPC_GRAY_RGN_HANDLE),
        )),
        PpcImportDispatcherTarget::LMSetGrayRgn => {
            // Macintosh Toolbox Essentials (1992), p. 4-113: GrayRgn is the
            // low-memory handle to the current desktop region.
            let _ = memory.write_u32_be(PPC_GRAY_RGN_ADDR, cpu.gpr[3]);
            Some(PpcImportAction::ReturnPreserve)
        }
        PpcImportDispatcherTarget::LMGetUTableBase => {
            // Inside Macintosh: Devices (1994), pp. 1-8--1-9: UTableBase
            // points to an array of DCE handles, with the Sound Driver at
            // unit 3 (reference number -4).
            Some(PpcImportAction::Return(PPC_UNIT_TABLE))
        }
        PpcImportDispatcherTarget::LMGetCurDirStore => {
            // Inside Macintosh: PowerPC System Software (1994), p. 1-57:
            // LMGetCurDirStore returns the CurDirStore directory ID at $0398.
            Some(PpcImportAction::Return(
                memory
                    .read_u32_be(crate::memory::globals::addr::CUR_DIR_STORE)
                    .unwrap_or(default_dir_id),
            ))
        }
        PpcImportDispatcherTarget::LMSetCurDirStore => {
            // Inside Macintosh: PowerPC System Software (1994), p. 1-57:
            // LMSetCurDirStore sets the CurDirStore directory ID at $0398.
            let _ = memory.write_u32_be(crate::memory::globals::addr::CUR_DIR_STORE, cpu.gpr[3]);
            Some(PpcImportAction::ReturnPreserve)
        }
        PpcImportDispatcherTarget::LMGetSFSaveDisk => {
            // Inside Macintosh: Files (1992), p. 3-65: SFSaveDisk is the
            // signed word at $0214 containing the negative volume refnum.
            Some(PpcImportAction::Return(ppc_i16_result(
                memory
                    .read_u16_be(crate::memory::globals::addr::SF_SAVE_DISK)
                    .unwrap_or_default() as i16,
            )))
        }
        PpcImportDispatcherTarget::LMSetSFSaveDisk => {
            // Inside Macintosh: Files (1992), p. 3-65: SFSaveDisk is the
            // signed word at $0214 containing the negative volume refnum.
            let _ = memory.write_u16_be(
                crate::memory::globals::addr::SF_SAVE_DISK,
                cpu.gpr[3] as u16,
            );
            Some(PpcImportAction::ReturnPreserve)
        }
        PpcImportDispatcherTarget::LMGetHiliteMode => Some(
            memory
                .read_u8(crate::memory::globals::addr::HILITE_MODE)
                .map_or(PpcImportAction::Halt, |value| {
                    PpcImportAction::Return(u32::from(value))
                }),
        ),
        PpcImportDispatcherTarget::LMSetHiliteMode => Some(
            memory
                .write_u8(crate::memory::globals::addr::HILITE_MODE, cpu.gpr[3] as u8)
                .map_or(PpcImportAction::Halt, |_| PpcImportAction::ReturnPreserve),
        ),
        PpcImportDispatcherTarget::LMGetRndSeed => Some(PpcImportAction::Return(
            memory.read_u32_be(PPC_RAND_SEED_ADDR).unwrap_or(1),
        )),
        PpcImportDispatcherTarget::LMGetCrsrBusy => {
            // CrsrBusy is true only while the system is changing the cursor.
            // No asynchronous cursor operation is active in this HLE.
            // Inside Macintosh: Processes (1994), 4-18.
            Some(PpcImportAction::Return(0))
        }
        PpcImportDispatcherTarget::LMSetRndSeed => {
            // Inside Macintosh: Memory (1992), pp. 2-6--2-8: RndSeed is the
            // 32-bit random-number seed low-memory global at $0156.
            let _ = memory.write_u32_be(PPC_RAND_SEED_ADDR, cpu.gpr[3]);
            Some(PpcImportAction::ReturnPreserve)
        }
        PpcImportDispatcherTarget::SetCurrentA5
        | PpcImportDispatcherTarget::SetA5
        | PpcImportDispatcherTarget::LMGetCurrentA5 => {
            // Native PowerPC code has no architectural A5 register. These
            // compatibility routes expose the synthetic mini-A5 world used
            // when native glue brackets a legacy callback.
            Some(PpcImportAction::Return(PPC_DATA_BASE))
        }
        _ => None,
    }
}