files-community/Files

Code Quality: Replace references to Vanara and WinForms with CsWin32

Closed

#15,000 opened on Mar 19, 2024

View on GitHubContributor guide
 (11 comments) (5 reactions) (0 assignees)C# (2,719 forks)batch import
help wanted

Repository metrics

Stars
 (43,502 stars)
PR merge metrics
 (Avg merge 11d 15h) (61 merged PRs in 30d)

Description

Description

We're working on utilizing Native Aot in the application, however, runtime marshaler is one of the blocker against this. Vanara uses loads of runtime marshaler via DllImport and ComImport and we're working on replacing it with CsWin32, ultimately removing its reference completely.

Concerned code

  • Vanara references
  • DllImport we explicitly use within the codebase

Gains

  • AoT compliant codebase
  • Less 3rd party references

Requirements

  • Replace DllImport with CsWin32

Comments

CsWin32 requires you to add interfaces, functions, constants, enums, snd etc in NativeMethods.txt placed in Files.App.CsWin32. #define'd constants also need to be written in that text file and use like "PInvoke.CMF_DEFAULT" (They don't get placed in a particular namespace). For more info, download ILSpy and win32metadata.winmd in order to see the full projections.

Contributor guide

Research direction
Examine the existing codebase for Vanara references and explicit DllImport usage. Understand the structure of NativeMethods.txt in Files.App.CsWin32. For each DllImport, find the corresponding Win32 API in the Windows SDK metadata and add it to NativeMethods.txt. Use ILSpy and win32metadata.winmd to discover the proper signatures. Replace the DllImport calls with the generated CsWin32 wrappers (e.g., PInvoke.SomeFunction). Ensure the application still compiles and runs correctly. Refer to the issue comments for additional guidance on #define constants.
Tech stack
csharp
Domain
desktop
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Knowledge of C#Understanding of P/InvokeFamiliarity with CsWin32
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30