lily/music.cc

   1 /*
   2   music.cc -- implement Music
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9 #include "main.hh"
  10 #include "input-smob.hh"
  11 #include "music.hh"
  12 #include "music-list.hh"
  13 #include "warn.hh"
  14 #include "pitch.hh"
  15 #include "ly-smobs.icc"
  16
  17
  18
  19 bool
  20 Music::internal_is_music_type (SCM k)const
  21 {
  22   SCM ifs = get_property ("types");
  23
  24   return scm_memq (k, ifs) != SCM_BOOL_F;
  25 }
  26
  27 String
  28 Music::name () const
  29 {
  30   SCM nm = get_property ("name");
  31   if (gh_symbol_p (nm))
  32     {
  33       return ly_symbol2string (nm);
  34     }
  35   else
  36     {
  37       return classname (this);
  38     }
  39 }
  40
  41
  42
  43 Music::Music (Music const &m)
  44 {
  45   immutable_property_alist_ = m.immutable_property_alist_;
  46   mutable_property_alist_ = SCM_EOL;
  47   self_scm_ = SCM_EOL;
  48
  49   /*
  50     First we smobify_self, then we copy over the stuff.  If we don't,
  51     stack vars that hold the copy might be optimized away, meaning
  52     that they won't be protected from GC.
  53    */
  54   smobify_self ();
  55   mutable_property_alist_ = ly_deep_mus_copy (m.mutable_property_alist_);
  56   set_spot (*m.origin ());
  57 }
  58
  59 Music::Music ()
  60 {
  61   self_scm_ = SCM_EOL;
  62   immutable_property_alist_ = SCM_EOL;
  63   mutable_property_alist_ = SCM_EOL;
  64   smobify_self ();
  65 }
  66
  67 SCM
  68 Music::get_property_alist (bool m) const
  69 {
  70   return (m) ? mutable_property_alist_ : immutable_property_alist_;
  71 }
  72
  73 SCM
  74 Music::mark_smob (SCM m)
  75 {
  76   Music * mus = (Music *)SCM_CELL_WORD_1 (m);
  77   scm_gc_mark (mus->immutable_property_alist_);
  78   scm_gc_mark (mus->mutable_property_alist_);
  79   return SCM_EOL;
  80 }
  81
  82 Moment
  83 Music::get_length () const
  84 {
  85   SCM l = get_property ("length");
  86   if (unsmob_moment (l))
  87     return *unsmob_moment (l);
  88   else if (gh_procedure_p (l))
  89     {
  90       SCM res = gh_call1 (l, self_scm ());
  91       return *unsmob_moment (res);
  92     }
  93
  94   return 0;
  95 }
  96
  97 Moment
  98 Music::start_mom () const
  99 {
 100   SCM l = get_property ("start-moment-function");
 101   if (gh_procedure_p (l))
 102     {
 103       SCM res = gh_call1 (l, self_scm ());
 104       return *unsmob_moment (res);
 105     }
 106
 107   Moment m ;
 108   return m;
 109 }
 110
 111 void
 112 print_alist (SCM a, SCM port)
 113 {
 114   /*
 115     SCM_EOL  -> catch malformed lists.
 116   */
 117   for (SCM s = a; gh_pair_p (s); s = ly_cdr (s))
 118     {
 119       scm_display (ly_caar (s), port);
 120       scm_puts (" = ", port);
 121       scm_write (ly_cdar (s), port);
 122       scm_puts ("\n", port);
 123     }
 124 }
 125
 126 int
 127 Music::print_smob (SCM s, SCM p, scm_print_state*)
 128 {
 129   scm_puts ("#<Music ", p);
 130   Music* m = unsmob_music (s);
 131
 132   SCM nm = m->get_property ("name");
 133   if (gh_symbol_p (nm) || gh_string_p (nm))
 134     {
 135       scm_display (nm, p);
 136     }
 137   else
 138     {
 139       scm_puts (classname (m),p);
 140     }
 141
 142   /*
 143     Printing properties takes a lot of time, especially during backtraces.
 144     For inspecting, it is better to explicitly use an inspection
 145     function.
 146    */
 147
 148   scm_puts (">",p);
 149   return 1;
 150 }
 151
 152 Pitch
 153 Music::to_relative_octave (Pitch p)
 154 {
 155   SCM elt = get_property ("element");
 156
 157   if (Music* m = unsmob_music (elt))
 158     p = m->to_relative_octave (p);
 159
 160   p = music_list_to_relative (get_property ("elements"),
 161                               p, false);
 162   return p;
 163 }
 164
 165 void
 166 Music::compress (Moment factor)
 167 {
 168   SCM elt = get_property ("element");
 169
 170   if (Music* m = unsmob_music (elt))
 171     m->compress (factor);
 172
 173   compress_music_list (get_property ("elements"), factor);
 174 }
 175
 176
 177 void
 178 Music::transpose (Pitch delta)
 179 {
 180   SCM elt = get_property ("element");
 181
 182   if (Music* m = unsmob_music (elt))
 183     m->transpose (delta);
 184
 185   transpose_music_list (get_property ("elements"), delta);
 186 }
 187
 188
 189 IMPLEMENT_TYPE_P (Music, "ly:music?");
 190
 191 IMPLEMENT_SMOBS (Music);
 192 IMPLEMENT_DEFAULT_EQUAL_P (Music);
 193
 194 /****************************/
 195
 196 SCM
 197 Music::internal_get_property (SCM sym) const
 198 {
 199   SCM s = scm_sloppy_assq (sym, mutable_property_alist_);
 200   if (s != SCM_BOOL_F)
 201     return ly_cdr (s);
 202
 203   s = scm_sloppy_assq (sym, immutable_property_alist_);
 204   return (s == SCM_BOOL_F) ? SCM_EOL : ly_cdr (s);
 205 }
 206
 207 void
 208 Music::internal_set_property (SCM s, SCM v)
 209 {
 210   if (internal_type_checking_global_b)
 211     if (!type_check_assignment (s, v, ly_symbol2scm ("music-type?")))
 212       abort ();
 213
 214   mutable_property_alist_ =  scm_assq_set_x (mutable_property_alist_, s, v);
 215 }
 216
 217 #include "main.hh"
 218
 219 void
 220 Music::set_spot (Input ip)
 221 {
 222   set_property ("origin", make_input (ip));
 223 }
 224
 225 Input*
 226 Music::origin () const
 227 {
 228   Input *ip = unsmob_input (get_property ("origin"));
 229   return ip ? ip : & dummy_input_global;
 230 }
 231
 232
 233 Music::~Music ()
 234 {
 235
 236 }
 237
 238 LY_DEFINE(ly_music_length,
 239           "ly:music-length", 1, 0, 0,  (SCM mus),
 240           "Get the length (in musical time) of music expression @var{mus}.")
 241 {
 242   Music * sc = unsmob_music (mus);
 243   SCM_ASSERT_TYPE(sc, mus, SCM_ARG1, __FUNCTION__, "music");
 244   return sc->get_length().smobbed_copy();
 245 }
 246
 247 LY_DEFINE(ly_music_property,
 248           "ly:music-property", 2, 0, 0,  (SCM mus, SCM sym),
 249           "Get the property @var{sym} of music expression @var{mus}.\n"
 250           "If @var{sym} is undefined, return @code{'()}.\n" )
 251 {
 252   Music * sc = unsmob_music (mus);
 253   SCM_ASSERT_TYPE(sc, mus, SCM_ARG1, __FUNCTION__, "music");
 254   SCM_ASSERT_TYPE(gh_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
 255
 256   return sc->internal_get_property (sym);
 257 }
 258
 259 LY_DEFINE(ly_music_set_property,
 260           "ly:music-set-property!", 3, 0, 0,
 261           (SCM mus, SCM sym, SCM val),
 262           "Set property @var{sym} in music expression @var{mus} to @var{val}.")
 263 {
 264   Music * sc = unsmob_music (mus);
 265   SCM_ASSERT_TYPE(sc, mus, SCM_ARG1, __FUNCTION__, "music");
 266   SCM_ASSERT_TYPE(gh_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
 267
 268   bool ok = type_check_assignment (sym, val, ly_symbol2scm ("music-type?"));
 269   if (ok)
 270     {
 271       sc->internal_set_property (sym, val);
 272     }
 273
 274   return SCM_UNSPECIFIED;
 275 }
 276
 277
 278 LY_DEFINE(ly_music_name, "ly:music-name", 1, 0, 0,
 279   (SCM mus),
 280   "Return the name of @var{music}.")
 281 {
 282   Music * m = unsmob_music (mus);
 283   SCM_ASSERT_TYPE(m, mus, SCM_ARG1, __FUNCTION__ ,"music");
 284
 285   const char * nm = classname (m);
 286   return scm_makfrom0str (nm);
 287 }
 288
 289
 290
 291 // to do  property args
 292 LY_DEFINE(ly_extended_make_music,
 293           "ly:make-bare-music", 2, 0, 0,  (SCM type, SCM props),
 294           "Make a C++ music object of type @var{type}, initialize with\n"
 295           "@var{props}. \n\n"
 296           ""
 297           "This function is for internal use, and is only called by "
 298           "@code{make-music}, which is the preferred interface "
 299           "for creating music objects. "
 300           )
 301 {
 302   SCM_ASSERT_TYPE(gh_string_p (type), type, SCM_ARG1, __FUNCTION__, "string");
 303
 304   SCM s = make_music (ly_scm2string (type))->self_scm ();
 305   unsmob_music (s)->immutable_property_alist_ = props;
 306   scm_gc_unprotect_object (s);
 307   return s;
 308 }
 309
 310 // to do  property args
 311 LY_DEFINE(ly_get_mutable_properties,
 312           "ly:get-mutable-properties", 1, 0, 0,  (SCM mus),
 313           "Return an alist containing the mutable properties of @var{mus}.\n"
 314           "The immutable properties are not available; they should be initialized\n"
 315           "by the  @code{make-music} function.\n"
 316           )
 317 {
 318   Music *m = unsmob_music (mus);
 319   SCM_ASSERT_TYPE(m, mus, SCM_ARG1, __FUNCTION__, "music");
 320
 321   return m->get_property_alist (true);
 322 }
 323
 324 LY_DEFINE(ly_music_list_p,"ly:music-list?", 1, 0, 0,
 325   (SCM l),"Type predicate: return true if @var{l} is a list of music objects.")
 326 {
 327   if (scm_list_p (l) != SCM_BOOL_T)
 328     return SCM_BOOL_F;
 329
 330   while (gh_pair_p (l))
 331     {
 332       if (!unsmob_music (gh_car (l)))
 333         return SCM_BOOL_F;
 334       l =gh_cdr (l);
 335     }
 336   return SCM_BOOL_T;
 337 }
 338 ADD_MUSIC(Music);
 339
 340
 341
 342 LY_DEFINE(ly_deep_mus_copy,
 343           "ly:music-deep-copy", 1,0,0, (SCM m),
 344           "Copy @var{m} and all sub expressions of @var{m}")
 345 {
 346   if (unsmob_music (m))
 347     {
 348       SCM ss =  unsmob_music (m)->clone ()->self_scm ();
 349       scm_gc_unprotect_object (ss);
 350       return ss;
 351     }
 352   else if (gh_pair_p (m))
 353     {
 354       return gh_cons (ly_deep_mus_copy (ly_car (m)), ly_deep_mus_copy (ly_cdr (m)));
 355     }
 356   else
 357     return m;
 358 }
 359
 360 LY_DEFINE(ly_music_transpose,
 361           "ly:music-transpose", 2,0,0, (SCM m, SCM p),
 362           "Transpose @var{m} such that central C is mapped to @var{p}. "
 363 "Return @var{m}.")
 364 {
 365   Music * sc = unsmob_music (m);
 366   Pitch * sp = unsmob_pitch (p);
 367   SCM_ASSERT_TYPE(sc, m, SCM_ARG1, __FUNCTION__, "music");
 368   SCM_ASSERT_TYPE(sp, p, SCM_ARG2, __FUNCTION__, "pitch");
 369
 370   sc->transpose (*sp);
 371   return sc->self_scm();        // SCM_UNDEFINED ?
 372 }
 373
 374
 375 SCM make_music_proc;
 376
 377
 378 Music*
 379 make_music_by_name (SCM sym)
 380 {
 381   if (!make_music_proc)
 382     make_music_proc = scm_primitive_eval (ly_symbol2scm ("make-music"));
 383
 384   SCM rv = scm_call_1 (make_music_proc, sym);
 385
 386   /*
 387     UGH.
 388   */
 389   scm_gc_protect_object (rv);
 390   return unsmob_music (rv);
 391 }
 392