/*
 * mon_file.c - The VICE built-in monitor file functions.
 *
 * Written by
 *  Andreas Boose <viceteam@t-online.de>
 *  Daniel Sladic <sladic@eecg.toronto.edu>
 *  Ettore Perazzoli <ettore@comm2000.it>
 *
 * This file is part of VICE, the Versatile Commodore Emulator.
 * See README for copyright notice.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
 *  02111-1307  USA.
 *
 */

#include "vice.h"

#include <stdio.h>
#include <string.h>

#include "archdep.h"
#include "attach.h"
#include "autostart.h"
#include "cartridge.h"
#include "charset.h"
#include "lib.h"
#include "log.h"
#include "machine.h"
#include "mem.h"
#include "montypes.h"
#include "mon_drive.h"
#include "mon_util.h"
#include "tape.h"
#include "tapeport.h"
#include "uimon.h"
#include "util.h"
#include "vdrive-iec.h"
#include "vdrive.h"

#include "mon_file.h"

/* #define DEBUG_MONITOR */

#ifdef DEBUG_MONITOR
#define DBG(x) log_printf    x
#else
#define DBG(x)
#endif

#define ADDR_LIMIT(x) ((uint16_t)(addr_mask(x)))

#define curbank (mon_interfaces[mem]->current_bank)

static FILE *fp;
static vdrive_t *vdrive;
/* we require an EOF buffer to support CBM EOFs. */
static int mon_file_read_eof[4][16];

static int mon_file_open(const char *filename,
                         unsigned int secondary, /* 0: load, 1: save */
                         int device)
{
    char pname[17];
    const char *s;
    int i;

    const char *fspath = NULL;
    char *fullpath;

    fp = NULL;

    DBG(("mon_file_open(filename:%s, secondary:%u, device:%d\n",
         filename, secondary, device));

    switch (device) {
        case 0:
            fp = fopen(filename, (secondary == 0) ? MODE_READ : MODE_WRITE);
            if (fp == NULL) {
                return -1;
            }
            break;
        case 8:
        case 9:
        case 10:
        case 11:
            vdrive = file_system_get_vdrive((unsigned int)device);
            if (vdrive == NULL) {
                /* if vdrive did not succeed, try fsdevice */
                if ((fspath = mon_drive_get_fsdevice_path(device))) {
                    fullpath = util_join_paths(fspath, filename, NULL);
                    fp = fopen(fullpath, (secondary == 0) ? MODE_READ : MODE_WRITE);
                    lib_free(fullpath);
                    if (fp != NULL) {
                        return 0;
                    }
                }
                return -1;
            }

            /* convert filename to petscii */
            s = filename;
            for (i = 0; (i < 16) && (*s); ++i) {
                pname[i] = charset_p_topetscii(*s);
                ++s;
            }
            pname[i] = 0;

            if (vdrive_iec_open(vdrive, (const uint8_t *)pname,
                                (int)strlen(pname), secondary, NULL) != SERIAL_OK) {
                return -1;
            }

            /* initialize EOF buffer. */
            mon_file_read_eof[device - 8][secondary] = 0;
            break;
        default:
            return -1;
    }
    return 0;
}

static int mon_file_read(uint8_t *data, unsigned int secondary, int device)
{
    if (fp) {
        if (fread((char *)data, 1, 1, fp) < 1) {
            return -1;
        }
    } else if (device >= 8) {
        /* Return EOF if we hit a CBM EOF on the last read. */
        if (mon_file_read_eof[device - 8][secondary]) {
            *data = 0xc7;
            return -1;
        }
        /* Set next EOF based on CBM EOF. */
        mon_file_read_eof[device - 8][secondary] =
            vdrive_iec_read(vdrive, data, secondary);
    }
    return 0;
}

static int mon_file_write(uint8_t data, unsigned int secondary, int device)
{
    if (fp) {
        if (fwrite((char *)&data, 1, 1, fp) < 1) {
            return -1;
        }
    } else if (device >= 8) {
        if (vdrive_iec_write(vdrive, data, secondary) != SERIAL_OK) {
            return -1;
        }
    }
    return 0;
}

static int mon_file_close(unsigned int secondary, int device)
{
    if (fp) {
        if (fclose(fp) != 0) {
            return -1;
        }
    } else if (device >= 8) {
        if (vdrive_iec_close(vdrive, secondary) != SERIAL_OK) {
            return -1;
        }
    }
    return 0;
}


void mon_file_load(const char *filename, int device, MON_ADDR start_addr,
                   bool is_binary, bool set_pointers)
{
    uint16_t adr, load_addr = 0;
    uint8_t b1 = 0, b2 = 0;
    int ch = 0;
    MEMSPACE mem;
    int origbank = 0;

    if (mon_file_open(filename, 0, device) < 0) {
        mon_out("Cannot open '%s'.\n", filename);
        return;
    }

    /* if loading a .prg file, read/skip the start address */
    if (is_binary == FALSE) {
        mon_file_read(&b1, 0, device);
        mon_file_read(&b2, 0, device);
        load_addr = (uint8_t)b1 | ((uint8_t)b2 << 8);
    }

    mon_evaluate_default_addr(&start_addr); /* get target addr given in monitor */

    if (!mon_is_valid_addr(start_addr)) {   /* No Load address given */
        if (is_binary == TRUE) {
            /* when loading plain binary, load addr is required */
            mon_out("Invalid LOAD address given.\n");
            mon_file_close(0, device);
            return;
        }
        /* use load addr from .prg file */
        start_addr = new_addr(e_default_space, load_addr);
        mon_evaluate_default_addr(&start_addr);
        adr = addr_location(start_addr);
        mem = addr_memspace(start_addr);
    } else {
        adr = addr_location(start_addr);
        mem = addr_memspace(start_addr);
    }

    mon_out("Loading '%s' from %04X ", filename, adr);

    if (machine_class == VICE_MACHINE_C64DTV) {
        origbank = curbank;
    }

    do {
        /* initialize to avoid false positive with clang static initializer
         * about using a garbage load_byte in the memset() call
         */
        uint8_t load_byte = 0;

        if (mon_file_read(&load_byte, 0, device) < 0) {
            break;
        }
        mon_set_mem_val(mem, ADDR_LIMIT(adr + ch), load_byte);

        /* Hack to be able to read large .prgs for x64dtv */
        if ((machine_class == VICE_MACHINE_C64DTV) &&
            (ADDR_LIMIT(adr + ch) == 0xffff) &&
            ((curbank >= mem_bank_from_name("ram00")) && (curbank <= mem_bank_from_name("ram1f")))) {
            curbank++;
            if (curbank > mem_bank_from_name("ram1f")) {
                curbank = mem_bank_from_name("ram00");
            }
            mon_out("Crossing 64KiB boundary.\n");
        }
        ch++;
    } while (1);

    if (machine_class == VICE_MACHINE_C64DTV) {
        curbank = origbank;
    }

    mon_out("to %04X (%04X bytes)\n", ADDR_LIMIT((adr + ch) - 1), (unsigned int)ch);

    /* set BASIC pointers like kernal load if
     * 1. loading .prg file
     * 2. using BASIC load (ldb)
     * 3. loading to computer bank/memory
     */
    if ((is_binary == FALSE) && (set_pointers == TRUE) && (mem == e_comp_space)) {
        mem_set_basic_text(adr, (uint16_t)(adr + ch));
    }

    mon_file_close(0, device);
}

void mon_file_save(const char *filename, int device, MON_ADDR start_addr,
                   MON_ADDR end_addr, bool is_bsave)
{
    uint16_t adr, end;
    long len;
    int ch = 0;
    MEMSPACE mem;

    len = mon_evaluate_address_range(&start_addr, &end_addr, TRUE, -1);

    if (len < 0) {
        mon_out("Invalid range.\n");
        return;
    }

    mem = addr_memspace(start_addr);
    adr = addr_location(start_addr);
    end = addr_location(end_addr);

    if (end < adr) {
        mon_out("Start address must be below end address.\n");
        return;
    }

    if (mon_file_open(filename, 1, device) < 0) {
        mon_out("Cannot open '%s'.\n", filename);
        return;
    }

    if (is_bsave == FALSE) {
        if (mon_file_write((uint8_t)(adr & 0xff), 1, device) < 0
            || mon_file_write((uint8_t)((adr >> 8) & 0xff), 1, device) < 0) {
            mon_out("Saving for '%s' failed.\n", filename);
            mon_file_close(1, device);
            return;
        }
    }

    do {
        unsigned char save_byte;

        save_byte = mon_get_mem_val(mem, (uint16_t)(adr + ch));
        if (mon_file_write(save_byte, 1, device) < 0) {
            mon_out("Saving for '%s' failed.\n", filename);
            mon_file_close(1, device);
            return;
        }
        ch++;
    } while ((adr + ch) <= end);

    mon_out("Saving file '%s' from $%04x to $%04x\n",
            filename, addr_location(start_addr), addr_location(end_addr));


    mon_file_close(1, device);
}

void mon_file_verify(const char *filename, int device, MON_ADDR start_addr, bool is_bverify)
{
    uint16_t adr, load_addr = 0;
    uint8_t b1 = 0, b2 = 0;
    int ch = 0;
    MEMSPACE mem;
    int origbank = 0;
    int diffcount = 0;

    if (mon_file_open(filename, 0, device) < 0) {
        mon_out("Cannot open '%s'.\n", filename);
        return;
    }

    /* if loading a .prg file, read/skip the start address */
    if (is_bverify == FALSE) {
        mon_file_read(&b1, 0, device);
        mon_file_read(&b2, 0, device);
        load_addr = (uint8_t)b1 | ((uint8_t)b2 << 8);
    }

    mon_evaluate_default_addr(&start_addr); /* get target addr given in monitor */

    if (!mon_is_valid_addr(start_addr)) {   /* No Load address given */
        if (is_bverify == TRUE) {
            /* when loading plain binary, load addr is required */
            mon_out("Invalid VERIFY address given.\n");
            mon_file_close(0, device);
            return;
        }

        start_addr = new_addr(e_default_space, load_addr);
        mon_evaluate_default_addr(&start_addr);
    }
    adr = addr_location(start_addr);
    mem = addr_memspace(start_addr);

    mon_out("Verifying '%s' from %04X ", filename, adr);

    if (machine_class == VICE_MACHINE_C64DTV) {
        origbank = curbank;
    }

    do {
        /* initialize to avoid false positive with clang static initializer
         * about using a garbage load_byte in the if() below
         */
        uint8_t load_byte = 0;
        uint8_t mem_byte;

        if (mon_file_read(&load_byte, 0, device) < 0) {
            break;
        }
        mem_byte = mon_get_mem_val(mem, ADDR_LIMIT(adr + ch));
        if (load_byte != mem_byte) {
            if (diffcount == 0) {
                mon_out("\naddr:mem file\n");
            }
            mon_out("%04x: ", ADDR_LIMIT(adr + ch));
            mon_out("%02x %02x", mem_byte, load_byte);
            mon_out("\n");
            diffcount++;
        }

        /* Hack to be able to read large .prgs for x64dtv */
        if ((machine_class == VICE_MACHINE_C64DTV) &&
            (ADDR_LIMIT(adr + ch) == 0xffff) &&
            ((curbank >= mem_bank_from_name("ram00")) && (curbank <= mem_bank_from_name("ram1f")))) {
            curbank++;
            if (curbank > mem_bank_from_name("ram1f")) {
                curbank = mem_bank_from_name("ram00");
            }
            mon_out("Crossing 64KiB boundary.\n");
        }
        ch++;
    } while (1);

    if (machine_class == VICE_MACHINE_C64DTV) {
        curbank = origbank;
    }

    mon_out("to %04X (%04X bytes)\n", ADDR_LIMIT((adr + ch) - 1), (unsigned int)ch);
    if (diffcount > 0) {
        mon_out("%d byte(s) different\n", diffcount);
    }

    mon_file_close(0, device);
}


void mon_attach(const char *filename, int device)
{
    switch (device) {
        case 1:
            if (machine_class == VICE_MACHINE_C64DTV || machine_class == VICE_MACHINE_SCPU64) {
                mon_out("Unimplemented.\n");
            } else if (tape_image_attach(device, filename)) {
                mon_out("Failed.\n");
            }
            break;
        case 2:
            if (machine_class != VICE_MACHINE_PET) {
                mon_out("Unimplemented.\n");
            } else if (tape_image_attach(device, filename)) {
                mon_out("Failed.\n");
            }
            break;
        case 8:
        case 9:
        case 10:
        case 11:
            /* TODO: drive 1? */
            if (file_system_attach_disk(device, 0, filename)) {
                mon_out("Failed.\n");
            }
            break;
        case 32:
            if (mon_cart_cmd.cartridge_attach_image != NULL) {
                if ((mon_cart_cmd.cartridge_attach_image)(CARTRIDGE_CRT, filename)) {
                    mon_out("Failed.\n");
                }
            } else {
                mon_out("Unsupported.\n");
            }
            break;
        default:
            mon_out("Unknown device %i.\n", device);
            break;
    }
}

void mon_detach(int device)
{
    switch (device) {
        case 1:
            if (machine_class == VICE_MACHINE_C64DTV || machine_class == VICE_MACHINE_SCPU64) {
                mon_out("Unimplemented.\n");
            } else {
                tape_image_detach(device);
            }
            break;
        case 2:
            if (machine_class != VICE_MACHINE_PET) {
                mon_out("Unimplemented.\n");
            } else {
                tape_image_detach(device);
            }
            break;
        case 8:
        case 9:
        case 10:
        case 11:
            /* TODO: drive 1? */
            file_system_detach_disk(device, 0);
            break;
        case 32:
            if (mon_cart_cmd.cartridge_detach_image != NULL) {
                (mon_cart_cmd.cartridge_detach_image)(-1); /* FIXME: param should be cart id, -1 detaches all */
            } else {
                mon_out("Unsupported.\n");
            }
            break;
        default:
            mon_out("Unknown device %i.\n", device);
            break;
    }
}

int mon_autostart(const char *image_name,
                   int file_index,
                   int run)
{
    int result = 0;

    mon_out("auto%s %s #%d\n", run ? "starting" : "loading",
            image_name, file_index);
    result = autostart_autodetect_opt_prgname(image_name, file_index,
                                     run ? AUTOSTART_MODE_RUN : AUTOSTART_MODE_LOAD);

    /* leave monitor but return after autostart */
    autostart_trigger_monitor(1);
    exit_mon = 1;

    return result;
}
