Building a document browser app for custom file formats
At a glance
| Item | Summary |
|---|---|
| Purpose | Implement a custom document file format to manage user interactions with files on different cloud storage providers. |
| App architecture | A Swift sample with the source-visible chain AppDelegate → DocumentBrowserViewController → Document → ThumbnailProvider → UIKit APIs. |
| Main patterns | View-controller organization, Delegate or data-source callbacks |
| Project style | 8 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | Source-visible boundaries: DispatchQueue.main.async; none alone proves a background thread. |
| State/event model | No structured observation or publisher-scheduling marker indexed. |
| Key frameworks/packages | UIKit, SceneKit, MobileCoreServices, os, QuickLook; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
├── Particles/
│ ├── EditorViewController.swift
│ ├── AppDelegate.swift
│ ├── Document.swift
│ ├── DocumentBrowserViewController.swift
│ ├── DocumentViewController.swift
│ ├── ParticleViewController.swift
│ └── Base.lproj/
│ └── LaunchScreen.storyboard
├── ParticlesPreview/
│ └── PreviewViewController.swift
├── ParticlesThumbnails/
│ └── ThumbnailProvider.swift
├── Configuration/
│ └── SampleCode.xcconfig
└── Particles.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 9 project/configuration file(s) and 12 source declaration(s).
Overall architecture
flowchart LR
N1["AppDelegate"]
N2["DocumentBrowserViewController"]
N3["Document"]
N4["ThumbnailProvider"]
N5["UIKit APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
N4 --> N5
Reference code
Particles/AppDelegate.swift:11 — architecture anchor
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
// ...
var window: UIWindow?
// ...
}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
EditorSetting *-- String : keyPath
EditorSetting *-- String : label
EditorSetting *-- Float : min
EditorSetting *-- Float : max
Ownership evidence
Particles/EditorViewController.swift:19 — stored dependency or nearest verified ownership anchor
private struct EditorSetting: Hashable {
let keyPath: String
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
EditorSetting |
String (keyPath) |
owns value state | Initialized by the owner; the binding is immutable |
EditorSetting |
String (label) |
owns value state | Initialized by the owner; the binding is immutable |
EditorSetting |
Float (min) |
owns value state | Initialized by the owner; the binding is immutable |
EditorSetting |
Float (max) |
owns value state | Initialized by the owner; the binding is immutable |
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.
| Concern | Source mechanism | Verified placement or handoff | Evidence |
|---|---|---|---|
| Queue scheduling | DispatchQueue.main.async |
The source addresses the main dispatch queue. | ParticlesThumbnails/ThumbnailProvider.swift:41 |
@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.
Reference code
ParticlesThumbnails/ThumbnailProvider.swift:41 — representative execution boundary
DispatchQueue.main.async {
let particleViewController = ParticleViewController()
// ...
}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. | Particles/AppDelegate.swift:8 |
| Source import | SceneKit |
The cited file imports this module; runtime use and architectural role are not inferred. | Particles/Document.swift:9 |
| Source import | MobileCoreServices |
The cited file imports this module; runtime use and architectural role are not inferred. | Particles/DocumentViewController.swift:9 |
| Source import | os |
The cited file imports this module; runtime use and architectural role are not inferred. | Particles/AppDelegate.swift:9 |
| Source import | QuickLook |
The cited file imports this module; runtime use and architectural role are not inferred. | ParticlesPreview/PreviewViewController.swift:10 |
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
Particles/AppDelegate.swift:12 — representative type boundary
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
// ...
var window: UIWindow?
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
AppDelegate |
Receives callback-driven events | UIResponder, UIApplicationDelegate |
EditorViewController |
View lifecycle, callbacks, and feature coordination | UITableViewController, UIDocumentPickerDelegate |
FloatToColorTransformer |
Transforms feature data or representations | ValueTransformer |
Document |
Owns document data or lifecycle behavior | UIDocument |
DocumentBrowserViewController |
View lifecycle, callbacks, and feature coordination | UIDocumentBrowserViewController, UIDocumentBrowserViewControllerDelegate, UIViewControllerTransitioningDelegate |
DocumentViewController |
View lifecycle, callbacks, and feature coordination | UIViewController |
ParticleViewController |
View lifecycle, callbacks, and feature coordination | UIViewController |
PreviewViewController |
View lifecycle, callbacks, and feature coordination | UIViewController, QLPreviewingController |
ThumbnailProvider |
Supplies a capability or framework resource | QLThumbnailProvider |
Section |
Defines a closed set of feature states or choices | String |
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 |
|---|---|---|---|
document (Particles/DocumentViewController.swift:13) |
private(set) |
Read access follows the declaration; writes remain in the private scope. | Inference: allow observation while reserving invariant-changing writes for the owner. |
particleNavigationController (Particles/DocumentViewController.swift:22) |
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. |
particleViewController (Particles/DocumentViewController.swift:23) |
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. |
editorViewController (Particles/DocumentViewController.swift:24) |
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
Particles/DocumentViewController.swift:13 — representative boundary
class DocumentViewController: UIViewController {
// ...
private(set) var document: Document?
// ...
}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, DocumentViewController, EditorViewController, ParticleViewController |
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. |
| Supplies a capability or framework resource | ThumbnailProvider |
The source’s Provider suffix makes this role explicit. |
| Transforms feature data or representations | FloatToColorTransformer |
The source’s Transformer suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| View-controller organization | Particles/DocumentBrowserViewController.swift:11 |
A controller is the verified coordination boundary; this is MVC-style only where a separate model is present. |
| Delegate or data-source callbacks | Particles/AppDelegate.swift:12 |
Callback protocols invert event delivery back into the sample’s owner. |
Naming conventions
- Types: Controller: DocumentBrowserViewController, DocumentViewController, EditorViewController, ParticleViewController, PreviewViewController; Delegate: AppDelegate; Document: Document; Provider: ThumbnailProvider; Transformer: FloatToColorTransformer.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
value,reversedValue,prepareForReuse,transformedValue,reverseTransformedValue,viewDidLoad,makeDataSource,scheduleAutosave. - Files:
Particles/EditorViewController.swift,Particles/AppDelegate.swift,Particles/Document.swift,Particles/DocumentBrowserViewController.swift,Particles/DocumentViewController.swift,Particles/ParticleViewController.swift.
Architecture takeaways
AppDelegateis the main source-visible entry or composition anchor for this sample.- Framework work reaches UIKit, SceneKit, MobileCoreServices, QuickLook 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 |
|---|---|
Particles/AppDelegate.swift |
Cited implementation, AppDelegate, UIKit, os |
Particles/EditorViewController.swift |
Cited implementation, EditorViewController, Section, EditorSetting, PETableViewCell, FloatToColorTransformer |
Particles/DocumentViewController.swift |
Cited implementation, MobileCoreServices, DocumentViewController |
Particles/DocumentBrowserViewController.swift |
DocumentBrowserViewController |
ParticlesThumbnails/ThumbnailProvider.swift |
DispatchQueue.main.async, ThumbnailProvider |
Particles/Document.swift |
SceneKit, Document |
ParticlesPreview/PreviewViewController.swift |
QuickLook, PreviewViewController |
Particles/ParticleViewController.swift |
ParticleViewController |