lily/tab-note-heads-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2002--2010 Han-Wen Nienhuys, Jean-Baptiste Lamy <jiba@tuxfamily.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 <cctype>
  21 #include <cstdio>
  22
  23 #include "engraver.hh"
  24
  25 using namespace std;
  26
  27 #include "articulations.hh"
  28 #include "duration.hh"
  29 #include "item.hh"
  30 #include "output-def.hh"
  31 #include "pitch.hh"
  32 #include "rhythmic-head.hh"
  33 #include "stream-event.hh"
  34 #include "warn.hh"
  35 #include "context.hh"
  36
  37 #include "translator.icc"
  38
  39 /**
  40    make (guitar-like) tablature note
  41 */
  42 class Tab_note_heads_engraver : public Engraver
  43 {
  44   vector<Item *> notes_;
  45
  46   vector<Stream_event *> note_events_;
  47   vector<Stream_event *> tabstring_events_;
  48 public:
  49   TRANSLATOR_DECLARATIONS (Tab_note_heads_engraver);
  50
  51 protected:
  52   DECLARE_TRANSLATOR_LISTENER (note);
  53   DECLARE_TRANSLATOR_LISTENER (string_number);
  54   void process_music ();
  55
  56   void stop_translation_timestep ();
  57 };
  58
  59 Tab_note_heads_engraver::Tab_note_heads_engraver ()
  60 {
  61 }
  62
  63 IMPLEMENT_TRANSLATOR_LISTENER (Tab_note_heads_engraver, note);
  64 void
  65 Tab_note_heads_engraver::listen_note (Stream_event *ev)
  66 {
  67   note_events_.push_back (ev);
  68 }
  69
  70 IMPLEMENT_TRANSLATOR_LISTENER (Tab_note_heads_engraver, string_number);
  71 void
  72 Tab_note_heads_engraver::listen_string_number (Stream_event *ev)
  73 {
  74   tabstring_events_.push_back (ev);
  75 }
  76
  77 void
  78 Tab_note_heads_engraver::process_music ()
  79 {
  80   SCM tab_strings = articulation_list (note_events_,
  81                                        tabstring_events_,
  82                                        "string-number-event");
  83   SCM tab_notes = ly_cxx_vector_to_list (note_events_);
  84   SCM proc = get_property ("noteToFretFunction");
  85   SCM string_fret_finger = SCM_EOL;
  86   if (ly_is_procedure (proc))
  87     string_fret_finger = scm_call_3 (proc,
  88                                      context ()->self_scm (),
  89                                      tab_notes,
  90                                      tab_strings);
  91   SCM note_entry = SCM_EOL;
  92   SCM string_number = SCM_EOL;
  93   SCM fret = SCM_EOL;
  94   SCM fret_label = SCM_EOL;
  95   SCM fret_procedure = get_property ("tablatureFormat");
  96   SCM staff_line_procedure = get_property ("tabStaffLineLayoutFunction");
  97   SCM staff_position = SCM_EOL;
  98   vsize fret_count = (vsize) scm_ilength (string_fret_finger);
  99   bool length_changed = (note_events_.size () != fret_count);
 100   vsize index;
 101
 102   if (string_fret_finger != SCM_EOL)
 103     for (vsize i = 0; i < fret_count; i++)
 104       {
 105         note_entry = scm_list_ref (string_fret_finger, scm_from_int (i));
 106         string_number = scm_car (note_entry);
 107         fret = scm_cadr (note_entry);
 108         fret_label = scm_call_3 (fret_procedure,
 109                                  context ()->self_scm (),
 110                                  string_number,
 111                                  fret);
 112         index = length_changed ? 0 : i;
 113         Item *note = make_item ("TabNoteHead", note_events_[index]->self_scm ());
 114         note->set_property ("text", fret_label);
 115         staff_position = scm_call_2 (staff_line_procedure,
 116                                      context ()->self_scm (),
 117                                      string_number);
 118         note->set_property ("staff-position", staff_position);
 119         notes_.push_back (note);
 120       }
 121 }
 122
 123 void
 124 Tab_note_heads_engraver::stop_translation_timestep ()
 125 {
 126   notes_.clear ();
 127   note_events_.clear ();
 128   tabstring_events_.clear ();
 129 }
 130
 131 ADD_TRANSLATOR (Tab_note_heads_engraver,
 132                 /* doc */
 133                 "Generate one or more tablature noteheads from event of type"
 134                 " @code{NoteEvent}.",
 135
 136                 /* create */
 137                 "TabNoteHead ",
 138
 139                 /* read */
 140                 "fretLabels "
 141                 "highStringOne "
 142                 "middleCPosition "
 143                 "minimumFret "
 144                 "noteToFretFunction "
 145                 "stringOneTopmost "
 146                 "stringTunings "
 147                 "tablatureFormat "
 148                 "tabStaffLineLayoutFunction ",
 149
 150                 /* write */ ""
 151                 );
 152