annotate base/conditions.lisp @ 106:8528c316fbcc

delete diatonic-pitch (as was)

Delete the diatonic-pitch class, in preparation for MIPS pitch being our single
representation.  Add a DIATONIC-PITCH-OCTAVE generic, and make OCTAVE return
the octave based on a MIDI-PITCH-NUMBER (and make sure that it returns an
integer, too).

darcs-hash:20070726121235-dc3a5-4cbd1058145163eecbfc84384234904e2353fead.gz

(cl:in-package #:amuse) 

;; Some conditions we might want to be able to signal

(define-condition undefined-action (condition)
  ;; This condition would apply to an attempt to perform a meaningless
  ;; operation on an object. This may, initially, include things that
  ;; are a pain to implement but should really be used when it's
  ;; genuinely unclear what an operation means in the given
  ;; context. In such cases, a condition handler might be the best
  ;; approach anyway.
  ((operation :initarg :operation
	      :reader undefined-action-operation)
   (datatype :initarg :datatype
	     :reader undefined-action-datatype))
  (:report (lambda (condition stream)
	     (format stream "The consequence of performing ~A on and object of type ~A is undefined"
		     (undefined-action-operation condition)
		     (undefined-action-datatype condition)))))

(define-condition insufficient-information (condition)
  ;; It should be possible to construct genuinely minimal musical
  ;; structures. When the information in these is insufficient to
  ;; answer a query, this condition should be raised.
  ((operation :initarg :operation
	      :reader insufficient-information-operation)
   (datatype :initarg :datatype
	     :reader insufficient-information-datatype))
  (:report (lambda (condition stream)
	     (format stream "The ~A object does not contain enough information to perform ~A"
		     (insufficient-information-datatype condition)
		     (insufficient-information-operation condition)))))