lily/script-column.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1999--2011 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 }
  43
  44 LY_DEFINE (ly_grob_script_priority_less, "ly:grob-script-priority-less",
  45            2, 0, 0, (SCM a, SCM b),
  46            "Compare two grobs by script priority.  For internal use.")
  47 {
  48   Grob *i1 = unsmob_grob (a);
  49   Grob *i2 = unsmob_grob (b);
  50
  51   SCM p1 = i1->get_property ("script-priority");
  52   SCM p2 = i2->get_property ("script-priority");
  53
  54   return scm_to_int (p1) < scm_to_int (p2) ? SCM_BOOL_T : SCM_BOOL_F;
  55 }
  56
  57 MAKE_SCHEME_CALLBACK (Script_column, row_before_line_breaking, 1);
  58 SCM
  59 Script_column::row_before_line_breaking (SCM smob)
  60 {
  61   Grob *me = unsmob_grob (smob);
  62   vector<Grob *> horizontal_grobs;
  63   extract_grob_set (me, "scripts", scripts);
  64
  65   Grob_scripts_map head_scripts_map;
  66   vector<Grob *> affect_all_grobs;
  67   for (vsize i = 0; i < scripts.size (); i++)
  68     {
  69       Grob *sc = scripts[i];
  70
  71       /*
  72         Don't want to consider scripts horizontally next to notes.
  73       */
  74       if (Accidental_placement::has_interface (sc)
  75           || Arpeggio::has_interface (sc))
  76         {
  77           affect_all_grobs.push_back (sc);
  78         }
  79       else if (sc->get_property_data ("Y-offset")
  80                != Side_position_interface::y_aligned_side_proc)
  81         {
  82           head_scripts_map[sc->get_parent (Y_AXIS)].push_back (sc);
  83         }
  84     }
  85
  86   for (Grob_scripts_map::const_iterator i (head_scripts_map.begin ());
  87        i != head_scripts_map.end ();
  88        i++)
  89     {
  90       vector<Grob *> grobs = (*i).second;
  91
  92       // this isn't right in all cases, but in general a safe assumption.
  93       concat (grobs, affect_all_grobs);
  94       order_grobs (grobs);
  95     }
  96
  97   return SCM_UNSPECIFIED;
  98 }
  99
 100 MAKE_SCHEME_CALLBACK (Script_column, before_line_breaking, 1);
 101 SCM
 102 Script_column::before_line_breaking (SCM smob)
 103 {
 104   Grob *me = unsmob_grob (smob);
 105   vector<Grob *> staff_sided;
 106
 107   extract_grob_set (me, "scripts", scripts);
 108   for (vsize i = 0; i < scripts.size (); i++)
 109     {
 110       Grob *sc = scripts[i];
 111       /*
 112         Don't want to consider scripts horizontally next to notes.
 113       */
 114       if (sc->get_property_data ("X-offset")
 115           != Side_position_interface::x_aligned_side_proc)
 116         staff_sided.push_back (sc);
 117     }
 118
 119   order_grobs (staff_sided);
 120   return SCM_UNSPECIFIED;
 121 }
 122
 123 void
 124 Script_column::order_grobs (vector<Grob *> grobs)
 125 {
 126   Drul_array<SCM> scripts_drul (SCM_EOL, SCM_EOL);
 127   for (vsize i = 0; i < grobs.size (); i++)
 128     {
 129       Grob *g = grobs[i];
 130       Direction d = get_grob_direction (g);
 131
 132       scripts_drul[d] = scm_cons (g->self_scm (), scripts_drul[d]);
 133     }
 134
 135   Direction d = DOWN;
 136   do
 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, just
 157                 use it as a support for the current grob
 158               */
 159               if (!scm_is_number (last_outside_staff))
 160                 Side_position_interface::add_support (g, last);
 161               /*
 162                 if outside_staff_priority is missing or is equal to original
 163                 outside_staff_priority of previous grob, set new
 164                 outside_staff_priority to just higher than outside_staff_priority
 165                 of previous grob in order to preserve ordering.
 166               */
 167               else if ((!scm_is_number (initial_outside_staff))
 168                        || (fabs (scm_to_double (initial_outside_staff)
 169                                  - robust_scm2double (last_initial_outside_staff, 0)) < 0.001))
 170                 g->set_property ("outside-staff-priority",
 171                                  scm_from_double (scm_to_double (last_outside_staff) + 0.1));
 172             }
 173         }
 174     }
 175   while (flip (&d) != DOWN);
 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                ""
 184               );