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 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 Rhythmic_req*rhythmic() { return 0; }
  32     virtual Musical_script_req*musicalscript() { return 0; }
  33     virtual Text_req*text() { return 0; }
  34     virtual Rest_req *rest() { return 0; }
  35     virtual Skip_req* skip() { return 0; }
  36     virtual Dynamic_req* dynamic() { return 0; }
  37     virtual Absolute_dynamic_req * absdynamic() { return 0; }
  38     virtual Tie_req * tie() { return 0; }
  39     virtual Span_dynamic_req * span_dynamic() { return 0; }
  40     REQUESTMETHODS(Musical_req, musical);
  41 };
  42
  43
  44
  45 /** a request with a duration.
  46   This request is used only a base class.
  47  */
  48 class Rhythmic_req  : public virtual Musical_req  {
  49 public:
  50     Duration duration_;
  51
  52     /* *************** */
  53     void set_duration (Duration);
  54     bool do_equal_b (Request*)const;
  55     virtual Moment duration() const;
  56     Rhythmic_req();
  57     static int compare (Rhythmic_req const&,Rhythmic_req const&);
  58     REQUESTMETHODS(Rhythmic_req, rhythmic);
  59 };
  60
  61 class Skip_req  : public Rhythmic_req  {
  62 public:
  63     REQUESTMETHODS(Skip_req, skip);
  64 };
  65 struct Spacing_req :virtual Request {
  66     Moment next;
  67     Real distance;
  68     Real strength;
  69     /* *************** */
  70     Spacing_req();
  71     REQUESTMETHODS(Spacing_req, spacing);
  72 };
  73
  74 class Blank_req  : public Spacing_req, Rhythmic_req  {
  75 public:
  76     REQUESTMETHODS(Spacing_req, spacing);
  77
  78 };
  79
  80 /// Put a text above or below (?) this staff.
  81 class Text_req  : public virtual Musical_req  {
  82 public:
  83     /// preferred position (above/below)
  84     int dir_i_;
  85     /// the characteristics of the text
  86     Text_def *tdef_p_;
  87
  88     /* *************** */
  89     Text_req (int d, Text_def*);
  90     ~Text_req();
  91     Text_req (Text_req const&);
  92
  93     REQUESTMETHODS(Text_req,text);
  94 };
  95
  96 /** Put a text in lyric_staff
  97   @see Lyric_staff
  98   */
  99 class Lyric_req  : public  Rhythmic_req, public Text_req  {
 100 public:
 101     Lyric_req (Text_def* t_p);
 102     REQUESTMETHODS(Lyric_req, lreq_l);
 103 };
 104
 105 /// request which has some kind of pitch
 106 struct Melodic_req :virtual Musical_req
 107 {
 108     /// 0 is c, 6 is b
 109     int notename_i_;
 110     /// 0 is central c
 111     int octave_i_;
 112
 113     /// 0 natural, 1 sharp, etc
 114     int accidental_i_;
 115
 116     /// return height from central c (in halflines)
 117     int height()const;
 118
 119     /// transpose. #delta# is relative to central c.
 120     void transpose (Melodic_req const &delta);
 121     /// return pitch from central c (in halfnotes)
 122     int pitch()const;
 123     Melodic_req();
 124     bool do_equal_b (Request*)const;
 125     static int compare (Melodic_req const&,Melodic_req const&);
 126     REQUESTMETHODS(Melodic_req,melodic);
 127 };
 128
 129 /// Put a note of specified type, height, and with accidental on the staff.
 130 class Note_req  : public Rhythmic_req, virtual public Melodic_req  {
 131 public:
 132
 133     /// force/supress printing of accidental.
 134     bool forceacc_b_;
 135     Note_req();
 136     bool do_equal_b (Request*)const;
 137     Rhythmic_req* rhythmic() { return Rhythmic_req::rhythmic (); }
 138     REQUESTMETHODS(Note_req, note);
 139  };
 140
 141 /**
 142 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.
 143 */
 144 class Rest_req : public Rhythmic_req {
 145 public:
 146     REQUESTMETHODS(Rest_req,rest);
 147 };
 148
 149 /**
 150   attach a stem to the noteball.
 151   Rhythmic_req parent needed to  determine if it will fit inside a beam.
 152   */
 153 class Stem_req  : public Rhythmic_req  {
 154 public:
 155     /// preferred direction for the stem
 156     int dir_i_;
 157     Stem_req();
 158     REQUESTMETHODS(Stem_req,stem);
 159 };
 160
 161 /**
 162   Requests to start or stop something.
 163  This type of request typically results in the creation of a #Spanner#
 164 */
 165 class Span_req  : public virtual Musical_req  {
 166 public:
 167     /// should the spanner start or stop, or is it unwanted?
 168     enum {
 169         NOSPAN, START, STOP
 170     } spantype ;
 171     bool do_equal_b (Request*)const;
 172     REQUESTMETHODS(Span_req,span);
 173
 174     Span_req();
 175
 176 };
 177
 178 /** Start / stop a beam at this note.  if #nplet# is set, the staff
 179 will try to put an appropriate number over the beam */
 180 class Beam_req  : public Span_req  {
 181 public:
 182     int nplet;
 183
 184     /* *************** */
 185      REQUESTMETHODS(Beam_req,beam);
 186
 187     Beam_req();
 188 };
 189
 190 /**
 191   Start a tie at this voice element, end it at the next
 192  */
 193 class Tie_req : public Musical_req {
 194 public:
 195     REQUESTMETHODS(Tie_req, tie);
 196 };
 197
 198 /// a slur
 199 class Slur_req  : public Span_req  {
 200 public:
 201  REQUESTMETHODS(Slur_req,slur);
 202
 203 };
 204
 205 class Musical_script_req : public Musical_req,  public Script_req {
 206 public:
 207     REQUESTMETHODS(Musical_script_req, musicalscript);
 208 };
 209
 210
 211 class Dynamic_req  : public virtual Musical_req  {
 212 public:
 213     /// for absolute dynamics
 214     enum Loudness {
 215         FFF, FF, F, MF, MP, P, PP, PPP
 216     };
 217     static String loudness_str (Loudness);
 218     REQUESTMETHODS(Dynamic_req, dynamic);
 219 };
 220
 221 class Absolute_dynamic_req  : public Dynamic_req  {
 222 public:
 223     Loudness loudness_;
 224     Absolute_dynamic_req();
 225     REQUESTMETHODS(Absolute_dynamic_req, absdynamic);
 226 };
 227
 228 class Span_dynamic_req  : public Dynamic_req, public Span_req  {
 229 public:
 230     /// Grow or shrink the volume: 1=cresc, -1 = decresc
 231     int dynamic_dir_i_;
 232     Span_dynamic_req();
 233     REQUESTMETHODS(Span_dynamic_req, span_dynamic);
 234 };
 235
 236 #endif // MUSICALREQUESTS_HH