lily/context-def.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2000--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
   5
   6   LilyPond is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   LilyPond is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 /* TODO: should junk this class an replace by
  21    a single list of context modifications?  */
  22
  23 #include "context-def.hh"
  24
  25 #include "context.hh"
  26 #include "context-mod.hh"
  27 #include "international.hh"
  28 #include "output-def.hh"
  29 #include "translator.hh"
  30 #include "warn.hh"
  31
  32 Context_def::Context_def ()
  33 {
  34   context_aliases_ = SCM_EOL;
  35   translator_group_type_ = SCM_EOL;
  36   accept_mods_ = SCM_EOL;
  37   translator_mods_ = SCM_EOL;
  38   property_ops_ = SCM_EOL;
  39   context_name_ = SCM_EOL;
  40   default_child_ = SCM_EOL;
  41   description_ = SCM_EOL;
  42   input_location_ = SCM_EOL;
  43
  44   smobify_self ();
  45
  46   input_location_ = make_input (Input ());
  47   context_name_ = ly_symbol2scm ("");
  48 }
  49
  50 Input *
  51 Context_def::origin () const
  52 {
  53   return unsmob_input (input_location_);
  54 }
  55
  56 Context_def::Context_def (Context_def const &s)
  57 {
  58   context_aliases_ = SCM_EOL;
  59   translator_group_type_ = SCM_EOL;
  60   accept_mods_ = SCM_EOL;
  61   translator_mods_ = SCM_EOL;
  62   property_ops_ = SCM_EOL;
  63   context_name_ = SCM_EOL;
  64   description_ = SCM_EOL;
  65   default_child_ = SCM_EOL;
  66   input_location_ = SCM_EOL;
  67   smobify_self ();
  68
  69   description_ = s.description_;
  70   input_location_ = make_input (*s.origin ());
  71   default_child_ = s.default_child_;
  72   accept_mods_ = s.accept_mods_;
  73   property_ops_ = s.property_ops_;
  74   translator_mods_ = s.translator_mods_;
  75   context_aliases_ = s.context_aliases_;
  76   translator_group_type_ = s.translator_group_type_;
  77   context_name_ = s.context_name_;
  78 }
  79
  80 Context_def::~Context_def ()
  81 {
  82 }
  83
  84 #include "ly-smobs.icc"
  85 IMPLEMENT_SMOBS (Context_def);
  86 IMPLEMENT_DEFAULT_EQUAL_P (Context_def);
  87 IMPLEMENT_TYPE_P (Context_def, "ly:context-def?");
  88
  89 int
  90 Context_def::print_smob (SCM smob, SCM port, scm_print_state *)
  91 {
  92   Context_def *me = (Context_def *) SCM_CELL_WORD_1 (smob);
  93
  94   scm_puts ("#<Context_def ", port);
  95   scm_display (me->context_name_, port);
  96   scm_puts (">", port);
  97   return 1;
  98 }
  99
 100 SCM
 101 Context_def::mark_smob (SCM smob)
 102 {
 103   ASSERT_LIVE_IS_ALLOWED ();
 104
 105   Context_def *me = (Context_def *) SCM_CELL_WORD_1 (smob);
 106
 107   scm_gc_mark (me->description_);
 108   scm_gc_mark (me->context_aliases_);
 109   scm_gc_mark (me->accept_mods_);
 110   scm_gc_mark (me->translator_mods_);
 111   scm_gc_mark (me->property_ops_);
 112   scm_gc_mark (me->translator_group_type_);
 113   scm_gc_mark (me->default_child_);
 114   scm_gc_mark (me->input_location_);
 115
 116   return me->context_name_;
 117 }
 118
 119 void
 120 Context_def::add_context_mod (SCM mod)
 121 {
 122   SCM tag = scm_car (mod);
 123   if (ly_symbol2scm ("description") == tag)
 124     {
 125       description_ = scm_cadr (mod);
 126       return;
 127     }
 128
 129   /*
 130     other modifiers take symbols as argument.
 131   */
 132   SCM sym = scm_cadr (mod);
 133   if (scm_is_string (sym))
 134     sym = scm_string_to_symbol (sym);
 135
 136   if (ly_symbol2scm ("default-child") == tag)
 137     default_child_ = sym;
 138   else if (ly_symbol2scm ("consists") == tag
 139            || ly_symbol2scm ("remove") == tag)
 140     {
 141       translator_mods_ = scm_cons (scm_list_2 (tag, sym), translator_mods_);
 142     }
 143   else if (ly_symbol2scm ("accepts") == tag
 144            || ly_symbol2scm ("denies") == tag)
 145     accept_mods_ = scm_cons (scm_list_2 (tag, sym), accept_mods_);
 146   else if (ly_symbol2scm ("pop") == tag
 147            || ly_symbol2scm ("push") == tag
 148            || ly_symbol2scm ("assign") == tag
 149            || ly_symbol2scm ("unset") == tag)
 150     property_ops_ = scm_cons (mod, property_ops_);
 151   else if (ly_symbol2scm ("alias") == tag)
 152     context_aliases_ = scm_cons (sym, context_aliases_);
 153   else if (ly_symbol2scm ("translator-type") == tag)
 154     translator_group_type_ = sym;
 155   else if (ly_symbol2scm ("context-name") == tag)
 156     context_name_ = sym;
 157   else
 158     programming_error ("unknown context mod tag");
 159 }
 160
 161 SCM
 162 Context_def::get_accepted (SCM user_mod) const
 163 {
 164   SCM mods = scm_reverse_x (scm_list_copy (accept_mods_), user_mod);
 165   SCM acc = SCM_EOL;
 166   for (SCM s = mods; scm_is_pair (s); s = scm_cdr (s))
 167     {
 168       SCM tag = scm_caar (s);
 169       SCM sym = scm_cadar (s);
 170       if (tag == ly_symbol2scm ("accepts"))
 171         acc = scm_cons (sym, acc);
 172       else if (tag == ly_symbol2scm ("denies"))
 173         acc = scm_delete_x (sym, acc);
 174     }
 175
 176   SCM def = get_default_child (user_mod);
 177   if (scm_is_symbol (def))
 178     {
 179       acc = scm_delete_x (def, acc);
 180       acc = scm_cons (def, acc);
 181     }
 182
 183   return acc;
 184 }
 185
 186 SCM
 187 Context_def::get_default_child (SCM user_mod) const
 188 {
 189   SCM name = default_child_;
 190   for (SCM s = user_mod; scm_is_pair (s); s = scm_cdr (s))
 191     {
 192       SCM entry = scm_car (s);
 193       if (scm_car (entry) == ly_symbol2scm ("default-child"))
 194         {
 195           name = scm_cadr (entry);
 196           break;
 197         }
 198     }
 199
 200   return name;
 201 }
 202
 203 /*
 204   Given a name of a context that we want to create, finds a list of context
 205   definitions such that:
 206    - the first element in the list defines a context that is a valid child of
 207      the context defined by this Context_def
 208    - each subsequent element in the list defines a context that is a valid child
 209      of the context defined by the preceding element in the list
 210    - the last element in the list defines a context with the given name
 211
 212   The ADDITIONAL_ACCEPTS parameter is a list of additional contexts that this
 213   specific context def (but not any of the child context defs) should accept.
 214 */
 215 vector<Context_def *>
 216 Context_def::path_to_acceptable_context (SCM type_sym,
 217                                          Output_def *odef,
 218                                          SCM additional_accepts) const
 219 {
 220   set<const Context_def *> seen;
 221   return internal_path_to_acceptable_context (type_sym, odef, additional_accepts, &seen);
 222 }
 223
 224 /*
 225 The SEEN parameter is a set which keeps track of visited contexts, allowing
 226 contexts of the same type to be nested.
 227 */
 228 vector<Context_def *>
 229 Context_def::internal_path_to_acceptable_context (SCM type_sym,
 230                                                   Output_def *odef,
 231                                                   SCM additional_accepts,
 232                                                   set<const Context_def *> *seen) const
 233 {
 234   assert (scm_is_symbol (type_sym));
 235
 236   SCM accepted = get_accepted (additional_accepts);
 237
 238   vector<Context_def *> accepteds;
 239   for (SCM s = accepted; scm_is_pair (s); s = scm_cdr (s))
 240     if (Context_def *t = unsmob_context_def (find_context_def (odef,
 241                                                                scm_car (s))))
 242       accepteds.push_back (t);
 243
 244   vector<Context_def *> best_result;
 245   for (vsize i = 0; i < accepteds.size (); i++)
 246     {
 247       /* do not check aliases, because \context Staff should not
 248          create RhythmicStaff. */
 249       if (ly_is_equal (accepteds[i]->get_context_name (), type_sym))
 250         {
 251           best_result.push_back (accepteds[i]);
 252           return best_result;
 253         }
 254     }
 255
 256   seen->insert (this);
 257   vsize best_depth = INT_MAX;
 258   for (vsize i = 0; i < accepteds.size (); i++)
 259     {
 260       Context_def *g = accepteds[i];
 261
 262       if (!seen->count (g))
 263         {
 264           vector<Context_def *> result
 265             = g->internal_path_to_acceptable_context (type_sym, odef, SCM_EOL, seen);
 266           if (result.size () && result.size () < best_depth)
 267             {
 268               best_depth = result.size ();
 269               result.insert (result.begin (), g);
 270               best_result = result;
 271             }
 272         }
 273     }
 274   seen->erase (this);
 275
 276   return best_result;
 277 }
 278
 279 SCM
 280 Context_def::get_translator_names (SCM user_mod) const
 281 {
 282   SCM l1 = SCM_EOL;
 283
 284   SCM mods = scm_reverse_x (scm_list_copy (translator_mods_), user_mod);
 285
 286   for (SCM s = mods; scm_is_pair (s); s = scm_cdr (s))
 287     {
 288       SCM tag = scm_caar (s);
 289       SCM arg = scm_cadar (s);
 290
 291       if (scm_is_string (arg))
 292         arg = scm_string_to_symbol (arg);
 293
 294       if (ly_symbol2scm ("consists") == tag)
 295         l1 = scm_cons (arg, l1);
 296       else if (ly_symbol2scm ("remove") == tag
 297                && (scm_is_pair (arg)
 298                    || ly_is_procedure (arg)
 299                    || get_translator (arg)))
 300         l1 = scm_delete_x (arg, l1);
 301     }
 302
 303   return l1;
 304 }
 305
 306 Context *
 307 Context_def::instantiate (SCM ops)
 308 {
 309   Context *context = new Context ();
 310
 311   context->definition_ = self_scm ();
 312   context->definition_mods_ = ops;
 313   context->aliases_ = context_aliases_;
 314   context->accepts_list_ = get_accepted (ops);
 315
 316   return context;
 317 }
 318
 319 SCM
 320 Context_def::make_scm ()
 321 {
 322   Context_def *t = new Context_def;
 323   return t->unprotect ();
 324 }
 325
 326 void
 327 Context_def::apply_default_property_operations (Context *tg)
 328 {
 329   apply_property_operations (tg, property_ops_);
 330 }
 331
 332 SCM
 333 Context_def::to_alist () const
 334 {
 335   SCM ell = SCM_EOL;
 336
 337   ell = scm_cons (scm_cons (ly_symbol2scm ("consists"),
 338                             get_translator_names (SCM_EOL)), ell);
 339   ell = scm_cons (scm_cons (ly_symbol2scm ("description"), description_), ell);
 340   ell = scm_cons (scm_cons (ly_symbol2scm ("aliases"), context_aliases_), ell);
 341   ell = scm_cons (scm_cons (ly_symbol2scm ("accepts"), get_accepted (SCM_EOL)),
 342                   ell);
 343   ell = scm_cons (scm_cons (ly_symbol2scm ("property-ops"), property_ops_),
 344                   ell);
 345   ell = scm_cons (scm_cons (ly_symbol2scm ("context-name"), context_name_),
 346                   ell);
 347
 348   if (scm_is_symbol (translator_group_type_))
 349     ell = scm_cons (scm_cons (ly_symbol2scm ("group-type"),
 350                               translator_group_type_), ell);
 351   return ell;
 352 }
 353
 354 SCM
 355 Context_def::lookup (SCM sym) const
 356 {
 357   if (scm_is_eq (ly_symbol2scm ("default-child"), sym))
 358     return default_child_;
 359   else if (scm_is_eq (ly_symbol2scm ("consists"), sym))
 360     return get_translator_names (SCM_EOL);
 361   else if (scm_is_eq (ly_symbol2scm ("description"), sym))
 362     return description_;
 363   else if (scm_is_eq (ly_symbol2scm ("aliases"), sym))
 364     return context_aliases_;
 365   else if (scm_is_eq (ly_symbol2scm ("accepts"), sym))
 366     return get_accepted (SCM_EOL);
 367   else if (scm_is_eq (ly_symbol2scm ("property-ops"), sym))
 368     return property_ops_;
 369   else if (scm_is_eq (ly_symbol2scm ("context-name"), sym))
 370     return context_name_;
 371   else if (scm_is_eq (ly_symbol2scm ("group-type"), sym))
 372     return translator_group_type_;
 373   return SCM_UNDEFINED;
 374 }
 375
 376 LY_DEFINE (ly_context_def_lookup, "ly:context-def-lookup",
 377            2, 1, 0, (SCM def, SCM sym, SCM val),
 378            "Return the value of @var{sym} in output definition @var{def}"
 379            " (e.g., @code{\\paper}).  If no value is found, return"
 380            " @var{val} or @code{'()} if @var{val} is undefined.")
 381 {
 382   LY_ASSERT_SMOB (Context_def, def, 1);
 383   Context_def *cd = unsmob_context_def (def);
 384   LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
 385
 386   SCM res = cd->lookup (sym);
 387
 388   scm_remember_upto_here_1 (def);
 389
 390   if (SCM_UNBNDP (res))
 391     res = SCM_EOL;
 392
 393   if (scm_is_null (res) && !SCM_UNBNDP (val))
 394     return val;
 395
 396   return res;
 397 }
 398
 399 LY_DEFINE (ly_context_def_modify, "ly:context-def-modify",
 400            2, 0, 0, (SCM def, SCM mod),
 401            "Return the result of applying the context-mod @var{mod} to"
 402            " the context definition @var{def}.  Does not change @var{def}.")
 403 {
 404   LY_ASSERT_SMOB (Context_def, def, 1);
 405   LY_ASSERT_SMOB (Context_mod, mod, 2);
 406
 407   Context_def *cd = unsmob_context_def (def)->clone ();
 408
 409   for (SCM s = unsmob_context_mod (mod)->get_mods ();
 410        scm_is_pair (s);
 411        s = scm_cdr (s))
 412     cd->add_context_mod (scm_car (s));
 413
 414   return cd->unprotect ();
 415 }