using System; using System.Collections.Generic; using System.Globalization; using System.Runtime.CompilerServices; using System.Security; using System.Text; using System.Text.RegularExpressions; namespace Godot { public static class StringExtensions { private static int GetSliceCount(this string instance, string splitter) { if (instance.Empty() || splitter.Empty()) return 0; int pos = 0; int slices = 1; while ((pos = instance.Find(splitter, pos, caseSensitive: true)) >= 0) { slices++; pos += splitter.Length; } return slices; } private static string GetSliceCharacter(this string instance, char splitter, int slice) { if (!instance.Empty() && slice >= 0) { int i = 0; int prev = 0; int count = 0; while (true) { bool end = instance.Length <= i; if (end || instance[i] == splitter) { if (slice == count) { return instance.Substring(prev, i - prev); } else if (end) { return string.Empty; } count++; prev = i + 1; } i++; } } return string.Empty; } // // If the string is a path to a file, return the path to the file without the extension. // public static string BaseName(this string instance) { int index = instance.LastIndexOf('.'); if (index > 0) return instance.Substring(0, index); return instance; } // // Return true if the strings begins with the given string. // public static bool BeginsWith(this string instance, string text) { return instance.StartsWith(text); } // // Return the bigrams (pairs of consecutive letters) of this string. // public static string[] Bigrams(this string instance) { var b = new string[instance.Length - 1]; for (int i = 0; i < b.Length; i++) { b[i] = instance.Substring(i, 2); } return b; } // // Return the amount of substrings in string. // public static int Count(this string instance, string what, bool caseSensitive = true, int from = 0, int to = 0) { if (what.Length == 0) { return 0; } int len = instance.Length; int slen = what.Length; if (len < slen) { return 0; } string str; if (from >= 0 && to >= 0) { if (to == 0) { to = len; } else if (from >= to) { return 0; } if (from == 0 && to == len) { str = instance; } else { str = instance.Substring(from, to - from); } } else { return 0; } int c = 0; int idx; do { idx = str.IndexOf(what, caseSensitive ? StringComparison.Ordinal : StringComparison.OrdinalIgnoreCase); if (idx != -1) { str = str.Substring(idx + slen); ++c; } } while (idx != -1); return c; } // // Return a copy of the string with special characters escaped using the C language standard. // public static string CEscape(this string instance) { var sb = new StringBuilder(string.Copy(instance)); sb.Replace("\\", "\\\\"); sb.Replace("\a", "\\a"); sb.Replace("\b", "\\b"); sb.Replace("\f", "\\f"); sb.Replace("\n", "\\n"); sb.Replace("\r", "\\r"); sb.Replace("\t", "\\t"); sb.Replace("\v", "\\v"); sb.Replace("\'", "\\'"); sb.Replace("\"", "\\\""); sb.Replace("?", "\\?"); return sb.ToString(); } // // Return a copy of the string with escaped characters replaced by their meanings according to the C language standard. // public static string CUnescape(this string instance) { var sb = new StringBuilder(string.Copy(instance)); sb.Replace("\\a", "\a"); sb.Replace("\\b", "\b"); sb.Replace("\\f", "\f"); sb.Replace("\\n", "\n"); sb.Replace("\\r", "\r"); sb.Replace("\\t", "\t"); sb.Replace("\\v", "\v"); sb.Replace("\\'", "\'"); sb.Replace("\\\"", "\""); sb.Replace("\\?", "?"); sb.Replace("\\\\", "\\"); return sb.ToString(); } // // Change the case of some letters. Replace underscores with spaces, convert all letters to lowercase then capitalize first and every letter following the space character. For [code]capitalize camelCase mixed_with_underscores[/code] it will return [code]Capitalize Camelcase Mixed With Underscores[/code]. // public static string Capitalize(this string instance) { string aux = instance.Replace("_", " ").ToLower(); var cap = string.Empty; for (int i = 0; i < aux.GetSliceCount(" "); i++) { string slice = aux.GetSliceCharacter(' ', i); if (slice.Length > 0) { slice = char.ToUpper(slice[0]) + slice.Substring(1); if (i > 0) cap += " "; cap += slice; } } return cap; } // // Perform a case-sensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater. // public static int CasecmpTo(this string instance, string to) { return instance.CompareTo(to, caseSensitive: true); } // // Perform a comparison to another string, return -1 if less, 0 if equal and +1 if greater. // public static int CompareTo(this string instance, string to, bool caseSensitive = true) { if (instance.Empty()) return to.Empty() ? 0 : -1; if (to.Empty()) return 1; int instanceIndex = 0; int toIndex = 0; if (caseSensitive) // Outside while loop to avoid checking multiple times, despite some code duplication. { while (true) { if (to[toIndex] == 0 && instance[instanceIndex] == 0) return 0; // We're equal if (instance[instanceIndex] == 0) return -1; // If this is empty, and the other one is not, then we're less... I think? if (to[toIndex] == 0) return 1; // Otherwise the other one is smaller... if (instance[instanceIndex] < to[toIndex]) // More than return -1; if (instance[instanceIndex] > to[toIndex]) // Less than return 1; instanceIndex++; toIndex++; } } else { while (true) { if (to[toIndex] == 0 && instance[instanceIndex] == 0) return 0; // We're equal if (instance[instanceIndex] == 0) return -1; // If this is empty, and the other one is not, then we're less... I think? if (to[toIndex] == 0) return 1; // Otherwise the other one is smaller.. if (char.ToUpper(instance[instanceIndex]) < char.ToUpper(to[toIndex])) // More than return -1; if (char.ToUpper(instance[instanceIndex]) > char.ToUpper(to[toIndex])) // Less than return 1; instanceIndex++; toIndex++; } } } // // Return true if the string is empty. // public static bool Empty(this string instance) { return string.IsNullOrEmpty(instance); } // // Return true if the strings ends with the given string. // public static bool EndsWith(this string instance, string text) { return instance.EndsWith(text); } // // Erase [code]chars[/code] characters from the string starting from [code]pos[/code]. // public static void Erase(this StringBuilder instance, int pos, int chars) { instance.Remove(pos, chars); } // // If the string is a path to a file, return the extension. // public static string Extension(this string instance) { int pos = instance.FindLast("."); if (pos < 0) return instance; return instance.Substring(pos + 1); } /// Find the first occurrence of a substring. Optionally, the search starting position can be passed. /// The starting position of the substring, or -1 if not found. public static int Find(this string instance, string what, int from = 0, bool caseSensitive = true) { return instance.IndexOf(what, from, caseSensitive ? StringComparison.Ordinal : StringComparison.OrdinalIgnoreCase); } /// Find the last occurrence of a substring. /// The starting position of the substring, or -1 if not found. public static int FindLast(this string instance, string what, bool caseSensitive = true) { return instance.FindLast(what, instance.Length - 1, caseSensitive); } /// Find the last occurrence of a substring specifying the search starting position. /// The starting position of the substring, or -1 if not found. public static int FindLast(this string instance, string what, int from, bool caseSensitive = true) { return instance.LastIndexOf(what, from, caseSensitive ? StringComparison.Ordinal : StringComparison.OrdinalIgnoreCase); } /// Find the first occurrence of a substring but search as case-insensitive. Optionally, the search starting position can be passed. /// The starting position of the substring, or -1 if not found. public static int FindN(this string instance, string what, int from = 0) { return instance.IndexOf(what, from, StringComparison.OrdinalIgnoreCase); } // // If the string is a path to a file, return the base directory. // public static string GetBaseDir(this string instance) { int basepos = instance.Find("://"); string rs; var @base = string.Empty; if (basepos != -1) { var end = basepos + 3; rs = instance.Substring(end); @base = instance.Substring(0, end); } else { if (instance.BeginsWith("/")) { rs = instance.Substring(1); @base = "/"; } else { rs = instance; } } int sep = Mathf.Max(rs.FindLast("/"), rs.FindLast("\\")); if (sep == -1) return @base; return @base + rs.Substr(0, sep); } // // If the string is a path to a file, return the file and ignore the base directory. // public static string GetFile(this string instance) { int sep = Mathf.Max(instance.FindLast("/"), instance.FindLast("\\")); if (sep == -1) return instance; return instance.Substring(sep + 1); } // // Hash the string and return a 32 bits integer. // public static int Hash(this string instance) { int index = 0; int hashv = 5381; int c; while ((c = instance[index++]) != 0) hashv = (hashv << 5) + hashv + c; // hash * 33 + c return hashv; } // // Convert a string containing an hexadecimal number into an int. // public static int HexToInt(this string instance) { int sign = 1; if (instance[0] == '-') { sign = -1; instance = instance.Substring(1); } if (!instance.StartsWith("0x")) return 0; return sign * int.Parse(instance.Substring(2), NumberStyles.HexNumber); } // // Insert a substring at a given position. // public static string Insert(this string instance, int pos, string what) { return instance.Insert(pos, what); } // // If the string is a path to a file or directory, return true if the path is absolute. // public static bool IsAbsPath(this string instance) { return System.IO.Path.IsPathRooted(instance); } // // If the string is a path to a file or directory, return true if the path is relative. // public static bool IsRelPath(this string instance) { return !System.IO.Path.IsPathRooted(instance); } // // Check whether this string is a subsequence of the given string. // public static bool IsSubsequenceOf(this string instance, string text, bool caseSensitive = true) { int len = instance.Length; if (len == 0) return true; // Technically an empty string is subsequence of any string if (len > text.Length) return false; int source = 0; int target = 0; while (instance[source] != 0 && text[target] != 0) { bool match; if (!caseSensitive) { char sourcec = char.ToLower(instance[source]); char targetc = char.ToLower(text[target]); match = sourcec == targetc; } else { match = instance[source] == text[target]; } if (match) { source++; if (instance[source] == 0) return true; } target++; } return false; } // // Check whether this string is a subsequence of the given string, ignoring case differences. // public static bool IsSubsequenceOfI(this string instance, string text) { return instance.IsSubsequenceOf(text, caseSensitive: false); } // // Check whether the string contains a valid float. // public static bool IsValidFloat(this string instance) { float f; return float.TryParse(instance, out f); } // // Check whether the string contains a valid color in HTML notation. // public static bool IsValidHtmlColor(this string instance) { return Color.HtmlIsValid(instance); } // // Check whether the string is a valid identifier. As is common in programming languages, a valid identifier may contain only letters, digits and underscores (_) and the first character may not be a digit. // public static bool IsValidIdentifier(this string instance) { int len = instance.Length; if (len == 0) return false; for (int i = 0; i < len; i++) { if (i == 0) { if (instance[0] >= '0' && instance[0] <= '9') return false; // Don't start with number plz } bool validChar = instance[i] >= '0' && instance[i] <= '9' || instance[i] >= 'a' && instance[i] <= 'z' || instance[i] >= 'A' && instance[i] <= 'Z' || instance[i] == '_'; if (!validChar) return false; } return true; } // // Check whether the string contains a valid integer. // public static bool IsValidInteger(this string instance) { int f; return int.TryParse(instance, out f); } // // Check whether the string contains a valid IP address. // public static bool IsValidIPAddress(this string instance) { // TODO: Support IPv6 addresses string[] ip = instance.Split("."); if (ip.Length != 4) return false; for (int i = 0; i < ip.Length; i++) { string n = ip[i]; if (!n.IsValidInteger()) return false; int val = n.ToInt(); if (val < 0 || val > 255) return false; } return true; } // // Return a copy of the string with special characters escaped using the JSON standard. // public static string JSONEscape(this string instance) { var sb = new StringBuilder(string.Copy(instance)); sb.Replace("\\", "\\\\"); sb.Replace("\b", "\\b"); sb.Replace("\f", "\\f"); sb.Replace("\n", "\\n"); sb.Replace("\r", "\\r"); sb.Replace("\t", "\\t"); sb.Replace("\v", "\\v"); sb.Replace("\"", "\\\""); return sb.ToString(); } // // Return an amount of characters from the left of the string. // public static string Left(this string instance, int pos) { if (pos <= 0) return string.Empty; if (pos >= instance.Length) return instance; return instance.Substring(0, pos); } /// /// Return the length of the string in characters. /// public static int Length(this string instance) { return instance.Length; } // // Do a simple expression match, where '*' matches zero or more arbitrary characters and '?' matches any single character except '.'. // public static bool ExprMatch(this string instance, string expr, bool caseSensitive) { if (expr.Length == 0 || instance.Length == 0) return false; switch (expr[0]) { case '\0': return instance[0] == 0; case '*': return ExprMatch(expr + 1, instance, caseSensitive) || instance[0] != 0 && ExprMatch(expr, instance + 1, caseSensitive); case '?': return instance[0] != 0 && instance[0] != '.' && ExprMatch(expr + 1, instance + 1, caseSensitive); default: return (caseSensitive ? instance[0] == expr[0] : char.ToUpper(instance[0]) == char.ToUpper(expr[0])) && ExprMatch(expr + 1, instance + 1, caseSensitive); } } // // Do a simple case sensitive expression match, using ? and * wildcards (see [method expr_match]). // public static bool Match(this string instance, string expr, bool caseSensitive = true) { return instance.ExprMatch(expr, caseSensitive); } // // Do a simple case insensitive expression match, using ? and * wildcards (see [method expr_match]). // public static bool MatchN(this string instance, string expr) { return instance.ExprMatch(expr, caseSensitive: false); } // // Return the MD5 hash of the string as an array of bytes. // public static byte[] MD5Buffer(this string instance) { return godot_icall_String_md5_buffer(instance); } [MethodImpl(MethodImplOptions.InternalCall)] internal extern static byte[] godot_icall_String_md5_buffer(string str); // // Return the MD5 hash of the string as a string. // public static string MD5Text(this string instance) { return godot_icall_String_md5_text(instance); } [MethodImpl(MethodImplOptions.InternalCall)] internal extern static string godot_icall_String_md5_text(string str); // // Perform a case-insensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater. // public static int NocasecmpTo(this string instance, string to) { return instance.CompareTo(to, caseSensitive: false); } // // Return the character code at position [code]at[/code]. // public static int OrdAt(this string instance, int at) { return instance[at]; } // // Format a number to have an exact number of [code]digits[/code] after the decimal point. // public static string PadDecimals(this string instance, int digits) { int c = instance.Find("."); if (c == -1) { if (digits <= 0) return instance; instance += "."; c = instance.Length - 1; } else { if (digits <= 0) return instance.Substring(0, c); } if (instance.Length - (c + 1) > digits) { instance = instance.Substring(0, c + digits + 1); } else { while (instance.Length - (c + 1) < digits) { instance += "0"; } } return instance; } // // Format a number to have an exact number of [code]digits[/code] before the decimal point. // public static string PadZeros(this string instance, int digits) { string s = instance; int end = s.Find("."); if (end == -1) end = s.Length; if (end == 0) return s; int begin = 0; while (begin < end && (s[begin] < '0' || s[begin] > '9')) { begin++; } if (begin >= end) return s; while (end - begin < digits) { s = s.Insert(begin, "0"); end++; } return s; } // // Decode a percent-encoded string. See [method percent_encode]. // public static string PercentDecode(this string instance) { return Uri.UnescapeDataString(instance); } // // Percent-encode a string. This is meant to encode parameters in a URL when sending a HTTP GET request and bodies of form-urlencoded POST request. // public static string PercentEncode(this string instance) { return Uri.EscapeDataString(instance); } // // If the string is a path, this concatenates [code]file[/code] at the end of the string as a subpath. E.g. [code]"this/is".plus_file("path") == "this/is/path"[/code]. // public static string PlusFile(this string instance, string file) { if (instance.Length > 0 && instance[instance.Length - 1] == '/') return instance + file; return instance + "/" + file; } // // Replace occurrences of a substring for different ones inside the string. // public static string Replace(this string instance, string what, string forwhat) { return instance.Replace(what, forwhat); } // // Replace occurrences of a substring for different ones inside the string, but search case-insensitive. // public static string ReplaceN(this string instance, string what, string forwhat) { return Regex.Replace(instance, what, forwhat, RegexOptions.IgnoreCase); } // // Perform a search for a substring, but start from the end of the string instead of the beginning. // public static int RFind(this string instance, string what, int from = -1) { return godot_icall_String_rfind(instance, what, from); } [MethodImpl(MethodImplOptions.InternalCall)] internal extern static int godot_icall_String_rfind(string str, string what, int from); // // Perform a search for a substring, but start from the end of the string instead of the beginning. Also search case-insensitive. // public static int RFindN(this string instance, string what, int from = -1) { return godot_icall_String_rfindn(instance, what, from); } [MethodImpl(MethodImplOptions.InternalCall)] internal extern static int godot_icall_String_rfindn(string str, string what, int from); // // Return the right side of the string from a given position. // public static string Right(this string instance, int pos) { if (pos >= instance.Length) return instance; if (pos < 0) return string.Empty; return instance.Substring(pos, instance.Length - pos); } public static byte[] SHA256Buffer(this string instance) { return godot_icall_String_sha256_buffer(instance); } [MethodImpl(MethodImplOptions.InternalCall)] internal extern static byte[] godot_icall_String_sha256_buffer(string str); // // Return the SHA-256 hash of the string as a string. // public static string SHA256Text(this string instance) { return godot_icall_String_sha256_text(instance); } [MethodImpl(MethodImplOptions.InternalCall)] internal extern static string godot_icall_String_sha256_text(string str); // // Return the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar. // public static float Similarity(this string instance, string text) { if (instance == text) { // Equal strings are totally similar return 1.0f; } if (instance.Length < 2 || text.Length < 2) { // No way to calculate similarity without a single bigram return 0.0f; } string[] sourceBigrams = instance.Bigrams(); string[] targetBigrams = text.Bigrams(); int sourceSize = sourceBigrams.Length; int targetSize = targetBigrams.Length; float sum = sourceSize + targetSize; float inter = 0; for (int i = 0; i < sourceSize; i++) { for (int j = 0; j < targetSize; j++) { if (sourceBigrams[i] == targetBigrams[j]) { inter++; break; } } } return 2.0f * inter / sum; } // // Split the string by a divisor string, return an array of the substrings. Example "One,Two,Three" will return ["One","Two","Three"] if split by ",". // public static string[] Split(this string instance, string divisor, bool allowEmpty = true) { return instance.Split(new[] { divisor }, StringSplitOptions.RemoveEmptyEntries); } // // Split the string in floats by using a divisor string, return an array of the substrings. Example "1,2.5,3" will return [1,2.5,3] if split by ",". // public static float[] SplitFloats(this string instance, string divisor, bool allowEmpty = true) { var ret = new List(); int from = 0; int len = instance.Length; while (true) { int end = instance.Find(divisor, from, caseSensitive: true); if (end < 0) end = len; if (allowEmpty || end > from) ret.Add(float.Parse(instance.Substring(from))); if (end == len) break; from = end + divisor.Length; } return ret.ToArray(); } private static readonly char[] _nonPrintable = { (char)00, (char)01, (char)02, (char)03, (char)04, (char)05, (char)06, (char)07, (char)08, (char)09, (char)10, (char)11, (char)12, (char)13, (char)14, (char)15, (char)16, (char)17, (char)18, (char)19, (char)20, (char)21, (char)22, (char)23, (char)24, (char)25, (char)26, (char)27, (char)28, (char)29, (char)30, (char)31, (char)32 }; // // Return a copy of the string stripped of any non-printable character at the beginning and the end. The optional arguments are used to toggle stripping on the left and right edges respectively. // public static string StripEdges(this string instance, bool left = true, bool right = true) { if (left) { if (right) return instance.Trim(_nonPrintable); return instance.TrimStart(_nonPrintable); } return instance.TrimEnd(_nonPrintable); } // // Return part of the string from the position [code]from[/code], with length [code]len[/code]. // public static string Substr(this string instance, int from, int len) { int max = instance.Length - from; return instance.Substring(from, len > max ? max : len); } // // Convert the String (which is a character array) to PoolByteArray (which is an array of bytes). The conversion is speeded up in comparison to to_utf8() with the assumption that all the characters the String contains are only ASCII characters. // public static byte[] ToAscii(this string instance) { return Encoding.ASCII.GetBytes(instance); } // // Convert a string, containing a decimal number, into a [code]float[/code]. // public static float ToFloat(this string instance) { return float.Parse(instance); } // // Convert a string, containing an integer number, into an [code]int[/code]. // public static int ToInt(this string instance) { return int.Parse(instance); } // // Return the string converted to lowercase. // public static string ToLower(this string instance) { return instance.ToLower(); } // // Return the string converted to uppercase. // public static string ToUpper(this string instance) { return instance.ToUpper(); } // // Convert the String (which is an array of characters) to PoolByteArray (which is an array of bytes). The conversion is a bit slower than to_ascii(), but supports all UTF-8 characters. Therefore, you should prefer this function over to_ascii(). // public static byte[] ToUTF8(this string instance) { return Encoding.UTF8.GetBytes(instance); } // // Return a copy of the string with special characters escaped using the XML standard. // public static string XMLEscape(this string instance) { return SecurityElement.Escape(instance); } // // Return a copy of the string with escaped characters replaced by their meanings according to the XML standard. // public static string XMLUnescape(this string instance) { return SecurityElement.FromString(instance).Text; } } }