]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/context-def.cc
Run grand-replace (issue 3765)
[lilypond.git] / lily / context-def.cc
index 37690fd61a096d7c8a21f7fe777924b36393d431..fb5657b6ed0aec0520bb0cb19f1e7d48dc92b1dd 100644 (file)
@@ -1,9 +1,20 @@
 /*
-  context-def.cc -- implement Context_def
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2000--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2000--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 /* TODO: should junk this class an replace by
@@ -12,6 +23,7 @@
 #include "context-def.hh"
 
 #include "context.hh"
+#include "context-mod.hh"
 #include "international.hh"
 #include "output-def.hh"
 #include "translator.hh"
@@ -55,7 +67,7 @@ Context_def::Context_def (Context_def const &s)
   smobify_self ();
 
   description_ = s.description_;
-  input_location_ = make_input (*s.origin ()); 
+  input_location_ = make_input (*s.origin ());
   default_child_ = s.default_child_;
   accept_mods_ = s.accept_mods_;
   property_ops_ = s.property_ops_;
@@ -72,14 +84,18 @@ Context_def::~Context_def ()
 #include "ly-smobs.icc"
 IMPLEMENT_SMOBS (Context_def);
 IMPLEMENT_DEFAULT_EQUAL_P (Context_def);
+IMPLEMENT_TYPE_P (Context_def, "ly:context-def?");
 
 int
-Context_def::print_smob (SCM smob, SCM port, scm_print_state*)
+Context_def::print_smob (SCM smob, SCM port, scm_print_state *)
 {
   Context_def *me = (Context_def *) SCM_CELL_WORD_1 (smob);
 
   scm_puts ("#<Context_def ", port);
   scm_display (me->context_name_, port);
+  scm_puts (" ", port);
+  string loc = me->origin ()->location_string ();
+  scm_puts (loc.c_str (), port);
   scm_puts (">", port);
   return 1;
 }
@@ -87,8 +103,8 @@ Context_def::print_smob (SCM smob, SCM port, scm_print_state*)
 SCM
 Context_def::mark_smob (SCM smob)
 {
-  ASSERT_LIVE_IS_ALLOWED ();
-  
+  ASSERT_LIVE_IS_ALLOWED (smob);
+
   Context_def *me = (Context_def *) SCM_CELL_WORD_1 (smob);
 
   scm_gc_mark (me->description_);
@@ -123,22 +139,18 @@ Context_def::add_context_mod (SCM mod)
   if (ly_symbol2scm ("default-child") == tag)
     default_child_ = sym;
   else if (ly_symbol2scm ("consists") == tag
-          || ly_symbol2scm ("consists-end") == tag
-          || ly_symbol2scm ("remove") == tag)
+           || ly_symbol2scm ("remove") == tag)
     {
-      if (!get_translator (sym))
-       error (_f ("program has no such type: `%s'",
-                  ly_symbol2string (sym).c_str ()));
-      else
-       translator_mods_ = scm_cons (scm_list_2 (tag, sym), translator_mods_);
+      translator_mods_ = scm_cons (scm_list_2 (tag, sym), translator_mods_);
     }
   else if (ly_symbol2scm ("accepts") == tag
-          || ly_symbol2scm ("denies") == tag)
+           || ly_symbol2scm ("denies") == tag)
     accept_mods_ = scm_cons (scm_list_2 (tag, sym), accept_mods_);
   else if (ly_symbol2scm ("pop") == tag
-          || ly_symbol2scm ("push") == tag
-          || ly_symbol2scm ("assign") == tag
-          || ly_symbol2scm ("unset") == tag)
+           || ly_symbol2scm ("push") == tag
+           || ly_symbol2scm ("assign") == tag
+           || ly_symbol2scm ("unset") == tag
+           || ly_symbol2scm ("apply") == tag)
     property_ops_ = scm_cons (mod, property_ops_);
   else if (ly_symbol2scm ("alias") == tag)
     context_aliases_ = scm_cons (sym, context_aliases_);
@@ -160,16 +172,15 @@ Context_def::get_accepted (SCM user_mod) const
       SCM tag = scm_caar (s);
       SCM sym = scm_cadar (s);
       if (tag == ly_symbol2scm ("accepts"))
-       acc = scm_cons (sym, acc);
+        acc = scm_cons (sym, acc);
       else if (tag == ly_symbol2scm ("denies"))
-       acc = scm_delete_x (sym, acc);
+        acc = scm_delete_x (sym, acc);
     }
 
   SCM def = get_default_child (user_mod);
   if (scm_is_symbol (def))
     {
-      if (scm_memq (def, acc))
-       acc = scm_delete_x (def, acc);
+      acc = scm_delete_x (def, acc);
       acc = scm_cons (def, acc);
     }
 
@@ -184,10 +195,10 @@ Context_def::get_default_child (SCM user_mod) const
     {
       SCM entry = scm_car (s);
       if (scm_car (entry) == ly_symbol2scm ("default-child"))
-       {
-         name = scm_cadr (entry);
-         break;
-       }
+        {
+          name = scm_cadr (entry);
+          break;
+        }
     }
 
   return name;
@@ -199,7 +210,7 @@ Context_def::get_default_child (SCM user_mod) const
    - the first element in the list defines a context that is a valid child of
      the context defined by this Context_def
    - each subsequent element in the list defines a context that is a valid child
-     of the the context defined by the preceding element in the list
+     of the context defined by the preceding element in the list
    - the last element in the list defines a context with the given name
 
   The ADDITIONAL_ACCEPTS parameter is a list of additional contexts that this
@@ -207,8 +218,8 @@ Context_def::get_default_child (SCM user_mod) const
 */
 vector<Context_def *>
 Context_def::path_to_acceptable_context (SCM type_sym,
-                                        Output_def *odef,
-                                        SCM additional_accepts) const
+                                         Output_def *odef,
+                                         SCM additional_accepts) const
 {
   set<const Context_def *> seen;
   return internal_path_to_acceptable_context (type_sym, odef, additional_accepts, &seen);
@@ -218,32 +229,32 @@ Context_def::path_to_acceptable_context (SCM type_sym,
 The SEEN parameter is a set which keeps track of visited contexts, allowing
 contexts of the same type to be nested.
 */
-vector<Context_def*>
+vector<Context_def *>
 Context_def::internal_path_to_acceptable_context (SCM type_sym,
-                                                 Output_def *odef,
-                                                 SCM additional_accepts,
-                                                 set<const Context_def *> *seen) const
+                                                  Output_def *odef,
+                                                  SCM additional_accepts,
+                                                  set<const Context_def *> *seen) const
 {
   assert (scm_is_symbol (type_sym));
 
   SCM accepted = get_accepted (additional_accepts);
 
-  vector<Context_def*> accepteds;
+  vector<Context_def *> accepteds;
   for (SCM s = accepted; scm_is_pair (s); s = scm_cdr (s))
     if (Context_def *t = unsmob_context_def (find_context_def (odef,
-                                                              scm_car (s))))
+                                                               scm_car (s))))
       accepteds.push_back (t);
 
-  vector<Context_def*> best_result;
+  vector<Context_def *> best_result;
   for (vsize i = 0; i < accepteds.size (); i++)
     {
       /* do not check aliases, because \context Staff should not
-        create RhythmicStaff. */
+         create RhythmicStaff. */
       if (ly_is_equal (accepteds[i]->get_context_name (), type_sym))
-       {
-         best_result.push_back (accepteds[i]);
-         return best_result;
-       }
+        {
+          best_result.push_back (accepteds[i]);
+          return best_result;
+        }
     }
 
   seen->insert (this);
@@ -253,16 +264,16 @@ Context_def::internal_path_to_acceptable_context (SCM type_sym,
       Context_def *g = accepteds[i];
 
       if (!seen->count (g))
-       {
-         vector<Context_def*> result
-           = g->internal_path_to_acceptable_context (type_sym, odef, SCM_EOL, seen);
-         if (result.size () && result.size () < best_depth)
-           {
-             best_depth = result.size ();
-             result.insert (result.begin (), g);
-             best_result = result;
-           }
-       }
+        {
+          vector<Context_def *> result
+            = g->internal_path_to_acceptable_context (type_sym, odef, SCM_EOL, seen);
+          if (result.size () && result.size () < best_depth)
+            {
+              best_depth = result.size ();
+              result.insert (result.begin (), g);
+              best_result = result;
+            }
+        }
     }
   seen->erase (this);
 
@@ -282,12 +293,15 @@ Context_def::get_translator_names (SCM user_mod) const
       SCM arg = scm_cadar (s);
 
       if (scm_is_string (arg))
-       arg = scm_string_to_symbol (arg);
+        arg = scm_string_to_symbol (arg);
 
       if (ly_symbol2scm ("consists") == tag)
-       l1 = scm_cons (arg, l1);
-      else if (ly_symbol2scm ("remove") == tag)
-       l1 = scm_delete_x (arg, l1);
+        l1 = scm_cons (arg, l1);
+      else if (ly_symbol2scm ("remove") == tag
+               && (scm_is_pair (arg)
+                   || ly_is_procedure (arg)
+                   || get_translator (arg)))
+        l1 = scm_delete_x (arg, l1);
     }
 
   return l1;
@@ -302,6 +316,7 @@ Context_def::instantiate (SCM ops)
   context->definition_mods_ = ops;
   context->aliases_ = context_aliases_;
   context->accepts_list_ = get_accepted (ops);
+  context->default_child_ = get_default_child (ops);
 
   return context;
 }
@@ -316,7 +331,7 @@ Context_def::make_scm ()
 void
 Context_def::apply_default_property_operations (Context *tg)
 {
-  apply_property_operations (tg, property_ops_);
+  apply_property_operations (tg, scm_reverse (property_ops_));
 }
 
 SCM
@@ -325,19 +340,97 @@ Context_def::to_alist () const
   SCM ell = SCM_EOL;
 
   ell = scm_cons (scm_cons (ly_symbol2scm ("consists"),
-                           get_translator_names (SCM_EOL)), ell);
+                            get_translator_names (SCM_EOL)), ell);
   ell = scm_cons (scm_cons (ly_symbol2scm ("description"), description_), ell);
   ell = scm_cons (scm_cons (ly_symbol2scm ("aliases"), context_aliases_), ell);
   ell = scm_cons (scm_cons (ly_symbol2scm ("accepts"), get_accepted (SCM_EOL)),
-                 ell);
+                  ell);
+  if (scm_is_symbol (default_child_))
+    ell = scm_acons (ly_symbol2scm ("default-child"), default_child_, ell);
+  ell = scm_cons (scm_cons (ly_symbol2scm ("accepts"), get_accepted (SCM_EOL)),
+                  ell);
   ell = scm_cons (scm_cons (ly_symbol2scm ("property-ops"), property_ops_),
-                 ell);
+                  ell);
   ell = scm_cons (scm_cons (ly_symbol2scm ("context-name"), context_name_),
-                 ell);
+                  ell);
 
   if (scm_is_symbol (translator_group_type_))
     ell = scm_cons (scm_cons (ly_symbol2scm ("group-type"),
-                             translator_group_type_), ell);
+                              translator_group_type_), ell);
   return ell;
 }
 
+SCM
+Context_def::lookup (SCM sym) const
+{
+  if (scm_is_eq (ly_symbol2scm ("default-child"), sym))
+    return default_child_;
+  else if (scm_is_eq (ly_symbol2scm ("consists"), sym))
+    return get_translator_names (SCM_EOL);
+  else if (scm_is_eq (ly_symbol2scm ("description"), sym))
+    return description_;
+  else if (scm_is_eq (ly_symbol2scm ("aliases"), sym))
+    return context_aliases_;
+  else if (scm_is_eq (ly_symbol2scm ("accepts"), sym))
+    return get_accepted (SCM_EOL);
+  else if (scm_is_eq (ly_symbol2scm ("property-ops"), sym))
+    return property_ops_;
+  else if (scm_is_eq (ly_symbol2scm ("context-name"), sym))
+    return context_name_;
+  else if (scm_is_eq (ly_symbol2scm ("group-type"), sym))
+    return translator_group_type_;
+  return SCM_UNDEFINED;
+}
+
+bool
+Context_def::is_alias (SCM sym) const
+{
+  if (scm_is_eq (sym, ly_symbol2scm ("Bottom")))
+    return !scm_is_symbol (get_default_child (SCM_EOL));
+
+  if (scm_is_eq (sym, get_context_name ()))
+    return true;
+
+  return scm_is_true (scm_c_memq (sym, context_aliases_));
+}
+
+LY_DEFINE (ly_context_def_lookup, "ly:context-def-lookup",
+           2, 1, 0, (SCM def, SCM sym, SCM val),
+           "Return the value of @var{sym} in output definition @var{def}"
+           " (e.g., @code{\\paper}).  If no value is found, return"
+           " @var{val} or @code{'()} if @var{val} is undefined.")
+{
+  LY_ASSERT_SMOB (Context_def, def, 1);
+  Context_def *cd = unsmob_context_def (def);
+  LY_ASSERT_TYPE (ly_is_symbol, sym, 2);
+
+  SCM res = cd->lookup (sym);
+
+  scm_remember_upto_here_1 (def);
+
+  if (SCM_UNBNDP (res))
+    res = SCM_EOL;
+
+  if (scm_is_null (res) && !SCM_UNBNDP (val))
+    return val;
+
+  return res;
+}
+
+LY_DEFINE (ly_context_def_modify, "ly:context-def-modify",
+           2, 0, 0, (SCM def, SCM mod),
+           "Return the result of applying the context-mod @var{mod} to"
+           " the context definition @var{def}.  Does not change @var{def}.")
+{
+  LY_ASSERT_SMOB (Context_def, def, 1);
+  LY_ASSERT_SMOB (Context_mod, mod, 2);
+
+  Context_def *cd = unsmob_context_def (def)->clone ();
+
+  for (SCM s = unsmob_context_mod (mod)->get_mods ();
+       scm_is_pair (s);
+       s = scm_cdr (s))
+    cd->add_context_mod (scm_car (s));
+
+  return cd->unprotect ();
+}