claunia/plist-cil
1
0
Fork 0
mirror of https://github.com/claunia/plist-cil.git synced 2025-12-16 11:04:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Code refactor and clean-up to follow new C# 9 conventions and features where applicable.

Browse Source
This commit is contained in:
Natalia Portillo
2021-04-30 13:06:04 +01:00
parent a72e7ad0e4
commit 19756723a3
34 changed files with 2467 additions and 2691 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
plist-cil.benchmark/BinaryPropertyListParserBenchmarks.cs
View File

@@ -1,25 +1,22 @@
using BenchmarkDotNet.Attributes;
using System.IO;
using BenchmarkDotNet.Attributes;
using BenchmarkDotNet.Jobs;
using System.IO;
namespace Claunia.PropertyList.Benchmark
{
[SimpleJob(RuntimeMoniker.NetCoreApp50)]
[MemoryDiagnoser]
[SimpleJob(RuntimeMoniker.NetCoreApp50), MemoryDiagnoser]
public class BinaryPropertyListParserBenchmarks
{
byte[] data;
[GlobalSetup]
public void Setup()
{
data = File.ReadAllBytes("plist.bin");
}
public void Setup() => data = File.ReadAllBytes("plist.bin");
[Benchmark]
public NSObject ReadLargePropertylistTest()
{
NSObject nsObject = PropertyListParser.Parse(data);
return nsObject;
}
}

13
plist-cil.benchmark/BinaryPropertyListWriterBenchmarks.cs
View File

@@ -3,22 +3,15 @@ using BenchmarkDotNet.Jobs;
namespace Claunia.PropertyList.Benchmark
{
[SimpleJob(RuntimeMoniker.NetCoreApp50)]
[MemoryDiagnoser]
[SimpleJob(RuntimeMoniker.NetCoreApp50), MemoryDiagnoser]
public class BinaryPropertyListWriterBenchmarks
{
NSObject data;
[GlobalSetup]
public void Setup()
{
data = PropertyListParser.Parse("plist.bin");
}
public void Setup() => data = PropertyListParser.Parse("plist.bin");
[Benchmark]
public byte[] WriteLargePropertylistTest()
{
return BinaryPropertyListWriter.WriteToArray(data);
}
public byte[] WriteLargePropertylistTest() => BinaryPropertyListWriter.WriteToArray(data);
}
}

9
plist-cil.benchmark/Program.cs
View File

@@ -1,14 +1,13 @@
using BenchmarkDotNet.Reports;
using BenchmarkDotNet.Running;
using BenchmarkDotNet.Running;
namespace Claunia.PropertyList.Benchmark
{
class Program
internal class Program
{
static void Main(string[] args)
{
Summary summary = BenchmarkRunner.Run<BinaryPropertyListParserBenchmarks>();
summary = BenchmarkRunner.Run<BinaryPropertyListWriterBenchmarks>();
BenchmarkRunner.Run<BinaryPropertyListParserBenchmarks>();
BenchmarkRunner.Run<BinaryPropertyListWriterBenchmarks>();
}
}
}

3
plist-cil.sln.DotSettings Normal file
View File

@@ -0,0 +1,3 @@
<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
<s:Boolean x:Key="/Default/UserDictionary/Words/=Claunia/@EntryIndexedValue">True</s:Boolean>
<s:Boolean x:Key="/Default/UserDictionary/Words/=Dreibrodt/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>

77
plist-cil.test/BinaryPropertyListParserTests.cs
View File

@@ -5,39 +5,64 @@ namespace plistcil.test
{
public class BinaryPropertyListParserTests
{
[Theory]
[InlineData(new byte[] {0x08}, 0x08)]
[InlineData(new byte[] {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x07}, 7)]
[InlineData(new byte[] {0x00, 0x0e, 0x47, 0x7b}, 0x00000000000e477b)]
public void ParseUnsignedIntTest(byte[] binaryValue, int expectedValue)
[Theory, InlineData(new byte[]
{
0x08
}, 0x08), InlineData(new byte[]
{
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x07
}, 7), InlineData(new byte[]
{
0x00, 0x0e, 0x47, 0x7b
}, 0x00000000000e477b)]
public void ParseUnsignedIntTest(byte[] binaryValue, int expectedValue) =>
Assert.Equal(expectedValue, BinaryPropertyListParser.ParseUnsignedInt(binaryValue));
}
[Theory]
[InlineData(new byte[] {0x57}, 0x57)]
[InlineData(new byte[] {0x12, 0x34}, 0x1234)]
[InlineData(new byte[] {0x12, 0x34, 0x56}, 0x123456)]
[InlineData(new byte[] {0x40, 0x2d, 0xf8, 0x4d}, 0x402df84d)]
[InlineData(new byte[] {0x12, 0x34, 0x56, 0x78, 0x9a }, 0x123456789a)]
[InlineData(new byte[] {0x12, 0x34, 0x56, 0x78, 0x9a, 0xbc }, 0x123456789abc)]
[InlineData(new byte[] {0x12, 0x34, 0x56, 0x78, 0x9a, 0xbc, 0xde }, 0x123456789abcde)]
[InlineData(new byte[] {0x41, 0xb4, 0x83, 0x98, 0x2a, 0x00, 0x00, 0x00}, 0x41b483982a000000)]
[InlineData(new byte[] {0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xfc, 0x19}, unchecked((long)0xfffffffffffffc19))]
[InlineData(new byte[] {0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xfc, 0x19 },
unchecked((long)0xfffffffffffffc19))]
public void ParseLongTest(byte[] binaryValue, long expectedValue)
[Theory, InlineData(new byte[]
{
0x57
}, 0x57), InlineData(new byte[]
{
0x12, 0x34
}, 0x1234), InlineData(new byte[]
{
0x12, 0x34, 0x56
}, 0x123456), InlineData(new byte[]
{
0x40, 0x2d, 0xf8, 0x4d
}, 0x402df84d), InlineData(new byte[]
{
0x12, 0x34, 0x56, 0x78, 0x9a
}, 0x123456789a), InlineData(new byte[]
{
0x12, 0x34, 0x56, 0x78, 0x9a, 0xbc
}, 0x123456789abc), InlineData(new byte[]
{
0x12, 0x34, 0x56, 0x78, 0x9a, 0xbc, 0xde
}, 0x123456789abcde), InlineData(new byte[]
{
0x41, 0xb4, 0x83, 0x98, 0x2a, 0x00, 0x00, 0x00
}, 0x41b483982a000000), InlineData(new byte[]
{
0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xfc, 0x19
}, unchecked((long)0xfffffffffffffc19)), InlineData(new byte[]
{
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xfc, 0x19
}, unchecked((long)0xfffffffffffffc19))]
public void ParseLongTest(byte[] binaryValue, long expectedValue) =>
Assert.Equal(expectedValue, BinaryPropertyListParser.ParseLong(binaryValue));
}
[Theory]
[InlineData(new byte[] {0x41, 0xb4, 0x83, 0x98, 0x2a, 0x00, 0x00, 0x00}, 344168490)]
[InlineData(new byte[] {0x40, 0x09, 0x21, 0xf9, 0xf0, 0x1b, 0x86, 0x6e}, 3.14159)]
[InlineData(new byte[] {0x40, 0x2d, 0xf8, 0x4d}, 2.71828007698059)]
public void ParseDoubleTest(byte[] binaryValue, double expectedValue)
[Theory, InlineData(new byte[]
{
0x41, 0xb4, 0x83, 0x98, 0x2a, 0x00, 0x00, 0x00
}, 344168490), InlineData(new byte[]
{
0x40, 0x09, 0x21, 0xf9, 0xf0, 0x1b, 0x86, 0x6e
}, 3.14159), InlineData(new byte[]
{
0x40, 0x2d, 0xf8, 0x4d
}, 2.71828007698059)]
public void ParseDoubleTest(byte[] binaryValue, double expectedValue) =>
Assert.Equal(expectedValue, BinaryPropertyListParser.ParseDouble(binaryValue), 14);
}
}
}

77
plist-cil.test/BinaryPropertyListWriterTests.cs
View File

@@ -12,14 +12,18 @@ namespace plistcil.test
byte[] data = File.ReadAllBytes("test-files/plist2.bin");
NSObject root = PropertyListParser.Parse(data);
using(MemoryStream actualOutput = new MemoryStream())
using(Stream expectedOutput = File.OpenRead("test-files/plist2.bin"))
using(ValidatingStream validatingStream = new ValidatingStream(actualOutput, expectedOutput))
{
BinaryPropertyListWriter writer = new BinaryPropertyListWriter(validatingStream);
writer.ReuseObjectIds = false;
writer.Write(root);
}
using var actualOutput = new MemoryStream();
using Stream expectedOutput = File.OpenRead("test-files/plist2.bin");
using var validatingStream = new ValidatingStream(actualOutput, expectedOutput);
var writer = new BinaryPropertyListWriter(validatingStream)
{
ReuseObjectIds = false
};
writer.Write(root);
}
[Fact]
@@ -28,14 +32,15 @@ namespace plistcil.test
byte[] data = File.ReadAllBytes("test-files/plist3.bin");
NSObject root = PropertyListParser.Parse(data);
using(MemoryStream actualOutput = new MemoryStream())
using(Stream expectedOutput = File.OpenRead("test-files/plist3.bin"))
using(ValidatingStream validatingStream = new ValidatingStream(actualOutput, expectedOutput))
{
BinaryPropertyListWriter writer = new BinaryPropertyListWriter(validatingStream);
writer.ReuseObjectIds = false;
writer.Write(root);
}
using var actualOutput = new MemoryStream();
using Stream expectedOutput = File.OpenRead("test-files/plist3.bin");
using var validatingStream = new ValidatingStream(actualOutput, expectedOutput);
var writer = new BinaryPropertyListWriter(validatingStream);
writer.ReuseObjectIds = false;
writer.Write(root);
}
[Fact]
@@ -44,14 +49,18 @@ namespace plistcil.test
byte[] data = File.ReadAllBytes("test-files/plist4.bin");
NSObject root = PropertyListParser.Parse(data);
using(MemoryStream actualOutput = new MemoryStream())
using(Stream expectedOutput = File.OpenRead("test-files/plist4.bin"))
using(ValidatingStream validatingStream = new ValidatingStream(actualOutput, expectedOutput))
{
BinaryPropertyListWriter writer = new BinaryPropertyListWriter(validatingStream);
writer.ReuseObjectIds = false;
writer.Write(root);
}
using var actualOutput = new MemoryStream();
using Stream expectedOutput = File.OpenRead("test-files/plist4.bin");
using var validatingStream = new ValidatingStream(actualOutput, expectedOutput);
var writer = new BinaryPropertyListWriter(validatingStream)
{
ReuseObjectIds = false
};
writer.Write(root);
}
[Fact]
@@ -60,14 +69,18 @@ namespace plistcil.test
byte[] data = File.ReadAllBytes("test-files/plist.bin");
NSObject root = PropertyListParser.Parse(data);
using(MemoryStream actualOutput = new MemoryStream())
using(Stream expectedOutput = File.OpenRead("test-files/plist.bin"))
using(ValidatingStream validatingStream = new ValidatingStream(actualOutput, expectedOutput))
{
BinaryPropertyListWriter writer = new BinaryPropertyListWriter(validatingStream);
writer.ReuseObjectIds = false;
writer.Write(root);
}
using var actualOutput = new MemoryStream();
using Stream expectedOutput = File.OpenRead("test-files/plist.bin");
using var validatingStream = new ValidatingStream(actualOutput, expectedOutput);
var writer = new BinaryPropertyListWriter(validatingStream)
{
ReuseObjectIds = false
};
writer.Write(root);
}
}
}

42
plist-cil.test/IssueTest.cs
View File

@@ -32,8 +32,8 @@ namespace plistcil.test
public static class IssueTest
{
/// <summary>
/// Makes sure that binary data is line-wrapped correctly when being serialized, in a scenario
/// where the binary data is not indented (no leading whitespace).
/// Makes sure that binary data is line-wrapped correctly when being serialized, in a scenario where the binary
/// data is not indented (no leading whitespace).
/// </summary>
[Fact]
public static void RoundtripDataTest()
@@ -46,16 +46,15 @@ namespace plistcil.test
}
/// <summary>
/// Makes sure that binary data is line-wrapped correctly when being serialized, in a scenario
/// where the binary data is indented.
/// Makes sure that binary data is line-wrapped correctly when being serialized, in a scenario where the binary
/// data is indented.
/// </summary>
[Fact]
public static void RoundtripDataTest2()
{
string expected = File.ReadAllText(@"test-files/RoundtripBinaryIndentation.plist");
NSObject value =
XmlPropertyListParser.Parse(new FileInfo(@"test-files/RoundtripBinaryIndentation.plist"));
string actual = value.ToXmlPropertyList();
string expected = File.ReadAllText(@"test-files/RoundtripBinaryIndentation.plist");
NSObject value = XmlPropertyListParser.Parse(new FileInfo(@"test-files/RoundtripBinaryIndentation.plist"));
string actual = value.ToXmlPropertyList();
Assert.Equal(expected, actual, ignoreLineEndingDifferences: true);
}
@@ -90,7 +89,7 @@ namespace plistcil.test
[Fact]
public static void TestIssue18()
{
NSNumber x = new NSNumber(-999);
var x = new NSNumber(-999);
PropertyListParser.SaveAsBinary(x, new FileInfo("test-files/out-testIssue18.plist"));
NSObject y = PropertyListParser.Parse(new FileInfo("test-files/out-testIssue18.plist"));
Assert.True(x.Equals(y));
@@ -106,14 +105,12 @@ namespace plistcil.test
[Fact]
public static void TestIssue22()
{
NSDictionary x1 = (NSDictionary)PropertyListParser.Parse(new FileInfo("test-files/issue22-emoji.plist"));
NSDictionary x2 =
(NSDictionary)PropertyListParser.Parse(new FileInfo("test-files/issue22-emoji-xml.plist"));
var x1 = (NSDictionary)PropertyListParser.Parse(new FileInfo("test-files/issue22-emoji.plist"));
var x2 = (NSDictionary)PropertyListParser.Parse(new FileInfo("test-files/issue22-emoji-xml.plist"));
PropertyListParser.SaveAsBinary(x1, new FileInfo("test-files/out-testIssue22.plist"));
NSDictionary y1 = (NSDictionary)PropertyListParser.Parse(new FileInfo("test-files/out-testIssue22.plist"));
var y1 = (NSDictionary)PropertyListParser.Parse(new FileInfo("test-files/out-testIssue22.plist"));
PropertyListParser.SaveAsXml(x2, new FileInfo("test-files/out-testIssue22-xml.plist"));
NSDictionary y2 =
(NSDictionary)PropertyListParser.Parse(new FileInfo("test-files/out-testIssue22-xml.plist"));
var y2 = (NSDictionary)PropertyListParser.Parse(new FileInfo("test-files/out-testIssue22-xml.plist"));
Assert.True(x1.Equals(x2));
Assert.True(x1.Equals(y1));
Assert.True(x1.Equals(y2));
@@ -132,7 +129,7 @@ namespace plistcil.test
public static void TestIssue30()
{
#pragma warning disable 219
NSArray arr = (NSArray)PropertyListParser.Parse(new FileInfo("test-files/issue30.plist"));
var arr = (NSArray)PropertyListParser.Parse(new FileInfo("test-files/issue30.plist"));
#pragma warning restore 219
}
@@ -140,30 +137,32 @@ namespace plistcil.test
public static void TestIssue33()
{
#pragma warning disable 219
NSDictionary dict = (NSDictionary)PropertyListParser.Parse(new FileInfo("test-files/issue33.pbxproj"));
var dict = (NSDictionary)PropertyListParser.Parse(new FileInfo("test-files/issue33.pbxproj"));
#pragma warning restore 219
}
[Fact]
public static void TestIssue38()
{
NSDictionary dict = (NSDictionary)PropertyListParser.Parse(new FileInfo("test-files/issue33.pbxproj"));
var dict = (NSDictionary)PropertyListParser.Parse(new FileInfo("test-files/issue33.pbxproj"));
NSObject fileRef =
((NSDictionary)((NSDictionary)dict.Get("objects")).Get("65541A9C16D13B8C00A968D5")).Get("fileRef");
Assert.True(fileRef.Equals(new NSString("65541A9B16D13B8C00A968D5")));
}
[Fact]
public static void TestIssue4()
{
NSDictionary d = (NSDictionary)PropertyListParser.Parse(new FileInfo("test-files/issue4.plist"));
var d = (NSDictionary)PropertyListParser.Parse(new FileInfo("test-files/issue4.plist"));
Assert.Equal("Kid\u2019s iPhone", ((NSString)d.ObjectForKey("Device Name")).ToString());
}
[Fact]
public static void TestIssue49()
{
NSDictionary dict = (NSDictionary)PropertyListParser.Parse(new FileInfo("test-files/issue49.plist"));
var dict = (NSDictionary)PropertyListParser.Parse(new FileInfo("test-files/issue49.plist"));
Assert.Empty(dict);
}
@@ -181,8 +180,7 @@ namespace plistcil.test
[Fact]
public static void TestRealInResourceRule()
{
NSDictionary dict =
(NSDictionary)XmlPropertyListParser.Parse(new FileInfo("test-files/ResourceRules.plist"));
var dict = (NSDictionary)XmlPropertyListParser.Parse(new FileInfo("test-files/ResourceRules.plist"));
Assert.Single(dict);
Assert.True(dict.ContainsKey("weight"));

64
plist-cil.test/NSArrayTests.cs
View File

@@ -6,30 +6,30 @@ namespace plistcil.test
{
public class NSArrayTests
{
/// <summary>
/// Tests the addition of a .NET object to the NSArray
/// </summary>
/// <summary>Tests the addition of a .NET object to the NSArray</summary>
[Fact]
public void AddAndContainsObjectTest()
{
NSArray array = new NSArray();
array.Add(1);
var array = new NSArray
{
1
};
Assert.True(array.Contains(1));
Assert.False(array.Contains(2));
}
/// <summary>
/// Tests the <see cref="NSArray.GetEnumerator" /> method.
/// </summary>
/// <summary>Tests the <see cref="NSArray.GetEnumerator" /> method.</summary>
[Fact]
public void EnumeratorTest()
{
NSArray array = new NSArray();
array.Add(0);
array.Add(1);
var array = new NSArray
{
0,
1
};
IEnumerator<NSObject> enumerator = array.GetEnumerator();
using IEnumerator<NSObject> enumerator = array.GetEnumerator();
Assert.Null(enumerator.Current);
@@ -42,46 +42,46 @@ namespace plistcil.test
Assert.False(enumerator.MoveNext());
}
/// <summary>
/// Tests the <see cref="NSArray.IndexOf(object)" /> method for .NET objects.
/// </summary>
/// <summary>Tests the <see cref="NSArray.IndexOf(object)" /> method for .NET objects.</summary>
[Fact]
public void IndexOfTest()
{
NSArray array = new NSArray();
array.Add(1);
array.Add("test");
var array = new NSArray
{
1,
"test"
};
Assert.Equal(0, array.IndexOf(1));
Assert.Equal(1, array.IndexOf("test"));
}
/// <summary>
/// Tests the <see cref="NSArray.Insert(int, object)" /> method for a
/// .NET object.
/// </summary>
/// <summary>Tests the <see cref="NSArray.Insert(int, object)" /> method for a .NET object.</summary>
[Fact]
public void InsertTest()
{
NSArray array = new NSArray();
array.Add(0);
array.Add(1);
array.Add(2);
var array = new NSArray
{
0,
1,
2
};
array.Insert(1, "test");
Assert.Equal(4, array.Count);
Assert.Equal(4, array.Count);
Assert.Equal("test", array[1].ToObject());
}
/// <summary>
/// Tests the <see cref="NSArray.Remove(object)" /> method for a .NET object.
/// </summary>
/// <summary>Tests the <see cref="NSArray.Remove(object)" /> method for a .NET object.</summary>
[Fact]
public void RemoveTest()
{
NSArray array = new NSArray();
array.Add(0);
var array = new NSArray
{
0
};
Assert.False(array.Remove((object)1));
Assert.True(array.Remove((object)0));

10
plist-cil.test/NSDateTests.cs
View File

@@ -9,17 +9,17 @@ namespace plistcil.test
[Fact]
public static void ConstructorTest()
{
NSDate actual = new NSDate("2000-01-01T00:00:00Z");
DateTime expected = new DateTime(2000, 1, 1, 0, 0, 0, DateTimeKind.Utc);
var actual = new NSDate("2000-01-01T00:00:00Z");
var expected = new DateTime(2000, 1, 1, 0, 0, 0, DateTimeKind.Utc);
Assert.Equal(expected, actual.Date.ToUniversalTime());
}
[Fact]
public static void MakeDateStringTest()
{
DateTime date = new DateTime(2000, 1, 1, 0, 0, 0, DateTimeKind.Utc);
string expected = "2000-01-01T00:00:00Z";
string actual = NSDate.MakeDateString(date);
var date = new DateTime(2000, 1, 1, 0, 0, 0, DateTimeKind.Utc);
string expected = "2000-01-01T00:00:00Z";
string actual = NSDate.MakeDateString(date);
Assert.Equal(expected, actual);
}

500
plist-cil.test/NSNumberTests.cs
View File

@@ -1,72 +1,187 @@
using Claunia.PropertyList;
using System;
using System;
using System.Collections.Generic;
using Claunia.PropertyList;
using Xunit;
namespace plistcil.test
{
public class NSNumberTests
{
public static IEnumerable<object[]> SpanConstructorTestData()
public static IEnumerable<object[]> SpanConstructorTestData() => new List<object[]>
{
return new List<object[]>
// INTEGER values
// 0
new object[]
{
// INTEGER values
// 0
new object[] { new byte[] { 0x00 }, NSNumber.INTEGER, false, 0, 0.0 },
new byte[]
{
0x00
},
NSNumber.INTEGER, false, 0, 0.0
},
// 1-byte value < sbyte.maxValue
new object[] { new byte[] { 0x10 }, NSNumber.INTEGER, true, 16, 16.0 },
// 1-byte value < sbyte.maxValue
new object[]
{
new byte[]
{
0x10
},
NSNumber.INTEGER, true, 16, 16.0
},
// 1-byte value > sbyte.MaxValue
new object[] { new byte[] { 0xFF }, NSNumber.INTEGER, true, byte.MaxValue, (double)byte.MaxValue},
// 1-byte value > sbyte.MaxValue
new object[]
{
new byte[]
{
0xFF
},
NSNumber.INTEGER, true, byte.MaxValue, (double)byte.MaxValue
},
// 2-byte value < short.maxValue
new object[] { new byte[] { 0x10, 0x00 }, NSNumber.INTEGER, true, 4096, 4096.0 },
// 2-byte value < short.maxValue
new object[]
{
new byte[]
{
0x10, 0x00
},
NSNumber.INTEGER, true, 4096, 4096.0
},
// 2-byte value > short.maxValue
new object[] { new byte[] { 0xFF, 0xFF }, NSNumber.INTEGER, true, ushort.MaxValue, (double)ushort.MaxValue},
// 2-byte value > short.maxValue
new object[]
{
new byte[]
{
0xFF, 0xFF
},
NSNumber.INTEGER, true, ushort.MaxValue, (double)ushort.MaxValue
},
// 4-byte value < int.maxValue
new object[] { new byte[] { 0x10, 0x00, 0x00, 0x00 }, NSNumber.INTEGER, true, 0x10000000, 1.0 * 0x10000000 },
// 4-byte value < int.maxValue
new object[]
{
new byte[]
{
0x10, 0x00, 0x00, 0x00
},
NSNumber.INTEGER, true, 0x10000000, 1.0 * 0x10000000
},
// 4-bit value > int.MaxValue
new object[] { new byte[] { 0xFF, 0xFF, 0xFF, 0xFF }, NSNumber.INTEGER, true, uint.MaxValue, (double)uint.MaxValue },
// 4-bit value > int.MaxValue
new object[]
{
new byte[]
{
0xFF, 0xFF, 0xFF, 0xFF
},
NSNumber.INTEGER, true, uint.MaxValue, (double)uint.MaxValue
},
// 64-bit value < long.MaxValue
new object[] { new byte[] { 0x10, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }, NSNumber.INTEGER, true, 0x1000000000000000, 1.0 * 0x1000000000000000 },
// 64-bit value < long.MaxValue
new object[]
{
new byte[]
{
0x10, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
},
NSNumber.INTEGER, true, 0x1000000000000000, 1.0 * 0x1000000000000000
},
// 64-bit value > long.MaxValue
new object[] { new byte[] { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF }, NSNumber.INTEGER, true, -1, -1.0 },
// 64-bit value > long.MaxValue
new object[]
{
new byte[]
{
0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF
},
NSNumber.INTEGER, true, -1, -1.0
},
// 128-bit positive value
new object[] { new byte[] { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xa0, 0x00 }, NSNumber.INTEGER, true, unchecked((long)0xffffffffffffa000), 1.0 * unchecked((long)0xffffffffffffa000) },
// 128-bit positive value
new object[]
{
new byte[]
{
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xa0, 0x00
},
NSNumber.INTEGER, true, unchecked((long)0xffffffffffffa000), 1.0 * unchecked((long)0xffffffffffffa000)
},
// 128-bit negative value
new object[] { new byte[] { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff }, NSNumber.INTEGER, true, -1, -1.0 },
// 128-bit negative value
new object[]
{
new byte[]
{
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
},
NSNumber.INTEGER, true, -1, -1.0
},
// REAL values
// 4-byte value (float)
new object[] { new byte[] { 0x00, 0x00, 0x00, 0x00 }, NSNumber.REAL, false, 0, 0.0 },
// REAL values
// 4-byte value (float)
new object[]
{
new byte[]
{
0x00, 0x00, 0x00, 0x00
},
NSNumber.REAL, false, 0, 0.0
},
new object[] { new byte[] { 0x41, 0x20, 0x00, 0x00 }, NSNumber.REAL, true, 10, 10.0 },
new object[]
{
new byte[]
{
0x41, 0x20, 0x00, 0x00
},
NSNumber.REAL, true, 10, 10.0
},
new object[] { new byte[] { 0x3d, 0xcc, 0xcc, 0xcd }, NSNumber.REAL, false, 0, 0.1 },
new object[]
{
new byte[]
{
0x3d, 0xcc, 0xcc, 0xcd
},
NSNumber.REAL, false, 0, 0.1
},
// 8-byte value (double)
new object[] { new byte[] { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }, NSNumber.REAL, false, 0, 0.0 },
// 8-byte value (double)
new object[]
{
new byte[]
{
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
},
NSNumber.REAL, false, 0, 0.0
},
new object[] { new byte[] { 0x40, 0x24, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }, NSNumber.REAL, true, 10, 10.0 },
new object[]
{
new byte[]
{
0x40, 0x24, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
},
NSNumber.REAL, true, 10, 10.0
},
new object[] { new byte[] { 0x3f, 0xb9, 0x99, 0x99, 0x99, 0x99, 0x99, 0x9a }, NSNumber.REAL, false, 0, 0.1 }
};
}
new object[]
{
new byte[]
{
0x3f, 0xb9, 0x99, 0x99, 0x99, 0x99, 0x99, 0x9a
},
NSNumber.REAL, false, 0, 0.1
}
};
[Theory]
[MemberData(nameof(SpanConstructorTestData))]
[Theory, MemberData(nameof(SpanConstructorTestData))]
public void SpanConstructorTest(byte[] data, int type, bool boolValue, long longValue, double doubleValue)
{
NSNumber number = new NSNumber((Span<byte>)data, type);
var number = new NSNumber((Span<byte>)data, type);
Assert.Equal(boolValue, number.ToBool());
Assert.Equal(longValue, number.ToLong());
Assert.Equal(doubleValue, number.ToDouble(), 5);
@@ -77,7 +192,10 @@ namespace plistcil.test
{
Assert.Throws<ArgumentNullException>(() => new NSNumber((Span<byte>)null, NSNumber.INTEGER));
Assert.Throws<ArgumentNullException>(() => new NSNumber((Span<byte>)null, NSNumber.REAL));
Assert.Throws<ArgumentOutOfRangeException>(() => new NSNumber((Span<byte>)Array.Empty<byte>(), NSNumber.INTEGER));
Assert.Throws<ArgumentOutOfRangeException>(() => new NSNumber((Span<byte>)Array.Empty<byte>(),
NSNumber.INTEGER));
Assert.Throws<ArgumentException>(() => new NSNumber((Span<byte>)Array.Empty<byte>(), NSNumber.REAL));
Assert.Throws<ArgumentException>(() => new NSNumber((Span<byte>)Array.Empty<byte>(), 9));
}
@@ -93,15 +211,15 @@ namespace plistcil.test
[Fact]
public static void NSNumberConstructorTest()
{
NSNumber number = new NSNumber("10032936613", NSNumber.INTEGER);
var number = new NSNumber("10032936613", NSNumber.INTEGER);
Assert.Equal(NSNumber.INTEGER, number.GetNSNumberType());
Assert.Equal(10032936613, number.ToObject());
Assert.Equal(10032936613, number.ToObject());
}
[Fact]
public static void NSNumberWithDecimalTest()
{
NSNumber number = new NSNumber("1360155352.748765", NSNumber.REAL);
var number = new NSNumber("1360155352.748765", NSNumber.REAL);
Assert.Equal("1360155352.748765", number.ToString());
}
@@ -110,92 +228,147 @@ namespace plistcil.test
// The value being used comes seen in a real property list:
// <key>TimeZoneOffsetFromUTC</key>
// <real>7200.000000</real>
[Fact]
[UseCulture("en-US")]
[Fact, UseCulture("en-US")]
public static void ParseNumberEnTest()
{
NSNumber number = new NSNumber("7200.000001");
var number = new NSNumber("7200.000001");
Assert.True(number.isReal());
Assert.Equal(7200.000001d, number.ToDouble());
}
[Fact]
[UseCulture("nl-BE")]
[Fact, UseCulture("nl-BE")]
public static void ParseNumberNlTest()
{
// As seen in a real property list:
// <key>TimeZoneOffsetFromUTC</key>
// <real>7200.000000</real>
NSNumber number = new NSNumber("7200.000001");
var number = new NSNumber("7200.000001");
Assert.True(number.isReal());
Assert.Equal(7200.000001d, number.ToDouble());
}
[Fact]
[UseCulture("en-US")]
[Fact, UseCulture("en-US")]
public static void ParseNumberEnTest2()
{
// As seen in a real property list:
// <key>TimeZoneOffsetFromUTC</key>
// <real>7200.000000</real>
NSNumber number = new NSNumber("7200.000000", NSNumber.REAL);
var number = new NSNumber("7200.000000", NSNumber.REAL);
Assert.True(number.isReal());
Assert.Equal(7200d, number.ToDouble());
}
[Fact]
[UseCulture("nl-BE")]
[Fact, UseCulture("nl-BE")]
public static void ParseNumberNlTest2()
{
// As seen in a real property list:
// <key>TimeZoneOffsetFromUTC</key>
// <real>7200.000000</real>
NSNumber number = new NSNumber("7200.000000", NSNumber.REAL);
var number = new NSNumber("7200.000000", NSNumber.REAL);
Assert.True(number.isReal());
Assert.Equal(7200d, number.ToDouble());
}
public static IEnumerable<object[]> StringConstructorTestData()
public static IEnumerable<object[]> StringConstructorTestData() => new List<object[]>
{
return new List<object[]>
// Long values, formatted as hexadecimal values
new object[]
{
// Long values, formatted as hexadecimal values
new object[] { "0x00", false, 0, 0.0 },
new object[] { "0x1000", true, 0x1000, 1.0 * 0x1000 },
new object[] { "0x00001000", true, 0x1000, 1.0 * 0x1000 },
new object[] { "0x0000000000001000", true, 0x1000, 1.0 * 0x1000 },
"0x00", false, 0, 0.0
},
new object[]
{
"0x1000", true, 0x1000, 1.0 * 0x1000
},
new object[]
{
"0x00001000", true, 0x1000, 1.0 * 0x1000
},
new object[]
{
"0x0000000000001000", true, 0x1000, 1.0 * 0x1000
},
// Long values, formatted as decimal values
new object[] { "0", false, 0, 0.0 },
new object[] { "10", true, 10, 10.0 },
// Decimal values
new object[] { "0.0", false, 0, 0.0 },
new object[] { "0.10", false, 0, 0.1 },
new object[] { "3.14", true, 3, 3.14 },
// Long values, formatted as decimal values
new object[]
{
"0", false, 0, 0.0
},
new object[]
{
"10", true, 10, 10.0
},
// Boolean values
new object[] { "yes", true, 1, 1},
new object[] { "true", true, 1, 1},
new object[] { "Yes", true, 1, 1},
new object[] { "True", true, 1, 1},
new object[] { "YES", true, 1, 1},
new object[] { "TRUE", true, 1, 1},
// Decimal values
new object[]
{
"0.0", false, 0, 0.0
},
new object[]
{
"0.10", false, 0, 0.1
},
new object[]
{
"3.14", true, 3, 3.14
},
new object[] { "no", false, 0, 0},
new object[] { "false", false, 0, 0},
new object[] { "No", false, 0, 0},
new object[] { "False", false, 0, 0},
new object[] { "NO", false, 0, 0},
new object[] { "FALSE", false, 0, 0},
};
}
// Boolean values
new object[]
{
"yes", true, 1, 1
},
new object[]
{
"true", true, 1, 1
},
new object[]
{
"Yes", true, 1, 1
},
new object[]
{
"True", true, 1, 1
},
new object[]
{
"YES", true, 1, 1
},
new object[]
{
"TRUE", true, 1, 1
},
[Theory]
[MemberData(nameof(StringConstructorTestData))]
new object[]
{
"no", false, 0, 0
},
new object[]
{
"false", false, 0, 0
},
new object[]
{
"No", false, 0, 0
},
new object[]
{
"False", false, 0, 0
},
new object[]
{
"NO", false, 0, 0
},
new object[]
{
"FALSE", false, 0, 0
}
};
[Theory, MemberData(nameof(StringConstructorTestData))]
public void StringConstructorTest(string value, bool boolValue, long longValue, double doubleValue)
{
NSNumber number = new NSNumber(value);
var number = new NSNumber(value);
Assert.Equal(boolValue, number.ToBool());
Assert.Equal(longValue, number.ToLong());
Assert.Equal(doubleValue, number.ToDouble(), 5);
@@ -208,90 +381,129 @@ namespace plistcil.test
Assert.Throws<ArgumentException>(() => new NSNumber("plist"));
}
public static IEnumerable<object[]> Int32ConstructorTestData()
public static IEnumerable<object[]> Int32ConstructorTestData() => new List<object[]>
{
return new List<object[]>
// Long values, formatted as hexadecimal values
new object[]
{
// Long values, formatted as hexadecimal values
new object[] { 0, false, 0, 0.0 },
new object[] { 1, true, 1, 1.0 },
new object[] { -1, true, -1, -1.0 },
new object[] { int.MaxValue, true, int.MaxValue, int.MaxValue },
new object[] { int.MinValue, true, int.MinValue, int.MinValue },
};
}
0, false, 0, 0.0
},
new object[]
{
1, true, 1, 1.0
},
new object[]
{
-1, true, -1, -1.0
},
new object[]
{
int.MaxValue, true, int.MaxValue, int.MaxValue
},
new object[]
{
int.MinValue, true, int.MinValue, int.MinValue
}
};
[Theory]
[MemberData(nameof(Int32ConstructorTestData))]
[Theory, MemberData(nameof(Int32ConstructorTestData))]
public void Int32ConstructorTest(int value, bool boolValue, long longValue, double doubleValue)
{
NSNumber number = new NSNumber(value);
var number = new NSNumber(value);
Assert.Equal(boolValue, number.ToBool());
Assert.Equal(longValue, number.ToLong());
Assert.Equal(doubleValue, number.ToDouble(), 5);
}
public static IEnumerable<object[]> Int64ConstructorTestData()
public static IEnumerable<object[]> Int64ConstructorTestData() => new List<object[]>
{
return new List<object[]>
// Long values, formatted as hexadecimal values
new object[]
{
// Long values, formatted as hexadecimal values
new object[] { 0, false, 0, 0.0 },
new object[] { 1, true, 1, 1.0 },
new object[] { -1, true, -1, -1.0 },
new object[] { long.MaxValue, true, long.MaxValue, long.MaxValue },
new object[] { long.MinValue, true, long.MinValue, long.MinValue },
};
}
0, false, 0, 0.0
},
new object[]
{
1, true, 1, 1.0
},
new object[]
{
-1, true, -1, -1.0
},
new object[]
{
long.MaxValue, true, long.MaxValue, long.MaxValue
},
new object[]
{
long.MinValue, true, long.MinValue, long.MinValue
}
};
[Theory]
[MemberData(nameof(Int64ConstructorTestData))]
[Theory, MemberData(nameof(Int64ConstructorTestData))]
public void Int64ConstructorTest(long value, bool boolValue, long longValue, double doubleValue)
{
NSNumber number = new NSNumber(value);
var number = new NSNumber(value);
Assert.Equal(boolValue, number.ToBool());
Assert.Equal(longValue, number.ToLong());
Assert.Equal(doubleValue, number.ToDouble(), 5);
}
public static IEnumerable<object[]> DoubleConstructorTestData()
public static IEnumerable<object[]> DoubleConstructorTestData() => new List<object[]>
{
return new List<object[]>
// Long values, formatted as hexadecimal values
new object[]
{
// Long values, formatted as hexadecimal values
new object[] { 0.0, false, 0, 0.0 },
new object[] { 1.0, true, 1, 1.0 },
new object[] { -1.0, true, -1, -1.0 },
new object[] { double.Epsilon, false, 0, double.Epsilon },
new object[] { double.MaxValue, true, long.MinValue /* Overflow! */, double.MaxValue },
new object[] { double.MinValue, true, long.MinValue, double.MinValue },
};
}
0.0, false, 0, 0.0
},
new object[]
{
1.0, true, 1, 1.0
},
new object[]
{
-1.0, true, -1, -1.0
},
new object[]
{
double.Epsilon, false, 0, double.Epsilon
},
new object[]
{
double.MaxValue, true, long.MinValue /* Overflow! */, double.MaxValue
},
new object[]
{
double.MinValue, true, long.MinValue, double.MinValue
}
};
[Theory]
[MemberData(nameof(DoubleConstructorTestData))]
[Theory, MemberData(nameof(DoubleConstructorTestData))]
public void DoubleConstructorTest(double value, bool boolValue, long longValue, double doubleValue)
{
NSNumber number = new NSNumber(value);
var number = new NSNumber(value);
Assert.Equal(boolValue, number.ToBool());
Assert.Equal(longValue, number.ToLong());
Assert.Equal(doubleValue, number.ToDouble(), 5);
}
public static IEnumerable<object[]> BoolConstructorTestData()
{
return new List<object[]>
{
// Long values, formatted as hexadecimal values
new object[] { false, false, 0, 0.0 },
new object[] { true, true, 1, 1.0 },
};
}
[Theory]
[MemberData(nameof(BoolConstructorTestData))]
public static IEnumerable<object[]> BoolConstructorTestData() => new List<object[]>
{
// Long values, formatted as hexadecimal values
new object[]
{
false, false, 0, 0.0
},
new object[]
{
true, true, 1, 1.0
}
};
[Theory, MemberData(nameof(BoolConstructorTestData))]
public void BoolConstructorTest(bool value, bool boolValue, long longValue, double doubleValue)
{
NSNumber number = new NSNumber(value);
var number = new NSNumber(value);
Assert.Equal(boolValue, number.ToBool());
Assert.Equal(longValue, number.ToLong());
Assert.Equal(doubleValue, number.ToDouble(), 5);
@@ -300,8 +512,8 @@ namespace plistcil.test
[Fact]
public void EqualTest()
{
NSNumber a = new NSNumber(2);
NSNumber b = new NSNumber(2);
var a = new NSNumber(2);
var b = new NSNumber(2);
Assert.Equal(a.GetHashCode(), b.GetHashCode());
Assert.True(a.Equals(b));

186
plist-cil.test/ParseTest.cs
View File

@@ -35,22 +35,20 @@ namespace plistcil.test
{
static bool ArrayEquals(byte[] arrayA, byte[] arrayB)
{
if(arrayA.Length == arrayB.Length)
{
for(int i = 0; i < arrayA.Length; i++)
if(arrayA[i] != arrayB[i])
return false;
if(arrayA.Length != arrayB.Length)
return false;
return true;
}
for(int i = 0; i < arrayA.Length; i++)
if(arrayA[i] != arrayB[i])
return false;
return false;
return true;
}
/**
* NSSet only occurs in binary property lists, so we have to test it separately.
* NSSets are not yet supported in reading/writing, as binary property list format v1+ is required.
*/
* NSSet only occurs in binary property lists, so we have to test it separately.
* NSSets are not yet supported in reading/writing, as binary property list format v1+ is required.
*/
/*
[Fact]
public static void TestSet()
@@ -73,23 +71,26 @@ namespace plistcil.test
NSObject ParsedRoot = PropertyListParser.Parse(new FileInfo("test-files/out-testSet.plist"));
Assert.True(ParsedRoot.Equals(dict));
}*/
[Fact]
public static void TestASCII()
{
NSObject x = PropertyListParser.Parse(new FileInfo("test-files/test1-ascii.plist"));
NSDictionary d = (NSDictionary)x;
NSObject x = PropertyListParser.Parse(new FileInfo("test-files/test1-ascii.plist"));
var d = (NSDictionary)x;
Assert.True(d.Count == 5);
Assert.Equal("valueA", ((NSString)d.ObjectForKey("keyA")).ToString());
Assert.Equal("valueA", ((NSString)d.ObjectForKey("keyA")).ToString());
Assert.Equal("value&B", ((NSString)d.ObjectForKey("key&B")).ToString());
NSDate actualDate = (NSDate)d.ObjectForKey("date");
var actualDate = (NSDate)d.ObjectForKey("date");
DateTime expectedDate = new DateTime(2011, 11, 28, 9, 21, 30, DateTimeKind.Utc).ToLocalTime();
Assert.Equal(actualDate.Date, expectedDate);
Assert.True(ArrayEquals(((NSData)d.ObjectForKey("data")).Bytes,
new byte[] {0x00, 0x00, 0x00, 0x04, 0x10, 0x41, 0x08, 0x20, 0x82}));
NSArray a = (NSArray)d.ObjectForKey("array");
Assert.True(ArrayEquals(((NSData)d.ObjectForKey("data")).Bytes, new byte[]
{
0x00, 0x00, 0x00, 0x04, 0x10, 0x41, 0x08, 0x20, 0x82
}));
var a = (NSArray)d.ObjectForKey("array");
Assert.True(a.Count == 4);
Assert.True(a[0].Equals(new NSString("YES")));
Assert.True(a[1].Equals(new NSString("NO")));
@@ -100,32 +101,32 @@ namespace plistcil.test
[Fact]
public static void testAsciiUtf8CharactersInQuotedString()
{
NSObject x = PropertyListParser.Parse(new FileInfo("test-files/test-ascii-utf8.plist"));
NSDictionary d = (NSDictionary)x;
Assert.Equal(2, d.Count);
Assert.Equal("JÔÖú@2x.jpg", d.ObjectForKey("path").ToString());
NSObject x = PropertyListParser.Parse(new FileInfo("test-files/test-ascii-utf8.plist"));
var d = (NSDictionary)x;
Assert.Equal(2, d.Count);
Assert.Equal("JÔÖú@2x.jpg", d.ObjectForKey("path").ToString());
Assert.Equal("QÔÖú@2x 啕.jpg", d.ObjectForKey("Key QÔÖª@2x 䌡").ToString());
}
[Fact]
public static void TestASCIIWriting()
{
FileInfo inf = new FileInfo("test-files/test1.plist");
FileInfo outf = new FileInfo("test-files/out-test1-ascii.plist");
FileInfo in2 = new FileInfo("test-files/test1-ascii.plist");
NSDictionary x = (NSDictionary)PropertyListParser.Parse(inf);
var inf = new FileInfo("test-files/test1.plist");
var outf = new FileInfo("test-files/out-test1-ascii.plist");
var in2 = new FileInfo("test-files/test1-ascii.plist");
var x = (NSDictionary)PropertyListParser.Parse(inf);
PropertyListParser.SaveAsASCII(x, outf);
//Information gets lost when saving into the ASCII format (NSNumbers are converted to NSStrings)
NSDictionary y = (NSDictionary)PropertyListParser.Parse(outf);
NSDictionary z = (NSDictionary)PropertyListParser.Parse(in2);
var y = (NSDictionary)PropertyListParser.Parse(outf);
var z = (NSDictionary)PropertyListParser.Parse(in2);
Assert.True(y.Equals(z));
}
/**
* Test the binary reader/writer.
*/
* Test the binary reader/writer.
*/
[Fact]
public static void TestBinary()
{
@@ -140,16 +141,21 @@ namespace plistcil.test
[Fact]
public static void TestGnuStepASCII()
{
NSObject x = PropertyListParser.Parse(new FileInfo("test-files/test1-ascii-gnustep.plist"));
NSDictionary d = (NSDictionary)x;
NSObject x = PropertyListParser.Parse(new FileInfo("test-files/test1-ascii-gnustep.plist"));
var d = (NSDictionary)x;
Assert.True(d.Count == 5);
Assert.Equal("valueA", ((NSString)d.ObjectForKey("keyA")).ToString());
Assert.Equal("valueA", ((NSString)d.ObjectForKey("keyA")).ToString());
Assert.Equal("value&B", ((NSString)d.ObjectForKey("key&B")).ToString());
Assert.True(((NSDate)d.ObjectForKey("date")).Date.Equals(new DateTime(2011, 11, 28, 9, 21, 30,
DateTimeKind.Utc).ToLocalTime()));
Assert.True(ArrayEquals(((NSData)d.ObjectForKey("data")).Bytes,
new byte[] {0x00, 0x00, 0x00, 0x04, 0x10, 0x41, 0x08, 0x20, 0x82}));
NSArray a = (NSArray)d.ObjectForKey("array");
DateTimeKind.Utc).ToLocalTime()));
Assert.True(ArrayEquals(((NSData)d.ObjectForKey("data")).Bytes, new byte[]
{
0x00, 0x00, 0x00, 0x04, 0x10, 0x41, 0x08, 0x20, 0x82
}));
var a = (NSArray)d.ObjectForKey("array");
Assert.True(a.Count == 4);
Assert.True(a[0].Equals(new NSNumber(true)));
Assert.True(a[1].Equals(new NSNumber(false)));
@@ -160,9 +166,9 @@ namespace plistcil.test
[Fact]
public static void TestGnuStepASCIIWriting()
{
FileInfo inf = new FileInfo("test-files/test1.plist");
FileInfo outf = new FileInfo("test-files/out-test1-ascii-gnustep.plist");
NSDictionary x = (NSDictionary)PropertyListParser.Parse(inf);
var inf = new FileInfo("test-files/test1.plist");
var outf = new FileInfo("test-files/out-test1-ascii-gnustep.plist");
var x = (NSDictionary)PropertyListParser.Parse(inf);
PropertyListParser.SaveAsGnuStepASCII(x, outf);
NSObject y = PropertyListParser.Parse(outf);
Assert.True(x.Equals(y));
@@ -171,84 +177,99 @@ namespace plistcil.test
[Fact]
public static void TestWrap()
{
bool bl = true;
byte byt = 24;
short shrt = 12;
int i = 42;
long lng = 30000000000L;
float flt = 124.3f;
double dbl = 32.0;
DateTime date = new DateTime();
string strg = "Hello World";
byte[] bytes = {0x00, 0xAF, 0xAF};
object[] array = {bl, byt, shrt, i, lng, flt, dbl, date, strg, bytes};
int[] array2 = {1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 3000};
List<object> list = new List<object>(array);
bool bl = true;
byte byt = 24;
short shrt = 12;
int i = 42;
long lng = 30000000000L;
float flt = 124.3f;
double dbl = 32.0;
var date = new DateTime();
string strg = "Hello World";
Dictionary<string, object> map = new Dictionary<string, object>();
map.Add("int", i);
byte[] bytes =
{
0x00, 0xAF, 0xAF
};
object[] array =
{
bl, byt, shrt, i, lng, flt, dbl, date, strg, bytes
};
int[] array2 =
{
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 3000
};
List<object> list = new(array);
Dictionary<string, object> map = new();
map.Add("int", i);
map.Add("long", lng);
map.Add("date", date);
NSObject WrappedO = NSObject.Wrap((object)bl);
Assert.True(WrappedO.GetType().Equals(typeof(NSNumber)));
var WrappedO = NSObject.Wrap((object)bl);
Assert.True(WrappedO is (NSNumber));
Assert.True(WrappedO.ToObject().Equals(bl));
WrappedO = NSObject.Wrap((object)byt);
Assert.True(WrappedO.GetType().Equals(typeof(NSNumber)));
Assert.True(WrappedO is (NSNumber));
Assert.True((int)WrappedO.ToObject() == byt);
WrappedO = NSObject.Wrap((object)shrt);
Assert.True(WrappedO.GetType().Equals(typeof(NSNumber)));
Assert.True(WrappedO is (NSNumber));
Assert.True((int)WrappedO.ToObject() == shrt);
WrappedO = NSObject.Wrap((object)i);
Assert.True(WrappedO.GetType().Equals(typeof(NSNumber)));
Assert.True(WrappedO is (NSNumber));
Assert.True((int)WrappedO.ToObject() == i);
WrappedO = NSObject.Wrap((object)lng);
Assert.True(WrappedO.GetType().Equals(typeof(NSNumber)));
Assert.True(WrappedO is (NSNumber));
Assert.True((long)WrappedO.ToObject() == lng);
WrappedO = NSObject.Wrap((object)flt);
Assert.True(WrappedO.GetType().Equals(typeof(NSNumber)));
Assert.True(WrappedO is (NSNumber));
Assert.True((double)WrappedO.ToObject() == flt);
WrappedO = NSObject.Wrap((object)dbl);
Assert.True(WrappedO.GetType().Equals(typeof(NSNumber)));
Assert.True(WrappedO is (NSNumber));
Assert.True((double)WrappedO.ToObject() == dbl);
WrappedO = NSObject.Wrap(date);
Assert.True(WrappedO.GetType().Equals(typeof(NSDate)));
Assert.True(WrappedO is (NSDate));
Assert.True(((DateTime)WrappedO.ToObject()).Equals(date));
WrappedO = NSObject.Wrap(strg);
Assert.True(WrappedO.GetType().Equals(typeof(NSString)));
Assert.True(WrappedO is (NSString));
Assert.Equal((string)WrappedO.ToObject(), strg);
WrappedO = NSObject.Wrap((object)bytes);
Assert.True(WrappedO.GetType().Equals(typeof(NSData)));
Assert.True(WrappedO is (NSData));
byte[] data = (byte[])WrappedO.ToObject();
Assert.True(data.Length == bytes.Length);
for(int x = 0; x < bytes.Length; x++) Assert.True(data[x] == bytes[x]);
for(int x = 0; x < bytes.Length; x++)
Assert.True(data[x] == bytes[x]);
WrappedO = NSObject.Wrap((object)array);
Assert.True(WrappedO.GetType().Equals(typeof(NSArray)));
Assert.True(WrappedO is (NSArray));
object[] objArray = (object[])WrappedO.ToObject();
Assert.True(objArray.Length == array.Length);
WrappedO = NSObject.Wrap(array2);
Assert.True(WrappedO.GetType().Equals(typeof(NSArray)));
Assert.True(WrappedO is (NSArray));
Assert.True(((NSArray)WrappedO).Count == array2.Length);
WrappedO = NSObject.Wrap((object)list);
Assert.True(WrappedO.GetType().Equals(typeof(NSArray)));
Assert.True(WrappedO is (NSArray));
objArray = (object[])WrappedO.ToObject();
Assert.True(objArray.Length == array.Length);
WrappedO = NSObject.Wrap((object)map);
Assert.True(WrappedO.GetType().Equals(typeof(NSDictionary)));
NSDictionary dict = (NSDictionary)WrappedO;
Assert.True(WrappedO is (NSDictionary));
var dict = (NSDictionary)WrappedO;
Assert.True(((NSNumber)dict.ObjectForKey("int")).ToLong() == i);
Assert.True(((NSNumber)dict.ObjectForKey("long")).ToLong() == lng);
Assert.True(((NSDate)dict.ObjectForKey("date")).Date.Equals(date));
@@ -272,17 +293,22 @@ namespace plistcil.test
NSObject x = PropertyListParser.Parse(new FileInfo("test-files/test1.plist"));
// check the data in it
NSDictionary d = (NSDictionary)x;
var d = (NSDictionary)x;
Assert.True(d.Count == 5);
Assert.Equal("valueA", ((NSString)d.ObjectForKey("keyA")).ToString());
Assert.Equal("valueA", ((NSString)d.ObjectForKey("keyA")).ToString());
Assert.Equal("value&B", ((NSString)d.ObjectForKey("key&B")).ToString());
Assert.True(((NSDate)d.ObjectForKey("date")).Date.Equals(new DateTime(2011, 11, 28, 10, 21, 30,
DateTimeKind.Utc)) ||
DateTimeKind.Utc)) ||
((NSDate)d.ObjectForKey("date")).Date.Equals(new DateTime(2011, 11, 28, 9, 21, 30,
DateTimeKind.Utc)));
Assert.True(ArrayEquals(((NSData)d.ObjectForKey("data")).Bytes,
new byte[] {0x00, 0x00, 0x00, 0x04, 0x10, 0x41, 0x08, 0x20, 0x82}));
NSArray a = (NSArray)d.ObjectForKey("array");
DateTimeKind.Utc)));
Assert.True(ArrayEquals(((NSData)d.ObjectForKey("data")).Bytes, new byte[]
{
0x00, 0x00, 0x00, 0x04, 0x10, 0x41, 0x08, 0x20, 0x82
}));
var a = (NSArray)d.ObjectForKey("array");
Assert.True(a.Count == 4);
Assert.True(a[0].Equals(new NSNumber(true)));
Assert.True(a[1].Equals(new NSNumber(false)));

10
plist-cil.test/PropertyListParserTests.cs
View File

@@ -8,13 +8,13 @@ namespace plistcil.test
{
static void ParseEmptyStreamTestDelegate()
{
using(MemoryStream stream = new MemoryStream()) PropertyListParser.Parse(stream);
using var stream = new MemoryStream();
PropertyListParser.Parse(stream);
}
[Fact]
public static void ParseEmptyStreamTest()
{
Assert.Throws<PropertyListFormatException>(() => ParseEmptyStreamTestDelegate());
}
public static void ParseEmptyStreamTest() =>
Assert.Throws<PropertyListFormatException>(ParseEmptyStreamTestDelegate);
}
}

91
plist-cil.test/UIDTests.cs
View File

@@ -6,83 +6,120 @@ namespace plistcil.test
{
public class UIDTests
{
[Theory]
[InlineData(new byte[] {0xAB})]
[InlineData(new byte[] {0xAB, 0xCD})]
[InlineData(new byte[] {0xAB, 0xCD, 0xEF, 0xFE})]
[InlineData(new byte[] {0xAB, 0xCD, 0xEF, 0xFE, 0xFE, 0xEF, 0xCD, 0xAB})]
[Theory, InlineData(new byte[]
{
0xAB
}), InlineData(new byte[]
{
0xAB, 0xCD
}), InlineData(new byte[]
{
0xAB, 0xCD, 0xEF, 0xFE
}), InlineData(new byte[]
{
0xAB, 0xCD, 0xEF, 0xFE, 0xFE, 0xEF, 0xCD, 0xAB
})]
public void UidFromArrayTest(byte[] array)
{
UID uid = new UID(array);
var uid = new UID(array);
Assert.Equal(array, uid.Bytes);
}
[Fact]
public void BinaryRoundTripTest()
{
UID original = new UID(0xabcd);
var original = new UID(0xabcd);
using(MemoryStream stream = new MemoryStream())
{
BinaryPropertyListWriter.Write(stream, original);
stream.Position = 0;
UID roundtrip = BinaryPropertyListParser.Parse(stream) as UID;
Assert.Equal(original.Bytes, roundtrip.Bytes);
}
using var stream = new MemoryStream();
BinaryPropertyListWriter.Write(stream, original);
stream.Position = 0;
var roundtrip = BinaryPropertyListParser.Parse(stream) as UID;
Assert.Equal(original.Bytes, roundtrip.Bytes);
}
[Fact]
public void ByteUidTest()
{
UID uid = new UID(0xAB);
Assert.Equal(new byte[] {0xAB}, uid.Bytes);
var uid = new UID(0xAB);
Assert.Equal(new byte[]
{
0xAB
}, uid.Bytes);
Assert.Equal(0xABu, uid.ToUInt64());
}
[Fact]
public void IntUidTest()
{
UID uid = new UID(0xABCDEF00);
Assert.Equal(new byte[] {0xAB, 0xCD, 0xEF, 0x00}, uid.Bytes);
var uid = new UID(0xABCDEF00);
Assert.Equal(new byte[]
{
0xAB, 0xCD, 0xEF, 0x00
}, uid.Bytes);
Assert.Equal(0xABCDEF00, uid.ToUInt64());
}
[Fact]
public void LongUidTest()
{
UID uid = new UID(0xABCDEF0000EFCDAB);
Assert.Equal(new byte[] {0xAB, 0xCD, 0xEF, 0x00, 0x00, 0xEF, 0xCD, 0xAB}, uid.Bytes);
var uid = new UID(0xABCDEF0000EFCDAB);
Assert.Equal(new byte[]
{
0xAB, 0xCD, 0xEF, 0x00, 0x00, 0xEF, 0xCD, 0xAB
}, uid.Bytes);
Assert.Equal(0xABCDEF0000EFCDAB, uid.ToUInt64());
}
[Fact]
public void UIntUidTest()
{
UID uid = new UID(0xABCDEF00u);
Assert.Equal(new byte[] {0xAB, 0xCD, 0xEF, 0x00}, uid.Bytes);
var uid = new UID(0xABCDEF00u);
Assert.Equal(new byte[]
{
0xAB, 0xCD, 0xEF, 0x00
}, uid.Bytes);
Assert.Equal(0xABCDEF00u, uid.ToUInt64());
}
[Fact]
public void ULongUidTest()
{
UID uid = new UID(0xABCDEF0000EFCDABu);
Assert.Equal(new byte[] {0xAB, 0xCD, 0xEF, 0x00, 0x00, 0xEF, 0xCD, 0xAB}, uid.Bytes);
var uid = new UID(0xABCDEF0000EFCDABu);
Assert.Equal(new byte[]
{
0xAB, 0xCD, 0xEF, 0x00, 0x00, 0xEF, 0xCD, 0xAB
}, uid.Bytes);
Assert.Equal(0xABCDEF0000EFCDABu, uid.ToUInt64());
}
[Fact]
public void UShortUidTest()
{
UID uid = new UID(0xABCDu);
Assert.Equal(new byte[] {0xAB, 0xCD}, uid.Bytes);
var uid = new UID(0xABCDu);
Assert.Equal(new byte[]
{
0xAB, 0xCD
}, uid.Bytes);
Assert.Equal(0xABCDu, uid.ToUInt64());
}
[Fact]
public void XmlRoundTripTest()
{
UID original = new UID(0xabcd);
var original = new UID(0xabcd);
string plist = original.ToXmlPropertyList();

45
plist-cil.test/UseCultureAttribute.cs
View File

@@ -5,9 +5,8 @@ using System.Threading;
using Xunit.Sdk;
/// <summary>
/// Apply this attribute to your test method to replace the
/// <see cref="Thread.CurrentThread" /> <see cref="CultureInfo.CurrentCulture" /> and
/// <see cref="CultureInfo.CurrentUICulture" /> with another culture.
/// Apply this attribute to your test method to replace the <see cref="Thread.CurrentThread" />
/// <see cref="CultureInfo.CurrentCulture" /> and <see cref="CultureInfo.CurrentUICulture" /> with another culture.
/// </summary>
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method)]
public class UseCultureAttribute : BeforeAfterTestAttribute
@@ -18,22 +17,19 @@ public class UseCultureAttribute : BeforeAfterTestAttribute
CultureInfo originalCulture;
CultureInfo originalUICulture;
/// <summary>
/// Replaces the culture and UI culture of the current thread with
/// <paramref name="culture" />
/// </summary>
/// <summary>Replaces the culture and UI culture of the current thread with <paramref name="culture" /></summary>
/// <param name="culture">The name of the culture.</param>
/// <remarks>
/// <para>
/// This constructor overload uses <paramref name="culture" /> for both
/// <see cref="Culture" /> and <see cref="UICulture" />.
/// This constructor overload uses <paramref name="culture" /> for both <see cref="Culture" /> and
/// <see cref="UICulture" />.
/// </para>
/// </remarks>
public UseCultureAttribute(string culture) : this(culture, culture) { }
public UseCultureAttribute(string culture) : this(culture, culture) {}
/// <summary>
/// Replaces the culture and UI culture of the current thread with
/// <paramref name="culture" /> and <paramref name="uiCulture" />
/// Replaces the culture and UI culture of the current thread with <paramref name="culture" /> and
/// <paramref name="uiCulture" />
/// </summary>
/// <param name="culture">The name of the culture.</param>
/// <param name="uiCulture">The name of the UI culture.</param>
@@ -43,37 +39,32 @@ public class UseCultureAttribute : BeforeAfterTestAttribute
this.uiCulture = new Lazy<CultureInfo>(() => new CultureInfo(uiCulture));
}
/// <summary>
/// Gets the culture.
/// </summary>
/// <summary>Gets the culture.</summary>
public CultureInfo Culture => culture.Value;
/// <summary>
/// Gets the UI culture.
/// </summary>
/// <summary>Gets the UI culture.</summary>
public CultureInfo UICulture => uiCulture.Value;
/// <summary>
/// Stores the current <see cref="Thread.CurrentPrincipal" />
/// <see cref="CultureInfo.CurrentCulture" /> and <see cref="CultureInfo.CurrentUICulture" />
/// and replaces them with the new cultures defined in the constructor.
/// Stores the current <see cref="Thread.CurrentPrincipal" /> <see cref="CultureInfo.CurrentCulture" /> and
/// <see cref="CultureInfo.CurrentUICulture" /> and replaces them with the new cultures defined in the constructor.
/// </summary>
/// <param name="methodUnderTest">The method under test</param>
public override void Before(MethodInfo methodUnderTest)
{
#if NETCORE
#if NETCORE
originalCulture = CultureInfo.CurrentCulture;
originalUICulture = CultureInfo.CurrentUICulture;
CultureInfo.CurrentCulture = Culture;
CultureInfo.CurrentUICulture = Culture;
#else
#else
originalCulture = Thread.CurrentThread.CurrentCulture;
originalUICulture = Thread.CurrentThread.CurrentUICulture;
Thread.CurrentThread.CurrentCulture = Culture;
Thread.CurrentThread.CurrentUICulture = UICulture;
#endif
#endif
}
/// <summary>
@@ -83,12 +74,12 @@ public class UseCultureAttribute : BeforeAfterTestAttribute
/// <param name="methodUnderTest">The method under test</param>
public override void After(MethodInfo methodUnderTest)
{
#if NETCORE
#if NETCORE
CultureInfo.CurrentCulture = originalCulture;
CultureInfo.CurrentUICulture = originalUICulture;
#else
#else
Thread.CurrentThread.CurrentCulture = originalCulture;
Thread.CurrentThread.CurrentUICulture = originalUICulture;
#endif
#endif
}
}

47
plist-cil.test/ValidatingStream.cs
View File

@@ -15,20 +15,14 @@ namespace plistcil.test
/// A <see cref="Stream" /> which writes its output to a <see cref="Stream" /> and validates that the data which
/// is being written to the output stream matches the data in a reference stream.
/// </summary>
class ValidatingStream : Stream
internal class ValidatingStream : Stream
{
Stream expectedOutput;
Stream output;
readonly Stream expectedOutput;
readonly Stream output;
/// <summary>
/// Initializes a new instance of the <see cref="ValidatingCompositeStream" /> class.
/// </summary>
/// <param name="output">
/// The <see cref="Stream" /> to which to write data.
/// </param>
/// <param name="expectedOutput">
/// The reference stream for <paramref name="output" />.
/// </param>
/// <summary>Initializes a new instance of the <see cref="ValidatingCompositeStream" /> class.</summary>
/// <param name="output">The <see cref="Stream" /> to which to write data.</param>
/// <param name="expectedOutput">The reference stream for <paramref name="output" />.</param>
public ValidatingStream(Stream output, Stream expectedOutput)
{
this.output = output ?? throw new ArgumentNullException(nameof(output));
@@ -55,34 +49,21 @@ namespace plistcil.test
}
/// <inheritdoc />
public override void Flush()
{
output.Flush();
}
public override void Flush() => output.Flush();
/// <inheritdoc />
public override int Read(byte[] buffer, int offset, int count)
{
public override int Read(byte[] buffer, int offset, int count) => throw new NotSupportedException();
/// <inheritdoc />
public override Task<int>
ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken) =>
throw new NotSupportedException();
}
/// <inheritdoc />
public override Task<int> ReadAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
{
throw new NotSupportedException();
}
public override long Seek(long offset, SeekOrigin origin) => throw new NotImplementedException();
/// <inheritdoc />
public override long Seek(long offset, SeekOrigin origin)
{
throw new NotImplementedException();
}
/// <inheritdoc />
public override void SetLength(long value)
{
throw new NotImplementedException();
}
public override void SetLength(long value) => throw new NotImplementedException();
/// <inheritdoc />
public override void Write(byte[] buffer, int offset, int count)

599
plist-cil/ASCIIPropertyListParser.cs
View File

@@ -33,170 +33,95 @@ namespace Claunia.PropertyList
{
/// <summary>
/// <para>
/// Parser for ASCII property lists. Supports Apple OS X/iOS and GnuStep/NeXTSTEP format.
/// This parser is based on the recursive descent paradigm, but the underlying grammar
/// is not explicitely defined.
/// </para>
/// <para>
/// Resources on ASCII property list format:
/// </para>
/// <para>
/// https://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/PropertyLists/OldStylePlists/OldStylePLists.html
/// </para>
/// <para>
/// Property List Programming Guide - Old-Style ASCII Property Lists
/// </para>
/// <para>
/// http://www.gnustep.org/resources/documentation/Developer/Base/Reference/NSPropertyList.html
/// </para>
/// <para>
/// GnuStep - NSPropertyListSerialization class documentation
/// Parser for ASCII property lists. Supports Apple OS X/iOS and GnuStep/NeXTSTEP format. This parser is based on
/// the recursive descent paradigm, but the underlying grammar is not explicitly defined.
/// </para>
/// <para>Resources on ASCII property list format:</para>
/// <para>https://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/PropertyLists/OldStylePlists/OldStylePLists.html</para>
/// <para>Property List Programming Guide - Old-Style ASCII Property Lists</para>
/// <para>http://www.gnustep.org/resources/documentation/Developer/Base/Reference/NSPropertyList.html</para>
/// <para>GnuStep - NSPropertyListSerialization class documentation</para>
/// </summary>
/// @author Daniel Dreibrodt
/// @author Natalia Portillo
public class ASCIIPropertyListParser
{
/// <summary>
/// A space
/// </summary>
/// <summary>A space</summary>
public const char WHITESPACE_SPACE = ' ';
/// <summary>
/// A tabulator
/// </summary>
/// <summary>A tabulator</summary>
public const char WHITESPACE_TAB = '\t';
/// <summary>
/// A newline
/// </summary>
/// <summary>A newline</summary>
public const char WHITESPACE_NEWLINE = '\n';
/// <summary>
/// A carriage return
/// </summary>
/// <summary>A carriage return</summary>
public const char WHITESPACE_CARRIAGE_RETURN = '\r';
/// <summary>
/// Token of NSArray start
/// </summary>
/// <summary>Token of NSArray start</summary>
public const char ARRAY_BEGIN_TOKEN = '(';
/// <summary>
/// Token of NSArray end
/// </summary>
/// <summary>Token of NSArray end</summary>
public const char ARRAY_END_TOKEN = ')';
/// <summary>
/// Token of NSArray item delimiter
/// </summary>
/// <summary>Token of NSArray item delimiter</summary>
public const char ARRAY_ITEM_DELIMITER_TOKEN = ',';
/// <summary>
/// Token of NSDictionary start
/// </summary>
/// <summary>Token of NSDictionary start</summary>
public const char DICTIONARY_BEGIN_TOKEN = '{';
/// <summary>
/// Token of NSDictionary end
/// </summary>
/// <summary>Token of NSDictionary end</summary>
public const char DICTIONARY_END_TOKEN = '}';
/// <summary>
/// Token of NSDictionary assignment
/// </summary>
/// <summary>Token of NSDictionary assignment</summary>
public const char DICTIONARY_ASSIGN_TOKEN = '=';
/// <summary>
/// Token of NSDictionary item delimiter
/// </summary>
/// <summary>Token of NSDictionary item delimiter</summary>
public const char DICTIONARY_ITEM_DELIMITER_TOKEN = ';';
/// <summary>
/// Token of quoted NSString start
/// </summary>
/// <summary>Token of quoted NSString start</summary>
public const char QUOTEDSTRING_BEGIN_TOKEN = '"';
/// <summary>
/// Token of quoted NSString end
/// </summary>
/// <summary>Token of quoted NSString end</summary>
public const char QUOTEDSTRING_END_TOKEN = '"';
/// <summary>
/// Token of quoted NSString escaped character
/// </summary>
/// <summary>Token of quoted NSString escaped character</summary>
public const char QUOTEDSTRING_ESCAPE_TOKEN = '\\';
/// <summary>
/// Token of NSData start
/// </summary>
/// <summary>Token of NSData start</summary>
public const char DATA_BEGIN_TOKEN = '<';
/// <summary>
/// Token of NSData end
/// </summary>
/// <summary>Token of NSData end</summary>
public const char DATA_END_TOKEN = '>';
/// <summary>
/// Token of GSObject start
/// </summary>
/// <summary>Token of GSObject start</summary>
public const char DATA_GSOBJECT_BEGIN_TOKEN = '*';
/// <summary>
/// Token of GSDate start
/// </summary>
/// <summary>Token of GSDate start</summary>
public const char DATA_GSDATE_BEGIN_TOKEN = 'D';
/// <summary>
/// Token of GSBoolean start
/// </summary>
/// <summary>Token of GSBoolean start</summary>
public const char DATA_GSBOOL_BEGIN_TOKEN = 'B';
/// <summary>
/// Token for GSBoolen's <c>true</c>
/// </summary>
/// <summary>Token for GSBoolen's <c>true</c></summary>
public const char DATA_GSBOOL_TRUE_TOKEN = 'Y';
/// <summary>
/// Token for GSBoolen's <c>false</c>
/// </summary>
/// <summary>Token for GSBoolen's <c>false</c></summary>
public const char DATA_GSBOOL_FALSE_TOKEN = 'N';
/// <summary>
/// Token for GSInteger
/// </summary>
/// <summary>Token for GSInteger</summary>
public const char DATA_GSINT_BEGIN_TOKEN = 'I';
/// <summary>
/// Token for GSReal
/// </summary>
/// <summary>Token for GSReal</summary>
public const char DATA_GSREAL_BEGIN_TOKEN = 'R';
/// <summary>
/// Token for NSDate date field delimited
/// </summary>
/// <summary>Token for NSDate date field delimited</summary>
public const char DATE_DATE_FIELD_DELIMITER = '-';
/// <summary>
/// Token for NSDate time field delimiter
/// </summary>
/// <summary>Token for NSDate time field delimiter</summary>
public const char DATE_TIME_FIELD_DELIMITER = ':';
/// <summary>
/// Token for GSDate date and time delimiter
/// </summary>
/// <summary>Token for GSDate date and time delimiter</summary>
public const char DATE_GS_DATE_TIME_DELIMITER = ' ';
/// <summary>
/// Token for NSDate date and time delimiter
/// </summary>
/// <summary>Token for NSDate date and time delimiter</summary>
public const char DATE_APPLE_DATE_TIME_DELIMITER = 'T';
/// <summary>
/// Token for NSDate end
/// </summary>
/// <summary>Token for NSDate end</summary>
public const char DATE_APPLE_END_TOKEN = 'Z';
/// <summary>
/// Token for comment start
/// </summary>
/// <summary>Token for comment start</summary>
public const char COMMENT_BEGIN_TOKEN = '/';
/// <summary>
/// Second token for multiline comment
/// </summary>
/// <summary>Second token for multiline comment</summary>
public const char MULTILINE_COMMENT_SECOND_TOKEN = '*';
/// <summary>
/// Second token for singleline comment
/// </summary>
/// <summary>Second token for singleline comment</summary>
public const char SINGLELINE_COMMENT_SECOND_TOKEN = '/';
/// <summary>
/// End token for multiline comment
/// </summary>
/// <summary>End token for multiline comment</summary>
public const char MULTILINE_COMMENT_END_TOKEN = '/';
/**
* Property list source data
*/
char[] data;
readonly char[] data;
/**
* Current parsing index
*/
@@ -205,32 +130,20 @@ namespace Claunia.PropertyList
/**
* Only allow subclasses to change instantiation.
*/
protected ASCIIPropertyListParser() { }
protected ASCIIPropertyListParser() {}
/// <summary>
/// Creates a new parser for the given property list content.
/// </summary>
/// <summary>Creates a new parser for the given property list content.</summary>
/// <param name="propertyListContent">The content of the property list that is to be parsed.</param>
ASCIIPropertyListParser(char[] propertyListContent)
{
data = propertyListContent;
}
ASCIIPropertyListParser(char[] propertyListContent) => data = propertyListContent;
/// <summary>
/// Parses an ASCII property list file.
/// </summary>
/// <summary>Parses an ASCII property list file.</summary>
/// <param name="f">The ASCII property list file..</param>
/// <returns>The root object of the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
/// <exception cref="FormatException">When an error occurs during parsing.</exception>
/// <exception cref="IOException">When an error occured while reading from the input stream.</exception>
public static NSObject Parse(FileInfo f)
{
return Parse(f.OpenRead());
}
public static NSObject Parse(FileInfo f) => Parse(f.OpenRead());
/// <summary>
/// Parses an ASCII property list from an input stream.
/// </summary>
/// <summary>Parses an ASCII property list from an input stream.</summary>
/// <param name="fs">The input stream that points to the property list's data.</param>
/// <returns>The root object of the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
/// <exception cref="FormatException">When an error occurs during parsing.</exception>
@@ -238,65 +151,51 @@ namespace Claunia.PropertyList
public static NSObject Parse(Stream fs)
{
byte[] buf = PropertyListParser.ReadAll(fs);
// Don't close the stream - that would be the responisibility of code that class
// Don't close the stream - that would be the responsibility of code that class
// Parse
return Parse(buf);
}
/// <summary>
/// Parses an ASCII property list from a byte array.
/// </summary>
/// <summary>Parses an ASCII property list from a byte array.</summary>
/// <param name="bytes">The ASCII property list data.</param>
/// <returns>The root object of the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
/// <exception cref="FormatException">When an error occurs during parsing.</exception>
public static NSObject Parse(byte[] bytes)
{
return Parse(bytes.AsSpan());
}
public static NSObject Parse(byte[] bytes) => Parse(bytes.AsSpan());
/// <summary>
/// Parses an ASCII property list from a byte array.
/// </summary>
/// <summary>Parses an ASCII property list from a byte array.</summary>
/// <param name="bytes">The ASCII property list data.</param>
/// <param name="count">The offset at which to start reading the property list.</param>
/// <param name="offset">The length of the property list.</param>
/// <returns>The root object of the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
/// <exception cref="FormatException">When an error occurs during parsing.</exception>
public static NSObject Parse(byte[] bytes, int offset, int count)
{
return Parse(bytes.AsSpan(offset, count));
}
public static NSObject Parse(byte[] bytes, int offset, int count) => Parse(bytes.AsSpan(offset, count));
/// <summary>
/// Parses an ASCII property list from a byte span.
/// </summary>
/// <summary>Parses an ASCII property list from a byte span.</summary>
/// <param name="bytes">The ASCII property list data.</param>
/// <returns>The root object of the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
/// <exception cref="FormatException">When an error occurs during parsing.</exception>
public static NSObject Parse(ReadOnlySpan<byte> bytes)
{
#if NATIVE_SPAN
#if NATIVE_SPAN
return ParseString(Encoding.UTF8.GetString(bytes));
#else
#else
return ParseString(Encoding.UTF8.GetString(bytes.ToArray()));
#endif
#endif
}
/// <summary>
/// Parses an ASCII property list from a string.
/// </summary>
/// <summary>Parses an ASCII property list from a string.</summary>
/// <param name="value">The ASCII property list data.</param>
/// <returns>The root object of the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
/// <exception cref="FormatException">When an error occurs during parsing.</exception>
public static NSObject ParseString(string value)
{
ASCIIPropertyListParser parser = new ASCIIPropertyListParser(value.ToCharArray());
var parser = new ASCIIPropertyListParser(value.ToCharArray());
return parser.Parse();
}
/// <summary>
/// Checks whether the given sequence of symbols can be accepted.
/// </summary>
/// <summary>Checks whether the given sequence of symbols can be accepted.</summary>
/// <returns>Whether the given tokens occur at the current parsing position.</returns>
/// <param name="sequence">The sequence of tokens to look for.</param>
bool AcceptSequence(params char[] sequence)
@@ -309,61 +208,57 @@ namespace Claunia.PropertyList
}
/// <summary>
/// Checks whether the given symbols can be accepted, that is, if one
/// of the given symbols is found at the current parsing position.
/// Checks whether the given symbols can be accepted, that is, if one of the given symbols is found at the current
/// parsing position.
/// </summary>
/// <param name="acceptableSymbols">The symbols to check.</param>
/// <returns>Whether one of the symbols can be accepted or not.</returns>
bool Accept(params char[] acceptableSymbols)
{
bool symbolPresent = false;
foreach(char c in acceptableSymbols) symbolPresent |= data[index] == c;
bool symbolPresent = false;
foreach(char c in acceptableSymbols)
symbolPresent |= data[index] == c;
return symbolPresent;
}
/// <summary>
/// Checks whether the given symbol can be accepted, that is, if
/// the given symbols is found at the current parsing position.
/// Checks whether the given symbol can be accepted, that is, if the given symbols is found at the current parsing
/// position.
/// </summary>
/// <param name="acceptableSymbol">The symbol to check.</param>
/// <returns>Whether the symbol can be accepted or not.</returns>
bool Accept(char acceptableSymbol)
{
return data[index] == acceptableSymbol;
}
bool Accept(char acceptableSymbol) => data[index] == acceptableSymbol;
/// <summary>
/// Expects the input to have one of the given symbols at the current parsing position.
/// </summary>
/// <summary>Expects the input to have one of the given symbols at the current parsing position.</summary>
/// <param name="expectedSymbols">The expected symbols.</param>
/// <exception cref="FormatException">If none of the expected symbols could be found.</exception>
void Expect(params char[] expectedSymbols)
{
if(!Accept(expectedSymbols))
{
string excString = "Expected '" + expectedSymbols[0] + "'";
for(int i = 1; i < expectedSymbols.Length; i++) excString += " or '" + expectedSymbols[i] + "'";
if(Accept(expectedSymbols))
return;
excString += " but found '" + data[index] + "'";
throw new FormatException(string.Format("{0} at {1}", excString, index));
}
string excString = "Expected '" + expectedSymbols[0] + "'";
for(int i = 1; i < expectedSymbols.Length; i++)
excString += " or '" + expectedSymbols[i] + "'";
excString += " but found '" + data[index] + "'";
throw new FormatException($"{excString} at {index}");
}
/// <summary>
/// Expects the input to have the given symbol at the current parsing position.
/// </summary>
/// <summary>Expects the input to have the given symbol at the current parsing position.</summary>
/// <param name="expectedSymbol">The expected symbol.</param>
/// <exception cref="FormatException">If the expected symbol could be found.</exception>
void Expect(char expectedSymbol)
{
if(!Accept(expectedSymbol))
throw new FormatException(string.Format("Expected '{0}' but found '{1}' at {2}", expectedSymbol,
data[index], index));
throw new FormatException($"Expected '{expectedSymbol}' but found '{data[index]}' at {index}");
}
/// <summary>
/// Reads an expected symbol.
/// </summary>
/// <summary>Reads an expected symbol.</summary>
/// <param name="symbol">The symbol to read.</param>
/// <exception cref="FormatException">If the expected symbol could not be read.</exception>
void Read(char symbol)
@@ -375,19 +270,11 @@ namespace Claunia.PropertyList
/**
* Skips the current symbol.
*/
void Skip()
{
index++;
}
void Skip() => index++;
/// <summary>
/// Skips several symbols
/// </summary>
/// <summary>Skips several symbols</summary>
/// <param name="numSymbols">The amount of symbols to skip.</param>
void Skip(int numSymbols)
{
index += numSymbols;
}
void Skip(int numSymbols) => index += numSymbols;
/**
* Skips all whitespaces and comments from the current parsing position onward.
@@ -395,12 +282,14 @@ namespace Claunia.PropertyList
void SkipWhitespacesAndComments()
{
bool commentSkipped;
do
{
commentSkipped = false;
//Skip whitespaces
while(Accept(WHITESPACE_CARRIAGE_RETURN, WHITESPACE_NEWLINE, WHITESPACE_SPACE, WHITESPACE_TAB)) Skip();
while(Accept(WHITESPACE_CARRIAGE_RETURN, WHITESPACE_NEWLINE, WHITESPACE_SPACE, WHITESPACE_TAB))
Skip();
//Skip single line comments "//..."
if(AcceptSequence(COMMENT_BEGIN_TOKEN, SINGLELINE_COMMENT_SECOND_TOKEN))
@@ -409,15 +298,18 @@ namespace Claunia.PropertyList
ReadInputUntil(WHITESPACE_CARRIAGE_RETURN, WHITESPACE_NEWLINE);
commentSkipped = true;
}
//Skip multi line comments "/* ... */"
else if(AcceptSequence(COMMENT_BEGIN_TOKEN, MULTILINE_COMMENT_SECOND_TOKEN))
{
Skip(2);
while(true)
{
if(AcceptSequence(MULTILINE_COMMENT_SECOND_TOKEN, MULTILINE_COMMENT_END_TOKEN))
{
Skip(2);
break;
}
@@ -426,19 +318,17 @@ namespace Claunia.PropertyList
commentSkipped = true;
}
}
while(commentSkipped
); //if a comment was skipped more whitespace or another comment can follow, so skip again
} while(
commentSkipped); //if a comment was skipped more whitespace or another comment can follow, so skip again
}
/// <summary>
/// Reads input until one of the given symbols is found.
/// </summary>
/// <summary>Reads input until one of the given symbols is found.</summary>
/// <returns>The input until one the given symbols.</returns>
/// <param name="symbols">The symbols that can occur after the string to read.</param>
string ReadInputUntil(params char[] symbols)
{
string s = "";
while(!Accept(symbols))
{
s += data[index];
@@ -448,14 +338,13 @@ namespace Claunia.PropertyList
return s;
}
/// <summary>
/// Reads input until the given symbol is found.
/// </summary>
/// <summary>Reads input until the given symbol is found.</summary>
/// <returns>The input until the given symbol.</returns>
/// <param name="symbol">The symbol that can occur after the string to read.</param>
string ReadInputUntil(char symbol)
{
string s = "";
while(!Accept(symbol))
{
s += data[index];
@@ -465,46 +354,63 @@ namespace Claunia.PropertyList
return s;
}
/// <summary>
/// Parses the property list from the beginning and returns the root object
/// of the property list.
/// </summary>
/// <summary>Parses the property list from the beginning and returns the root object of the property list.</summary>
/// <returns>The root object of the property list. This can either be a NSDictionary or a NSArray.</returns>
/// <exception cref="FormatException">When an error occured during parsing</exception>
public NSObject Parse()
{
index = 0;
//Skip Unicode byte order mark (BOM)
if(data.Length >= 3 && (data[0] & 0xFF) == 0xEF && (data[1] & 0xFF) == 0xBB &&
(data[2] & 0xFF) == 0xBF) Skip(3);
if(data.Length >= 3 &&
(data[0] & 0xFF) == 0xEF &&
(data[1] & 0xFF) == 0xBB &&
(data[2] & 0xFF) == 0xBF)
Skip(3);
SkipWhitespacesAndComments();
Expect(DICTIONARY_BEGIN_TOKEN, ARRAY_BEGIN_TOKEN, COMMENT_BEGIN_TOKEN);
try { return ParseObject(); }
try
{
return ParseObject();
}
catch(IndexOutOfRangeException)
{
throw new FormatException(string.Format("Reached end of input unexpectedly at {0}.", index));
throw new FormatException($"Reached end of input unexpectedly at {index}.");
}
}
/// <summary>
/// Parses the NSObject found at the current position in the property list
/// data stream.
/// </summary>
/// <summary>Parses the NSObject found at the current position in the property list data stream.</summary>
/// <returns>The parsed NSObject.</returns>
/// <seealso cref="ASCIIPropertyListParser.index" />
NSObject ParseObject()
{
switch(data[index])
{
case ARRAY_BEGIN_TOKEN: { return ParseArray(); }
case DICTIONARY_BEGIN_TOKEN: { return ParseDictionary(); }
case DATA_BEGIN_TOKEN: { return ParseData(); }
case ARRAY_BEGIN_TOKEN:
{
return ParseArray();
}
case DICTIONARY_BEGIN_TOKEN:
{
return ParseDictionary();
}
case DATA_BEGIN_TOKEN:
{
return ParseData();
}
case QUOTEDSTRING_BEGIN_TOKEN:
{
string quotedString = ParseQuotedString();
//apple dates are quoted strings of length 20 and after the 4 year digits a dash is found
if(quotedString.Length == 20 && quotedString[4] == DATE_DATE_FIELD_DELIMITER)
try { return new NSDate(quotedString); }
if(quotedString.Length == 20 &&
quotedString[4] == DATE_DATE_FIELD_DELIMITER)
try
{
return new NSDate(quotedString);
}
catch(Exception)
{
//not a date? --> return string
@@ -516,18 +422,21 @@ namespace Claunia.PropertyList
default:
{
//0-9
if(data[index] > 0x2F && data[index] < 0x3A) return ParseDateString();
if(data[index] > 0x2F &&
data[index] < 0x3A)
return ParseDateString();
//non-numerical -> string or boolean
string parsedString = ParseString();
return new NSString(parsedString);
}
}
}
/// <summary>
/// Parses an array from the current parsing position.
/// The prerequisite for calling this method is, that an array begin token has been read.
/// Parses an array from the current parsing position. The prerequisite for calling this method is, that an array
/// begin token has been read.
/// </summary>
/// <returns>The array found at the parsing position.</returns>
NSArray ParseArray()
@@ -535,25 +444,30 @@ namespace Claunia.PropertyList
//Skip begin token
Skip();
SkipWhitespacesAndComments();
List<NSObject> objects = new List<NSObject>();
List<NSObject> objects = new();
while(!Accept(ARRAY_END_TOKEN))
{
objects.Add(ParseObject());
SkipWhitespacesAndComments();
if(Accept(ARRAY_ITEM_DELIMITER_TOKEN)) Skip();
else break; //must have reached end of array
if(Accept(ARRAY_ITEM_DELIMITER_TOKEN))
Skip();
else
break; //must have reached end of array
SkipWhitespacesAndComments();
}
//parse end token
Read(ARRAY_END_TOKEN);
return new NSArray(objects.ToArray());
}
/// <summary>
/// Parses a dictionary from the current parsing position.
/// The prerequisite for calling this method is, that a dictionary begin token has been read.
/// Parses a dictionary from the current parsing position. The prerequisite for calling this method is, that a
/// dictionary begin token has been read.
/// </summary>
/// <returns>The dictionary found at the parsing position.</returns>
NSDictionary ParseDictionary()
@@ -561,13 +475,15 @@ namespace Claunia.PropertyList
//Skip begin token
Skip();
SkipWhitespacesAndComments();
NSDictionary dict = new NSDictionary();
var dict = new NSDictionary();
while(!Accept(DICTIONARY_END_TOKEN))
{
//Parse key
string keyString;
if(Accept(QUOTEDSTRING_BEGIN_TOKEN)) keyString = ParseQuotedString();
else keyString = ParseString();
keyString = Accept(QUOTEDSTRING_BEGIN_TOKEN) ? ParseQuotedString() : ParseString();
SkipWhitespacesAndComments();
//Parse assign token
@@ -583,32 +499,40 @@ namespace Claunia.PropertyList
//skip end token
Skip();
return dict;
}
/// <summary>
/// Parses a data object from the current parsing position.
/// This can either be a NSData object or a GnuStep NSNumber or NSDate.
/// The prerequisite for calling this method is, that a data begin token has been read.
/// Parses a data object from the current parsing position. This can either be a NSData object or a GnuStep
/// NSNumber or NSDate. The prerequisite for calling this method is, that a data begin token has been read.
/// </summary>
/// <returns>The data object found at the parsing position.</returns>
NSObject ParseData()
{
NSObject obj = null;
//Skip begin token
Skip();
if(Accept(DATA_GSOBJECT_BEGIN_TOKEN))
{
Skip();
Expect(DATA_GSBOOL_BEGIN_TOKEN, DATA_GSDATE_BEGIN_TOKEN, DATA_GSINT_BEGIN_TOKEN,
DATA_GSREAL_BEGIN_TOKEN);
if(Accept(DATA_GSBOOL_BEGIN_TOKEN))
{
//Boolean
Skip();
Expect(DATA_GSBOOL_TRUE_TOKEN, DATA_GSBOOL_FALSE_TOKEN);
if(Accept(DATA_GSBOOL_TRUE_TOKEN)) obj = new NSNumber(true);
else obj = new NSNumber(false);
if(Accept(DATA_GSBOOL_TRUE_TOKEN))
obj = new NSNumber(true);
else
obj = new NSNumber(false);
//Skip the parsed boolean token
Skip();
}
@@ -637,6 +561,7 @@ namespace Claunia.PropertyList
int numBytes = dataString.Length / 2;
byte[] bytes = new byte[numBytes];
for(int i = 0; i < bytes.Length; i++)
{
string byteString = dataString.Substring(i * 2, 2);
@@ -653,39 +578,41 @@ namespace Claunia.PropertyList
return obj;
}
/// <summary>
/// Attempts to parse a plain string as a date if possible.
/// </summary>
/// <summary>Attempts to parse a plain string as a date if possible.</summary>
/// <returns>A NSDate if the string represents such an object. Otherwise a NSString is returned.</returns>
NSObject ParseDateString()
{
string numericalString = ParseString();
if(numericalString.Length > 4 && numericalString[4] == DATE_DATE_FIELD_DELIMITER)
try { return new NSDate(numericalString); }
catch(Exception)
{
//An exception occurs if the string is not a date but just a string
}
if(numericalString.Length <= 4 ||
numericalString[4] != DATE_DATE_FIELD_DELIMITER)
return new NSString(numericalString);
try
{
return new NSDate(numericalString);
}
catch(Exception)
{
//An exception occurs if the string is not a date but just a string
}
return new NSString(numericalString);
}
/// <summary>
/// Parses a plain string from the current parsing position.
/// The string is made up of all characters to the next whitespace, delimiter token or assignment token.
/// Parses a plain string from the current parsing position. The string is made up of all characters to the next
/// whitespace, delimiter token or assignment token.
/// </summary>
/// <returns>The string found at the current parsing position.</returns>
string ParseString()
{
return ReadInputUntil(WHITESPACE_SPACE, WHITESPACE_TAB, WHITESPACE_NEWLINE,
WHITESPACE_CARRIAGE_RETURN,
ARRAY_ITEM_DELIMITER_TOKEN, DICTIONARY_ITEM_DELIMITER_TOKEN, DICTIONARY_ASSIGN_TOKEN,
ARRAY_END_TOKEN);
}
string ParseString() => ReadInputUntil(WHITESPACE_SPACE, WHITESPACE_TAB, WHITESPACE_NEWLINE,
WHITESPACE_CARRIAGE_RETURN, ARRAY_ITEM_DELIMITER_TOKEN,
DICTIONARY_ITEM_DELIMITER_TOKEN, DICTIONARY_ASSIGN_TOKEN,
ARRAY_END_TOKEN);
/// <summary>
/// Parses a quoted string from the current parsing position.
/// The prerequisite for calling this method is, that a quoted string begin token has been read.
/// Parses a quoted string from the current parsing position. The prerequisite for calling this method is, that a
/// quoted string begin token has been read.
/// </summary>
/// <returns>The quoted string found at the parsing method with all special characters unescaped.</returns>
/// <exception cref="FormatException">If an error occured during parsing.</exception>
@@ -695,31 +622,39 @@ namespace Claunia.PropertyList
Skip();
string quotedString = "";
bool unescapedBackslash = true;
//Read from opening quotation marks to closing quotation marks and skip escaped quotation marks
while(data[index] != QUOTEDSTRING_END_TOKEN ||
data[index - 1] == QUOTEDSTRING_ESCAPE_TOKEN && unescapedBackslash)
(data[index - 1] == QUOTEDSTRING_ESCAPE_TOKEN && unescapedBackslash))
{
quotedString += data[index];
if(Accept(QUOTEDSTRING_ESCAPE_TOKEN))
unescapedBackslash = !(data[index - 1] == QUOTEDSTRING_ESCAPE_TOKEN && unescapedBackslash);
Skip();
}
string unescapedString;
try { unescapedString = ParseQuotedString(quotedString); }
try
{
unescapedString = ParseQuotedString(quotedString);
}
catch(Exception)
{
throw new FormatException(string.Format("The quoted string could not be parsed at {0}.", index));
throw new FormatException($"The quoted string could not be parsed at {index}.");
}
//skip end token
Skip();
return unescapedString;
}
/// <summary>
/// Parses a string according to the format specified for ASCII property lists.
/// Such strings can contain escape sequences which are unescaped in this method.
/// Parses a string according to the format specified for ASCII property lists. Such strings can contain escape
/// sequences which are unescaped in this method.
/// </summary>
/// <returns>The unescaped string in UTF-8 or ASCII format, depending on the contained characters.</returns>
/// <param name="s">
@@ -730,7 +665,7 @@ namespace Claunia.PropertyList
/// <exception cref="EncoderFallbackException">If the string is encoded neither in ASCII nor in UTF-8</exception>
public static string ParseQuotedString(string s)
{
List<byte> strBytes = new List<byte>();
List<byte> strBytes = new();
IEnumerable<char> characters = s.ToCharArray();
IEnumerator<char> c = characters.GetEnumerator();
@@ -742,18 +677,27 @@ namespace Claunia.PropertyList
{
//An escaped sequence is following
byte[] bts = Encoding.UTF8.GetBytes(ParseEscapedSequence(c));
foreach(byte b in bts) strBytes.Add(b);
foreach(byte b in bts)
strBytes.Add(b);
break;
}
default:
{
//a normal ASCII char
strBytes.AddRange(Encoding.BigEndianUnicode.GetBytes(new[] {c.Current}));
strBytes.AddRange(Encoding.BigEndianUnicode.GetBytes(new[]
{
c.Current
}));
break;
}
}
byte[] bytArr = new byte[strBytes.Count];
int i = 0;
foreach(byte b in strBytes)
{
bytArr[i] = b;
@@ -773,9 +717,7 @@ namespace Claunia.PropertyList
return result;
}
/// <summary>
/// Unescapes an escaped character sequence, e.g. \\u00FC.
/// </summary>
/// <summary>Unescapes an escaped character sequence, e.g. \\u00FC.</summary>
/// <returns>The unescaped character as a string.</returns>
/// <param name="iterator">The string character iterator pointing to the first character after the backslash</param>
/// <exception cref="EncoderFallbackException">If an invalid Unicode or ASCII escape sequence is found.</exception>
@@ -783,46 +725,79 @@ namespace Claunia.PropertyList
{
iterator.MoveNext();
char c = iterator.Current;
if(c == '\\') return Encoding.UTF8.GetString(new byte[] {0, (byte)'\\'});
if(c == '"') return Encoding.UTF8.GetString(new byte[] {0, (byte)'\"'});
if(c == 'b') return Encoding.UTF8.GetString(new byte[] {0, (byte)'\b'});
if(c == 'n') return Encoding.UTF8.GetString(new byte[] {0, (byte)'\n'});
if(c == 'r') return Encoding.UTF8.GetString(new byte[] {0, (byte)'\r'});
if(c == 't') return Encoding.UTF8.GetString(new byte[] {0, (byte)'\t'});
if(c == 'U' || c == 'u')
switch(c)
{
//4 digit hex Unicode value
string byte1 = "";
iterator.MoveNext();
byte1 += iterator.Current;
iterator.MoveNext();
byte1 += iterator.Current;
string byte2 = "";
iterator.MoveNext();
byte2 += iterator.Current;
iterator.MoveNext();
byte2 += iterator.Current;
byte[] stringBytes = {(byte)Convert.ToInt32(byte1, 16), (byte)Convert.ToInt32(byte2, 16)};
return Encoding.UTF8.GetString(stringBytes);
}
else
{
//3 digit octal ASCII value
string num = "";
num += c;
iterator.MoveNext();
num += iterator.Current;
iterator.MoveNext();
num += iterator.Current;
int asciiCode = Convert.ToInt32(num, 8);
byte[] stringBytes = {0, (byte)asciiCode};
return Encoding.UTF8.GetString(stringBytes);
case '\\':
return Encoding.UTF8.GetString(new byte[]
{
0, (byte)'\\'
});
case '"':
return Encoding.UTF8.GetString(new byte[]
{
0, (byte)'\"'
});
case 'b':
return Encoding.UTF8.GetString(new byte[]
{
0, (byte)'\b'
});
case 'n':
return Encoding.UTF8.GetString(new byte[]
{
0, (byte)'\n'
});
case 'r':
return Encoding.UTF8.GetString(new byte[]
{
0, (byte)'\r'
});
case 't':
return Encoding.UTF8.GetString(new byte[]
{
0, (byte)'\t'
});
case 'U':
case 'u':
{
//4 digit hex Unicode value
string byte1 = "";
iterator.MoveNext();
byte1 += iterator.Current;
iterator.MoveNext();
byte1 += iterator.Current;
string byte2 = "";
iterator.MoveNext();
byte2 += iterator.Current;
iterator.MoveNext();
byte2 += iterator.Current;
byte[] stringBytes =
{
(byte)Convert.ToInt32(byte1, 16), (byte)Convert.ToInt32(byte2, 16)
};
return Encoding.UTF8.GetString(stringBytes);
}
default:
{
//3 digit octal ASCII value
string num = "";
num += c;
iterator.MoveNext();
num += iterator.Current;
iterator.MoveNext();
num += iterator.Current;
int asciiCode = Convert.ToInt32(num, 8);
byte[] stringBytes =
{
0, (byte)asciiCode
};
return Encoding.UTF8.GetString(stringBytes);
}
}
}

254
plist-cil/BinaryPropertyListParser.cs
View File

@@ -34,13 +34,12 @@ namespace Claunia.PropertyList
{
/// <summary>
/// <para>
/// Parses property lists that are in Apple's binary format.
/// Use this class when you are sure about the format of the property list.
/// Otherwise use the PropertyListParser class.
/// Parses property lists that are in Apple's binary format. Use this class when you are sure about the format of
/// the property list. Otherwise use the PropertyListParser class.
/// </para>
/// <para>
/// Parsing is done by calling the static <see cref="Parse(byte[])" />,
/// <see cref="Parse(FileInfo)" /> and <see cref="Parse(Stream)" /> methods.
/// Parsing is done by calling the static <see cref="Parse(byte[])" />, <see cref="Parse(FileInfo)" /> and
/// <see cref="Parse(Stream)" /> methods.
/// </para>
/// </summary>
/// @author Daniel Dreibrodt
@@ -49,81 +48,63 @@ namespace Claunia.PropertyList
{
static readonly Encoding utf16BigEndian = Encoding.GetEncoding("UTF-16BE");
/// <summary>
/// Major version of the property list format
/// </summary>
/// <summary>Major version of the property list format</summary>
int majorVersion;
/// <summary>
/// Minor version of the property list format
/// </summary>
/// <summary>Minor version of the property list format</summary>
int minorVersion;
/// <summary>
/// Length of an object reference in bytes
/// </summary>
/// <summary>Length of an object reference in bytes</summary>
int objectRefSize;
/// <summary>
/// The table holding the information at which offset each object is found
/// </summary>
/// <summary>The table holding the information at which offset each object is found</summary>
int[] offsetTable;
/// <summary>
/// Protected constructor so that instantiation is fully controlled by the
/// static parse methods.
/// </summary>
/// <summary>Protected constructor so that instantiation is fully controlled by the static parse methods.</summary>
/// <see cref="Parse(byte[])" />
protected BinaryPropertyListParser() { }
protected BinaryPropertyListParser() {}
/// <summary>
/// Parses a binary property list from a byte array.
/// </summary>
/// <summary>Parses a binary property list from a byte array.</summary>
/// <param name="data">The binary property list's data.</param>
/// <returns>The root object of the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
/// <exception cref="PropertyListFormatException">When the property list's format could not be parsed.</exception>
public static NSObject Parse(byte[] data)
{
return Parse(data.AsSpan());
}
public static NSObject Parse(byte[] data) => Parse(data.AsSpan());
/// <summary>
/// Parses a binary property list from a byte array.
/// </summary>
/// <summary>Parses a binary property list from a byte array.</summary>
/// <param name="data">The binary property list's data.</param>
/// <param name="offset">The length of the property list.</param>
/// <param name="count">The offset at which to start reading the property list.</param>
/// <returns>The root object of the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
/// <exception cref="PropertyListFormatException">When the property list's format could not be parsed.</exception>
public static NSObject Parse(byte[] data, int offset, int length)
{
return Parse(data.AsSpan(offset, length));
}
public static NSObject Parse(byte[] data, int offset, int length) => Parse(data.AsSpan(offset, length));
/// <summary>
/// Parses a binary property list from a byte span.
/// </summary>
/// <summary>Parses a binary property list from a byte span.</summary>
/// <param name="data">The binary property list's data.</param>
/// <returns>The root object of the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
/// <exception cref="PropertyListFormatException">When the property list's format could not be parsed.</exception>
public static NSObject Parse(ReadOnlySpan<byte> data)
{
BinaryPropertyListParser parser = new BinaryPropertyListParser();
var parser = new BinaryPropertyListParser();
return parser.DoParse(data);
}
/// <summary>
/// Parses a binary property list from a byte array.
/// </summary>
/// <summary>Parses a binary property list from a byte array.</summary>
/// <returns>The root object of the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
/// <param name="bytes">The binary property list's data.</param>
/// <exception cref="PropertyListFormatException">When the property list's format could not be parsed.</exception>
protected NSObject DoParse(ReadOnlySpan<byte> bytes)
{
if(bytes.Length < 8 || bytes[0] != 'b' || bytes[1] != 'p' || bytes[2] != 'l' || bytes[3] != 'i' ||
bytes[4] != 's' || bytes[5] != 't')
if(bytes.Length < 8 ||
bytes[0] != 'b' ||
bytes[1] != 'p' ||
bytes[2] != 'l' ||
bytes[3] != 'i' ||
bytes[4] != 's' ||
bytes[5] != 't')
{
string magic = Encoding.ASCII.GetString(bytes.Slice(0, 8).ToArray());
throw new PropertyListFormatException("The given data is no binary property list. Wrong magic bytes: " +
magic);
}
@@ -139,18 +120,18 @@ namespace Claunia.PropertyList
if(majorVersion > 0)
throw new PropertyListFormatException("Unsupported binary property list format: v" + majorVersion +
"." + minorVersion +
". " +
"." + minorVersion + ". " +
"Version 1.0 and later are not yet supported.");
/*
* Handle trailer, last 32 bytes of the file
*/
ReadOnlySpan<byte> trailer = bytes.Slice(bytes.Length - 32, 32);
//6 null bytes (index 0 to 5)
int offsetSize = trailer[6];
objectRefSize = trailer[7];
int numObjects = (int)BinaryPrimitives.ReadUInt64BigEndian(trailer.Slice(8, 8));
int numObjects = (int)BinaryPrimitives.ReadUInt64BigEndian(trailer.Slice(8, 8));
int topObject = (int)BinaryPrimitives.ReadUInt64BigEndian(trailer.Slice(16, 8));
int offsetTableOffset = (int)BinaryPrimitives.ReadUInt64BigEndian(trailer.Slice(24, 8));
@@ -161,16 +142,14 @@ namespace Claunia.PropertyList
for(int i = 0; i < numObjects; i++)
{
ReadOnlySpan<byte> offsetBytes = bytes.Slice(offsetTableOffset + i * offsetSize, offsetSize);
ReadOnlySpan<byte> offsetBytes = bytes.Slice(offsetTableOffset + (i * offsetSize), offsetSize);
offsetTable[i] = (int)ParseUnsignedInt(offsetBytes);
}
return ParseObject(bytes, topObject);
}
/// <summary>
/// Parses a binary property list from an input stream.
/// </summary>
/// <summary>Parses a binary property list from an input stream.</summary>
/// <param name="fs">The input stream that points to the property list's data.</param>
/// <returns>The root object of the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
/// <exception cref="PropertyListFormatException">When the property list's format could not be parsed.</exception>
@@ -178,32 +157,25 @@ namespace Claunia.PropertyList
{
//Read all bytes into a list
byte[] buf = PropertyListParser.ReadAll(fs);
// Don't close the stream - that would be the responisibility of code that class
// Parse
return Parse(buf);
}
/// <summary>
/// Parses a binary property list file.
/// </summary>
/// <summary>Parses a binary property list file.</summary>
/// <param name="f">The binary property list file</param>
/// <returns>The root object of the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
/// <exception cref="PropertyListFormatException">When the property list's format could not be parsed.</exception>
public static NSObject Parse(FileInfo f)
{
return Parse(f.OpenRead());
}
public static NSObject Parse(FileInfo f) => Parse(f.OpenRead());
protected int GetOffset(int obj)
{
return this.offsetTable[obj];
}
protected int GetOffset(int obj) => offsetTable[obj];
/// <summary>
/// Parses an object inside the currently parsed binary property list.
/// For the format specification check
/// Parses an object inside the currently parsed binary property list. For the format specification check
/// <a href="http://www.opensource.apple.com/source/CF/CF-855.17/CFBinaryPList.c">
/// Apple's binary property list parser implementation
/// Apple's binary property list parser
/// implementation
/// </a>
/// .
/// </summary>
@@ -216,6 +188,7 @@ namespace Claunia.PropertyList
byte type = bytes[offset];
int objType = (type & 0xF0) >> 4; //First 4 bits
int objInfo = type & 0x0F; //Second 4 bits
switch(objType)
{
case 0x0:
@@ -269,12 +242,14 @@ namespace Claunia.PropertyList
{
//integer
int length = 1 << objInfo;
return new NSNumber(bytes.Slice(offset + 1, length), NSNumber.INTEGER);
}
case 0x2:
{
//real
int length = 1 << objInfo;
return new NSNumber(bytes.Slice(offset + 1, length), NSNumber.REAL);
}
case 0x3:
@@ -283,8 +258,7 @@ namespace Claunia.PropertyList
if(objInfo != 0x3)
throw new
PropertyListFormatException("The given binary property list contains a date object of an unknown type (" +
objInfo +
")");
objInfo + ")");
return new NSDate(bytes.Slice(offset + 1, 8));
}
@@ -292,12 +266,14 @@ namespace Claunia.PropertyList
{
//Data
ReadLengthAndOffset(bytes, objInfo, offset, out int length, out int dataoffset);
return new NSData(CopyOfRange(bytes, offset + dataoffset, offset + dataoffset + length));
}
case 0x5:
{
//ASCII String, each character is 1 byte
ReadLengthAndOffset(bytes, objInfo, offset, out int length, out int stroffset);
return new NSString(bytes.Slice(offset + stroffset, length), Encoding.ASCII);
}
case 0x6:
@@ -308,6 +284,7 @@ namespace Claunia.PropertyList
//UTF-16 characters can have variable length, but the Core Foundation reference implementation
//assumes 2 byte characters, thus only covering the Basic Multilingual Plane
length *= 2;
return new NSString(bytes.Slice(offset + stroffset, length), utf16BigEndian);
}
case 0x7:
@@ -318,12 +295,14 @@ namespace Claunia.PropertyList
//UTF-8 characters can have variable length, so we need to calculate the byte length dynamically
//by reading the UTF-8 characters one by one
int length = CalculateUtf8StringLength(bytes, offset + strOffset, characters);
return new NSString(bytes.Slice(offset + strOffset, length), Encoding.UTF8);
return new NSString(bytes.Slice(offset + strOffset, length), Encoding.UTF8);
}
case 0x8:
{
//UID (v1.0 and later)
int length = objInfo + 1;
return new UID(bytes.Slice(offset + 1, length));
}
case 0xA:
@@ -331,11 +310,14 @@ namespace Claunia.PropertyList
//Array
ReadLengthAndOffset(bytes, objInfo, offset, out int length, out int arrayOffset);
NSArray array = new NSArray(length);
var array = new NSArray(length);
for(int i = 0; i < length; i++)
{
int objRef =
(int)ParseUnsignedInt(bytes.Slice(offset + arrayOffset + i * objectRefSize, objectRefSize));
(int)ParseUnsignedInt(bytes.Slice(offset + arrayOffset + (i * objectRefSize),
objectRefSize));
array.Add(ParseObject(bytes, objRef));
}
@@ -346,12 +328,14 @@ namespace Claunia.PropertyList
//Ordered set (v1.0 and later)
ReadLengthAndOffset(bytes, objInfo, offset, out int length, out int contentOffset);
NSSet set = new NSSet(true);
var set = new NSSet(true);
for(int i = 0; i < length; i++)
{
int objRef =
(int)ParseUnsignedInt(bytes.Slice(offset + contentOffset + i * objectRefSize,
(int)ParseUnsignedInt(bytes.Slice(offset + contentOffset + (i * objectRefSize),
objectRefSize));
set.AddObject(ParseObject(bytes, objRef));
}
@@ -362,12 +346,14 @@ namespace Claunia.PropertyList
//Set (v1.0 and later)
ReadLengthAndOffset(bytes, objInfo, offset, out int length, out int contentOffset);
NSSet set = new NSSet();
var set = new NSSet();
for(int i = 0; i < length; i++)
{
int objRef =
(int)ParseUnsignedInt(bytes.Slice(offset + contentOffset + i * objectRefSize,
(int)ParseUnsignedInt(bytes.Slice(offset + contentOffset + (i * objectRefSize),
objectRefSize));
set.AddObject(ParseObject(bytes, objRef));
}
@@ -379,16 +365,19 @@ namespace Claunia.PropertyList
ReadLengthAndOffset(bytes, objInfo, offset, out int length, out int contentOffset);
//System.out.println("Parsing dictionary #"+obj);
NSDictionary dict = new NSDictionary(length);
var dict = new NSDictionary(length);
for(int i = 0; i < length; i++)
{
int keyRef =
(int)ParseUnsignedInt(bytes.Slice(offset + contentOffset + i * objectRefSize,
(int)ParseUnsignedInt(bytes.Slice(offset + contentOffset + (i * objectRefSize),
objectRefSize));
int valRef =
(int)
ParseUnsignedInt(bytes.Slice(offset + contentOffset + length * objectRefSize + i * objectRefSize,
ParseUnsignedInt(bytes.Slice(offset + contentOffset + (length * objectRefSize) + (i * objectRefSize),
objectRefSize));
NSObject key = ParseObject(bytes, keyRef);
NSObject val = ParseObject(bytes, valRef);
dict.Add(key.ToString(), val);
@@ -399,8 +388,8 @@ namespace Claunia.PropertyList
default:
{
Debug.WriteLine("WARNING: The given binary property list contains an object of unknown type (" +
objType +
")");
objType + ")");
break;
}
}
@@ -408,28 +397,31 @@ namespace Claunia.PropertyList
return null;
}
/// <summary>
/// Reads the length for arrays, sets and dictionaries.
/// </summary>
/// <summary>Reads the length for arrays, sets and dictionaries.</summary>
/// <returns>An array with the length two. First entry is the length, second entry the offset at which the content starts.</returns>
/// <param name="objInfo">Object information byte.</param>
/// <param name="offset">Offset in the byte array at which the object is located.</param>
void ReadLengthAndOffset(ReadOnlySpan<byte> bytes, int objInfo, int offset, out int lengthValue,
out int offsetValue)
out int offsetValue)
{
lengthValue = objInfo;
offsetValue = 1;
if(objInfo == 0xF)
{
int int_type = bytes[offset + 1];
int intType = (int_type & 0xF0) >> 4;
if(intType != 0x1)
Debug.WriteLine("BinaryPropertyListParser: Length integer has an unexpected type" + intType +
". Attempting to parse anyway...");
int intInfo = int_type & 0x0F;
int intLength = 1 << intInfo;
offsetValue = 2 + intLength;
if(intLength < 3) lengthValue = (int)ParseUnsignedInt(bytes.Slice(offset + 2, intLength));
if(intLength < 3)
lengthValue = (int)ParseUnsignedInt(bytes.Slice(offset + 2, intLength));
else
{
// BigInteger is Little-Endian in .NET, swap the thing.
@@ -443,9 +435,7 @@ namespace Claunia.PropertyList
}
}
/// <summary>
/// Calculates the length in bytes of the UTF-8 string.
/// </summary>
/// <summary>Calculates the length in bytes of the UTF-8 string.</summary>
/// <returns>The UTF-8 string length.</returns>
/// <param name="bytes">Array containing the UTF-8 string.</param>
/// <param name="offset">Offset in the array where the UTF-8 string resides.</param>
@@ -453,31 +443,41 @@ namespace Claunia.PropertyList
int CalculateUtf8StringLength(ReadOnlySpan<byte> bytes, int offset, int numCharacters)
{
int length = 0;
for(int i = 0; i < numCharacters; i++)
{
int tempOffset = offset + length;
if(bytes.Length <= tempOffset) return numCharacters;
if(bytes[tempOffset] < 0x80) length++;
if(bytes[tempOffset] < 0xC2) return numCharacters;
if(bytes.Length <= tempOffset)
return numCharacters;
if(bytes[tempOffset] < 0x80)
length++;
if(bytes[tempOffset] < 0xC2)
return numCharacters;
if(bytes[tempOffset] < 0xE0)
{
if((bytes[tempOffset + 1] & 0xC0) != 0x80) return numCharacters;
if((bytes[tempOffset + 1] & 0xC0) != 0x80)
return numCharacters;
length += 2;
}
else if(bytes[tempOffset] < 0xF0)
{
if((bytes[tempOffset + 1] & 0xC0) != 0x80 || (bytes[tempOffset + 2] & 0xC0) != 0x80)
if((bytes[tempOffset + 1] & 0xC0) != 0x80 ||
(bytes[tempOffset + 2] & 0xC0) != 0x80)
return numCharacters;
length += 3;
}
else if(bytes[tempOffset] < 0xF5)
{
if((bytes[tempOffset + 1] & 0xC0) != 0x80 || (bytes[tempOffset + 2] & 0xC0) != 0x80 ||
(bytes[tempOffset + 3] & 0xC0) != 0x80) return numCharacters;
if((bytes[tempOffset + 1] & 0xC0) != 0x80 ||
(bytes[tempOffset + 2] & 0xC0) != 0x80 ||
(bytes[tempOffset + 3] & 0xC0) != 0x80)
return numCharacters;
length += 4;
}
@@ -486,31 +486,23 @@ namespace Claunia.PropertyList
return length;
}
/// <summary>
/// Parses an unsigned integer from a span.
/// </summary>
/// <summary>Parses an unsigned integer from a span.</summary>
/// <returns>The byte array containing the unsigned integer.</returns>
/// <param name="bytes">The unsigned integer represented by the given bytes.</param>
public static long ParseUnsignedInt(ReadOnlySpan<byte> bytes)
{
if(bytes.Length <= 4) return ParseLong(bytes);
if(bytes.Length <= 4)
return ParseLong(bytes);
return ParseLong(bytes) & 0xFFFFFFFFL;
}
/// <summary>
/// Parses an unsigned integers from a byte array.
/// </summary>
/// <summary>Parses an unsigned integers from a byte array.</summary>
/// <returns>The byte array containing the unsigned integer.</returns>
/// <param name="bytes">The unsigned integer represented by the given bytes.</param>
public static long ParseUnsignedInt(byte[] bytes)
{
return ParseUnsignedInt(bytes.AsSpan());
}
public static long ParseUnsignedInt(byte[] bytes) => ParseUnsignedInt(bytes.AsSpan());
/// <summary>
/// Parses a long from a (big-endian) byte array.
/// </summary>
/// <summary>Parses a long from a (big-endian) byte array.</summary>
/// <returns>The long integer represented by the given bytes.</returns>
/// <param name="bytes">The bytes representing the long integer.</param>
public static long ParseLong(ReadOnlySpan<byte> bytes)
@@ -527,7 +519,7 @@ namespace Claunia.PropertyList
// https://opensource.apple.com/source/CF/CF-1153.18/CFBinaryPList.c,
// __CFBinaryPlistCreateObjectFiltered, case kCFBinaryPlistMarkerInt:
//
//
// in format version '00', 1, 2, and 4-byte integers have to be interpreted as unsigned,
// whereas 8-byte integers are signed (and 16-byte when available)
// negative 1, 2, 4-byte integers are always emitted as 8 bytes in format '00'
@@ -548,28 +540,27 @@ namespace Claunia.PropertyList
case 16: return BinaryPrimitives.ReadInt64BigEndian(bytes.Slice(8));
}
if (bytes.Length < 8)
if(bytes.Length >= 8)
throw new ArgumentOutOfRangeException(nameof(bytes),
$"Cannot read a byte span of length {bytes.Length}");
// Compatibility with existing archives, including anything with a non-power-of-2
// size and 16-byte values, and architectures that don't support unaligned access
long value = 0;
for(int i = 0; i < bytes.Length; i++)
{
// Compatability with existing archives, including anything with a non-power-of-2
// size and 16-byte values, and architectures that don't support unaligned access
long value = 0;
for(int i = 0; i < bytes.Length; i++)
{
value = (value << 8) + bytes[i];
}
return value;
value = (value << 8) + bytes[i];
}
return value;
// Theoretically we could handle non-power-of-2 byte arrays larger than 8, with the code
// above, and it appears the reference implementation does exactly that. But it seems to
// be an extreme edge case.
throw new ArgumentOutOfRangeException(nameof(bytes),
$"Cannot read a byte span of length {bytes.Length}");
}
/// <summary>
/// Parses a double from a (big-endian) byte array.
/// </summary>
/// <summary>Parses a double from a (big-endian) byte array.</summary>
/// <returns>The double represented by the given bytes.</returns>
/// <param name="bytes">The bytes representing the double.</param>
public static double ParseDouble(ReadOnlySpan<byte> bytes)
@@ -579,15 +570,15 @@ namespace Claunia.PropertyList
throw new ArgumentNullException(nameof(bytes));
}
if(bytes.Length == 8) return BitConverter.Int64BitsToDouble(ParseLong(bytes));
if(bytes.Length == 4) return BitConverter.ToSingle(BitConverter.GetBytes(ParseLong(bytes)), 0);
throw new ArgumentException("bad byte array length " + bytes.Length);
return bytes.Length switch
{
8 => BitConverter.Int64BitsToDouble(ParseLong(bytes)),
4 => BitConverter.ToSingle(BitConverter.GetBytes(ParseLong(bytes)), 0),
_ => throw new ArgumentException("bad byte array length " + bytes.Length)
};
}
/// <summary>
/// Copies a part of a byte array into a new array.
/// </summary>
/// <summary>Copies a part of a byte array into a new array.</summary>
/// <returns>The copied array.</returns>
/// <param name="src">The source array.</param>
/// <param name="startIndex">The index from which to start copying.</param>
@@ -595,6 +586,7 @@ namespace Claunia.PropertyList
public static byte[] CopyOfRange(ReadOnlySpan<byte> src, int startIndex, int endIndex)
{
int length = endIndex - startIndex;
if(length < 0)
throw new ArgumentOutOfRangeException("startIndex (" + startIndex + ")" + " > endIndex (" + endIndex +
")");

23
plist-cil/BinaryPropertyListWriter.AddObjectEqualityComparer.cs
View File

@@ -6,30 +6,29 @@ namespace Claunia.PropertyList
public partial class BinaryPropertyListWriter
{
/// <summary>
/// The equality comparer which is used when adding an object to the <see cref="BinaryPropertyListWriter.idMap" />. In
/// most cases,
/// objects are always added. The only exception are very specific strings, which are only added once.
/// The equality comparer which is used when adding an object to the <see cref="BinaryPropertyListWriter.idMap" />
/// . In most cases, objects are always added. The only exception are very specific strings, which are only added once.
/// </summary>
class AddObjectEqualityComparer : EqualityComparer<NSObject>
{
public override bool Equals(NSObject x, NSObject y)
{
NSString a = x as NSString;
NSString b = y as NSString;
if(x is not NSString a ||
y is not NSString b)
return ReferenceEquals(x, y);
if(a == null || b == null) return ReferenceEquals(x, y);
if(!IsSerializationPrimitive(a) || !IsSerializationPrimitive(b)) return ReferenceEquals(x, y);
if(!IsSerializationPrimitive(a) ||
!IsSerializationPrimitive(b))
return ReferenceEquals(x, y);
return string.Equals(a.Content, b.Content, StringComparison.Ordinal);
}
public override int GetHashCode(NSObject obj)
{
if(obj == null) return 0;
NSString s = obj as NSString;
if(s != null && IsSerializationPrimitive(s)) return s.Content.GetHashCode();
if(obj is NSString s &&
IsSerializationPrimitive(s))
return s.Content.GetHashCode();
return obj.GetHashCode();
}

48
plist-cil/BinaryPropertyListWriter.GetObjectEqualityComparer.cs
View File

@@ -5,45 +5,35 @@ namespace Claunia.PropertyList
public partial class BinaryPropertyListWriter
{
/// <summary>
/// The equality comparer which is used when retrieving objects in the <see cref="BinaryPropertyListWriter.idMap" />.
/// The logic is slightly different from <see cref="AddObjectEqualityComparer" />, results in two equivalent objects
/// (UIDs mainly) being added to the <see cref="BinaryPropertyListWriter.idMap" />. Whenever the ID for one of
/// those equivalent objects is requested, the first ID is always returned.
/// This means that there are "orphan" objects in binary property lists - duplicate objects which are never referenced
/// -;
/// this logic exists purely to maintain binary compatibility with Apple's format.
/// The equality comparer which is used when retrieving objects in the
/// <see cref="BinaryPropertyListWriter.idMap" />. The logic is slightly different from
/// <see cref="AddObjectEqualityComparer" />, results in two equivalent objects (UIDs mainly) being added to the
/// <see cref="BinaryPropertyListWriter.idMap" />. Whenever the ID for one of those equivalent objects is requested,
/// the first ID is always returned. This means that there are "orphan" objects in binary property lists - duplicate
/// objects which are never referenced -; this logic exists purely to maintain binary compatibility with Apple's
/// format.
/// </summary>
class GetObjectEqualityComparer : EqualityComparer<NSObject>
{
public override bool Equals(NSObject x, NSObject y)
public override bool Equals(NSObject x, NSObject y) => x switch
{
// By default, use reference equality. Even if there are two objects - say a NSString - with the same
// value, do not consider them equal unless they are the same instance of NSString.
// The exceptions are UIDs, where we always compare by value, and "primitive" strings (a list of well-known
// strings), which are treaded specially and "recycled".
if(x is UID) return x.Equals(y);
UID => x.Equals(y),
NSNumber number when IsSerializationPrimitive(number) => number.Equals(y),
NSString nsString when IsSerializationPrimitive(nsString) => nsString.Equals(y),
_ => ReferenceEquals(x, y)
};
if(x is NSNumber && IsSerializationPrimitive((NSNumber)x)) return x.Equals(y);
if(x is NSString && IsSerializationPrimitive((NSString)x)) return x.Equals(y);
return ReferenceEquals(x, y);
}
public override int GetHashCode(NSObject obj)
public override int GetHashCode(NSObject obj) => obj switch
{
if(obj == null) return 0;
UID u = obj as UID;
if(u != null) return u.GetHashCode();
NSNumber n = obj as NSNumber;
if(n != null && IsSerializationPrimitive(n)) return n.ToObject().GetHashCode();
NSString s = obj as NSString;
if(s != null && IsSerializationPrimitive(s)) return s.Content.GetHashCode();
return obj.GetHashCode();
}
UID u => u.GetHashCode(),
NSNumber n when IsSerializationPrimitive(n) => n.ToObject().GetHashCode(),
NSString s when IsSerializationPrimitive(s) => s.Content.GetHashCode(),
_ => obj.GetHashCode()
};
}
}
}

331
plist-cil/BinaryPropertyListWriter.cs
View File

@@ -30,60 +30,43 @@ using System.IO;
namespace Claunia.PropertyList
{
/// <summary>
/// <para>A BinaryPropertyListWriter is a helper class for writing out binary property list files.</para>
/// <para>
/// A BinaryPropertyListWriter is a helper class for writing out
/// binary property list files.
/// </para>
/// <para>
/// It contains an output stream and various structures for keeping track
/// of which NSObjects have already been serialized, and where they were
/// put in the file.
/// It contains an output stream and various structures for keeping track of which NSObjects have already been
/// serialized, and where they were put in the file.
/// </para>
/// </summary>
/// @author Keith Randall
/// @author Natalia Portillo
public partial class BinaryPropertyListWriter
{
/// <summary>
/// Binary property list version 0.0
/// </summary>
/// <summary>Binary property list version 0.0</summary>
public const int VERSION_00 = 0;
/// <summary>
/// Binary property list version 1.0
/// </summary>
/// <summary>Binary property list version 1.0</summary>
public const int VERSION_10 = 10;
/// <summary>
/// Binary property list version 1.5
/// </summary>
/// <summary>Binary property list version 1.5</summary>
public const int VERSION_15 = 15;
/// <summary>
/// Binary property list version 2.0
/// </summary>
/// <summary>Binary property list version 2.0</summary>
public const int VERSION_20 = 20;
// map from object to its ID
protected readonly Dictionary<NSObject, int> idDict = new Dictionary<NSObject, int>(new AddObjectEqualityComparer());
protected readonly Dictionary<NSObject, int> idDict2 = new Dictionary<NSObject, int>(new GetObjectEqualityComparer());
// # of bytes written so far
private long count;
protected int currentId;
private int idSizeInBytes;
protected readonly Dictionary<NSObject, int> idDict = new(new AddObjectEqualityComparer());
protected readonly Dictionary<NSObject, int> idDict2 = new(new GetObjectEqualityComparer());
// raw output stream to result file
Stream outStream;
readonly Stream outStream;
int version = VERSION_00;
readonly int version = VERSION_00;
/// <summary>
/// Creates a new binary property list writer
/// </summary>
// # of bytes written so far
long count;
protected int currentId;
int idSizeInBytes;
/// <summary>Creates a new binary property list writer</summary>
/// <param name="outStr">The output stream into which the binary property list will be written</param>
/// <exception cref="IOException">If an error occured while writing to the stream</exception>
public BinaryPropertyListWriter(Stream outStr)
{
outStream = outStr;
}
public BinaryPropertyListWriter(Stream outStr) => outStream = outStr;
public BinaryPropertyListWriter(Stream outStr, int version)
{
@@ -91,7 +74,9 @@ namespace Claunia.PropertyList
outStream = outStr;
}
public BinaryPropertyListWriter(Stream outStr, int version, IEqualityComparer<NSObject> addObjectEqualityComparer, IEqualityComparer<NSObject> getObjectEqualityComparer)
public BinaryPropertyListWriter(Stream outStr, int version,
IEqualityComparer<NSObject> addObjectEqualityComparer,
IEqualityComparer<NSObject> getObjectEqualityComparer)
{
this.version = version;
outStream = outStr;
@@ -100,139 +85,169 @@ namespace Claunia.PropertyList
}
/// <summary>
/// Gets or sets a value indicating whether two equivalent objects should be serialized once in the binary property
/// list file, or whether
/// the value should be stored multiple times in the binary property list file. The default is <see langword="false" />
/// .
/// Gets or sets a value indicating whether two equivalent objects should be serialized once in the binary
/// property list file, or whether the value should be stored multiple times in the binary property list file. The
/// default is <see langword="false" /> .
/// </summary>
/// <remarks>
/// In most scenarios, you want this to be <see langword="true" />, as it reduces the size of the binary proeprty list
/// file. However,
/// by default, the Apple tools do not seem to implement this optimization, so set this value to
/// <see langword="false" /> if you
/// want to maintain binary compatibility with the Apple tools.
/// In most scenarios, you want this to be <see langword="true" />, as it reduces the size of the binary proeprty
/// list file. However, by default, the Apple tools do not seem to implement this optimization, so set this value to
/// <see langword="false" /> if you want to maintain binary compatibility with the Apple tools.
/// </remarks>
public bool ReuseObjectIds { get; set; }
/// <summary>
/// Finds out the minimum binary property list format version that
/// can be used to save the given NSObject tree.
/// </summary>
/// <summary>Finds out the minimum binary property list format version that can be used to save the given NSObject tree.</summary>
/// <returns>Version code</returns>
/// <param name="root">Object root.</param>
static int GetMinimumRequiredVersion(NSObject root)
{
int minVersion = VERSION_00;
if(root == null) minVersion = VERSION_10;
if(root is NSDictionary)
int minVersion = VERSION_00;
switch(root)
{
NSDictionary dict = (NSDictionary)root;
foreach(NSObject o in dict.GetDictionary().Values)
case null:
minVersion = VERSION_10;
break;
case NSDictionary dict:
{
int v = GetMinimumRequiredVersion(o);
if(v > minVersion) minVersion = v;
foreach(NSObject o in dict.GetDictionary().Values)
{
int v = GetMinimumRequiredVersion(o);
if(v > minVersion)
minVersion = v;
}
break;
}
}
else if(root is NSArray)
{
NSArray array = (NSArray)root;
foreach(NSObject o in array)
case NSArray array:
{
int v = GetMinimumRequiredVersion(o);
if(v > minVersion) minVersion = v;
foreach(NSObject o in array)
{
int v = GetMinimumRequiredVersion(o);
if(v > minVersion)
minVersion = v;
}
break;
}
}
else if(root is NSSet)
{
//Sets are only allowed in property lists v1+
minVersion = VERSION_10;
NSSet set = (NSSet)root;
foreach(NSObject o in set.AllObjects())
case NSSet set:
{
int v = GetMinimumRequiredVersion(o);
if(v > minVersion) minVersion = v;
//Sets are only allowed in property lists v1+
minVersion = VERSION_10;
foreach(NSObject o in set.AllObjects())
{
int v = GetMinimumRequiredVersion(o);
if(v > minVersion)
minVersion = v;
}
break;
}
}
return minVersion;
}
/// <summary>
/// Writes a binary plist file with the given object as the root.
/// </summary>
/// <summary>Writes a binary plist file with the given object as the root.</summary>
/// <param name="file">the file to write to</param>
/// <param name="root">the source of the data to write to the file</param>
/// <exception cref="IOException"></exception>
public static void Write(FileInfo file, NSObject root)
{
using(FileStream fous = file.OpenWrite()) Write(fous, root);
using FileStream fous = file.OpenWrite();
Write(fous, root);
}
/// <summary>
/// Writes a binary plist serialization of the given object as the root.
/// </summary>
/// <summary>Writes a binary plist serialization of the given object as the root.</summary>
/// <param name="outStream">the stream to write to</param>
/// <param name="root">the source of the data to write to the stream</param>
/// <exception cref="IOException"></exception>
public static void Write(Stream outStream, NSObject root)
{
int minVersion = GetMinimumRequiredVersion(root);
if(minVersion > VERSION_00)
{
string versionString = minVersion == VERSION_10
? "v1.0"
: (minVersion == VERSION_15
? "v1.5"
: (minVersion == VERSION_20 ? "v2.0" : "v0.0"));
: minVersion == VERSION_15
? "v1.5"
: minVersion == VERSION_20
? "v2.0"
: "v0.0";
throw new IOException("The given property list structure cannot be saved. " +
"The required version of the binary format (" + versionString +
") is not yet supported.");
}
BinaryPropertyListWriter w = new BinaryPropertyListWriter(outStream, minVersion);
var w = new BinaryPropertyListWriter(outStream, minVersion);
w.Write(root);
}
/// <summary>
/// Writes a binary plist serialization of the given object as the root
/// into a byte array.
/// </summary>
/// <summary>Writes a binary plist serialization of the given object as the root into a byte array.</summary>
/// <returns>The byte array containing the serialized property list</returns>
/// <param name="root">The root object of the property list</param>
/// <exception cref="IOException"></exception>
public static byte[] WriteToArray(NSObject root)
{
MemoryStream bout = new MemoryStream();
var bout = new MemoryStream();
Write(bout, root);
return bout.ToArray();
}
public void Write(NSObject root)
{
// magic bytes
Write(new[] {(byte)'b', (byte)'p', (byte)'l', (byte)'i', (byte)'s', (byte)'t'});
Write(new[]
{
(byte)'b', (byte)'p', (byte)'l', (byte)'i', (byte)'s', (byte)'t'
});
//version
switch(version)
{
case VERSION_00:
{
Write(new[] {(byte)'0', (byte)'0'});
Write(new[]
{
(byte)'0', (byte)'0'
});
break;
}
case VERSION_10:
{
Write(new[] {(byte)'1', (byte)'0'});
Write(new[]
{
(byte)'1', (byte)'0'
});
break;
}
case VERSION_15:
{
Write(new[] {(byte)'1', (byte)'5'});
Write(new[]
{
(byte)'1', (byte)'5'
});
break;
}
case VERSION_20:
{
Write(new[] {(byte)'2', (byte)'0'});
Write(new[]
{
(byte)'2', (byte)'0'
});
break;
}
}
@@ -251,29 +266,39 @@ namespace Claunia.PropertyList
NSObject obj = pair.Key;
int id = pair.Value;
offsets[id] = count;
if(obj == null) Write(0x00);
else obj.ToBinary(this);
if(obj == null)
Write(0x00);
else
obj.ToBinary(this);
}
// write offset table
long offsetTableOffset = count;
int offsetSizeInBytes = ComputeOffsetSizeInBytes(count);
foreach(long offset in offsets) WriteBytes(offset, offsetSizeInBytes);
foreach(long offset in offsets)
WriteBytes(offset, offsetSizeInBytes);
if(version != VERSION_15)
{
// write trailer
// 6 null bytes
Write(new byte[6]);
// size of an offset
Write(offsetSizeInBytes);
// size of a ref
Write(idSizeInBytes);
// number of objects
WriteLong(idDict.Count);
// top object
int rootID = idDict[root];
WriteLong(rootID);
// offset table offset
WriteLong(offsetTableOffset);
}
@@ -285,59 +310,64 @@ namespace Claunia.PropertyList
{
if(ReuseObjectIds)
{
if(!idDict.ContainsKey(obj)) idDict.Add(obj, currentId++);
if(!idDict.ContainsKey(obj))
idDict.Add(obj, currentId++);
}
else
{
if(!idDict2.ContainsKey(obj)) idDict2.Add(obj, currentId);
if(!idDict.ContainsKey(obj)) idDict.Add(obj, currentId++);
if(!idDict2.ContainsKey(obj))
idDict2.Add(obj, currentId);
if(!idDict.ContainsKey(obj))
idDict.Add(obj, currentId++);
}
}
internal int GetID(NSObject obj)
{
if(ReuseObjectIds) return idDict[obj];
return idDict2[obj];
}
internal int GetID(NSObject obj) => ReuseObjectIds ? idDict[obj] : idDict2[obj];
static int ComputeIdSizeInBytes(int numberOfIds)
{
if(numberOfIds < 256) return 1;
if(numberOfIds < 256)
return 1;
return numberOfIds < 65536 ? 2 : 4;
}
static int ComputeOffsetSizeInBytes(long maxOffset)
static int ComputeOffsetSizeInBytes(long maxOffset) => maxOffset switch
{
if(maxOffset < 256) return 1;
if(maxOffset < 65536) return 2;
return maxOffset < 4294967296L ? 4 : 8;
}
< 256 => 1,
< 65536 => 2,
< 4294967296L => 4,
_ => 8
};
internal void WriteIntHeader(int kind, int value)
{
if(value < 0) throw new ArgumentException("value must be greater than or equal to 0", "value");
switch(value)
{
case < 0: throw new ArgumentException("value must be greater than or equal to 0", "value");
case < 15:
Write((kind << 4) + value);
if(value < 15) Write((kind << 4) + value);
else if(value < 256)
{
Write((kind << 4) + 15);
Write(0x10);
WriteBytes(value, 1);
}
else if(value < 65536)
{
Write((kind << 4) + 15);
Write(0x11);
WriteBytes(value, 2);
}
else
{
Write((kind << 4) + 15);
Write(0x12);
WriteBytes(value, 4);
break;
case < 256:
Write((kind << 4) + 15);
Write(0x10);
WriteBytes(value, 1);
break;
case < 65536:
Write((kind << 4) + 15);
Write(0x11);
WriteBytes(value, 2);
break;
default:
Write((kind << 4) + 15);
Write(0x12);
WriteBytes(value, 4);
break;
}
}
@@ -355,34 +385,26 @@ namespace Claunia.PropertyList
internal void Write(Span<byte> bytes)
{
#if NATIVE_SPAN
#if NATIVE_SPAN
outStream.Write(bytes);
count += bytes.Length;
#else
#else
Write(bytes.ToArray());
#endif
#endif
}
internal void WriteBytes(long value, int bytes)
{
// write low-order bytes big-endian style
for(int i = bytes - 1; i >= 0; i--) Write((int)(value >> (8 * i)));
for(int i = bytes - 1; i >= 0; i--)
Write((int)(value >> (8 * i)));
}
internal void WriteID(int id)
{
WriteBytes(id, idSizeInBytes);
}
internal void WriteID(int id) => WriteBytes(id, idSizeInBytes);
internal void WriteLong(long value)
{
WriteBytes(value, 8);
}
internal void WriteLong(long value) => WriteBytes(value, 8);
internal void WriteDouble(double value)
{
WriteLong(BitConverter.DoubleToInt64Bits(value));
}
internal void WriteDouble(double value) => WriteLong(BitConverter.DoubleToInt64Bits(value));
internal static bool IsSerializationPrimitive(NSString obj)
{
@@ -390,18 +412,11 @@ namespace Claunia.PropertyList
// This is a list of "special" values which are only added once to a binary property
// list, and can be referenced multiple times.
return content == "$class" || content == "$classes" || content == "$classname" ||
content == "NS.objects" ||
content == "NS.keys" || content == "NS.base" || content == "NS.relative" ||
content == "NS.string" ||
content == "NSURL" || content == "NSDictionary" || content == "NSObject" ||
content == "NSMutableDictionary" || content == "NSMutableArray" || content == "NSArray" ||
content == "NSUUID" || content == "NSKeyedArchiver" || content == "NSMutableString";
return content is "$class" or "$classes" or "$classname" or "NS.objects" or "NS.keys" or "NS.base" or
"NS.relative" or "NS.string" or "NSURL" or "NSDictionary" or "NSObject" or "NSMutableDictionary"
or "NSMutableArray" or "NSArray" or "NSUUID" or "NSKeyedArchiver" or "NSMutableString";
}
internal static bool IsSerializationPrimitive(NSNumber n)
{
return n.isBoolean();
}
internal static bool IsSerializationPrimitive(NSNumber n) => n.isBoolean();
}
}

75
plist-cil/NSArray.IList.cs
View File

@@ -38,88 +38,43 @@ namespace Claunia.PropertyList
public bool IsReadOnly => false;
/// <inheritdoc />
public void Add(NSObject item)
{
array.Add(item);
}
public void Add(NSObject item) => array.Add(item);
/// <inheritdoc />
public void Clear()
{
array.Clear();
}
public void Clear() => array.Clear();
/// <inheritdoc />
public bool Contains(NSObject item)
{
return array.Contains(item);
}
public bool Contains(NSObject item) => array.Contains(item);
/// <inheritdoc />
public void CopyTo(NSObject[] array, int arrayIndex)
{
this.array.CopyTo(array, arrayIndex);
}
public void CopyTo(NSObject[] array, int arrayIndex) => this.array.CopyTo(array, arrayIndex);
/// <inheritdoc />
public IEnumerator<NSObject> GetEnumerator()
{
return array.GetEnumerator();
}
public IEnumerator<NSObject> GetEnumerator() => array.GetEnumerator();
/// <inheritdoc />
public int IndexOf(NSObject item)
{
return array.IndexOf(item);
}
public int IndexOf(NSObject item) => array.IndexOf(item);
/// <inheritdoc />
public void Insert(int index, NSObject item)
{
array.Insert(index, item);
}
public void Insert(int index, NSObject item) => array.Insert(index, item);
/// <inheritdoc />
public bool Remove(NSObject item)
{
return array.Remove(item);
}
public bool Remove(NSObject item) => array.Remove(item);
/// <inheritdoc />
public void RemoveAt(int index)
{
array.RemoveAt(index);
}
public void RemoveAt(int index) => array.RemoveAt(index);
/// <inheritdoc />
IEnumerator IEnumerable.GetEnumerator()
{
return array.GetEnumerator();
}
IEnumerator IEnumerable.GetEnumerator() => array.GetEnumerator();
public void Add(object item)
{
Add(Wrap(item));
}
public void Add(object item) => Add(Wrap(item));
public bool Contains(object item)
{
return Contains(Wrap(item));
}
public bool Contains(object item) => Contains(Wrap(item));
public int IndexOf(object item)
{
return array.IndexOf(Wrap(item));
}
public int IndexOf(object item) => array.IndexOf(Wrap(item));
public void Insert(int index, object item)
{
Insert(index, Wrap(item));
}
public void Insert(int index, object item) => Insert(index, Wrap(item));
public bool Remove(object item)
{
return Remove(Wrap(item));
}
public bool Remove(object item) => Remove(Wrap(item));
}
}

205
plist-cil/NSArray.cs
View File

@@ -29,96 +29,64 @@ using System.Text;
namespace Claunia.PropertyList
{
/// <summary>
/// Represents an Array.
/// </summary>
/// <summary>Represents an Array.</summary>
/// @author Daniel Dreibrodt
/// @author Natalia Portillo
public partial class NSArray : NSObject
{
List<NSObject> array;
readonly List<NSObject> array;
/// <summary>
/// Creates an empty array of the given length.
/// </summary>
/// <summary>Creates an empty array of the given length.</summary>
/// <param name="length">The number of elements this array will be able to hold.</param>
public NSArray(int length)
{
array = new List<NSObject>(length);
}
public NSArray(int length) => array = new List<NSObject>(length);
/// <summary>
/// Creates a array from an existing one
/// </summary>
/// <summary>Creates a array from an existing one</summary>
/// <param name="a">The array which should be wrapped by the NSArray.</param>
public NSArray(params NSObject[] a)
{
array = new List<NSObject>(a);
}
public NSArray(params NSObject[] a) => array = new List<NSObject>(a);
/// <summary>
/// Returns the size of the array.
/// </summary>
/// <summary>Returns the size of the array.</summary>
/// <value>The number of elements that this array can store.</value>
public int Count => array.Count;
/// <summary>
/// Returns the object stored at the given index.
/// </summary>
/// <summary>Returns the object stored at the given index.</summary>
/// <returns>The object at the given index.</returns>
/// <param name="i">The index of the object.</param>
[Obsolete]
public NSObject ObjectAtIndex(int i)
{
return array[i];
}
public NSObject ObjectAtIndex(int i) => array[i];
/// <summary>
/// Remove the i-th element from the array.
/// The array will be resized.
/// </summary>
/// <summary>Remove the i-th element from the array. The array will be resized.</summary>
/// <param name="i">The index of the object</param>
[Obsolete]
public void Remove(int i)
{
array.RemoveAt(i);
}
public void Remove(int i) => array.RemoveAt(i);
/// <summary>
/// Stores an object at the specified index.
/// If there was another object stored at that index it will be replaced.
/// </summary>
/// <summary>Stores an object at the specified index. If there was another object stored at that index it will be replaced.</summary>
/// <param name="key">The index where to store the object.</param>
/// <param name="value">The object.</param>
[Obsolete]
public void SetValue(int key, object value)
{
if(value == null) throw new ArgumentNullException("value", "Cannot add null values to an NSArray!");
if(value == null)
throw new ArgumentNullException("value", "Cannot add null values to an NSArray!");
array[key] = Wrap(value);
}
/// <summary>
/// Returns the array of NSObjects represented by this NSArray.
/// Any changes to the values of this array will also affect the NSArray.
/// Returns the array of NSObjects represented by this NSArray. Any changes to the values of this array will also
/// affect the NSArray.
/// </summary>
/// <returns>The actual array represented by this NSArray.</returns>
[Obsolete]
public NSObject[] GetArray()
{
return array.ToArray();
}
public NSObject[] GetArray() => array.ToArray();
/// <summary>
/// Checks whether an object is present in the array or whether it is equal
/// to any of the objects in the array.
/// </summary>
/// <summary>Checks whether an object is present in the array or whether it is equal to any of the objects in the array.</summary>
/// <returns><c>true</c>, when the object could be found. <c>false</c> otherwise.</returns>
/// <param name="obj">The object to look for.</param>
[Obsolete]
public bool ContainsObject(object obj)
{
NSObject nso = Wrap(obj);
foreach(NSObject elem in array)
if(elem.Equals(nso))
return true;
@@ -127,9 +95,8 @@ namespace Claunia.PropertyList
}
/// <summary>
/// Searches for an object in the array. If it is found its index will be
/// returned. This method also returns an index if the object is not the same
/// as the one stored in the array but has equal contents.
/// Searches for an object in the array. If it is found its index will be returned. This method also returns an
/// index if the object is not the same as the one stored in the array but has equal contents.
/// </summary>
/// <returns>The index of the object, if it was found. -1 otherwise.</returns>
/// <param name="obj">The object to look for.</param>
@@ -137,6 +104,7 @@ namespace Claunia.PropertyList
public int IndexOfObject(object obj)
{
NSObject nso = Wrap(obj);
for(int i = 0; i < array.Count; i++)
if(array[i].Equals(nso))
return i;
@@ -145,10 +113,9 @@ namespace Claunia.PropertyList
}
/// <summary>
/// Searches for an object in the array. If it is found its index will be
/// returned. This method only returns the index of an object that is
/// <b>identical</b> to the given one. Thus objects that might contain the
/// same value as the given one will not be considered.
/// Searches for an object in the array. If it is found its index will be returned. This method only returns the
/// index of an object that is <b>identical</b> to the given one. Thus objects that might contain the same value as the
/// given one will not be considered.
/// </summary>
/// <returns>The index of the object, if it was found. -1 otherwise.</returns>
/// <param name="obj">The object to look for.</param>
@@ -156,6 +123,7 @@ namespace Claunia.PropertyList
public int IndexOfIdenticalObject(object obj)
{
NSObject nso = Wrap(obj);
for(int i = 0; i < array.Count; i++)
if(array[i] == nso)
return i;
@@ -163,18 +131,13 @@ namespace Claunia.PropertyList
return -1;
}
/// <summary>
/// Returns the last object contained in this array.
/// </summary>
/// <summary>Returns the last object contained in this array.</summary>
/// <returns>The value of the highest index in the array.</returns>
public NSObject LastObject()
{
return array[array.Count - 1];
}
public NSObject LastObject() => array[array.Count - 1];
/// <summary>
/// Returns a new array containing only the values stored at the given
/// indices. The values are sorted by their index.
/// Returns a new array containing only the values stored at the given indices. The values are sorted by their
/// index.
/// </summary>
/// <returns>The new array containing the objects stored at the given indices.</returns>
/// <param name="indexes">The indices of the objects.</param>
@@ -182,7 +145,10 @@ namespace Claunia.PropertyList
{
NSObject[] result = new NSObject[indexes.Length];
Array.Sort(indexes);
for(int i = 0; i < indexes.Length; i++) result[i] = array[indexes[i]];
for(int i = 0; i < indexes.Length; i++)
result[i] = array[indexes[i]];
return result;
}
@@ -200,17 +166,18 @@ namespace Claunia.PropertyList
/// </returns>
public override bool Equals(object obj)
{
if(obj.GetType().Equals(typeof(NSArray))) return ArrayEquals((NSArray)obj, this);
if(obj is NSArray nsArray)
return ArrayEquals(nsArray, this);
NSObject nso = Wrap(obj);
if(nso.GetType().Equals(typeof(NSArray))) return ArrayEquals((NSArray)nso, this);
if(nso is NSArray nsoArray)
return ArrayEquals(nsoArray, this);
return false;
}
/// <summary>
/// Serves as a hash function for a <see cref="Claunia.PropertyList.NSArray" /> object.
/// </summary>
/// <summary>Serves as a hash function for a <see cref="Claunia.PropertyList.NSArray" /> object.</summary>
/// <returns>
/// A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a
/// hash table.
@@ -218,7 +185,8 @@ namespace Claunia.PropertyList
public override int GetHashCode()
{
int hash = 7;
hash = 89 * hash + array.GetHashCode();
hash = (89 * hash) + array.GetHashCode();
return hash;
}
@@ -227,6 +195,7 @@ namespace Claunia.PropertyList
Indent(xml, level);
xml.Append("<array>");
xml.Append(NEWLINE);
foreach(NSObject o in array)
{
o.ToXml(xml, level + 1);
@@ -240,23 +209,23 @@ namespace Claunia.PropertyList
internal override void AssignIDs(BinaryPropertyListWriter outPlist)
{
base.AssignIDs(outPlist);
foreach(NSObject obj in array) obj.AssignIDs(outPlist);
foreach(NSObject obj in array)
obj.AssignIDs(outPlist);
}
internal override void ToBinary(BinaryPropertyListWriter outPlist)
{
outPlist.WriteIntHeader(0xA, array.Count);
foreach(NSObject obj in array) outPlist.WriteID(outPlist.GetID(obj));
foreach(NSObject obj in array)
outPlist.WriteID(outPlist.GetID(obj));
}
/// <summary>
/// <para>Generates a valid ASCII property list which has this NSArray as its root object.</para>
/// <para>
/// Generates a valid ASCII property list which has this NSArray as its
/// root object.
/// </para>
/// <para>
/// The generated property list complies with the format as
/// described in
/// The generated property list complies with the format as described in
/// https://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/PropertyLists/OldStylePlists/OldStylePLists.html
/// Property List Programming Guide - Old-Style ASCII Property Lists.
/// </para>
@@ -264,30 +233,28 @@ namespace Claunia.PropertyList
/// <returns>ASCII representation of this object.</returns>
public string ToASCIIPropertyList()
{
StringBuilder ascii = new StringBuilder();
var ascii = new StringBuilder();
ToASCII(ascii, 0);
ascii.Append(NEWLINE);
return ascii.ToString();
}
/// <summary>
/// <para>Generates a valid ASCII property list in GnuStep format which has this NSArray as its root object.</para>
/// <para>
/// Generates a valid ASCII property list in GnuStep format which has this
/// NSArray as its root object.
/// </para>
/// <para>
/// The generated property list complies with
/// the format as described in
/// http://www.gnustep.org/resources/documentation/Developer/Base/Reference/NSPropertyList.html
/// GnuStep - NSPropertyListSerialization class documentation.
/// The generated property list complies with the format as described in
/// http://www.gnustep.org/resources/documentation/Developer/Base/Reference/NSPropertyList.html GnuStep -
/// NSPropertyListSerialization class documentation.
/// </para>
/// </summary>
/// <returns>GnuStep ASCII representation of this object.</returns>
public string ToGnuStepASCIIPropertyList()
{
StringBuilder ascii = new StringBuilder();
var ascii = new StringBuilder();
ToASCIIGnuStep(ascii, 0);
ascii.Append(NEWLINE);
return ascii.ToString();
}
@@ -296,11 +263,11 @@ namespace Claunia.PropertyList
Indent(ascii, level);
ascii.Append(ASCIIPropertyListParser.ARRAY_BEGIN_TOKEN);
int indexOfLastNewLine = ascii.ToString().LastIndexOf(NEWLINE, StringComparison.Ordinal);
for(int i = 0; i < array.Count; i++)
{
Type objClass = array[i].GetType();
if((objClass.Equals(typeof(NSDictionary)) || objClass.Equals(typeof(NSArray)) ||
objClass.Equals(typeof(NSData))) && indexOfLastNewLine != ascii.Length)
if((array[i] is NSDictionary || array[i] is NSArray || array[i] is NSData) &&
indexOfLastNewLine != ascii.Length)
{
ascii.Append(NEWLINE);
indexOfLastNewLine = ascii.Length;
@@ -308,17 +275,20 @@ namespace Claunia.PropertyList
}
else
{
if(i != 0) ascii.Append(" ");
if(i != 0)
ascii.Append(" ");
array[i].ToASCII(ascii, 0);
}
if(i != array.Count - 1) ascii.Append(ASCIIPropertyListParser.ARRAY_ITEM_DELIMITER_TOKEN);
if(i != array.Count - 1)
ascii.Append(ASCIIPropertyListParser.ARRAY_ITEM_DELIMITER_TOKEN);
if(ascii.Length - indexOfLastNewLine > ASCII_LINE_LENGTH)
{
ascii.Append(NEWLINE);
indexOfLastNewLine = ascii.Length;
}
if(ascii.Length - indexOfLastNewLine <= ASCII_LINE_LENGTH)
continue;
ascii.Append(NEWLINE);
indexOfLastNewLine = ascii.Length;
}
ascii.Append(ASCIIPropertyListParser.ARRAY_END_TOKEN);
@@ -329,11 +299,13 @@ namespace Claunia.PropertyList
Indent(ascii, level);
ascii.Append(ASCIIPropertyListParser.ARRAY_BEGIN_TOKEN);
int indexOfLastNewLine = ascii.ToString().LastIndexOf(NEWLINE, StringComparison.Ordinal);
for(int i = 0; i < array.Count; i++)
{
Type objClass = array[i].GetType();
if((objClass.Equals(typeof(NSDictionary)) || objClass.Equals(typeof(NSArray)) ||
objClass.Equals(typeof(NSData))) && indexOfLastNewLine != ascii.Length)
if((array[i] is NSDictionary || array[i] is NSArray || array[i] is NSData) &&
indexOfLastNewLine != ascii.Length)
{
ascii.Append(NEWLINE);
indexOfLastNewLine = ascii.Length;
@@ -341,17 +313,20 @@ namespace Claunia.PropertyList
}
else
{
if(i != 0) ascii.Append(" ");
if(i != 0)
ascii.Append(" ");
array[i].ToASCIIGnuStep(ascii, 0);
}
if(i != array.Count - 1) ascii.Append(ASCIIPropertyListParser.ARRAY_ITEM_DELIMITER_TOKEN);
if(i != array.Count - 1)
ascii.Append(ASCIIPropertyListParser.ARRAY_ITEM_DELIMITER_TOKEN);
if(ascii.Length - indexOfLastNewLine > ASCII_LINE_LENGTH)
{
ascii.Append(NEWLINE);
indexOfLastNewLine = ascii.Length;
}
if(ascii.Length - indexOfLastNewLine <= ASCII_LINE_LENGTH)
continue;
ascii.Append(NEWLINE);
indexOfLastNewLine = ascii.Length;
}
ascii.Append(ASCIIPropertyListParser.ARRAY_END_TOKEN);
@@ -371,12 +346,14 @@ namespace Claunia.PropertyList
/// </returns>
public override bool Equals(NSObject obj)
{
if(!(obj is NSArray)) return false;
if(obj is not NSArray nsArray)
return false;
if(array.Count != ((NSArray)obj).array.Count) return false;
if(array.Count != nsArray.array.Count)
return false;
for(int i = 0; i < array.Count; i++)
if(!array[i].Equals(((NSArray)obj)[i]))
if(!array[i].Equals(nsArray[i]))
return false;
return true;

109
plist-cil/NSData.cs
View File

@@ -29,9 +29,7 @@ using System.Text;
namespace Claunia.PropertyList
{
/// <summary>
/// NSData objects are wrappers for byte buffers
/// </summary>
/// <summary>NSData objects are wrappers for byte buffers</summary>
/// @author Daniel Dreibrodt
/// @author Natalia Portillo
public class NSData : NSObject
@@ -40,78 +38,51 @@ namespace Claunia.PropertyList
// Each line contains 68 characters.
const int DataLineLength = 68;
/// <summary>
/// Creates the NSData object from the binary representation of it.
/// </summary>
/// <summary>Creates the NSData object from the binary representation of it.</summary>
/// <param name="bytes">The raw data contained in the NSData object.</param>
public NSData(byte[] bytes)
{
Bytes = bytes;
}
public NSData(byte[] bytes) => Bytes = bytes;
/// <summary>
/// Creates a NSData object from its textual representation, which is a Base64 encoded amount of bytes.
/// </summary>
/// <summary>Creates a NSData object from its textual representation, which is a Base64 encoded amount of bytes.</summary>
/// <param name="base64">The Base64 encoded contents of the NSData object.</param>
/// <exception cref="FormatException">When the given string is not a proper Base64 formatted string.</exception>
public NSData(string base64)
{
Bytes = Convert.FromBase64String(base64);
}
public NSData(string base64) => Bytes = Convert.FromBase64String(base64);
/// <summary>
/// Creates a NSData object from a file. Using the files contents as the contents of this NSData object.
/// </summary>
/// <summary>Creates a NSData object from a file. Using the files contents as the contents of this NSData object.</summary>
/// <param name="file">The file containing the data.</param>
/// <exception cref="FileNotFoundException">If the file could not be found.</exception>
/// <exception cref="IOException">If the file could not be read.</exception>
public NSData(FileInfo file)
{
Bytes = new byte[(int)file.Length];
using(FileStream raf = file.OpenRead()) raf.Read(Bytes, 0, (int)file.Length);
using FileStream raf = file.OpenRead();
raf.Read(Bytes, 0, (int)file.Length);
}
/// <summary>
/// The bytes contained in this NSData object.
/// </summary>
/// <summary>The bytes contained in this NSData object.</summary>
/// <value>The data as bytes</value>
public byte[] Bytes { get; }
/// <summary>
/// Gets the amount of data stored in this object.
/// </summary>
/// <summary>Gets the amount of data stored in this object.</summary>
/// <value>The number of bytes contained in this object.</value>
public int Length => Bytes.Length;
/// <summary>
/// Loads the bytes from this NSData object into a byte buffer.
/// </summary>
/// <summary>Loads the bytes from this NSData object into a byte buffer.</summary>
/// <param name="buf">The byte buffer which will contain the data</param>
/// <param name="length">The amount of data to copy</param>
public void GetBytes(MemoryStream buf, int length)
{
buf.Write(Bytes, 0, Math.Min(Bytes.Length, length));
}
public void GetBytes(MemoryStream buf, int length) => buf.Write(Bytes, 0, Math.Min(Bytes.Length, length));
/// <summary>
/// Loads the bytes from this NSData object into a byte buffer.
/// </summary>
/// <summary>Loads the bytes from this NSData object into a byte buffer.</summary>
/// <param name="buf">The byte buffer which will contain the data</param>
/// <param name="rangeStart">The start index.</param>
/// <param name="rangeStop">The stop index.</param>
public void GetBytes(MemoryStream buf, int rangeStart, int rangeStop)
{
public void GetBytes(MemoryStream buf, int rangeStart, int rangeStop) =>
buf.Write(Bytes, rangeStart, Math.Min(Bytes.Length, rangeStop));
}
/// <summary>
/// Gets the Base64 encoded data contained in this NSData object.
/// </summary>
/// <summary>Gets the Base64 encoded data contained in this NSData object.</summary>
/// <returns>The Base64 encoded data as a <c>string</c>.</returns>
public string GetBase64EncodedData()
{
return Convert.ToBase64String(Bytes);
}
public string GetBase64EncodedData() => Convert.ToBase64String(Bytes);
/// <summary>
/// Determines whether the specified <see cref="System.Object" /> is equal to the current
@@ -125,14 +96,10 @@ namespace Claunia.PropertyList
/// <c>true</c> if the specified <see cref="System.Object" /> is equal to the current
/// <see cref="Claunia.PropertyList.NSData" />; otherwise, <c>false</c>.
/// </returns>
public override bool Equals(object obj)
{
return obj.GetType().Equals(GetType()) && ArrayEquals(((NSData)obj).Bytes, Bytes);
}
public override bool Equals(object obj) =>
obj.GetType().Equals(GetType()) && ArrayEquals(((NSData)obj).Bytes, Bytes);
/// <summary>
/// Serves as a hash function for a <see cref="Claunia.PropertyList.NSData" /> object.
/// </summary>
/// <summary>Serves as a hash function for a <see cref="Claunia.PropertyList.NSData" /> object.</summary>
/// <returns>
/// A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a
/// hash table.
@@ -140,7 +107,8 @@ namespace Claunia.PropertyList
public override int GetHashCode()
{
int hash = 5;
hash = 67 * hash + Bytes.GetHashCode();
hash = (67 * hash) + Bytes.GetHashCode();
return hash;
}
@@ -150,6 +118,7 @@ namespace Claunia.PropertyList
xml.Append("<data>");
xml.Append(NEWLINE);
string base64 = GetBase64EncodedData();
foreach(string line in base64.Split('\n'))
for(int offset = 0; offset < base64.Length; offset += DataLineLength)
{
@@ -173,25 +142,26 @@ namespace Claunia.PropertyList
Indent(ascii, level);
ascii.Append(ASCIIPropertyListParser.DATA_BEGIN_TOKEN);
int indexOfLastNewLine = ascii.ToString().LastIndexOf(NEWLINE, StringComparison.Ordinal);
for(int i = 0; i < Bytes.Length; i++)
{
int b = Bytes[i] & 0xFF;
ascii.Append(string.Format("{0:x2}", b));
ascii.Append($"{b:x2}");
if(ascii.Length - indexOfLastNewLine > ASCII_LINE_LENGTH)
{
ascii.Append(NEWLINE);
indexOfLastNewLine = ascii.Length;
}
else if((i + 1) % 2 == 0 && i != Bytes.Length - 1) ascii.Append(" ");
else if((i + 1) % 2 == 0 &&
i != Bytes.Length - 1)
ascii.Append(" ");
}
ascii.Append(ASCIIPropertyListParser.DATA_END_TOKEN);
}
internal override void ToASCIIGnuStep(StringBuilder ascii, int level)
{
ToASCII(ascii, level);
}
internal override void ToASCIIGnuStep(StringBuilder ascii, int level) => ToASCII(ascii, level);
/// <summary>
/// Determines whether the specified <see cref="Claunia.PropertyList.NSObject" /> is equal to the current
@@ -205,21 +175,10 @@ namespace Claunia.PropertyList
/// <c>true</c> if the specified <see cref="Claunia.PropertyList.NSObject" /> is equal to the current
/// <see cref="Claunia.PropertyList.NSData" />; otherwise, <c>false</c>.
/// </returns>
public override bool Equals(NSObject obj)
{
if(!(obj is NSData)) return false;
public override bool Equals(NSObject obj) => obj is NSData data && ArrayEquals(Bytes, data.Bytes);
return ArrayEquals(Bytes, ((NSData)obj).Bytes);
}
public static explicit operator byte[](NSData value) => value.Bytes;
public static explicit operator byte[](NSData value)
{
return value.Bytes;
}
public static explicit operator NSData(byte[] value)
{
return new NSData(value);
}
public static explicit operator NSData(byte[] value) => new(value);
}
}

109
plist-cil/NSDate.cs
View File

@@ -29,92 +29,69 @@ using System.Text;
namespace Claunia.PropertyList
{
/// <summary>
/// Represents a date
/// </summary>
/// <summary>Represents a date</summary>
/// @author Daniel Dreibrodt
/// @author Natalia Portillo
public class NSDate : NSObject
{
static readonly DateTime EPOCH = new DateTime(2001, 1, 1, 0, 0, 0, DateTimeKind.Utc);
static readonly DateTime EPOCH = new(2001, 1, 1, 0, 0, 0, DateTimeKind.Utc);
// The datetime ends with 'Z', which indicates UTC time. To make sure .NET
// understands the 'Z' character as a timezone, specify the 'K' format string.
static readonly string sdfDefault = "yyyy-MM-dd'T'HH:mm:ssK";
static readonly string sdfGnuStep = "yyyy-MM-dd HH:mm:ss zzz";
static readonly string[] sdfAll = { sdfDefault, sdfGnuStep };
static readonly string[] sdfAll =
{
sdfDefault, sdfGnuStep
};
static readonly CultureInfo provider = CultureInfo.InvariantCulture;
/// <summary>
/// Creates a date from its binary representation.
/// </summary>
/// <summary>Creates a date from its binary representation.</summary>
/// <param name="bytes">bytes The date bytes</param>
public NSDate(ReadOnlySpan<byte> bytes)
{
public NSDate(ReadOnlySpan<byte> bytes) =>
//dates are 8 byte big-endian double, seconds since the epoch
Date = EPOCH.AddSeconds(BinaryPropertyListParser.ParseDouble(bytes));
}
/// <summary>
/// Parses a date from its textual representation.
/// That representation has the following pattern: <code>yyyy-MM-dd'T'HH:mm:ss'Z'</code>
/// Parses a date from its textual representation. That representation has the following pattern:
/// <code>yyyy-MM-dd'T'HH:mm:ss'Z'</code>
/// </summary>
/// <param name="textRepresentation">The textual representation of the date (ISO 8601 format)</param>
/// <exception cref="FormatException">When the date could not be parsed, i.e. it does not match the expected pattern.</exception>
public NSDate(string textRepresentation)
{
Date = ParseDateString(textRepresentation);
}
public NSDate(string textRepresentation) => Date = ParseDateString(textRepresentation);
/// <summary>
/// Creates a NSDate from a .NET DateTime
/// </summary>
/// <summary>Creates a NSDate from a .NET DateTime</summary>
/// <param name="d">The date</param>
public NSDate(DateTime d)
{
Date = d;
}
public NSDate(DateTime d) => Date = d;
/// <summary>
/// Gets the date.
/// </summary>
/// <summary>Gets the date.</summary>
/// <returns>The date.</returns>
public DateTime Date { get; }
/// <summary>
/// Parses the XML date string and creates a .NET DateTime object from it.
/// </summary>
/// <summary>Parses the XML date string and creates a .NET DateTime object from it.</summary>
/// <returns>The parsed Date</returns>
/// <param name="textRepresentation">The date string as found in the XML property list</param>
/// <exception cref="FormatException">Given string cannot be parsed</exception>
static DateTime ParseDateString(string textRepresentation)
{
return DateTime.ParseExact(textRepresentation, sdfAll, provider, DateTimeStyles.None);
}
static DateTime ParseDateString(string textRepresentation) =>
DateTime.ParseExact(textRepresentation, sdfAll, provider, DateTimeStyles.None);
/// <summary>
/// Generates a String representation of a .NET DateTime object. The string
/// is formatted according to the specification for XML property list dates.
/// Generates a String representation of a .NET DateTime object. The string is formatted according to the
/// specification for XML property list dates.
/// </summary>
/// <param name="date">The date which should be represented.</param>
/// <returns>The string representation of the date.</returns>
public static string MakeDateString(DateTime date)
{
return date.ToUniversalTime().ToString(sdfDefault, provider);
}
public static string MakeDateString(DateTime date) => date.ToUniversalTime().ToString(sdfDefault, provider);
/// <summary>
/// Generates a String representation of a .NET DateTime object. The string
/// is formatted according to the specification for GnuStep ASCII property
/// list dates.
/// Generates a String representation of a .NET DateTime object. The string is formatted according to the
/// specification for GnuStep ASCII property list dates.
/// </summary>
/// <param name="date">The date which should be represented.</param>
/// <returns>The string representation of the date.</returns>
static string MakeDateStringGnuStep(DateTime date)
{
return date.ToString(sdfGnuStep, provider);
}
static string MakeDateStringGnuStep(DateTime date) => date.ToString(sdfGnuStep, provider);
/// <summary>
/// Determines whether the specified <see cref="System.Object" /> is equal to the current
@@ -128,22 +105,14 @@ namespace Claunia.PropertyList
/// <c>true</c> if the specified <see cref="System.Object" /> is equal to the current
/// <see cref="Claunia.PropertyList.NSDate" />; otherwise, <c>false</c>.
/// </returns>
public override bool Equals(object obj)
{
return obj.GetType().Equals(GetType()) && Date.Equals(((NSDate)obj).Date);
}
public override bool Equals(object obj) => obj.GetType().Equals(GetType()) && Date.Equals(((NSDate)obj).Date);
/// <summary>
/// Serves as a hash function for a <see cref="Claunia.PropertyList.NSDate" /> object.
/// </summary>
/// <summary>Serves as a hash function for a <see cref="Claunia.PropertyList.NSDate" /> object.</summary>
/// <returns>
/// A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a
/// hash table.
/// </returns>
public override int GetHashCode()
{
return Date.GetHashCode();
}
public override int GetHashCode() => Date.GetHashCode();
internal override void ToXml(StringBuilder xml, int level)
{
@@ -159,14 +128,9 @@ namespace Claunia.PropertyList
outPlist.WriteDouble((Date - EPOCH).TotalSeconds);
}
/// <summary>
/// Generates a string representation of the date.
/// </summary>
/// <summary>Generates a string representation of the date.</summary>
/// <returns>A string representation of the date.</returns>
public override string ToString()
{
return Date.ToString();
}
public override string ToString() => Date.ToString();
internal override void ToASCII(StringBuilder ascii, int level)
{
@@ -198,21 +162,16 @@ namespace Claunia.PropertyList
/// </returns>
public override bool Equals(NSObject obj)
{
if(!(obj is NSDate)) return false;
if(obj is not NSDate date)
return false;
int equality = DateTime.Compare(Date, ((NSDate)obj).Date);
int equality = DateTime.Compare(Date, date.Date);
return equality == 0;
}
public static explicit operator DateTime(NSDate value)
{
return value.Date;
}
public static explicit operator DateTime(NSDate value) => value.Date;
public static explicit operator NSDate(DateTime value)
{
return new NSDate(value);
}
public static explicit operator NSDate(DateTime value) => new(value);
}
}

366
plist-cil/NSDictionary.cs
View File

@@ -32,16 +32,11 @@ namespace Claunia.PropertyList
{
/// <summary>
/// <para>
/// A NSDictionary is a collection of keys and values, essentially a Dictionary.
/// The keys are simple Strings whereas the values can be any kind of NSObject.
/// </para>
/// <para>
/// You can access the keys through the function <see cref="Keys" />.
/// </para>
/// <para>
/// Access to the objects stored for each key is given through the function
/// <see cref="ObjectForKey" />.
/// A NSDictionary is a collection of keys and values, essentially a Dictionary. The keys are simple Strings
/// whereas the values can be any kind of NSObject.
/// </para>
/// <para>You can access the keys through the function <see cref="Keys" />.</para>
/// <para>Access to the objects stored for each key is given through the function <see cref="ObjectForKey" />.</para>
/// </summary>
/// @author Daniel Dreibrodt
/// @author Natalia Portillo
@@ -50,120 +45,88 @@ namespace Claunia.PropertyList
readonly Dictionary<string, NSObject> dict;
// Maps the keys in this dictionary to their NSString equivalent. Makes sure the NSString
// object remains constant accross calls to AssignIDs and ToBinary
// object remains constant across calls to AssignIDs and ToBinary
readonly Dictionary<string, NSString> keys;
/// <summary>
/// Creates a new empty NSDictionary with a specific capacity.
/// </summary>
/// <param name="capacity">
/// The capacity of the dictionary.
/// </param>
/// <summary>Creates a new empty NSDictionary with a specific capacity.</summary>
/// <param name="capacity">The capacity of the dictionary.</param>
public NSDictionary(int capacity)
{
dict = new Dictionary<string, NSObject>(capacity);
keys = new Dictionary<string, NSString>(capacity);
}
/// <summary>
/// Creates a new empty NSDictionary.
/// </summary>
public NSDictionary() : this(0) { }
/// <summary>Creates a new empty NSDictionary.</summary>
public NSDictionary() : this(0) {}
/// <summary>
/// Gets a value indicating whether this instance is empty.
/// </summary>
/// <summary>Gets a value indicating whether this instance is empty.</summary>
/// <value><c>true</c> if this instance is empty; otherwise, <c>false</c>.</value>
public bool IsEmpty => dict.Count == 0;
#region IEnumerable implementation
/// <summary>
/// Gets the enumerator.
/// </summary>
/// <summary>Gets the enumerator.</summary>
/// <returns>The enumerator.</returns>
public IEnumerator<KeyValuePair<string, NSObject>> GetEnumerator()
{
return dict.GetEnumerator();
}
public IEnumerator<KeyValuePair<string, NSObject>> GetEnumerator() => dict.GetEnumerator();
#endregion
#region IEnumerable implementation
IEnumerator IEnumerable.GetEnumerator()
{
return dict.GetEnumerator();
}
IEnumerator IEnumerable.GetEnumerator() => dict.GetEnumerator();
#endregion
/// <summary>
/// Gets the hashmap which stores the keys and values of this dictionary.
/// Changes to the hashmap's contents are directly reflected in this
/// dictionary.
/// Gets the hashmap which stores the keys and values of this dictionary. Changes to the hashmap's contents are
/// directly reflected in this dictionary.
/// </summary>
/// <returns>The hashmap which is used by this dictionary to store its contents.</returns>
public Dictionary<string, NSObject> GetDictionary()
{
return dict;
}
public Dictionary<string, NSObject> GetDictionary() => dict;
/// <summary>
/// Gets the NSObject stored for the given key.
/// </summary>
/// <summary>Gets the NSObject stored for the given key.</summary>
/// <returns>The object.</returns>
/// <param name="key">The key.</param>
public NSObject ObjectForKey(string key)
{
NSObject nso;
return dict.TryGetValue(key, out nso) ? nso : null;
}
/// <summary>
/// Checks if the specified object key is contained in the current instance.
/// </summary>
/// <summary>Checks if the specified object key is contained in the current instance.</summary>
/// <returns><c>true</c>, if key is contained, <c>false</c> otherwise.</returns>
/// <param name="key">Key.</param>
public bool ContainsKey(object key)
{
return key is string && dict.ContainsKey((string)key);
}
public bool ContainsKey(object key) => key is string s && dict.ContainsKey(s);
/// <summary>
/// Removes the item corresponding to the specified key from the current instance, if found.
/// </summary>
/// <summary>Removes the item corresponding to the specified key from the current instance, if found.</summary>
/// <param name="key">Key.</param>
/// <returns><c>true</c>, if removed, <c>false</c> otherwise.</returns>
public bool Remove(object key)
{
return key is string && dict.Remove((string)key);
}
public bool Remove(object key) => key is string s && dict.Remove(s);
/// <summary>
/// Gets the <see cref="NSObject" /> corresponding to the specified key from the current instance.
/// </summary>
/// <summary>Gets the <see cref="NSObject" /> corresponding to the specified key from the current instance.</summary>
/// <param name="key">Key.</param>
/// <returns>The object corresponding to the specified key, null if not found in the current instance.</returns>
public NSObject Get(object key)
{
if(key is string) return ObjectForKey((string)key);
if(key is string s)
return ObjectForKey(s);
return null;
}
/// <summary>
/// Checks if the current instance contains the object corresponding to the specified key.
/// </summary>
/// <summary>Checks if the current instance contains the object corresponding to the specified key.</summary>
/// <returns><c>true</c>, if value is contained, <c>false</c> otherwise.</returns>
/// <param name="value">Object to search up in the current instance.</param>
public bool ContainsValue(object value)
{
if(value == null) return false;
if(value == null)
return false;
NSObject wrap = Wrap(value);
return dict.ContainsValue(wrap);
}
/// <summary>
/// Puts a new key-value pair into this dictionary.
/// If the value is null, no operation will be performed on the dictionary.
/// Puts a new key-value pair into this dictionary. If the value is null, no operation will be performed on the
/// dictionary.
/// </summary>
/// <param name="key">The key.</param>
/// <param name="obj">
@@ -172,139 +135,104 @@ namespace Claunia.PropertyList
/// </param>
public void Add(string key, object obj)
{
if(obj == null) return;
if(obj == null)
return;
Add(key, Wrap(obj));
}
/// <summary>
/// Puts a new key-value pair into this dictionary.
/// </summary>
/// <summary>Puts a new key-value pair into this dictionary.</summary>
/// <param name="key">The key.</param>
/// <param name="obj">The value.</param>
public void Add(string key, long obj)
{
Add(key, new NSNumber(obj));
}
public void Add(string key, long obj) => Add(key, new NSNumber(obj));
/// <summary>
/// Puts a new key-value pair into this dictionary.
/// </summary>
/// <summary>Puts a new key-value pair into this dictionary.</summary>
/// <param name="key">The key.</param>
/// <param name="obj">The value.</param>
public void Add(string key, double obj)
{
Add(key, new NSNumber(obj));
}
public void Add(string key, double obj) => Add(key, new NSNumber(obj));
/// <summary>
/// Puts a new key-value pair into this dictionary.
/// </summary>
/// <summary>Puts a new key-value pair into this dictionary.</summary>
/// <param name="key">The key.</param>
/// <param name="obj">The value.</param>
public void Add(string key, bool obj)
{
Add(key, new NSNumber(obj));
}
public void Add(string key, bool obj) => Add(key, new NSNumber(obj));
/// <summary>
/// Checks whether a given value is contained in this dictionary.
/// </summary>
/// <summary>Checks whether a given value is contained in this dictionary.</summary>
/// <param name="val">The value that will be searched for.</param>
/// <returns>Whether the key is contained in this dictionary.</returns>
public bool ContainsValue(string val)
{
foreach(NSObject o in dict.Values)
if(o.GetType().Equals(typeof(NSString)))
{
NSString str = (NSString)o;
if(str.Content.Equals(val)) return true;
}
if(o is NSString str &&
str.Content.Equals(val))
return true;
return false;
}
/// <summary>
/// Checks whether a given value is contained in this dictionary.
/// </summary>
/// <summary>Checks whether a given value is contained in this dictionary.</summary>
/// <param name="val">The value that will be searched for.</param>
/// <returns>Whether the key is contained in this dictionary.</returns>
public bool ContainsValue(long val)
{
foreach(NSObject o in dict.Values)
if(o.GetType().Equals(typeof(NSNumber)))
{
NSNumber num = (NSNumber)o;
if(num.isInteger() && num.ToInt() == val) return true;
}
if(o is NSNumber num &&
num.isInteger() &&
num.ToInt() == val)
return true;
return false;
}
/// <summary>
/// Checks whether a given value is contained in this dictionary.
/// </summary>
/// <summary>Checks whether a given value is contained in this dictionary.</summary>
/// <param name="val">The value that will be searched for.</param>
/// <returns>Whether the key is contained in this dictionary.</returns>
public bool ContainsValue(double val)
{
foreach(NSObject o in dict.Values)
if(o.GetType().Equals(typeof(NSNumber)))
{
NSNumber num = (NSNumber)o;
if(num.isReal() && num.ToDouble() == val) return true;
}
if(o is NSNumber num &&
num.isReal() &&
num.ToDouble() == val)
return true;
return false;
}
/// <summary>
/// Checks whether a given value is contained in this dictionary.
/// </summary>
/// <summary>Checks whether a given value is contained in this dictionary.</summary>
/// <param name="val">The value that will be searched for.</param>
/// <returns>Whether the key is contained in this dictionary.</returns>
public bool ContainsValue(bool val)
{
foreach(NSObject o in dict.Values)
if(o.GetType().Equals(typeof(NSNumber)))
{
NSNumber num = (NSNumber)o;
if(num.isBoolean() && num.ToBool() == val) return true;
}
if(o is NSNumber num &&
num.isBoolean() &&
num.ToBool() == val)
return true;
return false;
}
/// <summary>
/// Checks whether a given value is contained in this dictionary.
/// </summary>
/// <summary>Checks whether a given value is contained in this dictionary.</summary>
/// <param name="val">The value that will be searched for.</param>
/// <returns>Whether the key is contained in this dictionary.</returns>
public bool ContainsValue(DateTime val)
{
foreach(NSObject o in dict.Values)
if(o.GetType().Equals(typeof(NSDate)))
{
NSDate dat = (NSDate)o;
if(dat.Date.Equals(val)) return true;
}
if(o is NSDate dat &&
dat.Date.Equals(val))
return true;
return false;
}
/// <summary>
/// Checks whether a given value is contained in this dictionary.
/// </summary>
/// <summary>Checks whether a given value is contained in this dictionary.</summary>
/// <param name="val">The value that will be searched for.</param>
/// <returns>Whether the key is contained in this dictionary.</returns>
public bool ContainsValue(byte[] val)
{
foreach(NSObject o in dict.Values)
if(o.GetType().Equals(typeof(NSData)))
{
NSData dat = (NSData)o;
if(ArrayEquals(dat.Bytes, val)) return true;
}
if(o is NSData dat &&
ArrayEquals(dat.Bytes, val))
return true;
return false;
}
@@ -323,26 +251,27 @@ namespace Claunia.PropertyList
/// </returns>
public override bool Equals(NSObject obj)
{
if(!(obj is NSDictionary)) return false;
if(obj is not NSDictionary dictionary)
return false;
if(((NSDictionary)obj).dict.Count != dict.Count) return false;
bool found;
if(dictionary.dict.Count != dict.Count)
return false;
foreach(KeyValuePair<string, NSObject> kvp in dict)
{
NSObject nsoB;
found = ((NSDictionary)obj).dict.TryGetValue(kvp.Key, out nsoB);
if(!found) return false;
if(!kvp.Value.Equals(nsoB)) return false;
bool found = dictionary.dict.TryGetValue(kvp.Key, out NSObject nsoB);
if(!found)
return false;
if(!kvp.Value.Equals(nsoB))
return false;
}
return true;
}
/// <summary>
/// Serves as a hash function for a <see cref="Claunia.PropertyList.NSDictionary" /> object.
/// </summary>
/// <summary>Serves as a hash function for a <see cref="Claunia.PropertyList.NSDictionary" /> object.</summary>
/// <returns>
/// A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a
/// hash table.
@@ -350,7 +279,8 @@ namespace Claunia.PropertyList
public override int GetHashCode()
{
int hash = 7;
hash = 83 * hash + (dict != null ? dict.GetHashCode() : 0);
hash = (83 * hash) + (dict != null ? dict.GetHashCode() : 0);
return hash;
}
@@ -359,19 +289,24 @@ namespace Claunia.PropertyList
Indent(xml, level);
xml.Append("<dict>");
xml.Append(NEWLINE);
foreach(KeyValuePair<string, NSObject> kvp in dict)
{
Indent(xml, level + 1);
xml.Append("<key>");
//According to http://www.w3.org/TR/REC-xml/#syntax node values must not
//contain the characters < or &. Also the > character should be escaped.
if(kvp.Key.Contains("&") || kvp.Key.Contains("<") || kvp.Key.Contains(">"))
if(kvp.Key.Contains("&") ||
kvp.Key.Contains("<") ||
kvp.Key.Contains(">"))
{
xml.Append("<![CDATA[");
xml.Append(kvp.Key.Replace("]]>", "]]]]><![CDATA[>"));
xml.Append("]]>");
}
else xml.Append(kvp.Key);
else
xml.Append(kvp.Key);
xml.Append("</key>");
xml.Append(NEWLINE);
@@ -387,47 +322,53 @@ namespace Claunia.PropertyList
{
base.AssignIDs(outPlist);
foreach(KeyValuePair<string, NSObject> entry in dict) keys[entry.Key].AssignIDs(outPlist);
foreach(KeyValuePair<string, NSObject> entry in dict)
keys[entry.Key].AssignIDs(outPlist);
foreach(KeyValuePair<string, NSObject> entry in dict) entry.Value.AssignIDs(outPlist);
foreach(KeyValuePair<string, NSObject> entry in dict)
entry.Value.AssignIDs(outPlist);
}
internal override void ToBinary(BinaryPropertyListWriter outPlist)
{
outPlist.WriteIntHeader(0xD, dict.Count);
foreach(KeyValuePair<string, NSObject> entry in dict) outPlist.WriteID(outPlist.GetID(keys[entry.Key]));
foreach(KeyValuePair<string, NSObject> entry in dict) outPlist.WriteID(outPlist.GetID(entry.Value));
foreach(KeyValuePair<string, NSObject> entry in dict)
outPlist.WriteID(outPlist.GetID(keys[entry.Key]));
foreach(KeyValuePair<string, NSObject> entry in dict)
outPlist.WriteID(outPlist.GetID(entry.Value));
}
/// <summary>
/// Generates a valid ASCII property list which has this NSDictionary as its
/// root object. The generated property list complies with the format as
/// described in
/// Generates a valid ASCII property list which has this NSDictionary as its root object. The generated property
/// list complies with the format as described in
/// https://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/PropertyLists/OldStylePlists/OldStylePLists.html
/// Property List Programming Guide - Old-Style ASCII Property Lists.
/// </summary>
/// <returns>ASCII representation of this object.</returns>
public string ToASCIIPropertyList()
{
StringBuilder ascii = new StringBuilder();
var ascii = new StringBuilder();
ToASCII(ascii, 0);
ascii.Append(NEWLINE);
return ascii.ToString();
}
/// <summary>
/// Generates a valid ASCII property list in GnuStep format which has this
/// NSDictionary as its root object. The generated property list complies with
/// the format as described in
/// http://www.gnustep.org/resources/documentation/Developer/Base/Reference/NSPropertyList.html
/// GnuStep - NSPropertyListSerialization class documentation.
/// Generates a valid ASCII property list in GnuStep format which has this NSDictionary as its root object. The
/// generated property list complies with the format as described in
/// http://www.gnustep.org/resources/documentation/Developer/Base/Reference/NSPropertyList.html GnuStep -
/// NSPropertyListSerialization class documentation.
/// </summary>
/// <returns>GnuStep ASCII representation of this object.</returns>
public string ToGnuStepASCIIPropertyList()
{
StringBuilder ascii = new StringBuilder();
var ascii = new StringBuilder();
ToASCIIGnuStep(ascii, 0);
ascii.Append(NEWLINE);
return ascii.ToString();
}
@@ -436,6 +377,7 @@ namespace Claunia.PropertyList
Indent(ascii, level);
ascii.Append(ASCIIPropertyListParser.DICTIONARY_BEGIN_TOKEN);
ascii.Append(NEWLINE);
foreach(string key in Keys)
{
NSObject val = ObjectForKey(key);
@@ -443,9 +385,8 @@ namespace Claunia.PropertyList
ascii.Append("\"");
ascii.Append(NSString.EscapeStringForASCII(key));
ascii.Append("\" =");
Type objClass = val.GetType();
if(objClass.Equals(typeof(NSDictionary)) || objClass.Equals(typeof(NSArray)) ||
objClass.Equals(typeof(NSData)))
if(val is NSDictionary or NSArray or NSData)
{
ascii.Append(NEWLINE);
val.ToASCII(ascii, level + 2);
@@ -469,6 +410,7 @@ namespace Claunia.PropertyList
Indent(ascii, level);
ascii.Append(ASCIIPropertyListParser.DICTIONARY_BEGIN_TOKEN);
ascii.Append(NEWLINE);
foreach(string key in Keys)
{
NSObject val = ObjectForKey(key);
@@ -476,9 +418,8 @@ namespace Claunia.PropertyList
ascii.Append("\"");
ascii.Append(NSString.EscapeStringForASCII(key));
ascii.Append("\" =");
Type objClass = val.GetType();
if(objClass.Equals(typeof(NSDictionary)) || objClass.Equals(typeof(NSArray)) ||
objClass.Equals(typeof(NSData)))
if(val is NSDictionary or NSArray or NSData)
{
ascii.Append(NEWLINE);
val.ToASCIIGnuStep(ascii, level + 2);
@@ -498,9 +439,7 @@ namespace Claunia.PropertyList
}
#region IDictionary implementation
/// <summary>
/// Add the specified key and value.
/// </summary>
/// <summary>Add the specified key and value.</summary>
/// <param name="key">Key.</param>
/// <param name="value">Value.</param>
public void Add(string key, NSObject value)
@@ -509,79 +448,56 @@ namespace Claunia.PropertyList
keys.Add(key, new NSString(key));
}
/// <summary>
/// Checks if there is any item contained in the current instance corresponding with the specified key.
/// </summary>
/// <summary>Checks if there is any item contained in the current instance corresponding with the specified key.</summary>
/// <returns><c>true</c>, if key was contained, <c>false</c> otherwise.</returns>
/// <param name="key">Key.</param>
public bool ContainsKey(string key)
{
return dict.ContainsKey(key);
}
public bool ContainsKey(string key) => dict.ContainsKey(key);
/// <summary>
/// Checks if there is any item contained in the current instance corresponding with the specified value.
/// </summary>
/// <summary>Checks if there is any item contained in the current instance corresponding with the specified value.</summary>
/// <returns><c>true</c>, if value is contained, <c>false</c> otherwise.</returns>
/// <param name="value">Key.</param>
public bool ContainsValue(NSObject value)
{
return dict.ContainsValue(value);
}
public bool ContainsValue(NSObject value) => dict.ContainsValue(value);
/// <summary>
/// Removes the item belonging to the specified key.
/// </summary>
/// <summary>Removes the item belonging to the specified key.</summary>
/// <param name="key">Key.</param>
public bool Remove(string key)
{
keys.Remove(key);
return dict.Remove(key);
}
/// <summary>
/// Tries to get the item corresponding to the specified key
/// </summary>
/// <summary>Tries to get the item corresponding to the specified key</summary>
/// <returns><c>true</c>, if get value was successfully found and retrieved, <c>false</c> otherwise.</returns>
/// <param name="key">Key.</param>
/// <param name="value">Where to store the value.</param>
public bool TryGetValue(string key, out NSObject value)
{
return dict.TryGetValue(key, out value);
}
public bool TryGetValue(string key, out NSObject value) => dict.TryGetValue(key, out value);
/// <summary>
/// Gets or sets the <see cref="Claunia.PropertyList.NSObject" /> at the specified index.
/// </summary>
/// <summary>Gets or sets the <see cref="Claunia.PropertyList.NSObject" /> at the specified index.</summary>
/// <param name="index">Index.</param>
public NSObject this[string index]
{
get => dict[index];
set
{
if(!keys.ContainsKey(index)) keys.Add(index, new NSString(index));
if(!keys.ContainsKey(index))
keys.Add(index, new NSString(index));
dict[index] = value;
}
}
/// <summary>
/// Gets an array with all the keys contained in the current instance.
/// </summary>
/// <summary>Gets an array with all the keys contained in the current instance.</summary>
/// <value>The keys.</value>
public ICollection<string> Keys => dict.Keys;
/// <summary>
/// Gets an array with all the objects contained in the current instance.
/// </summary>
/// <summary>Gets an array with all the objects contained in the current instance.</summary>
/// <value>The objects.</value>
public ICollection<NSObject> Values => dict.Values;
#endregion
#region ICollection implementation
/// <summary>
/// Adds the specified item.
/// </summary>
/// <summary>Adds the specified item.</summary>
/// <param name="item">Item.</param>
public void Add(KeyValuePair<string, NSObject> item)
{
@@ -589,24 +505,17 @@ namespace Claunia.PropertyList
dict.Add(item.Key, item.Value);
}
/// <summary>
/// Clears this instance.
/// </summary>
/// <summary>Clears this instance.</summary>
public void Clear()
{
keys.Clear();
dict.Clear();
}
/// <summary>
/// Checks if the current instance contains the specified item.
/// </summary>
/// <summary>Checks if the current instance contains the specified item.</summary>
/// <param name="item">Item.</param>
/// <returns><c>true</c> if it is found, <c>false</c> otherwise.</returns>
public bool Contains(KeyValuePair<string, NSObject> item)
{
return dict.ContainsKey(item.Key);
}
public bool Contains(KeyValuePair<string, NSObject> item) => dict.ContainsKey(item.Key);
/// <summary>
/// Copies the <see cref="Dictionary{TKey, TValue}.ValueCollection" /> elements to an existing one-dimensional
@@ -623,26 +532,21 @@ namespace Claunia.PropertyList
coll.CopyTo(array, arrayIndex);
}
/// <summary>
/// Removes the specified item.
/// </summary>
/// <summary>Removes the specified item.</summary>
/// <param name="item">Item to remove.</param>
/// <returns><c>true</c> if successfully removed, <c>false</c> if not, or if item is not in current instance.</returns>
public bool Remove(KeyValuePair<string, NSObject> item)
{
keys.Remove(item.Key);
return dict.Remove(item.Key);
}
/// <summary>
/// Gets the count of items in the current instance.
/// </summary>
/// <summary>Gets the count of items in the current instance.</summary>
/// <value>How many items are contained in the current instance.</value>
public int Count => dict.Count;
/// <summary>
/// Gets a value indicating whether this instance is read only.
/// </summary>
/// <summary>Gets a value indicating whether this instance is read only.</summary>
/// <value><c>true</c> if this instance is read only; otherwise, <c>false</c>.</value>
public bool IsReadOnly => false;
#endregion

422
plist-cil/NSNumber.cs
View File

@@ -29,30 +29,24 @@ using System.Text;
namespace Claunia.PropertyList
{
/// <summary>
/// A number whose value is either an integer, a real number or bool.
/// </summary>
/// <summary>A number whose value is either an integer, a real number or bool.</summary>
/// @author Daniel Dreibrodt
/// @author Natalia Portillo
public class NSNumber : NSObject, IComparable
{
/// <summary>
/// Indicates that the number's value is an integer.
/// The number is stored as a .NET <see cref="long" />.
/// Its original value could have been char, short, int, long or even long long.
/// Indicates that the number's value is an integer. The number is stored as a .NET <see cref="long" />. Its
/// original value could have been char, short, int, long or even long long.
/// </summary>
public const int INTEGER = 0;
/// <summary>
/// Indicates that the number's value is a real number.
/// The number is stored as a .NET <see cref="double" />.
/// Its original value could have been float or double.
/// Indicates that the number's value is a real number. The number is stored as a .NET <see cref="double" />. Its
/// original value could have been float or double.
/// </summary>
public const int REAL = 1;
/// <summary>
/// Indicates that the number's value is bool.
/// </summary>
/// <summary>Indicates that the number's value is bool.</summary>
public const int BOOLEAN = 2;
readonly bool boolValue;
readonly double doubleValue;
@@ -76,11 +70,13 @@ namespace Claunia.PropertyList
{
case INTEGER:
doubleValue = longValue = BinaryPropertyListParser.ParseLong(bytes);
break;
case REAL:
doubleValue = BinaryPropertyListParser.ParseDouble(bytes);
longValue = (long)Math.Round(doubleValue);
break;
default: throw new ArgumentException("Type argument is not valid.", nameof(type));
@@ -96,35 +92,38 @@ namespace Claunia.PropertyList
case INTEGER:
{
doubleValue = longValue = long.Parse(text, CultureInfo.InvariantCulture);
break;
}
case REAL:
{
doubleValue = double.Parse(text, CultureInfo.InvariantCulture);
longValue = (long)Math.Round(doubleValue);
break;
}
default: { throw new ArgumentException("Type argument is not valid."); }
default:
{
throw new ArgumentException("Type argument is not valid.");
}
}
this.type = type;
}
/// <summary>
/// Creates a number from its textual representation.
/// </summary>
/// <summary>Creates a number from its textual representation.</summary>
/// <param name="text">The textual representation of the number.</param>
/// <seealso cref="bool.Parse(string)" />
/// <seealso cref="long.Parse(string)" />
/// <seealso cref="double.Parse(string, IFormatProvider)" />
public NSNumber(string text)
{
if(text == null) throw new ArgumentException("The given string is null and cannot be parsed as number.");
if(text == null)
throw new ArgumentException("The given string is null and cannot be parsed as number.");
long l;
double d;
if(text.StartsWith("0x") && long.TryParse(text.Substring(2), NumberStyles.AllowHexSpecifier, CultureInfo.InvariantCulture, out l))
if(text.StartsWith("0x") &&
long.TryParse(text.Substring(2), NumberStyles.AllowHexSpecifier, CultureInfo.InvariantCulture,
out long l))
{
doubleValue = longValue = l;
type = INTEGER;
@@ -134,7 +133,7 @@ namespace Claunia.PropertyList
doubleValue = longValue = l;
type = INTEGER;
}
else if(double.TryParse(text, NumberStyles.Number, CultureInfo.InvariantCulture, out d))
else if(double.TryParse(text, NumberStyles.Number, CultureInfo.InvariantCulture, out double d))
{
doubleValue = d;
longValue = (long)Math.Round(doubleValue);
@@ -143,9 +142,10 @@ namespace Claunia.PropertyList
else
{
bool isTrue = string.Equals(text, "true", StringComparison.CurrentCultureIgnoreCase) ||
string.Equals(text, "yes", StringComparison.CurrentCultureIgnoreCase);
string.Equals(text, "yes", StringComparison.CurrentCultureIgnoreCase);
bool isFalse = string.Equals(text, "false", StringComparison.CurrentCultureIgnoreCase) ||
string.Equals(text, "no", StringComparison.CurrentCultureIgnoreCase);
string.Equals(text, "no", StringComparison.CurrentCultureIgnoreCase);
if(isTrue || isFalse)
{
@@ -159,9 +159,7 @@ namespace Claunia.PropertyList
}
}
/// <summary>
/// Creates an integer number.
/// </summary>
/// <summary>Creates an integer number.</summary>
/// <param name="i">The integer value.</param>
public NSNumber(int i)
{
@@ -169,9 +167,7 @@ namespace Claunia.PropertyList
type = INTEGER;
}
/// <summary>
/// Creates an integer number.
/// </summary>
/// <summary>Creates an integer number.</summary>
/// <param name="l">The long integer value.</param>
public NSNumber(long l)
{
@@ -179,9 +175,7 @@ namespace Claunia.PropertyList
type = INTEGER;
}
/// <summary>
/// Creates a real number.
/// </summary>
/// <summary>Creates a real number.</summary>
/// <param name="d">The real value.</param>
public NSNumber(double d)
{
@@ -189,9 +183,7 @@ namespace Claunia.PropertyList
type = REAL;
}
/// <summary>
/// Creates a bool number.
/// </summary>
/// <summary>Creates a bool number.</summary>
/// <param name="b">The bool value.</param>
public NSNumber(bool b)
{
@@ -200,143 +192,104 @@ namespace Claunia.PropertyList
type = BOOLEAN;
}
/// <summary>
/// Compares the current <see cref="Claunia.PropertyList.NSNumber" /> to the specified object.
/// </summary>
/// <summary>Compares the current <see cref="Claunia.PropertyList.NSNumber" /> to the specified object.</summary>
/// <returns>
/// 0 if the numbers are equal, 1 if the current <see cref="Claunia.PropertyList.NSNumber" /> is greater
/// than the argument and -1 if it is less, or the argument is not a number.
/// 0 if the numbers are equal, 1 if the current <see cref="Claunia.PropertyList.NSNumber" /> is greater than the
/// argument and -1 if it is less, or the argument is not a number.
/// </returns>
/// <param name="o">Object to compare to the current <see cref="Claunia.PropertyList.NSNumber" />.</param>
public int CompareTo(object o)
{
double x = ToDouble();
double y;
if(o is NSNumber)
if(o is NSNumber num)
{
NSNumber num = (NSNumber)o;
y = num.ToDouble();
return x < y ? -1 : (x == y ? 0 : 1);
return x < y
? -1
: x == y
? 0
: 1;
}
if(IsNumber(o))
{
y = GetDoubleFromObject(o);
return x < y ? -1 : (x == y ? 0 : 1);
}
if(!IsNumber(o))
return -1;
return -1;
y = GetDoubleFromObject(o);
return x < y
? -1
: x == y
? 0
: 1;
}
/// <summary>
/// Gets the type of this number's value.
/// </summary>
/// <summary>Gets the type of this number's value.</summary>
/// <returns>The type flag.</returns>
/// <seealso cref="BOOLEAN" />
/// <seealso cref="INTEGER" />
/// <seealso cref="REAL" />
public int GetNSNumberType()
{
return type;
}
public int GetNSNumberType() => type;
/// <summary>
/// Checks whether the value of this NSNumber is a bool.
/// </summary>
/// <summary>Checks whether the value of this NSNumber is a bool.</summary>
/// <returns>Whether the number's value is a bool.</returns>
public bool isBoolean()
{
return type == BOOLEAN;
}
public bool isBoolean() => type == BOOLEAN;
/// <summary>
/// Checks whether the value of this NSNumber is an integer.
/// </summary>
/// <summary>Checks whether the value of this NSNumber is an integer.</summary>
/// <returns>Whether the number's value is an integer.</returns>
public bool isInteger()
{
return type == INTEGER;
}
public bool isInteger() => type == INTEGER;
/// <summary>
/// Checks whether the value of this NSNumber is a real number.
/// </summary>
/// <summary>Checks whether the value of this NSNumber is a real number.</summary>
/// <returns>Whether the number's value is a real number.</returns>
public bool isReal()
{
return type == REAL;
}
public bool isReal() => type == REAL;
/// <summary>
/// The number's bool value.
/// </summary>
/// <summary>The number's bool value.</summary>
/// <returns><c>true</c> if the value is true or non-zero, <c>false</c> otherwise.</returns>
public bool ToBool()
{
if(type == BOOLEAN) return boolValue;
if(type == BOOLEAN)
return boolValue;
return longValue != 0;
}
/// <summary>
/// The number's long value.
/// </summary>
/// <summary>The number's long value.</summary>
/// <returns>The value of the number as long</returns>
public long ToLong()
{
return longValue;
}
public long ToLong() => longValue;
/// <summary>
/// The number's int value.
/// <i>
/// Note: Even though the number's type might be INTEGER it can be larger than a Java int.
/// Use intValue() only if you are certain that it contains a number from the int range.
/// Otherwise the value might be innaccurate.
/// Note: Even though the number's type might be INTEGER it can be larger than a Java int. Use intValue() only if
/// you are certain that it contains a number from the int range. Otherwise the value might be inaccurate.
/// </i>
/// </summary>
/// <returns>The value of the number as int.</returns>
public int ToInt()
{
return (int)longValue;
}
public int ToInt() => (int)longValue;
/// <summary>
/// The number's double value.
/// </summary>
/// <summary>The number's double value.</summary>
/// <returns>The value of the number as double.</returns>
public double ToDouble()
{
return doubleValue;
}
public double ToDouble() => doubleValue;
/// <summary>
/// The number's float value.
/// WARNING: Possible loss of precision if the value is outside the float range.
/// </summary>
/// <summary>The number's float value. WARNING: Possible loss of precision if the value is outside the float range.</summary>
/// <returns>The value of the number as float.</returns>
public float floatValue()
{
return (float)doubleValue;
}
public float floatValue() => (float)doubleValue;
/// <summary>
/// Checks whether the other object is a NSNumber of the same value.
/// </summary>
/// <summary>Checks whether the other object is a NSNumber of the same value.</summary>
/// <param name="obj">The object to compare to.</param>
/// <returns>Whether the objects are equal in terms of numeric value and type.</returns>
public override bool Equals(object obj)
{
if(!(obj is NSNumber)) return false;
if(obj is not NSNumber number)
return false;
NSNumber n = (NSNumber)obj;
return type == n.type && longValue == n.longValue && doubleValue == n.doubleValue &&
boolValue == n.boolValue;
return type == number.type && longValue == number.longValue && doubleValue == number.doubleValue &&
boolValue == number.boolValue;
}
/// <summary>
/// Serves as a hash function for a <see cref="Claunia.PropertyList.NSNumber" /> object.
/// </summary>
/// <summary>Serves as a hash function for a <see cref="Claunia.PropertyList.NSNumber" /> object.</summary>
/// <returns>
/// A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a
/// hash table.
@@ -344,31 +297,33 @@ namespace Claunia.PropertyList
public override int GetHashCode()
{
int hash = type;
hash = 37 * hash + (int)(longValue ^ ((uint)longValue >> 32));
hash = 37 * hash + (int)(BitConverter.DoubleToInt64Bits(doubleValue) ^
(uint)(BitConverter.DoubleToInt64Bits(doubleValue) >> 32));
hash = 37 * hash + (ToBool() ? 1 : 0);
hash = (37 * hash) + (int)(longValue ^ ((uint)longValue >> 32));
hash = (37 * hash) + (int)(BitConverter.DoubleToInt64Bits(doubleValue) ^
(uint)(BitConverter.DoubleToInt64Bits(doubleValue) >> 32));
hash = (37 * hash) + (ToBool() ? 1 : 0);
return hash;
}
/// <summary>
/// Returns a <see cref="System.String" /> that represents the current <see cref="Claunia.PropertyList.NSNumber" />.
/// Returns a <see cref="System.String" /> that represents the current
/// <see cref="Claunia.PropertyList.NSNumber" />.
/// </summary>
/// <returns>A <see cref="System.String" /> that represents the current <see cref="Claunia.PropertyList.NSNumber" />.</returns>
public override string ToString()
public override string ToString() => type switch
{
switch(type)
{
case INTEGER: { return ToLong().ToString(); }
case REAL: { return ToDouble().ToString("R", CultureInfo.InvariantCulture); }
case BOOLEAN: { return ToBool().ToString(); }
default: { return base.ToString(); }
}
}
INTEGER => ToLong().ToString(),
REAL => ToDouble().ToString("R", CultureInfo.InvariantCulture),
BOOLEAN => ToBool().ToString(),
_ => base.ToString()
};
internal override void ToXml(StringBuilder xml, int level)
{
Indent(xml, level);
switch(type)
{
case INTEGER:
@@ -376,22 +331,26 @@ namespace Claunia.PropertyList
xml.Append("<integer>");
xml.Append(ToLong());
xml.Append("</integer>");
break;
}
case REAL:
{
xml.Append("<real>");
if(doubleValue == 0) xml.Append("0.0");
else xml.Append(ToDouble().ToString("R", CultureInfo.InvariantCulture));
if(doubleValue == 0)
xml.Append("0.0");
else
xml.Append(ToDouble().ToString("R", CultureInfo.InvariantCulture));
xml.Append("</real>");
break;
}
case BOOLEAN:
{
if(ToBool()) xml.Append("<true/>");
else xml.Append("<false/>");
xml.Append(ToBool() ? "<true/>" : "<false/>");
break;
}
}
@@ -435,11 +394,13 @@ namespace Claunia.PropertyList
{
outPlist.Write(0x23);
outPlist.WriteDouble(ToDouble());
break;
}
case BOOLEAN:
{
outPlist.Write(ToBool() ? 0x09 : 0x08);
break;
}
}
@@ -448,13 +409,17 @@ namespace Claunia.PropertyList
internal override void ToASCII(StringBuilder ascii, int level)
{
Indent(ascii, level);
if(type == BOOLEAN) ascii.Append(boolValue ? "YES" : "NO");
else ascii.Append(ToString());
if(type == BOOLEAN)
ascii.Append(boolValue ? "YES" : "NO");
else
ascii.Append(ToString());
}
internal override void ToASCIIGnuStep(StringBuilder ascii, int level)
{
Indent(ascii, level);
switch(type)
{
case INTEGER:
@@ -462,6 +427,7 @@ namespace Claunia.PropertyList
ascii.Append("<*I");
ascii.Append(ToString());
ascii.Append(">");
break;
}
case REAL:
@@ -469,45 +435,39 @@ namespace Claunia.PropertyList
ascii.Append("<*R");
ascii.Append(ToString());
ascii.Append(">");
break;
}
case BOOLEAN:
{
if(boolValue) ascii.Append("<*BY>");
else ascii.Append("<*BN>");
ascii.Append(boolValue ? "<*BY>" : "<*BN>");
break;
}
}
}
/// <summary>
/// Determines if an object is a number.
/// Substitutes .NET's Number class comparison
/// </summary>
/// <summary>Determines if an object is a number. Substitutes .NET's Number class comparison</summary>
/// <returns><c>true</c> if it is a number.</returns>
/// <param name="o">Object.</param>
static bool IsNumber(object o)
{
return o is sbyte || o is byte || o is short || o is ushort || o is int || o is uint || o is long ||
o is ulong || o is float || o is double || o is decimal;
}
static bool IsNumber(object o) =>
o is sbyte or byte or short or ushort or int or uint or long or ulong or float or double or decimal;
static double GetDoubleFromObject(object o)
static double GetDoubleFromObject(object o) => o switch
{
if(o is sbyte) return (sbyte)o;
if(o is byte) return (byte)o;
if(o is short) return (short)o;
if(o is ushort) return (ushort)o;
if(o is int) return (int)o;
if(o is uint) return (uint)o;
if(o is long) return (long)o;
if(o is ulong) return (ulong)o;
if(o is float) return (float)o;
if(o is double) return (double)o;
if(o is decimal) return (double)(decimal)o;
return 0;
}
sbyte @sbyte => @sbyte,
byte b => b,
short s => s,
ushort @ushort => @ushort,
int i => i,
uint u => u,
long l => l,
ulong @ulong => @ulong,
float f => f,
double d => d,
decimal @decimal => (double)@decimal,
_ => 0
};
/// <summary>
/// Determines whether the specified <see cref="Claunia.PropertyList.NSObject" /> is equal to the current
@@ -523,127 +483,63 @@ namespace Claunia.PropertyList
/// </returns>
public override bool Equals(NSObject obj)
{
if(!(obj is NSNumber)) return false;
if(obj is not NSNumber number)
return false;
if(((NSNumber)obj).GetNSNumberType() != type) return false;
if(number.GetNSNumberType() != type)
return false;
switch(type)
return type switch
{
case INTEGER: return longValue == ((NSNumber)obj).ToLong();
case REAL: return doubleValue == ((NSNumber)obj).ToDouble();
case BOOLEAN: return boolValue == ((NSNumber)obj).ToBool();
default: return false;
}
INTEGER => longValue == number.ToLong(),
REAL => doubleValue == number.ToDouble(),
BOOLEAN => boolValue == number.ToBool(),
_ => false
};
}
public static explicit operator ulong(NSNumber value)
{
return (ulong)value.longValue;
}
public static explicit operator ulong(NSNumber value) => (ulong)value.longValue;
public static explicit operator long(NSNumber value)
{
return value.longValue;
}
public static explicit operator long(NSNumber value) => value.longValue;
public static explicit operator uint(NSNumber value)
{
return (uint)value.longValue;
}
public static explicit operator uint(NSNumber value) => (uint)value.longValue;
public static explicit operator int(NSNumber value)
{
return (int)value.longValue;
}
public static explicit operator int(NSNumber value) => (int)value.longValue;
public static explicit operator ushort(NSNumber value)
{
return (ushort)value.longValue;
}
public static explicit operator ushort(NSNumber value) => (ushort)value.longValue;
public static explicit operator short(NSNumber value)
{
return (short)value.longValue;
}
public static explicit operator short(NSNumber value) => (short)value.longValue;
public static explicit operator byte(NSNumber value)
{
return (byte)value.longValue;
}
public static explicit operator byte(NSNumber value) => (byte)value.longValue;
public static explicit operator sbyte(NSNumber value)
{
return (sbyte)value.longValue;
}
public static explicit operator sbyte(NSNumber value) => (sbyte)value.longValue;
public static explicit operator double(NSNumber value)
{
return value.doubleValue;
}
public static explicit operator double(NSNumber value) => value.doubleValue;
public static explicit operator float(NSNumber value)
{
return (float)value.doubleValue;
}
public static explicit operator float(NSNumber value) => (float)value.doubleValue;
public static explicit operator bool(NSNumber value)
{
return value.boolValue;
}
public static explicit operator bool(NSNumber value) => value.boolValue;
public static explicit operator NSNumber(ulong value)
{
return new NSNumber(value);
}
public static explicit operator NSNumber(ulong value) => new(value);
public static explicit operator NSNumber(long value)
{
return new NSNumber(value);
}
public static explicit operator NSNumber(long value) => new(value);
public static explicit operator NSNumber(uint value)
{
return new NSNumber(value);
}
public static explicit operator NSNumber(uint value) => new(value);
public static explicit operator NSNumber(int value)
{
return new NSNumber(value);
}
public static explicit operator NSNumber(int value) => new(value);
public static explicit operator NSNumber(ushort value)
{
return new NSNumber(value);
}
public static explicit operator NSNumber(ushort value) => new(value);
public static explicit operator NSNumber(short value)
{
return new NSNumber(value);
}
public static explicit operator NSNumber(short value) => new(value);
public static explicit operator NSNumber(byte value)
{
return new NSNumber(value);
}
public static explicit operator NSNumber(byte value) => new(value);
public static explicit operator NSNumber(sbyte value)
{
return new NSNumber(value);
}
public static explicit operator NSNumber(sbyte value) => new(value);
public static explicit operator NSNumber(double value)
{
return new NSNumber(value);
}
public static explicit operator NSNumber(double value) => new(value);
public static explicit operator NSNumber(float value)
{
return new NSNumber(value);
}
public static explicit operator NSNumber(float value) => new(value);
public static explicit operator NSNumber(bool value)
{
return new NSNumber(value);
}
public static explicit operator NSNumber(bool value) => new(value);
}
}

391
plist-cil/NSObject.cs
View File

@@ -25,73 +25,51 @@
using System;
using System.Collections.Generic;
using System.Reflection;
using System.Text;
namespace Claunia.PropertyList
{
/// <summary>
/// <para>
/// Abstract interface for any object contained in a property list.
/// </para>
/// <para>
/// The names and functions of the various objects orient themselves
/// towards Apple's Cocoa API.
/// </para>
/// <para>Abstract interface for any object contained in a property list.</para>
/// <para>The names and functions of the various objects orient themselves towards Apple's Cocoa API.</para>
/// </summary>
/// @author Daniel Dreibrodt
/// @author Natalia Portillo
public abstract class NSObject
{
/// <summary>
/// The newline character used for generating the XML output.
/// To maintain compatibility with the Apple format, only a newline character
/// is used (as opposed to cr+lf which is normally used on Windows).
/// The newline character used for generating the XML output. To maintain compatibility with the Apple format,
/// only a newline character is used (as opposed to cr+lf which is normally used on Windows).
/// </summary>
internal static readonly string NEWLINE = "\n";
/// <summary>
/// The identation character used for generating the XML output. This is the
/// tabulator character.
/// </summary>
/// <summary>The indentation character used for generating the XML output. This is the tabulator character.</summary>
static readonly string INDENT = "\t";
/// <summary>
/// The maximum length of the text lines to be used when generating
/// ASCII property lists. But this number is only a guideline it is not
/// guaranteed that it will not be overstepped.
/// The maximum length of the text lines to be used when generating ASCII property lists. But this number is only
/// a guideline it is not guaranteed that it will not be overstepped.
/// </summary>
internal static readonly int ASCII_LINE_LENGTH = 80;
/// <summary>
/// Generates the XML representation of the object (without XML headers or enclosing plist-tags).
/// </summary>
/// <summary>Generates the XML representation of the object (without XML headers or enclosing plist-tags).</summary>
/// <param name="xml">The StringBuilder onto which the XML representation is appended.</param>
/// <param name="level">The indentation level of the object.</param>
internal abstract void ToXml(StringBuilder xml, int level);
/// <summary>
/// Assigns IDs to all the objects in this NSObject subtree.
/// </summary>
/// <summary>Assigns IDs to all the objects in this NSObject subtree.</summary>
/// <param name="outPlist">The writer object that handles the binary serialization.</param>
internal virtual void AssignIDs(BinaryPropertyListWriter outPlist)
{
outPlist.AssignID(this);
}
internal virtual void AssignIDs(BinaryPropertyListWriter outPlist) => outPlist.AssignID(this);
/// <summary>
/// Generates the binary representation of the object.
/// </summary>
/// <summary>Generates the binary representation of the object.</summary>
/// <param name="outPlist">The output stream to serialize the object to.</param>
internal abstract void ToBinary(BinaryPropertyListWriter outPlist);
/// <summary>
/// Generates a valid XML property list including headers using this object as root.
/// </summary>
/// <summary>Generates a valid XML property list including headers using this object as root.</summary>
/// <returns>The XML representation of the property list including XML header and doctype information.</returns>
public string ToXmlPropertyList()
{
StringBuilder xml = new StringBuilder("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
var xml = new StringBuilder("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
xml.Append(NEWLINE);
xml.Append("<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">");
xml.Append(NEWLINE);
@@ -101,13 +79,13 @@ namespace Claunia.PropertyList
xml.Append(NEWLINE);
xml.Append("</plist>");
xml.Append(NEWLINE);
return xml.ToString();
}
/// <summary>
/// Generates the ASCII representation of this object.
/// The generated ASCII representation does not end with a newline.
/// Complies with
/// Generates the ASCII representation of this object. The generated ASCII representation does not end with a
/// newline. Complies with
/// https://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/PropertyLists/OldStylePlists/OldStylePLists.html
/// </summary>
/// <param name="ascii">The StringBuilder onto which the ASCII representation is appended.</param>
@@ -115,124 +93,99 @@ namespace Claunia.PropertyList
internal abstract void ToASCII(StringBuilder ascii, int level);
/// <summary>
/// Generates the ASCII representation of this object in the GnuStep format.
/// The generated ASCII representation does not end with a newline.
/// Generates the ASCII representation of this object in the GnuStep format. The generated ASCII representation
/// does not end with a newline.
/// </summary>
/// <param name="ascii">The StringBuilder onto which the ASCII representation is appended.</param>
/// <param name="level">The indentation level of the object.</param>
internal abstract void ToASCIIGnuStep(StringBuilder ascii, int level);
/// <summary>
/// Helper method that adds correct identation to the xml output.
/// Calling this method will add <c>level</c> number of tab characters
/// to the <c>xml</c> string.
/// Helper method that adds correct indentation to the xml output. Calling this method will add <c>level</c>
/// number of tab characters to the <c>xml</c> string.
/// </summary>
/// <param name="xml">The string builder for the XML document.</param>
/// <param name="level">The level of identation.</param>
/// <param name="level">The level of indentation.</param>
internal static void Indent(StringBuilder xml, int level)
{
for(int i = 0; i < level; i++) xml.Append(INDENT);
for(int i = 0; i < level; i++)
xml.Append(INDENT);
}
/// <summary>
/// Wraps the given value inside a NSObject.
/// </summary>
/// <summary>Wraps the given value inside a NSObject.</summary>
/// <param name="value">The value to represent as a NSObject.</param>
/// <returns>A NSObject representing the given value.</returns>
public static NSNumber Wrap(long value)
{
return new NSNumber(value);
}
public static NSNumber Wrap(long value) => new(value);
/// <summary>
/// Wraps the given value inside a NSObject.
/// </summary>
/// <summary>Wraps the given value inside a NSObject.</summary>
/// <param name="value">The value to represent as a NSObject.</param>
/// <returns>A NSObject representing the given value.</returns>
public static NSNumber Wrap(double value)
{
return new NSNumber(value);
}
public static NSNumber Wrap(double value) => new(value);
/// <summary>
/// Wraps the given value inside a NSObject.
/// </summary>
/// <summary>Wraps the given value inside a NSObject.</summary>
/// <param name="value">The value to represent as a NSObject.</param>
/// <returns>A NSObject representing the given value.</returns>
public static NSNumber Wrap(bool value)
{
return new NSNumber(value);
}
public static NSNumber Wrap(bool value) => new(value);
/// <summary>
/// Wraps the given value inside a NSObject.
/// </summary>
/// <summary>Wraps the given value inside a NSObject.</summary>
/// <param name="value">The value to represent as a NSObject.</param>
/// <returns>A NSObject representing the given value.</returns>
public static NSData Wrap(byte[] value)
{
return new NSData(value);
}
public static NSData Wrap(byte[] value) => new(value);
/// <summary>
/// Creates a NSArray with the contents of the given array.
/// </summary>
/// <summary>Creates a NSArray with the contents of the given array.</summary>
/// <param name="value">The value to represent as a NSObject.</param>
/// <returns>A NSObject representing the given value.</returns>
/// <exception cref="SystemException">When one of the objects contained in the array cannot be represented by a NSObject.</exception>
public static NSArray Wrap(object[] value)
{
NSArray arr = new NSArray(value.Length);
for(int i = 0; i < value.Length; i++) arr.Add(Wrap(value[i]));
var arr = new NSArray(value.Length);
for(int i = 0; i < value.Length; i++)
arr.Add(Wrap(value[i]));
return arr;
}
/// <summary>
/// Creates a NSDictionary with the contents of the given map.
/// </summary>
/// <summary>Creates a NSDictionary with the contents of the given map.</summary>
/// <param name="value">The value to represent as a NSObject.</param>
/// <returns>A NSObject representing the given value.</returns>
/// <exception cref="SystemException">When one of the values contained in the map cannot be represented by a NSObject.</exception>
public static NSDictionary Wrap(Dictionary<string, object> value)
{
NSDictionary dict = new NSDictionary();
foreach(KeyValuePair<string, object> kvp in value) dict.Add(kvp.Key, Wrap(kvp.Value));
var dict = new NSDictionary();
foreach(KeyValuePair<string, object> kvp in value)
dict.Add(kvp.Key, Wrap(kvp.Value));
return dict;
}
/// <summary>
/// Creates a NSSet with the contents of this set.
/// </summary>
/// <summary>Creates a NSSet with the contents of this set.</summary>
/// <param name="value">The value to represent as a NSObject.</param>
/// <returns>A NSObject representing the given value.</returns>
/// <exception cref="SystemException">When one of the values contained in the map cannot be represented by a NSObject.</exception>
public static NSSet Wrap(List<object> value)
{
NSSet set = new NSSet();
foreach(object o in value) set.AddObject(Wrap(o));
var set = new NSSet();
foreach(object o in value)
set.AddObject(Wrap(o));
return set;
}
/// <summary>
/// <para>
/// Creates a NSObject representing the given .NET Object.
/// </para>
/// <para>Creates a NSObject representing the given .NET Object.</para>
/// <para>
/// Numerics of type <see cref="bool" />, <see cref="int" />, <see cref="long" />, <see cref="short" />,
/// <see cref="byte" />, <see cref="float" /> or <see cref="double" /> are wrapped as NSNumber objects.
/// </para>
/// <para>Strings are wrapped as <see cref="NSString" /> objects and byte arrays as <see cref="NSData" /> objects.</para>
/// <para>DateTime objects are wrapped as <see cref="NSDate" /> objects.</para>
/// <para>Serializable classes are serialized and their data is stored in <see cref="NSData" /> objects.</para>
/// <para>
/// Strings are wrapped as <see cref="NSString" /> objects and byte arrays as <see cref="NSData" /> objects.
/// </para>
/// <para>
/// DateTime objects are wrapped as <see cref="NSDate" /> objects.
/// </para>
/// <para>
/// Serializable classes are serialized and their data is stored in <see cref="NSData" /> objects.
/// </para>
/// <para>
/// Arrays and Collection objects are converted to <see cref="NSArray" /> where each array member is wrapped into a
/// <see cref="NSObject" />.
/// Arrays and Collection objects are converted to <see cref="NSArray" /> where each array member is wrapped into
/// a <see cref="NSObject" />.
/// </para>
/// <para>
/// Dictionaries are converted to <see cref="NSDictionary" />. Each key is converted to a string and each value
@@ -243,79 +196,111 @@ namespace Claunia.PropertyList
/// <returns>A NSObject equivalent to the given object.</returns>
public static NSObject Wrap(object o)
{
if(o == null) throw new NullReferenceException("A null object cannot be wrapped as a NSObject");
if(o == null)
throw new NullReferenceException("A null object cannot be wrapped as a NSObject");
if(o is NSObject) return (NSObject)o;
if(o is NSObject nsObject)
return nsObject;
Type c = o.GetType();
if(typeof(bool).Equals(c)) return Wrap((bool)o);
if(typeof(byte).Equals(c)) return Wrap((byte)o);
if(typeof(bool).Equals(c))
return Wrap((bool)o);
if(typeof(short).Equals(c)) return Wrap((short)o);
if(typeof(byte).Equals(c))
return Wrap((byte)o);
if(typeof(int).Equals(c)) return Wrap((int)o);
if(typeof(short).Equals(c))
return Wrap((short)o);
if(typeof(long).IsAssignableFrom(c)) return Wrap((long)o);
if(typeof(int).Equals(c))
return Wrap((int)o);
if(typeof(float).Equals(c)) return Wrap((float)o);
if(typeof(long).IsAssignableFrom(c))
return Wrap((long)o);
if(typeof(double).IsAssignableFrom(c)) return Wrap((double)o);
if(typeof(float).Equals(c))
return Wrap((float)o);
if(typeof(string).Equals(c)) return new NSString((string)o);
if(typeof(double).IsAssignableFrom(c))
return Wrap((double)o);
if(typeof(DateTime).Equals(c)) return new NSDate((DateTime)o);
if(typeof(string).Equals(c))
return new NSString((string)o);
if(typeof(DateTime).Equals(c))
return new NSDate((DateTime)o);
if(c.IsArray)
{
Type cc = c.GetElementType();
if(cc.Equals(typeof(byte))) return Wrap((byte[])o);
if(cc.Equals(typeof(byte)))
return Wrap((byte[])o);
if(cc.Equals(typeof(bool)))
{
bool[] array = (bool[])o;
NSArray nsa = new NSArray(array.Length);
for(int i = 0; i < array.Length; i++) nsa.Add(Wrap(array[i]));
bool[] array = (bool[])o;
var nsa = new NSArray(array.Length);
for(int i = 0; i < array.Length; i++)
nsa.Add(Wrap(array[i]));
return nsa;
}
if(cc.Equals(typeof(float)))
{
float[] array = (float[])o;
NSArray nsa = new NSArray(array.Length);
for(int i = 0; i < array.Length; i++) nsa.Add(Wrap(array[i]));
var nsa = new NSArray(array.Length);
for(int i = 0; i < array.Length; i++)
nsa.Add(Wrap(array[i]));
return nsa;
}
if(cc.Equals(typeof(double)))
{
double[] array = (double[])o;
NSArray nsa = new NSArray(array.Length);
for(int i = 0; i < array.Length; i++) nsa.Add(Wrap(array[i]));
var nsa = new NSArray(array.Length);
for(int i = 0; i < array.Length; i++)
nsa.Add(Wrap(array[i]));
return nsa;
}
if(cc.Equals(typeof(short)))
{
short[] array = (short[])o;
NSArray nsa = new NSArray(array.Length);
for(int i = 0; i < array.Length; i++) nsa.Add(Wrap(array[i]));
var nsa = new NSArray(array.Length);
for(int i = 0; i < array.Length; i++)
nsa.Add(Wrap(array[i]));
return nsa;
}
if(cc.Equals(typeof(int)))
{
int[] array = (int[])o;
NSArray nsa = new NSArray(array.Length);
for(int i = 0; i < array.Length; i++) nsa.Add(Wrap(array[i]));
int[] array = (int[])o;
var nsa = new NSArray(array.Length);
for(int i = 0; i < array.Length; i++)
nsa.Add(Wrap(array[i]));
return nsa;
}
if(cc.Equals(typeof(long)))
{
long[] array = (long[])o;
NSArray nsa = new NSArray(array.Length);
for(int i = 0; i < array.Length; i++) nsa.Add(Wrap(array[i]));
long[] array = (long[])o;
var nsa = new NSArray(array.Length);
for(int i = 0; i < array.Length; i++)
nsa.Add(Wrap(array[i]));
return nsa;
}
@@ -325,19 +310,22 @@ namespace Claunia.PropertyList
if(typeof(Dictionary<string, object>).IsAssignableFrom(c))
{
Dictionary<string, object> netDict = (Dictionary<string, object>)o;
NSDictionary dict = new NSDictionary();
foreach(KeyValuePair<string, object> kvp in netDict) dict.Add(kvp.Key, Wrap(kvp.Value));
var dict = new NSDictionary();
foreach(KeyValuePair<string, object> kvp in netDict)
dict.Add(kvp.Key, Wrap(kvp.Value));
return dict;
}
if(typeof(List<object>).IsAssignableFrom(c)) return Wrap(((List<object>)o).ToArray());
if(typeof(List<object>).IsAssignableFrom(c))
return Wrap(((List<object>)o).ToArray());
throw new PropertyListException(string.Format("Cannot wrap an object of type {0}.", o.GetType().Name));
throw new PropertyListException($"Cannot wrap an object of type {o.GetType().Name}.");
}
/// <summary>
/// Converts this NSObject into an equivalent object
/// of the .NET Runtime Environment.
/// Converts this NSObject into an equivalent object of the .NET Runtime Environment.
/// <para><see cref="NSArray" /> objects are converted to arrays.</para>
/// <para>
/// <see cref="NSDictionary" /> objects are converted to objects extending the
@@ -356,90 +344,93 @@ namespace Claunia.PropertyList
/// <returns>A native .NET object representing this NSObject's value.</returns>
public object ToObject()
{
if(this is NSArray)
switch(this)
{
NSArray nsArray = (NSArray)this;
object[] array = new object[nsArray.Count];
for(int i = 0; i < nsArray.Count; i++) array[i] = nsArray[i].ToObject();
return array;
}
if(this is NSDictionary)
{
Dictionary<string, NSObject> dictA = ((NSDictionary)this).GetDictionary();
Dictionary<string, object> dictB = new Dictionary<string, object>(dictA.Count);
foreach(KeyValuePair<string, NSObject> kvp in dictA) dictB.Add(kvp.Key, kvp.Value.ToObject());
return dictB;
}
if(this is NSSet)
{
List<NSObject> setA = ((NSSet)this).GetSet();
List<object> setB = new List<object>();
foreach(NSObject o in setA) setB.Add(o.ToObject());
return setB;
}
if(this is NSNumber)
{
NSNumber num = (NSNumber)this;
switch(num.GetNSNumberType())
case NSArray:
{
case NSNumber.INTEGER:
{
long longVal = num.ToLong();
if(longVal > int.MaxValue || longVal < int.MinValue) return longVal;
var nsArray = (NSArray)this;
object[] array = new object[nsArray.Count];
return num.ToInt();
}
case NSNumber.REAL: return num.ToDouble();
case NSNumber.BOOLEAN: return num.ToBool();
default: return num.ToDouble();
for(int i = 0; i < nsArray.Count; i++)
array[i] = nsArray[i].ToObject();
return array;
}
case NSDictionary:
{
Dictionary<string, NSObject> dictA = ((NSDictionary)this).GetDictionary();
Dictionary<string, object> dictB = new(dictA.Count);
foreach(KeyValuePair<string, NSObject> kvp in dictA)
dictB.Add(kvp.Key, kvp.Value.ToObject());
return dictB;
}
case NSSet:
{
List<NSObject> setA = ((NSSet)this).GetSet();
List<object> setB = new();
foreach(NSObject o in setA)
setB.Add(o.ToObject());
return setB;
}
case NSNumber:
{
var num = (NSNumber)this;
switch(num.GetNSNumberType())
{
case NSNumber.INTEGER:
{
long longVal = num.ToLong();
if(longVal is > int.MaxValue or < int.MinValue)
return longVal;
return num.ToInt();
}
case NSNumber.REAL: return num.ToDouble();
case NSNumber.BOOLEAN: return num.ToBool();
default: return num.ToDouble();
}
break;
}
case NSString: return ((NSString)this).Content;
case NSData: return ((NSData)this).Bytes;
case NSDate: return ((NSDate)this).Date;
case UID: return ((UID)this).Bytes;
default: return this;
}
if(this is NSString) return ((NSString)this).Content;
if(this is NSData) return ((NSData)this).Bytes;
if(this is NSDate) return ((NSDate)this).Date;
if(this is UID) return ((UID)this).Bytes;
return this;
}
internal static bool ArrayEquals(byte[] arrayA, byte[] arrayB)
{
if(arrayA.Length == arrayB.Length)
{
for(int i = 0; i < arrayA.Length; i++)
if(arrayA[i] != arrayB[i])
return false;
if(arrayA.Length != arrayB.Length)
return false;
return true;
}
for(int i = 0; i < arrayA.Length; i++)
if(arrayA[i] != arrayB[i])
return false;
return false;
return true;
}
internal static bool ArrayEquals(IList<NSObject> arrayA, IList<NSObject> arrayB)
{
if(arrayA.Count == arrayB.Count)
{
for(int i = 0; i < arrayA.Count; i++)
if(arrayA[i] != arrayB[i])
return false;
if(arrayA.Count != arrayB.Count)
return false;
return true;
}
for(int i = 0; i < arrayA.Count; i++)
if(arrayA[i] != arrayB[i])
return false;
return false;
return true;
}
/// <summary>
/// Determines if the specific NSObject is the same as the NSObject overriding this method.
/// </summary>
/// <summary>Determines if the specific NSObject is the same as the NSObject overriding this method.</summary>
/// <param name="obj">
/// The <see cref="Claunia.PropertyList.NSObject" /> to compare with the current
/// <see cref="Claunia.PropertyList.NSObject" />.

227
plist-cil/NSSet.cs
View File

@@ -31,33 +31,20 @@ using System.Text;
namespace Claunia.PropertyList
{
/// <summary>
/// <para>
/// A set is an interface to an unordered collection of objects.
/// </para>
/// <para>
/// This implementation uses a <see cref="List{T}" />as the underlying
/// data structure.
/// </para>
/// <para>A set is an interface to an unordered collection of objects.</para>
/// <para>This implementation uses a <see cref="List{T}" />as the underlying data structure.</para>
/// </summary>
/// @author Daniel Dreibrodt
/// @author Natalia Portillo
public class NSSet : NSObject, IEnumerable
{
readonly bool ordered;
readonly List<NSObject> set;
bool ordered;
/// <summary>Creates an empty unordered set.</summary>
public NSSet() => set = new List<NSObject>();
/// <summary>
/// Creates an empty unordered set.
/// </summary>
public NSSet()
{
set = new List<NSObject>();
}
/// <summary>
/// Creates an empty set.
/// </summary>
/// <summary>Creates an empty set.</summary>
/// <param name="ordered">Should the set be ordered on operations?</param>
public NSSet(bool ordered)
{
@@ -65,108 +52,94 @@ namespace Claunia.PropertyList
set = new List<NSObject>();
}
/// <summary>
/// Creates a set and fill it with the given objects.
/// </summary>
/// <summary>Creates a set and fill it with the given objects.</summary>
/// <param name="objects">The objects to populate the set.</param>
public NSSet(params NSObject[] objects)
{
set = new List<NSObject>(objects);
}
public NSSet(params NSObject[] objects) => set = new List<NSObject>(objects);
/// <summary>
/// Creates a set and fill it with the given objects.
/// </summary>
/// <summary>Creates a set and fill it with the given objects.</summary>
/// <param name="objects">The objects to populate the set.</param>
/// <param name="ordered">Should the set be ordered on operations?</param>
public NSSet(bool ordered, params NSObject[] objects)
{
this.ordered = ordered;
set = new List<NSObject>(objects);
if(ordered) set.Sort();
if(ordered)
set.Sort();
}
/// <summary>
/// Gets the number of elements in the set.
/// </summary>
/// <summary>Gets the number of elements in the set.</summary>
/// <value>The number of elements in the set.</value>
public int Count
{
get
{
lock(set) return set.Count;
lock(set)
return set.Count;
}
}
/// <summary>
/// Returns an enumerator object that lets you iterate over all elements of the set.
/// This is the equivalent to <c>objectEnumerator</c> in the Cocoa implementation
/// of NSSet.
/// Returns an enumerator object that lets you iterate over all elements of the set. This is the equivalent to
/// <c>objectEnumerator</c> in the Cocoa implementation of NSSet.
/// </summary>
/// <returns>The iterator for the set.</returns>
public IEnumerator GetEnumerator()
{
lock(set) return set.GetEnumerator();
lock(set)
return set.GetEnumerator();
}
/// <summary>
/// Adds an object to the set.
/// </summary>
/// <summary>Adds an object to the set.</summary>
/// <param name="obj">The object to add.</param>
public void AddObject(NSObject obj)
{
lock(set)
{
set.Add(obj);
if(ordered) set.Sort();
if(ordered)
set.Sort();
}
}
/// <summary>
/// Removes an object from the set.
/// </summary>
/// <summary>Removes an object from the set.</summary>
/// <param name="obj">The object to remove.</param>
public void RemoveObject(NSObject obj)
{
lock(set)
{
set.Remove(obj);
if(ordered) set.Sort();
if(ordered)
set.Sort();
}
}
/// <summary>
/// Returns all objects contained in the set.
/// </summary>
/// <summary>Returns all objects contained in the set.</summary>
/// <returns>An array of all objects in the set.</returns>
public NSObject[] AllObjects()
{
lock(set) return set.ToArray();
lock(set)
return set.ToArray();
}
/// <summary>
/// Returns one of the objects in the set, or <c>null</c>
/// if the set contains no objects.
/// </summary>
/// <summary>Returns one of the objects in the set, or <c>null</c> if the set contains no objects.</summary>
/// <returns>The first object in the set, or <c>null</c> if the set is empty.</returns>
public NSObject AnyObject()
{
lock(set) return set.Count == 0 ? null : set[0];
lock(set)
return set.Count == 0 ? null : set[0];
}
/// <summary>
/// Finds out whether a given object is contained in the set.
/// </summary>
/// <summary>Finds out whether a given object is contained in the set.</summary>
/// <returns><c>true</c>, when the object was found, <c>false</c> otherwise.</returns>
/// <param name="obj">The object to look for.</param>
public bool ContainsObject(NSObject obj)
{
return set.Contains(obj);
}
public bool ContainsObject(NSObject obj) => set.Contains(obj);
/// <summary>
/// Determines whether the set contains an object equal to a given object
/// and returns that object if it is present.
/// Determines whether the set contains an object equal to a given object and returns that object if it is
/// present.
/// </summary>
/// <param name="obj">The object to look for.</param>
/// <returns>The object if it is present, <c>null</c> otherwise.</returns>
@@ -182,9 +155,7 @@ namespace Claunia.PropertyList
}
}
/// <summary>
/// Finds out whether at least one object is present in both sets.
/// </summary>
/// <summary>Finds out whether at least one object is present in both sets.</summary>
/// <returns><c>true</c> if the intersection of both sets is empty, <c>false</c> otherwise.</returns>
/// <param name="otherSet">The other set.</param>
public bool IntersectsSet(NSSet otherSet)
@@ -199,9 +170,7 @@ namespace Claunia.PropertyList
}
}
/// <summary>
/// Finds out if this set is a subset of the given set.
/// </summary>
/// <summary>Finds out if this set is a subset of the given set.</summary>
/// <returns><c>true</c> if all elements in this set are also present in the other set, <c>false</c>otherwise.</returns>
/// <param name="otherSet">The other set.</param>
public bool IsSubsetOfSet(NSSet otherSet)
@@ -216,18 +185,11 @@ namespace Claunia.PropertyList
}
}
/// <summary>
/// Gets the underlying data structure in which this NSSets stores its content.
/// </summary>
/// <summary>Gets the underlying data structure in which this NSSets stores its content.</summary>
/// <returns>A Set object.</returns>
internal List<NSObject> GetSet()
{
return set;
}
internal List<NSObject> GetSet() => set;
/// <summary>
/// Serves as a hash function for a <see cref="Claunia.PropertyList.NSSet" /> object.
/// </summary>
/// <summary>Serves as a hash function for a <see cref="Claunia.PropertyList.NSSet" /> object.</summary>
/// <returns>
/// A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a
/// hash table.
@@ -235,7 +197,8 @@ namespace Claunia.PropertyList
public override int GetHashCode()
{
int hash = 7;
hash = 29 * hash + (set != null ? set.GetHashCode() : 0);
hash = (29 * hash) + (set != null ? set.GetHashCode() : 0);
return hash;
}
@@ -253,18 +216,20 @@ namespace Claunia.PropertyList
/// </returns>
public override bool Equals(object obj)
{
if(obj == null) return false;
if(obj == null)
return false;
if(GetType() != obj.GetType()) return false;
if(GetType() != obj.GetType())
return false;
var other = (NSSet)obj;
NSSet other = (NSSet)obj;
return !(set != other.set && (set == null || !set.Equals(other.set)));
}
/// <summary>
/// Returns the XML representantion for this set.
/// There is no official XML representation specified for sets.
/// In this implementation it is represented by an array.
/// Returns the XML representation for this set. There is no official XML representation specified for sets. In
/// this implementation it is represented by an array.
/// </summary>
/// <param name="xml">The XML StringBuilder</param>
/// <param name="level">The indentation level</param>
@@ -273,7 +238,10 @@ namespace Claunia.PropertyList
Indent(xml, level);
xml.Append("<array>");
xml.Append(NEWLINE);
if(ordered) set.Sort();
if(ordered)
set.Sort();
foreach(NSObject o in set)
{
o.ToXml(xml, level + 1);
@@ -287,7 +255,9 @@ namespace Claunia.PropertyList
internal override void AssignIDs(BinaryPropertyListWriter outPlist)
{
base.AssignIDs(outPlist);
foreach(NSObject obj in set) obj.AssignIDs(outPlist);
foreach(NSObject obj in set)
obj.AssignIDs(outPlist);
}
internal override void ToBinary(BinaryPropertyListWriter outPlist)
@@ -297,30 +267,37 @@ namespace Claunia.PropertyList
set.Sort();
outPlist.WriteIntHeader(0xB, set.Count);
}
else outPlist.WriteIntHeader(0xC, set.Count);
else
outPlist.WriteIntHeader(0xC, set.Count);
foreach(NSObject obj in set) outPlist.WriteID(outPlist.GetID(obj));
foreach(NSObject obj in set)
outPlist.WriteID(outPlist.GetID(obj));
}
/// <summary>
/// Returns the ASCII representation of this set.
/// There is no official ASCII representation for sets.
/// In this implementation sets are represented as arrays.
/// Returns the ASCII representation of this set. There is no official ASCII representation for sets. In this
/// implementation sets are represented as arrays.
/// </summary>
/// <param name="ascii">The ASCII file string builder</param>
/// <param name="level">The indentation level</param>
internal override void ToASCII(StringBuilder ascii, int level)
{
Indent(ascii, level);
if(ordered) set.Sort();
if(ordered)
set.Sort();
NSObject[] array = AllObjects();
ascii.Append(ASCIIPropertyListParser.ARRAY_BEGIN_TOKEN);
int indexOfLastNewLine = ascii.ToString().LastIndexOf(NEWLINE, StringComparison.Ordinal);
for(int i = 0; i < array.Length; i++)
{
Type objClass = array[i].GetType();
if((objClass.Equals(typeof(NSDictionary)) || objClass.Equals(typeof(NSArray)) ||
objClass.Equals(typeof(NSData))) && indexOfLastNewLine != ascii.Length)
objClass.Equals(typeof(NSData))) &&
indexOfLastNewLine != ascii.Length)
{
ascii.Append(NEWLINE);
indexOfLastNewLine = ascii.Length;
@@ -328,41 +305,46 @@ namespace Claunia.PropertyList
}
else
{
if(i != 0) ascii.Append(" ");
if(i != 0)
ascii.Append(" ");
array[i].ToASCII(ascii, 0);
}
if(i != array.Length - 1) ascii.Append(ASCIIPropertyListParser.ARRAY_ITEM_DELIMITER_TOKEN);
if(i != array.Length - 1)
ascii.Append(ASCIIPropertyListParser.ARRAY_ITEM_DELIMITER_TOKEN);
if(ascii.Length - indexOfLastNewLine > ASCII_LINE_LENGTH)
{
ascii.Append(NEWLINE);
indexOfLastNewLine = ascii.Length;
}
if(ascii.Length - indexOfLastNewLine <= ASCII_LINE_LENGTH)
continue;
ascii.Append(NEWLINE);
indexOfLastNewLine = ascii.Length;
}
ascii.Append(ASCIIPropertyListParser.ARRAY_END_TOKEN);
}
/// <summary>
/// Returns the ASCII representation of this set according to the GnuStep format.
/// There is no official ASCII representation for sets.
/// In this implementation sets are represented as arrays.
/// Returns the ASCII representation of this set according to the GnuStep format. There is no official ASCII
/// representation for sets. In this implementation sets are represented as arrays.
/// </summary>
/// <param name="ascii">The ASCII file string builder</param>
/// <param name="level">The indentation level</param>
internal override void ToASCIIGnuStep(StringBuilder ascii, int level)
{
Indent(ascii, level);
if(ordered) set.Sort();
if(ordered)
set.Sort();
NSObject[] array = AllObjects();
ascii.Append(ASCIIPropertyListParser.ARRAY_BEGIN_TOKEN);
int indexOfLastNewLine = ascii.ToString().LastIndexOf(NEWLINE, StringComparison.Ordinal);
for(int i = 0; i < array.Length; i++)
{
Type objClass = array[i].GetType();
if((objClass.Equals(typeof(NSDictionary)) || objClass.Equals(typeof(NSArray)) ||
objClass.Equals(typeof(NSData))) && indexOfLastNewLine != ascii.Length)
if(array[i] is NSDictionary or NSArray or NSData &&
indexOfLastNewLine != ascii.Length)
{
ascii.Append(NEWLINE);
indexOfLastNewLine = ascii.Length;
@@ -370,17 +352,20 @@ namespace Claunia.PropertyList
}
else
{
if(i != 0) ascii.Append(" ");
if(i != 0)
ascii.Append(" ");
array[i].ToASCIIGnuStep(ascii, 0);
}
if(i != array.Length - 1) ascii.Append(ASCIIPropertyListParser.ARRAY_ITEM_DELIMITER_TOKEN);
if(i != array.Length - 1)
ascii.Append(ASCIIPropertyListParser.ARRAY_ITEM_DELIMITER_TOKEN);
if(ascii.Length - indexOfLastNewLine > ASCII_LINE_LENGTH)
{
ascii.Append(NEWLINE);
indexOfLastNewLine = ascii.Length;
}
if(ascii.Length - indexOfLastNewLine <= ASCII_LINE_LENGTH)
continue;
ascii.Append(NEWLINE);
indexOfLastNewLine = ascii.Length;
}
ascii.Append(ASCIIPropertyListParser.ARRAY_END_TOKEN);
@@ -400,11 +385,13 @@ namespace Claunia.PropertyList
/// </returns>
public override bool Equals(NSObject obj)
{
if(!(obj is NSSet)) return false;
if(obj is not NSSet nsSet)
return false;
if(set.Count != ((NSSet)obj).Count) return false;
if(set.Count != nsSet.Count)
return false;
foreach(NSObject objS in (NSSet)obj)
foreach(NSObject objS in nsSet)
if(!set.Contains(objS))
return false;

174
plist-cil/NSString.cs
View File

@@ -28,101 +28,65 @@ using System.Text;
namespace Claunia.PropertyList
{
/// <summary>
/// A NSString contains a string.
/// </summary>
/// <summary>A NSString contains a string.</summary>
/// @author Daniel Dreibrodt
/// @author Natalia Portillo
public class NSString : NSObject, IComparable
{
static Encoding asciiEncoder, utf16beEncoder, utf8Encoder;
/// <summary>
/// Creates a NSString from its binary representation.
/// </summary>
/// <summary>Creates a NSString from its binary representation.</summary>
/// <param name="bytes">The binary representation.</param>
/// <param name="encoding">The encoding of the binary representation, the name of a supported charset.</param>
/// <exception cref="ArgumentException">The encoding charset is invalid or not supported by the underlying platform.</exception>
public NSString(ReadOnlySpan<byte> bytes, string encoding) : this(bytes, Encoding.GetEncoding(encoding)) { }
public NSString(ReadOnlySpan<byte> bytes, string encoding) : this(bytes, Encoding.GetEncoding(encoding)) {}
/// <summary>
/// Creates a NSString from its binary representation.
/// </summary>
/// <summary>Creates a NSString from its binary representation.</summary>
/// <param name="bytes">The binary representation.</param>
/// <param name="encoding">The encoding of the binary representation.</param>
/// <exception cref="ArgumentException">The encoding charset is invalid or not supported by the underlying platform.</exception>
public NSString(ReadOnlySpan<byte> bytes, Encoding encoding)
{
#if NATIVE_SPAN
#if NATIVE_SPAN
Content = encoding.GetString(bytes);
#else
#else
Content = encoding.GetString(bytes.ToArray());
#endif
#endif
}
/// <summary>
/// Creates a NSString from a string.
/// </summary>
/// <summary>Creates a NSString from a string.</summary>
/// <param name="text">The string that will be contained in the NSString.</param>
public NSString(string text)
{
Content = text;
}
public NSString(string text) => Content = text;
/// <summary>
/// Gets this strings content.
/// </summary>
/// <summary>Gets this strings content.</summary>
/// <returns>This NSString as .NET string object.</returns>
public string Content { get; set; }
/// <summary>
/// Compares the current <see cref="Claunia.PropertyList.NSString" /> to the specified object.
/// </summary>
/// <summary>Compares the current <see cref="Claunia.PropertyList.NSString" /> to the specified object.</summary>
/// <returns>A 32-bit signed integer that indicates the lexical relationship between the two comparands.</returns>
/// <param name="o">Object to compare to the current <see cref="Claunia.PropertyList.NSString" />.</param>
public int CompareTo(object o)
public int CompareTo(object o) => o switch
{
if(o is NSString) return string.Compare(Content, ((NSString)o).Content, StringComparison.Ordinal);
if(o is string) return string.Compare(Content, (string)o, StringComparison.Ordinal);
NSString nsString => string.Compare(Content, nsString.Content, StringComparison.Ordinal),
string s => string.Compare(Content, s, StringComparison.Ordinal),
_ => -1
};
return -1;
}
/// <summary>
/// Appends a string to this string.
/// </summary>
/// <summary>Appends a string to this string.</summary>
/// <param name="s">The string to append.</param>
public void Append(NSString s)
{
Append(s.Content);
}
public void Append(NSString s) => Append(s.Content);
/// <summary>
/// Appends a string to this string.
/// </summary>
/// <summary>Appends a string to this string.</summary>
/// <param name="s">The string to append.</param>
public void Append(string s)
{
Content += s;
}
public void Append(string s) => Content += s;
/// <summary>
/// Prepends a string to this string.
/// </summary>
/// <summary>Prepends a string to this string.</summary>
/// <param name="s">The string to prepend.</param>
public void Prepend(string s)
{
Content = s + Content;
}
public void Prepend(string s) => Content = s + Content;
/// <summary>
/// Prepends a string to this string.
/// </summary>
/// <summary>Prepends a string to this string.</summary>
/// <param name="s">The string to prepend.</param>
public void Prepend(NSString s)
{
Prepend(s.Content);
}
public void Prepend(NSString s) => Prepend(s.Content);
/// <summary>
/// Determines whether the specified <see cref="System.Object" /> is equal to the current
@@ -136,33 +100,18 @@ namespace Claunia.PropertyList
/// <c>true</c> if the specified <see cref="System.Object" /> is equal to the current
/// <see cref="Claunia.PropertyList.NSString" />; otherwise, <c>false</c>.
/// </returns>
public override bool Equals(object obj)
{
if(!(obj is NSString)) return false;
public override bool Equals(object obj) => obj is NSString nsString && Content.Equals(nsString.Content);
return Content.Equals(((NSString)obj).Content);
}
/// <summary>
/// Serves as a hash function for a <see cref="Claunia.PropertyList.NSString" /> object.
/// </summary>
/// <summary>Serves as a hash function for a <see cref="Claunia.PropertyList.NSString" /> object.</summary>
/// <returns>
/// A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a
/// hash table.
/// </returns>
public override int GetHashCode()
{
return Content.GetHashCode();
}
public override int GetHashCode() => Content.GetHashCode();
/// <summary>
/// The textual representation of this NSString.
/// </summary>
/// <summary>The textual representation of this NSString.</summary>
/// <returns>The NSString's contents.</returns>
public override string ToString()
{
return Content;
}
public override string ToString() => Content;
internal override void ToXml(StringBuilder xml, int level)
{
@@ -172,7 +121,7 @@ namespace Claunia.PropertyList
//Make sure that the string is encoded in UTF-8 for the XML output
lock(typeof(NSString))
{
if(utf8Encoder == null) utf8Encoder = Encoding.GetEncoding("UTF-8");
utf8Encoder ??= Encoding.GetEncoding("UTF-8");
try
{
@@ -187,13 +136,16 @@ namespace Claunia.PropertyList
//According to http://www.w3.org/TR/REC-xml/#syntax node values must not
//contain the characters < or &. Also the > character should be escaped.
if(Content.Contains("&") || Content.Contains("<") || Content.Contains(">"))
if(Content.Contains("&") ||
Content.Contains("<") ||
Content.Contains(">"))
{
xml.Append("<![CDATA[");
xml.Append(Content.Replace("]]>", "]]]]><![CDATA[>"));
xml.Append("]]>");
}
else xml.Append(Content);
else
xml.Append(Content);
xml.Append("</string>");
}
@@ -202,12 +154,12 @@ namespace Claunia.PropertyList
{
int kind;
byte[] byteBuf;
lock(typeof(NSString))
{
if(asciiEncoder == null)
// Not much use, because some characters do not fallback to exception, even if not ASCII
asciiEncoder = Encoding.GetEncoding("ascii", EncoderFallback.ExceptionFallback,
DecoderFallback.ExceptionFallback);
// Not much use, because some characters do not fallback to exception, even if not ASCII
asciiEncoder ??= Encoding.GetEncoding("ascii", EncoderFallback.ExceptionFallback,
DecoderFallback.ExceptionFallback);
if(IsASCIIEncodable(Content))
{
@@ -216,7 +168,7 @@ namespace Claunia.PropertyList
}
else
{
if(utf16beEncoder == null) utf16beEncoder = Encoding.BigEndianUnicode;
utf16beEncoder ??= Encoding.BigEndianUnicode;
kind = 0x6; // UTF-16-BE
byteBuf = utf16beEncoder.GetBytes(Content);
@@ -231,6 +183,7 @@ namespace Claunia.PropertyList
{
Indent(ascii, level);
ascii.Append("\"");
//According to https://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/PropertyLists/OldStylePlists/OldStylePLists.html
//non-ASCII characters are not escaped but simply written into the
//file, thus actually violating the ASCII plain text format.
@@ -247,31 +200,37 @@ namespace Claunia.PropertyList
ascii.Append("\"");
}
/// <summary>
/// Escapes a string for use in ASCII property lists.
/// </summary>
/// <summary>Escapes a string for use in ASCII property lists.</summary>
/// <returns>The unescaped string.</returns>
/// <param name="s">S.</param>
internal static string EscapeStringForASCII(string s)
{
string outString = "";
char[] cArray = s.ToCharArray();
foreach(char c in cArray)
if(c > 127)
{
//non-ASCII Unicode
outString += "\\U";
string hex = string.Format("{0:x}", c);
while(hex.Length < 4) hex = "0" + hex;
string hex = $"{c:x}";
while(hex.Length < 4)
hex = "0" + hex;
outString += hex;
}
else if(c == '\\') outString += "\\\\";
else if(c == '\"') outString += "\\\"";
else if(c == '\b') outString += "\\b";
else if(c == '\n') outString += "\\n";
else if(c == '\r') outString += "\\r";
else if(c == '\t') outString += "\\t";
else outString += c;
else
outString += c switch
{
'\\' => "\\\\",
'\"' => "\\\"",
'\b' => "\\b",
'\n' => "\\n",
'\r' => "\\r",
'\t' => "\\t",
_ => c
};
return outString;
}
@@ -290,9 +249,10 @@ namespace Claunia.PropertyList
/// </returns>
public override bool Equals(NSObject obj)
{
if(!(obj is NSString)) return false;
if(obj is not NSString nsString)
return false;
return Content == ((NSString)obj).Content;
return Content == nsString.Content;
}
internal static bool IsASCIIEncodable(string text)
@@ -304,14 +264,8 @@ namespace Claunia.PropertyList
return true;
}
public static explicit operator string(NSString value)
{
return value.Content;
}
public static explicit operator string(NSString value) => value.Content;
public static explicit operator NSString(string value)
{
return new NSString(value);
}
public static explicit operator NSString(string value) => new(value);
}
}

39
plist-cil/PropertyListException.cs
View File

@@ -29,40 +29,25 @@ using System.Runtime.Serialization;
namespace Claunia.PropertyList
{
/// <summary>
/// The exception that is thrown when an property list file could not be processed correctly.
/// </summary>
/// <summary>The exception that is thrown when an property list file could not be processed correctly.</summary>
[Serializable]
public class PropertyListException : Exception
{
/// <summary>
/// Initializes a new instance of the <see cref="PropertyListException" /> class.
/// </summary>
public PropertyListException() { }
/// <summary>Initializes a new instance of the <see cref="PropertyListException" /> class.</summary>
public PropertyListException() {}
/// <summary>
/// Initializes a new instance of the <see cref="PropertyListException" /> class.
/// </summary>
/// <param name="message">
/// The error message that explains the reason for the exception.
/// </param>
public PropertyListException(string message) : base(message) { }
/// <summary>Initializes a new instance of the <see cref="PropertyListException" /> class.</summary>
/// <param name="message">The error message that explains the reason for the exception.</param>
public PropertyListException(string message) : base(message) {}
/// <summary>
/// Initializes a new instance of the <see cref="PropertyListException" /> class.
/// </summary>
/// <param name="message">
/// The error message that explains the reason for the exception.
/// </param>
/// <summary>Initializes a new instance of the <see cref="PropertyListException" /> class.</summary>
/// <param name="message">The error message that explains the reason for the exception.</param>
/// <param name="inner">
/// The exception that is the cause of the current exception, or <see langword="null" />
/// if no inner exception is specified.
/// The exception that is the cause of the current exception, or <see langword="null" /> if no inner
/// exception is specified.
/// </param>
public PropertyListException(string message, Exception inner) : base(message, inner) { }
public PropertyListException(string message, Exception inner) : base(message, inner) {}
protected PropertyListException(SerializationInfo info, StreamingContext context)
: base(info, context)
{
}
protected PropertyListException(SerializationInfo info, StreamingContext context) : base(info, context) {}
}
}

10
plist-cil/PropertyListFormatException.cs
View File

@@ -26,17 +26,15 @@
namespace Claunia.PropertyList
{
/// <summary>
/// A PropertyListFormatException is thrown by the various property list format parsers
/// when an error in the format of the given property list is encountered.
/// A PropertyListFormatException is thrown by the various property list format parsers when an error in the
/// format of the given property list is encountered.
/// </summary>
/// @author Daniel Dreibrodt
/// @author Natalia Portillo
public class PropertyListFormatException : PropertyListException
{
/// <summary>
/// Creates a new exception with the given message.
/// </summary>
/// <summary>Creates a new exception with the given message.</summary>
/// <param name="message">A message containing information about the nature of the exception.</param>
public PropertyListFormatException(string message) : base(message) { }
public PropertyListFormatException(string message) : base(message) {}
}
}

287
plist-cil/PropertyListParser.cs
View File

@@ -30,9 +30,8 @@ using System.Text;
namespace Claunia.PropertyList
{
/// <summary>
/// This class provides methods to parse property lists. It can handle files,
/// input streams and byte arrays. All known property list formats are supported.
/// This class also provides methods to save and convert property lists.
/// This class provides methods to parse property lists. It can handle files, input streams and byte arrays. All
/// known property list formats are supported. This class also provides methods to save and convert property lists.
/// </summary>
/// @author Daniel Dreibrodt
/// @author Natalia Portillo
@@ -44,57 +43,71 @@ namespace Claunia.PropertyList
const int TYPE_ERROR_BLANK = 10;
const int TYPE_ERROR_UNKNOWN = 11;
/// <summary>
/// Determines the type of a property list by means of the first bytes of its data
/// </summary>
/// <summary>Determines the type of a property list by means of the first bytes of its data</summary>
/// <returns>The type of the property list</returns>
/// <param name="dataBeginning">The very first bytes of data of the property list (minus any whitespace) as a string</param>
static int DetermineTypeExact(ReadOnlySpan<byte> dataBeginning)
{
if(dataBeginning.Length == 0) return TYPE_ERROR_BLANK;
if(dataBeginning.Length == 0)
return TYPE_ERROR_BLANK;
if(dataBeginning[0] == '(' || dataBeginning[0] == '{' || dataBeginning[0] == '/') return TYPE_ASCII;
if(dataBeginning[0] == '(' ||
dataBeginning[0] == '{' ||
dataBeginning[0] == '/')
return TYPE_ASCII;
if(dataBeginning[0] == '<') return TYPE_XML;
if(dataBeginning.Length >= 6 && dataBeginning[0] == 'b' && dataBeginning[1] == 'p' &&
dataBeginning[2] == 'l' && dataBeginning[3] == 'i' && dataBeginning[4] == 's' &&
dataBeginning[5] == 't') return TYPE_BINARY;
if(dataBeginning[0] == '<')
return TYPE_XML;
if(dataBeginning.Length >= 6 &&
dataBeginning[0] == 'b' &&
dataBeginning[1] == 'p' &&
dataBeginning[2] == 'l' &&
dataBeginning[3] == 'i' &&
dataBeginning[4] == 's' &&
dataBeginning[5] == 't')
return TYPE_BINARY;
return TYPE_ERROR_UNKNOWN;
}
/// <summary>
/// Determines the type of a property list by means of the first bytes of its data
/// </summary>
/// <summary>Determines the type of a property list by means of the first bytes of its data</summary>
/// <returns>The very first bytes of data of the property list (minus any whitespace)</returns>
/// <param name="bytes">The type of the property list</param>
static int DetermineType(ReadOnlySpan<byte> bytes)
{
if(bytes.Length == 0) return TYPE_ERROR_BLANK;
if(bytes.Length == 0)
return TYPE_ERROR_BLANK;
//Skip any possible whitespace at the beginning of the file
int offset = 0;
if(bytes.Length >= 3 && (bytes[0] & 0xFF) == 0xEF && (bytes[1] & 0xFF) == 0xBB &&
(bytes[2] & 0xFF) == 0xBF) offset += 3;
while(offset < bytes.Length && (bytes[offset] == ' ' || bytes[offset] == '\t' || bytes[offset] == '\r' ||
bytes[offset] == '\n' || bytes[offset] == '\f')) offset++;
if(bytes.Length >= 3 &&
(bytes[0] & 0xFF) == 0xEF &&
(bytes[1] & 0xFF) == 0xBB &&
(bytes[2] & 0xFF) == 0xBF)
offset += 3;
while(offset < bytes.Length &&
(bytes[offset] == ' ' || bytes[offset] == '\t' || bytes[offset] == '\r' || bytes[offset] == '\n' ||
bytes[offset] == '\f'))
offset++;
ReadOnlySpan<byte> header = bytes.Slice(offset, Math.Min(8, bytes.Length - offset));
return DetermineTypeExact(header);
}
/// <summary>
/// Determines the type of a property list by means of the first bytes of its data
/// </summary>
/// <summary>Determines the type of a property list by means of the first bytes of its data</summary>
/// <returns>The type of the property list</returns>
/// <param name="fs">
/// An input stream pointing to the beginning of the property list data.
/// The stream will be reset to the beginning of the property
/// list data after the type has been determined.
/// An input stream pointing to the beginning of the property list data. The stream will be reset to the
/// beginning of the property list data after the type has been determined.
/// </param>
static int DetermineType(Stream fs, long offset = 0)
{
if(fs.Length == 0) return TYPE_ERROR_BLANK;
if(fs.Length == 0)
return TYPE_ERROR_BLANK;
long index = offset;
long readLimit = index + 1024;
@@ -109,18 +122,20 @@ namespace Claunia.PropertyList
if(++index > readLimit)
{
fs.Seek(mark, SeekOrigin.Begin);
return DetermineType(fs, readLimit);
}
b = fs.ReadByte();
//Check if we are reading the Unicode byte order mark (BOM) and skip it
bom = index < 3 && (index == 0 && b == 0xEF ||
bom && (index == 1 && b == 0xBB || index == 2 && b == 0xBF));
}
while(b != -1 && (b == ' ' || b == '\t' || b == '\r' || b == '\n' || b == '\f' || bom));
bom = index < 3 && ((index == 0 && b == 0xEF) ||
(bom && ((index == 1 && b == 0xBB) || (index == 2 && b == 0xBF))));
} while(b != -1 &&
(b is ' ' or '\t' or '\r' or '\n' or '\f' || bom));
if(b == -1) return TYPE_ERROR_BLANK;
if(b == -1)
return TYPE_ERROR_BLANK;
byte[] magicBytes = new byte[8];
magicBytes[0] = (byte)b;
@@ -128,46 +143,37 @@ namespace Claunia.PropertyList
int type = DetermineTypeExact(magicBytes.AsSpan(0, read));
fs.Seek(mark, SeekOrigin.Begin);
return type;
}
/// <summary>
/// Reads all bytes from an Stream and stores them in an array, up to
/// a maximum count.
/// </summary>
/// <summary>Reads all bytes from an Stream and stores them in an array, up to a maximum count.</summary>
/// <param name="fs">The Stream pointing to the data that should be stored in the array.</param>
internal static byte[] ReadAll(Stream fs)
{
using(MemoryStream outputStream = new MemoryStream())
{
fs.CopyTo(outputStream);
return outputStream.ToArray();
}
using var outputStream = new MemoryStream();
fs.CopyTo(outputStream);
return outputStream.ToArray();
}
/// <summary>
/// Parses a property list from a file.
/// </summary>
/// <summary>Parses a property list from a file.</summary>
/// <param name="filePath">Path to the property list file.</param>
/// <returns>The root object in the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
public static NSObject Parse(string filePath)
{
return Parse(new FileInfo(filePath));
}
public static NSObject Parse(string filePath) => Parse(new FileInfo(filePath));
/// <summary>
/// Parses a property list from a file.
/// </summary>
/// <summary>Parses a property list from a file.</summary>
/// <param name="f">The property list file.</param>
/// <returns>The root object in the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
public static NSObject Parse(FileInfo f)
{
using(FileStream fis = f.OpenRead()) return Parse(fis);
using FileStream fis = f.OpenRead();
return Parse(fis);
}
/// <summary>
/// Parses a property list from a byte array.
/// </summary>
/// <summary>Parses a property list from a byte array.</summary>
/// <param name="bytes">The property list data as a byte array.</param>
/// <returns>The root object in the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
public static NSObject Parse(byte[] bytes)
@@ -183,21 +189,14 @@ namespace Claunia.PropertyList
}
}
/// <summary>
/// Parses a property list from a byte array.
/// </summary>
/// <summary>Parses a property list from a byte array.</summary>
/// <param name="bytes">The property list data as a byte array.</param>
/// <param name="offset">The length of the property list.</param>
/// <param name="count">The offset at which to start reading the property list.</param>
/// <returns>The root object in the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
public static NSObject Parse(byte[] bytes, int offset, int length)
{
return Parse(bytes.AsSpan(offset, length));
}
public static NSObject Parse(byte[] bytes, int offset, int length) => Parse(bytes.AsSpan(offset, length));
/// <summary>
/// Parses a property list from a byte span.
/// </summary>
/// <summary>Parses a property list from a byte span.</summary>
/// <param name="bytes">The property list data as a byte array.</param>
/// <returns>The root object in the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
public static NSObject Parse(ReadOnlySpan<byte> bytes)
@@ -213,47 +212,41 @@ namespace Claunia.PropertyList
}
}
/// <summary>
/// Parses a property list from an Stream.
/// </summary>
/// <summary>Parses a property list from an Stream.</summary>
/// <param name="fs">The Stream delivering the property list data.</param>
/// <returns>The root object of the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
public static NSObject Parse(Stream fs)
{
return Parse(ReadAll(fs));
}
public static NSObject Parse(Stream fs) => Parse(ReadAll(fs));
/// <summary>
/// Saves a property list with the given object as root into a XML file.
/// </summary>
/// <summary>Saves a property list with the given object as root into a XML file.</summary>
/// <param name="root">The root object.</param>
/// <param name="outFile">The output file.</param>
/// <exception cref="IOException">When an error occurs during the writing process.</exception>
public static void SaveAsXml(NSObject root, FileInfo outFile)
{
string parent = outFile.DirectoryName;
if(!Directory.Exists(parent)) Directory.CreateDirectory(parent);
if(!Directory.Exists(parent))
Directory.CreateDirectory(parent);
// Use Create here -- to make sure that when the updated file is shorter than
// the original file, no "obsolete" data is left at the end.
using(Stream fous = outFile.Open(FileMode.Create, FileAccess.ReadWrite)) SaveAsXml(root, fous);
using Stream fous = outFile.Open(FileMode.Create, FileAccess.ReadWrite);
SaveAsXml(root, fous);
}
/// <summary>
/// Saves a property list with the given object as root in XML format into an output stream.
/// </summary>
/// <summary>Saves a property list with the given object as root in XML format into an output stream.</summary>
/// <param name="root">The root object.</param>
/// <param name="outStream">The output stream.</param>
/// <exception cref="IOException">When an error occurs during the writing process.</exception>
public static void SaveAsXml(NSObject root, Stream outStream)
{
using(StreamWriter w = new StreamWriter(outStream, Encoding.UTF8, 1024, true))
w.Write(root.ToXmlPropertyList());
using var w = new StreamWriter(outStream, Encoding.UTF8, 1024, true);
w.Write(root.ToXmlPropertyList());
}
/// <summary>
/// Converts a given property list file into the OS X and iOS XML format.
/// </summary>
/// <summary>Converts a given property list file into the OS X and iOS XML format.</summary>
/// <param name="inFile">The source file.</param>
/// <param name="outFile">The target file.</param>
public static void ConvertToXml(FileInfo inFile, FileInfo outFile)
@@ -262,33 +255,28 @@ namespace Claunia.PropertyList
SaveAsXml(root, outFile);
}
/// <summary>
/// Saves a property list with the given object as root into a binary file.
/// </summary>
/// <summary>Saves a property list with the given object as root into a binary file.</summary>
/// <param name="root">The root object.</param>
/// <param name="outFile">The output file.</param>
/// <exception cref="IOException">When an error occurs during the writing process.</exception>
public static void SaveAsBinary(NSObject root, FileInfo outFile)
{
string parent = outFile.DirectoryName;
if(!Directory.Exists(parent)) Directory.CreateDirectory(parent);
if(!Directory.Exists(parent))
Directory.CreateDirectory(parent);
BinaryPropertyListWriter.Write(outFile, root);
}
/// <summary>
/// Saves a property list with the given object as root in binary format into an output stream.
/// </summary>
/// <summary>Saves a property list with the given object as root in binary format into an output stream.</summary>
/// <param name="root">The root object.</param>
/// <param name="outStream">The output stream.</param>
/// <exception cref="IOException">When an error occurs during the writing process.</exception>
public static void SaveAsBinary(NSObject root, Stream outStream)
{
public static void SaveAsBinary(NSObject root, Stream outStream) =>
BinaryPropertyListWriter.Write(outStream, root);
}
/// <summary>
/// Converts a given property list file into the OS X and iOS binary format.
/// </summary>
/// <summary>Converts a given property list file into the OS X and iOS binary format.</summary>
/// <param name="inFile">The source file.</param>
/// <param name="outFile">The target file.</param>
public static void ConvertToBinary(FileInfo inFile, FileInfo outFile)
@@ -297,94 +285,115 @@ namespace Claunia.PropertyList
SaveAsBinary(root, outFile);
}
/// <summary>
/// Saves a property list with the given object as root into a ASCII file.
/// </summary>
/// <summary>Saves a property list with the given object as root into a ASCII file.</summary>
/// <param name="root">The root object.</param>
/// <param name="outFile">The output file.</param>
/// <exception cref="IOException">When an error occurs during the writing process.</exception>
public static void SaveAsASCII(NSDictionary root, FileInfo outFile)
{
string parent = outFile.DirectoryName;
if(!Directory.Exists(parent)) Directory.CreateDirectory(parent);
using(Stream fous = outFile.Open(FileMode.OpenOrCreate, FileAccess.ReadWrite))
using(StreamWriter w = new StreamWriter(fous, Encoding.ASCII))
w.Write(root.ToASCIIPropertyList());
if(!Directory.Exists(parent))
Directory.CreateDirectory(parent);
using Stream fous = outFile.Open(FileMode.OpenOrCreate, FileAccess.ReadWrite);
using var w = new StreamWriter(fous, Encoding.ASCII);
w.Write(root.ToASCIIPropertyList());
}
/// <summary>
/// Saves a property list with the given object as root into a ASCII file.
/// </summary>
/// <summary>Saves a property list with the given object as root into a ASCII file.</summary>
/// <param name="root">The root object.</param>
/// <param name="outFile">The output file.</param>
/// <exception cref="IOException">When an error occurs during the writing process.</exception>
public static void SaveAsASCII(NSArray root, FileInfo outFile)
{
string parent = outFile.DirectoryName;
if(!Directory.Exists(parent)) Directory.CreateDirectory(parent);
using(Stream fous = outFile.Open(FileMode.OpenOrCreate, FileAccess.ReadWrite))
using(StreamWriter w = new StreamWriter(fous, Encoding.ASCII))
w.Write(root.ToASCIIPropertyList());
if(!Directory.Exists(parent))
Directory.CreateDirectory(parent);
using Stream fous = outFile.Open(FileMode.OpenOrCreate, FileAccess.ReadWrite);
using var w = new StreamWriter(fous, Encoding.ASCII);
w.Write(root.ToASCIIPropertyList());
}
/// <summary>
/// Converts a given property list file into ASCII format.
/// </summary>
/// <summary>Converts a given property list file into ASCII format.</summary>
/// <param name="inFile">The source file.</param>
/// <param name="outFile">The target file.</param>
public static void ConvertToASCII(FileInfo inFile, FileInfo outFile)
{
NSObject root = Parse(inFile);
if(root is NSDictionary) SaveAsASCII((NSDictionary)root, outFile);
else if(root is NSArray) SaveAsASCII((NSArray)root, outFile);
if(root is NSDictionary dictionary)
SaveAsASCII(dictionary, outFile);
else if(root is NSArray array)
SaveAsASCII(array, outFile);
else
throw new PropertyListFormatException("The root of the given input property list " +
"is neither a Dictionary nor an Array!");
}
/// <summary>
/// Saves a property list with the given object as root into a GnuStep ASCII file.
/// </summary>
/// <summary>Saves a property list with the given object as root into a GnuStep ASCII file.</summary>
/// <param name="root">The root object.</param>
/// <param name="outFile">The output file.</param>
/// <exception cref="IOException">When an error occurs during the writing process.</exception>
public static void SaveAsGnuStepASCII(NSDictionary root, FileInfo outFile)
{
string parent = outFile.DirectoryName;
if(!Directory.Exists(parent)) Directory.CreateDirectory(parent);
using(Stream fous = outFile.Open(FileMode.OpenOrCreate, FileAccess.ReadWrite))
using(StreamWriter w = new StreamWriter(fous, Encoding.ASCII))
w.Write(root.ToGnuStepASCIIPropertyList());
if(!Directory.Exists(parent))
Directory.CreateDirectory(parent);
using Stream fous = outFile.Open(FileMode.OpenOrCreate, FileAccess.ReadWrite);
using var w = new StreamWriter(fous, Encoding.ASCII);
w.Write(root.ToGnuStepASCIIPropertyList());
}
/// <summary>
/// Saves a property list with the given object as root into a GnuStep ASCII file.
/// </summary>
/// <summary>Saves a property list with the given object as root into a GnuStep ASCII file.</summary>
/// <param name="root">The root object.</param>
/// <param name="outFile">The output file.</param>
/// <exception cref="IOException">When an error occurs during the writing process.</exception>
public static void SaveAsGnuStepASCII(NSArray root, FileInfo outFile)
{
string parent = outFile.DirectoryName;
if(!Directory.Exists(parent)) Directory.CreateDirectory(parent);
using(Stream fous = outFile.Open(FileMode.OpenOrCreate, FileAccess.ReadWrite))
using(StreamWriter w = new StreamWriter(fous, Encoding.ASCII))
w.Write(root.ToGnuStepASCIIPropertyList());
if(!Directory.Exists(parent))
Directory.CreateDirectory(parent);
using Stream fous = outFile.Open(FileMode.OpenOrCreate, FileAccess.ReadWrite);
using var w = new StreamWriter(fous, Encoding.ASCII);
w.Write(root.ToGnuStepASCIIPropertyList());
}
/// <summary>
/// Converts a given property list file into GnuStep ASCII format.
/// </summary>
/// <summary>Converts a given property list file into GnuStep ASCII format.</summary>
/// <param name="inFile">The source file.</param>
/// <param name="outFile">The target file.</param>
public static void ConvertToGnuStepASCII(FileInfo inFile, FileInfo outFile)
{
NSObject root = Parse(inFile);
if(root is NSDictionary) SaveAsGnuStepASCII((NSDictionary)root, outFile);
else if(root is NSArray) SaveAsGnuStepASCII((NSArray)root, outFile);
else
throw new PropertyListFormatException("The root of the given input property list " +
"is neither a Dictionary nor an Array!");
switch(root)
{
case NSDictionary dictionary:
SaveAsGnuStepASCII(dictionary, outFile);
break;
case NSArray array:
SaveAsGnuStepASCII(array, outFile);
break;
default:
throw new PropertyListFormatException("The root of the given input property list " +
"is neither a Dictionary nor an Array!");
}
}
}
}

133
plist-cil/UID.cs
View File

@@ -29,67 +29,56 @@ using System.Text;
namespace Claunia.PropertyList
{
/// <summary>
/// An UID. Only found in binary property lists that are keyed archives.
/// </summary>
/// <summary>An UID. Only found in binary property lists that are keyed archives.</summary>
/// @author Daniel Dreibrodt
/// @author Natalia Portillo
public class UID : NSObject
{
readonly ulong value;
/// <summary>
/// Initializes a new instance of the <see cref="Claunia.PropertyList.UID" /> class.
/// </summary>
/// <summary>Initializes a new instance of the <see cref="Claunia.PropertyList.UID" /> class.</summary>
/// <param name="bytes">Bytes.</param>
public UID(ReadOnlySpan<byte> bytes)
{
if(bytes.Length != 1 && bytes.Length != 2 && bytes.Length != 4 && bytes.Length != 8)
if(bytes.Length != 1 &&
bytes.Length != 2 &&
bytes.Length != 4 &&
bytes.Length != 8)
throw new ArgumentException("Type argument is not valid.");
value = (ulong)BinaryPropertyListParser.ParseLong(bytes);
}
/// <summary>
/// Initializes a new instance of the <see cref="Claunia.PropertyList.UID" /> class using an unsigned 8-bit number.
/// Initializes a new instance of the <see cref="Claunia.PropertyList.UID" /> class using an unsigned 8-bit
/// number.
/// </summary>
/// <param name="number">Unsigned 8-bit number.</param>
public UID(byte number)
{
value = number;
}
public UID(byte number) => value = number;
/// <summary>
/// Initializes a new instance of the <see cref="Claunia.PropertyList.UID" /> class using an unsigned 16-bit number.
/// Initializes a new instance of the <see cref="Claunia.PropertyList.UID" /> class using an unsigned 16-bit
/// number.
/// </summary>
/// <param name="name">Name.</param>
/// <param name="number">Unsigned 16-bit number.</param>
public UID(ushort number)
{
value = number;
}
public UID(ushort number) => value = number;
/// <summary>
/// Initializes a new instance of the <see cref="Claunia.PropertyList.UID" /> class using an unsigned 32-bit number.
/// Initializes a new instance of the <see cref="Claunia.PropertyList.UID" /> class using an unsigned 32-bit
/// number.
/// </summary>
/// <param name="number">Unsigned 32-bit number.</param>
public UID(uint number)
{
value = number;
}
public UID(uint number) => value = number;
/// <summary>
/// Initializes a new instance of the <see cref="Claunia.PropertyList.UID" /> class using an unsigned 64-bit number.
/// Initializes a new instance of the <see cref="Claunia.PropertyList.UID" /> class using an unsigned 64-bit
/// number.
/// </summary>
/// <param name="number">Unsigned 64-bit number.</param>
public UID(ulong number)
{
value = number;
}
public UID(ulong number) => value = number;
/// <summary>
/// Gets the bytes.
/// </summary>
/// <summary>Gets the bytes.</summary>
/// <value>The bytes.</value>
public byte[] Bytes
{
@@ -97,50 +86,44 @@ namespace Claunia.PropertyList
{
byte[] bytes = new byte[ByteCount];
GetBytes(bytes);
return bytes;
}
}
/// <summary>
/// Gets the number of bytes required to represent this <see cref="UID" />.
/// </summary>
public int ByteCount
/// <summary>Gets the number of bytes required to represent this <see cref="UID" />.</summary>
public int ByteCount => value switch
{
get
{
if(value <= byte.MaxValue) return 1;
<= byte.MaxValue => 1,
<= ushort.MaxValue => 2,
<= uint.MaxValue => 4,
_ => 8
};
if(value <= ushort.MaxValue) return 2;
if(value <= uint.MaxValue) return 4;
return 8;
}
}
/// <summary>
/// Writes the bytes required to represent this <see cref="UID" /> to a byte span.
/// </summary>
/// <param name="bytes">
/// The byte span to which to write the byte representation of this UID.
/// </param>
/// <summary>Writes the bytes required to represent this <see cref="UID" /> to a byte span.</summary>
/// <param name="bytes">The byte span to which to write the byte representation of this UID.</param>
public void GetBytes(Span<byte> bytes)
{
switch(ByteCount)
{
case 1:
bytes[0] = (byte)value;
break;
case 2:
BinaryPrimitives.WriteUInt16BigEndian(bytes, (ushort)value);
break;
case 4:
BinaryPrimitives.WriteUInt32BigEndian(bytes, (uint)value);
break;
case 8:
BinaryPrimitives.WriteUInt64BigEndian(bytes, value);
break;
default: throw new InvalidOperationException();
@@ -148,9 +131,8 @@ namespace Claunia.PropertyList
}
/// <summary>
/// UIDs are represented as dictionaries in XML property lists,
/// where the key is always <c>CF$UID</c> and the value is the integer
/// representation of the UID.
/// UIDs are represented as dictionaries in XML property lists, where the key is always <c>CF$UID</c> and the
/// value is the integer representation of the UID.
/// </summary>
/// <param name="xml">The xml StringBuilder</param>
/// <param name="level">The indentation level</param>
@@ -165,7 +147,7 @@ namespace Claunia.PropertyList
xml.AppendLine();
Indent(xml, level + 1);
xml.Append($"<integer>{this.value}</integer>");
xml.Append($"<integer>{value}</integer>");
xml.AppendLine();
Indent(xml, level);
@@ -186,14 +168,14 @@ namespace Claunia.PropertyList
ascii.Append("\"");
Span<byte> bytes = stackalloc byte[ByteCount];
GetBytes(bytes);
foreach(byte b in bytes) ascii.Append(string.Format("{0:x2}", b));
foreach(byte b in bytes)
ascii.Append($"{b:x2}");
ascii.Append("\"");
}
internal override void ToASCIIGnuStep(StringBuilder ascii, int level)
{
ToASCII(ascii, level);
}
internal override void ToASCIIGnuStep(StringBuilder ascii, int level) => ToASCII(ascii, level);
/// <summary>
/// Determines whether the specified <see cref="Claunia.PropertyList.NSObject" /> is equal to the current
@@ -207,42 +189,25 @@ namespace Claunia.PropertyList
/// <c>true</c> if the specified <see cref="Claunia.PropertyList.NSObject" /> is equal to the current
/// <see cref="Claunia.PropertyList.UID" />; otherwise, <c>false</c>.
/// </returns>
public override bool Equals(NSObject obj)
{
return Equals((object)obj);
}
public override bool Equals(NSObject obj) => Equals((object)obj);
/// <inheritdoc />
public override bool Equals(object obj)
{
UID uid = obj as UID;
if(uid == null) return false;
if(obj is not UID uid)
return false;
return uid.value == value;
}
/// <inheritdoc />
public override int GetHashCode()
{
return value.GetHashCode();
}
public override int GetHashCode() => value.GetHashCode();
/// <inheritdoc />
public override string ToString()
{
return $"{value} (UID)";
}
public override string ToString() => $"{value} (UID)";
/// <summary>
/// Gets a <see cref="ulong"/> which represents this <see cref="UID"/>.
/// </summary>
/// <returns>
/// A <see cref="ulong"/> which represents this <see cref="UID"/>.
/// </returns>
public ulong ToUInt64()
{
return this.value;
}
/// <summary>Gets a <see cref="ulong" /> which represents this <see cref="UID" />.</summary>
/// <returns>A <see cref="ulong" /> which represents this <see cref="UID" />.</returns>
public ulong ToUInt64() => value;
}
}

169
plist-cil/XmlPropertyListParser.cs
View File

@@ -30,69 +30,64 @@ using System.Xml;
namespace Claunia.PropertyList
{
/// <summary>
/// Parses XML property lists.
/// </summary>
/// <summary>Parses XML property lists.</summary>
/// @author Daniel Dreibrodt
/// @author Natalia Portillo
public static class XmlPropertyListParser
{
/// <summary>
/// Parses a XML property list file.
/// </summary>
/// <summary>Parses a XML property list file.</summary>
/// <param name="f">The XML property list file.</param>
/// <returns>The root object of the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
public static NSObject Parse(FileInfo f)
{
XmlDocument doc = new XmlDocument();
var doc = new XmlDocument();
XmlReaderSettings settings = new XmlReaderSettings {DtdProcessing = DtdProcessing.Ignore};
var settings = new XmlReaderSettings
{
DtdProcessing = DtdProcessing.Ignore
};
using(Stream stream = f.OpenRead())
using(XmlReader reader = XmlReader.Create(stream, settings))
using(var reader = XmlReader.Create(stream, settings))
doc.Load(reader);
return ParseDocument(doc);
}
/// <summary>
/// Parses a XML property list from a byte array.
/// </summary>
/// <summary>Parses a XML property list from a byte array.</summary>
/// <param name="bytes">The byte array containing the property list's data.</param>
/// <returns>The root object of the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
public static NSObject Parse(byte[] bytes)
{
MemoryStream bis = new MemoryStream(bytes);
var bis = new MemoryStream(bytes);
return Parse(bis);
}
/// <summary>
/// Parses a XML property list from an input stream.
/// </summary>
/// <summary>Parses a XML property list from an input stream.</summary>
/// <param name="str">The input stream pointing to the property list's data.</param>
/// <returns>The root object of the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
public static NSObject Parse(Stream str)
{
XmlDocument doc = new XmlDocument();
var doc = new XmlDocument();
XmlReaderSettings settings = new XmlReaderSettings();
var settings = new XmlReaderSettings();
settings.DtdProcessing = DtdProcessing.Ignore;
using(XmlReader reader = XmlReader.Create(str, settings)) doc.Load(reader);
using(var reader = XmlReader.Create(str, settings))
doc.Load(reader);
return ParseDocument(doc);
}
/// <summary>
/// Parses a XML property list from a string.
/// </summary>
/// <summary>Parses a XML property list from a string.</summary>
/// <param name="value">The string pointing to the property list's data.</param>
/// <returns>The root object of the property list. This is usually a NSDictionary but can also be a NSArray.</returns>
public static NSObject ParseString(string value)
{
XmlDocument doc = new XmlDocument();
var doc = new XmlDocument();
XmlReaderSettings settings = new XmlReaderSettings();
var settings = new XmlReaderSettings();
settings.DtdProcessing = DtdProcessing.Ignore;
doc.LoadXml(value);
@@ -100,19 +95,18 @@ namespace Claunia.PropertyList
return ParseDocument(doc);
}
/// <summary>
/// Parses the XML document by generating the appropriate NSObjects for each XML node.
/// </summary>
/// <summary>Parses the XML document by generating the appropriate NSObjects for each XML node.</summary>
/// <returns>The root NSObject of the property list contained in the XML document.</returns>
/// <param name="doc">The XML document.</param>
static NSObject ParseDocument(XmlDocument doc)
{
XmlNode docType = doc.ChildNodes.OfType<XmlNode>()
.SingleOrDefault(n => n.NodeType == XmlNodeType.DocumentType);
XmlNode docType = doc.ChildNodes.OfType<XmlNode>().
SingleOrDefault(n => n.NodeType == XmlNodeType.DocumentType);
if(docType == null)
{
if(!doc.DocumentElement.Name.Equals("plist"))
if(doc.DocumentElement != null &&
!doc.DocumentElement.Name.Equals("plist"))
throw new XmlException("The given XML document is not a property list.");
}
else if(!docType.Name.Equals("plist"))
@@ -120,46 +114,43 @@ namespace Claunia.PropertyList
XmlNode rootNode;
if(doc.DocumentElement.Name.Equals("plist"))
if(doc.DocumentElement is { Name: "plist" })
{
//Root element wrapped in plist tag
List<XmlNode> rootNodes = FilterElementNodes(doc.DocumentElement.ChildNodes);
if(rootNodes.Count == 0)
throw new PropertyListFormatException("The given XML property list has no root element!");
if(rootNodes.Count == 1) rootNode = rootNodes[0];
else
throw
new PropertyListFormatException("The given XML property list has more than one root element!");
rootNode = rootNodes.Count switch
{
0 => throw new PropertyListFormatException("The given XML property list has no root element!"),
1 => rootNodes[0],
_ => throw new
PropertyListFormatException("The given XML property list has more than one root element!")
};
}
else
//Root NSObject not wrapped in plist-tag
rootNode = doc.DocumentElement;
return ParseObject(rootNode);
}
/// <summary>
/// Parses a node in the XML structure and returns the corresponding NSObject
/// </summary>
/// <summary>Parses a node in the XML structure and returns the corresponding NSObject</summary>
/// <returns>The corresponding NSObject.</returns>
/// <param name="n">The XML node.</param>
static NSObject ParseObject(XmlNode n)
{
if(n.Name.Equals("dict"))
switch(n.Name)
{
// Special case for UID values
if(n.ChildNodes.Count == 2
&& n.ChildNodes[0].Name == "key"
&& n.ChildNodes[0].InnerText == "CF$UID"
&& n.ChildNodes[1].Name == "integer"
&& uint.TryParse(n.ChildNodes[1].InnerText, out uint uidValue))
case "dict" when n.ChildNodes.Count == 2 && n.ChildNodes[0].Name == "key" &&
n.ChildNodes[0].InnerText == "CF$UID" && n.ChildNodes[1].Name == "integer" &&
uint.TryParse(n.ChildNodes[1].InnerText, out uint uidValue): return new UID(uidValue);
case "dict":
{
return new UID(uidValue);
}
else
{
NSDictionary dict = new NSDictionary();
var dict = new NSDictionary();
List<XmlNode> children = FilterElementNodes(n.ChildNodes);
for(int i = 0; i < children.Count; i += 2)
{
XmlNode key = children[i];
@@ -172,69 +163,69 @@ namespace Claunia.PropertyList
return dict;
}
case "array":
{
List<XmlNode> children = FilterElementNodes(n.ChildNodes);
var array = new NSArray(children.Count);
for(int i = 0; i < children.Count; i++)
array.Add(ParseObject(children[i]));
return array;
}
case "true": return new NSNumber(true);
case "false": return new NSNumber(false);
case "integer": return new NSNumber(GetNodeTextContents(n), NSNumber.INTEGER);
case "real": return new NSNumber(GetNodeTextContents(n), NSNumber.REAL);
case "string": return new NSString(GetNodeTextContents(n));
case "data": return new NSData(GetNodeTextContents(n));
default: return n.Name.Equals("date") ? new NSDate(GetNodeTextContents(n)) : null;
}
if(n.Name.Equals("array"))
{
List<XmlNode> children = FilterElementNodes(n.ChildNodes);
NSArray array = new NSArray(children.Count);
for(int i = 0; i < children.Count; i++) array.Add(ParseObject(children[i]));
return array;
}
if(n.Name.Equals("true")) return new NSNumber(true);
if(n.Name.Equals("false")) return new NSNumber(false);
if(n.Name.Equals("integer")) return new NSNumber(GetNodeTextContents(n), NSNumber.INTEGER);
if(n.Name.Equals("real")) return new NSNumber(GetNodeTextContents(n), NSNumber.REAL);
if(n.Name.Equals("string")) return new NSString(GetNodeTextContents(n));
if(n.Name.Equals("data")) return new NSData(GetNodeTextContents(n));
return n.Name.Equals("date") ? new NSDate(GetNodeTextContents(n)) : null;
}
/// <summary>
/// Returns all element nodes that are contained in a list of nodes.
/// </summary>
/// <summary>Returns all element nodes that are contained in a list of nodes.</summary>
/// <returns>The sublist containing only nodes representing actual elements.</returns>
/// <param name="list">The list of nodes to search.</param>
static List<XmlNode> FilterElementNodes(XmlNodeList list)
{
List<XmlNode> result = new List<XmlNode>();
List<XmlNode> result = new();
foreach(XmlNode child in list)
if(child.NodeType == XmlNodeType.Element)
result.Add(child);
return result;
}
/// <summary>
/// Returns a node's text content.
/// This method will return the text value represented by the node's direct children.
/// If the given node is a TEXT or CDATA node, then its value is returned.
/// Returns a node's text content. This method will return the text value represented by the node's direct
/// children. If the given node is a TEXT or CDATA node, then its value is returned.
/// </summary>
/// <returns>The node's text content.</returns>
/// <param name="n">The node.</param>
static string GetNodeTextContents(XmlNode n)
{
if(n.NodeType == XmlNodeType.Text || n.NodeType == XmlNodeType.CDATA)
if(n.NodeType is XmlNodeType.Text or XmlNodeType.CDATA)
{
string content = n.Value; //This concatenates any adjacent text/cdata/entity nodes
return content ?? "";
}
if(n.HasChildNodes)
{
XmlNodeList children = n.ChildNodes;
foreach(XmlNode child in children)
//Skip any non-text nodes, like comments or entities
if(child.NodeType == XmlNodeType.Text || child.NodeType == XmlNodeType.CDATA)
{
string content = child.Value; //This concatenates any adjacent text/cdata/entity nodes
return content ?? "";
}
if(!n.HasChildNodes)
return "";
}
XmlNodeList children = n.ChildNodes;
foreach(XmlNode child in children)
//Skip any non-text nodes, like comments or entities
if(child.NodeType is XmlNodeType.Text or XmlNodeType.CDATA)
{
string content = child.Value; //This concatenates any adjacent text/cdata/entity nodes
return content ?? "";
}
return "";
}