lily/script-column.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1999--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
   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 "script-column.hh"
  21
  22 #include "accidental-placement.hh"
  23 #include "arpeggio.hh"
  24 #include "directional-element-interface.hh"
  25 #include "side-position-interface.hh"
  26 #include "warn.hh"
  27 #include "grob.hh"
  28 #include "pointer-group-interface.hh"
  29
  30 #include <map>
  31
  32 typedef map<Grob *, vector <Grob *> > Grob_scripts_map;
  33
  34 void
  35 Script_column::add_side_positioned (Grob *me, Grob *script)
  36 {
  37   SCM p = script->get_property ("script-priority");
  38   if (!scm_is_number (p))
  39     return;
  40
  41   Pointer_group_interface::add_grob (me, ly_symbol2scm ("scripts"), script);
  42   script->set_object ("script-column", me->self_scm ());
  43 }
  44
  45 LY_DEFINE (ly_grob_script_priority_less, "ly:grob-script-priority-less",
  46            2, 0, 0, (SCM a, SCM b),
  47            "Compare two grobs by script priority.  For internal use.")
  48 {
  49   Grob *i1 = unsmob<Grob> (a);
  50   Grob *i2 = unsmob<Grob> (b);
  51
  52   SCM p1 = i1->get_property ("script-priority");
  53   SCM p2 = i2->get_property ("script-priority");
  54
  55   return scm_to_int (p1) < scm_to_int (p2) ? SCM_BOOL_T : SCM_BOOL_F;
  56 }
  57
  58 MAKE_SCHEME_CALLBACK (Script_column, row_before_line_breaking, 1);
  59 SCM
  60 Script_column::row_before_line_breaking (SCM smob)
  61 {
  62   Grob *me = unsmob<Grob> (smob);
  63   vector<Grob *> horizontal_grobs;
  64   extract_grob_set (me, "scripts", scripts);
  65
  66   Grob_scripts_map head_scripts_map;
  67   vector<Grob *> affect_all_grobs;
  68   for (vsize i = 0; i < scripts.size (); i++)
  69     {
  70       Grob *sc = scripts[i];
  71
  72       /*
  73         Don't want to consider scripts horizontally next to notes.
  74       */
  75       if (has_interface<Accidental_placement> (sc)
  76           || has_interface<Arpeggio> (sc))
  77         {
  78           affect_all_grobs.push_back (sc);
  79         }
  80       else if (!scm_is_eq (sc->get_property_data ("Y-offset"),
  81                            Side_position_interface::y_aligned_side_proc))
  82         {
  83           head_scripts_map[sc->get_parent (Y_AXIS)].push_back (sc);
  84         }
  85     }
  86
  87   for (Grob_scripts_map::const_iterator i (head_scripts_map.begin ());
  88        i != head_scripts_map.end ();
  89        i++)
  90     {
  91       vector<Grob *> grobs = (*i).second;
  92
  93       // this isn't right in all cases, but in general a safe assumption.
  94       concat (grobs, affect_all_grobs);
  95       order_grobs (grobs);
  96     }
  97
  98   return SCM_UNSPECIFIED;
  99 }
 100
 101 MAKE_SCHEME_CALLBACK (Script_column, before_line_breaking, 1);
 102 SCM
 103 Script_column::before_line_breaking (SCM smob)
 104 {
 105   Grob *me = unsmob<Grob> (smob);
 106   vector<Grob *> staff_sided;
 107
 108   extract_grob_set (me, "scripts", scripts);
 109   for (vsize i = 0; i < scripts.size (); i++)
 110     {
 111       Grob *sc = scripts[i];
 112       /*
 113         Don't want to consider scripts horizontally next to notes.
 114       */
 115       if (!scm_is_eq (sc->get_property_data ("X-offset"),
 116                       Side_position_interface::x_aligned_side_proc))
 117         staff_sided.push_back (sc);
 118     }
 119
 120   order_grobs (staff_sided);
 121   return SCM_UNSPECIFIED;
 122 }
 123
 124 void
 125 Script_column::order_grobs (vector<Grob *> grobs)
 126 {
 127   Drul_array<SCM> scripts_drul (SCM_EOL, SCM_EOL);
 128   for (vsize i = 0; i < grobs.size (); i++)
 129     {
 130       Grob *g = grobs[i];
 131       Direction d = get_grob_direction (g);
 132
 133       scripts_drul[d] = scm_cons (g->self_scm (), scripts_drul[d]);
 134     }
 135
 136   for (DOWN_and_UP (d))
 137     {
 138       SCM ss = scm_reverse_x (scripts_drul[d], SCM_EOL);
 139       ss = scm_stable_sort_x (ss, ly_grob_script_priority_less_proc);
 140
 141       Grob *g = 0;  // current grob in list
 142       Grob *last = 0; // previous grob in list
 143       SCM initial_outside_staff = SCM_EOL;  // initial outside_staff_priority of current grob
 144       SCM last_initial_outside_staff = SCM_EOL;  // initial outside_staff_priority of previous grob
 145
 146       //  loop over all grobs in script column (already sorted by script_priority)
 147       for (SCM s = ss; scm_is_pair (s);
 148            s = scm_cdr (s), last = g, last_initial_outside_staff = initial_outside_staff)
 149         {
 150           g = unsmob<Grob> (scm_car (s));
 151           initial_outside_staff = g->get_property ("outside-staff-priority");
 152           if (last)    //not the first grob in the list
 153             {
 154               SCM last_outside_staff = last->get_property ("outside-staff-priority");
 155               /*
 156                 if outside_staff_priority is missing for previous grob,
 157                 use all the scripts so far as support for the current grob
 158               */
 159               if (!scm_is_number (last_outside_staff))
 160                 for (SCM t = ss; !scm_is_eq (t, s); t = scm_cdr (t))
 161                   Side_position_interface::add_support (g, unsmob<Grob> (scm_car (t)));
 162               /*
 163                 if outside_staff_priority is missing or is equal to original
 164                 outside_staff_priority of previous grob, set new
 165                 outside_staff_priority to just higher than outside_staff_priority
 166                 of previous grob in order to preserve ordering.
 167               */
 168               else if ((!scm_is_number (initial_outside_staff))
 169                        || (fabs (scm_to_double (initial_outside_staff)
 170                                  - robust_scm2double (last_initial_outside_staff, 0)) < 0.001))
 171                 g->set_property ("outside-staff-priority",
 172                                  scm_from_double (scm_to_double (last_outside_staff) + 0.1));
 173             }
 174         }
 175     }
 176 }
 177
 178 ADD_INTERFACE (Script_column,
 179                "An interface that sorts scripts according to their"
 180                " @code{script-priority} and @code{outside-staff-priority}.",
 181
 182                /* properties */
 183                "scripts "
 184               );