dvander@233: /** dvander@374: * =============================================================== dvander@374: * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved. dvander@374: * =============================================================== dvander@374: * dvander@374: * This file is part of the SourceMod/SourcePawn SDK. This file may only be used dvander@374: * or modified under the Terms and Conditions of its License Agreement, which is found dvander@374: * in LICENSE.txt. The Terms and Conditions for making SourceMod extensions/plugins dvander@374: * may change at any time. To view the latest information, see: dvander@374: * http://www.sourcemod.net/license.php dvander@374: * dvander@374: * Version: $Id$ dvander@233: */ dvander@374: dvander@233: #if defined _string_included dvander@233: #endinput dvander@233: #endif dvander@233: #define _string_included dvander@233: dvander@233: /** dvander@233: * @GLOBAL@ dvander@233: * Unless otherwise noted, all string functions which take in a writable buffer and maximum length dvander@233: * should have the null terminator INCLUDED in the length. This means that this is valid: dvander@233: * StrCopy(string, sizeof(string), ...) dvander@233: */ dvander@233: dvander@233: /** dvander@233: * Calculates the length of a string. dvander@233: * dvander@233: * @param str String to check. dvander@233: * @return Length of string, in cells (NOT characters). dvander@233: */ dvander@233: native strlen(const String:str[]); dvander@233: dvander@233: /** dvander@233: * Tests whether a string is found inside another string. dvander@233: * dvander@233: * @param str String to search in. dvander@233: * @param substr Substring to find inside the original string. dvander@233: * @param caseSensitive If true (default), search is case sensitive. dvander@233: * If false, search is case insensitive. dvander@233: * @return -1 on failure (no match found). Any other value dvander@233: * indicates a position in the string where the match starts. dvander@233: */ dvander@233: native StrContains(const String:str[], const String:substr[], bool:caseSensitive=true); dvander@233: dvander@233: /** dvander@233: * Compares two strings lexographically. dvander@233: * dvander@233: * @param str1 First string (left). dvander@233: * @param str2 Second string (right). dvander@233: * @param caseSensitive If true (default), comparison is case sensitive. dvander@233: * If false, comparison is case insensitive. dvander@233: * @return -1 if str1 < str2 dvander@233: * 0 if str1 == str2 dvander@233: * 1 if str1 > str2 dvander@233: */ dvander@233: native StrCompare(const String:str1[], const String:str2[], bool:caseSensitive=true); dvander@233: dvander@233: /** dvander@233: * Returns whether two strings are equal. dvander@233: * dvander@233: * dvander@233: * @param str1 First string (left). dvander@233: * @param str2 Second string (right). dvander@233: * @param caseSensitive If true (default), comparison is case sensitive. dvander@412: * If false, comparison is case insensitive. dvander@412: * @return True if equal, false otherwise. dvander@233: */ faluco@234: stock bool:StrEqual(const String:str1[], const String:str2[], bool:caseSensitive=true) dvander@233: { faluco@234: return (StrCompare(str1, str2, caseSensitive) == 0); dvander@233: } dvander@233: dvander@233: /** dvander@233: * Copies one string to another string. dvander@233: * NOTE: If the destination buffer is too small to hold the source string, dvander@233: * the destination will be truncated. dvander@233: * dvander@233: * @param dest Destination string buffer to copy to. dvander@233: * @param destlen Destination buffer length (includes null terminator). dvander@233: * @param source Source string buffer to copy from. dvander@412: * @return Number of cells written. dvander@233: */ dvander@233: native StrCopy(String:dest[], destLen, const String:source[]); dvander@233: dvander@233: /** dvander@257: * Formats a string according to the SourceMod format rules (see documentation). dvander@257: * dvander@257: * @param buffer Destination string buffer. dvander@257: * @param maxlength Maximum length of output string buffer. dvander@257: * @param format Formatting rules. dvander@257: * @param ... Variable number of format parameters. dvander@412: * @return Number of cells written. dvander@257: */ dvander@257: native Format(String:buffer[], maxlength, const String:format[], {Handle,Float,String,_}:...); dvander@257: dvander@257: /** dvander@257: * Formats a string according to the SourceMod format rules (see documentation). dvander@257: * @note This is the same as Format(), except none of the input buffers can overlap the same dvander@257: * memory as the output buffer. Since this security check is removed, it is slightly faster. dvander@257: * dvander@257: * @param buffer Destination string buffer. dvander@257: * @param maxlength Maximum length of output string buffer. dvander@257: * @param format Formatting rules. dvander@257: * @param ... Variable number of format parameters. dvander@412: * @return Number of cells written. dvander@257: */ dvander@257: native FormatEx(String:buffer[], maxlength, const String:format[], {Handle,Float,String,_}:...); dvander@257: dvander@257: /** dvander@412: * Formats a string according to the SourceMod format rules (see documentation). dvander@412: * @note This is the same as Format(), except it grabs parameters from a parent parameter dvander@412: * stack, rather than a local. This is useful for implementing your own variable argument dvander@412: * functions. dvander@412: * dvander@412: * @param buffer Destination string buffer. dvander@412: * @param maxlength Maximum length of output string buffer. dvander@412: * @param format Formatting rules. dvander@412: * @param varpos Argument number which contains the '...' symbol. dvander@412: * Note: Arguments start at 1. dvander@412: * @return Number of bytes written. dvander@412: */ dvander@412: native VFormat(String:buffer[], maxlength, const String:format[], varpos); dvander@412: dvander@412: /** dvander@233: * Converts a string to an integer. dvander@233: * dvander@233: * @param str String to convert. dvander@412: * @param nBase Numerical base to use. 10 is default. dvander@412: * @return Integer conversion of string, or 0 on failure. dvander@233: */ dvander@233: native StringToInt(const String:str[], nBase=10); dvander@233: dvander@233: /** dvander@233: * Converts an integer to a string. dvander@233: * dvander@451: * @param num Integer to convert. dvander@233: * @param str Buffer to store string in. dvander@233: * @param maxlength Maximum length of string buffer. dvander@412: * @return Number of cells written to buffer. dvander@233: */ dvander@451: native IntToString(num, String:str[], maxlength); dvander@233: dvander@233: /** dvander@233: * Converts a string to a floating point number. dvander@233: * dvander@233: * @param str String to convert to a foat. dvander@412: * @return Floating point result, or 0.0 on error. dvander@233: */ dvander@233: native Float:StringToFloat(const String:str[]); dvander@233: dvander@233: /** dvander@233: * Converts a floating point number to a string. dvander@233: * dvander@233: * @param str Buffer to store string in. dvander@233: * @param maxlength Maximum length of string buffer. dvander@233: * @param num Floating point number to convert. dvander@412: * @return Number of cells written to buffer. dvander@233: */ faluco@234: native FloatToString(String:str[], maxlength, Float:num);