lily/include/musical-request.hh

   1 /*
   2   musical-request.hh -- declare Musical requests
   3
   4   source file of the GNU LilyPond music typesetter
   5
   6   (c)  1997--1998 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   7 */
   8
   9
  10 #ifndef MUSICALREQUESTS_HH
  11 #define MUSICALREQUESTS_HH
  12
  13 #include "lily-proto.hh"
  14 #include "request.hh"
  15 #include "duration.hh"
  16 #include "musical-pitch.hh"
  17
  18 /**
  19   A request which is coupled to a note (that has duration).
  20   Base class only
  21  */
  22 class Musical_req  : public virtual Request  {
  23 public:
  24
  25   DEFAULTACCESSOR(Lyric_req)
  26   DEFAULTACCESSOR(Note_req )
  27   DEFAULTACCESSOR(Stem_req )
  28   DEFAULTACCESSOR(Melodic_req )
  29   DEFAULTACCESSOR(Slur_req )
  30   DEFAULTACCESSOR(Beam_req )
  31   DEFAULTACCESSOR(Abbreviation_beam_req)
  32   DEFAULTACCESSOR(Rhythmic_req)
  33   DEFAULTACCESSOR(Musical_script_req)
  34   DEFAULTACCESSOR(Text_req)
  35   DEFAULTACCESSOR(Rest_req )
  36   DEFAULTACCESSOR(Skip_req)
  37   DEFAULTACCESSOR(Dynamic_req)
  38   DEFAULTACCESSOR(Absolute_dynamic_req )
  39   DEFAULTACCESSOR(Tie_req)
  40   DEFAULTACCESSOR(Musical_span_req)
  41   DEFAULTACCESSOR(Plet_req)
  42   DEFAULTACCESSOR(Span_dynamic_req )
  43   DEFAULTACCESSOR(Abbreviation_req)
  44   DEFAULTACCESSOR(Multi_measure_rest_req)
  45   REQUESTMETHODS(Musical_req);
  46 };
  47
  48
  49
  50 /** a request with a duration.
  51   This request is used only used as a base class.
  52  */
  53 class Rhythmic_req  : public virtual Musical_req  {
  54 public:
  55   Duration duration_;
  56
  57   bool do_equal_b (Request*) const;
  58   void compress (Moment);
  59   virtual Moment duration() const;
  60   Rhythmic_req();
  61   static int compare (Rhythmic_req const&,Rhythmic_req const&);
  62   REQUESTMETHODS(Rhythmic_req);
  63 };
  64
  65 class Skip_req  : public Rhythmic_req  {
  66 public:
  67   REQUESTMETHODS(Skip_req);
  68 };
  69
  70 struct Spacing_req :virtual Request {
  71   Moment next;
  72   Real distance;
  73   Real strength;
  74   Spacing_req();
  75   REQUESTMETHODS(Spacing_req);
  76 };
  77
  78 struct Abbreviation_req : public Musical_req {
  79   REQUESTMETHODS (Abbreviation_req);
  80   Abbreviation_req ();
  81   int type_i_;
  82 };
  83
  84 class Blank_req  : public Spacing_req, Rhythmic_req  {
  85 public:
  86   REQUESTMETHODS(Spacing_req);
  87 };
  88
  89 /// Put a text above or below (?) this staff.
  90 class Text_req  : public virtual Musical_req  {
  91 public:
  92   /// preferred position (above/below)
  93   Direction dir_;
  94   /// the characteristics of the text
  95   Text_def *tdef_p_;
  96
  97   Text_req (int d, Text_def*);
  98   ~Text_req();
  99   Text_req (Text_req const&);
 100
 101   REQUESTMETHODS(Text_req);
 102 };
 103
 104 /** a syllable  or lyric is a string with rhythm.
 105   */
 106 class Lyric_req  : public  Rhythmic_req  {
 107 public:
 108   String text_str_;
 109   REQUESTMETHODS(Lyric_req);
 110 };
 111
 112
 113
 114 /// request which has some kind of pitch
 115 struct Melodic_req :virtual Musical_req
 116 {
 117   Musical_pitch pitch_;
 118   /// transpose. #delta# is relative to central c.
 119   virtual void transpose (Musical_pitch delta);
 120   Melodic_req();
 121   bool do_equal_b (Request*) const;
 122   static int compare (Melodic_req const&,Melodic_req const&);
 123   REQUESTMETHODS(Melodic_req);
 124 };
 125
 126 /// Put a note of specified type, height, and with accidental on the staff.
 127 class Note_req  : public Rhythmic_req, virtual public Melodic_req  {
 128 public:
 129
 130   /// force/supress printing of accidental.
 131   bool forceacc_b_;
 132   Note_req();
 133   bool do_equal_b (Request*) const;
 134   Rhythmic_req* access_Rhythmic_req () { return Rhythmic_req::access_Rhythmic_req (); }
 135   REQUESTMETHODS(Note_req);
 136 };
 137
 138 /**
 139 Put a rest on the staff. Why a request? It might be a good idea to not typeset the rest, if the paper is too crowded.
 140 */
 141 class Rest_req : public Rhythmic_req {
 142 public:
 143   REQUESTMETHODS(Rest_req);
 144 };
 145
 146 /**
 147  Part: typeset a measure with the number of measures rest
 148  Score: typeset all individual measures ass full rests
 149  */
 150 class Multi_measure_rest_req : public Rhythmic_req  {
 151 public:
 152   REQUESTMETHODS(Multi_measure_rest_req);
 153
 154 };
 155
 156 class Musical_span_req : public Span_req, public virtual Musical_req
 157 {
 158 public:
 159   REQUESTMETHODS(Musical_span_req);
 160
 161 };
 162
 163 /** Start / stop a beam at this note */
 164 class Beam_req  : public Musical_span_req  {
 165 public:
 166   REQUESTMETHODS(Beam_req);
 167
 168   Beam_req();
 169 };
 170
 171 /**
 172  Start / stop an abbreviation beam at this note.
 173  */
 174 class Abbreviation_beam_req : public Musical_span_req  {
 175 public:
 176   REQUESTMETHODS (Abbreviation_beam_req);
 177
 178   Abbreviation_beam_req ();
 179
 180   int type_i_;
 181 };
 182
 183 /**
 184   Start a tie at this note, end it at the next
 185  */
 186 class Tie_req : public Musical_req {
 187 public:
 188   REQUESTMETHODS(Tie_req);
 189 };
 190
 191 /// a slur
 192 class Slur_req  : public Musical_span_req  {
 193 public:
 194   REQUESTMETHODS(Slur_req);
 195
 196 };
 197
 198 /// a plet (bracket with) number
 199 class Plet_req : public Musical_span_req  {
 200 public:
 201   int plet_i_;
 202
 203   REQUESTMETHODS(Plet_req);
 204   Plet_req ();
 205 };
 206
 207 class Musical_script_req : public Musical_req,  public Script_req {
 208 public:
 209   REQUESTMETHODS(Musical_script_req);
 210 };
 211
 212
 213 class Dynamic_req  : public virtual Musical_req  {
 214 public:
 215   /**
 216     for absolute dynamics
 217
 218     This sux. We'd want increasing numbers for FFF till PPP, but not
 219     for FP, SF, SFZ (FP is *not* louder than FFF)
 220    */
 221   enum Loudness {
 222     FFF, FF, F, MF, MP, P, PP, PPP, FP, SF, SFZ
 223   };
 224   static String loudness_static_str (Loudness);
 225   REQUESTMETHODS(Dynamic_req);
 226 };
 227
 228 class Absolute_dynamic_req  : public Dynamic_req  {
 229 public:
 230   Loudness loudness_;
 231   virtual bool do_equal_b (Request*) const;
 232   String loudness_str () const;
 233   Absolute_dynamic_req();
 234   REQUESTMETHODS(Absolute_dynamic_req);
 235 };
 236
 237 class Span_dynamic_req  : public Dynamic_req, public Musical_span_req  {
 238 public:
 239   virtual bool do_equal_b (Request*) const;
 240   /// Grow or shrink the volume: 1=cresc, -1 = decresc
 241   Direction dynamic_dir_;
 242   Span_dynamic_req();
 243   REQUESTMETHODS(Span_dynamic_req);
 244 };
 245
 246 #endif // MUSICALREQUESTS_HH