lily/include/command-request.hh

   1 /*
   2   command-request.hh -- declare non-musical requests
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c) 1997 Han-Wen Nienhuys <hanwen@stack.nl>
   7 */
   8
   9
  10 #ifndef COMMANDREQUEST_HH
  11 #define COMMANDREQUEST_HH
  12
  13 #include "request.hh"
  14 #include "varray.hh"
  15 #include "duration.hh"
  16
  17 /** Request which are  assumed to be "happening" before the
  18   musical requests. */
  19 class Command_req  : public virtual Request  {
  20 public:
  21     REQUESTMETHODS(Command_req, command);
  22     virtual Group_feature_req * groupfeature() { return 0; }
  23     virtual Measure_grouping_req * measuregrouping() { return 0; }
  24     virtual Clef_change_req * clefchange() { return 0; }
  25     virtual Key_change_req * keychange() { return 0; }
  26     virtual Partial_measure_req * partial() { return 0; }
  27     virtual Meter_change_req * meterchange() { return 0; }
  28     virtual Bar_req *bar() { return 0; }
  29     virtual Cadenza_req *cadenza() { return 0; }
  30     virtual Disallow_break_req *disallowbreak() { return 0; }
  31     virtual Timing_req*timing() {  return 0; }
  32     virtual Command_script_req*commandscript() { return 0;}
  33 };
  34
  35
  36 class Command_script_req : public Command_req,  public Script_req {
  37 public:
  38     // huh?
  39     Command_script_req();
  40     REQUESTMETHODS(Command_script_req, commandscript);
  41 };
  42
  43
  44 class Disallow_break_req : public Command_req {
  45 public:
  46     REQUESTMETHODS(Disallow_break_req, disallowbreak);
  47 };
  48
  49
  50 /** Baseclass for meter/partial req. It has to be handled by
  51   Staff_{walker,column} baseclass.  */
  52 class Timing_req  : public Command_req  {
  53 public:
  54     REQUESTMETHODS(Timing_req, timing);
  55     virtual Tempo_req * tempo(){return 0; }
  56     Tempo_req();
  57 };
  58
  59
  60 class Tempo_req : public Timing_req
  61 {
  62 public:
  63     Duration dur_;
  64     int metronome_i_;
  65
  66     Tempo_req();
  67     REQUESTMETHODS(Tempo_req, tempo);
  68     bool do_equal_b(Request *)const;
  69 };
  70
  71 class Partial_measure_req  : public Timing_req  {
  72 public:
  73     Moment duration_;
  74
  75     Partial_measure_req(Moment);
  76     REQUESTMETHODS(Partial_measure_req, partial);
  77     bool do_equal_b(Request*)const;
  78 };
  79
  80 /**
  81   todo: allow C meter
  82  */
  83 class Meter_change_req  : public Timing_req  {
  84 public:
  85     int beats_i_, one_beat_i_;
  86
  87     Meter_change_req();
  88     void set(int,int);
  89     bool do_equal_b(Request*)const;
  90     REQUESTMETHODS(Meter_change_req, meterchange);
  91 };
  92
  93 /// toggle Cadenza mode
  94 class Cadenza_req  : public Timing_req  {
  95 public:
  96     /// turn on?
  97     bool on_b_;
  98     bool do_equal_b(Request*)const;
  99     Cadenza_req(bool);
 100     REQUESTMETHODS(Cadenza_req,cadenza);
 101 };
 102
 103 /// check if we're at start of a  measure.
 104 class Barcheck_req  : public Timing_req  {
 105 public:
 106     bool do_equal_b(Request *)const;
 107     REQUESTMETHODS(Barcheck_req,barcheck);
 108 };
 109
 110 class Measure_grouping_req : public Timing_req  {
 111 public:
 112     Array<int> beat_i_arr_;
 113     Array<Moment> elt_length_arr_;
 114     bool do_equal_b(Request *)const;
 115     REQUESTMETHODS(Measure_grouping_req, measuregrouping);
 116 };
 117
 118 /** draw a (repeat)-bar. This something different than #Barcheck_req#,
 119   the latter should only happen at the start of a measure.  */
 120 class Bar_req  : public Command_req  {
 121 public:
 122     String type_str_;
 123     Bar_req(String);
 124     bool do_equal_b(Request*)const;
 125
 126     REQUESTMETHODS(Bar_req,bar);
 127 };
 128
 129 class Group_feature_req  : public Command_req  {
 130 public:
 131     String type_str_;
 132     String value_str_;
 133
 134     REQUESTMETHODS(Group_feature_req, groupfeature);
 135 };
 136
 137
 138 /**
 139     Handle key changes.
 140     Routines for sharps and flats are separated,
 141     so that caller may identify non-conventional keys.
 142 */
 143 class Key_change_req  : public Command_req  {
 144 public:
 145     Array<Melodic_req*> melodic_p_arr_;
 146     bool minor_b_;
 147
 148     /// don't ignore the  octaves in #melodic_p_arr_#?
 149     bool multi_octave_b_;
 150     Key_change_req();
 151     Key_change_req(Key_change_req const&);
 152     ~Key_change_req();
 153     REQUESTMETHODS(Key_change_req, keychange);
 154
 155     /// squash the octaves to 1
 156     void squash_octaves();
 157     /// return number of flats in key
 158     int flats_i();
 159
 160     /// return number of sharps in key
 161     int sharps_i();
 162
 163     void transpose(Melodic_req const & d) const;
 164     /// is minor key?
 165     int minor_b();
 166 };
 167
 168 class Clef_change_req  : public Command_req  {
 169 public:
 170     String clef_str_;
 171     Clef_change_req(String);
 172     REQUESTMETHODS(Clef_change_req, clefchange);
 173 };
 174
 175 #endif // COMMANDREQUEST_HH