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  '(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   '())
 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  'instrument-specific-markup-interface
 112  "Instrument-specific markup (like fret boards or harp pedal diagrams)."
 113  '(fret-diagram-details graphical harp-pedal-details size thickness))
 114
 115 (ly:add-interface
 116  'key-cancellation-interface
 117  "A key cancellation."
 118  '())
 119
 120 (ly:add-interface
 121  'ligature-bracket-interface
 122  "A bracket indicating a ligature in the original edition."
 123  '(width thickness height))
 124
 125 (ly:add-interface
 126  'ligature-interface
 127  "A ligature."
 128  '())
 129
 130 (ly:add-interface
 131  'lyric-interface
 132  "Any object that is related to lyrics."
 133  '())
 134
 135 (ly:add-interface
 136  'lyric-syllable-interface
 137  "A single piece of lyrics."
 138  '())
 139
 140 (ly:add-interface
 141  'mark-interface
 142  "A rehearsal mark."
 143  '())
 144
 145 (ly:add-interface
 146  'metronome-mark-interface
 147  "A metronome mark."
 148  '())
 149
 150 (ly:add-interface
 151  'multi-measure-interface
 152  "Multi measure rest, and the text or number that is printed over it."
 153  '(bound-padding))
 154
 155 (ly:add-interface
 156  'note-name-interface
 157  "Note names."
 158  '())
 159
 160 (ly:add-interface
 161  'only-prebreak-interface
 162  "Kill this grob after the line breaking process."
 163  '())
 164
 165 (ly:add-interface
 166  'parentheses-interface
 167  "Parentheses for other objects."
 168  '(padding stencils))
 169
 170 (ly:add-interface
 171  'percent-repeat-interface
 172  "Beat, Double and single measure repeats."
 173  '(dot-negative-kern slash-negative-kern slope thickness))
 174
 175 (ly:add-interface
 176  'piano-pedal-interface
 177  "A piano pedal sign."
 178  '())
 179
 180 (ly:add-interface
 181  'piano-pedal-script-interface
 182  "A piano pedal sign, fixed size."
 183  '())
 184
 185 (ly:add-interface
 186  'pitched-trill-interface
 187  "A note head to indicate trill pitches."
 188  '(accidental-grob))
 189
 190 (ly:add-interface
 191  'rhythmic-grob-interface
 192  "Any object with a duration.  Used to determine which grobs are
 193 interesting enough to maintain a hara-kiri staff."
 194  '())
 195
 196 (ly:add-interface
 197  'spacing-options-interface
 198  "Supports setting of spacing variables."
 199  '(spacing-increment shortest-duration-space))
 200
 201 (ly:add-interface
 202  'stanza-number-interface
 203  "A stanza number, to be put in from of a lyrics line."
 204  '())
 205
 206 (ly:add-interface
 207  'string-number-interface
 208  "A string number instruction."
 209  '())
 210
 211 (ly:add-interface
 212  'stroke-finger-interface
 213  "A right hand finger instruction."
 214  '(digit-names))
 215
 216 (ly:add-interface
 217  'system-start-text-interface
 218  "Text in front of the system."
 219  '(long-text self-alignment-X self-alignment-Y text))
 220
 221 (ly:add-interface
 222  'tab-note-head-interface
 223  "A note head in tablature."
 224  '(details display-cautionary span-start))
 225
 226 (ly:add-interface
 227  'trill-spanner-interface
 228  "A trill spanner."
 229  '())
 230
 231 (ly:add-interface
 232  'trill-pitch-accidental-interface
 233  "An accidental for trill pitch."
 234  '())
 235
 236 (ly:add-interface
 237  'unbreakable-spanner-interface
 238  "A spanner that should not be broken across line breaks.  Override
 239 with @code{breakable=##t}."
 240  '(breakable))
 241
 242 (ly:add-interface
 243  'volta-interface
 244  "A volta repeat."
 245  '())