Developing a Document-Based App
At a glance
| Item | Summary |
|---|---|
| Purpose | Write an app that creates, manages, edits, and saves text documents. |
| App architecture | A Swift sample with the source-visible chain AppDelegate → ViewController → Document → Cocoa APIs. |
| Main patterns | Delegate or data-source callbacks |
| Project style | 5 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 | Cocoa, Foundation; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── DocumentBasedApp/
│ ├── AppDelegate.swift
│ ├── Document.swift
│ ├── ViewController.swift
│ ├── WindowController.swift
│ ├── Content.swift
│ ├── Base.lproj/
│ │ └── Main.storyboard
│ ├── DocumentBasedApp.entitlements
│ └── Info.plist
├── Configuration/
│ └── SampleCode.xcconfig
└── DocumentBasedApp.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: Swift.
- The verified tree contains 6 project/configuration file(s) and 5 source declaration(s).
Overall architecture
flowchart LR
N1["AppDelegate"]
N2["ViewController"]
N3["Document"]
N4["Cocoa APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
Reference code
DocumentBasedApp/AppDelegate.swift:10 — architecture anchor
@NSApplicationMain
class AppDelegate: NSObject, NSApplicationDelegate {
func applicationDidFinishLaunching(_ aNotification: Notification) {
// Insert code here to initialize your application
}
func applicationWillTerminate(_ aNotification: Notification) {
// Insert code here to tear down your application
}
func applicationShouldTerminate(_ sender: NSApplication)-> NSApplication.TerminateReply {
return .terminateNow
}
}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 AppKit.
Ownership and state
classDiagram
Document *-- Content : content
Document o-- ViewController : contentViewController
Content o-- Contentstring : contentString
Ownership evidence
DocumentBasedApp/Document.swift:12 — stored dependency or nearest verified ownership anchor
class Document: NSDocument {
// ...
@objc var content = Content(contentString: "")
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
Document |
Content (content) |
creates and retains | App/module collaborators |
Document |
ViewController (contentViewController) |
stores or receives | App/module collaborators |
Content |
Contentstring (contentString) |
stores or receives | 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 | Cocoa |
The cited file imports this module; runtime use and architectural role are not inferred. | DocumentBasedApp/AppDelegate.swift:8 |
| Source import | Foundation |
The cited file imports this module; runtime use and architectural role are not inferred. | DocumentBasedApp/Content.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
DocumentBasedApp/AppDelegate.swift:11 — representative type boundary
@NSApplicationMain
class AppDelegate: NSObject, NSApplicationDelegate {
// ...
return .terminateNow
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
AppDelegate |
Receives callback-driven events | NSObject, NSApplicationDelegate |
Document |
Owns document data or lifecycle behavior | NSDocument |
ViewController |
View lifecycle, callbacks, and feature coordination | NSViewController, NSTextViewDelegate |
WindowController |
View lifecycle, callbacks, and feature coordination | NSWindowController, NSWindowDelegate |
Content |
Owns feature behavior and collaborator lifecycle | NSObject |
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 |
|---|---|---|---|
Content (DocumentBasedApp/Content.swift:14) |
public |
The symbol is visible to importing modules. | Inference: make the declaration available across a module or target boundary. |
ViewController (DocumentBasedApp/ViewController.swift:8) |
implicit internal |
No explicit modifier means the Swift declaration is internal to the module. | Inference: app-target collaboration needs no exported library surface. |
Reference code
DocumentBasedApp/Content.swift:14 — representative boundary
public init(contentString: String) {
self.contentString = contentString
}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, WindowController |
The source’s Controller suffix makes this role explicit. |
| Receives callback-driven events | AppDelegate |
The source’s Delegate suffix makes this role explicit. |
| Owns document data or lifecycle behavior | Document |
The source’s Document suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| Delegate or data-source callbacks | DocumentBasedApp/AppDelegate.swift:11 |
Callback protocols invert event delivery back into the sample’s owner. |
Naming conventions
- Types: Controller: ViewController, WindowController; Delegate: AppDelegate; Document: Document.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
applicationDidFinishLaunching,applicationWillTerminate,applicationShouldTerminate,canAsynchronouslyWrite,canConcurrentlyReadDocuments,makeWindowControllers,read,data. - Files:
DocumentBasedApp/AppDelegate.swift,DocumentBasedApp/Document.swift,DocumentBasedApp/ViewController.swift,DocumentBasedApp/WindowController.swift,DocumentBasedApp/Content.swift.
Architecture takeaways
AppDelegateis the main source-visible entry or composition anchor for this sample.- Framework work reaches Cocoa 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 |
|---|---|
DocumentBasedApp/AppDelegate.swift |
Cited implementation, AppDelegate, Cocoa |
DocumentBasedApp/Document.swift |
Cited implementation, Document |
DocumentBasedApp/Content.swift |
Cited implementation, Foundation, Content |
DocumentBasedApp/ViewController.swift |
ViewController |
DocumentBasedApp/WindowController.swift |
WindowController |