Adding hardware keyboard support to your app
At a glance
| Item | Summary |
|---|---|
| Purpose | Enhance interactions with your app by handling raw keyboard events, writing custom keyboard shortcuts, and working with gesture recognizers. |
| App architecture | A Swift sample with the source-visible chain AppDelegate → AddShapeViewController → FileStore → UIKit APIs. |
| Main patterns | View-controller organization, Protocol-oriented abstraction, Delegate or data-source callbacks, Central store |
| Project style | 10 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | No structured execution marker indexed; callback threading requires source review. |
| State/event model | No structured observation or publisher-scheduling marker indexed. |
| Key frameworks/packages | UIKit, Foundation; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── ProIllustratorSample/
│ ├── Model.swift
│ ├── AppDelegate.swift
│ ├── Canvas/
│ │ ├── AddShapeViewController.swift
│ │ ├── CanvasViewController.swift
│ │ ├── ShapeSelectionView.swift
│ │ └── ShapeView.swift
│ ├── FileListViewController.swift
│ ├── MainViewController.swift
│ ├── SceneDelegate.swift
│ └── GlobalKeyboardShortcutRespondable.swift
├── Configuration/
│ └── SampleCode.xcconfig
└── ProIllustratorSample.xcodeproj/
└── .xcodesamplecode.plist
Structure observations
- Architecturally prominent files are ranked from entry points and role-named declarations; resource-only paths are omitted.
- Primary languages: Swift.
- The verified tree contains 7 project/configuration file(s) and 17 source declaration(s).
Overall architecture
flowchart LR
N1["AppDelegate"]
N2["AddShapeViewController"]
N3["FileStore"]
N4["UIKit APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
Reference code
ProIllustratorSample/AppDelegate.swift:10 — architecture anchor
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
// ...
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
// Override point for customization after application launch.
return true
}
// ...
}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 UIKit.
Ownership and state
classDiagram
Shape *-- CGRect : rect
Shape o-- Style : style
Shape o-- UIColor : color
IllustrationFile *-- String : name
Ownership evidence
ProIllustratorSample/Model.swift:16 — stored dependency or nearest verified ownership anchor
class Shape {
// ...
var rect: CGRect
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
Shape |
CGRect (rect) |
owns value state | App/module collaborators |
Shape |
Style (style) |
stores or receives | App/module collaborators |
Shape |
UIColor (color) |
stores or receives | App/module collaborators |
IllustrationFile |
String (name) |
owns value state | App/module collaborators |
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.
Concurrency, scheduling, and thread safety
Evidence limit: actor isolation, async/await, or Task creation does not by itself prove background-thread execution; Sendable conformance alone does not prove thread-safe mutation.
No source-visible execution, scheduling, or synchronization boundary was found in the indexed source.
@MainActor/MainActor.run, DispatchQueue.main, and RunLoop.main are reported as distinct isolation, queue, and event-loop mechanisms. A plain Task is kept separate from Task.detached; neither is labeled as a background thread.
State propagation, frameworks, and dependencies
Evidence limit: an import proves a source-level compilation dependency at the cited line; it does not prove runtime use, architectural adoption, or whether a Swift package is a direct application dependency.
| Category | Mechanism or module | Verified role | Evidence |
|---|---|---|---|
| Source import | UIKit |
The cited file imports this module; runtime use and architectural role are not inferred. | ProIllustratorSample/AppDelegate.swift:8 |
| Source import | Foundation |
The cited file imports this module; runtime use and architectural role are not inferred. | ProIllustratorSample/GlobalKeyboardShortcutRespondable.swift:8 |
receive(on:) describes downstream delivery scheduling, while subscribe(on:) describes upstream subscription/request/cancel scheduling. An import Combine alone establishes neither behavior nor a Store, reducer, Redux, or other application architecture.
Class and protocol design
ProIllustratorSample/Canvas/AddShapeViewController.swift:10 — representative type boundary
protocol AddShapeViewControllerDelegate: AnyObject {
func addShapeViewController(_: AddShapeViewController, didSelectShapeStyle style: Shape.Style)
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
AppDelegate |
Receives callback-driven events | UIResponder, UIApplicationDelegate |
AddShapeViewControllerDelegate |
Defines a capability or collaboration contract | AnyObject |
FileListViewControllerDelegate |
Defines a capability or collaboration contract | AnyObject |
FileStore |
Centralized state or persistence access | Concrete collaborators/imported frameworks |
AddShapeViewController |
View lifecycle, callbacks, and feature coordination | UITableViewController |
CanvasViewController |
View lifecycle, callbacks, and feature coordination | UIViewController, AddShapeViewControllerDelegate |
ShapeSelectionView |
User-interface presentation and input forwarding | UIView |
SelectionGrabberView |
User-interface presentation and input forwarding | UIView |
FileListViewController |
View lifecycle, callbacks, and feature coordination | UITableViewController |
ShapeView |
User-interface presentation and input forwarding | UIView |
The source explicitly defines local protocol relationships: CanvasViewController → AddShapeViewControllerDelegate, MainViewController → FileListViewControllerDelegate, CanvasViewController → GlobalKeyboardShortcutRespondable, FileListViewController → GlobalKeyboardShortcutRespondable.
Access control
| Symbol | Access | Verified effect | Likely rationale |
|---|---|---|---|
delegate (ProIllustratorSample/Canvas/AddShapeViewController.swift:17) |
public |
The symbol is visible to importing modules. | Inference: make the declaration available across a module or target boundary. |
shapeDataSource (ProIllustratorSample/Canvas/AddShapeViewController.swift:18) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
addKeyCommands (ProIllustratorSample/Canvas/AddShapeViewController.swift:32) |
fileprivate |
Use is restricted to this source file. | Inference: share with same-file helpers or extensions without exposing the symbol module-wide. |
addBarButtonItem (ProIllustratorSample/Canvas/CanvasViewController.swift:32) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
Reference code
ProIllustratorSample/Canvas/AddShapeViewController.swift:17 — representative boundary
class AddShapeViewController: UITableViewController {
// ...
public weak var delegate: AddShapeViewControllerDelegate?
// ...
}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 | AddShapeViewController, CanvasViewController, FileListViewController, MainViewController |
The source’s Controller suffix makes this role explicit. |
| Receives callback-driven events | AddShapeViewControllerDelegate, AppDelegate, FileListViewControllerDelegate, SceneDelegate |
The source’s Delegate suffix makes this role explicit. |
| Centralized state or persistence access | FileStore |
The source’s Store suffix makes this role explicit. |
| User-interface presentation and input forwarding | SelectionGrabberView, ShapeSelectionView, ShapeView |
The source’s View suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| View-controller organization | ProIllustratorSample/Canvas/AddShapeViewController.swift:14 |
A controller is the verified coordination boundary; this is MVC-style only where a separate model is present. |
| Protocol-oriented abstraction | ProIllustratorSample/Canvas/CanvasViewController.swift:11 |
A local protocol and concrete conformance create an explicit capability boundary. |
| Delegate or data-source callbacks | ProIllustratorSample/AppDelegate.swift:11 |
Callback protocols invert event delivery back into the sample’s owner. |
| Central store | ProIllustratorSample/Model.swift:38 |
A store-named type centralizes feature state or persistence. |
Naming conventions
- Types: Controller: AddShapeViewController, CanvasViewController, FileListViewController, MainViewController; Delegate: AddShapeViewControllerDelegate, AppDelegate, FileListViewControllerDelegate, SceneDelegate; Store: FileStore; View: SelectionGrabberView, ShapeSelectionView, ShapeView.
- Protocols:
AddShapeViewControllerDelegate,FileListViewControllerDelegate,GlobalKeyboardShortcutRespondable. - Methods:
untitledNameForIdentifier,itemForIdentifier,allIdentifiers,createNewFile,deleteItemWithIdentifier,application,buildMenu,addShapeViewController. - Files:
ProIllustratorSample/AppDelegate.swift,ProIllustratorSample/Canvas/AddShapeViewController.swift,ProIllustratorSample/Canvas/CanvasViewController.swift,ProIllustratorSample/Canvas/ShapeSelectionView.swift,ProIllustratorSample/FileListViewController.swift,ProIllustratorSample/Canvas/ShapeView.swift.
Architecture takeaways
AppDelegateis the main source-visible entry or composition anchor for this sample.- Framework work reaches UIKit 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.
- Local protocol relationships provide an explicit substitution boundary.
Source map
| Source file | Relevant symbols |
|---|---|
ProIllustratorSample/AppDelegate.swift |
Cited implementation, UIKit, AppDelegate |
ProIllustratorSample/Model.swift |
Cited implementation, FileStore, Shape, Style, IllustrationFile |
ProIllustratorSample/Canvas/AddShapeViewController.swift |
AddShapeViewControllerDelegate, Cited implementation, AddShapeViewController |
ProIllustratorSample/Canvas/CanvasViewController.swift |
Cited implementation, CanvasViewController, KeyboardMovementDelta |
ProIllustratorSample/GlobalKeyboardShortcutRespondable.swift |
Foundation, GlobalKeyboardShortcutRespondable |
ProIllustratorSample/Canvas/ShapeSelectionView.swift |
ShapeSelectionView, SelectionGrabberView |
ProIllustratorSample/FileListViewController.swift |
FileListViewControllerDelegate, FileListViewController |
ProIllustratorSample/Canvas/ShapeView.swift |
ShapeView |
ProIllustratorSample/MainViewController.swift |
MainViewController |
ProIllustratorSample/SceneDelegate.swift |
SceneDelegate |