Skip to content

Code Quality: Introduced ComHeapPtr #16237

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
merged 4 commits into from
Sep 30, 2024
Merged

Code Quality: Introduced ComHeapPtr #16237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9275c25
Init
0x5bfa Sep 21, 2024
2d7e590
Fixed a missing declaration
0x5bfa Sep 21, 2024
9cda552
Update Windows.Win32.ComHeapPtr.cs
0x5bfa Sep 21, 2024
6989363
Merge branch 'main' into 5bfa/CQ-ComHeapPtr
0x5bfa Sep 29, 2024
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
1 change: 1 addition & 0 deletions src/Files.App.CsWin32/NativeMethods.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,4 +133,5 @@ IFileOperation
IShellItem2
PSGetPropertyKeyFromName
ShellExecuteEx
CoTaskMemFree
QueryDosDevice
49 changes: 49 additions & 0 deletions src/Files.App.CsWin32/Windows.Win32.ComHeapPtr.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
// Copyright (c) 2024 Files Community
// Licensed under the MIT License. See the LICENSE.

using System;
using System.Runtime.CompilerServices;
using Windows.Win32;
using Windows.Win32.System.Com;

namespace Windows.Win32
{
/// <summary>
/// Contains a heap pointer allocated via CoTaskMemAlloc and a set of methods to work with the pointer safely.
/// </summary>
public unsafe struct ComHeapPtr<T> : IDisposable where T : unmanaged
{
private T* _ptr;

public bool IsNull
=> _ptr == default;

public ComHeapPtr(T* ptr)
{
_ptr = ptr;
}

[MethodImpl(MethodImplOptions.AggressiveInlining)]
public readonly T* Get()
{
return _ptr;
}

[MethodImpl(MethodImplOptions.AggressiveInlining)]
public readonly T** GetAddressOf()
{
return (T**)Unsafe.AsPointer(ref Unsafe.AsRef(in this));
}

[MethodImpl(MethodImplOptions.AggressiveInlining)]
public void Dispose()
{
T* ptr = _ptr;
if (ptr is not null)
{
_ptr = null;
PInvoke.CoTaskMemFree((void*)ptr);
}
}
}
}