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@stack.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
  17
  18 /**
  19   A request which is coupled to a #Request_chord#
  20   Base class only
  21  */
  22 class Musical_req  : public virtual Request  {
  23 public:
  24
  25   virtual Lyric_req* lreq_l() { return 0; }
  26   virtual Note_req *note() { return 0;}
  27   virtual Stem_req *stem() { return 0;}
  28   virtual Melodic_req *melodic() { return 0; }
  29   virtual Slur_req *slur() { return 0 ; }
  30   virtual Beam_req *beam() { return 0 ; }
  31   virtual Abbreviation_beam_req* abbrev_beam() { return 0 ; }
  32   virtual Rhythmic_req*rhythmic() { return 0; }
  33   virtual Musical_script_req*musicalscript() { return 0; }
  34   virtual Text_req*text() { return 0; }
  35   virtual Rest_req *rest() { return 0; }
  36   virtual Skip_req* skip() { return 0; }
  37   virtual Dynamic_req* dynamic() { return 0; }
  38   virtual Absolute_dynamic_req * absdynamic() { return 0; }
  39   virtual Tie_req * tie() { return 0; }
  40   virtual Plet_req* plet() { return 0; }
  41   virtual Span_dynamic_req * span_dynamic() { return 0; }
  42   virtual Abbreviation_req* abbrev() { return 0; }
  43   virtual Multi_measure_rest_req* multi_measure() { return 0; }
  44   REQUESTMETHODS(Musical_req, musical);
  45 };
  46
  47
  48
  49 /** a request with a duration.
  50   This request is used only a base class.
  51  */
  52 class Rhythmic_req  : public virtual Musical_req  {
  53 public:
  54   Duration duration_;
  55
  56   /* *************** */
  57   void set_duration (Duration);
  58   bool do_equal_b (Request*) const;
  59   virtual Moment duration() const;
  60   Rhythmic_req();
  61   static int compare (Rhythmic_req const&,Rhythmic_req const&);
  62   REQUESTMETHODS(Rhythmic_req, rhythmic);
  63 };
  64
  65 class Skip_req  : public Rhythmic_req  {
  66 public:
  67   REQUESTMETHODS(Skip_req, skip);
  68 };
  69
  70 struct Spacing_req :virtual Request {
  71   Moment next;
  72   Real distance;
  73   Real strength;
  74   /* *************** */
  75   Spacing_req();
  76   REQUESTMETHODS(Spacing_req, spacing);
  77 };
  78
  79 struct Abbreviation_req : public Musical_req {
  80   REQUESTMETHODS (Abbreviation_req, abbrev);
  81   Abbreviation_req ();
  82   int type_i_;
  83 };
  84
  85 class Blank_req  : public Spacing_req, Rhythmic_req  {
  86 public:
  87   REQUESTMETHODS(Spacing_req, spacing);
  88 };
  89
  90 /// Put a text above or below (?) this staff.
  91 class Text_req  : public virtual Musical_req  {
  92 public:
  93   /// preferred position (above/below)
  94   Direction dir_;
  95   /// the characteristics of the text
  96   Text_def *tdef_p_;
  97
  98   /* *************** */
  99   Text_req (int d, Text_def*);
 100   ~Text_req();
 101   Text_req (Text_req const&);
 102
 103   REQUESTMETHODS(Text_req,text);
 104 };
 105
 106 /** Put a text in lyric_staff
 107   @see Lyric_staff
 108   */
 109 class Lyric_req  : public  Rhythmic_req, public Text_req  {
 110 public:
 111   Lyric_req (Text_def* t_p);
 112   REQUESTMETHODS(Lyric_req, lreq_l);
 113 };
 114
 115 /// request which has some kind of pitch
 116 struct Melodic_req :virtual Musical_req
 117 {
 118   /// 0 is c, 6 is b
 119   int notename_i_;
 120   /// 0 is central c
 121   int octave_i_;
 122
 123     /// 0 natural, 1 sharp, etc
 124   int accidental_i_;
 125
 126   /// return height from central c (in halflines)
 127   int height() const;
 128
 129   /// transpose. #delta# is relative to central c.
 130   virtual void transpose (Melodic_req const *delta);
 131   /// return pitch from central c (in halfnotes)
 132   int pitch() const;
 133   Melodic_req();
 134   bool do_equal_b (Request*) const;
 135   static int compare (Melodic_req const&,Melodic_req const&);
 136   REQUESTMETHODS(Melodic_req,melodic);
 137 };
 138
 139 /// Put a note of specified type, height, and with accidental on the staff.
 140 class Note_req  : public Rhythmic_req, virtual public Melodic_req  {
 141 public:
 142
 143   /// force/supress printing of accidental.
 144   bool forceacc_b_;
 145   Note_req();
 146   bool do_equal_b (Request*) const;
 147   Rhythmic_req* rhythmic() { return Rhythmic_req::rhythmic (); }
 148   REQUESTMETHODS(Note_req, note);
 149 };
 150
 151 /**
 152 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.
 153 */
 154 class Rest_req : public Rhythmic_req {
 155 public:
 156   REQUESTMETHODS(Rest_req,rest);
 157 };
 158
 159 /**
 160  Part: typeset a measure with the number of measures rest
 161  Score: typeset all individual measures ass full rests
 162  */
 163 class Multi_measure_rest_req : public Rhythmic_req  {
 164 public:
 165   REQUESTMETHODS(Multi_measure_rest_req, multi_measure);
 166
 167 };
 168
 169 /**
 170   Requests to start or stop something.
 171  This type of request typically results in the creation of a #Spanner#
 172 */
 173 class Span_req  : public virtual Musical_req  {
 174 public:
 175   /// should the spanner start or stop, or is it unwanted?
 176   enum Spantype {
 177     NOSPAN, START, STOP
 178   } spantype;
 179   bool do_equal_b (Request*) const;
 180   REQUESTMETHODS(Span_req,span);
 181
 182   Span_req();
 183
 184 };
 185
 186 /** Start / stop a beam at this note */
 187 class Beam_req  : public Span_req  {
 188 public:
 189   /* *************** */
 190   REQUESTMETHODS(Beam_req,beam);
 191
 192   Beam_req();
 193 };
 194
 195 /**
 196  Start / stop an abbreviation beam at this note.
 197  */
 198 class Abbreviation_beam_req : public Span_req  {
 199 public:
 200   REQUESTMETHODS (Abbreviation_beam_req, abbrev_beam);
 201
 202   Abbreviation_beam_req ();
 203
 204   int type_i_;
 205 };
 206
 207 /**
 208   Start a tie at this voice element, end it at the next
 209  */
 210 class Tie_req : public Musical_req {
 211 public:
 212   REQUESTMETHODS(Tie_req, tie);
 213 };
 214
 215 /// a slur
 216 class Slur_req  : public Span_req  {
 217 public:
 218   REQUESTMETHODS(Slur_req,slur);
 219
 220 };
 221
 222 /// a plet (bracket with) number
 223 class Plet_req : public Span_req  {
 224 public:
 225   int plet_i_;
 226
 227   REQUESTMETHODS(Plet_req,plet);
 228
 229   Plet_req ();
 230 };
 231
 232 class Musical_script_req : public Musical_req,  public Script_req {
 233 public:
 234   REQUESTMETHODS(Musical_script_req, musicalscript);
 235 };
 236
 237
 238 class Dynamic_req  : public virtual Musical_req  {
 239 public:
 240   /**
 241     for absolute dynamics
 242
 243     This sux. We'd want increasing numbers for FFF till PPP, but not
 244     for FP, SF, SFZ (FP is *not* louder than FFF)
 245    */
 246   enum Loudness {
 247     FFF, FF, F, MF, MP, P, PP, PPP, FP, SF, SFZ
 248   };
 249   static String loudness_static_str (Loudness);
 250   REQUESTMETHODS(Dynamic_req, dynamic);
 251 };
 252
 253 class Absolute_dynamic_req  : public Dynamic_req  {
 254 public:
 255   Loudness loudness_;
 256   virtual bool do_equal_b (Request*) const;
 257   String loudness_str () const;
 258   Absolute_dynamic_req();
 259   REQUESTMETHODS(Absolute_dynamic_req, absdynamic);
 260 };
 261
 262 class Span_dynamic_req  : public Dynamic_req, public Span_req  {
 263 public:
 264   /// Grow or shrink the volume: 1=cresc, -1 = decresc
 265   Direction dynamic_dir_;
 266   Span_dynamic_req();
 267   REQUESTMETHODS(Span_dynamic_req, span_dynamic);
 268 };
 269
 270 #endif // MUSICALREQUESTS_HH