public/IMemoryUtils.h
author Nicholas Hastings <skamonkey@gmail.com>
Wed Aug 14 14:20:57 2013 -0400 (2013-08-14)
changeset 4008 490b01aa0683
parent 2992 affc67b319f4
permissions -rw-r--r--
Updated some CS:GO gamedata.
ds@700
     1
/**
ds@2863
     2
 * vim: set ts=4 sw=4 tw=99 noet :
ds@1330
     3
 * =============================================================================
dvander@1226
     4
 * SourceMod
ds@2863
     5
 * Copyright (C) 2004-2009 AlliedModders LLC.  All rights reserved.
ds@1330
     6
 * =============================================================================
ds@700
     7
 *
ds@1330
     8
 * This program is free software; you can redistribute it and/or modify it under
ds@1330
     9
 * the terms of the GNU General Public License, version 3.0, as published by the
ds@1330
    10
 * Free Software Foundation.
ds@700
    11
 * 
ds@1330
    12
 * This program is distributed in the hope that it will be useful, but WITHOUT
ds@1330
    13
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
ds@1330
    14
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
ds@1330
    15
 * details.
dvander@1226
    16
 *
ds@1330
    17
 * You should have received a copy of the GNU General Public License along with
ds@1330
    18
 * this program.  If not, see <http://www.gnu.org/licenses/>.
dvander@1226
    19
 *
ds@1330
    20
 * As a special exception, AlliedModders LLC gives you permission to link the
ds@1330
    21
 * code of this program (as well as its derivative works) to "Half-Life 2," the
ds@1330
    22
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
ds@1330
    23
 * by the Valve Corporation.  You must obey the GNU General Public License in
ds@1330
    24
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
ds@1330
    25
 * this exception to all derivative works.  AlliedModders LLC defines further
ds@1330
    26
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
ds@1330
    27
 * or <http://www.sourcemod.net/license.php>.
ds@700
    28
 */
ds@700
    29
ds@700
    30
#ifndef _INCLUDE_SOURCEMOD_INTERFACE_BINARYUTILS_H_
ds@700
    31
#define _INCLUDE_SOURCEMOD_INTERFACE_BINARYUTILS_H_
ds@700
    32
ds@700
    33
#include <IShareSys.h>
ds@700
    34
ds@700
    35
#define SMINTERFACE_MEMORYUTILS_NAME		"IMemoryUtils"
ds@2863
    36
#define SMINTERFACE_MEMORYUTILS_VERSION		2
ds@700
    37
dvander@1680
    38
/**
dvander@1680
    39
 * @file IMemoryUtils.h
dvander@1680
    40
 * @brief Interface for finding patterns in memory.
dvander@1680
    41
 */
dvander@1680
    42
ds@700
    43
namespace SourceMod
ds@700
    44
{
ds@700
    45
	class IMemoryUtils : public SMInterface
ds@700
    46
	{
ds@700
    47
	public:
ds@700
    48
		const char *GetInterfaceName()
ds@700
    49
		{
ds@700
    50
			return SMINTERFACE_MEMORYUTILS_NAME;
ds@700
    51
		}
ds@700
    52
		unsigned int GetInterfaceVersion()
ds@700
    53
		{
ds@700
    54
			return SMINTERFACE_MEMORYUTILS_VERSION;
ds@700
    55
		}
ds@700
    56
	public:
ds@700
    57
		/**
ds@700
    58
		 * @brief Searches for a pattern of bytes within the memory of a dynamic library.
ds@700
    59
		 *
ds@700
    60
		 * @param libPtr	Pointer to any chunk of memory that resides in the dynamic library.
ds@700
    61
		 * @param pattern	Pattern of bytes to search for. 0x2A can be used as a wildcard.
ds@700
    62
		 * @param len		Size of the pattern in bytes.
ds@700
    63
		 * @return			Pointer to pattern found in memory, NULL if not found.
ds@700
    64
		 */
ds@701
    65
		virtual void *FindPattern(const void *libPtr, const char *pattern, size_t len) =0;
ds@2863
    66
ds@2863
    67
		/**
ds@2863
    68
		 * @brief Retrieves a symbol pointer from a dynamic library.
ds@2863
    69
		 *
ds@2992
    70
		 * Note: On Linux and Mac OS X, this function is able to resolve symbols that are hidden
ds@2992
    71
		 * via GCC's -fvisibility=hidden option.
ds@2992
    72
		 *
ds@2992
    73
		 * Note: On Mac OS X, the symbol name should be passed without the prepended underscore,
ds@2992
    74
		 * as this is how dlsym() would expect it.
ds@2863
    75
		 *
ds@2863
    76
		 * @param handle	Operating system specific handle that points to dynamic library.
ds@2992
    77
		 *					This comes from dlopen() on Linux/OS X or LoadLibrary() on Windows.
ds@2863
    78
		 * @param symbol	Symbol name.
ds@2863
    79
		 * @return			Symbol pointer, or NULL if not found.
ds@2863
    80
		 */
ds@2863
    81
		virtual void *ResolveSymbol(void *handle, const char *symbol) =0;
ds@700
    82
	};
ds@700
    83
}
ds@700
    84
ds@700
    85
#endif // _INCLUDE_SOURCEMOD_INTERFACE_MEMORYUTILS_H_