musx::util::EnigmaString::EnigmaParsingOptions Struct Reference

Options for configuring how Enigma strings are parsed. More...

#include <EnigmaString.h>

Public Member Functions
	EnigmaParsingOptions ()
	constructor
	EnigmaParsingOptions (AccidentalStyle accidentalStyle)
	constructor for accidental substitution

Public Attributes
AccidentalInsertHandling	insertHandling
	Specifies how accidental insert commands are handled during parsing.
AccidentalStyle	substitutionStyle
	Specifies the accidental substitution style used when insertHandling is Substitute.
bool	stripUnknownTags = true
	Specifies whether to strip unknown tags or dump them into the output string.
bool	ignoreStyleTags = false
	If value is true, font & style tags are ignored. Note that you may still get get font and style changes for accidental inserts.
std::unordered_set< std::string_view >	ignoreTags
	Skip tags in this set. Primarily used by the "partname" insert to avoid a situation where the partname itself contains a ^partname tag. (Though the Finale UI prevents this, a plugin might possibly do it in theory.)

Detailed Description

Options for configuring how Enigma strings are parsed.

This struct encapsulates all parsing configuration for Enigma string processing, including accidental insert handling behavior and substitution style.

Member Data Documentation

insertHandling

AccidentalInsertHandling musx::util::EnigmaString::EnigmaParsingOptions::insertHandling

Specifies how accidental insert commands are handled during parsing.

Defaults to ParseToGlyphs, which parses insert commands into font changes and glyph strings.

substitutionStyle

AccidentalStyle musx::util::EnigmaString::EnigmaParsingOptions::substitutionStyle

Specifies the accidental substitution style used when insertHandling is Substitute.

Ignored unless insertHandling is set to Substitute. Defaults to Unicode substitution.