UI: support showing basic context & window menus

This change adds support for basic context menus (attached to a `View` instance) and window title menus.

Author: egorzhdan

Examples/UICatalog/UICatalog.swift

@@ -110,6 +110,19 @@ final class UICatalog: ApplicationDelegate, SceneDelegate {
     window.addSubview(self.tableview)
     window.addSubview(self.imageview)
 
+    window.rootViewController?.titleMenu = Menu(children: [
+      Menu(title: "Foo", children: [
+        Menu(title: "Another Submenu", children: [
+          MenuElement(title: "Deep Item")
+        ])
+      ]),
+      Menu(title: "Bar", children: [
+        MenuElement(title: "Item Without a Submenu")
+      ]),
+    ])
+
+    self.progress.addInteraction(ContextMenuInteraction(delegate: self))
+
     self.label.font = Font(name: "Consolas", size: 10)!
 
     self.button.addTarget(self, action: UICatalog.pressMe(_:),
@@ -184,3 +197,15 @@ extension UICatalog: TableViewDataSource {
     return cell
   }
 }
+
+extension UICatalog: ContextMenuInteractionDelegate {
+  public func contextMenuInteraction(_ interaction: ContextMenuInteraction,
+                                     configurationForMenuAtLocation location: Point) -> ContextMenuConfiguration? {
+    return ContextMenuConfiguration(identifier: nil, previewProvider: nil) { suggestedElements -> Menu? in
+      Menu(children: [
+        MenuElement(title: "Popup!"),
+        MenuElement(title: "2nd Element"),
+      ])
+    }
+  }
+}

Sources/SwiftWin32/UI/ContextMenuConfiguration.swift

@@ -44,4 +44,8 @@ public class ContextMenuConfiguration {
 
   private var previewProvider: ContextMenuContentPreviewProvider
   private var actionProvider: ContextMenuActionProvider?
+
+  internal func provideActions() -> Menu? {
+    actionProvider?([]) // TODO suggest default actions
+  }
 }

Sources/SwiftWin32/UI/ContextMenuInteraction.swift

@@ -19,7 +19,7 @@ extension ContextMenuInteraction {
   }
 }
 
-public class ContextMenuInteraction {
+public class ContextMenuInteraction: Interaction {
   // MARK - Creating a Context Menu Interaction Object
 
   /// Creates a context menu interaction object with the specified delegate

Sources/SwiftWin32/UI/Interaction.swift

@@ -0,0 +1,9 @@
+/**
+ * Copyright © 2020 Saleem Abdulrasool <[email protected]>
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ **/
+
+public protocol Interaction {
+}

Sources/SwiftWin32/UI/Menu.swift

@@ -5,6 +5,8 @@
  * SPDX-License-Identifier: BSD-3-Clause
  **/
 
+import WinSDK
+
 extension Menu {
   /// Constants for identifying an application's standard menus.
   public struct Identifier: Equatable, Hashable, RawRepresentable {
@@ -275,12 +277,42 @@ extension Menu.Options {
 /// A container for grouping related menu elements in an application menu or
 /// contextual menu.
 public class Menu: MenuElement {
+  internal let children: [MenuElement]
+
   /// Creating a Menu Object
 
   /// Creates a new menu with the specified values.
   public init(title: String = "", image: Image? = nil,
               identifier: Menu.Identifier? = nil, options: Menu.Options = [],
               children: [MenuElement] = []) {
+    self.children = children
     super.init(title: title, image: image)
   }
 }
+
+internal class WrappedMenu {
+  internal let hMenu: HMENU
+  private let children: [WrappedMenuElement]
+
+  private init(hMenu: HMENU, children: [MenuElement]) {
+    self.hMenu = hMenu
+    self.children = children.map { WrappedMenuElement.of($0) }
+    for (index, child) in self.children.enumerated() {
+      InsertMenuItemW(hMenu,
+                      UINT(index), true,
+                      &(child.info))
+    }
+  }
+
+  internal static func ofContextMenu(_ menu: Menu) -> WrappedMenu {
+    WrappedMenu(hMenu: CreatePopupMenu(), children: menu.children)
+  }
+
+  internal static func ofWindowMenu(_ menu: Menu) -> WrappedMenu {
+    WrappedMenu(hMenu: CreateMenu(), children: menu.children)
+  }
+
+  deinit {
+    DestroyMenu(hMenu)
+  }
+}

Sources/SwiftWin32/UI/MenuElement.swift

@@ -5,6 +5,8 @@
  * SPDX-License-Identifier: BSD-3-Clause
  **/
 
+import WinSDK
+
 extension MenuElement {
   /// Attributes that determine the style of the menu element.
   public struct Attributes: OptionSet {
@@ -55,15 +57,60 @@ public class MenuElement {
   /// Getting the Element Attributes
 
   /// The title of the menu element.
-  public var title: String
+  public let title: String
 
   /// The image to display alongside the menu element's title.
-  public var image: Image?
+  public let image: Image?
 
   /// Creating a Menu Element
 
-  internal init(title: String, image: Image?) {
+  public init(title: String, image: Image? = nil) {
     self.title = title
     self.image = image
   }
 }
+
+internal class WrappedMenuElement {
+  internal var info: MENUITEMINFOW
+  private var titleW: [WCHAR]
+  private let subMenu: WrappedMenu?
+
+  private init(title: String, subMenu: WrappedMenu?, fType: Int32) {
+    self.titleW = title.LPCWSTR
+    let titleSize = titleW.count
+
+    self.subMenu = subMenu
+    self.info = titleW.withUnsafeMutableBufferPointer {
+      MENUITEMINFOW(cbSize: UINT(MemoryLayout<MENUITEMINFOW>.size),
+                    fMask: UINT(MIIM_FTYPE | MIIM_STATE | MIIM_ID | MIIM_STRING | MIIM_SUBMENU | MIIM_DATA),
+                    fType: UINT(fType),
+                    fState: UINT(MFS_ENABLED),
+                    wID: UInt32.random(in: .min ... .max),
+                    hSubMenu: subMenu?.hMenu,
+                    hbmpChecked: nil,
+                    hbmpUnchecked: nil,
+                    dwItemData: 0,
+                    dwTypeData: $0.baseAddress,
+                    cch: UINT(titleSize),
+                    hbmpItem: nil)
+    }
+  }
+
+  internal static func of(_ element: MenuElement) -> WrappedMenuElement {
+    let subMenu: WrappedMenu?
+    if let menu = element as? Menu {
+      subMenu = WrappedMenu.ofContextMenu(menu)
+    } else {
+      subMenu = nil
+    }
+    return WrappedMenuElement(title: element.title, subMenu: subMenu, fType: MFT_STRING)
+  }
+
+  internal static func ofSeparator() -> WrappedMenuElement {
+    return WrappedMenuElement(title: "", subMenu: nil, fType: MFT_SEPARATOR)
+  }
+
+  internal var isSeparator: Bool {
+    info.fType == MFT_SEPARATOR
+  }
+}

Sources/SwiftWin32/UI/View.swift

@@ -11,8 +11,25 @@ private let SwiftViewProc: SUBCLASSPROC = { (hWnd, uMsg, wParam, lParam, uIdSubc
   let view: View? = unsafeBitCast(dwRefData, to: AnyObject.self) as? View
   switch uMsg {
   case UINT(WM_CONTEXTMENU):
-    // TODO handle popup menu events
+    guard let view = view,
+          let menuInteraction = view.interactions.first(where: { $0 is ContextMenuInteraction })
+            as? ContextMenuInteraction else { break }
+    let x = Int16(truncatingIfNeeded: lParam)
+    let y = Int16(truncatingIfNeeded: lParam >> 16)
+    let point = Point(x: Int(x), y: Int(y))
+    let menuConfiguration = menuInteraction.delegate?.contextMenuInteraction(menuInteraction,
+                                                                             configurationForMenuAtLocation: point)
+    if let menu = menuConfiguration?.provideActions() {
+      view.wrappedContextMenu = WrappedMenu.ofContextMenu(menu)
+    } else {
+      view.wrappedContextMenu = nil
+    }
+    TrackPopupMenu(view.wrappedContextMenu?.hMenu, UINT(TPM_RIGHTBUTTON),
+                   Int32(x), Int32(y), 0, view.hWnd, nil)
     return 0
+  case UINT(WM_COMMAND):
+    // TODO handle menu actions
+    break
   default:
     break
   }
@@ -202,6 +219,13 @@ public class View: Responder {
     set { _ = EnableWindow(self.hWnd, newValue) }
   }
 
+  public private(set) var interactions: [Interaction] = []
+  internal var wrappedContextMenu: WrappedMenu? = nil
+
+  public func addInteraction(_ interaction: Interaction) {
+    interactions.append(interaction)
+  }
+
   // MARK - Managing the View Hierarchy
 
   public private(set) var superview: View?

Sources/SwiftWin32/UI/ViewController.swift

@@ -57,6 +57,19 @@ public class ViewController: Responder {
     set(value) { _ = SetWindowTextW(view.hWnd, value?.LPCWSTR) }
   }
 
+  /// Menu bar shown below the window title
+  public var titleMenu: Menu? {
+    didSet {
+      if let newValue = titleMenu {
+        wrappedTitleMenu = WrappedMenu.ofWindowMenu(newValue)
+      } else {
+        wrappedTitleMenu = nil
+      }
+      SetMenu(view.hWnd, wrappedTitleMenu?.hMenu)
+    }
+  }
+  private var wrappedTitleMenu: WrappedMenu? = nil
+
   /// The preferred size for the view controller's view.
   public var preferredContentSize: Size {
     fatalError("not yet implemented")