Issue 4550 (2/2) Avoid "using namespace std;" in included files

[lilypond.git] / lily / include / context.hh

diff --git a/lily/include/context.hh b/lily/include/context.hh
index c8bea9fad98c571201f25fb52433cc13f56be71a..76317e96b4956c835e297f418046f2fe8e56bdb9 100644 (file)
--- a/lily/include/context.hh
+++ b/lily/include/context.hh
@@ -1,7 +1,7 @@
 /*
   This file is part of LilyPond, the GNU music typesetter.
 
-  Copyright (C) 2004--2014 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
@@ -28,12 +28,17 @@
 #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 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 ();
 
@@ -58,7 +63,7 @@ protected:
   SCM default_child_;
   SCM aliases_;
   Translator_group *implementation_;
-  string id_string_;
+  std::string id_string_;
 
   /* Events reported in the context is sent to this dispatcher. */
   Dispatcher *event_source_;
@@ -74,11 +79,11 @@ 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_; }
+  std::string id_string () const { return id_string_; }
   SCM children_contexts () const { return context_list_; }
   SCM default_child_context_name () const;
 
@@ -103,21 +108,21 @@ public:
   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);
+  Context *create_context (Context_def *, const std::string&, SCM);
+  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;
+  std::string context_name () const;
   SCM context_name_symbol () const;
   Global_context *get_global_context () const;
 
   virtual Context *get_score_context () const;
   virtual Output_def *get_output_def () const;
   virtual Moment now_mom () const;
-  virtual Context *get_default_interpreter (const string &context_id = "");
+  virtual Context *get_default_interpreter (const std::string &context_id = "");
 
   bool is_alias (SCM) const;
   void add_alias (SCM);
@@ -126,10 +131,10 @@ public:
   bool is_removable () const;
 
   Context *find_create_context (SCM context_name,
-                                const string &id, SCM ops);
-  Context *create_unique_context (SCM context_name, const string &context_id,
+                                const std::string &id, SCM ops);
+  Context *create_unique_context (SCM context_name, const std::string &context_id,
                                   SCM ops);
-  vector<Context_def *> path_to_acceptable_context (SCM alias) const;
+  std::vector<Context_def *> path_to_acceptable_context (SCM alias) const;
 };
 
 /*
@@ -139,12 +144,36 @@ public:
 void apply_property_operations (Context *tg, SCM pre_init_ops);
 void execute_pushpop_property (Context *trg, SCM prop, SCM eltprop, SCM val);
 
+// 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);
+                             SCM type_sym, const std::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 std::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);
 
 Moment measure_position (Context const *context);