LanguageResource.h

Go to the documentation of this file.

/*
  Cavestory Multiplayer API
  Copyright (C) 2021 Johnny Ledger
 
  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.
*/
 
#ifndef CAVESTORY_MOD_API_H_
#error "Please include CavestoryModAPI.h before including sub-classes."
#endif
 
#include <CSMAPI_begincode.h>
 
#pragma once
 
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
#define PXLANG_MAGIC            "PXLANG"
#define PXLANG_VERSION          2
#define PXLANG_VALID_CRC        0x1F5F1F44
#define PXLANG_SYMBOL_MAGIC     "PXLNGS"
#define PXLANG_SYMBOL_VERSION   1
 
// Enable to always recompile PXLANG. Useful when working on the compiler.
//#define ALWAYS_RECOMPILE_PXLANG
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
#define __VA_NARGS_IMPL(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, N, ...)                                                    N
#define __EXPAND(x)                                                                                                         x
#define __VA_NARGS(...)                                                                                                     __EXPAND(__VA_NARGS_IMPL(__VA_ARGS__, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1))
#define _LOC(x, ...)                                                                                                        x
#define LOCALE_STATIC
#define USE_LOCALE_NAME_AS_DEFAULT                                                                                          NULL
 
// Buffer info
#define UseGlobalLocaleBuffer(x)                                                                                            CSM_PxLang_GetGlobalBuffer(x), -1
#define UseStaticLocaleBuffer(BUFFER)                                                                                       BUFFER, sizeof(BUFFER)
#define UseDynamicLocaleBuffer(BUFFER, BUFFERSIZE)                                                                          BUFFER, BUFFERSIZE
 
// Localization Macros
#define GetLocaleStringWithArgumentsA(LOCALE_NAME, ARG_FORMAT, DEFAULT_STRING, ...)                                         CSM_PxLang_GetString(LOCALE_NAME, NULL, -1, DEFAULT_STRING, NULL, ARG_FORMAT, __VA_NARGS(__VA_ARGS__), ## __VA_ARGS__)
#define GetLocaleStringA(LOCALE_NAME, DEFAULT_STRING)                                                                       CSM_PxLang_GetString(LOCALE_NAME, NULL, -1, DEFAULT_STRING, NULL, NULL, 0)
 
// Safe copy macros
// Use USE_BUFFER_FOR_LOCALE or USE_GLOBAL_LOCALE_BUFFER for BUFFERINFO.
#define CopyLocaleStringWithArgumentsA(BUFFERINFO, LOCALE_NAME, ARG_FORMAT, DEFAULT_STRING, ...)                            CSM_PxLang_GetString(LOCALE_NAME, BUFFERINFO, DEFAULT_STRING, NULL, ARG_FORMAT, __VA_NARGS(__VA_ARGS__), ## __VA_ARGS__)
#define CopyLocaleStringA(BUFFERINFO, LOCALE_NAME, DEFAULT_STRING)                                                          CSM_PxLang_GetString(LOCALE_NAME, BUFFERINFO, DEFAULT_STRING, NULL, NULL, 0)
 
#define BuildLocaleString(STRING)                                                                                           CSM_PxLang_BuildFormat(STRING)
#define LoadNonLocaleFont(FONTNAME, FONTW, FONTH)                                                                           (CSM_PxLang_IsLoaded(&gCurrentLocalization) && strcmpi(gCurrentLocalization.font_name, "Courier New") ? FontHandle(NULL, (gCurrentLocalization.font_width / 1.1), (gCurrentLocalization.font_height / 1.1)) : FontHandle(FONTNAME, FONTW, FONTH))
#define LoadNonLocaleFontWithSubstitue(FONTNAME, FONTNAME2, FONTW, FONTH)                                                   (CSM_PxLang_IsLoaded(&gCurrentLocalization) && strcmpi(gCurrentLocalization.font_name, "Courier New") ? FontHandle(FONTNAME2, (gCurrentLocalization.font_width / 1.1), (gCurrentLocalization.font_height / 1.1)) : FontHandle(FONTNAME, FONTW, FONTH))
#define LoadNonLocaleFontCustomMag(INPUT_MAG, FONTNAME, FONTW, FONTH)                                                       (CSM_PxLang_IsLoaded(&gCurrentLocalization) && strcmpi(gCurrentLocalization.font_name, "Courier New") ? FontHandle(NULL, (gCurrentLocalization.font_width / 1.1), (gCurrentLocalization.font_height / 1.1), INPUT_MAG) : FontHandle(FONTNAME, FONTW, FONTH, INPUT_MAG))
#define LoadNonLocaleFontWithSubstitueCustomMag(INPUT_MAG, FONTNAME, FONTNAME2, FONTW, FONTH)                               (CSM_PxLang_IsLoaded(&gCurrentLocalization) && strcmpi(gCurrentLocalization.font_name, "Courier New") ? FontHandle(FONTNAME2, (gCurrentLocalization.font_width / 1.1), (gCurrentLocalization.font_height / 1.1), INPUT_MAG) : FontHandle(FONTNAME, FONTW, FONTH, INPUT_MAG))
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
enum PXLANG_ArgType
{
    PXLANG_TYPE_STRING = 0,
    PXLANG_TYPE_INT    = 1
};
 
enum PXLANG_SymbolType
{
    PXLANG_SYMBOL_TYPE_GROUP  = 0,
    PXLANG_SYMBOL_TYPE_STRING = 1,
 
    MAX_PXLANG_SYMBOL_COUNT
};
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
struct PXLANG_DEBUG_SYMBOL_STRUCT
{
    PXLANG_SymbolType type;
 
    unsigned int crc;
 
    char* name;
 
    int line;
};
 
struct PXLANG_STRING_STRUCT
{
    unsigned int crc;
 
    wchar_t* content;
 
    char* content_ascii;
 
    int symbol;
    
    bool special_content;
};
 
struct PXLANG_GROUP_STRUCT
{
    unsigned int crc;
    
    unsigned int string_size;
 
    unsigned int string_count;
 
    PXLANG_STRING_STRUCT* string_list;
 
    bool loaded;
 
    int symbol;
};
 
struct PXLANG_RESOURCE_STRUCT
{
    // Internal ------------------------------------------------
 
    unsigned int valid_crc;
 
    // Metadata ------------------------------------------------
 
    char* path_name;
 
    unsigned int font_width;
    
    unsigned int font_height;
    
    unsigned int file_crc;
 
    char* file_name;
    
    char* font_name;
 
    // Resource configuration ----------------------------------
 
    int encoding_type;
    
    int charset_type;
 
    char* display_name;
 
    unsigned int selected_group_crc;
    
    unsigned int group_count;
 
    PXLANG_GROUP_STRUCT* group_list;
 
    unsigned int string_table_size;
 
    wchar_t** string_table;
 
    bool hidden;
 
    unsigned char char_travel;
 
    // Linkage -------------------------------------------------
 
    static PXLANG_RESOURCE_STRUCT* first;
    
    PXLANG_RESOURCE_STRUCT* next;
    
    PXLANG_RESOURCE_STRUCT* prev;
 
    // Debug ---------------------------------------------------
 
    unsigned int symbol_count;
 
    PXLANG_DEBUG_SYMBOL_STRUCT* symbol_list;
};
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
extern CAVESTORY_MOD_API PXLANG_RESOURCE_STRUCT gCurrentLocalization;
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
extern CAVESTORY_MOD_API int CSM_PxLang_Compile
(
    const char* pFileName,
    bool bForceDebugSymbols = false
);
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
extern CAVESTORY_MOD_API int CSM_PxLang_Load
(
    PXLANG_RESOURCE_STRUCT* pLangObj,
    const char* pFileName,
    const char* pGroupName = NULL,
    bool bRecompile = true,
    bool bForceDebugSymbols = false
);
 
extern CAVESTORY_MOD_API BOOL CSM_PxLang_Free
(
    PXLANG_RESOURCE_STRUCT* pLangObj
);
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
extern CAVESTORY_MOD_API BOOL CSM_PxLang_IsLoaded
(
    PXLANG_RESOURCE_STRUCT* pLangObj
);
 
extern CAVESTORY_MOD_API BOOL CSM_PxLang_HasString
(
    const char* pStringName,
    PXLANG_RESOURCE_STRUCT* pLangObj = NULL
);
 
extern CAVESTORY_MOD_API const char* CSM_PxLang_GetString
(
    const char* pStringName,
    char* pBuffer = NULL,
    int iBufferSize = -1,
    const char* pDefaultValue = NULL,
    PXLANG_RESOURCE_STRUCT* pLangObj = NULL,
    const char* pArgFormat = NULL,
    int iArgCount = 0,
    ...
);
 
extern CAVESTORY_MOD_API char* CSM_PxLang_GetGlobalBuffer
(
    unsigned int iBufferID
);
 
extern CAVESTORY_MOD_API bool CSM_PxLang_LoadDebugSymbols
(
    PXLANG_RESOURCE_STRUCT* pLangObj
);
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
extern CAVESTORY_MOD_API BOOL CSM_PxLang_SetCurrentLocalization
(
    const char* pLanguageName,
    bool bUseData = false
);
 
extern CAVESTORY_MOD_API void CSM_PxLang_SetGroup
(
    const char* pGroupName,
    PXLANG_RESOURCE_STRUCT* pLangObj = NULL
);
 
extern CAVESTORY_MOD_API const char* CSM_PxLang_BuildFormat
(
    const char* pFormat
);
 
//------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
 
#include <CSMAPI_endcode.h>
 
///