X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Ftranslator.cc;h=3020006f837e21e9edfac660a720a41bb80ca2f3;hb=eaa41b4e4dc1d3b893c5a75711f26db6a7f5fa18;hp=fd9f367df62f796acf4c64007e79288d46e00e10;hpb=637eff7ba745bbeb96d347d1798615529cea9e5f;p=lilypond.git diff --git a/lily/translator.cc b/lily/translator.cc index fd9f367df6..3020006f83 100644 --- a/lily/translator.cc +++ b/lily/translator.cc @@ -1,21 +1,34 @@ /* - translator.cc -- implement Translator + This file is part of LilyPond, the GNU music typesetter. - source file of the GNU LilyPond music typesetter + Copyright (C) 1997--2011 Han-Wen Nienhuys - (c) 1997--2001 Han-Wen Nienhuys -*/ + 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 . +*/ #include "translator.hh" -#include "debug.hh" + +#include "context-def.hh" +#include "dispatcher.hh" +#include "global-context.hh" +#include "international.hh" #include "translator-group.hh" -#include "translator-def.hh" +#include "warn.hh" -#include "moment.hh" +#include "translator.icc" #include "ly-smobs.icc" - Translator::~Translator () { } @@ -23,190 +36,347 @@ Translator::~Translator () void Translator::init () { - simple_trans_list_ = SCM_EOL; - trans_group_list_ = SCM_EOL; - properties_scm_ = SCM_EOL; - definition_ = SCM_EOL; - daddy_trans_l_ =0; + self_scm_ = SCM_EOL; + daddy_context_ = 0; + smobify_self (); } -Translator::Translator () +void +Translator::process_music () { - init (); - output_def_l_ = 0; - smobify_self (); - } -Translator::Translator (Translator const &s) - : Input (s) +void +Translator::process_acknowledged () { - init (); - output_def_l_ = s.output_def_l_; - type_str_ = s.type_str_; - - smobify_self (); } -bool -Translator::is_alias_b (String s) const +Translator::Translator () { - bool b = s == type_str_; - - for (SCM a = unsmob_translator_def (definition_)->type_aliases_; - !b && gh_pair_p (a); a = ly_cdr (a)) - b = b || s == ly_scm2string (ly_car (a)); - - return b; + init (); } -bool -Translator::try_music (Music *) +Translator::Translator (Translator const &src) { - return false; + (void) src; + init (); } - Moment Translator::now_mom () const { - return daddy_trans_l_->now_mom (); + return daddy_context_->now_mom (); } +Output_def * +Translator::get_output_def () const +{ + return daddy_context_->get_output_def (); +} - - - +Translator_group * +Translator::get_daddy_translator () const +{ + return daddy_context_->implementation (); +} void -Translator::removal_processing () +Translator::protect_event (SCM ev) { - finalize (); + get_daddy_translator ()->protect_event (ev); } +SCM +Translator::internal_get_property (SCM sym) const +{ + return daddy_context_->internal_get_property (sym); +} void -Translator::announces () +Translator::stop_translation_timestep () { - do_announces (); } - -Music_output_def * -Translator::output_def_l () const +/* + this function is called once each moment, before any user + information enters the translators. (i.e. no \property or event has + been processed yet.) +*/ +void +Translator::start_translation_timestep () { - return output_def_l_; } -SCM -Translator::get_property (char const * id) const +void +Translator::initialize () { - return daddy_trans_l_->get_property (ly_symbol2scm (id)); } -SCM -Translator::get_property (SCM sym) const +void +Translator::finalize () { - return daddy_trans_l_->get_property (sym); } void -Translator:: stop_translation_timestep () +Translator::connect_to_context (Context *c) { + for (translator_listener_record *r = get_listener_list (); r; r = r->next_) + c->events_below ()->add_listener (r->get_listener_ (this, r->event_class_), + r->event_class_); } void -Translator::start_translation_timestep () +Translator::disconnect_from_context (Context *c) { + for (translator_listener_record *r = get_listener_list (); r; r = r->next_) + c->events_below ()->remove_listener (r->get_listener_ (this, r->event_class_), + r->event_class_); } +static SCM listened_event_class_table; void -Translator::do_announces () +ensure_listened_hash () { + if (!listened_event_class_table) + listened_event_class_table = scm_permanent_object (scm_c_make_hash_table (61)); } -void -Translator::initialize () + +LY_DEFINE (ly_get_listened_event_classes, "ly:get-listened-event-classes", + 0, 0, 0, (), + "Return a list of all event classes that some translator listens" + " to.") { + ensure_listened_hash (); + return ly_hash_table_keys (listened_event_class_table); +} + +LY_DEFINE (ly_is_listened_event_class, "ly:is-listened-event-class", + 1, 0, 0, (SCM sym), + "Is @var{sym} a listened event class?") +{ + ensure_listened_hash (); + return scm_hashq_ref (listened_event_class_table, sym, SCM_BOOL_F); } void -Translator::finalize () +add_listened_event_class (SCM sym) { + ensure_listened_hash (); + scm_hashq_set_x (listened_event_class_table, sym, SCM_BOOL_T); } /* + internally called once, statically, for each translator + listener. Connects the name of an event class with a procedure that + fetches the corresponding listener. - SMOBS + The method should only be called from the macro + IMPLEMENT_TRANSLATOR_LISTENER. + */ +void +Translator::add_translator_listener (translator_listener_record **listener_list, + translator_listener_record *r, + Listener (*get_listener) (void *, SCM), + const char *ev_class) +{ + /* ev_class is the C++ identifier name. Convert to scm symbol */ + string name = string (ev_class); + name = replace_all (&name, '_', '-'); + name += "-event"; + + SCM class_sym = scm_from_locale_symbol (name.c_str ()); + + add_listened_event_class (class_sym); + r->event_class_ = class_sym; + r->get_listener_ = get_listener; + r->next_ = *listener_list; + *listener_list = r; +} + +/* + Helps the individual static_translator_description methods of translators. +*/ +SCM +Translator::static_translator_description (const char *grobs, + const char *desc, + translator_listener_record *listener_list, + const char *read, + const char *write) const +{ + SCM static_properties = SCM_EOL; + + static_properties = scm_acons (ly_symbol2scm ("grobs-created"), + parse_symbol_list (grobs), static_properties); + + static_properties = scm_acons (ly_symbol2scm ("description"), + scm_from_locale_string (desc), static_properties); + + SCM list = SCM_EOL; + for (; listener_list; listener_list = listener_list->next_) + list = scm_cons (listener_list->event_class_, list); + static_properties = scm_acons (ly_symbol2scm ("events-accepted"), + list, static_properties); + + static_properties = scm_acons (ly_symbol2scm ("properties-read"), + parse_symbol_list (read), static_properties); + + static_properties = scm_acons (ly_symbol2scm ("properties-written"), + parse_symbol_list (write), static_properties); + + return static_properties; +} + +/* + SMOBS */ SCM Translator::mark_smob (SCM sm) { - Translator * me = (Translator*) SCM_CELL_WORD_1 (sm); - scm_gc_mark (me->simple_trans_list_); - scm_gc_mark (me->trans_group_list_); - scm_gc_mark (me->definition_); - scm_gc_mark (me->properties_scm_); + Translator *me = (Translator *) SCM_CELL_WORD_1 (sm); + me->derived_mark (); + return SCM_EOL; +} - return me->properties_scm_; +Global_context * +Translator::get_global_context () const +{ + return daddy_context_->get_global_context (); } -MAKE_SCHEME_CALLBACK(Translator,name,1); -SCM -Translator::name (SCM trans) +Context * +Translator::get_score_context () const { - if (unsmob_translator (trans)) - { - char const* nm = classname (unsmob_translator (trans)); - return ly_str02scm (nm); - } - return - SCM_EOL; + return daddy_context_->get_score_context (); } -MAKE_SCHEME_CALLBACK(Translator,description,1) -SCM -Translator::description (SCM me) +IMPLEMENT_SMOBS (Translator); +IMPLEMENT_DEFAULT_EQUAL_P (Translator); +IMPLEMENT_TYPE_P (Translator, "ly:translator?"); + +bool +Translator::must_be_last () const { - if (unsmob_translator (me)) - return unsmob_translator(me)->translator_description (); - else - { - programming_error ("Translator::description ()"); - return SCM_EOL; - } + return false; } -SCM -Translator::translator_description () const +void +Translator::derived_mark () const { - return SCM_EOL; } int Translator::print_smob (SCM s, SCM port, scm_print_state *) { - Translator *sc = (Translator *) ly_cdr (s); - + Translator *me = (Translator *) SCM_CELL_WORD_1 (s); scm_puts ("#simple_trans_list_, port); - /* - don't try to print properties, that is too much hassle. - */ + scm_puts (me->class_name (), port); scm_puts (" >", port); - return 1; } -SCM -Translator::static_translator_description ()const +void +add_acknowledger (Engraver_void_function_engraver_grob_info ptr, + char const *func_name, + vector *ack_array) { - return SCM_EOL; + Acknowledge_information inf; + inf.function_ = ptr; + + string interface_name (func_name); + + interface_name = replace_all (&interface_name, '_', '-'); + interface_name += "-interface"; + + /* + this is only called during program init, so safe to use scm_gc_protect_object () + */ + inf.symbol_ = scm_gc_protect_object (ly_symbol2scm (interface_name.c_str ())); + ack_array->push_back (inf); } -IMPLEMENT_UNSMOB (Translator, translator); -IMPLEMENT_SMOBS (Translator); -IMPLEMENT_DEFAULT_EQUAL_P (Translator); +Engraver_void_function_engraver_grob_info +generic_get_acknowledger (SCM sym, vector const *ack_array) +{ + for (vsize i = 0; i < ack_array->size (); i++) + { + if (ack_array->at (i).symbol_ == sym) + return ack_array->at (i).function_; + } + return 0; +} + + +Moment +get_event_length (Stream_event *e) +{ + Moment *m = unsmob_moment (e->get_property ("length")); + if (m) + return *m; + else + return Moment (0); +} + +Moment +get_event_length (Stream_event *e, Moment now) +{ + Moment len = get_event_length (e); + + if (now.grace_part_) + { + len.grace_part_ = len.main_part_; + len.main_part_ = Rational (0); + } + return len; +} + +/* + Helper, used through ASSIGN_EVENT_ONCE to throw warnings for + simultaneous events. The helper is only useful in listen_* methods + of translators. +*/ +bool +internal_event_assignment (Stream_event **old_ev, Stream_event *new_ev, const char *function) +{ + if (*old_ev && + !to_boolean (scm_equal_p ((*old_ev)->self_scm (), + new_ev->self_scm ()))) + { + /* extract event class from function name */ + string ev_class = function; + + /* This assertion fails if EVENT_ASSIGNMENT was called outside a + translator listener. Don't do that. */ + const char *prefix = "listen_"; + assert (0 == ev_class.find (prefix)); + + /* "listen_foo_bar" -> "foo-bar" */ + ev_class.erase (0, strlen (prefix)); + replace_all (&ev_class, '_', '-'); + + new_ev->origin ()->warning (_f ("Two simultaneous %s events, junking this one", ev_class.c_str ())); + (*old_ev)->origin ()->warning (_f ("Previous %s event here", ev_class.c_str ())); + return false; + } + else + { + *old_ev = new_ev; + return true; + } +} + +ADD_TRANSLATOR (Translator, + /* doc */ + "Base class. Not instantiated.", + + /* create */ + "", + + /* read */ + "", + + /* write */ + "" + );