Added source documentation

This commit is contained in:
2014-09-03 04:25:33 +01:00
parent 82c4bf85bc
commit 4a5d0736a9

View File

@@ -43,6 +43,11 @@ namespace DiscImageChef
{ {
public static class StringHandlers public static class StringHandlers
{ {
/// <summary>
/// Converts a null-terminated (aka C string) ASCII byte array to a C# string
/// </summary>
/// <returns>The corresponding C# string</returns>
/// <param name="CString">A null-terminated (aka C string) ASCII byte array</param>
public static string CToString(byte[] CString) public static string CToString(byte[] CString)
{ {
StringBuilder sb = new StringBuilder(); StringBuilder sb = new StringBuilder();
@@ -58,6 +63,11 @@ namespace DiscImageChef
return sb.ToString(); return sb.ToString();
} }
/// <summary>
/// Converts a length-prefixed (aka Pascal string) ASCII byte array to a C# string
/// </summary>
/// <returns>The corresponding C# string</returns>
/// <param name="PascalString">A length-prefixed (aka Pascal string) ASCII byte array</param>
public static string PascalToString(byte[] PascalString) public static string PascalToString(byte[] PascalString)
{ {
StringBuilder sb = new StringBuilder(); StringBuilder sb = new StringBuilder();
@@ -72,23 +82,28 @@ namespace DiscImageChef
return sb.ToString(); return sb.ToString();
} }
public static string SpaceTerminatedToString(byte[] SpaceTerminatedString) /// <summary>
/// Converts a space (' ', 0x20, ASCII SPACE) padded ASCII byte array to a C# string
/// </summary>
/// <returns>The corresponding C# string</returns>
/// <param name="SpacePaddedString">A space (' ', 0x20, ASCII SPACE) padded ASCII byte array</param>
public static string SpacePaddedToString(byte[] SpacePaddedString)
{ {
int length; int length;
for (int i = SpaceTerminatedString.Length; i >= 0; i--) for (int i = SpacePaddedString.Length; i >= 0; i--)
{ {
if (i == 0) if (i == 0)
return ""; return "";
if (SpaceTerminatedString[i - 1] != 0x20) if (SpacePaddedString[i - 1] != 0x20)
{ {
length = i; length = i;
break; break;
} }
} }
return Encoding.ASCII.GetString(SpaceTerminatedString, 0, length); return Encoding.ASCII.GetString(SpacePaddedString, 0, length);
} }
} }
} }