Refactor to support naked chords.
This commit is contained in:
parent
8515546c89
commit
6a3793cb0a
@ -1,6 +1,6 @@
|
||||
# Package
|
||||
|
||||
version = "0.1.0"
|
||||
version = "0.3.0"
|
||||
author = "Jonathan Bernard"
|
||||
description = "Chord chart formatter compatible with Planning Center Online"
|
||||
license = "MIT"
|
||||
|
||||
@ -40,5 +40,5 @@ when isMainModule:
|
||||
|
||||
except:
|
||||
fatal getCurrentExceptionMsg()
|
||||
#raise getCurrentException()
|
||||
debug getCurrentException().getStackTrace
|
||||
quit(QuitFailure)
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
import std/nre, std/strtabs, std/strutils
|
||||
import std/logging, std/nre, std/strtabs, std/strutils
|
||||
import zero_functional
|
||||
|
||||
type
|
||||
@ -49,8 +49,9 @@ type
|
||||
ParserContext = ref object
|
||||
lines: seq[string]
|
||||
curKeyCenter: ChordChartPitch
|
||||
curLine: int
|
||||
curNode: ChordChartNode
|
||||
curLineNum: int
|
||||
curSection: ChordChartNode
|
||||
unparsedLineParts: seq[string]
|
||||
|
||||
func `[]`*(ccmd: ChordChartMetadata, key: string): string =
|
||||
ccmd.optionalProps[key]
|
||||
@ -101,7 +102,7 @@ func dump*(ccn: ChordChartNode, indent = ""): string =
|
||||
result = indent & "Redefine key to " & $ccn.newKey
|
||||
|
||||
of ccnkLine:
|
||||
result = indent & "Line\p"
|
||||
result = indent & "Line "
|
||||
for child in ccn.line:
|
||||
let formattedChild = dump(child, indent)
|
||||
if child.kind == ccnkWord: result &= formattedChild
|
||||
@ -128,12 +129,27 @@ func `$`*(cc: ChordChart): string =
|
||||
# PARSER
|
||||
# -----------------------------------------------------------------------------
|
||||
|
||||
func hasNextLine(ctx: ParserContext): bool =
|
||||
ctx.unparsedLineParts.len > 1 or
|
||||
ctx.curLineNum + 1 < ctx.lines.len
|
||||
|
||||
func nextLine(ctx: var ParserContext): string =
|
||||
if ctx.unparsedLineParts.len > 0:
|
||||
result = ctx.unparsedLineParts[0]
|
||||
ctx.unparsedLineParts.delete(0)
|
||||
else:
|
||||
ctx.curLineNum += 1
|
||||
result = ctx.lines[ctx.curLineNum]
|
||||
|
||||
func pushPartialsToParse(ctx: var ParserContext, parts: varargs[string]): void =
|
||||
ctx.unparsedLineParts &= parts
|
||||
|
||||
template makeError(ctx: ParserContext, msg: string): untyped =
|
||||
newException(ValueError,
|
||||
"error parsing input at line " & $ctx.curLine & ":\p\t" & msg)
|
||||
"error parsing input at line " & $ctx.curLineNum & ":\p\t" & msg)
|
||||
|
||||
template addToCurSection(n: ChordChartNode): untyped =
|
||||
if ctx.curNode.kind == ccnkSection: ctx.curNode.sectionContents.add(n)
|
||||
if ctx.curSection.kind == ccnkSection: ctx.curSection.sectionContents.add(n)
|
||||
else: result.add(n)
|
||||
|
||||
func parsePitch*(ctx: ParserContext, keyValue: string): ChordChartPitch =
|
||||
@ -160,11 +176,10 @@ proc parseMetadata(ctx: var ParserContext): ChordChartMetadata =
|
||||
var songKey = "MISSING"
|
||||
var optProps = newStringTable()
|
||||
|
||||
while ctx.curLine < ctx.lines.len:
|
||||
let line = ctx.lines[ctx.curLine]
|
||||
while ctx.curLineNum < ctx.lines.len:
|
||||
let line = ctx.nextLine
|
||||
|
||||
if line.match(METADATA_END_PAT).isSome:
|
||||
ctx.curLine += 1
|
||||
break
|
||||
|
||||
let m = line.match(METADATA_LINE_PAT)
|
||||
@ -176,7 +191,6 @@ proc parseMetadata(ctx: var ParserContext): ChordChartMetadata =
|
||||
if key == "title": title = value
|
||||
elif key == "key": songKey = value
|
||||
else: optProps[key] = value
|
||||
ctx.curLine += 1
|
||||
|
||||
if title == "MISSING":
|
||||
raise ctx.makeError("metadata is missing the 'title' property")
|
||||
@ -189,31 +203,42 @@ proc parseMetadata(ctx: var ParserContext): ChordChartMetadata =
|
||||
key: ctx.parsePitch(songKey),
|
||||
optionalProps: optProps)
|
||||
|
||||
let SECTION_LINE_PAT = re"^((?i)(chorus|verse|bridge|breakdown|vamp) ?\d*\s*)|([[:upper:]]+\s*)$"
|
||||
let NAKED_CHORD_REGEX =
|
||||
"[[:upper:]][b#♭♮𝄫𝄪]?" & # chord root
|
||||
"([mM1-9#b♭♮𝄫𝄪Δ+oøoø]|min|maj|aug|dim|sus|6\\/9)*" & # chord flavor/type
|
||||
"(\\/[[:upper:]])?" # optional bass
|
||||
|
||||
const KNOWN_SECTION_NAMES = [
|
||||
"chorus", "verse", "bridge", "breakdown", "vamp", "intstrumental",
|
||||
"interlude", "intro", "outtro", "ending", "end", "tag"
|
||||
]
|
||||
|
||||
let SECTION_LINE_PAT = re(
|
||||
"^((" & # case insensitive
|
||||
"((?i)" & KNOWN_SECTION_NAMES.join("|") & ")" & # known names
|
||||
"|[[:upper:]]{3,}" & # all upper-case words
|
||||
") ?\\d*)" & # numeric suffix (Verse 2)
|
||||
|
||||
# Allow notes or other text to follow on the same line
|
||||
"(.*)$"
|
||||
)
|
||||
let COL_BREAK_PAT = re"\s*COLUMN_BREAK\s*$"
|
||||
let PAGE_BREAK_PAT = re"\s*PAGE_BREAK\s*$"
|
||||
let TRANSPOSE_PAT = re"\s*TRANSPOSE KEY ([+-]\d+)\s*$"
|
||||
let REDEFINE_KEY_PAT = re"\s*REDEFINE KEY ([+-]\d+)\s*$"
|
||||
let NOTE_PAT = re"^(.*)({{[^}]+}}|{[^}]+})(.*)$"
|
||||
#let NOTE_PAT = re"^(.*)({{[^}]+}}|{[^}]+})(.*)$"
|
||||
let NOTE_START_PAT = re"{{"
|
||||
let NOTE_END_PAT = re"}}"
|
||||
let SPACE_PAT = re"\s"
|
||||
let CHORD_IN_LYRICS_PAT = re"(\w+)(\[.+)"
|
||||
let CHORD_AND_LYRICS_PAT = re"^\[([^\]]+)\]([^\s\[]+)(.*)$"
|
||||
let CHORD_PAT = re"^\[([^\]]+)\]$"
|
||||
let BRACED_CHORD_PAT = re"^\[([^\]]+)\]$"
|
||||
let NAKED_CHORDS_ONLY_PAT = re("^(" & NAKED_CHORD_REGEX & "\\s*\\|*\\s*)+$")
|
||||
|
||||
proc parseLineParts(parts: varargs[string]): seq[ChordChartNode] =
|
||||
result = @[]
|
||||
for p in parts:
|
||||
var m = p.match(NOTE_PAT)
|
||||
if m.isSome:
|
||||
if m.get.captures[0].len > 0: result &= parseLineParts(m.get.captures[0])
|
||||
result.add(ChordChartNode(
|
||||
kind: ccnkNote,
|
||||
note: m.get.captures[1].strip(chars = {'{', '}', ' '}),
|
||||
inclInLyrics: not m.get.captures[1].startsWith("{{")))
|
||||
if m.get.captures[2].len > 0: result &= parseLineParts(m.get.captures[2])
|
||||
continue
|
||||
|
||||
m = p.match(SPACE_PAT)
|
||||
var m = p.match(SPACE_PAT)
|
||||
if m.isSome:
|
||||
result &= parseLineParts(p.splitWhitespace)
|
||||
continue
|
||||
@ -234,7 +259,7 @@ proc parseLineParts(parts: varargs[string]): seq[ChordChartNode] =
|
||||
result &= parseLineParts(m.get.captures[2])
|
||||
continue
|
||||
|
||||
m = p.match(CHORD_PAT)
|
||||
m = p.match(BRACED_CHORD_PAT)
|
||||
if m.isSome:
|
||||
result.add(ChordChartNode(
|
||||
kind: ccnkWord,
|
||||
@ -253,23 +278,70 @@ proc parseLineParts(parts: varargs[string]): seq[ChordChartNode] =
|
||||
word: p))
|
||||
|
||||
proc parseLine(line: string): ChordChartNode =
|
||||
result = ChordChartNode(
|
||||
kind: ccnkLine,
|
||||
line: parseLineParts(line.splitWhitespace))
|
||||
result = ChordChartNode(kind: ccnkLine)
|
||||
|
||||
let m = line.match(NAKED_CHORDS_ONLY_PAT)
|
||||
if m.isSome:
|
||||
result.line = line.splitWhitespace --> map(
|
||||
ChordChartNode(
|
||||
kind: ccnkWord,
|
||||
spaceAfter: false, #FIXME
|
||||
spaceBefore: false, #FIXME
|
||||
chord: it.strip,
|
||||
word: ""))
|
||||
|
||||
else: result.line = parseLineParts(line.splitWhitespace)
|
||||
|
||||
proc readNote(ctx: var ParserContext, endPat: Regex): string =
|
||||
let startLineNum = ctx.curLineNum
|
||||
result = ""
|
||||
|
||||
while ctx.lines.len > ctx.curLineNum:
|
||||
let line = ctx.nextLine
|
||||
let m = line.find(endPat)
|
||||
if m.isSome:
|
||||
result &= line[0..<m.get.matchBounds.a]
|
||||
ctx.pushPartialsToParse(line[m.get.matchBounds.b..^1])
|
||||
break
|
||||
else: result &= line
|
||||
|
||||
if not ctx.hasNextLine:
|
||||
raise ctx.makeError("a note section was started on line " &
|
||||
$startLineNum & " and never closed")
|
||||
|
||||
proc parseBody(ctx: var ParserContext): seq[ChordChartNode] =
|
||||
result = @[]
|
||||
while ctx.curLine < ctx.lines.len:
|
||||
let line = ctx.lines[ctx.curLine]
|
||||
ctx.curLine += 1
|
||||
while ctx.hasNextLine:
|
||||
var line = ctx.nextLine
|
||||
|
||||
var m = line.match(SECTION_LINE_PAT)
|
||||
var m = line.find(NOTE_START_PAT)
|
||||
if m.isSome:
|
||||
ctx.curNode = ChordChartNode(
|
||||
if m.get.matchBounds.a > 0:
|
||||
# if this is not the first character of the line then let's split the
|
||||
# line and continue to parse
|
||||
ctx.pushPartialsToParse(
|
||||
line[0..<m.get.matchBounds.a],
|
||||
line[m.get.matchBounds.a..^1])
|
||||
continue
|
||||
|
||||
else:
|
||||
# if this is the first character of the line, then let's parse the note
|
||||
result.add(ChordChartNode(
|
||||
kind: ccnkNote,
|
||||
inclInLyrics: m.get.match .len < 2,
|
||||
note: ctx.readNote(NOTE_END_PAT)))
|
||||
|
||||
m = line.match(SECTION_LINE_PAT)
|
||||
if m.isSome:
|
||||
let captures = m.get.captures.toSeq
|
||||
ctx.curSection = ChordChartNode(
|
||||
kind: ccnkSection,
|
||||
sectionName: line.strip,
|
||||
sectionName: if captures[0].isSome: captures[0].get.strip
|
||||
else: raise ctx.makeError("unknown error parsing section header: " & line),
|
||||
sectionContents: @[])
|
||||
result.add(ctx.curNode)
|
||||
result.add(ctx.curSection)
|
||||
if captures[3].isSome:
|
||||
ctx.curSection.sectionContents &= parseLineParts(captures[3].get)
|
||||
continue
|
||||
|
||||
# FIXME: as implemented, this will not allow column breaks within a section
|
||||
@ -311,7 +383,8 @@ proc parseBody(ctx: var ParserContext): seq[ChordChartNode] =
|
||||
proc parseChordChart*(s: string): ChordChart =
|
||||
var parserCtx = ParserContext(
|
||||
lines: s.splitLines,
|
||||
curLine: 0)
|
||||
curLineNum: -1,
|
||||
unparsedLineParts: @[])
|
||||
|
||||
let metadata = parseMetadata(parserCtx)
|
||||
parserCtx.curKeyCenter = metadata.key
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
const PCO_CHORDS_VERSION* = "0.1.0"
|
||||
const PCO_CHORDS_VERSION* = "0.3.0"
|
||||
|
||||
const USAGE* = """Usage:
|
||||
pco_chords [options]
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user