2 (define (engraver-description name description created-elts properties)
3 (list name description created-elts properties)
7 (define engraver-description-alist
13 "Create stems and single-stem tremolos. It also works together with
14 the beam engraver for overriding beaming."
25 "Create lyric hyphens"
34 "Create lyric extenders"
41 'Separating_line_group_engraver
43 "Separating_line_group_engraver"
44 "Generates objects for computing spacing parameters."
45 '(SeparationItem SeparatingGroupSpanner)
53 "Group all objects created in this context in a VerticalAxisGroup spanner."
55 '(CONTEXTNAMEVerticalExtent CONTEXTNAMEMinimumVerticalExtent CONTEXTNAMExtraVerticalExtent)
62 "Like Axis_group_engraver, but make a hara kiri spanner, and add
63 interesting items (ie. note heads, lyric syllables and normal rests)"
64 '(HaraKiriVerticalGroup)
73 "Make accidentals. Catches note heads, ties and notices key-change
74 events. Due to interaction with ties (which don't come together
75 with note heads), this needs to be in a context higher than Tie_engraver.
92 '(repeatCommands voltaSpannerDuration)
99 "Determine and set reference point for pitches"
100 '(Clef OctavateEight)
106 explicitClefVisibility
113 (engraver-description
115 "Part combine engraver for orchestral scores."
131 'Align_note_column_engraver
132 (engraver-description
133 "Align_note_column_engraver"
134 "Generate object to put grace notes from left to right."
144 (engraver-description
146 "Generate an Arpeggio from a Arpeggio_req"
153 (engraver-description
155 "Generate beams based on measure characteristics and observed
156 Stems. Uses beatLength, measureLength and measurePosition to decide
157 when to start and stop a beam. Overriding beaming is done through
158 @ref{Stem_engraver} properties stemLeftBeamCount and
169 (engraver-description
171 "Create barlines. This engraver is controlled through the
172 @code{whichBar} property. If it has no bar line to create, it will forbid a linebreak at this point"
182 (engraver-description
183 "Bar_number_engraver"
184 "A bar number is created whenever measurePosition is zero. It is
185 put on top of all staffs, and appears only at left side of the staff."
194 (engraver-description
196 "Handles Beam_requests by engraving Beams. If omitted, then notes will be
197 printed with flags instead of beams."
204 'Break_align_engraver
205 (engraver-description
206 "Break_align_engraver"
207 "Align grobs with corresponding break-align-symbols into groups, and order the groups according to breakAlignOrder"
208 '(BreakAlignment BreakAlignGroup LeftEdge)
216 'Breathing_sign_engraver
217 (engraver-description
218 "Breathing_sign_engraver"
227 (engraver-description
228 "Chord_name_engraver"
229 "Catch Note_req's, Tonic_reqs, Inversion_reqs, Bass_req
230 and generate the appropriate chordname."
236 'Chord_tremolo_engraver
237 (engraver-description
238 "Chord_tremolo_engraver"
239 "Generates beams for the \repeat X tremolo ... construct"
248 (engraver-description
258 (engraver-description
268 (engraver-description
269 "Dot_column_engraver"
270 " Engraves dots on dotted notes shifted to the right of the note.
271 If omitted, then dots appear on top of the notes.
281 (engraver-description
294 'Grace_position_engraver
295 (engraver-description
296 "Grace_position_engraver"
297 "Attach a grace note alignment to a note-column "
303 'Grace_engraver_group
304 (engraver-description
305 "Grace_engraver_group"
306 "An engraver that creates a `shielded' context-tree with separate notion of time"
313 'Instrument_name_engraver
314 (engraver-description
315 "Instrument_name_engraver"
316 " Prints the name of the instrument (specified by
317 @code{Staff.instrument} and @code{Staff.instr}) at the left of the
326 'Engraver_group_engraver
327 (engraver-description
328 "Engraver_group_engraver"
329 "A group of engravers taken together"
336 (engraver-description
345 explicitKeySignatureVisibility
346 createKeyOnClefChange
351 (cons 'Lyric_engraver
352 (engraver-description
360 (cons 'Lyric_phrasing_engraver
361 (engraver-description
362 "Lyric_phrasing_engraver"
375 (engraver-description
388 (engraver-description
402 'Multi_measure_rest_engraver
403 (engraver-description
404 "Multi_measure_rest_engraver"
405 "Engraves multi-measure rests that are produced with @code{R}. Reads
406 measurePosition and currentBarNumber to determine what number to print over the MultiMeasureRest
414 (engraver-description
415 "Note_heads_engraver"
416 "Generate one or more noteheads from Music of type Note_req."
422 'Note_head_line_engraver
423 (engraver-description
424 "Note_head_line_engraver"
425 "Engrave a line between two note heads, for example a glissando.
426 If followThread is set, staff switches also generate a line."
427 '(Glissando FollowThread)
432 (engraver-description
441 'Output_property_engraver
442 (engraver-description
443 "Output_property_engraver"
444 "Interpret Music of Output_property type, and apply a function
445 to any Graphic objects that satisfies the predicate."
452 'Piano_pedal_engraver
453 (engraver-description
454 "Piano_pedal_engraver"
455 "Engrave piano pedal symbols."
456 '(SostenutoPedal SustainPedal UnaChordaPedal)
457 '(pedalSostenutoStrings pedalSustainStrings pedalUnaChordaStrings
461 'Pitch_squash_engraver
462 (engraver-description
463 "Pitch_squash_engraver"
464 "Treat all pitches as middle C. Note that the notes move, but
465 the locations of accidentals stay the same.
466 Set the position field of all note heads to zero. This useful for
467 making a single line staff that demonstrates the rhythm of a melody."
475 (engraver-description
477 "This is a engraver that converts \property settings into
478 back-end grob-property settings. Example: Voice.stemLength will set
479 #'length in all Stem objects.
481 Due to CPU and memory requirements, the use of this engraver is deprecated."
483 '(Generic_property_list)
488 'Repeat_acknowledge_engraver
489 (engraver-description
490 "Repeat_acknowledge_engraver"
492 "Acknowledge repeated music, and convert the contents of
493 repeatCommands ainto an appropriate setting for whichBar"
503 'Rest_collision_engraver
504 (engraver-description
505 "Rest_collision_engraver"
506 "Handles collisions of rests."
514 (engraver-description
523 'Rhythmic_column_engraver
524 (engraver-description
525 "Rhythmic_column_engraver"
526 "Generates NoteColumn, an objects that groups stems, noteheads and rests."
533 'Script_column_engraver
534 (engraver-description
535 "Script_column_engraver"
544 (engraver-description
546 " Handles note ornaments generated by @code{\script}.
556 (engraver-description
558 "Top level engraver. Takes care of generating columns and the complete system (ie. LineOfScore)
560 This engraver decides whether a column is breakable. The default is
561 that a column is always breakable. However, when every Bar_engraver
562 that does not have a barline at a certain point will call
563 Score_engraver::forbid_breaks to stop linebreaks. In practice, this
564 means that you can make a breakpoint by creating a barline (assuming
565 that there are no beams or notes that prevent a breakpoint.)
568 '(LineOfScore PaperColumn NonMusicalPaperColumn)
574 (cons 'Skip_req_swallow_translator
575 (engraver-description
576 "Skip_req_swallow_translator"
585 (engraver-description
587 "Build slurs from Slur_reqs"
599 (engraver-description
601 "make a SpacingSpanner and do bookkeeping of shortest starting and playing notes "
608 'Span_arpeggio_engraver
609 (engraver-description
610 "Span_arpeggio_engraver"
620 (engraver-description
622 "This engraver makes cross-staff barlines: It catches all normal
623 bar lines, and draws a single span-bar across them."
631 'Staff_symbol_engraver
632 (engraver-description
633 "Staff_symbol_engraver"
634 "create the constellation of five (default) staff lines."
641 'Stanza_number_engraver
642 (engraver-description
643 "Stanza_number_engraver"
655 'System_start_delimiter_engraver
656 (engraver-description
657 "System_start_delimiter_engraver"
658 "creates a SystemStartDelimiter spanner"
659 '(SystemStartDelimiter)
666 (engraver-description
668 "Create text-scripts"
677 'Text_spanner_engraver
678 (engraver-description
679 "Text_spanner_engraver"
680 "Create text spanner from a Span_req "
687 'Thread_devnull_engraver
688 (engraver-description
689 "Thread_devnull_engraver"
690 "Kill elements whenever we are Voice called `two' and
691 either unison, unisilence or soloADue is set"
698 (engraver-description
700 "Generate ties between noteheads of equal pitch."
708 'Time_signature_engraver
709 (engraver-description
710 "Time_signature_engraver"
711 "Create a TimeSignature whenever @code{timeSignatureFraction} changes"
719 (engraver-description
721 " Responsible for synchronizing timing information from staffs.
722 Normally in @code{Score}. In order to create polyrhythmic music,
723 this engraver should be removed from @code{Score} and placed in
727 timeSignatureFraction
728 barCheckNoSynchronize
744 (engraver-description
746 "Catch Time_scaled_music and generate appropriate bracket "
748 '(tupletNumberFormatFunction tupletSpannerDuration tupletInvisible)))
752 'Vertical_align_engraver
753 (engraver-description
754 "Vertical_align_engraver"
755 "Catch Vertical axis groups and stack them."
762 'Voice_devnull_engraver
763 (engraver-description
764 "Voice_devnull_engraver"
765 "Kill off certain items and spanners if we're Voice `two' and unison or unisilence is set."
772 (set! engraver-description-alist
773 (sort engraver-description-alist alist<?))
775 (define context-description-alist
778 The context for handling grace notes. It is instantiated
779 automatically when you use @code{\grace}. Basically, it is an
780 `embedded' miniature of the Score context. Since this context
781 needs special interaction with the rest of LilyPond, you should
782 not explicitly instantiate it.
785 Corresponds to a voice with lyrics. Handles the printing of a
786 single line of lyrics.
789 Handles note heads, and is contained in the Voice context. You
790 have to instantiate this explicitly if you want to adjust the
791 style of individual note heads.
794 Corresponds to a voice on a staff. This context handles the
795 conversion of dynamic signs, stems, beams, super- and subscripts,
796 slurs, ties, and rests.
798 You have to instantiate this explicitly if you want to have
799 multiple voices on the same staff.")
802 A voice with chord names. Handles printing of a line of chord
806 Typesets chord names. Can contain @code{ChordNamesVoice}
810 Typesets lyrics. It can contain @code{LyricsVoice} contexts.
813 Handles clefs, bar lines, keys, accidentals. It can contain
814 @code{Voice} contexts.
817 A context like @code{Staff} but for printing rhythms. Pitches are
818 ignored; the notes are printed on one line. It can contain
819 @code{Voice} contexts.
822 Contains @code{Staff} or @code{RhythmicStaff} contexts. It adds a
823 brace on the left side, grouping the staffs together. The bar
824 lines of the contained staffs are connected vertically. It can
825 contain @code{Staff} contexts.")
828 Just like @code{GrandStaff} but with @code{minVerticalAlign} set
829 equal to @code{maxVerticalAlign} so that interstaff beaming and
830 slurring can be used.")
833 Contains @code{Staff} or @code{RhythmicStaff} contexts. Adds a
834 bracket on the left side, grouping the staffs together. The bar
835 lines of the contained staffs are connected vertically. It can
836 contain @code{Staff}, @code{RhythmicStaff}, @code{GrandStaff}, or
837 @code{Lyrics} contexts.
840 Identical to @code{StaffGroup} except that the contained staffs
841 are not connected vertically.
844 This is the top level notation context. No other context can
845 contain a @code{Score} context. This context handles the
846 administration of time signatures. It also makes sure that items
847 such as clefs, time signatures, and key-signatures are aligned
848 across staffs. It can contain @code{Lyrics}, @code{Staff},
849 @code{RhythmicStaff}, @code{GrandStaff}, @code{StaffGroup}, and
850 @code{ChoirStaff} contexts.
852 You cannot explicitly instantiate a Score context (since it is
853 not contained in any other context). It is instantiated
854 automatically when an output definition (a @code{\score} or
855 @code{\paper} block) is processed.
860 (set! context-description-alist
861 (sort context-description-alist alist<?))