lily/prob.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2004--2014 Jan Nieuwenhuizen <janneke@gnu.org>
   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 #include "prob.hh"
  21 #include "main.hh"
  22 #include "item.hh"
  23 #include "input.hh"
  24 #include "profile.hh"
  25
  26 #include "ly-smobs.icc"
  27
  28 IMPLEMENT_SMOBS (Prob);
  29 IMPLEMENT_TYPE_P (Prob, "ly:prob?");
  30
  31 SCM
  32 Prob::equal_p (SCM sa, SCM sb)
  33 {
  34   /* This comparison function is only designed to make the copy
  35      constructor preserve equality.
  36
  37      Perhaps it would be better to use a more strict definition of
  38      equality; e.g., that two probs are equal iff they can be
  39      distinguished by calls to ly:prob-property.
  40   */
  41   Prob *probs[2] = {unsmob_prob (sa), unsmob_prob (sb)};
  42   SCM props[2][2];
  43   int i;
  44
  45   for (i = 0; i < 2; i++)
  46     {
  47       props[i][0] = probs[i]->immutable_property_alist_;
  48       props[i][1] = probs[i]->mutable_property_alist_;
  49     }
  50
  51   if (strcmp (probs[0]->class_name (), probs[1]->class_name ()))
  52     return SCM_BOOL_F;
  53
  54   /* Compare mutable and immutable lists, element by element. */
  55   for (i = 0; i < 2; i++)
  56     {
  57       SCM aprop = props[0][i];
  58       SCM bprop = props[1][i];
  59
  60       for (;
  61            scm_is_pair (aprop) && scm_is_pair (bprop);
  62            aprop = scm_cdr (aprop), bprop = scm_cdr (bprop))
  63         {
  64           SCM aval = scm_cdar (aprop);
  65           SCM bval = scm_cdar (bprop);
  66           if (scm_caar (aprop) != scm_caar (bprop)
  67               || (!(unsmob_input (aval) && unsmob_input (bval))
  68                   &&
  69                   !to_boolean (scm_equal_p (aval, bval))))
  70             return SCM_BOOL_F;
  71         }
  72
  73       /* is one list shorter? */
  74       if (aprop != SCM_EOL || bprop != SCM_EOL)
  75         return SCM_BOOL_F;
  76     }
  77
  78   return SCM_BOOL_T;
  79 }
  80
  81 Prob::Prob (SCM type, SCM immutable_init)
  82 {
  83   self_scm_ = SCM_EOL;
  84   mutable_property_alist_ = SCM_EOL;
  85   immutable_property_alist_ = immutable_init;
  86   type_ = type;
  87   smobify_self ();
  88 }
  89
  90 Prob::~Prob ()
  91 {
  92 }
  93
  94 Prob::Prob (Prob const &src)
  95 {
  96   immutable_property_alist_ = src.immutable_property_alist_;
  97   mutable_property_alist_ = SCM_EOL;
  98   self_scm_ = SCM_EOL;
  99   type_ = src.type_;
 100
 101   /* First we smobify_self, then we copy over the stuff.  If we don't,
 102      stack vars that hold the copy might be optimized away, meaning
 103      that they won't be protected from GC. */
 104   smobify_self ();
 105   mutable_property_alist_ = src.copy_mutable_properties ();
 106 }
 107
 108 SCM
 109 Prob::copy_mutable_properties () const
 110 {
 111   return ly_deep_copy (mutable_property_alist_);
 112 }
 113
 114 void
 115 Prob::derived_mark () const
 116 {
 117 }
 118
 119 SCM
 120 Prob::mark_smob (SCM smob)
 121 {
 122   ASSERT_LIVE_IS_ALLOWED (smob);
 123
 124   Prob *system = (Prob *) SCM_CELL_WORD_1 (smob);
 125   scm_gc_mark (system->mutable_property_alist_);
 126   system->derived_mark ();
 127
 128   return system->immutable_property_alist_;
 129 }
 130
 131 int
 132 Prob::print_smob (SCM smob, SCM port, scm_print_state *)
 133 {
 134   Prob *p = (Prob *) SCM_CELL_WORD_1 (smob);
 135   scm_puts ("#<", port);
 136   scm_puts ("Prob: ", port);
 137   scm_display (p->type_, port);
 138   scm_puts (" C++: ", port);
 139   scm_puts (p->class_name (), port);
 140   scm_display (p->mutable_property_alist_, port);
 141   scm_display (p->immutable_property_alist_, port);
 142
 143   scm_puts (" >\n", port);
 144   return 1;
 145 }
 146
 147 SCM
 148 Prob::internal_get_property (SCM sym) const
 149 {
 150 #ifndef NDEBUG
 151   if (profile_property_accesses)
 152     note_property_access (&prob_property_lookup_table, sym);
 153 #endif
 154
 155   /*
 156     TODO: type checking
 157    */
 158   SCM s = scm_sloppy_assq (sym, mutable_property_alist_);
 159   if (s != SCM_BOOL_F)
 160     return scm_cdr (s);
 161
 162   s = scm_sloppy_assq (sym, immutable_property_alist_);
 163   return (s == SCM_BOOL_F) ? SCM_EOL : scm_cdr (s);
 164 }
 165
 166 /* We don't (yet) instrument probs */
 167 void
 168 Prob::instrumented_set_property (SCM sym, SCM val, const char *, int, const char *)
 169 {
 170   internal_set_property (sym, val);
 171 }
 172
 173 void
 174 Prob::internal_set_property (SCM sym, SCM val)
 175 {
 176   if (do_internal_type_checking_global)
 177     type_check_assignment (sym, val);
 178
 179   mutable_property_alist_ = scm_assq_set_x (mutable_property_alist_, sym, val);
 180 }
 181
 182 void
 183 Prob::type_check_assignment (SCM, SCM) const
 184 {
 185   /* empty */
 186 }
 187
 188 SCM
 189 Prob::get_property_alist (bool m) const
 190 {
 191   return (m) ? mutable_property_alist_ : immutable_property_alist_;
 192 }
 193
 194 string
 195 Prob::name () const
 196 {
 197   SCM nm = get_property ("name");
 198   if (scm_is_symbol (nm))
 199     return ly_symbol2string (nm);
 200   else
 201     return this->class_name ();
 202 }
 203