2 music.cc -- implement Music
4 source file of the GNU LilyPond music typesetter
6 (c) 1997--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
10 #include "input-smob.hh"
12 #include "music-list.hh"
15 #include "ly-smobs.icc"
20 Music::internal_is_music_type (SCM k) const
22 SCM ifs = get_property ("types");
24 return scm_c_memq (k, ifs) != SCM_BOOL_F;
30 SCM nm = get_property ("name");
33 return ly_symbol2string (nm);
37 return classname (this);
44 immutable_property_alist_ = SCM_EOL;
45 mutable_property_alist_ = SCM_EOL;
49 Music::Music (Music const &m)
51 immutable_property_alist_ = m.immutable_property_alist_;
52 mutable_property_alist_ = SCM_EOL;
55 /* First we smobify_self, then we copy over the stuff. If we don't,
56 stack vars that hold the copy might be optimized away, meaning
57 that they won't be protected from GC. */
59 mutable_property_alist_ = ly_deep_mus_copy (m.mutable_property_alist_);
60 set_spot (*m.origin ());
70 Music::get_property_alist (bool m) const
72 return (m) ? mutable_property_alist_ : immutable_property_alist_;
76 Music::mark_smob (SCM m)
78 Music *mus = (Music*) SCM_CELL_WORD_1 (m);
79 scm_gc_mark (mus->immutable_property_alist_);
80 scm_gc_mark (mus->mutable_property_alist_);
85 Music::get_length () const
87 SCM lst = get_property ("length");
88 if (unsmob_moment (lst))
89 return *unsmob_moment (lst);
90 else if (gh_procedure_p (lst))
92 SCM res = gh_call1 (lst, self_scm ());
93 return *unsmob_moment (res);
100 Music::start_mom () const
102 SCM lst = get_property ("start-moment-function");
103 if (gh_procedure_p (lst))
105 SCM res = gh_call1 (lst, self_scm ());
106 return *unsmob_moment (res);
114 print_alist (SCM a, SCM port)
116 /* SCM_EOL -> catch malformed lists. */
117 for (SCM s = a; gh_pair_p (s); s = ly_cdr (s))
119 scm_display (ly_caar (s), port);
120 scm_puts (" = ", port);
121 scm_write (ly_cdar (s), port);
122 scm_puts ("\n", port);
127 Music::print_smob (SCM s, SCM p, scm_print_state*)
129 scm_puts ("#<Music ", p);
130 Music* m = unsmob_music (s);
132 SCM nm = m->get_property ("name");
133 if (gh_symbol_p (nm) || gh_string_p (nm))
136 scm_puts (classname (m),p);
138 /* Printing properties takes a lot of time, especially during backtraces.
139 For inspecting, it is better to explicitly use an inspection
147 Music::to_relative_octave (Pitch p)
149 SCM elt = get_property ("element");
151 if (Music *m = unsmob_music (elt))
152 p = m->to_relative_octave (p);
154 p = music_list_to_relative (get_property ("elements"), p, false);
159 Music::compress (Moment factor)
161 SCM elt = get_property ("element");
163 if (Music *m = unsmob_music (elt))
164 m->compress (factor);
166 compress_music_list (get_property ("elements"), factor);
170 Music::transpose (Pitch delta)
172 SCM elt = get_property ("element");
174 if (Music* m = unsmob_music (elt))
175 m->transpose (delta);
177 transpose_music_list (get_property ("elements"), delta);
180 IMPLEMENT_TYPE_P (Music, "ly:music?");
181 IMPLEMENT_SMOBS (Music);
182 IMPLEMENT_DEFAULT_EQUAL_P (Music);
185 Music::internal_get_property (SCM sym) const
187 SCM s = scm_sloppy_assq (sym, mutable_property_alist_);
191 s = scm_sloppy_assq (sym, immutable_property_alist_);
192 return (s == SCM_BOOL_F) ? SCM_EOL : ly_cdr (s);
196 Music::internal_set_property (SCM s, SCM v)
198 if (internal_type_checking_global_b)
199 if (!type_check_assignment (s, v, ly_symbol2scm ("music-type?")))
202 mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, s, v);
206 Music::set_spot (Input ip)
208 set_property ("origin", make_input (ip));
212 Music::origin () const
214 Input *ip = unsmob_input (get_property ("origin"));
215 return ip ? ip : & dummy_input_global;
218 LY_DEFINE (ly_music_length, "ly:music-length",
220 "Get the length of music expression @var{mus}, and return as a @code{Moment} object.")
222 Music *sc = unsmob_music (mus);
223 SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
224 return sc->get_length ().smobbed_copy ();
227 LY_DEFINE (ly_music_property,
228 "ly:music-property", 2, 0, 0, (SCM mus, SCM sym),
229 "Get the property @var{sym} of music expression @var{mus}.\n"
230 "If @var{sym} is undefined, return @code{' ()}.\n" )
232 Music * sc = unsmob_music (mus);
233 SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
234 SCM_ASSERT_TYPE (gh_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
236 return sc->internal_get_property (sym);
239 LY_DEFINE (ly_music_set_property, "ly:music-set-property!",
240 3, 0, 0, (SCM mus, SCM sym, SCM val),
241 "Set property @var{sym} in music expression @var{mus} to @var{val}.")
243 Music * sc = unsmob_music (mus);
244 SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
245 SCM_ASSERT_TYPE (gh_symbol_p (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
247 bool ok = type_check_assignment (sym, val, ly_symbol2scm ("music-type?"));
250 sc->internal_set_property (sym, val);
253 return SCM_UNSPECIFIED;
256 LY_DEFINE (ly_music_name, "ly:music-name",
258 "Return the name of @var{music}.")
260 Music *m = unsmob_music (mus);
261 SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__ ,"music");
263 char const *nm = classname (m);
264 return scm_makfrom0str (nm);
267 /* todo: property args */
268 LY_DEFINE (ly_extended_make_music, "ly:make-bare-music",
269 2, 0, 0, (SCM type, SCM props),
270 "Make a C++ music object of type @var{type}, initialize with\n"
273 "This function is for internal use, and is only called by "
274 "@code{make-music}, which is the preferred interface "
275 "for creating music objects. "
278 SCM_ASSERT_TYPE (gh_string_p (type), type, SCM_ARG1, __FUNCTION__, "string");
279 SCM s = make_music (ly_scm2string (type))->self_scm ();
280 unsmob_music (s)->immutable_property_alist_ = props;
281 scm_gc_unprotect_object (s);
285 /* todo: property args */
286 LY_DEFINE (ly_music_mutable_properties, "ly:music-mutable-properties",
288 "Return an alist containing the mutable properties of @var{mus}.\n"
289 "The immutable properties are not available, since "
290 "they are constant and initialized by the "
291 "@code{make-music} function.\n")
293 Music *m = unsmob_music (mus);
294 SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "music");
295 return m->get_property_alist (true);
298 LY_DEFINE (ly_music_list_p,"ly:music-list?",
300 "Type predicate: return true if @var{lst} is a list "
303 if (scm_list_p (lst) == SCM_BOOL_T)
304 while (gh_pair_p (lst))
306 if (!unsmob_music (gh_car (lst)))
314 LY_DEFINE (ly_deep_mus_copy, "ly:music-deep-copy",
316 "Copy @var{m} and all sub expressions of @var{m}")
319 if (unsmob_music (m))
321 copy = unsmob_music (m)->clone ()->self_scm ();
322 scm_gc_unprotect_object (copy);
324 else if (gh_pair_p (m))
325 copy = gh_cons (ly_deep_mus_copy (ly_car (m)),
326 ly_deep_mus_copy (ly_cdr (m)));
330 LY_DEFINE (ly_music_transpose, "ly:music-transpose",
331 2, 0, 0, (SCM m, SCM p),
332 "Transpose @var{m} such that central C is mapped to @var{p}. "
335 Music * sc = unsmob_music (m);
336 Pitch * sp = unsmob_pitch (p);
337 SCM_ASSERT_TYPE (sc, m, SCM_ARG1, __FUNCTION__, "music");
338 SCM_ASSERT_TYPE (sp, p, SCM_ARG2, __FUNCTION__, "pitch");
342 return sc->self_scm ();
346 TODO: should take moment factor?
348 LY_DEFINE (ly_music_compress, "ly:music-compress",
349 2, 0, 0, (SCM m, SCM factor),
350 "Compress music object @var{m} by moment @var{factor}."
353 Music * sc = unsmob_music (m);
355 SCM_ASSERT_TYPE (sc, m, SCM_ARG1, __FUNCTION__, "music");
356 SCM_ASSERT_TYPE (unsmob_moment (factor), factor, SCM_ARG2, __FUNCTION__, "moment");
358 sc->compress (*unsmob_moment (factor));
359 return sc->self_scm ();
363 make_music_by_name (SCM sym)
365 SCM make_music_proc = ly_scheme_function ("make-music");
366 SCM rv = scm_call_1 (make_music_proc, sym);
369 scm_gc_protect_object (rv);
370 return unsmob_music (rv);