lily/include/context-def.hh

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2000--2010 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 #ifndef CONTEXT_DEF_HH
  21 #define CONTEXT_DEF_HH
  22
  23 #include "std-vector.hh"
  24 #include "lily-proto.hh"
  25 #include "smobs.hh"
  26 #include "input.hh"
  27 #include "virtual-methods.hh"
  28 #include <set>
  29
  30
  31 /*
  32   The definition of a interpretation context as given in the
  33   input. The lists are stored in order of definition.
  34 */
  35 struct Context_def
  36 {
  37 private:
  38   /*
  39     these lists store the definition, in opposite order of entry
  40   */
  41   SCM translator_mods_;
  42   SCM accept_mods_;
  43   SCM property_ops_;
  44   SCM description_;
  45   SCM context_name_;
  46   SCM context_aliases_;
  47   SCM translator_group_type_;
  48   SCM default_child_;
  49   SCM input_location_;
  50 public:
  51   Input *origin () const;
  52   void add_context_mod (SCM);
  53   SCM get_default_child (SCM user_mods) const;
  54   SCM get_context_name () const { return context_name_; }
  55   SCM get_accepted (SCM user_mods) const;
  56   SCM get_property_ops () const { return property_ops_; }
  57   SCM get_translator_names (SCM) const;
  58   SCM get_translator_group_type () const { return translator_group_type_; }
  59   void set_acceptor (SCM accepts, bool add);
  60
  61   VIRTUAL_COPY_CONSTRUCTOR(Context_def, Context_def);
  62
  63   vector<Context_def*> path_to_acceptable_context (SCM type_string,
  64                                                    Output_def *,
  65                                                    SCM) const;
  66   vector<Context_def*> internal_path_to_acceptable_context (SCM type_string,
  67                                                             Output_def *,
  68                                                             SCM,
  69                                                             set<const Context_def *> *seen) const;
  70   Context *instantiate (SCM extra_ops);
  71
  72   SCM to_alist () const;
  73   static SCM make_scm ();
  74
  75   void apply_default_property_operations (Context *);
  76
  77 private:
  78   DECLARE_SMOBS (Context_def);
  79   Context_def ();
  80   Context_def (Context_def const &);
  81 };
  82
  83 DECLARE_UNSMOB (Context_def, context_def);
  84
  85 #endif /* CONTEXT_DEF_HH */
  86