X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Ftranslator.cc;h=efa375549fba042301a1f4903b0c567113999573;hb=b8c66cadfa52c1c5b32ba35166d9b2099f627726;hp=4229f61600d44e91af80452eecef916a53e22ce4;hpb=5e47fbe9f5a8e10458a9d737d1c35cff2eae6791;p=lilypond.git diff --git a/lily/translator.cc b/lily/translator.cc index 4229f61600..efa375549f 100644 --- a/lily/translator.cc +++ b/lily/translator.cc @@ -3,179 +3,368 @@ source file of the GNU LilyPond music typesetter - (c) 1997 Han-Wen Nienhuys + (c) 1997--2009 Han-Wen Nienhuys */ - #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 "dictionary-iter.hh" +#include "warn.hh" + +#include "translator.icc" +#include "ly-smobs.icc" Translator::~Translator () { } -Translator::Translator () +void +Translator::init () { - status = ORPHAN; - daddy_trans_l_ = 0; - output_def_l_ = 0; + must_be_last_ = false; + self_scm_ = SCM_EOL; + daddy_context_ = 0; + smobify_self (); } -Translator::Translator (Translator const &s) - : Input (s) +void +Translator::process_music () { - status = ORPHAN; - daddy_trans_l_ =0; - output_def_l_ = s.output_def_l_; - properties_dict_ = s.properties_dict_; - type_str_ = s.type_str_; } -bool -Translator::is_alias_b (String s) const +void +Translator::process_acknowledged () { - return s == type_str_; } -bool -Translator::do_try_request (Request *) +Translator::Translator () +{ + init (); +} + +Translator::Translator (Translator const &src) { - return false; + init (); + must_be_last_ = src.must_be_last_; } - Moment -Translator::now_moment () const +Translator::now_mom () const { - return daddy_trans_l_->now_moment (); + 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::add_processing () +Translator::protect_event (SCM ev) { - if (status > ORPHAN) - return; - - do_add_processing (); - status = VIRGIN; + get_daddy_translator ()->protect_event (ev); +} + +SCM +Translator::internal_get_property (SCM sym) const +{ + return daddy_context_->internal_get_property (sym); } void -Translator::do_add_processing () +Translator::stop_translation_timestep () { } +/* + 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::print () const +Translator::start_translation_timestep () { -#ifndef NPRINT - DOUT << name () << " {"; - if (name () != type_str_) - DOUT << "type = " << type_str_; - for (Dictionary_iter i (properties_dict_); i.ok (); i++) - { - DOUT << i.key () << "=" << i.val () <<"\n"; - } - do_print (); - DOUT << "}\n"; -#endif } void -Translator::do_print () const +Translator::initialize () { } -IMPLEMENT_IS_TYPE_B(Translator); +void +Translator::finalize () +{ +} +void +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_); +} void -Translator::creation_processing () +Translator::disconnect_from_context (Context *c) { - if (status >= CREATION_INITED) - return ; - - do_creation_processing (); - status = CREATION_INITED; + for (translator_listener_record *r = get_listener_list (); r; r=r->next_) + c->events_below ()->remove_listener (r->get_listener_ (this), r->event_class_); } +static SCM listened_event_class_table; void -Translator::post_move_processing () +ensure_listened_hash () { - if (status >= MOVE_INITED) - return; + if (!listened_event_class_table) + listened_event_class_table = scm_permanent_object (scm_c_make_hash_table (61)); +} + + +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); +} - creation_processing (); - do_post_move_processing (); - status = MOVE_INITED; +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::removal_processing () +add_listened_event_class (SCM sym) { - if (status == ORPHAN) - return; - creation_processing (); - do_removal_processing (); - // elegancy ... - // status = ORPHAN; + ensure_listened_hash (); + scm_hashq_set_x (listened_event_class_table, sym, SCM_BOOL_T); } -bool -Translator::try_request (Request * r) +/* + internally called once, statically, for each translator + listener. Connects the name of an event class with a procedure that + fetches the corresponding listener. + + 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 *), + const char *ev_class) { - if (status < MOVE_INITED) - post_move_processing (); + /* 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_str2symbol (name.c_str ()); + + add_listened_event_class (class_sym); - return do_try_request (r); + r->event_class_ = class_sym; + r->get_listener_ = get_listener; + r->next_ = *listener_list; + *listener_list = r; } -void -Translator::process_requests () +/* + 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 { - if (status < PROCESSED_REQS) - post_move_processing (); - else if (status >= PROCESSED_REQS) - return; + 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); - status = PROCESSED_REQS; - do_process_requests (); + 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); + me->derived_mark (); + return SCM_EOL; +} + +Global_context * +Translator::get_global_context () const +{ + return daddy_context_->get_global_context (); +} + +Context * +Translator::get_score_context () const +{ + return daddy_context_->get_score_context (); +} + +IMPLEMENT_SMOBS (Translator); +IMPLEMENT_DEFAULT_EQUAL_P (Translator); +IMPLEMENT_TYPE_P (Translator, "ly:translator?"); + +bool +Translator::must_be_last () const +{ + return must_be_last_; } void -Translator::pre_move_processing () +Translator::derived_mark () const +{ +} + +int +Translator::print_smob (SCM s, SCM port, scm_print_state *) { - do_pre_move_processing (); - status = CREATION_INITED; + Translator *me = (Translator *) SCM_CELL_WORD_1 (s); + scm_puts ("#class_name (), port); + scm_puts (" >", port); + return 1; +} + +void +add_acknowledger (Engraver_void_function_engraver_grob_info ptr, + char const *func_name, + vector *ack_array) +{ + 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); } -Scalar -Translator::get_property (String id) +Engraver_void_function_engraver_grob_info +generic_get_acknowledger (SCM sym, vector const *ack_array) { - if (properties_dict_.elt_b (id)) + for (vsize i = 0; i < ack_array->size (); i++) { - return properties_dict_[id]; + if (ack_array->at (i).symbol_ == sym) + return ack_array->at (i).function_; } - - if (daddy_trans_l_) - return daddy_trans_l_->get_property (id); - - return ""; + return 0; } -void -Translator::set_property (String id, Scalar val) + +Moment +get_event_length (Stream_event *e) { - properties_dict_[id] = val; + 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; +} -Music_output_def * -Translator::output_def_l () const +/* + 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) { - return output_def_l_; + 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 */ + "" + );