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 "international.hh"
  27 #include "output-def.hh"
  28 #include "translator.hh"
  29 #include "warn.hh"
  30
  31 Context_def::Context_def ()
  32 {
  33   context_aliases_ = SCM_EOL;
  34   translator_group_type_ = SCM_EOL;
  35   accept_mods_ = SCM_EOL;
  36   translator_mods_ = SCM_EOL;
  37   property_ops_ = SCM_EOL;
  38   context_name_ = SCM_EOL;
  39   default_child_ = SCM_EOL;
  40   description_ = SCM_EOL;
  41   input_location_ = SCM_EOL;
  42
  43   smobify_self ();
  44
  45   input_location_ = make_input (Input ());
  46   context_name_ = ly_symbol2scm ("");
  47 }
  48
  49 Input *
  50 Context_def::origin () const
  51 {
  52   return unsmob_input (input_location_);
  53 }
  54
  55 Context_def::Context_def (Context_def const &s)
  56 {
  57   context_aliases_ = SCM_EOL;
  58   translator_group_type_ = SCM_EOL;
  59   accept_mods_ = SCM_EOL;
  60   translator_mods_ = SCM_EOL;
  61   property_ops_ = SCM_EOL;
  62   context_name_ = SCM_EOL;
  63   description_ = SCM_EOL;
  64   default_child_ = SCM_EOL;
  65   input_location_ = SCM_EOL;
  66   smobify_self ();
  67
  68   description_ = s.description_;
  69   input_location_ = make_input (*s.origin ());
  70   default_child_ = s.default_child_;
  71   accept_mods_ = s.accept_mods_;
  72   property_ops_ = s.property_ops_;
  73   translator_mods_ = s.translator_mods_;
  74   context_aliases_ = s.context_aliases_;
  75   translator_group_type_ = s.translator_group_type_;
  76   context_name_ = s.context_name_;
  77 }
  78
  79 Context_def::~Context_def ()
  80 {
  81 }
  82
  83 #include "ly-smobs.icc"
  84 IMPLEMENT_SMOBS (Context_def);
  85 IMPLEMENT_DEFAULT_EQUAL_P (Context_def);
  86
  87 int
  88 Context_def::print_smob (SCM smob, SCM port, scm_print_state *)
  89 {
  90   Context_def *me = (Context_def *) SCM_CELL_WORD_1 (smob);
  91
  92   scm_puts ("#<Context_def ", port);
  93   scm_display (me->context_name_, port);
  94   scm_puts (">", port);
  95   return 1;
  96 }
  97
  98 SCM
  99 Context_def::mark_smob (SCM smob)
 100 {
 101   ASSERT_LIVE_IS_ALLOWED ();
 102
 103   Context_def *me = (Context_def *) SCM_CELL_WORD_1 (smob);
 104
 105   scm_gc_mark (me->description_);
 106   scm_gc_mark (me->context_aliases_);
 107   scm_gc_mark (me->accept_mods_);
 108   scm_gc_mark (me->translator_mods_);
 109   scm_gc_mark (me->property_ops_);
 110   scm_gc_mark (me->translator_group_type_);
 111   scm_gc_mark (me->default_child_);
 112   scm_gc_mark (me->input_location_);
 113
 114   return me->context_name_;
 115 }
 116
 117 void
 118 Context_def::add_context_mod (SCM mod)
 119 {
 120   SCM tag = scm_car (mod);
 121   if (ly_symbol2scm ("description") == tag)
 122     {
 123       description_ = scm_cadr (mod);
 124       return;
 125     }
 126
 127   /*
 128     other modifiers take symbols as argument.
 129   */
 130   SCM sym = scm_cadr (mod);
 131   if (scm_is_string (sym))
 132     sym = scm_string_to_symbol (sym);
 133
 134   if (ly_symbol2scm ("default-child") == tag)
 135     default_child_ = sym;
 136   else if (ly_symbol2scm ("consists") == tag
 137            || ly_symbol2scm ("remove") == tag)
 138     {
 139       translator_mods_ = scm_cons (scm_list_2 (tag, sym), translator_mods_);
 140     }
 141   else if (ly_symbol2scm ("accepts") == tag
 142            || ly_symbol2scm ("denies") == tag)
 143     accept_mods_ = scm_cons (scm_list_2 (tag, sym), accept_mods_);
 144   else if (ly_symbol2scm ("pop") == tag
 145            || ly_symbol2scm ("push") == tag
 146            || ly_symbol2scm ("assign") == tag
 147            || ly_symbol2scm ("unset") == tag)
 148     property_ops_ = scm_cons (mod, property_ops_);
 149   else if (ly_symbol2scm ("alias") == tag)
 150     context_aliases_ = scm_cons (sym, context_aliases_);
 151   else if (ly_symbol2scm ("translator-type") == tag)
 152     translator_group_type_ = sym;
 153   else if (ly_symbol2scm ("context-name") == tag)
 154     context_name_ = sym;
 155   else
 156     programming_error ("unknown context mod tag");
 157 }
 158
 159 SCM
 160 Context_def::get_accepted (SCM user_mod) const
 161 {
 162   SCM mods = scm_reverse_x (scm_list_copy (accept_mods_), user_mod);
 163   SCM acc = SCM_EOL;
 164   for (SCM s = mods; scm_is_pair (s); s = scm_cdr (s))
 165     {
 166       SCM tag = scm_caar (s);
 167       SCM sym = scm_cadar (s);
 168       if (tag == ly_symbol2scm ("accepts"))
 169         acc = scm_cons (sym, acc);
 170       else if (tag == ly_symbol2scm ("denies"))
 171         acc = scm_delete_x (sym, acc);
 172     }
 173
 174   SCM def = get_default_child (user_mod);
 175   if (scm_is_symbol (def))
 176     {
 177       acc = scm_delete_x (def, acc);
 178       acc = scm_cons (def, acc);
 179     }
 180
 181   return acc;
 182 }
 183
 184 SCM
 185 Context_def::get_default_child (SCM user_mod) const
 186 {
 187   SCM name = default_child_;
 188   for (SCM s = user_mod; scm_is_pair (s); s = scm_cdr (s))
 189     {
 190       SCM entry = scm_car (s);
 191       if (scm_car (entry) == ly_symbol2scm ("default-child"))
 192         {
 193           name = scm_cadr (entry);
 194           break;
 195         }
 196     }
 197
 198   return name;
 199 }
 200
 201 /*
 202   Given a name of a context that we want to create, finds a list of context
 203   definitions such that:
 204    - the first element in the list defines a context that is a valid child of
 205      the context defined by this Context_def
 206    - each subsequent element in the list defines a context that is a valid child
 207      of the context defined by the preceding element in the list
 208    - the last element in the list defines a context with the given name
 209
 210   The ADDITIONAL_ACCEPTS parameter is a list of additional contexts that this
 211   specific context def (but not any of the child context defs) should accept.
 212 */
 213 vector<Context_def *>
 214 Context_def::path_to_acceptable_context (SCM type_sym,
 215                                          Output_def *odef,
 216                                          SCM additional_accepts) const
 217 {
 218   set<const Context_def *> seen;
 219   return internal_path_to_acceptable_context (type_sym, odef, additional_accepts, &seen);
 220 }
 221
 222 /*
 223 The SEEN parameter is a set which keeps track of visited contexts, allowing
 224 contexts of the same type to be nested.
 225 */
 226 vector<Context_def *>
 227 Context_def::internal_path_to_acceptable_context (SCM type_sym,
 228                                                   Output_def *odef,
 229                                                   SCM additional_accepts,
 230                                                   set<const Context_def *> *seen) const
 231 {
 232   assert (scm_is_symbol (type_sym));
 233
 234   SCM accepted = get_accepted (additional_accepts);
 235
 236   vector<Context_def *> accepteds;
 237   for (SCM s = accepted; scm_is_pair (s); s = scm_cdr (s))
 238     if (Context_def *t = unsmob_context_def (find_context_def (odef,
 239                                                                scm_car (s))))
 240       accepteds.push_back (t);
 241
 242   vector<Context_def *> best_result;
 243   for (vsize i = 0; i < accepteds.size (); i++)
 244     {
 245       /* do not check aliases, because \context Staff should not
 246          create RhythmicStaff. */
 247       if (ly_is_equal (accepteds[i]->get_context_name (), type_sym))
 248         {
 249           best_result.push_back (accepteds[i]);
 250           return best_result;
 251         }
 252     }
 253
 254   seen->insert (this);
 255   vsize best_depth = INT_MAX;
 256   for (vsize i = 0; i < accepteds.size (); i++)
 257     {
 258       Context_def *g = accepteds[i];
 259
 260       if (!seen->count (g))
 261         {
 262           vector<Context_def *> result
 263             = g->internal_path_to_acceptable_context (type_sym, odef, SCM_EOL, seen);
 264           if (result.size () && result.size () < best_depth)
 265             {
 266               best_depth = result.size ();
 267               result.insert (result.begin (), g);
 268               best_result = result;
 269             }
 270         }
 271     }
 272   seen->erase (this);
 273
 274   return best_result;
 275 }
 276
 277 SCM
 278 Context_def::get_translator_names (SCM user_mod) const
 279 {
 280   SCM l1 = SCM_EOL;
 281
 282   SCM mods = scm_reverse_x (scm_list_copy (translator_mods_), user_mod);
 283
 284   for (SCM s = mods; scm_is_pair (s); s = scm_cdr (s))
 285     {
 286       SCM tag = scm_caar (s);
 287       SCM arg = scm_cadar (s);
 288
 289       if (scm_is_string (arg))
 290         arg = scm_string_to_symbol (arg);
 291
 292       if (ly_symbol2scm ("consists") == tag)
 293         l1 = scm_cons (arg, l1);
 294       else if (ly_symbol2scm ("remove") == tag
 295                && (scm_is_pair (arg)
 296                    || ly_is_procedure (arg)
 297                    || get_translator (arg)))
 298         l1 = scm_delete_x (arg, l1);
 299     }
 300
 301   return l1;
 302 }
 303
 304 Context *
 305 Context_def::instantiate (SCM ops)
 306 {
 307   Context *context = new Context ();
 308
 309   context->definition_ = self_scm ();
 310   context->definition_mods_ = ops;
 311   context->aliases_ = context_aliases_;
 312   context->accepts_list_ = get_accepted (ops);
 313
 314   return context;
 315 }
 316
 317 SCM
 318 Context_def::make_scm ()
 319 {
 320   Context_def *t = new Context_def;
 321   return t->unprotect ();
 322 }
 323
 324 void
 325 Context_def::apply_default_property_operations (Context *tg)
 326 {
 327   apply_property_operations (tg, property_ops_);
 328 }
 329
 330 SCM
 331 Context_def::to_alist () const
 332 {
 333   SCM ell = SCM_EOL;
 334
 335   ell = scm_cons (scm_cons (ly_symbol2scm ("consists"),
 336                             get_translator_names (SCM_EOL)), ell);
 337   ell = scm_cons (scm_cons (ly_symbol2scm ("description"), description_), ell);
 338   ell = scm_cons (scm_cons (ly_symbol2scm ("aliases"), context_aliases_), ell);
 339   ell = scm_cons (scm_cons (ly_symbol2scm ("accepts"), get_accepted (SCM_EOL)),
 340                   ell);
 341   ell = scm_cons (scm_cons (ly_symbol2scm ("property-ops"), property_ops_),
 342                   ell);
 343   ell = scm_cons (scm_cons (ly_symbol2scm ("context-name"), context_name_),
 344                   ell);
 345
 346   if (scm_is_symbol (translator_group_type_))
 347     ell = scm_cons (scm_cons (ly_symbol2scm ("group-type"),
 348                               translator_group_type_), ell);
 349   return ell;
 350 }
 351
 352 #include "ly-smobs.icc"
 353
 354 IMPLEMENT_TYPE_P (Context_def, "ly:context-def?");