X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=lily%2Faccidental-placement.cc;h=f8000479883144573436d5dfb4ad73b9ee897001;hb=9d4a5bbc9687aef811a60aabd9cb839412984e96;hp=292f9935512f1195fb6458a994338e7f07dc387b;hpb=46c1dd95d637b86046407b1364794511dd9516c1;p=lilypond.git diff --git a/lily/accidental-placement.cc b/lily/accidental-placement.cc index 292f993551..f800047988 100644 --- a/lily/accidental-placement.cc +++ b/lily/accidental-placement.cc @@ -1,112 +1,75 @@ -/* -accidental-placement.cc -- implement Accidental_placement +/* + accidental-placement.cc -- implement Accidental_placement + + source file of the GNU LilyPond music typesetter -source file of the GNU LilyPond music typesetter + (c) 2002--2006 Han-Wen Nienhuys +*/ -(c) 2002 Han-Wen Nienhuys - */ -#include -#include -#include "item.hh" +#include "accidental-placement.hh" #include "skyline.hh" #include "music.hh" #include "pitch.hh" #include "warn.hh" -#include "accidental-placement.hh" #include "note-column.hh" -#include "group-interface.hh" +#include "pointer-group-interface.hh" #include "note-collision.hh" #include "accidental-interface.hh" -/* - Hmm. why not group-extent? - */ -MAKE_SCHEME_CALLBACK(Accidental_placement,extent_callback, 2); -SCM -Accidental_placement::extent_callback(SCM s, SCM axis) -{ - Grob * me =unsmob_grob (s); - Axis a = Axis (gh_scm2int (axis)); - - assert (a == X_AXIS); - - SCM w = position_accidentals (me); - return w; -} - -MAKE_SCHEME_CALLBACK(Accidental_placement,alignment_callback, 2); -SCM -Accidental_placement::alignment_callback(SCM s, SCM ) -{ - Grob * me =unsmob_grob (s); - - Grob * par = me->get_parent (X_AXIS); - if (!to_boolean (par->get_grob_property ("alignment-done"))) - { - par->set_grob_property ("alignment-done", SCM_BOOL_T); - position_accidentals (par); - } - - return gh_int2scm (0); -} - - void -Accidental_placement::add_accidental (Grob* me, Grob* a) +Accidental_placement::add_accidental (Grob *me, Grob *a) { a->set_parent (me, X_AXIS); - a->add_offset_callback (alignment_callback_proc, X_AXIS); - SCM cause = a->get_parent (Y_AXIS)->get_grob_property("cause"); + a->set_property ("X-offset", Grob::x_parent_positioning_proc); + SCM cause = a->get_parent (Y_AXIS)->get_property ("cause"); - Music *mcause =unsmob_music (cause); + Music *mcause = unsmob_music (cause); if (!mcause) { - programming_error ("Note head has no music cause!"); - return; + programming_error ("note head has no music cause"); + return; } - Pitch *p= unsmob_pitch (mcause->get_mus_property ("pitch")); + Pitch *p = unsmob_pitch (mcause->get_property ("pitch")); - int n = p->notename_i_; + int n = p->get_notename (); - SCM accs = me->get_grob_property ("accidentals"); - SCM key = gh_int2scm (n); + SCM accs = me->get_object ("accidental-grobs"); + SCM key = scm_from_int (n); SCM entry = scm_assq (key, accs); if (entry == SCM_BOOL_F) - { - entry = SCM_EOL; - } + entry = SCM_EOL; else - entry = gh_cdr (entry); + entry = scm_cdr (entry); - entry = gh_cons (a->self_scm (), entry); + entry = scm_cons (a->self_scm (), entry); - accs = scm_assq_set_x (accs, key, entry); + accs = scm_assq_set_x (accs, key, entry); - me->set_grob_property ("accidentals", accs); + me->set_object ("accidental-grobs", accs); } /* Split into break reminders. - */ +*/ void -Accidental_placement::split_accidentals (Grob * accs, - Link_array *break_reminder, - Link_array *real_acc) +Accidental_placement::split_accidentals (Grob *accs, + Link_array__Grob_ *break_reminder, + Link_array__Grob_ *real_acc) { - for (SCM acs =accs->get_grob_property ("accidentals"); gh_pair_p (acs); - acs =gh_cdr (acs)) - for (SCM s = gh_cdar (acs); gh_pair_p (s); s = gh_cdr (s)) + for (SCM acs = accs->get_object ("accidental-grobs"); scm_is_pair (acs); + acs = scm_cdr (acs)) + for (SCM s = scm_cdar (acs); scm_is_pair (s); s = scm_cdr (s)) { - Grob *a = unsmob_grob (gh_car (s)); + Grob *a = unsmob_grob (scm_car (s)); - if (unsmob_grob (a->get_grob_property ("tie"))) - break_reminder->push (a); + if (unsmob_grob (a->get_object ("tie"))) + break_reminder->push_back (a); else - real_acc->push (a); + real_acc->push_back (a); } } @@ -119,355 +82,331 @@ Accidental_placement::get_relevant_accidental_extent (Grob *me, Item *item_col, Grob *left_object) { - Link_array br, ra; - Link_array *which = 0; + Link_array__Grob_ br, ra; + Link_array__Grob_ *which = 0; Accidental_placement::split_accidentals (me, &br, &ra); - br.concat (ra); - - if (dynamic_cast(left_object)->break_status_dir () == RIGHT) - which = & br; + concat (br, ra); + + if (dynamic_cast (left_object)->break_status_dir () == RIGHT) + which = &br; else - which = & ra; - + which = &ra; + Interval extent; - for (int i = 0; i < which->size(); i++) - { - extent.unite (which->elem(i)->extent (item_col, X_AXIS)); - } + for (vsize i = 0; i < which->size (); i++) + extent.unite (which->at (i)->extent (item_col, X_AXIS)); - if (!extent.empty_b()) + if (!extent.is_empty ()) { - Real p = gh_scm2double (me->get_grob_property ("left-padding")); + Real p = robust_scm2double (me->get_property ("left-padding"), 0.2); extent[LEFT] -= p; } - + return extent; } - - struct Accidental_placement_entry { - Array left_skyline_; - Array right_skyline_; + std::vector left_skyline_; + std::vector right_skyline_; Interval vertical_extent_; - Array extents_; - Link_array grobs_; - Real offset_; + std::vector extents_; + Link_array__Grob_ grobs_; + Real offset_; int notename_; - Accidental_placement_entry() + Accidental_placement_entry () { - offset_ =0.0; + offset_ = 0.0; notename_ = -1; } }; static Interval all_accidental_vertical_extent; -Real ape_priority (Accidental_placement_entry const * a) +Real ape_priority (Accidental_placement_entry const *a) { return a->vertical_extent_[UP]; } - - int ape_compare (Accidental_placement_entry *const &a, Accidental_placement_entry *const &b) { - return sign (ape_priority (a) - ape_priority(b)); + return sign (ape_priority (a) - ape_priority (b)); } int ape_rcompare (Accidental_placement_entry *const &a, - Accidental_placement_entry *const &b) + Accidental_placement_entry *const &b) { - return -sign (ape_priority (a) - ape_priority(b)); + return -sign (ape_priority (a) - ape_priority (b)); } - /* + TODO: should favor -TODO: should favor - b - b + b -placement - + placement */ void -stagger_apes (Link_array *apes) +stagger_apes (Link_array__Accidental_placement_entry_ *apes) { - Link_array asc = *apes; + Link_array__Accidental_placement_entry_ asc = *apes; + vector_sort (asc, &ape_compare); - asc.sort (&ape_compare); + apes->clear (); - apes->clear(); - - int i =0; int parity = 1; - while (i < asc.size()) + for (vsize i = 0; i < asc.size ();) { - Accidental_placement_entry * a = 0; + Accidental_placement_entry *a = 0; if (parity) - a = asc.pop(); + { + a = asc.back (); + asc.pop_back (); + } else a = asc[i++]; - apes->push (a); + apes->push_back (a); parity = !parity; } - apes->reverse(); + reverse (*apes); } - - /* - Return: width as SCM interval. - - This routine computes placements of accidentals. During - add_accidental(), accidentals are already grouped by note, so that + add_accidental (), accidentals are already grouped by note, so that octaves are placed above each other; they form columns. Then the columns are sorted: the biggest columns go closest to the note. Then the columns are spaced as closely as possible (using skyline spacing). - - + + TODO: more advanced placement. Typically, the accs should be placed to form a C shape, like this - - ## - b b - # # - b - b b - The naturals should be left of the C as well; they should - be separate accs. + ## + b b + # # + b + b b + + The naturals should be left of the C as well; they should + be separate accs. + + Note that this placement problem looks NP hard, so we just use a + simple strategy, not an optimal choice. +*/ + +/* + TODO: there should be more space in the following situation + + + Natural + downstem - Note that this placement problem looks NP hard, so we just use a - simple strategy, not an optimal choice. + * + * |_ + * | | X + * |_| | + * | | + * */ +MAKE_SCHEME_CALLBACK(Accidental_placement, calc_positioning_done, 1); SCM -Accidental_placement::position_accidentals (Grob * me) +Accidental_placement::calc_positioning_done (SCM smob) { - SCM accs = me->get_grob_property ("accidentals"); + Grob *me = unsmob_grob (smob); + if (!me->is_live ()) + return SCM_BOOL_T; + + SCM accs = me->get_object ("accidental-grobs"); + if (!scm_is_pair (accs)) + return SCM_BOOL_T; /* TODO: there is a bug in this code. If two accs are on the same - Y-position, they share an Ape, and will be pritned in overstrike. - */ - Link_array apes; - for (SCM s = accs; gh_pair_p (s); s =gh_cdr (s)) + Y-position, they share an Ape, and will be printed in overstrike. + */ + Link_array__Accidental_placement_entry_ apes; + for (SCM s = accs; scm_is_pair (s); s = scm_cdr (s)) { Accidental_placement_entry *ape = new Accidental_placement_entry; - ape->notename_ = gh_scm2int (gh_caar (s)); - - for (SCM t = gh_cdar (s); gh_pair_p (t); t =gh_cdr (t)) - ape->grobs_.push (unsmob_grob (gh_car (t))); + ape->notename_ = scm_to_int (scm_caar (s)); - apes.push (ape); - } + for (SCM t = scm_cdar (s); scm_is_pair (t); t = scm_cdr (t)) + ape->grobs_.push_back (unsmob_grob (scm_car (t))); + apes.push_back (ape); + } Grob *common[] = {me, 0}; /* First we must extract *all* pointers. We can only determine extents if we're sure that we've found the right common refpoint - */ - Link_array note_cols, heads; - for (int i= apes.size (); i--;) - { - Accidental_placement_entry * ape = apes[i]; - for (int j = ape->grobs_.size(); j--;) + */ + Link_array__Grob_ note_cols, heads; + for (vsize i = apes.size (); i--;) + { + Accidental_placement_entry *ape = apes[i]; + for (vsize j = ape->grobs_.size (); j--;) { - Grob * a = ape->grobs_[j]; + Grob *a = ape->grobs_[j]; if (common[Y_AXIS]) common[Y_AXIS] = common[Y_AXIS]->common_refpoint (a, Y_AXIS); else common[Y_AXIS] = a; - + Grob *head = a->get_parent (Y_AXIS); - Grob * col = head->get_parent (X_AXIS); + Grob *col = head->get_parent (X_AXIS); if (Note_column::has_interface (col)) - note_cols.push (col); + note_cols.push_back (col); else - heads.push (head); + heads.push_back (head); } } /* This is a little kludgy: to get all notes, we look if there are collisions as well. - */ - for (int i = note_cols.size() ; i--;) + */ + for (vsize i = note_cols.size (); i--;) { Grob *c = note_cols[i]->get_parent (X_AXIS); if (Note_collision_interface::has_interface (c)) { - Link_array gs = - Pointer_group_interface__extract_grobs (c, (Grob*)0, "elements"); - - note_cols.concat (gs); + extract_grob_set (c, "elements", gs); + + concat (note_cols, gs); } } - - for (int i = note_cols.size() ; i--;) - { - heads.concat (Pointer_group_interface__extract_grobs (note_cols[i], - (Grob*)0, - "note-heads")); - - } - heads.default_sort(); - heads.uniq(); + + for (vsize i = note_cols.size (); i--;) + concat (heads, extract_grob_array (note_cols[i], "note-heads")); + + vector_sort (heads, default_compare); + uniq (heads); common[Y_AXIS] = common_refpoint_of_array (heads, common[Y_AXIS], Y_AXIS); - - for (int i= apes.size (); i--;) + for (vsize i = apes.size (); i--;) { - Accidental_placement_entry * ape = apes[i]; + Accidental_placement_entry *ape = apes[i]; ape->left_skyline_ = empty_skyline (LEFT); ape->right_skyline_ = empty_skyline (RIGHT); - - for (int j = apes[i]->grobs_.size(); j--;) + + for (vsize j = apes[i]->grobs_.size (); j--;) { - Grob * a = apes[i]->grobs_[j]; + Grob *a = apes[i]->grobs_[j]; - Array boxes = Accidental_interface::accurate_boxes (a, common); - - ape->extents_.concat (boxes); - for (int j = boxes.size(); j--;) + std::vector boxes = Accidental_interface::accurate_boxes (a, common); + + ape->extents_.insert (ape->extents_.end (), boxes.begin (), boxes.end ()); + for (vsize j = boxes.size (); j--;) { insert_extent_into_skyline (&ape->left_skyline_, boxes[j], Y_AXIS, LEFT); - insert_extent_into_skyline (&ape->right_skyline_ , boxes[j], Y_AXIS, RIGHT); + insert_extent_into_skyline (&ape->right_skyline_, boxes[j], Y_AXIS, RIGHT); } } } - Interval total; - for (int i = apes.size(); i--;) + for (vsize i = apes.size (); i--;) { - Interval y ; - - for (int j = apes[i]->extents_.size(); j--;) - { - y.unite (apes[i]->extents_[j][Y_AXIS]); - } + Interval y; + + for (vsize j = apes[i]->extents_.size (); j--;) + y.unite (apes[i]->extents_[j][Y_AXIS]); apes[i]->vertical_extent_ = y; total.unite (y); } all_accidental_vertical_extent = total; stagger_apes (&apes); - Accidental_placement_entry * head_ape = new Accidental_placement_entry; - common[X_AXIS] = common_refpoint_of_array (heads, common[X_AXIS], X_AXIS); - Array head_skyline (empty_skyline (LEFT)); - Array head_extents; - for (int i = heads.size(); i--;) + Accidental_placement_entry *head_ape = new Accidental_placement_entry; + common[X_AXIS] = common_refpoint_of_array (heads, common[X_AXIS], X_AXIS); + std::vector head_skyline (empty_skyline (LEFT)); + std::vector head_extents; + for (vsize i = heads.size (); i--;) { - Box b(heads[i]->extent (common[X_AXIS] , X_AXIS), - heads[i]->extent (common[Y_AXIS], Y_AXIS)); + Box b (heads[i]->extent (common[X_AXIS], X_AXIS), + heads[i]->extent (common[Y_AXIS], Y_AXIS)); - insert_extent_into_skyline (&head_skyline, b , Y_AXIS, LEFT); + insert_extent_into_skyline (&head_skyline, b, Y_AXIS, LEFT); } - head_ape-> left_skyline_ = head_skyline; + head_ape->left_skyline_ = head_skyline; head_ape->offset_ = 0.0; - SCM rs = me->get_grob_property ("right-padding"); - if (gh_number_p (rs)) - head_ape->offset_ -= gh_scm2double (rs); - - - Real padding = 0.2; - SCM spad = me->get_grob_property ("padding"); - if (gh_number_p (spad)) - padding = gh_scm2double (spad); - + Real padding = robust_scm2double (me->get_property ("padding"), 0.2); + std::vector left_skyline = head_ape->left_skyline_; + heighten_skyline (&left_skyline, + -robust_scm2double (me->get_property ("right-padding"), 0)); /* - TODO: - - There is a bug in this code: the left_skylines should be - accumulated, otherwise the b will collide with bb in - - bb - b - n - - */ - apes.push (head_ape); - for (int i= apes.size () -1 ; i-- > 0;) + Add accs entries right-to-left. + */ + for (vsize i = apes.size (); i-- > 0;) { - Accidental_placement_entry *ape = apes[i]; - Real d = 0.0; - int j = i+1; - do { - d = - skyline_meshing_distance (ape->right_skyline_, - apes[j]->left_skyline_); - - if (!isinf(d) - || j + 1 == apes.size()) - break; - - j = j+ 1; - } while (1); - - if (isinf(d)) - d = 0.0; - - d -= padding; - ape->offset_ += apes[j]->offset_ + d; + Real offset + = -skyline_meshing_distance (apes[i]->right_skyline_, left_skyline); + if (isinf (offset)) + offset = (i < apes.size () - 1) ? apes[i + 1]->offset_ : 0.0; + else + offset -= padding; + + apes[i]->offset_ = offset; + + std::vector new_left_skyline = apes[i]->left_skyline_; + heighten_skyline (&new_left_skyline, apes[i]->offset_); + merge_skyline (&new_left_skyline, left_skyline, LEFT); + left_skyline = new_left_skyline; } - apes.pop(); - for (int i = apes.size(); i--;) + for (vsize i = apes.size (); i--;) { - Accidental_placement_entry* ape = apes[i]; - for (int j = ape->grobs_.size(); j--;) - { - ape->grobs_[j]->translate_axis (ape->offset_, X_AXIS); - } + Accidental_placement_entry *ape = apes[i]; + for (vsize j = ape->grobs_.size (); j--;) + ape->grobs_[j]->translate_axis (ape->offset_, X_AXIS); } - Interval left_extent, right_extent; Accidental_placement_entry *ape = apes[0]; - for (int i = ape->extents_.size(); i--;) - left_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]); - - ape = apes.top(); - for (int i = ape->extents_.size(); i--;) - right_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]); + for (vsize i = ape->extents_.size (); i--;) + left_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]); - SCM ls = me->get_grob_property ("left-padding"); - if (gh_number_p (rs)) - left_extent[LEFT] -= gh_scm2double (ls); + ape = apes.back (); + for (vsize i = ape->extents_.size (); i--;) + right_extent.unite (ape->offset_ + ape->extents_[i][X_AXIS]); - - Interval width(left_extent[LEFT], right_extent[RIGHT]); + left_extent[LEFT] -= robust_scm2double (me->get_property ("left-padding"), 0); + Interval width (left_extent[LEFT], right_extent[RIGHT]); SCM scm_width = ly_interval2scm (width); - me->set_extent (scm_width, X_AXIS); - - for (int i = apes.size(); i--;) + me->flush_extent_cache (X_AXIS); + me->set_property ("X-extent", scm_width); + + for (vsize i = apes.size (); i--;) delete apes[i]; - return scm_width; + return SCM_BOOL_T; } -ADD_INTERFACE(Accidental_placement, - "accidental-placement-interface", - "Take care of complex accidental collisions.", - "left-padding padding right-padding accidentals alignment-done") +ADD_INTERFACE (Accidental_placement, + "accidental-placement-interface", + "Resolve accidental collisions.", + + /* properties */ + "accidental-grobs " + "left-padding " + "padding " + "positioning-done " + "right-padding ")