lily/mark-engraver.cc

   1 /*
   2   This file is part of LilyPond, the GNU music typesetter.
   3
   4   Copyright (C) 1998--2015 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 <cctype>
  21 using namespace std;
  22
  23 #include "engraver.hh"
  24
  25 #include "axis-group-interface.hh"
  26 #include "context.hh"
  27 #include "grob-array.hh"
  28 #include "international.hh"
  29 #include "item.hh"
  30 #include "stream-event.hh"
  31 #include "text-interface.hh"
  32 #include "warn.hh"
  33
  34 #include "translator.icc"
  35
  36 /**
  37    put stuff over or next to  bars.  Examples: bar numbers, marginal notes,
  38    rehearsal marks.
  39 */
  40 class Mark_engraver : public Engraver
  41 {
  42
  43   void create_items (Stream_event *);
  44   Item *text_;
  45   Item *final_text_;
  46   Stream_event *mark_ev_;
  47
  48 public:
  49   TRANSLATOR_DECLARATIONS (Mark_engraver);
  50
  51 protected:
  52   void process_music ();
  53   void start_translation_timestep ();
  54   void stop_translation_timestep ();
  55   virtual void finalize ();
  56
  57   void listen_mark (Stream_event *);
  58   void acknowledge_break_alignment (Grob_info);
  59 };
  60
  61 Mark_engraver::Mark_engraver (Context *c)
  62   : Engraver (c)
  63 {
  64   text_ = 0;
  65   final_text_ = 0;
  66   mark_ev_ = 0;
  67 }
  68
  69 void
  70 Mark_engraver::acknowledge_break_alignment (Grob_info inf)
  71 {
  72   Grob *s = inf.grob ();
  73   if (text_
  74       && dynamic_cast<Item *> (s))
  75     text_->set_parent (s, X_AXIS);
  76 }
  77
  78 void
  79 Mark_engraver::start_translation_timestep ()
  80 {
  81   final_text_ = 0;
  82 }
  83
  84 void
  85 Mark_engraver::stop_translation_timestep ()
  86 {
  87   if (text_)
  88     {
  89       text_->set_object ("side-support-elements",
  90                          grob_list_to_grob_array (get_property ("stavesFound")));
  91       final_text_ = text_;
  92       text_ = 0;
  93     }
  94   mark_ev_ = 0;
  95 }
  96
  97 void
  98 Mark_engraver::finalize ()
  99 {
 100   if (final_text_)
 101     final_text_->set_property ("break-visibility",
 102                                scm_c_make_vector (3, SCM_BOOL_T));
 103   final_text_ = 0;
 104 }
 105
 106 void
 107 Mark_engraver::create_items (Stream_event *ev)
 108 {
 109   if (text_)
 110     return;
 111
 112   text_ = make_item ("RehearsalMark", ev->self_scm ());
 113 }
 114
 115 void
 116 Mark_engraver::listen_mark (Stream_event *ev)
 117 {
 118   ASSIGN_EVENT_ONCE (mark_ev_, ev);
 119 }
 120
 121 /*
 122   TODO: make the increment function in Scheme.
 123 */
 124 void
 125 Mark_engraver::process_music ()
 126 {
 127   if (mark_ev_)
 128     {
 129       create_items (mark_ev_);
 130
 131       /*
 132         automatic marks.
 133       */
 134
 135       SCM m = mark_ev_->get_property ("label");
 136       SCM proc = get_property ("markFormatter");
 137       if (!Text_interface::is_markup (m)
 138           && ly_is_procedure (proc))
 139         {
 140           if (!scm_is_number (m))
 141             m = get_property ("rehearsalMark");
 142
 143           if (scm_is_number (m))
 144             {
 145               context ()->set_property ("rehearsalMark", scm_oneplus (m));
 146               m = scm_call_2 (proc, m, context ()->self_scm ());
 147             }
 148           else
 149             /* Score.rehearsalMark is initialized to #1 so we
 150                never should see this case without user error */
 151             mark_ev_->origin ()->warning
 152               (_ ("rehearsalMark must have integer value"));
 153         }
 154
 155       if (Text_interface::is_markup (m))
 156         text_->set_property ("text", m);
 157       else
 158         mark_ev_->origin ()->warning (_ ("mark label must be a markup object"));
 159     }
 160 }
 161
 162
 163 void
 164 Mark_engraver::boot ()
 165 {
 166   ADD_LISTENER (Mark_engraver, mark);
 167   ADD_ACKNOWLEDGER (Mark_engraver, break_alignment);
 168 }
 169
 170 ADD_TRANSLATOR (Mark_engraver,
 171                 /* doc */
 172                 "Create @code{RehearsalMark} objects.  It puts them on top of"
 173                 " all staves (which is taken from the property"
 174                 " @code{stavesFound}).  If moving this engraver to a different"
 175                 " context, @ref{Staff_collecting_engraver} must move along,"
 176                 " otherwise all marks end up on the same Y@tie{}location.",
 177
 178                 /* create */
 179                 "RehearsalMark ",
 180
 181                 /* read */
 182                 "markFormatter "
 183                 "rehearsalMark "
 184                 "stavesFound ",
 185
 186                 /* write */
 187                 ""
 188                );