public/IMemoryUtils.h
author mr.e.unk <mr.e.unk@gmail.com>
Sun Feb 01 20:39:23 2009 -0500 (2009-02-01)
changeset 2564 e4cd7bb48e7c
parent 2289 44045ead61cd
child 2863 d740d9cdf53a
permissions -rw-r--r--
Removed RTV section from maplists.cfg. (bug 3611 r=Liam)
ds@700
     1
/**
ds@700
     2
 * vim: set ts=4 :
ds@1330
     3
 * =============================================================================
dvander@1226
     4
 * SourceMod
ds@1947
     5
 * Copyright (C) 2004-2008 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
 * Version: $Id$
ds@700
    30
 */
ds@700
    31
ds@700
    32
#ifndef _INCLUDE_SOURCEMOD_INTERFACE_BINARYUTILS_H_
ds@700
    33
#define _INCLUDE_SOURCEMOD_INTERFACE_BINARYUTILS_H_
ds@700
    34
ds@700
    35
#include <IShareSys.h>
ds@700
    36
ds@700
    37
#define SMINTERFACE_MEMORYUTILS_NAME		"IMemoryUtils"
ds@700
    38
#define SMINTERFACE_MEMORYUTILS_VERSION		1
ds@700
    39
dvander@1680
    40
/**
dvander@1680
    41
 * @file IMemoryUtils.h
dvander@1680
    42
 * @brief Interface for finding patterns in memory.
dvander@1680
    43
 */
dvander@1680
    44
ds@700
    45
namespace SourceMod
ds@700
    46
{
ds@700
    47
	class IMemoryUtils : public SMInterface
ds@700
    48
	{
ds@700
    49
	public:
ds@700
    50
		const char *GetInterfaceName()
ds@700
    51
		{
ds@700
    52
			return SMINTERFACE_MEMORYUTILS_NAME;
ds@700
    53
		}
ds@700
    54
		unsigned int GetInterfaceVersion()
ds@700
    55
		{
ds@700
    56
			return SMINTERFACE_MEMORYUTILS_VERSION;
ds@700
    57
		}
ds@700
    58
	public:
ds@700
    59
		/**
ds@700
    60
		 * @brief Searches for a pattern of bytes within the memory of a dynamic library.
ds@700
    61
		 *
ds@700
    62
		 * @param libPtr	Pointer to any chunk of memory that resides in the dynamic library.
ds@700
    63
		 * @param pattern	Pattern of bytes to search for. 0x2A can be used as a wildcard.
ds@700
    64
		 * @param len		Size of the pattern in bytes.
ds@700
    65
		 * @return			Pointer to pattern found in memory, NULL if not found.
ds@700
    66
		 */
ds@701
    67
		virtual void *FindPattern(const void *libPtr, const char *pattern, size_t len) =0;
ds@700
    68
	};
ds@700
    69
}
ds@700
    70
ds@700
    71
#endif // _INCLUDE_SOURCEMOD_INTERFACE_MEMORYUTILS_H_