Skip to content

Add PDictionary.OpenFile and TryOpenFile methods #172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rolfbjarne merged 3 commits into from
Apr 30, 2026
Merged

Add PDictionary.OpenFile and TryOpenFile methods #172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0694bf
Add PDictionary.OpenFile and TryOpenFile methods
rolfbjarne Apr 28, 2026
a5edf5b
Add tests showing PObject.FromFile returns non-PDictionary types
rolfbjarne Apr 28, 2026
3a063f8
Add tests for [Try]OpenFile with non-dictionary root plist types
rolfbjarne Apr 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 52 additions & 1 deletion Xamarin.MacDev/PListObject.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -769,6 +769,57 @@ static int IndexOf (byte [] haystack, int startIndex, byte [] needle)
return (PDictionary?) PObject.FromFile (fileName, out isBinary);
}

/// <summary>
/// Opens a plist file and returns a PDictionary.
/// Throws if the file does not exist, cannot be parsed, or does not contain a dictionary.
/// </summary>
public static PDictionary OpenFile (string fileName)
{
return OpenFile (fileName, out _);
}

/// <summary>
/// Opens a plist file and returns a PDictionary.
/// Throws if the file does not exist, cannot be parsed, or does not contain a dictionary.
/// </summary>
public static PDictionary OpenFile (string fileName, out bool isBinary)
{
var result = PObject.FromFile (fileName, out isBinary);
if (result is PDictionary dict)
return dict;
throw new FormatException ($"The plist file '{fileName}' does not contain a dictionary (got {result?.GetType ().Name ?? "null"}).");
}

/// <summary>
/// Tries to open a plist file as a PDictionary.
/// Returns false if the file does not exist, cannot be parsed, or does not contain a dictionary.
/// </summary>
public static bool TryOpenFile (string fileName, [NotNullWhen (true)] out PDictionary? result)
{
return TryOpenFile (fileName, out result, out _);
}

/// <summary>
/// Tries to open a plist file as a PDictionary.
/// Returns false if the file does not exist, cannot be parsed, or does not contain a dictionary.
/// </summary>
public static bool TryOpenFile (string fileName, [NotNullWhen (true)] out PDictionary? result, out bool isBinary)
{
result = null;
isBinary = false;

try {
var obj = PObject.FromFile (fileName, out isBinary);
if (obj is PDictionary dict) {
result = dict;
return true;
}
return false;
} catch {
Comment thread
rolfbjarne marked this conversation as resolved.
return false;
}
}

public static PDictionary? FromBinaryXml (string fileName)
{
return FromBinaryXml (File.ReadAllBytes (fileName));
Expand Down Expand Up @@ -1919,7 +1970,7 @@ protected override void ReadObjectHead ()
try {
CurrentType = (PlistType) Enum.Parse (typeof (PlistType), reader!.LocalName);
} catch (Exception ex) {
throw new ArgumentException (string.Format ("Failed to parse PList data type: {0}", reader?.LocalName), ex);
throw new FormatException (string.Format ("Failed to parse PList data type: {0}", reader?.LocalName), ex);
}
}

Expand Down
304 changes: 304 additions & 0 deletions tests/PListObjectTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,310 @@ public void TestStrings ()
Assert.That (plist.TryGetStringValue ("✅", out var emojiValue), Is.True);
Assert.That (emojiValue, Is.EqualTo ("❌"));
}

string CreateTempPlistFile (string content)
{
var path = Path.Combine (Path.GetTempPath (), Path.GetRandomFileName () + ".plist");
File.WriteAllText (path, content);
return path;
}

static readonly string SamplePlistXml = @"<?xml version=""1.0"" encoding=""UTF-8""?>
<!DOCTYPE plist PUBLIC ""-//Apple//DTD PLIST 1.0//EN"" ""http://www.apple.com/DTDs/PropertyList-1.0.dtd"">
<plist version=""1.0"">
<dict>
<key>Name</key>
<string>Test</string>
</dict>
</plist>";

static readonly string ArrayPlistXml = @"<?xml version=""1.0"" encoding=""UTF-8""?>
<!DOCTYPE plist PUBLIC ""-//Apple//DTD PLIST 1.0//EN"" ""http://www.apple.com/DTDs/PropertyList-1.0.dtd"">
<plist version=""1.0"">
<array>
<string>A</string>
</array>
</plist>";

static readonly string StringPlistXml = @"<?xml version=""1.0"" encoding=""UTF-8""?>
<!DOCTYPE plist PUBLIC ""-//Apple//DTD PLIST 1.0//EN"" ""http://www.apple.com/DTDs/PropertyList-1.0.dtd"">
<plist version=""1.0"">
<string>hello world</string>
</plist>";

static readonly string IntegerPlistXml = @"<?xml version=""1.0"" encoding=""UTF-8""?>
<!DOCTYPE plist PUBLIC ""-//Apple//DTD PLIST 1.0//EN"" ""http://www.apple.com/DTDs/PropertyList-1.0.dtd"">
<plist version=""1.0"">
<integer>42</integer>
</plist>";

static readonly string RealPlistXml = @"<?xml version=""1.0"" encoding=""UTF-8""?>
<!DOCTYPE plist PUBLIC ""-//Apple//DTD PLIST 1.0//EN"" ""http://www.apple.com/DTDs/PropertyList-1.0.dtd"">
<plist version=""1.0"">
<real>3.14</real>
</plist>";

static readonly string BooleanPlistXml = @"<?xml version=""1.0"" encoding=""UTF-8""?>
<!DOCTYPE plist PUBLIC ""-//Apple//DTD PLIST 1.0//EN"" ""http://www.apple.com/DTDs/PropertyList-1.0.dtd"">
<plist version=""1.0"">
<true/>
</plist>";

static readonly string DatePlistXml = @"<?xml version=""1.0"" encoding=""UTF-8""?>
<!DOCTYPE plist PUBLIC ""-//Apple//DTD PLIST 1.0//EN"" ""http://www.apple.com/DTDs/PropertyList-1.0.dtd"">
<plist version=""1.0"">
<date>2024-01-15T10:30:00Z</date>
</plist>";

static readonly string DataPlistXml = @"<?xml version=""1.0"" encoding=""UTF-8""?>
<!DOCTYPE plist PUBLIC ""-//Apple//DTD PLIST 1.0//EN"" ""http://www.apple.com/DTDs/PropertyList-1.0.dtd"">
<plist version=""1.0"">
<data>AQID</data>
</plist>";

[Test]
public void OpenFile_ValidDictionary ()
{
var path = CreateTempPlistFile (SamplePlistXml);
try {
var dict = PDictionary.OpenFile (path);
Assert.That (dict, Is.Not.Null);
Assert.That (dict.TryGetStringValue ("Name", out var name), Is.True);
Assert.That (name, Is.EqualTo ("Test"));
} finally {
File.Delete (path);
}
}

[Test]
public void OpenFile_ValidDictionaryWithIsBinary ()
{
var path = CreateTempPlistFile (SamplePlistXml);
try {
var dict = PDictionary.OpenFile (path, out bool isBinary);
Assert.That (isBinary, Is.False);
Assert.That (dict, Is.Not.Null);
} finally {
File.Delete (path);
}
}

[Test]
public void OpenFile_FileNotFound ()
{
var path = Path.Combine (Path.GetTempPath (), "nonexistent-" + Path.GetRandomFileName () + ".plist");
Assert.Throws<FileNotFoundException> (() => PDictionary.OpenFile (path));
}

[Test]
public void OpenFile_NotADictionary ()
{
var path = CreateTempPlistFile (ArrayPlistXml);
try {
var ex = Assert.Throws<FormatException> (() => PDictionary.OpenFile (path));
Assert.That (ex.Message, Does.Contain ("does not contain a dictionary"));
} finally {
File.Delete (path);
}
}

[Test]
public void OpenFile_InvalidContent ()
{
var path = CreateTempPlistFile ("this is not valid plist content");
try {
Assert.Throws<FormatException> (() => PDictionary.OpenFile (path));
} finally {
File.Delete (path);
}
}

[Test]
public void TryOpenFile_ValidDictionary ()
{
var path = CreateTempPlistFile (SamplePlistXml);
try {
Assert.That (PDictionary.TryOpenFile (path, out var dict), Is.True);
Assert.That (dict, Is.Not.Null);
Assert.That (dict.TryGetStringValue ("Name", out var name), Is.True);
Assert.That (name, Is.EqualTo ("Test"));
} finally {
File.Delete (path);
}
}

[Test]
public void TryOpenFile_ValidDictionaryWithIsBinary ()
{
var path = CreateTempPlistFile (SamplePlistXml);
try {
Assert.That (PDictionary.TryOpenFile (path, out var dict, out bool isBinary), Is.True);
Assert.That (isBinary, Is.False);
Assert.That (dict, Is.Not.Null);
} finally {
File.Delete (path);
}
}

[Test]
public void TryOpenFile_FileNotFound ()
{
var path = Path.Combine (Path.GetTempPath (), "nonexistent-" + Path.GetRandomFileName () + ".plist");
Assert.That (PDictionary.TryOpenFile (path, out var dict), Is.False);
Assert.That (dict, Is.Null);
}

[Test]
public void TryOpenFile_NotADictionary ()
{
var path = CreateTempPlistFile (ArrayPlistXml);
try {
Assert.That (PDictionary.TryOpenFile (path, out var dict), Is.False);
Assert.That (dict, Is.Null);
} finally {
File.Delete (path);
}
}

[Test]
public void TryOpenFile_InvalidContent ()
{
var path = CreateTempPlistFile ("this is not valid plist content");
try {
Assert.That (PDictionary.TryOpenFile (path, out var dict), Is.False);
Assert.That (dict, Is.Null);
} finally {
File.Delete (path);
}
}

static readonly object [] NonDictPlistCases = new object [] {
new object [] { "array", ArrayPlistXml, "PArray" },
new object [] { "string", StringPlistXml, "PString" },
new object [] { "integer", IntegerPlistXml, "PNumber" },
new object [] { "real", RealPlistXml, "PReal" },
new object [] { "boolean", BooleanPlistXml, "PBoolean" },
new object [] { "date", DatePlistXml, "PDate" },
new object [] { "data", DataPlistXml, "PData" },
};

[TestCaseSource (nameof (NonDictPlistCases))]
public void OpenFile_NonDictRoot_Throws (string label, string xml, string expectedTypeName)
{
var path = CreateTempPlistFile (xml);
try {
var ex = Assert.Throws<FormatException> (() => PDictionary.OpenFile (path));
Assert.That (ex.Message, Does.Contain ("does not contain a dictionary"));
Assert.That (ex.Message, Does.Contain (expectedTypeName));
} finally {
File.Delete (path);
}
}

[TestCaseSource (nameof (NonDictPlistCases))]
public void TryOpenFile_NonDictRoot_ReturnsFalse (string label, string xml, string expectedTypeName)
{
var path = CreateTempPlistFile (xml);
try {
Assert.That (PDictionary.TryOpenFile (path, out var dict), Is.False);
Assert.That (dict, Is.Null);
} finally {
File.Delete (path);
}
}

[Test]
public void FromFile_ReturnsArray ()
{
var path = CreateTempPlistFile (ArrayPlistXml);
try {
var obj = PObject.FromFile (path, out bool isBinary);
Assert.That (obj, Is.InstanceOf<PArray> ());
Comment thread
rolfbjarne marked this conversation as resolved.
var array = (PArray) obj!;
Assert.That (array.Count, Is.EqualTo (1));
Assert.That (((PString) array [0]).Value, Is.EqualTo ("A"));
} finally {
File.Delete (path);
}
}

[Test]
public void FromFile_ReturnsString ()
{
var path = CreateTempPlistFile (StringPlistXml);
try {
var obj = PObject.FromFile (path, out bool isBinary);
Assert.That (obj, Is.InstanceOf<PString> ());
Comment thread
rolfbjarne marked this conversation as resolved.
Assert.That (((PString) obj!).Value, Is.EqualTo ("hello world"));
} finally {
File.Delete (path);
}
}

[Test]
public void FromFile_ReturnsInteger ()
{
var path = CreateTempPlistFile (IntegerPlistXml);
try {
var obj = PObject.FromFile (path, out bool isBinary);
Assert.That (obj, Is.InstanceOf<PNumber> ());
Assert.That (((PNumber) obj!).Value, Is.EqualTo (42));
Comment thread
rolfbjarne marked this conversation as resolved.
} finally {
File.Delete (path);
}
}

[Test]
public void FromFile_ReturnsReal ()
{
var path = CreateTempPlistFile (RealPlistXml);
try {
var obj = PObject.FromFile (path, out bool isBinary);
Assert.That (obj, Is.InstanceOf<PReal> ());
Assert.That (((PReal) obj!).Value, Is.EqualTo (3.14));
Comment thread
rolfbjarne marked this conversation as resolved.
} finally {
File.Delete (path);
}
}

[Test]
public void FromFile_ReturnsBoolean ()
{
var path = CreateTempPlistFile (BooleanPlistXml);
try {
var obj = PObject.FromFile (path, out bool isBinary);
Assert.That (obj, Is.InstanceOf<PBoolean> ());
Assert.That (((PBoolean) obj!).Value, Is.True);
Comment thread
rolfbjarne marked this conversation as resolved.
} finally {
File.Delete (path);
}
}

[Test]
public void FromFile_ReturnsDate ()
{
var path = CreateTempPlistFile (DatePlistXml);
try {
var obj = PObject.FromFile (path, out bool isBinary);
Assert.That (obj, Is.InstanceOf<PDate> ());
Assert.That (((PDate) obj!).Value, Is.EqualTo (new DateTime (2024, 1, 15, 10, 30, 0, DateTimeKind.Utc)));
Comment thread
rolfbjarne marked this conversation as resolved.
} finally {
File.Delete (path);
}
}

[Test]
public void FromFile_ReturnsData ()
{
var path = CreateTempPlistFile (DataPlistXml);
try {
var obj = PObject.FromFile (path, out bool isBinary);
Assert.That (obj, Is.InstanceOf<PData> ());
Assert.That (((PData) obj!).Value, Is.EqualTo (new byte [] { 1, 2, 3 }));
Comment thread
rolfbjarne marked this conversation as resolved.
} finally {
File.Delete (path);
}
}
}
}

Loading