ChordProParser Actor Reference

Arguments
A dictionary with optional arguments for a directive
Declaration
Swift

typealias Arguments = [ChordPro.Directive.FormattingAttribute: String]
Show on GitHub

Parse a ‘ChordPro’ file


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

Parse a ChordPro file

Declaration

Swift

static func parse(
    id: UUID,
    text: String,
    transpose: Int,
    settings: AppSettings.Song,
    fileURL: URL?
) async -> Song

Parameters

`id`	The ID of the song
`text`	The text of the file
`transpose`	The optional transpose of the song in the GUI
`settings`	The settings for the song
`fileURL`	The optional file url of the song

Return Value

A Song item

Show on GitHub


                    
                    
                    addSection(source:sectionLabel:directive:arguments:environment:currentSection:song:)

Add a complete section with a single directive in a line

Declaration

Swift

static func addSection(
    source: String? = nil,
    sectionLabel: String? = nil,
    directive: ChordPro.Directive,
    arguments: Arguments,
    environment: ChordPro.Environment = .metadata,
    currentSection: inout Song.Section,
    song: inout Song
)

Parameters

`source`	The optional source of the line; else it will be calculated
`sectionLabel`	The optional override of the section label
`directive`	The `Directive` to add to the line
`arguments`	The optional arguments for the directive
`environment`	The optional environment for the section; defaults to ‘metadata`
`currentSection`	The current `Section`
`song`	The whole `Song`

Show on GitHub


                    
                    
                    argumentsToString(_:)

Convert arguments to a single string

Declaration

Swift

static func argumentsToString(_ arguments: ChordProParser.Arguments) -> String?

Parameters


                                arguments

The arguments dictionary

Return Value

A single string with arguments

Show on GitHub


                    
                    
                    stringToArguments(_:currentSection:)

Convert an argument string into arguments

Declaration

Swift

static func stringToArguments(_ parsedArgument: String?, currentSection: inout Song.Section) -> ChordProParser.Arguments

Parameters

`parsedArgument`	The parsed argument string
`currentSection`	The current section of the song; this is to add optional warnings

Return Value

The arguments in a dictionary

Show on GitHub


                    
                    
                    autoSection(environment:currentSection:song:)

Create an automatic section in the Song

Declaration

Swift

static func autoSection(
    environment: ChordPro.Environment,
    currentSection: inout Song.Section,
    song: inout Song
) -> String

Parameters

`environment`	The `Environment` of the section
`currentSection`	The current `Section`
`song`	The whole `Song`

Return Value

A warning as String

Show on GitHub


                    
                    
                    closeSection(currentSection:song:)

Close a section in the song

Note

This will open a new empty section as well

Declaration

Swift

static func closeSection(
    currentSection: inout Song.Section,
    song: inout Song
)

Parameters

`currentSection`	The current `Section`
`song`	The whole `Song`

Show on GitHub


                    
                    
                    getImageURL(_:fileURL:)

Get the full URL of an image

Declaration

Swift

static func getImageURL( _ source: String, fileURL: URL?) -> URL?

Parameters

`source`	The image source as defined in the song
`fileURL`	The optional URL of the song file

Return Value

An optional URL of the image

Show on GitHub


                    
                    
                    getImageSize(image:arguments:)

Get the size of an image

Declaration

Swift

static func getImageSize(image: NSImage, arguments: Arguments?) -> CGSize

Parameters

`image`	The `NSImage`
`arguments`	The arguments of the image in the song

Return Value

The CGSize of the image

Show on GitHub


                    
                    
                    getOffset(_:)

Get the offset of a ChordPro directive

Declaration

Swift

static func getOffset(_ arguments: ChordProParser.Arguments?) -> CGSize

Parameters


                                arguments

The arguments of the directive in the song

Return Value

The offset as CGSize

Show on GitHub


                    
                    
                    openSection(directive:arguments:currentSection:song:)

Open a new section in the song

Declaration

Swift

static func openSection(
    directive: ChordPro.Directive,
    arguments: Arguments,
    currentSection: inout Song.Section,
    song: inout Song
)

Parameters

`directive`	The `Directive` to add to the line
`arguments`	The optional arguments for the directive
`currentSection`	The current `Section`
`song`	The whole `Song`

Show on GitHub

Process a chord


                    
                    
                    processChord(chord:line:song:ignoreUnknown:)

Process a chord

Declaration

Swift

static func processChord(
    chord: String,
    line: inout Song.Section.Line,
    song: inout Song,
    ignoreUnknown: Bool = false
) -> ChordDefinition

Parameters

`chord`	The `chord` as String
`line`	The current line of the section
`song`	The whole `Song`
`ignoreUnknown`	Bool to ignore an unknown chord so it will not be added to the chord list

Return Value

The processed chord as String

Show on GitHub


                    
                    
                    processComment(arguments:currentSection:song:)

Process a comment

Declaration

Swift

static func processComment(
    arguments: Arguments,
    currentSection: inout Song.Section,
    song: inout Song
)

Parameters

`arguments`	The optional arguments for the directive
`currentSection`	The current `Section`
`song`	The whole `Song`

Show on GitHub

Process a chord definition


                    
                    
                    processDefine(arguments:currentSection:song:)

Process a chord definition

Declaration

Swift

static func processDefine(
    arguments: Arguments,
    currentSection: inout Song.Section,
    song: inout Song
)

Parameters

`arguments`	The directive arguments
`currentSection`	The current `Section`
`song`	The whole `Song`

Show on GitHub


                    
                    
                    getDirective(_:)

Get the Directive from a String

Declaration

Swift

static func getDirective(_ directive: String) -> (directive: ChordPro.Directive, warning: Bool)?

Parameters


                                directive

The directive as string

Return Value

The optional directive with an optional warning if a ‘short’ directive is found

Show on GitHub

Process a directive


                    
                    
                    processDirective(text:currentSection:song:)

Process a directive

Declaration

Swift

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

Parameters

`text`	The text to process
`currentSection`	The current `Section`
`song`	The whole `Song`

Show on GitHub


                    
                    
                    processEmptyLine(currentSection:song:)

Process an empty line

Declaration

Swift

static func processEmptyLine(
    currentSection: inout Song.Section,
    song: inout Song
)

Parameters

`currentSection`	The current `Section`
`song`	The whole `Song`

Show on GitHub

Process a grid environment


                    
                    
                    processGrid(text:currentSection:song:)

Process a grid environment

Declaration

Swift

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

Parameters

`text`	The text to process
`currentSection`	The current `Section`
`song`	The whole `Song`

Show on GitHub

Process a line


                    
                    
                    processLine(text:currentSection:song:)

Process a line

Declaration

Swift

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

Parameters

`text`	The text to process
`currentSection`	The current `Section`
`song`	The whole `Song`

Show on GitHub


                    
                    
                    processMetadata(directive:arguments:currentSection:song:)

Process meta data

Declaration

Swift

static func processMetadata(
    directive: ChordPro.Directive,
    arguments: Arguments,
    currentSection: inout Song.Section,
    song: inout Song
)

Parameters

`directive`	The `Directive` to process
`arguments`	The optional arguments for the directive
`currentSection`	The current `Section`
`song`	The whole `Song`

Show on GitHub


                    
                    
                    processSourceComment(comment:currentSection:song:)

Process a source comment

Declaration

Swift

static func processSourceComment(
    comment: String,
    currentSection: inout Song.Section,
    song: inout Song
)

Parameters

`comment`	The source comment
`currentSection`	The current `Section`
`song`	The whole `Song`

Show on GitHub

Process a strum environment


                    
                    
                    processStrum(text:currentSection:song:)

Process a strum environment

Declaration

Swift

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

Parameters

`text`	The text to process
`currentSection`	The current `Section`
`song`	The whole `Song`

Show on GitHub

Process a tab environment


                    
                    
                    processTab(text:currentSection:song:)

Process a tab environment

Declaration

Swift

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

Parameters

`text`	The text to process
`currentSection`	The current `Section`
`song`	The whole `Song`

Show on GitHub

Debug stuff


                    
                    
                    encode(_:)

Encode a struct

Declaration

Swift

static func encode<T: Codable>(_ value: T) -> String

Parameters


                                value

The struct

Return Value

A JSON string

Show on GitHub


                    
                    
                    decode(_:)

Decode a JSON encoded Song

Declaration

Swift

static func decode(_ string: String)

Parameters


                                string

The Song as JSON string

Show on GitHub