Building an app with a document browser
At a glance
| Item | Summary |
|---|---|
| Purpose | Provide access to on-device and cloud files by adding a document browser to your app. |
| App architecture | A Swift sample with the source-visible chain AppDelegate → DocumentBrowserViewController → TextDocument → UIKit APIs. |
| Main patterns | View-controller organization, Protocol-oriented abstraction, 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 | Source-visible mechanisms: NotificationCenter. |
| Key frameworks/packages | UIKit, os; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── Document Browser/
│ ├── BrowserSceneDelegate.swift
│ ├── AppDelegate.swift
│ ├── TextDocument.swift
│ ├── DocumentBrowserViewController.swift
│ ├── TextDocumentViewController.swift
│ ├── Base.lproj/
│ │ ├── LaunchScreen.storyboard
│ │ └── Main.storyboard
│ └── Info.plist
├── Configuration/
│ └── SampleCode.xcconfig
└── Document Browser.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 7 source declaration(s).
Overall architecture
flowchart LR
N1["AppDelegate"]
N2["DocumentBrowserViewController"]
N3["TextDocument"]
N4["UIKit APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
Reference code
Document Browser/AppDelegate.swift:15 — architecture anchor
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
func application(_ application: UIApplication,
didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {
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
BrowserSceneDelegate o-- UIWindow : window
AppDelegate o-- UIWindow : window
TextDocument o-- TextDocumentDelegate : delegate
TextDocument *-- Progress : loadProgress
Ownership evidence
Document Browser/BrowserSceneDelegate.swift:17 — stored dependency or nearest verified ownership anchor
@available(iOS 13.0, *)
class BrowserSceneDelegate: UIResponder, UIWindowSceneDelegate {
// ...
var window: UIWindow?
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
BrowserSceneDelegate |
UIWindow (window) |
stores or receives | App/module collaborators |
AppDelegate |
UIWindow (window) |
stores or receives | App/module collaborators |
TextDocument |
TextDocumentDelegate (delegate) |
holds a non-owning reference | The referenced object’s lifecycle is owned elsewhere |
TextDocument |
Progress (loadProgress) |
creates and retains | 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 |
|---|---|---|---|
| State propagation | NotificationCenter |
NotificationCenter distributes named process-local events. | Document Browser/TextDocument.swift:45 |
| Source import | UIKit |
The cited file imports this module; runtime use and architectural role are not inferred. | Document Browser/AppDelegate.swift:8 |
| Source import | os |
The cited file imports this module; runtime use and architectural role are not inferred. | Document Browser/BrowserSceneDelegate.swift:9 |
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
Document Browser/TextDocument.swift:16 — representative type boundary
protocol TextDocumentDelegate: AnyObject {
func textDocumentEnableEditing(_ doc: TextDocument)
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
AppDelegate |
Receives callback-driven events | UIResponder, UIApplicationDelegate |
TextDocumentDelegate |
Defines a capability or collaboration contract | AnyObject |
BrowserSceneDelegate |
Receives callback-driven events | UIResponder, UIWindowSceneDelegate |
TextDocument |
Owns document data or lifecycle behavior | UIDocument |
DocumentBrowserViewController |
View lifecycle, callbacks, and feature coordination | UIDocumentBrowserViewController, UIDocumentBrowserViewControllerDelegate |
TextDocumentViewController |
View lifecycle, callbacks, and feature coordination | UIViewController, UITextViewDelegate, TextDocumentDelegate |
TextDocumentError |
Represents feature failure conditions | Error |
The source explicitly defines local protocol relationships: TextDocumentViewController → TextDocumentDelegate.
Access control
| Symbol | Access | Verified effect | Likely rationale |
|---|---|---|---|
openURLContext (Document Browser/BrowserSceneDelegate.swift:47) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: hide an implementation step that is not part of the collaboration surface. |
text (Document Browser/TextDocument.swift:28) |
public |
The symbol is visible to importing modules. | Inference: make the declaration available across a module or target boundary. |
delegate (Document Browser/TextDocument.swift:34) |
public |
The symbol is visible to importing modules. | Inference: make the declaration available across a module or target boundary. |
loadProgress (Document Browser/TextDocument.swift:35) |
public |
The symbol is visible to importing modules. | Inference: make the declaration available across a module or target boundary. |
Reference code
Document Browser/BrowserSceneDelegate.swift:47 — representative boundary
private func openURLContext(_ urlContext: UIOpenURLContext) {
// ...
fatalError("*** The root view is not a document browser ***")
// ...
}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 | DocumentBrowserViewController, TextDocumentViewController |
The source’s Controller suffix makes this role explicit. |
| Receives callback-driven events | AppDelegate, BrowserSceneDelegate, TextDocumentDelegate |
The source’s Delegate suffix makes this role explicit. |
| Owns document data or lifecycle behavior | TextDocument |
The source’s Document suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| View-controller organization | Document Browser/DocumentBrowserViewController.swift:12 |
A controller is the verified coordination boundary; this is MVC-style only where a separate model is present. |
| Protocol-oriented abstraction | Document Browser/TextDocumentViewController.swift:12 |
A local protocol and concrete conformance create an explicit capability boundary. |
| Delegate or data-source callbacks | Document Browser/AppDelegate.swift:16 |
Callback protocols invert event delivery back into the sample’s owner. |
Naming conventions
- Types: Controller: DocumentBrowserViewController, TextDocumentViewController; Delegate: AppDelegate, BrowserSceneDelegate, TextDocumentDelegate; Document: TextDocument.
- Protocols:
TextDocumentDelegate. - Methods:
browserSceneSession,scene,openURLContext,application,textDocumentEnableEditing,textDocumentDisableEditing,textDocumentUpdateContent,textDocumentTransferBegan. - Files:
Document Browser/BrowserSceneDelegate.swift,Document Browser/AppDelegate.swift,Document Browser/TextDocument.swift,Document Browser/DocumentBrowserViewController.swift,Document Browser/TextDocumentViewController.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 |
|---|---|
Document Browser/AppDelegate.swift |
Cited implementation, UIKit, AppDelegate |
Document Browser/BrowserSceneDelegate.swift |
Cited implementation, os, BrowserSceneDelegate, func |
Document Browser/TextDocument.swift |
TextDocumentDelegate, Cited implementation, NotificationCenter, TextDocumentError, TextDocument |
Document Browser/DocumentBrowserViewController.swift |
DocumentBrowserViewController |
Document Browser/TextDocumentViewController.swift |
Cited implementation, TextDocumentViewController |