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--2004 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           else if (m->is_mus_type ("harmonic-event"))
  91             {
  92               inf.grob_->set_grob_property ("style", ly_symbol2scm ("harmonic"));
  93             }
  94         }
  95
  96       heads_.push (inf.grob_);
  97     }
  98   else if (Stem::has_interface (inf.grob_))
  99     {
 100       stem_ = inf.grob_;
 101     }
 102 }
 103
 104 void
 105 New_fingering_engraver::add_script (Grob * head,
 106                                     Music * event,
 107                                     Music * )
 108 {
 109   Finger_tuple ft ;
 110
 111   Grob * g=  make_item ("Script");
 112   make_script_from_event (g, &ft.description_, daddy_trans_,
 113                           event->get_mus_property ("articulation-type"), 0);
 114   if (g)
 115     {
 116       ft.script_ =g ;
 117
 118       articulations_.push (ft);
 119       announce_grob (g, event->self_scm ());
 120
 121       ft.script_->set_parent (head, X_AXIS);
 122     }
 123 }
 124
 125
 126 void
 127 New_fingering_engraver::add_fingering (Grob * head,
 128                                        Music * event,
 129                                        Music *hevent)
 130 {
 131   Finger_tuple ft;
 132
 133   ft.script_ = make_item ("Fingering");
 134   announce_grob (ft.script_, event->self_scm());
 135
 136   Side_position_interface::add_support (ft.script_, head);
 137
 138   int d = gh_scm2int (event->get_mus_property ("digit"));
 139
 140   /*
 141     TODO:
 142
 143     Should add support for thumb.  It's a little involved, since
 144     the thumb lives in a different font. Maybe it should be moved?
 145
 146    */
 147   if (d > 5)
 148     {
 149       /*
 150         music for the softenon children?
 151        */
 152       event->origin()->warning (_("music for the martians."));
 153     }
 154   SCM sstr = scm_number_to_string (gh_int2scm (d), gh_int2scm (10)) ;
 155   ft.script_->set_grob_property ("text", sstr);
 156
 157   ft.finger_event_ = event;
 158   ft.note_event_ = hevent;
 159   ft.head_ = head;
 160
 161   fingerings_.push (ft);
 162 }
 163
 164 void
 165 New_fingering_engraver::position_scripts ()
 166 {
 167
 168   /*
 169     This is not extremely elegant, but we have to do a little
 170     formatting here, because the parent/child relations should be
 171     known before we move on to the next time step.
 172
 173     A more sophisticated approach would be to set both X and Y parents
 174     to the note head, and write a more flexible function for
 175     positioning the fingerings, setting both X and Y coordinates.
 176   */
 177   for (int i = 0; i < fingerings_.size(); i++)
 178     {
 179       fingerings_[i].position_ = gh_scm2int (fingerings_[i].head_ -> get_grob_property( "staff-position"));
 180     }
 181
 182   for (int i = fingerings_.size(); i--;)
 183     for (int j = heads_.size() ; j--;)
 184       Side_position_interface::add_support (fingerings_[i].script_, heads_[j]);
 185
 186   Array<Finger_tuple> up, down, horiz;
 187   for (int i = fingerings_.size(); i--;)
 188     {
 189       SCM d = fingerings_[i].finger_event_->get_mus_property ("direction");
 190       if (to_dir (d))
 191         {
 192           ((to_dir (d) == UP) ? up : down ).push (fingerings_[i]);
 193           fingerings_.del (i);
 194         }
 195     }
 196
 197   fingerings_.sort (&Finger_tuple::compare);
 198   SCM orientations = get_property ("fingeringOrientations");
 199
 200   bool up_p = scm_memq (ly_symbol2scm ("up"), orientations) != SCM_BOOL_F;
 201   bool down_p = scm_memq (ly_symbol2scm ("down"), orientations) != SCM_BOOL_F;
 202   bool left_p = scm_memq (ly_symbol2scm ("left"), orientations) != SCM_BOOL_F;
 203   bool right_p = scm_memq (ly_symbol2scm ("right"), orientations) != SCM_BOOL_F;
 204   Direction hordir = (right_p) ? RIGHT : LEFT;
 205   if (left_p || right_p)
 206     {
 207       if (up_p && !up.size () && fingerings_.size ())
 208         up.push (fingerings_.pop());
 209
 210       if (down_p && !down.size () && fingerings_.size())
 211         {
 212           down.push (fingerings_[0]);
 213           fingerings_.del(0);
 214         }
 215
 216       horiz.concat (fingerings_);
 217     }
 218   else if (up_p && down_p)
 219     {
 220       int center = fingerings_.size() / 2;
 221       down.concat (fingerings_.slice (0,center));
 222       up.concat (fingerings_.slice (center, fingerings_.size()));
 223     }
 224   else if (up_p)
 225     {
 226       up.concat (fingerings_);
 227       fingerings_ .clear ();
 228     }
 229   else
 230     {
 231       if (!down_p)
 232         warning(_ ("Fingerings are also not down?! Putting them down anyway."));
 233       down.concat (fingerings_);
 234       fingerings_.clear();
 235     }
 236
 237   for (int i = 0; i < horiz.size(); i++)
 238     {
 239       Finger_tuple ft = horiz[i];
 240       Grob* f = ft.script_;
 241       f->set_parent (ft.head_, X_AXIS);
 242       f->set_parent (ft.head_, Y_AXIS);
 243       f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, Y_AXIS);
 244       f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, Y_AXIS);
 245       f->add_offset_callback (Side_position_interface::aligned_side_proc, X_AXIS);
 246
 247       f->set_grob_property ("direction", gh_int2scm (hordir));
 248       typeset_grob (f);
 249     }
 250
 251   int finger_prio = 200;
 252   for (int i = 0; i < up.size(); i++)
 253     {
 254       Finger_tuple ft = up[i];
 255       Grob* f = ft.script_;
 256       f->set_parent (ft.head_, X_AXIS);
 257       f->set_grob_property ("script-priority",
 258                             gh_int2scm (finger_prio + i));
 259       f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
 260       f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
 261       f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
 262
 263       f->set_grob_property ("direction", gh_int2scm (UP));
 264
 265       typeset_grob (f);
 266     }
 267
 268   for (int i = 0; i < down.size(); i++)
 269     {
 270       Finger_tuple ft = down[i];
 271       Grob* f = ft.script_;
 272       f->set_parent (ft.head_, X_AXIS);
 273       f->set_grob_property ("script-priority",
 274                             gh_int2scm (finger_prio + down.size() - i));
 275
 276       f->add_offset_callback (Self_alignment_interface::centered_on_parent_proc, X_AXIS);
 277       f->add_offset_callback (Self_alignment_interface::aligned_on_self_proc, X_AXIS);
 278       f->add_offset_callback (Side_position_interface::aligned_side_proc, Y_AXIS);
 279       f->set_grob_property ("direction", gh_int2scm (DOWN));
 280       typeset_grob (f);
 281     }
 282 }
 283
 284 void
 285 New_fingering_engraver::stop_translation_timestep ()
 286 {
 287   if (fingerings_.size ())
 288     {
 289       position_scripts();
 290       fingerings_.clear ();
 291     }
 292
 293   for (int i =  articulations_.size(); i--;)
 294     {
 295       Grob *sc = articulations_[i].script_;
 296
 297       for (int j = heads_.size() ; j--;)
 298         Side_position_interface::add_support (sc, heads_[j]);
 299
 300       if (stem_ && to_dir (sc->get_grob_property ("side-relative-direction")))
 301         sc->set_grob_property ("direction-source", stem_->self_scm ());
 302
 303       SCM follow = scm_assoc (ly_symbol2scm ("follow-into-staff"), articulations_[i].description_);
 304       if (gh_pair_p (follow) && to_boolean (gh_cdr (follow)))
 305         {
 306           sc->add_offset_callback (Side_position_interface::quantised_position_proc, Y_AXIS);
 307           sc->set_grob_property ("staff-padding" , SCM_EOL);
 308         }
 309       typeset_grob (sc);
 310     }
 311
 312   stem_ = 0;
 313   heads_.clear ();
 314   articulations_.clear();
 315 }
 316
 317
 318 New_fingering_engraver::New_fingering_engraver()
 319 {
 320   stem_ = 0;
 321 }
 322
 323 ENTER_DESCRIPTION(New_fingering_engraver,
 324 /* descr */       "Create fingering-scripts for notes in a new chord.  "
 325                   "This engraver is ill-named, since it "
 326                   "also takes care of articulations and harmonic note heads",
 327 /* creats*/       "Fingering",
 328 /* accepts */     "",
 329 /* acks  */       "rhythmic-head-interface stem-interface",
 330 /* reads */       "fingeringOrientations",
 331 /* write */       "");