scm/define-grob-interfaces.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 1998--2011  Han-Wen Nienhuys <hanwen@xs4all.nl>
   4 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
   5 ;;;;
   6 ;;;; LilyPond is free software: you can redistribute it and/or modify
   7 ;;;; it under the terms of the GNU General Public License as published by
   8 ;;;; the Free Software Foundation, either version 3 of the License, or
   9 ;;;; (at your option) any later version.
  10 ;;;;
  11 ;;;; LilyPond is distributed in the hope that it will be useful,
  12 ;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 ;;;; GNU General Public License for more details.
  15 ;;;;
  16 ;;;; You should have received a copy of the GNU General Public License
  17 ;;;; along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18
  19
  20 ;; The interfaces defined here generally have no code (e.g.,
  21 ;; dynamic-interface), or have callbacks defined entirely in
  22 ;; scheme.  Others interfaces are defined in lily/*.cc with the
  23 ;; ADD_INTERFACE function.
  24
  25 ;; should include default value?
  26
  27
  28 (ly:add-interface
  29  'accidental-suggestion-interface
  30  "An accidental, printed as a suggestion (typically: vertically over a
  31 note)."
  32  '())
  33
  34 (ly:add-interface
  35  'ambitus-interface
  36  "The line between note heads for a pitch range."
  37  '(gap note-heads thickness))
  38
  39 (ly:add-interface
  40  'bass-figure-interface
  41  "A bass figure text."
  42  '(implicit))
  43
  44 (ly:add-interface
  45  'bass-figure-alignment-interface
  46  "Align a bass figure."
  47  '())
  48
  49 (ly:add-interface
  50  'bend-after-interface
  51  "A doit or drop."
  52  '(thickness delta-position))
  53
  54 (ly:add-interface
  55  'dynamic-interface
  56  "Any kind of loudness sign."
  57  '())
  58
  59 (ly:add-interface
  60  'dynamic-line-spanner-interface
  61  "Dynamic line spanner."
  62  '(avoid-slur))
  63
  64 (ly:add-interface
  65  'dynamic-text-interface
  66  "An absolute text dynamic."
  67  '(right-padding))
  68
  69 (ly:add-interface
  70  'dynamic-text-spanner-interface
  71  "Dynamic text spanner."
  72  '(text))
  73
  74 (ly:add-interface
  75  'episema-interface
  76  "An episema line."
  77  '())
  78
  79 (ly:add-interface
  80  'finger-interface
  81  "A fingering instruction."
  82  '())
  83
  84 (ly:add-interface
  85  'footnote-interface
  86  "Make a footnote."
  87  '(automatically-numbered footnote-text))
  88
  89 (ly:add-interface
  90  'footnote-spanner-interface
  91  "Make a footnote spanner."
  92  '(footnote-text spanner-placement))
  93
  94 (ly:add-interface
  95  'fret-diagram-interface
  96  "A fret diagram"
  97  '(align-dir fret-diagram-details size dot-placement-list
  98    thickness))
  99
 100 (ly:add-interface
 101   'glissando-interface
 102   "A glissando."
 103   '(glissando-index))
 104
 105 (ly:add-interface
 106  'grace-spacing-interface
 107  "Keep track of durations in a run of grace notes."
 108  '(columns common-shortest-duration))
 109
 110 (ly:add-interface
 111  'inline-accidental-interface
 112  "An inlined accidental (i.e. normal accidentals, cautionary
 113 accidentals)."
 114  '())
 115
 116 (ly:add-interface
 117  'instrument-specific-markup-interface
 118  "Instrument-specific markup (like fret boards or harp pedal diagrams)."
 119  '(fret-diagram-details graphical harp-pedal-details size thickness))
 120
 121 (ly:add-interface
 122  'key-cancellation-interface
 123  "A key cancellation."
 124  '())
 125
 126 (ly:add-interface
 127  'ligature-head-interface
 128  "A note head that can become part of a ligature."
 129  '())
 130
 131 (ly:add-interface
 132  'ligature-bracket-interface
 133  "A bracket indicating a ligature in the original edition."
 134  '(width thickness height))
 135
 136 (ly:add-interface
 137  'ligature-interface
 138  "A ligature."
 139  '())
 140
 141 (ly:add-interface
 142  'lyric-interface
 143  "Any object that is related to lyrics."
 144  '())
 145
 146 (ly:add-interface
 147  'lyric-syllable-interface
 148  "A single piece of lyrics."
 149  '())
 150
 151 (ly:add-interface
 152  'mark-interface
 153  "A rehearsal mark."
 154  '())
 155
 156 (ly:add-interface
 157  'metronome-mark-interface
 158  "A metronome mark."
 159  '())
 160
 161 (ly:add-interface
 162  'multi-measure-interface
 163  "Multi measure rest, and the text or number that is printed over it."
 164  '(bound-padding))
 165
 166 (ly:add-interface
 167  'note-name-interface
 168  "Note names."
 169  '())
 170
 171 (ly:add-interface
 172  'only-prebreak-interface
 173  "Kill this grob after the line breaking process."
 174  '())
 175
 176 (ly:add-interface
 177  'parentheses-interface
 178  "Parentheses for other objects."
 179  '(padding stencils))
 180
 181 (ly:add-interface
 182  'percent-repeat-interface
 183  "Beat, Double and single measure repeats."
 184  '(dot-negative-kern slash-negative-kern slope thickness))
 185
 186 (ly:add-interface
 187  'piano-pedal-interface
 188  "A piano pedal sign."
 189  '())
 190
 191 (ly:add-interface
 192  'piano-pedal-script-interface
 193  "A piano pedal sign, fixed size."
 194  '())
 195
 196 (ly:add-interface
 197  'pitched-trill-interface
 198  "A note head to indicate trill pitches."
 199  '(accidental-grob))
 200
 201 (ly:add-interface
 202  'rhythmic-grob-interface
 203  "Any object with a duration.  Used to determine which grobs are
 204 interesting enough to maintain a hara-kiri staff."
 205  '())
 206
 207 (ly:add-interface
 208  'spacing-options-interface
 209  "Supports setting of spacing variables."
 210  '(spacing-increment shortest-duration-space))
 211
 212 (ly:add-interface
 213  'stanza-number-interface
 214  "A stanza number, to be put in from of a lyrics line."
 215  '())
 216
 217 (ly:add-interface
 218  'string-number-interface
 219  "A string number instruction."
 220  '())
 221
 222 (ly:add-interface
 223  'stroke-finger-interface
 224  "A right hand finger instruction."
 225  '(digit-names))
 226
 227 (ly:add-interface
 228  'system-start-text-interface
 229  "Text in front of the system."
 230  '(long-text self-alignment-X self-alignment-Y text))
 231
 232 (ly:add-interface
 233  'tab-note-head-interface
 234  "A note head in tablature."
 235  '(details display-cautionary span-start))
 236
 237 (ly:add-interface
 238  'trill-spanner-interface
 239  "A trill spanner."
 240  '())
 241
 242 (ly:add-interface
 243  'trill-pitch-accidental-interface
 244  "An accidental for trill pitch."
 245  '())
 246
 247 (ly:add-interface
 248  'unbreakable-spanner-interface
 249  "A spanner that should not be broken across line breaks.  Override
 250 with @code{breakable=##t}."
 251  '(breakable))
 252
 253 (ly:add-interface
 254  'volta-interface
 255  "A volta repeat."
 256  '())