gronod/iccery-v2-mac
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases 7 Wiki Activity

[Feature/Medium] Stage 2: Add paper size and print quality selection to printer details #183

New Issue
Closed
opened 2026-09-15 10:20:29 +01:00 by gronod · 3 comments
gronod commented 2026-09-15 10:20:29 +01:00
Owner
Copy Link
Copy Source

Summary

Stage 2 printer details selection allows selection of the printer, media type, and orientation, but not quality or paper size settings from the ICCery screen. The paper size should follow the setting selected at the top of Stage 1 (defaults to A4) and default to portrait orientation. Print quality options should be populated from the printer's capabilities (lpoptions -l / PPD).

Spec refs

  • 09 — Stage 2 printtarg UI & argv builder
  • 10 — Print system shared types (PrinterPaperSize, PrintOptions.paperSize — the spec names it paper_size; the Swift field is camelCase, PrinterModels.swift:100)
  • 11 — macOS printing and ColorSync suppression

Scope

  1. Stage 2 UI: Add paper size picker and print quality picker to the print panel (below/beside tray/media/orientation)
  2. PrintSessionViewModel: Add selectedPaperSize and selectedQuality @Published properties
  3. PrinterCapabilities: Already has paperSizes: [PrinterPaperSize] — wire it to the UI
  4. Quality options: Extract from lpoptions -l (keys like EPIJ_Qual, cupsPrintQuality, Quality, CNIJQuality, StpQuality, OutputMode, Resolution) and/or PPD *OpenUI entries
  5. PrintOptions: Pass paperSize and quality through captured cupsOptions when opening printer properties
  6. Printer properties dialog: Pre-select the chosen paper size and quality in the NSPrintPanel — paper size + quality only here; media type + orientation preselect, capture-return of all fields, and binding verification are #186 scope

Implementation notes

  • The Stage 2 paper picker is an editable picker that re-mirrors Stage 1's workflow.pageSize: it seeds from pageSize and re-seeds on pageSize change or capabilities reload, but remains user-editable otherwise
  • Custom page size from Stage 1 (customPageW/customPageH) maps to a custom PageSize entry: the PPD token Custom.WIDTHxHEIGHT is a template — emit Custom.<w>x<h> in points (mm × 72/25.4); synthetic picker entry id: 0, label Custom (W×H mm)
  • Quality options come from the printer driver — enumerate via lpoptions -p <queue> -l and PPD parsing
  • The PrinterCapabilities.paperSizes array is already populated but unused by Stage 2 UI (docs/10 §PrinterPaperSize gap)
  • When opening printer properties (NSPrintPanel), pre-set PMPageFormat paper size and PMPrintSettings quality before runModal
  • Quality key detection: the capture-relevance roster is CupsOptionsFilter.relevantKeys (Packages/ICCeryCore/Sources/ICCeryCore/Print/CupsOptionsFilter.swift:16-32). CupsParsers holds mediaTypeKeys, bypassKeys, detectMediaTypeKey, detectDriverColorBypass only (CupsParsers.swift:217-263) — a new quality-key roster/detector is needed. Include EPIJ_Qual (see issue #180)

Rewrite invariants

  • Never search $PATH for binaries (use /usr/bin/lpoptions via CupsService)
  • Atomic writes = .tmp + rename (#213)
  • User-supplied strings via SwiftUI Text only (#114)
  • ARGYLL_NOT_INTERACTIVE=1 on every spawn
  • No blocking subprocess I/O on @MainActor

Dependencies

  • Depends on: Issues 12, 13, 14, 17 (M3 printing infrastructure — already complete)
  • Blocks: #180, #181, #186 (bug fixes that need the quality/media pickers to exist)
  • Scope split with #186: this issue wires the showProperties initial-selections plumbing for paper size + quality only; #186 completes media type + orientation preselect, capture-return of all fields, and binding verification

Test

  • CI/mock: Fixture lpoptions -l output with multiple paper sizes and quality options; verify UI populates pickers; verify PrintOptions carries values to build_lp_args
  • Hardware: Real Epson/Canon queue — verify paper size and quality pickers show driver options; verify printer properties dialog pre-selects chosen values

Acceptance criteria

  • Stage 2 print panel shows paper size picker (populated from printer capabilities; seeded from Stage 1 pageSize and re-mirroring on pageSize change / caps reload, editable otherwise)
  • Stage 2 print panel shows print quality picker (populated from printer driver options)
  • Selected paper size and quality are passed to PrintOptions when printing
  • Printer properties dialog (NSPrintPanel) opens with selected printer pre-bound AND paper size/quality pre-selected (media type + orientation preselect is #186 scope)
  • Custom page size from Stage 1 maps to a custom paper size entry (Custom.<w>x<h> in points)
## Summary Stage 2 printer details selection allows selection of the printer, media type, and orientation, but not quality or paper size settings from the ICCery screen. The paper size should follow the setting selected at the top of Stage 1 (defaults to A4) and default to portrait orientation. Print quality options should be populated from the printer's capabilities (lpoptions -l / PPD). ## Spec refs - [09](09-stage2-printtarg.md) — Stage 2 printtarg UI & argv builder - [10](10-print-system.md) — Print system shared types (PrinterPaperSize, `PrintOptions.paperSize` — the spec names it `paper_size`; the Swift field is camelCase, PrinterModels.swift:100) - [11](11-print-macos.md) — macOS printing and ColorSync suppression ## Scope 1. **Stage 2 UI**: Add paper size picker and print quality picker to the print panel (below/beside tray/media/orientation) 2. **PrintSessionViewModel**: Add `selectedPaperSize` and `selectedQuality` @Published properties 3. **PrinterCapabilities**: Already has `paperSizes: [PrinterPaperSize]` — wire it to the UI 4. **Quality options**: Extract from `lpoptions -l` (keys like `EPIJ_Qual`, `cupsPrintQuality`, `Quality`, `CNIJQuality`, `StpQuality`, `OutputMode`, `Resolution`) and/or PPD `*OpenUI` entries 5. **PrintOptions**: Pass `paperSize` and quality through captured `cupsOptions` when opening printer properties 6. **Printer properties dialog**: Pre-select the chosen paper size and quality in the NSPrintPanel — **paper size + quality only here**; media type + orientation preselect, capture-return of all fields, and binding verification are #186 scope ## Implementation notes - The Stage 2 paper picker is an **editable picker that re-mirrors** Stage 1's `workflow.pageSize`: it seeds from `pageSize` and re-seeds on pageSize change or capabilities reload, but remains user-editable otherwise - Custom page size from Stage 1 (`customPageW`/`customPageH`) maps to a custom `PageSize` entry: the PPD token `Custom.WIDTHxHEIGHT` is a template — emit `Custom.<w>x<h>` in **points** (mm × 72/25.4); synthetic picker entry `id: 0`, label `Custom (W×H mm)` - Quality options come from the printer driver — enumerate via `lpoptions -p <queue> -l` and PPD parsing - The `PrinterCapabilities.paperSizes` array is already populated but unused by Stage 2 UI (docs/10 §PrinterPaperSize gap) - When opening printer properties (NSPrintPanel), pre-set `PMPageFormat` paper size and `PMPrintSettings` quality before `runModal` - Quality key detection: the capture-relevance roster is `CupsOptionsFilter.relevantKeys` (Packages/ICCeryCore/Sources/ICCeryCore/Print/CupsOptionsFilter.swift:16-32). `CupsParsers` holds `mediaTypeKeys`, `bypassKeys`, `detectMediaTypeKey`, `detectDriverColorBypass` only (CupsParsers.swift:217-263) — a new quality-key roster/detector is needed. Include `EPIJ_Qual` (see issue #180) ## Rewrite invariants - Never search `$PATH` for binaries (use `/usr/bin/lpoptions` via CupsService) - Atomic writes = `.tmp` + rename (#213) - User-supplied strings via SwiftUI `Text` only (#114) - `ARGYLL_NOT_INTERACTIVE=1` on every spawn - No blocking subprocess I/O on `@MainActor` ## Dependencies - **Depends on:** Issues 12, 13, 14, 17 (M3 printing infrastructure — already complete) - **Blocks:** #180, #181, #186 (bug fixes that need the quality/media pickers to exist) - **Scope split with #186:** this issue wires the `showProperties` initial-selections plumbing for **paper size + quality only**; #186 completes media type + orientation preselect, capture-return of all fields, and binding verification ## Test - CI/mock: Fixture `lpoptions -l` output with multiple paper sizes and quality options; verify UI populates pickers; verify `PrintOptions` carries values to `build_lp_args` - Hardware: Real Epson/Canon queue — verify paper size and quality pickers show driver options; verify printer properties dialog pre-selects chosen values ## Acceptance criteria - [ ] Stage 2 print panel shows paper size picker (populated from printer capabilities; seeded from Stage 1 `pageSize` and re-mirroring on pageSize change / caps reload, editable otherwise) - [ ] Stage 2 print panel shows print quality picker (populated from printer driver options) - [ ] Selected paper size and quality are passed to `PrintOptions` when printing - [ ] Printer properties dialog (NSPrintPanel) opens with selected printer pre-bound AND paper size/quality pre-selected (media type + orientation preselect is #186 scope) - [ ] Custom page size from Stage 1 maps to a custom paper size entry (`Custom.<w>x<h>` in points)
gronod added this to the M11 — Printer settings completeness & dialog binding milestone 2026-09-15 11:58:22 +01:00
gronod commented 2026-09-15 17:47:04 +01:00
Author
Owner
Copy Link
Copy Source

Planning errata for the implementation contract (verified on develop@736fd08 — code is ground truth):

  1. "reuse CupsParsers.relevantKeys" — the roster is CupsOptionsFilter.relevantKeys (Packages/ICCeryCore/Sources/ICCeryCore/Print/CupsOptionsFilter.swift:16–32). CupsParsers holds mediaTypeKeys, bypassKeys, detectMediaTypeKey, detectDriverColorBypass only (CupsParsers.swift:217–263).
  2. PrintOptions.paper_size — the Swift field is paperSize (camelCase, PrinterModels.swift:100); paper_size is docs/10 spec naming.
  3. Scope split with #186: the AC "dialog … paper size/quality pre-selected" is satisfied here for paper size + quality only — this issue wires the showProperties initial-selections plumbing for those two. #186 completes media type + orientation preselect, capture-return of all fields, and binding verification.
  4. "mirror … not be independent" vs AC "defaulting to" — resolved: the Stage 2 paper picker is an editable picker that re-mirrors workflow.pageSize on pageSize change or caps reload.
  5. Custom mapping: the PPD token Custom.WIDTHxHEIGHT is a template — emit Custom.<w>x<h> in points (mm × 72/25.4); synthetic picker entry id: 0, label Custom (W×H mm).
Planning errata for the implementation contract (verified on develop@736fd08 — code is ground truth): 1. "reuse `CupsParsers.relevantKeys`" — the roster is `CupsOptionsFilter.relevantKeys` (Packages/ICCeryCore/Sources/ICCeryCore/Print/CupsOptionsFilter.swift:16–32). `CupsParsers` holds `mediaTypeKeys`, `bypassKeys`, `detectMediaTypeKey`, `detectDriverColorBypass` only (CupsParsers.swift:217–263). 2. `PrintOptions.paper_size` — the Swift field is `paperSize` (camelCase, PrinterModels.swift:100); `paper_size` is docs/10 spec naming. 3. Scope split with #186: the AC "dialog … paper size/quality pre-selected" is satisfied here for **paper size + quality only** — this issue wires the `showProperties` initial-selections plumbing for those two. #186 completes media type + orientation preselect, capture-return of all fields, and binding verification. 4. "mirror … not be independent" vs AC "defaulting to" — resolved: the Stage 2 paper picker is an **editable picker that re-mirrors** `workflow.pageSize` on pageSize change or caps reload. 5. Custom mapping: the PPD token `Custom.WIDTHxHEIGHT` is a template — emit `Custom.<w>x<h>` in **points** (mm × 72/25.4); synthetic picker entry `id: 0`, label `Custom (W×H mm)`.
gronod added the Feature/UIKind/Feature
Priority
Medium
3
Project/ICCery-v2 labels 2026-09-15 17:47:20 +01:00
gronod commented 2026-09-15 18:05:19 +01:00
Author
Owner
Copy Link
Copy Source

Errata above incorporated into the issue body — the ticket itself is now the corrected contract.

Errata above incorporated into the issue body — the ticket itself is now the corrected contract.
gronod commented 2026-09-15 21:44:12 +01:00
Author
Owner
Copy Link
Copy Source

Implementation landed in PR #193 at 51c3073 on milestone/m11-print-settings.

Acceptance evidence:

  • Stage 2 print panel shows paper size picker populated from caps.paperSizes and quality picker populated from caps.qualities — paperSizeGroup/printerPaperSizeSelect and qualityGroup/printerQualitySelect in Stage2View; UI tests testPaperAndQualityPickersExist, testPickersSeedFromStage1AndDriverDefault (Milestone11PrintSettingsUITests)
  • selectedPaperSize mirrors workflow.pageSize including .custom → synthetic Custom.<pt>x<pt> entry, and re-mirrors on pageSize change / printer change / caps reload while staying user-editable — PrintSessionViewModelTests: testSeedMatchesPageSizeRawValue, testSeedCustomPageSizeSyntheticEntry, testReseedOnPageSizeChange, testPrinterChangeReseeds, testUserEditPreservedAcrossUnrelatedPublishes, testSeedNoMatchLeavesNil
  • Selected paper size and quality flow PrintOptions.paperSize/quality → LpArgs → lp argv (-o PageSize=, -o <qualityKey>= after media, before orientation) — LpArgsTests: testPageSize, testQualityDerived, testQualityDetectedKey, testCapturedWinsQuality, testQualityNilNoEmit; testSpoolPassesPaperTokenAndQuality (PrintSessionViewModelTests)
  • Printer properties dialog opens with selected printer bound and paper size/quality pre-selected (plumbing) — PMPrintSettingsSetValue PageSize + PMCreatePageFormatWithPMPaper page-format write + detected quality key in PrintPanelService; PrintPanelStubTests coverage. PDE echo remains a hardware gate
  • New ids printerPaperSizeSelect/printerQualitySelect/paperSizeGroup/qualityGroup present and distinct; all 13 pre-existing accessibility identifiers unchanged — verified at milestone tip 6adbf99
  • Custom page size maps to Custom.<w>x<h> in points (mm × 72/25.4); Custom.WIDTHxHEIGHT never emitted verbatim — testSeedCustomPageSizeSyntheticEntry, testSpoolPassesPaperTokenAndQuality

Verification at milestone/m11-print-settings 6adbf99bd9:

  • xcodebuild test -scheme ICCery -destination 'platform=macOS' -derivedDataPath build/DerivedData-m11-final ARCHS="$(uname -m)" CODE_SIGNING_ALLOWED=YES CODE_SIGN_IDENTITY='-' (x86_64): passed
  • full host-arch ICCeryCoreTests: 483 passed, 0 failed
  • full ICCeryUITests: 67 passed, 0 failed (genuine xctest pass summary; single allowed clean rerun consumed for an app-activation attach flake in run 1 — testAboutDialogShowsVersionAndBuildDate, no assertion failure)

Hardware item remains a milestone gate (not this issue's merge gate).
Closing manually only after code and tests are present on the milestone branch.

Implementation landed in PR #193 at 51c3073 on milestone/m11-print-settings. Acceptance evidence: - [x] Stage 2 print panel shows paper size picker populated from `caps.paperSizes` and quality picker populated from `caps.qualities` — `paperSizeGroup`/`printerPaperSizeSelect` and `qualityGroup`/`printerQualitySelect` in Stage2View; UI tests `testPaperAndQualityPickersExist`, `testPickersSeedFromStage1AndDriverDefault` (Milestone11PrintSettingsUITests) - [x] `selectedPaperSize` mirrors `workflow.pageSize` including `.custom` → synthetic `Custom.<pt>x<pt>` entry, and re-mirrors on pageSize change / printer change / caps reload while staying user-editable — PrintSessionViewModelTests: `testSeedMatchesPageSizeRawValue`, `testSeedCustomPageSizeSyntheticEntry`, `testReseedOnPageSizeChange`, `testPrinterChangeReseeds`, `testUserEditPreservedAcrossUnrelatedPublishes`, `testSeedNoMatchLeavesNil` - [x] Selected paper size and quality flow `PrintOptions.paperSize`/`quality` → `LpArgs` → `lp` argv (`-o PageSize=`, `-o <qualityKey>=` after media, before orientation) — LpArgsTests: `testPageSize`, `testQualityDerived`, `testQualityDetectedKey`, `testCapturedWinsQuality`, `testQualityNilNoEmit`; `testSpoolPassesPaperTokenAndQuality` (PrintSessionViewModelTests) - [x] Printer properties dialog opens with selected printer bound and paper size/quality pre-selected (plumbing) — `PMPrintSettingsSetValue` PageSize + `PMCreatePageFormatWithPMPaper` page-format write + detected quality key in PrintPanelService; PrintPanelStubTests coverage. PDE echo remains a hardware gate - [x] New ids `printerPaperSizeSelect`/`printerQualitySelect`/`paperSizeGroup`/`qualityGroup` present and distinct; all 13 pre-existing accessibility identifiers unchanged — verified at milestone tip 6adbf99 - [x] Custom page size maps to `Custom.<w>x<h>` in points (mm × 72/25.4); `Custom.WIDTHxHEIGHT` never emitted verbatim — `testSeedCustomPageSizeSyntheticEntry`, `testSpoolPassesPaperTokenAndQuality` Verification at milestone/m11-print-settings 6adbf99bd9aaefd84a55a35442f1bd18bf8ab2c3: - `xcodebuild test -scheme ICCery -destination 'platform=macOS' -derivedDataPath build/DerivedData-m11-final ARCHS="$(uname -m)" CODE_SIGNING_ALLOWED=YES CODE_SIGN_IDENTITY='-'` (x86_64): passed - full host-arch ICCeryCoreTests: 483 passed, 0 failed - full ICCeryUITests: 67 passed, 0 failed (genuine xctest pass summary; single allowed clean rerun consumed for an app-activation attach flake in run 1 — `testAboutDialogShowsVersionAndBuildDate`, no assertion failure) Hardware item remains a milestone gate (not this issue's merge gate). Closing manually only after code and tests are present on the milestone branch.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Bug/Architecture
Core / wizard / process infra defect
 Bug/Backend
Argyll orchestration, file/data defect
 Bug/DevOps
Build, packaging, CI defect
 Bug/UI
Views, controls, dialogs defect
 Compat/Breaking
Breaking change that won't be backward compatible
 Feature/Architecture
Core / wizard / process infra
 Feature/Backend
Argyll orchestration, file/data engines
 Feature/DevOps
Build, packaging, CI
 Feature/UI
Views, controls, dialogs
 Kind/Bug
Something is not working
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Security
This is security issue
 Kind/Testing
Issue or pull request related to testing
Priority
Critical
1
The priority is critical
Priority
High
2
The priority is high
Priority
Low
4
The priority is low
Priority
Medium
3
The priority is medium
Project/ICCery-v2
ICCery v2 Mac rewrite
Reviewed
Confirmed
1
Issue has been confirmed
Reviewed
Duplicate
2
This issue or pull request already exists
Reviewed
Invalid
3
Invalid issue
Reviewed
Won't Fix
3
This issue won't be fixed
Status
Abandoned
3
Somebody has started to work on this but abandoned work
Status
Blocked
1
Something is blocking this issue or pull request
Status
Need More Info
2
Feedback is required to reproduce issue or to continue work
No labels Feature/UI Kind/Feature
Priority
Medium
3
 Project/ICCery-v2
Milestone
No items
No Milestone M11 — Printer settings completeness & dialog binding
Projects
Clear projects
No projects
Assignees
Clear assignees
gronod
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Blocks
#180 [Bug/Critical] Epson printer quality options limited to default only — only "Normal" shown, 6 other options missing
gronod/iccery-v2-mac
#181 [Bug/Medium] Canon printer media types display Thai characters instead of English labels
gronod/iccery-v2-mac
#186 [Bug/High] Printer properties dialog doesn't apply selected printer and settings from ICCery
gronod/iccery-v2-mac
Reference: gronod/iccery-v2-mac#183