Module

Data.Abc.Optics

Package: purescript-abc-parser
Repository: newlandsvalley/purescript-abc-parser

Optics for accessing the tune headers

ABC allows for multiple headers of the same type to exist: https://abcnotation.com/wiki/abc:standard:v2.1#file_header It's not clear how you should discriminate between them if, for example, you want to display the main tune header on a score. I use the convention that the first header to be defined is the prominent one.

It's also probably not necessary that optics are needed to retrieve components of the tune body because it's almost always necessary to process this serially.

Usage requires profunctor-optics.

To retrieve the first title:

firstOf (headers <<< traversed <<< Title) abcTune

To retrieve all the titles into a list:

toListOf (headers <<< traversed <<< Title) abcTune

Or to get the tune mode:

firstOf (headers <<< traversed <<< ModifiedKeySignature <<< keySignature <<< mode) abcTune

Or to reset the title of a tune:

set (headers <<< traversed <<< Title) "new title" abcTune

#_headers Source

_headers :: forall a r. Lens' { headers :: a | r } a

the tune headers

#_body Source

_body :: forall a r. Lens' { body :: a | r } a

the tune body

#_Area Source

_Area :: Prism' Header String

specific headers

#_Book Source

_Book :: Prism' Header String

#_Composer Source

_Composer :: Prism' Header String

#_Discography Source

_Discography :: Prism' Header String

#_FileUrl Source

_FileUrl :: Prism' Header String

#_Group Source

_Group :: Prism' Header String

#_History Source

_History :: Prism' Header String

#_Instruction Source

_Instruction :: Prism' Header String

#_ModifiedKeySignature Source

_ModifiedKeySignature :: Prism' Header ModifiedKeySignature

#_UnitNoteLength Source

_UnitNoteLength :: Prism' Header NoteDuration

#_Meter Source

_Meter :: Prism' Header (Maybe TimeSignature)

#_Macro Source

_Macro :: Prism' Header String

#_Notes Source

_Notes :: Prism' Header String

#_Origin Source

_Origin :: Prism' Header String

#_Parts Source

_Parts :: Prism' Header String

#_Tempo Source

_Tempo :: Prism' Header TempoSignature

#_Rhythm Source

_Rhythm :: Prism' Header String

#_Remark Source

_Remark :: Prism' Header String

#_Source Source

_Source :: Prism' Header String

#_SymbolLine Source

_SymbolLine :: Prism' Header String

#_Title Source

_Title :: Prism' Header String

#_Voice Source

_Voice :: Prism' Header VoiceDescription

#_WordsAfter Source

_WordsAfter :: Prism' Header String

#_WordsAligned Source

_WordsAligned :: Prism' Header String

#_ReferenceNumber Source

_ReferenceNumber :: Prism' Header (Maybe Int)

#_Transcription Source

_Transcription :: Prism' Header String

#_FieldContinuation Source

_FieldContinuation :: Prism' Header String

#_Comment Source

_Comment :: Prism' Header String

#_keySignature Source

_keySignature :: forall a r. Lens' { keySignature :: a | r } a

modified Key signature fields the underlying key signature

#_keySignatureModifications Source

_keySignatureModifications :: forall a r. Lens' { modifications :: a | r } a

modifications to the key signature

#_pitchClass Source

_pitchClass :: forall a r. Lens' { pitchClass :: a | r } a

the pitch class e.g. A

#_accidental Source

_accidental :: forall a r. Lens' { accidental :: a | r } a

#_mode Source

_mode :: forall a r. Lens' { mode :: a | r } a

#_bpm Source

_bpm :: forall a r. Lens' { bpm :: a | r } a

Tempo signature fields

#_noteLengths Source

_noteLengths :: forall a r. Lens' { noteLengths :: a | r } a

#_marking Source

_marking :: forall a r. Lens' { marking :: a | r } a

#_id Source

_id :: forall a r. Lens' { id :: a | r } a

Voice fields

#_properties Source

_properties :: forall a r. Lens' { properties :: a | r } a

key signature or voice description properties