scm/define-grob-interfaces.scm

   1 ;;;; This file is part of LilyPond, the GNU music typesetter.
   2 ;;;;
   3 ;;;; Copyright (C) 1998--2012  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
  38    length-fraction
  39    maximum-gap
  40    note-heads
  41    thickness))
  42
  43 (ly:add-interface
  44  'bar-line-interface
  45  "Print a special bar symbol.  It replaces the regular bar
  46 symbol with a special symbol.  The argument @var{bartype}
  47 is a string which specifies the kind of bar line to print.
  48
  49 The list of allowed glyphs and predefined bar lines can be
  50 found in @file{scm/bar-line.scm}.
  51
  52 @code{gap} is used for the gaps in dashed bar lines."
  53  '(allow-span-bar
  54    bar-extent
  55    gap
  56    glyph
  57    glyph-name
  58    hair-thickness
  59    has-span-bar
  60    kern
  61    rounded
  62    thin-kern
  63    thick-thickness))
  64
  65 (ly:add-interface
  66  'bass-figure-interface
  67  "A bass figure text."
  68  '(implicit))
  69
  70 (ly:add-interface
  71  'bass-figure-alignment-interface
  72  "Align a bass figure."
  73  '())
  74
  75 (ly:add-interface
  76  'bend-after-interface
  77  "A doit or drop."
  78  '(delta-position
  79    thickness))
  80
  81 (ly:add-interface
  82  'clef-modifier-interface
  83  "The number describing transposition of the clef, placed below
  84 or above clef sign. Usually this is 8 (octave transposition)
  85 or 15 (two octaves), but LilyPond allows any integer here."
  86  '())
  87
  88 (ly:add-interface
  89  'dynamic-interface
  90  "Any kind of loudness sign."
  91  '())
  92
  93 (ly:add-interface
  94  'dynamic-line-spanner-interface
  95  "Dynamic line spanner."
  96  '(avoid-slur))
  97
  98 (ly:add-interface
  99  'dynamic-text-interface
 100  "An absolute text dynamic."
 101  '(right-padding))
 102
 103 (ly:add-interface
 104  'dynamic-text-spanner-interface
 105  "Dynamic text spanner."
 106  '(text))
 107
 108 (ly:add-interface
 109  'episema-interface
 110  "An episema line."
 111  '())
 112
 113 (ly:add-interface
 114  'finger-interface
 115  "A fingering instruction."
 116  '())
 117
 118 (ly:add-interface
 119  'footnote-interface
 120  "Make a footnote."
 121  '(automatically-numbered
 122    footnote
 123    footnote-text
 124    numbering-assertion-function))
 125
 126 (ly:add-interface
 127  'footnote-spanner-interface
 128  "Make a footnote spanner."
 129  '(footnote-text
 130    spanner-placement))
 131
 132 (ly:add-interface
 133  'fret-diagram-interface
 134  "A fret diagram"
 135  '(align-dir
 136    dot-placement-list
 137    fret-diagram-details
 138    size
 139    thickness))
 140
 141 (ly:add-interface
 142  'glissando-interface
 143  "A glissando."
 144  '(glissando-index))
 145
 146 (ly:add-interface
 147  'grace-spacing-interface
 148  "Keep track of durations in a run of grace notes."
 149  '(columns
 150    common-shortest-duration))
 151
 152 (ly:add-interface
 153  'inline-accidental-interface
 154  "An inlined accidental (i.e. normal accidentals, cautionary
 155 accidentals)."
 156  '())
 157
 158 (ly:add-interface
 159  'instrument-specific-markup-interface
 160  "Instrument-specific markup (like fret boards or harp pedal diagrams)."
 161  '(fret-diagram-details graphical harp-pedal-details size thickness))
 162
 163 (ly:add-interface
 164  'key-cancellation-interface
 165  "A key cancellation."
 166  '())
 167
 168 (ly:add-interface
 169  'ligature-head-interface
 170  "A note head that can become part of a ligature."
 171  '())
 172
 173 (ly:add-interface
 174  'ligature-bracket-interface
 175  "A bracket indicating a ligature in the original edition."
 176  '(width thickness height))
 177
 178 (ly:add-interface
 179  'ligature-interface
 180  "A ligature."
 181  '())
 182
 183 (ly:add-interface
 184  'lyric-interface
 185  "Any object that is related to lyrics."
 186  '())
 187
 188 (ly:add-interface
 189  'lyric-syllable-interface
 190  "A single piece of lyrics."
 191  '())
 192
 193 (ly:add-interface
 194  'mark-interface
 195  "A rehearsal mark."
 196  '())
 197
 198 (ly:add-interface
 199  'measure-counter-interface
 200  "A counter for numbering measures."
 201  '(columns
 202    count-from))
 203
 204 (ly:add-interface
 205  'metronome-mark-interface
 206  "A metronome mark."
 207  '())
 208
 209 (ly:add-interface
 210  'multi-measure-interface
 211  "Multi measure rest, and the text or number that is printed over it."
 212  '(bound-padding))
 213
 214 (ly:add-interface
 215  'note-name-interface
 216  "Note names."
 217  '())
 218
 219 (ly:add-interface
 220  'only-prebreak-interface
 221  "Kill this grob after the line breaking process."
 222  '())
 223
 224 (ly:add-interface
 225  'parentheses-interface
 226  "Parentheses for other objects."
 227  '(padding
 228    stencils))
 229
 230 (ly:add-interface
 231  'percent-repeat-interface
 232  "Beat, Double and single measure repeats."
 233  '(dot-negative-kern
 234    slash-negative-kern
 235    slope
 236    thickness))
 237
 238 (ly:add-interface
 239  'piano-pedal-interface
 240  "A piano pedal sign."
 241  '())
 242
 243 (ly:add-interface
 244  'piano-pedal-script-interface
 245  "A piano pedal sign, fixed size."
 246  '())
 247
 248 (ly:add-interface
 249  'pitched-trill-interface
 250  "A note head to indicate trill pitches."
 251  '(accidental-grob))
 252
 253 (ly:add-interface
 254  'rhythmic-grob-interface
 255  "Any object with a duration.  Used to determine which grobs are
 256 interesting enough to maintain a hara-kiri staff."
 257  '())
 258
 259 (ly:add-interface
 260  'spacing-options-interface
 261  "Supports setting of spacing variables."
 262  '(spacing-increment
 263    shortest-duration-space))
 264
 265 (ly:add-interface
 266  'span-bar-interface
 267  "A bar line that is spanned between other barlines.
 268   This interface is used for bar lines that connect different
 269   staves."
 270  '(glyph-name
 271    elements
 272    pure-Y-common
 273    pure-relevant-grobs
 274    pure-relevant-items
 275    pure-relevant-spanners))
 276
 277 (ly:add-interface
 278  'stanza-number-interface
 279  "A stanza number, to be put in from of a lyrics line."
 280  '())
 281
 282 (ly:add-interface
 283  'string-number-interface
 284  "A string number instruction."
 285  '())
 286
 287 (ly:add-interface
 288  'stroke-finger-interface
 289  "A right hand finger instruction."
 290  '(digit-names))
 291
 292 (ly:add-interface
 293  'system-start-text-interface
 294  "Text in front of the system."
 295  '(long-text
 296    self-alignment-X
 297    self-alignment-Y
 298    text))
 299
 300 (ly:add-interface
 301  'tab-note-head-interface
 302  "A note head in tablature."
 303  '(details display-cautionary span-start))
 304
 305 (ly:add-interface
 306  'trill-spanner-interface
 307  "A trill spanner."
 308  '())
 309
 310 (ly:add-interface
 311  'trill-pitch-accidental-interface
 312  "An accidental for trill pitch."
 313  '())
 314
 315 (ly:add-interface
 316  'unbreakable-spanner-interface
 317  "A spanner that should not be broken across line breaks.  Override
 318 with @code{breakable=##t}."
 319  '(breakable))
 320
 321 (ly:add-interface
 322  'volta-interface
 323  "A volta repeat."
 324  '())