lily/context-scheme.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1998--2015 Jan Nieuwenhuizen <janneke@gnu.org>
   5   Han-Wen Nienhuys <hanwen@xs4all.nl>
   6
   7   LilyPond is free software: you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation, either version 3 of the License, or
  10   (at your option) any later version.
  11
  12   LilyPond is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include "context.hh"
  22 #include "context-def.hh"
  23 #include "dispatcher.hh"
  24 #include "grob-properties.hh"
  25
  26 LY_DEFINE (ly_context_current_moment,
  27            "ly:context-current-moment",
  28            1, 0, 0, (SCM context),
  29            "Return the current moment of @var{context}.")
  30 {
  31   Context *tr = unsmob<Context> (context);
  32
  33   LY_ASSERT_SMOB (Context, context, 1);
  34
  35   return tr->now_mom ().smobbed_copy ();
  36 }
  37
  38 LY_DEFINE (ly_context_id, "ly:context-id",
  39            1, 0, 0, (SCM context),
  40            "Return the ID string of @var{context},"
  41            " i.e., for @code{\\context Voice = \"one\" @dots{}}"
  42            " return the string @code{one}.")
  43 {
  44   Context *tr = unsmob<Context> (context);
  45
  46   LY_ASSERT_SMOB (Context, context, 1);
  47
  48   return ly_string2scm (tr->id_string ());
  49 }
  50
  51 LY_DEFINE (ly_context_name, "ly:context-name",
  52            1, 0, 0, (SCM context),
  53            "Return the name of @var{context},"
  54            " i.e., for @code{\\context Voice = \"one\" @dots{}}"
  55            " return the symbol @code{Voice}.")
  56 {
  57   LY_ASSERT_SMOB (Context, context, 1);
  58
  59   Context *tr = unsmob<Context> (context);
  60
  61   return ly_symbol2scm (tr->context_name ().c_str ());
  62 }
  63
  64 LY_DEFINE (ly_context_grob_definition, "ly:context-grob-definition",
  65            2, 0, 0, (SCM context, SCM name),
  66            "Return the definition of @var{name} (a symbol) within"
  67            " @var{context} as an alist.")
  68 {
  69   Context *tr = unsmob<Context> (context);
  70
  71   LY_ASSERT_SMOB (Context, context, 1);
  72   LY_ASSERT_TYPE (ly_is_symbol, name, 2);
  73
  74   return Grob_property_info (tr, name).updated ();
  75 }
  76
  77 LY_DEFINE (ly_context_pushpop_property, "ly:context-pushpop-property",
  78            3, 1, 0, (SCM context, SCM grob, SCM eltprop, SCM val),
  79            "Do @code{\\temporary \\override} or @code{\\revert} operation"
  80            " in @var{context}.  The grob definition @var{grob} is extended"
  81            " with @var{eltprop} (if @var{val} is specified) or reverted"
  82            " (if unspecified).")
  83 {
  84   Context *tg = unsmob<Context> (context);
  85
  86   LY_ASSERT_SMOB (Context, context, 1);
  87   LY_ASSERT_TYPE (ly_is_symbol, grob, 2);
  88   LY_ASSERT_TYPE (ly_is_symbol, eltprop, 3);
  89
  90   execute_pushpop_property (tg, grob, eltprop, val);
  91
  92   return SCM_UNSPECIFIED;
  93 }
  94
  95 LY_DEFINE (ly_context_matched_pop_property, "ly:context-matched-pop-property",
  96            3, 0, 0, (SCM context, SCM grob, SCM cell),
  97            "This undoes a particular @code{\\override},"
  98            " @code{\\once \\override} or @code{\\once \\revert}"
  99            " when given the specific alist pair to undo.")
 100 {
 101   Context *tg = LY_ASSERT_SMOB (Context, context, 1);
 102   LY_ASSERT_TYPE (ly_is_symbol, grob, 2);
 103   Grob_property_info (tg, grob).matched_pop (cell);
 104   return SCM_UNSPECIFIED;
 105 }
 106
 107
 108 LY_DEFINE (ly_context_property, "ly:context-property",
 109            2, 1, 0, (SCM context, SCM sym, SCM def),
 110            "Return the value for property @var{sym} in @var{context}."
 111            " If @var{def} is given, and property value is @code{'()},"
 112            " return @var{def}.")
 113 {
 114   LY_ASSERT_SMOB (Context, context, 1);
 115   LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
 116
 117   Context *t = unsmob<Context> (context);
 118   SCM result = t->get_property (sym);
 119   return !SCM_UNBNDP (def) && scm_is_null (result) ? def : result;
 120 }
 121
 122 LY_DEFINE (ly_context_set_property_x, "ly:context-set-property!",
 123            3, 0, 0, (SCM context, SCM name, SCM val),
 124            "Set value of property @var{name} in context @var{context}"
 125            " to @var{val}.")
 126 {
 127   LY_ASSERT_SMOB (Context, context, 1);
 128   LY_ASSERT_TYPE (ly_is_symbol, name, 2);
 129
 130   Context *tr = unsmob<Context> (context);
 131
 132   tr->set_property (name, val);
 133
 134   return SCM_UNSPECIFIED;
 135 }
 136
 137 LY_DEFINE (ly_context_property_where_defined, "ly:context-property-where-defined",
 138            2, 0, 0, (SCM context, SCM name),
 139            "Return the context above @var{context}"
 140            " where @var{name} is defined.")
 141 {
 142   LY_ASSERT_SMOB (Context, context, 1);
 143   LY_ASSERT_TYPE (ly_is_symbol, name, 2);
 144
 145   Context *tr = unsmob<Context> (context);
 146
 147   SCM val;
 148   tr = tr->where_defined (name, &val);
 149   if (tr)
 150     return tr->self_scm ();
 151
 152   return SCM_EOL;
 153 }
 154
 155 LY_DEFINE (ly_context_unset_property, "ly:context-unset-property", 2, 0, 0,
 156            (SCM context, SCM name),
 157            "Unset value of property @var{name} in context @var{context}.")
 158 {
 159   LY_ASSERT_SMOB (Context, context, 1);
 160   LY_ASSERT_TYPE (ly_is_symbol, name, 2);
 161   Context *tr = unsmob<Context> (context);
 162
 163   tr->unset_property (name);
 164   return SCM_UNSPECIFIED;
 165 }
 166
 167 LY_DEFINE (ly_context_parent, "ly:context-parent",
 168            1, 0, 0, (SCM context),
 169            "Return the parent of @var{context}, @code{#f} if none.")
 170 {
 171   LY_ASSERT_SMOB (Context, context, 1);
 172   Context *tr = unsmob<Context> (context);
 173
 174   tr = tr->get_parent_context ();
 175   if (tr)
 176     return tr->self_scm ();
 177   else
 178     return SCM_BOOL_F;
 179 }
 180
 181 /* FIXME: todo: should support translator IDs, and creation? */
 182 LY_DEFINE (ly_context_find, "ly:context-find",
 183            2, 0, 0, (SCM context, SCM name),
 184            "Find a parent of @var{context} that has name or alias @var{name}."
 185            "  Return @code{#f} if not found.")
 186 {
 187   LY_ASSERT_SMOB (Context, context, 1);
 188   LY_ASSERT_TYPE (ly_is_symbol, name, 2);
 189   Context *tr = unsmob<Context> (context);
 190
 191   while (tr)
 192     {
 193       if (tr->is_alias (name))
 194         return tr->self_scm ();
 195       tr = tr->get_parent_context ();
 196     }
 197
 198   return SCM_BOOL_F;
 199 }
 200
 201 LY_DEFINE (ly_context_now, "ly:context-now",
 202            1, 0, 0, (SCM context),
 203            "Return @code{now-moment} of context @var{context}.")
 204 {
 205   LY_ASSERT_SMOB (Context, context, 1);
 206   Context *ctx = unsmob<Context> (context);
 207   return ctx->now_mom ().smobbed_copy ();
 208 }
 209
 210 LY_DEFINE (ly_context_event_source, "ly:context-event-source",
 211            1, 0, 0, (SCM context),
 212            "Return @code{event-source} of context @var{context}.")
 213 {
 214   LY_ASSERT_SMOB (Context, context, 1);
 215   Context *ctx = unsmob<Context> (context);
 216   return ctx->event_source ()->self_scm ();
 217 }
 218
 219 LY_DEFINE (ly_context_events_below, "ly:context-events-below",
 220            1, 0, 0, (SCM context),
 221            "Return a @code{stream-distributor} that distributes all events"
 222            " from @var{context} and all its subcontexts.")
 223 {
 224   LY_ASSERT_SMOB (Context, context, 1);
 225   Context *ctx = unsmob<Context> (context);
 226   return ctx->events_below ()->self_scm ();
 227 }