files-community/Files

Code Quality: Replace references to Vanara and WinForms with CsWin32

Fermée

#15 000 ouverte le 19 mars 2024

Voir sur GitHubGuide contributeur
 (11 commentaires) (5 réactions) (0 personne assignée)C# (2 719 forks)batch import
help wanted

Métriques du dépôt

Stars
 (43 502 étoiles)
Métriques de merge PR
 (Merge moyen 11j 15h) (61 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Examinez la base de code existante pour les références à Vanara et l'utilisation explicite de DllImport. Comprenez la structure de NativeMethods.txt dans Files.App.CsWin32. Pour chaque DllImport, trouvez l'API Win32 correspondante dans les métadonnées du SDK Windows et ajoutez la à NativeMethods.txt. Utilisez ILSpy et win32metadata.winmd pour découvrir les signatures appropriées. Remplacez les appels DllImport par les wrappers CsWin32 générés (par exemple, PInvoke.SomeFunction). Assurez vous que l'application compile et s'exécute toujours correctement. Reportez vous aux commentaires de l'issue pour des conseils supplémentaires sur les constantes #define.
Stack technique
csharp
Domaine
desktop
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Knowledge of C#Understanding of P/InvokeFamiliarity with CsWin32
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
30