lily/script-engraver.cc

   1 /*
   2   script-engraver.cc -- implement Script_engraver
   3
   4   (c)  1997--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   5 */
   6
   7 #include "script.hh"
   8 #include "side-position-interface.hh"
   9 #include "event.hh"
  10 #include "stem.hh"
  11 #include "rhythmic-head.hh"
  12 #include "engraver.hh"
  13 #include "note-column.hh"
  14 #include "translator-group.hh"
  15
  16 struct Script_tuple
  17 {
  18   Music *event_;
  19   Grob * script_;
  20   SCM description_;
  21   Script_tuple ()
  22   {
  23     event_ = 0;
  24     script_ = 0;
  25     description_ = SCM_EOL;
  26   }
  27 };
  28
  29 class Script_engraver : public Engraver
  30 {
  31   Array<Script_tuple> scripts_;
  32 public:
  33   TRANSLATOR_DECLARATIONS(Script_engraver);
  34 protected:
  35   virtual bool try_music (Music*);
  36   virtual void stop_translation_timestep ();
  37   virtual void process_music ();
  38   virtual void acknowledge_grob (Grob_info);
  39 };
  40
  41 bool
  42 Script_engraver::try_music (Music *r)
  43 {
  44   if (r->is_mus_type ("articulation-event"))
  45     {
  46       Script_tuple t;
  47       t.event_ =r;
  48       scripts_.push (t);
  49       return true;
  50     }
  51   return false;
  52 }
  53
  54 void
  55 copy_property (Grob * g , SCM sym, SCM alist)
  56 {
  57   if (g->internal_get_grob_property (sym) == SCM_EOL)
  58     {
  59       SCM entry = scm_assoc (sym,alist);
  60       if (gh_pair_p (entry))
  61         {
  62           g->internal_set_grob_property (sym, gh_cdr (entry));
  63         }
  64     }
  65 }
  66
  67
  68 /*
  69   We add the properties, one by one for each Script. We could save a
  70   little space by tacking the props onto the Script grob (i.e. make
  71   ScriptStaccato , ScriptMarcato, etc. )
  72  */
  73 Grob *make_script_from_event (SCM * descr, Translator_group*tg, Music * event,
  74                               int index)
  75 {
  76   SCM alist = tg->get_property ("scriptDefinitions");
  77   SCM art_type= event->get_mus_property ("articulation-type");
  78   SCM art = scm_assoc (art_type, alist);
  79
  80   if (art == SCM_BOOL_F)
  81     {
  82       event->origin ()->warning (_("Don't know how to interpret articulation:"));
  83       event->origin ()->warning (_("Scheme encoding: "));
  84       scm_write (art_type, scm_current_error_port ());
  85       return 0 ;
  86     }
  87
  88   art = gh_cdr (art);
  89
  90   Grob *p =new Item (tg->get_property ("Script"));
  91   *descr = art;
  92
  93   SCM force_dir = event->get_mus_property ("direction");
  94   if (is_direction (force_dir) && to_dir (force_dir))
  95     p->set_grob_property ("direction", force_dir);
  96
  97   copy_property (p, ly_symbol2scm ("script-molecule"), art);
  98   copy_property (p, ly_symbol2scm ("direction"), art);
  99   copy_property (p, ly_symbol2scm ("side-relative-direction"), art);
 100
 101   int prio =0;
 102   SCM sprio = scm_assoc (ly_symbol2scm ("script-priority"), art);
 103   if (gh_pair_p (sprio))
 104     prio = gh_scm2int (gh_cdr (sprio));
 105
 106
 107   /*
 108     Make sure they're in order of user input by adding index i.
 109     Don't use the direction in this priority. Smaller means closer
 110     to the head.
 111   */
 112   prio += index;
 113
 114   Side_position_interface::set_axis (p, Y_AXIS);
 115   p->set_grob_property ("script-priority", gh_int2scm (prio));
 116   return p;
 117 }
 118
 119 void
 120 Script_engraver::process_music ()
 121 {
 122   for (int i=0; i < scripts_.size (); i++)
 123     {
 124       Music* l=scripts_[i].event_;
 125
 126       Grob * p = make_script_from_event (&scripts_[i].description_, daddy_trans_, l, i);
 127
 128       scripts_[i].script_ = p;
 129       if (p)
 130         announce_grob (p, l->self_scm());
 131     }
 132 }
 133
 134 void
 135 Script_engraver::acknowledge_grob (Grob_info inf)
 136 {
 137   if (Stem::has_interface (inf.grob_))
 138     {
 139       for (int i=0; i < scripts_.size (); i++)
 140         {
 141           Grob*e = scripts_[i].script_;
 142
 143           if (to_dir (e->get_grob_property ("side-relative-direction")))
 144             e->set_grob_property ("direction-source", inf.grob_->self_scm ());
 145
 146           /*
 147             add dep ?
 148            */
 149           e->add_dependency (inf.grob_);
 150           Side_position_interface::add_support (e, inf.grob_);
 151         }
 152     }
 153   else if (Rhythmic_head::has_interface (inf.grob_))
 154     {
 155       for (int i=0; i < scripts_.size (); i++)
 156         {
 157           Grob *e = scripts_[i].script_;
 158
 159           if (Side_position_interface::get_axis (e) == X_AXIS
 160               && !e->get_parent (Y_AXIS))
 161             {
 162               e->set_parent (inf.grob_, Y_AXIS);
 163               e->add_dependency (inf.grob_); // ??
 164             }
 165           Side_position_interface::add_support (e,inf.grob_);
 166         }
 167     }
 168   else if (Note_column::has_interface (inf.grob_))
 169     {
 170
 171       /*
 172         We make note column the parent of the script. That's not
 173         correct, but due to seconds in a chord, noteheads may be
 174         swapped around horizontally. We don't know which note head to
 175         put it on, so we postpone this decision to
 176         Script_interface::before_line_breaking ().
 177
 178        */
 179       for (int i=0; i < scripts_.size (); i++)
 180         {
 181           Grob *e = scripts_[i].script_;
 182
 183           if (!e->get_parent (X_AXIS) &&
 184               Side_position_interface::get_axis (e) == Y_AXIS)
 185             {
 186               e->set_parent (inf.grob_, X_AXIS);
 187             }
 188         }
 189     }
 190 }
 191
 192 void
 193 Script_engraver::stop_translation_timestep ()
 194 {
 195   for (int i=0; i < scripts_.size (); i++)
 196     {
 197       if (!scripts_[i].script_)
 198         continue;
 199
 200       Grob * sc = scripts_[i].script_;
 201
 202       SCM follow = scm_assoc (ly_symbol2scm ("follow-into-staff"), scripts_[i].description_);
 203       if (gh_pair_p (follow) && to_boolean (gh_cdr (follow)))
 204         sc->add_offset_callback (Side_position_interface::quantised_position_proc, Y_AXIS);
 205       else
 206         Side_position_interface::add_staff_support (sc);
 207       typeset_grob (sc);
 208     }
 209   scripts_.clear ();
 210 }
 211
 212
 213
 214 Script_engraver::Script_engraver(){}
 215
 216 ENTER_DESCRIPTION(Script_engraver,
 217 /* descr */       "Handles note scripted articulations.",
 218 /* creats*/       "Script",
 219 /* accepts */     "script-event articulation-event",
 220 /* acks  */      "stem-interface rhythmic-head-interface note-column-interface",
 221 /* reads */       "scriptDefinitions",
 222 /* write */       "");