new engraver for spacing in chordlyrics

* Remove Metronome mark engraver
* Remove midiQuarterNoteSpeed

private_includes/base/all.ily

@@ -21,8 +21,17 @@
     )))))
     (scm-load "resolve_inherits.scm")
     (scm-load "yaml_parser.scm")))
-#(define AUTHOR_DATA (if (defined? 'AUTHOR_DATA) AUTHOR_DATA (parse-yml-file "../../lilypond-song-includes/data/authors.yml")))
-#(define SONG_DATA (if (defined? 'SONG_DATA) SONG_DATA (parse-yml-file "../../lilypond-song-includes/data/songs.yml")))
+
+#(define (song-includes-data-path filename)
+  (string-join
+    (list
+      (dirname (dirname (dirname (dirname (current-filename)))))
+      "lilypond-song-includes"
+      "data"
+      filename)
+    file-name-separator-string))
+#(define AUTHOR_DATA (if (defined? 'AUTHOR_DATA) AUTHOR_DATA (parse-yml-file (song-includes-data-path "authors.yml"))))
+#(define SONG_DATA (if (defined? 'SONG_DATA) SONG_DATA (parse-yml-file (song-includes-data-path "songs.yml"))))
 
 \include "merge_rests_engraver_override.ily"
 \include "basic_format_and_style_settings.ily"

private_includes/base/basic_format_and_style_settings.ily

@@ -49,6 +49,7 @@ generalLayout = \layout {
   \context {
     \Score
     \remove "Bar_number_engraver"
+    \remove "Metronome_mark_engraver"
     \RemoveEmptyStaves
     \override VerticalAxisGroup.remove-first = ##t
     \overrideTimeSignatureSettings
@@ -133,18 +134,23 @@ override-stanza =
 #}
 )
 
+#(define (handle-stanza-numbers context numbers number-formater)
+  (let* ((stanzanumbers (ly:assoc-get 'custom-stanzanumber-override (ly:assoc-get 'details (ly:context-grob-definition context 'StanzaNumber) '()) numbers))
+         (stanza-style (ly:assoc-get 'style (ly:context-grob-definition context 'StanzaNumber)))
+         (roman-format (lambda (stanzanumber) (format #f "~@r" stanzanumber))))
+      (ly:context-set-property! context 'stanza
+        (number-formater
+          (if (eq? stanza-style 'roman)
+              (map roman-format stanzanumbers)
+              stanzanumbers)))))
+
 #(define (stanza . stanzanumbers)
 #{
   \once \override StanzaNumber.details.custom-realstanza = ##t % set this to signal that there is a real stanza and no repeat signs
   \applyContext
   #(lambda (context)
-    (let* ((stanzanumbers-override (ly:assoc-get 'custom-stanzanumber-override (ly:assoc-get 'details (ly:context-grob-definition context 'StanzaNumber) '()) #f))
-           (stanza-style (ly:assoc-get 'style (ly:context-grob-definition context 'StanzaNumber)))
-           (stanza-format (lambda (stanzanumber) (format #f (if (eq? stanza-style 'roman) romanStanzaFormat stanzaFormat) stanzanumber))))
-        (ly:context-set-property! context 'stanza
-          (string-join (map stanza-format
-                            (if stanzanumbers-override stanzanumbers-override stanzanumbers))
-                        ", "))))
+    (handle-stanza-numbers context stanzanumbers
+      (lambda (numbers) (string-join (map (lambda (n) (format #f stanzaFormat n)) numbers) ", "))))
 #}
 )
 
@@ -152,7 +158,14 @@ ref =
 #(define-music-function (stanzanumbers lyrics) ((number-list? (list)) ly:music?)
 #{ \lyricmode {
     \once \override StanzaNumber.details.custom-realstanza = ##t % set this to signal that there is a real stanza and no repeat signs
-    \set stanza = #(make-on-the-fly-markup (lambda (layout props m) ((ly:output-def-lookup layout 'refMarkupFormatter) layout props stanzanumbers)) (make-null-markup))
+    \applyContext
+    #(lambda (context)
+      (handle-stanza-numbers context stanzanumbers
+        (lambda (numbers)
+          (make-on-the-fly-markup
+            (lambda (layout props m)
+              ((ly:output-def-lookup layout 'refMarkupFormatter) layout props numbers))
+            (make-null-markup)))))
     #lyrics
   }
 #}

private_includes/base/default_style.ily

@@ -16,7 +16,6 @@ songTocColumns = 3
 globalSize = 15
 lyricSize = 1.6
 stanzaFormat = "~a."
-romanStanzaFormat = "~@r."
 refString = "Ref.:"
 refStringWithNumbers = "Ref. ~a:"
 % hübsche Wiederholungszeichen für den Liedtext

private_includes/base/verses_with_chords.ily

@@ -60,19 +60,20 @@
 
 % Text über Text mittig darstellen
 #(define-markup-command (textup layout props text uptext) (markup? markup?)
+   #:properties ((verselayout generalLayout)
+                 (verse-text-chord-distance songTextChordDistance))
    "Markup über Text mittig darstellen."
-   (let ((verselayout (chain-assoc-get 'verselayout props generalLayout)))
    (interpret-markup layout props
      #{\markup {
        \size-box-to-box-style-dependent ##t ##f
-         \general-align #X #LEFT \override #`(direction . ,UP) \override #'(baseline-skip . 1.0) \dir-column \chord-alignment-style-dependent {
-           \pad-to-box #'(0 . 0) #'(0 . 2.0) { #text }
-           \size-box-to-box ##f ##t #uptext \score { \chords { g4:m a } \layout { \verselayout } }
+         \general-align #X #LEFT \override #`(direction . ,UP) \override #'(baseline-skip . 1) \dir-column \chord-alignment-style-dependent {
+           \pad-to-box #'(0 . 0) #`(0 . ,(- verse-text-chord-distance 0.8)) { #text }
+           \size-box-to-box ##f ##t #uptext \score { \chords { g4:m a } \layout { $verselayout } }
          }
          #text
        }
      #}
-   )))
+   ))
 
 #(define-markup-command (anchor-x-between layout props arga argb)
    (markup? markup?)
@@ -82,16 +83,15 @@
             (ly:stencil-aligned-to m X (- (/ (* la 2) l) 1))
      ))
 
-#(define-markup-command (stanza-raw layout props arg)
-   (string-or-music?)
-   (let ((verselayout (chain-assoc-get 'verselayout props generalLayout)))
+#(define-markup-command (stanza-raw layout props arg) (string-or-music?)
+   #:properties ((verselayout generalLayout))
    (interpret-markup layout props
      (if (and (string? arg) (string-null? arg))
          " "
          #{\markup
-           \score { \new Lyrics { \lyricmode { #(if (ly:music? arg) arg #{ \set stanza = #arg #}) "" } } \layout { \verselayout } }
+           \score { \new Lyrics { \lyricmode { #(if (ly:music? arg) arg #{ \set stanza = #arg #}) "" } } \layout { $verselayout } }
          #}
-     ))))
+     )))
 
 #(define-markup-command (stanza layout props arg)
    (string-or-music?)
@@ -141,7 +141,7 @@
        (make-wrap-newline-markup
                (ly:regex-replace (ly:make-regex "\\(( *)([^,()]*)( *),([^)]*)\\)")
                  (ly:regex-replace (ly:make-regex "(([^ \n]*\\([^()]*,[^()]+\\)[^ \n(]*)+)") (handle-custom-newlines custom-verse-breaks verse) " \\concat { " 1 " } ")
-                "\\textup \\line { \"" 1 "\" " 2 " \"" 3 "\" } \\score { " transp " \\chords { s4 " 4 " } \\layout { \\verselayout } }")
+                "\\textup \\line { \"" 1 "\" " 2 " \"" 3 "\" } \\score { " transp " \\chords { s4 " 4 " } \\layout { $verselayout } }")
                 )
      ))))
 
@@ -255,110 +255,96 @@
 
 Chord_lyrics_spacing_engraver =
 #(lambda (ctx)
-   (let ((last-note-head #f)
-         (note-head-extended #f)
-         (last-lyric-syllable-width 0)
+   (let ((last-lyric-syllable #f)
          (lyric-width-since-last-chord 0)
-         (notes-on-syllable-count 0)
-         (last-chord-name #f)
-         (remaining-chord-width 0)
-         (last-rest #f)
-         (rest-count 0)
-         (multi-measure-rest-count 0)
-         (stanza-shift 0))
+         (music-columns-for-last-syllable 0)
+         (last-printed-chord #f)
+         (chord-width-since-last-lyric 0)
+         (lyrics-seen-since-break #f)
+         (have-a-rest #f)
+         (stanza #f)
+         (place-at-right-edge
+          (lambda (grob anchor padding)
+            (let ((anchor-width (interval-length (ly:grob-extent anchor anchor X))))
+              (ly:grob-set-parent! grob X anchor)
+              (ly:grob-set-property! grob 'X-offset (+ padding anchor-width))
+              ))))
      (make-engraver
       (listeners
        ((multi-measure-rest-event engraver event)
-        (set! multi-measure-rest-count (+ multi-measure-rest-count 1))
+        (set! have-a-rest #t)
+        )
+       ((rest-event engraver event)
+        (set! have-a-rest #t)
+        )
+       ((lyric-event engraver event)
+        (set! have-a-rest #f)
+        (set! music-columns-for-last-syllable 0)
         )
        ((break-event engraver event)
-        (set! last-note-head #f)
-        (set! note-head-extended #f)
-        (set! last-lyric-syllable-width 0)
+        (set! last-lyric-syllable #f)
         (set! lyric-width-since-last-chord 0)
-        (set! notes-on-syllable-count 0)
-        (set! last-chord-name #f)
-        (set! remaining-chord-width 0)
-        (set! last-rest #f)
-        (set! rest-count 0)
-        (set! multi-measure-rest-count 0)
-        (set! stanza-shift 0)
+        (set! music-columns-for-last-syllable 0)
+        (set! last-printed-chord #f)
+        (set! chord-width-since-last-lyric 0)
+        (set! lyrics-seen-since-break #f)
         ))
       (acknowledgers
-       ((note-head-interface this-engraver grob source-engraver)
-        (if (and (> rest-count 0) (not last-note-head))
-            (let ((rest-spacing-on-line-start 1.2))
-              (ly:grob-set-property! grob 'minimum-X-extent (cons (- rest-spacing-on-line-start) 0))
-              (set! stanza-shift rest-spacing-on-line-start)
-              ))
-        (set! notes-on-syllable-count (+ 1 notes-on-syllable-count))
-        (set! last-note-head grob)
-        (set! note-head-extended #f)
-        (set! last-rest #f)
-        (set! rest-count 0)
-        (set! multi-measure-rest-count 0)
+       ((musical-paper-column-interface this-engraver grob source-engraver)
+        (set! music-columns-for-last-syllable (+ 1 music-columns-for-last-syllable))
         )
        ((lyric-syllable-interface this-engraver grob source-engraver)
-        (set! remaining-chord-width (max 0 (- remaining-chord-width lyric-width-since-last-chord)))
-        (set! last-lyric-syllable-width (- (cdr (ly:grob-extent grob grob X)) 0.2))
-        (set! lyric-width-since-last-chord (+ lyric-width-since-last-chord last-lyric-syllable-width))
-        (if last-note-head (set! notes-on-syllable-count 1))
+        (let ((syllable-width (interval-length (ly:grob-extent grob grob X))))
+          (set! lyric-width-since-last-chord (+ lyric-width-since-last-chord syllable-width))
+          )
+        (if (> chord-width-since-last-lyric 0)
+            (if lyrics-seen-since-break
+                (ly:grob-set-property! grob 'extra-spacing-width
+                                       (cons (- chord-width-since-last-lyric) (cdr (ly:grob-property grob 'extra-spacing-width '(0 . 0)))))
+                (if last-printed-chord
+                  (begin
+                    (if stanza (ly:grob-set-property! stanza 'padding chord-width-since-last-lyric))
+                    (place-at-right-edge grob last-printed-chord 0)
+                    )))
+            )
+        (set! last-lyric-syllable grob)
+        (set! chord-width-since-last-lyric 0)
+        (set! lyrics-seen-since-break #t)
         )
        ((chord-name-interface this-engraver grob source-engraver)
         (if (not (and
                   (boolean? (ly:grob-property grob 'begin-of-line-visible))
-                  (ly:grob-property grob 'begin-of-line-visible)))
-            (let ((on-a-rest (> rest-count 0)))
-              (if (not on-a-rest)
-                  (set! notes-on-syllable-count (- notes-on-syllable-count 1)))
-              (if (and last-chord-name (= multi-measure-rest-count 1) (> lyric-width-since-last-chord remaining-chord-width))
-                  (ly:grob-set-property! last-chord-name 'extra-spacing-width (cons -0.1 (+ 0.1 (- lyric-width-since-last-chord remaining-chord-width)))))
-              (if last-note-head
-                  (let* ((last-note-min-x-extent (ly:grob-property last-note-head 'minimum-X-extent))
-                         (last-note-min-x-lower (if (pair? last-note-min-x-extent) (car last-note-min-x-extent) 0))
-                         (last-note-min-x-upper (if (pair? last-note-min-x-extent) (cdr last-note-min-x-extent) 0)))
-                    (if on-a-rest
-                        (begin
-                         (if (not note-head-extended)
-                             (begin
-                              (ly:grob-set-property! last-note-head 'minimum-X-extent
-                                                     (cons last-note-min-x-lower (- last-lyric-syllable-width -2 (* 2.2 rest-count))))
-                              (set! note-head-extended #t)
-                              ))
-                         (ly:grob-set-property! last-rest 'minimum-X-extent (cons 0 2))
-                         )
-                        (if (and (> lyric-width-since-last-chord 0)
-                                 (> remaining-chord-width lyric-width-since-last-chord))
-                            (ly:grob-set-property! last-note-head 'minimum-X-extent
-                                                   (cons (- -1.2 (- remaining-chord-width lyric-width-since-last-chord)) last-note-min-x-upper))
-                            (let* ((width-per-note-head 0.5)
-                                   (note-width-since-last-chord (* width-per-note-head notes-on-syllable-count)))
-                              (if (> remaining-chord-width note-width-since-last-chord)
-                                  (ly:grob-set-property! last-note-head 'minimum-X-extent
-                                                         (cons (- note-width-since-last-chord remaining-chord-width) last-note-min-x-upper))
-                                  )
-                              )
-                            )
-                        )))
-              (set! last-chord-name grob)
-              (set! remaining-chord-width
-                    (if (and on-a-rest (equal? (ly:prob-property (ly:grob-property grob 'cause) 'duration) (ly:prob-property (ly:grob-property last-rest 'cause) 'duration)))
-                        0
-                        (cdr (ly:grob-extent grob grob X))))
-              (set! lyric-width-since-last-chord 0)
-              (set! notes-on-syllable-count (if on-a-rest 0 1))
-              ))
+                  (ly:grob-property grob 'begin-of-line-visible)
+                  lyrics-seen-since-break))
+            (let* ((last-printed-chord-width (if last-printed-chord (interval-length (ly:grob-extent last-printed-chord last-printed-chord X)) 0))
+                   (chord-overwidth (- last-printed-chord-width lyric-width-since-last-chord))
+                   (chord-gap 0.5))
+              (if have-a-rest
+                  (let ((chord-width (interval-length (ly:grob-extent grob grob X))))
+                    (if last-lyric-syllable
+                        (if (and last-printed-chord (> chord-overwidth 0))
+                          (place-at-right-edge grob last-printed-chord chord-gap)
+                          (place-at-right-edge grob last-lyric-syllable 0))
+                        (if last-printed-chord
+                            (place-at-right-edge grob last-printed-chord chord-gap)))
+                    (set! chord-width-since-last-lyric (+ chord-width-since-last-lyric chord-width chord-gap))
+                    ))
+              (if (and last-lyric-syllable last-printed-chord (> chord-overwidth 0))
+                      (ly:grob-set-property! last-lyric-syllable 'extra-spacing-width
+                                             (cons (car (ly:grob-property last-lyric-syllable 'extra-spacing-width '(0 . 0))) (+ chord-gap chord-overwidth)))
+                      )
+              (set! lyric-width-since-last-chord (* (if last-lyric-syllable (interval-length (ly:grob-extent last-lyric-syllable last-lyric-syllable X)) 0) (- 1 (/ 1.0 music-columns-for-last-syllable))))
+              (set! last-printed-chord grob)
+              (set! last-lyric-syllable #f)
+              )
+            (ly:grob-set-property! grob 'X-extent '(+inf.0 . -inf.0))
+            )
         )
-       ((rest-interface this-engraver grob source-engraver)
-        (set! rest-count (+ 1 rest-count))
-        (set! last-rest grob)
-        (set! multi-measure-rest-count 0)
-        )
-       ((stanza-number-interface this-engraver grob source-engraver)
-        (ly:grob-set-property! grob 'padding (+ 1 stanza-shift)))
-       ))))
-
-%#(ly:set-option 'debug-skylines #t)
+        ((stanza-number-interface this-engraver grob source-engraver)
+          (set! stanza grob)
+          )
+       )
+      )))
 
 #(define-markup-command (chordlyrics layout props lyrics) (ly:music?)
    #:properties ((verse-chords #{#})
@@ -379,10 +365,7 @@ Chord_lyrics_spacing_engraver =
             \new Lyrics \lyricsto "dummyvoice" { #lyrics }
           >>
           \layout {
-            \verselayout
-            #(let
-              ((custom-size (ly:output-def-lookup verselayout 'size #f)))
-              (if custom-size (layout-set-staff-size custom-size)))
+            $verselayout
             ragged-right = ##t
             \context {
               \Lyrics
@@ -403,10 +386,10 @@ Chord_lyrics_spacing_engraver =
             \context {
               \Score
               \override PaperColumn.keep-inside-line = ##f
-             % \override SpacingSpanner.strict-note-spacing = ##t
+              % \override SpacingSpanner.strict-note-spacing = ##t
               \override SpacingSpanner.uniform-stretching = ##t
               \override SpacingSpanner.spacing-increment = 0
-              %\override SpacingSpanner.packed-spacing = ##t
+              % \override SpacingSpanner.packed-spacing = ##t
               \consists \Chord_lyrics_spacing_engraver
               \remove Bar_number_engraver
               \remove Mark_engraver
@@ -437,15 +420,6 @@ Chord_lyrics_spacing_engraver =
               \remove Note_heads_engraver
               \remove Script_engraver
             }
-            \context {
-              \NullVoice
-              \consists Rest_engraver
-              \omit Rest
-              \override Rest.X-extent = #'(0 . 0)
-              \undo \omit NoteHead
-              \hide NoteHead
-              \override NoteHead.X-extent = #'(0 . 0.5)
-            }
           }
         }
       }

private_includes/book/toc_include.ily

@@ -90,7 +90,7 @@
      (for-each (lambda (category)
             (let* ((catsym (string->symbol category))
                    (catlist (hashq-ref category-index-hash catsym
-                              (list (list label 'indexCategoryMarkup `(((rawtext . ,category))))))))
+                              (list (list label 'indexCategoryMarkup `(((combine-with-next . #t) (rawtext . ,category))))))))
               (if (assq catsym category-names)
                 (hashq-set! category-index-hash catsym
                   (cons (list label markup-symbol textoptions) catlist))
@@ -114,7 +114,7 @@
      (for-each (lambda (authorID)
             (let* ((authorsym (string->symbol authorID))
                    (authorlist (hashq-ref author-index-hash authorsym
-                              (list (list label 'indexAuthorMarkup `(((rawtext . ,authorID))))))))
+                              (list (list label 'indexAuthorMarkup `(((combine-with-next . #t) (rawtext . ,authorID))))))))
                 (hashq-set! author-index-hash authorsym
                   (cons (list label markup-symbol textoptions) authorlist))
                 ))
@@ -218,20 +218,29 @@
 }
 
 #(define (prepare-item-markup items layout)
-   (map (lambda (index-item)
-         (let* ((label (car index-item))
-                (index-markup (cadr index-item))
-                (textoptions (caddr index-item))
-                (text (chain-assoc-get 'rawtext textoptions))
-                (alternative (chain-assoc-get 'alternative textoptions))
-                (songnumber (chain-assoc-get 'songnumber textoptions)))
-           (markup #:override (cons 'index:label label)
-             #:override (cons 'index:page (markup #:custom-page-number label -1))
-             #:override (cons 'index:text text)
-             #:override (cons 'index:alternative alternative)
-             #:override (cons 'index:songnumber songnumber)
-             (ly:output-def-lookup layout index-markup))))
-       (items)))
+  (define (single-item-markup index-item)
+    (let* ((label (car index-item))
+           (index-markup (cadr index-item))
+           (textoptions (caddr index-item))
+           (text (chain-assoc-get 'rawtext textoptions))
+           (alternative (chain-assoc-get 'alternative textoptions))
+           (songnumber (chain-assoc-get 'songnumber textoptions)))
+      (markup #:override (cons 'index:label label)
+        #:override (cons 'index:page (markup #:custom-page-number label -1))
+        #:override (cons 'index:text text)
+        #:override (cons 'index:alternative alternative)
+        #:override (cons 'index:songnumber songnumber)
+        (ly:output-def-lookup layout index-markup))))
+  (if (null? items)
+      items
+      (let* ((index-item (car items))
+             (combine-with-next (chain-assoc-get 'combine-with-next (caddr index-item) #f))
+             (restitems (cdr items))
+             (item-markup (single-item-markup index-item)))
+        (if (and combine-with-next (not (null? restitems)))
+            (cons (make-column-markup (list item-markup (single-item-markup (car restitems)))) (prepare-item-markup (cdr restitems) layout))
+            (cons item-markup (prepare-item-markup restitems layout))))
+      ))
 
 #(define-markup-list-command (index-in-columns-with-title layout props index-type title-markup) (symbol? markup?)
   ( _i "Outputs index alphabetical sorted or in categories" )
@@ -245,7 +254,7 @@
         (make-columnlayout-markup-list songTocColumns 2
           (let ((h (- (ly:output-def-lookup layout 'paper-height) 12)))
             (cons (- h (interval-length (ly:stencil-extent title Y))) h))
-          (prepare-item-markup items layout))))))
+          (prepare-item-markup (items) layout))))))
 
 indexItem =
 #(define-music-function (parser location sorttext text) (string? markup?)
@@ -255,7 +264,7 @@ indexItem =
 indexSection =
 #(define-music-function (parser location sorttext text) (string? markup?)
    "Add a section line to the alphabetical index, using @code{indexSectionMarkup} paper variable markup. This can be used to divide the alphabetical index into different sections, for example one section for each first letter."
-   (add-index-item! 'indexSectionMarkup (prepend-alist-chain 'rawtext text '()) sorttext))
+   (add-index-item! 'indexSectionMarkup (prepend-alist-chain 'combine-with-next #t (prepend-alist-chain 'rawtext text '())) sorttext))
 
 #(define (extract-and-check-vars-from-header bookheader varlist)
   (let* ((headervars (hash-map->list cons (struct-ref (ly:book-header bookheader) 0)))

public_includes/layout_bottom.ily

@@ -1,8 +1,12 @@
-% set the speed of the midi music
-#(define midiQuarterNoteSpeed (if (defined? 'midiQuarterNoteSpeed) midiQuarterNoteSpeed 90))
-
 MUSIC = { \transposable #TRANSPOSITION \MUSIC }
 
+LAYOUT = \layout {
+  \LAYOUT
+  #(let
+    ((custom-size (ly:output-def-lookup LAYOUT 'size #f)))
+    (if custom-size (layout-set-staff-size custom-size)))
+}
+
 verselayout = \layout {
   \LAYOUT
   \context {
@@ -11,13 +15,6 @@ verselayout = \layout {
   }
 }
 
-LAYOUT = \layout {
-  \LAYOUT
-  #(let
-    ((custom-size (ly:output-def-lookup LAYOUT 'size #f)))
-    (if custom-size (layout-set-staff-size custom-size)))
-}
-
 TEXT = \markuplist {
   \override #`(transposition . ,TRANSPOSITION)
   \override #`(verselayout . ,verselayout)
@@ -70,11 +67,6 @@ TEXT = \markuplist {
     \score {
       \unfoldRepeats { \MUSIC \INLINESCOREMUSIC }
       \midi {
-        \context {
-          \Score
-          % Tempo des midi files
-          tempoWholesPerMinute = #(/ midiQuarterNoteSpeed 4)
-        }
         \context {
           \Staff
           \remove "Staff_performer"