Editor

enum Editor

Static settings and functions for the editor

Show on GitHub

lineHeightMultiple
The line height multiplier for the editor text
Declaration
Swift

static let lineHeightMultiple: Double = 1.6
Show on GitHub
rulerNumberStyle
The style of a number in the ruler
Declaration
Swift

static var rulerNumberStyle: [NSAttributedString.Key: Any]
Show on GitHub
highlightedForegroundColor
The foreground of the highlighted line in the editor

Note
A var to keep it up-to-date when the accent color is changed
Declaration
Swift

static var highlightedForegroundColor: NSColor
Show on GitHub
highlightedBackgroundColor
The background of the highlighted line in the editor
Declaration
Swift

static let highlightedBackgroundColor: NSColor = .gray.withAlphaComponent(0.1)
Show on GitHub


                    
                    
                    format(directive:editorInternals:)

Edit a Directive with its argument in the ChordProEditor

Declaration

Swift

static func format(
    directive: ChordPro.Directive,
    editorInternals: ChordProEditor.Internals
)

Parameters

`directive`	The `Directive` to apply
`editorInternals`	The internals of the `ChordProEditor`

Show on GitHub


                    
                    
                    format(directive:argument:)

Format a Directive with its argument

Declaration

Swift

static func format(directive: ChordPro.Directive, argument: String) -> String

Parameters

`directive`	The `Directive` to apply
`argument`	The argument of the `directive`

Return Value

A formatted Directive as String

Show on GitHub

Settings for the editor

Settings
Settings for the editor
See more
Declaration
Swift

struct Settings: Equatable, Codable, Sendable
Show on GitHub
RegexType
The type of regex
See more
Declaration
Swift

enum RegexType
Show on GitHub


                    
                    
                    chordRegex

The regex for chords

Declaration

Swift

static let chordRegex = try! NSRegularExpression(pattern: "\\[([\\w#b\\/]+)\\]", options: .caseInsensitive)

Show on GitHub


                    
                    
                    directiveRegex

The regex for directives

Declaration

Swift

static let directiveRegex = try! NSRegularExpression(pattern: "\\{(\\w+):?([^\\}\\n]+)?(?:\\}|\\n)")

Show on GitHub


                    
                    
                    commentsRegex

The regex for comments

Declaration

Swift

static let commentsRegex = try! NSRegularExpression(pattern: "(?<=^|\\n)(#[^\\n]*)")

Show on GitHub


                    
                    
                    markupRegex

The regex for markup

Declaration

Swift

static let markupRegex = try! NSRegularExpression(pattern: "<\\/?([^>]*)>")

Show on GitHub


                    
                    
                    keyValueRegex

The regex for key=value

Declaration

Swift

static let keyValueRegex = try! NSRegularExpression(pattern: "\"\\/?([^\"]*)\"")

Show on GitHub


                    
                    
                    bracketsRegex

The regex for brackets

Declaration

Swift

static let bracketsRegex = try! NSRegularExpression(pattern: "\\/?([\\[\\]\\{\\}\"\\<\\>/])")

Show on GitHub


                    
                    
                    newLineRegex

The regex for new lines

Declaration

Swift

static let newLineRegex = try! NSRegularExpression(pattern: "\n", options: [])

Show on GitHub


                    
                    
                    regexes(settings:)

The highlight regex dictionary for the text editor

Declaration

Swift

static func regexes(settings: Editor.Settings) -> [(regex: NSRegularExpression, color: NSColor, regexType: RegexType)]

Parameters


                                settings

The Settings of the ChordProEditor

Return Value

The highlight regex dictionary

Show on GitHub


                    
                    
                    highlight(view:settings:range:)

Highlight the text in the editor

Declaration

Swift

static func highlight(
    view: NSTextView,
    settings: Editor.Settings,
    range: NSRange
)

Parameters

`view`	The `NSTextView`
`settings`	The `Settings` of the editor
`range`	The range in the text that needs highlighting

Show on GitHub