]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/chord-name-engraver.cc
Fix whitespace of files in Documentation/misc.
[lilypond.git] / lily / chord-name-engraver.cc
index 133f91ae6423607948bcd85ff75da6376dac9507..eab4d94d075c52ef95f0ae09449d6d9d184585c5 100644 (file)
 /*
-  chord-name-engraver.cc -- implement Chord_name_engraver
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 1998--2012 Jan Nieuwenhuizen <janneke@gnu.org>
 
-  (c) 1998 Jan Nieuwenhuizen <janneke@gnu.org>
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-#include "chord-name-engraver.hh"
-#include "musical-request.hh"
-#include "text-item.hh"
-#include "paper-def.hh"
-#include "lookup.hh"
-#include "paper-def.hh"
-#include "main.hh"
+#include "chord-name.hh"
+#include "context.hh"
 #include "dimensions.hh"
+#include "engraver.hh"
+#include "font-interface.hh"
+#include "item.hh"
+#include "output-def.hh"
+#include "pitch.hh"
+#include "protected-scm.hh"
+#include "stream-event.hh"
+#include "text-interface.hh"
+#include "warn.hh"
+
+#include "translator.icc"
+
+class Chord_name_engraver : public Engraver
+{
+  TRANSLATOR_DECLARATIONS (Chord_name_engraver);
+protected:
+  void stop_translation_timestep ();
+  void process_music ();
+  virtual void finalize ();
+  virtual void derived_mark () const;
+  DECLARE_TRANSLATOR_LISTENER (note);
+  DECLARE_TRANSLATOR_LISTENER (rest);
+private:
+  Item *chord_name_;
+  vector<Stream_event *> notes_;
+
+  SCM last_chord_;
+  Stream_event *rest_event_;
+};
 
-ADD_THIS_TRANSLATOR (Chord_name_engraver);
-
-Chord_name_engraver::Chord_name_engraver ()
+void
+Chord_name_engraver::finalize ()
 {
 }
 
 void
-Chord_name_engraver::acknowledge_element (Score_element_info i)
+Chord_name_engraver::derived_mark () const
 {
-  if (Note_req* n = dynamic_cast<Note_req*> (i.req_l_))
-    pitch_arr_.push (n->pitch_);
+  scm_gc_mark (last_chord_);
 }
 
-bool
-Chord_name_engraver::do_try_music (Music* m)
+Chord_name_engraver::Chord_name_engraver ()
 {
-  if (Note_req* n = dynamic_cast<Note_req*> (m))
-    {
-      pitch_arr_.push (n->pitch_);
-      return true;
-    }
-  return false;
+  chord_name_ = 0;
+  last_chord_ = SCM_EOL;
+  rest_event_ = 0;
 }
 
 void
-Chord_name_engraver::do_process_requests ()
+Chord_name_engraver::process_music ()
 {
-  if (text_p_arr_.size ())
-    return;
-  if (!pitch_arr_.size ())
-    return;
+  SCM markup;
+  SCM bass = SCM_EOL;
+  SCM inversion = SCM_EOL;
+  SCM pitches = SCM_EOL;
 
-  /*
-   Banter style chord names (almost).
-   TODO:
-     - don't print inclusive scale (i.e. no "9" in c 9/11)
-     - handle c7 / cmaj7
-     - use #,b iso -es -is on tonica
-     - switch on property, add american (?) chordNameStyle
-
-  Scalar chordNameStyle = get_property ("chordNameStyle");
-  if (chordNameStyle == "Banner")
-     chord = pitches_to_banner (pitch_arr_.size ());
-
-   */
-
-  Scalar style = get_property ("textstyle");
-  Scalar alignment = get_property ("textalignment");
-  Text_def* text_p = new Text_def;
-  text_p->align_dir_ = LEFT;
-  if (style.length_i ())
-    text_p->style_str_ = style;
-  if (alignment.isnum_b())
-    text_p->align_dir_= (Direction)(int)alignment;
-
-  Musical_pitch tonic = pitch_arr_[0];
-
-  Array<Musical_pitch> scale;
-  scale.push (Musical_pitch (0)); // c
-  scale.push (Musical_pitch (1)); // d
-  scale.push (Musical_pitch (2)); // e
-  scale.push (Musical_pitch (3)); // f
-  scale.push (Musical_pitch (4)); // g
-  scale.push (Musical_pitch (5)); // a
-  // 7 always means 7-...
-  scale.push (Musical_pitch (6, -1)); // b
-
-  for (int i = 0; i < scale.size (); i++)
-    scale[i].transpose (tonic);
-
-  //urg, should do translation in scheme.
-  char const *acc[] = {"\\textflat\\textflat ", "\\textflat ", "", "\\textsharp " , "\\textsharp\\textsharp "};
-  String tonic_str = tonic.str ();
-  tonic_str = tonic_str.left_str (1).upper_str ()
-    + acc[tonic.accidental_i_ + 2];
-
-  String add_str;
-  String sep_str;
-  for (int i=1; i < pitch_arr_.size (); i++)
+  if (rest_event_)
     {
-      Musical_pitch p = pitch_arr_[i];
-      int trap = p.notename_i_ - tonic.notename_i_ 
-        + (p.octave_i_ - tonic.octave_i_) * 7 + 1;
-      int accidental = p.accidental_i_ - scale[(trap - 1) % 7].accidental_i_;
-      if ((trap == 3) && (accidental == -1))
-        tonic_str += "m"; // hmm
-      else if (accidental || (!(trap % 2) || ((i + 1 == pitch_arr_.size ()) && (trap > 5))))
+      SCM no_chord_markup = get_property ("noChordSymbol");
+      if (!Text_interface::is_markup (no_chord_markup))
+        return;
+      markup = no_chord_markup;
+    }
+  else
+    {
+      if (!notes_.size ())
+        return;
+
+      Stream_event *inversion_event = 0;
+      for (vsize i = 0; i < notes_.size (); i++)
         {
-         add_str += sep_str;
-          if ((trap == 7) && (accidental == 1))
-            add_str += "maj7";
+          Stream_event *n = notes_[i];
+          SCM p = n->get_property ("pitch");
+          if (!unsmob_pitch (p))
+            continue;
+
+          if (n->get_property ("inversion") == SCM_BOOL_T)
+            {
+              inversion_event = n;
+              inversion = p;
+            }
+          else if (n->get_property ("bass") == SCM_BOOL_T)
+            bass = p;
           else
+            pitches = scm_cons (p, pitches);
+        }
+
+      if (inversion_event)
+        {
+          SCM oct = inversion_event->get_property ("octavation");
+          if (scm_is_number (oct))
             {
-              add_str += to_str (trap);
-              if (accidental)
-                add_str += accidental < 0 ? "-" : "+";
+              Pitch *p = unsmob_pitch (inversion_event->get_property ("pitch"));
+              int octavation = scm_to_int (oct);
+              Pitch orig = p->transposed (Pitch (-octavation, 0, 0));
+
+              pitches = scm_cons (orig.smobbed_copy (), pitches);
             }
-         sep_str = "/";
-       }
+          else
+            programming_error ("inversion does not have original pitch");
+        }
+
+      pitches = scm_sort_list (pitches, Pitch::less_p_proc);
+
+      SCM name_proc = get_property ("chordNameFunction");
+      markup = scm_call_4 (name_proc, pitches, bass, inversion,
+                           context ()->self_scm ());
     }
+  /*
+    Ugh.
+  */
+  SCM chord_as_scm = scm_cons (pitches, scm_cons (bass, inversion));
+
+  chord_name_ = make_item ("ChordName",
+                           rest_event_ ? rest_event_->self_scm () : notes_[0]->self_scm ());
+  chord_name_->set_property ("text", markup);
 
-  text_p->text_str_ = tonic_str + "$^{" + add_str + "}$";
-  Text_item* item_p =  new Text_item (text_p);
-  item_p->dir_ = DOWN;
-  item_p->fat_b_ = true;
-  text_p_arr_.push (item_p);
-  announce_element (Score_element_info (item_p, 0));
+  SCM chord_changes = get_property ("chordChanges");
+  if (to_boolean (chord_changes) && scm_is_pair (last_chord_)
+      && ly_is_equal (chord_as_scm, last_chord_))
+    chord_name_->set_property ("begin-of-line-visible", SCM_BOOL_T);
+
+  last_chord_ = chord_as_scm;
 }
 
+IMPLEMENT_TRANSLATOR_LISTENER (Chord_name_engraver, note);
 void
-Chord_name_engraver::do_pre_move_processing ()
+Chord_name_engraver::listen_note (Stream_event *ev)
 {
-  for (int i=0; i < text_p_arr_.size (); i++)
-    {
-      typeset_element (text_p_arr_[i]);
-    }
-  text_p_arr_.clear ();
-  pitch_arr_.clear ();
+  notes_.push_back (ev);
+}
+
+IMPLEMENT_TRANSLATOR_LISTENER (Chord_name_engraver, rest);
+void
+Chord_name_engraver::listen_rest (Stream_event *ev)
+{
+  ASSIGN_EVENT_ONCE (rest_event_, ev);
 }
 
+void
+Chord_name_engraver::stop_translation_timestep ()
+{
+  chord_name_ = 0;
+  notes_.clear ();
+  rest_event_ = 0;
+}
+
+/*
+  The READs description is not strictly accurate:
+  which properties are read depend on the chord naming function active.
+*/
+ADD_TRANSLATOR (Chord_name_engraver,
+                /* doc */
+                "Catch note and rest events and generate the appropriate chordname.",
+
+                /* create */
+                "ChordName ",
+
+                /* read */
+                "chordChanges "
+                "chordNameExceptions "
+                "chordNameFunction "
+                "chordNoteNamer "
+                "chordRootNamer "
+                "chordNameExceptions "
+                "majorSevenSymbol "
+                "noChordSymbol ",
+
+                /* write */
+                ""
+               );