CATStringTableCore.cpp

Go to the documentation of this file.

/// \file CATStringTableCore.cpp
/// \brief Core String table for CAT library
/// \ingroup CAT
///
/// Copyright (c) 2007-2008 by Michael Ellison.
/// See COPYING.txt for the \ref gaslicense License (MIT License).
///
// $Author: mikeellison $
// $Date: 2008-01-23 06:02:38 -0600 (Wed, 23 Jan 2008) $
// $Revision:   $
// $NoKeywords: $

#include "CATStringTableCore.h"


struct CATStringEntry
{
    CATResult       resultCode;
    const CATWChar* resultString;
};

/// \todo
/// Switch this to use a std::map when we're loading it in from a file
///
/// Temporary table of resultCode->String mapp entries
const CATStringEntry kCATStringEntries[] = 
{
    {CAT_SUCCESS,                       L"Success"},
    
    {CAT_STATUS,                        L"Status"},
    {CAT_STAT_FILE_AT_EOF,              L"The file is at EOF"},
    {CAT_STAT_MULTIPLE_PROCS,           L"Multiple matching processes found."},
    {CAT_STAT_PATH_NO_FILE,             L"No filename present."},
    {CAT_STAT_PATH_NO_DIRECTORY,        L"No directory present."},
    {CAT_STAT_PATH_IS_DIRECTORY,        L"The path is a directory."},
    {CAT_STAT_PATH_IS_FILE,             L"The path is a file."},
    {CAT_STAT_PROMPT_OK,                L"OK"},
    {CAT_STAT_PROMPT_YES,               L"Yes"},
    {CAT_STAT_PROMPT_NO,                L"No"},
    {CAT_STAT_PROMPT_CANCEL,            L"Cancel"},
    {CAT_STAT_IN_PROGRESS,              L"Progress"},
    {CAT_STAT_IMAGE_ALREADY_LOADED,     L"Image already loaded."},
    {CAT_STAT_CONTROL_IMAGE_SIZE_MISMATCH, L"Image size mismatch in control."},
    {CAT_STAT_SKIN_WINDOW_ALREADY_OPEN, L"Window already open."},


    {CAT_STR_EMPTY,                     L""},
    {CAT_STR_USAGE,                     L"Usage:"},
    {CAT_STR_HELPDESC,                  L"Display Help."},    

    {CAT_ERROR,                         L"Error"},
    {CAT_ERR_NOT_IMPLEMENTED,           L"Feature not yet implemented."},
    {CAT_ERR_FILE_NOT_FOUND,            L"File not found."},
    {CAT_ERR_UNABLE_TO_OPEN_PROCESS,    L"Unable to open process."},
    {CAT_ERR_REMOTE_ALLOC_RAM,          L"Unable to allocate memory in remote process."},
    {CAT_ERR_REMOTE_WRITE,              L"Unable to write to remote process."},
    {CAT_ERR_REMOTE_CREATE_THREAD,      L"Unable to create a thread in the remote process."},
    {CAT_ERR_REMOTE_THREAD_TIMEOUT,     L"Remote thread timed out."},
    {CAT_ERR_REMOTE_THREAD_INVALID_EXIT,L"Remote thread exited with an error."},
    {CAT_ERR_PROCESS_CREATE,            L"Error creating process"},
    {CAT_ERR_INVALID_PARAM,             L"Invalid parameter"},
    {CAT_ERR_OUT_OF_MEMORY,             L"Out of memory"},
    {CAT_ERR_FILE_OPEN,                 L"Error opening file."},
    {CAT_ERR_FILE_READ,                 L"Error reading from file"},
    {CAT_ERR_FILE_HAS_OPEN_SUBSTREAMS,  L"Attempting to close a file with open substreams."},
    {CAT_ERR_FILE_NOT_OPEN,             L"The file has not been opened."},
    {CAT_ERR_FILE_UNSUPPORTED_MODE,     L"The requested open mode is not supported."},
    {CAT_ERR_FILE_WRITE,                L"Error writing to file."},
    {CAT_ERR_FILE_GET_POSITION,         L"Error retrieving file position."},
    {CAT_ERR_FILE_SEEK,                 L"Error seeking within file."},
    {CAT_ERR_FILE_SET_POSITION,         L"Error setting the file position."},
    {CAT_ERR_OPENING_SUBSTREAM,         L"Opening a substream is not a valid operation."},
    {CAT_ERR_CLOSING_SUBSTREAM,         L"Closing a substream is not a valid operation."},
    {CAT_ERR_SUBSTREAM_NO_PARENT,       L"Substream has no parent."},
    {CAT_ERR_WRITE_PAST_SPECIFIED_END,  L"A write request was made past the end of a substream."},
    {CAT_ERR_SEEK_PAST_SPECIFIED_END,   L"A seek request was made past the end of a substream."},
    {CAT_ERR_STRINGTABLE_NOT_FOUND,     L"Stringtable was not found for removal."},
    {CAT_ERR_CMD_TABLE_INVALID,         L"Invalid command table for command line parsing."},
    {CAT_ERR_CMD_INVALID_SWITCH,        L"Invalid switch on command line."},
    {CAT_ERR_CMD_NO_STRINGTABLE,        L"No string table."},
    {CAT_ERR_PARSE_CALLBACK_ABORT,      L"Callback during cmd line parsing aborted."},
    {CAT_ERR_ENUM_PROCS,                L"An error occurred enumerating processes."},
    {CAT_ERR_NO_MATCHING_PROC,          L"No matching process found."},
    {CAT_ERR_READING_TARGET_EXEC,       L"Error reading target executable."},
    {CAT_ERR_EXE_NOT_PE_FORMAT,         L"Target is not in Portable Executable format."},
    {CAT_ERR_CMDREQ_GROUP,              L"Required command-line group not found."},
    {CAT_ERR_CMDREQ_EXCLUSIVE_GROUP,    L"Multiple options set in exclusive group on command line."},
    {CAT_ERR_CMDREQ_OP,                 L"Required operand not found on command line."},
    {CAT_ERR_CMDREQ_SWITCH,             L"Required switch not found on command line."},
    {CAT_ERR_CMD_SWITCH_NO_ARG,         L"A switch on the command line is missing a required argument."},
    {CAT_ERR_UNPATCH_TIMEOUT,           L"Timed out waiting for target process patch."},
    {CAT_ERR_HOOK_PROTECT_FAILED,       L"Setting memory protections failed when hooking function."},
    {CAT_ERR_HOOK_NOT_FOUND,            L"Hook target function not found."},
    {CAT_ERR_HOOK_NOT_ENOUGH_BYTES,     L"Not enough bytes for push/jmp in hook."},
    {CAT_ERR_INTERCEPT_NO_DSOUND,       L"Could not find DirectSound DLL."},
    {CAT_ERR_XML_CREATE_FAILED,         L"Could not create XML object."},
    {CAT_ERR_XML_INVALID_ATTRIBUTE,     L"Invalid attribute in XML."},
    {CAT_ERR_XML_PARSER_INVALID_PATH,   L"Invalid XML path."},
    {CAT_ERR_XML_PARSER_OUT_OF_MEMORY,  L"XML Parser out of memory."},
    {CAT_ERR_XML_INVALID_XML,           L"Invalid XML file."},
    {CAT_ERR_IMAGE_NULL,                L"Null image."},
    {CAT_ERR_IMAGE_INVALID_SUB_POSITION,L"Invalid sub-image position."},
    {CAT_ERR_IMAGE_INVALID_SIZE,        L"Invalid image size."},
    {CAT_ERR_IMAGE_MUST_INITIALIZE,     L"Must initialize image first."},
    {CAT_ERR_IMAGE_FILL_OUT_OF_BOUNDS,  L"Image fill request is out of bounds."},
    {CAT_ERR_IMAGE_OPERATION_INVALID_ON_ROOT, L"The image operation is invalid on root image."},
    {CAT_ERR_IMAGE_EMPTY,               L"The image is empty."},
    {CAT_ERR_IMAGE_OUT_OF_RANGE,        L"Out of range of image size."},
    {CAT_ERR_IMAGE_OVERLAY_OUT_OF_BOUNDS, L"Image overlay out of range."},
    {CAT_ERR_PNG_ERROR_CREATING_READ,   L"Error creating read struct for .png image."},
    {CAT_ERR_PNG_UNSUPPORTED_FORMAT,    L"Unsupported PNG format - 3 or 4 channel only."},
    {CAT_ERR_IMAGE_UNKNOWN_FORMAT,      L"Unsupported image format."},
    {CAT_ERR_PNG_CORRUPT,               L".PNG image file is corrupt."},
    {CAT_ERR_PNG_ERROR_CREATING_WRITE,  L"Error creating write struct for .png image."},
    {CAT_ERR_PNG_WARNING,               L"Warning received from .png library."},
    {CAT_ERR_MUTEX_INVALID_HANDLE,      L"Invalid mutex handle."},
    {CAT_ERR_MUTEX_TIMEOUT,             L"Mutex timed out."},
    {CAT_ERR_MUTEX_WAIT_ERROR,          L"Error waiting on mutex."},
    {CAT_ERR_SIGNAL_INVALID_HANDLE,     L"Invalid handle for signal."},
    {CAT_ERR_SIGNAL_TIMEOUT,            L"Signal timed out."},
    {CAT_ERR_SIGNAL_WAIT_ERROR,         L"Error waiting for signal."},
    {CAT_ERR_FILE_ALREADY_EXISTS,       L"File already exists."},
    {CAT_ERR_PATH_EMPTY,                L"The path is empty."},
    {CAT_ERR_FILE_DOES_NOT_EXIST,       L"The file does not exist."},
    {CAT_ERR_FILE_IS_DIRECTORY,         L"The path is a directory."},
    {CAT_ERR_DIR_DOES_NOT_EXIST,        L"The directory does not exist."},
    {CAT_ERR_DIR_IS_FILE,               L"The path is a file."},
    {CAT_ERR_NULL_PARAM,                L"Null parameter."},
    {CAT_ERR_FILESYSTEM_CREATE_DIR,     L"Filesystem is unable to create the directory."},
    {CAT_ERR_PATH_DOES_NOT_EXIST,       L"The path does not exist."},
    {CAT_ERR_FIND_NO_MATCHES,           L"No matches found."},
    {CAT_ERR_FIND_CALL_FINDFIRST,       L"Must call FindFirst before FindNext."},
    {CAT_ERR_FIND_END,                  L"No more matches."},
    {CAT_ERR_SKIN_XPIN_MISUSE,          L"XPos must be positive, XPin must be negative, and Width may not be used for scaled skin controls."},
    {CAT_ERR_SKIN_YPIN_MISUSE,          L"YPos must be positive, YPin must be negative, and Width may not be used for scaled skin controls."},
    {CAT_ERR_QUEUE_EMPTY,               L"Queue is empty."},
    {CAT_ERR_FILE_CORRUPTED,            L"File is corrupted."},
    {CAT_ERR_FILE_ACCESS_DENIED,        L"Access denied to file."},
    {CAT_ERR_EXECUTE_FAILED,            L"Failed to execute file."},
    {CAT_ERR_WINDOW_CLASSREG_FAILED,    L"Window class registration failed."},
    {CAT_ERR_WINDOW_CREATE_FAILED,      L"Window creation failed."},
    {CAT_ERR_STACK_EMPTY,               L"Stack is empty."},
    {CAT_ERR_NO_HELP_AVAILABLE,         L"No help available."},
    {CAT_ERR_FILEOPEN_CANCELLED,        L"File Open dialog was cancelled."},
    {CAT_ERR_FILESAVE_CANCELLED,        L"File Save dialog was cancelled."},
    {CAT_ERR_COMBO_MENU_NOT_FOUND,      L"Combo control is missing a menu."},
    {CAT_ERR_COMBO_EDIT_NOT_FOUND,      L"Combo control is missing an edit box."},
    {CAT_ERR_CONTROL_NO_IMAGE,          L"No image found for control."},    
    {CAT_ERR_GUIFACTORY_UNKNOWN_TYPE,   L"GUIFactory - control type not found!"},
    {CAT_ERR_LIST_ITEM_NOT_FOUND,       L"Item not found in list."},
    {CAT_ERR_LIST_OUT_OF_RANGE,         L"Item out of range in list."},
    {CAT_ERR_SKIN_WINDOW_NOT_FOUND,     L"Window skin not found."},
    {CAT_ERR_SKIN_WINDOW_NOT_OPEN,      L"Window not open."},
    {CAT_ERR_INVALID_TAB,               L"Invalid tab index."},
    {CAT_ERR_CONTROL_NOT_FOUND,         L"Control not found."},
    {CAT_ERR_CMD_NOT_FOUND,             L"Command not found."},
    {CAT_ERR_TREE_ITEM_NOT_FOUND,       L"Tree item not found."},
    {CAT_ERR_TREE_INSERT_ERROR,         L"Error inserting item into tree."},
    {CAT_ERR_TREE_REMOVE_ERROR,         L"Error removing item from tree."},
    {CAT_ERR_TREE_SET_ITEM_ERROR,       L"Error setting tree item."},
    {CAT_ERR_IMAGELIST_FAILED,          L"Imagelist failed."},
    {CAT_ERR_PREFS_NO_FILESYSTEM,       L"No filesystem for prefs."},
    {CAT_ERR_STREAM_INVALID,            L"Stream invalid."},
    {CAT_ERR_NOT_INITIALIZED,           L"Object is not initialized."},
    {CAT_ERR_CORE_LAST,                 0}
};

CATStringTableCore::CATStringTableCore()
: CATStringTable()
{
}

CATStringTableCore::~CATStringTableCore()
{
}

const CATWChar* CATStringTableCore::GetString(CATResult     stringId,
                                              CATLangId     languageId) const
{
    // Check subtables
    const CATWChar* stringVal = CATStringTable::GetString(stringId,languageId);    
    if (stringVal)
        return stringVal;

    // Not in subtables, scan local table. We're currently ignoring language id here.
    CATStringEntry* entry = (CATStringEntry*)&kCATStringEntries;
    while (entry->resultCode != CAT_ERR_CORE_LAST)
    {
        if (stringId == entry->resultCode)
        {
            return entry->resultString;
        }
        ++entry;
    }
    
    // Just plain not found.
    return 0;
}

---