ui_zx.h

#pragma once
/*#
    # ui_zx.h

    Integrated debugging UI for zx.h

    Do this:
    ~~~C
    #define CHIPS_UI_IMPL
    ~~~
    before you include this file in *one* C++ file to create the
    implementation.

    Optionally provide the following macros with your own implementation

    ~~~C
    CHIPS_ASSERT(c)
    ~~~
        your own assert macro (default: assert(c))

    Include the following headers (and their depenencies) before including
    ui_zx.h both for the declaration and implementation.

    - zx.h
    - mem.h
    - ui_chip.h
    - ui_util.h
    - ui_settings.h
    - ui_z80.h
    - ui_ay38910.h
    - ui_audio.h
    - ui_display.h
    - ui_kbd.h
    - ui_dasm.h
    - ui_dbg.h
    - ui_memedit.h
    - ui_memmap.h

    ## zlib/libpng license

    Copyright (c) 2018 Andre Weissflog
    This software is provided 'as-is', without any express or implied warranty.
    In no event will the authors be held liable for any damages arising from the
    use of this software.
    Permission is granted to anyone to use this software for any purpose,
    including commercial applications, and to alter it and redistribute it
    freely, subject to the following restrictions:
        1. The origin of this software must not be misrepresented; you must not
        claim that you wrote the original software. If you use this software in a
        product, an acknowledgment in the product documentation would be
        appreciated but is not required.
        2. Altered source versions must be plainly marked as such, and must not
        be misrepresented as being the original software.
        3. This notice may not be removed or altered from any source
        distribution.
#*/
#include <stdint.h>
#include <stdbool.h>

#ifdef __cplusplus
extern "C" {
#endif

// general callback type for rebooting to different configs
typedef void (*ui_zx_boot_t)(zx_t* sys, zx_type_t type);

typedef struct {
    zx_t* zx;
    ui_zx_boot_t boot_cb; // user-provided callback to reboot to different config
    ui_dbg_texture_callbacks_t dbg_texture; // user-provided texture create/update/destroy callbacks
    ui_dbg_keys_desc_t dbg_keys;            // user-defined hotkeys for ui_dbg_t
    ui_snapshot_desc_t snapshot;            // snapshot system creation params
} ui_zx_desc_t;

typedef struct {
    zx_t* zx;
    ui_zx_boot_t boot_cb;
    ui_z80_t cpu;
    ui_ay38910_t ay;
    ui_audio_t audio;
    ui_display_t display;
    ui_kbd_t kbd;
    ui_memmap_t memmap;
    ui_memedit_t memedit[4];
    ui_dasm_t dasm[4];
    ui_dbg_t dbg;
    ui_snapshot_t snapshot;
} ui_zx_t;

typedef struct {
    ui_display_frame_t display;
} ui_zx_frame_t;

void ui_zx_init(ui_zx_t* ui, const ui_zx_desc_t* desc);
void ui_zx_discard(ui_zx_t* ui);
void ui_zx_draw(ui_zx_t* ui, const ui_zx_frame_t* frame);
chips_debug_t ui_zx_get_debug(ui_zx_t* ui);
void ui_zx_save_settings(ui_zx_t* ui, ui_settings_t* settings);
void ui_zx_load_settings(ui_zx_t* ui, const ui_settings_t* settings);

#ifdef __cplusplus
} /* extern "C" */
#endif

/*-- IMPLEMENTATION (include in C++ source) ----------------------------------*/
#ifdef CHIPS_UI_IMPL
#ifndef __cplusplus
#error "implementation must be compiled as C++"
#endif
#include <string.h> /* memset */
#ifndef CHIPS_ASSERT
    #include <assert.h>
    #define CHIPS_ASSERT(c) assert(c)
#endif
#ifdef __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wmissing-field-initializers"
#endif

static void _ui_zx_draw_menu(ui_zx_t* ui) {
    CHIPS_ASSERT(ui && ui->zx && ui->boot_cb);
    if (ImGui::BeginMainMenuBar()) {
        if (ImGui::BeginMenu("System")) {
            ui_snapshot_menus(&ui->snapshot);
            if (ImGui::MenuItem("Reset")) {
                zx_reset(ui->zx);
                ui_dbg_reset(&ui->dbg);
            }
            if (ImGui::MenuItem("ZX Spectrum 48K", 0, (ui->zx->type == ZX_TYPE_48K))) {
                ui->boot_cb(ui->zx, ZX_TYPE_48K);
                ui_dbg_reboot(&ui->dbg);
            }
            if (ImGui::MenuItem("ZX Spectrum 128", 0, (ui->zx->type == ZX_TYPE_128))) {
                ui->boot_cb(ui->zx, ZX_TYPE_128);
                ui_dbg_reboot(&ui->dbg);
            }
            if (ImGui::BeginMenu("Joystick")) {
                if (ImGui::MenuItem("None", 0, (ui->zx->joystick_type == ZX_JOYSTICKTYPE_NONE))) {
                    ui->zx->joystick_type = ZX_JOYSTICKTYPE_NONE;
                }
                if (ImGui::MenuItem("Kempston", 0, (ui->zx->joystick_type == ZX_JOYSTICKTYPE_KEMPSTON))) {
                    ui->zx->joystick_type = ZX_JOYSTICKTYPE_KEMPSTON;
                }
                if (ImGui::MenuItem("Sinclair #1", 0, (ui->zx->joystick_type == ZX_JOYSTICKTYPE_SINCLAIR_1))) {
                    ui->zx->joystick_type = ZX_JOYSTICKTYPE_SINCLAIR_1;
                }
                if (ImGui::MenuItem("Sinclair #2", 0, (ui->zx->joystick_type == ZX_JOYSTICKTYPE_SINCLAIR_2))) {
                    ui->zx->joystick_type = ZX_JOYSTICKTYPE_SINCLAIR_2;
                }
                ImGui::EndMenu();
            }
            ImGui::EndMenu();
        }
        if (ImGui::BeginMenu("Hardware")) {
            ImGui::MenuItem("Memory Map", 0, &ui->memmap.open);
            ImGui::MenuItem("Keyboard Matrix", 0, &ui->kbd.open);
            ImGui::MenuItem("Audio Output", 0, &ui->audio.open);
            ImGui::MenuItem("Display", 0, &ui->display.open);
            ImGui::MenuItem("Z80 CPU", 0, &ui->cpu.open);
            if (ui->zx->type == ZX_TYPE_128) {
                ImGui::MenuItem("AY-3-8912", 0, &ui->ay.open);
            }
            else {
                ui->ay.open = false;
            }
            ImGui::EndMenu();
        }
        if (ImGui::BeginMenu("Debug")) {
            ImGui::MenuItem("CPU Debugger", 0, &ui->dbg.ui.open);
            ImGui::MenuItem("Breakpoints", 0, &ui->dbg.ui.breakpoints.open);
            ImGui::MenuItem("Stopwatch", 0, &ui->dbg.ui.stopwatch.open);
            ImGui::MenuItem("Execution History", 0, &ui->dbg.ui.history.open);
            ImGui::MenuItem("Memory Heatmap", 0, &ui->dbg.ui.heatmap.open);
            if (ImGui::BeginMenu("Memory Editor")) {
                ImGui::MenuItem("Window #1", 0, &ui->memedit[0].open);
                ImGui::MenuItem("Window #2", 0, &ui->memedit[1].open);
                ImGui::MenuItem("Window #3", 0, &ui->memedit[2].open);
                ImGui::MenuItem("Window #4", 0, &ui->memedit[3].open);
                ImGui::EndMenu();
            }
            if (ImGui::BeginMenu("Disassembler")) {
                ImGui::MenuItem("Window #1", 0, &ui->dasm[0].open);
                ImGui::MenuItem("Window #2", 0, &ui->dasm[1].open);
                ImGui::MenuItem("Window #3", 0, &ui->dasm[2].open);
                ImGui::MenuItem("Window #4", 0, &ui->dasm[3].open);
                ImGui::EndMenu();
            }
            ImGui::EndMenu();
        }
        ui_util_options_menu();
        ImGui::EndMainMenuBar();
    }

}

static void _ui_zx_update_memmap(ui_zx_t* ui) {
    CHIPS_ASSERT(ui && ui->zx);
    ui_memmap_reset(&ui->memmap);
    if (ZX_TYPE_48K == ui->zx->type) {
        ui_memmap_layer(&ui->memmap, "System");
            ui_memmap_region(&ui->memmap, "ROM", 0x0000, 0x4000, true);
            ui_memmap_region(&ui->memmap, "RAM", 0x4000, 0xC000, true);
    }
    else {
        const uint8_t m = ui->zx->last_mem_config;
        ui_memmap_layer(&ui->memmap, "Layer 0");
            ui_memmap_region(&ui->memmap, "ZX128 ROM", 0x0000, 0x4000, !(m & (1<<4)));
            ui_memmap_region(&ui->memmap, "RAM 5", 0x4000, 0x4000, true);
            ui_memmap_region(&ui->memmap, "RAM 2", 0x8000, 0x4000, true);
            ui_memmap_region(&ui->memmap, "RAM 0", 0xC000, 0x4000, 0 == (m & 7));
        ui_memmap_layer(&ui->memmap, "Layer 1");
            ui_memmap_region(&ui->memmap, "ZX48K ROM", 0x0000, 0x4000, 0 != (m & (1<<4)));
            ui_memmap_region(&ui->memmap, "RAM 1", 0xC000, 0x4000, 1 == (m & 7));
        ui_memmap_layer(&ui->memmap, "Layer 2");
            ui_memmap_region(&ui->memmap, "RAM 2", 0xC000, 0x4000, 2 == (m & 7));
        ui_memmap_layer(&ui->memmap, "Layer 3");
            ui_memmap_region(&ui->memmap, "RAM 3", 0xC000, 0x4000, 3 == (m & 7));
        ui_memmap_layer(&ui->memmap, "Layer 4");
            ui_memmap_region(&ui->memmap, "RAM 4", 0xC000, 0x4000, 4 == (m & 7));
        ui_memmap_layer(&ui->memmap, "Layer 5");
            ui_memmap_region(&ui->memmap, "RAM 5", 0xC000, 0x4000, 5 == (m & 7));
        ui_memmap_layer(&ui->memmap, "Layer 6");
            ui_memmap_region(&ui->memmap, "RAM 6", 0xC000, 0x4000, 6 == (m & 7));
        ui_memmap_layer(&ui->memmap, "Layer 7");
            ui_memmap_region(&ui->memmap, "RAM 7", 0xC000, 0x4000, 7 == (m & 7));
    }
}

static uint8_t* _ui_zx_memptr(zx_t* zx, int layer, uint16_t addr) {
    if (0 == layer) {
        /* ZX128 ROM, RAM 5, RAM 2, RAM 0 */
        if (addr < 0x4000) {
            return &zx->rom[0][addr];
        }
        else if (addr < 0x8000) {
            return &zx->ram[5][addr - 0x4000];
        }
        else if (addr < 0xC000) {
            return &zx->ram[2][addr - 0x8000];
        }
        else {
            return &zx->ram[0][addr - 0xC000];
        }
    }
    else if (1 == layer) {
        /* 48K ROM, RAM 1 */
        if (addr < 0x4000) {
            return &zx->rom[1][addr];
        }
        else if (addr >= 0xC000) {
            return &zx->ram[1][addr - 0xC000];
        }
    }
    else if (layer < 8) {
        if (addr >= 0xC000) {
            return &zx->ram[layer][addr - 0xC000];
        }
    }
    /* fallthrough: unmapped memory */
    return 0;
}

static uint8_t _ui_zx_mem_read(int layer, uint16_t addr, void* user_data) {
    CHIPS_ASSERT(user_data);
    zx_t* zx = (zx_t*) user_data;
    if ((layer == 0) || (ZX_TYPE_48K == zx->type)) {
        /* CPU visible layer */
        return mem_rd(&zx->mem, addr);
    }
    else {
        uint8_t* ptr = _ui_zx_memptr(zx, layer-1, addr);
        if (ptr) {
            return *ptr;
        }
        else {
            return 0xFF;
        }
    }
}

static void _ui_zx_mem_write(int layer, uint16_t addr, uint8_t data, void* user_data) {
    CHIPS_ASSERT(user_data);
    zx_t* zx = (zx_t*) user_data;
    if ((layer == 0) || (ZX_TYPE_48K == zx->type)) {
        mem_wr(&zx->mem, addr, data);
    }
    else {
        uint8_t* ptr = _ui_zx_memptr(zx, layer-1, addr);
        if (ptr) {
            *ptr = data;
        }
    }
}

static const ui_chip_pin_t _ui_zx_cpu_pins[] = {
    { "D0",     0,      Z80_D0 },
    { "D1",     1,      Z80_D1 },
    { "D2",     2,      Z80_D2 },
    { "D3",     3,      Z80_D3 },
    { "D4",     4,      Z80_D4 },
    { "D5",     5,      Z80_D5 },
    { "D6",     6,      Z80_D6 },
    { "D7",     7,      Z80_D7 },
    { "M1",     8,      Z80_M1 },
    { "MREQ",   9,      Z80_MREQ },
    { "IORQ",   10,     Z80_IORQ },
    { "RD",     11,     Z80_RD },
    { "WR",     12,     Z80_WR },
    { "RFSH",   13,     Z80_RFSH },
    { "HALT",   14,     Z80_HALT },
    { "INT",    15,     Z80_INT },
    { "NMI",    16,     Z80_NMI },
    { "WAIT",   17,     Z80_WAIT },
    { "A0",     18,     Z80_A0 },
    { "A1",     19,     Z80_A1 },
    { "A2",     20,     Z80_A2 },
    { "A3",     21,     Z80_A3 },
    { "A4",     22,     Z80_A4 },
    { "A5",     23,     Z80_A5 },
    { "A6",     24,     Z80_A6 },
    { "A7",     25,     Z80_A7 },
    { "A8",     26,     Z80_A8 },
    { "A9",     27,     Z80_A9 },
    { "A10",    28,     Z80_A10 },
    { "A11",    29,     Z80_A11 },
    { "A12",    30,     Z80_A12 },
    { "A13",    31,     Z80_A13 },
    { "A14",    32,     Z80_A14 },
    { "A15",    33,     Z80_A15 },
};

static const ui_chip_pin_t _ui_zx_ay_pins[] = {
    { "DA0",  0, AY38910_DA0 },
    { "DA1",  1, AY38910_DA1 },
    { "DA2",  2, AY38910_DA2 },
    { "DA3",  3, AY38910_DA3 },
    { "DA4",  4, AY38910_DA4 },
    { "DA5",  5, AY38910_DA5 },
    { "DA6",  6, AY38910_DA6 },
    { "DA7",  7, AY38910_DA7 },
    { "BDIR", 9, AY38910_BDIR },
    { "BC1",  10, AY38910_BC1 },
    { "IOA0", 11, AY38910_IOA0 },
    { "IOA1", 12, AY38910_IOA1 },
    { "IOA2", 13, AY38910_IOA2 },
    { "IOA3", 14, AY38910_IOA3 },
    { "IOA4", 15, AY38910_IOA4 },
    { "IOA5", 16, AY38910_IOA5 },
    { "IOA6", 17, AY38910_IOA6 },
    { "IOA7", 18, AY38910_IOA7 },
};

void ui_zx_init(ui_zx_t* ui, const ui_zx_desc_t* ui_desc) {
    CHIPS_ASSERT(ui && ui_desc);
    CHIPS_ASSERT(ui_desc->zx);
    CHIPS_ASSERT(ui_desc->boot_cb);
    ui->zx = ui_desc->zx;
    ui->boot_cb = ui_desc->boot_cb;
    ui_snapshot_init(&ui->snapshot, &ui_desc->snapshot);
    int x = 20, y = 20, dx = 10, dy = 10;
    {
        ui_dbg_desc_t desc = {0};
        desc.title = "CPU Debugger";
        desc.x = x;
        desc.y = y;
        desc.z80 = &ui->zx->cpu;
        desc.read_cb = _ui_zx_mem_read;
        desc.texture_cbs = ui_desc->dbg_texture;
        desc.keys = ui_desc->dbg_keys;
        desc.user_data = ui->zx;
        ui_dbg_init(&ui->dbg, &desc);
    }
    x += dx; y += dy;
    {
        ui_z80_desc_t desc = {0};
        desc.title = "Z80 CPU";
        desc.cpu = &ui->zx->cpu;
        desc.x = x;
        desc.y = y;
        UI_CHIP_INIT_DESC(&desc.chip_desc, "Z80\nCPU", 36, _ui_zx_cpu_pins);
        ui_z80_init(&ui->cpu, &desc);
    }
    x += dx; y += dy;
    {
        ui_ay38910_desc_t desc = {0};
        desc.title = "AY-3-8912";
        desc.ay = &ui->zx->ay;
        desc.x = x;
        desc.y = y;
        UI_CHIP_INIT_DESC(&desc.chip_desc, "8912", 22, _ui_zx_ay_pins);
        ui_ay38910_init(&ui->ay, &desc);
    }
    x += dx; y += dy;
    {
        ui_kbd_desc_t desc = {0};
        desc.title = "Keyboard Matrix";
        desc.kbd = &ui->zx->kbd;
        desc.layers[0] = "None";
        desc.layers[1] = "Shift";
        desc.layers[2] = "Sym Shift";
        desc.x = x;
        desc.y = y;
        ui_kbd_init(&ui->kbd, &desc);
    }
    x += dx; y += dy;
    {
        ui_audio_desc_t desc = {0};
        desc.title = "Audio Output";
        desc.sample_buffer = ui->zx->audio.sample_buffer;
        desc.num_samples = ui->zx->audio.num_samples;
        desc.x = x;
        desc.y = y;
        ui_audio_init(&ui->audio, &desc);
    }
    x += dx; y += dy;
    {
        ui_display_desc_t desc = {0};
        desc.title = "Display";
        desc.x = x;
        desc.y = y;
        ui_display_init(&ui->display, &desc);
    }
    x += dx; y += dy;
    {
        ui_memedit_desc_t desc = {0};
        desc.layers[0] = "CPU Mapped";
        desc.layers[1] = "Layer 0";
        desc.layers[2] = "Layer 1";
        desc.layers[3] = "Layer 2";
        desc.layers[4] = "Layer 3";
        desc.layers[5] = "Layer 4";
        desc.layers[6] = "Layer 5";
        desc.layers[7] = "Layer 6";
        desc.read_cb = _ui_zx_mem_read;
        desc.write_cb = _ui_zx_mem_write;
        desc.user_data = ui->zx;
        static const char* titles[] = { "Memory Editor #1", "Memory Editor #2", "Memory Editor #3", "Memory Editor #4" };
        for (int i = 0; i < 4; i++) {
            desc.title = titles[i]; desc.x = x; desc.y = y;
            ui_memedit_init(&ui->memedit[i], &desc);
            x += dx; y += dy;
        }
    }
    {
        ui_memmap_desc_t desc = {0};
        desc.title = "Memory Map";
        desc.x = x;
        desc.y = y;
        ui_memmap_init(&ui->memmap, &desc);
    }
    x += dx; y += dy;
    {
        ui_dasm_desc_t desc = {0};
        desc.layers[0] = "CPU Mapped";
        desc.layers[1] = "Layer 0";
        desc.layers[2] = "Layer 1";
        desc.layers[3] = "Layer 2";
        desc.layers[4] = "Layer 3";
        desc.layers[5] = "Layer 4";
        desc.layers[6] = "Layer 5";
        desc.layers[7] = "Layer 6";
        desc.cpu_type = UI_DASM_CPUTYPE_Z80;
        desc.start_addr = 0x0000;
        desc.read_cb = _ui_zx_mem_read;
        desc.user_data = ui->zx;
        static const char* titles[4] = { "Disassembler #1", "Disassembler #2", "Disassembler #2", "Dissassembler #3" };
        for (int i = 0; i < 4; i++) {
            desc.title = titles[i]; desc.x = x; desc.y = y;
            ui_dasm_init(&ui->dasm[i], &desc);
            x += dx; y += dy;
        }
    }
}

void ui_zx_discard(ui_zx_t* ui) {
    CHIPS_ASSERT(ui && ui->zx);
    ui->zx = 0;
    ui_z80_discard(&ui->cpu);
    ui_ay38910_discard(&ui->ay);
    ui_audio_discard(&ui->audio);
    ui_display_discard(&ui->display);
    ui_kbd_discard(&ui->kbd);
    ui_memmap_discard(&ui->memmap);
    for (int i = 0; i < 4; i++) {
        ui_memedit_discard(&ui->memedit[i]);
        ui_dasm_discard(&ui->dasm[i]);
    }
    ui_dbg_discard(&ui->dbg);
}

void ui_zx_draw(ui_zx_t* ui, const ui_zx_frame_t* frame) {
    CHIPS_ASSERT(ui && ui->zx && frame);
    _ui_zx_draw_menu(ui);
    if (ui->memmap.open) {
        _ui_zx_update_memmap(ui);
    }
    ui_audio_draw(&ui->audio, ui->zx->audio.sample_pos);
    ui_display_draw(&ui->display, &frame->display);
    ui_z80_draw(&ui->cpu);
    ui_ay38910_draw(&ui->ay);
    ui_kbd_draw(&ui->kbd);
    ui_memmap_draw(&ui->memmap);
    for (int i = 0; i < 4; i++) {
        ui_memedit_draw(&ui->memedit[i]);
        ui_dasm_draw(&ui->dasm[i]);
    }
    ui_dbg_draw(&ui->dbg);
}

chips_debug_t ui_zx_get_debug(ui_zx_t* ui) {
    chips_debug_t res = {};
    res.callback.func = (chips_debug_func_t)ui_dbg_tick;
    res.callback.user_data = &ui->dbg;
    res.stopped = &ui->dbg.dbg.stopped;
    return res;
}

void ui_zx_save_settings(ui_zx_t* ui, ui_settings_t* settings) {
    CHIPS_ASSERT(ui && settings);
    ui_z80_save_settings(&ui->cpu, settings);
    ui_ay38910_save_settings(&ui->ay, settings);
    ui_audio_save_settings(&ui->audio, settings);
    ui_display_save_settings(&ui->display, settings);
    ui_kbd_save_settings(&ui->kbd, settings);
    ui_memmap_save_settings(&ui->memmap, settings);
    for (int i = 0; i < 4; i++) {
        ui_memedit_save_settings(&ui->memedit[i], settings);
    }
    for (int i = 0; i < 4; i++) {
        ui_dasm_save_settings(&ui->dasm[i], settings);
    }
    ui_dbg_save_settings(&ui->dbg, settings);
}

void ui_zx_load_settings(ui_zx_t* ui, const ui_settings_t* settings) {
    CHIPS_ASSERT(ui && settings);
    ui_z80_load_settings(&ui->cpu, settings);
    ui_ay38910_load_settings(&ui->ay, settings);
    ui_audio_load_settings(&ui->audio, settings);
    ui_display_load_settings(&ui->display, settings);
    ui_kbd_load_settings(&ui->kbd, settings);
    ui_memmap_load_settings(&ui->memmap, settings);
    for (int i = 0; i < 4; i++) {
        ui_memedit_load_settings(&ui->memedit[i], settings);
    }
    for (int i = 0; i < 4; i++) {
        ui_dasm_load_settings(&ui->dasm[i], settings);
    }
    ui_dbg_load_settings(&ui->dbg, settings);
}

#ifdef __clang__
#pragma clang diagnostic pop
#endif
#endif /* CHIPS_UI_IMPL */