1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240 |
- 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 (string.IsNullOrEmpty(instance) || string.IsNullOrEmpty(splitter))
- 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 (!string.IsNullOrEmpty(instance) && 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;
- }
- // <summary>
- // If the string is a path to a file, return the path to the file without the extension.
- // </summary>
- public static string BaseName(this string instance)
- {
- int index = instance.LastIndexOf('.');
- if (index > 0)
- return instance.Substring(0, index);
- return instance;
- }
- // <summary>
- // Return true if the strings begins with the given string.
- // </summary>
- public static bool BeginsWith(this string instance, string text)
- {
- return instance.StartsWith(text);
- }
- // <summary>
- // Return the bigrams (pairs of consecutive letters) of this string.
- // </summary>
- 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;
- }
- /// <summary>
- /// Converts a string containing a binary number into an integer.
- /// Binary strings can either be prefixed with `0b` or not,
- /// and they can also start with a `-` before the optional prefix.
- /// </summary>
- /// <param name="instance">The string to convert.</param>
- /// <returns>The converted string.</returns>
- public static int BinToInt(this string instance)
- {
- if (instance.Length == 0)
- {
- return 0;
- }
- int sign = 1;
- if (instance[0] == '-')
- {
- sign = -1;
- instance = instance.Substring(1);
- }
- if (instance.StartsWith("0b"))
- {
- instance = instance.Substring(2);
- }
- return sign * Convert.ToInt32(instance, 2);;
- }
- // <summary>
- // Return the amount of substrings in string.
- // </summary>
- 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;
- }
- // <summary>
- // Return a copy of the string with special characters escaped using the C language standard.
- // </summary>
- 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();
- }
- // <summary>
- // Return a copy of the string with escaped characters replaced by their meanings according to the C language standard.
- // </summary>
- 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();
- }
- // <summary>
- // 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].
- // </summary>
- 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;
- }
- // <summary>
- // Perform a case-sensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater.
- // </summary>
- public static int CasecmpTo(this string instance, string to)
- {
- return instance.CompareTo(to, caseSensitive: true);
- }
- // <summary>
- // Perform a comparison to another string, return -1 if less, 0 if equal and +1 if greater.
- // </summary>
- public static int CompareTo(this string instance, string to, bool caseSensitive = true)
- {
- if (string.IsNullOrEmpty(instance))
- return string.IsNullOrEmpty(to) ? 0 : -1;
- if (string.IsNullOrEmpty(to))
- 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++;
- }
- }
- }
- // <summary>
- // Return true if the strings ends with the given string.
- // </summary>
- public static bool EndsWith(this string instance, string text)
- {
- return instance.EndsWith(text);
- }
- // <summary>
- // Erase [code]chars[/code] characters from the string starting from [code]pos[/code].
- // </summary>
- public static void Erase(this StringBuilder instance, int pos, int chars)
- {
- instance.Remove(pos, chars);
- }
- // <summary>
- // If the string is a path to a file, return the extension.
- // </summary>
- public static string Extension(this string instance)
- {
- int pos = instance.FindLast(".");
- if (pos < 0)
- return instance;
- return instance.Substring(pos + 1);
- }
- /// <summary>Find the first occurrence of a substring. Optionally, the search starting position can be passed.</summary>
- /// <returns>The starting position of the substring, or -1 if not found.</returns>
- 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);
- }
- /// <summary>Find the first occurrence of a char. Optionally, the search starting position can be passed.</summary>
- /// <returns>The first instance of the char, or -1 if not found.</returns>
- public static int Find(this string instance, char what, int from = 0, bool caseSensitive = true)
- {
- // TODO: Could be more efficient if we get a char version of `IndexOf`.
- // See https://github.com/dotnet/runtime/issues/44116
- return instance.IndexOf(what.ToString(), from, caseSensitive ? StringComparison.Ordinal : StringComparison.OrdinalIgnoreCase);
- }
- /// <summary>Find the last occurrence of a substring.</summary>
- /// <returns>The starting position of the substring, or -1 if not found.</returns>
- public static int FindLast(this string instance, string what, bool caseSensitive = true)
- {
- return instance.FindLast(what, instance.Length - 1, caseSensitive);
- }
- /// <summary>Find the last occurrence of a substring specifying the search starting position.</summary>
- /// <returns>The starting position of the substring, or -1 if not found.</returns>
- public static int FindLast(this string instance, string what, int from, bool caseSensitive = true)
- {
- return instance.LastIndexOf(what, from, caseSensitive ? StringComparison.Ordinal : StringComparison.OrdinalIgnoreCase);
- }
- /// <summary>Find the first occurrence of a substring but search as case-insensitive. Optionally, the search starting position can be passed.</summary>
- /// <returns>The starting position of the substring, or -1 if not found.</returns>
- public static int FindN(this string instance, string what, int from = 0)
- {
- return instance.IndexOf(what, from, StringComparison.OrdinalIgnoreCase);
- }
- // <summary>
- // If the string is a path to a file, return the base directory.
- // </summary>
- 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);
- }
- // <summary>
- // If the string is a path to a file, return the file and ignore the base directory.
- // </summary>
- 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);
- }
- /// <summary>
- /// Converts the given byte array of ASCII encoded text to a string.
- /// Faster alternative to <see cref="GetStringFromUTF8"/> if the
- /// content is ASCII-only. Unlike the UTF-8 function this function
- /// maps every byte to a character in the array. Multibyte sequences
- /// will not be interpreted correctly. For parsing user input always
- /// use <see cref="GetStringFromUTF8"/>.
- /// </summary>
- /// <param name="bytes">A byte array of ASCII characters (on the range of 0-127).</param>
- /// <returns>A string created from the bytes.</returns>
- public static string GetStringFromASCII(this byte[] bytes)
- {
- return Encoding.ASCII.GetString(bytes);
- }
- /// <summary>
- /// Converts the given byte array of UTF-8 encoded text to a string.
- /// Slower than <see cref="GetStringFromASCII"/> but supports UTF-8
- /// encoded data. Use this function if you are unsure about the
- /// source of the data. For user input this function
- /// should always be preferred.
- /// </summary>
- /// <param name="bytes">A byte array of UTF-8 characters (a character may take up multiple bytes).</param>
- /// <returns>A string created from the bytes.</returns>
- public static string GetStringFromUTF8(this byte[] bytes)
- {
- return Encoding.UTF8.GetString(bytes);
- }
- // <summary>
- // Hash the string and return a 32 bits unsigned integer.
- // </summary>
- public static uint Hash(this string instance)
- {
- uint hash = 5381;
- foreach(uint c in instance)
- {
- hash = (hash << 5) + hash + c; // hash * 33 + c
- }
- return hash;
- }
- /// <summary>
- /// Returns a hexadecimal representation of this byte as a string.
- /// </summary>
- /// <param name="b">The byte to encode.</param>
- /// <returns>The hexadecimal representation of this byte.</returns>
- internal static string HexEncode(this byte b)
- {
- var ret = string.Empty;
- for (int i = 0; i < 2; i++)
- {
- char c;
- int lv = b & 0xF;
- if (lv < 10)
- {
- c = (char)('0' + lv);
- }
- else
- {
- c = (char)('a' + lv - 10);
- }
- b >>= 4;
- ret = c + ret;
- }
- return ret;
- }
- /// <summary>
- /// Returns a hexadecimal representation of this byte array as a string.
- /// </summary>
- /// <param name="bytes">The byte array to encode.</param>
- /// <returns>The hexadecimal representation of this byte array.</returns>
- public static string HexEncode(this byte[] bytes)
- {
- var ret = string.Empty;
- foreach (byte b in bytes)
- {
- ret += b.HexEncode();
- }
- return ret;
- }
- /// <summary>
- /// Converts a string containing a hexadecimal number into an integer.
- /// Hexadecimal strings can either be prefixed with `0x` or not,
- /// and they can also start with a `-` before the optional prefix.
- /// </summary>
- /// <param name="instance">The string to convert.</param>
- /// <returns>The converted string.</returns>
- public static int HexToInt(this string instance)
- {
- if (instance.Length == 0)
- {
- return 0;
- }
- int sign = 1;
- if (instance[0] == '-')
- {
- sign = -1;
- instance = instance.Substring(1);
- }
- if (instance.StartsWith("0x"))
- {
- instance = instance.Substring(2);
- }
- return sign * int.Parse(instance, NumberStyles.HexNumber);
- }
- // <summary>
- // Insert a substring at a given position.
- // </summary>
- public static string Insert(this string instance, int pos, string what)
- {
- return instance.Insert(pos, what);
- }
- // <summary>
- // If the string is a path to a file or directory, return true if the path is absolute.
- // </summary>
- public static bool IsAbsPath(this string instance)
- {
- if (string.IsNullOrEmpty(instance))
- return false;
- else if (instance.Length > 1)
- return instance[0] == '/' || instance[0] == '\\' || instance.Contains(":/") || instance.Contains(":\\");
- else
- return instance[0] == '/' || instance[0] == '\\';
- }
- // <summary>
- // If the string is a path to a file or directory, return true if the path is relative.
- // </summary>
- public static bool IsRelPath(this string instance)
- {
- return !IsAbsPath(instance);
- }
- // <summary>
- // Check whether this string is a subsequence of the given string.
- // </summary>
- 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 (source < len && target < text.Length)
- {
- 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 (source >= len)
- return true;
- }
- target++;
- }
- return false;
- }
- // <summary>
- // Check whether this string is a subsequence of the given string, ignoring case differences.
- // </summary>
- public static bool IsSubsequenceOfI(this string instance, string text)
- {
- return instance.IsSubsequenceOf(text, caseSensitive: false);
- }
- // <summary>
- // Check whether the string contains a valid float.
- // </summary>
- public static bool IsValidFloat(this string instance)
- {
- float f;
- return float.TryParse(instance, out f);
- }
- // <summary>
- // Check whether the string contains a valid color in HTML notation.
- // </summary>
- public static bool IsValidHtmlColor(this string instance)
- {
- return Color.HtmlIsValid(instance);
- }
- // <summary>
- // 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.
- // </summary>
- 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;
- }
- // <summary>
- // Check whether the string contains a valid integer.
- // </summary>
- public static bool IsValidInteger(this string instance)
- {
- int f;
- return int.TryParse(instance, out f);
- }
- // <summary>
- // Check whether the string contains a valid IP address.
- // </summary>
- 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;
- }
- // <summary>
- // Return a copy of the string with special characters escaped using the JSON standard.
- // </summary>
- 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();
- }
- // <summary>
- // Return an amount of characters from the left of the string.
- // </summary>
- 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);
- }
- /// <summary>
- /// Return the length of the string in characters.
- /// </summary>
- public static int Length(this string instance)
- {
- return instance.Length;
- }
- /// <summary>
- /// Returns a copy of the string with characters removed from the left.
- /// </summary>
- /// <param name="instance">The string to remove characters from.</param>
- /// <param name="chars">The characters to be removed.</param>
- /// <returns>A copy of the string with characters removed from the left.</returns>
- public static string LStrip(this string instance, string chars)
- {
- int len = instance.Length;
- int beg;
- for (beg = 0; beg < len; beg++)
- {
- if (chars.Find(instance[beg]) == -1)
- {
- break;
- }
- }
- if (beg == 0)
- {
- return instance;
- }
- return instance.Substr(beg, len - beg);
- }
- /// <summary>
- /// Do a simple expression match, where '*' matches zero or more arbitrary characters and '?' matches any single character except '.'.
- /// </summary>
- private static bool ExprMatch(this string instance, string expr, bool caseSensitive)
- {
- // case '\0':
- if (expr.Length == 0)
- return instance.Length == 0;
- switch (expr[0])
- {
- case '*':
- return ExprMatch(instance, expr.Substring(1), caseSensitive) || (instance.Length > 0 && ExprMatch(instance.Substring(1), expr, caseSensitive));
- case '?':
- return instance.Length > 0 && instance[0] != '.' && ExprMatch(instance.Substring(1), expr.Substring(1), caseSensitive);
- default:
- if (instance.Length == 0) return false;
- return (caseSensitive ? instance[0] == expr[0] : char.ToUpper(instance[0]) == char.ToUpper(expr[0])) && ExprMatch(instance.Substring(1), expr.Substring(1), caseSensitive);
- }
- }
- /// <summary>
- /// Do a simple case sensitive expression match, using ? and * wildcards (see [method expr_match]).
- /// </summary>
- public static bool Match(this string instance, string expr, bool caseSensitive = true)
- {
- if (instance.Length == 0 || expr.Length == 0)
- return false;
- return instance.ExprMatch(expr, caseSensitive);
- }
- /// <summary>
- /// Do a simple case insensitive expression match, using ? and * wildcards (see [method expr_match]).
- /// </summary>
- public static bool MatchN(this string instance, string expr)
- {
- if (instance.Length == 0 || expr.Length == 0)
- return false;
- return instance.ExprMatch(expr, caseSensitive: false);
- }
- // <summary>
- // Return the MD5 hash of the string as an array of bytes.
- // </summary>
- 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);
- // <summary>
- // Return the MD5 hash of the string as a string.
- // </summary>
- 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);
- // <summary>
- // Perform a case-insensitive comparison to another string, return -1 if less, 0 if equal and +1 if greater.
- // </summary>
- public static int NocasecmpTo(this string instance, string to)
- {
- return instance.CompareTo(to, caseSensitive: false);
- }
- // <summary>
- // Return the character code at position [code]at[/code].
- // </summary>
- public static int OrdAt(this string instance, int at)
- {
- return instance[at];
- }
- // <summary>
- // Format a number to have an exact number of [code]digits[/code] after the decimal point.
- // </summary>
- 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;
- }
- // <summary>
- // Format a number to have an exact number of [code]digits[/code] before the decimal point.
- // </summary>
- 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;
- }
- // <summary>
- // 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].
- // </summary>
- public static string PlusFile(this string instance, string file)
- {
- if (instance.Length > 0 && instance[instance.Length - 1] == '/')
- return instance + file;
- return instance + "/" + file;
- }
- // <summary>
- // Replace occurrences of a substring for different ones inside the string.
- // </summary>
- public static string Replace(this string instance, string what, string forwhat)
- {
- return instance.Replace(what, forwhat);
- }
- // <summary>
- // Replace occurrences of a substring for different ones inside the string, but search case-insensitive.
- // </summary>
- public static string ReplaceN(this string instance, string what, string forwhat)
- {
- return Regex.Replace(instance, what, forwhat, RegexOptions.IgnoreCase);
- }
- // <summary>
- // Perform a search for a substring, but start from the end of the string instead of the beginning.
- // </summary>
- 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);
- // <summary>
- // Perform a search for a substring, but start from the end of the string instead of the beginning. Also search case-insensitive.
- // </summary>
- 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);
- // <summary>
- // Return the right side of the string from a given position.
- // </summary>
- 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);
- }
- /// <summary>
- /// Returns a copy of the string with characters removed from the right.
- /// </summary>
- /// <param name="instance">The string to remove characters from.</param>
- /// <param name="chars">The characters to be removed.</param>
- /// <returns>A copy of the string with characters removed from the right.</returns>
- public static string RStrip(this string instance, string chars)
- {
- int len = instance.Length;
- int end;
- for (end = len - 1; end >= 0; end--)
- {
- if (chars.Find(instance[end]) == -1)
- {
- break;
- }
- }
- if (end == len - 1)
- {
- return instance;
- }
- return instance.Substr(0, end + 1);
- }
- 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);
- // <summary>
- // Return the SHA-256 hash of the string as a string.
- // </summary>
- 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);
- // <summary>
- // Return the similarity index of the text compared to this string. 1 means totally similar and 0 means totally dissimilar.
- // </summary>
- 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;
- }
- // <summary>
- // 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 ",".
- // </summary>
- public static string[] Split(this string instance, string divisor, bool allowEmpty = true)
- {
- return instance.Split(new[] { divisor }, StringSplitOptions.RemoveEmptyEntries);
- }
- // <summary>
- // 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 ",".
- // </summary>
- public static float[] SplitFloats(this string instance, string divisor, bool allowEmpty = true)
- {
- var ret = new List<float>();
- 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
- };
- // <summary>
- // 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.
- // </summary>
- 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);
- }
- // <summary>
- // Return part of the string from the position [code]from[/code], with length [code]len[/code].
- // </summary>
- public static string Substr(this string instance, int from, int len)
- {
- int max = instance.Length - from;
- return instance.Substring(from, len > max ? max : len);
- }
- // <summary>
- // Convert the String (which is a character array) to PackedByteArray (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.
- // </summary>
- public static byte[] ToAscii(this string instance)
- {
- return Encoding.ASCII.GetBytes(instance);
- }
- // <summary>
- // Convert a string, containing a decimal number, into a [code]float[/code].
- // </summary>
- public static float ToFloat(this string instance)
- {
- return float.Parse(instance);
- }
- // <summary>
- // Convert a string, containing an integer number, into an [code]int[/code].
- // </summary>
- public static int ToInt(this string instance)
- {
- return int.Parse(instance);
- }
- // <summary>
- // Return the string converted to lowercase.
- // </summary>
- public static string ToLower(this string instance)
- {
- return instance.ToLower();
- }
- // <summary>
- // Return the string converted to uppercase.
- // </summary>
- public static string ToUpper(this string instance)
- {
- return instance.ToUpper();
- }
- // <summary>
- // Convert the String (which is an array of characters) to PackedByteArray (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().
- // </summary>
- public static byte[] ToUTF8(this string instance)
- {
- return Encoding.UTF8.GetBytes(instance);
- }
- /// <summary>
- /// Decodes a string in URL encoded format. This is meant to
- /// decode parameters in a URL when receiving an HTTP request.
- /// This mostly wraps around `System.Uri.UnescapeDataString()`,
- /// but also handles `+`.
- /// See <see cref="URIEncode"/> for encoding.
- /// </summary>
- /// <param name="instance">The string to decode.</param>
- /// <returns>The unescaped string.</returns>
- public static string URIDecode(this string instance)
- {
- return Uri.UnescapeDataString(instance.Replace("+", "%20"));
- }
- /// <summary>
- /// Encodes a string to URL friendly format. This is meant to
- /// encode parameters in a URL when sending an HTTP request.
- /// This wraps around `System.Uri.EscapeDataString()`.
- /// See <see cref="URIDecode"/> for decoding.
- /// </summary>
- /// <param name="instance">The string to encode.</param>
- /// <returns>The escaped string.</returns>
- public static string URIEncode(this string instance)
- {
- return Uri.EscapeDataString(instance);
- }
- // <summary>
- // Return a copy of the string with special characters escaped using the XML standard.
- // </summary>
- public static string XMLEscape(this string instance)
- {
- return SecurityElement.Escape(instance);
- }
- // <summary>
- // Return a copy of the string with escaped characters replaced by their meanings according to the XML standard.
- // </summary>
- public static string XMLUnescape(this string instance)
- {
- return SecurityElement.FromString(instance).Text;
- }
- }
- }
|