From 6a3793cb0a060387c09d37170af332ddef3fddc2 Mon Sep 17 00:00:00 2001 From: Jonathan Bernard Date: Wed, 5 Oct 2022 08:59:24 -0500 Subject: [PATCH] Refactor to support naked chords. --- pco_chords.nimble | 2 +- src/pco_chords.nim | 2 +- src/pco_chordspkg/ast.nim | 145 ++++++++++++++++++++++------- src/pco_chordspkg/cliconstants.nim | 2 +- 4 files changed, 112 insertions(+), 39 deletions(-) diff --git a/pco_chords.nimble b/pco_chords.nimble index 68feb72..3701e69 100644 --- a/pco_chords.nimble +++ b/pco_chords.nimble @@ -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" diff --git a/src/pco_chords.nim b/src/pco_chords.nim index 1f3274e..6dce4c2 100644 --- a/src/pco_chords.nim +++ b/src/pco_chords.nim @@ -40,5 +40,5 @@ when isMainModule: except: fatal getCurrentExceptionMsg() - #raise getCurrentException() + debug getCurrentException().getStackTrace quit(QuitFailure) diff --git a/src/pco_chordspkg/ast.nim b/src/pco_chordspkg/ast.nim index 791fda0..b22446b 100644 --- a/src/pco_chordspkg/ast.nim +++ b/src/pco_chordspkg/ast.nim @@ -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.. 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..