lily/keep-alive-together-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 2010--2015 Joe Neeman <joeneeman@gmail.com>
   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 "context.hh"
  21 #include "dispatcher.hh"
  22 #include "engraver.hh"
  23 #include "grob.hh"
  24 #include "grob-array.hh"
  25
  26 #include "translator.icc"
  27
  28 class Keep_alive_together_engraver: public Engraver
  29 {
  30   vector<Grob *> group_spanners_;
  31
  32 public:
  33   TRANSLATOR_DECLARATIONS (Keep_alive_together_engraver);
  34   void acknowledge_hara_kiri_group_spanner (Grob_info);
  35
  36   virtual void finalize ();
  37 };
  38
  39 Keep_alive_together_engraver::Keep_alive_together_engraver ()
  40 {
  41 }
  42
  43 void
  44 Keep_alive_together_engraver::acknowledge_hara_kiri_group_spanner (Grob_info i)
  45 {
  46   group_spanners_.push_back (i.grob ());
  47 }
  48
  49 void
  50 Keep_alive_together_engraver::finalize ()
  51 {
  52   for (vsize i = 0; i < group_spanners_.size (); ++i)
  53     {
  54       SCM this_layer = group_spanners_[i]->get_property ("remove-layer");
  55       if (scm_is_false (this_layer))
  56         continue;
  57
  58       SCM live_scm = Grob_array::make_array ();
  59       Grob_array *live = unsmob<Grob_array> (live_scm);
  60       SCM dead_scm = Grob_array::make_array ();
  61       Grob_array *dead = unsmob<Grob_array> (dead_scm);
  62
  63       for (vsize j = 0; j < group_spanners_.size (); ++j)
  64         {
  65           if (i == j)
  66             continue;
  67           SCM that_layer = group_spanners_[j]->get_property ("remove-layer");
  68           if (scm_is_false (that_layer))
  69             continue;
  70           if (!scm_is_integer (this_layer))
  71             {
  72               // Unspecified layers are kept alive by anything else
  73               live->add (group_spanners_[j]);
  74               continue;
  75             }
  76           // an explicit layer is only affected by explicit layers
  77           if (!scm_is_integer (that_layer))
  78             continue;
  79           if (scm_is_true (scm_num_eq_p (that_layer, this_layer)))
  80             live->add (group_spanners_[j]);
  81           else if (scm_is_true (scm_less_p (that_layer, this_layer)))
  82             dead->add (group_spanners_[j]);
  83         }
  84       if (!live->empty ())
  85         group_spanners_[i]->set_object ("keep-alive-with", live_scm);
  86       if (!dead->empty ())
  87         group_spanners_[i]->set_object ("make-dead-when", dead_scm);
  88     }
  89 }
  90
  91
  92 void
  93 Keep_alive_together_engraver::boot ()
  94 {
  95   ADD_ACKNOWLEDGER (Keep_alive_together_engraver, hara_kiri_group_spanner);
  96 }
  97
  98 ADD_TRANSLATOR (Keep_alive_together_engraver,
  99                 /* doc */
 100                 "This engraver collects all @code{Hara_kiri_group_spanner}s "
 101                 "that are created in contexts at or below its own.  "
 102                 "These spanners are then tied together so that one will "
 103                 "be removed only if all are removed.  For example, "
 104                 "if a @code{StaffGroup} uses this engraver, then the staves "
 105                 "in the group will all be visible as long as there is a note "
 106                 "in at least one of them.",
 107
 108                 /* create */
 109                 "",
 110
 111                 /* read */
 112                 "",
 113
 114                 /* write */
 115                 ""
 116                );