StringExtensions.cs

using System;

namespace JavaScriptEngineSwitcher.Core.Extensions
{
	/// <summary>
	/// Extensions for String
	/// </summary>
	public static class StringExtensions
	{
		/// <summary>
		/// Array of strings used to find the newline
		/// </summary>
		private static readonly string[] _newLineStrings = ["\r\n", "\r", "\n"];


		/// <summary>
		/// Returns a value indicating whether the specified quoted string occurs within this string
		/// </summary>
		/// <param name="source">Instance of <see cref="String"/></param>
		/// <param name="value">The string without quotes to seek</param>
		/// <returns><c>true</c> if the quoted value occurs within this string; otherwise, <c>false</c></returns>
		public static bool ContainsQuotedValue(this string source, string value)
		{
			if (source is null)
			{
				throw new ArgumentNullException(nameof(source));
			}

			if (value is null)
			{
				throw new ArgumentNullException(nameof(value));
			}

			bool result = source.Contains("'" + value + "'") || source.Contains("\"" + value + "\"");

			return result;
		}

		/// <summary>
		/// Removes leading occurrence of the specified string from the current <see cref="String"/> object
		/// </summary>
		/// <param name="source">Instance of <see cref="String"/></param>
		/// <param name="trimString">An string to remove</param>
		/// <returns>The string that remains after removing of the specified string from the start of
		/// the current string</returns>
		public static string TrimStart(this string source, string trimString)
		{
			if (source is null)
			{
				throw new ArgumentNullException(nameof(source));
			}

			if (trimString is null)
			{
				throw new ArgumentNullException(nameof(trimString));
			}

			if (source.Length == 0 || trimString.Length == 0)
			{
				return source;
			}

			string result = source;
			if (source.StartsWith(trimString, StringComparison.Ordinal))
			{
				result = source.Substring(trimString.Length);
			}

			return result;
		}

		/// <summary>
		/// Splits a string into lines
		/// </summary>
		/// <param name="source">Instance of <see cref="String"/></param>
		/// <returns>An array of lines</returns>
		[Obsolete]
		public static string[] SplitToLines(this string source)
		{
			if (source is null)
			{
				throw new ArgumentNullException(nameof(source));
			}

			string[] result = source.Split(_newLineStrings, StringSplitOptions.None);

			return result;
		}

		/// <summary>
		/// Splits a string into lines
		/// </summary>
		/// <param name="source">Instance of <see cref="String"/></param>
		/// <param name="options"><see cref="StringSplitOptions.RemoveEmptyEntries"/> to omit empty array
		/// elements from the array returned; or <see cref="StringSplitOptions.None"/> to include empty
		/// array elements in the array returned</param>
		/// <returns>An array of lines</returns>
		internal static string[] SplitToLines(this string source, StringSplitOptions options)
		{
			if (source is null)
			{
				throw new ArgumentNullException(nameof(source));
			}

			string[] result = source.Split(_newLineStrings, options);

			return result;
		}

		/// <summary>
		/// Gets a character at the specified index from the string.
		/// A return value indicates whether the receiving succeeded.
		/// </summary>
		/// <param name="source">The source string</param>
		/// <param name="index">The zero-based index of the character</param>
		/// <param name="result">When this method returns, contains the character from the string,
		/// if the receiving succeeded, or null character if the receiving failed.
		/// The receiving fails if the index out of bounds.</param>
		/// <returns><c>true</c> if the character was received successfully; otherwise, <c>false</c></returns>
		internal static bool TryGetChar(this string source, int index, out char result)
		{
			if (source is null)
			{
				throw new ArgumentNullException(nameof(source));
			}

			bool isSuccess;
			int length = source.Length;

			if (length > 0 && index >= 0 && index < length)
			{
				result = source[index];
				isSuccess = true;
			}
			else
			{
				result = '\0';
				isSuccess = false;
			}

			return isSuccess;
		}
	}
}