lily/lyric-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1997--2011 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5   Jan Nieuwenhuizen <janneke@gnu.org>
   6
   7   LilyPond is free software: you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation, either version 3 of the License, or
  10   (at your option) any later version.
  11
  12   LilyPond is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "context.hh"
  22 #include "engraver.hh"
  23 #include "item.hh"
  24 #include "note-head.hh"
  25 #include "stream-event.hh"
  26 #include "international.hh"
  27
  28 #include "translator.icc"
  29
  30 /**
  31    Generate texts for lyric syllables.  We only do one lyric at a time.
  32    Multiple copies of this engraver should be used to do multiple voices.
  33 */
  34 class Lyric_engraver : public Engraver
  35 {
  36 protected:
  37   void stop_translation_timestep ();
  38   void process_music ();
  39   DECLARE_TRANSLATOR_LISTENER (lyric);
  40
  41 public:
  42   TRANSLATOR_DECLARATIONS (Lyric_engraver);
  43
  44 private:
  45   Stream_event *event_;
  46   Item *text_;
  47   Item *last_text_;
  48
  49   Context *get_voice_context ();
  50 };
  51
  52 Lyric_engraver::Lyric_engraver ()
  53 {
  54   text_ = 0;
  55   last_text_ = 0;
  56   event_ = 0;
  57 }
  58
  59 IMPLEMENT_TRANSLATOR_LISTENER (Lyric_engraver, lyric);
  60 void
  61 Lyric_engraver::listen_lyric (Stream_event *ev)
  62 {
  63   ASSIGN_EVENT_ONCE (event_, ev);
  64 }
  65
  66 void
  67 Lyric_engraver::process_music ()
  68 {
  69   if (event_)
  70     {
  71       SCM text = event_->get_property ("text");
  72
  73       if (ly_is_equal (text, scm_from_locale_string (" ")))
  74         {
  75           if (last_text_)
  76             last_text_->set_property ("self-alignment-X",
  77                                       get_property ("lyricMelismaAlignment"));
  78         }
  79       else
  80         text_ = make_item ("LyricText", event_->self_scm ());
  81     }
  82
  83     Context *voice = get_voice_to_lyrics (context ());
  84     if (last_text_
  85         && voice
  86         && to_boolean (voice->get_property ("melismaBusy"))
  87         && !to_boolean (context ()->get_property ("ignoreMelismata")))
  88       last_text_->set_property ("self-alignment-X",
  89                                 get_property ("lyricMelismaAlignment"));
  90 }
  91
  92 Context *
  93 get_voice_to_lyrics (Context *lyrics)
  94 {
  95   SCM avc = lyrics->get_property ("associatedVoiceContext");
  96   if (Context *c = unsmob_context (avc))
  97     return c;
  98
  99   SCM voice_name = lyrics->get_property ("associatedVoice");
 100   string nm = lyrics->id_string ();
 101
 102   if (scm_is_string (voice_name))
 103     nm = ly_scm2string (voice_name);
 104   else if (nm == "")
 105     return 0;
 106   else
 107     {
 108       ssize idx = nm.rfind ('-');
 109       if (idx != NPOS)
 110         nm = nm.substr (0, idx);
 111     }
 112
 113   Context *parent = lyrics;
 114   Context *voice = 0;
 115   while (parent && !voice)
 116     {
 117       voice = find_context_below (parent, ly_symbol2scm ("Voice"), nm);
 118       parent = parent->get_parent_context ();
 119     }
 120
 121   if (voice)
 122     return voice;
 123
 124   parent = lyrics;
 125   voice = 0;
 126   while (parent && !voice)
 127     {
 128       voice = find_context_below (parent, ly_symbol2scm ("Voice"), "");
 129       parent = parent->get_parent_context ();
 130     }
 131
 132   return voice;
 133 }
 134
 135 Grob *
 136 get_current_note_head (Context *voice, bool include_grace_notes)
 137 {
 138   Moment now = voice->now_mom ();
 139   for (SCM s = voice->get_property ("busyGrobs");
 140        scm_is_pair (s); s = scm_cdr (s))
 141     {
 142       Grob *g = unsmob_grob (scm_cdar (s));;
 143       Moment *end_mom = unsmob_moment (scm_caar (s));
 144       if (!end_mom || !g)
 145         {
 146           programming_error ("busyGrobs invalid");
 147           continue;
 148         }
 149
 150       if (((end_mom->main_part_ > now.main_part_) ||
 151            (include_grace_notes && end_mom->grace_part_ > now.grace_part_))
 152           && dynamic_cast<Item *> (g)
 153           && Note_head::has_interface (g))
 154         {
 155           return g;
 156         }
 157     }
 158
 159   return 0;
 160 }
 161
 162 void
 163 Lyric_engraver::stop_translation_timestep ()
 164 {
 165   if (text_)
 166     {
 167       Context *voice = get_voice_to_lyrics (context ());
 168
 169       if (voice)
 170         {
 171           bool include_grace_notes = to_boolean (get_property ("includeGraceNotes"));
 172           Grob *head = get_current_note_head (voice, include_grace_notes);
 173
 174           if (head)
 175             {
 176               text_->set_parent (head, X_AXIS);
 177               if (melisma_busy (voice)
 178                   && !to_boolean (get_property ("ignoreMelismata")))
 179                 text_->set_property ("self-alignment-X",
 180                                      get_property ("lyricMelismaAlignment"));
 181             }
 182           else
 183             {
 184               text_->warning (_ ("Lyric syllable does not have note. Use \\lyricsto or associatedVoice."));
 185               text_->set_property ("X-offset", scm_from_int (0));
 186             }
 187         }
 188
 189       last_text_ = text_;
 190       text_ = 0;
 191     }
 192   event_ = 0;
 193 }
 194
 195 ADD_TRANSLATOR (Lyric_engraver,
 196                 /* doc */
 197                 "Engrave text for lyrics.",
 198
 199                 /* create */
 200                 "LyricText ",
 201
 202                 /* read */
 203                 "ignoreMelismata "
 204                 "includeGraceNotes "
 205                 "lyricMelismaAlignment ",
 206
 207                 /* write */
 208                 ""
 209                 );