ChordPro Actor Reference

Parse a ‘ChordPro’ file


                    
                    
                    parse(id:text:transpose:instrument:fileURL:)

Parse a ChordPro file

Declaration

Swift

static func parse(id: UUID, text: String, transpose: Int, instrument: Instrument, fileURL: URL?) -> Song

Parameters

`text`	The text of the file
`transpose`	The optional transpose of the song
`id`	The ID of the song
`instrument`	The instrument of the song
`fileURL`	The optional file url of the song

Return Value

A Song item

Show on GitHub

Process a directive


                    
                    
                    processDirective(text:song:currentSection:)

Process a directive

Declaration

Swift

private static func processDirective(
    text: String,
    song: inout Song,
    currentSection: inout Song.Section
)

Parameters

`text`	The text to process
`song`	The `Song`
`currentSection`	The current `section` of the `song`

Show on GitHub

Process a section


                    
                    
                    processSection(label:type:song:currentSection:)

Process a section

Declaration

Swift

private static func processSection(label: String, type: Environment, song: inout Song, currentSection: inout Song.Section)

Parameters

`label`	The label of the `section`
`type`	The type of `section`
`song`	The `song`
`currentSection`	The current `section` of the `song`

Show on GitHub

Process a chord definition


                    
                    
                    processDefine(text:song:)

Process a chord definition

Declaration

Swift

private static func processDefine(text: String, song: inout Song)

Parameters

`text`	The chord definition
`song`	The `song`

Show on GitHub

Process a tab environment


                    
                    
                    processTab(text:song:currentSection:)

Process a tab environment

Declaration

Swift

private static func processTab(text: String, song: inout Song, currentSection: inout Song.Section)

Parameters

`text`	The text to process
`song`	The `Song`
`currentSection`	The current `section` of the `song`

Show on GitHub

Process a grid environment


                    
                    
                    processGrid(text:song:currentSection:)

Process a grid environment

Declaration

Swift

private static func processGrid(text: String, song: inout Song, currentSection: inout Song.Section)

Parameters

`text`	The text to process
`song`	The `Song`
`currentSection`	The current `section` of the `song`

Show on GitHub

Process a strum environment


                    
                    
                    processStrum(text:song:currentSection:)

Process a strum environment

Declaration

Swift

private static func processStrum(text: String, song: inout Song, currentSection: inout Song.Section)

Parameters

`text`	The text to process
`song`	The `Song`
`currentSection`	The current `section` of the `song`

Show on GitHub

Process a line


                    
                    
                    processLine(text:song:currentSection:)

Process a line

Declaration

Swift

private static func processLine(text: String, song: inout Song, currentSection: inout Song.Section)

Parameters

`text`	The text to process
`song`	The `Song`
`currentSection`	The current `section` of the `song`

Show on GitHub

Process a chord


                    
                    
                    processChord(chord:song:)

Process a chord

Declaration

Swift

private static func processChord(chord: String, song: inout Song) -> ChordDefinition

Parameters

`chord`	The `chord` as String
`song`	The `Song`

Return Value

The processed chord as String

Show on GitHub

‘ChordPro’ directives

Directive
The directives Chord Provider supports
See more
Declaration
Swift

enum Directive: String, CaseIterable
Show on GitHub

‘ChordPro’ section environments

Environment
The environment of a section of the song
See more
Declaration
Swift

enum Environment: String
Show on GitHub

Regex definitions

directives
All the directives we know about
Declaration
Swift

static let directives = ChordPro.Directive.allCases.map(\.rawValue)
Show on GitHub


                    
                    
                    directiveRegex

The regex for a directive with an optional label

/// ## Examples

{title: The title of the song}
{chorus}
{start_of_verse}
{start_of_verse: Last Verse}

Note

This needs an extension for ChoiceOf

Declaration

Swift

static let directiveRegex = Regex {
    "{"
    Capture {
        ChoiceOf(directives)
    } transform: {
        Directive(rawValue: $0.lowercased()) ?? .none
    }
    Optionally {
        ":"
        TryCapture {
            OneOrMore {
                CharacterClass(
                    .anyOf("}").inverted
                )
            }
        } transform: {
            $0.trimmingCharacters(in: .whitespacesAndNewlines)
        }
    }
    "}"
    Optionally {
        CharacterClass(
            .anyOf("{").inverted
        )
    }
}

Show on GitHub


                    
                    
                    lineRegex

The regex for a normal line with optionalchords and/or lyrics

/// ## Example

[A]I sing you a [G]song!!

Declaration

Swift

static let lineRegex = Regex {
    /// The chord
    Optionally {
        chordRegex
    }
    /// The lyric
    Optionally {
        Capture {
            OneOrMore {
                CharacterClass(
                    .anyOf("[]").inverted
                )
            }
        }
    }
}

Show on GitHub


                    
                    
                    bracketRegex

Regex for brackets for chords and directives

Declaration

Swift

static let bracketRegex = Regex {
    Capture {
        OneOrMore {
            CharacterClass(
                .anyOf("[]{}")
            )
        }
    }
}

Show on GitHub


                    
                    
                    chordRegex

Regex for a chord

Declaration

Swift

static let chordRegex = Regex {
    Regex {
        "["
        Capture {
            OneOrMore {
                CharacterClass(
                    .anyOf("[] ").inverted
                )
            }
        }
        "]"
    }
}

Show on GitHub