mirror of
https://github.com/SabreTools/SabreTools.IO.git
synced 2026-02-10 21:31:11 +00:00
Compare commits
34 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b99c80390e | ||
|
|
3a79646650 | ||
|
|
f16f05beb9 | ||
|
|
e901b52143 | ||
|
|
a638b146b4 | ||
|
|
6bfc961a87 | ||
|
|
a825bae039 | ||
|
|
e0eba8e5bb | ||
|
|
fb4b533dfb | ||
|
|
6162af2216 | ||
|
|
3b5fd128f0 | ||
|
|
9beb2177aa | ||
|
|
f0033af712 | ||
|
|
3de5b2378d | ||
|
|
ee7ce59627 | ||
|
|
39bf9c19ad | ||
|
|
32cab49bae | ||
|
|
5d71957841 | ||
|
|
7ea182c7d8 | ||
|
|
b97ec13661 | ||
|
|
8caeea053f | ||
|
|
a7476b6ac9 | ||
|
|
f0095f9e41 | ||
|
|
a0b5ea1368 | ||
|
|
a94d2c8c64 | ||
|
|
8c19ad712a | ||
|
|
0317f751b9 | ||
|
|
b8d431b06b | ||
|
|
3fcf10e2f7 | ||
|
|
40e439b18c | ||
|
|
bf707b1c11 | ||
|
|
d074a6a7ee | ||
|
|
0c736c2491 | ||
|
|
964506057d |
@@ -407,7 +407,7 @@ namespace SabreTools.IO.Test.Extensions
|
||||
var br = new BinaryReader(stream);
|
||||
var expected = new TestStructExplicit
|
||||
{
|
||||
FirstValue = 0x03020100,
|
||||
FirstValue = TestEnum.RecognizedTestValue,
|
||||
SecondValue = 0x07060504,
|
||||
ThirdValue = 0x0504,
|
||||
FourthValue = 0x0706,
|
||||
@@ -434,7 +434,7 @@ namespace SabreTools.IO.Test.Extensions
|
||||
var br = new BinaryReader(stream);
|
||||
var expected = new TestStructSequential
|
||||
{
|
||||
FirstValue = 0x03020100,
|
||||
FirstValue = TestEnum.RecognizedTestValue,
|
||||
SecondValue = 0x07060504,
|
||||
ThirdValue = 0x0908,
|
||||
FourthValue = 0x0B0A,
|
||||
@@ -447,5 +447,140 @@ namespace SabreTools.IO.Test.Extensions
|
||||
Assert.Equal(expected.FourthValue, read.FourthValue);
|
||||
Assert.Equal(expected.FifthValue, read.FifthValue);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ReadTypeStringsTest()
|
||||
{
|
||||
byte[] structBytes =
|
||||
[
|
||||
0x03, 0x41, 0x42, 0x43, // AnsiBStr
|
||||
0x03, 0x00, 0x41, 0x00, 0x42, 0x00, 0x43, 0x00, // BStr
|
||||
0x41, 0x42, 0x43, // ByValTStr
|
||||
0x41, 0x42, 0x43, 0x00, // LPStr
|
||||
0x41, 0x00, 0x42, 0x00, 0x43, 0x00, 0x00, 0x00, // LPWStr
|
||||
];
|
||||
|
||||
var stream = new MemoryStream(structBytes);
|
||||
var br = new BinaryReader(stream);
|
||||
var expected = new TestStructStrings
|
||||
{
|
||||
AnsiBStr = "ABC",
|
||||
BStr = "ABC",
|
||||
ByValTStr = "ABC",
|
||||
LPStr = "ABC",
|
||||
LPWStr = "ABC",
|
||||
};
|
||||
var read = br.ReadType<TestStructStrings>();
|
||||
Assert.Equal(expected.AnsiBStr, read.AnsiBStr);
|
||||
Assert.Equal(expected.BStr, read.BStr);
|
||||
Assert.Equal(expected.ByValTStr, read.ByValTStr);
|
||||
Assert.Equal(expected.LPStr, read.LPStr);
|
||||
Assert.Equal(expected.LPWStr, read.LPWStr);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ReadTypeArraysTest()
|
||||
{
|
||||
byte[] structBytes =
|
||||
[
|
||||
// Byte Array
|
||||
0x00, 0x01, 0x02, 0x03,
|
||||
|
||||
// Int Array
|
||||
0x03, 0x02, 0x01, 0x00,
|
||||
0x04, 0x03, 0x02, 0x01,
|
||||
0x05, 0x04, 0x03, 0x02,
|
||||
0x06, 0x05, 0x04, 0x03,
|
||||
|
||||
// Struct Array (X, Y)
|
||||
0xFF, 0x00, 0x00, 0xFF,
|
||||
0x00, 0xFF, 0xFF, 0x00,
|
||||
0xAA, 0x55, 0x55, 0xAA,
|
||||
0x55, 0xAA, 0xAA, 0x55,
|
||||
|
||||
// LPArray
|
||||
0x04, 0x00,
|
||||
0x00, 0x01, 0x02, 0x03,
|
||||
];
|
||||
|
||||
var stream = new MemoryStream(structBytes);
|
||||
var br = new BinaryReader(stream);
|
||||
var expected = new TestStructArrays
|
||||
{
|
||||
ByteArray = [0x00, 0x01, 0x02, 0x03],
|
||||
IntArray = [0x00010203, 0x01020304, 0x02030405, 0x03040506],
|
||||
StructArray =
|
||||
[
|
||||
new TestStructPoint { X = 0x00FF, Y = 0xFF00 },
|
||||
new TestStructPoint { X = 0xFF00, Y = 0x00FF },
|
||||
new TestStructPoint { X = 0x55AA, Y = 0xAA55 },
|
||||
new TestStructPoint { X = 0xAA55, Y = 0x55AA },
|
||||
],
|
||||
LPByteArrayLength = 0x0004,
|
||||
LPByteArray = [0x00, 0x01, 0x02, 0x03],
|
||||
};
|
||||
var read = br.ReadType<TestStructArrays>();
|
||||
Assert.NotNull(read.ByteArray);
|
||||
Assert.True(expected.ByteArray.SequenceEqual(read.ByteArray));
|
||||
Assert.NotNull(read.IntArray);
|
||||
Assert.True(expected.IntArray.SequenceEqual(read.IntArray));
|
||||
Assert.NotNull(read.StructArray);
|
||||
Assert.True(expected.StructArray.SequenceEqual(read.StructArray));
|
||||
Assert.Equal(expected.LPByteArrayLength, read.LPByteArrayLength);
|
||||
Assert.NotNull(read.LPByteArray);
|
||||
Assert.True(expected.LPByteArray.SequenceEqual(read.LPByteArray));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ReadTypeInheritanceTest()
|
||||
{
|
||||
byte[] structBytes1 =
|
||||
[
|
||||
0x41, 0x42, 0x43, 0x44, // Signature
|
||||
0x00, 0xFF, 0x00, 0xFF, // IdentifierType
|
||||
0xAA, 0x55, 0xAA, 0x55, // FieldA
|
||||
0x55, 0xAA, 0x55, 0xAA, // FieldB
|
||||
];
|
||||
|
||||
var stream1 = new MemoryStream(structBytes1);
|
||||
var br1 = new BinaryReader(stream1);
|
||||
var expected1 = new TestStructInheritanceChild1
|
||||
{
|
||||
Signature = [0x41, 0x42, 0x43, 0x44],
|
||||
IdentifierType = 0xFF00FF00,
|
||||
FieldA = 0x55AA55AA,
|
||||
FieldB = 0xAA55AA55,
|
||||
};
|
||||
var read1 = br1.ReadType<TestStructInheritanceChild1>();
|
||||
Assert.NotNull(read1?.Signature);
|
||||
Assert.Equal(expected1.Signature, read1.Signature);
|
||||
Assert.Equal(expected1.IdentifierType, read1.IdentifierType);
|
||||
Assert.Equal(expected1.FieldA, read1.FieldA);
|
||||
Assert.Equal(expected1.FieldB, read1.FieldB);
|
||||
|
||||
byte[] structBytes2 =
|
||||
[
|
||||
0x41, 0x42, 0x43, 0x44, // Signature
|
||||
0x00, 0xFF, 0x00, 0xFF, // IdentifierType
|
||||
0xAA, 0x55, // FieldA
|
||||
0x55, 0xAA, // FieldB
|
||||
];
|
||||
|
||||
var stream2 = new MemoryStream(structBytes2);
|
||||
var br2 = new BinaryReader(stream2);
|
||||
var expected2 = new TestStructInheritanceChild2
|
||||
{
|
||||
Signature = [0x41, 0x42, 0x43, 0x44],
|
||||
IdentifierType = 0xFF00FF00,
|
||||
FieldA = 0x55AA,
|
||||
FieldB = 0xAA55,
|
||||
};
|
||||
var read2 = br2.ReadType<TestStructInheritanceChild2>();
|
||||
Assert.NotNull(read2?.Signature);
|
||||
Assert.Equal(expected2.Signature, read2.Signature);
|
||||
Assert.Equal(expected2.IdentifierType, read2.IdentifierType);
|
||||
Assert.Equal(expected2.FieldA, read2.FieldA);
|
||||
Assert.Equal(expected2.FieldB, read2.FieldB);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -449,14 +449,21 @@ namespace SabreTools.IO.Test.Extensions
|
||||
[Fact]
|
||||
public void WriteTypeExplicitTest()
|
||||
{
|
||||
byte[] bytesWithString =
|
||||
[
|
||||
0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
|
||||
0x41, 0x42, 0x43, 0x00,
|
||||
];
|
||||
|
||||
var stream = new MemoryStream(new byte[16], 0, 16, true, true);
|
||||
var bw = new BinaryWriter(stream);
|
||||
var obj = new TestStructExplicit
|
||||
{
|
||||
FirstValue = 0x03020100,
|
||||
FirstValue = TestEnum.RecognizedTestValue,
|
||||
SecondValue = 0x07060504,
|
||||
FifthValue = "ABC",
|
||||
};
|
||||
byte[] expected = _bytes.Take(8).ToArray();
|
||||
byte[] expected = bytesWithString.Take(12).ToArray();
|
||||
bool write = bw.WriteType(obj);
|
||||
Assert.True(write);
|
||||
ValidateBytes(expected, stream.GetBuffer());
|
||||
@@ -465,16 +472,23 @@ namespace SabreTools.IO.Test.Extensions
|
||||
[Fact]
|
||||
public void WriteTypeSequentialTest()
|
||||
{
|
||||
byte[] bytesWithString =
|
||||
[
|
||||
0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
|
||||
0x08, 0x09, 0x0A, 0x0B, 0x41, 0x42, 0x43, 0x00,
|
||||
];
|
||||
|
||||
var stream = new MemoryStream(new byte[24], 0, count: 24, true, true);
|
||||
var bw = new BinaryWriter(stream);
|
||||
var obj = new TestStructSequential
|
||||
{
|
||||
FirstValue = 0x03020100,
|
||||
FirstValue = TestEnum.RecognizedTestValue,
|
||||
SecondValue = 0x07060504,
|
||||
ThirdValue = 0x0908,
|
||||
FourthValue = 0x0B0A,
|
||||
FifthValue = "ABC",
|
||||
};
|
||||
byte[] expected = _bytes.Take(12).ToArray();
|
||||
byte[] expected = bytesWithString.Take(16).ToArray();
|
||||
bool write = bw.WriteType(obj);
|
||||
Assert.True(write);
|
||||
ValidateBytes(expected, stream.GetBuffer());
|
||||
|
||||
@@ -374,7 +374,7 @@ namespace SabreTools.IO.Test.Extensions
|
||||
int offset = 0;
|
||||
var expected = new TestStructExplicit
|
||||
{
|
||||
FirstValue = 0x03020100,
|
||||
FirstValue = TestEnum.RecognizedTestValue,
|
||||
SecondValue = 0x07060504,
|
||||
ThirdValue = 0x0504,
|
||||
FourthValue = 0x0706,
|
||||
@@ -399,7 +399,7 @@ namespace SabreTools.IO.Test.Extensions
|
||||
int offset = 0;
|
||||
var expected = new TestStructSequential
|
||||
{
|
||||
FirstValue = 0x03020100,
|
||||
FirstValue = TestEnum.RecognizedTestValue,
|
||||
SecondValue = 0x07060504,
|
||||
ThirdValue = 0x0908,
|
||||
FourthValue = 0x0B0A,
|
||||
@@ -412,5 +412,136 @@ namespace SabreTools.IO.Test.Extensions
|
||||
Assert.Equal(expected.FourthValue, read.FourthValue);
|
||||
Assert.Equal(expected.FifthValue, read.FifthValue);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ReadTypeStringsTest()
|
||||
{
|
||||
byte[] structBytes =
|
||||
[
|
||||
0x03, 0x41, 0x42, 0x43, // AnsiBStr
|
||||
0x03, 0x00, 0x41, 0x00, 0x42, 0x00, 0x43, 0x00, // BStr
|
||||
0x41, 0x42, 0x43, // ByValTStr
|
||||
0x41, 0x42, 0x43, 0x00, // LPStr
|
||||
0x41, 0x00, 0x42, 0x00, 0x43, 0x00, 0x00, 0x00, // LPWStr
|
||||
];
|
||||
|
||||
int offset = 0;
|
||||
var expected = new TestStructStrings
|
||||
{
|
||||
AnsiBStr = "ABC",
|
||||
BStr = "ABC",
|
||||
ByValTStr = "ABC",
|
||||
LPStr = "ABC",
|
||||
LPWStr = "ABC",
|
||||
};
|
||||
var read = structBytes.ReadType<TestStructStrings>(ref offset);
|
||||
Assert.Equal(expected.AnsiBStr, read.AnsiBStr);
|
||||
Assert.Equal(expected.BStr, read.BStr);
|
||||
Assert.Equal(expected.ByValTStr, read.ByValTStr);
|
||||
Assert.Equal(expected.LPStr, read.LPStr);
|
||||
Assert.Equal(expected.LPWStr, read.LPWStr);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ReadTypeArraysTest()
|
||||
{
|
||||
byte[] structBytes =
|
||||
[
|
||||
// Byte Array
|
||||
0x00, 0x01, 0x02, 0x03,
|
||||
|
||||
// Int Array
|
||||
0x03, 0x02, 0x01, 0x00,
|
||||
0x04, 0x03, 0x02, 0x01,
|
||||
0x05, 0x04, 0x03, 0x02,
|
||||
0x06, 0x05, 0x04, 0x03,
|
||||
|
||||
// Struct Array (X, Y)
|
||||
0xFF, 0x00, 0x00, 0xFF,
|
||||
0x00, 0xFF, 0xFF, 0x00,
|
||||
0xAA, 0x55, 0x55, 0xAA,
|
||||
0x55, 0xAA, 0xAA, 0x55,
|
||||
|
||||
// LPArray
|
||||
0x04, 0x00,
|
||||
0x00, 0x01, 0x02, 0x03,
|
||||
];
|
||||
|
||||
int offset = 0;
|
||||
var expected = new TestStructArrays
|
||||
{
|
||||
ByteArray = [0x00, 0x01, 0x02, 0x03],
|
||||
IntArray = [0x00010203, 0x01020304, 0x02030405, 0x03040506],
|
||||
StructArray =
|
||||
[
|
||||
new TestStructPoint { X = 0x00FF, Y = 0xFF00 },
|
||||
new TestStructPoint { X = 0xFF00, Y = 0x00FF },
|
||||
new TestStructPoint { X = 0x55AA, Y = 0xAA55 },
|
||||
new TestStructPoint { X = 0xAA55, Y = 0x55AA },
|
||||
],
|
||||
LPByteArrayLength = 0x0004,
|
||||
LPByteArray = [0x00, 0x01, 0x02, 0x03],
|
||||
};
|
||||
var read = structBytes.ReadType<TestStructArrays>(ref offset);
|
||||
Assert.NotNull(read.ByteArray);
|
||||
Assert.True(expected.ByteArray.SequenceEqual(read.ByteArray));
|
||||
Assert.NotNull(read.IntArray);
|
||||
Assert.True(expected.IntArray.SequenceEqual(read.IntArray));
|
||||
Assert.NotNull(read.StructArray);
|
||||
Assert.True(expected.StructArray.SequenceEqual(read.StructArray));
|
||||
Assert.Equal(expected.LPByteArrayLength, read.LPByteArrayLength);
|
||||
Assert.NotNull(read.LPByteArray);
|
||||
Assert.True(expected.LPByteArray.SequenceEqual(read.LPByteArray));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ReadTypeInheritanceTest()
|
||||
{
|
||||
byte[] structBytes1 =
|
||||
[
|
||||
0x41, 0x42, 0x43, 0x44, // Signature
|
||||
0x00, 0xFF, 0x00, 0xFF, // IdentifierType
|
||||
0xAA, 0x55, 0xAA, 0x55, // FieldA
|
||||
0x55, 0xAA, 0x55, 0xAA, // FieldB
|
||||
];
|
||||
|
||||
int offset1 = 0;
|
||||
var expected1 = new TestStructInheritanceChild1
|
||||
{
|
||||
Signature = [0x41, 0x42, 0x43, 0x44],
|
||||
IdentifierType = 0xFF00FF00,
|
||||
FieldA = 0x55AA55AA,
|
||||
FieldB = 0xAA55AA55,
|
||||
};
|
||||
var read1 = structBytes1.ReadType<TestStructInheritanceChild1>(ref offset1);
|
||||
Assert.NotNull(read1?.Signature);
|
||||
Assert.Equal(expected1.Signature, read1.Signature);
|
||||
Assert.Equal(expected1.IdentifierType, read1.IdentifierType);
|
||||
Assert.Equal(expected1.FieldA, read1.FieldA);
|
||||
Assert.Equal(expected1.FieldB, read1.FieldB);
|
||||
|
||||
byte[] structBytes2 =
|
||||
[
|
||||
0x41, 0x42, 0x43, 0x44, // Signature
|
||||
0x00, 0xFF, 0x00, 0xFF, // IdentifierType
|
||||
0xAA, 0x55, // FieldA
|
||||
0x55, 0xAA, // FieldB
|
||||
];
|
||||
|
||||
int offset2 = 0;
|
||||
var expected2 = new TestStructInheritanceChild2
|
||||
{
|
||||
Signature = [0x41, 0x42, 0x43, 0x44],
|
||||
IdentifierType = 0xFF00FF00,
|
||||
FieldA = 0x55AA,
|
||||
FieldB = 0xAA55,
|
||||
};
|
||||
var read2 = structBytes2.ReadType<TestStructInheritanceChild2>(ref offset2);
|
||||
Assert.NotNull(read2?.Signature);
|
||||
Assert.Equal(expected2.Signature, read2.Signature);
|
||||
Assert.Equal(expected2.IdentifierType, read2.IdentifierType);
|
||||
Assert.Equal(expected2.FieldA, read2.FieldA);
|
||||
Assert.Equal(expected2.FieldB, read2.FieldB);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -432,14 +432,21 @@ namespace SabreTools.IO.Test.Extensions
|
||||
[Fact]
|
||||
public void WriteTypeExplicitTest()
|
||||
{
|
||||
byte[] bytesWithString =
|
||||
[
|
||||
0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
|
||||
0x41, 0x42, 0x43, 0x00,
|
||||
];
|
||||
|
||||
byte[] buffer = new byte[16];
|
||||
int offset = 0;
|
||||
var obj = new TestStructExplicit
|
||||
{
|
||||
FirstValue = 0x03020100,
|
||||
FirstValue = TestEnum.RecognizedTestValue,
|
||||
SecondValue = 0x07060504,
|
||||
FifthValue = "ABC",
|
||||
};
|
||||
byte[] expected = _bytes.Take(8).ToArray();
|
||||
byte[] expected = bytesWithString.Take(12).ToArray();
|
||||
bool write = buffer.WriteType(ref offset, obj);
|
||||
Assert.True(write);
|
||||
ValidateBytes(expected, buffer);
|
||||
@@ -448,16 +455,23 @@ namespace SabreTools.IO.Test.Extensions
|
||||
[Fact]
|
||||
public void WriteTypeSequentialTest()
|
||||
{
|
||||
byte[] bytesWithString =
|
||||
[
|
||||
0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
|
||||
0x08, 0x09, 0x0A, 0x0B, 0x41, 0x42, 0x43, 0x00,
|
||||
];
|
||||
|
||||
byte[] buffer = new byte[24];
|
||||
int offset = 0;
|
||||
var obj = new TestStructSequential
|
||||
{
|
||||
FirstValue = 0x03020100,
|
||||
FirstValue = TestEnum.RecognizedTestValue,
|
||||
SecondValue = 0x07060504,
|
||||
ThirdValue = 0x0908,
|
||||
FourthValue = 0x0B0A,
|
||||
FifthValue = "ABC",
|
||||
};
|
||||
byte[] expected = _bytes.Take(12).ToArray();
|
||||
byte[] expected = bytesWithString.Take(16).ToArray();
|
||||
bool write = buffer.WriteType(ref offset, obj);
|
||||
Assert.True(write);
|
||||
ValidateBytes(expected, buffer);
|
||||
|
||||
@@ -368,7 +368,7 @@ namespace SabreTools.IO.Test.Extensions
|
||||
var stream = new MemoryStream(bytesWithString);
|
||||
var expected = new TestStructExplicit
|
||||
{
|
||||
FirstValue = 0x03020100,
|
||||
FirstValue = TestEnum.RecognizedTestValue,
|
||||
SecondValue = 0x07060504,
|
||||
ThirdValue = 0x0504,
|
||||
FourthValue = 0x0706,
|
||||
@@ -393,7 +393,7 @@ namespace SabreTools.IO.Test.Extensions
|
||||
var stream = new MemoryStream(bytesWithString);
|
||||
var expected = new TestStructSequential
|
||||
{
|
||||
FirstValue = 0x03020100,
|
||||
FirstValue = TestEnum.RecognizedTestValue,
|
||||
SecondValue = 0x07060504,
|
||||
ThirdValue = 0x0908,
|
||||
FourthValue = 0x0B0A,
|
||||
@@ -406,5 +406,136 @@ namespace SabreTools.IO.Test.Extensions
|
||||
Assert.Equal(expected.FourthValue, read.FourthValue);
|
||||
Assert.Equal(expected.FifthValue, read.FifthValue);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ReadTypeStringsTest()
|
||||
{
|
||||
byte[] structBytes =
|
||||
[
|
||||
0x03, 0x41, 0x42, 0x43, // AnsiBStr
|
||||
0x03, 0x00, 0x41, 0x00, 0x42, 0x00, 0x43, 0x00, // BStr
|
||||
0x41, 0x42, 0x43, // ByValTStr
|
||||
0x41, 0x42, 0x43, 0x00, // LPStr
|
||||
0x41, 0x00, 0x42, 0x00, 0x43, 0x00, 0x00, 0x00, // LPWStr
|
||||
];
|
||||
|
||||
var stream = new MemoryStream(structBytes);
|
||||
var expected = new TestStructStrings
|
||||
{
|
||||
AnsiBStr = "ABC",
|
||||
BStr = "ABC",
|
||||
ByValTStr = "ABC",
|
||||
LPStr = "ABC",
|
||||
LPWStr = "ABC",
|
||||
};
|
||||
var read = stream.ReadType<TestStructStrings>();
|
||||
Assert.Equal(expected.AnsiBStr, read.AnsiBStr);
|
||||
Assert.Equal(expected.BStr, read.BStr);
|
||||
Assert.Equal(expected.ByValTStr, read.ByValTStr);
|
||||
Assert.Equal(expected.LPStr, read.LPStr);
|
||||
Assert.Equal(expected.LPWStr, read.LPWStr);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ReadTypeArraysTest()
|
||||
{
|
||||
byte[] structBytes =
|
||||
[
|
||||
// Byte Array
|
||||
0x00, 0x01, 0x02, 0x03,
|
||||
|
||||
// Int Array
|
||||
0x03, 0x02, 0x01, 0x00,
|
||||
0x04, 0x03, 0x02, 0x01,
|
||||
0x05, 0x04, 0x03, 0x02,
|
||||
0x06, 0x05, 0x04, 0x03,
|
||||
|
||||
// Struct Array (X, Y)
|
||||
0xFF, 0x00, 0x00, 0xFF,
|
||||
0x00, 0xFF, 0xFF, 0x00,
|
||||
0xAA, 0x55, 0x55, 0xAA,
|
||||
0x55, 0xAA, 0xAA, 0x55,
|
||||
|
||||
// LPArray
|
||||
0x04, 0x00,
|
||||
0x00, 0x01, 0x02, 0x03,
|
||||
];
|
||||
|
||||
var stream = new MemoryStream(structBytes);
|
||||
var expected = new TestStructArrays
|
||||
{
|
||||
ByteArray = [0x00, 0x01, 0x02, 0x03],
|
||||
IntArray = [0x00010203, 0x01020304, 0x02030405, 0x03040506],
|
||||
StructArray =
|
||||
[
|
||||
new TestStructPoint { X = 0x00FF, Y = 0xFF00 },
|
||||
new TestStructPoint { X = 0xFF00, Y = 0x00FF },
|
||||
new TestStructPoint { X = 0x55AA, Y = 0xAA55 },
|
||||
new TestStructPoint { X = 0xAA55, Y = 0x55AA },
|
||||
],
|
||||
LPByteArrayLength = 0x0004,
|
||||
LPByteArray = [0x00, 0x01, 0x02, 0x03],
|
||||
};
|
||||
var read = stream.ReadType<TestStructArrays>();
|
||||
Assert.NotNull(read.ByteArray);
|
||||
Assert.True(expected.ByteArray.SequenceEqual(read.ByteArray));
|
||||
Assert.NotNull(read.IntArray);
|
||||
Assert.True(expected.IntArray.SequenceEqual(read.IntArray));
|
||||
Assert.NotNull(read.StructArray);
|
||||
Assert.True(expected.StructArray.SequenceEqual(read.StructArray));
|
||||
Assert.Equal(expected.LPByteArrayLength, read.LPByteArrayLength);
|
||||
Assert.NotNull(read.LPByteArray);
|
||||
Assert.True(expected.LPByteArray.SequenceEqual(read.LPByteArray));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ReadTypeInheritanceTest()
|
||||
{
|
||||
byte[] structBytes1 =
|
||||
[
|
||||
0x41, 0x42, 0x43, 0x44, // Signature
|
||||
0x00, 0xFF, 0x00, 0xFF, // IdentifierType
|
||||
0xAA, 0x55, 0xAA, 0x55, // FieldA
|
||||
0x55, 0xAA, 0x55, 0xAA, // FieldB
|
||||
];
|
||||
|
||||
var stream1 = new MemoryStream(structBytes1);
|
||||
var expected1 = new TestStructInheritanceChild1
|
||||
{
|
||||
Signature = [0x41, 0x42, 0x43, 0x44],
|
||||
IdentifierType = 0xFF00FF00,
|
||||
FieldA = 0x55AA55AA,
|
||||
FieldB = 0xAA55AA55,
|
||||
};
|
||||
var read1 = stream1.ReadType<TestStructInheritanceChild1>();
|
||||
Assert.NotNull(read1?.Signature);
|
||||
Assert.Equal(expected1.Signature, read1.Signature);
|
||||
Assert.Equal(expected1.IdentifierType, read1.IdentifierType);
|
||||
Assert.Equal(expected1.FieldA, read1.FieldA);
|
||||
Assert.Equal(expected1.FieldB, read1.FieldB);
|
||||
|
||||
byte[] structBytes2 =
|
||||
[
|
||||
0x41, 0x42, 0x43, 0x44, // Signature
|
||||
0x00, 0xFF, 0x00, 0xFF, // IdentifierType
|
||||
0xAA, 0x55, // FieldA
|
||||
0x55, 0xAA, // FieldB
|
||||
];
|
||||
|
||||
var stream2 = new MemoryStream(structBytes2);
|
||||
var expected2 = new TestStructInheritanceChild2
|
||||
{
|
||||
Signature = [0x41, 0x42, 0x43, 0x44],
|
||||
IdentifierType = 0xFF00FF00,
|
||||
FieldA = 0x55AA,
|
||||
FieldB = 0xAA55,
|
||||
};
|
||||
var read2 = stream2.ReadType<TestStructInheritanceChild2>();
|
||||
Assert.NotNull(read2?.Signature);
|
||||
Assert.Equal(expected2.Signature, read2.Signature);
|
||||
Assert.Equal(expected2.IdentifierType, read2.IdentifierType);
|
||||
Assert.Equal(expected2.FieldA, read2.FieldA);
|
||||
Assert.Equal(expected2.FieldB, read2.FieldB);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -397,13 +397,20 @@ namespace SabreTools.IO.Test.Extensions
|
||||
[Fact]
|
||||
public void WriteTypeExplicitTest()
|
||||
{
|
||||
byte[] bytesWithString =
|
||||
[
|
||||
0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
|
||||
0x41, 0x42, 0x43, 0x00,
|
||||
];
|
||||
|
||||
var stream = new MemoryStream(new byte[16], 0, 16, true, true);
|
||||
var obj = new TestStructExplicit
|
||||
{
|
||||
FirstValue = 0x03020100,
|
||||
FirstValue = TestEnum.RecognizedTestValue,
|
||||
SecondValue = 0x07060504,
|
||||
FifthValue = "ABC",
|
||||
};
|
||||
byte[] expected = _bytes.Take(8).ToArray();
|
||||
byte[] expected = bytesWithString.Take(12).ToArray();
|
||||
bool write = stream.WriteType(obj);
|
||||
Assert.True(write);
|
||||
ValidateBytes(expected, stream.GetBuffer());
|
||||
@@ -412,15 +419,22 @@ namespace SabreTools.IO.Test.Extensions
|
||||
[Fact]
|
||||
public void WriteTypeSequentialTest()
|
||||
{
|
||||
byte[] bytesWithString =
|
||||
[
|
||||
0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
|
||||
0x08, 0x09, 0x0A, 0x0B, 0x41, 0x42, 0x43, 0x00,
|
||||
];
|
||||
|
||||
var stream = new MemoryStream(new byte[24], 0, 24, true, true);
|
||||
var obj = new TestStructSequential
|
||||
{
|
||||
FirstValue = 0x03020100,
|
||||
FirstValue = TestEnum.RecognizedTestValue,
|
||||
SecondValue = 0x07060504,
|
||||
ThirdValue = 0x0908,
|
||||
FourthValue = 0x0B0A,
|
||||
FifthValue = "ABC",
|
||||
};
|
||||
byte[] expected = _bytes.Take(12).ToArray();
|
||||
byte[] expected = bytesWithString.Take(16).ToArray();
|
||||
bool write = stream.WriteType(obj);
|
||||
Assert.True(write);
|
||||
ValidateBytes(expected, stream.GetBuffer());
|
||||
|
||||
9
SabreTools.IO.Test/Extensions/TestEnum.cs
Normal file
9
SabreTools.IO.Test/Extensions/TestEnum.cs
Normal file
@@ -0,0 +1,9 @@
|
||||
namespace SabreTools.IO.Test.Extensions
|
||||
{
|
||||
internal enum TestEnum : uint
|
||||
{
|
||||
None = 0x00000000,
|
||||
RecognizedTestValue = 0x03020100,
|
||||
UpperBoundaryValue = 0xFFFFFFFF,
|
||||
}
|
||||
}
|
||||
53
SabreTools.IO.Test/Extensions/TestStructArrays.cs
Normal file
53
SabreTools.IO.Test/Extensions/TestStructArrays.cs
Normal file
@@ -0,0 +1,53 @@
|
||||
using System.Runtime.InteropServices;
|
||||
|
||||
namespace SabreTools.IO.Test.Extensions
|
||||
{
|
||||
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Ansi)]
|
||||
internal struct TestStructArrays
|
||||
{
|
||||
/// <summary>
|
||||
/// 4 entry byte array
|
||||
/// </summary>
|
||||
[MarshalAs(UnmanagedType.ByValArray, SizeConst = 4)]
|
||||
public byte[]? ByteArray;
|
||||
|
||||
/// <summary>
|
||||
/// 4 entry int array
|
||||
/// </summary>
|
||||
[MarshalAs(UnmanagedType.ByValArray, SizeConst = 4)]
|
||||
public int[]? IntArray;
|
||||
|
||||
/// <summary>
|
||||
/// 4 entry struct array
|
||||
/// </summary>
|
||||
[MarshalAs(UnmanagedType.ByValArray, SizeConst = 4)]
|
||||
public TestStructPoint[]? StructArray;
|
||||
|
||||
/// <summary>
|
||||
/// Length of <see cref="LPByteArray"/>
|
||||
/// </summary>
|
||||
public ushort LPByteArrayLength;
|
||||
|
||||
/// <summary>
|
||||
/// 4 entry byte array whose length is defined by <see cref="LPByteArrayLength"/>
|
||||
/// </summary>
|
||||
[MarshalAs(UnmanagedType.LPArray, SizeParamIndex = 3)]
|
||||
public byte[]? LPByteArray;
|
||||
|
||||
// /// <summary>
|
||||
// /// 4 entry nested byte array
|
||||
// /// </summary>
|
||||
// /// <remarks>This will likely fail</remarks>
|
||||
// [MarshalAs(UnmanagedType.ByValArray, SizeConst = 4)]
|
||||
// public byte[][]? NestedByteArray;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Struct for nested tests
|
||||
/// </summary>
|
||||
internal struct TestStructPoint
|
||||
{
|
||||
public ushort X;
|
||||
public ushort Y;
|
||||
}
|
||||
}
|
||||
@@ -6,7 +6,7 @@ namespace SabreTools.IO.Test.Extensions
|
||||
internal struct TestStructExplicit
|
||||
{
|
||||
[FieldOffset(0)]
|
||||
public int FirstValue;
|
||||
public TestEnum FirstValue;
|
||||
|
||||
[FieldOffset(4)]
|
||||
public int SecondValue;
|
||||
|
||||
29
SabreTools.IO.Test/Extensions/TestStructInheritance.cs
Normal file
29
SabreTools.IO.Test/Extensions/TestStructInheritance.cs
Normal file
@@ -0,0 +1,29 @@
|
||||
using System.Runtime.InteropServices;
|
||||
|
||||
namespace SabreTools.IO.Test.Extensions
|
||||
{
|
||||
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Ansi)]
|
||||
internal class TestStructInheritanceParent
|
||||
{
|
||||
[MarshalAs(UnmanagedType.ByValArray, SizeConst = 4)]
|
||||
public byte[]? Signature;
|
||||
|
||||
public uint IdentifierType;
|
||||
}
|
||||
|
||||
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Ansi)]
|
||||
internal class TestStructInheritanceChild1 : TestStructInheritanceParent
|
||||
{
|
||||
public uint FieldA;
|
||||
|
||||
public uint FieldB;
|
||||
}
|
||||
|
||||
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Ansi)]
|
||||
internal class TestStructInheritanceChild2 : TestStructInheritanceParent
|
||||
{
|
||||
public ushort FieldA;
|
||||
|
||||
public ushort FieldB;
|
||||
}
|
||||
}
|
||||
@@ -5,7 +5,7 @@ namespace SabreTools.IO.Test.Extensions
|
||||
[StructLayout(LayoutKind.Sequential)]
|
||||
internal struct TestStructSequential
|
||||
{
|
||||
public int FirstValue;
|
||||
public TestEnum FirstValue;
|
||||
|
||||
public int SecondValue;
|
||||
|
||||
|
||||
38
SabreTools.IO.Test/Extensions/TestStructStrings.cs
Normal file
38
SabreTools.IO.Test/Extensions/TestStructStrings.cs
Normal file
@@ -0,0 +1,38 @@
|
||||
using System.Runtime.InteropServices;
|
||||
|
||||
namespace SabreTools.IO.Test.Extensions
|
||||
{
|
||||
[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Ansi)]
|
||||
internal struct TestStructStrings
|
||||
{
|
||||
/// <summary>
|
||||
/// ASCII-encoded, byte-length-prefixed string
|
||||
/// </summary>
|
||||
[MarshalAs(UnmanagedType.AnsiBStr)]
|
||||
public string? AnsiBStr;
|
||||
|
||||
/// <summary>
|
||||
/// Unicode-encoded, WORD-length-prefixed string
|
||||
/// </summary>
|
||||
[MarshalAs(UnmanagedType.BStr)]
|
||||
public string? BStr;
|
||||
|
||||
/// <summary>
|
||||
/// Fixed length string
|
||||
/// </summary>
|
||||
[MarshalAs(UnmanagedType.ByValTStr, SizeConst = 3)]
|
||||
public string? ByValTStr;
|
||||
|
||||
/// <summary>
|
||||
/// ASCII-encoded, null-terminated string
|
||||
/// </summary>
|
||||
[MarshalAs(UnmanagedType.LPStr)]
|
||||
public string? LPStr;
|
||||
|
||||
/// <summary>
|
||||
/// Unicode-encoded, null-terminated string
|
||||
/// </summary>
|
||||
[MarshalAs(UnmanagedType.LPWStr)]
|
||||
public string? LPWStr;
|
||||
}
|
||||
}
|
||||
@@ -6,6 +6,7 @@
|
||||
<LangVersion>latest</LangVersion>
|
||||
<Nullable>enable</Nullable>
|
||||
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
|
||||
<WarningsNotAsErrors>CS0618</WarningsNotAsErrors>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
|
||||
@@ -326,8 +326,12 @@ namespace SabreTools.IO.Extensions
|
||||
// Short-circuit to explicit implementations
|
||||
if (encoding.Equals(Encoding.ASCII))
|
||||
return reader.ReadNullTerminatedAnsiString();
|
||||
else if (encoding.Equals(Encoding.UTF8))
|
||||
return reader.ReadNullTerminatedUTF8String();
|
||||
else if (encoding.Equals(Encoding.Unicode))
|
||||
return reader.ReadNullTerminatedUnicodeString();
|
||||
else if (encoding.Equals(Encoding.UTF32))
|
||||
return reader.ReadNullTerminatedUTF32String();
|
||||
|
||||
if (reader.BaseStream.Position >= reader.BaseStream.Length)
|
||||
return null;
|
||||
@@ -352,36 +356,44 @@ namespace SabreTools.IO.Extensions
|
||||
if (reader.BaseStream.Position >= reader.BaseStream.Length)
|
||||
return null;
|
||||
|
||||
List<byte> buffer = [];
|
||||
while (reader.BaseStream.Position < reader.BaseStream.Length)
|
||||
{
|
||||
byte ch = reader.ReadByte();
|
||||
buffer.Add(ch);
|
||||
if (ch == '\0')
|
||||
break;
|
||||
}
|
||||
|
||||
return Encoding.ASCII.GetString([.. buffer]);
|
||||
byte[] buffer = ReadUntilNull1Byte(reader);
|
||||
return Encoding.ASCII.GetString(buffer);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read a null-terminated Unicode string from the underlying stream
|
||||
/// Read a null-terminated UTF-8 string from the underlying stream
|
||||
/// </summary>
|
||||
public static string? ReadNullTerminatedUTF8String(this BinaryReader reader)
|
||||
{
|
||||
if (reader.BaseStream.Position >= reader.BaseStream.Length)
|
||||
return null;
|
||||
|
||||
byte[] buffer = ReadUntilNull1Byte(reader);
|
||||
return Encoding.ASCII.GetString(buffer);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read a null-terminated UTF-16 (Unicode) string from the underlying stream
|
||||
/// </summary>
|
||||
public static string? ReadNullTerminatedUnicodeString(this BinaryReader reader)
|
||||
{
|
||||
if (reader.BaseStream.Position >= reader.BaseStream.Length)
|
||||
return null;
|
||||
|
||||
List<byte> buffer = [];
|
||||
while (reader.BaseStream.Position < reader.BaseStream.Length)
|
||||
{
|
||||
byte[] ch = reader.ReadBytes(2);
|
||||
buffer.AddRange(ch);
|
||||
if (ch[0] == '\0' && ch[1] == '\0')
|
||||
break;
|
||||
}
|
||||
byte[] buffer = ReadUntilNull2Byte(reader);
|
||||
return Encoding.Unicode.GetString(buffer);
|
||||
}
|
||||
|
||||
return Encoding.Unicode.GetString([.. buffer]);
|
||||
/// <summary>
|
||||
/// Read a null-terminated UTF-32 string from the underlying stream
|
||||
/// </summary>
|
||||
public static string? ReadNullTerminatedUTF32String(this BinaryReader reader)
|
||||
{
|
||||
if (reader.BaseStream.Position >= reader.BaseStream.Length)
|
||||
return null;
|
||||
|
||||
byte[] buffer = ReadUntilNull4Byte(reader);
|
||||
return Encoding.Unicode.GetString(buffer);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -409,10 +421,10 @@ namespace SabreTools.IO.Extensions
|
||||
return null;
|
||||
|
||||
ushort size = reader.ReadUInt16();
|
||||
if (reader.BaseStream.Position + size >= reader.BaseStream.Length)
|
||||
if (reader.BaseStream.Position + (size * 2) >= reader.BaseStream.Length)
|
||||
return null;
|
||||
|
||||
byte[] buffer = reader.ReadBytes(size);
|
||||
byte[] buffer = reader.ReadBytes(size * 2);
|
||||
return Encoding.Unicode.GetString(buffer);
|
||||
}
|
||||
|
||||
@@ -458,16 +470,34 @@ namespace SabreTools.IO.Extensions
|
||||
/// <summary>
|
||||
/// Read a <typeparamref name="T"/> from the underlying stream
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This method is different than standard marshalling in a few notable ways:
|
||||
/// - Strings are read by value, not by reference
|
||||
/// - Complex objects are read by value, not by reference
|
||||
/// - Enumeration values are read by the underlying value type
|
||||
/// - Arrays of the above are handled sequentially as above
|
||||
/// - Inherited fields from parents are deserialized BEFORE fields in the child
|
||||
/// </remarks>
|
||||
public static T? ReadType<T>(this BinaryReader reader)
|
||||
=> (T?)reader.ReadType(typeof(T));
|
||||
|
||||
/// <summary>
|
||||
/// Read a <paramref name="type"/> from the underlying stream
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This method is different than standard marshalling in a few notable ways:
|
||||
/// - Strings are read by value, not by reference
|
||||
/// - Complex objects are read by value, not by reference
|
||||
/// - Enumeration values are read by the underlying value type
|
||||
/// - Arrays of the above are handled sequentially as above
|
||||
/// - Inherited fields from parents are deserialized BEFORE fields in the child
|
||||
/// </remarks>
|
||||
public static object? ReadType(this BinaryReader reader, Type type)
|
||||
{
|
||||
if (type.IsClass || (type.IsValueType && !type.IsPrimitive))
|
||||
if (type.IsClass || (type.IsValueType && !type.IsEnum && !type.IsPrimitive))
|
||||
return ReadComplexType(reader, type);
|
||||
else if (type.IsValueType && type.IsEnum)
|
||||
return ReadNormalType(reader, Enum.GetUnderlyingType(type));
|
||||
else
|
||||
return ReadNormalType(reader, type);
|
||||
}
|
||||
@@ -480,7 +510,7 @@ namespace SabreTools.IO.Extensions
|
||||
try
|
||||
{
|
||||
int typeSize = Marshal.SizeOf(type);
|
||||
byte[] buffer = reader.ReadBytes(typeSize);;
|
||||
byte[] buffer = reader.ReadBytes(typeSize); ;
|
||||
|
||||
var handle = GCHandle.Alloc(buffer, GCHandleType.Pinned);
|
||||
var data = Marshal.PtrToStructure(handle.AddrOfPinnedObject(), type);
|
||||
@@ -497,49 +527,33 @@ namespace SabreTools.IO.Extensions
|
||||
/// <summary>
|
||||
/// Read a <paramref name="type"/> from the underlying stream
|
||||
/// </summary>
|
||||
private static object? ReadComplexType(this BinaryReader reader, Type type)
|
||||
private static object? ReadComplexType(BinaryReader reader, Type type)
|
||||
{
|
||||
try
|
||||
{
|
||||
// Try to create an instance of the type
|
||||
var instance = Activator.CreateInstance(type);
|
||||
if (instance == null)
|
||||
return null;
|
||||
|
||||
// Get the layout attribute
|
||||
var layoutAttr = type.GetCustomAttributes(typeof(StructLayoutAttribute), true).FirstOrDefault() as StructLayoutAttribute;
|
||||
|
||||
// Get the layout type
|
||||
LayoutKind layoutKind = LayoutKind.Auto;
|
||||
if (layoutAttr != null)
|
||||
layoutKind = layoutAttr.Value;
|
||||
else if (type.IsAutoLayout)
|
||||
layoutKind = LayoutKind.Auto;
|
||||
else if (type.IsExplicitLayout)
|
||||
layoutKind = LayoutKind.Explicit;
|
||||
else if (type.IsLayoutSequential)
|
||||
layoutKind = LayoutKind.Sequential;
|
||||
|
||||
// Get the encoding to use
|
||||
Encoding encoding = layoutAttr?.CharSet switch
|
||||
{
|
||||
CharSet.None => Encoding.ASCII,
|
||||
CharSet.Ansi => Encoding.ASCII,
|
||||
CharSet.Unicode => Encoding.Unicode,
|
||||
CharSet.Auto => Encoding.ASCII, // UTF-8 on Unix
|
||||
_ => Encoding.ASCII,
|
||||
};
|
||||
// Get the layout information
|
||||
var layoutAttr = MarshalHelpers.GetAttribute<StructLayoutAttribute>(type);
|
||||
LayoutKind layoutKind = MarshalHelpers.DetermineLayoutKind(layoutAttr, type);
|
||||
Encoding encoding = MarshalHelpers.DetermineEncoding(layoutAttr);
|
||||
|
||||
// Cache the current offset
|
||||
long currentOffset = reader.BaseStream.Position;
|
||||
|
||||
// Generate the fields by parent first
|
||||
var fields = MarshalHelpers.GetFields(type);
|
||||
|
||||
// Loop through the fields and set them
|
||||
var fields = type.GetFields();
|
||||
foreach (var fi in fields)
|
||||
{
|
||||
// If we have an explicit layout, move accordingly
|
||||
if (layoutKind == LayoutKind.Explicit)
|
||||
{
|
||||
var fieldOffset = fi.GetCustomAttributes(typeof(FieldOffsetAttribute), true).FirstOrDefault() as FieldOffsetAttribute;
|
||||
var fieldOffset = MarshalHelpers.GetAttribute<FieldOffsetAttribute>(fi);
|
||||
reader.BaseStream.Seek(currentOffset + fieldOffset?.Value ?? 0, SeekOrigin.Begin);
|
||||
}
|
||||
|
||||
@@ -561,9 +575,14 @@ namespace SabreTools.IO.Extensions
|
||||
{
|
||||
if (fi.FieldType.IsAssignableFrom(typeof(string)))
|
||||
{
|
||||
var value = ReadStringType(reader, encoding, instance, fi);
|
||||
var value = ReadStringType(reader, encoding, fi);
|
||||
fi.SetValue(instance, value);
|
||||
}
|
||||
else if (fi.FieldType.IsArray)
|
||||
{
|
||||
var value = ReadArrayType(reader, fields, instance, fi);
|
||||
fi.SetValue(instance, Convert.ChangeType(value, fi.FieldType));
|
||||
}
|
||||
else
|
||||
{
|
||||
var value = reader.ReadType(fi.FieldType);
|
||||
@@ -571,72 +590,127 @@ namespace SabreTools.IO.Extensions
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read an array type field for an object
|
||||
/// </summary>
|
||||
private static Array ReadArrayType(BinaryReader reader, FieldInfo[] fields, object instance, FieldInfo fi)
|
||||
{
|
||||
var marshalAsAttr = MarshalHelpers.GetAttribute<MarshalAsAttribute>(fi);
|
||||
if (marshalAsAttr == null)
|
||||
return new object[0];
|
||||
|
||||
// Get the number of elements expected
|
||||
int elementCount = MarshalHelpers.GetArrayElementCount(marshalAsAttr, fields, instance);
|
||||
if (elementCount < 0)
|
||||
return new object[0];
|
||||
|
||||
// Get the item type for the array
|
||||
Type elementType = fi.FieldType.GetElementType() ?? typeof(object);
|
||||
|
||||
// Loop through and build the array
|
||||
Array arr = Array.CreateInstance(elementType, elementCount);
|
||||
for (int i = 0; i < elementCount; i++)
|
||||
{
|
||||
var value = ReadType(reader, elementType);
|
||||
arr.SetValue(value, i);
|
||||
}
|
||||
|
||||
// Return the built array
|
||||
return arr;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read a string type field for an object
|
||||
/// </summary>
|
||||
private static string? ReadStringType(BinaryReader reader, Encoding encoding, object instance, FieldInfo fi)
|
||||
private static string? ReadStringType(BinaryReader reader, Encoding encoding, FieldInfo? fi)
|
||||
{
|
||||
var marshalAsAttr = fi.GetCustomAttributes(typeof(MarshalAsAttribute), true).FirstOrDefault() as MarshalAsAttribute;
|
||||
var marshalAsAttr = fi?.GetCustomAttributes(typeof(MarshalAsAttribute), true)?.FirstOrDefault() as MarshalAsAttribute;
|
||||
|
||||
switch (marshalAsAttr?.Value)
|
||||
{
|
||||
case UnmanagedType.AnsiBStr:
|
||||
byte ansiLength = reader.ReadByte();
|
||||
byte[] ansiBytes = reader.ReadBytes(ansiLength);
|
||||
return Encoding.ASCII.GetString(ansiBytes);
|
||||
return reader.ReadPrefixedAnsiString();
|
||||
|
||||
case UnmanagedType.BStr:
|
||||
ushort bstrLength = reader.ReadUInt16();
|
||||
byte[] bstrBytes = reader.ReadBytes(bstrLength);
|
||||
return Encoding.ASCII.GetString(bstrBytes);
|
||||
case UnmanagedType.TBStr: // Technically distinct; returns char[] instead
|
||||
return reader.ReadPrefixedUnicodeString();
|
||||
|
||||
// TODO: Handle length from another field
|
||||
case UnmanagedType.ByValTStr:
|
||||
int byvalLength = marshalAsAttr.SizeConst;
|
||||
int byvalLength = marshalAsAttr!.SizeConst;
|
||||
byte[] byvalBytes = reader.ReadBytes(byvalLength);
|
||||
return encoding.GetString(byvalBytes);
|
||||
|
||||
case UnmanagedType.LPStr:
|
||||
case UnmanagedType.LPTStr: // Technically distinct; possibly not null-terminated
|
||||
case null:
|
||||
var lpstrBytes = new List<byte>();
|
||||
while (true)
|
||||
{
|
||||
byte next = reader.ReadByte();
|
||||
if (next == 0x00)
|
||||
break;
|
||||
return reader.ReadNullTerminatedAnsiString();
|
||||
|
||||
lpstrBytes.Add(next);
|
||||
|
||||
if (reader.BaseStream.Position >= reader.BaseStream.Length)
|
||||
break;
|
||||
}
|
||||
|
||||
return Encoding.ASCII.GetString([.. lpstrBytes]);
|
||||
|
||||
case UnmanagedType.LPWStr:
|
||||
var lpwstrBytes = new List<byte>();
|
||||
while (true)
|
||||
{
|
||||
ushort next = reader.ReadUInt16();
|
||||
|
||||
if (next == 0x0000)
|
||||
break;
|
||||
lpwstrBytes.AddRange(BitConverter.GetBytes(next));
|
||||
|
||||
if (reader.BaseStream.Position >= reader.BaseStream.Length)
|
||||
break;
|
||||
}
|
||||
|
||||
return Encoding.ASCII.GetString([.. lpwstrBytes]);
|
||||
|
||||
// No support required yet
|
||||
case UnmanagedType.LPTStr:
|
||||
#if NET472_OR_GREATER || NETCOREAPP
|
||||
case UnmanagedType.LPUTF8Str:
|
||||
return reader.ReadNullTerminatedUTF8String();
|
||||
#endif
|
||||
case UnmanagedType.TBStr:
|
||||
|
||||
case UnmanagedType.LPWStr:
|
||||
return reader.ReadNullTerminatedUnicodeString();
|
||||
|
||||
// No other string types are recognized
|
||||
default:
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read bytes until a 1-byte null terminator is found
|
||||
/// </summary>
|
||||
private static byte[] ReadUntilNull1Byte(BinaryReader reader)
|
||||
{
|
||||
var bytes = new List<byte>();
|
||||
while (reader.BaseStream.Position < reader.BaseStream.Length)
|
||||
{
|
||||
byte next = reader.ReadByte();
|
||||
if (next == 0x00)
|
||||
break;
|
||||
|
||||
bytes.Add(next);
|
||||
}
|
||||
|
||||
return [.. bytes];
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read bytes until a 2-byte null terminator is found
|
||||
/// </summary>
|
||||
private static byte[] ReadUntilNull2Byte(BinaryReader reader)
|
||||
{
|
||||
var bytes = new List<byte>();
|
||||
while (reader.BaseStream.Position < reader.BaseStream.Length)
|
||||
{
|
||||
ushort next = reader.ReadUInt16();
|
||||
if (next == 0x0000)
|
||||
break;
|
||||
|
||||
bytes.AddRange(BitConverter.GetBytes(next));
|
||||
}
|
||||
|
||||
return [.. bytes];
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read bytes until a 4-byte null terminator is found
|
||||
/// </summary>
|
||||
private static byte[] ReadUntilNull4Byte(BinaryReader reader)
|
||||
{
|
||||
var bytes = new List<byte>();
|
||||
while (reader.BaseStream.Position < reader.BaseStream.Length)
|
||||
{
|
||||
uint next = reader.ReadUInt32();
|
||||
if (next == 0x00000000)
|
||||
break;
|
||||
|
||||
bytes.AddRange(BitConverter.GetBytes(next));
|
||||
}
|
||||
|
||||
return [.. bytes];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -3,6 +3,7 @@ using System.IO;
|
||||
#if NET7_0_OR_GREATER
|
||||
using System.Numerics;
|
||||
#endif
|
||||
using System.Reflection;
|
||||
using System.Runtime.InteropServices;
|
||||
using System.Text;
|
||||
|
||||
@@ -15,8 +16,6 @@ namespace SabreTools.IO.Extensions
|
||||
/// TODO: Handle proper negative values for Int24 and Int48
|
||||
public static class BinaryWriterExtensions
|
||||
{
|
||||
#region Write
|
||||
|
||||
/// <inheritdoc cref="BinaryWriter.Write(byte[])"/>
|
||||
/// <remarks>Writes in big-endian format</remarks>
|
||||
public static bool WriteBigEndian(this BinaryWriter writer, byte[] value)
|
||||
@@ -345,11 +344,23 @@ namespace SabreTools.IO.Extensions
|
||||
=> writer.WriteNullTerminatedString(value, Encoding.ASCII);
|
||||
|
||||
/// <summary>
|
||||
/// Write a null-terminated Unicode string to the underlying stream
|
||||
/// Write a null-terminated UTF-8 string to the underlying stream
|
||||
/// </summary>
|
||||
public static bool WriteNullTerminatedUTF8String(this BinaryWriter writer, string? value)
|
||||
=> writer.WriteNullTerminatedString(value, Encoding.UTF8);
|
||||
|
||||
/// <summary>
|
||||
/// Write a null-terminated UTF-16 (Unicode) string to the underlying stream
|
||||
/// </summary>
|
||||
public static bool WriteNullTerminatedUnicodeString(this BinaryWriter writer, string? value)
|
||||
=> writer.WriteNullTerminatedString(value, Encoding.Unicode);
|
||||
|
||||
/// <summary>
|
||||
/// Write a null-terminated UTF-32 string to the underlying stream
|
||||
/// </summary>
|
||||
public static bool WriteNullTerminatedUTF32String(this BinaryWriter writer, string? value)
|
||||
=> writer.WriteNullTerminatedString(value, Encoding.UTF32);
|
||||
|
||||
/// <summary>
|
||||
/// Write a byte-prefixed ASCII string to the underlying stream
|
||||
/// </summary>
|
||||
@@ -413,21 +424,207 @@ namespace SabreTools.IO.Extensions
|
||||
/// <summary>
|
||||
/// Write a <typeparamref name="T"/> to the underlying stream
|
||||
/// </summary>
|
||||
/// TODO: Fix writing as reading was fixed
|
||||
/// <remarks>
|
||||
/// This method is different than standard marshalling in a few notable ways:
|
||||
/// - Strings are written by value, not by reference
|
||||
/// - Complex objects are written by value, not by reference
|
||||
/// - Enumeration values are written by the underlying value type
|
||||
/// - Arrays of the above are handled sequentially as above
|
||||
/// - Inherited fields from parents are serialized BEFORE fields in the child
|
||||
/// </remarks>
|
||||
public static bool WriteType<T>(this BinaryWriter writer, T? value)
|
||||
=> writer.WriteType(value, typeof(T));
|
||||
|
||||
/// <summary>
|
||||
/// Write a <typeparamref name="T"/> to the underlying stream
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This method is different than standard marshalling in a few notable ways:
|
||||
/// - Strings are written by value, not by reference
|
||||
/// - Complex objects are written by value, not by reference
|
||||
/// - Enumeration values are written by the underlying value type
|
||||
/// - Arrays of the above are handled sequentially as above
|
||||
/// - Inherited fields from parents are serialized BEFORE fields in the child
|
||||
/// </remarks>
|
||||
public static bool WriteType(this BinaryWriter writer, object? value, Type type)
|
||||
{
|
||||
// Handle the null case
|
||||
if (value == null)
|
||||
if (type.IsClass || (type.IsValueType && !type.IsEnum && !type.IsPrimitive))
|
||||
return WriteComplexType(writer, value, type);
|
||||
else if (type.IsValueType && type.IsEnum)
|
||||
return WriteNormalType(writer, value, Enum.GetUnderlyingType(type));
|
||||
else
|
||||
return WriteNormalType(writer, value, type);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read a <paramref name="type"/> from the stream
|
||||
/// </summary>
|
||||
private static bool WriteNormalType(BinaryWriter writer, object? value, Type type)
|
||||
{
|
||||
try
|
||||
{
|
||||
// Null values cannot be written
|
||||
if (value == null)
|
||||
return true;
|
||||
|
||||
int typeSize = Marshal.SizeOf(type);
|
||||
if (value.GetType() != type)
|
||||
value = Convert.ChangeType(value, type);
|
||||
|
||||
var buffer = new byte[typeSize];
|
||||
var handle = GCHandle.Alloc(buffer, GCHandleType.Pinned);
|
||||
Marshal.StructureToPtr(value, handle.AddrOfPinnedObject(), false);
|
||||
handle.Free();
|
||||
|
||||
return WriteFromBuffer(writer, buffer);
|
||||
}
|
||||
catch
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read a <paramref name="type"/> from the stream
|
||||
/// </summary>
|
||||
private static bool WriteComplexType(BinaryWriter writer, object? value, Type type)
|
||||
{
|
||||
try
|
||||
{
|
||||
// Null values cannot be written
|
||||
if (value == null)
|
||||
return true;
|
||||
|
||||
// Get the layout information
|
||||
var layoutAttr = MarshalHelpers.GetAttribute<StructLayoutAttribute>(type);
|
||||
LayoutKind layoutKind = MarshalHelpers.DetermineLayoutKind(layoutAttr, type);
|
||||
Encoding encoding = MarshalHelpers.DetermineEncoding(layoutAttr);
|
||||
|
||||
// Cache the current offset
|
||||
long currentOffset = writer.BaseStream.Position;
|
||||
|
||||
// Generate the fields by parent first
|
||||
var fields = MarshalHelpers.GetFields(type);
|
||||
|
||||
// Loop through the fields and set them
|
||||
foreach (var fi in fields)
|
||||
{
|
||||
// If we have an explicit layout, move accordingly
|
||||
if (layoutKind == LayoutKind.Explicit)
|
||||
{
|
||||
var fieldOffset = MarshalHelpers.GetAttribute<FieldOffsetAttribute>(fi);
|
||||
writer.BaseStream.Seek(currentOffset + fieldOffset?.Value ?? 0, SeekOrigin.Begin);
|
||||
}
|
||||
|
||||
if (!GetField(writer, encoding, fields, value, fi))
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
catch
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Write a single field from an object
|
||||
/// </summary>
|
||||
private static bool GetField(BinaryWriter writer, Encoding encoding, FieldInfo[] fields, object instance, FieldInfo fi)
|
||||
{
|
||||
if (fi.FieldType.IsAssignableFrom(typeof(string)))
|
||||
{
|
||||
return WriteStringType(writer, encoding, instance, fi);
|
||||
}
|
||||
else if (fi.FieldType.IsArray)
|
||||
{
|
||||
return WriteArrayType(writer, fields, instance, fi);
|
||||
}
|
||||
else
|
||||
{
|
||||
var value = fi.GetValue(instance);
|
||||
return writer.WriteType(value, fi.FieldType);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Write an array type field from an object
|
||||
/// </summary>
|
||||
private static bool WriteArrayType(BinaryWriter writer, FieldInfo[] fields, object instance, FieldInfo fi)
|
||||
{
|
||||
var marshalAsAttr = MarshalHelpers.GetAttribute<MarshalAsAttribute>(fi);
|
||||
if (marshalAsAttr == null)
|
||||
return false;
|
||||
|
||||
int typeSize = Marshal.SizeOf(typeof(T));
|
||||
// Get the array
|
||||
Array? arr = fi.GetValue(instance) as Array;
|
||||
if (arr == null)
|
||||
return false;
|
||||
|
||||
var buffer = new byte[typeSize];
|
||||
var handle = GCHandle.Alloc(buffer, GCHandleType.Pinned);
|
||||
Marshal.StructureToPtr(value, handle.AddrOfPinnedObject(), false);
|
||||
handle.Free();
|
||||
// Get the number of elements expected
|
||||
int elementCount = MarshalHelpers.GetArrayElementCount(marshalAsAttr, fields, instance);
|
||||
if (elementCount < 0)
|
||||
return false;
|
||||
|
||||
return WriteFromBuffer(writer, buffer);
|
||||
// Get the item type for the array
|
||||
Type elementType = fi.FieldType.GetElementType() ?? typeof(object);
|
||||
|
||||
// Loop through and write the array
|
||||
for (int i = 0; i < elementCount; i++)
|
||||
{
|
||||
var value = arr.GetValue(i);
|
||||
if (!WriteType(writer, value, elementType))
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Write a string type field from an object
|
||||
/// </summary>
|
||||
private static bool WriteStringType(BinaryWriter writer, Encoding encoding, object instance, FieldInfo fi)
|
||||
{
|
||||
var marshalAsAttr = MarshalHelpers.GetAttribute<MarshalAsAttribute>(fi);
|
||||
string? fieldValue = fi.GetValue(instance) as string;
|
||||
if (fieldValue == null)
|
||||
return true;
|
||||
|
||||
switch (marshalAsAttr?.Value)
|
||||
{
|
||||
case UnmanagedType.AnsiBStr:
|
||||
return writer.WritePrefixedAnsiString(fieldValue);
|
||||
|
||||
case UnmanagedType.BStr:
|
||||
case UnmanagedType.TBStr: // Technically distinct; returns char[] instead
|
||||
return writer.WritePrefixedUnicodeString(fieldValue);
|
||||
|
||||
case UnmanagedType.ByValTStr:
|
||||
int byvalLength = marshalAsAttr!.SizeConst;
|
||||
byte[] byvalBytes = encoding.GetBytes(fieldValue);
|
||||
byte[] byvalSizedBytes = new byte[byvalLength];
|
||||
Array.Copy(byvalBytes, byvalSizedBytes, Math.Min(byvalBytes.Length, byvalSizedBytes.Length));
|
||||
writer.Write(byvalSizedBytes);
|
||||
return true;
|
||||
|
||||
case UnmanagedType.LPStr:
|
||||
case UnmanagedType.LPTStr: // Technically distinct; possibly not null-terminated
|
||||
case null:
|
||||
return writer.WriteNullTerminatedAnsiString(fieldValue);
|
||||
|
||||
#if NET472_OR_GREATER || NETCOREAPP
|
||||
case UnmanagedType.LPUTF8Str:
|
||||
return writer.WriteNullTerminatedUTF8String(fieldValue);
|
||||
#endif
|
||||
|
||||
case UnmanagedType.LPWStr:
|
||||
return writer.WriteNullTerminatedUnicodeString(fieldValue);
|
||||
|
||||
// No other string types are recognized
|
||||
default:
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -447,7 +644,5 @@ namespace SabreTools.IO.Extensions
|
||||
writer.Write(value, 0, value.Length);
|
||||
return true;
|
||||
}
|
||||
|
||||
#endregion
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,5 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
#if NET7_0_OR_GREATER
|
||||
using System.Numerics;
|
||||
#endif
|
||||
@@ -455,8 +454,12 @@ namespace SabreTools.IO.Extensions
|
||||
// Short-circuit to explicit implementations
|
||||
if (encoding.Equals(Encoding.ASCII))
|
||||
return content.ReadNullTerminatedAnsiString(ref offset);
|
||||
else if (encoding.Equals(Encoding.UTF8))
|
||||
return content.ReadNullTerminatedUTF8String(ref offset);
|
||||
else if (encoding.Equals(Encoding.Unicode))
|
||||
return content.ReadNullTerminatedUnicodeString(ref offset);
|
||||
else if (encoding.Equals(Encoding.UTF32))
|
||||
return content.ReadNullTerminatedUTF32String(ref offset);
|
||||
|
||||
if (offset >= content.Length)
|
||||
return null;
|
||||
@@ -481,36 +484,44 @@ namespace SabreTools.IO.Extensions
|
||||
if (offset >= content.Length)
|
||||
return null;
|
||||
|
||||
List<byte> buffer = [];
|
||||
while (offset < content.Length)
|
||||
{
|
||||
byte ch = content.ReadByteValue(ref offset);
|
||||
buffer.Add(ch);
|
||||
if (ch == '\0')
|
||||
break;
|
||||
}
|
||||
|
||||
return Encoding.ASCII.GetString([.. buffer]);
|
||||
byte[] buffer = ReadUntilNull1Byte(content, ref offset);
|
||||
return Encoding.ASCII.GetString(buffer);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read a null-terminated Unicode string from the byte array
|
||||
/// Read a null-terminated UTF-8 string from the byte array
|
||||
/// </summary>
|
||||
public static string? ReadNullTerminatedUTF8String(this byte[] content, ref int offset)
|
||||
{
|
||||
if (offset >= content.Length)
|
||||
return null;
|
||||
|
||||
byte[] buffer = ReadUntilNull1Byte(content, ref offset);
|
||||
return Encoding.UTF8.GetString(buffer);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read a null-terminated UTF-16 (Unicode) string from the byte array
|
||||
/// </summary>
|
||||
public static string? ReadNullTerminatedUnicodeString(this byte[] content, ref int offset)
|
||||
{
|
||||
if (offset >= content.Length)
|
||||
return null;
|
||||
|
||||
List<byte> buffer = [];
|
||||
while (offset < content.Length)
|
||||
{
|
||||
byte[] ch = content.ReadBytes(ref offset, 2);
|
||||
buffer.AddRange(ch);
|
||||
if (ch[0] == '\0' && ch[1] == '\0')
|
||||
break;
|
||||
}
|
||||
byte[] buffer = ReadUntilNull2Byte(content, ref offset);
|
||||
return Encoding.Unicode.GetString(buffer);
|
||||
}
|
||||
|
||||
return Encoding.Unicode.GetString([.. buffer]);
|
||||
/// <summary>
|
||||
/// Read a null-terminated UTF-32 string from the byte array
|
||||
/// </summary>
|
||||
public static string? ReadNullTerminatedUTF32String(this byte[] content, ref int offset)
|
||||
{
|
||||
if (offset >= content.Length)
|
||||
return null;
|
||||
|
||||
byte[] buffer = ReadUntilNull4Byte(content, ref offset);
|
||||
return Encoding.Unicode.GetString(buffer);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -538,10 +549,10 @@ namespace SabreTools.IO.Extensions
|
||||
return null;
|
||||
|
||||
ushort size = content.ReadUInt16(ref offset);
|
||||
if (offset + size >= content.Length)
|
||||
if (offset + (size * 2) >= content.Length)
|
||||
return null;
|
||||
|
||||
byte[] buffer = content.ReadBytes(ref offset, size);
|
||||
byte[] buffer = content.ReadBytes(ref offset, size * 2);
|
||||
return Encoding.Unicode.GetString(buffer);
|
||||
}
|
||||
|
||||
@@ -587,16 +598,34 @@ namespace SabreTools.IO.Extensions
|
||||
/// <summary>
|
||||
/// Read a <typeparamref name="T"/> from the stream
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This method is different than standard marshalling in a few notable ways:
|
||||
/// - Strings are read by value, not by reference
|
||||
/// - Complex objects are read by value, not by reference
|
||||
/// - Enumeration values are read by the underlying value type
|
||||
/// - Arrays of the above are handled sequentially as above
|
||||
/// - Inherited fields from parents are deserialized BEFORE fields in the child
|
||||
/// </remarks>
|
||||
public static T? ReadType<T>(this byte[] content, ref int offset)
|
||||
=> (T?)content.ReadType(ref offset, typeof(T));
|
||||
|
||||
/// <summary>
|
||||
/// Read a <paramref name="type"/> from the stream
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This method is different than standard marshalling in a few notable ways:
|
||||
/// - Strings are read by value, not by reference
|
||||
/// - Complex objects are read by value, not by reference
|
||||
/// - Enumeration values are read by the underlying value type
|
||||
/// - Arrays of the above are handled sequentially as above
|
||||
/// - Inherited fields from parents are deserialized BEFORE fields in the child
|
||||
/// </remarks>
|
||||
public static object? ReadType(this byte[] content, ref int offset, Type type)
|
||||
{
|
||||
if (type.IsClass || (type.IsValueType && !type.IsPrimitive))
|
||||
if (type.IsClass || (type.IsValueType && !type.IsEnum && !type.IsPrimitive))
|
||||
return ReadComplexType(content, ref offset, type);
|
||||
else if (type.IsValueType && type.IsEnum)
|
||||
return ReadNormalType(content, ref offset, Enum.GetUnderlyingType(type));
|
||||
else
|
||||
return ReadNormalType(content, ref offset, type);
|
||||
}
|
||||
@@ -626,49 +655,33 @@ namespace SabreTools.IO.Extensions
|
||||
/// <summary>
|
||||
/// Read a <paramref name="type"/> from the stream
|
||||
/// </summary>
|
||||
private static object? ReadComplexType(this byte[] content, ref int offset, Type type)
|
||||
private static object? ReadComplexType(byte[] content, ref int offset, Type type)
|
||||
{
|
||||
try
|
||||
{
|
||||
// Try to create an instance of the type
|
||||
var instance = Activator.CreateInstance(type);
|
||||
if (instance == null)
|
||||
return null;
|
||||
|
||||
// Get the layout attribute
|
||||
var layoutAttr = type.GetCustomAttributes(typeof(StructLayoutAttribute), true).FirstOrDefault() as StructLayoutAttribute;
|
||||
|
||||
// Get the layout type
|
||||
LayoutKind layoutKind = LayoutKind.Auto;
|
||||
if (layoutAttr != null)
|
||||
layoutKind = layoutAttr.Value;
|
||||
else if (type.IsAutoLayout)
|
||||
layoutKind = LayoutKind.Auto;
|
||||
else if (type.IsExplicitLayout)
|
||||
layoutKind = LayoutKind.Explicit;
|
||||
else if (type.IsLayoutSequential)
|
||||
layoutKind = LayoutKind.Sequential;
|
||||
|
||||
// Get the encoding to use
|
||||
Encoding encoding = layoutAttr?.CharSet switch
|
||||
{
|
||||
CharSet.None => Encoding.ASCII,
|
||||
CharSet.Ansi => Encoding.ASCII,
|
||||
CharSet.Unicode => Encoding.Unicode,
|
||||
CharSet.Auto => Encoding.ASCII, // UTF-8 on Unix
|
||||
_ => Encoding.ASCII,
|
||||
};
|
||||
// Get the layout information
|
||||
var layoutAttr = MarshalHelpers.GetAttribute<StructLayoutAttribute>(type);
|
||||
LayoutKind layoutKind = MarshalHelpers.DetermineLayoutKind(layoutAttr, type);
|
||||
Encoding encoding = MarshalHelpers.DetermineEncoding(layoutAttr);
|
||||
|
||||
// Cache the current offset
|
||||
int currentOffset = offset;
|
||||
|
||||
// Generate the fields by parent first
|
||||
var fields = MarshalHelpers.GetFields(type);
|
||||
|
||||
// Loop through the fields and set them
|
||||
var fields = type.GetFields();
|
||||
foreach (var fi in fields)
|
||||
{
|
||||
// If we have an explicit layout, move accordingly
|
||||
if (layoutKind == LayoutKind.Explicit)
|
||||
{
|
||||
var fieldOffset = fi.GetCustomAttributes(typeof(FieldOffsetAttribute), true).FirstOrDefault() as FieldOffsetAttribute;
|
||||
var fieldOffset = MarshalHelpers.GetAttribute<FieldOffsetAttribute>(fi);
|
||||
offset = currentOffset + fieldOffset?.Value ?? 0;
|
||||
}
|
||||
|
||||
@@ -693,6 +706,11 @@ namespace SabreTools.IO.Extensions
|
||||
var value = ReadStringType(content, ref offset, encoding, instance, fi);
|
||||
fi.SetValue(instance, value);
|
||||
}
|
||||
else if (fi.FieldType.IsArray)
|
||||
{
|
||||
var value = ReadArrayType(content, ref offset, fields, instance, fi);
|
||||
fi.SetValue(instance, Convert.ChangeType(value, fi.FieldType));
|
||||
}
|
||||
else
|
||||
{
|
||||
var value = content.ReadType(ref offset, fi.FieldType);
|
||||
@@ -700,74 +718,129 @@ namespace SabreTools.IO.Extensions
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read an array type field for an object
|
||||
/// </summary>
|
||||
private static Array ReadArrayType(byte[] content, ref int offset, FieldInfo[] fields, object instance, FieldInfo fi)
|
||||
{
|
||||
var marshalAsAttr = MarshalHelpers.GetAttribute<MarshalAsAttribute>(fi);
|
||||
if (marshalAsAttr == null)
|
||||
return new object[0];
|
||||
|
||||
// Get the number of elements expected
|
||||
int elementCount = MarshalHelpers.GetArrayElementCount(marshalAsAttr, fields, instance);
|
||||
if (elementCount < 0)
|
||||
return new object[0];
|
||||
|
||||
// Get the item type for the array
|
||||
Type elementType = fi.FieldType.GetElementType() ?? typeof(object);
|
||||
|
||||
// Loop through and build the array
|
||||
Array arr = Array.CreateInstance(elementType, elementCount);
|
||||
for (int i = 0; i < elementCount; i++)
|
||||
{
|
||||
var value = ReadType(content, ref offset, elementType);
|
||||
arr.SetValue(value, i);
|
||||
}
|
||||
|
||||
// Return the built array
|
||||
return arr;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read a string type field for an object
|
||||
/// </summary>
|
||||
private static string? ReadStringType(byte[] content, ref int offset, Encoding encoding, object instance, FieldInfo fi)
|
||||
{
|
||||
var marshalAsAttr = fi.GetCustomAttributes(typeof(MarshalAsAttribute), true).FirstOrDefault() as MarshalAsAttribute;
|
||||
var marshalAsAttr = MarshalHelpers.GetAttribute<MarshalAsAttribute>(fi);
|
||||
|
||||
switch (marshalAsAttr?.Value)
|
||||
{
|
||||
case UnmanagedType.AnsiBStr:
|
||||
byte ansiLength = content.ReadByteValue(ref offset);
|
||||
byte[] ansiBytes = content.ReadBytes(ref offset, ansiLength);
|
||||
return Encoding.ASCII.GetString(ansiBytes);
|
||||
return content.ReadPrefixedAnsiString(ref offset);
|
||||
|
||||
case UnmanagedType.BStr:
|
||||
ushort bstrLength = content.ReadUInt16(ref offset);
|
||||
byte[] bstrBytes = content.ReadBytes(ref offset, bstrLength);
|
||||
return Encoding.ASCII.GetString(bstrBytes);
|
||||
case UnmanagedType.TBStr: // Technically distinct; returns char[] instead
|
||||
return content.ReadPrefixedUnicodeString(ref offset);
|
||||
|
||||
// TODO: Handle length from another field
|
||||
case UnmanagedType.ByValTStr:
|
||||
int byvalLength = marshalAsAttr.SizeConst;
|
||||
int byvalLength = marshalAsAttr!.SizeConst;
|
||||
byte[] byvalBytes = content.ReadBytes(ref offset, byvalLength);
|
||||
return encoding.GetString(byvalBytes);
|
||||
|
||||
case UnmanagedType.LPStr:
|
||||
case UnmanagedType.LPTStr: // Technically distinct; possibly not null-terminated
|
||||
case null:
|
||||
var lpstrBytes = new List<byte>();
|
||||
while (true)
|
||||
{
|
||||
byte next = content.ReadByteValue(ref offset);
|
||||
if (next == 0x00)
|
||||
break;
|
||||
return content.ReadNullTerminatedAnsiString(ref offset);
|
||||
|
||||
lpstrBytes.Add(next);
|
||||
|
||||
if (offset >= content.Length)
|
||||
break;
|
||||
}
|
||||
|
||||
return Encoding.ASCII.GetString([.. lpstrBytes]);
|
||||
|
||||
case UnmanagedType.LPWStr:
|
||||
var lpwstrBytes = new List<byte>();
|
||||
while (true)
|
||||
{
|
||||
ushort next = content.ReadUInt16(ref offset);
|
||||
|
||||
if (next == 0x0000)
|
||||
break;
|
||||
lpwstrBytes.AddRange(BitConverter.GetBytes(next));
|
||||
|
||||
if (offset >= content.Length)
|
||||
break;
|
||||
}
|
||||
|
||||
return Encoding.ASCII.GetString([.. lpwstrBytes]);
|
||||
|
||||
// No support required yet
|
||||
case UnmanagedType.LPTStr:
|
||||
#if NET472_OR_GREATER || NETCOREAPP
|
||||
case UnmanagedType.LPUTF8Str:
|
||||
return content.ReadNullTerminatedUTF8String(ref offset);
|
||||
#endif
|
||||
case UnmanagedType.TBStr:
|
||||
|
||||
case UnmanagedType.LPWStr:
|
||||
return content.ReadNullTerminatedUnicodeString(ref offset);
|
||||
|
||||
// No other string types are recognized
|
||||
default:
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read bytes until a 1-byte null terminator is found
|
||||
/// </summary>
|
||||
private static byte[] ReadUntilNull1Byte(byte[] content, ref int offset)
|
||||
{
|
||||
var bytes = new List<byte>();
|
||||
while (offset < content.Length)
|
||||
{
|
||||
byte next = content.ReadByte(ref offset);
|
||||
if (next == 0x00)
|
||||
break;
|
||||
|
||||
bytes.Add(next);
|
||||
}
|
||||
|
||||
return [.. bytes];
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read bytes until a 2-byte null terminator is found
|
||||
/// </summary>
|
||||
private static byte[] ReadUntilNull2Byte(byte[] content, ref int offset)
|
||||
{
|
||||
var bytes = new List<byte>();
|
||||
while (offset < content.Length)
|
||||
{
|
||||
ushort next = content.ReadUInt16(ref offset);
|
||||
if (next == 0x0000)
|
||||
break;
|
||||
|
||||
bytes.AddRange(BitConverter.GetBytes(next));
|
||||
}
|
||||
|
||||
return [.. bytes];
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read bytes until a 4-byte null terminator is found
|
||||
/// </summary>
|
||||
private static byte[] ReadUntilNull4Byte(byte[] content, ref int offset)
|
||||
{
|
||||
var bytes = new List<byte>();
|
||||
while (offset < content.Length)
|
||||
{
|
||||
uint next = content.ReadUInt32(ref offset);
|
||||
if (next == 0x00000000)
|
||||
break;
|
||||
|
||||
bytes.AddRange(BitConverter.GetBytes(next));
|
||||
}
|
||||
|
||||
return [.. bytes];
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read a number of bytes from the byte array to a buffer
|
||||
/// </summary>
|
||||
|
||||
@@ -2,6 +2,7 @@ using System;
|
||||
#if NET7_0_OR_GREATER
|
||||
using System.Numerics;
|
||||
#endif
|
||||
using System.Reflection;
|
||||
using System.Runtime.InteropServices;
|
||||
using System.Text;
|
||||
|
||||
@@ -494,11 +495,23 @@ namespace SabreTools.IO.Extensions
|
||||
=> content.WriteNullTerminatedString(ref offset, value, Encoding.ASCII);
|
||||
|
||||
/// <summary>
|
||||
/// Write a null-terminated Unicode string to the byte array
|
||||
/// Write a null-terminated UTF-8 string to the byte array
|
||||
/// </summary>
|
||||
public static bool WriteNullTerminatedUTF8String(this byte[] content, ref int offset, string? value)
|
||||
=> content.WriteNullTerminatedString(ref offset, value, Encoding.UTF8);
|
||||
|
||||
/// <summary>
|
||||
/// Write a null-terminated UTF-16 (Unicode) string to the byte array
|
||||
/// </summary>
|
||||
public static bool WriteNullTerminatedUnicodeString(this byte[] content, ref int offset, string? value)
|
||||
=> content.WriteNullTerminatedString(ref offset, value, Encoding.Unicode);
|
||||
|
||||
/// <summary>
|
||||
/// Write a null-terminated UTF-32 string to the byte array
|
||||
/// </summary>
|
||||
public static bool WriteNullTerminatedUTF32String(this byte[] content, ref int offset, string? value)
|
||||
=> content.WriteNullTerminatedString(ref offset, value, Encoding.UTF32);
|
||||
|
||||
/// <summary>
|
||||
/// Write a byte-prefixed ASCII string to the byte array
|
||||
/// </summary>
|
||||
@@ -564,21 +577,206 @@ namespace SabreTools.IO.Extensions
|
||||
/// <summary>
|
||||
/// Write a <typeparamref name="T"/> to the byte array
|
||||
/// </summary>
|
||||
/// TODO: Fix writing as reading was fixed
|
||||
/// <remarks>
|
||||
/// This method is different than standard marshalling in a few notable ways:
|
||||
/// - Strings are written by value, not by reference
|
||||
/// - Complex objects are written by value, not by reference
|
||||
/// - Enumeration values are written by the underlying value type
|
||||
/// - Arrays of the above are handled sequentially as above
|
||||
/// - Inherited fields from parents are serialized BEFORE fields in the child
|
||||
/// </remarks>
|
||||
public static bool WriteType<T>(this byte[] content, ref int offset, T? value)
|
||||
=> content.WriteType(ref offset, value, typeof(T));
|
||||
|
||||
/// <summary>
|
||||
/// Write a <typeparamref name="T"/> to the byte array
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This method is different than standard marshalling in a few notable ways:
|
||||
/// - Strings are written by value, not by reference
|
||||
/// - Complex objects are written by value, not by reference
|
||||
/// - Enumeration values are written by the underlying value type
|
||||
/// - Arrays of the above are handled sequentially as above
|
||||
/// - Inherited fields from parents are serialized BEFORE fields in the child
|
||||
/// </remarks>
|
||||
public static bool WriteType(this byte[] content, ref int offset, object? value, Type type)
|
||||
{
|
||||
// Handle the null case
|
||||
if (value == null)
|
||||
if (type.IsClass || (type.IsValueType && !type.IsEnum && !type.IsPrimitive))
|
||||
return WriteComplexType(content, ref offset, value, type);
|
||||
else if (type.IsValueType && type.IsEnum)
|
||||
return WriteNormalType(content, ref offset, value, Enum.GetUnderlyingType(type));
|
||||
else
|
||||
return WriteNormalType(content, ref offset, value, type);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read a <paramref name="type"/> from the stream
|
||||
/// </summary>
|
||||
private static bool WriteNormalType(byte[] content, ref int offset, object? value, Type type)
|
||||
{
|
||||
try
|
||||
{
|
||||
// Null values cannot be written
|
||||
if (value == null)
|
||||
return true;
|
||||
|
||||
int typeSize = Marshal.SizeOf(type);
|
||||
if (value.GetType() != type)
|
||||
value = Convert.ChangeType(value, type);
|
||||
|
||||
var buffer = new byte[typeSize];
|
||||
var handle = GCHandle.Alloc(buffer, GCHandleType.Pinned);
|
||||
Marshal.StructureToPtr(value, handle.AddrOfPinnedObject(), false);
|
||||
handle.Free();
|
||||
|
||||
return WriteFromBuffer(content, ref offset, buffer);
|
||||
}
|
||||
catch
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read a <paramref name="type"/> from the stream
|
||||
/// </summary>
|
||||
private static bool WriteComplexType(byte[] content, ref int offset, object? value, Type type)
|
||||
{
|
||||
try
|
||||
{
|
||||
// Null values cannot be written
|
||||
if (value == null)
|
||||
return true;
|
||||
|
||||
// Get the layout information
|
||||
var layoutAttr = MarshalHelpers.GetAttribute<StructLayoutAttribute>(type);
|
||||
LayoutKind layoutKind = MarshalHelpers.DetermineLayoutKind(layoutAttr, type);
|
||||
Encoding encoding = MarshalHelpers.DetermineEncoding(layoutAttr);
|
||||
|
||||
// Cache the current offset
|
||||
int currentOffset = offset;
|
||||
|
||||
// Generate the fields by parent first
|
||||
var fields = MarshalHelpers.GetFields(type);
|
||||
|
||||
// Loop through the fields and set them
|
||||
foreach (var fi in fields)
|
||||
{
|
||||
// If we have an explicit layout, move accordingly
|
||||
if (layoutKind == LayoutKind.Explicit)
|
||||
{
|
||||
var fieldOffset = MarshalHelpers.GetAttribute<FieldOffsetAttribute>(fi);
|
||||
offset = currentOffset + fieldOffset?.Value ?? 0;
|
||||
}
|
||||
|
||||
if (!GetField(content, ref offset, encoding, fields, value, fi))
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
catch
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Write a single field from an object
|
||||
/// </summary>
|
||||
private static bool GetField(byte[] content, ref int offset, Encoding encoding, FieldInfo[] fields, object instance, FieldInfo fi)
|
||||
{
|
||||
if (fi.FieldType.IsAssignableFrom(typeof(string)))
|
||||
{
|
||||
return WriteStringType(content, ref offset, encoding, instance, fi);
|
||||
}
|
||||
else if (fi.FieldType.IsArray)
|
||||
{
|
||||
return WriteArrayType(content, ref offset, fields, instance, fi);
|
||||
}
|
||||
else
|
||||
{
|
||||
var value = fi.GetValue(instance);
|
||||
return content.WriteType(ref offset, value, fi.FieldType);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Write an array type field from an object
|
||||
/// </summary>
|
||||
private static bool WriteArrayType(byte[] content, ref int offset, FieldInfo[] fields, object instance, FieldInfo fi)
|
||||
{
|
||||
var marshalAsAttr = MarshalHelpers.GetAttribute<MarshalAsAttribute>(fi);
|
||||
if (marshalAsAttr == null)
|
||||
return false;
|
||||
|
||||
int typeSize = Marshal.SizeOf(typeof(T));
|
||||
// Get the array
|
||||
Array? arr = fi.GetValue(instance) as Array;
|
||||
if (arr == null)
|
||||
return false;
|
||||
|
||||
var buffer = new byte[typeSize];
|
||||
var handle = GCHandle.Alloc(buffer, GCHandleType.Pinned);
|
||||
Marshal.StructureToPtr(value, handle.AddrOfPinnedObject(), false);
|
||||
handle.Free();
|
||||
// Get the number of elements expected
|
||||
int elementCount = MarshalHelpers.GetArrayElementCount(marshalAsAttr, fields, instance);
|
||||
if (elementCount < 0)
|
||||
return false;
|
||||
|
||||
return WriteFromBuffer(content, ref offset, buffer);
|
||||
// Get the item type for the array
|
||||
Type elementType = fi.FieldType.GetElementType() ?? typeof(object);
|
||||
|
||||
// Loop through and write the array
|
||||
for (int i = 0; i < elementCount; i++)
|
||||
{
|
||||
var value = arr.GetValue(i);
|
||||
if (!WriteType(content, ref offset, value, elementType))
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Write a string type field from an object
|
||||
/// </summary>
|
||||
private static bool WriteStringType(byte[] content, ref int offset, Encoding encoding, object instance, FieldInfo fi)
|
||||
{
|
||||
var marshalAsAttr = MarshalHelpers.GetAttribute<MarshalAsAttribute>(fi);
|
||||
string? fieldValue = fi.GetValue(instance) as string;
|
||||
if (fieldValue == null)
|
||||
return true;
|
||||
|
||||
switch (marshalAsAttr?.Value)
|
||||
{
|
||||
case UnmanagedType.AnsiBStr:
|
||||
return content.WritePrefixedAnsiString(ref offset, fieldValue);
|
||||
|
||||
case UnmanagedType.BStr:
|
||||
case UnmanagedType.TBStr: // Technically distinct; returns char[] instead
|
||||
return content.WritePrefixedUnicodeString(ref offset, fieldValue);
|
||||
|
||||
case UnmanagedType.ByValTStr:
|
||||
int byvalLength = marshalAsAttr!.SizeConst;
|
||||
byte[] byvalBytes = encoding.GetBytes(fieldValue);
|
||||
byte[] byvalSizedBytes = new byte[byvalLength];
|
||||
Array.Copy(byvalBytes, byvalSizedBytes, Math.Min(byvalBytes.Length, byvalSizedBytes.Length));
|
||||
return content.Write(ref offset, byvalSizedBytes);
|
||||
|
||||
case UnmanagedType.LPStr:
|
||||
case UnmanagedType.LPTStr: // Technically distinct; possibly not null-terminated
|
||||
case null:
|
||||
return content.WriteNullTerminatedAnsiString(ref offset, fieldValue);
|
||||
|
||||
#if NET472_OR_GREATER || NETCOREAPP
|
||||
case UnmanagedType.LPUTF8Str:
|
||||
return content.WriteNullTerminatedUTF8String(ref offset, fieldValue);
|
||||
#endif
|
||||
|
||||
case UnmanagedType.LPWStr:
|
||||
return content.WriteNullTerminatedUnicodeString(ref offset, fieldValue);
|
||||
|
||||
// No other string types are recognized
|
||||
default:
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
|
||||
namespace SabreTools.IO.Extensions
|
||||
@@ -10,7 +11,15 @@ namespace SabreTools.IO.Extensions
|
||||
public static IEnumerable<T> SafeEnumerate<T>(this IEnumerable<T> enumerable)
|
||||
{
|
||||
// Get the enumerator for the enumerable
|
||||
var enumerator = enumerable.GetEnumerator();
|
||||
IEnumerator<T> enumerator;
|
||||
try
|
||||
{
|
||||
enumerator = enumerable.GetEnumerator();
|
||||
}
|
||||
catch
|
||||
{
|
||||
yield break;
|
||||
}
|
||||
|
||||
// Iterate through and absorb any errors
|
||||
while (true)
|
||||
@@ -21,6 +30,16 @@ namespace SabreTools.IO.Extensions
|
||||
{
|
||||
moved = enumerator.MoveNext();
|
||||
}
|
||||
catch (InvalidOperationException)
|
||||
{
|
||||
// Specific case for collections that were modified
|
||||
yield break;
|
||||
}
|
||||
catch (System.IO.IOException ex) when (ex.Message.Contains("The file or directory is corrupted and unreadable."))
|
||||
{
|
||||
// Specific case we can't circumvent
|
||||
yield break;
|
||||
}
|
||||
catch
|
||||
{
|
||||
continue;
|
||||
|
||||
@@ -1,5 +1,11 @@
|
||||
using System.Collections.Generic;
|
||||
#if NETCOREAPP3_1_OR_GREATER
|
||||
using System;
|
||||
#endif
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
#if NETCOREAPP3_1_OR_GREATER
|
||||
using System.IO.Enumeration;
|
||||
#endif
|
||||
using System.Linq;
|
||||
using System.Text;
|
||||
|
||||
@@ -309,68 +315,296 @@ namespace SabreTools.IO.Extensions
|
||||
/// <remarks>Calls <see cref="SafeGetFileSystemEntries(string, string, SearchOption)"/> implementation</remarks>
|
||||
public static IEnumerable<string> SafeEnumerateFileSystemEntries(this string path, string searchPattern, SearchOption searchOption)
|
||||
=> path.SafeGetFileSystemEntries(searchPattern, searchOption);
|
||||
#else
|
||||
#elif NET40_OR_GREATER
|
||||
/// <inheritdoc cref="Directory.EnumerateDirectories(string)"/>
|
||||
public static IEnumerable<string> SafeEnumerateDirectories(this string path)
|
||||
{
|
||||
var enumerable = Directory.EnumerateDirectories(path);
|
||||
return enumerable.SafeEnumerate();
|
||||
try
|
||||
{
|
||||
var enumerable = Directory.EnumerateDirectories(path);
|
||||
return enumerable.SafeEnumerate();
|
||||
}
|
||||
catch
|
||||
{
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc cref="Directory.EnumerateDirectories(string, string)"/>
|
||||
public static IEnumerable<string> SafeEnumerateDirectories(this string path, string searchPattern)
|
||||
{
|
||||
var enumerable = Directory.EnumerateDirectories(path, searchPattern);
|
||||
return enumerable.SafeEnumerate();
|
||||
try
|
||||
{
|
||||
var enumerable = Directory.EnumerateDirectories(path, searchPattern);
|
||||
return enumerable.SafeEnumerate();
|
||||
}
|
||||
catch
|
||||
{
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc cref="Directory.EnumerateDirectories(string, string, SearchOption)"/>
|
||||
public static IEnumerable<string> SafeEnumerateDirectories(this string path, string searchPattern, SearchOption searchOption)
|
||||
{
|
||||
var enumerable = Directory.EnumerateDirectories(path, searchPattern, searchOption);
|
||||
return enumerable.SafeEnumerate();
|
||||
try
|
||||
{
|
||||
var enumerable = Directory.EnumerateDirectories(path, searchPattern, searchOption);
|
||||
return enumerable.SafeEnumerate();
|
||||
}
|
||||
catch
|
||||
{
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc cref="Directory.EnumerateFiles(string)"/>
|
||||
public static IEnumerable<string> SafeEnumerateFiles(this string path)
|
||||
{
|
||||
var enumerable = Directory.EnumerateFiles(path);
|
||||
return enumerable.SafeEnumerate();
|
||||
try
|
||||
{
|
||||
var enumerable = Directory.EnumerateFiles(path);
|
||||
return enumerable.SafeEnumerate();
|
||||
}
|
||||
catch
|
||||
{
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc cref="Directory.EnumerateFiles(string, string)"/>
|
||||
public static IEnumerable<string> SafeEnumerateFiles(this string path, string searchPattern)
|
||||
{
|
||||
var enumerable = Directory.EnumerateFiles(path, searchPattern);
|
||||
return enumerable.SafeEnumerate();
|
||||
try
|
||||
{
|
||||
var enumerable = Directory.EnumerateFiles(path, searchPattern);
|
||||
return enumerable.SafeEnumerate();
|
||||
}
|
||||
catch
|
||||
{
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc cref="Directory.EnumerateFiles(string, string, SearchOption)"/>
|
||||
public static IEnumerable<string> SafeEnumerateFiles(this string path, string searchPattern, SearchOption searchOption)
|
||||
{
|
||||
var enumerable = Directory.EnumerateFiles(path, searchPattern, searchOption);
|
||||
return enumerable.SafeEnumerate();
|
||||
try
|
||||
{
|
||||
var enumerable = Directory.EnumerateFiles(path, searchPattern, searchOption);
|
||||
return enumerable.SafeEnumerate();
|
||||
}
|
||||
catch
|
||||
{
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc cref="Directory.EnumerateFileSystemEntries(string)"/>
|
||||
public static IEnumerable<string> SafeEnumerateFileSystemEntries(this string path)
|
||||
{
|
||||
var enumerable = Directory.EnumerateFileSystemEntries(path);
|
||||
return enumerable.SafeEnumerate();
|
||||
try
|
||||
{
|
||||
var enumerable = Directory.EnumerateFileSystemEntries(path);
|
||||
return enumerable.SafeEnumerate();
|
||||
}
|
||||
catch
|
||||
{
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc cref="Directory.EnumerateFileSystemEntries(string, string)"/>
|
||||
public static IEnumerable<string> SafeEnumerateFileSystemEntries(this string path, string searchPattern)
|
||||
{
|
||||
var enumerable = Directory.EnumerateFileSystemEntries(path, searchPattern);
|
||||
return enumerable.SafeEnumerate();
|
||||
try
|
||||
{
|
||||
var enumerable = Directory.EnumerateFileSystemEntries(path, searchPattern);
|
||||
return enumerable.SafeEnumerate();
|
||||
}
|
||||
catch
|
||||
{
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc cref="Directory.EnumerateFileSystemEntries(string, string, SearchOption)"/>
|
||||
public static IEnumerable<string> SafeEnumerateFileSystemEntries(this string path, string searchPattern, SearchOption searchOption)
|
||||
{
|
||||
var enumerable = Directory.EnumerateFileSystemEntries(path, searchPattern, searchOption);
|
||||
return enumerable.SafeEnumerate();
|
||||
try
|
||||
{
|
||||
var enumerable = Directory.EnumerateFileSystemEntries(path, searchPattern, searchOption);
|
||||
return enumerable.SafeEnumerate();
|
||||
}
|
||||
catch
|
||||
{
|
||||
return [];
|
||||
}
|
||||
}
|
||||
#else
|
||||
/// <inheritdoc cref="Directory.EnumerateDirectories(string)"/>
|
||||
public static IEnumerable<string> SafeEnumerateDirectories(this string path)
|
||||
{
|
||||
try
|
||||
{
|
||||
string searchPattern = "*";
|
||||
SearchOption searchOption = SearchOption.TopDirectoryOnly;
|
||||
var enumerationOptions = FromSearchOption(searchOption);
|
||||
enumerationOptions.IgnoreInaccessible = true;
|
||||
var enumerable = Directory.EnumerateDirectories(path, searchPattern, enumerationOptions);
|
||||
return enumerable.SafeEnumerate();
|
||||
}
|
||||
catch
|
||||
{
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc cref="Directory.EnumerateDirectories(string, string)"/>
|
||||
public static IEnumerable<string> SafeEnumerateDirectories(this string path, string searchPattern)
|
||||
{
|
||||
try
|
||||
{
|
||||
SearchOption searchOption = SearchOption.TopDirectoryOnly;
|
||||
var enumerationOptions = FromSearchOption(searchOption);
|
||||
enumerationOptions.IgnoreInaccessible = true;
|
||||
var enumerable = Directory.EnumerateDirectories(path, searchPattern, enumerationOptions);
|
||||
return enumerable.SafeEnumerate();
|
||||
}
|
||||
catch
|
||||
{
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc cref="Directory.EnumerateDirectories(string, string, SearchOption)"/>
|
||||
public static IEnumerable<string> SafeEnumerateDirectories(this string path, string searchPattern, SearchOption searchOption)
|
||||
{
|
||||
try
|
||||
{
|
||||
var enumerationOptions = FromSearchOption(searchOption);
|
||||
enumerationOptions.IgnoreInaccessible = true;
|
||||
var enumerable = Directory.EnumerateDirectories(path, searchPattern, enumerationOptions);
|
||||
return enumerable.SafeEnumerate();
|
||||
}
|
||||
catch
|
||||
{
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc cref="Directory.EnumerateFiles(string)"/>
|
||||
public static IEnumerable<string> SafeEnumerateFiles(this string path)
|
||||
{
|
||||
try
|
||||
{
|
||||
string searchPattern = "*";
|
||||
SearchOption searchOption = SearchOption.TopDirectoryOnly;
|
||||
var enumerationOptions = FromSearchOption(searchOption);
|
||||
enumerationOptions.IgnoreInaccessible = true;
|
||||
var enumerable = Directory.EnumerateFiles(path, searchPattern, enumerationOptions);
|
||||
return enumerable.SafeEnumerate();
|
||||
}
|
||||
catch
|
||||
{
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc cref="Directory.EnumerateFiles(string, string)"/>
|
||||
public static IEnumerable<string> SafeEnumerateFiles(this string path, string searchPattern)
|
||||
{
|
||||
try
|
||||
{
|
||||
SearchOption searchOption = SearchOption.TopDirectoryOnly;
|
||||
var enumerationOptions = FromSearchOption(searchOption);
|
||||
enumerationOptions.IgnoreInaccessible = true;
|
||||
var enumerable = Directory.EnumerateFiles(path, searchPattern, enumerationOptions);
|
||||
return enumerable.SafeEnumerate();
|
||||
}
|
||||
catch
|
||||
{
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc cref="Directory.EnumerateFiles(string, string, SearchOption)"/>
|
||||
public static IEnumerable<string> SafeEnumerateFiles(this string path, string searchPattern, SearchOption searchOption)
|
||||
{
|
||||
try
|
||||
{
|
||||
var enumerationOptions = FromSearchOption(searchOption);
|
||||
enumerationOptions.IgnoreInaccessible = true;
|
||||
var enumerable = Directory.EnumerateFiles(path, searchPattern, enumerationOptions);
|
||||
return enumerable.SafeEnumerate();
|
||||
}
|
||||
catch
|
||||
{
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc cref="Directory.EnumerateFileSystemEntries(string)"/>
|
||||
public static IEnumerable<string> SafeEnumerateFileSystemEntries(this string path)
|
||||
{
|
||||
try
|
||||
{
|
||||
string searchPattern = "*";
|
||||
SearchOption searchOption = SearchOption.TopDirectoryOnly;
|
||||
var enumerationOptions = FromSearchOption(searchOption);
|
||||
enumerationOptions.IgnoreInaccessible = true;
|
||||
var enumerable = Directory.EnumerateFileSystemEntries(path, searchPattern, enumerationOptions);
|
||||
return enumerable.SafeEnumerate();
|
||||
}
|
||||
catch
|
||||
{
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc cref="Directory.EnumerateFileSystemEntries(string, string)"/>
|
||||
public static IEnumerable<string> SafeEnumerateFileSystemEntries(this string path, string searchPattern)
|
||||
{
|
||||
try
|
||||
{
|
||||
SearchOption searchOption = SearchOption.TopDirectoryOnly;
|
||||
var enumerationOptions = FromSearchOption(searchOption);
|
||||
enumerationOptions.IgnoreInaccessible = true;
|
||||
var enumerable = Directory.EnumerateFileSystemEntries(path, searchPattern, enumerationOptions);
|
||||
return enumerable.SafeEnumerate();
|
||||
}
|
||||
catch
|
||||
{
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc cref="Directory.EnumerateFileSystemEntries(string, string, SearchOption)"/>
|
||||
public static IEnumerable<string> SafeEnumerateFileSystemEntries(this string path, string searchPattern, SearchOption searchOption)
|
||||
{
|
||||
try
|
||||
{
|
||||
var enumerationOptions = FromSearchOption(searchOption);
|
||||
enumerationOptions.IgnoreInaccessible = true;
|
||||
var enumerable = Directory.EnumerateFileSystemEntries(path, searchPattern, enumerationOptions);
|
||||
return enumerable.SafeEnumerate();
|
||||
}
|
||||
catch
|
||||
{
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Initializes a new instance of the <see cref="EnumerationOptions" /> class with the recommended default options.</summary>
|
||||
/// <see href="https://github.com/dotnet/runtime/blob/main/src/libraries/System.Private.CoreLib/src/System/IO/EnumerationOptions.cs#L42"</remarks>
|
||||
private static EnumerationOptions FromSearchOption(SearchOption searchOption)
|
||||
{
|
||||
if ((searchOption != SearchOption.TopDirectoryOnly) && (searchOption != SearchOption.AllDirectories))
|
||||
throw new ArgumentOutOfRangeException(nameof(searchOption));
|
||||
|
||||
return searchOption == SearchOption.AllDirectories
|
||||
? new EnumerationOptions { RecurseSubdirectories = true, MatchType = MatchType.Win32, AttributesToSkip = 0, IgnoreInaccessible = false }
|
||||
: new EnumerationOptions { MatchType = MatchType.Win32, AttributesToSkip = 0, IgnoreInaccessible = false };
|
||||
}
|
||||
#endif
|
||||
|
||||
|
||||
176
SabreTools.IO/Extensions/MarshalHelpers.cs
Normal file
176
SabreTools.IO/Extensions/MarshalHelpers.cs
Normal file
@@ -0,0 +1,176 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using System.Reflection;
|
||||
using System.Runtime.InteropServices;
|
||||
using System.Text;
|
||||
|
||||
namespace SabreTools.IO.Extensions
|
||||
{
|
||||
/// <summary>
|
||||
/// Common methods for use during marshalling
|
||||
/// </summary>
|
||||
internal static class MarshalHelpers
|
||||
{
|
||||
/// <summary>
|
||||
/// Get an attribute of the requested type
|
||||
/// </summary>
|
||||
public static T? GetAttribute<T>(FieldInfo? fi) where T : Attribute
|
||||
{
|
||||
// If the field info is invalid
|
||||
if (fi == null)
|
||||
return null;
|
||||
|
||||
// Get all matching attributes
|
||||
var attributes = fi.GetCustomAttributes(typeof(T), true);
|
||||
if (attributes == null || attributes.Length == 0)
|
||||
return null;
|
||||
|
||||
// Get the first attribute that matches
|
||||
return attributes.First() as T;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Get an attribute of the requested type
|
||||
/// </summary>
|
||||
public static T? GetAttribute<T>(Type? type) where T : Attribute
|
||||
{
|
||||
// If the field info is invalid
|
||||
if (type == null)
|
||||
return null;
|
||||
|
||||
// Get all matching attributes
|
||||
var attributes = type.GetCustomAttributes(typeof(T), true);
|
||||
if (attributes == null || attributes.Length == 0)
|
||||
return null;
|
||||
|
||||
// Get the first attribute that matches
|
||||
return attributes.First() as T;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Determine the layout kind for a type
|
||||
/// </summary>
|
||||
public static LayoutKind DetermineLayoutKind(StructLayoutAttribute? layoutAttr, Type type)
|
||||
{
|
||||
LayoutKind layoutKind = LayoutKind.Auto;
|
||||
|
||||
if (layoutAttr != null)
|
||||
layoutKind = layoutAttr.Value;
|
||||
else if (type.IsAutoLayout)
|
||||
layoutKind = LayoutKind.Auto;
|
||||
else if (type.IsExplicitLayout)
|
||||
layoutKind = LayoutKind.Explicit;
|
||||
else if (type.IsLayoutSequential)
|
||||
layoutKind = LayoutKind.Sequential;
|
||||
|
||||
return layoutKind;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Determine the encoding for a type
|
||||
/// </summary>
|
||||
public static Encoding DetermineEncoding(StructLayoutAttribute? layoutAttr)
|
||||
{
|
||||
return layoutAttr?.CharSet switch
|
||||
{
|
||||
CharSet.None => Encoding.ASCII,
|
||||
CharSet.Ansi => Encoding.ASCII,
|
||||
CharSet.Unicode => Encoding.Unicode,
|
||||
CharSet.Auto => Encoding.ASCII, // UTF-8 on Unix
|
||||
_ => Encoding.ASCII,
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Determine the parent hierarchy for a given type
|
||||
/// </summary>
|
||||
/// <remarks>Returns the highest parent as the first element</remarks>
|
||||
public static IEnumerable<Type> DetermineTypeLineage(Type type)
|
||||
{
|
||||
var lineage = new List<Type>();
|
||||
while (type != typeof(object) && type != typeof(ValueType))
|
||||
{
|
||||
lineage.Add(type);
|
||||
type = type.BaseType ?? typeof(object);
|
||||
}
|
||||
|
||||
lineage.Reverse();
|
||||
return lineage;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Get an ordered set of fields from a type
|
||||
/// </summary>
|
||||
/// <remarks>Returns fields from the parents before fields from the type</remarks>
|
||||
public static FieldInfo[] GetFields(Type type)
|
||||
{
|
||||
// Get the type hierarchy for ensuring serialization order
|
||||
var lineage = DetermineTypeLineage(type);
|
||||
|
||||
// Generate the fields by parent first
|
||||
var fieldsList = new List<FieldInfo>();
|
||||
foreach (var nextType in lineage)
|
||||
{
|
||||
var nextFields = nextType.GetFields();
|
||||
foreach (var field in nextFields)
|
||||
{
|
||||
if (!fieldsList.Any(f => f.Name == field.Name && f.FieldType == field.FieldType))
|
||||
fieldsList.Add(field);
|
||||
}
|
||||
}
|
||||
|
||||
return [.. fieldsList];
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Get the expected array size for a field
|
||||
/// </summary>
|
||||
/// <returns>Array size on success, -1 on failure</returns>
|
||||
public static int GetArrayElementCount(MarshalAsAttribute marshalAsAttr, FieldInfo[] fields, object instance)
|
||||
{
|
||||
int elementCount = -1;
|
||||
if (marshalAsAttr.Value == UnmanagedType.ByValArray)
|
||||
{
|
||||
elementCount = marshalAsAttr.SizeConst;
|
||||
}
|
||||
else if (marshalAsAttr.Value == UnmanagedType.LPArray)
|
||||
{
|
||||
elementCount = marshalAsAttr.SizeConst;
|
||||
if (marshalAsAttr.SizeParamIndex >= 0)
|
||||
elementCount = GetLPArraySizeFromField(marshalAsAttr, fields, instance);
|
||||
}
|
||||
|
||||
return elementCount;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Get the expected LPArray size from a field
|
||||
/// </summary>
|
||||
public static int GetLPArraySizeFromField(MarshalAsAttribute marshalAsAttr, FieldInfo[] fields, object instance)
|
||||
{
|
||||
// If the index is invalid
|
||||
if (marshalAsAttr.SizeParamIndex < 0)
|
||||
return -1;
|
||||
|
||||
// Get the size field
|
||||
var sizeField = fields[marshalAsAttr.SizeParamIndex];
|
||||
if (sizeField == null)
|
||||
return -1;
|
||||
|
||||
// Cast based on the field type
|
||||
return sizeField.GetValue(instance) switch
|
||||
{
|
||||
sbyte val => val,
|
||||
byte val => val,
|
||||
short val => val,
|
||||
ushort val => val,
|
||||
int val => val,
|
||||
uint val => (int)val,
|
||||
long val => (int)val,
|
||||
ulong val => (int)val,
|
||||
_ => -1,
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,7 +1,6 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
#if NET7_0_OR_GREATER
|
||||
using System.Numerics;
|
||||
#endif
|
||||
@@ -439,8 +438,12 @@ namespace SabreTools.IO.Extensions
|
||||
// Short-circuit to explicit implementations
|
||||
if (encoding.Equals(Encoding.ASCII))
|
||||
return stream.ReadNullTerminatedAnsiString();
|
||||
else if (encoding.Equals(Encoding.UTF8))
|
||||
return stream.ReadNullTerminatedUTF8String();
|
||||
else if (encoding.Equals(Encoding.Unicode))
|
||||
return stream.ReadNullTerminatedUnicodeString();
|
||||
else if (encoding.Equals(Encoding.UTF32))
|
||||
return stream.ReadNullTerminatedUTF32String();
|
||||
|
||||
if (stream.Position >= stream.Length)
|
||||
return null;
|
||||
@@ -465,36 +468,44 @@ namespace SabreTools.IO.Extensions
|
||||
if (stream.Position >= stream.Length)
|
||||
return null;
|
||||
|
||||
List<byte> buffer = [];
|
||||
while (stream.Position < stream.Length)
|
||||
{
|
||||
byte ch = stream.ReadByteValue();
|
||||
buffer.Add(ch);
|
||||
if (ch == '\0')
|
||||
break;
|
||||
}
|
||||
|
||||
return Encoding.ASCII.GetString([.. buffer]);
|
||||
byte[] buffer = ReadUntilNull1Byte(stream);
|
||||
return Encoding.ASCII.GetString(buffer);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read a null-terminated Unicode string from the stream
|
||||
/// Read a null-terminated UTF-8 string from the stream
|
||||
/// </summary>
|
||||
public static string? ReadNullTerminatedUTF8String(this Stream stream)
|
||||
{
|
||||
if (stream.Position >= stream.Length)
|
||||
return null;
|
||||
|
||||
byte[] buffer = ReadUntilNull1Byte(stream);
|
||||
return Encoding.UTF8.GetString(buffer);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read a null-terminated UTF-16 (Unicode) string from the stream
|
||||
/// </summary>
|
||||
public static string? ReadNullTerminatedUnicodeString(this Stream stream)
|
||||
{
|
||||
if (stream.Position >= stream.Length)
|
||||
return null;
|
||||
|
||||
List<byte> buffer = [];
|
||||
while (stream.Position < stream.Length)
|
||||
{
|
||||
byte[] ch = stream.ReadBytes(2);
|
||||
buffer.AddRange(ch);
|
||||
if (ch[0] == '\0' && ch[1] == '\0')
|
||||
break;
|
||||
}
|
||||
byte[] buffer = ReadUntilNull2Byte(stream);
|
||||
return Encoding.Unicode.GetString(buffer);
|
||||
}
|
||||
|
||||
return Encoding.Unicode.GetString([.. buffer]);
|
||||
/// <summary>
|
||||
/// Read a null-terminated UTF-32 string from the stream
|
||||
/// </summary>
|
||||
public static string? ReadNullTerminatedUTF32String(this Stream stream)
|
||||
{
|
||||
if (stream.Position >= stream.Length)
|
||||
return null;
|
||||
|
||||
byte[] buffer = ReadUntilNull4Byte(stream);
|
||||
return Encoding.Unicode.GetString(buffer);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -522,10 +533,10 @@ namespace SabreTools.IO.Extensions
|
||||
return null;
|
||||
|
||||
ushort size = stream.ReadUInt16();
|
||||
if (stream.Position + size >= stream.Length)
|
||||
if (stream.Position + (size * 2) >= stream.Length)
|
||||
return null;
|
||||
|
||||
byte[] buffer = stream.ReadBytes(size);
|
||||
byte[] buffer = stream.ReadBytes(size * 2);
|
||||
return Encoding.Unicode.GetString(buffer);
|
||||
}
|
||||
|
||||
@@ -571,16 +582,34 @@ namespace SabreTools.IO.Extensions
|
||||
/// <summary>
|
||||
/// Read a <typeparamref name="T"/> from the stream
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This method is different than standard marshalling in a few notable ways:
|
||||
/// - Strings are read by value, not by reference
|
||||
/// - Complex objects are read by value, not by reference
|
||||
/// - Enumeration values are read by the underlying value type
|
||||
/// - Arrays of the above are handled sequentially as above
|
||||
/// - Inherited fields from parents are deserialized BEFORE fields in the child
|
||||
/// </remarks>
|
||||
public static T? ReadType<T>(this Stream stream)
|
||||
=> (T?)stream.ReadType(typeof(T));
|
||||
|
||||
/// <summary>
|
||||
/// Read a <paramref name="type"/> from the stream
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This method is different than standard marshalling in a few notable ways:
|
||||
/// - Strings are read by value, not by reference
|
||||
/// - Complex objects are read by value, not by reference
|
||||
/// - Enumeration values are read by the underlying value type
|
||||
/// - Arrays of the above are handled sequentially as above
|
||||
/// - Inherited fields from parents are deserialized BEFORE fields in the child
|
||||
/// </remarks>
|
||||
public static object? ReadType(this Stream stream, Type type)
|
||||
{
|
||||
if (type.IsClass || (type.IsValueType && !type.IsPrimitive))
|
||||
if (type.IsClass || (type.IsValueType && !type.IsEnum && !type.IsPrimitive))
|
||||
return ReadComplexType(stream, type);
|
||||
else if (type.IsValueType && type.IsEnum)
|
||||
return ReadNormalType(stream, Enum.GetUnderlyingType(type));
|
||||
else
|
||||
return ReadNormalType(stream, type);
|
||||
}
|
||||
@@ -610,49 +639,33 @@ namespace SabreTools.IO.Extensions
|
||||
/// <summary>
|
||||
/// Read a <paramref name="type"/> from the stream
|
||||
/// </summary>
|
||||
private static object? ReadComplexType(this Stream stream, Type type)
|
||||
private static object? ReadComplexType(Stream stream, Type type)
|
||||
{
|
||||
try
|
||||
{
|
||||
// Try to create an instance of the type
|
||||
var instance = Activator.CreateInstance(type);
|
||||
if (instance == null)
|
||||
return null;
|
||||
|
||||
// Get the layout attribute
|
||||
var layoutAttr = type.GetCustomAttributes(typeof(StructLayoutAttribute), true).FirstOrDefault() as StructLayoutAttribute;
|
||||
|
||||
// Get the layout type
|
||||
LayoutKind layoutKind = LayoutKind.Auto;
|
||||
if (layoutAttr != null)
|
||||
layoutKind = layoutAttr.Value;
|
||||
else if (type.IsAutoLayout)
|
||||
layoutKind = LayoutKind.Auto;
|
||||
else if (type.IsExplicitLayout)
|
||||
layoutKind = LayoutKind.Explicit;
|
||||
else if (type.IsLayoutSequential)
|
||||
layoutKind = LayoutKind.Sequential;
|
||||
|
||||
// Get the encoding to use
|
||||
Encoding encoding = layoutAttr?.CharSet switch
|
||||
{
|
||||
CharSet.None => Encoding.ASCII,
|
||||
CharSet.Ansi => Encoding.ASCII,
|
||||
CharSet.Unicode => Encoding.Unicode,
|
||||
CharSet.Auto => Encoding.ASCII, // UTF-8 on Unix
|
||||
_ => Encoding.ASCII,
|
||||
};
|
||||
// Get the layout information
|
||||
var layoutAttr = MarshalHelpers.GetAttribute<StructLayoutAttribute>(type);
|
||||
LayoutKind layoutKind = MarshalHelpers.DetermineLayoutKind(layoutAttr, type);
|
||||
Encoding encoding = MarshalHelpers.DetermineEncoding(layoutAttr);
|
||||
|
||||
// Cache the current offset
|
||||
long currentOffset = stream.Position;
|
||||
|
||||
// Generate the fields by parent first
|
||||
var fields = MarshalHelpers.GetFields(type);
|
||||
|
||||
// Loop through the fields and set them
|
||||
var fields = type.GetFields();
|
||||
foreach (var fi in fields)
|
||||
{
|
||||
// If we have an explicit layout, move accordingly
|
||||
if (layoutKind == LayoutKind.Explicit)
|
||||
{
|
||||
var fieldOffset = fi.GetCustomAttributes(typeof(FieldOffsetAttribute), true).FirstOrDefault() as FieldOffsetAttribute;
|
||||
var fieldOffset = MarshalHelpers.GetAttribute<FieldOffsetAttribute>(fi);
|
||||
stream.Seek(currentOffset + fieldOffset?.Value ?? 0, SeekOrigin.Begin);
|
||||
}
|
||||
|
||||
@@ -677,6 +690,11 @@ namespace SabreTools.IO.Extensions
|
||||
var value = ReadStringType(stream, encoding, instance, fi);
|
||||
fi.SetValue(instance, value);
|
||||
}
|
||||
else if (fi.FieldType.IsArray)
|
||||
{
|
||||
var value = ReadArrayType(stream, fields, instance, fi);
|
||||
fi.SetValue(instance, Convert.ChangeType(value, fi.FieldType));
|
||||
}
|
||||
else
|
||||
{
|
||||
var value = stream.ReadType(fi.FieldType);
|
||||
@@ -684,74 +702,129 @@ namespace SabreTools.IO.Extensions
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read an array type field for an object
|
||||
/// </summary>
|
||||
private static Array ReadArrayType(Stream stream, FieldInfo[] fields, object instance, FieldInfo fi)
|
||||
{
|
||||
var marshalAsAttr = MarshalHelpers.GetAttribute<MarshalAsAttribute>(fi);
|
||||
if (marshalAsAttr == null)
|
||||
return new object[0];
|
||||
|
||||
// Get the number of elements expected
|
||||
int elementCount = MarshalHelpers.GetArrayElementCount(marshalAsAttr, fields, instance);
|
||||
if (elementCount < 0)
|
||||
return new object[0];
|
||||
|
||||
// Get the item type for the array
|
||||
Type elementType = fi.FieldType.GetElementType() ?? typeof(object);
|
||||
|
||||
// Loop through and build the array
|
||||
Array arr = Array.CreateInstance(elementType, elementCount);
|
||||
for (int i = 0; i < elementCount; i++)
|
||||
{
|
||||
var value = ReadType(stream, elementType);
|
||||
arr.SetValue(value, i);
|
||||
}
|
||||
|
||||
// Return the built array
|
||||
return arr;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read a string type field for an object
|
||||
/// </summary>
|
||||
private static string? ReadStringType(Stream stream, Encoding encoding, object instance, FieldInfo fi)
|
||||
{
|
||||
var marshalAsAttr = fi.GetCustomAttributes(typeof(MarshalAsAttribute), true).FirstOrDefault() as MarshalAsAttribute;
|
||||
var marshalAsAttr = MarshalHelpers.GetAttribute<MarshalAsAttribute>(fi);
|
||||
|
||||
switch (marshalAsAttr?.Value)
|
||||
{
|
||||
case UnmanagedType.AnsiBStr:
|
||||
byte ansiLength = stream.ReadByteValue();
|
||||
byte[] ansiBytes = stream.ReadBytes(ansiLength);
|
||||
return Encoding.ASCII.GetString(ansiBytes);
|
||||
return stream.ReadPrefixedAnsiString();
|
||||
|
||||
case UnmanagedType.BStr:
|
||||
ushort bstrLength = stream.ReadUInt16();
|
||||
byte[] bstrBytes = stream.ReadBytes(bstrLength);
|
||||
return Encoding.ASCII.GetString(bstrBytes);
|
||||
case UnmanagedType.TBStr: // Technically distinct; returns char[] instead
|
||||
return stream.ReadPrefixedUnicodeString();
|
||||
|
||||
// TODO: Handle length from another field
|
||||
case UnmanagedType.ByValTStr:
|
||||
int byvalLength = marshalAsAttr.SizeConst;
|
||||
int byvalLength = marshalAsAttr!.SizeConst;
|
||||
byte[] byvalBytes = stream.ReadBytes(byvalLength);
|
||||
return encoding.GetString(byvalBytes);
|
||||
|
||||
case UnmanagedType.LPStr:
|
||||
case UnmanagedType.LPTStr: // Technically distinct; possibly not null-terminated
|
||||
case null:
|
||||
var lpstrBytes = new List<byte>();
|
||||
while (true)
|
||||
{
|
||||
byte next = stream.ReadByteValue();
|
||||
if (next == 0x00)
|
||||
break;
|
||||
return stream.ReadNullTerminatedAnsiString();
|
||||
|
||||
lpstrBytes.Add(next);
|
||||
|
||||
if (stream.Position >= stream.Length)
|
||||
break;
|
||||
}
|
||||
|
||||
return Encoding.ASCII.GetString([.. lpstrBytes]);
|
||||
|
||||
case UnmanagedType.LPWStr:
|
||||
var lpwstrBytes = new List<byte>();
|
||||
while (true)
|
||||
{
|
||||
ushort next = stream.ReadUInt16();
|
||||
|
||||
if (next == 0x0000)
|
||||
break;
|
||||
lpwstrBytes.AddRange(BitConverter.GetBytes(next));
|
||||
|
||||
if (stream.Position >= stream.Length)
|
||||
break;
|
||||
}
|
||||
|
||||
return Encoding.ASCII.GetString([.. lpwstrBytes]);
|
||||
|
||||
// No support required yet
|
||||
case UnmanagedType.LPTStr:
|
||||
#if NET472_OR_GREATER || NETCOREAPP
|
||||
case UnmanagedType.LPUTF8Str:
|
||||
return stream.ReadNullTerminatedUTF8String();
|
||||
#endif
|
||||
case UnmanagedType.TBStr:
|
||||
|
||||
case UnmanagedType.LPWStr:
|
||||
return stream.ReadNullTerminatedUnicodeString();
|
||||
|
||||
// No other string types are recognized
|
||||
default:
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read bytes until a 1-byte null terminator is found
|
||||
/// </summary>
|
||||
private static byte[] ReadUntilNull1Byte(Stream stream)
|
||||
{
|
||||
var bytes = new List<byte>();
|
||||
while (stream.Position < stream.Length)
|
||||
{
|
||||
byte next = stream.ReadByteValue();
|
||||
if (next == 0x00)
|
||||
break;
|
||||
|
||||
bytes.Add(next);
|
||||
}
|
||||
|
||||
return [.. bytes];
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read bytes until a 2-byte null terminator is found
|
||||
/// </summary>
|
||||
private static byte[] ReadUntilNull2Byte(Stream stream)
|
||||
{
|
||||
var bytes = new List<byte>();
|
||||
while (stream.Position < stream.Length)
|
||||
{
|
||||
ushort next = stream.ReadUInt16();
|
||||
if (next == 0x0000)
|
||||
break;
|
||||
|
||||
bytes.AddRange(BitConverter.GetBytes(next));
|
||||
}
|
||||
|
||||
return [.. bytes];
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read bytes until a 4-byte null terminator is found
|
||||
/// </summary>
|
||||
private static byte[] ReadUntilNull4Byte(Stream stream)
|
||||
{
|
||||
var bytes = new List<byte>();
|
||||
while (stream.Position < stream.Length)
|
||||
{
|
||||
uint next = stream.ReadUInt32();
|
||||
if (next == 0x00000000)
|
||||
break;
|
||||
|
||||
bytes.AddRange(BitConverter.GetBytes(next));
|
||||
}
|
||||
|
||||
return [.. bytes];
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read a number of bytes from the stream to a buffer
|
||||
/// </summary>
|
||||
|
||||
@@ -3,6 +3,7 @@ using System.IO;
|
||||
#if NET7_0_OR_GREATER
|
||||
using System.Numerics;
|
||||
#endif
|
||||
using System.Reflection;
|
||||
using System.Runtime.InteropServices;
|
||||
using System.Text;
|
||||
|
||||
@@ -495,12 +496,24 @@ namespace SabreTools.IO.Extensions
|
||||
=> stream.WriteNullTerminatedString(value, Encoding.ASCII);
|
||||
|
||||
/// <summary>
|
||||
/// Write a null-terminated Unicode string to the stream
|
||||
/// Write a null-terminated UTF-8 string to the stream
|
||||
/// </summary>
|
||||
public static bool WriteNullTerminatedUTF8String(this Stream stream, string? value)
|
||||
=> stream.WriteNullTerminatedString(value, Encoding.UTF8);
|
||||
|
||||
/// <summary>
|
||||
/// Write a null-terminated UTF-16 (Unicode) string to the stream
|
||||
/// </summary>
|
||||
public static bool WriteNullTerminatedUnicodeString(this Stream stream, string? value)
|
||||
=> stream.WriteNullTerminatedString(value, Encoding.Unicode);
|
||||
|
||||
/// <summary>
|
||||
/// Write a null-terminated UTF-32 string to the stream
|
||||
/// </summary>
|
||||
public static bool WriteNullTerminatedUTF32String(this Stream stream, string? value)
|
||||
=> stream.WriteNullTerminatedString(value, Encoding.UTF32);
|
||||
|
||||
//// <summary>
|
||||
/// Write a byte-prefixed ASCII string to the stream
|
||||
/// </summary>
|
||||
public static bool WritePrefixedAnsiString(this Stream stream, string? value)
|
||||
@@ -565,21 +578,207 @@ namespace SabreTools.IO.Extensions
|
||||
/// <summary>
|
||||
/// Write a <typeparamref name="T"/> to the stream
|
||||
/// </summary>
|
||||
/// TODO: Fix writing as reading was fixed
|
||||
/// <remarks>
|
||||
/// This method is different than standard marshalling in a few notable ways:
|
||||
/// - Strings are written by value, not by reference
|
||||
/// - Complex objects are written by value, not by reference
|
||||
/// - Enumeration values are written by the underlying value type
|
||||
/// - Arrays of the above are handled sequentially as above
|
||||
/// - Inherited fields from parents are serialized BEFORE fields in the child
|
||||
/// </remarks>
|
||||
public static bool WriteType<T>(this Stream stream, T? value)
|
||||
=> stream.WriteType(value, typeof(T));
|
||||
|
||||
/// <summary>
|
||||
/// Write a <typeparamref name="T"/> to the stream
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// This method is different than standard marshalling in a few notable ways:
|
||||
/// - Strings are written by value, not by reference
|
||||
/// - Complex objects are written by value, not by reference
|
||||
/// - Enumeration values are written by the underlying value type
|
||||
/// - Arrays of the above are handled sequentially as above
|
||||
/// - Inherited fields from parents are serialized BEFORE fields in the child
|
||||
/// </remarks>
|
||||
public static bool WriteType(this Stream stream, object? value, Type type)
|
||||
{
|
||||
// Handle the null case
|
||||
if (value == null)
|
||||
if (type.IsClass || (type.IsValueType && !type.IsEnum && !type.IsPrimitive))
|
||||
return WriteComplexType(stream, value, type);
|
||||
else if (type.IsValueType && type.IsEnum)
|
||||
return WriteNormalType(stream, value, Enum.GetUnderlyingType(type));
|
||||
else
|
||||
return WriteNormalType(stream, value, type);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read a <paramref name="type"/> from the stream
|
||||
/// </summary>
|
||||
private static bool WriteNormalType(Stream stream, object? value, Type type)
|
||||
{
|
||||
try
|
||||
{
|
||||
// Null values cannot be written
|
||||
if (value == null)
|
||||
return true;
|
||||
|
||||
int typeSize = Marshal.SizeOf(type);
|
||||
if (value.GetType() != type)
|
||||
value = Convert.ChangeType(value, type);
|
||||
|
||||
var buffer = new byte[typeSize];
|
||||
var handle = GCHandle.Alloc(buffer, GCHandleType.Pinned);
|
||||
Marshal.StructureToPtr(value, handle.AddrOfPinnedObject(), false);
|
||||
handle.Free();
|
||||
|
||||
return WriteFromBuffer(stream, buffer);
|
||||
}
|
||||
catch
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Read a <paramref name="type"/> from the stream
|
||||
/// </summary>
|
||||
private static bool WriteComplexType(Stream stream, object? value, Type type)
|
||||
{
|
||||
try
|
||||
{
|
||||
// Null values cannot be written
|
||||
if (value == null)
|
||||
return true;
|
||||
|
||||
// Get the layout information
|
||||
var layoutAttr = MarshalHelpers.GetAttribute<StructLayoutAttribute>(type);
|
||||
LayoutKind layoutKind = MarshalHelpers.DetermineLayoutKind(layoutAttr, type);
|
||||
Encoding encoding = MarshalHelpers.DetermineEncoding(layoutAttr);
|
||||
|
||||
// Cache the current offset
|
||||
long currentOffset = stream.Position;
|
||||
|
||||
// Generate the fields by parent first
|
||||
var fields = MarshalHelpers.GetFields(type);
|
||||
|
||||
// Loop through the fields and set them
|
||||
foreach (var fi in fields)
|
||||
{
|
||||
// If we have an explicit layout, move accordingly
|
||||
if (layoutKind == LayoutKind.Explicit)
|
||||
{
|
||||
var fieldOffset = MarshalHelpers.GetAttribute<FieldOffsetAttribute>(fi);
|
||||
stream.Seek(currentOffset + fieldOffset?.Value ?? 0, SeekOrigin.Begin);
|
||||
}
|
||||
|
||||
if (!GetField(stream, encoding, fields, value, fi))
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
catch
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Write a single field from an object
|
||||
/// </summary>
|
||||
private static bool GetField(Stream stream, Encoding encoding, FieldInfo[] fields, object instance, FieldInfo fi)
|
||||
{
|
||||
if (fi.FieldType.IsAssignableFrom(typeof(string)))
|
||||
{
|
||||
return WriteStringType(stream, encoding, instance, fi);
|
||||
}
|
||||
else if (fi.FieldType.IsArray)
|
||||
{
|
||||
return WriteArrayType(stream, fields, instance, fi);
|
||||
}
|
||||
else
|
||||
{
|
||||
var value = fi.GetValue(instance);
|
||||
return stream.WriteType(value, fi.FieldType);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Write an array type field from an object
|
||||
/// </summary>
|
||||
private static bool WriteArrayType(Stream stream, FieldInfo[] fields, object instance, FieldInfo fi)
|
||||
{
|
||||
var marshalAsAttr = MarshalHelpers.GetAttribute<MarshalAsAttribute>(fi);
|
||||
if (marshalAsAttr == null)
|
||||
return false;
|
||||
|
||||
int typeSize = Marshal.SizeOf(typeof(T));
|
||||
// Get the array
|
||||
Array? arr = fi.GetValue(instance) as Array;
|
||||
if (arr == null)
|
||||
return false;
|
||||
|
||||
var buffer = new byte[typeSize];
|
||||
var handle = GCHandle.Alloc(buffer, GCHandleType.Pinned);
|
||||
Marshal.StructureToPtr(value, handle.AddrOfPinnedObject(), false);
|
||||
handle.Free();
|
||||
// Get the number of elements expected
|
||||
int elementCount = MarshalHelpers.GetArrayElementCount(marshalAsAttr, fields, instance);
|
||||
if (elementCount < 0)
|
||||
return false;
|
||||
|
||||
return WriteFromBuffer(stream, buffer);
|
||||
// Get the item type for the array
|
||||
Type elementType = fi.FieldType.GetElementType() ?? typeof(object);
|
||||
|
||||
// Loop through and write the array
|
||||
for (int i = 0; i < elementCount; i++)
|
||||
{
|
||||
var value = arr.GetValue(i);
|
||||
if (!WriteType(stream, value, elementType))
|
||||
return false;
|
||||
}
|
||||
|
||||
// Return the built array
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Write a string type field from an object
|
||||
/// </summary>
|
||||
private static bool WriteStringType(Stream stream, Encoding encoding, object instance, FieldInfo fi)
|
||||
{
|
||||
var marshalAsAttr = MarshalHelpers.GetAttribute<MarshalAsAttribute>(fi);
|
||||
string? fieldValue = fi.GetValue(instance) as string;
|
||||
if (fieldValue == null)
|
||||
return true;
|
||||
|
||||
switch (marshalAsAttr?.Value)
|
||||
{
|
||||
case UnmanagedType.AnsiBStr:
|
||||
return stream.WritePrefixedAnsiString(fieldValue);
|
||||
|
||||
case UnmanagedType.BStr:
|
||||
case UnmanagedType.TBStr: // Technically distinct; returns char[] instead
|
||||
return stream.WritePrefixedUnicodeString(fieldValue);
|
||||
|
||||
case UnmanagedType.ByValTStr:
|
||||
int byvalLength = marshalAsAttr!.SizeConst;
|
||||
byte[] byvalBytes = encoding.GetBytes(fieldValue);
|
||||
byte[] byvalSizedBytes = new byte[byvalLength];
|
||||
Array.Copy(byvalBytes, byvalSizedBytes, Math.Min(byvalBytes.Length, byvalSizedBytes.Length));
|
||||
return Write(stream, byvalSizedBytes);
|
||||
|
||||
case UnmanagedType.LPStr:
|
||||
case UnmanagedType.LPTStr: // Technically distinct; possibly not null-terminated
|
||||
case null:
|
||||
return stream.WriteNullTerminatedAnsiString(fieldValue);
|
||||
|
||||
#if NET472_OR_GREATER || NETCOREAPP
|
||||
case UnmanagedType.LPUTF8Str:
|
||||
return stream.WriteNullTerminatedUTF8String(fieldValue);
|
||||
#endif
|
||||
|
||||
case UnmanagedType.LPWStr:
|
||||
return stream.WriteNullTerminatedUnicodeString(fieldValue);
|
||||
|
||||
// No other string types are recognized
|
||||
default:
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
|
||||
@@ -7,7 +7,7 @@
|
||||
<LangVersion>latest</LangVersion>
|
||||
<Nullable>enable</Nullable>
|
||||
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
|
||||
<Version>1.4.6</Version>
|
||||
<Version>1.4.9</Version>
|
||||
<WarningsNotAsErrors>CS0618</WarningsNotAsErrors>
|
||||
|
||||
<!-- Package Properties -->
|
||||
|
||||
Reference in New Issue
Block a user