Sample CodeDriverKit, macOSReviewed 2026-07-21View on Apple Developer

Handling Keyboard Events from a Human Interface Device

At a glance

Item Summary
Purpose Process keyboard-related data from a human interface device and dispatch events to the system.
App architecture A C++, Swift sample with the source-visible chain AppDelegateViewControllerDriverKit / HIDDriverKit APIs.
Main patterns Delegate or data-source callbacks
Project style 3 scanned source file(s) across C++, Swift, organized around ranked entry, type, and file boundaries.

Project structure

Source bundle/
├── HIDKeyboardApp/
│   ├── AppDelegate.swift
│   ├── ViewController.swift
│   ├── Base.lproj/
│   │   └── Main.storyboard
│   ├── HIDKeyboardApp.entitlements
│   └── Info.plist
├── HIDKeyboardDriver/
│   ├── HIDKeyboardDriver.cpp
│   ├── HIDKeyboardDriver.entitlements
│   └── Info.plist
├── Configuration/
│   └── SampleCode.xcconfig
└── HIDKeyboardDriver.xcodeproj/
    ├── .xcodesamplecode.plist
    └── project.pbxproj

Structure observations

  • Architecturally prominent files are ranked from entry points and role-named declarations; resource-only paths are omitted.
  • Primary languages: C++, Swift.
  • The verified tree contains 8 project/configuration file(s) and 3 source declaration(s).

Overall architecture

Reference code

HIDKeyboardApp/AppDelegate.swift:11 — architecture anchor

@NSApplicationMain
class AppDelegate: NSObject, NSApplicationDelegate, OSSystemExtensionRequestDelegate {
    // ...
}

Interpretation

The arrows summarize the source-visible entry, role-named types or folders, and framework direction; when nodes come from structural folders, the sequence is a high-level interpretation rather than proof that every adjacent node calls the next. Ownership is claimed only where the next section cites a stored property or assignment. The diagram is intentionally limited to the dominant path into HIDDriverKit.

Ownership and state

Ownership evidence

HIDKeyboardApp/ViewController.swift:8 — stored dependency or nearest verified ownership anchor

import Cocoa
Owner Object or state Relationship Mutation authority
AppDelegate HIDDriverKit APIs Uses framework types; no stored lifecycle relationship was detected in the architecture anchor. The declaring implementation controls calls.

Composition arrows indicate a source-visible construction expression or locally owned value state; aggregation means the owner stores or receives a dependency without proving exclusive lifetime ownership.

Class and protocol design

HIDKeyboardApp/AppDelegate.swift:12 — representative type boundary

class AppDelegate: NSObject, NSApplicationDelegate, OSSystemExtensionRequestDelegate {
    // ...
}
Type Responsibility Depends on or conforms to
AppDelegate Receives callback-driven events NSObject, NSApplicationDelegate, OSSystemExtensionRequestDelegate
ViewController View lifecycle, callbacks, and feature coordination NSViewController
HIDKeyboardDriver_IVars Represents a feature value or composable behavior Concrete collaborators/imported frameworks

No local protocol conformance is claimed as protocol-oriented design; external framework conformances are listed only as dependencies.

Access control

Symbol Access Verified effect Likely rationale
AppDelegate (HIDKeyboardApp/AppDelegate.swift:12) implicit internal No explicit modifier means the Swift declaration is internal to the module. Inference: app-target collaboration needs no exported library surface.
ViewController (HIDKeyboardApp/ViewController.swift:10) implicit internal No explicit modifier means the Swift declaration is internal to the module. Inference: app-target collaboration needs no exported library surface.
HIDKeyboardDriver (HIDKeyboardDriver/HIDKeyboardDriver.cpp:8) language/file boundary Visibility follows header/implementation and language linkage rules. Inference: the language’s file or module boundary is sufficient for this sample collaboration.

Reference code

HIDKeyboardApp/AppDelegate.swift:12 — representative boundary

class AppDelegate: NSObject, NSApplicationDelegate, OSSystemExtensionRequestDelegate {
    // ...
}

Swift declarations without a modifier are internal; explicit private, fileprivate, private(set), public, or open entries above are interpreted by language semantics. Objective-C/C samples instead rely on header and implementation boundaries, which are not equivalent to Swift lexical privacy.

Logic ownership and placement

Logic Owning type or file Placement rationale
View lifecycle, callbacks, and feature coordination ViewController The source’s Controller suffix makes this role explicit.
Receives callback-driven events AppDelegate The source’s Delegate suffix makes this role explicit.

Design patterns

Pattern Source evidence Purpose or tradeoff
Delegate or data-source callbacks HIDKeyboardApp/AppDelegate.swift:12 Callback protocols invert event delivery back into the sample’s owner.

Naming conventions

  • Types: Controller: ViewController; Delegate: AppDelegate.
  • Protocols: no local protocol declaration in the scanned source.
  • Methods: applicationDidFinishLaunching, applicationWillTerminate, request, requestNeedsUserApproval, viewDidLoad.
  • Files: HIDKeyboardApp/AppDelegate.swift, HIDKeyboardApp/ViewController.swift.

Architecture takeaways

  • AppDelegate is the main source-visible entry or composition anchor for this sample.
  • Framework work reaches DriverKit, Cocoa, HIDDriverKit, SystemExtensions through a deliberately small high-level chain; the detailed API graph remains inside the cited implementation files.
  • Stored-property evidence identifies lifecycle collaboration; it does not by itself prove exclusive object ownership.
  • Access-control conclusions separate verified language visibility from the likely design rationale.
  • The source does not justify labeling the design protocol-oriented.

Source map

Source file Relevant symbols
HIDKeyboardApp/AppDelegate.swift AppDelegate
HIDKeyboardApp/ViewController.swift ViewController
HIDKeyboardDriver/HIDKeyboardDriver.cpp HIDKeyboardDriver_IVars