* lily/smobs.cc (protect_smob): switch off fancy smob protection

[lilypond.git] / scm / define-context-properties.scm

diff --git a/scm/define-context-properties.scm b/scm/define-context-properties.scm
index 641376fde65a59a0cbacf53523d1369d61b712f2..caaa39c704458bb0b532f0949bbfdb3adba2596c 100644 (file)
--- a/scm/define-context-properties.scm
+++ b/scm/define-context-properties.scm
@@ -2,7 +2,7 @@
 ;;;;
 ;;;;  source file of the GNU LilyPond music typesetter
 ;;;; 
 ;;;;
 ;;;;  source file of the GNU LilyPond music typesetter
 ;;;; 

-;;;; (c) 1998--2005  Han-Wen Nienhuys <hanwen@cs.uu.nl>
+;;;; (c) 1998--2006  Han-Wen Nienhuys <hanwen@cs.uu.nl>

 ;;;;                  Jan Nieuwenhuizen <janneke@gnu.org>
 
 
 ;;;;                  Jan Nieuwenhuizen <janneke@gnu.org>
 
 


@@ -32,6 +32,8 @@
                                 "If true, then the accidentals are aligned in bass figure context.")
 
      (allowBeamBreak ,boolean? "If true allow line breaks for beams over bar lines.")
                                 "If true, then the accidentals are aligned in bass figure context.")
 
      (allowBeamBreak ,boolean? "If true allow line breaks for beams over bar lines.")

+     (allowPageTurn ,pair? "In the form (moment-start . penalty). Allow a page turn
+at the most recent breakpoint if it was after moment-start.")

      (associatedVoice ,string? "Name of the
 @code{Voice} that has the melody for this @code{Lyrics} line.")
      (autoBeamSettings ,list? "Specifies
      (associatedVoice ,string? "Name of the
 @code{Voice} that has the melody for this @code{Lyrics} line.")
      (autoBeamSettings ,list? "Specifies


@@ -108,7 +110,7 @@ for the down staff of PianoStaff. Used by @code{\\autochange}")
      (trebleStaffProperties ,list? "Alist of property settings to apply
 for the up staff of PianoStaff. Used by @code{\\autochange}")
 
      (trebleStaffProperties ,list? "Alist of property settings to apply
 for the up staff of PianoStaff. Used by @code{\\autochange}")
 

-     (newFiguredBassFormatter ,procedure? "Routine generating a markup
+     (figuredBassFormatter ,procedure? "Routine generating a markup

 for a bass figure.")
      (bassFigureFormatFunction ,procedure? "Procedure that is called
 to produce the formatting for a @code{BassFigure} grob. It takes a
 for a bass figure.")
      (bassFigureFormatFunction ,procedure? "Procedure that is called
 to produce the formatting for a @code{BassFigure} grob. It takes a


@@ -122,7 +124,7 @@ list of @code{BassFigureEvent}s, a context, and the grob to format.")
 
 
      (middleCPosition ,number? "Place of the middle C, measured in half
 
 
      (middleCPosition ,number? "Place of the middle C, measured in half

-staffspaces.  Usually determined by looking at @code{clefPosition} and
+staff-spaces.  Usually determined by looking at @code{clefPosition} and

 @code{clefGlyph}.")
 
      (chordNameFunction ,procedure?
 @code{clefGlyph}.")
 
      (chordNameFunction ,procedure?


@@ -210,6 +212,8 @@ another non-natural.")
 
 
      (figuredBassCenterContinuations ,boolean? "Whether to vertically center pairs of extender lines.")
 
 
      (figuredBassCenterContinuations ,boolean? "Whether to vertically center pairs of extender lines.")

+     (figuredBassPlusDirection ,ly:dir? "Where to put plus signs relative to the the main figure.")
+     

      (figuredBassAlterationDirection ,ly:dir? "Where to put
 alterations relative to the main figure.")
      (followVoice ,boolean? "If set, note heads are tracked across staff
      (figuredBassAlterationDirection ,ly:dir? "Where to put
 alterations relative to the main figure.")
      (followVoice ,boolean? "If set, note heads are tracked across staff


@@ -218,6 +222,8 @@ switches by a thin line")
      (fontSize ,number?
               "The relative size of all grobs in a context. ")
 
      (fontSize ,number?
               "The relative size of all grobs in a context. ")
 

+     (forbidBreak ,boolean? "If set to ##t, prevent a line break at this point.")
+

      (fingeringOrientations ,list?
                            "List of symbols, containing
 @samp{left}, @samp{right}, @samp{up} and/or @samp{down}. This list
      (fingeringOrientations ,list?
                            "List of symbols, containing
 @samp{left}, @samp{right}, @samp{up} and/or @samp{down}. This list


@@ -232,6 +238,8 @@ for the full staff.")
      (gridInterval ,ly:moment?
                   "Interval for which to generate @ref{GridPoint}s")
 
      (gridInterval ,ly:moment?
                   "Interval for which to generate @ref{GridPoint}s")
 

+     (hairpinToBarline ,boolean? "If set, end a hairpin at the barline before the ending note.")
+     

      (harmonicAccidentals ,boolean? "If set, harmonic notes in chords
 get accidentals.")
      (highStringOne ,boolean? "Whether the 1st string is the string with
      (harmonicAccidentals ,boolean? "If set, harmonic notes in chords
 get accidentals.")
      (highStringOne ,boolean? "Whether the 1st string is the string with


@@ -244,9 +252,9 @@ selector for tab notation.")
      (implicitBassFigures ,list? "List of bass figures that are not
 printed as numbers, but only as extender lines.")
      
      (implicitBassFigures ,list? "List of bass figures that are not
 printed as numbers, but only as extender lines.")
      

-     (instr ,markup? "See @code{instrument}")

 
 

-     (instrument ,markup? "The name to print left of a staff.  The
+     (instrumentCueName ,markup? "Name to print if another instrument is to be taken.")
+     (instrumentName ,markup? "The name to print left of a staff.  The

 @code{instrument} property labels the staff in the first system, and
 the @code{instr} property labels following lines.")
      (instrumentEqualizer ,procedure? "
 @code{instrument} property labels the staff in the first system, and
 the @code{instr} property labels following lines.")
      (instrumentEqualizer ,procedure? "


@@ -257,7 +265,7 @@ the instrument. Its value is the pitch that sounds like middle C. This
 is used to transpose the MIDI output, and @code{\\quote}s.")
 
      (keepAliveInterfaces ,list? "List of symbols, signifying grob interfaces that
 is used to transpose the MIDI output, and @code{\\quote}s.")
 
      (keepAliveInterfaces ,list? "List of symbols, signifying grob interfaces that

-are worth keeping a RemoveEmptyStaff staff around for.")   
+are worth keeping an staff with @code{remove-empty} set around for.")   

      (keyAlterationOrder ,list? " Alist that defines in what order
 alterations should be printed.  The format is (@var{step}
 . @var{alter}), where @var{step} is from 0 .. 6 and @var{alter} from
      (keyAlterationOrder ,list? " Alist that defines in what order
 alterations should be printed.  The format is (@var{step}
 . @var{alter}), where @var{step} is from 0 .. 6 and @var{alter} from


@@ -269,7 +277,6 @@ containing (@var{name} . @var{alter}) or ((@var{octave} . @var{name}) . @var{alt
  where @var{name} is from 0.. 6 and
 @var{alter} from -4 (double flat) to 4 (double sharp).
 ")
  where @var{name} is from 0.. 6 and
 @var{alter} from -4 (double flat) to 4 (double sharp).
 ")

-

      (majorSevenSymbol ,markup? "How should
 the major 7th be formatted in a chord name?")
      (markFormatter ,procedure? "Procedure
      (majorSevenSymbol ,markup? "How should
 the major 7th be formatted in a chord name?")
      (markFormatter ,procedure? "Procedure


@@ -301,6 +308,7 @@ markup.  Called with 2 arguments, event and context.")
 selects the highest string with a fret at least @code{minimumFret}")
      (minimumVerticalExtent ,number-pair? "minimum vertical extent, same
 format as @var{verticalExtent}")
 selects the highest string with a fret at least @code{minimumFret}")
      (minimumVerticalExtent ,number-pair? "minimum vertical extent, same
 format as @var{verticalExtent}")

+     (output ,ly:music-output? "The output produced by a score-level translator during music interpretation")

      (ottavation ,string? "If set, the text for an ottava spanner. Changing
 this creates a new text spanner. ")
      (pedalSustainStrings ,list? "List of string to print for
      (ottavation ,string? "If set, the text for an ottava spanner. Changing
 this creates a new text spanner. ")
      (pedalSustainStrings ,list? "List of string to print for


@@ -331,8 +339,11 @@ whether they are processed in this context.")
      (restNumberThreshold ,number?
                          "If a multimeasure rest has more measures
 than this, a number is printed. ")
      (restNumberThreshold ,number?
                          "If a multimeasure rest has more measures
 than this, a number is printed. ")

+     (revokePageTurns ,pair? "Signals to the paper-column-engraver to revoke (or increase the penalties for) all the page turns within a time interval. Used to disable page turns that occur within an unturnable volta repeat.")

      (shapeNoteStyles ,vector? "Vector of symbols, listing style for each note
 head relative to the tonic (qv.) of the scale.")
      (shapeNoteStyles ,vector? "Vector of symbols, listing style for each note
 head relative to the tonic (qv.) of the scale.")

+     (shortInstrumentName ,markup? "See @code{instrument}")
+     (shortVocalName ,markup? "Name of a vocal line, short version.")

      (skipBars ,boolean? "If set to true, then
 skip the empty bars that are produced by multimeasure notes and rests.
 These bars will not appear on the printed output.  If not set (the
      (skipBars ,boolean? "If set to true, then
 skip the empty bars that are produced by multimeasure notes and rests.
 These bars will not appear on the printed output.  If not set (the


@@ -342,9 +353,11 @@ with other voices is preserved.
 
 
 @example
 
 
 @example

-@@lilypond[fragment,verbatim,center]
-r1 r1*3 R1*3 \\\\property Score.skipBars= ##t r1*3 R1*3
-@@end lilypond
+@{
+r1 r1*3 R1*3
+\\set Score.skipBars= ##t
+r1*3 R1*3
+@}

 @end example
 ")
      (skipTypesetting ,boolean?
 @end example
 ")
      (skipTypesetting ,boolean?


@@ -376,6 +389,8 @@ one).")
 at beat positions by only drawing one beam over the beat.")
      (suggestAccidentals ,boolean? "If set, accidentals are typeset as cautionary suggestions over the note.")
 
 at beat positions by only drawing one beam over the beat.")
      (suggestAccidentals ,boolean? "If set, accidentals are typeset as cautionary suggestions over the note.")
 

+     (systemStartDelimiterHierarchy ,pair? "A nested list, indicating the nesting of a start delimiters.") 
+

      (systemStartDelimiter ,symbol? "Which grob to make for the start of
 the system/staff? Set to @code{SystemStartBrace},
 @code{SystemStartBracket} or @code{SystemStartBar}.")
      (systemStartDelimiter ,symbol? "Which grob to make for the start of
 the system/staff? Set to @code{SystemStartBrace},
 @code{SystemStartBracket} or @code{SystemStartBar}.")


@@ -398,25 +413,19 @@ Switch off for cadenzas.")
      (tremoloFlags ,integer? "Number of tremolo flags to add if no
 number is specified.")
 
      (tremoloFlags ,integer? "Number of tremolo flags to add if no
 number is specified.")
 

-     (tupletFullLength ,boolean? "If set, the tuplet is printed upto
+     (tupletFullLength ,boolean? "If set, the tuplet is printed up to

 the start of the next note.")
 the start of the next note.")

-     (tupletNumberFormatFunction
-      ,procedure?
-      "Function taking a music as input, producing a string. This function
-is called to determine the text to print on a tuplet bracket.")
-
+     (tupletFullLengthNote ,boolean? "If set, end at the next note, otherwise end on the matter (time sigs, etc.) before the note.")

      (tupletSpannerDuration ,ly:moment? "
 Normally a tuplet bracket is as wide as the
 @code{\\times} expression that gave rise to it.  By setting this
 property, you can make brackets last shorter.  Example
 
 @example
      (tupletSpannerDuration ,ly:moment? "
 Normally a tuplet bracket is as wide as the
 @code{\\times} expression that gave rise to it.  By setting this
 property, you can make brackets last shorter.  Example
 
 @example

-@@lilypond[verbatim,fragment]
-context Voice \\times 2/3 @{
-  property Voice.tupletSpannerDuration = #(ly:make-moment 1 4)
-  c-[8 c c-] c-[ c c-]
+@{
+\\set tupletSpannerDuration = #(ly:make-moment 1 4)
+\\times 2/3 @{ c8 c c c c c @}

 @}
 @}

-@@end lilypond

 @end example
 .")
 
 @end example
 .")
 


@@ -425,7 +434,7 @@ for repeated bass figures")
 
      (verticalExtent ,number-pair? "Hard coded vertical extent.  The format
 is a pair of dimensions, for example, this sets the sizes of a staff
 
      (verticalExtent ,number-pair? "Hard coded vertical extent.  The format
 is a pair of dimensions, for example, this sets the sizes of a staff

-to 10 (5+5) staffspaces high.
+to 10 (5+5) staff-spaces high.

 
 @example
 \\set Staff.verticalExtent = #'(-5.0 . 5.0)
 
 @example
 \\set Staff.verticalExtent = #'(-5.0 . 5.0)


@@ -440,7 +449,6 @@ context names whose vertical axis groups should be taken into account for
 vertical spacing of systems.")
      
      (vocalName ,markup? "Name of a vocal line.")
 vertical spacing of systems.")
      
      (vocalName ,markup? "Name of a vocal line.")

-     (vocNam ,markup? "Name of a vocal line, short version.")

 
      (voltaOnThisStaff ,boolean?
                       "Normally, volta brackets are put only on the
 
      (voltaOnThisStaff ,boolean?
                       "Normally, volta brackets are put only on the


@@ -464,6 +472,10 @@ Example:
 This will create a start-repeat bar in this staff only.
 Valid values are described in @internalsref{bar-line-interface}.
 ")
 This will create a start-repeat bar in this staff only.
 Valid values are described in @internalsref{bar-line-interface}.
 ")

+     (tempoWholesPerMinute 'ly:moment? "The tempo in whole notes per minute.")
+     (tempoUnitDuration 'ly:duration? "Unit for specifying tempo.")
+     (tempoUnitCount 'number? "Count for specifying tempo.")
+     

      )))
 
 (define-public all-internal-translation-properties
      )))
 
 (define-public all-internal-translation-properties