unsmob_pitch -> Pitch::unsmob and related

[lilypond.git] / lily / include / pitch.hh

diff --git a/lily/include/pitch.hh b/lily/include/pitch.hh
index b281c0e1984dec41624a72bf2a2fd85a91c031cd..91c527455712cb4f6a1f388921d1328fc23d7530 100644 (file)
--- a/lily/include/pitch.hh
+++ b/lily/include/pitch.hh
@@ -1,92 +1,108 @@
-/*   
-  pitch.hh -- declare Pitch
-  
-  source file of the GNU LilyPond music typesetter
-  
-  (c) 1998--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  
- */
-
-#ifndef MUSICAL_PITCH_HH
-#define MUSICAL_PITCH_HH
+/*
+  This file is part of LilyPond, the GNU music typesetter.
 
-#include "lily-proto.hh"
-#include "smobs.hh"
+  Copyright (C) 1998--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
+
+  LilyPond is free software: you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation, either version 3 of the License, or
+  (at your option) any later version.
+
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
 
-/** A "tonal" pitch. This is a pitch used in diatonal western music
-   (24 quartertones in an octave), as opposed to a frequency in Hz or a
-   integer number of semitones.
+  You should have received a copy of the GNU General Public License
+  along with LilyPond.  If not, see <http://www.gnu.org/licenses/>.
+*/
 
-  Pitch is lexicographically ordered by (octave, notename,
-    alteration).    
-  
+#ifndef PITCH_HH
+#define PITCH_HH
 
-   TODO:
+#include "lily-proto.hh"
+#include "smobs.hh"
+#include "rational.hh"
 
-   - add indeterminate octaves, so it can be used as a key in keySigature
+/*
+  A "tonal" pitch.  This is a pitch used in diatonal western music
+  (24 quartertones in an octave), as opposed to a frequency in Hz or a
+  integer number of semitones.
 
+  Pitch is lexicographically ordered by (octave, notename, alteration).
 */
+
 class Pitch
 {
-private:                               // fixme
-  /*
-    TODO: use SCM
-   */
-
-  int notename_;
-  int alteration_;
+private:
   int octave_;
- 
+  int notename_;
+  Rational alteration_;
+  Scale *scale_;
+
   void transpose (Pitch);
   void up_to (int);
   void down_to (int);
-  void normalise ();
+  void normalize_octave ();
+  void normalize_alteration ();
+  void normalize ();
 
 public:
-  
   int get_octave () const;
   int get_notename () const;
-  int get_alteration () const;
+  Rational get_alteration () const;
 
-  Pitch (int octave, int notename,int accidental);
+  Pitch (int octave, int notename, Rational accidental = 0);
   Pitch ();
 
   Pitch transposed (Pitch) const;
   Pitch to_relative_octave (Pitch) const;
 
-  static int compare (Pitch const&,Pitch const&);
+  Pitch normalized () const;
+
+  static int compare (Pitch const &, Pitch const &);
 
   int steps () const;
-  int semitone_pitch () const; 
-  int quartertone_pitch () const; 
-  String to_string () const;
+  Rational tone_pitch () const;
+  int rounded_semitone_pitch () const;
+  int rounded_quartertone_pitch () const;
+  Pitch negated () const;
+  string to_string () const;
 
   DECLARE_SCHEME_CALLBACK (less_p, (SCM a, SCM b));
-  DECLARE_SIMPLE_SMOBS (Pitch,);
+  DECLARE_SIMPLE_SMOBS (Pitch);
 };
 
-enum {
+enum
+{
   DOUBLE_FLAT = -4,
   THREE_Q_FLAT,
-  FLAT ,
+  FLAT,
   SEMI_FLAT,
   NATURAL,
   SEMI_SHARP,
-  SHARP ,
+  SHARP,
   THREE_Q_SHARP,
   DOUBLE_SHARP,
 };
 
-SCM ly_pitch_diff (SCM pitch, SCM  root);
+extern Rational DOUBLE_FLAT_ALTERATION;
+extern Rational THREE_Q_FLAT_ALTERATION;
+extern Rational FLAT_ALTERATION;
+extern Rational SEMI_FLAT_ALTERATION;
+extern Rational NATURAL_ALTERATION;
+extern Rational SEMI_SHARP_ALTERATION;
+extern Rational SHARP_ALTERATION;
+extern Rational THREE_Q_SHARP_ALTERATION;
+extern Rational DOUBLE_SHARP_ALTERATION;
+
+SCM ly_pitch_diff (SCM pitch, SCM root);
 SCM ly_pitch_transpose (SCM p, SCM delta);
-DECLARE_UNSMOB(Pitch,pitch);
 
 INSTANTIATE_COMPARE (Pitch, Pitch::compare);
 
-int compare (Array<Pitch>*, Array<Pitch>*);
 extern SCM pitch_less_proc;
-Pitch pitch_interval (Pitch const & from , Pitch const & to );
-
-#endif /* MUSICAL_PITCH_HH */
-
+Pitch pitch_interval (Pitch const &from, Pitch const &to);
+extern SCM Pitch_type_p_proc;
 
+#endif /* PITCH_HH */