2 lyric-phrasing-engraver.hh -- declare Lyric_phrasing_engraver
4 source file of the GNU LilyPond music typesetter
6 (c) 2000 Glen Prideaux <glenprideaux@iname.com>
10 #ifndef LYRIC_PHRASING_ENGRAVER_HH
11 #define LYRIC_PHRASING_ENGRAVER_HH
13 #include "lily-proto.hh"
14 #include "engraver.hh"
17 #include "protected-scm.hh"
23 Align lyrics with noteheads, left aligning beginning of phrases,
24 right aligning end of phrases, centering others under their notes.
28 * Build an engraver that catches noteheads and lyrics.
30 (It needs to be in a context above Staff and Lyrics, eg. in Score
33 * Determine which heads belong to which lyrics
35 (eg. by looking at the names of their originating contexts, or maybe
38 * Attach the lyrics to the appropriate heads
40 (by doing lyric->set_parent (head, X_AXIS), that will fix the current
41 noteheadwidth guessing kludge)
43 * Check if the lyric syllables end or start a phrase.
45 (eg. check if the syllable ends with punctuation, and remember that
46 fact for the next one.)
48 * Adjust their alignment accordingly.
50 (eg. by doing lyric->add_offset_callback (centered_on_parent,X_AXIS)
51 and setting self-alignment-X)
53 * Add a property to switch on/off the engraver (for multi stanza
54 vs. single stanza music)
56 Maybe this engraver could also take care of correct lyric alignment
63 class Lyric_phrasing_engraver : public Engraver
66 virtual void acknowledge_grob (Grob_info);
67 virtual void process_acknowledged_grobs ();
68 virtual void stop_translation_timestep ();
69 virtual void finalize ();
71 void record_notehead (const String &context_id, Grob * notehead);
72 void record_lyric (const String &context_id, Grob * lyric);
73 void record_melisma (const String &context_id);
74 void record_extender (const String &context_id, Grob * extender);
75 Syllable_group * lookup_context_id (const String &context_id);
79 ~Lyric_phrasing_engraver ();
80 TRANSLATOR_DECLARATIONS( Lyric_phrasing_engraver);
83 /** association list of Syllable_group smobs
85 fixme: should use property.
88 Protected_scm voice_alist_;
95 bool first_in_phrase_b_;
97 Link_array<Grob> lyrics_;
98 Grob * longest_lyric_;
99 Grob * shortest_lyric_;
102 Real group_translation_;
104 static SCM make_entry ();
105 void set_first_in_phrase (bool f);
106 void set_notehead (Grob * notehead);
107 void add_lyric (Grob * lyric);
108 void add_extender (Grob * extender);
109 void set_melisma () { melisma_b_ = true; }
110 bool get_melisma () { return melisma_b_; }
111 int lyric_count () { return lyrics_.size (); }
114 bool set_lyric_align (const char *punc, Grob *default_notehead);
115 void adjust_melisma_align ();
116 int appropriate_alignment (const char *punc);
117 Real amount_to_translate ();
119 void copy (Syllable_group *);
122 DECLARE_SIMPLE_SMOBS (Syllable_group,);
125 DECLARE_UNSMOB(Syllable_group,voice_entry);
128 #endif // LYRIC_PHRASING_ENGRAVER_HH