lily/music-scheme.cc

   1 /*
   2   music-scheme.cc --  implement
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 2005 Han-Wen Nienhuys <hanwen@xs4all.nl>
   7
   8 */
   9
  10 #include "music.hh"
  11 #include "pitch.hh"
  12
  13 LY_DEFINE (ly_music_length, "ly:music-length",
  14            1, 0, 0, (SCM mus),
  15           "Get the length of music expression @var{mus}, and return as a @code{Moment} object.")
  16 {
  17   Music *sc = unsmob_music (mus);
  18   SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
  19   return sc->get_length ().smobbed_copy ();
  20 }
  21
  22 LY_DEFINE (ly_music_property,
  23           "ly:music-property", 2, 0, 0, (SCM mus, SCM sym),
  24           "Get the property @var{sym} of music expression @var{mus}.\n"
  25           "If @var{sym} is undefined, return @code{' ()}.\n" )
  26 {
  27   Music * sc = unsmob_music (mus);
  28   SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
  29   SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
  30
  31   return sc->internal_get_property (sym);
  32 }
  33
  34 LY_DEFINE (ly_music_set_property, "ly:music-set-property!",
  35           3, 0, 0, (SCM mus, SCM sym, SCM val),
  36           "Set property @var{sym} in music expression @var{mus} to @var{val}.")
  37 {
  38   Music * sc = unsmob_music (mus);
  39   SCM_ASSERT_TYPE (sc, mus, SCM_ARG1, __FUNCTION__, "music");
  40   SCM_ASSERT_TYPE (scm_is_symbol (sym), sym, SCM_ARG2, __FUNCTION__, "symbol");
  41
  42   bool ok = type_check_assignment (sym, val, ly_symbol2scm ("music-type?"));
  43   if (ok)
  44     {
  45       sc->internal_set_property (sym, val);
  46     }
  47
  48   return SCM_UNSPECIFIED;
  49 }
  50
  51 LY_DEFINE (ly_music_name, "ly:music-name",
  52            1, 0, 0, (SCM mus),
  53            "Return the name of @var{music}.")
  54 {
  55   Music *m = unsmob_music (mus);
  56   SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__ ,"music");
  57
  58   char const *nm = classname (m);
  59   return scm_makfrom0str (nm);
  60 }
  61
  62 /* todo:  property args */
  63 LY_DEFINE (ly_extended_make_music, "ly:make-bare-music",
  64            2, 0, 0, (SCM type, SCM props),
  65           "Make a C++ music object of type @var{type}, initialize with\n"
  66           "@var{props}. \n\n"
  67           ""
  68           "This function is for internal use, and is only called by "
  69           "@code{make-music}, which is the preferred interface "
  70           "for creating music objects. "
  71           )
  72 {
  73   SCM_ASSERT_TYPE (scm_is_string (type), type, SCM_ARG1, __FUNCTION__, "string");
  74   SCM s = make_music (ly_scm2string (type))->self_scm ();
  75   unsmob_music (s)->immutable_property_alist_ = props;
  76   scm_gc_unprotect_object (s);
  77   return s;
  78 }
  79
  80 /* todo: property args */
  81 LY_DEFINE (ly_music_mutable_properties, "ly:music-mutable-properties",
  82           1, 0, 0, (SCM mus),
  83           "Return an alist containing the mutable properties of @var{mus}.\n"
  84           "The immutable properties are not available, since "
  85           "they are constant and initialized by the "
  86            "@code{make-music} function.\n")
  87 {
  88   Music *m = unsmob_music (mus);
  89   SCM_ASSERT_TYPE (m, mus, SCM_ARG1, __FUNCTION__, "music");
  90   return m->get_property_alist (true);
  91 }
  92
  93 LY_DEFINE (ly_music_list_p,"ly:music-list?",
  94            1, 0, 0, (SCM lst),
  95            "Type predicate: return true if @var{lst} is a list "
  96            "of music objects.")
  97 {
  98   if (scm_list_p (lst) == SCM_BOOL_T)
  99     while (scm_is_pair (lst))
 100       {
 101         if (!unsmob_music (scm_car (lst)))
 102           return SCM_BOOL_F;
 103         lst = scm_cdr (lst);
 104       }
 105
 106   return SCM_BOOL_T;
 107 }
 108
 109 LY_DEFINE (ly_music_deep_copy, "ly:music-deep-copy",
 110           1, 0, 0, (SCM m),
 111           "Copy @var{m} and all sub expressions of @var{m}")
 112 {
 113   SCM copy = m;
 114   if (unsmob_music (m))
 115     {
 116       copy = unsmob_music (m)->clone ()->self_scm ();
 117       scm_gc_unprotect_object (copy);
 118     }
 119   else if (scm_is_pair (m))
 120     copy = scm_cons (ly_music_deep_copy (scm_car (m)),
 121                     ly_music_deep_copy (scm_cdr (m)));
 122   return copy;
 123 }
 124
 125 LY_DEFINE (ly_music_transpose, "ly:music-transpose",
 126           2, 0, 0, (SCM m, SCM p),
 127           "Transpose @var{m} such that central C is mapped to @var{p}. "
 128           "Return @var{m}.")
 129 {
 130   Music * sc = unsmob_music (m);
 131   Pitch * sp = unsmob_pitch (p);
 132   SCM_ASSERT_TYPE (sc, m, SCM_ARG1, __FUNCTION__, "music");
 133   SCM_ASSERT_TYPE (sp, p, SCM_ARG2, __FUNCTION__, "pitch");
 134
 135   sc->transpose (*sp);
 136   // SCM_UNDEFINED ?
 137   return sc->self_scm ();
 138 }
 139
 140 /*
 141   TODO: should take moment factor?
 142  */
 143 LY_DEFINE (ly_music_compress, "ly:music-compress",
 144           2, 0, 0, (SCM m, SCM factor),
 145           "Compress music object @var{m} by moment @var{factor}."
 146            )
 147 {
 148   Music * sc = unsmob_music (m);
 149
 150   SCM_ASSERT_TYPE (sc, m, SCM_ARG1, __FUNCTION__, "music");
 151   SCM_ASSERT_TYPE (unsmob_moment (factor), factor, SCM_ARG2, __FUNCTION__, "moment");
 152
 153   sc->compress (*unsmob_moment (factor));
 154   return sc->self_scm ();
 155 }
 156