lily/script-engraver.cc

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