core-legacy/util.h
author David Anderson <dvander@alliedmods.net>
Mon Nov 18 11:22:15 2013 -0800 (2013-11-18)
changeset 881 9c07bcf2b4d4
parent 661 952a16ae1d2b
permissions -rw-r--r--
Push build.
dvander@541
     1
/* ======== SourceMM ========
dvander@541
     2
 * Copyright (C) 2004-2008 Metamod:Source Development Team
dvander@541
     3
 * No warranties of any kind
dvander@541
     4
 *
dvander@541
     5
 * License: zlib/libpng
dvander@541
     6
 *
dvander@541
     7
 * Author(s): David "BAILOPAN" Anderson
dvander@541
     8
 * ============================
dvander@541
     9
 */
dvander@541
    10
dvander@541
    11
#ifndef _INCLUDE_UTIL_H
dvander@541
    12
#define _INCLUDE_UTIL_H
dvander@541
    13
dvander@541
    14
#include <stdarg.h>
dvander@661
    15
#include "sourcehook/sourcehook.h"
dvander@541
    16
dvander@541
    17
/**
dvander@541
    18
 * @brief Utility functions
dvander@541
    19
 * @file util.h
dvander@541
    20
 */
dvander@541
    21
dvander@541
    22
#define IA32_JMP_IMM32 '\xE9'
dvander@541
    23
dvander@541
    24
/**
dvander@541
    25
 * @brief Returns a pointer to the extension in a file name.
dvander@541
    26
 */
dvander@541
    27
const char *UTIL_GetExtension(const char *file);
dvander@541
    28
dvander@541
    29
/**
dvander@541
    30
 * @brief Removes whitespace characters from left side of string.
dvander@541
    31
 */
dvander@541
    32
void UTIL_TrimLeft(char *buffer);
dvander@541
    33
dvander@541
    34
/**
dvander@541
    35
 * @brief Removes whitespace characters from right side of string.
dvander@541
    36
 */
dvander@541
    37
void UTIL_TrimRight(char *buffer);
dvander@541
    38
dvander@541
    39
/**
dvander@541
    40
 * @brief Compares two file paths.
dvander@541
    41
 */
dvander@541
    42
bool UTIL_PathCmp(const char *path1, const char *path2);
dvander@541
    43
dvander@541
    44
/**
dvander@541
    45
 * @brief Same as snprintf except that it ensures the string buffer is null terminated.
dvander@541
    46
 */
dvander@541
    47
size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...);
dvander@541
    48
dvander@541
    49
/**
dvander@541
    50
 * @brief Same as vsnprintf except that it ensures the string buffer is null terminated.
dvander@541
    51
 */
dvander@541
    52
size_t UTIL_FormatArgs(char *buffer, size_t maxlength, const char *fmt, va_list params);
dvander@541
    53
dvander@541
    54
/**
dvander@541
    55
 * @brief Forms a relative path given two absolute paths.
dvander@541
    56
 *
dvander@541
    57
 * @param buffer		Buffer to store relative path in.
dvander@541
    58
 * @param maxlength		Maximum length of the output buffer.
dvander@541
    59
 * @param relTo			Destination folder to use as a working directory.
dvander@541
    60
 *						Final folder name should not be pathchar-terminated.
dvander@541
    61
 * @param relFrom		Source file or folder to use as a target.
dvander@541
    62
 * @return				True on success, false on failure.
dvander@541
    63
 */
dvander@541
    64
bool UTIL_Relatize(char buffer[],
dvander@541
    65
				   size_t maxlength,
dvander@541
    66
				   const char *relTo,
dvander@541
    67
				   const char *relFrom);
dvander@541
    68
dvander@541
    69
/**
dvander@541
    70
 * @brief Compares memory address against a signature.
dvander@541
    71
 *
dvander@541
    72
 * @param addr			Memory address to check.
dvander@541
    73
 * @param sig			Signature used to check against memory address. Accept 0x2A as wildcard.
dvander@541
    74
 * @param len			Length of signature.
dvander@541
    75
 * @return				True if signature was verified, false otherwise.
dvander@541
    76
 */
dvander@541
    77
bool UTIL_VerifySignature(const void *addr, const char *sig, size_t len);
dvander@541
    78
dvander@541
    79
/**
dvander@541
    80
 * @brief Returns the original function address of a given virtual function.
dvander@541
    81
 *
dvander@541
    82
 * @param mfp			Member function pointer to virtual function.
dvander@541
    83
 * @param ptr			Pointer to interface in which the virtual function belongs.
dvander@541
    84
 * @return				Address of function originally pointed to by the virtual function.
dvander@541
    85
 */
dvander@541
    86
template <class MFP, class Iface>
dvander@659
    87
char *UTIL_GetOrigFunction(MFP vfunc, Iface *ptr)
dvander@541
    88
{
dvander@541
    89
	SourceHook::MemFuncInfo info = {true, -1, 0, 0};
dvander@541
    90
	SourceHook::GetFuncInfo(vfunc, info);
dvander@541
    91
dvander@541
    92
	/* Get address of original GetUserMessageInfo() */
dvander@659
    93
	char *func = reinterpret_cast<char *>(SH_GET_ORIG_VFNPTR_ENTRY(ptr, vfunc));
dvander@541
    94
dvander@541
    95
	/* Check for relative jumps */
dvander@541
    96
	if (func[0] == IA32_JMP_IMM32)
dvander@541
    97
	{
dvander@541
    98
		/* Get address from displacement...
dvander@541
    99
		 *
dvander@541
   100
		 * Add 5 because it's relative to next instruction:
dvander@541
   101
		 * Opcode <1 byte> + 32-bit displacement <4 bytes> 
dvander@541
   102
		 */
dvander@541
   103
		func += *reinterpret_cast<unsigned long *>(func + 1) + 5;
dvander@541
   104
	}
dvander@541
   105
dvander@541
   106
	return func;
dvander@541
   107
}
dvander@541
   108
dvander@541
   109
#endif //_INCLUDE_UTIL_H