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