lily/new-fingering-engraver.cc

   1 /*
   2   fingering-engraver.cc --  implement New_fingering_engraver
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1998--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7
   8  */
   9
  10 #include "warn.hh"
  11 #include "engraver.hh"
  12 #include "side-position-interface.hh"
  13 #include "item.hh"
  14 #include "event.hh"
  15 #include "stem.hh"
  16 #include "rhythmic-head.hh"
  17 #include "self-alignment-interface.hh"
  18 #include "script.hh"
  19 #include "stem.hh"
  20
  21 struct Finger_tuple
  22 {
  23   Grob *head_;
  24   Grob *script_;
  25   Music *note_event_;
  26   Music *finger_event_;
  27   SCM description_;
  28   int position_;
  29
  30   Finger_tuple ()
  31   {
  32     position_ = 0;
  33     head_ = script_ = 0;
  34     note_event_ = finger_event_ = 0;
  35     description_ = SCM_EOL;
  36   }
  37   static int compare (Finger_tuple const & c1, Finger_tuple const & c2)
  38   {
  39     return c1.position_-  c2.position_;
  40   }
  41
  42 };
  43
  44 class New_fingering_engraver : public Engraver
  45 {
  46   Array<Finger_tuple> fingerings_;
  47   Array<Finger_tuple> articulations_;
  48   Link_array<Grob> heads_;
  49   Grob *stem_;
  50
  51 public:
  52   TRANSLATOR_DECLARATIONS(New_fingering_engraver);
  53 protected:
  54   virtual void stop_translation_timestep ();
  55   virtual void acknowledge_grob (Grob_info);
  56   void add_fingering (Grob*, Music*,Music*);
  57   void add_script  (Grob*, Music*,Music*);
  58   void position_scripts();
  59 };
  60
  61 void
  62 New_fingering_engraver::acknowledge_grob (Grob_info inf)
  63 {
  64   if (Rhythmic_head::has_interface (inf.grob_))
  65     {
  66       Music * note_ev =inf.music_cause ();
  67
  68       SCM arts = note_ev->get_mus_property ("articulations");
  69
  70       for (SCM s = arts; gh_pair_p (s); s = gh_cdr  (s))
  71         {
  72           Music * m = unsmob_music (gh_car (s));
  73
  74           if (!m)
  75             continue;
  76
  77
  78           if (m->is_mus_type ("fingering-event"))
  79             {
  80               add_fingering (inf.grob_ , m, note_ev);
  81             }
  82           else if (m->is_mus_type ("text-script-event"))
  83             {
  84               m->origin ()->warning ("Can not add text scripts to individual note heads");
  85             }
  86           else if (m->is_mus_type ("script-event"))
  87             {
  88               add_script (inf.grob_, m, note_ev);
  89             }
  90         }
  91
  92       heads_.push (inf.grob_);
  93     }
  94   else if (Stem::has_interface (inf.grob_))
  95     {
  96       stem_ = inf.grob_;
  97     }
  98 }
  99
 100 extern Grob *make_script_from_event (SCM * descr, Translator_group*tg, Music * event,
 101                                      int index);
 102 void
 103 New_fingering_engraver::add_script (Grob * head,
 104                                     Music * event,
 105                                     Music * )
 106 {
 107   Finger_tuple ft ;
 108
 109   Grob * g=  make_script_from_event (&ft.description_, daddy_trans_, event, 0);
 110   if (g)
 111     {
 112       ft.script_ =g ;
 113
 114       articulations_.push (ft);
 115       announce_grob (g, event->self_scm ());
 116
 117       ft.script_->set_parent (head, X_AXIS);
 118     }
 119 }
 120
 121
 122 void
 123 New_fingering_engraver::add_fingering (Grob * head,
 124                                        Music * event,
 125                                        Music *hevent)
 126 {
 127   Finger_tuple ft;
 128
 129   ft.script_ = new Item (get_property ("Fingering"));
 130   announce_grob (ft.script_, event->self_scm());
 131
 132   Side_position_interface::add_support (ft.script_, head);
 133
 134   int d = gh_scm2int ( event->get_mus_property ("digit"));
 135
 136   /*
 137     TODO:
 138
 139     Should add support for thumb.  It's a little involved, since
 140     the thumb lives in a different font. Maybe it should be moved?
 141
 142    */
 143   if (d > 5)
 144     {
 145       /*
 146         music for the softenon children?
 147        */
 148       event->origin()->warning (_("music for the martians."));
 149     }
 150   SCM sstr = scm_number_to_string (gh_int2scm (d), gh_int2scm (10)) ;
 151   ft.script_->set_grob_property ("text", sstr);
 152
 153   ft.finger_event_ = event;
 154   ft.note_event_ = hevent;
 155   ft.head_ = head;
 156
 157   fingerings_.push (ft);
 158 }
 159
 160 void
 161 New_fingering_engraver::position_scripts ()
 162 {
 163
 164   /*
 165     This is not extremely elegant, but we have to do a little
 166     formatting here, because the parent/child relations should be
 167     known before we move on to the next time step.
 168
 169     A more sophisticated approach would be to set both X and Y parents
 170     to the note head, and write a more flexible function for
 171     positioning the fingerings, setting both X and Y coordinates.
 172   */
 173   for (int i = 0; i < fingerings_.size(); i++)
 174     {
 175       fingerings_[i].position_ = gh_scm2int (fingerings_[i].head_ -> get_grob_property( "staff-position"));
 176     }
 177
 178   for (int i = fingerings_.size(); i--;)
 179     for (int j = heads_.size() ; j--;)
 180       Side_position_interface::add_support (fingerings_[i].script_, heads_[j]);
 181
 182   Array<Finger_tuple> up, down, horiz;
 183   for (int i = fingerings_.size(); i--;)
 184     {
 185       SCM d = fingerings_[i].finger_event_->get_mus_property ("direction");
 186       if (to_dir (d))
 187         {
 188           ((to_dir (d) == UP) ? up : down ).push (fingerings_[i]);
 189           fingerings_.del (i);
 190         }
 191     }
 192
 193   fingerings_.sort (&Finger_tuple::compare);
 194   SCM orientations = get_property ("fingeringOrientations");
 195
 196   bool up_p = scm_memq (ly_symbol2scm ("up"), orientations) != SCM_BOOL_F;
 197   bool down_p = scm_memq (ly_symbol2scm ("down"), orientations) != SCM_BOOL_F;
 198   bool left_p = scm_memq (ly_symbol2scm ("left"), orientations) != SCM_BOOL_F;
 199   bool right_p = scm_memq (ly_symbol2scm ("right"), orientations) != SCM_BOOL_F;
 200   Direction hordir = (right_p) ? RIGHT : LEFT;
 201   if (left_p || right_p)
 202     {
 203       if (up_p && !up.size () && fingerings_.size ())
 204         up.push (fingerings_.pop());
 205
 206       if (down_p && !down.size () && fingerings_.size())
 207         {
 208           down.push (fingerings_[0]);
 209           fingerings_.del(0);
 210         }
 211
 212       horiz.concat (fingerings_);
 213     }
 214   else if (up_p && down_p)
 215     {
 216       int center = fingerings_.size() / 2;
 217       down.concat (fingerings_.slice (0,center));
 218       up.concat (fingerings_.slice (center, fingerings_.size()));
 219     }
 220   else if (up_p)
 221     {
 222       up.concat (fingerings_);
 223       fingerings_ .clear ();
 224     }
 225   else
 226     {
 227       if (!down_p)
 228         warning(_ ("Fingerings are also not down?! Putting them down anyway."));
 229       down.concat (fingerings_);
 230       fingerings_.clear();
 231     }
 232
 233   for (int i = 0; i < horiz.size(); i++)
 234     {
 235       Finger_tuple ft = horiz[i];
 236       Grob* f = ft.script_;
 237       f->set_parent (ft.head_, X_AXIS);
 238       f->set_parent (ft.head_, Y_AXIS);
 239       f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, Y_AXIS);
 240       f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, Y_AXIS);
 241       f->add_offset_callback (Side_position_interface::aligned_side_proc, X_AXIS);
 242
 243       f->set_grob_property ("direction", gh_int2scm (hordir));
 244       typeset_grob (f);
 245     }
 246
 247   int finger_prio = 200;
 248   for (int i = 0; i < up.size(); i++)
 249     {
 250       Finger_tuple ft = up[i];
 251       Grob* f = ft.script_;
 252       f->set_parent (ft.head_, X_AXIS);
 253       f->set_grob_property ("script-priority",
 254                             gh_int2scm (finger_prio + i));
 255       f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
 256       f->add_offset_callback (Side_position_interface::out_of_staff_proc, Y_AXIS);
 257       f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
 258       f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
 259
 260       f->set_grob_property ("direction", gh_int2scm (UP));
 261
 262       typeset_grob (f);
 263     }
 264
 265   for (int i = 0; i < down.size(); i++)
 266     {
 267       Finger_tuple ft = down[i];
 268       Grob* f = ft.script_;
 269       f->set_parent (ft.head_, X_AXIS);
 270       f->set_grob_property ("script-priority",
 271                             gh_int2scm (finger_prio + down.size() - i));
 272
 273       f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
 274       f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
 275       f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
 276       f->add_offset_callback (Side_position_interface::out_of_staff_proc, Y_AXIS);
 277       f->set_grob_property ("direction", gh_int2scm (DOWN));
 278       typeset_grob (f);
 279     }
 280 }
 281
 282 void
 283 New_fingering_engraver::stop_translation_timestep ()
 284 {
 285   if (fingerings_.size ())
 286     {
 287       position_scripts();
 288       fingerings_.clear ();
 289     }
 290
 291   for (int i =  articulations_.size(); i--;)
 292     {
 293       Grob *sc = articulations_[i].script_;
 294
 295       for (int j = heads_.size() ; j--;)
 296         Side_position_interface::add_support (sc, heads_[j]);
 297
 298       if (stem_ && to_dir (sc->get_grob_property ("side-relative-direction")))
 299         sc->set_grob_property ("direction-source", stem_->self_scm ());
 300
 301       SCM follow = scm_assoc (ly_symbol2scm ("follow-into-staff"), articulations_[i].description_);
 302       if (gh_pair_p (follow) && to_boolean (gh_cdr (follow)))
 303         sc->add_offset_callback (Side_position_interface::quantised_position_proc, Y_AXIS);
 304       else
 305         Side_position_interface::add_staff_support (sc);
 306       typeset_grob (sc);
 307     }
 308
 309   stem_ = 0;
 310   heads_.clear ();
 311   articulations_.clear();
 312 }
 313
 314
 315 New_fingering_engraver::New_fingering_engraver()
 316 {
 317   stem_ = 0;
 318 }
 319
 320 ENTER_DESCRIPTION(New_fingering_engraver,
 321 /* descr */       "Create fingering-scripts for notes in a new chord.",
 322 /* creats*/       "Fingering",
 323 /* accepts */     "",
 324 /* acks  */       "rhythmic-head-interface stem-interface",
 325 /* reads */       "fingeringOrientations",
 326 /* write */       "");