summaryrefslogtreecommitdiff
path: root/sourcemod/scripting/include/string.inc
diff options
context:
space:
mode:
Diffstat (limited to 'sourcemod/scripting/include/string.inc')
-rw-r--r--sourcemod/scripting/include/string.inc590
1 files changed, 0 insertions, 590 deletions
diff --git a/sourcemod/scripting/include/string.inc b/sourcemod/scripting/include/string.inc
deleted file mode 100644
index 4034d45..0000000
--- a/sourcemod/scripting/include/string.inc
+++ /dev/null
@@ -1,590 +0,0 @@
-/**
- * vim: set ts=4 :
- * =============================================================================
- * SourceMod (C)2004-2008 AlliedModders LLC. All rights reserved.
- * =============================================================================
- *
- * This file is part of the SourceMod/SourcePawn SDK.
- *
- * This program is free software; you can redistribute it and/or modify it under
- * the terms of the GNU General Public License, version 3.0, as published by the
- * Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
- * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
- * details.
- *
- * You should have received a copy of the GNU General Public License along with
- * this program. If not, see <http://www.gnu.org/licenses/>.
- *
- * As a special exception, AlliedModders LLC gives you permission to link the
- * code of this program (as well as its derivative works) to "Half-Life 2," the
- * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
- * by the Valve Corporation. You must obey the GNU General Public License in
- * all respects for all other code used. Additionally, AlliedModders LLC grants
- * this exception to all derivative works. AlliedModders LLC defines further
- * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
- * or <http://www.sourcemod.net/license.php>.
- *
- * Version: $Id$
- */
-
-#if defined _string_included
- #endinput
-#endif
-#define _string_included
-
-/**
- * @global Unless otherwise noted, all string functions which take in a
- * writable buffer and maximum length should have the null terminator INCLUDED
- * in the length. This means that this is valid:
- * strcopy(string, sizeof(string), ...)
- */
-
-/**
- * Calculates the length of a string.
- *
- * @param str String to check.
- * @return Number of valid character bytes in the string.
- */
-native int strlen(const char[] str);
-
-/**
- * Tests whether a string is found inside another string.
- *
- * @param str String to search in.
- * @param substr Substring to find inside the original string.
- * @param caseSensitive If true (default), search is case sensitive.
- * If false, search is case insensitive.
- * @return -1 on failure (no match found). Any other value
- * indicates a position in the string where the match starts.
- */
-native int StrContains(const char[] str, const char[] substr, bool caseSensitive=true);
-
-/**
- * Compares two strings lexographically.
- *
- * @param str1 First string (left).
- * @param str2 Second string (right).
- * @param caseSensitive If true (default), comparison is case sensitive.
- * If false, comparison is case insensitive.
- * @return -1 if str1 < str2
- * 0 if str1 == str2
- * 1 if str1 > str2
- */
-native int strcmp(const char[] str1, const char[] str2, bool caseSensitive=true);
-
-/**
- * Compares two strings parts lexographically.
- *
- * @param str1 First string (left).
- * @param str2 Second string (right).
- * @param num Number of characters to compare.
- * @param caseSensitive If true (default), comparison is case sensitive.
- * If false, comparison is case insensitive.
- * @return -1 if str1 < str2
- * 0 if str1 == str2
- * 1 if str1 > str2
- */
-native int strncmp(const char[] str1, const char[] str2, int num, bool caseSensitive=true);
-
-/**
- * Backwards compatible stock - StrCompare is now strcmp
- * @deprecated Renamed to strcmp
- */
-#pragma deprecated Use strcmp() instead
-stock int StrCompare(const char[] str1, const char[] str2, bool caseSensitive=true)
-{
- return strcmp(str1, str2, caseSensitive);
-}
-
-/**
- * Returns whether two strings are equal.
- *
- * @param str1 First string (left).
- * @param str2 Second string (right).
- * @param caseSensitive If true (default), comparison is case sensitive.
- * If false, comparison is case insensitive.
- * @return True if equal, false otherwise.
- */
-stock bool StrEqual(const char[] str1, const char[] str2, bool caseSensitive=true)
-{
- return (strcmp(str1, str2, caseSensitive) == 0);
-}
-
-/**
- * Copies one string to another string.
- * @note If the destination buffer is too small to hold the source string, the
- * destination will be truncated.
- *
- * @param dest Destination string buffer to copy to.
- * @param destLen Destination buffer length (includes null terminator).
- * @param source Source string buffer to copy from.
- * @return Number of characters written to the buffer,
- * not including the null terminator.
- */
-native int strcopy(char[] dest, int destLen, const char[] source);
-
-/**
- * Backwards compatibility stock - use strcopy
- * @deprecated Renamed to strcopy
- */
-#pragma deprecated Use strcopy() instead
-stock int StrCopy(char[] dest, int destLen, const char[] source)
-{
- return strcopy(dest, destLen, source);
-}
-
-/**
- * Formats a string according to the SourceMod format rules (see documentation).
- *
- * @param buffer Destination string buffer.
- * @param maxlength Maximum length of output string buffer.
- * @param format Formatting rules.
- * @param ... Variable number of format parameters.
- * @return Number of characters written to the buffer,
- * not including the null terminator.
- */
-native int Format(char[] buffer, int maxlength, const char[] format, any ...);
-
-/**
- * Formats a string according to the SourceMod format rules (see documentation).
- * @note This is the same as Format(), except none of the input buffers can
- * overlap the same memory as the output buffer. Since this security
- * check is removed, it is slightly faster.
- *
- * @param buffer Destination string buffer.
- * @param maxlength Maximum length of output string buffer.
- * @param format Formatting rules.
- * @param ... Variable number of format parameters.
- * @return Number of characters written to the buffer,
- * not including the null terminator.
- */
-native int FormatEx(char[] buffer, int maxlength, const char[] format, any ...);
-
-/**
- * Formats a string according to the SourceMod format rules (see documentation).
- * @note This is the same as Format(), except it grabs parameters from a
- * parent parameter stack, rather than a local. This is useful for
- * implementing your own variable argument functions.
- *
- * @param buffer Destination string buffer.
- * @param maxlength Maximum length of output string buffer.
- * @param format Formatting rules.
- * @param varpos Argument number which contains the '...' symbol.
- * Note: Arguments start at 1.
- * @return Number of bytes written.
- * @error Invalid argument index.
- */
-native int VFormat(char[] buffer, int maxlength, const char[] format, int varpos);
-
-/**
- * Converts a string to an integer.
- *
- * @param str String to convert.
- * @param nBase Numerical base to use. 10 is default.
- * @return Integer conversion of string, or 0 on failure.
- */
-native int StringToInt(const char[] str, int nBase=10);
-
-/**
- * Converts a string to an integer with some more options.
- *
- * @param str String to convert.
- * @param result Variable to store the result in.
- * @param nBase Numerical base to use. 10 is default.
- * @return Number of characters consumed.
- */
-native int StringToIntEx(const char[] str, int &result, int nBase=10);
-
-/**
- * Converts a string to a 64-bit integer.
- *
- * @param str String to convert.
- * @param result Array to store the upper and lower
- * 32-bits of the 64-bit integer.
- * @param nBase Numerical base to use. 10 is default.
- * @return Number of characters consumed.
- */
-native int StringToInt64(const char[] str, int result[2], int nBase=10);
-
-/**
- * Converts an integer to a string.
- *
- * @param num Integer to convert.
- * @param str Buffer to store string in.
- * @param maxlength Maximum length of string buffer.
- * @return Number of characters written to the buffer,
- * not including the null terminator.
- */
-native int IntToString(int num, char[] str, int maxlength);
-
-/**
- * Converts a 64-bit integer to a string.
- *
- * @param num Array containing the upper and lower
- * 32-bits of a 64-bit integer.
- * @param str Buffer to store string in.
- * @param maxlength Maximum length of string buffer.
- * @return Number of characters written to the buffer,
- * not including the null terminator.
- */
-native int Int64ToString(const int num[2], char[] str, int maxlength);
-
-/**
- * Converts a string to a floating point number.
- *
- * @param str String to convert to a float.
- * @return Floating point result, or 0.0 on error.
- */
-native float StringToFloat(const char[] str);
-
-/**
- * Converts a string to a floating point number with some more options.
- *
- * @param str String to convert to a float.
- * @param result Variable to store result in.
- * @return Number of characters consumed.
- */
-native int StringToFloatEx(const char[] str, float &result);
-
-/**
- * Converts a floating point number to a string.
- *
- * @param num Floating point number to convert.
- * @param str Buffer to store string in.
- * @param maxlength Maximum length of string buffer.
- * @return Number of characters written to the buffer,
- * not including the null terminator.
- */
-native int FloatToString(float num, char[] str, int maxlength);
-
-/**
- * Finds the first "argument" in a string; either a set of space
- * terminated characters, or a fully quoted string. After the
- * argument is found, whitespace is read until the next portion
- * of the string is reached. If nothing remains, -1 is returned.
- * Otherwise, the index to the first character is returned.
- *
- * @param source Source input string.
- * @param arg Stores argument read from string.
- * @param argLen Maximum length of argument buffer.
- * @return Index to next piece of string, or -1 if none.
- */
-native int BreakString(const char[] source, char[] arg, int argLen);
-
-/**
- * Backwards compatibility stock - use BreakString
- * @deprecated Renamed to BreakString.
- */
-#pragma deprecated Use BreakString() instead
-stock int StrBreak(const char[] source, char[] arg, int argLen)
-{
- return BreakString(source, arg, argLen);
-}
-
-/**
- * Removes whitespace characters from the beginning and end of a string.
- *
- * @param str The string to trim.
- * @return Number of bytes written (UTF-8 safe).
- */
-native int TrimString(char[] str);
-
-/**
- * Returns text in a string up until a certain character sequence is reached.
- *
- * @param source Source input string.
- * @param split A string which specifies a search point to break at.
- * @param part Buffer to store string part.
- * @param partLen Maximum length of the string part buffer.
- * @return -1 if no match was found; otherwise, an index into source
- * marking the first index after the searched text. The
- * index is always relative to the start of the input string.
- */
-native int SplitString(const char[] source, const char[] split, char[] part, int partLen);
-
-/**
- * Given a string, replaces all occurrences of a search string with a
- * replacement string.
- *
- * @param text String to perform search and replacements on.
- * @param maxlength Maximum length of the string buffer.
- * @param search String to search for.
- * @param replace String to replace the search string with.
- * @param caseSensitive If true (default), search is case sensitive.
- * @return Number of replacements that were performed.
- * @error 'search' parameter is empty.
- */
-native int ReplaceString(char[] text, int maxlength, const char[] search, const char[] replace, bool caseSensitive=true);
-
-/**
- * Given a string, replaces the first occurrence of a search string with a
- * replacement string.
- *
- * @param text String to perform search and replacements on.
- * @param maxlength Maximum length of the string buffer.
- * @param search String to search for.
- * @param replace String to replace the search string with.
- * @param searchLen If higher than -1, its value will be used instead of
- * a strlen() call on the search parameter.
- * @param replaceLen If higher than -1, its value will be used instead of
- * a strlen() call on the replace parameter.
- * @param caseSensitive If true (default), search is case sensitive.
- * @return Index into the buffer (relative to the start) from where
- * the last replacement ended, or -1 if no replacements were
- * made.
- * @error 'search' parameter is empty.
- */
-native int ReplaceStringEx(char[] text, int maxlength, const char[] search, const char[] replace, int searchLen=-1, int replaceLen=-1, bool caseSensitive=true);
-
-/**
- * Returns the number of bytes a character is using. This is
- * for multi-byte characters (UTF-8). For normal ASCII characters,
- * this will return 1.
- *
- * @param source Source input string.
- * @return Number of bytes the current character uses.
- */
-native int GetCharBytes(const char[] source);
-
-/**
- * Returns whether a character is an ASCII alphabet character.
- *
- * @note Multi-byte characters will always return false.
- *
- * @param chr Character to test.
- * @return True if character is alphabetical, otherwise false.
- */
-native bool IsCharAlpha(int chr);
-
-/**
- * Returns whether a character is numeric.
- *
- * @note Multi-byte characters will always return false.
- *
- * @param chr Character to test.
- * @return True if character is numeric, otherwise false.
- */
-native bool IsCharNumeric(int chr);
-
-/**
- * Returns whether a character is whitespace.
- *
- * @note Multi-byte characters will always return false.
- *
- * @param chr Character to test.
- * @return True if character is whitespace, otherwise false.
- */
-native bool IsCharSpace(int chr);
-
-/**
- * Returns if a character is multi-byte or not.
- *
- * @param chr Character to test.
- * @return 0 for a normal 7-bit ASCII character,
- * otherwise number of bytes in multi-byte character.
- */
-native int IsCharMB(int chr);
-
-/**
- * Returns whether an alphabetic character is uppercase.
- *
- * @note Multi-byte characters will always return false.
- *
- * @param chr Character to test.
- * @return True if character is uppercase, otherwise false.
- */
-native bool IsCharUpper(int chr);
-
-/**
- * Returns whether an alphabetic character is lowercase.
- *
- * @note Multi-byte characters will always return false.
- *
- * @param chr Character to test.
- * @return True if character is lowercase, otherwise false.
- */
-native bool IsCharLower(int chr);
-
-/**
- * Strips a quote pair off a string if it exists. That is, the following
- * replace rule is applied once: ^"(.*)"$ -> ^\1$
- *
- * Note that the leading and trailing quotes will only be removed if both
- * exist. Otherwise, the string is left unmodified. This function should
- * be considered O(k) (all characters get shifted down).
- *
- * @param text String to modify (in place).
- * @return True if string was modified, false if there was no
- * set of quotes.
- */
-native bool StripQuotes(char[] text);
-
-/**
- * Converts a lowercase character to its uppercase counterpart.
- *
- * @param chr Character to convert.
- * @return Uppercase character on success,
- * no change on failure.
- */
-stock int CharToUpper(int chr)
-{
- if (IsCharLower(chr))
- {
- return (chr & ~(1<<5));
- }
-
- return chr;
-}
-
-/**
- * Converts an uppercase character to its lowercase counterpart.
- *
- * @param chr Character to convert.
- * @return Lowercase character on success,
- * no change on failure.
- */
-stock int CharToLower(int chr)
-{
- if (IsCharUpper(chr))
- {
- return (chr | (1<<5));
- }
-
- return chr;
-}
-
-/**
- * Finds the first occurrence of a character in a string.
- *
- * @param str String.
- * @param c Character to search for.
- * @param reverse False (default) to search forward, true to search
- * backward.
- * @return The index of the first occurrence of the character
- * in the string, or -1 if the character was not found.
- */
-stock int FindCharInString(const char[] str, char c, bool reverse = false)
-{
- int len = strlen(str);
-
- if (!reverse)
- {
- for (int i = 0; i < len; i++)
- {
- if (str[i] == c)
- {
- return i;
- }
- }
- }
- else
- {
- for (int i = len - 1; i >= 0; i--)
- {
- if (str[i] == c)
- {
- return i;
- }
- }
- }
-
- return -1;
-}
-
-/**
- * Concatenates one string onto another.
- *
- * @param buffer String to append to.
- * @param maxlength Maximum length of entire buffer.
- * @param source Source string to concatenate.
- * @return Number of bytes written.
- */
-stock int StrCat(char[] buffer, int maxlength, const char[] source)
-{
- int len = strlen(buffer);
- if (len >= maxlength)
- {
- return 0;
- }
-
- return Format(buffer[len], maxlength-len, "%s", source);
-}
-
-/**
- * Breaks a string into pieces and stores each piece into an array of buffers.
- *
- * @param text The string to split.
- * @param split The string to use as a split delimiter.
- * @param buffers An array of string buffers (2D array).
- * @param maxStrings Number of string buffers (first dimension size).
- * @param maxStringLength Maximum length of each string buffer.
- * @param copyRemainder False (default) discard excess pieces, true to ignore
- * delimiters after last piece.
- * @return Number of strings retrieved.
- */
-stock int ExplodeString(const char[] text, const char[] split, char[][] buffers, int maxStrings,
- int maxStringLength, bool copyRemainder = false)
-{
- int reloc_idx, idx, total;
-
- if (maxStrings < 1 || !split[0])
- {
- return 0;
- }
-
- while ((idx = SplitString(text[reloc_idx], split, buffers[total], maxStringLength)) != -1)
- {
- reloc_idx += idx;
- if (++total == maxStrings)
- {
- if (copyRemainder)
- {
- strcopy(buffers[total-1], maxStringLength, text[reloc_idx-idx]);
- }
- return total;
- }
- }
-
- strcopy(buffers[total++], maxStringLength, text[reloc_idx]);
-
- return total;
-}
-
-/**
- * Joins an array of strings into one string, with a "join" string inserted in
- * between each given string. This function complements ExplodeString.
- *
- * @param strings An array of strings.
- * @param numStrings Number of strings in the array.
- * @param join The join string to insert between each string.
- * @param buffer Output buffer to write the joined string to.
- * @param maxLength Maximum length of the output buffer.
- * @return Number of bytes written to the output buffer.
- */
-stock int ImplodeStrings(const char[][] strings, int numStrings, const char[] join, char[] buffer, int maxLength)
-{
- int total, length, part_length;
- int join_length = strlen(join);
- for (int i=0; i<numStrings; i++)
- {
- length = strcopy(buffer[total], maxLength-total, strings[i]);
- total += length;
- if (length < part_length)
- {
- break;
- }
- if (i != numStrings - 1)
- {
- length = strcopy(buffer[total], maxLength-total, join);
- total += length;
- if (length < join_length)
- {
- break;
- }
- }
- }
- return total;
-}