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 void make_script_from_event (Grob *p,
  74                              SCM * descr, Translator_group*tg, Music * event,
  75                              int index)
  76 {
  77   SCM alist = tg->get_property ("scriptDefinitions");
  78   SCM art_type= event->get_mus_property ("articulation-type");
  79   SCM art = scm_assoc (art_type, alist);
  80
  81   if (art == SCM_BOOL_F)
  82     {
  83       event->origin ()->warning (_("Don't know how to interpret articulation:"));
  84       event->origin ()->warning (_("Scheme encoding: "));
  85       scm_write (art_type, scm_current_error_port ());
  86       return  ;
  87     }
  88
  89   art = gh_cdr (art);
  90
  91
  92   *descr = art;
  93
  94   SCM force_dir = event->get_mus_property ("direction");
  95   if (is_direction (force_dir) && to_dir (force_dir))
  96     p->set_grob_property ("direction", force_dir);
  97
  98   copy_property (p, ly_symbol2scm ("script-molecule"), art);
  99   copy_property (p, ly_symbol2scm ("direction"), art);
 100   copy_property (p, ly_symbol2scm ("side-relative-direction"), art);
 101
 102   int prio =0;
 103   SCM sprio = scm_assoc (ly_symbol2scm ("script-priority"), art);
 104   if (gh_pair_p (sprio))
 105     prio = gh_scm2int (gh_cdr (sprio));
 106
 107
 108   /*
 109     Make sure they're in order of user input by adding index i.
 110     Don't use the direction in this priority. Smaller means closer
 111     to the head.
 112   */
 113   prio += index;
 114
 115   Side_position_interface::set_axis (p, Y_AXIS);
 116   p->set_grob_property ("script-priority", gh_int2scm (prio));
 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_item ("Script");
 127
 128       make_script_from_event (p, &scripts_[i].description_, daddy_trans_, l, i);
 129
 130       scripts_[i].script_ = p;
 131       if (p)
 132         announce_grob (p, l->self_scm());
 133     }
 134 }
 135
 136 void
 137 Script_engraver::acknowledge_grob (Grob_info inf)
 138 {
 139   if (Stem::has_interface (inf.grob_))
 140     {
 141       for (int i=0; i < scripts_.size (); i++)
 142         {
 143           Grob*e = scripts_[i].script_;
 144
 145           if (to_dir (e->get_grob_property ("side-relative-direction")))
 146             e->set_grob_property ("direction-source", inf.grob_->self_scm ());
 147
 148           /*
 149             add dep ?
 150            */
 151           e->add_dependency (inf.grob_);
 152           Side_position_interface::add_support (e, inf.grob_);
 153         }
 154     }
 155   else if (Rhythmic_head::has_interface (inf.grob_))
 156     {
 157       for (int i=0; i < scripts_.size (); i++)
 158         {
 159           Grob *e = scripts_[i].script_;
 160
 161           if (Side_position_interface::get_axis (e) == X_AXIS
 162               && !e->get_parent (Y_AXIS))
 163             {
 164               e->set_parent (inf.grob_, Y_AXIS);
 165               e->add_dependency (inf.grob_); // ??
 166             }
 167           Side_position_interface::add_support (e,inf.grob_);
 168         }
 169     }
 170   else if (Note_column::has_interface (inf.grob_))
 171     {
 172
 173       /*
 174         We make note column the parent of the script. That's not
 175         correct, but due to seconds in a chord, noteheads may be
 176         swapped around horizontally. We don't know which note head to
 177         put it on, so we postpone this decision to
 178         Script_interface::before_line_breaking ().
 179
 180        */
 181       for (int i=0; i < scripts_.size (); i++)
 182         {
 183           Grob *e = scripts_[i].script_;
 184
 185           if (!e->get_parent (X_AXIS) &&
 186               Side_position_interface::get_axis (e) == Y_AXIS)
 187             {
 188               e->set_parent (inf.grob_, X_AXIS);
 189             }
 190         }
 191     }
 192 }
 193
 194 void
 195 Script_engraver::stop_translation_timestep ()
 196 {
 197   for (int i=0; i < scripts_.size (); i++)
 198     {
 199       if (!scripts_[i].script_)
 200         continue;
 201
 202       Grob * sc = scripts_[i].script_;
 203
 204       SCM follow = scm_assoc (ly_symbol2scm ("follow-into-staff"), scripts_[i].description_);
 205       if (gh_pair_p (follow) && to_boolean (gh_cdr (follow)))
 206         {
 207           sc->add_offset_callback (Side_position_interface::quantised_position_proc, Y_AXIS);
 208           sc->set_grob_property ("staff-padding", SCM_EOL);
 209         }
 210       typeset_grob (sc);
 211     }
 212   scripts_.clear ();
 213 }
 214
 215
 216
 217 Script_engraver::Script_engraver(){}
 218
 219 ENTER_DESCRIPTION(Script_engraver,
 220 /* descr */       "Handles note scripted articulations.",
 221 /* creats*/       "Script",
 222 /* accepts */     "script-event articulation-event",
 223 /* acks  */      "stem-interface rhythmic-head-interface note-column-interface",
 224 /* reads */       "scriptDefinitions",
 225 /* write */       "");