mirror of https://github.com/dahall/Vanara.git
Updated PIDL wrapper to fix memory release errors and add a few helper methods.
David Hall
parent
dd46a07422
commit
19c6995b60
|
|
@ -1,37 +1,27 @@
|
|||
using Microsoft.Win32.SafeHandles;
|
||||
using System;
|
||||
using System;
|
||||
using System.Collections;
|
||||
using System.Collections.Generic;
|
||||
using System.Diagnostics;
|
||||
using System.Linq;
|
||||
using System.Runtime.InteropServices;
|
||||
using System.Text;
|
||||
using Vanara.Extensions;
|
||||
using Vanara.InteropServices;
|
||||
|
||||
//using static Vanara.Shell32.PIDLUtil;
|
||||
// ReSharper disable InconsistentNaming
|
||||
|
||||
namespace Vanara.PInvoke
|
||||
{
|
||||
public static partial class Shell32
|
||||
{
|
||||
/// <summary>
|
||||
/// Represents a managed pointer to an ITEMIDLIST.
|
||||
/// </summary>
|
||||
/// <seealso cref="SafeHandleZeroOrMinusOneIsInvalid" />
|
||||
/// <seealso cref="System.Collections.Generic.IEnumerable{PIDL}" />
|
||||
/// <summary>Represents a managed pointer to an ITEMIDLIST.</summary>
|
||||
/// <seealso cref="System.Collections.Generic.IEnumerable{PIDL}"/>
|
||||
[PInvokeData("Shtypes.h", MSDNShortId = "bb773321")]
|
||||
public class PIDL : SafeHandleZeroOrMinusOneIsInvalid, IEnumerable<PIDL>, IEquatable<PIDL>, IEquatable<IntPtr>
|
||||
public class PIDL : GenericSafeHandle, IEnumerable<PIDL>, IEquatable<PIDL>, IEquatable<IntPtr>
|
||||
{
|
||||
/// <summary>Initializes a new instance of the <see cref="PIDL"/> class.</summary>
|
||||
/// <param name="pidl">The raw pointer to a native ITEMIDLIST.</param>
|
||||
/// <param name="clone">if set to <c>true</c> clone the list before storing it.</param>
|
||||
/// <param name="own">if set to <c>true</c><see cref="PIDL"/> will release the memory associated with the ITEMIDLIST when done.</param>
|
||||
public PIDL(IntPtr pidl, bool clone = false, bool own = true) : base(clone || own)
|
||||
{
|
||||
SetHandle(clone ? IntILClone(pidl) : pidl);
|
||||
}
|
||||
public PIDL(IntPtr pidl, bool clone = false, bool own = true) : base(clone ? IntILClone(pidl) : pidl, Free, clone || own) { }
|
||||
|
||||
/// <summary>Initializes a new instance of the <see cref="PIDL"/> class.</summary>
|
||||
/// <param name="pidl">An existing <see cref="PIDL"/> that will be copied and managed.</param>
|
||||
|
|
@ -39,13 +29,14 @@ namespace Vanara.PInvoke
|
|||
|
||||
/// <summary>Initializes a new instance of the <see cref="PIDL"/> class from a file path.</summary>
|
||||
/// <param name="path">A string that contains the path.</param>
|
||||
public PIDL(string path) : base(true)
|
||||
{
|
||||
SetHandle(IntILCreateFromPath(path));
|
||||
}
|
||||
public PIDL(string path) : this(IntILCreateFromPath(path)) { }
|
||||
|
||||
/// <summary>Initializes a new instance of the <see cref="PIDL"/> class.</summary>
|
||||
internal PIDL() : base(true) { }
|
||||
internal PIDL() : base(Free) { }
|
||||
|
||||
/// <summary>Gets a value representing a NULL PIDL.</summary>
|
||||
/// <value>The null equivalent.</value>
|
||||
public static PIDL Null { get; } = new PIDL();
|
||||
|
||||
/// <summary>Gets a value indicating whether this list is empty.</summary>
|
||||
/// <value><c>true</c> if this list is empty; otherwise, <c>false</c>.</value>
|
||||
|
|
@ -53,32 +44,57 @@ namespace Vanara.PInvoke
|
|||
|
||||
/// <summary>Gets the last SHITEMID in this ITEMIDLIST.</summary>
|
||||
/// <value>The last SHITEMID.</value>
|
||||
public PIDL LastId => ILFindLastID(handle);
|
||||
public PIDL LastId => new PIDL(ILFindLastID(handle), true);
|
||||
|
||||
/// <summary>Gets a value representing a NULL PIDL.</summary>
|
||||
/// <value>The null equivalent.</value>
|
||||
public static PIDL Null { get; } = new PIDL();
|
||||
|
||||
/// <summary>Performs an explicit conversion from <see cref="PIDL"/> to <see cref="IntPtr"/>.</summary>
|
||||
/// <param name="pidl">The current <see cref="PIDL"/>.</param>
|
||||
/// <returns>The result of the conversion.</returns>
|
||||
public static explicit operator IntPtr(PIDL pidl) => pidl.handle;
|
||||
|
||||
/// <summary>Appends the specified <see cref="PIDL"/> to the existing list.</summary>
|
||||
/// <param name="appendPidl">The <see cref="PIDL"/> to append.</param>
|
||||
public void Append(PIDL appendPidl)
|
||||
/// <summary>Gets an ITEMIDLIST with the last ID removed. If this is the topmost ID, a clone of the current is returned.</summary>
|
||||
public PIDL Parent
|
||||
{
|
||||
var newPidl = IntILCombine(handle, appendPidl.DangerousGetHandle());
|
||||
Marshal.FreeCoTaskMem(handle);
|
||||
SetHandle(newPidl);
|
||||
get
|
||||
{
|
||||
var p = new PIDL(this);
|
||||
p.RemoveLastId();
|
||||
return p;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Gets the size, in bytes, of the ITEMIDLIST.</summary>
|
||||
public uint Size => ILGetSize(handle);
|
||||
|
||||
/// <summary>Combines the specified <see cref="PIDL"/> instances to create a new one.</summary>
|
||||
/// <param name="firstPidl">The first <see cref="PIDL"/>.</param>
|
||||
/// <param name="secondPidl">The second <see cref="PIDL"/>.</param>
|
||||
/// <returns>A managed <see cref="PIDL"/> instance that contains both supplied lists in their respective order.</returns>
|
||||
public static PIDL Combine(PIDL firstPidl, PIDL secondPidl) => ILCombine(firstPidl.handle, secondPidl.handle);
|
||||
|
||||
/// <summary>Performs an explicit conversion from <see cref="PIDL"/> to <see cref="IntPtr"/>.</summary>
|
||||
/// <param name="pidl">The current <see cref="PIDL"/>.</param>
|
||||
/// <returns>The result of the conversion.</returns>
|
||||
public static explicit operator IntPtr(PIDL pidl) => pidl.handle;
|
||||
|
||||
/// <summary>Performs an implicit conversion from <see cref="IntPtr"/> to <see cref="PIDL"/>.</summary>
|
||||
/// <param name="p">The pointer to a raw ITEMIDLIST.</param>
|
||||
/// <returns>The result of the conversion.</returns>
|
||||
public static implicit operator PIDL(IntPtr p) => new PIDL(p);
|
||||
|
||||
/// <summary>Combines the specified <see cref="PIDL"/> instances to create a new one.</summary>
|
||||
/// <param name="first">The first <see cref="PIDL"/>.</param>
|
||||
/// <param name="second">The second <see cref="PIDL"/>.</param>
|
||||
/// <returns>A managed <see cref="PIDL"/> instance that contains both supplied lists in their respective order.</returns>
|
||||
public static PIDL operator +(PIDL first, PIDL second) => Combine(first, second);
|
||||
|
||||
/// <summary>Appends the specified <see cref="PIDL"/> to the existing list.</summary>
|
||||
/// <param name="appendPidl">The <see cref="PIDL"/> to append.</param>
|
||||
public void Append(PIDL appendPidl)
|
||||
{
|
||||
var newPidl = IntILCombine(handle, appendPidl.DangerousGetHandle());
|
||||
Free(handle);
|
||||
SetHandle(newPidl);
|
||||
}
|
||||
|
||||
/// <summary>Dumps this instance to a string a list of binary values.</summary>
|
||||
/// <returns>A binary string of the contents.</returns>
|
||||
public string Dump() => string.Join(" ", handle.ToIEnum<byte>((int)Size).Select(b => $"{b:X2}").ToArray());
|
||||
|
||||
/// <summary>Determines whether the specified <see cref="System.Object"/>, is equal to this instance.</summary>
|
||||
/// <param name="obj">The <see cref="System.Object"/> to compare with this instance.</param>
|
||||
/// <returns><c>true</c> if the specified <see cref="System.Object"/> is equal to this instance; otherwise, <c>false</c>.</returns>
|
||||
|
|
@ -97,53 +113,40 @@ namespace Vanara.PInvoke
|
|||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Indicates whether the current object is equal to another object of the same type.
|
||||
/// </summary>
|
||||
/// <summary>Indicates whether the current object is equal to another object of the same type.</summary>
|
||||
/// <param name="other">An object to compare with this object.</param>
|
||||
/// <returns>
|
||||
/// true if the current object is equal to the <paramref name="other" /> parameter; otherwise, false.
|
||||
/// </returns>
|
||||
/// <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
|
||||
public bool Equals(IntPtr other) => ILIsEqual(handle, other);
|
||||
|
||||
/// <summary>
|
||||
/// Indicates whether the current object is equal to another object of the same type.
|
||||
/// </summary>
|
||||
/// <summary>Indicates whether the current object is equal to another object of the same type.</summary>
|
||||
/// <param name="other">An object to compare with this object.</param>
|
||||
/// <returns>
|
||||
/// true if the current object is equal to the <paramref name="other" /> parameter; otherwise, false.
|
||||
/// </returns>
|
||||
/// <returns>true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.</returns>
|
||||
public bool Equals(PIDL other) => Equals(other?.handle ?? IntPtr.Zero);
|
||||
|
||||
//public static bool operator ==(PIDL a, PIDL b) => (a == null && b == null) || (a?.Equals(b) ?? false);
|
||||
|
||||
//public static bool operator !=(PIDL a, PIDL b) => !(a == b);
|
||||
|
||||
/// <summary>Returns an enumerator that iterates through the collection.</summary>
|
||||
/// <returns>A <see cref="T:System.Collections.Generic.IEnumerator{PIDL}"/> that can be used to iterate through the collection.</returns>
|
||||
public IEnumerator<PIDL> GetEnumerator() => new InternalEnumerator(handle);
|
||||
|
||||
/// <summary>Returns an enumerator that iterates through a collection.</summary>
|
||||
/// <returns>An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.</returns>
|
||||
IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
|
||||
|
||||
// ReSharper disable once BaseObjectGetHashCodeCallInGetHashCode
|
||||
/// <summary>Returns a hash code for this instance.</summary>
|
||||
/// <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns>
|
||||
public override int GetHashCode() => base.GetHashCode();
|
||||
public override int GetHashCode() => new Collections.EnumerableEqualityComparer<byte>().GetHashCode(handle.ToIEnum<byte>((int)Size));
|
||||
|
||||
/// <summary>Inserts the specified <see cref="PIDL"/> before the existing list.</summary>
|
||||
/// <param name="insertPidl">The <see cref="PIDL"/> to insert.</param>
|
||||
public void Insert(PIDL insertPidl)
|
||||
{
|
||||
var newPidl = IntILCombine(insertPidl.handle, handle);
|
||||
Marshal.FreeCoTaskMem(handle);
|
||||
Free(handle);
|
||||
SetHandle(newPidl);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Removes the last identifier from the list.
|
||||
/// </summary>
|
||||
/// <summary>Determines if this instance is a parent or ancestor of a supplied PIDL.</summary>
|
||||
/// <param name="childPidl">Child instance to test.</param>
|
||||
/// <param name="immediate">If <c>true</c>, narrows test to immediate children only.</param>
|
||||
/// <returns><c>true</c> if this instance is a parent or ancestor of a supplied PIDL.</returns>
|
||||
public bool IsParentOf(PIDL childPidl, bool immediate = true) => ILIsParent(this, childPidl, immediate);
|
||||
|
||||
/// <summary>Removes the last identifier from the list.</summary>
|
||||
public bool RemoveLastId() => ILRemoveLastID(handle);
|
||||
|
||||
/// <summary>Returns a <see cref="System.String"/> that represents this instance.</summary>
|
||||
|
|
@ -164,36 +167,11 @@ namespace Vanara.PInvoke
|
|||
return null;
|
||||
}
|
||||
|
||||
/// <summary>Dumps this instance to a string a list of binary values.</summary>
|
||||
/// <returns>A binary string of the contents.</returns>
|
||||
public string Dump()
|
||||
{
|
||||
var sb = new StringBuilder();
|
||||
foreach (var pidl in this)
|
||||
{
|
||||
var sz = ILGetItemSize(pidl.handle);
|
||||
var bytes = pidl.handle.ToIEnum<byte>(sz);
|
||||
sb.AppendLine(string.Join(" ", bytes.Select(b => $"{b:X2}").ToArray()));
|
||||
}
|
||||
return sb.ToString();
|
||||
}
|
||||
/// <summary>Returns an enumerator that iterates through a collection.</summary>
|
||||
/// <returns>An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.</returns>
|
||||
IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
|
||||
|
||||
/// <summary>Performs an implicit conversion from <see cref="IntPtr"/> to <see cref="PIDL"/>.</summary>
|
||||
/// <param name="p">The pointer to a raw ITEMIDLIST.</param>
|
||||
/// <returns>The result of the conversion.</returns>
|
||||
public static implicit operator PIDL(IntPtr p) => new PIDL(p);
|
||||
|
||||
/// <summary>When overridden in a derived class, executes the code required to free the handle.</summary>
|
||||
/// <returns>
|
||||
/// true if the handle is released successfully; otherwise, in the event of a catastrophic failure, false. In this case, it generates a
|
||||
/// releaseHandleFailed MDA Managed Debugging Assistant.
|
||||
/// </returns>
|
||||
protected override bool ReleaseHandle()
|
||||
{
|
||||
try { Marshal.FreeCoTaskMem(handle); } catch { }
|
||||
handle = IntPtr.Zero;
|
||||
return true;
|
||||
}
|
||||
private static bool Free(IntPtr pidl) { ILFree(pidl); return true; }
|
||||
|
||||
private class InternalEnumerator : IEnumerator<PIDL>
|
||||
{
|
||||
|
|
|
|||
Loading…
Reference in New Issue