[webern]

AI Summary

An accidental-mark lost how it is drawn when read into mx::api and written back. Only its accidental value, position and placement were kept; its parentheses, bracket, size, SMuFL glyph, id, font and color were dropped on read and could not be authored. This applied both to a standalone accidental mark in notations and to an accidental that belongs to an ornament, such as the sharp over a trill.

What changes in mx::api:

• A new SymbolSize enum in ApiCommon.h (unspecified, full, cue, graceCue, large) carries MusicXML's size attribute. unspecified leaves the size to the application.
• MarkDataChoice gains an AccidentalMarkData alternative (Kind::accidentalMark, isAccidentalMark(), accidentalMark()) for the accidentalMark* mark types:
  • parentheses and bracket (Bool): yes draws the accidental in parentheses or square brackets, common ways to show an editorial accidental. unspecified leaves it to the application.
  • size (SymbolSize): how large the accidental is drawn.
  • smufl: a specific SMuFL accidental glyph, for example accidentalSharp. A name that is not a SMuFL accidental (one starting with acc, medRenFla, medRenNatura, medRenShar or kievanAccidental) is not written, and the write reports an error diagnostic with the dropped-data code.
  • id: the element's id.
    The accidental's font and color go in the existing MarkData::printData. A payload with every field at its default is stored as none, so a mark built from its MarkType alone still compares equal after a write and a read.
• OrnamentAccidental gains the same five fields directly, plus PrintData for its font and color. An owned accidental has no MarkData around it, so its fields sit on the one struct a caller already reads.

One reader helper and one writer helper fill both shapes.

Behaviour change for callers reading files

Reading an accidental mark that sets any of parentheses, bracket, size, smufl or id now gives a choice holding AccidentalMarkData where it used to be none. Its MarkData::printData, and an OrnamentAccidental's printData, now holds the font and color from the file where it used to be left at its default. Code that builds accidental marks is unaffected, and nothing was removed or renamed, so this is labelled non-breaking.

Out of scope

• MarkData::name is still filled in by the reader for an accidental mark (for example "sharp") but left empty by the MarkData constructor, as it already is for ornaments. The writer ignores name for these marks. Changing the constructor would change what existing callers build, so it is left alone here.
• printObject on an accidental mark's PrintData, and the alignment fields of its PositionData, have no MusicXML attribute to go to and are not written. The headers say so. Other marks drop these the same way without a diagnostic, and adding one for every mark belongs in its own change.
• A MarkDataChoice payload of another kind on an accidental mark is ignored, as on every other mark. An ornament payload on an accidental mark is still reported, as before.

Pinned files

• synthetic/accidental-mark.3.0.xml
• synthetic/accidental-mark.3.1.xml

Testing

• MarkRoundTripTest: AccidentalMarkAttributes, AccidentalMarkSizes, AccidentalMarkDefaultsToNoPayload, OrnamentAccidentalAttributes, AccidentalMarkSmuflNotAnAccidental, AccidentalMarkChoiceAccessorsAndEquality (every new field's equality, both shapes)
• NoteDataTest: readsSyntheticAccidentalMarkFixture reads every attribute of the trill's sharp from the 3.1 fixture; standaloneAccidentalMarkKeepsHowItIsDrawn reads a standalone accidental-mark's attributes, checks the written xml carries each one, and checks a bare one reads with no payload
• make api-test: 6884 assertions in 806 test cases pass
• make api-roundtrip: 460 of 460 pinned files pass, two more than before
• make api-roundtrip-discover: 461 PASS, 380 FAIL; the PASS list is main's plus the two pinned files
• make audit-test passes; make fmt-check passes
• Unity build of target mx (CMAKE_UNITY_BUILD, batch size 0) succeeds

References

• Stacked on feat: an ornament owns the accidental marks written after it #496
• Progresses expose the id attribute of dynamics, fermata and accidental-mark in mx::api #403 (the accidental-mark id)
• Completes the accidental-mark work started in the writer drops tuplet position, midi-unpitched and accidental marks #443 and feat: an ornament owns the accidental marks written after it #496