Repository navigation
feat: key signature print-object in mx::api - #468
Merged
Merged
Conversation
7 tasks done
webern
marked this pull request as ready for review
October 29, 2026 07:08
webern
changed the title
<key print-object="no"> (a key signature that applies to the music but is not drawn) had no api home, so it was written back as a plain <key> and the signature became visible. KeyData gains printObject, a Bool that mirrors ClefData::printObject. The reader fills it for traditional and non-traditional keys, and the writer emits it when it is not unspecified. The default leaves output unchanged. musuite/testInvisibleElements.xml now round-trips and is pinned in the baseline.
webern
force-pushed
the
m/mxdev-keyprint
branch
from
October 30, 2026 08:15
3faf381 to
e6f9da7
Compare
webern
added a commit
that referenced
this pull request
Nov 1, 2026
## Summary `<staff-details>` kept `<staff-lines>` but dropped every `<staff-tuning>`, so a guitar tab came back with its lines and no record of what the strings are tuned to. `StaffData` gains `staffTunings`, a list of the new `StaffTuningData` (line, step, alter, cents, octave). Like `staffLines`, it is set on the measure whose attributes carry the staff-details and is not carried forward to later measures. The reader honours the `number` attribute on `<staff-details>`, and reads a `<staff-details>` that holds only tunings. The writer emits the tunings between `<staff-lines>` and `<staff-size>`, as the schema orders them. The tuning-step / tuning-alter / tuning-octave translation is shared with the existing scordatura reader and writer through a small header-only helper (`TuningFunctions.h`), with no change to scordatura behavior or diagnostics. A separate `StaffTuningData` type rather than reusing `AccordData`: a staff tuning has a required line, an accord an optional string number. `musuite/testTablature1.xml`, `testTablature2.xml` and `testTablature3.xml` now round-trip and are pinned in the baseline. `lysuite/ly71e_TabStaves.xml` and `recsuite/BrookeWestSample.xml` lose their tuning differences but still fail on other staff-details content (staff-type, capo, show-frets, line-detail), which is not modeled here. ## Testing - [x] New `MeasureDataTest` cases: tuning round trip, alter and cents, tunings without staff-lines, two staves; new `MeasureWriterTest` case for the written `<staff-tuning>` - [x] Existing scordatura tests pass unchanged - [x] `make api-test` passes (6195 assertions in 716 test cases) - [x] `make api-roundtrip` passes, 445 of 445 pinned files - [x] `make api-roundtrip-discover`: 445 pass, no file that passed before now fails - [x] Unity build (`CMAKE_UNITY_BUILD_BATCH_SIZE=0`) of the `mx` target compiles - [x] `make fmt-check` passes ## References - Stacked on #468
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
<key print-object="no">(a key signature that applies to the music but is not drawn) had no apihome, so it was written back as a plain
<key>and the signature became visible.KeyDatagainsprintObject, a tri-stateBoolthat mirrorsClefData::printObject. The readerfills it for traditional and non-traditional keys;
PropertiesWriter::writeKey, the one place a<key>is built, emits it when it is not unspecified. The default leaves output unchanged.data/api.features.xmlmarks keyprint-objectas supported.musuite/testInvisibleElements.xmlnow round-trips and is pinned in the baseline.Not addressed here: the non-traditional key reader branch still does not set
staffIndexortickTimePosition, and other<key>attributes (color, position, font) are still dropped.Testing
PrintObject*cases inKeyDataTest.cpp: no, yes, unspecified (omitted), non-traditional,per-staff, and equality
make api-testpasses (6141 assertions in 710 test cases)make api-roundtrippasses, 442 of 442 pinned filesmake api-roundtrip-discover: 442 pass, no file that passed before now failsmake fmt-checkpassesReferences