lily/script-engraver.cc

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