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 '(VerticalExtent MinimumVerticalExtent ExtraVerticalExtent)
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.
117 The markings @emph{a2}, @emph{Solo} and @emph{Solo II}, are
118 created by this engraver. It also acts upon instructions of the part
119 combiner. Another thing that the this engraver, is forcing of stem,
120 slur and tie directions, always when both threads are not identical;
121 up for the musicexpr called @code{one}, down for the musicexpr called
141 'Align_note_column_engraver
142 (engraver-description
143 "Align_note_column_engraver"
144 "Generate object to put grace notes from left to right."
154 (engraver-description
156 "Generate an Arpeggio from a Arpeggio_req"
163 (engraver-description
165 "Generate beams based on measure characteristics and observed
166 Stems. Uses beatLength, measureLength and measurePosition to decide
167 when to start and stop a beam. Overriding beaming is done through
168 @ref{Stem_engraver} properties stemLeftBeamCount and
179 (engraver-description
181 "Create barlines. This engraver is controlled through the
182 @code{whichBar} property. If it has no bar line to create, it will forbid a linebreak at this point"
192 (engraver-description
193 "Bar_number_engraver"
194 "A bar number is created whenever measurePosition is zero. It is
195 put on top of all staffs, and appears only at left side of the staff."
204 (engraver-description
206 "Handles Beam_requests by engraving Beams. If omitted, then notes will be
207 printed with flags instead of beams."
214 'Break_align_engraver
215 (engraver-description
216 "Break_align_engraver"
217 "Align grobs with corresponding break-align-symbols into groups, and order the groups according to breakAlignOrder"
218 '(BreakAlignment BreakAlignGroup LeftEdge)
226 'Breathing_sign_engraver
227 (engraver-description
228 "Breathing_sign_engraver"
237 (engraver-description
238 "Chord_name_engraver"
239 "Catch Note_req's, Tonic_reqs, Inversion_reqs, Bass_req
240 and generate the appropriate chordname."
246 'Chord_tremolo_engraver
247 (engraver-description
248 "Chord_tremolo_engraver"
249 "Generates beams for the \repeat X tremolo ... construct"
258 (engraver-description
268 (engraver-description
278 (engraver-description
279 "Dot_column_engraver"
280 " Engraves dots on dotted notes shifted to the right of the note.
281 If omitted, then dots appear on top of the notes.
291 (engraver-description
304 'Grace_position_engraver
305 (engraver-description
306 "Grace_position_engraver"
307 "Attach a grace note alignment to a note-column "
313 'Grace_engraver_group
314 (engraver-description
315 "Grace_engraver_group"
316 "An engraver that creates a `shielded' context-tree with separate notion of time"
323 'Instrument_name_engraver
324 (engraver-description
325 "Instrument_name_engraver"
326 " Prints the name of the instrument (specified by
327 @code{Staff.instrument} and @code{Staff.instr}) at the left of the
336 'Engraver_group_engraver
337 (engraver-description
338 "Engraver_group_engraver"
339 "A group of engravers taken together"
346 (engraver-description
351 '( keySignature explicitKeySignatureVisibility createKeyOnClefChange keyAccidentalOrder keySignature )))
353 (cons 'Lyric_engraver
354 (engraver-description
362 (cons 'Lyric_phrasing_engraver
363 (engraver-description
364 "Lyric_phrasing_engraver"
377 (engraver-description
390 (engraver-description
404 'Multi_measure_rest_engraver
405 (engraver-description
406 "Multi_measure_rest_engraver"
407 "Engraves multi-measure rests that are produced with @code{R}. Reads
408 measurePosition and currentBarNumber to determine what number to print over the MultiMeasureRest
411 '(currentBarNumber currentCommandColumn measurePosition
416 (engraver-description
417 "Note_heads_engraver"
418 "Generate one or more noteheads from Music of type Note_req."
424 'Note_head_line_engraver
425 (engraver-description
426 "Note_head_line_engraver"
427 "Engrave a line between two note heads, for example a glissando.
428 If followVoice is set, staff switches also generate a line."
429 '(Glissando VoiceFollower)
434 (engraver-description
443 'Output_property_engraver
444 (engraver-description
445 "Output_property_engraver"
446 "Interpret Music of Output_property type, and apply a function
447 to any Graphic objects that satisfies the predicate."
454 'Piano_pedal_engraver
455 (engraver-description
456 "Piano_pedal_engraver"
457 "Engrave piano pedal symbols."
458 '(SostenutoPedal SustainPedal UnaCordaPedal)
459 '(pedalSostenutoStrings pedalSustainStrings pedalUnaCordaStrings
463 'Pitch_squash_engraver
464 (engraver-description
465 "Pitch_squash_engraver"
466 "Treat all pitches as middle C. Note that the notes move, but
467 the locations of accidentals stay the same.
468 Set the position field of all note heads to zero. This useful for
469 making a single line staff that demonstrates the rhythm of a melody."
477 (engraver-description
479 "This is a engraver that converts \property settings into
480 back-end grob-property settings. Example: Voice.stemLength will set
481 #'length in all Stem objects.
483 Due to CPU and memory requirements, the use of this engraver is deprecated."
485 '(Generic_property_list)
490 'Repeat_acknowledge_engraver
491 (engraver-description
492 "Repeat_acknowledge_engraver"
494 "Acknowledge repeated music, and convert the contents of
495 repeatCommands ainto an appropriate setting for whichBar"
505 'Rest_collision_engraver
506 (engraver-description
507 "Rest_collision_engraver"
508 "Handles collisions of rests."
516 (engraver-description
525 'Rhythmic_column_engraver
526 (engraver-description
527 "Rhythmic_column_engraver"
528 "Generates NoteColumn, an objects that groups stems, noteheads and rests."
535 'Script_column_engraver
536 (engraver-description
537 "Script_column_engraver"
546 (engraver-description
548 " Handles note ornaments generated by @code{\script}.
558 (engraver-description
560 "Top level engraver. Takes care of generating columns and the complete system (ie. LineOfScore)
562 This engraver decides whether a column is breakable. The default is
563 that a column is always breakable. However, when every Bar_engraver
564 that does not have a barline at a certain point will call
565 Score_engraver::forbid_breaks to stop linebreaks. In practice, this
566 means that you can make a breakpoint by creating a barline (assuming
567 that there are no beams or notes that prevent a breakpoint.)
570 '(LineOfScore PaperColumn NonMusicalPaperColumn)
576 (cons 'Skip_req_swallow_translator
577 (engraver-description
578 "Skip_req_swallow_translator"
587 (engraver-description
589 "Build slurs from Slur_reqs"
601 (engraver-description
603 "make a SpacingSpanner and do bookkeeping of shortest starting and playing notes "
610 'Span_arpeggio_engraver
611 (engraver-description
612 "Span_arpeggio_engraver"
622 (engraver-description
624 "This engraver makes cross-staff barlines: It catches all normal
625 bar lines, and draws a single span-bar across them."
633 'Staff_symbol_engraver
634 (engraver-description
635 "Staff_symbol_engraver"
636 "create the constellation of five (default) staff lines."
643 'Stanza_number_engraver
644 (engraver-description
645 "Stanza_number_engraver"
657 'System_start_delimiter_engraver
658 (engraver-description
659 "System_start_delimiter_engraver"
660 "creates a SystemStartDelimiter spanner"
661 '(SystemStartDelimiter)
668 (engraver-description
670 "Create text-scripts"
679 'Text_spanner_engraver
680 (engraver-description
681 "Text_spanner_engraver"
682 "Create text spanner from a Span_req "
689 'Thread_devnull_engraver
690 (engraver-description
691 "Thread_devnull_engraver"
692 "Kill elements whenever we are Voice called `two' and either
693 unison, unisilence or soloADue is set.@footnote{On unix systems, the
694 file @file{/dev/null} is special device: anything written to it is
695 discarded.}. This engraver works closely together with the part
696 combiner. When the part combiner notices that two threads are
697 identical, it tells the @code{Thread_devnull_engraver} to discard
698 everything in the second thread.
707 (engraver-description
709 "Generate ties between noteheads of equal pitch."
717 'Time_signature_engraver
718 (engraver-description
719 "Time_signature_engraver"
720 "Create a TimeSignature whenever @code{timeSignatureFraction} changes"
728 (engraver-description
730 " Responsible for synchronizing timing information from staffs.
731 Normally in @code{Score}. In order to create polyrhythmic music,
732 this engraver should be removed from @code{Score} and placed in
736 timeSignatureFraction
737 barCheckNoSynchronize
753 (engraver-description
755 "Catch Time_scaled_music and generate appropriate bracket "
757 '(tupletNumberFormatFunction tupletSpannerDuration tupletInvisible)))
761 'Vertical_align_engraver
762 (engraver-description
763 "Vertical_align_engraver"
764 "Catch Vertical axis groups and stack them."
771 'Voice_devnull_engraver
772 (engraver-description
773 "Voice_devnull_engraver"
774 "Kill off certain items and spanners if we're Voice `two' and unison or unisilence is set."
781 (set! engraver-description-alist
782 (sort engraver-description-alist alist<?))
784 (define context-description-alist
787 The context for handling grace notes. It is instantiated
788 automatically when you use @code{\grace}. Basically, it is an
789 `embedded' miniature of the Score context. Since this context
790 needs special interaction with the rest of LilyPond, you should
791 not explicitly instantiate it.
794 Corresponds to a voice with lyrics. Handles the printing of a
795 single line of lyrics.
798 Handles note heads, and is contained in the Voice context. You
799 have to instantiate this explicitly if you want to adjust the
800 style of individual note heads.
803 Corresponds to a voice on a staff. This context handles the
804 conversion of dynamic signs, stems, beams, super- and subscripts,
805 slurs, ties, and rests.
807 You have to instantiate this explicitly if you want to have
808 multiple voices on the same staff.")
811 A voice with chord names. Handles printing of a line of chord
815 Typesets chord names. Can contain @code{ChordNamesVoice}
819 Typesets lyrics. It can contain @code{LyricsVoice} contexts.
822 Handles clefs, bar lines, keys, accidentals. It can contain
823 @code{Voice} contexts.
826 A context like @code{Staff} but for printing rhythms. Pitches are
827 ignored; the notes are printed on one line. It can contain
828 @code{Voice} contexts.
831 Contains @code{Staff} or @code{RhythmicStaff} contexts. It adds a
832 brace on the left side, grouping the staffs together. The bar
833 lines of the contained staffs are connected vertically. It can
834 contain @code{Staff} contexts.")
837 Just like @code{GrandStaff} but with @code{minVerticalAlign} set
838 equal to @code{maxVerticalAlign} so that interstaff beaming and
839 slurring can be used.")
842 Contains @code{Staff} or @code{RhythmicStaff} contexts. Adds a
843 bracket on the left side, grouping the staffs together. The bar
844 lines of the contained staffs are connected vertically. It can
845 contain @code{Staff}, @code{RhythmicStaff}, @code{GrandStaff}, or
846 @code{Lyrics} contexts.
849 Identical to @code{StaffGroup} except that the contained staffs
850 are not connected vertically.
853 This is the top level notation context. No other context can
854 contain a @code{Score} context. This context handles the
855 administration of time signatures. It also makes sure that items
856 such as clefs, time signatures, and key-signatures are aligned
857 across staffs. It can contain @code{Lyrics}, @code{Staff},
858 @code{RhythmicStaff}, @code{GrandStaff}, @code{StaffGroup}, and
859 @code{ChoirStaff} contexts.
861 You cannot explicitly instantiate a Score context (since it is
862 not contained in any other context). It is instantiated
863 automatically when an output definition (a @code{\score} or
864 @code{\paper} block) is processed.
869 (set! context-description-alist
870 (sort context-description-alist alist<?))