files-community/Files

Code Quality: Replace references to Vanara and WinForms with CsWin32

Geschlossen

#15.000 geöffnet am 19.03.2024

Auf GitHub ansehenContributor Guide
 (11 Kommentare) (5 Reaktionen) (0 zugewiesene Personen)C# (2.719 Forks)batch import
help wanted

Repository-Metriken

Stars
 (43.502 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 11T 15h) (61 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Untersuche den vorhandenen Codebestand auf Vanara Referenzen und explizite DllImport Verwendung. Verstehe die Struktur von NativeMethods.txt in Files.App.CsWin32. Finde für jeden DllImport die entsprechende Win32 API in den Windows SDK Metadaten und füge sie zu NativeMethods.txt hinzu. Verwende ILSpy und win32metadata.winmd, um die korrekten Signaturen zu ermitteln. Ersetze die DllImport Aufrufe durch die generierten CsWin32 Wrapper (z.B. PInvoke.SomeFunction). Stelle sicher, dass die Anwendung weiterhin korrekt kompiliert und ausgeführt wird. Siehe die Issue Kommentare für zusätzliche Anleitungen zu #define Konstanten.
Tech Stack
csharp
Domain
desktop
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Knowledge of C#Understanding of P/InvokeFamiliarity with CsWin32
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
30