Home - sourcemod-central - file revision - public/IMemoryUtils.h@8abb0924497b Mercurial
summary | shortlog | changelog | graph | tags | branches | files | changeset | file | latest | revisions | annotate | diff | raw | help
public/IMemoryUtils.h
author Nicholas Hastings <skamonkey@gmail.com>
Tue Mar 19 11:19:19 2013 -0400 (2013-03-19)
changeset 3854 8abb0924497b
parent 2992 affc67b319f4
permissions -rw-r--r--
Tweaked Dota 2 support to account for lack of IPluginHelpers (bug 5656, r=asherkin). 
     1 /**
     2  * vim: set ts=4 sw=4 tw=99 noet :
     3  * =============================================================================
     4  * SourceMod
     5  * Copyright (C) 2004-2009 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 
    30 #ifndef _INCLUDE_SOURCEMOD_INTERFACE_BINARYUTILS_H_
    31 #define _INCLUDE_SOURCEMOD_INTERFACE_BINARYUTILS_H_
    32 
    33 #include <IShareSys.h>
    34 
    35 #define SMINTERFACE_MEMORYUTILS_NAME		"IMemoryUtils"
    36 #define SMINTERFACE_MEMORYUTILS_VERSION		2
    37 
    38 /**
    39  * @file IMemoryUtils.h
    40  * @brief Interface for finding patterns in memory.
    41  */
    42 
    43 namespace SourceMod
    44 {
    45 	class IMemoryUtils : public SMInterface
    46 	{
    47 	public:
    48 		const char *GetInterfaceName()
    49 		{
    50 			return SMINTERFACE_MEMORYUTILS_NAME;
    51 		}
    52 		unsigned int GetInterfaceVersion()
    53 		{
    54 			return SMINTERFACE_MEMORYUTILS_VERSION;
    55 		}
    56 	public:
    57 		/**
    58 		 * @brief Searches for a pattern of bytes within the memory of a dynamic library.
    59 		 *
    60 		 * @param libPtr	Pointer to any chunk of memory that resides in the dynamic library.
    61 		 * @param pattern	Pattern of bytes to search for. 0x2A can be used as a wildcard.
    62 		 * @param len		Size of the pattern in bytes.
    63 		 * @return			Pointer to pattern found in memory, NULL if not found.
    64 		 */
    65 		virtual void *FindPattern(const void *libPtr, const char *pattern, size_t len) =0;
    66 
    67 		/**
    68 		 * @brief Retrieves a symbol pointer from a dynamic library.
    69 		 *
    70 		 * Note: On Linux and Mac OS X, this function is able to resolve symbols that are hidden
    71 		 * via GCC's -fvisibility=hidden option.
    72 		 *
    73 		 * Note: On Mac OS X, the symbol name should be passed without the prepended underscore,
    74 		 * as this is how dlsym() would expect it.
    75 		 *
    76 		 * @param handle	Operating system specific handle that points to dynamic library.
    77 		 *					This comes from dlopen() on Linux/OS X or LoadLibrary() on Windows.
    78 		 * @param symbol	Symbol name.
    79 		 * @return			Symbol pointer, or NULL if not found.
    80 		 */
    81 		virtual void *ResolveSymbol(void *handle, const char *symbol) =0;
    82 	};
    83 }
    84 
    85 #endif // _INCLUDE_SOURCEMOD_INTERFACE_MEMORYUTILS_H_
sourcemod-central
Feed