Section

struct Section: Identifiable, Equatable, Codable

A section in the Song

Show on GitHub
  • id

    The unique ID of the section

    Declaration

    Swift

    var id: Int
    Show on GitHub

  • The label of the section

    Declaration

    Swift

    var label: String = ""
    Show on GitHub

  • The Environment type of the section

    Declaration

    Swift

    var environment: ChordPro.Environment = .none
    Show on GitHub

  • The lines in the section

    Declaration

    Swift

    var lines: [Line] = []
    Show on GitHub

  • Boolean if the section is automatic created

    This happens mostly for lines with test and chords that is not surrounded by a {start_of_verse} and {end_of_verse}

    But also for a Tab or Grid when a line starts with an ‘|’

    The editor will show a warning when the section is automatically created with an assumed Environment.

    Note

    Automatically created sections will end with an ‘newline’, unlike defined sections.

    Declaration

    Swift

    var autoCreated: Bool
    Show on GitHub

  • Optional warnings for this section

    Declaration

    Swift

    private(set) var warnings: Set<String>?
    Show on GitHub

  • The optional arguments of the section

    Declaration

    Swift

    var arguments: ChordProParser.Arguments?
    Show on GitHub

  • Note

    warnings are optionals so we can not just ‘insert’ it

    Declaration

    Swift

    mutating func addWarning(_ warning: String)
    Show on GitHub

  • Reset all the warnings

    Declaration

    Swift

    mutating func resetWarnings()
    Show on GitHub

  • A line in the Section

    This is a line in the source document, parsed into components

    See more

    Declaration

    Swift

    struct Line: Identifiable, Equatable, Codable
    Show on GitHub