Doc-es: update Programming interface.

[lilypond.git] / ly / engraver-init.ly

diff --git a/ly/engraver-init.ly b/ly/engraver-init.ly
index 92c8398f34c56ebeb95b30999664e2b51041f26b..d719d4a43ff9e2d0a3d8355c812540adc116a7ec 100644 (file)
--- a/ly/engraver-init.ly
+++ b/ly/engraver-init.ly
@@ -16,7 +16,7 @@
 %%%% You should have received a copy of the GNU General Public License
 %%%% along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 
 %%%% You should have received a copy of the GNU General Public License
 %%%% along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 

-\version "2.13.48"
+\version "2.14.0"

 
 \context {
   \name "Global"
 
 \context {
   \name "Global"


@@ -208,7 +208,6 @@ subscripts, slurs, ties, and rests.
 You have to instantiate this explicitly if you want to have
 multiple voices on the same staff."
 
 You have to instantiate this explicitly if you want to have
 multiple voices on the same staff."
 

-  localKeySignature = #'()

   \consists "Font_size_engraver"
 
   \consists "Pitched_trill_engraver"
   \consists "Font_size_engraver"
 
   \consists "Pitched_trill_engraver"


@@ -229,6 +228,7 @@ multiple voices on the same staff."
   \consists "Dots_engraver"
   \consists "Rest_engraver"
   \consists "Tweak_engraver"
   \consists "Dots_engraver"
   \consists "Rest_engraver"
   \consists "Tweak_engraver"

+  \consists "Footnote_engraver"

 
   %% switch on to make stem directions interpolate for the
   %% center line.
 
   %% switch on to make stem directions interpolate for the
   %% center line.


@@ -243,6 +243,7 @@ multiple voices on the same staff."
   \consists "New_fingering_engraver"
 
   \consists "Chord_tremolo_engraver"
   \consists "New_fingering_engraver"
 
   \consists "Chord_tremolo_engraver"

+  \consists "Double_percent_repeat_engraver"

   \consists "Percent_repeat_engraver"
   \consists "Slash_repeat_engraver"
   \consists "Part_combine_engraver"
   \consists "Percent_repeat_engraver"
   \consists "Slash_repeat_engraver"
   \consists "Part_combine_engraver"


@@ -322,6 +323,10 @@ contained staves are connected vertically."
 
   \defaultchild "Staff"
   \accepts "Staff"
 
   \defaultchild "Staff"
   \accepts "Staff"

+  \accepts "RhythmicStaff"
+  \accepts "DrumStaff"
+  \accepts "TabStaff"
+  \accepts "Lyrics"

   \accepts "FiguredBass"
   \accepts "Dynamics"
   \accepts "ChordNames"
   \accepts "FiguredBass"
   \accepts "Dynamics"
   \accepts "ChordNames"


@@ -393,6 +398,7 @@ a collection of staves, with a bracket in front and spanning bar lines."
   \consists "Text_engraver"
   \consists "Text_spanner_engraver"
   \consists "Axis_group_engraver"
   \consists "Text_engraver"
   \consists "Text_spanner_engraver"
   \consists "Axis_group_engraver"

+  \consists "Tweak_engraver"

 
   pedalSustainStrings = #'("Ped." "*Ped." "*")
   pedalUnaCordaStrings = #'("una corda" "" "tre corde")
 
   pedalSustainStrings = #'("Ped." "*Ped." "*")
   pedalUnaCordaStrings = #'("una corda" "" "tre corde")


@@ -415,9 +421,6 @@ centered between the staves surrounding this context."
 printing of a single line of lyrics."
 
   \name "Lyrics"
 printing of a single line of lyrics."
 
   \name "Lyrics"

-  instrumentName = #'()
-  shortInstrumentName = #'()
-

   \consists "Lyric_engraver"
   \consists "Extender_engraver"
   \consists "Hyphen_engraver"
   \consists "Lyric_engraver"
   \consists "Extender_engraver"
   \consists "Hyphen_engraver"


@@ -425,6 +428,7 @@ printing of a single line of lyrics."
   \consists "Instrument_name_engraver"
   \consists "Font_size_engraver"
   \consists "Hara_kiri_engraver"
   \consists "Instrument_name_engraver"
   \consists "Font_size_engraver"
   \consists "Hara_kiri_engraver"

+  searchForVoice = ##f

   %% explicitly set instrument, so it is not inherited from the parent
   instrumentName = #'()
   shortInstrumentName = #'()
   %% explicitly set instrument, so it is not inherited from the parent
   instrumentName = #'()
   shortInstrumentName = #'()


@@ -459,8 +463,18 @@ printing of a single line of lyrics."
   \description "A context for printing the names of notes."
   \consists "Axis_group_engraver"
 
   \description "A context for printing the names of notes."
   \consists "Axis_group_engraver"
 

-  % FIXME: not sure what the default should be here.
-  \override VerticalAxisGroup #'staff-affinity = #DOWN
+  \override VerticalAxisGroup #'staff-affinity = #UP
+  \override VerticalAxisGroup #'nonstaff-nonstaff-spacing =
+    #'((basic-distance . 0)
+       (minimum-distance . 2.8)
+       (padding . 0.2)
+       (stretchability . 0))
+  \override VerticalAxisGroup #'nonstaff-relatedstaff-spacing =
+    #'((basic-distance . 5.5)
+       (padding . 0.5)
+       (stretchability . 1))
+  \override VerticalAxisGroup
+    #'nonstaff-unrelatedstaff-spacing #'padding = 1.5

 
   \consists "Tie_engraver"
   \consists "Note_name_engraver"
 
   \consists "Tie_engraver"
   \consists "Note_name_engraver"


@@ -484,20 +498,6 @@ printing of a single line of lyrics."
   \override VerticalAxisGroup #'nonstaff-nonstaff-spacing #'padding = #0.5
 }
 
   \override VerticalAxisGroup #'nonstaff-nonstaff-spacing #'padding = #0.5
 }
 

-
-RemoveEmptyStaves = \with {
-  \remove "Axis_group_engraver"
-    % If RemoveEmptyStaves is called twice, two
-    % Hara_kiri_engravers would be added, which leads to a
-    % warning.
-    % This code makes sure that no previous Hara_kiri_engraver
-    % is left before adding a new one.
-  \remove "Hara_kiri_engraver"
-  \consists "Hara_kiri_engraver"
-  \override VerticalAxisGroup #'remove-empty = ##t
-}
-
-

 \context {
   \type "Score_engraver"
   \name "Score"
 \context {
   \type "Score_engraver"
   \name "Score"


@@ -543,6 +543,7 @@ automatically when an output definition (a @code{\score} or
   \accepts "VaticanaStaff"
   \accepts "GregorianTranscriptionStaff"
   \accepts "MensuralStaff"
   \accepts "VaticanaStaff"
   \accepts "GregorianTranscriptionStaff"
   \accepts "MensuralStaff"

+  \accepts "PetrucciStaff"

   \accepts "StaffGroup"
   \accepts "DrumStaff"
   \accepts "Lyrics"
   \accepts "StaffGroup"
   \accepts "DrumStaff"
   \accepts "Lyrics"


@@ -675,6 +676,7 @@ automatically when an output definition (a @code{\score} or
   graceSettings = #`(
     (Voice Stem direction ,UP)
     (Voice Stem font-size -3)
   graceSettings = #`(
     (Voice Stem direction ,UP)
     (Voice Stem font-size -3)

+    (Voice Flag font-size -3)

     (Voice NoteHead font-size -3)
     (Voice TabNoteHead font-size -4)
     (Voice Dots font-size -3)
     (Voice NoteHead font-size -3)
     (Voice TabNoteHead font-size -4)
     (Voice Dots font-size -3)


@@ -781,9 +783,8 @@ context."
   \remove "Accidental_engraver"
   %% make the Stems as short as possible to minimize their influence
   %% on the slur::calc-control-points routine
   \remove "Accidental_engraver"
   %% make the Stems as short as possible to minimize their influence
   %% on the slur::calc-control-points routine

-  \override Stem #'length = #0

   \override Stem #'no-stem-extend = ##t
   \override Stem #'no-stem-extend = ##t

-  \override Stem #'flag-style = #'no-flag
+  \override Flag #'style = #'no-flag

   \override Stem #'details = #'((lengths 0 0 0 0 0 0)
                                 (beamed-lengths 0 0 0)
                                 (beamed-minimum-free-lengths 0 0 0)
   \override Stem #'details = #'((lengths 0 0 0 0 0 0)
                                 (beamed-lengths 0 0 0)
                                 (beamed-minimum-free-lengths 0 0 0)


@@ -988,6 +989,7 @@ accommodated for typesetting a piece in mensural style."
   %% Set default head for notes outside of \[ \].
   \override NoteHead #'style = #'mensural
   \override Rest #'style = #'mensural
   %% Set default head for notes outside of \[ \].
   \override NoteHead #'style = #'mensural
   \override Rest #'style = #'mensural

+  \override Flag #'style = #'mensural

 
   %% There are no beams in mensural notation.
   autoBeaming = ##f
 
   %% There are no beams in mensural notation.
   autoBeaming = ##f


@@ -1038,6 +1040,60 @@ accommodated for typesetting a piece in mensural style."
   printKeyCancellation = ##f
 }
 
   printKeyCancellation = ##f
 }
 

+\context {
+  \Voice
+  \name "PetrucciVoice"
+  \alias "Voice"
+  \description "Same as @code{Voice} context, except that it is
+accommodated for typesetting a piece in Petrucci style."
+
+  \remove "Ligature_bracket_engraver"
+  \consists "Mensural_ligature_engraver"
+
+  %% Set glyph styles.
+  \override NoteHead #'style = #'petrucci
+  \override Rest #'style = #'mensural
+
+  % Thickens and shortens stems.
+  \override Stem #'thickness = #1.7
+  \override Stem #'length = #5
+
+  %% There are no beams in Petrucci notation.
+  autoBeaming = ##f
+}
+
+\context {
+  \Staff
+  \name "PetrucciStaff"
+  \alias "Staff"
+  \denies "Voice"
+  \defaultchild "PetrucciVoice"
+  \accepts "PetrucciVoice"
+  \description "Same as @code{Staff} context, except that it is
+accommodated for typesetting a piece in Petrucci style."
+
+  \consists "Custos_engraver"
+
+  \override StaffSymbol #'thickness = #1.3
+
+  %% Choose Petrucci g clef on 2nd line as default.
+  clefGlyph = #"clefs.petrucci.g"
+  middleCClefPosition = #-6
+  middleCPosition = #-6
+  clefPosition = #-2
+  clefOctavation = #0
+
+  \override Custos #'style = #'mensural
+  \override Custos #'neutral-position = #3
+  \override Custos #'neutral-direction = #DOWN
+
+  %% Accidentals are valid only once (if the following note is different)
+  extraNatural = ##f
+  autoAccidentals = #`(Staff ,(make-accidental-rule 'same-octave 0)
+                             ,neo-modern-accidental-rule)
+  autoCautionaries = #'()
+  printKeyCancellation = ##f
+}

 
 %% Keep the old definitions in here for compatibility (they erase previous
 %% settings to the corresponding context!).
 
 %% Keep the old definitions in here for compatibility (they erase previous
 %% settings to the corresponding context!).


@@ -1069,4 +1125,3 @@ RemoveEmptyTabStaffContext = \context {
   \TabStaff
   \RemoveEmptyStaves
 }
   \TabStaff
   \RemoveEmptyStaves
 }

-