Menus and Shortcuts: make _MenuBuilder materialize the menus

This change teaches `_MenuBuilder` to build the window menus. It handles submenus & icons similarly to `Win32Menu`.

Author: egorzhdan

Sources/SwiftWin32/Platform/Win32+Menu.swift

@@ -13,7 +13,7 @@ internal final class _MenuBuilder: MenuSystem {
   private var menus: OrderedSet<Menu>
 
   internal init?(for view: View) {
-    self.hMenu = MenuHandle(owning: CreateMenu())
+    self.hMenu = MenuHandle(owning: view is Window ? CreateMenu() : CreatePopupMenu())
     if self.hMenu.value == nil {
       log.warning("CreateMenu: \(Error(win32: GetLastError()))")
       return nil
@@ -22,8 +22,42 @@ internal final class _MenuBuilder: MenuSystem {
     self.menus = []
   }
 
+  private func append<T: Collection>(_ menus: T, to hMenu: MenuHandle)
+      where T.Element: MenuElement {
+    for (index, child) in menus.enumerated() {
+      let hImage: BitmapHandle? =
+          BitmapHandle(from: child.image?.bitmap)
+
+      var hSubmenu: MenuHandle?
+      if let submenu = child as? Menu {
+        hSubmenu = MenuHandle(referencing: CreatePopupMenu())
+        if hSubmenu?.value == nil {
+          log.warning("CreateMenu: \(Error(win32: GetLastError()))")
+          continue
+        }
+        append(submenu.children, to: hSubmenu!)
+      }
+
+      var wide = child.title.wide
+      var info = wide.withUnsafeMutableBufferPointer {
+        MENUITEMINFOW(cbSize: UINT(MemoryLayout<MENUITEMINFOW>.size),
+                      fMask: UINT(MIIM_FTYPE | MIIM_STATE | MIIM_ID | MIIM_STRING | MIIM_SUBMENU | MIIM_DATA | MIIM_BITMAP),
+                      fType: UINT(MFT_STRING), fState: UINT(MFS_ENABLED), wID: UInt32.random(in: .min ... .max),
+                      hSubMenu: hSubmenu?.value, hbmpChecked: nil, hbmpUnchecked: nil, dwItemData: 0,
+                      dwTypeData: $0.baseAddress, cch: UINT(child.title.count), hbmpItem: hImage?.value)
+      }
+      InsertMenuItemW(hMenu.value, UINT(index), true, &info)
+    }
+  }
+
   override func setNeedsRebuild() {
-    // TODO(compnerd) create the actual menus
+    // Remove the old submenus from the menu:
+    for index in (0..<GetMenuItemCount(self.hMenu.value)).reversed() {
+      DeleteMenu(self.hMenu.value, UINT(index), UINT(MF_BYPOSITION))
+    }
+
+    // Create the new submenus and add them to the root menu:
+    append(self.menus, to: self.hMenu)
   }
 }
 

Tests/UICoreTests/MenuBuilderTests.swift

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: BSD-3-Clause
 
 import XCTest
+import WinSDK
 @testable import SwiftWin32
 
 final class MenuBuilderTests: XCTestCase {
@@ -85,8 +86,47 @@ final class MenuBuilderTests: XCTestCase {
 
   func testBuildMenu() {
     let view: View = View(frame: .zero)
-    let builder = _MenuBuilder(for: view)
-    XCTAssertNotNil((builder?.system as? _MenuBuilder)?.hMenu.value)
+    guard let builder = _MenuBuilder(for: view) else { return }
+
+    let hMenu = (builder.system as? _MenuBuilder)?.hMenu
+    XCTAssertNotNil(hMenu?.value)
+    XCTAssertEqual(GetMenuItemCount(hMenu?.value), 0)
+  }
+
+  func testBuildMenuWithChildren() {
+    let view: View = View(frame: .zero)
+    guard let builder = _MenuBuilder(for: view) else { return }
+
+    let menu = Menu(title: "menu1", children: [Command(title: "item1") { _ in },
+                                               Action(title: "item2") { _ in }])
+    builder.insertSibling(menu, afterMenu: .root)
+    builder.setNeedsRebuild()
+
+    let hRootMenu = (builder.system as? _MenuBuilder)?.hMenu
+    XCTAssertNotNil(hRootMenu?.value)
+    XCTAssertEqual(GetMenuItemCount(hRootMenu?.value), 1)
+
+    let hMenu = GetSubMenu(hRootMenu?.value, 0)
+    XCTAssertNotNil(hMenu)
+    XCTAssertEqual(GetMenuItemCount(hMenu), 2)
+  }
+
+  func testRebuildMenu() {
+    let view: View = View(frame: .zero)
+    guard let builder = _MenuBuilder(for: view) else { return }
+
+    let hMenu1 = (builder.system as? _MenuBuilder)?.hMenu
+
+    let menu = Menu(title: "title", children: [Command(title: "cmd") { _ in }])
+    builder.insertSibling(menu, afterMenu: .root)
+    builder.setNeedsRebuild()
+
+    let hMenu2 = (builder.system as? _MenuBuilder)?.hMenu
+
+    XCTAssert(hMenu1 === hMenu2)
+    XCTAssertNotNil(hMenu1)
+    XCTAssertNotNil(hMenu2)
+    XCTAssertEqual(hMenu1?.value, hMenu2?.value)
   }
 
   public static var allTests = [
@@ -96,5 +136,7 @@ final class MenuBuilderTests: XCTestCase {
     ("testRemove", testRemove),
     ("testReplace", testReplace),
     ("testBuildMenu", testBuildMenu),
+    ("testBuildMenuWithChildren", testBuildMenuWithChildren),
+    ("testRebuildMenu", testRebuildMenu),
   ]
 }