DOCUMENTATION: Added XML documentation to DiscImageChef.Core.

This commit is contained in:
2017-12-23 01:46:08 +00:00
parent e7932c12c2
commit 9249a221fc
61 changed files with 1937 additions and 1267 deletions

View File

@@ -40,12 +40,12 @@ namespace DiscImageChef.Checksums
{
public class Fletcher32Context
{
UInt16 sum1, sum2;
byte oddValue;
bool inodd;
byte oddValue;
ushort sum1, sum2;
/// <summary>
/// Initializes the Fletcher32 sums
/// Initializes the Fletcher32 sums
/// </summary>
public void Init()
{
@@ -56,16 +56,14 @@ namespace DiscImageChef.Checksums
}
/// <summary>
/// Updates the hash with data.
/// Updates the hash with data.
/// </summary>
/// <param name="data">Data buffer.</param>
/// <param name="len">Length of buffer to hash.</param>
public void Update(byte[] data, uint len)
{
UInt16 block;
ushort block;
if(!inodd)
{
// Odd size
if(len % 2 != 0)
{
oddValue = data[len - 1];
@@ -74,8 +72,8 @@ namespace DiscImageChef.Checksums
for(int i = 0; i < len - 1; i += 2)
{
block = BigEndianBitConverter.ToUInt16(data, i);
sum1 = (UInt16)((sum1 + block) % 0xFFFF);
sum2 = (UInt16)((sum2 + sum1) % 0xFFFF);
sum1 = (ushort)((sum1 + block) % 0xFFFF);
sum2 = (ushort)((sum2 + sum1) % 0xFFFF);
}
}
else
@@ -84,11 +82,10 @@ namespace DiscImageChef.Checksums
for(int i = 0; i < len; i += 2)
{
block = BigEndianBitConverter.ToUInt16(data, i);
sum1 = (UInt16)((sum1 + block) % 0xFFFF);
sum2 = (UInt16)((sum2 + sum1) % 0xFFFF);
sum1 = (ushort)((sum1 + block) % 0xFFFF);
sum2 = (ushort)((sum2 + sum1) % 0xFFFF);
}
}
}
// Carrying odd
else
{
@@ -97,8 +94,8 @@ namespace DiscImageChef.Checksums
oddData[1] = data[0];
block = BigEndianBitConverter.ToUInt16(oddData, 0);
sum1 = (UInt16)((sum1 + block) % 0xFFFF);
sum2 = (UInt16)((sum2 + sum1) % 0xFFFF);
sum1 = (ushort)((sum1 + block) % 0xFFFF);
sum2 = (ushort)((sum2 + sum1) % 0xFFFF);
// Even size, carrying odd
if(len % 2 == 0)
@@ -109,8 +106,8 @@ namespace DiscImageChef.Checksums
for(int i = 1; i < len - 1; i += 2)
{
block = BigEndianBitConverter.ToUInt16(data, i);
sum1 = (UInt16)((sum1 + block) % 0xFFFF);
sum2 = (UInt16)((sum2 + sum1) % 0xFFFF);
sum1 = (ushort)((sum1 + block) % 0xFFFF);
sum2 = (ushort)((sum2 + sum1) % 0xFFFF);
}
}
else
@@ -119,15 +116,15 @@ namespace DiscImageChef.Checksums
for(int i = 1; i < len; i += 2)
{
block = BigEndianBitConverter.ToUInt16(data, i);
sum1 = (UInt16)((sum1 + block) % 0xFFFF);
sum2 = (UInt16)((sum2 + sum1) % 0xFFFF);
sum1 = (ushort)((sum1 + block) % 0xFFFF);
sum2 = (ushort)((sum2 + sum1) % 0xFFFF);
}
}
}
}
/// <summary>
/// Updates the hash with data.
/// Updates the hash with data.
/// </summary>
/// <param name="data">Data buffer.</param>
public void Update(byte[] data)
@@ -136,68 +133,62 @@ namespace DiscImageChef.Checksums
}
/// <summary>
/// Returns a byte array of the hash value.
/// Returns a byte array of the hash value.
/// </summary>
public byte[] Final()
{
UInt32 finalSum = (UInt32)(sum1 + (sum2 << 16));
uint finalSum = (uint)(sum1 + (sum2 << 16));
return BigEndianBitConverter.GetBytes(finalSum);
}
/// <summary>
/// Returns a hexadecimal representation of the hash value.
/// Returns a hexadecimal representation of the hash value.
/// </summary>
public string End()
{
UInt32 finalSum = (UInt32)(sum1 + (sum2 << 16));
uint finalSum = (uint)(sum1 + (sum2 << 16));
StringBuilder fletcherOutput = new StringBuilder();
for(int i = 0; i < BigEndianBitConverter.GetBytes(finalSum).Length; i++)
{
fletcherOutput.Append(BigEndianBitConverter.GetBytes(finalSum)[i].ToString("x2"));
}
return fletcherOutput.ToString();
}
/// <summary>
/// Gets the hash of a file
/// Gets the hash of a file
/// </summary>
/// <param name="filename">File path.</param>
public static byte[] File(string filename)
{
byte[] hash;
File(filename, out hash);
File(filename, out byte[] hash);
return hash;
}
/// <summary>
/// Gets the hash of a file in hexadecimal and as a byte array.
/// Gets the hash of a file in hexadecimal and as a byte array.
/// </summary>
/// <param name="filename">File path.</param>
/// <param name="hash">Byte array of the hash value.</param>
public static string File(string filename, out byte[] hash)
{
FileStream fileStream = new FileStream(filename, FileMode.Open);
UInt16 localSum1, localSum2, block;
UInt32 finalSum;
ushort localSum1, localSum2, block;
uint finalSum;
byte[] blockBytes;
localSum1 = 0xFFFF;
localSum2 = 0xFFFF;
block = 0;
if(fileStream.Length % 2 == 0)
{
for(int i = 0; i < fileStream.Length; i += 2)
{
blockBytes = new byte[2];
fileStream.Read(blockBytes, 0, 2);
block = BigEndianBitConverter.ToUInt16(blockBytes, 0);
localSum1 = (UInt16)((localSum1 + block) % 0xFFFF);
localSum2 = (UInt16)((localSum2 + localSum1) % 0xFFFF);
localSum1 = (ushort)((localSum1 + block) % 0xFFFF);
localSum2 = (ushort)((localSum2 + localSum1) % 0xFFFF);
}
}
else
{
for(int i = 0; i < fileStream.Length - 1; i += 2)
@@ -205,8 +196,8 @@ namespace DiscImageChef.Checksums
blockBytes = new byte[2];
fileStream.Read(blockBytes, 0, 2);
block = BigEndianBitConverter.ToUInt16(blockBytes, 0);
localSum1 = (UInt16)((localSum1 + block) % 0xFFFF);
localSum2 = (UInt16)((localSum2 + localSum1) % 0xFFFF);
localSum1 = (ushort)((localSum1 + block) % 0xFFFF);
localSum2 = (ushort)((localSum2 + localSum1) % 0xFFFF);
}
byte[] oddData = new byte[2];
@@ -214,55 +205,49 @@ namespace DiscImageChef.Checksums
oddData[1] = 0;
block = BigEndianBitConverter.ToUInt16(oddData, 0);
localSum1 = (UInt16)((localSum1 + block) % 0xFFFF);
localSum2 = (UInt16)((localSum2 + localSum1) % 0xFFFF);
localSum1 = (ushort)((localSum1 + block) % 0xFFFF);
localSum2 = (ushort)((localSum2 + localSum1) % 0xFFFF);
}
finalSum = (UInt32)(localSum1 + (localSum2 << 16));
finalSum = (uint)(localSum1 + (localSum2 << 16));
hash = BitConverter.GetBytes(finalSum);
StringBuilder fletcherOutput = new StringBuilder();
for(int i = 0; i < hash.Length; i++)
{
fletcherOutput.Append(hash[i].ToString("x2"));
}
foreach(byte h in hash) fletcherOutput.Append(h.ToString("x2"));
return fletcherOutput.ToString();
}
/// <summary>
/// Gets the hash of the specified data buffer.
/// Gets the hash of the specified data buffer.
/// </summary>
/// <param name="data">Data buffer.</param>
/// <param name="len">Length of the data buffer to hash.</param>
/// <param name="hash">Byte array of the hash value.</param>
public static string Data(byte[] data, uint len, out byte[] hash)
{
UInt16 localSum1, localSum2, block;
UInt32 finalSum;
ushort localSum1, localSum2, block;
uint finalSum;
localSum1 = 0xFFFF;
localSum2 = 0xFFFF;
block = 0;
if(len % 2 == 0)
{
for(int i = 0; i < len; i += 2)
{
block = BigEndianBitConverter.ToUInt16(data, i);
localSum1 = (UInt16)((localSum1 + block) % 0xFFFF);
localSum2 = (UInt16)((localSum2 + localSum1) % 0xFFFF);
localSum1 = (ushort)((localSum1 + block) % 0xFFFF);
localSum2 = (ushort)((localSum2 + localSum1) % 0xFFFF);
}
}
else
{
for(int i = 0; i < len - 1; i += 2)
{
block = BigEndianBitConverter.ToUInt16(data, i);
localSum1 = (UInt16)((localSum1 + block) % 0xFFFF);
localSum2 = (UInt16)((localSum2 + localSum1) % 0xFFFF);
localSum1 = (ushort)((localSum1 + block) % 0xFFFF);
localSum2 = (ushort)((localSum2 + localSum1) % 0xFFFF);
}
byte[] oddData = new byte[2];
@@ -270,26 +255,23 @@ namespace DiscImageChef.Checksums
oddData[1] = 0;
block = BigEndianBitConverter.ToUInt16(oddData, 0);
localSum1 = (UInt16)((localSum1 + block) % 0xFFFF);
localSum2 = (UInt16)((localSum2 + localSum1) % 0xFFFF);
localSum1 = (ushort)((localSum1 + block) % 0xFFFF);
localSum2 = (ushort)((localSum2 + localSum1) % 0xFFFF);
}
finalSum = (UInt32)(localSum1 + (localSum2 << 16));
finalSum = (uint)(localSum1 + (localSum2 << 16));
hash = BitConverter.GetBytes(finalSum);
StringBuilder fletcherOutput = new StringBuilder();
for(int i = 0; i < hash.Length; i++)
{
fletcherOutput.Append(hash[i].ToString("x2"));
}
foreach(byte h in hash) fletcherOutput.Append(h.ToString("x2"));
return fletcherOutput.ToString();
}
/// <summary>
/// Gets the hash of the specified data buffer.
/// Gets the hash of the specified data buffer.
/// </summary>
/// <param name="data">Data buffer.</param>
/// <param name="hash">Byte array of the hash value.</param>
@@ -304,7 +286,7 @@ namespace DiscImageChef.Checksums
byte sum1, sum2;
/// <summary>
/// Initializes the Fletcher16 sums
/// Initializes the Fletcher16 sums
/// </summary>
public void Init()
{
@@ -313,7 +295,7 @@ namespace DiscImageChef.Checksums
}
/// <summary>
/// Updates the hash with data.
/// Updates the hash with data.
/// </summary>
/// <param name="data">Data buffer.</param>
/// <param name="len">Length of buffer to hash.</param>
@@ -327,7 +309,7 @@ namespace DiscImageChef.Checksums
}
/// <summary>
/// Updates the hash with data.
/// Updates the hash with data.
/// </summary>
/// <param name="data">Data buffer.</param>
public void Update(byte[] data)
@@ -336,43 +318,40 @@ namespace DiscImageChef.Checksums
}
/// <summary>
/// Returns a byte array of the hash value.
/// Returns a byte array of the hash value.
/// </summary>
public byte[] Final()
{
UInt16 finalSum = (UInt16)(sum1 + (sum2 << 8));
ushort finalSum = (ushort)(sum1 + (sum2 << 8));
return BigEndianBitConverter.GetBytes(finalSum);
}
/// <summary>
/// Returns a hexadecimal representation of the hash value.
/// Returns a hexadecimal representation of the hash value.
/// </summary>
public string End()
{
UInt16 finalSum = (UInt16)(sum1 + (sum2 << 8));
ushort finalSum = (ushort)(sum1 + (sum2 << 8));
StringBuilder fletcherOutput = new StringBuilder();
for(int i = 0; i < BigEndianBitConverter.GetBytes(finalSum).Length; i++)
{
fletcherOutput.Append(BigEndianBitConverter.GetBytes(finalSum)[i].ToString("x2"));
}
return fletcherOutput.ToString();
}
/// <summary>
/// Gets the hash of a file
/// Gets the hash of a file
/// </summary>
/// <param name="filename">File path.</param>
public static byte[] File(string filename)
{
byte[] hash;
File(filename, out hash);
File(filename, out byte[] hash);
return hash;
}
/// <summary>
/// Gets the hash of a file in hexadecimal and as a byte array.
/// Gets the hash of a file in hexadecimal and as a byte array.
/// </summary>
/// <param name="filename">File path.</param>
/// <param name="hash">Byte array of the hash value.</param>
@@ -380,11 +359,10 @@ namespace DiscImageChef.Checksums
{
FileStream fileStream = new FileStream(filename, FileMode.Open);
byte localSum1, localSum2, block;
UInt16 finalSum;
ushort finalSum;
localSum1 = 0xFF;
localSum2 = 0xFF;
block = 0;
for(int i = 0; i < fileStream.Length; i += 2)
{
@@ -393,22 +371,19 @@ namespace DiscImageChef.Checksums
localSum2 = (byte)((localSum2 + localSum1) % 0xFF);
}
finalSum = (UInt16)(localSum1 + (localSum2 << 8));
finalSum = (ushort)(localSum1 + (localSum2 << 8));
hash = BitConverter.GetBytes(finalSum);
StringBuilder fletcherOutput = new StringBuilder();
for(int i = 0; i < hash.Length; i++)
{
fletcherOutput.Append(hash[i].ToString("x2"));
}
foreach(byte h in hash) fletcherOutput.Append(h.ToString("x2"));
return fletcherOutput.ToString();
}
/// <summary>
/// Gets the hash of the specified data buffer.
/// Gets the hash of the specified data buffer.
/// </summary>
/// <param name="data">Data buffer.</param>
/// <param name="len">Length of the data buffer to hash.</param>
@@ -416,7 +391,7 @@ namespace DiscImageChef.Checksums
public static string Data(byte[] data, uint len, out byte[] hash)
{
byte localSum1, localSum2;
UInt16 finalSum;
ushort finalSum;
localSum1 = 0xFF;
localSum2 = 0xFF;
@@ -427,22 +402,19 @@ namespace DiscImageChef.Checksums
localSum2 = (byte)((localSum2 + localSum1) % 0xFF);
}
finalSum = (UInt16)(localSum1 + (localSum2 << 8));
finalSum = (ushort)(localSum1 + (localSum2 << 8));
hash = BitConverter.GetBytes(finalSum);
StringBuilder fletcherOutput = new StringBuilder();
for(int i = 0; i < hash.Length; i++)
{
fletcherOutput.Append(hash[i].ToString("x2"));
}
foreach(byte h in hash) fletcherOutput.Append(h.ToString("x2"));
return fletcherOutput.ToString();
}
/// <summary>
/// Gets the hash of the specified data buffer.
/// Gets the hash of the specified data buffer.
/// </summary>
/// <param name="data">Data buffer.</param>
/// <param name="hash">Byte array of the hash value.</param>
@@ -451,6 +423,4 @@ namespace DiscImageChef.Checksums
return Data(data, (uint)data.Length, out hash);
}
}
}
*/
}*/