lily/chord-name-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1998--2014 Jan Nieuwenhuizen <janneke@gnu.org>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "chord-name.hh"
  21 #include "context.hh"
  22 #include "dimensions.hh"
  23 #include "engraver.hh"
  24 #include "font-interface.hh"
  25 #include "item.hh"
  26 #include "output-def.hh"
  27 #include "pitch.hh"
  28 #include "protected-scm.hh"
  29 #include "stream-event.hh"
  30 #include "text-interface.hh"
  31 #include "warn.hh"
  32
  33 #include "translator.icc"
  34
  35 class Chord_name_engraver : public Engraver
  36 {
  37   TRANSLATOR_DECLARATIONS (Chord_name_engraver);
  38 protected:
  39   void stop_translation_timestep ();
  40   void process_music ();
  41   virtual void finalize ();
  42   DECLARE_TRANSLATOR_LISTENER (note);
  43   DECLARE_TRANSLATOR_LISTENER (rest);
  44 private:
  45   Item *chord_name_;
  46   vector<Stream_event *> notes_;
  47
  48   Stream_event *rest_event_;
  49 };
  50
  51 void
  52 Chord_name_engraver::finalize ()
  53 {
  54 }
  55
  56 Chord_name_engraver::Chord_name_engraver ()
  57 {
  58   chord_name_ = 0;
  59   rest_event_ = 0;
  60 }
  61
  62 void
  63 Chord_name_engraver::process_music ()
  64 {
  65   if (!rest_event_ && !notes_.size ())
  66    return;
  67
  68   chord_name_ = make_item ("ChordName",
  69                            rest_event_ ? rest_event_->self_scm () : notes_[0]->self_scm ());
  70
  71   SCM maybe_markup = chord_name_->get_property_data ("text");
  72
  73   bool make_markup = !(Text_interface::is_markup (maybe_markup)
  74                        || ly_is_procedure (maybe_markup));
  75
  76   SCM markup;
  77
  78   if (rest_event_ && !make_markup) { }
  79   else if (rest_event_)
  80     {
  81       SCM no_chord_markup = get_property ("noChordSymbol");
  82       if (!Text_interface::is_markup (no_chord_markup))
  83         return;
  84       markup = no_chord_markup;
  85     }
  86   else
  87     {
  88       SCM bass = SCM_EOL;
  89       SCM inversion = SCM_EOL;
  90       SCM pitches = SCM_EOL;
  91
  92       Stream_event *inversion_event = 0;
  93       for (vsize i = 0; i < notes_.size (); i++)
  94         {
  95           Stream_event *n = notes_[i];
  96           SCM p = n->get_property ("pitch");
  97           if (!unsmob_pitch (p))
  98             continue;
  99
 100           if (n->get_property ("inversion") == SCM_BOOL_T)
 101             {
 102               inversion_event = n;
 103               inversion = p;
 104             }
 105           else if (n->get_property ("bass") == SCM_BOOL_T)
 106             bass = p;
 107           else
 108             pitches = scm_cons (p, pitches);
 109         }
 110
 111       if (inversion_event)
 112         {
 113           SCM oct = inversion_event->get_property ("octavation");
 114           if (scm_is_number (oct))
 115             {
 116               Pitch *p = unsmob_pitch (inversion_event->get_property ("pitch"));
 117               int octavation = scm_to_int (oct);
 118               Pitch orig = p->transposed (Pitch (-octavation, 0, 0));
 119
 120               pitches = scm_cons (orig.smobbed_copy (), pitches);
 121             }
 122           else
 123             programming_error ("inversion does not have original pitch");
 124         }
 125
 126       pitches = scm_sort_list (pitches, Pitch::less_p_proc);
 127
 128       SCM name_proc = get_property ("chordNameFunction");
 129       if (make_markup)
 130         markup = scm_call_4 (name_proc, pitches, bass, inversion,
 131                              context ()->self_scm ());
 132     }
 133   /*
 134     Ugh.
 135   */
 136   if (make_markup)
 137     chord_name_->set_property ("text", markup);
 138   else if (Text_interface::is_markup (maybe_markup))
 139     markup = maybe_markup;
 140
 141   SCM chord_changes = get_property ("chordChanges");
 142   SCM last_chord = get_property ("lastChord");
 143   if (to_boolean (chord_changes) && scm_is_pair (last_chord)
 144       && ly_is_equal (markup, last_chord))
 145     chord_name_->set_property ("begin-of-line-visible", SCM_BOOL_T);
 146
 147   context ()->set_property ("lastChord", markup);
 148 }
 149
 150 IMPLEMENT_TRANSLATOR_LISTENER (Chord_name_engraver, note);
 151 void
 152 Chord_name_engraver::listen_note (Stream_event *ev)
 153 {
 154   notes_.push_back (ev);
 155 }
 156
 157 IMPLEMENT_TRANSLATOR_LISTENER (Chord_name_engraver, rest);
 158 void
 159 Chord_name_engraver::listen_rest (Stream_event *ev)
 160 {
 161   ASSIGN_EVENT_ONCE (rest_event_, ev);
 162 }
 163
 164 void
 165 Chord_name_engraver::stop_translation_timestep ()
 166 {
 167   chord_name_ = 0;
 168   notes_.clear ();
 169   rest_event_ = 0;
 170 }
 171
 172 /*
 173   The READs description is not strictly accurate:
 174   which properties are read depend on the chord naming function active.
 175 */
 176 ADD_TRANSLATOR (Chord_name_engraver,
 177                 /* doc */
 178                 "Catch note and rest events and generate the appropriate chordname.",
 179
 180                 /* create */
 181                 "ChordName ",
 182
 183                 /* read */
 184                 "chordChanges "
 185                 "chordNameExceptions "
 186                 "chordNameFunction "
 187                 "chordNoteNamer "
 188                 "chordRootNamer "
 189                 "chordNameExceptions "
 190                 "lastChord "
 191                 "majorSevenSymbol "
 192                 "noChordSymbol ",
 193
 194                 /* write */
 195                 "lastChord "
 196                );