/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 *   Mupen64plus-core - api/common.c                                       *
 *   Mupen64Plus homepage: https://mupen64plus.org/                        *
 *   Copyright (C) 2009 Richard Goedeken                                   *
 *                                                                         *
 *   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.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.          *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/* This file contains the Core common functions which will be exported
 * outside of the core library.
 */

#include <stddef.h>
#include <stdlib.h>

#define M64P_CORE_PROTOTYPES 1
#include "../main/version.h"
#include "m64p_common.h"
#include "m64p_types.h"

EXPORT m64p_error CALL PluginGetVersion(m64p_plugin_type *PluginType, int *PluginVersion, int *APIVersion, const char **PluginNamePtr, int *Capabilities)
{
    /* set version info */
    if (PluginType != NULL)
        *PluginType = M64PLUGIN_CORE;

    if (PluginVersion != NULL)
        *PluginVersion = MUPEN_CORE_VERSION;

    if (APIVersion != NULL)
        *APIVersion = FRONTEND_API_VERSION;
    
    if (PluginNamePtr != NULL)
        *PluginNamePtr = MUPEN_CORE_NAME;

    if (Capabilities != NULL)
    {
        *Capabilities = 0;
#if defined(DBG)
        *Capabilities |= M64CAPS_DEBUGGER;
#endif
#if defined(DYNAREC)
        *Capabilities |= M64CAPS_DYNAREC;
#endif
#if defined(COMPARE_CORE)
        *Capabilities |= M64CAPS_CORE_COMPARE;
#endif
    }
                    
    return M64ERR_SUCCESS;
}

EXPORT m64p_error CALL CoreGetAPIVersions(int *ConfigVersion, int *DebugVersion, int *VidextVersion, int *ExtraVersion)
{
    /* set version info */
    if (ConfigVersion != NULL)
        *ConfigVersion = CONFIG_API_VERSION;

    if (DebugVersion != NULL)
        *DebugVersion = DEBUG_API_VERSION;

    if (VidextVersion != NULL)
        *VidextVersion = VIDEXT_API_VERSION;

    if (ExtraVersion != NULL)
        *ExtraVersion = 0;

    return M64ERR_SUCCESS;
}

static const char *ErrorMessages[] = {
                   "SUCCESS: No error",
                   "NOT_INIT: A function was called before it's associated module was initialized",
                   "ALREADY_INIT: Initialization function called twice",
                   "INCOMPATIBLE: API versions between components are incompatible",
                   "INPUT_ASSERT: Invalid function parameters, such as a NULL pointer",
                   "INPUT_INVALID: An input function parameter is logically invalid",
                   "INPUT_NOT_FOUND: The input parameter(s) specified a particular item which was not found",
                   "NO_MEMORY: Memory allocation failed",
                   "FILES: Error opening, creating, reading, or writing to a file",
                   "INTERNAL: logical inconsistency in program code.  Probably a bug.",
                   "INVALID_STATE: An operation was requested which is not allowed in the current state",
                   "PLUGIN_FAIL: A plugin function returned a fatal error",
                   "SYSTEM_FAIL: A system function call, such as an SDL or file operation, failed",
                   "UNSUPPORTED: Function call is not supported (ie, core not built with debugger)",
                   "WRONG_TYPE: A given input type parameter cannot be used for desired operation" };

EXPORT const char * CALL CoreErrorMessage(m64p_error ReturnCode)
{
    size_t i = (size_t) ReturnCode;

    if (i >= (sizeof(ErrorMessages) / sizeof(char *)))
        return "ERROR: Invalid m64p_error code given to CoreErrorMessage()";

    return ErrorMessages[i];
}

