public/IMemoryUtils.h
author Matt Woodrow <pred@alliedmods.net>
Sun Jul 06 03:30:06 2008 +0000 (2008-07-06)
changeset 2165 ca3757e676f6
parent 1952 b7aa2b626807
child 2289 44045ead61cd
permissions -rw-r--r--
Fixed requiring dependencies at the wrong time.
     1 /**
     2  * vim: set ts=4 :
     3  * =============================================================================
     4  * SourceMod
     5  * Copyright (C) 2004-2008 AlliedModders LLC.  All rights reserved.
     6  * =============================================================================
     7  *
     8  * This program is free software; you can redistribute it and/or modify it under
     9  * the terms of the GNU General Public License, version 3.0, as published by the
    10  * Free Software Foundation.
    11  * 
    12  * This program is distributed in the hope that it will be useful, but WITHOUT
    13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
    15  * details.
    16  *
    17  * You should have received a copy of the GNU General Public License along with
    18  * this program.  If not, see <http://www.gnu.org/licenses/>.
    19  *
    20  * As a special exception, AlliedModders LLC gives you permission to link the
    21  * code of this program (as well as its derivative works) to "Half-Life 2," the
    22  * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
    23  * by the Valve Corporation.  You must obey the GNU General Public License in
    24  * all respects for all other code used.  Additionally, AlliedModders LLC grants
    25  * this exception to all derivative works.  AlliedModders LLC defines further
    26  * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
    27  * or <http://www.sourcemod.net/license.php>.
    28  *
    29  * Version: $Id$
    30  */
    31 
    32 #ifndef _INCLUDE_SOURCEMOD_INTERFACE_BINARYUTILS_H_
    33 #define _INCLUDE_SOURCEMOD_INTERFACE_BINARYUTILS_H_
    34 
    35 #include <IShareSys.h>
    36 
    37 #define SMINTERFACE_MEMORYUTILS_NAME		"IMemoryUtils"
    38 #define SMINTERFACE_MEMORYUTILS_VERSION		1
    39 
    40 /**
    41  * @file IMemoryUtils.h
    42  * @brief Interface for finding patterns in memory.
    43  */
    44 
    45 namespace SourceMod
    46 {
    47 	class IMemoryUtils : public SMInterface
    48 	{
    49 	public:
    50 		const char *GetInterfaceName()
    51 		{
    52 			return SMINTERFACE_MEMORYUTILS_NAME;
    53 		}
    54 		unsigned int GetInterfaceVersion()
    55 		{
    56 			return SMINTERFACE_MEMORYUTILS_VERSION;
    57 		}
    58 	public:
    59 		/**
    60 		 * @brief Searches for a pattern of bytes within the memory of a dynamic library.
    61 		 *
    62 		 * @param libPtr	Pointer to any chunk of memory that resides in the dynamic library.
    63 		 * @param pattern	Pattern of bytes to search for. 0x2A can be used as a wildcard.
    64 		 * @param len		Size of the pattern in bytes.
    65 		 * @return			Pointer to pattern found in memory, NULL if not found.
    66 		 */
    67 		virtual void *FindPattern(const void *libPtr, const char *pattern, size_t len) =0;
    68 	};
    69 }
    70 
    71 #endif // _INCLUDE_SOURCEMOD_INTERFACE_MEMORYUTILS_H_