2017-11-27 12:18:01 -05:00
using System ;
using System.Collections.Generic ;
using System.Diagnostics.CodeAnalysis ;
using System.Runtime.InteropServices ;
using System.Security ;
using Vanara.Extensions ;
namespace Vanara.InteropServices
{
/// <summary>Unmanaged memory methods for HGlobal.</summary>
/// <seealso cref="IMemoryMethods"/>
public sealed class HGlobalMemoryMethods : IMemoryMethods
{
/// <summary>Gets the allocation method.</summary>
public Func < int , IntPtr > AllocMem = > Marshal . AllocHGlobal ;
/// <summary>Gets the reallocation method.</summary>
public Func < IntPtr , int , IntPtr > ReAllocMem = > ( p , i ) = > Marshal . ReAllocHGlobal ( p , ( IntPtr ) i ) ;
/// <summary>Gets the free method.</summary>
public Action < IntPtr > FreeMem = > Marshal . FreeHGlobal ;
/// <summary>Gets the Unicode string allocation method.</summary>
public Func < string , IntPtr > AllocStringUni = > Marshal . StringToHGlobalUni ;
/// <summary>Gets the Ansi string allocation method.</summary>
public Func < string , IntPtr > AllocStringAnsi = > Marshal . StringToHGlobalAnsi ;
/// <summary>Gets the Unicode <see cref="SecureString"/> allocation method.</summary>
public Func < SecureString , IntPtr > AllocSecureStringUni = > Marshal . SecureStringToGlobalAllocUnicode ;
/// <summary>Gets the Ansi <see cref="SecureString"/> allocation method.</summary>
public Func < SecureString , IntPtr > AllocSecureStringAnsi = > Marshal . SecureStringToGlobalAllocAnsi ;
/// <summary>Gets the Unicode <see cref="SecureString"/> free method.</summary>
public Action < IntPtr > FreeSecureStringUni = > Marshal . ZeroFreeGlobalAllocUnicode ;
/// <summary>Gets the Ansi <see cref="SecureString"/> free method.</summary>
public Action < IntPtr > FreeSecureStringAnsi = > Marshal . ZeroFreeGlobalAllocAnsi ;
}
/// <summary>A <see cref="SafeHandle"/> for memory allocated via LocalAlloc.</summary>
/// <seealso cref="System.Runtime.InteropServices.SafeHandle"/>
public class SafeHGlobalHandle : SafeMemoryHandleExt < HGlobalMemoryMethods >
{
/// <summary>Initializes a new instance of the <see cref="SafeHGlobalHandle"/> class.</summary>
/// <param name="handle">The handle.</param>
/// <param name="size">The size of memory allocated to the handle, in bytes.</param>
/// <param name="ownsHandle">if set to <c>true</c> if this class is responsible for freeing the memory on disposal.</param>
public SafeHGlobalHandle ( IntPtr handle , int size , bool ownsHandle = true ) : base ( handle , size , ownsHandle ) { }
/// <summary>Initializes a new instance of the <see cref="SafeHGlobalHandle"/> class.</summary>
/// <param name="size">The size of memory to allocate, in bytes.</param>
/// <exception cref="System.ArgumentOutOfRangeException">size - The value of this argument must be non-negative</exception>
public SafeHGlobalHandle ( int size ) : base ( size ) { }
/// <summary>Allocates from unmanaged memory to represent an array of pointers and marshals the unmanaged pointers (IntPtr) to the native array equivalent.</summary>
/// <param name="bytes">Array of unmanaged pointers</param>
/// <returns>SafeHGlobalHandle object to an native (unmanaged) array of pointers</returns>
public SafeHGlobalHandle ( byte [ ] bytes ) : base ( bytes ) { }
/// <summary>Allocates from unmanaged memory to represent an array of pointers and marshals the unmanaged pointers (IntPtr) to the native array equivalent.</summary>
/// <param name="values">Array of unmanaged pointers</param>
/// <returns>SafeHGlobalHandle object to an native (unmanaged) array of pointers</returns>
public SafeHGlobalHandle ( IntPtr [ ] values ) : base ( values ) { }
/// <summary>Allocates from unmanaged memory to represent a Unicode string (WSTR) and marshal this to a native PWSTR.</summary>
/// <param name="s">The string value.</param>
/// <returns>SafeHGlobalHandle object to an native (unmanaged) Unicode string</returns>
public SafeHGlobalHandle ( string s ) : base ( s ) { }
/// <summary>Initializes a new instance of the <see cref="SafeHGlobalHandle"/> class.</summary>
[ExcludeFromCodeCoverage]
internal SafeHGlobalHandle ( ) : base ( 0 ) { }
/// <summary>Represents a NULL memory pointer.</summary>
public static SafeHGlobalHandle Null { get ; } = new SafeHGlobalHandle ( IntPtr . Zero , 0 , false ) ;
/// <summary>Converts an <see cref="IntPtr"/> to a <see cref="SafeHGlobalHandle"/> where it owns the reference.</summary>
/// <param name="ptr">The <see cref="IntPtr"/>.</param>
/// <returns>The result of the conversion.</returns>
public static implicit operator SafeHGlobalHandle ( IntPtr ptr ) = > new SafeHGlobalHandle ( ptr , 0 , true ) ;
/// <summary>Allocates from unmanaged memory sufficient memory to hold an object of type T.</summary>
/// <typeparam name="T">Native type</typeparam>
/// <param name="value">The value.</param>
/// <returns><see cref="SafeHGlobalHandle"/> object to an native (unmanaged) memory block the size of T.</returns>
2018-11-19 23:18:50 -05:00
public static SafeHGlobalHandle CreateFromStructure < T > ( T value = default ) = > new SafeHGlobalHandle ( InteropExtensions . StructureToPtr ( value , new HGlobalMemoryMethods ( ) . AllocMem , out int s ) , s ) ;
2017-11-27 12:18:01 -05:00
/// <summary>
/// Allocates from unmanaged memory to represent a structure with a variable length array at the end and marshal these structure elements. It is the
/// callers responsibility to marshal what precedes the trailing array into the unmanaged memory. ONLY structures with attribute StructLayout of
/// LayoutKind.Sequential are supported.
/// </summary>
/// <typeparam name="T">Type of the trailing array of structures</typeparam>
/// <param name="values">Collection of structure objects</param>
/// <param name="count">Number of items in <paramref name="values"/>.</param>
/// <param name="prefixBytes">Number of bytes preceding the trailing array of structures</param>
/// <returns><see cref="SafeHGlobalHandle"/> object to an native (unmanaged) structure with a trail array of structures</returns>
2018-10-26 14:24:07 -04:00
public static SafeHGlobalHandle CreateFromList < T > ( IEnumerable < T > values , int count = - 1 , int prefixBytes = 0 ) = > new SafeHGlobalHandle ( InteropExtensions . MarshalToPtr ( values , new HGlobalMemoryMethods ( ) . AllocMem , out int s , prefixBytes ) , s ) ;
2017-11-27 12:18:01 -05:00
/// <summary>Allocates from unmanaged memory sufficient memory to hold an array of strings.</summary>
/// <param name="values">The list of strings.</param>
/// <param name="packing">The packing type for the strings.</param>
/// <param name="charSet">The character set to use for the strings.</param>
/// <param name="prefixBytes">Number of bytes preceding the trailing strings.</param>
/// <returns><see cref="SafeHGlobalHandle"/> object to an native (unmanaged) array of strings stored using the <paramref name="packing"/> model and the character set defined by <paramref name="charSet"/>.</returns>
2018-10-26 14:24:07 -04:00
public static SafeHGlobalHandle CreateFromStringList ( IEnumerable < string > values , StringListPackMethod packing = StringListPackMethod . Concatenated , CharSet charSet = CharSet . Auto , int prefixBytes = 0 ) = > new SafeHGlobalHandle ( InteropExtensions . MarshalToPtr ( values , packing , new HGlobalMemoryMethods ( ) . AllocMem , out int s , charSet , prefixBytes ) , s ) ;
2017-11-27 12:18:01 -05:00
}
}