]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/include/context.hh
Imported Upstream version 2.19.45
[lilypond.git] / lily / include / context.hh
index c779074007cbfe3061051419be0471f2e01b25a2..468f612061707734ee3865faf8937cba06ea92ec 100644 (file)
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 2004--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  Copyright (C) 2004--2015 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
 #include "std-vector.hh"
 #include "virtual-methods.hh"
 
-class Context
+class Context : public Smob<Context>
 {
+public:
+  SCM mark_smob () const;
+  int print_smob (SCM, scm_print_state *) const;
+  static const char * const type_p_name_;
+  virtual ~Context ();
+private:
   Scheme_hash_table *properties_dict () const;
-  Context (Context const &src);
+  Context (Context const &src); // Do not define!  Not copyable!
 
-  DECLARE_SMOBS (Context);
   DECLARE_CLASSNAME (Context);
   void terminate ();
 
@@ -74,8 +79,8 @@ protected:
   // UGH! initialises implementation_
   friend SCM ly_make_global_translator (SCM);
 
-  DECLARE_LISTENER (set_property_from_event);
-  DECLARE_LISTENER (unset_property_from_event);
+  void set_property_from_event (SCM);
+  void unset_property_from_event (SCM);
 
 public:
   string id_string () const { return id_string_; }
@@ -97,16 +102,17 @@ public:
   SCM internal_get_property (SCM name_sym) const;
   SCM properties_as_alist () const;
   Context *where_defined (SCM name_sym, SCM *value) const;
+  bool here_defined (SCM name_sym, SCM *value) const;
   void unset_property (SCM var_sym);
 
   void instrumented_set_property (SCM, SCM, const char *, int, const char *);
   void internal_set_property (SCM var_sym, SCM value);
 
   Context *create_context (Context_def *, const string&, SCM);
-  DECLARE_LISTENER (create_context_from_event);
-  DECLARE_LISTENER (acknowledge_infant);
-  DECLARE_LISTENER (remove_context);
-  DECLARE_LISTENER (change_parent);
+  void create_context_from_event (SCM);
+  void acknowledge_infant (SCM);
+  void remove_context (SCM);
+  void change_parent (SCM);
   void disconnect_from_parent ();
   void check_removal ();
   string context_name () const;
@@ -136,21 +142,39 @@ public:
 */
 
 void apply_property_operations (Context *tg, SCM pre_init_ops);
-void execute_revert_property (Context *context,
-                              SCM context_property,
-                              SCM grob_property_path);
 void execute_pushpop_property (Context *trg, SCM prop, SCM eltprop, SCM val);
-void sloppy_general_pushpop_property (Context *context,
-                                      SCM context_property, SCM grob_property_path, SCM val);
-SCM updated_grob_properties (Context *tg, SCM sym);
+
+// Search for a context of the given type starting from the given context and
+// moving toward the root of the tree.  If the starting context matches, it is
+// returned.
+Context *find_context_above (Context *where, SCM type_sym);
+
+// Search for a context of the given type starting from the given context and
+// moving toward the root of the tree.  If found, return its child that was
+// found on the way there.
+Context *find_context_above_by_parent_type (Context *where, SCM parent_type);
+
+// Search for a context of the given type and ID starting from the given
+// context and moving toward the leaves of the tree.  If the starting context
+// matches, it is returned.  An empty ID matches any context of the given type.
 Context *find_context_below (Context *where,
                              SCM type_sym, const string &id);
+
+// Search for a context of the given type and ID starting with the given
+// context, then searching its descendants, then its parent's descendants, etc.
+// An empty ID matches any context of the given type.
+Context *find_context_near (Context *where,
+                            SCM type_sym, const string &id);
+
+// Search for the top context (i.e. the ancestor with no parent) starting with
+// the given context.
+Context *find_top_context (Context *where);
+
 bool melisma_busy (Context *);
 
 Context *get_voice_to_lyrics (Context *lyrics);
-Grob *get_current_note_head (Context *voice, bool include_grace_notes);
+Grob *get_current_note_head (Context *voice);
 Grob *get_current_rest (Context *voice);
-DECLARE_UNSMOB (Context, context);
 
 Moment measure_position (Context const *context);
 Moment measure_position (Context const *context, Duration const *dur);
@@ -162,14 +186,23 @@ bool check_repeat_count_visibility (Context const *context, SCM count);
 void set_context_property_on_children (Context *trans, SCM sym, SCM val);
 
 /* Shorthand for creating and broadcasting stream events. */
-#define send_stream_event(ctx, type, origin, ...)                               \
-{                                                                       \
-  SCM props[] = { __VA_ARGS__, 0 };                                     \
-  ctx->internal_send_stream_event (ly_symbol2scm (type), origin, props);        \
-}
+#define send_stream_event(ctx, type, origin, ...)                       \
+  do {                                                                  \
+    SCM props[] = { __VA_ARGS__, 0 };                                   \
+    ctx->internal_send_stream_event (ly_symbol2scm (type), origin, props); \
+  } while (0)
 
 SCM nested_property_alist (SCM alist, SCM prop_path, SCM value);
-SCM nested_property_revert_alist (SCM alist, SCM prop_path);
+SCM nested_property (SCM alist, SCM prop_path, SCM fallback = SCM_EOL);
+SCM nested_create_alist (SCM prop_path, SCM value);
+SCM partial_list_copy (SCM alist, SCM tail, SCM newtail);
+SCM assq_tail (SCM key, SCM alist, SCM alist_end);
+SCM assv_tail (SCM key, SCM alist, SCM alist_end);
+SCM assoc_tail (SCM key, SCM alist, SCM alist_end);
 SCM evict_from_alist (SCM, SCM, SCM);
+SCM nalist_to_alist (SCM nalist, int nested);
+extern SCM ly_context_set_property_x_proc;
+extern SCM ly_context_unset_property_proc;
+extern SCM ly_context_matched_pop_property_proc;
 
 #endif /* CONTEXT_HH */