Some style names are duplicated in MSS files

[shoogle]

Issue type

Engraving bug (incorrect score rendering)

Bug description

These XML tag names are duplicated in src/engraving/style/styledef.cpp:

• "measureNumberPosBelow"
  • Sid::measureNumberPosBelow
  • Sid::mmRestRangePosBelow
• "minVerticalDistance"
  • Sid::minVerticalDistance
  • Sid::skylineMinHorizontalClearance
• "systemOffsetType"
  • Sid::systemTextOffsetType
  • Sid::staffTextOffsetType

As a result, MuseScore cannot tell the difference between these style settings when reading and writing score files.

This problem would manifest as an engraving bug for end users.

Steps to reproduce

Run this command in MuseScore's source folder to see duplicated XML tags:

sed -En 's|.*Sid::([a-zA-Z0-9]+) *, *"([a-zA-Z0-9]+)".*|\2|p' src/engraving/style/styledef.cpp | sort | uniq -d

Screenshots/Screen recordings

No response

MuseScore Version

master

Regression

No.

Operating system

All

Additional context

This command shows XML tags that don't match the Sid name:

sed -En 's|.*Sid::([a-zA-Z0-9]+) *, *"([a-zA-Z0-9]+)".*|\1 \2|p' src/engraving/style/styledef.cpp | awk '$1!=$2' | column -t

Command output (click to show/hide)

Sid name on the left, XML tag on the right

minStaffSpread                  minSpreadSpread
maxStaffSpread                  maxSpreadSpread
hairpinLineWidth                hairpinWidth
chordSymbolAPosAbove            chordSymbolPosAbove
chordSymbolAPosBelow            chordSymbolPosBelow
measureNumberAllStaves          measureNumberAllStaffs
firstSystemInstNameVisibility   firstSystemInsNameVisibility
SlurEndWidth                    slurEndWidth
SlurMidWidth                    slurMidWidth
SlurDottedWidth                 slurDottedWidth
TieEndWidth                     tieEndWidth
TieMidWidth                     tieMidWidth
TieDottedWidth                  tieDottedWidth
MinTieLength                    minTieLength
MinStraightGlissandoLength      minStraightGlissandoLength
MinWigglyGlissandoLength        minWigglyGlissandoLength
SlurMinDistance                 slurMinDistance
TieMinDistance                  tieMinDistance
HeaderToLineStartDistance       headerSlurTieDistance
SectionPause                    sectionPause
MusicalSymbolFont               musicalSymbolFont
MusicalTextFont                 musicalTextFont
tremoloStrokeWidth              tremoloLineWidth
tremoloStyle                    tremoloStrokeStyle
skylineMinHorizontalClearance   minVerticalDistance
spatium                         Spatium
measureNumberPosAbove           measureNumberOffset
mmRestRangePosAbove             measureNumberPosAbove
mmRestRangePosBelow             measureNumberPosBelow
systemTextFontFace              systemFontFace
systemTextFontSize              systemFontSize
systemTextFontSpatiumDependent  systemFontSpatiumDependent
systemTextFontStyle             systemFontStyle
systemTextAlign                 systemAlign
systemTextOffsetType            systemOffsetType
systemTextPlacement             systemPlacement
systemTextPosAbove              systemPosAbove
systemTextPosBelow              systemPosBelow
systemTextMinDistance           systemMinDistance
systemTextFrameType             systemFrameType
systemTextFramePadding          systemFramePadding
systemTextFrameWidth            systemFrameWidth
systemTextFrameRound            systemFrameRound
systemTextFrameFgColor          systemFrameFgColor
systemTextFrameBgColor          systemFrameBgColor
staffTextFontFace               staffFontFace
staffTextFontSize               staffFontSize
staffTextFontSpatiumDependent   staffFontSpatiumDependent
staffTextFontStyle              staffFontStyle
staffTextAlign                  staffAlign
staffTextOffsetType             systemOffsetType
staffTextPlacement              staffPlacement
staffTextPosAbove               staffPosAbove
staffTextPosBelow               staffPosBelow
staffTextMinDistance            staffMinDistance
staffTextFrameType              staffFrameType
staffTextFramePadding           staffFramePadding
staffTextFrameWidth             staffFrameWidth
staffTextFrameRound             staffFrameRound
staffTextFrameFgColor           staffFrameFgColor
staffTextFrameBgColor           staffFrameBgColor

The mismatch is annoying for developers but doesn't cause problems for end users. If we want to fix it, the Sid should be renamed to match the XML tag rather than the other way around, because changing the XML would cause compatibility problems. (However, for the duplicates mentioned above, we have no choice but to change the XML tag.)

Possibly the XML tags should be generated by a pre-processor macro to ensure they match the Sid names.

In cases where the mismatch is intentional, the macro could take an extra argument, or those cases could be written out explicitly like they are now.