Allow the command line to specify extra instance methods that should be readonly

Author: tannergooding

sources/ClangSharp.PInvokeGenerator/PInvokeGenerator.VisitDecl.cs

@@ -7,11 +7,9 @@
 using System.Linq;
 using System.Runtime.InteropServices;
 using System.Text;
-using System.Text.RegularExpressions;
 using ClangSharp.Abstractions;
 using ClangSharp.CSharp;
 using static ClangSharp.Interop.CX_CastKind;
-using static ClangSharp.Interop.CX_CharacterKind;
 using static ClangSharp.Interop.CX_DeclKind;
 using static ClangSharp.Interop.CX_StmtClass;
 using static ClangSharp.Interop.CX_StorageClass;
@@ -607,7 +605,7 @@ private void VisitFunctionDecl(FunctionDecl functionDecl)
             IsCxx = cxxMethodDecl is not null,
             IsStatic = isDllImport || (cxxMethodDecl is null) || cxxMethodDecl.IsStatic,
             NeedsNewKeyword = NeedsNewKeyword(escapedName, functionDecl.Parameters),
-            IsReadOnly = (cxxMethodDecl is not null) && cxxMethodDecl.IsConst,
+            IsReadOnly = IsReadonly(cxxMethodDecl),
             IsUnsafe = IsUnsafe(functionDecl),
             IsCtxCxxRecord = cxxRecordDecl is not null,
             IsCxxRecordCtxUnsafe = cxxRecordDecl is not null && IsUnsafe(cxxRecordDecl),
@@ -2228,7 +2226,7 @@ void OutputVtblHelperMethod(CXXRecordDecl cxxRecordDecl, CXXMethodDecl cxxMethod
                 HasFnPtrCodeGen = !_config.ExcludeFnptrCodegen,
                 IsCtxCxxRecord = true,
                 IsCxxRecordCtxUnsafe = IsUnsafe(cxxRecordDecl),
-                IsReadOnly = cxxMethodDecl.IsConst,
+                IsReadOnly = IsReadonly(cxxMethodDecl),
                 IsUnsafe = true,
                 NeedsReturnFixup = needsReturnFixup,
                 ReturnType = returnTypeName,
@@ -2353,7 +2351,7 @@ void OutputVtblHelperMethod(CXXRecordDecl cxxRecordDecl, CXXMethodDecl cxxMethod
                 body.Write(escapedCXXRecordDeclName);
                 body.Write("*)Unsafe.AsPointer(");
 
-                if (cxxMethodDecl.IsConst)
+                if (IsReadonly(cxxMethodDecl))
                 {
                     if (!_config.GenerateLatestCode)
                     {

sources/ClangSharp.PInvokeGenerator/PInvokeGenerator.cs

@@ -5402,6 +5402,15 @@ private bool IsPrevContextStmt<T>([MaybeNullWhen(false)] out T cursor, out objec
         }
     }
 
+    private bool IsReadonly(CXXMethodDecl? cxxMethodDecl)
+    {
+        if (cxxMethodDecl is not null)
+        {
+            return cxxMethodDecl.IsConst || HasRemapping(cxxMethodDecl, _config._withReadonlys, matchStar: true);
+        }
+        return false;
+    }
+
     private static bool IsStmtAsWritten<T>(Cursor cursor, [MaybeNullWhen(false)] out T value, bool removeParens = false)
         where T : Stmt
     {

sources/ClangSharp.PInvokeGenerator/PInvokeGeneratorConfiguration.cs

@@ -33,6 +33,7 @@ public sealed class PInvokeGeneratorConfiguration
     private readonly HashSet<string> _nativeTypeNamesToStrip;
     private readonly HashSet<string> _withManualImports;
     private readonly HashSet<string> _traversalNames;
+    internal readonly HashSet<string> _withReadonlys;
     internal readonly HashSet<string> _withSetLastErrors;
     internal readonly HashSet<string> _withSuppressGCTransitions;
 
@@ -87,6 +88,7 @@ public PInvokeGeneratorConfiguration(string language, string languageStandard, s
         _nativeTypeNamesToStrip = new HashSet<string>(StringComparer.Ordinal);
         _withManualImports = new HashSet<string>(StringComparer.Ordinal);
         _traversalNames = new HashSet<string>(StringComparer.Ordinal);
+        _withReadonlys = new HashSet<string>(QualifiedNameComparer.Default);
         _withSetLastErrors = new HashSet<string>(QualifiedNameComparer.Default);
         _withSuppressGCTransitions = new HashSet<string>(QualifiedNameComparer.Default);
 
@@ -516,6 +518,20 @@ public IReadOnlyDictionary<string, string> WithNamespaces
         }
     }
 
+    [AllowNull]
+    public IReadOnlyCollection<string> WithReadonlys
+    {
+        get
+        {
+            return _withReadonlys;
+        }
+
+        init
+        {
+            AddRange(_withReadonlys, value);
+        }
+    }
+
     [AllowNull]
     public IReadOnlyCollection<string> WithSetLastErrors
     {

sources/ClangSharpPInvokeGenerator/Program.cs

@@ -54,6 +54,7 @@ internal static class Program
     private static readonly string[] s_withManualImportOptionAliases = ["--with-manual-import", "-wmi"];
     private static readonly string[] s_withNamespaceOptionAliases = ["--with-namespace", "-wn"];
     private static readonly string[] s_withPackingOptionAliases = ["--with-packing", "-wp"];
+    private static readonly string[] s_withReadonlyOptionAliases = ["--with-readonly", "-wro"];
     private static readonly string[] s_withSetLastErrorOptionAliases = ["--with-setlasterror", "-wsle"];
     private static readonly string[] s_withSuppressGCTransitionOptionAliases = ["--with-suppressgctransition", "-wsgct"];
     private static readonly string[] s_withTransparentStructOptionAliases = ["--with-transparent-struct", "-wts"];
@@ -92,6 +93,7 @@ internal static class Program
     private static readonly Option<string[]> s_withManualImports = GetWithManualImportOption();
     private static readonly Option<string[]> s_withNamespaceNameValuePairs = GetWithNamespaceOption();
     private static readonly Option<string[]> s_withPackingNameValuePairs = GetWithPackingOption();
+    private static readonly Option<string[]> s_withReadonlys = GetWithReadonlyOption();
     private static readonly Option<string[]> s_withSetLastErrors = GetWithSetLastErrorOption();
     private static readonly Option<string[]> s_withSuppressGCTransitions = GetWithSuppressGCTransitionOption();
     private static readonly Option<string[]> s_withTransparentStructNameValuePairs = GetWithTransparentStructOption();
@@ -255,6 +257,7 @@ public static void Run(InvocationContext context)
         var withLibraryPathNameValuePairs = context.ParseResult.GetValueForOption(s_withLibraryPathNameValuePairs) ?? [];
         var withManualImports = context.ParseResult.GetValueForOption(s_withManualImports) ?? [];
         var withNamespaceNameValuePairs = context.ParseResult.GetValueForOption(s_withNamespaceNameValuePairs) ?? [];
+        var withReadonlys = context.ParseResult.GetValueForOption(s_withReadonlys) ?? [];
         var withSetLastErrors = context.ParseResult.GetValueForOption(s_withSetLastErrors) ?? [];
         var withSuppressGCTransitions = context.ParseResult.GetValueForOption(s_withSuppressGCTransitions) ?? [];
         var withTransparentStructNameValuePairs = context.ParseResult.GetValueForOption(s_withTransparentStructNameValuePairs) ?? [];
@@ -729,6 +732,7 @@ public static void Run(InvocationContext context)
             WithLibraryPaths = withLibraryPaths,
             WithManualImports = withManualImports,
             WithNamespaces = withNamespaces,
+            WithReadonlys = withReadonlys,
             WithSetLastErrors = withSetLastErrors,
             WithSuppressGCTransitions = withSuppressGCTransitions,
             WithTransparentStructs = withTransparentStructs,
@@ -1202,6 +1206,7 @@ private static RootCommand GetRootCommand()
             s_withManualImports,
             s_withNamespaceNameValuePairs,
             s_withPackingNameValuePairs,
+            s_withReadonlys,
             s_withSetLastErrors,
             s_withSuppressGCTransitions,
             s_withTransparentStructNameValuePairs,
@@ -1350,6 +1355,17 @@ private static Option<string[]> GetWithNamespaceOption()
         };
     }
 
+    private static Option<string[]> GetWithReadonlyOption()
+    {
+        return new Option<string[]>(
+            aliases: s_withReadonlyOptionAliases,
+            description: "Add the readonly modifier to a given instance method. Supports wildcards.",
+            getDefaultValue: Array.Empty<string>
+        ) {
+            AllowMultipleArgumentsPerToken = true
+        };
+    }
+
     private static Option<string[]> GetWithSetLastErrorOption()
     {
         return new Option<string[]>(

sources/ClangSharpPInvokeGenerator/Properties/launchSettings.json

@@ -12,7 +12,7 @@
     "GenerateLocal": {
       "commandName": "Project",
       "commandLineArgs": "@generate.rsp",
-      "workingDirectory": "D:\\repos\\terrafx.interop.windows\\generation\\DirectX\\um\\dcommon"
+      "workingDirectory": "D:\\repos\\terrafx.interop.windows\\generation\\windows\\um\\wingdi"
     }
   }
 }