Replace in-process shell extension with out-of-proc extension (#64)

This makes it work on ARM64 through the MSIX install, but leaves the MSI install without an extension. That's a reasonable tradeoff right now, and possibly forever.
Fixes #50

Author: zooba

.github/workflows/build.yml

@@ -36,7 +36,7 @@ jobs:
         python-version: 3.14-dev
 
     - name: Install build dependencies
-      run: python -m pip install pymsbuild
+      run: python -m pip install "pymsbuild>=1.2.0b1"
 
     - name: 'Install test runner'
       run: python -m pip install pytest pytest-cov

_msbuild.py

@@ -149,8 +149,7 @@ def mainw_exe(name):
         CProject('launcher',
             VersionInfo(FileDescription="Python launcher", OriginalFilename="launcher.exe"),
             CPP_SETTINGS,
-            Property('DynamicLibcppLinkage', 'true'),
-            ItemDefinition('ClCompile', RuntimeLibrary='MultiThreaded'),
+            Property('StaticLibcppLinkage', 'true'),
             ItemDefinition('Link', SubSystem='CONSOLE'),
             Manifest('default.manifest'),
             ResourceFile('pyicon.rc'),
@@ -163,8 +162,7 @@ def mainw_exe(name):
         CProject('launcherw',
             VersionInfo(FileDescription="Python launcher (windowed)", OriginalFilename="launcherw.exe"),
             CPP_SETTINGS,
-            Property('DynamicLibcppLinkage', 'true'),
-            ItemDefinition('ClCompile', RuntimeLibrary='MultiThreaded'),
+            Property('StaticLibcppLinkage', 'true'),
             ItemDefinition('Link', SubSystem='WINDOWS'),
             Manifest('default.manifest'),
             ResourceFile('pywicon.rc'),
@@ -206,24 +204,20 @@ def mainw_exe(name):
     CProject("pyshellext",
         VersionInfo(
             FileDescription="Python shell extension",
-            OriginalFilename="pyshellext.dll",
-        ),
-        Property('DynamicLibcppLinkage', 'true'),
-        ItemDefinition('ClCompile',
-            LanguageStandard='stdcpp20',
-            RuntimeLibrary='MultiThreaded',
+            OriginalFilename="pyshellext.exe",
         ),
+        Property('StaticLibcppLinkage', 'true'),
+        ItemDefinition('ClCompile', LanguageStandard='stdcpp20'),
         ItemDefinition('Link',
             AdditionalDependencies=Prepend("RuntimeObject.lib;"),
             SubSystem='WINDOWS',
-            ModuleDefinitionFile='$(SourceRootDir)src\\pyshellext\\pyshellext.def',
         ),
         Manifest('default.manifest'),
         CSourceFile('shellext.cpp'),
         ResourceFile('pyshellext.rc'),
-        SourceFile('pyshellext.def'),
         source='src/pyshellext',
-    )
+        ConfigurationType='Application',
+    ),
 )
 
 

ci/release.yml

@@ -89,7 +89,7 @@ stages:
       workingDirectory: $(Build.BinariesDirectory)
 
     - powershell: |
-        python -m pip install pymsbuild
+        python -m pip install "pymsbuild>=1.2.0b1"
       displayName: 'Install build dependencies'
 
     - ${{ if eq(parameters.PreTest, 'true') }}:

pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ['pymsbuild>=1.1.1,<2.0']
+requires = ['pymsbuild>=1.2.0b1,<2.0']
 build-backend = "pymsbuild"
 
 [tool.coverage.run]

src/pymanager/appxmanifest.xml

@@ -2,7 +2,7 @@
 <Package IgnorableNamespaces="desktop4 desktop6 desktop7 uap13 uap17"
     xmlns="http://schemas.microsoft.com/appx/manifest/foundation/windows10"
     xmlns:uap="http://schemas.microsoft.com/appx/manifest/uap/windows10"
-    xmlns:com="http://schemas.microsoft.com/appx/manifest/com/windows10"
+    xmlns:com4="http://schemas.microsoft.com/appx/manifest/com/windows10/4"
     xmlns:rescap="http://schemas.microsoft.com/appx/manifest/foundation/windows10/restrictedcapabilities"
     xmlns:rescap4="http://schemas.microsoft.com/appx/manifest/foundation/windows10/restrictedcapabilities/4"
     xmlns:desktop4="http://schemas.microsoft.com/appx/manifest/desktop/windows10/4"
@@ -194,20 +194,20 @@
                         </uap:SupportedFileTypes>
                     </uap:FileTypeAssociation>
                 </uap:Extension>
-                <com:Extension Category="windows.comServer">
-                    <com:ComServer>
-                        <com:SurrogateServer AppId="C7E29CB0-9691-4DE8-B72B-6719DDC0B4A1" DisplayName="EditInIdleCommand">
-                            <com:Class Id="C7E29CB0-9691-4DE8-B72B-6719DDC0B4A1" Path="pyshellext.dll" ThreadingModel="Both"/>
-                        </com:SurrogateServer>
-                    </com:ComServer>
-                </com:Extension>
                 <desktop4:Extension Category="windows.fileExplorerContextMenus">
                     <desktop4:FileExplorerContextMenus>
                         <desktop4:ItemType Type=".py">
                             <desktop4:Verb Id="EditInIdle" Clsid="C7E29CB0-9691-4DE8-B72B-6719DDC0B4A1" />
                         </desktop4:ItemType>
                     </desktop4:FileExplorerContextMenus>
                 </desktop4:Extension>
+                <com4:Extension Category="windows.comServer">
+                    <com4:ComServer>
+                        <com4:ExeServer Executable="pyshellext.exe" DisplayName="Python Shell Extension">
+                            <com4:Class Id="C7E29CB0-9691-4DE8-B72B-6719DDC0B4A1" DisplayName="EditInIdleCommand" />
+                        </com4:ExeServer>
+                    </com4:ComServer>
+                </com4:Extension>
             </Extensions>
         </Application>
 

src/pymanager/msi.wxs

@@ -44,10 +44,17 @@
       <File Source="vcruntime140.dll" />
       <File Source="vcruntime140_1.dll" />
 
-      <File Source="pyshellext.dll">
-        <Class Id="{C7E29CB0-9691-4DE8-B72B-6719DDC0B4A1}" Advertise="no"
-               Context="InprocServer32" ThreadingModel="both" />
+      <!--
+      When installed via MSIX, this extension must be out of proc.
+      Apparently, when installed via MSI, it must be in proc. Which means we'd
+      need to compile DLLs for each platform just for the MSI, as well as the
+      EXE that we use for regular installs.
+      Right now, not worth it.
+
+      <File Source="pyshellext.exe">
+        <Class Id="{C7E29CB0-9691-4DE8-B72B-6719DDC0B4A1}" Advertise="no" Context="LocalServer32" />
       </File>
+      -->
 
       <File Source="version.txt" />
       <Environment Id="PATH" Action="set" Name="PATH" Part="last" System="yes" Value="[INSTALLFOLDER]" />

src/pyshellext/pyshellext.def

@@ -1,8 +1,6 @@
-// Support back to Windows 10
 #define _WIN32_WINNT _WIN32_WINNT_WIN10
 #include <sdkddkver.h>
 
-// Use WRL to define a classic COM class
 #define __WRL_CLASSIC_COM__
 #include <wrl.h>
 
@@ -454,24 +452,27 @@ IExplorerCommand *MakeIdleCommand(HKEY hive, LPCWSTR root)
 #endif
 
 
-STDAPI DllGetClassObject(REFCLSID rclsid, REFIID riid, _COM_Outptr_ void** ppv)
-{
-    return Module<InProc>::GetModule().GetClassObject(rclsid, riid, ppv);
-}
-
+#ifndef PYSHELLEXT_TEST
+class OutOfProcModule : public Module<OutOfProc, OutOfProcModule>
+{ };
 
-STDAPI DllCanUnloadNow()
-{
-    return Module<InProc>::GetModule().Terminate() ? S_OK : S_FALSE;
-}
 
-#ifndef PYSHELLEXT_TEST
-STDAPI_(BOOL) DllMain(_In_opt_ HINSTANCE hinst, DWORD reason, _In_opt_ void*)
+int WINAPI wWinMain(
+    HINSTANCE hInstance,
+    HINSTANCE hPrevInstance,
+    LPWSTR lpCmdLine,
+    int nCmdShow
+)
 {
-    if (reason == DLL_PROCESS_ATTACH) {
-        hModule = hinst;
-        DisableThreadLibraryCalls(hinst);
-    }
-    return TRUE;
+    HANDLE hStopEvent = CreateEvent(NULL, TRUE, FALSE, NULL);
+    hModule = hInstance;
+
+    CoInitializeEx(nullptr, COINIT_MULTITHREADED);
+    auto& module = OutOfProcModule::Create([=]() { SetEvent(hStopEvent); });
+    module.RegisterObjects();
+    ::WaitForSingleObject(hStopEvent, INFINITE);
+    module.UnregisterObjects();
+    CoUninitialize();
+    return 0;
 }
 #endif