sean-m
/
Vanara
mirror of https://github.com/dahall/Vanara.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Added more helper functions for working with StringBuffer related methods.

pull/303/head
dahall 2022-06-09 22:33:11 -06:00
parent a391f0c183
commit dec0bb3cc0
1 changed files with 132 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

162
PInvoke/Shared/FunctionHelper.cs
View File

@ -1,7 +1,6 @@
using System;
using System.Collections.Generic;
using System.Text;
using Vanara.Extensions;
using Vanara.InteropServices;
namespace Vanara.PInvoke
@ -9,7 +8,7 @@ namespace Vanara.PInvoke
/// <summary>Generic functions to help with standard function patterns like getting a string from a method.</summary>
public static class FunctionHelper
{
private static readonly List<Win32Error> buffErrs = new List<Win32Error> { Win32Error.ERROR_MORE_DATA, Win32Error.ERROR_INSUFFICIENT_BUFFER, Win32Error.ERROR_BUFFER_OVERFLOW };
private static readonly List<Win32Error> buffErrs = new() { Win32Error.ERROR_MORE_DATA, Win32Error.ERROR_INSUFFICIENT_BUFFER, Win32Error.ERROR_BUFFER_OVERFLOW };
/// <summary>Delegate to get the size of memory allocated to a pointer.</summary>
/// <typeparam name="TSize">The type of the size result. This is usually <see cref="int"/> or <see cref="uint"/>.</typeparam>
@ -18,9 +17,7 @@ namespace Vanara.PInvoke
/// <returns>Resulting error or <see cref="Win32Error.ERROR_SUCCESS"/> on success.</returns>
public delegate Win32Error PtrFunc<TSize>(IntPtr ptr, ref TSize sz) where TSize : struct, IConvertible;
/// <summary>
/// Delegate that takes and StringBuilder and initial size and returns a result.
/// </summary>
/// <summary>Delegate that takes and StringBuilder and initial size and returns a result.</summary>
/// <typeparam name="TSize">The type of the size result. This is usually <see cref="int"/> or <see cref="uint"/>.</typeparam>
/// <typeparam name="TRet">The return type.</typeparam>
/// <param name="sb">The <see cref="StringBuilder"/> value.</param>
@ -28,6 +25,28 @@ namespace Vanara.PInvoke
/// <returns>The return value. Often this is an error.</returns>
public delegate TRet SBFunc<TSize, TRet>(StringBuilder sb, ref TSize sz) where TSize : struct, IConvertible;
/// <summary>Delegate that takes and StringBuilder and initial size and returns a result.</summary>
/// <typeparam name="T1">The type of the first parameter.</typeparam>
/// <typeparam name="TSize">The type of the size result. This is usually <see cref="int"/> or <see cref="uint"/>.</typeparam>
/// <typeparam name="TRet">The return type.</typeparam>
/// <param name="arg1">The first parameter.</param>
/// <param name="sb">The <see cref="StringBuilder"/> value.</param>
/// <param name="sz">On input, the size of the <paramref name="sb"/> capacity. On output, the number of characters written.</param>
/// <returns>The return value. Often this is an error.</returns>
public delegate TRet SBFunc<in T1, TSize, TRet>(T1 arg1, StringBuilder sb, ref TSize sz) where TSize : struct, IConvertible;
/// <summary>Delegate that takes and StringBuilder and initial size and returns a result.</summary>
/// <typeparam name="T1">The type of the first parameter.</typeparam>
/// <typeparam name="T2">The type of the second parameter.</typeparam>
/// <typeparam name="TSize">The type of the size result. This is usually <see cref="int"/> or <see cref="uint"/>.</typeparam>
/// <typeparam name="TRet">The return type.</typeparam>
/// <param name="arg1">The first parameter.</param>
/// <param name="arg2">The second parameter.</param>
/// <param name="sb">The <see cref="StringBuilder"/> value.</param>
/// <param name="sz">On input, the size of the <paramref name="sb"/> capacity. On output, the number of characters written.</param>
/// <returns>The return value. Often this is an error.</returns>
public delegate TRet SBFunc<in T1, in T2, TSize, TRet>(T1 arg1, T2 arg2, StringBuilder sb, ref TSize sz) where TSize : struct, IConvertible;
/// <summary>Gets a size and returns an error.</summary>
/// <typeparam name="TSize">The type of the size result. This is usually <see cref="int"/> or <see cref="uint"/>.</typeparam>
/// <param name="sz">On input, the size of the capacity. On output, the number of characters written.</param>
@ -39,16 +58,6 @@ namespace Vanara.PInvoke
/// <returns>Resulting error or <see cref="Win32Error.ERROR_SUCCESS"/> on success.</returns>
public static Win32Error BoolToLastErr(bool result) => result ? Win32Error.ERROR_SUCCESS : Win32Error.GetLastError();
/// <summary>
/// Checks to see if size is not 0 and if the error is requesting a larger buffer.
/// </summary>
/// <typeparam name="TSize">The type of the size result. This is usually <see cref="int"/> or <see cref="uint"/>.</typeparam>
/// <typeparam name="TRet">The error provider return type.</typeparam>
/// <param name="sz">On input, the size of the capacity. On output, the number of characters written.</param>
/// <param name="err">The error.</param>
/// <returns><c>true</c> if buffer size is good; otherwise <c>false</c>.</returns>
public static bool ChkGoodBuf<TSize, TRet>(TSize sz, TRet err) where TSize : struct where TRet : IErrorProvider, IConvertible => !sz.Equals(default(TSize)) && buffErrs.ConvertAll(e => (HRESULT)e).Contains(err.ToHRESULT());
/// <summary>Calls a method with <see cref="StringBuilder"/> and gets the resulting string or error.</summary>
/// <typeparam name="TSize">The type of the size result. This is usually <see cref="int"/> or <see cref="uint"/>.</typeparam>
/// <typeparam name="TRet">The return type.</typeparam>
@ -71,8 +80,62 @@ namespace Vanara.PInvoke
var ret = method(sb, ref sz);
result = sb.ToString();
return ret;
}
bool IsNotDef(TSize _sz, TRet _ret) => !_sz.Equals(default(TSize));
/// <summary>Calls a method with <see cref="StringBuilder"/> and gets the resulting string or error.</summary>
/// <typeparam name="T1">The type of the first parameter.</typeparam>
/// <typeparam name="TSize">The type of the size result. This is usually <see cref="int"/> or <see cref="uint"/>.</typeparam>
/// <typeparam name="TRet">The return type.</typeparam>
/// <param name="method">The lambda or method to call into.</param>
/// <param name="arg1">The first parameter.</param>
/// <param name="result">The resulting string value.</param>
/// <param name="gotGoodSize">An optional method to determine if a valid size was retrieved by <paramref name="method"/>.</param>
/// <returns>The return value of <paramref name="method"/>.</returns>
public static TRet CallMethodWithStrBuf<T1, TSize, TRet>(SBFunc<T1, TSize, TRet> method, T1 arg1, out string result,
Func<TSize, TRet, bool> gotGoodSize = null) where TSize : struct, IConvertible
{
TSize sz = default;
var ret0 = method(arg1, null, ref sz);
if (!(gotGoodSize ?? IsNotDef)(sz, ret0))
{
result = null;
return ret0;
}
var len = sz.ToInt32(null) + 1;
var sb = new StringBuilder(len, len);
sz = (TSize)Convert.ChangeType(len, typeof(TSize));
var ret = method(arg1, sb, ref sz);
result = sb.ToString();
return ret;
}
/// <summary>Calls a method with <see cref="StringBuilder"/> and gets the resulting string or error.</summary>
/// <typeparam name="T1">The type of the first parameter.</typeparam>
/// <typeparam name="T2">The type of the second parameter.</typeparam>
/// <typeparam name="TSize">The type of the size result. This is usually <see cref="int"/> or <see cref="uint"/>.</typeparam>
/// <typeparam name="TRet">The return type.</typeparam>
/// <param name="method">The lambda or method to call into.</param>
/// <param name="arg1">The first parameter.</param>
/// <param name="arg2">The second parameter.</param>
/// <param name="result">The resulting string value.</param>
/// <param name="gotGoodSize">An optional method to determine if a valid size was retrieved by <paramref name="method"/>.</param>
/// <returns>The return value of <paramref name="method"/>.</returns>
public static TRet CallMethodWithStrBuf<T1, T2, TSize, TRet>(SBFunc<T1, T2, TSize, TRet> method, T1 arg1, T2 arg2, out string result,
Func<TSize, TRet, bool> gotGoodSize = null) where TSize : struct, IConvertible
{
TSize sz = default;
var ret0 = method(arg1, arg2, null, ref sz);
if (!(gotGoodSize ?? IsNotDef)(sz, ret0))
{
result = null;
return ret0;
}
var len = sz.ToInt32(null) + 1;
var sb = new StringBuilder(len, len);
sz = (TSize)Convert.ChangeType(len, typeof(TSize));
var ret = method(arg1, arg2, sb, ref sz);
result = sb.ToString();
return ret;
}
/// <summary>Calls a method with <see cref="StringBuilder"/> and gets the resulting string or error.</summary>
@ -91,20 +154,23 @@ namespace Vanara.PInvoke
return ret;
}
/// <summary>
/// Calls a method with buffer for a type and gets the result or error.
/// </summary>
/// <summary>Calls a method with buffer for a type and gets the result or error.</summary>
/// <typeparam name="TOut">The return type.</typeparam>
/// <typeparam name="TSize">The type of the size result. This is usually <see cref="int" /> or <see cref="uint" />.</typeparam>
/// <typeparam name="TSize">The type of the size result. This is usually <see cref="int"/> or <see cref="uint"/>.</typeparam>
/// <param name="getSize">Method to get the size of the buffer.</param>
/// <param name="method">The lambda or method to call into.</param>
/// <param name="result">The resulting value of <typeparamref name="TOut" />.</param>
/// <param name="outConverter">An optional method to convert the pointer to the type specified by <typeparamref name="TOut" />. By default, this will marshal the pointer to the structure.</param>
/// <param name="bufErr">The optional error <paramref name="method"/> returns when the buffer size is insufficient. If left <see langword="null"/>, then a list of well known errors will be used.</param>
/// <returns>
/// Resulting error or <see cref="Win32Error.ERROR_SUCCESS" /> on success.
/// </returns>
public static Win32Error CallMethodWithTypedBuf<TOut, TSize>(SizeFunc<TSize> getSize, PtrFunc<TSize> method, out TOut result, Func<IntPtr, TSize, TOut> outConverter = null, Win32Error? bufErr = null) where TSize : struct, IConvertible
/// <param name="result">The resulting value of <typeparamref name="TOut"/>.</param>
/// <param name="outConverter">
/// An optional method to convert the pointer to the type specified by <typeparamref name="TOut"/>. By default, this will marshal the
/// pointer to the structure.
/// </param>
/// <param name="bufErr">
/// The optional error <paramref name="method"/> returns when the buffer size is insufficient. If left <see langword="null"/>, then a
/// list of well known errors will be used.
/// </param>
/// <returns>Resulting error or <see cref="Win32Error.ERROR_SUCCESS"/> on success.</returns>
public static Win32Error CallMethodWithTypedBuf<TOut, TSize>(SizeFunc<TSize> getSize, PtrFunc<TSize> method, out TOut result,
Func<IntPtr, TSize, TOut> outConverter = null, Win32Error? bufErr = null) where TSize : struct, IConvertible
{
TSize sz = default;
result = default;
@ -128,13 +194,49 @@ namespace Vanara.PInvoke
/// <typeparam name="TSize">The type of the size result. This is usually <see cref="int"/> or <see cref="uint"/>.</typeparam>
/// <param name="method">The lambda or method to call into.</param>
/// <param name="getSize">Method to get the size of the buffer.</param>
/// <param name="outConverter">An optional method to convert the pointer to the type specified by <typeparamref name="TOut"/>. By default, this will marshal the pointer to the structure.</param>
/// <param name="bufErr">The optional error <paramref name="method"/> returns when the buffer size is insufficient. If left <see langword="null"/>, then a list of well known errors will be used.</param>
/// <param name="outConverter">
/// An optional method to convert the pointer to the type specified by <typeparamref name="TOut"/>. By default, this will marshal the
/// pointer to the structure.
/// </param>
/// <param name="bufErr">
/// The optional error <paramref name="method"/> returns when the buffer size is insufficient. If left <see langword="null"/>, then a
/// list of well known errors will be used.
/// </param>
/// <returns>The resulting value of <typeparamref name="TOut"/>.</returns>
public static TOut CallMethodWithTypedBuf<TOut, TSize>(PtrFunc<TSize> method, SizeFunc<TSize> getSize = null, Func<IntPtr, TSize, TOut> outConverter = null, Win32Error? bufErr = null) where TSize : struct, IConvertible
public static TOut CallMethodWithTypedBuf<TOut, TSize>(PtrFunc<TSize> method, SizeFunc<TSize> getSize = null,
Func<IntPtr, TSize, TOut> outConverter = null, Win32Error? bufErr = null) where TSize : struct, IConvertible
{
CallMethodWithTypedBuf(getSize, method, out var res, outConverter, bufErr).ThrowIfFailed();
return res;
}
/// <summary>Checks to see if size is not 0 and if the error is requesting a larger buffer.</summary>
/// <typeparam name="TSize">The type of the size result. This is usually <see cref="int"/> or <see cref="uint"/>.</typeparam>
/// <typeparam name="TRet">The error provider return type.</typeparam>
/// <param name="sz">On input, the size of the capacity. On output, the number of characters written.</param>
/// <param name="err">The error.</param>
/// <returns><c>true</c> if buffer size is good; otherwise <c>false</c>.</returns>
public static bool ChkGoodBuf<TSize, TRet>(TSize sz, TRet err) where TSize : struct where TRet : IErrorProvider, IConvertible =>
!sz.Equals(default(TSize)) && buffErrs.ConvertAll(e => (HRESULT)e).Contains(err.ToHRESULT());
private static bool IsNotDef<TSize, TRet>(TSize _sz, TRet _ret) where TSize : struct, IConvertible => !_sz.Equals(default(TSize));
/*
public delegate TRet P0QI<out TRet>(in Guid iid, out object ppv) where TRet : IErrorProvider, IConvertible;
public delegate TRet P1QI<in TIn1, out TRet>(TIn1 p1, in Guid iid, out object ppv) where TRet : IErrorProvider, IConvertible;
public delegate TRet P1IQI<TIn1, out TRet>(in TIn1 p1, in Guid iid, out object ppv) where TIn1 : struct where TRet : IErrorProvider, IConvertible;
public delegate TRet P2QI<in TIn1, in TIn2, out TRet>(TIn1 p1, TIn2 p2, in Guid iid, out object ppv) where TRet : IErrorProvider, IConvertible;
public static TIntf QueryInterface<TIntf>(P0QI<IErrorProvider> f) => f0(typeof(TIntf).GUID, out object ppv).Succeeded ? (TIntf)ppv : throw new InvalidCastException();
public static TIntf QueryInterface<TIntf>(P1QI<TIn1, IErrorProvider> f, TIn1 p1) => QueryInterface<TIntf, TIn1, IErrorProvider>(f1, p1, hr => hr.Succeeded);
public static TIntf QueryInterface<TIntf, TIn1>(P1IQI<TIn1, IErrorProvider> f, in TIn1 p1) where TIn1 : struct => QueryInterface<TIntf, TIn1, IErrorProvider>(f1, in p1, hr => hr.Succeeded);
private void Test()
{
static HRESULT GetObj(uint f, in Guid iid, out object ppv);
X x = QueryInterface<X>(GetObj, 3U);
}
*/
}
}