2 This file is part of LilyPond, the GNU music typesetter.
4 Copyright (C) 2006--2010 Han-Wen Nienhuys
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.
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.
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/>.
26 #include "engraver.hh"
28 #include "stream-event.hh"
31 #include "translator.icc"
34 make (guitar-like) tablature note
36 class Fretboard_engraver : public Engraver
40 vector<Stream_event*> note_events_;
41 vector<Stream_event*> tabstring_events_;
43 TRANSLATOR_DECLARATIONS (Fretboard_engraver);
46 void stop_translation_timestep ();
47 void process_music ();
48 virtual void derived_mark() const;
49 DECLARE_TRANSLATOR_LISTENER (note);
50 DECLARE_TRANSLATOR_LISTENER (string_number);
58 Fretboard_engraver::derived_mark () const
60 scm_gc_mark (last_fret_notes_);
63 Fretboard_engraver::Fretboard_engraver ()
66 last_fret_notes_ = SCM_EOL;
69 IMPLEMENT_TRANSLATOR_LISTENER (Fretboard_engraver, note);
71 Fretboard_engraver::listen_note (Stream_event *ev)
73 note_events_.push_back (ev);
76 IMPLEMENT_TRANSLATOR_LISTENER (Fretboard_engraver, string_number);
78 Fretboard_engraver::listen_string_number (Stream_event *ev)
80 tabstring_events_.push_back (ev);
84 Fretboard_engraver::process_music ()
86 if (!note_events_.size ())
89 // Ugh -- copied from tab-note-heads-engraver; need to resolve
92 vector<Stream_event *> string_events;
94 for (vsize i = 0; i < note_events_.size (); i++)
97 Stream_event *event = note_events_[i];
99 Stream_event *tabstring_event = 0;
102 For notes inside a chord construct, string indications are
103 stored as articulations on the note, so we check through
106 for (SCM s = event->get_property ("articulations");
107 !tabstring_event && scm_is_pair (s); s = scm_cdr (s))
109 Stream_event *art = unsmob_stream_event (scm_car (s));
111 if (art->in_event_class ("string-number-event"))
112 tabstring_event = art;
116 For string indications listed outside a chord construct,
117 a string_number_event is generated, so if there was no string
118 in the articulations, we check for string events outside
121 if (!tabstring_event && j < tabstring_events_.size ())
123 tabstring_event = tabstring_events_[j];
124 if (j + 1 < tabstring_events_.size ())
128 string_events.push_back (tabstring_event);
130 // end of copied code
132 fret_board_ = make_item ("FretBoard", note_events_[0]->self_scm ());
133 SCM fret_notes = ly_cxx_vector_to_list (note_events_);
134 SCM proc = get_property ("noteToFretFunction");
135 if (ly_is_procedure (proc))
137 context ()->self_scm (),
139 ly_cxx_vector_to_list (string_events),
140 fret_board_->self_scm ());
141 SCM changes = get_property ("chordChanges");
142 if (to_boolean (changes) && scm_is_pair (last_fret_notes_)
143 && ly_is_equal (last_fret_notes_, fret_notes))
144 fret_board_->set_property ("begin-of-line-visible", SCM_BOOL_T);
146 last_fret_notes_ = fret_notes;
150 Fretboard_engraver::stop_translation_timestep ()
153 note_events_.clear ();
154 tabstring_events_.clear ();
157 ADD_TRANSLATOR (Fretboard_engraver,
159 "Generate fret diagram from one or more events of type"
160 " @code{NoteEvent}.",
168 "maximumFretStretch "
170 "noteToFretFunction "
171 "predefinedDiagramTable "