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