/*
  $Id: _MKParameter.h,v 1.9 2006/02/05 17:57:10 leighsmith Exp $
  Defined In: The MusicKit
  
  Description:
    Defines structures and function prototypes for _MKParameter.

  Original Author: David A. Jaffe

  Copyright (c) 1988-1992, NeXT Computer, Inc.
  Portions Copyright (c) 1994 NeXT Computer, Inc. and reproduced under license from NeXT
  Portions Copyright (c) 1994 Stanford University.
  Portions Copyright (c) 1999-2000 The MusicKit Project.
*/
/*
Modification history:

  $Log: _MKParameter.h,v $
  Revision 1.9  2006/02/05 17:57:10  leighsmith
  Cleaned up prototypes for Xcode 2.2 as it is much more strict about mixing id with a defined type

  Revision 1.8  2002/04/16 15:07:38  sbrandon
  removed a couple of defunct imports

  Revision 1.7  2000/10/11 02:55:13  leigh
  added import of MKNote.h to fix tokens.h import

  Revision 1.6  2000/10/01 07:00:29  leigh
  Added full prototypes of functions, moved _MKKeyNumPrintfunc to TuningSystemPrivate.h

  Revision 1.5  2000/06/09 14:59:57  leigh
  Removed objc.h

  Revision 1.4  2000/05/06 00:30:48  leigh
  Better typing of _MKParAsInt()

  Revision 1.3  2000/02/07 00:30:14  leigh
  removed _MKHighestPar()

  Revision 1.2  1999/07/29 01:25:59  leigh
  Added Win32 compatibility, CVS logs, SBs changes

  daj/04/23/90 - Created from _musickit.h 
  08/13/90/daj - Added _MKParNameStr().
*/
#ifndef __MK__parameter_H___
#define __MK__parameter_H___

#import <Foundation/Foundation.h>
#import "params.h"
#import "MKNote.h"
#import "tokens.h" // for _MKToken

typedef union __MKParameterUnion {
    /* Used for Parameters and scoreFile parsing. */
    id symbol;        /* This type is needed for scorefile parsing.
			 Also used for storing envelopes and wavetables. */
    double rval;
    NSString *sval;
    int ival;
} _MKParameterUnion;

typedef struct __MKParameter 
{
    _MKParameterUnion _uVal;    /* Value. */
    short _uType;               /* Type of union. */
    short parNum;               /* Number of this parameter. */
}
_MKParameter;

#define _MK_FIRSTAPPPAR  (MK_MKPARBITVECTS * 32)

/* _MKParameter and _MKParName object 'methods' */
extern id _MKParNameObj(int aPar);
extern NSString *_MKParNameStr(int aPar);
extern BOOL _MKParInit(void);
extern _MKParameter *_MKNewStringPar(NSString * value, int parNum);
extern _MKParameter *_MKNewDoublePar(double value, int parNum);
extern _MKParameter *_MKNewIntPar(int value, int parNum);
extern _MKParameter *_MKNewObjPar(id value, int parNum, _MKToken type);
extern _MKParameter *_MKSetDoublePar(_MKParameter * param, double value);
extern double _MKParAsDouble(_MKParameter *param);
extern _MKParameter *_MKSetIntPar(_MKParameter *param, int value);
extern int _MKParAsInt(_MKParameter *param);
extern _MKParameter *_MKSetStringPar(_MKParameter *param, NSString *value);
extern NSString *_MKParAsString(_MKParameter *param);
extern _MKParameter *_MKSetObjPar(_MKParameter *param, id value, _MKToken type);
extern id _MKParAsObj(_MKParameter *param);
// These should be statically typed
extern id _MKParAsEnv(_MKParameter *param);
extern id _MKParAsWave(_MKParameter *param);
extern _MKParameterUnion *_MKParRaw(_MKParameter *param);
extern NSString * _MKParAsStringNoCopy(_MKParameter *param);
extern BOOL _MKIsParPublic(_MKParameter *param);
extern _MKParameter * _MKCopyParameter(_MKParameter *aPar);

#import "_scorefile.h"

extern void _MKParWriteStdValueOn(_MKParameter *rcvr, NSMutableData *aStream, _MKScoreOutStruct *p);
extern void _MKParWriteOn(_MKParameter *rcvr, NSMutableData *aStream, _MKScoreOutStruct *p);
extern void _MKParWriteValueOn(_MKParameter *rcvr, NSMutableData *aStream, _MKScoreOutStruct *p);
extern void _MKArchiveParOn(_MKParameter *param, NSCoder *aTypedStream); /*sb: NSCoder originally converted as NSArchiver */
extern void _MKUnarchiveParOn(_MKParameter *param, NSCoder *aTypedStream); /*sb: originally converted as NSArchiver */
extern id  _MKDummyParameter();
extern BOOL _MKIsPar(unsigned aPar);
extern BOOL _MKIsPrivatePar(unsigned aPar);

typedef enum __MKPrivPar {
    _MK_dur = ((int)MK_privatePars + 1),
    _MK_maxPrivPar /* Must be <= MK_appPars */
}
_MKPrivPar;

extern _MKParameter *_MKFreeParameter(_MKParameter *param);

#endif